You are on page 1of 542

Dell EqualLogic Group Manager CLI

Reference Guide
PS Series Firmware Version 9.0
FS Series Firmware Version 4.0
Notes, Cautions, and Warnings
NOTE: A NOTE indicates important information that helps you make better use of your computer.

CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you
how to avoid the problem.
WARNING: A WARNING indicates a potential for property damage, personal injury, or death.

2016 Dell Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual
property laws. Dell and the Dell logo are trademarks of Dell Inc. in the United States and/or other jurisdictions. All other
marks and names mentioned herein may be trademarks of their respective companies.

2016 - 06

Rev. 110-6252-EN-R2
Contents
About This Manual................................................................................................. 19
Audience.............................................................................................................................................. 19
Conventions.........................................................................................................................................19
Related Documentation..................................................................................................................... 20
Online Services....................................................................................................................................20
Dell EqualLogic Storage Solutions..................................................................................................... 20
Technical Support and Customer Service......................................................................................... 20

1 Introduction to the CLI...................................................................................... 21


Using the CLI........................................................................................................................................21
Command Types.................................................................................................................................22
Using the CLI in Scripts....................................................................................................................... 22
Getting Help on the CLI...................................................................................................................... 22
Command-Line Editing.......................................................................................................................23
Entering CLI Commands.....................................................................................................................23
Changing the Terminal Display Settings............................................................................................ 25
Changing the CLI Display Settings..................................................................................................... 25
Run Online Diagnostics...................................................................................................................... 25

2 Group Management Commands..................................................................... 27


account................................................................................................................................................27
account create.................................................................................................................................... 28
account delete.....................................................................................................................................31
account select..................................................................................................................................... 32
account show......................................................................................................................................36
acl.........................................................................................................................................................37
acl access-policy.................................................................................................................................38
acl access-policy create..................................................................................................................... 39
acl access-policy delete..................................................................................................................... 39
acl access-policy rename...................................................................................................................40
acl access-policy select......................................................................................................................40
acl access-policy select access-point................................................................................................41
acl access-policy select access-point add.........................................................................................41
acl access-policy select access-point delete.................................................................................... 42
acl access-policy select access-point select.....................................................................................43
acl access-policy select associate-to................................................................................................ 45
acl access-policy select disassociate-from....................................................................................... 45
acl access-policy select show............................................................................................................46
acl access-policy show.......................................................................................................................46

3
acl access-policy-group..................................................................................................................... 47
acl access-policy-group create......................................................................................................... 48
acl access-policy-group delete......................................................................................................... 49
acl access-policy-group rename....................................................................................................... 49
acl access-policy-group select.......................................................................................................... 50
acl access-policy-group select access-policy.................................................................................. 50
acl access-policy-group select associate-to..................................................................................... 51
acl access-policy-group select disassociate-from............................................................................51
acl access-policy-group select show................................................................................................ 52
acl access-policy-group show........................................................................................................... 53
acl volume show................................................................................................................................. 53
ad-groups search................................................................................................................................54
alerts.................................................................................................................................................... 54
alerts select..........................................................................................................................................55
alerts show.......................................................................................................................................... 56
chapuser.............................................................................................................................................. 57
chapuser create...................................................................................................................................57
chapuser delete...................................................................................................................................58
chapuser rename................................................................................................................................ 59
chapuser select................................................................................................................................... 59
chapuser select show......................................................................................................................... 60
chapuser show.................................................................................................................................... 61
collection............................................................................................................................................. 61
collection create................................................................................................................................. 62
collection delete................................................................................................................................. 63
collection rename............................................................................................................................... 63
collection select..................................................................................................................................64
collection select add...........................................................................................................................65
collection select delete.......................................................................................................................65
collection select replication............................................................................................................... 66
collection select replication create-repcol....................................................................................... 66
collection select replication disable................................................................................................... 67
collection select replication enable................................................................................................... 68
collection select replication select show...........................................................................................68
collection select replication show..................................................................................................... 69
collection select schedule..................................................................................................................69
collection select schedule create.......................................................................................................70
collection select schedule delete....................................................................................................... 72
collection select schedule rename.....................................................................................................72
collection select schedule select........................................................................................................73
collection select schedule show........................................................................................................ 75
collection select show........................................................................................................................ 75

4
collection select sync-rep.................................................................................................................. 76
collection show...................................................................................................................................78
discover-devices................................................................................................................................. 78
domain-list show................................................................................................................................ 79
eula status............................................................................................................................................79
failback................................................................................................................................................ 80
failback retry........................................................................................................................................ 81
failback show....................................................................................................................................... 81
failback start........................................................................................................................................ 82
failback stop........................................................................................................................................ 82
folder................................................................................................................................................... 83
folder create........................................................................................................................................ 83
folder delete........................................................................................................................................ 84
folder rename......................................................................................................................................84
folder select.........................................................................................................................................85
folder select inbound-replicaset........................................................................................................ 86
folder select remove-all......................................................................................................................87
folder select show............................................................................................................................... 87
folder select volume........................................................................................................................... 88
folder show......................................................................................................................................... 88
grpparams........................................................................................................................................... 89
grpparams cliaccess-ssh ....................................................................................................................93
grpparams cliaccess-telnet................................................................................................................ 94
grpparams conn-balancing................................................................................................................ 94
grpparams crypto-legacy-protocols................................................................................................. 94
grpparams date................................................................................................................................... 95
grpparams dcb.................................................................................................................................... 96
grpparams dcb def-vlan-id.................................................................................................................96
grpparams default-snapshot-sched.................................................................................................. 96
grpparams default-snapshot-sched show........................................................................................ 99
grpparams default-snapshot-sched start-time.................................................................................99
grpparams def-iscsi-alias................................................................................................................. 100
grpparams def-mgmt-gateway....................................................................................................... 100
grpparams def-sector-size............................................................................................................... 101
grpparams def-snap-borrow............................................................................................................ 101
grpparams def-snap-depletion........................................................................................................ 102
grpparams def-snap-reserve............................................................................................................102
grpparams def-snap-warn................................................................................................................103
grpparams def-thin-growth-max.................................................................................................... 104
grpparams def-thin-growth-warn................................................................................................... 104
grpparams description ..................................................................................................................... 105
grpparams disallow-downgrades.....................................................................................................105

5
grpparams discovery-use-chap....................................................................................................... 106
grpparams dns-server-list................................................................................................................ 106
grpparams dns-suffix-list ................................................................................................................. 107
grpparams email-contact................................................................................................................. 107
grpparams email-from......................................................................................................................108
grpparams email-list......................................................................................................................... 108
grpparams email-notify.................................................................................................................... 109
grpparams ftp-service.......................................................................................................................109
grpparams group-ipaddress............................................................................................................. 110
grpparams group-ipv6address..........................................................................................................110
grpparams info-messages.................................................................................................................112
grpparams iscsi-local-auth............................................................................................................... 112
grpparams iscsi-radius-auth............................................................................................................. 112
grpparams isns-server-list.................................................................................................................113
grpparams location............................................................................................................................113
grpparams login-radius-acct............................................................................................................ 114
grpparams login-radius-attr..............................................................................................................114
grpparams login-radius-auth............................................................................................................ 115
grpparams management-network....................................................................................................115
grpparams name................................................................................................................................ 117
grpparams ntp-server-list..................................................................................................................117
grpparams passwd ............................................................................................................................118
grpparams perf-balancing................................................................................................................ 118
grpparams protocol-endpoint access show....................................................................................119
grpparams radius-acct-list................................................................................................................119
grpparams radius-acct-retries..........................................................................................................120
grpparams radius-acct-secrets........................................................................................................ 120
grpparams radius-acct-timeout....................................................................................................... 121
grpparams radius-auth-list............................................................................................................... 122
grpparams radius-auth-retries..........................................................................................................122
grpparams radius-auth-secrets........................................................................................................ 123
grpparams radius-auth-timeout.......................................................................................................124
grpparams session-banner............................................................................................................... 124
grpparams session-idle-timeout...................................................................................................... 125
grpparams show................................................................................................................................126
grpparams smtp-server-list.............................................................................................................. 127
grpparams snmp............................................................................................................................... 128
grpparams snmp show..................................................................................................................... 129
grpparams standby-button...............................................................................................................129
grpparams syslog-notify................................................................................................................... 129
grpparams syslog-server-list............................................................................................................ 130
grpparams target-auth-password....................................................................................................130

6
grpparams target-auth-username.................................................................................................... 131
grpparams thermal-shutdown.......................................................................................................... 131
grpparams time................................................................................................................................. 132
grpparams timezone......................................................................................................................... 132
grpparams vss-vds ...........................................................................................................................133
grpparams vss-vds access................................................................................................................ 133
grpparams vss-vds access-policy.....................................................................................................135
grpparams vss-vds access-policy-group.........................................................................................135
grpparams vss-vds show.................................................................................................................. 136
grpparams webaccess...................................................................................................................... 136
grpparams webaccess-noencrypt....................................................................................................136
ipsec................................................................................................................................................... 137
ipsec certificate..................................................................................................................................137
ipsec certificate delete...................................................................................................................... 138
ipsec certificate load......................................................................................................................... 138
ipsec certificate select show.............................................................................................................139
ipsec certificate show....................................................................................................................... 140
ipsec enable | disable........................................................................................................................140
ipsec policy........................................................................................................................................140
ipsec policy create.............................................................................................................................141
ipsec policy delete.............................................................................................................................143
ipsec policy show..............................................................................................................................143
ipsec security-association................................................................................................................ 144
ipsec security-association delete..................................................................................................... 145
ipsec security-association show...................................................................................................... 145
ipsec security-params.......................................................................................................................146
ipsec security-params create........................................................................................................... 146
ipsec security-params create certificate.......................................................................................... 147
ipsec security-params create manual-key.......................................................................................149
ipsec security-params create pre-shared-key.................................................................................150
ipsec security-params delete............................................................................................................153
ipsec security-params select show.................................................................................................. 153
ipsec security-params show............................................................................................................. 153
ipsec show......................................................................................................................................... 155
ldap.................................................................................................................................................... 156
ldap ad-group....................................................................................................................................157
ldap ad-group add.............................................................................................................................157
ldap ad-group delete........................................................................................................................ 158
ldap ad-group select.........................................................................................................................159
ldap ad-group select show...............................................................................................................160
ldap ad-group show.......................................................................................................................... 161
ldap ad-server....................................................................................................................................161

7
ldap ad-user...................................................................................................................................... 162
ldap ad-user add............................................................................................................................... 162
ldap ad-user delete........................................................................................................................... 164
ldap ad-user select............................................................................................................................164
ldap ad-user select show..................................................................................................................165
ldap ad-user show............................................................................................................................ 166
ldap authentication........................................................................................................................... 167
ldap server-list .................................................................................................................................. 167
ldap server-list create........................................................................................................................167
ldap server-list delete........................................................................................................................169
ldap server-list select........................................................................................................................ 169
ldap server-list select show.............................................................................................................. 170
ldap server-list show......................................................................................................................... 170
ldap show........................................................................................................................................... 171
local-groups search...........................................................................................................................171
member..............................................................................................................................................172
member delete.................................................................................................................................. 172
member rename................................................................................................................................173
member select...................................................................................................................................174
member select data-reduction compression resume.....................................................................178
member select data-reduction compression start..........................................................................178
member select data-reduction compression suspend................................................................... 179
member select disk select clear-label..............................................................................................179
member select disk select show...................................................................................................... 180
member select disk show.................................................................................................................180
member select eth select..................................................................................................................181
member select eth select dcb show................................................................................................ 183
member select eth select show....................................................................................................... 185
member select eth show.................................................................................................................. 185
member select sed-backup-key...................................................................................................... 186
member select show.........................................................................................................................187
member show................................................................................................................................... 192
monitor..............................................................................................................................................194
nas......................................................................................................................................................195
nas show............................................................................................................................................195
nas-cluster.........................................................................................................................................196
nas-cluster create............................................................................................................................. 196
nas-cluster delete............................................................................................................................. 199
nas-cluster rename........................................................................................................................... 199
nas-cluster select..............................................................................................................................199
nas-cluster select active-client-sessions nfs show........................................................................ 202
nas-cluster select active-client-sessions smb show...................................................................... 202

8
nas-cluster select ad-users search.................................................................................................. 203
nas-cluster select alerts available-space-threshold....................................................................... 203
nas-cluster select alerts used-space-threshold............................................................................. 204
nas-cluster select alerts show......................................................................................................... 204
nas-cluster select all-users.............................................................................................................. 205
nas-cluster select antivirus-servers................................................................................................. 205
nas-cluster select antivirus-servers create......................................................................................206
nas-cluster select antivirus-servers deleteAll..................................................................................206
nas-cluster select appliance.............................................................................................................207
nas-cluster select appliance select..................................................................................................208
nas-cluster select client-load-balance action move load-ip access-ip controller...................... 209
nas-cluster select client-load-balance action pin load-ip access-ip controller........................... 210
nas-cluster select client-load-balance action unpin load-ip access-ip controller....................... 210
nas-cluster select client-load-balance show...................................................................................211
nas-cluster select container..............................................................................................................211
nas-cluster select container create..................................................................................................212
nas-cluster select container delete..................................................................................................214
nas-cluster select container rename............................................................................................... 214
nas-cluster select container select...................................................................................................215
nas-cluster select container select access-security........................................................................216
nas-cluster select container select data-reduction.........................................................................217
nas-cluster select container select def-group-quota.....................................................................218
nas-cluster select container select def-group-quota modify........................................................ 219
nas-cluster select container select def-user-quota....................................................................... 220
nas-cluster select container select def-user-quota modify........................................................... 221
nas-cluster select container select dir-permission......................................................................... 221
nas-cluster select container select few-writers.............................................................................. 222
nas-cluster select container select file-permission........................................................................ 222
nas-cluster select container select group-quota............................................................................223
nas-cluster select container select group-quota create................................................................ 224
nas-cluster select container select group-quota delete................................................................ 224
nas-cluster select container select group-quota-effective-rule select show...............................225
nas-cluster select container select group-quota modify............................................................... 225
nas-cluster select container select group-quota select show.......................................................226
nas-cluster select container select group-quota show..................................................................226
nas-cluster select container select nfs-export................................................................................227
nas-cluster select container select nfs-export create.................................................................... 227
nas-cluster select container select nfs-export delete.................................................................... 229
nas-cluster select container select nfs-export select.....................................................................229
nas-cluster select container select nfs-export show...................................................................... 231
nas-cluster select container select quota-dir create...................................................................... 232
nas-cluster select container select quota-dir delete...................................................................... 233

9
nas-cluster select container select quota-dir select modify.......................................................... 233
nas-cluster select container select quota-dir show....................................................................... 234
nas-cluster select container select quota-usage............................................................................ 235
nas-cluster select container select rename.................................................................................... 235
nas-cluster select container select replication................................................................................235
nas-cluster select container select schedule.................................................................................. 237
nas-cluster select container select schedule create....................................................................... 237
nas-cluster select container select schedule delete.......................................................................239
nas-cluster select container select schedule rename.................................................................... 239
nas-cluster select container select schedule select ...................................................................... 240
nas-cluster select container select schedule show........................................................................ 241
nas-cluster select container select show........................................................................................ 241
nas-cluster select container select size...........................................................................................242
nas-cluster select container select smb-share............................................................................... 243
nas-cluster select container select smb-share create....................................................................243
nas-cluster select container select smb-share delete....................................................................245
nas-cluster select container select smb-share select.................................................................... 245
nas-cluster select container select smb-share select continuousavailability................................247
nas-cluster select container select smb-share select messageencryption...................................248
nas-cluster select container select smb-share show..................................................................... 248
nas-cluster select container select snap-reserve........................................................................... 249
nas-cluster select container select snap-warn............................................................................... 250
nas-cluster select container select snapshot..................................................................................250
nas-cluster select container select snapshot create-now.............................................................. 251
nas-cluster select container select snapshot delete....................................................................... 251
nas-cluster select container select snapshot rename.................................................................... 252
nas-cluster select container select snapshot select....................................................................... 252
nas-cluster select container select snapshot select thin-clone create......................................... 253
nas-cluster select container select snapshot show........................................................................ 254
nas-cluster select container select space-warn............................................................................. 254
nas-cluster select container select thin-clone show......................................................................255
nas-cluster select container select thin-provision disable............................................................. 256
nas-cluster select container select thin-provision enable..............................................................256
nas-cluster select container select thin-provision enable thin-reserve.........................................257
nas-cluster select container select user-quota...............................................................................257
nas-cluster select container select user-quota create................................................................... 258
nas-cluster select container select user-quota delete................................................................... 259
nas-cluster select container select user-quota-effective-rule select show..................................259
nas-cluster select container select user-quota modify..................................................................260
nas-cluster select container select user-quota select show.......................................................... 261
nas-cluster select container select useringroup-quota..................................................................261
nas-cluster select container select useringroup-quota create...................................................... 262

10
nas-cluster select container select useringroup-quota delete...................................................... 263
nas-cluster select container select useringroup-quota modify.....................................................264
nas-cluster select container select useringroup-quota select show.............................................265
nas-cluster select container show...................................................................................................265
nas-cluster select controller............................................................................................................ 266
nas-cluster select controller add..................................................................................................... 267
nas-cluster select controller select..................................................................................................267
nas-cluster select controller select attach...................................................................................... 270
nas-cluster select controller select detach..................................................................................... 270
nas-cluster select controller select load show................................................................................ 271
nas-cluster select controller select traffic show............................................................................. 272
nas-cluster select credentials...........................................................................................................273
nas-cluster select credentials create............................................................................................... 273
nas-cluster select credentials delete................................................................................................275
nas-cluster select credentials modify ad-preferred-dc.................................................................. 276
nas-cluster select credentials select AD.......................................................................................... 277
nas-cluster select data-reduction schedule.................................................................................... 277
nas-cluster select data-reduction schedule create........................................................................ 278
nas-cluster select data-reduction schedule delete........................................................................ 279
nas-cluster select data-reduction schedule rename...................................................................... 279
nas-cluster select data-reduction schedule select.........................................................................280
nas-cluster select def-access-security............................................................................................ 281
nas-cluster select def-available-space-warn.................................................................................. 281
nas-cluster select def-data-reduction............................................................................................ 282
nas-cluster select def-dir-permission............................................................................................. 282
nas-cluster select def-file-permission.............................................................................................283
nas-cluster select def-gateway........................................................................................................283
nas-cluster select def-nfs-permission............................................................................................ 284
nas-cluster select def-nfs-trusted-users........................................................................................ 284
nas-cluster select def-smb-access-based-enum.......................................................................... 285
nas-cluster select def-smb-antivirus...............................................................................................285
nas-cluster select def-smb-avexcludedirs......................................................................................286
nas-cluster select def-smb-avextensions....................................................................................... 286
nas-cluster select def-snap-reserve................................................................................................ 287
nas-cluster select def-snap-warn................................................................................................... 288
nas-cluster select def-space-provision thin|thick.......................................................................... 288
nas-cluster select def-space-warn..................................................................................................289
nas-cluster select def-thin-reserve................................................................................................. 289
nas-cluster select diagnostics..........................................................................................................290
nas-cluster select diagnostics show................................................................................................290
nas-cluster select diagnostics start-client....................................................................................... 291
nas-cluster select diagnostics start-file........................................................................................... 291

11
nas-cluster select diagnostics start-general................................................................................... 292
nas-cluster select diagnostics start-network.................................................................................. 292
nas-cluster select diagnostics start-nfs........................................................................................... 293
nas-cluster select diagnostics start-performance.......................................................................... 293
nas-cluster select diagnostics start-protocols................................................................................294
nas-cluster select diagnostics start-smb.........................................................................................294
nas-cluster select diagnostics start-smb-homeshare.................................................................... 295
nas-cluster select failback................................................................................................................ 295
nas-cluster select fs-scan-rate........................................................................................................ 296
nas-cluster select ftp-service...........................................................................................................296
nas-cluster select initialize-cluster.................................................................................................. 297
nas-cluster select local-group......................................................................................................... 297
nas-cluster select local-group create............................................................................................. 298
nas-cluster select local-group delete............................................................................................. 298
nas-cluster select local-group select show.................................................................................... 299
nas-cluster select local-group show...............................................................................................299
nas-cluster select local-user........................................................................................................... 300
nas-cluster select local-user create.................................................................................................301
nas-cluster select local-user delete................................................................................................ 302
nas-cluster select local-user modify............................................................................................... 302
nas-cluster select local-user select show....................................................................................... 303
nas-cluster select local-user show..................................................................................................304
nas-cluster select mass-failback..................................................................................................... 304
nas-cluster select mass-rebalance.................................................................................................. 305
nas-cluster select max-supported-nfs-version.............................................................................. 305
nas-cluster select ndmp...................................................................................................................306
nas-cluster select ndmp dma-server-list........................................................................................ 306
nas-cluster select ndmp passwd......................................................................................................307
nas-cluster select ndmp port........................................................................................................... 307
nas-cluster select ndmp show.........................................................................................................308
nas-cluster select ndmp start.......................................................................................................... 308
nas-cluster select ndmp stop.......................................................................................................... 309
nas-cluster select ndmp username................................................................................................. 309
nas-cluster select network............................................................................................................... 310
nas-cluster select network create....................................................................................................310
nas-cluster select network create client-secondary....................................................................... 311
nas-cluster select network delete.................................................................................................... 312
nas-cluster select network select.....................................................................................................312
nas-cluster select network select apply-changes........................................................................... 313
nas-cluster select network select cancel-changes.........................................................................314
nas-cluster select network select cluster-ip-list............................................................................. 314
nas-cluster select network select controller select.........................................................................314

12
nas-cluster select network select controller select controller-ip-addr-list................................... 315
nas-cluster select network select controller select show...............................................................316
nas-cluster select network select netmask......................................................................................316
nas-cluster select network select show...........................................................................................316
nas-cluster select network select static-route................................................................................ 317
nas-cluster select network select static-route add.........................................................................318
nas-cluster select network select static-route delete.....................................................................318
nas-cluster select network select static-route show...................................................................... 319
nas-cluster select network select vlan.............................................................................................319
nas-cluster select nfsv4-mode........................................................................................................ 320
nas-cluster select operation............................................................................................................ 320
nas-cluster select replicate-to-partner............................................................................................321
nas-cluster select resize................................................................................................................... 322
nas-cluster select service-mode......................................................................................................322
nas-cluster select show....................................................................................................................323
nas-cluster select show credentials.................................................................................................325
nas-cluster select smb-home-share create....................................................................................326
nas-cluster select smb-home-share delete.................................................................................... 327
nas-cluster select smb-home-share modify...................................................................................328
nas-cluster select smb-home-share show..................................................................................... 329
nas-cluster select smb-protocol maxsupportedversion................................................................ 330
nas-cluster select smb-protocol message-encryption.................................................................. 330
nas-cluster select smb-protocol message-signing.........................................................................331
nas-cluster select smb-protocol ntlm-config ntlm-set-name...................................................... 331
nas-cluster select smb-protocol ntlm-config show.......................................................................332
nas-cluster select smb-protocol show............................................................................................332
nas-cluster select traffic show......................................................................................................... 333
nas-cluster select unix-users search............................................................................................... 333
nas-cluster select update start.........................................................................................................334
nas-cluster select user-mapping..................................................................................................... 335
nas-cluster select user-mapping automatic................................................................................... 336
nas-cluster select user-mapping create..........................................................................................336
nas-cluster select user-mapping delete.......................................................................................... 337
nas-cluster select user-mapping show........................................................................................... 337
nas-cluster show.............................................................................................................................. 338
nfs-export select access...................................................................................................................339
nfs-export select access create....................................................................................................... 339
nfs-export select access delete....................................................................................................... 340
nfs-export select access select........................................................................................................340
nfs-export select access show......................................................................................................... 341
nsfv4-mode....................................................................................................................................... 341
partner............................................................................................................................................... 342

13
partner create....................................................................................................................................343
partner delete....................................................................................................................................347
partner rename................................................................................................................................. 348
partner select.................................................................................................................................... 349
partner select cancel-operation.......................................................................................................352
partner select failback-replicaset..................................................................................................... 352
partner select failback-replicaset select.......................................................................................... 353
partner select failback-replicaset select access.............................................................................. 354
partner select failback-replicaset select access create...................................................................355
partner select failback-replicaset select access delete...................................................................356
partner select failback-replicaset select access select....................................................................357
partner select failback-replicaset select access select show......................................................... 358
partner select failback-replicaset select assign...............................................................................359
partner select failback-replicaset select cancel-operation............................................................ 359
partner select failback-replicaset select delete-failback................................................................ 360
partner select failback-replicaset select pool................................................................................. 360
partner select failback-replicaset select promote........................................................................... 361
partner select failback-replicaset select show.................................................................................361
partner select failback-replicaset select unassign...........................................................................363
partner select failback-replicaset show...........................................................................................363
partner select inbound-nas-replication.......................................................................................... 364
partner select inbound-nas-replication delete............................................................................... 364
partner select inbound-nas-replication select................................................................................365
partner select inbound-nas-replication select pause..................................................................... 365
partner select inbound-nas-replication select promote................................................................ 366
partner select inbound-nas-replication select read-only-access..................................................367
partner select inbound-nas-replication resume............................................................................. 367
partner select inbound-nas-replication show................................................................................ 368
partner select inbound-pause..........................................................................................................368
partner select inbound-repcol.........................................................................................................369
partner select inbound-repcolset.................................................................................................... 370
partner select inbound-replicaset.................................................................................................... 371
partner select inbound-replicaset delete......................................................................................... 371
partner select inbound-replicaset select......................................................................................... 372
partner select inbound-replicaset select access............................................................................. 373
partner select inbound-replicaset select access create..................................................................373
partner select inbound-replicaset select access delete..................................................................375
partner select inbound-replicaset select access select.................................................................. 375
partner select inbound-replicaset select access show................................................................... 377
partner select inbound-replicaset select cancel-operation........................................................... 378
partner select inbound-replicaset select clone...............................................................................378
partner select inbound-replicaset select delete............................................................................. 380

14
partner select inbound-replicaset select lost-blocks mark-valid................................................... 381
partner select inbound-replicaset select manual-xfer done.......................................................... 381
partner select inbound-replicaset select pool................................................................................ 382
partner select inbound-replicaset select promote......................................................................... 382
partner select inbound-replicaset select show............................................................................... 385
partner select inbound-replicaset show..........................................................................................385
partner select inbound-resume....................................................................................................... 386
partner select move-space-delegated............................................................................................ 386
partner select nas-replication.......................................................................................................... 387
partner select nas-replication upgrade-protocol-version..............................................................387
partner select outbound-nas-replication........................................................................................388
partner select outbound-pause....................................................................................................... 389
partner select outbound-repcol...................................................................................................... 389
partner select outbound-repcolset................................................................................................. 390
partner select outbound-replicaset................................................................................................. 391
partner select outbound-replicaset delete...................................................................................... 391
partner select outbound-replicaset select...................................................................................... 392
partner select outbound-replicaset select delete........................................................................... 392
partner select outbound-replicaset select show............................................................................ 393
partner select outbound-replicaset show....................................................................................... 394
partner select outbound-resume.................................................................................................... 394
partner select pool-map...................................................................................................................395
partner select pool-space-delegated..............................................................................................396
partner select show.......................................................................................................................... 397
partner select volume-replication................................................................................................... 398
partner show..................................................................................................................................... 399
pool....................................................................................................................................................401
pool create........................................................................................................................................402
pool delete........................................................................................................................................403
pool merge....................................................................................................................................... 403
pool rename..................................................................................................................................... 404
pool select........................................................................................................................................ 404
pool show......................................................................................................................................... 407
recovery-bin..................................................................................................................................... 407
save-config....................................................................................................................................... 408
show...................................................................................................................................................411
show account....................................................................................................................................413
show alerts........................................................................................................................................ 413
show audit-log.................................................................................................................................. 414
show chapuser.................................................................................................................................. 415
show collections............................................................................................................................... 415
show-devices.................................................................................................................................... 415

15
show grpparams................................................................................................................................416
show member................................................................................................................................... 417
show nas-cluster...............................................................................................................................418
show partners....................................................................................................................................419
show pool......................................................................................................................................... 420
show recentevents........................................................................................................................... 420
show snapcol.................................................................................................................................... 421
show usersessions............................................................................................................................ 422
show volume.....................................................................................................................................422
snapcol..............................................................................................................................................424
snapcol create.................................................................................................................................. 424
snapcol delete...................................................................................................................................425
snapcol rename................................................................................................................................ 426
snapcol select................................................................................................................................... 426
snapcol show.................................................................................................................................... 427
storage-container............................................................................................................................. 427
storage-container create................................................................................................................. 428
storage-container delete................................................................................................................. 429
storage-container rename............................................................................................................... 429
storage-container select.................................................................................................................. 430
storage-container show................................................................................................................... 431
tag...................................................................................................................................................... 431
tag create.......................................................................................................................................... 432
tag delete.......................................................................................................................................... 432
tag rename........................................................................................................................................ 433
tag select show................................................................................................................................. 433
tag select value add.......................................................................................................................... 434
tag select value delete......................................................................................................................434
tag select value rename....................................................................................................................435
tag show............................................................................................................................................435
unix-groups search...........................................................................................................................436
volume.............................................................................................................................................. 436
volume create................................................................................................................................... 437
volume delete...................................................................................................................................440
volume rename................................................................................................................................. 441
volume select....................................................................................................................................442
volume select access........................................................................................................................447
volume select access create............................................................................................................ 448
volume select access delete............................................................................................................ 450
volume select access select.............................................................................................................450
volume select access show.............................................................................................................. 451
volume select clone......................................................................................................................... 452

16
volume select convert-to.................................................................................................................454
volume select create-thin-clone..................................................................................................... 455
volume select delete-failback.......................................................................................................... 455
volume select multihost-access...................................................................................................... 456
volume select pool........................................................................................................................... 457
volume select replicate-to-primary.................................................................................................458
volume select replication................................................................................................................. 458
volume select replication cancel..................................................................................................... 459
volume select replication create-replica.........................................................................................460
volume select replication demote....................................................................................................461
volume select replication disable.....................................................................................................462
volume select replication enable..................................................................................................... 462
volume select replication pause...................................................................................................... 464
volume select replication resume....................................................................................................464
volume select replication select...................................................................................................... 465
volume select replication show....................................................................................................... 466
volume select schedule....................................................................................................................467
volume select schedule create........................................................................................................ 468
volume select schedule delete........................................................................................................ 470
volume select schedule rename...................................................................................................... 470
volume select schedule select..........................................................................................................471
volume select schedule show.......................................................................................................... 472
volume select show.......................................................................................................................... 473
volume select shrink......................................................................................................................... 477
volume select size.............................................................................................................................478
volume select snapshot....................................................................................................................479
volume select snapshot create-now...............................................................................................480
volume select snapshot delete.........................................................................................................481
volume select snapshot rename...................................................................................................... 481
volume select snapshot select.........................................................................................................482
volume select snapshot select clone.............................................................................................. 484
volume select snapshot select restore............................................................................................ 485
volume select snapshot select show...............................................................................................486
volume select snapshot show......................................................................................................... 488
volume select snap-borrowing........................................................................................................488
volume select sync-rep....................................................................................................................489
volume select sync-rep failover....................................................................................................... 491
volume select tag assign...................................................................................................................491
volume select tag create.................................................................................................................. 492
volume select tag show....................................................................................................................492
volume select tag unassign.............................................................................................................. 493
volume show tag............................................................................................................................493

17
volume show.................................................................................................................................... 494

3 Array Management Commands.....................................................................496


Running Array Management Commands........................................................................................ 496
clearlostdata..................................................................................................................................... 496
diag.................................................................................................................................................... 497
ping................................................................................................................................................... 500
ping6..................................................................................................................................................501
reset...................................................................................................................................................502
restart................................................................................................................................................ 503
setup..................................................................................................................................................504
shutdown.......................................................................................................................................... 509
update................................................................................................................................................ 511

4 Global Commands............................................................................................513
alias.................................................................................................................................................... 513
clear................................................................................................................................................... 513
cli-settings......................................................................................................................................... 514
exec....................................................................................................................................................517
exit......................................................................................................................................................519
help....................................................................................................................................................520
history................................................................................................................................................ 521
logout................................................................................................................................................ 522
stty..................................................................................................................................................... 522
tree.....................................................................................................................................................522
whoami..............................................................................................................................................523
A Dell FluidFS Diagnostic Tool.......................................................................... 525
Start the Dell FluidFS Diagnostic Tool..............................................................................................525
Run the Dell Support Diagnostic Tool Cluster Options.................................................................. 526
Run the FluidFS Diagnostic Tool Diagnostics Tools........................................................................528
Run the Dell Support Diagnostic Tool Network Tools....................................................................530
Run the Dell Support Diagnostic Tool Disk Tools........................................................................... 532
Run the FluidFS Diagnostic Tool Quick Diagnostics....................................................................... 535
B Third-Party Copyrights................................................................................... 537

18
Preface
About This Manual
Dell EqualLogic PS Series arrays optimize resources by automating capacity, performance, and network
load balancing. Additionally, PS Series arrays offer all-inclusive array management software and firmware
updates. Dell EqualLogic FS Series appliances, combined with PS Series arrays, offer a high-performance,
high-availability, scalable NAS solution.

The Dell EqualLogic Group Manager command-line interface (CLI) lets you use CLI commands to
manage the group, a specific array, or a NAS appliance for maintenance purposes.

For information about using the Group Manager graphical user interface (GUI) to manage a group, see
the Dell EqualLogic Group Manager Administrator's Guide.

Audience
The PS Series and FS Series documentation is designed for administrators responsible for managing a PS
Series group and one or more FS Series appliances. Administrators are not required to have extensive
network or storage system experience. However, it is helpful to understand:

Basic networking concepts


Current network environment
Application disk storage requirements

In addition, administrators might find it useful to understand the basic concepts for:

Network topologies
RAID configurations
Disk storage management

NOTE: Although this guide provides examples of using PS Series and FS Series hardware in some
common network configurations, detailed information about setting up a network is beyond the
scope of this document.

Conventions
The following typographical conventions are used in this document.

Table 1. Conventions Used in This Document

Convention Usage
> A greater-than symbol indicates the CLI command prompt.

fixed width font Command, parameter, output, field, or email address

19
Convention Usage
bold fixed width Input to command prompt

fixed_width_italic Indicates that you replace the variable with a command, parameter, file
name, and so on

text1|text2 Indicates that you can choose one of the items presented

parameter ... Trailing dots indicate that you can enter multiple parameters on a
command line, separated by spaces.

option [,...] Trailing dots, preceded by a comma, indicate that you can enter
multiple variables, separated by commas and no spaces.

[parameter] Brackets indicate that the item inside the bracket is optional.

... Ellipses indicates that part of an example is intentionally not shown.

Related Documentation
For detailed information about PS Series arrays, FS Series appliances, groups, volumes, array software, and
host software, log in to the Documentation page at the customer support site.

Online Services
You can learn about Dell products and services using this procedure:

1. Visit dell.com or the URL specified in any Dell product information.


2. Use the locale menu or click on the link that specifies your country or region.

Dell EqualLogic Storage Solutions


To learn more about Dell EqualLogic products and new releases being planned, visit the Dell EqualLogic
TechCenter site: Dell EqualLogic TechCenter. Here you can also see articles, demos, online discussions,
and more details about the benefits of our product family.

Technical Support and Customer Service


Dell support service is available to answer your questions about PS Series SAN arrays and FS Series
appliances.

Contacting Dell
Dell provides several online and telephone-based support and service options. Availability varies by
country and product, and some services might not be available in your area. To contact Dell for sales,
technical support, or customer service issues, go to dell.com/support.

20
1
Introduction to the CLI
The Dell EqualLogic Group Manager command-line interface (CLI) provides a comprehensive set of
commands for managing a group. The CLI also enables you to manage individual storage arrays for
maintenance purposes.

Using the CLI


With the Group Manager CLI, you can enter commands on a command line (or in a script) to manage a
group or a specific array.
NOTE: When managing an individual array, you must use a serial connection to the array or use
telnet or SSH to connect to an IP address for a network interface on the array. Do not connect to
the group IP address. See Running Array Management Commands for details.

To access the group to run CLI commands, you can either:

Use a network connection.


From a computer, use telnet or SSH to connect to the group (or management) IP address or if you
are running array management commands on a specific array connect to an IP address assigned to
a network interface on the array.
Use a serial connection.
Set up a serial connection to the array, as appropriate for the control module model. Make the
connection to serial port 0 on the active control module (the ACT LED will be green). Use the serial
cable that shipped with the array. See the Installation and Setup Guide shipped with your array for
more information.

The serial connection must have the following characteristics:


9600 baud
1 STOP bit
No parity
8 data bits
No hardware flow control

When connected to the group (or an array), press the Enter key and log in to a group administration
account (for example, grpadmin). You can then enter CLI commands at the command prompt.

The following example shows how to use telnet to log in to a group. The password is not shown on the
screen.

PS Series Storage Arrays


Unauthorized Access Prohibited
login as: grpadmin
Password:

Welcome to Group Manager

Introduction to the CLI 21


Copyright 2001-2016 Dell Inc.

group1>

Command Types
The CLI commands are divided into the following categories:

Group management commands These commands manage the group, members, and volumes.
They use a tree structure and generally have subcommands, parameters, or variables.
See Group Management Commands for detailed information about command formats and examples.
Array management commands These commands operate only on a specific array. To run, you
must use a telnet or ssh connection to an IP address assigned to a network interface on the array, not
to the group (or management) IP address. Alternatively, you can use a serial connection to the array.
See Array Management Commands for detailed information about command formats and examples.
Global commands These commands can be used anywhere in the CLI tree structure.
See Global Commands for detailed information about command formats and examples.

Using the CLI in Scripts


You can also manage a group using scripts that run on a host. Host scripting is supported using the CLI
with a Python script. A sample Python script and module are located on the Downloads page of the Dell
support website (eqlsupport.dell.com). The support site also includes instructions on using host scripting
and examples.

Getting Help on the CLI


The Group Manager CLI provides help at the command line. For help on a CLI command, type help and
the command.
You can also enter a command and then type a space (required) and a question mark (?), which shows all
the valid subcommands or parameters available. In addition, you can get help in the setup utility by typing
a question mark (?) at the prompt.

The following examples show how to get help for a command.

> help alerts


alerts - Displays and manages event notification methods.
select - Selects an event notification method.
show - Displays the event notification methods and priorities, if any.
> volume rename ?
<currentname> - Current volume name.
> member select ?
<name> - Name of the member to select.
> member select ps12 ?
cancel-operation - Cancels an in-progress operation.
controller-safe - Enables or disables controller-safe mode for the
selected member. If enabled, operates in write-through
mode to ensure data integrity.
def-gateway - Sets a default gateway for the member.
delay-data-move - Enables or disables (default) a delay before using
member storage until initial RAID verification
completes and batteries are fully charged.
description - Sets a description for the member.
disk - Displays information about one or more disks or adds

22 Introduction to the CLI


disks.
eth - Selects a network interface to configure, modify, or
display.
locate - Enables or disables blinking of LEDs on front and back
panel. Used to locate the member.
low-battery-safe - Enables or disables low-battery-safe mode for the
selected member.
pool - Assigns member to a pool.
raid-policy - Configures the RAID set.
show - Displays detailed information about a member or a
specific component.
<cr>

CLI help messages have two components, as shown in the following example:

> member select ?


<name> - Name of the member to select.

If the component to the left is in angle brackets (< >), you must replace the variable. If the component to
the left is not in angle brackets, you must specify the parameter itself (and possibly a variable).

Command-Line Editing
To see help on editing the command line itself, use the help edit command.

Available editing keystrokes

Delete current character.....................Ctrl-d


Delete text up to cursor.....................Ctrl-u
Delete from cursor to end of line............Ctrl-k
Move to beginning of line....................Ctrl-a
Move to end of line..........................Ctrl-e
Get prior command from history...............Ctrl-p
Get next command from history................Ctrl-n
Move cursor left.............................Ctrl-b
Move cursor right............................Ctrl-f
Move back one word...........................Esc-b
Move forward one word........................Esc-f
Convert rest of word to uppercase............Esc-c
Convert rest of word to lowercase............Esc-l
Delete remainder of word.....................Esc-d
Delete word up to cursor.....................Ctrl-w
Transpose current and previous character.....Ctrl-t
Enter command and return to root prompt......Ctrl-z
Refresh input line...........................Ctrl-l

Entering CLI Commands


The CLI lets you abbreviate a command or parameter if the abbreviation uniquely identifies the command
or parameter.
For example, the following commands are identical:

> volume select dbvol1


> vol sel dbvol1

These commands are also identical:

> cli-settings displayinMB on


> cli-settings display on

Introduction to the CLI 23


In addition, you can press the Tab key to automatically complete a command after entering a unique
portion of the command. Using this key can be useful in completing long commands or subcommands.

For example, entering grp and then pressing the Tab key is the same as entering grpparams:

> grp<Tab>
> grpparams

Similarly, you can enter the beginning of a volume, member, snapshot, partner, or other object name and
press the Tab key to display all the names that match those initial letters or number. For example, when
you type: volume select vo<Tab>, the CLI completes the volume name for you, if only one volume begins
with those characters. If several volumes begin with vo, the CLI displays all of them:

> vol select vol<Tab>


vol2 vol1 vol3

At this point, you can select and paste the correct volume name. Alternatively, if you enter enough
characters to make the name unique, the CLI completes the name for you.

In some cases, you can use subcommand mode to simplify entering repetitive commands related to the
same component (for example, a volume or a member). Subcommand mode is available with the
grpparams command and with commands that use the select subcommand.

To use subcommand mode with the grpparams command, enter the command without any parameters
and press the Enter key. At the resulting grpparams prompt, you can enter parameters, pressing the Enter
key after each one. When you are done, enter the exit command to leave subcommand mode.

With commands that use the select subcommand, select the component and press the Enter key. You
can then enter parameters.

For example, the following commands create a volume and then use subcommand mode to specify a
description for the volume and change the permission to read-only:

> volume create dbvol 100


> volume select dbvol
volume dbvol> description Staff Database
volume dbvol> read-only
volume dbvol> exit

Using subcommand mode is optional. The following example uses two complete command lines to
specify a description and read-write permission for a volume.

> volume select mailvol description Staff Mail


> volume select mailvol read-write

You can have multiple levels of subcommand mode when a command uses multiple select
subcommands. Use the exit command to leave one level at a time. Use the exit all command to leave
subcommand mode.

For example, the following series of commands takes you first into the subcommand level for a member,
then into the subcommand level for disk 1. Typing exit returns you to the member subcommand level.
From the disk subcommand level, typing exit all returns you to the root CLI level.

glasgow> member select panda31


glasgow(member_panda31)> disk select 1
glasgow(member_panda31 disk_1)> show

24 Introduction to the CLI


______________________________ Disk Information ______________________________
Slot: 1 Status: online
Model: WDC WD2500YS-01SHB0 Revision: 20.06C03
Size: 233.76GB Errors: 0
RPM: unknown
______________________________________________________________________________
glasgow(member_panda31 disk_1)> exit
glasgow(member_panda31)> disk select 1
glasgow(member_panda31 disk_1)> exit all
glasgow>

Changing the Terminal Display Settings


The stty command controls the following settings:

Screen height (number of rows)


Screen width (number of columns)
Whether to wrap the output at the screen width

The stty command also displays the current settings and the type of terminal in use. See stty for more
information.

Changing the CLI Display Settings


The cli-settings command controls the following settings. See cli-settings for more information.

Whether to display confirmation messages for critical actions, such as deleting or restarting a member
Whether to display sizes in MB or GB
Whether to display event messages on the console
Whether to format the output of a show command
Whether to enable or disable the automatic logout of idle CLI sessions after 1 hour of inactivity
Whether to display one screenful of output at a time

Run Online Diagnostics


Running diagnostics helps you detect problems with the FluidFS cluster. The diagnostic options available
for the cluster are:

FluidFS diagnostics Used to diagnose software issues


Embedded system diagnostics Used to diagnose hardware issues

The following online diagnostic options are available:

PerformanceDiagnostic
NetworkDiagnostic
ProtocolsDiagnostic
FileSystemDiagnostic
GeneralSystemDiagnostic

To run the online diagnostics:

Introduction to the CLI 25


1. Using an SSH client, log in with the grpadmin account and password to either the NAS cluster SAN
network management address or the NAS cluster IP address (in the client network).

To find either address, in the PS Series Group Manager GUI, select the NAS cluster name, then click
the Network tab.
2. From the CLI, run the following command with the diagnostic option you want (see list above):

diag start option

For example:

diag start PerformanceDiagnostic

To retrieve the diagnostic file:

1. Use an FTP client after the diagnostics is complete. For example:

ftp://admin@managementIP:44421/diagnostics
NOTE: The controller IP address you should use to retrieve the diagnostic file is displayed on
the screen.
2. Enter your grpadmin password.

To run the embedded system diagnostics:

NOTE: Use the embedded system diagnostics to test only your system. Using this program with
other systems might cause invalid results or error messages.

1. As the system boots, press F11.


2. Use the up and down arrow keys to select System Utilities Launch Dell Diagnostics.

The ePSA Pre-boot System Assessment window is displayed, listing all devices detected in the
system. The diagnostics starts executing the tests on all the detected devices.

26 Introduction to the CLI


2
Group Management Commands
Use group management commands to perform operations on the group or members, or on the objects
that you create on the group (such as volumes).
Some group management commands include subcommands, variables, and parameters.

account
Manages local administration accounts. Only a group administrator can create new accounts.

Account Types
You can create the following types of accounts, which have the abilities and restrictions listed in Table 2.
Administration Account Types and Abilities.

Table 2. Administration Account Types and Abilities

Account Type Abilities and Restrictions


grpadmin (default account on Can perform all group management tasks, including managing the
all groups) group, storage pools, members, NAS clusters, volumes, and accounts.
You set the password for the grpadmin account when you create a
group.
Only the grpadmin account can update member firmware or retrieve
diagnostic files using FTP. You cannot rename, delete, or change the
account type for the grpadmin account.

Group administrators Can perform the same tasks as the grpadmin account, except
updating member firmware or retrieving diagnostic files using FTP
Can configure and manage the NAS cluster

Pool administrators Can see and manage only the objects (volume and members) that
are in the pool or pools specified by the account
Can optionally see all objects in the group
Can see any volume administrator accounts that have quotas in the
pool administrators pools
Cannot see or manage the NAS cluster
Cannot manage access policies or access policy groups

Volume administrators Can create, modify, and delete volumes in one or more pools, within
the quota limits set by the group administrator for that account
Can create, modify, and delete access policies and access policy
groups for the volumes under their control
Can optionally be assigned a replication partner for their volumes

Group Management Commands 27


Account Type Abilities and Restrictions
Cannot see or manage the NAS cluster

Monitoring (read-only) Can see but cannot modify objects in the group (has read-only
accounts permission)
Cannot see or manage the NAS cluster

NOTE: You can also manage administration accounts using external RADIUS servers to perform the
authentication. See grpparams radius-acct-list.

Format
account subcommand

Subcommands
Subcommand Description
create Creates an account

delete Deletes an account

select Shows or modifies an account

show Shows all accounts or information about a specific account. Also shows
information about accounts that are currently logged in to the group.

account create
Creates an administration account. By default, the new account will be a group administrator account.
For a list of account types and what each type can do, see account.

When you create an account, you must enter the new account password twice. The password is not
shown on the screen. An account password must be 3 to 16 ASCII characters and is case-sensitive.
Punctuation characters are allowed, but spaces are not. Only the first 8 characters are used; the rest are
ignored (without a message).

You can enter user names containing pound signs (#). However, the group processes only those
characters preceding the pound sign. For example, if you try to create an account named
AdminUser#George, the resulting account is named AdminUser.

Formats
account create name [parameter ...]
account create name pool-admin pools pool1,pool2,... [group-read-access]
[parameter ...]
account create name volume-admin pool-quota-list {pool,quota,...|unlimited}
[partners] [parameter ...]

28 Group Management Commands


Variable
Variable Description
name Account name, up to 16 ASCII characters. Valid characters include
letters, numbers, period, hyphen, and underscore. The first character
must be a letter or number.
You cannot create multiple accounts with the same letters but in a
different case. For example, Greg and greg are interpreted as the same
account name.

For your security, Dell recommends that you not reuse administrator
account names after they have been deleted. All accounts can always
view their own audit log information, and new accounts with previously
used account names will be able to view audit records for the old
account.

Common Parameters
Parameter Description
description text (Optional) Description of the account, up to 127 characters. Fewer
characters are accepted for this field if you enter the value as a Unicode
character string, which takes up a variable number of bytes, depending
on the specific character.
If the text contains spaces, enclose it in quotation marks.

contact name (Optional) Name of the person responsible for the account, up to 63
characters. Fewer characters are accepted for this field if you enter the
value as a Unicode character string, which takes up a variable number
of bytes, depending on the specific character.
If the name contains spaces, enclose it in quotation marks.

email email_address (Optional) Email address, up to 31 ASCII characters, of the person


responsible for the account

phone phone_number (Optional) Telephone number, up to 31 ASCII characters, of the person


responsible for the account.
If you use a #, make sure it is inside quotation marks (for
example: "test#test"). Otherwise, characters that follow the # will be
ignored.

mobile phone_number (Optional) Mobile (cell phone) number, up to 31ASCII characters, of the
person responsible for the account.
If you use a #, make sure it is inside quotation marks (for
example: "test#test"). Otherwise, characters that follow the # will be
ignored.

read-write|read-only Account permission (default is read-write). A read-only account can


monitor the group but cannot create, modify, or delete objects or
settings.

Group Management Commands 29


Parameter Description

NOTE: Read-only is not valid for a pool administrator or a volume


administrator.

enable|disable Sets the status for the account: enabled (default) or disabled

Pool Administrator (pool-admin) Parameters


Parameter Description
group-read-access (Optional) Allows a pool administrator to view all objects in the group.
However, pool administrators can modify only the objects in their
assigned pools.

pools pool_name,... Specifies the pools that the account can manage. Separate the pool
names with commas only (no spaces).

Volume Administrator (volume-admin) Parameters


Parameter Description
pool-quota-list Specifies the pools that the account can manage, and the quota for
pool_name,quota,... each pool. Follow each pool name with its quota. Separate the pool
names and their quota limits with commas only (no spaces).
The minimum quota is 15MB, and the default unit of measure is MB. Use
g, G, gb, GB, m, M, mb, or MB to specify the unit of measure.

To specify no quota, enter unlimited.

partners (Optional) Specifies the replication partners to which the account has
partner1,partner2,... access for managing replication objects

Examples
Creating a Group Administrator Account

Create a group administration account. This account has the same privileges as the default grpadmin
account:

> account create admin21

Creating a Read-Only Account

Create a read-only account. The account can see but cannot modify anything in the group.

> account create monitor1 read-only

Creating a Pool Administrator Account

Create a pool administration account that can manage the objects in two pools:

> account create userbob pool-admin pools default,dbase

30 Group Management Commands


Creating a Pool Administrator Account with Group-Read Privileges

Create a pool administration account that can manage the objects in a pool, and can see all other objects
in the group:

> account create joey pool-admin pools pool2 group-read-access

Creating a Volume Administrator Account

Create a volume administration account that can manage volumes in three pools, and specify the quota
limit for each pool:

> account create voladm1 volume-admin pool-quota-list default,


2048,pool2,15gb,pool3,25MB

Creating a Volume Administrator Account with Replication Privileges

Create a volume administration account that can manage volumes in a pool, with no quota (unlimited).
This administrator can also replicate to a partner.

> account create defvoladm volume-admin pool-quota-list default,unlimited


partners GroupB

account delete
Deletes an administration account. You cannot delete the default grpadmin account.
NOTE: Dell recommends that administrator account names not be reused after they have been
deleted. All accounts can always view their own audit log information, and new accounts with
previously used account names will be able to view audit records for the old account.

Format
account delete account

Variable
Variable Description
account Name of an account

Example
Delete the an account:

> account delete testgroup


Do you really want to delete? (y/n) [n] y
Account deletion succeeded.

Group Management Commands 31


account select
Shows or modifies an account.

Restrictions
You cannot change the name of an account. Instead, you must delete the account and then recreate
it with the new name.
You cannot disable, delete, change the name, or change the type of the default grpadmin account.
Only a group administrator can modify the pools for a pool administrator, the volume assignments,
pools, quotas, or replication partners for a volume administrator, or enable or disable any account.
Only a group administrator can modify the attributes of another group administrator account
(including changing it to a read-only account), with the exceptions noted above for the default
grpadmin account.
You cannot apply read-only permission to a volume administrator or pool administrator account.
Only a group administrator can set or remove the read-only flag.
A pool administrator can see all volumes in their pools. The pool administrator can unassign any
volume in their pools. However, the pool administrator cannot change any volume administrators
pool access privileges or storage quotas.
An existing account (for example, a group administrator account) cannot change its type (for example,
to volume administrator or pool administrator). To change the privileges on an account, delete it and
then create it with the preferred privileges.

Permitted Modifications for All Account Types


The following attributes can be modified by an account for itself:

Description
Contact name
Email address
Telephone number
Mobile phone number
Password

To delete a name, phone number, email address, or description, enter two quotation marks ().

Format
account select account parameter ...

Variable
Variable Description
account Name of an account

32 Group Management Commands


Parameters
Variable Description
contact name Name of the person responsible for the account, up to 63 characters.
Fewer characters are accepted for this field if you enter the value as a
Unicode character string, which takes up a variable number of bytes,
depending on the specific character.
If the name contains spaces, enclose it in quotation marks (for example,
M Chenille).

description text Description of the account, up to 127 characters. Fewer characters are
accepted for this field if you enter the value as a Unicode character
string, which takes up a variable number of bytes, depending on the
specific character.
If the text contains spaces, enclose it in quotation marks.

disable Disables the account

email email_address Email address, up to 31 ASCII characters, for the person responsible for
the account

enable Enables the account

group-admin Specifies that the account is a group administrator account

group-read-access NOTE: Applies only to a pool-admin account.


enable|disable
Allows a pool administrator to view all objects in the group. However,
pool administrators can modify only the objects in their assigned pools.

mobile phone_number Mobile (cell phone) number, up to 31 ASCII characters, for the person
responsible for the account.
If you use a #, make sure it is inside quotation marks (for
example: "test#test"). Otherwise, characters that follow the # will be
ignored.

passwd Password for the account.


Do not enter a password on the command line. Instead, enter a
password (and confirmation) when you are prompted. An account
password must be 3 to 16 ASCII characters and is case-sensitive.
Punctuation characters are allowed, but spaces are not. Only the first 8
characters are used; the rest are ignored (without a message). Neither
your password nor your confirmation will be shown on the screen.

If you enter an invalid password, you will be given a chance to correct


your entry. If your second entry is still incorrect, the password routine
will exit.

phone phone_number Telephone number, up to 31 ASCII characters, for the person


responsible for the account.

Group Management Commands 33


Variable Description
If you use a #, make sure it is inside quotation marks (for
example: "test#test"). Otherwise, characters that follow the # will be
ignored.

pool-admin pools list Comma-separated list of pools that the pool administrator can manage

read-only Specifies that the account is a read-only account.

NOTE: Read-only is not valid for a pool administrator or a volume


administrator.

read-write Specifies that the account has read-write permission (default)

show Shows detailed information about the account

snmp-des|snmp-aes128 Sets SNMP privacy protocol for the account:


snmp-des(Default) Uses the Data Encryption Standard (DES)
snmp-aes128Uses the Advanced Encryption Standard (AES) 128-
bit encryption

NOTE: By default, all accounts use DES. Change an account setting


only if the account will be used by a third-party tool that employs
the USM security model with the privacy protocol set to AES.
For accounts used by the Host Integration Tools, these tools will
negotiate the privacy protocol with the group and will use AES-128
if it is supported.

volume-admin [pool- Selects a volume administrator account and specifies the pools that the
quota-list account can manage, and the quota for each pool. Follow each pool
pool_name,quota,...]
partners name with its quota. Separate the pool names and their quota limits
partner_list,...] with commas only (no spaces).
The minimum quota is 15MB, and the default unit of measure is MB. Use
g, G, gb, GB, m, M, mb, or MB to specify the unit of measure.

To specify no quota, enter unlimited.

Optionally also specifies one or more replication partners, in a comma-


separated list, that this volume administrator can replicate to.

Examples

Changing a Password
Change the password for an account:

> account select grpadmin passwd


Enter New Password:
Retype Password:

Passwords are not echoed on the screen.

34 Group Management Commands


Adding Description and Contact Information
Add a description and contact information for an account:

> account select monitor


(account_monitor)> description read-only account
(account_monitor)> email chenille@cust.com

Displaying Account Details


Show details about an account:

> account select voladm1 show


_____________________________ Account Information ____________________________
Name: voladm1 Description:
Account-Type: volume-admin Status: enable
Contact: Email:
Mobile: Phone:
Last-Login: Authorization-Type: local
SNMP-Privacy: snmp-des Replication-Partners:
______________________________________________________________________________
____________________________________ Pools ___________________________________
Name Quota Free Used Snapshots Volumes FailbkReplSets
--------------- --------- --------- --------- --------- --------- ------------
default unlimited 2.82TB 0MB 0MB 0MB 0MB
___________________________________ Volumes __________________________________
Name Size Snapshots Status Permission Connections
--------------- ---------- --------- -------- ---------- -----------
____________________________ Failback-Replicasets ____________________________
Name ReservedSpace FreeSpace Replicas Status
--------------- ------------- ------------- -------- -------------------------

Changing Account Privileges


Change an account to be a pool administrator (with read-write permission by default) for two pools:

> account select monitor pool-admin staff,sales

Adding Group Read Privileges


Allow an account to monitor all other objects in the group (does not change the ability to manage
objects in their pools):

> account select pool3admin group-read-access enable

Removing Group Read Privileges


Remove the group-read-access permission from a pool administrator account:

> account select marble group-read-access disable

Increasing Quotas
Increase the quotas for a volume administrator:

> account select adm1 volume-admin pool-quota-list pool2,1000m,pool3,500gb

Group Management Commands 35


Adding a Replication Partner
Add a replication partner to a volume administrator account:

> account select adm1 volume-admin partners GroupB

The account still has read-write access on all objects in its designated pool or pools, but can no longer
see other objects in the group.

account show
Shows all administration accounts or information about a specific account.

Format
account show [account] [active]

Variable
Variable Description
account Name of an account

Parameter
Parameter Description
active Displays the accounts currently logged in to the group. For users logged
in through the GUI, the active parameter also shows the remote IP
address of the user and the local IP address (that is, the group or
member IP address to which the user is connected).

Displaying All Accounts


Show all administration accounts:

> account show


_____________________________ Local Accounts ________________________________

Name Permission Privilege Status Last Login


---------------- ---------- ------------- -------- ------------------------
grpadmin read-write group-admin enable 2015-02-18:15:01:31
voladm1 read-write volume-admin enable None
voladm read-write volume-admin enable None
voladm3 read-write volume-admin enable None
voladm4 read-write volume-admin enable None
voladm5 read-write volume-admin enable None
voladm6 read-write volume-admin enable None
voladm7 read-write volume-admin enable None
voladm8 read-write volume-admin enable None
voladm9 read-write volume-admin enable None
voladm10 read-write volume-admin enable None
voladm11 read-write volume-admin enable None
adm read-write volume-admin enable 2015-02-11:11:40:37
test read-write volume-admin enable None

36 Group Management Commands


monitor read-write group-admin enable None

_____________________________ Radius Accounts ________________________________

Name Permission Privilege Status Last Login


---------------- ---------- ------------- -------- ------------------------

Displaying Logged-In Accounts


Show the accounts currently logged in to the group:

> account show active


Name Type StartTime Remote IP Local IP
-------------- --------- -------------------- --------------- -----------
grpadmin ssh 2015-02-15:17:14:05
grpadmin gui-ssl 2015-02-18:15:01:31 192.0.2.20 192.0.2.53

Displaying Account Details


Show details for a volume administrator account:

> account show voladm5


_____________________________ Account Information ____________________________
Name: voladm1 Description:
Account-Type: volume-admin Status: enable
Contact: Email:
Mobile: Phone:
Last-Login: Authorization-Type: local
SNMP-Privacy: snmp-des Replication-Partners:
______________________________________________________________________________
____________________________________ Pools ___________________________________
Name Quota Free Used Snapshots Volumes FailbkReplSets
--------------- --------- --------- --------- --------- --------- ------------
default unlimited 2.82TB 0MB 0MB 0MB 0MB
___________________________________ Volumes __________________________________
Name Size Snapshots Status Permission Connections
--------------- ---------- --------- -------- ---------- -----------
____________________________ Failback-Replicasets ____________________________
Name ReservedSpace FreeSpace Replicas Status
--------------- ------------- ------------- -------- -------------------------

acl
Manages access control policies and access policy groups for application to multiple volumes in the
group.
For detailed information about access control policies and access policy groups, see the Dell EqualLogic
Group Manager Administrator's Guide.

Format
acl subcommand

Group Management Commands 37


Subcommands
Subcommand Description
access-policy Manages access policies

access-policy-group Manages access policy groups

volume show Displays the association of access policies and policy groups to volumes

acl access-policy
Manages access policies.
In PS Series firmware version 7.0 and higher, access policies provide an easier way to apply basic access
points to volumes. The policies determine how hosts and clusters access those volumes.

Use this command to define an access policy for hosts. The access policy provides an access descriptor
for how a host will access its volumes. For a group of hosts or nodes in a cluster, you define an access
policy group (see acl access-policy-group) that describes how a cluster will access its shared volumes.

For more information about access policies and access policy groups, see the Dell EqualLogic Group
Manager Administrator's Guide.

You can use access policies even if you already have basic access points defined on individual volumes
(see volume select access).

Format
acl access-policy subcommand

Subcommands
Subcommand Description
create Creates a new access policy

delete Deletes an access policy

rename Renames an access policy

select Selects an access policy

show Displays all access policies

38 Group Management Commands


acl access-policy create
Creates access policies. An access policy is a named group of access points that you can then apply to
multiple volumes.

Format
acl access-policy create name [description text]

Variable
Variable Description
name Name of a new access policy, can be up to 31 characters long. Space
and underscores are not permitted. Fewer characters are accepted for
this field if you enter the value as a Unicode character string, which
takes up a variable number of bytes, depending on the specific
character.

Parameter
Parameter Description
description text Description for the access policy, 127 characters in length.Fewer
characters are accepted for this field if you enter the value as a Unicode
character string, which takes up a variable number of bytes, depending
on the specific character.
If the text contains spaces, enclose it in quotation marks (for example,
"my access policy").

Example
Create a new access policy with a description:

> acl access-policy create SQLserver description "Access policy for SQL server
host"

See Also
acl access-policy select
acl access-policy-group

acl access-policy delete


Deletes an access policy.

Format
acl access-policy delete name

Group Management Commands 39


Variable
Variable
name Name of an access policy to delete

Example
Delete an access policy:

> acl access-policy delete SQLserver

acl access-policy rename


Renames an access policy.

Format
acl access-policy rename current_name new_name

Variables
Variable Description
current_name Current name of an access policy

new_name Name of a new access policy. The name can be up to 31 characters


long. Spaces and underscores are not permitted.
Fewer characters are accepted for this field if you enter the value as a
Unicode character string, which takes up a variable number of bytes,
depending on the specific character.

Example
Rename an access policy:

> acl access-policy rename SQLserver SQLhost23

acl access-policy select


Selects an access policy for additional operations, such as adding or changing the access points,
associating the policy to volumes, or disassociating the policy from volumes.

Format
acl access-policy select name subcommand

40 Group Management Commands


Variable
Variable Description
name Name of an access policy

Subcommands
Subcommand Description
access-point Manages access points for the policy

associate-to Associates an access policy to a volume

disassociate-from Disassociates an access policy from a volume

show Displays detailed information about an access policy

acl access-policy select access-point


Manages access points for an access policy.

Format
acl access-policy select name access-point subcommand

Variable
Variable Description
name Name of an access policy

Subcommands
Subcommand Description
add Adds an access point to the policy

delete Deletes an access point from the policy

select Selects an access point for further operations

acl access-policy select access-point add


Adds access points to an access policy. An access point must have at least one access type defined. An
access point can be a CHAP account name, an iSCSI initiator name, an IP address (multiple IP addresses
and IP wildcards are supported in an access point), or any combination of these items.

Format
acl access-policy select name access-point add type[s] [description text]

Group Management Commands 41


Variables
Variable Description
name Name of an access policy

type[s] Adds an access point of one or more of the following types to the
policy:
chap chapuser_name1, chapuser_name2, ...
ipaddress address1, address 2, ...
initiator initiator_name1, initiator_name2, ...

NOTE: You can have only one CHAP and iSCSI initiator name in an
access point. Multiple CHAP and iSCSI initiator names are
supported only in an access policy.

Parameter
Parameter Description
description text Adds or changes the description for the access policy.
If the text contains spaces, enclose it in quotation marks (for example,
my access point).

To delete a description, enter an empty string inside quotation marks


(for example," ).

Examples
Add an access point for a CHAP user to an access policy:

> acl access-policy select SQLhost23 access-point add chap GeorgeSmith


Add an access point for an IP address to an access policy:

> acl access-policy select SQLhost23 access-point add ipaddress 192.0.2.20


Add an access point for a CHAP user and a specific initiator to an access policy:

> acl access-policy select SQLhost23 access-point add chap SJones initiator iqn.
1995-07.com.mycompany:sal_jonesPC.myemail.net

acl access-policy select access-point delete


Deletes an access point from an access policy.

Format
acl access-policy select name access-point delete id

42 Group Management Commands


Variables
Variable Description
name Name of an access policy

id ID number for the access point that you want to delete.


To see the list of access point IDs, use the acl access-policy select show
command.

Example
Delete an access point from an access policy.

First, display the access points for the policy, then delete the access point by its ID number:

> acl access-policy select SQLhost23 show


__________________________ Access Policy Information _________________________
Name: SQLhost23 Description:
Owner: grpadmin Is-Public: Y
______________________________________________________________________________
________________________________ Access Points _______________________________
AP ID CHAP Initiator IP Address
----- ----------------- ------------------------- -----------------
1 GeorgeSmith --- ---
2 --- --- 192.0.2.53
3 S.Jones iqn.1995-07.com.mycompany ---
:sal_jonesPC.myemail.net
___________________________________ Volumes __________________________________
Volume Applies To
-------------------- --------------------
> acl access-policy select SQLhost23 access-point delete 2

Redisplay the access policy to confirm that the access point was deleted:

> acl access-policy select SQLhost23 show


__________________________ Access Policy Information _________________________
Name: SQLhost23 Description:
Owner: grpadmin Is-Public: Y
______________________________________________________________________________
________________________________ Access Points _______________________________
AP ID CHAP Initiator IP Address
----- ----------------- ------------------------- -----------------
1 GeorgeSmith --- ---
3 S.Jones iqn.1995-07.com.mycompany ---
:sal_jonesPC.myemail.net
___________________________________ Volumes __________________________________
Volume Applies To
-------------------- --------------------

acl access-policy select access-point select


Manages attributes of a specific access point for an access policy.

Format
acl access-policy select name access-point select id [parameters | show]

Group Management Commands 43


NOTE: You can have only one CHAP and iSCSI initiator name in an access point. Multiple CHAP and
iSCSI initiator names are supported only in an access policy.

Variables
Variable Description
name Name of an access policy

id Identification number of an access point for the specified access policy.


To display the list of access point IDs, see acl access-policy select.

Parameters
Parameter Description
chap One or more CHAP user names, separated by
chapuser_name1,chapuser_name2,... commas (no spaces)

ipaddress address1,address2,... One or more IP addresses or IP wildcards, separated


by commas (no spaces)

initiator One or more initiator names, separated by commas


initiator_name1,initiator_name2,... (no spaces)

description text Adds or changes the description for the access policy.
If the text contains spaces, enclose it in quotation
marks (for example, my access point).

To delete a description, enter an empty string inside


quotation marks (for example, ).

Subcommand
Subcommand Description
show Displays details for the selected access point ID

Examples
Add three CHAP users to an access policy:

> acl access-policy sel ka1 access-point add chap greg,mary,frank

Add IP addresses to an access policy:

> acl access-policy sel ka1 access-point add ipaddress 192.0.2.20,192.0.2.21

Add a CHAP user and an initiator name to an access policy:

> acl access-policy select Test access-point add chap kris initiator iqn.
1995-07.com.mycompany:user-pc.company.com

44 Group Management Commands


acl access-policy select associate-to
Associates an access policy to a volume.

Format
acl access-policy select name associate-to volume association-type type

Variables
Variable Description
name Name of the access policy to select

volume Name of the volume to which to associate the access policy

type Specifies whether to associate the access policy to the volume and its
snapshots, the snapshots only, or the volume only:
vol-only
vol-and-snap
snap-only

NOTE: If a type is not specified, the association-type defaults to


vol-and-snap.

Example
Associate an access policyto a volume, for both the volume and its snapshots:

> acl access-policy select SQLhost23 associate-to kavol1 association-type vol-


and-snap

NOTE: If the access policy does not have any access points defined, a message is displayed asking
you to confirm the operation. For information about access points, see acl access-policy select
access-point.

acl access-policy select disassociate-from


Disassociates an access policy group from a volume.
If you disassociate the last (or only) access policy from a volume, the volume will be inaccessible unless it
has one or more basic access points defined. See volume select access.

Format
acl access-policy select name disassociate-from volume

Group Management Commands 45


Variables
Variable Description
name Name of the access policy to select

volume Name of the volume from which to disassociate the access policy

Example
Disassociate an access policy from a volume:

> acl access-policy select SQLhost23 disassociate-from kavol1

acl access-policy select show


Displays detailed information about an access policy.

Format
acl access-policy select name show

Variable
Variable Description
name Name of an access policy

Example
Display detailed information about an access policy:

> acl access-policy select ka1 show


candy> acl access-policy sel ka1 show
__________________________ Access Policy Information _________________________
Name: ka1 Description: this is a test
Owner: grpadmin Is-Public: Y
______________________________________________________________________________
________________________________ Access Points _______________________________
AP ID CHAP Initiator IP Address
----- ----------------- ------------------------- -----------------
___________________________________ Volumes __________________________________
Volume Applies To
-------------------- --------------------
kris volume and snapshot

acl access-policy show


Displays all or select information about the access policies on the group.

Format
acl access-policy show [-chap | -ip-addr | -initiator-name]

46 Group Management Commands


Parameters
Parameter Description
-chap chap_name Filters the display by CHAP name. Enter a specific CHAP name to display
all the access policies that use that name.

-ip-addr address Filters the display by IP address. Enter a specific IP address to display all
the access policies that use that IP address.

-initiator-name Filters the display by initiator name. Enter a specific initiator name to
initiator_iqn_name display all the access policies that use that initiator.

Examples
Display all access polices for a group:

> acl access-policy show


Access Policy AP ID CHAP Initiator IP Address
-------------------- ----- --------------- ---------------- ------------------
TestPolicy01 1 chap_test1 --- ---
kpol1 1 --- ...C.myemail.net ---

Access Policies With No Access Points


--------------------------------------------

Display all access polices that use a specific CHAP name:

> acl access-policy show -chap chap_test1

Display all access polices that use a specific initiator:

> acl access-policy show -initiator iqn.


1995-07.com.mycompany:l_jonesPC.myemail.net
Access Policy AP ID CHAP Initiator IP Address
-------------------- ----- --------------- ---------------- ------------------
kpol1 1 --- ...C.myemail.net ---

Access Policies With No Access Points


--------------------------------------------

acl access-policy-group
Manages access policy groups. Access policy groups combine individual access policies together so that
they can be managed as a single entity.

Format
acl access-policy-group subcommand

Group Management Commands 47


Subcommands
Subcommand Description
create Creates a new access policy group

delete Deletes an access policy group

rename Renames an access policy group

select Selects an access policy group for further operations

show Displays all access policy groups

acl access-policy-group create


Creates access policy groups, to which you can then add access policies.

Format
acl access-policy-group create name [description text]

Variable
Variable Description
name Name of a new access policy. The name can be up to 31 characters
long. Spaces and underscores are not permitted.
Fewer characters are accepted for this field if you enter the value as a
Unicode character string, which takes up a variable number of bytes,
depending on the specific character.

Parameter
Parameter Description
description text Description for the access policy, up to 127 characters. If the description
contains spaces, enclose the text in quotation marks (for example, my
access policy group).
Fewer characters are accepted for this field if you enter the value as a
Unicode character string, which takes up a variable number of bytes,
depending on the specific character.

Example
Create a new access policy group:

> acl access-policy-group create kagroup

48 Group Management Commands


acl access-policy-group delete
Deletes an access policy group.
NOTE: When you delete an access policy group, the command does not delete the access policies
that the group contains.

Format
acl access-policy-group delete name

Variables
Variable Description
name Name of the access policy group to delete

Example
Delete an access policy group:

> acl access-policy-group delete kagroup

acl access-policy-group rename


Renames an access policy group.

Format
acl access-policy-group rename current_name new_name

Variables
Variable Description
current_name Current name of the access policy group

new_name Name of a new access policy. The name can be up to 31 characters


long. Spaces and underscores are not permitted.
Fewer characters are accepted for this field if you enter the value
as a Unicode character string, which takes up a variable number of
bytes, depending on the specific character.

Example
Rename an access policy group from its current name to a new name:

> acl access-policy-group rename kagroup polgroup1

Group Management Commands 49


acl access-policy-group select
Selects an access policy group for further operations, such as adding access polices to the group, and
associating or disassociating policies from volumes.

Format
acl access-policy-group select name subcommand

Variable
Variable Description
name Name of the access policy group to select

Subcommands
Subcommand Description
access-policy Adds access policies to, or removes them from, the policy group

associate-to Associates an access policy group to a volume

disassociate-from Disassociates an access policy group from a volume

show Displays detailed information about an access policy group

acl access-policy-group select access-policy


Adds or removes access policies for an access policy group.

Format
acl access-policy-group select name access-policy add|remove policy_name

Variables
Variable Description
name Name of the access policy group to select

policy_name Name of the access policy to add or remove

Example
Add an access policy to a policy group:

> acl access-policy-group select SQLpolgroup access-policy add SQLhost23

50 Group Management Commands


acl access-policy-group select associate-to
Associates access policy groups to a volume.

Format
acl access-policy-group select name associate-to volume [association-type type]

Variables
Variable Description
name Name of the access policy group to select

volume Name of the volume to which to associate the access policy group

Parameter
Parameter Description
association-type type Specifies whether to associate the access policy group to the volume
and its snapshots, the snapshots only, or the volume only:
vol-only
vol-and-snap
snap-only

Example
Associate an access policy group to a volume. If multihost access is not already enabled on the volume,
you are asked whether you want to enable it:

> acl access-policy-group select kagroup associate-to sqlvol10

Would you like to enable multihost access on this volume? (y/n) [n] y

acl access-policy-group select disassociate-from


Disassociates an access policy group from a volume.
If you disassociate the last (or only) access policy from a volume, the volume will be inaccessible unless it
has one or more basic access points defined. See volume select access.

Format
acl access-policy-group select name disassociate-from volume

Group Management Commands 51


Variables
Variable Description
name Name of the access policy group to select

volume Name of the volume from which to disassociate the access policy
group

Example
Disassociate an access policy group from a volume. If multihost access is enabled on the volume, you are
given the option to keep it enabled or to disable it:

> acl access-policy-group select SQLpolgroup disassociate-from kavol1

Multihost access is currently enabled on this host, would you like to keep
multihost access enabled? (y/n) [y] n

acl access-policy-group select show


Displays detailed information about an access policy group.

Format
acl access-policy-group select name show

Variable
Variable Description
name Name of the access policy group to select

Example
Display details about an access policy group:

> acl access-policy-group select GroupPol show

_______________________ Access Policy Group Information ______________________


Name: GroupPol Description:
Owner: grpadmin Is-Public: Y
______________________________________________________________________________
_______________________________ Access Policies ______________________________
Access Policy AP ID CHAP Initiator IP Address
Test 1 --- --- 192.0.2.20
Test 2 kris ...mycompany.com ---
-------------------- ----- --------------- ---------------- ------------------
Test2 1 --- --- 192.0.2.21
Test3 1 --- --- 192.0.2.23
Access Policies With No Access Points
--------------------------------------------
___________________________________ Volumes __________________________________
Volume Applies To
-------------------- --------------------

52 Group Management Commands


acl access-policy-group show
Displays all access policy groups.

Format
acl access-policy-group show

Example
Display all access policy groups:

> acl access-policy-group show


Access Policy Group Access Policy Access Policy Description
-------------------- -------------------- ------------------------------------
Test-Policy
DocTest1
New-Policy
GroupPol Test
Test2
Test3
Access Policy Groups With No Access Policies
--------------------------------------------
TestPolicy01
Test-policy-group

acl volume show


Displays all the associations and disassociation of access policies and policy groups to volumes.

Format
acl volume show [associated|disassociated]

Parameters
Parameter Description
associated Shows only those access policies and groups that are associated to
volumes

disassociated Shows only those access policies and groups that are not associated to
volumes

Examples
Display all access policies and policy groups:

> acl volume show


Volume Access Policy Group Access Policy Apply-To
------------------ -------------------- ------------------ ------------------
ABVol1 --- Test both
ABVol2 Test-policy-group --- both
--- New-Policy both
CDag01 Test-Policy --- both

Group Management Commands 53


--- New-Policy both
--- Test both
--- Test2 both
--- Test3 both
vss-control
pe-control-vol
bigvol
CDag02
kvol1
katest
CDag03

Display only access polices and policy groups that are associated to volumes:

> acl volume show associated


Volume Access Policy Group Access Policy Apply-To
------------------ -------------------- ------------------ ------------------
testvol01 GroupPolicy01 --- volume

ad-groups search
Searches for instances of the specified user name in the specified domain.

Format
ad-groups search domain domain search_string

Variable
Variables Description
domain Name of an Active Directory domain that is allowed to connect to the
group

search_string Searches for users in the Active Directory database that match the terms
in the search string

Example
Search for instances of a user name in a domain. The search string looks for names that include the letter
n.

> ad-groups search domain EQLNAS n


Name Type Source
---------------------------------------- -------- --------
EQLNAS+New York Windows External

alerts
Sets the event priorities for email and syslog event notification.
When you enable an event notification method, by default events with fatal, error, or warning priority
result in notifications. You can change the notification event priorities.

Table 3. Event Priorities shows event priorities in order of decreasing severity.

54 Group Management Commands


Table 3. Event Priorities

Priority Description
FATAL Catastrophic failure that might require immediate administrator
intervention or an array restart

ERROR Serious failure that should be investigated and might require


administrator intervention

WARNING Potential problems in the group. Might become an event with error
priority if administrator intervention does not occur.

INFO Normal operational and transitional events in the group that are of
interest to administrators but do not require intervention. Setting this
priority could result in a large number of notifications.

To enable email notification, see grpparams email-notify. To enable syslog notification, see grpparams
syslog-notify.

Format
alerts subcommand

Subcommands
Subcommand Description
select Selects an event notification method

show Shows the notification methods and priorities, if any

alerts select
Specifies one or more event priorities for the selected type of event notification.
You can also use this command to stop email or syslog notification.

Format
alerts select method priority type | show

Variable
Variable Description
method One of the following notification methods:
email Email notification
syslog Remote syslog notification

Group Management Commands 55


Parameter
Parameter Description
priority type Priority of the event messages that result in notification. Choose one or
more of the following options, separated by commas:
info
warning
error
fatal
none (temporarily disables all event notification for the selected
method)
audit (available only for syslog events)

Subcommand
Subcommand Description
show Shows the event priorities for the selected method

Examples
Configure a remote syslog server to receive only those events with the specified priorities:

> alerts select syslog priority error,fatal

Show the event priorities for email notification:

> alerts select email show


Priority is :: warning,error,fatal

alerts show
Shows the event priorities that result in email and syslog notification, if notification is enabled.

Format
alerts show

Example
Show the event priorities for email and syslog notification:

> alerts show

Notification Method Priority


------------------------------ ------------------------------
Email error,fatal
SysLog warning,error,fatal,audit

56 Group Management Commands


chapuser
Manages local CHAP (Challenge Handshake Authentication Protocol) account names and passwords that
the group uses to authenticate iSCSI initiator access to iSCSI targets (volumes and snapshots).
NOTE: Performance can decrease if you have more than 100 local CHAP users. You can use an
external RADIUS server for initiator authentication if you have a large number of local CHAP users.
See grpparams radius-auth-list. In addition to iSCSI initiator authentication, you can use target
authentication. See grpparams target-auth-password and grpparams target-auth-username.

Format
chapuser subcommand

Subcommands
Subcommand Description
create Creates a CHAP account

delete Deletes a CHAP account

rename Renames a CHAP account

select Enables, disables, or shows the selected CHAP account

show Shows all CHAP accounts or the details of a specific account

chapuser create
Creates a local CHAP account for iSCSI initiator authentication.
RequirementTo enable local CHAP authentication of iSCSI initiators, see grpparams discovery-use-
chap.

RecommendationTo prevent unauthorized hosts from connecting to targets protected only with
CHAP, see grpparams discovery-use-chap.

After creating a local CHAP account, set up a basic access point for the volume and specify the account
name. See volume select access create.

Format
chapuser create name parameter

Variable
Variable Description
name CHAP account (user) name, up to 63 printable characters. Spaces
cannot be used.

Group Management Commands 57


Variable Description

NOTE: If the account name contains a pound sign, enclose the


name in quotation marks (for example, chap#user). Otherwise,
the system will read the characters after the pound sign as a
comment and not include them in the account name.

Parameters
Parameter Description
enable|disable Enables (default) or disables the CHAP account

password password (Optional) CHAP account password, up to 254 printable characters


(space characters cannot be used). If you do not specify a password, the
group creates a password that consists of 16 characters.
For optimal security, passwords used in CHAP authentication must
contain at least 12 characters, preferably random. Individual initiators
might have their own rules and restrictions for length and format.
Consult your initiator documentation for details.

Examples
Create two local CHAP accounts:

> chapuser create chap1 password k7%h4sm^pbj5-


CHAP user creation succeeded.
> chapuser create sherry enable
CHAP user creation succeeded.
Generating password.
Password is 2ZpJJj88ZR8Bz2Hr

chapuser delete
Deletes a local CHAP account.

Format
chapuser delete name

Variable
Variable Description
name Name of a CHAP account

58 Group Management Commands


Example
Delete a local CHAP account:

> chapuser delete chap1


Do you really want to delete? (y/n) [n] y
CHAP user deletion succeeded.

NOTE: If the CLI confirmation setting is off, you will not see the prompt asking if you want to delete
the CHAP account. See cli-settings.

chapuser rename
Renames a local CHAP account.

Format
chapuser rename current_name new_name

Variables
Variable Description
current_name Current name of a CHAP account

new_name New name for the CHAP account

Example
Rename a CHAP account:

> chapuser rename jchenille johnc

chapuser select
Modifies or shows the selected local CHAP account.

Format
chapuser select name parameter | show

Variable
Variable Description
name Name of a CHAP account

Group Management Commands 59


Parameters
Parameter Description
enable|disable Enables or disables the selected CHAP account

passwd password (Optional) Password for the selected CHAP account, up to 254 printable
characters. Spaces cannot be used.
If you do not specify a password, the group creates a password that
consists of 16 characters.

Subcommand
Subcommand Description
show Shows details for the selected CHAP account

Example
Disable a CHAP account:

> chapuser select greg disable

chapuser select show


Shows details for a selected CHAP account.

Format
chapuser select name show

Variable
Variable Description
name Name of a CHAP account

Example
Display details about a CHAP account:

> chapuser select samj show


Name Password Status Admin Account
------------------------------ ---------------- ---------- ----------------
samj nhm34ft7ud98b enable grpadmin

60 Group Management Commands


chapuser show
Shows all local CHAP accounts or details about a specific account.

Format
chapuser show [name]

Variable
Variable Description
name Name of a CHAP account

Example
Show the local CHAP accounts in the group:

> chapuser show


Name Password Status Admin Account
------------------------------ ---------------- ---------- ----------------
garyCHAP leqleqleqleql enable grpadmin
samjCHAP nhm34ft7ud98b enable grpadmin

collection
Manages the volume collections in a group.
A volume collection is a set of one or more volumes (up to eight) grouped together for the purpose of
creating simultaneous snapshots of the volumes in the collection (snapshot collection) or simultaneous
replicas of the volumes in the collection (replica collection).

NAS volumes cannot be part of a volume collection.

NOTE: See snapcol create for information about creating snapshot collections. See collection select
replication for information about creating replica collections.

Format
collection subcommand

Subcommands
Subcommand Description
create Creates a volume collection

delete Deletes a volume collection, but does not delete the volumes in the
collection

rename Renames a volume collection

select Selects a collection for additional operations

Group Management Commands 61


Subcommand Description
show Shows all volume collections or shows detailed information about a
specific collection

collection create
Creates a volume collection in the group.
NOTE: A collection cannot include template volumes or NAS volumes.

Format
collection create name volume[,volume,...] [description text] [sync-rep]

Variables
Variable Description
name Collection name, up to 63 characters.
Name can be up to 63 bytes and is case insensitive. You can use any
printable Unicode character except for ! " # $ % & ' ( ) * + , / ; < = > ?@
[ \ ] ^ _ ` { | } ~. First and last characters cannot be a period, hyphen, or
colon. Fewer characters are accepted for this field if you enter the value
as a Unicode character string, which takes up a variable number of
bytes, depending on the specific character.

volume Name of a volume to be included in the collection. Separate multiple


volumes using a comma and no space. Up to eight volumes can be
included in a collection.

Parameters
Parameter Description
sync-rep Enables the collection for synchronous replication (SyncRep).
To configure additional SyncRep options on the collection, see
collection select sync-rep.

description text Description for the volume collection, up to 127 characters. If the text
includes spaces, enclose it in quotation marks.
Fewer characters are accepted for this field if you enter the value as a
Unicode character string, which takes up a variable number of bytes,
depending on the specific character.

Example
Create a volume collection that includes two volumes:

> collection create dbasecol db1,db2 description Dbase Collection


Volume collection creation succeeded.

62 Group Management Commands


collection delete
Deletes a volume collection.

Format
collection delete collection_name

Variable
Variable Description
collection_name Name of a volume collection

Example
Delete a volume collection:

> collection delete staffall

Do you want to delete the volume collection? (y/n) [n] y


Volume collection deletion succeeded.

collection rename
Renames a volume collection.

Format
collection rename current_name new_name

Variables
Variable Description
current_name Current name of a volume collection

new_name New name for the volume collection.


Name can be up to 63 bytes and is case insensitive. You can use any
printable Unicode character except for ! " # $ % & ' ( ) * + , / ; < = > ?@
[ \ ] ^ _ ` { | } ~. First and last characters cannot be a period, hyphen, or
colon. Fewer characters are accepted for this field if you enter the value
as a Unicode character string, which takes up a variable number of
bytes, depending on the specific character.

Example
Rename a volume collection:

> collection rename hrbase hrcollection

Group Management Commands 63


collection select
Selects a volume collection for additional operations.
See snapcol create for information about creating snapshot collections.

Format
collection select collection_name description text | subcommand

Variable
Variable Description
collection_name Name of a volume collection

Parameter
Parameter Description
description text Adds a description for the collection, up to 127 characters. If the text
contains spaces, enclose it in quotation marks. To remove a description,
enter two quotation marks ().
Fewer characters are accepted for this field if you enter the value as a
Unicode character string, which takes up a variable number of bytes,
depending on the specific character.

Subcommands
Subcommand Description
add Adds a volume to the volume collection

delete Deletes a volume from the volume collection

replication Manages volume collection replication

schedule Manages snapshot collection and replica collection schedules

show Shows details about the volume collection

sync-rep Configures synchronous replication for the collection

Example
Add a description for a volume collection:

> collection select staffcol description Manufacturing Staff

64 Group Management Commands


collection select add
Adds a volume to the selected volume collection.
NOTE: You cannot add template volumes or NAS volumes to a volume collection.

Format
collection select collection_name add volume_name

Variables
Variable Description
collection_name Name of a volume collection

volume_name Name of a volume

Example
Add a volume to a volume collection:

> collection select dbcollection add vol3

collection select delete


Deletes a volume from the selected volume collection
The volume itself is not deleted.

Format
collection select collection_name delete volume_name

Variables
Variable Description
collection_name Name of a volume collection

volume_name Name of a volume

Examples
Delete a volume from a volume collection:

> collection select dbcollection delete vol6


Do you want to delete the volume from the volume collection? (y/n) [n] y

Delete the last volume from a volume collection, and also delete the collection:

> collection select coll-2 delete vol-data01


There is only one volume in the volume collection. Deleting this volume from

Group Management Commands 65


the collection results in deletion of volume collection. Snapshot collections
created using this volume collection will continue to exist. Do you really want
to delete the volume from volume collection? (y/n) [n] y

collection select replication


Manages the replication of volume collections.
A replica collection contains replicas of the volumes in a volume collection.

You can recover data by cloning an individual replica or promoting a replica set.

Format
collection select collection_name replication subcommand

Variable
Variable Description
collection_name Name of a volume collection

Subcommands
Subcommand Description
create-repcol Creates a replica of this volume collection on a partner

disable Disables replication of the volume collection to a partner. If a replication


is in process, it cancels the replication (and prompts for verification) and
disables replication on the collection.

enable Enables replication of the volume collection to a partner

select show Shows information about volume collection replication activity to the
selected partner

show Shows the replication partners configured for the volume collection or
detailed information about volume collection replication activity to a
specific partner

collection select replication create-repcol


Creates a replica collection for the selected volume collection.
The replica collection is stored on the specified replication partner.

You must configure each volume in the collection to replicate to the same partner. See volume select
replication enable. In addition, you must configure replication on the volume collection itself (see
collection select replication enable).

Format
collection select collection_name replication create-repcol [manual] partner

66 Group Management Commands


Variables
Variable Description
collection_name Name of a volume collection

partner Name of the replication partner that will store the replica collection
(the secondary group)

Parameter
Parameter Description
manual Creates the replica collection using manual transfer replication

Examples
Create a replica collection:

> collection select dbcollection replication create-repcol agroup

Create a replica collection by using manual transfer replication:

> collection select kcoll1 replication create-repcol manual delta

collection select replication disable


Disables replication of the selected volume collection to a replication partner.
NOTE: Disabling replication for a volume collection does not stop replication for the volumes in the
collection.

Format
collection select collection_name replication disable partner_name

Variables
Variable Description
collection_name Name of a volume collection

partner_name Name of a replication partner

Example
Disable replicating a volume collection to a partner:

> collection select dbcollection replication disable bgroup

Group Management Commands 67


collection select replication enable
Enables replication of the selected volume collection to a replication partner. You enable replication
before you can replicate a volume collection.
You must enable replication on each collection volume to the same partner. See volume select
replication enable.

Format
collection select collection_name replication enable partner_name

Variables
Variable Description
collection_name Name of a volume collection

partner_name Name of a replication partner

Example
Enable replicating a volume collection to a partner:

> collection select dbcollection replication enable agroup

collection select replication select show


Shows information about volume collection replication activity to a replication partner.

Format
collection select collection_name replication select partner_name show

Variables
Variable Description
collection_name Name of a volume collection

partner_name Name of a replication partner

Example
Show information about volume collection replication activity to a partner:

> collection select dbcollection replication select groupb show

68 Group Management Commands


collection select replication show
Shows the replication partner configured for the volume collection or detailed information about volume
collection replication activity to a specific partner.

Format
collection select collection_name replication show [partner_name]

Variables
Variable Description
collection_name Name of a volume collection

partner_name Name of a replication partner

Example
Show information about the replication partner configured for the volume collection:

> collection select dbcollection replication show

collection select schedule


Manages schedules for creating snapshot collections or replica collections.

Format
collection select collection_name schedule subcommand

Variable
Variable Description
collection_name Name of a volume collection

Subcommands
Subcommand Description
create Creates a schedule

delete Deletes a schedule

rename Renames a schedule

select Modifies, enables, disables, or shows details about a schedule

show Shows all schedules or details about a specific schedule

Group Management Commands 69


collection select schedule create
Sets up a schedule for creating snapshot collections or replication collections for the selected volume
collection.
NOTE: Using a schedule can result in the creation of many snapshots or replicas. To control the
number of snapshots or replicas, use the max-keep parameter when creating a schedule. In
addition, the size of the snapshot reserve limits the number of snapshots that you can create for a
volume, and the replica reserve limits the number of replicas that you can create for a volume.
For each schedule, you must specify:

Schedule name
Schedule type
Time to start creating the snapshots or replicas
Partner name (only for replication collection schedules)

Optionally, you can specify other parameters, based on the schedule type. To specify more than one
parameter, separate them with commas and no spaces.

Format
collection select collection_name schedule create schedule_name parameters

Variables
Variable Description
collection_name Name of a volume collection

schedule_name Name for the schedule. Name can be up to 63 bytes and is case
insensitive. You can use any printable Unicode character except for ! " #
$ % & ' ( ) * + , / ; < = > ?@ [ \ ] ^ _ ` { | } ~. First and last characters
cannot be a period, hyphen, or colon. Fewer characters are accepted
for this field if you enter the value as a Unicode character string, which
takes up a variable number of bytes, depending on the specific
character.
If the name contains spaces, enclose it in quotation marks (for example,
schedule for daily backups).

Parameters
Parameter Description
enable|disable Enables (default) or disables the schedule

end-date mm/dd/yy Month, day, and year that the schedule will stop. The default is no
ending date.

end-time hh:mm[AM|PM] Time when the schedule will stop creating a sequence of snapshot or
replica collections. Use 24-hour time or specify AM or PM.

70 Group Management Commands


Parameter Description
Applies only to schedules of type daily.

frequency nmins| Interval between the creation of snapshot or replica collections, in


nhour[s] minutes or hours (for example: 5mins, 1hour, 2hours).
Applies only to schedules of type hourly and daily.

max-keep n Maximum number of snapshot or replica collections created from the


schedule to retain (from 1 to 512). The default is 10.
If you reach the maximum limit, the oldest snapshot or replica
collection created from the schedule will be deleted before another
one is created.

partner partner_name Name of the partner that will store replica collections created through
the schedule.
Required for replication schedules.

read-write|read-only Permission for snapshots created from the schedule. The default is
read-write.

repeat-interval ndays Number of days between the creation of snapshot or replica


collections.
Applies only to schedules of type daily.

start-date mm/dd/yy Month, day, and year that the schedule will start. The default is the day
that the schedule was created (or the following day, if the starting time
has passed).

start-time hh:mm[AM| (Required) Time when the schedule will start creating snapshot or
PM] replica collections. Use 24-hour time or specify AM or PM.

type schedule_type (Required) Type of schedule, either once, hourly, or daily

Examples
Set up a schedule that creates a replica collection of a volume collection every day at 11:30 p.m.:

> collection select db1col schedule create dailydbsch type daily start-time
11:30PM repeat-interval 1days partner psgroup2

Schedule creation succeeded.

Set up a schedule that creates a snapshot collection of a volume collection every day, every 2 hours,
from 7:00 a.m. to 8:00 p.m.:

> collection select mailcol schedule create mailsch type daily start-time
07:00AM end-time 20:00 frequency 2hours repeat-interval 1days

Schedule creation succeeded.

Group Management Commands 71


collection select schedule delete
Deletes a snapshot collection or replication collection schedule for the selected volume collection.
Deleting a schedule does not delete snapshot collections or replica collections created by the schedule.

Format
collection select collection_name schedule delete schedule_name

Variables
Variable Description
collection_name Name of a volume collection

schedule_name Name of a schedule to delete. If the name contains spaces, enclose it in


quotation marks (for example schedule for daily backups).

Example
Delete a schedule:

> collection select staffcol schedule delete backupday

Do you want to delete the schedule? (y/n) [n] y


Schedule deletion succeeded.

Delete a schedule name that contains spaces:

> collection select ABVolCol schedule delete "one time schedule"

collection select schedule rename


Renames a snapshot or replication schedule for the selected volume.

Format
collection select collection_name schedule rename current_name new_name

Variables
Variable Description
collection_name Name of a volume collection

current_name Current name of a schedule. If the name contains spaces, enclose it in


quotation marks (for example schedule for daily backups).

new_name Name for the schedule. Name can be up to 63 bytes and is case
insensitive. You can use any printable Unicode character except for ! " #
$ % & ' ( ) * + , / ; < = > ?@ [ \ ] ^ _ ` { | } ~. First and last characters
cannot be a period, hyphen, or colon. Fewer characters are accepted

72 Group Management Commands


Variable Description
for this field if you enter the value as a Unicode character string, which
takes up a variable number of bytes, depending on the specific
character. The CLI does not allow an underscore as the first character.
If the name contains spaces, enclose it in quotation marks (for example,
schedule for daily backups).

Example
Rename a schedule:

> collection select staffcol schedule rename back2 daily2

collection select schedule select


Modifies a snapshot or replication collection schedule or shows details about a schedule.
To specify more than one parameter, separate them with commas and no spaces.

NOTE: You cannot modify the partner for a replication collection schedule. Instead, delete the
schedule and then create a new schedule with the correct partner.

Format
collection select collection_name schedule select schedule_name parameter | show

Variables
Variable Description
collection_name Name of a volume collection

schedule_name Name of a schedule. If the name contains spaces, enclose it in


quotation marks (for example schedule for daily backups).

Parameters
Parameter Description
enable|disable Enables or disables the schedule

end-date mm/dd/yy Month, day, and year that the schedule will stop

end-time hh:mm[AM|PM] Time when the schedule will stop creating a sequence of snapshot or
replica collections. Use 24-hour time or specify AM or PM.
Applies only to schedules of type daily.

frequency nmins| Interval between the creation of snapshot or replica collections, in


nhour[s] minutes or hours (for example: 5mins, 1hour, 2hours).
Applies only to schedules of type hourly and daily.

Group Management Commands 73


Parameter Description
max-keep n Maximum number of snapshot or replica collections created from the
schedule to retain (from 1 to 512). The default is 10.
If you reach the maximum limit, the oldest snapshot or replica
collection created from the schedule will be deleted before another is
created.

read-write|read-only Permission for snapshots created from the schedule

repeat-interval ndays Number of days between the creation of snapshot or replica


collections. Applies only to schedules of type daily.

start-date mm/dd/yy Month, day, and year that the schedule will start

start-time hh:mm[AM| Time when the schedule will start creating snapshot or replica
PM] collections. Use 24-hour time or specify AM or PM.

type schedule_type Type of schedule, either once, hourly, or daily

Subcommand
Subcommand Description
show Shows detailed information about the selected schedule

Examples
Change the time that snapshot collections of a volume collection are created with a schedule:

> collection select staffcol schedule select backup start-time 10:15PM

Show details about a replication collection schedule:

> collection select db2 schedule select hourly6 show


_____________ Volume Collection Schedule Information _____________
Name: hourly6 Type: hourly
AccessType: 1 Start-Date: 05/15/15
End-Date: None Start-Time: 12:00AM
End-Time: 12:00AM Frequency: 6hours
Repeat-Interval: Max-Keep: 10
NextCreation: Fri May 15 18:00:00 Desired Status: enable
2015 Status: enable

Select a schedule with a name that contains spaces for further operations:

> collection select ABVolCol schedule select "one time schedule"

groupA(collection_ABVolCol schedule_one time schedule)>

74 Group Management Commands


collection select schedule show
Shows the snapshot and replication collection schedules for the selected volume collection or shows
details about a specific schedule.

Format
collection select collection_name schedule show [schedule_name]

Variables
Variable Description
collection_name Name of a volume collection

schedule_name Name of a schedule to display. If the name contains spaces, enclose it


in quotation marks (for example schedule for daily backups).

Example
Show the snapshot and replication collection schedules for a volume collection:

> collection select dbcol schedule show

Name Interval DateRange TimeRange Frequency NextCreate


------ -------- --------- --------- --------- ----------
Daily daily 03/28/15-None 12:00AM-12:00AM Fri Apr 3 00:00:00 2015
______________________ Replication Schedules _____________________
Name Interval DateRange TimeRange NextCreate Partner
--------- -------- ------------ -------------- ----------- -----
Daily-Rep daily 03/28/15-None 06:00PM-06:00PM Fri Apr 3 rook
18:00:00 2015

collection select show


Shows detailed information about a volume collection.

Format
collection select collection_name show

Variable
Variable Description
collection_name Name of a volume collection

Example
Show information about a volume collection:

> collection select coll1 show

Group Management Commands 75


________________________ Volume Collection Information _______________________
Name: coll1 Description:
Type: not-replicated NoOfSnapcols: 0
ReplicationPartner:
______________________________________________________________________________
___________________________________ Volumes __________________________________
Name Size Snapshots Status Permission Connections
--------------- ---------- --------- -------- ---------- -----------
Jeff-0001 10GB 0 online read-write 1
Jeff-0002 10GB 0 online read-write 1
Jeff-0003 10GB 0 online read-write 1
__________________________________ Schedules _________________________________
Name Interval DateRange TimeRange Frequency NextCreate
--------- -------- ------------------- ---------------- --------- -----------
____________________________ Replication Schedules ___________________________
Name Interval DateRange TimeRange NextCreate Partner
--------- -------- ------------------- ---------------- ----------- ---------
__________________________________ Snapcols __________________________________
Name Snapshots Collection Schedule
------------------------------ ---------------- ------------ ------------

collection select sync-rep


Configures synchronous replication (SyncRep) settings for volume collections.

Format
collection select collection_name sync-rep subcommand

Variable
Variable Description
collection_name Name of a volume collection

Subcommands
Subcommand Description
disable Disables synchronous replication for the collection

enable Enables synchronous replication for the collection

failover [force] Changes the SyncActive pool and discards unreplicated changes
pool_name

show Displays information about synchronous replication

switch pool_name Changes the access pool

sync-active-offline Sets volumes in the collection offline and prevents connections to the
pool_name SyncActive pool

76 Group Management Commands


Examples

Displaying Synchronous Replication Information


Display information about synchronous replication for a collection. The output includes the synchronous
replication status, whether any changes are unreplicated, and the pools used, among other details.

> collection select kcoll sync-rep show

____________________ Volume Collection SyncRep Information ___________________


SyncReplStatus: In-sync SyncReplTxData: 0MB
SyncRepl Remaining TxData: 0MB SyncActive Pool: default
Unreplicated Changes: No Pools: default syncrep
SyncActive Offline: false
______________________________________________________________________________

Disabling Synchronous Replication


Set the volume collection offline for synchronous replication, and prevent access to the SyncActive pool
(the pool containing the source volumes; in this example, the default pool). This command does not
return any output.

> collection select kcoll sync-rep sync-active-offline default

Switching Synchronous Replication Pools


Switch the pools for a synchronous replication-enabled volume collection; that is, for all the volumes in
the collection and the collection itself, this command changes the SyncActive pool (currently, the default
pool) to be the SyncAlternate pool (currently, the pool named syncrep), and vice versa.

> collection select kcoll sync-rep switch syncrep

42282:33442:gigan34:MgmtExec:22-Mar-2015 14:
48:19.184755:syncReplSwitch.cc:1095:INFO:8.2.36:Successfully switched the Syn
cRep SyncActive pool to syncrep for volume kvol1.
42283:33443:gigan34:MgmtExec:22-Mar-2015 14:
48:19.214756:syncReplSwitch.cc:1095:INFO:8.2.36:Successfully switched the Syn
cRep SyncActive pool to syncrep for volume kvol2.
42284:33444:gigan34:MgmtExec:22-Mar-2015 14:
48:19.254757:syncReplSwitch.cc:1095:INFO:8.2.36:Successfully switched the
SyncRep Syn
cActive pool to syncrep for volume kvol3.

After the command completes, you can run the show command to see the new pool status. In the
following output, note that the SyncActive pool is now syncrep (originally, it was default):

> coll sel kcoll sync-rep show


____________________ Volume Collection SyncRep Information ___________________
SyncReplStatus: In-sync SyncReplTxData: 0MB
SyncRepl Remaining TxData: 0MB SyncActive Pool: syncrep
Unreplicated Changes: No Pools: default, syncrep
SyncActive Offline: false
______________________________________________________________________________

Group Management Commands 77


collection show
Shows all the volume collections in the group or detailed information about a specific collection.

Format
collection show [collection_name]

Variable
Variable Description
collection_name Name of a volume collection

Example
Show all the volume collections in the group:

> collection show

Name NoOfVolumes NoOfSnapcols


-------------------- ----------- -------------
hrcollection 2 0
dbcol 3 2

discover-devices
Discovers available, uninitialized NAS devices on the network.

Format
discover-devices

Example
> discover-devices

Product Type Service Tag Product Vendor Version


------------- ------------- ---------- --------- --------
nas 2L3KKQ1 FS7500 Dell V1.0.0
nas 2TC1BP1 FS7500 Dell V1.0.0
nas 2TC3BP1 FS7500 Dell V1.0.0
nas 2TD0BP1 FS7500 Dell V1.0.0
nas 2TD1BP1 FS7500 Dell V1.0.0
nas 2TF0BP1 FS7500 Dell V1.0.0
nas 2TF2BP1 FS7500 Dell V1.0.0
nas 2TH1BP1 FS7500 Dell V1.0.0
nas 2TH2BP1 FS7500 Dell V1.0.0
nas 3KLLBM1 FS7500 Dell V1.0.0
nas 4CQZFN1 FS7500 Dell V1.0.0
nas 5L3KKQ1 FS7500 Dell V1.0.0
nas 5R3KKQ1 FS7500 Dell V1.0.0
nas 5X3KKQ1 FS7500 Dell V1.0.0
nas 6L3KKQ1 FS7500 Dell V1.0.0
nas 7L3KKQ1 FS7500 Dell V1.0.0

78 Group Management Commands


nas 7R3KKQ1 FS7500 Dell V1.0.0
nas CBQZFN1 FS7500 Dell V1.0.0
nas FJLLBM1 FS7500 Dell V1.0.0
nas FX3KKQ1 FS7500 Dell V1.0.0
nas H9QZFN1 FS7500 Dell V1.0.0
nas HK3KKQ1 FS7500 Dell V1.0.0
nas HYCWFN1 FS7500 Dell V1.0.0
nas JJLLBM1 FS7500 Dell V1.0.0

domain-list show
Shows the domains in use for different types of users.

Format
domain-list show

Example
> domain-list show

Domain Name Domain Type


------------------------- --------------------
Bnas30 Local
NAS49 Local
groupNAS Active Directory
<nas12.com> UNIX

eula status
Displays the end-user license agreement (EULA) information for the PS Series group firmware and the
NAS firmware (if a NAS cluster is configured).

Format
eula status

Example
Display the end-user license agreement information for the group:

> eula status


__________________ PS Series array firmware EULA Information _________________
EULA Version: 2 Admin Account: grpadmin
Accepted On: 2015-02-25:12:21:07
______________________________________________________________________________
____________________ FluidFS NAS firmware EULA Information ___________________
EULA Version: 2 Admin Account: grpadmin
Accepted On: 2015-02-25:13:47:22
______________________________________________________________________________

Group Management Commands 79


failback
Manages failback operations for PS Series volumes.
For NAS replication failback, see nas-cluster select failback.

Failback is the third step in recovering replicated data from the secondary group when the primary group
is temporarily unavailable, either because of maintenance or failure:

1. Fail over to the secondary group. This step involves promoting the volumes inbound replica set to a
recovery volume. See partner select inbound-replicaset select promote.
2. Replicate to the primary group. After the primary group and the original volume become available,
this step involves demoting the original volume to a failback replica set and replicating the recovery
volume to the primary group. See volume select replicate-to-primary.
3. Fail back to the primary group. When you are ready to fail back, this step performs a final replication,
demotes the recovery volume to the original inbound replica set, and promotes the failback replica
set to the original volume.

All steps are performed on the secondary group in the volume replication configuration.

The replicate-to-primary step and the failback step include multiple tasks that must complete before you
can perform the next step.

You can start or stop failback operations, display in-progess and completed operations, or retry a failback
operation if an error occurs. Examine event messages to identify any problems. If a problem occurs,
correct it and retry the operation.

NOTE: You cannot perform failback operations on a template volume.

Format
failback subcommand

Subcommands
Subcommand Description
retry Retries a failback operation on a recovery volume

show Displays all in-progess and completed failback operations

start [manual-replica] Starts a failback operation on a recovery volume, optionally using


manual transfer replication

stop Stops a failback operation on a recovery volume

80 Group Management Commands


failback retry
Retries a failback operation that stopped due to an error in one of the tasks. The failback operation
continues from where it stopped.

Format
failback retry volume_name

Variable
Variable Description
volume_name Name of a recovery volume

Example
Retry a failback operation:

> failback retry vol1.1

Recovery volume vol1.1 is now replicating to the partner.


Successfully finished replicating volume 'vol1.1'.
Successfully created snapshot 'vol1.1-2015-07-31-09:37:53.7'
Volume successfully restored from snapshot 'vol1.1-2015-07-31-09:36:12.6'.
A new snapshot 'vol1.1-2015-07-31-09:37:53.7' was created from the volume
before the volume was restored.
Successfully created snapshot 'vol1.1-2015-07-31-09:37:53.8'
Recovery volume 'vol1.1' has been successfully demoted to a replica set.

failback show
Displays all failback operations. The output varies depending on whether operations are in progess or
complete.

Format
failback show

Examples
Display in-progess and completed failback operations:

> failback show

Volume InProgress StartTime Error


---------- --------------------- ------------------- ------------

vol01.1 recoveryVolume- 2015-06-17:17:13:14


FinalReplication
vol02.1 complete 2015-06-17:16:13:14

Group Management Commands 81


failback start
Starts a failback operation.
To start a failback operation, you must enter login credentials so that the secondary group can access the
primary group. Enter a valid group administrator account name and password for the primary group, or a
pool administrator account and password that has permission to manage the pool containing the original
volume.

Optionally, you can use manual transfer replication to perform the failback operation. See the Dell
EqualLogic Manual Transfer Utility Installation and Users Guide for more information.

Format
failback start [manual-replica] volume_name

Variable
Variable Description
volume_name Name of a recovery volume

Example
Start a failback operation on a recovery volume:

> failback start vol03.1

Enter user credentials for partner group1::


login: grpadmin
Password:
Task creation succeeded

failback stop
Stops an in-progess failback operation and deletes the task.

Format
failback stop volume_name

Variable
Variable Description
volume_name Name of a recovery volume

82 Group Management Commands


Example
Stop an in-progess failback operation:

> failback stop vol01.1

Task deletion succeeded

folder
Manages volume folders on the PS Series group.

Format
folder subcommand

Subcommands
Subcommand Description
create Creates a folder

delete Deletes a folder

rename Renames a folder

select Selects a folder

show Displays all folders for the group

folder create
Creates volume folders on the PS Series group.

Format
folder create folder_name [description text]

Variable
Variable Description
folder_name Name for the folder. Name can be up to 63 bytes and is case insensitive.
You can use any printable Unicode character except for ! " # $ % & ' ( ) *
+ , / ; < = > ?@ [ \ ] ^ _ ` { | } ~. First and last characters cannot be a
period, hyphen, or colon. Fewer characters are accepted for this field if
you enter the value as a Unicode character string, which takes up a
variable number of bytes, depending on the specific character.

Group Management Commands 83


Parameter
Parameter Description
description text Text for the folder description, up to 127 characters. If the description
includes spaces, enclose it in quotation marks.
Fewer characters are accepted for this field if you enter the value as a
Unicode character string, which takes up a variable number of bytes,
depending on the specific character.

Example
Create a folder with a description:

> folder create fold01 desc "My volumes"

See Also
To add volumes to a folder, see folder select volume.

folder delete
Deletes volume folders on the PS Series group. Deleting a folder does not delete the volumes in that
folder.

Format
folder delete folder_name

Variable
Variable Description
folder_name Name of the folder to delete

Example
Delete a folder:

> folder delete fold01

folder rename
Renames a volume folder on the PS Series group.

Format
folder rename current_name new_name

84 Group Management Commands


Variables
Variable Description
current_name Current name of the folder

new_name New name for the folder.


Name can be up to 63 bytes and is case insensitive. You can use any
printable Unicode character except for ! " # $ % & ' ( ) * + , / ; < = > ?@
[ \ ] ^ _ ` { | } ~. First and last characters cannot be a period, hyphen, or
colon. Fewer characters are accepted for this field if you enter the value
as a Unicode character string, which takes up a variable number of
bytes, depending on the specific character.

Example
Rename a folder:

> folder rename old-folder new-folder

folder select
Selects volume folders for additional operations.

Format
folder select folder_name [description text] | subcommand

Variable
Variable Description
folder_name Folder names are not case sensitive. For example, folder01 and
FOLDER01 are treated as the same name.

Parameter
Parameter Description
description text Description for the folder, up to 127 characters. If the description
includes spaces, enclose it in quotation marks.
Fewer characters are accepted for this field if you enter the value as a
Unicode character string, which takes up a variable number of bytes,
depending on the specific character.

Group Management Commands 85


Subcommands
Subcommand Description
inbound-replicaset Manages inbound replica sets in the folder

remove-all Removes all volumes from the folder. Does not delete the volumes or
the folder itself.

show Displays information about a folder

volume Manages volumes in the folder

Example
Add a description for a folder:

> folder select MyVolumes description "volumes I created today"

See Also
To add volumes to a folder, see folder select volume.

folder select inbound-replicaset


Manages inbound replica sets in a folder.

Format
folder select folder_name inbound-replicaset subcommand

Variable
Variable Description
folder_name Name of the folder

Subcommands
Subcommand Description
add inbound_replicaset Adds the specified inbound replica set to the folder

remove Removes the specified inbound replica set from the folder
inbound_replicaset

Example
Add an inbound replica set to a folder:

> folder select MyVolumes inbound-replicaset add kvol1.2

86 Group Management Commands


folder select remove-all
Removes all volumes from the folder.
This command does not delete the volumes or the folder.

Format
folder select folder_name remove-all

Variable
Variable Description
folder_name Name of the folder from which to remove volumes

Example
Remove all the volumes from a folder:

> folder select fold15 remove-all

folder select show


Displays the contents of a folder.

Format
folder select folder_name show

Variable
Variable Description
folder_name Name of the folder

Example
Display details about a folder:

> folder select fold01 show


__________________________ Volume Folder Information _________________________
Name: fold01 Description: my volumes
______________________________________________________________________________

___________________________________ Volumes __________________________________


Name Size Snapshots Status Permission Connections
--------------- --------- --------- ------- ---------- -----------
kvol1 100MB 0 online read-write 0

Group Management Commands 87


folder select volume
Manages volumes in a folder.

Format
folder select folder_name volume subcommand

Variable
Variable Description
folder_name Name of the folder

Subcommands
Subcommand Description
add volume_name Adds the specified volume to the folder

remove volume_name Removes the specified volume from the folder

Example
Add a volume to a folder:

> folder select MyVolumes volume add kvol1

folder show
Display all folders for a group.

Format
folder show

Example
Display all folders on the group:

> folder show


Name Volume Count Description
----------------------------------- --------------- -------------------------
sync 2
docvols 2

88 Group Management Commands


grpparams
Sets or shows group parameters. Any changes to groupwide parameters for volumes, such as thin-
provisioning settings and snapshot reserve, apply only to new volumes.
NOTE: If a parameter accepts multiple values (for example, multiple IP addresses), you must
separate each value with a comma and no space.

Unless otherwise specified, to remove a list, location, or address, enter two quotation marks ().

Format
grpparams parameter | show

Parameters
Parameters Description
cliaccess-ssh Enables (default) or disables the SSH service running on the group.
Optionally disables the default SSH version 1 protocol for increased
security.

cliaccess-telnet Enables (default) or disables the telnet service running on the group

conn-balancing Enables (default) or disables iSCSI connection load balancing across


group members

crypto-legacy- Enables (default) or disables the use of legacy encryption protocols in


protocols the group

date Sets the group date (month, day, and year)

dcb Enables or disables data center bridging (DCB) for all network interfaces
in the group

dcb def-vlan-id Sets the default VLAN ID for Ethernet interfaces to receive data center
bridging (DCB) control packets. The ID must be a number from 0
through 4095.

default-snapshot-sched Enables (default) or disables the creation of volume snapshots using the
default snapshot schedule

default-snapshot- Displays the current settings for the default snapshot schedule
sched show

default-snapshot- Specifies the starting time for the default snapshot schedule
sched start-time

def-iscsi-alias Specifies the groupwide default for whether the volumes iSCSI target
alias (public name) is set to the internal volume name. Also applies to
volume snapshots. Default is yes.

def-mgmt-gateway Configures or removes the default gateway for the group (IPv4 only)

Group Management Commands 89


Parameters Description
def-sector-size 4096| Configures the default sector size for volumes: either 512 bytes or 4096
512 bytes per sector

def-snap-borrow Enables or disables snapshot space borrowing for the group

def-snap-depletion Specifies the groupwide default snapshot reserve recovery policy.


Applies only to new volumes.

def-snap-reserve Specifies the groupwide default for the amount of space, as a


percentage of the volume reserve, to reserve for volume snapshots.
Applies only to new volumes. Default (and maximum) is 100%.

def-snap-warn Specifies the groupwide default for the threshold at which an alarm
occurs because the amount of free reserved snapshot space has fallen
below this value (as a percentage of total reserved snapshot space).
Applies only to new volumes. Default is 10%.

def-thin-growth-max Specifies the groupwide default for the maximum percentage of the
reported volume size that can be in use for a new thin-provisioned
volume. When in-use space reaches this limit, the volume will be set
offline. Default is 100%.

def-thin-growth-warn Specifies the groupwide default for the percentage of the reported
volume size that, when reached by in-use space, creates a warning
alarm and event message for a new thin-provisioned volume. Default is
60%.

description Specifies the group description, up to 63 ASCII characters. If the


description contains spaces, enclose it in quotation marks.

disallow-downgrades Disallows PS Series firmware downgrades on all members in the group.


Not allowing downgrades prevents a group from reverting to a previous
firmware version.

discovery-use-chap Allows or prevents (default) unauthorized hosts from connecting to


targets that are authenticated only with CHAP

dns-server-list Specifies up to three IP addresses for Domain Name servers (DNS)

dns-suffix-list Comma-separated list of DNS suffixes

email-contact Enables customer support and the specified local address to receive
email notification of firmware updates and hardware failures

email-from Specifies the email address to be used as the From address in email
notification messages. Up to 127 ASCII characters

email-list Specifies up to five email addresses to receive event notifications

email-notify Enables or disables (default) email notification

ftp-service Enables (default) or disables the FTP server on the group. When
disabled, prevents FTP file transfers to and from the group.

90 Group Management Commands


Parameters Description
group-ipaddress Specifies the group IP address in IPv4 format

group-ipv6address Specifies the group IP address in IPv6 format

info-messages Enables (default) or disables broadcasting live, real-time informational


messages to the console and the Group Events window in the GUI

iscsi-local-auth When authenticating host iSCSI access to volumes, enables (default) or


disables using local CHAP accounts. If enabled, the local accounts are
used before any RADIUS accounts.

iscsi-radius-auth Enables or disables (default) the use of external RADIUS authentication


servers for authenticating host iSCSI access to volumes

isns-server-list Specifies up to three IP addresses (with optional port) for iSNS servers

location Specifies the physical location of the group, up to 63 ASCII characters.


Default is default.

login-radius-acct Enables or disables (default) the use of external RADIUS accounting


servers for tracking group administration accounts that are
authenticated with external RADIUS authentication servers

login-radius-attr Enables (default) or disables requiring a RADIUS authentication server to


supply the EQL-Admin attribute when authenticating group
administration accounts

login-radius-auth Enables or disables (default) the use of external RADIUS authentication


servers for authenticating group administration accounts

management-network Configures or displays a management address for the group

name Sets the group name, which identifies the group, especially for
expansion and replication purposes

ntp-server-list Specifies up to three IP addresses (with optional port) for NTP servers

passwd Sets the password for adding members to the group. Do not specify the
password on the command line. You will be prompted for it.

perf-balancing Enables (default) or disables performance balancing

protocol-endpoint Shows access to the protocol endpoint


access show

radius-acct-list Specifies up to three IP addresses (with optional port) for RADIUS


accounting servers

radius-acct-retries Specifies the number of times the group will try to contact a RADIUS
accounting server after the first try fails. The default is 1 retry.

radius-acct-secrets Specifies up to three secrets (passwords), separated by commas and no


spaces, for RADIUS accounting servers. The order of the secrets must
be the same as the order of the corresponding accounting servers. The
maximum secret length is 63 characters.

Group Management Commands 91


Parameters Description
radius-acct-timeout Specifies the number of seconds the group will wait for a RADIUS
accounting server to respond. The default is 2 seconds.

radius-auth-list Adds one to three IP addresses (with optional port) for external RADIUS
authentication servers

radius-auth-retries Specifies the number of times the group will try to contact a RADIUS
authentication server after the first try fails. The default is 1 retry.

radius-auth-secrets Adds one to three secrets (passwords), separated by commas and no


spaces, for RADIUS authentication servers. The order of the secrets
must be the same as the order of the corresponding authentication
servers. The maximum secret length is 63 ASCII characters.

radius-auth-timeout Specifies the number of seconds the group will wait for a RADIUS
authentication server to respond. The default is 2 seconds.

session-banner Enables or disables the display of a login session banner

session-idle-timeout Enables or disables (default) the idle timeout value for a login session,
and optionally sets the length of time for the timeout value

smtp-server-list Specifies up to three IP addresses (with optional port) for SMTP (Simple
Mail Transfer Protocol) servers

snmp Manages SNMP (Simple Network Management Protocol) for the group

standby-button Enables or disables (default) the standby button for all members (arrays)
in the group that support this feature (PS4100 or PS6100 array models)

syslog-notify Enables or disables remote syslog notification

syslog-server-list Specifies up to three IP addresses for remote syslog event logging

target-auth-password Specifies the CHAP password for target authentication

target-auth-username Specifies the CHAP user name for target authentication

thermal-shutdown Enables (default) or disables the thermal shutdown feature for all
members in the group that support this feature (PS4100 or PS6100 array
models)

time Sets the group time

timezone Specifies the time zone using a country/city designation. The default is
America/New_York.

vss-vds Manages basic access points for Microsoft service access to the group

webaccess Enables (default) or disables standard web access (port 80) to the GUI

webaccess-noencrypt Enables (default) or disables the ability to use a web connection to the
GUI that is not encrypted with SSL

92 Group Management Commands


Subcommand
Subcommand Description
show [list] Shows the complete group configuration details or a specific list of
configured servers.

grpparams cliaccess-ssh
Enables or disables the SSH service.
This command has two functions:

By itself, enables (default) or disables the SSH service running on the group. Disabling the SSH service
prevents any SSH access to the group or a group member.
With the v1-protocol option, enables (default) or disables the SSH v1 protocol. You can disable V1 and
use only the v2 protocol, if your security considerations require it.
Recommendation Unless you need to use older SSH clients that do not support the protocols
currently recognized as the best security practices, Dell recommends disabling the v1 protocol.

NOTE: The commands grpparams crypto-legacy-protocols and grpparams cliaccess-ssh work


together. If you disable the cliaccess-ssh v1-protocol attribute, you might also want to
disable the crypto-legacy-protocols attribute. See grpparams crypto-legacy-protocols.

Formats
grpparams cliaccess-ssh enable|disable
grpparams cliaccess-ssh v1-protocol enable|disable

Examples
Disable SSH service:

> grpparams cliaccess-ssh disable

Disable the SSH v1 protocol. SSH access uses the v2 protocol instead.

> grpparams cliaccess-ssh v1-protocol disable

When SSH v2 protocol is enabled on the group, the grpparams show display looks similar to the following
output. See the bolded lines in the example (output has been edited for brevity).

______________________________ Group Information _____________________________


Name: thegrp Group-Ipaddress: 192.0.2.20
Def-Snap-Reserve: 100% Def-Snap-Warn: 10%
Def-Snap-Depletion: delete-oldest Def-Thin-Growth-Warn: 60%
Def-Thin-Growth-Max: 100% DateAndTime: Tue Jun 23 11:24:13 2015
TimeZone: America/New_York Description:
Def-Iscsi-Prefix: Def-Iscsi-Alias: yes
iqn.2002-10.com.mycompany Info-Messages: enabled
Webaccess: enabled Webaccess-noencrypt: enabled
Cliaccess-SSH: enabled Cliaccess-Telent: enabled
Email-Notify: disabled Syslog-Notify: disabled
iSNS-Server-List: Email-List:
NtpServers: Smtp-Server-List:

Group Management Commands 93


DNS-Server-List: 192.0.2.53 DNS-Suffix-List: spark.com
Syslog-Server-List: Target-Auth-UserName:
Target-Auth-Password: hJZj2RPXrPrHjPR2
H8hJ2jBZpX8X2HPX Email-From:
Location: default Conn-Balancing: enabled
Discovery-Use-Chap: disabled Email-Contact:
Perf-balancing: enabled Disallow-Downgrades: yes
Management-Ipaddress: SSH-V1-Protocol: disabled
FTP-service: enabled Standby-Button: disabled
DCB: enabled Def-DCB-VLAN-Id: 2
Thermal-Shutdown: enabled Crypto-Legacy-Protocols: enabled
Volume-Recovery: enabled Session-Idle-Timeout: 30
Session-Idle-Timeout-Enable: disabled Session-Banner-Enable: disabled
Def-Snapshot-Borrow: enabled Def-Sector-Size: 512

grpparams cliaccess-telnet
Enables or disables CLI access through telnet.

Format
grpparams cliaccess-telnet enable|disable

Example
Enable CLI access through telnet:

> grpparams cliaccess-telnet enable

grpparams conn-balancing
Enables (default) or disables iSCSI connection load balancing across group members.

Format
grpparams conn-balancing enable|disable

Example
Disable connection load balancing:

> grpparams conn-balancing disable

grpparams crypto-legacy-protocols
Enables (default) or disables the use of legacy encryption protocols and authentication algorithms.
You must use the CLI to change the encryption protocols for the group; this functionality is not available
through the GUI.

The group supports security protocols SSL/TLS and SSH, with a range of encryption algorithms. The
protocols and algorithms enabled by default include some older protocols (such as SSH v1 and SSL v2)
and encryption algorithms (such as DES) that are no longer recommended as best security practices.

94 Group Management Commands


Recommendation For best security, disable the legacy protocols and algorithms unless you need to
enable access from older clients (web browsers or SSH clients) that do not support the current
encryption protocols and authentication algorithms.

Disabling legacy protocols causes the group to reject all certificates using encryption keys of fewer than
2048 bits. For example, when you log in to the GUI using https, the group warns that the certificate has
changed. When you log in to the CLI using SSH, the group might display a warning about the key. You
might need to remove the old key from the host, and accept a new key signature.

Disabling legacy protocols affects the key length allowed for certificates used with IP security. For more
information, see ipsec certificate.

NOTE: The commands grpparams crypto-legacy-protocols and grpparams cliaccess-ssh work


together to allow you to disable the legacy protocols and encryption algorithms. If you disable the
crypto-legacy-protocols attribute, you should also disable the cliaccess-ssh v1-
protocol attribute. See grpparams cliaccess-ssh.

Format
grpparams crypto-legacy-protocols enable|disable

Example
Disable the use of legacy encryption protocols and authentication algorithms in the group:

> grpparams crypto-legacy-protocols disable

See Also
grpparams cliaccess-ssh
ipsec certificate

grpparams date
Sets the date for the group members.
NOTE: The date is assumed to be 2000 or later. You must enter a two-digit number for the year.

Format
grpparams date mm/dd/yy

Variable
Variable Description
mm/dd/yy Month (mm), day of month (dd), and year (yy)

Example
Set the date for the group members:

> grpparams date 08/13/15

Group Management Commands 95


grpparams dcb
Enables or disables data center bridging (DCB) for all network interfaces in the group. Data center
bridging is enabled by default.
To use DCB, all group members must be running version 5.1 or higher of the PS Series firmware.
Additionally, DCB applies only to arrays capable of operating at 10G Ethernet speeds and above.
Therefore, only Dell EqualLogic 10GbE PS Series arrays are capable of using DCB.

Format
grpparams dcb enable|disable

Example
Enable data center bridging for the group:

> grpparams dcb enable

grpparams dcb def-vlan-id


Sets the default virtual LAN (VLAN) ID for iSCSI interfaces to receive data center bridging (DCB) control
packets.

Format
grpparams dcb def-vlan-id n

Variable
Variable Description
n VLAN ID for iSCSI interfaces. The ID ust be a number from 0 through
4095.

Example
Set the VLAN ID:

> grpparams dcb def-vlan-id 2365

grpparams default-snapshot-sched
Enables (default) or disables the creation of volume snapshots using the default snapshot schedule (DSS).
The schedule runs once a day to create read-only snapshots of any eligible unprotected volumes in a
group on an array.
The default snapshot schedule is enabled by default. Disabling the schedule prevents snapshots from
being created by the schedule. Enabling the schedule after it has been disabled resumes the use of the
schedule to create snapshots. Only a group administrator can disable or reenable the schedule

96 Group Management Commands


To display the current settings for the default snapshot schedule, see grpparams default-snapshot-sched
show.

System Information
The default snapshot schedule is available as of PS Series firmware version 8.0. When the system is
updated, the default snapshot schedule is enabled automatically.

A PS Series group can have a maximum of 1024 custom snapshot schedules. The default snapshot
schedule does not reduce the number of available schedules (meaning that all 1024 schedules could be
defined and the default schedule will still be added).

The schedule covers all eligible volumes in a group. (Schedule parameters cannot be modified on a per-
volume basis.) When a volume is created, the group administrator does not need to explicitly associate
the volume to the schedule; the association happens automatically.
To be eligible for the default snapshot schedule, a volume must meet the following criteria:

Snapshot reserve is not set to zero (0)


Does not already have a snapshot or an enabled snapshot schedule associated with it
Does not have an online snapshot that was generated by the default snapshot schedule
Is not one of these types: replica set, failback replica set, deleted (in the recovery bin), NAS, control
(PE/VSS-VDS), shared (VVol), read-only, template

The group can support a maximum of 10,000 snapshots, and DSS-created snapshots are included in that
number. Snapshots created by the schedule are offline, read-only, and otherwise identical to traditional
snapshots. DSS-created snapshots follow standard compression rules and, in most cases, will not be
trimmed.

Recommendations
The default snapshot schedule is used primarily to create snapshots of volumes to which a traditional
snapshot schedule was never explicitly associated. Associating a snapshot schedule with a volume when
the volume is created provides a level of data protection that could save the group from losing data. If
volumes become corrupt, the group administrator can restore data from the most current snapshot.

Dell recommends that any volume whose data can be written, and therefore corrupted, should be
protected against data loss using the PS Series snapshot schedule mechanism. The default snapshot
schedule unobtrusively enforces this recommendation.

CAUTION: Although the purpose of DSS-created snapshots is to protect volume data against
write corruption, the schedule should not be used as a replacement for the existing snapshot
schedule mechanism. The default snapshot schedule provides an additional safeguard against
rare instances of data corruption, but it is intended solely as a disaster-recovery mechanism and
should not be relied on as the only data-protection strategy for the group.

Schedule Operation
While the default snapshot schedules execution is designed to use minimal system resources, it should
be run at a time of day when it will least affect usage load. To set the starting time for the schedule, see
grpparams default-snapshot-sched start-time.

Group Management Commands 97


The schedule draws on unused snapshot reserve space to create snapshots, and adjusts its behavior to
minimize the use of available storage when free space falls below a certain threshold. By default, the
schedule keeps two snapshots for each volume, which offers 24 hours of protection. However, if free
space for any pool on the group is less than or equal to 15 percent, the maximum number of snapshots
kept by the schedule (max-keep) drops to 1. When max-keep changes to 1, a warning message appears in
the Alarms window of the Group Manager GUI.

The max-keep value stays at 1 until at least the next time the schedule runs, when pool free space is
calculated again. If the amount of free space at that point is greater than 15 percent for all pools, max-
keep returns to the default value of 2.

To process multiple volumes, the schedule repeatedly resubmits itself to the snapshot schedule queue,
and yields for 5 seconds after each snapshot is created or after encountering 10 successive ineligible
volumes. The time it takes the DSS to create snapshots for all volumes in a group depends on the number
of eligible volumes in that group. In general, the DSS will complete its processing of all volumes within 5
minutes (though systems at or near the maximum number of allowed volumes could take up to 2.5
hours).

When to Disable the Default Snapshot Schedule


Only the group administrator can disable the default snapshot schedule. An admin might want to disable
the schedule in the following situations:

If current snapshot schedules are providing adequate coverage


If volumes are being replicated

When the schedule is disabled, the system asks about deleting all of the existing snapshots that were
created by the schedule. The default is to not delete snapshots, and snapshots are not deleted if CLI
echoing is turned off. Deleted snapshots cannot be undeleted.

Format
grpparams default-snapshot-sched enable|disable

Parameters
Parameters Description
enable|disable Enables or disables the default snapshot schedule

Examples
Disable the default snapshot schedule:

> grpparams default-snapshot-sched disable

Delete all snapshots generated by the default snapshot schedule? [y/n] [n] y
Are you sure? [y/n] [n] y

127 snapshots deleted.

Default snapshot schedule has been disabled.

98 Group Management Commands


Enable the default snapshot schedule after it has been disabled:

> grpparams default-snapshot-sched enable

Default snapshot schedule has been enabled.

grpparams default-snapshot-sched show


Shows information about the default snapshot schedule currently enabled for the group.
The command displays the following settings for the schedule:

Name Always Default


Type Always daily
AccessType Always read-only
Start-Date The date that the schedule last started
End-Date Always None
Start-Time The time that the schedule begins running. The default is midnight, but you can specify
a different time (see grpparams default-snapshot-sched start-time).
Repeat-Interval Always 1 day
Max-Keep The maximum number of snapshots kept for each volume. Either 1 or 2. The default is 2.
(See grpparams default-snapshot-sched for more information.)
NextCreation Next date and time that the schedule will run
Desired Status Always enabled, which is the default status for the schedule
Status Enabled or disabled

For more information about the default snapshot schedule, see grpparams default-snapshot-sched.

Format
grpparams default-snapshot-sched show

Example
Display the current settings for the default snapshot schedule for the group:

> grpparams default-snapshot-sched show

________________________ Schedule Information _____________________


Name: **Default** Type: daily
AccessType:read-only Start-Date: 03/24/15
End-Date: None Start-Time: 12:00AM
Repeat-Interval: 1day Max-Keep: 2
NextCreation: Wed Mar 25 00:00:00 2015
Status: enabled Desired status: enabled

grpparams default-snapshot-sched start-time


Specifies the starting time for the default snapshot schedule to run.
For more information about the default snapshot schedule, see grpparams default-snapshot-sched.

Group Management Commands 99


Format
grpparams default-snapshot-sched start-time hh:mm[AM|PM]

Variable
Variable Description
hh:mm[AM|PM] Time when the default snapshot schedule will start creating snapshots
of eligible volumes. Use 24-hour time or specify AM or PM. The default
is midnight.

Examples
Specify the starting time for the default snapshot schedule to run:

> grpparams default-snapshot-sched start-time 11:30PM

grpparams def-iscsi-alias
Specifies whether volumes will automatically use the volume name as the iSCSI target alias. (Using an
alias is optional.)
The default is to use the volume name (yes). If you do not use the volume name (no), you must manually
specify an alias for the volume.

Changing the groupwide setting does not change the settings for current volumes. You can override the
groupwide setting for a specific volume by using the volume create command or the volume select
command.

Format
grpparams def-iscsi-alias yes|no

Example
Prevent volume names from being used automatically as the iSCSI target alias:

> grpparams def-iscsi-alias no

grpparams def-mgmt-gateway
Sets or deletes the default management gateway for the group that uses a dedicated management
network.
The management gateway applies to all the configured management interfaces.

You must add a management address to the group. See grpparams management-network.

Format
grpparams def-mgmt-gateway [ipaddress ip_address | none]

100 Group Management Commands


Parameters
Parameter Description
ipaddress ip_address Sets the default gateway for the management network for the group
and the configured management interfaces on all members

none Deletes the default management gateway for the group

Example
Set the default management gateway for the group:

> grpparams def-mgmt-gateway ipaddress 192.0.2.21

grpparams def-sector-size
Sets the default sector size for new volumes: either 512 bytes (the default) or 4096 bytes (4K-bytes).
You can create volumes that use either 512-byte or 4K-byte sectors. The sector size of a volume does
not depend on the sector size of the physical drives in the members. The default volume setting of 512
bytes is almost always optimal, even if the physical drives use 4K-byte sectors.

Before you create a volume that uses 4K-byte sectors, verify that your operating system supports 4K-byte
sectors. You cannot change the sector size of a volume after it is created. Refer to the documentation for
your operating system for information about whether 4K-byte sectors are supported.

Format
grpparams def-sector-size 512|4096

Example
Set the default sector size for the group to 4K-bytes:

> grpparams def-sector-size 4096

grpparams def-snap-borrow
For new volumes, enables or disables the ability to borrow from free space to create snapshots.
Changing the groupwide setting does not change the settings for current volumes.

You can override the groupwide setting for a specific volume by using the volume create command or
the volume select command.

Format
grpparams def-snap-borrow enable|disable

Group Management Commands 101


Example
Set the groupwide default to allow volumes to borrow from free space to create snapshots:

> grpparams def-snap-borrow enable

grpparams def-snap-depletion
Specifies a groupwide default space recovery policy for new volumes.
For new volumes, specifies one of the following groupwide default space recovery policies when no
more snapshot reserve is available:

Delete the oldest snapshot until enough space is recovered (default)


Set the volume and its snapshots offline

Changing the groupwide setting does not change the settings for current volumes.

You can override the groupwide setting for a specific volume by using the volume create command or
the volume select command.

Format
grpparams def-snap-depletion delete-oldest|volume-offline

Parameters
Parameter Description
delete-oldest Deletes the oldest snapshots until enough space is recovered. This
action is the default.

volume-offline Sets the volume and its snapshots offline

Example
Set the groupwide default to set volumes and their snapshots offline when the reserved snapshot space
has been used:

> grpparams def-snap-depletion volume-offline

grpparams def-snap-reserve
Specifies the groupwide default for new volumes for the amount of space, as a percentage of the volume
reserve, to reserve for volume snapshots.
The default is 100 percent of the volume reserve.

Changing the groupwide setting does not change the settings for current volumes.

You can override the groupwide setting for an individual volume by using the volume create command or
the volume select command.

102 Group Management Commands


Format
grpparams def-snap-reserve n%

Variable
Variable Description
n Percentage of the volume reserve to reserve for snapshots

Example
Set the groupwide default for reserved snapshot space. You must include the percent sign (%).

> grpparams def-snap-reserve 120%

grpparams def-snap-warn
Specifies the groupwide default threshold at which an alarm occurs when the amount of free reserved
snapshot space is less than this threshold, specified as a percentage of the total reserved snapshot space.
Applies only to new volumes.
The default is 10 percent of the total reserved snapshot space for a volume.

Changing the groupwide setting does not change the settings for current volumes.

You can override the groupwide setting for an individual volume by using the volume create command or
the volume select command.

Format
grpparams def-snap-warn n%

Variable
Variable Description
n Percentage of reserved space for the threshold. If free reserved space
falls below this value, a warning occurs.

Example
Set the groupwide default for the free snapshot space warning threshold. You must include the percent
sign (%).

> grpparams def-snap-warn 20%

Group Management Commands 103


grpparams def-thin-growth-max
Specifies the groupwide default for new thin-provisioned volumes for the maximum percentage of the
reported volume size that can be in use.
The default is 100 percent. If the maximum in-use space value is less than 100 percent and an initiator
write exceeds this limit, the write fails, and the group sets the volume offline and generates event
messages.

If the maximum in-use space value is 100 percent and an initiator write exceeds this limit, the volume is
not set offline. However, the write fails, and the group generates event messages.

Changing the groupwide setting does not change the settings for current volumes.

You can override this value on a specific thin-provisioned volume by using the volume create command
or the volume select thin-growth-max command.

Format
grpparams def-thin-growth-max n%

Variable
Variable Description
n Maximum percentage of the reported volume size that can be in use for
a thin-provisioned volume

Example
Set the groupwide default for the maximum percentage of the volume size that can be in use for a thin-
provisioned volume. You must include the percent sign (%).

> grpparams def-thin-growth-max 90%

grpparams def-thin-growth-warn
Specifies the groupwide default for new thin-provisioned volumes for the in-use space warning limit.
When the in-use space reaches this value, as a percentage of reported volume size, a warning occurs.
The default is 60 percent.

Changing the groupwide setting does not change the settings for current volumes.

You can override this value on a specific thin-provisioned volume by using the volume create command
or the volume select thin-growth-warn command.

Format
grpparams def-thin-growth-warn n%

104 Group Management Commands


Variable
Variable Description
n Sets the amount of in-use space, as a percentage of the reported
volume size, at which an event occurs for a thin-provisioned volume

Example
Set the groupwide default for the in-use space warning limit. You must include the percent sign (%).

> grpparams def-thin-growth-warn 75%

grpparams description
Sets the group description. To remove a description, enter two quotation marks ().

Format
grpparams description text

Variable
Variable Description
text Group description, up to 63 ASCII characters. If the text contains
spaces, enclose it in quotation marks.

Example
Add a group description:

> grpparams description "Testing Group

grpparams disallow-downgrades
Prevents group members from reverting to a previous PS Series firmware version.
In some cases, you must run this command to use new features in the installed firmware or to perform
replication.

You can use this command only once on a group. If you later try to use the update command (see
update) to install a previous firmware version on a member, the operation will fail.

Make sure you are connected to the group IP address (or dedicated management address) when running
this command.

Prevent all the group members from returning to a firmware version earlier than v5.0.

Format
grpparams disallow-downgrades

Group Management Commands 105


Example
Prevent the group from reverting to a previous firmware version:

> grpparams disallow-downgrades

grpparams discovery-use-chap
Allows or prevents (default) the discovery of targets by iSCSI initiators for which the initiators are not
authorized.
If you do not prevent target discovery, initiators that support discovery will try to log in to a target, even if
they do not have the correct access credentials. The attempted logins will result in a large number of
events logged in the group and an inefficient use of resources.

Format
grpparams discovery-use-chap enable|disable

Example
Prevent unauthorized hosts from discovering volumes that are authenticated only with CHAP:

> grpparams discovery-use-chap enable

grpparams dns-server-list
Specifies from one to three IP addresses for Domain Name servers (DNS).
To change a server in the DNS server list, you must enter the IP addresses on the command line.

To remove all servers from the list, enter two quotation marks ().

Format
grpparams dns-server-list ip_address

Variable
Variable Description
ip_address Comma-separated list of up to three IP addresses. For example:
192.0.2.23,[fc00::7447:b795:6ba7:28f1],192.0.2.35

Example
Add two DNS servers for the group:

> grpparams dns-server-list 192.0.2.25,192.0.2.33

106 Group Management Commands


grpparams dns-suffix-list
Specifies a list of suffixes for Domain Name servers (DNS).

Format
grpparams dns-suffix-list suffix

Variable
Variable Description
suffix Comma-separated list of one to three DNS suffixes. For example:
companyA.com,companyB.com,companyC.com

Example
Add two DNS suffixes for the group:

> grpparams dns-suffix-list company1.com,company2.com

grpparams email-contact
Enables Email Home, which sends notification of firmware updates and hardware failures to customer
support and the specified local address.
You must specify an SMTP server or email relay for any type of email notification (see grpparams smtp-
server-list). You can also specify a sender address for the notification messages (see grpparams email-
from).

Format
grpparams email-contact email_address

Variable
Variable Description
email_address Email address of the recipient

Example
Enable Email Home and configure the specified email address to receive notification. (Customer support
also receives notifications.)

> grpparams email-contact me@myemail.com

Group Management Commands 107


grpparams email-from
Specifies the email address to be used as the From address in email notification messages sent by the
group, including Email Home notification. Specifying an address prevents email programs from rejecting
the notification messages.
To configure email notification, see grpparams email-list, grpparams email-notify, and grpparams smtp-
server-list.

Format
grpparams email-from email_address

Variable
Variable Description
email_address Email address of the sender

Example
Add an email address to be used as the From address in email event notification messages:

> grpparams email-from admin@customer.com

grpparams email-list
Specifies one to five email addresses to receive email notification of events.
When you enable email notification, by default events with a fatal, error, or warning priority result in
notification, unless you specify different priorities with the alerts command (see alerts).

To configure email event notification, you must enable email notification and specify an SMTP server or
email relay. See grpparams email-notify and grpparams smtp-server-list. In addition, you can specify a
sender address for the notification messages. See grpparams email-from.

Format
grpparams email-list email_address[,email_address,...]

Variable
Variable Description
email_address One to five addresses, separated by a comma and no space. To change
an email address, you must reenter all the addresses (old and new) on
the command line.
To remove all addresses from the list, enter two quotation marks ().

108 Group Management Commands


Example
Add two email addresses to receive notification of events:

> grpparams email-list admin8@cust.com,abc@mymail.com

grpparams email-notify
Enables or disables (default) email notification.
NOTE: Email notification is not the same as the Email Home feature. Email Home sends email to the
support provider for your array. Email notification configures the group to send email about group
events to recipients of your choosing. For more information about these features, see the Dell
EqualLogic Group Manager Administrator's Guide.

To receive email event notification, you must specify one or more email addresses to receive messages
and an SMTP server or email relay. See grpparams email-list and grpparams smtp-server-list. In addition,
see grpparams email-from to specify a sender address for the notification messages.

Format
grpparams email-notify enable|disable

Example
Enable email notification:

> grpparams email-notify enable

grpparams ftp-service
Enables (default) or disables the FTP server running on the group.
Disabling the server prevents FTP file transfers to and from the group. Preventing these transfers provides
enhanced security for those organizations that require it.

NOTE: To retrieve NAS cluster diagnostics, FTP service must be enabled on the cluster. See nas-
cluster select ftp-service.

Format
grpparams ftp-service enable|disable

Example
Disable FTP service to the group:

> grpparams ftp-service disable

Group Management Commands 109


grpparams group-ipaddress
Changes the group IP address, which is used for group administration (unless you configure a dedicated
management network) and iSCSI initiator access to volumes, in Internet Protocol version 4 (IPv4) format.
If you modify the group IP address and the group is configured as a replication partner, make sure the
replication partner is notified of the change. In other words, make sure the IP address stored on the
replication partner is changed to match the new group IP address.

NOTE: Modifying the group IP address disconnects group management sessions and iSCSI
discovery sessions. If you modify the group IP address and initiators are configured statically with
the group IP address, you might need to update the iSCSI initiators with the new information.
However, if initiators are finding targets dynamically (for example, through iSNS), they can
rediscover the targets.

Format
grpparams group-ipaddress ip_address|none

Variable
Variable Description
ip_address|none Group IP address. To delete the group IP address, specify none.

NOTE: You cannot delete an IPv4 group IP address unless the


group has an IPv6 group IP address configured. See grpparams
group-ipv6address.

Example
Change the IP address for the group:

> grpparams group-ipaddress 192.0.2.29

grpparams group-ipv6address
Specifies the group IP address, which is used for group administration (unless you configured a dedicated
management network) and iSCSI initiator access to volumes, in Internet Protocol version 6 (IPv6) format.
A group can have both an IPv4 address and an IPv6 address.

Understanding IPv6 Addresses


The IPv6 format is the successor to IPv4. IPv6 uses a 128-bit address, written as eight groups of four
hexadecimal digits, with each group separated by a colon. For example, the following address is in valid
IPv6 address:

2001:0db8:85a3:08d3:1319:8a2e:0370:7334

110 Group Management Commands


If one or more four-digit groups is 0000, you can omit the zeros and replace them with two colons (::).
For example, you can shorten 2001:0db8:0000:0000:0000:0000:1428:57ab to
2001:0db8::1428:57ab.

If an address has only one instance of consecutive groups of 0000, you can replace them with double
colons. Leading zeros in an address group can also be omitted (as in ::1 for localhost).

All of the following addresses are valid and equivalent:

2001:0db8:0000:0000:0000:0000:1428:57ab
2001:0db8:0000:0000:0000::1428:57ab
2001:0db8:0:0:0:0:1428:57ab
2001:0db8:0:0::1428:57ab
2001:0db8::1428:57ab
2001:db8::1428:57ab

If the group has a replication partner, make sure that the network addressing supports replication
between the partners. See partner create.

NOTE: Adding an IPv6 address to a group that also has an IPv4 address has no effect on current
group management sessions. However, if you remove the groups IPv4 address while connections
are open, users or initiators that become disconnected will not be able to reconnect to the original
address. If initiators are configured statically with the group IP address, you might need to update
the iSCSI initiators with the new information. However, if initiators are configured to find targets
dynamically, they can rediscover the targets. The computer running the initiator and the group must
use a common Internet Protocol to perform discovery and log in to a target.

Format
grpparams group-ipv6address ip_address|none

Variable
Variable Description
ip_address|none Group IP address in IPv6 format. To delete the IPv6 address, specify
none.

NOTE: You cannot delete an IPv6 group IP address unless the


group has an IPv4 group IP address configured. See grpparams
group-ipaddress.

Example
Set an IPv6 address for the group:

> grpparams group-ipv6address fc00:01ab:23cd:45ef:abc1:def2:000e:89ff

Group Management Commands 111


grpparams info-messages
Controls whether informational (INFO priority) messages appear on the console and in the GUI.
Messages with INFO priority describe normal operational and transitional events in the group. Typically,
these messages are of interest to administrators but do not require intervention.

Showing informational messages might result in the logging of a large amount of data to the console and
GUI.

Format
grpparams info-messages enable|disable

Example
Disable showing informational messages on the console and in the GUI:

> grpparams info-messages disable

grpparams iscsi-local-auth
Enables (default) or disables using local CHAP accounts to authenticate iSCSI initiator access to volumes
and snapshots (iSCSI targets). If enabled, the local CHAP accounts are queried before any external
RADIUS authentication servers.
To set up local CHAP accounts in the group, see chapuser.

NOTE: You can also use RADIUS servers to authenticate iSCSI initiator access to volumes. See
grpparams iscsi-radius-auth.

Format
grpparams iscsi-local-auth enable|disable

Example
Disable the use of local CHAP accounts:

> grpparams iscsi-local-auth disable

grpparams iscsi-radius-auth
Enables or disables (default) the use of RADIUS authentication servers for authenticating either iSCSI
initiator access to volumes or snapshots or Microsoft service access to the group.
NOTE: You can set up local CHAP accounts in the group to authenticate iSCSI initiator access to
volumes. See chapuser. You can set up target authentication in addition to initiator authentication.
See grpparams target-auth-password and grpparams target-auth-username.

You must specify external RADIUS servers for authenticating host access to volumes. See grpparams
radius-auth-list.

112 Group Management Commands


Format
grpparams iscsi-radius-auth enable|disable

Example
Enable the use of RADIUS authentication servers for authenticating host iSCSI access to volumes:

> grpparams iscsi-radius-auth enable

grpparams isns-server-list
Specifies or removes an IP address for an iSNS (Internet Storage Name Service) server.
An iSNS server can help with the automated discovery, management, and configuration of iSCSI devices
and other devices on a TCP/IP network.

NOTE: By default, an iSNS server cannot discover iSCSI targets (volumes or snapshots) in a group.
You must enable iSNS discovery on each target.

To remove the server IP address, enter two quotation marks ().

Format
grpparams isns-server-list ip_address[:port]

Variables
Variable Description
ip_address IP address of the iSNS server

[:port] Optional port. The default port number is 3205.

Example
Add an iSNS server and port:

> grpparams isns-server-list 192.0.2.26:3200

grpparams location
Specifies the physical location of the group. The default location is default.
To remove a group location, enter two quotation marks ().

Format
grpparams location text

Group Management Commands 113


Variable
Variable Description
text Group location, up to 63 ASCII characters. If the text contains spaces,
enclose it in quotation marks.

Example
Add a group location:

> grpparams location MySite, 2nd floor lab

grpparams login-radius-acct
Enables or disables (default) the use of RADIUS accounting servers for tracking the activity of group
administration accounts that are authenticated using RADIUS authentication servers.
To use RADIUS accounting, you must also enable RADIUS authentication for accounts. See grpparams
login-radius-auth. For information about specifying RADIUS accounting servers, see grpparams radius-
acct-list.

Format
grpparams login-radius-acct enable|disable

Example
Enable the use of RADIUS accounting servers:

> grpparams login-radius-acct enable

grpparams login-radius-attr
Enables (default) or disables requiring a RADIUS authentication server to supply the EQL-Admin attribute
when authenticating group administration accounts.
See grpparams login-radius-auth for information about enabling RADIUS authentication for group
administration accounts.

See the Dell EqualLogic Group Manager Administrator's Guide for information about additional RADIUS
attributes that you can configure.

Format
grpparams login-radius-attr enable|disable

Example
Require the RADIUS authentication server to supply the EQL-Admin attribute when authenticating group
administration accounts:

> grpparams login-radius-attr enable

114 Group Management Commands


grpparams login-radius-auth
Enables or disables (default) the use of RADIUS authentication servers for authenticating group
administration accounts.
Additionally, you can enable accounting to track accounts that are authenticated with RADIUS. See
grpparams login-radius-acct.

To enable RADIUS authentication, you must specify external RADIUS authentication servers. See
grpparams radius-auth-list.

Dell recommends that the RADIUS authentication server supply the EQL-Admin attribute for security
purposes. See grpparams login-radius-attr.

Format
grpparams login-radius-auth enable|disable

Example
Enable the use of RADIUS authentication servers for authenticating group administration accounts:

> grpparams login-radius-auth enable

grpparams management-network
Configures, removes, or displays the management network for a group.
A management network lets you separate iSCSI traffic (volume and snapshot I/O) from group
management traffic. After you configure and enable a management network, you log in to the
management address, instead of the group IP address, to perform any management operations.
Replication and other intergroup communication, in addition to iSCSI initiators, continue to use the group
IP address.

NOTE: To use a dedicated management network, your physical network must be set up with a
separate management router, with unique IP addresses and subnet masks. The management
network interface addresses and the group management address use either the IPv4 or IPv6
protocol.

Configuring a Management Network


To configure a management network using the CLI:

1. See the Dell EqualLogic Group Manager Administrator's Guide for detailed information about
configuring a dedicated management network.
2. Configure the highest-numbered network interface on each group member on the management
network, which must be on a different subnet than the iSCSI network. See member select eth select.
3. Add a default management gateway to the group. The management gateway applies to all the
configured management interfaces. See grpparams def-mgmt-gateway.
4. Configure a management address in the group.

Group Management Commands 115


Formats
grpparams management-network ipaddress mgmt_address
grpparams management-network ipaddress mgmt_address none
grpparams management-network ipv6address mgmt_address
grpparams management-network ipv6address mgmt_address none
grpparams management-network show

Parameters
Parameter Description
ipaddress mgmt_address Specifies a management network address for the group. The network
ipv6address must be on the same subnet as the management interfaces on the
mgmt_address group members.

none Removes a management network address from the group and disables
the dedicated management address.

NOTE: If you delete a management address, current GUI and CLI


sessions using that address will eventually time out and close.

Subcommand
Subcommand Description
show Displays the IP addresses for the management network

Examples

Configure an IPv4 or IPv6 management address for a group.

NOTE: This example assumes that you have already correctly configured the network interfaces on
all group members. Adding the management network address is the last step in the process of
configuring and using a management network. To test or use the management network, log in to
the group (either through the GUI or CLI) specifying the new management address.

> grpparams management-network ipaddress 192.0.2.37


> grpparams management-network ipv6address 2040:192.0.3.34

Display the management addresses for a group:

> grpparams management-network show

IP Address
--------------------
192.0.2.37
2040:192.0.3.34

116 Group Management Commands


Remove the IPv4 or IPv6 management address from the group and disable the address:

> grpparams management-network ipaddress 192.0.2.37 none


> grpparams management-network ipv6address 2040:192.0.3.34 none

Deleting the managment network address closes all management connections


associated
with the IP address. Do you want to delete the management network address?
(y/n) [n]y

grpparams name
Modifies the group name, which you use to identify the group for the purposes of adding new members
or setting up replication.
If the group is configured for replication, make sure to update the group name that is stored on all
replication partners.

Format
grpparams name group_name

Variable
Variable Description
group_name Group name for administrative purposes, up to 31 ASCII characters,
including hyphens. The first character must be a letter or a number.

Example
Change the group name:

> grpparams name psg1

grpparams ntp-server-list
Specifies from one to three IP addresses for Network Time Protocol (NTP) servers. Using an NTP server
sets a consistent time on all group members.
To change a server in the NTP server list, you must enter the IP addresses on the command line.

To remove all servers from the list, enter two quotation marks ().

Format
grpparams ntp-server-list ip_address[:port]

Group Management Commands 117


Variables
Variable Description
ip_address One to three IP addresses, separated by commas and no spaces

[:port] Optional port. The default port number is 123.

Example
Add two NTP servers for the group:

> grpparams ntp-server-list 192.0.2.31:101,192.0.2.42

grpparams passwd
Changes the password that is required to add a member to a group.
The original password was set when the group was created. The password must be between 3 and 16
ASCII characters and is case-sensitive. Do not specify a current user or account password.

NOTE: Do not specify a password on the command line. After entering the command, you will be
prompted for the new password. Passwords are not shown on the screen.

Format
grpparams passwd

Example
Change the password for adding a group member:

> grpparams passwd


Password for adding members:
Retype password:
Password has been changed.

grpparams perf-balancing
Enables (default) or disables performance load balancing.
When you enable performance load balancing, the group places volume data on members that have the
optimal RAID level for the volume, based on the volumes performance metrics and historical I/O pattern.
Performance load balancing occurs only after a period of time during which the group monitors the
volumes performance and I/O pattern. Over time, volume data might be moved across members.

NOTE: Dell recommends that you enable performance load balancing.

Format
grpparams perf-balancing enable|disable

118 Group Management Commands


Example
Disable performance balancing in the group:

> grpparams perf-balancing disable

grpparams protocol-endpoint access show


Displays all protocol endpoint access points for the group.

Format
grpparams protocol-endpoint access show

Example
> grpparams protocol-endpoint access show

_______________________ ACL Policies and Policy Groups ________________________

Access Policy Group Access Policy Apply-To


-------------------- ------------------ ------------------
--- VSMAR-140908140427 both
154
--- VSMAR-140908140439 both
523

grpparams radius-acct-list
Specifies one to three IP addresses for external RADIUS accounting servers that are used to track group
administration accounts that are also authenticated with RADIUS. The servers are contacted in the order
specified.
To enable RADIUS accounting, see grpparams login-radius-acct.

Depending on how you configured the RADIUS accounting server, you might need to specify secrets
(passwords). See grpparams radius-auth-secrets.

Optionally, you can override the default retry and timeout values for contacting RADIUS accounting
servers. See grpparams radius-auth-retries and grpparams radius-auth-timeout.

Format
grpparams radius-acct-list ip_address[:port]

Variable
Variable Description
ip_address[:port] One to three IP addresses, separated by commas but no spaces.
Optionally, specify a port if it is different from the default RADIUS server
port (1812).

Group Management Commands 119


Variable Description
The order in which you specify the IP addresses is the order in which
they will be used. To change any of the servers in the list, you must
reenter all the IP addresses.

To remove all addresses from the list, enter two quotation marks ().

Example
Add two RADIUS accounting servers:

> grpparams radius-acct-list 192.0.2.39:1655,192.0.2.47

grpparams radius-acct-retries
Specifies the number of times the group will try to contact a RADIUS accounting servers after the first
attempt fails. If the group cannot connect within the specified number of retries, it will try to connect to
another accounting server, if one is configured.
For example, when a user logs in to a group administration account, the group tries to contact a RADIUS
authentication server. Then if the account is authenticated the group tries to contact an accounting
server. If the group receives no response within the time limit set by the radius-acct-timeout
parameter, the group will keep trying to contact the server the number of times specified by the radius-
acct-retries parameter.

To specify RADIUS accounting servers, see grpparams radius-auth-list.

Format
grpparams radius-acct-retries n

Variable
Variable Description
n Number of times the group will try to contact a RADIUS accounting
server after the initial attempt fails. The default is 1 retry.

Example
Configure the group to try again two times to contact a RADIUS accounting server after the initial
attempt fails:

> grpparams radius-acct-retries 2

grpparams radius-acct-secrets
Specifies secrets (passwords) for the external RADIUS accounting servers that are used to track group
administration accounts that are authenticated with a RADIUS authentication server.
To specify RADIUS accounting servers, see grpparams radius-acct-list.

120 Group Management Commands


Format
grpparams radius-acct-secrets secrets

Variable
Variable Description
secrets One to three secrets (passwords), up to 63 ASCII characters each,
separated by commas and no spaces.
Specify the secrets in the same order as the list of specified accounting
servers. The first secret will apply to the first server specified with the
radius-acct-list parameter (see grpparams radius-acct-list). The
second secret will apply to the second server, and so on.

Example
Add secrets for two RADIUS accounting servers:

> grpparams radius-acct-secrets gonefishin2,lin2006

grpparams radius-acct-timeout
Specifies the number of seconds the group will wait for a RADIUS accounting server to respond before
timing out.
For example, when a user logs in to a group administration account, the group tries to contact a RADIUS
authentication server. Then if the account is authenticatedthe group tries to contact a RADIUS
accounting server. If the server does not respond within the timeout period, the contact fails. If the value
of the radius-acct-retries parameter is more than 1, the group will try to contact the server for the
specified number of times.

To specify RADIUS accounting servers, see grpparams radius-auth-list.

Format
grpparams radius-acct-timeout n

Variable
Variable Description
n Number of seconds to wait for a response from a RADIUS accounting
server. The default is 2 seconds.

Example
Configure the group to wait 5 seconds before trying again to contact the RADIUS accounting server:

> grpparams radius-acct-timeout 5

Group Management Commands 121


grpparams radius-auth-list
Specifies one to three IP addresses for external RADIUS authentication servers. These servers can be used
to authenticate host (iSCSI initiator) access to volumes through CHAP, authenticate group administration
accounts, or authenticate Microsoft service access to the group. The servers are contacted in the order
specified.
To enable RADIUS authentication for host access to volumes, see grpparams iscsi-radius-auth. To enable
RADIUS authentication for group administration accounts, see grpparams login-radius-auth.

Depending on the RADIUS server configuration, you might need to specify secrets (passwords) for the
authentication servers (see grpparams radius-auth-secrets.

Optionally, you can specify retry and timeout values for the servers. See grpparams radius-auth-retries
and grpparams radius-auth-timeout.

NOTE: After you have configured the group to use a RADIUS authentication server for host access
to volumes, you can create a basic access point for the volume with a CHAP account name that is
the same as an account on the RADIUS server. For more information about setting up basic access
points, see volume select access create.

Format
grpparams radius-auth-list ip_address[:port]

Variable
Variable Description
ip_address[:port] One to three IP addresses, separated by commas but no spaces, and
optional port. Optionally, specify a port if it is different from the default
RADIUS server port (1812).
The order in which you specify the IP addresses is the order in which
they will be used. To change any of the servers in the list, you must
reenter all the IP addresses. To remove all addresses from the list, enter
two quotation marks ().

Example
Add two RADIUS authentication servers:

> grpparams radius-auth-list 192.0.2.33:1107,192.0.2.26

grpparams radius-auth-retries
Specifies the number of times the group will try to contact a RADIUS authentication server after the first
attempt fails. If the group cannot connect within the specified number of retries, it will try to contact
another authentication server, if one is configured.
For example, when a host (iSCSI initiator) tries to connect to a volume (or a user logs in to an
administration account), the group tries to contact a RADIUS authentication server. If the group receives

122 Group Management Commands


no response within the time limit specified by the radius-auth-timeout parameter, the group will
keep trying to contact the server the number of times specified by the radius-auth-retries
parameter.

To specify RADIUS authentication servers, see grpparams radius-auth-list.

Format
grpparams radius-auth-retries n

Variable
Variable Description
n Number of times the group will try to contact a RADIUS authentication
server after the initial attempt fails. The default is 1 retry.

Example
Configure the group to try again two time to contact a RADIUS authentication server after the initial
attempt fails:

> grpparams radius-auth-retries 2

grpparams radius-auth-secrets
Specifies secrets (passwords) for the external RADIUS authentication servers that are used to authenticate
host access to volumes, authenticate group administration accounts, or authenticate Microsoft service
access to the group.
To specify RADIUS authentication servers, see grpparams radius-auth-list.

Format
grpparams radius-auth-secrets secret[,secret,...]

Variable
Variable Description
secret One to three secrets (passwords), up to 63 ASCII characters each,
separated by commas and no spaces.
Specify the secrets in the same order as the list of specified
authentication servers (see grpparams radius-auth-list). The first secret
applies to the first server, the second secret applies to the second
server, and so on.

Example
Add two RADIUS authentication secrets:

> grpparams radius-auth-secrets egbdf1,chenille1392

Group Management Commands 123


grpparams radius-auth-timeout
Specifies the number of seconds the group will wait for a RADIUS authentication server to respond before
timing out.
For example, when a host tries to connect to a volume (or a user logs in to an administration account),
the group tries to contact a RADIUS authentication server. If the server does not respond within the
timeout period, the contact fails. If the value of the radius-auth-retries parameter is more than 1,
the group will try to contact the server for the specified number of times.

To specify RADIUS authentication servers, see grpparams radius-auth-list.

Format
grpparams radius-auth-timeout n

Variable
Variable Description
n Number of seconds to wait for a response from a RADIUS
authentication server. The default is 2 seconds.

Example
Set the RADIUS timeout value to 3 seconds:

> grpparams radius-auth-timeout 3

grpparams session-banner
Enables or disables the display of a text banner before users log in to the group through the GUI or the
CLI.

Format
grpparams session-banner enable "bannerText" | disable

Variable
Variable Description
bannerText Text string, enclosed in quotation marks (), to be displayed in the
GUI or the CLI when a user logs in to the group.
The text string can be up to 256 characters.

124 Group Management Commands


Example
Enable the use of a CLI session banner, using the text inside the quotation marks:

> grpparams session-banner enable "This group is the property of ABC


Corporation. Unauthorized use is prohibited."

grpparams session-idle-timeout
Enables or disables (default) the idle timeout value for a login session, and optionally sets a length of time
for the value.
If enabled, the timeout value is the number of minutes that the session can remain idle before being
logged out. If disabled, the timeout value is ignored.

Format
grpparams session-idle-timeout enable [n] | disable

Variable
Variable Description
n Number of minutes, from 1 to 1440 (24 hours), to wait before the group
automatically logs out an idle session. By default, the timeout value is
set to 30 minutes but disabled.

NOTE: If the timeout value has been changed from the default to a
different number, you must use the enable parameter to set the
value back to 30 (grpparams session-idle-timeout enable 30).

Examples
Enable the idle timeout value and keep the current value (30 by default):

> grpparams session-idle-timeout enable

Enable the idle timeout value and set the value to 15 minutes:

> grpparams session-idle-timeout enable 15

After you enable and set the value, the display from the grpparams show command will show the
following settings:

Session-Idle-Timeout-Enable: enabled Session-Idle-Timeout: 15

Disable the idle timeout value (the current value stays the same):

> grpparams session-idle-timeout disable

See Also
cli-settings

Group Management Commands 125


grpparams show
Shows the current values of all the group parameters or a specific list parameter.

Format
grpparams show [list]

Variable
Variable Description
list Specifies one of the following lists to display:
access-points-list
email-list
isns-server-list
ntp-server-list
radius-acct-list
radius-auth-list
smtp-server-list
syslog-server-list

Examples
Display the list of syslog servers configured for the group:

> grpparams show syslog-server-list

Syslog Server List :: 192.0.2.29

Display the list of NTP servers configured for the group:

> grpparams show ntp-server-list

NTP Server List::192.0.2.23,192.0.2.33,192.0.2.43

Display all the basic access points, access policies, access policy groups, and associations between
access policy groups and volumes:

> grpparams show access-points-list

_____________________________ Access Information _____________________________


Total-Basic-Access-Points: 8 Total-Access-Policy-Groups: 2
Total-Access-Policies: 4 Total-Access-Points: 1
Total-Access-Point-Addresses: 0 Total-Access-Policy-Assocs: 5
______________________________________________________________________________

Display all of the group parameters:

> grpparams show

______________________________ Group Information _____________________________


Name: nasgrpbl13 Group-Ipaddress: 192.0.2.26
Def-Snap-Reserve: 100% Def-Snap-Warn: 10%

126 Group Management Commands


Def-Snap-Depletion: delete-oldest Def-Thin-Growth-Warn: 60%
Def-Thin-Growth-Max: 100% DateAndTime: Fri Jun 19 14:00:50 2015
TimeZone: America/New_York Description:
Def-Iscsi-Prefix: Def-Iscsi-Alias: yes
iqn.2002-10.com.mycompany Info-Messages: enabled
Webaccess: enabled Webaccess-noencrypt: enabled
Cliaccess-SSH: enabled Cliaccess-Telnet: enabled
Email-Notify: disabled Syslog-Notify: disabled
iSNS-Server-List: Email-List:
NtpServers: Smtp-Server-List:
DNS-Server-List: 192.0.2.36 DNS-Suffix-List: spark.com
Syslog-Server-List: Target-Auth-UserName:
Target-Auth-Password: hJZj2RPXrPrHjPR2
H8hJ2jBZpX8X2HPX Email-From:
Location: default Conn-Balancing: enabled
Discovery-Use-Chap: disabled Email-Contact:
Perf-balancing: enabled Disallow-Downgrades: yes
Management-Ipaddress: SSH-V1-Protocol: enabled
FTP-service: enabled Standby-Button: disabled
DCB: enabled Def-DCB-VLAN-Id: 2
Thermal-Shutdown: enabled Crypto-Legacy-Protocols: enabled
Volume-Recovery: enabled Session-Idle-Timeout: 30
Session-Idle-Timeout-Enable: disabled Session-Banner-Enable: disabled
Def-Snapshot-Borrow: enabled Def-Sector-Size: 512
Default-Snapshot-Sched: enabled
______________________________________________________________________________
_____________________________ Radius Information _____________________________
radius-auth-list: login-radius-auth: disabled
radius-auth-retries: 1 radius-auth-timeout: 2secs
login-radius-acct: disabled radius-acct-retries: 1
radius-acct-timeout: 2secs iscsi-radius-auth: disabled
iscsi-local-auth: enabled radius-acct-list:
login-radius-attr: enabled
______________________________________________________________________________
______________________________ Snmp Information ______________________________
read-only-comms: read-write-comms:
trap-community: SNMP-trap snmp-managers:
______________________________________________________________________________
_____________________________ Access Information _____________________________
Total-Basic-Access-Points: 8 Total-Access-Policy-Groups: 2
Total-Access-Policies: 4 Total-Access-Points: 1
Total-Access-Point-Addresses: 0 Total-Access-Policy-Assocs: 5
______________________________________________________________________________

grpparams smtp-server-list
Specifies from one to three IP addresses for SMTP (Simple Mail Transfer Protocol) servers or email relays
used for email event notification.
To change any of the servers in the SMTP server list, reenter all the IP addresses on the command line.

To remove all servers from the list, enter two quotation marks ().

To set up email notification, you must also specify one or more email addresses to receive the email and
enable email event notification. See grpparams email-list and grpparams email-notify. In addition, you
can specify a sender address for the notification messages (see grpparams email-from).

Format
grpparams smtp-server-list ip_address[:port]

Group Management Commands 127


Variable
Variable Description
ip_address[:port] One to three IP addresses, each separated by a comma and no space,
and optional port. The default port number is 25.

Example
Configure an SMTP server for the group:

> grpparams smtp-server-list 192.0.2.23

grpparams snmp
Sets or shows SNMP (Simple Network Management Protocol) configuration parameters, such as
community strings and trap destinations.
To remove a community string, SNMP managers string, or trap community string, enter two quotation
marks ().

Format
grpparams snmp parameter | show

Parameters
Parameter Description
read-only-comms string One or more read-only community strings, separated by commas and
no spaces, used by the SNMP agent to authenticate SNMP requests

read-write-comms One or more read-write community strings, separated by commas and


string no spaces, used by the SNMP agent to authenticate SNMP requests

snmp-managers string One or more IP addresses, separated by commas and no spaces, for
SNMP trap destinations

trap-community string Community string used by the SNMP agent when sending traps

Subcommand
Subcommand Description
show Displays the SNMP parameters

Example
Set the IP address for an SNMP trap destination:

> grpparams snmp snmp-managers 192.0.2.35

128 Group Management Commands


grpparams snmp show
Shows all the SNMP (Simple Network Management Protocol) configuration parameters for the group.

Format
grpparams snmp show

Example
Display the SNMP parameters:

> grpparams snmp show


______________________________ Snmp Information ______________________________
read-only-comms: public read-write-comms:
trap-community: SNMP-trap snmp-managers: 192.0.2.35
______________________________________________________________________________

grpparams standby-button
Enables or disables (default) the standby button for all members in the group that support this feature.
Only certain control modules have the standby button.
NOTE: Standby operation is compatible with all PS Series group members that have Type 11 or 12
control modules (PS4100 or PS6100 array models). Only a group administrator can enable or
disable the standby button setting in the CLI or the GUI. See the Hardware Owner's Manual for
details about the Standby ON/OFF button.

Format
grpparams standby-button enable|disable

Example
Enable the standby feature for all group members that support it:

> grpparams standby-button enable

If you add more members (arrays) to the group, the standby setting is automatically applied to members
that have the Standby ON/OFF button. Use the grpparams show command to view the standby mode
activity.

grpparams syslog-notify
Enables or disables (default) event logging to remote syslog servers.
When you enable syslog notification, by default events with a fatal, error, or warning priority result in
notification, unless you specify different priorities with the alerts command. See alerts.

To use syslog notification, you must also specify IP addresses for the syslog servers. See grpparams
syslog-server-list.

Group Management Commands 129


Format
grpparams syslog-notify enable|disable

Example
Enable sending event logs to a remote syslog server:

> grpparams syslog-notify enable

grpparams syslog-server-list
Sets one to three IP addresses for remote servers that will log events to a remote syslog-style log file.
The servers must be configured to accept remote log files. The default port number is 514 (UDP).To use
syslog notification, you must also enable syslog notification. See grpparams syslog-notify.

To change any of the servers in the syslog server list, reenter the IP addresses on the command line.

To remove all servers from the list, enter two quotation marks ().

Format
grpparams syslog-server-list ip_address[,ip_address,ip_address]

Variable
Variable Description
ip_address One to three IP addresses, separated by commas and no spaces

Example
Add a syslog server for the group:

> grpparams syslog-server-list 192.0.2.52

grpparams target-auth-password
Specifies a CHAP password to be used for target authentication, which lets the volume (iSCSI target) be
authenticated by the host (iSCSI initiator).
You must also specify the target authentication user name (see grpparams target-auth-username). You
cannot use target authentication without setting up initiator authentication. See chapuser and grpparams
cliaccess-ssh.

Format
grpparams target-auth-password password

130 Group Management Commands


Variable
Variable Description
password Password, up to 254 ASCII characters. If you enter only two quotation
marks (), the password is created automatically.

Example
Create a CHAP password for target authentication:

> grpparams target-auth-password bassethound29

grpparams target-auth-username
Specifies a CHAP user name to be used for target authentication, which lets the volume (iSCSI target) be
authenticated by the host (iSCSI initiator).
You must also specify the target authentication password (see grpparams target-auth-password). You
cannot use target authentication without setting up initiator authentication. See chapuser and grpparams
cliaccess-ssh.

Format
grpparams target-auth-username name

Variable
Variable Description
name User name, up to 63 ASCII characters

Example
Configure a CHAP user name for target authentication:

> grpparams target-auth-username dylan41

grpparams thermal-shutdown
Enables (default) or disables the thermal-shutdown feature for group members that support the feature
(for example, PS4100 and PS6100 array models).
The thermal-shutdown feature automatically shuts down the array when the ambient temperature
reaches a certain critical point past which the array will be damaged or destroyed if it continues to
operate.

WARNING:
Dell strongly discourages disabling the thermal-shutdown feature. Disabling this feature allows the
array to operate past its safe operating temperature and can result in the destruction of the array
and the data on it. Disabling this feature might void the warranty for the arrays that support it.

Group Management Commands 131


Format
grpparams thermal-shutdown enable|disable

Example
Disable the thermal shutdown feature (not recommended), which is enabled by default:

> grpparams thermal-shutdown disable


Are you sure you want to disable this feature, risk unrecoverable damage to the
arrays if the temperature gets too high, and possibly void your warranty?
[yes|no]

grpparams time
Sets the time for the group.

Format
grpparams time hh:mm:ss

Variable
Variable Description
hh:mm:ss Time in 24-hour format: hours (hh), minutes (mm), and seconds (ss)

Example
Set the group time:

> grpparams time 13:46:00

grpparams timezone
Sets the time zone for the group, using a country and city designation.
The default is America/New_York.

Format
grpparams timezone zone

Variable
Variable Description
zone Time zone. To see a list of supported time zones, use the grpparams
timezone ? command.

132 Group Management Commands


Example
Set the time zone for the group to London, England, time:

> grpparams timezone Europe/London

grpparams vss-vds
Configures VSS/VDS hosts to communicate with the group.
Hosts communicate with the group through the Microsoft Volume Shadow Copy Service (VSS) and
Virtual Disk Service (VDS).

Format
grpparams vss-vds subcommand

Subcommands
Subcommand Description
access Creates a basic access point for Microsoft service access to the group

access-policy Creates an access policy for Microsoft service access to the group

access-policy-group Creates an access policy group for Microsoft service access to the
group

show Displays all Microsoft service basic access points, access policies, and
policy groups

grpparams vss-vds access


Manages basic access points for Microsoft service access to the group, including Volume Shadow Copy
Service (VSS) and Virtual Disk Service (VDS).
When you create a basic access point, the group assigns an identification number to the record. Use this
number to manage the record with the CLI.

NOTE: If you are using CHAP to authenticate Microsoft service access to the group, you must set up
a CHAP account either locally (see chapuser) or on a RADIUS server (see grpparams radius-auth-
list). The Windows server that is running the Microsoft service must be configured with a matching
CHAP user name and password. See the Host Integration Tools for Microsoft documentation for
more information.

Format
grpparams vss-vds access subcommand [parameter]

Group Management Commands 133


Subcommands
Subcommand Description
create [parameter] Creates a basic access point for Microsoft service access to the group

delete id Deletes the specified Microsoft service basic access point

select id [parameter] Modifies or shows a Microsoft service basic access point

show Displays all Microsoft service basic access points

Parameters
Parameter Description
authmethod chap|none Specifies whether the record uses CHAP authentication (chap) to
restrict Microsoft service access to the group. The default is none;
CHAP authentication is not used.
You must also specify the username chap_name parameter for CHAP
authentication.

username chap_name CHAP account name (up to 63 printable characters; spaces cannot be
used) to which access is restricted. The name must match a local CHAP
account or an account on an external RADIUS server that is known to
the group.
You must also specify the authmethod chap parameter for CHAP
authentication.

ipaddress address IP address to which access is restricted. An asterisk (*) in any of the four
parts of an IP address is interpreted as a wildcard character; that is, any
value is accepted for that 8-bit field.

For example, specify *.*.*.* for unrestricted host access (not


recommended except for testing).

initiator name Name of the iSCSI initiator to which group access is restricted. For
example:
iqn.2002-10.com.mycompany.qla-4000.sn00044

show Shows details about the selected basic access point

Example
Create a basic access point that grants a user access to the Microsoft service for the group, using an
authentication method of CHAP:

> grpparams vss-vds access create authmethod chap username adm32

134 Group Management Commands


grpparams vss-vds access-policy
Associates or disassociates an access policy for the Microsoft service.

Format
grpparams vss-vds access-policy subcommand name

Variable
Variable Description
name Name of an access policy

Subcommands
Subcommand Description
associate-to Associates the specified access policy to the Microsoft service

disassociate-from Disassociates the specified access policy from the Microsoft service

Example
Associate an access policy to the Microsoft service for the group:

> grpparams vss-vds access-policy associate-to MSPol1

grpparams vss-vds access-policy-group


Associates or disassociates an access policy group for the Microsoft service.

Format
grpparams vss-vds access-policy-group subcommand name

Variable
Variable Description
name Name of the access policy group

Subcommands
Subcommand Description
associate-to Associates the specified access policy group to the Microsoft service

disassociate-from Disassociates the specified access policy group from the Microsoft
service

Group Management Commands 135


Example
Associate an access policy group to the Microsoft service for the group:

> grpparams vss-vds access-policy-group associate-to HITaccess

grpparams vss-vds show


Displays all Microsoft service basic access points, access policies, and policy groups.

Format
grpparams vss-vds show

Example
Display all Microsoft service basic access points, access policies, and policy groups for the group:

> grpparams vss-vds show

grpparams webaccess
Enables (default) or disables the use of standard HTTP web connections (through port 80) to the group
manager GUI.
To restrict GUI access to web connections that are secured with SSL, see grpparams webaccess-
noencrypt.

Format
grpparams webaccess enable|disable

Example
Disable web connections to the group:

> grpparams webaccess disable

grpparams webaccess-noencrypt
Enables (default) or disables requiring access to the GUI through a web connection that is not encrypted
with SSL or TLS.
If enabled, SSL and TLS are not required. To limit GUI access only to web connections that are secured
with SSL or TLS encryption, disable this feature and install the Java plug-in with SSL on the host running
the web browser. Also, you must select the checkbox next to Encrypt communication in the GUI login
dialog box.

Format
grpparams webaccess-noencrypt enable|disable

136 Group Management Commands


Example
Specify that web connections to the GUI must use TLS or SSL encryption:

> grpparams webaccess-noencrypt disable

ipsec
Manages IP security for the group.
NOTE: Enabling or disabling IPsec for the group using the ipsec enable and ipsec disable commands
might disrupt host connectivity to the group for several minutes. To prevent unplanned outages,
Dell recommends that IPsec be enabled or disabled during a planned maintenance window when
no volumes have any active iSCSI connections.

Format
ipsec subcommand

Subcommands
Subcommand Description
certificate Loads a security certificate. See ipsec certificate.

enable | disable Enables or disables IP security

policy Manages IP security policies. See ipsec policy.

security-association Manages IP security associations. See ipsec security-association.

security-params Manages IP security parameters. See ipsec security-params.

show Displays the IPsec certificates and security parameters for the group

See Also
ipsec certificate
ipsec security-association
ipsec security-params
ipsec policy

ipsec certificate
Manages IP security certificates for the group.

Interactions with Other Commands


If you have disabled the use of legacy encryption protocols on the group, the group will not accept
certificates that use an encryption key smaller than 2048 bits. See grpparams-crypto-legacy-protocols.

Group Management Commands 137


The save-config CLI command does not preserve the groups IPsec certificate configuration. The save-
config command saves the CLI commands that were used to configure IPsec, but it does not save
certificates that have been transferred to the array using FTP. Therefore, when you restore a
configuration, you must manually restore any configuration options set using the ipsec certificate load
and ipsec security-params create certificate commands.

Formats
ipsec certificate subcommand

Subcommands
Subcommand Description
delete Deletes an IP security certificate

load Loads an IP security certificate

select show Displays information about a specific IP security certificate

show Displays information about all IP security certificates

ipsec certificate delete


Deletes an IP security certificate.

Format
ipsec certificate certificate_name delete

Variable
Variable Description
certificate_name Name of the certificate

Example
Delete an IP security certificate:

> ipsec certificate RootCA delete

ipsec certificate load


Loads an IP security certificate onto the group.
You can load up to 10 certificates onto the group. The certificates can be of the following types:

One (1) root-ca certificate


Eight (8) intermediate certificates
One (1) local certificate

138 Group Management Commands


Formats
ipsec certificate load certificate_name file_name root-ca

ipsec certificate load certificate_name file_name intermediate

ipsec certificate load certificate_name file_name local priv-key-file password


password

Variables
Variable Description
certificate_name Name of the certificate (64 characters or fewer). Valid characters
include letters, numbers, period, hyphen, and underscore.

file_name Name of a file containing the certificate

priv_key_file Used only with the local certificate type. Specifies the file containing the
private key.

password Used only with the local certificate type. Specifies the password to
decrypt the private key file.

Examples
Load a local certificate:

> ipsec certificate load PSAcert IPsecPSA.pfx local password shRUFhe34

Load a root certificate:

> ipsec certificate load RootCA rootca.cer root-ca

ipsec certificate select show


Displays detailed information about a specific IP security certificate.

Format
ipsec certificate select certificate_name show

Variable
Variable Description
certificate_name Name of the certificate

Example
Display information about an IP security certificate:

> ipsec certificate select RootCA show

Group Management Commands 139


ipsec certificate show
Displays information about all IP security certificates.

Format
ipsec certificate show

Example
Display information about all IP security certificates on the group:

> ipsec certificate show


Certificate Name Type Format
-------------------------------- ------------ -------
RootCA root-ca
PSAcert local

ipsec enable | disable


Enables or disables IP security for the group.

Format
ipsec enable|disable

Subcommands
Subcommand Description
disable Disables IP security on the group

enable Enables IP security on the group

Example
Enable IPsec on the group:

> ipsec enable

ipsec policy
Manages IP security policies.

Format
ipsec-policy subcommand

140 Group Management Commands


Subcommands
Subcommand Description
create Creates an IP security policy

delete Deletes an IP security policy

show Displays all IP security policies

See Also
ipsec
ipsec certificate
ipsec security-params

ipsec policy create


Creates an IP security policy. You can create up to 256 policies on a group, including multiple policies for
the same IP protocol (IPv4 or IPv6).
Only administrators with grpadmin account types can create security policies.

Formats
For IPv4:

ipsec policy create name type v4 ip-addr ip_address


netmask netmask local-port local_port remote-port remote_port loc-ip-addr
local_ip_address protocol protocol_type action action

For IPv6:

ipsec policy create name type v6 ip-addr ip_address


prefix-length length local-port local_port remote-port remote_port
loc-ip-addr local_ip_address protocol protocol_type action action

Variable
Variable Description
name Specifies the name of this security policy.
Names can be up to 32 characters.

Parameters
Parameter Description
type v4|v6 Specifies whether this policy applies to IPv4 or IPv6

ip-addr ip_address Specifies the IP address of the host or network address of the
remote endpoints

Group Management Commands 141


Parameter Description
netmask netmask (IPv4 only) Specifies the netmask used by the remote
endpoints for this policy

prefix-length length (IPv6 only) Specifies the length of the prefix (from 1 to 128)
used by the remote endpoints for this policy

local-port port Specifies the local port number (from 1 to 65535) to which
the policy applies

remote-port port Specifies the remote port number (from 1 to 65535) to which
the policy applies

loc-ip-addr local_ip_address (Applies only if the security parameter type is manual-key.


See ipsec security-params create manual-key.) Specifies the
local IP address to use for this policy.

protocol protocol_type Specifies the network protocol for this policy. You can create
a unique policy for each protocol. The protocols support
different IP versions, as follows:

tcp (IPv4 and IPv6)


udp (IPv4 and IPv6)
icmp (IPv4 only)
ipv6icmp (IPv6 only)
any (IPv4 and IPv6)

action drop|pass|protect Specifies the action to take when a packet that matches the
security-params specified policy is received. Choices are:

drop Drop traffic that meets this policy


pass Pass traffic that meets this policy. (This action is
the default and provides no traffic security to the group.)
protect security-params Apply the specified
security parameters to the traffic (see ipsec security-
params)

Examples
Create a security policy for a certificate-based security parameter for an IPv4 implementation:

> ipsec policy create ToRemPeer_IPv4_CERT_Ikev1 type v4 ip-addr 192.0.2.20


protocol any action protect RemPeer_CERT_Auth

Create a security policy for a pre-shared-key security parameter for an IPv6 implementation:

> ipsec policy create ToRemPeer_IPv6_PSK_Ikev1 type v6 ip-addr


fc00::10::125::56::11 protocol tcp action protect RemPeer_PSK_Auth

Create a security policy for a certificate-based security parameter that uses tunneling for an IPv4
implementation:

> ipsec policy create ToRemPeer_IPv4_CERT_Ikev2 type v4 ip-addr 192.0.2.24


protocol any action protect RemPeer_CERT_Auth_Tunnel

142 Group Management Commands


Create a security policy for a pre-shared-key security parameter that uses tunneling for an IPv6
implementation and requires IKE v2:

> ipsec policy create ToRemPeer_IPv6_PSK_Ikev2 type v6 ip-addr


fc00::10::125::56::11 protocol tcp action protect RemPeer_PSK_Auth_Tunnel

See Also
ipsec
ipsec certificate
ipsec security-params

ipsec policy delete


Deletes an IP security policy.
Only administrators with grpadmin account types can delete security policies.

Format
ipsec-policy delete policy_name

Variable
Variable Description
policy_name Specifies the name of the security policy to delete

Example
Delete a security policy:

> ipsec policy delete sec1

See Also
ipsec
ipsec certificate
ipsec security-params

ipsec policy show


Displays all IP security policies on the group.

Format
ipsec policy show

Example
Display all the configured security policies on the group:

Group Management Commands 143


NOTE: Policies are applied in the order shown.

> ipsec policy show


Name IP Prefix Prot RPort LPort Security Params Action
------------- -------------------- -------- ----- ----- --------------- ------
swat-client02 192.0.2.20/32 any any any swat-client02 prot
swat-client04 192.0.2.22/32 any any any swat-client04 prot
swat-client05 192.0.2.24/32 any any any swat-client05 prot
swat-client05 192.0.2.26/32 any any any swat-client05 prot
-125
swat-client04 192.0.2.28/32 any any any swat-client04 prot
-246
swat-client02 192.0.2.30/32 any any any swat-client02 prot
-213
swat-client02 192.0.2.32/32 any any any swat-client02 prot
-211

See Also
ipsec
ipsec certificate
ipsec security-params

ipsec security-association
Manages IP security associations.
NOTE: You cannot use the save-config CLI command to preserve the groups IPsec certificate
configuration. The save-config command saves the CLI commands that were used to configure
IPsec, but it does not save certificates that have been transferred to the array using FTP. Therefore,
when you restore a configuration, you must manually restore any configuration options that were
set using the ipsec certificate load and ipsec security-params create certificate commands.

Format
ipsec security-association subcommand

Subcommands
Subcommand Description
delete Deletes an IP security association

show Displays all IP security associations

Example

See Also
ipsec
ipsec certificate
ipsec security-params
ipsec policy

144 Group Management Commands


ipsec security-association delete
Deletes IP security associations.
CAUTION: Use this command only with the guidance of a Dell Support representative. This
command is provided as an alternative to shutting down the IPsec functionality completely to
diagnose and correct a problem with the security communication between the group and the
hosts accessing the group.

Format
ipsec security-association delete type v4|v6 rem-ip-addr ip_address

Parameters
Parameter Description
rem-ip-addr ip_address Specifies an IP address (for example, of an iSCSI initiator) to delete.
Deleting the address breaks the security association to that remote
address.

NOTE: Do not specify an IP address that is configured for a


network interface on any group member.

type v4|v6 Specifies whether this security association applies to IPv4 or IPv6

Example
Delete a security association for an IPv4 address:

> ipsec security-association delete type v4 rem-ip-addr 192.0.2.20

See Also
ipsec
ipsec certificate
ipsec security-params
ipsec policy

ipsec security-association show


Displays all IP security associations.

Format
ipsec security-association show

Example
Display all the security associations on the group:

> ipsec security-association show


Member Src IP Address Dst IP Address Enc Alg Auth Alg SPI Manual

Group Management Commands 145


--------- --------------- --------------- -------- --------- ---------- ------
swat27 192.0.2.20 192.0.2.21 aes-cbc sha1-hmac 2712515355 false
swat27 192.0.2.22 192.0.2.23 aes-cbc sha1-hmac 2451959813 false
swat27 192.0.2.24 192.0.2.25 aes-cbc sha1-hmac 3027056011 false
swat27 192.0.2.26 192.0.2.27 aes-cbc sha1-hmac 3027056011 false
swat27 192.0.2.28 192.0.2.29 aes-cbc sha1-hmac 3027056011 false
swat27 192.0.2.30 192.0.2.31 aes-cbc sha1-hmac 2510514176 false
swat27 192.0.2.32 192.0.2.33 aes-cbc sha1-hmac 2420424581 false
swat27 192.0.2.34 192.0.2.35 aes-cbc sha1-hmac 388040876 false
.
.
.

ipsec security-params
Manages IP security parameters.
NOTE: The save-config CLI command does not preserve the groups IPsec certificate configuration.
The save-config command saves the CLI commands that were used to configure IPsec, but it does
not save certificates that have been transferred to the array using FTP. Therefore, when you restore
a configuration, you must manually restore any configuration options that were set using the ipsec
certificate load and ipsec security-params create certificate commands.

Format
ipsec security-params subcommand

Subcommands
Subcommand Description
create Creates IP security parameters

delete Deletes an IP security parameter

select show Displays information about a specific security peer

show Displays IP security parameters

See Also
ipsec
ipsec certificate
ipsec policy
ipsec security-association

ipsec security-params create


Creates IP security parameters.
You can create up to 256 security parameters.

Format
ipsec security-params create security_param parameter

146 Group Management Commands


Variable
Variable Description
security_param Name of the security parameter

Parameters
Parameter Description
certificate Creates an IP security parameter using a certificate

manual-key Creates an IP security parameter using a manual key

pre-shared-key Creates an IP security parameter using a pre-shared key

See Also
ipsec
ipsec certificate
ipsec policy
ipsec security-association

ipsec security-params create certificate


Creates IP security parameters using a certificate.
You can create multiple certificates, but each certificate can be of only one type, based on whether it
uses an IP address, domain name, email address, or distinguished name. Each command format is listed
separately.

For each certificate, you can specify any combination, all, or none of the following encryption methods:

null-encryption
require-ike-v2
tunnel (with either an IPv4 or IPv6 tunnel type, plus a tunnel IP address)

Formats
For a certificate that uses an IP address:
ipsec security-params create security_param certificate id-type ip-address
id-value ip_address [null-encryption] [require-ike-v2] [tunnel type type tun-
ip-addr tunnel_ip_address]
For a certificate that uses a domain name:
ipsec security-params create security_param certificate id-type domain-name
id-value domain_name [null-encryption] [require-ike-v2] [tunnel type type
tun-ip-addr tunnel_ip_address]
For a certificate that uses an email address:
ipsec security-params create security_param certificate id-type email-
address id-value email_address [null-encryption] [require-ike-v2] [tunnel
type type tun-ip-addr tunnel_ip_address]

Group Management Commands 147


For a certificate that uses a distinguished name:
ipsec security-params create security_param certificate id-type
distinguished-name id-value distinguished_name [null-encryption] [require-
ike-v2] [tunnel type type tun-ip-addr tunnel_ip_address]

Variables
Variable Description
security_param Specifies the name of the security parameter to create

ip_address IP address of the host that is allowed to connect to the group

domain_name Name of an Active Directory domain that is allowed to connect to the


group. For example: MYDEPT.myemail.net

email_address Email address of a user that is allowed to connect to the group

distinguished_name Distinguished name that is allowed to connect to the group. For


example: C=US,ST=Texas,L=Austin,O=MyPlace

Parameters
Parameter Description
null-encryption Specifies null encryption for the security certificate

require-ike-v2 Specifies IKE-V2 encryption for the security certificate

tunnel type v4|v6 Specifies a tunnel to an IP address for the security certificate, and
whether the tunnel uses IPv4 or IPv6 protocol

tun-ip-addr Specifies the IP address of the tunnel endpoint.


tunnel_ip_address

Formatting Distinguished Names


You can enter Distinguished Names (DN) using any characters that are valid in the CLI (including both
ASCII and non-ASCII characters). However, the following restrictions apply:

The string must comply with the syntax rules specified in Internet Engineering Task Force (IETF) RFC
4514, which is available at: http://www.ietf.org. In this context, this rule requires that you must escape
all spaces, as well as the following nonalphanumeric characters, by preceding them with a backslash
(\) character: " # + , ; < > = \ Special characters must be escaped only when they are part of the value
of a component. When used as delimiters or syntactic markers, they should not be escaped. Using
D=US! as an example, the exclamation mark (!) must be escaped, and the equal sign (=) must not.
You must enclose the string in quotation marks if it contains nonalphanumeric characters, including
non-ASCII or Unicode (double-byte) characters.
If the string itself contains quotation marks or null characters, you must enter them in hexadecimal
notation. For example:

A string containing only alphanumeric characters that does not require encapsulation in quotation
marks: C=US, O=Dell, CN=EquallogicArray42
A string containing nonalphanumeric characters that do not need to be escaped: "C=US!,
O=Dell, CN=EqualLogicArray-42"

148 Group Management Commands


A string containing nonalphanumeric characters that must be escaped:"C=US, O=Dell,
CN=EqualLogic\+Array\ 42"

Examples
Create a certificate-based security parameter:

> ipsec security-params create RemPeer_CERT_Auth certificate id-type


distinguished-name id-value "CN=RemPeerDN"

Create a certificate-based security parameter using tunneling:

> ipsec security-params create RemPeer_CERT_Auth_Tunnel certificate id-type


distinguished-name id-value "CN=RemPeerDN" tunnel type v4 tun-ip-addr
192.0.2.20 require-ike-v2

See Also
ipsec
ipsec certificate
ipsec policy
ipsec security-association

ipsec security-params create manual-key


Creates IP security parameters using a manual key.
CAUTION:
Do not use this command. The command is included in the Group Manager CLI only to satisfy a
certification suite. Using the command can lead to extremely serious security risks. Do not use this
command.

Format
ipsec security-params create security_param manual-key
auth-algorithm auth_alg auth-key-in inbound_key auth-key-out outbound_key
spi-inbound number spi-outbound number encrypt-algorithm enc_alg
[tunnel type type tun-ip-addr tunnel_ip_address]

Variable
Variable Description
security_param Specifies the name of the security parameter to create

Parameters
Parameter Description
auth-algorithm Specifies the authentication algorithm for the manual key. Either:
auth_alg
sha1 For Secure Hash Algorithm version 1 (SHA-1)

Group Management Commands 149


Parameter Description
sha256 For Secure Hash Algorithm version 2 (SHA-2) with a 256-
bit digest

auth-key-in Specifies the inbound security authentication key


inbound_key

auth-key-out Specifies the outbound security authentication key


outbound_key

spi-inbound number Specifies the inbound SPI. This number must be in the range between
255 and 4096.

spi-outbound number Specifies the outbound SPI. This number must be in the range between
255 and 4096.

encrypt-algorithm Specifies the encryption algorithm for the key. Options are:
enc_alg
3des-cbc
aes-cbc
null

For the 3des-cbc or aes-cbc encryption algorithms, you must also


specify an inbound and outbound encryption key with the encrypt-
key-inkey_inand encrypt-key-outkey_out parameters.

tunnel type v4|v6 Specifies using tunnel mode and the tunnel type (either v4 or v6)

tun-ip-addr Specifies the tunnel IP address. Used only if you specified tunnel mode.
tunnel_ip_address

See Also
ipsec
ipsec certificate
ipsec policy
ipsec security-association

ipsec security-params create pre-shared-key


Creates IP security parameters using a pre-shared key.
For each pre-shared key, you can specify any combination, all, or none of the following encryption
methods:

null-encryption
require-ike-v2 (with either an IP address, domain name, email address, or distinguished name)
tunnel (with either an IPv4 or IPv6 tunnel type, plus a tunnel IP address)

Each command format is listed separately.

150 Group Management Commands


Formats
For a pre-shared key that uses IKE v2 with an IP address:
ipsec security-params create security_param pre-shared-key key string [null-
encryption] [tunnel type type tun-ip-addr tunnel_ip_address][require-ike-v2
id-type ip-address id-value ip_address]
For a pre-shared key that uses IKE v2 with a domain name:
ipsec security-params create security_param pre-shared-key key string [null-
encryption] [tunnel type type tun-ip-addr tunnel_ip_address] [require-ike-v2
id-type domain-name id-value domain_name]
For a pre-shared key that uses IKE v2 with an email address:
ipsec security-params create security_param pre-shared-key key string [null-
encryption] [tunnel type type tun-ip-addr tunnel_ip_address] [require-ike-v2
id-type email-address id-value email_address]
For a pre-shared key that uses IKE v2 with a distinguished name:
ipsec security-params create security_param pre-shared-key key string [null-
encryption] [tunnel type type tun-ip-addr tunnel_ip_address] [require-ike-v2
id-type distinguished-name id-value distinguished_name]

Variables
Variable Description
security_param Specifies the name of the security parameter to create

key string Specifies the name of the pre-shared key. Pre-shared key names can be
from 6 to 32 characters, and can contain letters, numbers, or any of the
following nonalphanumeric characters: ! " # $ % & ( ) * + , - . / : ; < = > ?
@[\]^_`{|}~

ip_address IP address of the host or tunnel that is allowed to connect to the group

domain_name Name of an Active Directory domain that is allowed to connect to the


group. For example: MYDEPT.myemail.net

email_address Email address of a user allowed to connect to the group

distinguished_name Distinguished name that is allowed to connect to the group. For


example: C=US,ST=California,L=Roseville,O=MyPlace
See Formatting Distinguished Names for more information.

Parameters
Parameter Description
null-encryption Specifies null encryption for the security parameter

require-ike-v2 id- Specifies IKEv2 encryption for the security parameter.


type type id-value
The ID type is either an IP address, domain name, email address, or
value
distinguished name. The ID value is the information for the ID type.

tunnel type v4|v6 Specifies tunnel mode, and the tunnel type (either v4 or v6)

Group Management Commands 151


Parameter Description
tun-ip-addr Specifies the tunnel IP address
tunnel_ip_address

Formatting Distinguished Names


You can enter Distinguished Names (DN) using any characters that are valid in the CLI (including both
ASCII and non-ASCII characters). However, the following restrictions apply:

The string must comply with the syntax rules specified in Internet Engineering Task Force (IETF) RFC
4514, which is available at: http://www.ietf.org. In this context, this rule requires that you must escape
all spaces, as well as the following nonalphanumeric characters, by preceding them with a backslash
(\) character: " # + , ; < > = \
Special characters must be escaped only when they are part of the value of a component. When used
as delimiters or syntactic markers, they should not be escaped. Using D=US!as an example, the
exclamation mark (!) must be escaped, and the equal sign (=) must not.
You must enclose the string in quotation marks if it contains nonalphanumeric characters, including
non-ASCII or Unicode (double-byte) characters.
If the string itself contains quotation marks or null characters, you must enter them in hexadecimal
notation. For example:

A string containing only alphanumeric characters that does not require encapsulation in quotation
marks: C=US, O=Dell, CN=EquallogicArray42
A string containing nonalphanumeric characters that do not need to be escaped: "C=US!,
O=Dell, CN=EqualLogicArray-42"
A string containing nonalphanumeric characters that must be escaped: "C=US, O=Dell,
CN=EqualLogic\+Array\ 42"

Examples
Create a security parameter based on a pre-shared key:

> ipsec security-params create RemPeer_PSK_Auth pre-shared-key key 45TrUsTvErIfY

Create a security parameter based on a pre-shared key that uses tunneling and requires IKEv2 with a
domain name:

> ipsec security-params create RemPeer_PSK_Auth_Tunnel pre-shared-key key


22B4Ten tunnel type v6 tun-ip-addr fc00::10.::125::56::11 require-ike-v2 id-
type domain-name id-value RemPeer.company.com

See Also
ipsec
ipsec certificate
ipsec policy
ipsec security-association

152 Group Management Commands


ipsec security-params delete
Deletes an IP security parameter.

Format
ipsec security-params delete security_parameter

Variable
Variable Description
security_parameter Name of the IP security parameter to be deleted

Example
Delete a specific security parameter:

> ipsec security-params delete kirt24-grp-params

ipsec security-params select show


Displays information about a specific security peer.

Format
ipsec security-params select security_peer show

Variable
Variable Description
security_peer Name of the security peer

Example
Display information about a security peer for the group:

> ipsec security-params select peer1 show

ipsec security-params show


Displays IP security parameters.

Format
ipsec security-params show parameter

Group Management Commands 153


Parameters
Parameter Description
certificate Displays all IP security parameters that use a certificate

manual-key Displays all IP security parameters that use a manual key

pre-shared-key Displays all IP security parameters that use a pre-shared key

Examples
Display All Security Parameters

Display all the security parameters for the group:

> ipsec security-params show


_________________________________ Certificate ________________________________
Security Parameters ID Type Identifier Null Enc IKE V2 Tunnel Mode
------------------- --------- ---------------------- -------- ------ ---------
_________________________________ Manual Key _________________________________
Security Parameters Enc Alg SPI Out SPI In
--------------------------------------- -------- ---------- ----------
_______________________________ Pre-Shared Key _______________________________
Security Parameters Pre-Shared Key Null Enc IKE V2 Tunnel Mode
------------------- -------------------------------- -------- ------ ---------
kirt24-grp-params my_shared_key no no no

Display Security Parameters

Display all the security parameters for the group that use a certificate (output is formatted for readability):

> ipsec security-params show certificate


_________________________________ Certificate ________________________________
Security Parameters ID Type Identifier Null Enc IKE V2 Tunnel Mode
------------------- --------- ---------------------- -------- ------ ---------
Security Parameters ID Type Identifier Null Enc IKE V2 Tunnel Mode
------------------- --------- ---------------------- -------- ------ ---------
win7_ipv4_cert dstngd-nm C=US, ST=nh, L=mytown, no no no
O=comp, OU=sqa, CN=kings1950win7, emailAddress=kings1950win7@comp.com
bunt_ipv4_cert_ik dstngd-nm C=US, ST=nh, L=mytown, no yes no
ev2
O=comp, OU=sqa, CN=bunt, emailAddress=bunt@comp.com
ipv4_cert_ikev2_nul dstngd-nm C=US, ST=nh, L=mytown, yes yes no
l
O=comp, OU=sqa, CN=gyaos610bunt, emailAddress=gyaos610bunt@comp.com

Display all the security parameters for the group that use a manual key:

> ipsec security-params show manual-key


Security Parameters Enc Alg SPI Out SPI In
--------------------------------------- -------- ---------- ----------
mangia13deseth0 3des-cbc 2100 1100
mangia13deseth1 3des-cbc 2101 1101

154 Group Management Commands


Display all the security parameters for the group that use a pre-shared key:

> ipsec security-params show pre-shared-key


_______________________________ Pre-Shared Key _______________________________
Security Parameters Pre-Shared Key Null Enc IKE V2 Tunnel Mode
------------------- -------------------------------- -------- ------ ---------
w2k8_ipv4_psk password no no no
w2k8_ipv4_psk password no no no
w2k8_ipv4_psk password no no no
ed_cluster_psk password no no no
ikev2-sec-param password no yes no
ipv4_tun_psk password no no yes
ipv4_tun_psk_null password yes no yes

See Also
ipsec
ipsec certificate
ipsec policy
ipsec security-association

ipsec show
Displays the IPsec certificates and security parameters for the group.

Format
ipsec show

Example
Display the IPsec certificates and security parameters configured on the group:

> ipsec show


IP Security: enabledGroup IPSec Capable: yes
_______________________________ CERTIFICATES _________________________________
Certificate Name Type Format
-------------------------------- ------------ -------
____________________________ SECURITY PARAMETERS _____________________________
________________________________ Certificate _________________________________
Security Parameters ID Type Identifier Null Enc IKE V2 Tunnel Mode
------------------- --------- ---------------------- -------- ------ ---------
_________________________________ Manual Key _________________________________
Security Parameters Enc Alg SPI Out SPI In
--------------------------------------- -------- ---------- ----------
_______________________________ Pre-Shared Key _______________________________
Security Parameters Pre-Shared Key Null Enc IKE V2 Tunnel Mode
------------------- -------------------------------- -------- ------ ---------
swat-client02 client02key no no no
swat-client04 client04key no no no
swat-client05 client05key no no no
__________________________________ POLICIES __________________________________
Note: Policies are applied in order shown.
Name IP Prefix Prot RPort LPort Security Params Action
------------- -------------------- -------- ----- ----- --------------- ------
swat-client02 192.0.2.21/32 any any any swat-client02 prot
swat-client04 192.0.2.23/32 any any any swat-client04 prot
swat-client05 192.0.2.25/32 any any any swat-client05 prot

Group Management Commands 155


swat-client05 192.0.2.27/32 any any any swat-client05 prot
swat-client04 192.0.2.29/32 any any any swat-client04 prot
-246
swat-client02 192.0.2.31/32 any any any swat-client02 prot
-213
swat-client02 192.0.2.33/32 any any any swat-client02 prot
-211
swat-client02 192.0.2.35/32 any any any swat-client02 prot
-214
swat-client02 192.0.2.37/32 any any any swat-client02 prot
-212
swat-client02 192.0.2.39/32 any any any swat-client02 prot
-210
swat-client04 192.0.2.41/32 any any any swat-client04 prot
-192
swat-client04 192.0.2.43/32 any any any swat-client04 prot
-185
swat-client04 192.0.2.45/32 any any any swat-client04 prot
-255
swat-client04 192.0.2.47/32 any any any swat-client04 prot
-253
swat-client05 192.0.2.49/32 any any any swat-client05 prot
-221

ldap
Manages LDAP and Active Directory authentication within a PS Series group.

Format
ldap subcommand

Subcommands
Subcommand Description
ad-group Adds, removes, modifies, or displays information about one or all Active
Directory user groups that have administrative privileges in the group

ad-server Configures and displays information about the Active Directory servers.
Only group administrator accounts can configure Active Directory
servers.

ad-user Adds, removes, modifies, or displays information about one or all Active
Directory user accounts or a specific AD user in the group

authentication Enables or disables LDAP authentication for the group

server-list Configures and displays information about the LDAP server list

show Displays information about the groups LDAP authentication


configuration

156 Group Management Commands


ldap ad-group
Adds, removes, modifies, or displays information about Active Directory groups that have been given
administrative privileges in the PS Series group.

Format
ldap ad-group subcommand

Subcommands
Subcommand Description
add Grants administrator privileges to all accounts in an Active Directory
group

delete Revokes administrator privileges for all accounts in the Active Directory
group

select Modifies the Active Directory group

select show Displays information about a specific Active Directory group

show Displays information about all Active Directory groups

ldap ad-group add


Adds an Active Directory group. All accounts in the group will have administrator access to the group as
specified by the command.

Formats
ldap ad-group add name group-admin [read-only]
ldap ad-group add name pool-admin pools pool_list [group-read-access]
ldap ad-group add name volume-admin pool-quota-list pool_quota_list partners
partner_list

Variables
Variable Description
name Active Directory group name, up to 63 ASCII characters

pool_list Comma-separated list of storage pools to which the account has


access

pool_quota_list Comma-separated list of pools to which the account has access,


including the storage quota within the pool. For example: pool1,300GB

partner_list Comma-separated list of replication partners to which the volume


administrator accounts can replicate volumes. For example:
partnerA,partnerB

Group Management Commands 157


Parameters
Parameter Description
group-admin [read-only] Grants group administrator privileges to the accounts in the
Active Directory group.
Specify read-only to give the Active Directory group users
read-only access to the group. Specify read-write to give
the users read-write access.

pool-admin pools pool_list Grants the accounts in the Active Directory group pool
[group-read-access] administrator access to the specified pools.
Optionally, specify group-read-access to give the Active
Directory group users read-only access to the group.

volume-admin pool-quota-list Grants the accounts in the Active Directory group volume
pool_quota_list administrator privileges within the specified pool, as well as
an assigned storage quota

partners partner_list Applies only to the volume-admin parameter. Specifies the


replication partners to which volume administrators can
replicate their volumes.

Examples
Add an Active Directory group for which all users will be volume administrators with a 100GB quota in the
default storage pool:

> ldap ad-group add storage1 volume-admin pool-quota-list default,100GB

Add an Active Directory group for which all users will have group administrator privileges:

> ldap ad-group add storage1 group-admin

Add an Active Directory group for which all users will be pool administrators for the default storage pool:

> ldap ad-group add storage1 pool-admin pools default

ldap ad-group delete


Removes administrator account privileges for the specified Active Directory group.
NOTE: This command removes the Active Directory group from the PS Series group; it does not
remove the group from Active Directory.

Format
ldap ad-group delete group

158 Group Management Commands


Variable
Variable Description
group Active Directory group to delete

Example
Remove an Active Directory group:

> ldap ad-group delete storage1

ldap ad-group select


Modifies permissions of the specified Active Directory group.

Formats
ldap ad-group select group show
ldap ad-group select group group-admin [read-only|read-write]
ldap ad-group select group pool-admin pools pool_list [group-read-access]
ldap ad-group select group volume-admin pool-quota-list pool_quota_list
[partners partner_list]

Variables
Variable Description
group Active Directory group name

pool_list List of storage pools to which the account has access

pool_quota_list List of pools to which the account has access, including the storage
quota within the pool. For example: pool1,300GB

partner_list List of replication partners to which the volume administrator accounts


can replicate volumes

Parameters
Parameter Description
group-admin [read- Grants group administrator privileges to the account.
only|read-write]
Specify read-only to give the user read-only access to the group.
Specify read-write to give the user read-write access.

pool-admin pools Grants the account pool administrator access to the specified pools.
pool_list [group-read-
Specify group-read-access to give the Active Directory user read-
access]
only access to the group.

Group Management Commands 159


Parameter Description
volume-admin pool- Grants the accounts in the Active Directory group volume administrator
quota-list privileges within the specified pool, as well as an assigned storage quota
pool_quota_list

partners partner_list Specifies the replication partners to which volume administrators can
replicate their volumes. Applicable only with the volume-admin
parameter.

show Displays information about the specified Active Directory group

Examples
Grant pool administrator privileges for a storage pool to the accounts in an Active Directory group:

> ldap ad-group select storage1 pool-admin pools shares

Grant group administrator privileges to the accounts in an Active Directory group:

> ldap ad-group select storage1 group-admin

Grant volume administrator privileges within a storage pool to the accounts in an Active Directory group,
with each account having a quota of 100GB and replication partnership privileges to two other groups:

> ldap ad-group select storage1 volume-admin pool-quota-list shares,100GB


partners group2,group3

ldap ad-group select show


Displays information about the specified Active Directory group.

Format
ldap ad-group select group show

Variable
Variable Description
group Active Directory group to display information about

Example
Display information about an Active Directory group:

> ldap ad-group select storage1 show


____________________________ AD Group Information ____________________________
Name: storage1 Permission: read-write
Privilege: volume-admin Pools: default
VolumeQuota (MB): 10240 ReplicationPartners:
______________________________________________________________________________

160 Group Management Commands


ldap ad-group show
Lists the Active Directory groups that have been added to the PS Series groups list of administrators.

Format
ldap ad-group show

Example
Display the list of Active Directory groups:

> ldap ad-group show


_________________ Active Directory Groups - Allowed Access __________________
Name Permission Privilege
-------------------- ---------- -------------
Marketing read-write volume-admin
Engineering read-write group-admin
Volume-Admins read-write volume-admin
storage1 read-write volume-admin
Backup Operators read-write pool-admin

ldap ad-server
Configures and displays information about the Active Directory servers. Only group administrator
accounts can configure Active Directory servers.

Format
ldap ad-server subcommand

Subcommands
Subcommand Description
get-join-status Checks whether the group is currently registered with Active Directory

join user_name Adds the group to the current set of AD servers. You must specify a user
name for Active Directory server authentication.

leave user_name Removes the group from the current set of AD servers. You must
specify a user name for Active Directory server authentication.

Example
Add the group to the list of AD servers, and supply the AD server authentication user name:

> ldap ad-server join ADadmin


Enter password:
Retype paswword:

Group Management Commands 161


Display whether the group is currently registered with Active Directory:

> ldap ad-server get-join-status


PS Group SSO : Configured
AD Server SSO Status: Joined

Remove the group from the Active Directory domain. You must specify the AD user name for
authentication.

> ldap ad-server leave ADadmin


Enter password:
Retype paswword:

ldap ad-user
Adds, removes, modifies, or displays information about Active Directory user accounts that have
administrative privileges in the group.

Format
ldap ad-user subcommand

Subcommands
Subcommand Description
add Adds an Active Directory user to the groups list of administrator
accounts

delete Removes the Active Directory user account from the group

select Modifies an Active Directory user account

select show Displays information about a specific Active Directory account

show Displays information about all Active Directory accounts

ldap ad-user add


Adds an Active Directory account to the list of administrator accounts in the group.

Formats
ldap ad-user add name group-admin [read-only]
ldap ad-user add name pool-admin pools [group-read-access]
ldap ad-user add name volume-admin pool-quota-list pool_quota_list [partners
partner_list]

162 Group Management Commands


Variables
Variable Description
name Active Directory user name. Up to 63 characters, including underscore,
hyphen, or period.

pools Comma-separated list of storage pools to which the account has


access. Applies only to the pool-admin parameter.

pool_quota_list Comma-separated list of pools to which the account has access,


including the storage quota within the pool (for example:
pool1,300GB). Applies only to the volume-admin parameter.

partner_list Comma-separated list of replication partners to which the volume


administrator accounts can replicate volumes. Applies only to the
volume-admin parameter.

Parameters
Parameter Description
group-admin [read- Grants group administrator privileges to the account.
only|read-write]
Specify read-only to grant the user read-only access to the group.
Specify read-write to grant the user read-write access.

pool-admin pools Grants the account pool administrator access to the specified pools.
pool_list [group-read-
Optionally, specify group-read-access to grant the Active Directory
access]
user read-only access to the group.

volume-admin pool- Grants the accounts volume administrator privileges within the
quota-list specified pool, as well as an assigned storage quota
pool_quota_list

partners partner_list Specifies the replication partners to which a volume administrator can
replicate volumes. Applies only to thevolume-admin parameter.

Examples
Create an Active Directory user with group administrator privileges:

> ldap ad-user add peter group-admin

Create an Active Directory user with read-only access to the group:

> ldap ad-user add greg group-admin read-only

Create an Active Directory user with pool administrator access to two pools and with read access to the
entire group:

> ldap ad-user add danielle pool-admin pools default,pool1 group-read-access

Group Management Commands 163


Create an Active Directory user with volume administrator access to two pools, with a 100GB quota in
the default pool and an unlimited quota in pool1. This user also has access to two replication partners.

> ldap ad-user add maria volume-admin pool-quota-list default,


100GB,pool1,unlimited partners groupD,big_group

ldap ad-user delete


Removes the administrator account for the specified Active Directory user.
NOTE: This command removes the Active Directory user from the PS Series group; it does not
remove the account from Active Directory.

Format
ldap ad-user delete user_name

Variable
Variable Description
user_name Active Directory user name

Example
Delete an Active Directory user:

> ldap ad-user delete mike

ldap ad-user select


Modifies the administration privileges for the selected user.

Formats
ldap ad-user select name group-admin [read-only|read-write]
ldap ad-user select name pool-admin pools group-read-access
ldap ad-user select name volume-admin pool-quota-list pool_quota_list [partners
partner_list]

Variables
Variable Description
name Active Directory user name

pools Comma-separated list of storage pools to which the account has


access. Applies only to the pool-admin parameter.

pool_quota_list Comma-separated list of pools to which the account has access,


including the storage quota within the pool (for example:
pool1,300GB). Applies only to the volume-admin parameter.

164 Group Management Commands


Variable Description
partner_list Comma-separated list of replication partners to which the volume
administrator accounts can replicate volumes. Applies only to the
volume-admin parameter.

Parameters
Parameter Description
group-admin [read-only|read- Grants group administrator privileges to the account. By
write] default, the account will have read-write access.
Specify read-only to grant the user read-only access to the
group.

pool-admin pools [group-read- Grants the account pool administrator access to the specified
access] pools.
Specify group-read-access to grant the Active Directory
user read-only access to the group.

volume-admin pool-quota-list Grants the accounts volume administrator privileges within


pool_quota_list the specified pool, as well as an assigned storage quota

partners partner_list Specifies the replication partners to which a volume


administrator can replicate volumes. Applies only to the
volume-admin parameter.

Examples
Change a user to a read-only account:

> ldap ad-user select greg group-admin read-only

Give pool administrator access to a user, granting her access to two pools:

> ldap ad-user select paula pool-admin default,pool1

ldap ad-user select show


Displays information about the specified Active Directory user.

Format
ldap ad-user select user_name show

Variable
Variable Description
user_name Active Directory user name to display

Group Management Commands 165


Examples
The following commands display information for users with different privileges or permissions:

> ldap ad-user select aduser12 show


_____________________________ AD User Information ____________________________
Name: aduser12
Permission: read-only
Privilege: group-admin
______________________________________________________________________________
> ldap ad-user select aduser11 show
_____________________________ AD User Information ___________________________
Name: aduser11
Permission: read-write
Privilege: group-admin
______________________________________________________________________________
> ldap ad-user select aduser17 show
_____________________________ AD User Information ____________________________
Name: aduser17
Permission: read-write
Privilege: pool-admin
Pools: default
______________________________________________________________________________
> ldap ad-user select aduser15 show
_____________________________ AD User Information ____________________________
Name: aduser15
Permission: read-write
Privilege: volume-admin
Pools: default,Pool1
Volume Quota (MB): 204800,unlimited
Replication Partners: vanilla13-grp
______________________________________________________________________________

ldap ad-user show


Displays information about the Active Directory users that have administrator accounts in the group.

Format
ldap ad-user show

Example
> ldap ad-user show
__________________ Active Directory Users - Allowed Access ___________________
Name Permission Privilege
-------------------- ---------- -------------
volume_admin_eng read-write volume-admin
volume_admin_sales read-write volume-admin
volume_admin_market read-write volume-admin
group_admin read-write group-admin
pool_admin_1 read-write pool-admin
pool_admin_2 read-write pool-admin

166 Group Management Commands


pool_admin_3 read-write pool-admin
user_guest read-only group-admin

ldap authentication
Enables or disables LDAP authentication for administrator accounts in the group.

Format
ldap authentication enable|disable

Example
Enable LDAP authentication:

> ldap authentication enable

ldap server-list
Manages LDAP servers for the group.

Format
ldap server-list subcommand

Subcommands
Subcommand Description
create Creates a prioritized list of Active Directory servers

delete Deletes all configured Active Directory server addresses

select Selects the Active Directory authorization server to configure

select show Shows the configuration of the selected Active Directory server

show Shows the configuration of all Active Directory servers

ldap server-list create


Adds an LDAP server to the groups list of LDAP servers.

Format
ldap server-list create base-dn base_dn secure-protocol none|tls ip-addr-list
address_list anonymous-access bind-dn bind_dn

Group Management Commands 167


Variables
Variable Description
base_dn Base Distinguished Name (DN). Starting point when searching for user
accounts.
The value specified for base_dn must contain the Common Name (cn)
of the user account on the top-most level and one of the following
Relative Distinguished Names (RDN) on the bottom level:
Domain Component (dc)
Organization Name (o)
Country Name (c)
Locality Name(l)

Examples of valid names:

'cn=username,us=users,dc=ldap,dc=company,dc=com'

bind_dn Bind Distinguished Name (DN). Required if anonymous access is not


allowed. If anonymous access is allowed, this variable is not used.
The value specified for bind_dn must contain the Common Name (cn)
of the user account on the top-most level and one of the following
Relative Distinguished Names (RDN) on the bottom level:
Domain Component (dc)
Organization Name (o)
Country Name (c)
Locality Name(l)

Examples of valid names:

'cn=username,ou=org_unit,dc=company,dc=com

For more information about distinguished name usage, see Formatting Distinguished Names.

Parameters
Parameter Description
anonymous-access Enables anonymous access to the directory

base-dn base_dn Sets the Base Distinguished Name (DN)

bind-dn bind_dn Sets the Bind Distinguished Name (DN)

ip-addr-list Comma-separated IP addresses for the Active Directory server. Up to 3


address_list IP addresses, with optional port values, can be used. For example: ip-
addr-list 192.0.2.21:389,192.0.2.31:389,192.0.2.41:389

secure-protocol tls| Specifies the secure protocol used for communications with the Active
none Directory server: TLS or none (unsecured communications)

168 Group Management Commands


Example
Create a server list for the EqualLogic domain, using the TLS protocol, and enabling anonymous access
to the directory:

> ldap server-list create base-dn DC=aaadomain,DC=equallogic,DC=com


secure-protocol tls ip-addr-list 192.0.2.47 anonymous-access

Create a server list for the EqualLogic domain, using the TLS protocol and Bind Distinguished Name
options:

> ldap server-list create base-dn DC=aaadomain,DC=equallogic,DC=com


bind-dn cn=username,ou=org_unit,dc=company,dc=com secure-protocol tls ip-addr-
list 192.0.2.53

ldap server-list delete


Removes the specified LDAP server from the groups list of Active Directory servers.

Format
ldap server-list delete priority_index

Variable
Variable Description
priority_index Server priority number. Use the ldap server-list show command to
display the list of servers and their respective priorities.

Example
Remove the LDAP server with an index value of 1:

> ldap server-list delete 1

ldap server-list select


Selects an LDAP server for additional operations.

Format
ldap server-list select priority_index [ipaddress ip_address]

Variables
Variable Description
priority_index Server priority number. Use the ldap server-list show command to
display the priority index numbers.

ip_address Server IP address

Group Management Commands 169


Parameter
Parameter Description
ipaddress ip_address Specifies the IP address that the group uses for attempting
communications with the Active Directory server. This command does
not change the LDAP servers IP address.

Example
Set the IP address that the group will use to communicate with the server (which has an index value of 1):

> ldap server-list select 1 ipaddress 192.0.2.35

ldap server-list select show


Displays information about the specified LDAP server.

Format
ldap server-list select priority_index show

Variable
Variable Description
priority_index Server priority number. Use the ldap server-list show command to
display the list of servers and their respective priorities.

Example
Display information about the LDAP server with an index value of 1:

> ldap server-list select 1 show


__________________________ LDAP Server Information ___________________________
Priority:1 IPAddress: 192.0.2.27:256
Secure Protocol: none Base DN Name:
Bind DN Name: aaadomain\Administrator DC=aaadomain,DC=mycompany,DC=com
______________________________________________________________________________

ldap server-list show


Lists the LDAP servers that the group is configured to use for Active Directory authentication.

Format
ldap server-list show

Example
> ldap server-list show
___________________________ Configured LDAP Servers __________________________

170 Group Management Commands


Priority IP Address Port Secure Protocol Base DN
-------- --------------- ---- --------------- ------------------------------
1 192.0.2.27 389 none DC=activedir1,DC=domain,DC=com
2 192.0.2.39 389 none DC=activedir2,DC=domain,DC=com

ldap show
Displays information about the groups Active Directory authentication configuration.

Format
ldap show

Example
Display the groups Active Directory authentication configuration:

> ldap show


LDAP Authentication _____________________________
LDAP Admin Authentication: Disabled
_______________________________________________________________________________

___________________________ Configured LDAP Servers ___________________________

Priority IP Address Port Secure Protocol Base DN


-------- --------------- ---- --------------- ------------------------------

___________________ Active Directory Users - Allowed Access ___________________

Name Permission Privilege


-------------------- ---------- -----------------

__________________ Active Directory Groups - Allowed Access ___________________

Name Permission Privilege


-------------------- ---------- -----------------

local-groups search
Searches for a specified user in the defined local group.

Format
local-groups search search_string

Group Management Commands 171


Variable
Variable Description
search_string Searches for users in the Active Directory database that match the terms
in the search string

Example
> unix-groups search a
Name Type Source
---------------------------------------- -------- --------
Bnas30+Administrators Windows Local

member
Manages group members.

Format
member subcommand

Subcommands
Subcommand Description
delete Removes a member from the group

rename Renames a member

select Shows or modifies a member configuration, including the network


configuration, pool membership, and RAID policy for the member

show Shows information about all the group members or a specific member

member delete
Removes a member from its pool and from the group. Resets the array to factory defaults. Resetting an
array removes any group, member, and volume configuration information on the array.

Restrictions
You can remove only one member at a time.

You cannot remove a group member in the following circumstances:

The member is the only remaining member of a group.


The member is the only member in a pool that contains volumes. You must move the volumes to a
different pool before you can remove the member.
The member is offline.
All volumes, snapshots, and replica sets stored on the member are moved (vacated) to the other pool
members, with no effect on availability. If the other pool members do not have enough free space to

172 Group Management Commands


store the data from the member being removed, the operation fails. Increase the capacity of the
remaining members and retry the operation.

You can cancel an in-progress member delete operation. To see member status, use the member show
command. While volume data is moving to other members, the member status is vacating-in-
progress. When complete, the member no longer shows in the member show output.

In rare cases, you might need to remove a member that is offline (for example, if the member has failed
and is no longer operational). Because deleting an offline member can have serious or unintended
consequences, you must contact your support provider to proceed.

Format
member delete member_name

Variable
Variable Description
member_name Name of a member

Example
Remove a member from its pool and the group:

> member delete member16


Do you really want to delete the member? (y/n) [n] y
Member deletion succeeded.

Deleting a Member from an IPsec-Enabled Group


If the group (and all its members) are IPsec-enabled, when you delete a member from the group, you
might see a series of repeating error messages, such as:

# 3255:1361:quicksecpm:17-May-2015
13:37:22.431122:util_render.c:254:ERROR::65.4.1:IPsec (IKEv2) negotiation
failed as responder to remote identity: '192.0.2.28: (null)', using local
identity: '192.0.2.52: (null)'.
3257:1363:quicksecpm:17-May-2015
13:37:22.431124:util_render.c:323:ERROR::65.4.7:The IPsec or IKE protocols or
algorithms proposed by the peer do not match what is available on the array.

You can safely ignore these messages. The member deletion is completing normally. These error
messages will be removed in a future release.

member rename
Renames a member.

Format
member rename current_name new_name

Group Management Commands 173


Variables
Variable Description
current_name Name of a member

new_name New member name, up to 63 ASCII characters

Example
Change the name of a member:

> member rename memlab1 memstaff2

member select
Modifies or shows the configuration of the selected member, including the network configuration, RAID
policy, and the pool to which the member belongs. You can also cancel an in-progress member
operation, such as a member delete (vacate) operation.

Format
member select member_name subcommand | parameter...

Variable
Variable Description
member_name Name of a member

Subcommands
Subcommand Description
data-reduction resume| Manages compression on a member
start|suspend

disk select clear- Clears the label of or shows information about the selected disk
label|show

disk show Shows information about the disks in the selected member

eth select dcb show| Shows the configuration of the selected network interface
show

eth show Shows the configuration of all the network interfaces on the member

sed-backup-key Manages key shares for group members tht use encrypted drives

show [component] Shows detailed information about the member or the specified member
component:
channelcards
connections

174 Group Management Commands


Subcommand Description
controllers
disks [n]
enclosure
eths [n]
version
volumes

NOTE: Not all components are present, or in the same quantities,


in every array model.

Parameters
Parameter Description
cancel-operation op_id Cancels an in-progress move or delete operation. Use the member
select show command to obtain the operations ID number.

controller-safe Enables or disables (default) controller-safe mode for the member. The
enable|disable recommended setting is disable.

def-gateway none| Sets a default gateway for the member. The choices are none (for no
ip_address default gateway) or the IP address of the gateway to use.

delay-data-move Specifies whether or not the space on a member is usable before RAID
enable|disable verification is complete and batteries are fully charged.
If disabled (default), the member space is used immediately. However,
member performance is not optimal while the RAID verification is in
progress.

If enabled, the member space is not used until the verification


completes and the batteries are charged.

This parameter applies only when setting the member RAID policy for
the first time (see the raid-policy parameter). You can disable this
functionality at any time. However, you cannot reenable the
functionality.

description text Description for the member, up to 127 ASCII characters. If the text
contains spaces, enclose it in quotation marks.

locate enable|disable Enables or disables the flashing of array LEDs for the purpose of
locating the array.
Flashing stops automatically after 2 hours.

low-battery-safe Enables (default) or disables low-battery-safe mode for the selected


enable|disable member. The recommended setting is enable. Disabling low-battery-
safe mode is not recommended because of the risk of data loss if an
array loses power.

pool pool Adds the member to a pool. Note that moving a member from one pool
to another can be a lengthy operation, because volume data on the
member must be moved to the remaining pool members. The data

Group Management Commands 175


Parameter Description
movement will compete with user I/O for computational and network
bandwidth.
You can cancel a move operation.

Only one member at a time can be moved into or out of a pool.

raid-policy policy Sets the RAID policy for the member to one of the following levels:
[delay-data-move]
raid5 (not recommended)
raid6
raid6-accelerated (available only on certain PS Series array
models)
raid10
raid50
raid6-nospares
raid10-nospares
raid50-nospares

For the highest availability, choose a RAID policy that includes spare
disks, which are used automatically if a disk fails.

Specify delay-data-move to prevent the group from using the storage


on the member until after the RAID conversion is complete.

After you set a member RAID policy, you might be able to convert it to a
different RAID policy. However, the group does not support all RAID
policy conversions. When you convert a RAID policy, the members
RAID status is expanding.

RAID 5 does not offer optimal data protection for business-critical data
due to the higher risks of encountering a second drive failure during a
rebuild. As a result, Dell recommends against using this policy.

See the Dell EqualLogic Group Manager Administrator's Guide for more
information about specifying a members RAID policy.

raid-rebuild-delay Enables or disables (default) delaying the rebuilding of an SSD RAID set
by 24 hours to allow a new SSD to be inserted. When this feature is
enabled, an active status indicates that the 24-hour delay is in
progress.
This feature applies only to hybrid members with configurations that
include a single HDD spare but not an SSD spare. On these systems, if
you need to resolve a drive issue that is affecting the RAID set, you can
use the period of time provided by the rebuild delay feature to supply
the array with the required SSD spare. Supplying the SSD spare within
the 24-hour period prevents the array from using the HDD spare
instead, which could result in degraded system performance.

NOTE: The feature must have already been enabled on the system
before you can use it to resolve any issues.
If you try to enable this feature on an unsupported platform, the system
displays the following error message: Operation not supported on

176 Group Management Commands


Parameter Description
this platform. However, the member select show command still
displays the status of the feature on the system.

sed-backup-key Generates a new set of backup key shares for encrypted drives, or
generate|verify verifies existing key shares. See About Encrypted Drives.

About Encrypted Drives


Some array models support the use of encrypted drives. In those arrays, all the drives must be either
encrypted or not; you cannot mix encrypted and non-encrypted drives in an array.

A member with encrypted drives can belong to the same group or pool as members without encrypted
drives. However, if a volume spans members that do and do not include encrypted drives, the volume
data is not considered to be encrypted.

To ensure that all the data in a specific volume is encrypted, use only members with encrypted drives in
that pool.

If you move a volume from an all-encrypted pool to a non-encrypted pool, or to a pool with a mix of
encrypted and non-encrypted members, the volume data is no longer guaranteed to be encrypted.

If the member contains encrypted drives, setting or changing the RAID policy also generates the backup
key data for those drives.

You can copy and save the key shares to a separate location (paste the command output into another file
stored off the array).

At any time, you can display or regenerate the key shares.

Examples
Moving a Member to Another Pool

Move a member to a different pool:

> member select memlab2 pool staffpool

Setting a Default Gateway

Set a default gateway for all interfaces on the member (except the management network interface, if
any):

> member select member3 def-gateway 192.0.2.23

Setting the RAID Policy

Set the RAID policy for a new group member. Because the member contains encrypted drives, the key
shares are displayed.

> member select memlab2 raid-policy raid10


855:785:SP:27-Sep-2015 10:35:32.720786:verify.c:843:INFO::14.2.12:2:Parity
verification initiated on RAID LUN 2.
.

Group Management Commands 177


.
.
_______________________________ SED Backup Keys ______________________________
Key-Share 1:
113d02521bf928f66090a048a01ab8f31de844a94e428e4f0102350001fe61859613505e9f79b-
5d45b107909ea94ca31
0b08b50bc3d007ff6790b098fdf8518f210277bec301f7ce8a6b85c34dc08a2337
Key-Share 2:
113d02521bf928f66090a048a01ab8f31de844a94e428e4f0102350002620e6bc4d434854780c-
660421b9b8705acf127
50041785c3b485e7bd035762ba4d0cf3c637fa2dad19b7f6080c143b89f06e4c72
Key-Share 3:
113d02521bf928f66090a048a01ab8f31de844a94e428e4f0102350003162b310360e1cc0fd71-
e0cbcebc5fda94d11dc
900080ffc361fbef02720a3487d7ce2e9b24815c7e117e1776d8929a3ce03269b8
______________________________________________________________________________

member select data-reduction compression resume


Resumes suspended compression of snapshot data that is stored on the member.

Format
member select member_name data-reduction compression resume

Variable
Variable Description
member_name Name of the member

Example
Resume compression on a member:

> member select member1 data-reduction compression resume

member select data-reduction compression start


Enables compression on a member.

Format
member select member_name data-reduction compression start

Variable
Variable Description
member_name Name of the member

178 Group Management Commands


Example
Start compression on a member:

> member select MemberA data-reduction compression start


You are attempting to start compression on this member for the first time. If
you proceed, you cannot disable compression for this member. However, you can
suspend the operation. Please refer to the CLI guide for more informaion. Do
you want to proceed? (y/n)[n]

member select data-reduction compression suspend


Pauses compression on a member.

Format
member select member_name data-reduction compression suspend

Variable
Variable Description
member_name Name of the member

Example
Pause compression on a member:

> member select MemberA data-reduction compression suspend

member select disk select clear-label


Clears the label on the selected disk.
If a disk was previously installed in a different array, or removed and then reinstalled in the same array, it
has a foreign status. The disk will not be incorporated into a RAID set either as a spare or for expansion
purposes until you clear the label. If you have inadvertently inserted the drive into the array, remove it
immediately.

Format
member select member_name disk select slot_number clear-label

Variables
Variable Description
member_name Name of a member

slot_number Disk slot number. The total number of slots in a member varies based
on the array model.

Group Management Commands 179


Example
Clear the label on a disk:

> member select memlab2 disk select 0 clear-label

member select disk select show


Shows detailed information about the selected disk.

Format
member select member_name disk select slot_number show

Variables
Variable Description
member_name Name of a member

slot_number Disk slot number. The total number of slots in a member varies based
on the array model.

Example
Display information about a disk:

> member select memlab2 disk select 0 show

member select disk show


Shows information about the disks in the selected member.

Format
member select member_name disk show

Variable
Variable Description
member_name Name of a member

Example
Show information about a members disks:

> member select mem02 disk show

180 Group Management Commands


member select eth select
Configures or modifies the selected network interface, including configuring an interface for a dedicated
management network.
A dedicated management network requires that you configure the highest-numbered network interface
on each group member on the management network, which must be separate from the iSCSI network.
The management network addresses must use the IPv4 protocol. See grpparams management-network.

A network interface for iSCSI traffic can use either the IPv4 or the IPv6 protocol.

For IPv4, you must specify an IPv4 address and a netmask (subnet mask).
For IPv6, you can specify an IPv6 address, but these addresses are usually configured automatically
when you enable the interface. Subnet masks do not apply to IPv6.

Each interface can have up to eight (8) addresses. One interface can be a static IPv4 address, and one can
be a static IPv6 address (except for an interface configured for management). The other interfaces are
dynamic, and cannot be set, changed, or deleted. One of these dynamic addresses is a link-local address.

NOTE: If network problems occur, group members might lose the ability to communicate with each
other over the network. In this situation, some management operations are not allowed. For
example, you cannot change the IP address for an isolated members network interface.

Format
member select member_name eth select port_number parameter ...

Variables
Variable Description
member_name Name of a member

port_number Port number of the network interface (0, 1, or 2). For example, specify 2
for eth2.

Parameters
Parameter Description
description text Description for the network interface, up to 127 ASCII characters. If the
text contains spaces, enclose it in quotation marks.
Must be specified as a separate command.

To remove a description, enter two quotation marks ().

ipaddress address| IP address for the network interface in IPv4 format.


none [netmask mask_ip]
To remove an IP address, enter the keyword none.

You can also specify the netmask IP address on the same command
line.

Group Management Commands 181


Parameter Description
ipv6address address| IP address for the network interface in IPv6 format.
none
To remove an IP address, enter the keyword none.

lldp show Displays the LLDP (Link Layer Discovery Protocol) properties of the
Ethernet port

mgmt-only enable| Restricts the interface to dedicated management traffic. Supported only
disable on the highest-numbered network interface and only for an IPv4
address.

netmask mask_ip Netmask address (subnet mask) for the network interface. Applies only
to IPv4 addresses.

up|down Enables (up) or disables (down) the interface for I/O traffic.
Must be specified on a separate command line.

Examples
Configuring a Network Interface

The following commands configure a network interface and then enable it:

> member select m5 eth select 1 ipaddress 192.0.2.33 netmask 255.255.255.0

> member select m5 eth select 1 up

Add a description to a network interface:

> member select m5 eth select 1 description Eth-1 on member m5

Configuring a Network Interface (IPv6)

In a group using only the IPv6 protocol, you typically do not need to specify an IPv6 address for the
network interfaces. The router broadcasts available addresses. When you enable an interface, it takes one
of those addresses.

To enable a network interface in an IPv6 group and allow it to use a dynamic address, enter:

> member select member1 eth select 0 up

To configure a static IPv6 address for a network interface and enable it, enter the following commands:

> member select member1 eth select 0 ipv6address fc00::445a:a17:fcf7:686

> member select member1 eth select 0 up

To configure a static IPv6 address for a network interface that is already enabled (up), enter:

> member select scale16 eth select 2 ipv6address fc00::445a:a17:fcf7:686

Changing the IP address closes all management and iSCSI connections associated
with this IP address. Do you really want to change? (y/n) [n] y

Configuring a Management-Only Interface

182 Group Management Commands


Only the highest-numbered network interface on a member can be a management interface.
Management interfaces must use the IPv4 protocol for the management IP address.

The following commands configure eth2 as a management interface, enable the interface, and designate
it as a management-only interface:

> member select member1 eth select 2 ipaddress 192.0.2.27 netmask 255.255.0.0

> member select member1 eth sel 2 up

> member select member1 eth sel 2 mgmt-only enable

Show the details for the management-only interface:

> member select member1 eth select 2 show


_______________________________ Eth Information ______________________________
Name: eth2 Status: up
Changed: Mon Feb 9 11:38:35 2015 Type: ethernet-csmacd
DesiredStatus: up Mtu: 1500
Speed: 10 Mbps HardwareAddress: 00:09:8A:01:D1:4E
IPAddress: 192.0.2.27 NetMask: 255.255.0.0
IPv6Address: Description:
SupportsManagement: yes ManagementStatus: enabled
DCB: off
______________________________________________________________________________

member select eth select dcb show


Displays the data center bridging (DCB) configuration for the selected network interface.

Format
member select member_name eth select port_number dcb parameter show

Variables
Variable Description
member_name Name of a member

port_number Port number of the network interface to modify or configure. For


example, specify 2 for eth2.

Parameters
Parameter Description
congestion- Displays congestion notification for the selected interface
notification

lossless-priority Displays the lossless priority configuration for the selected interface

statistics Displays DCB control packet statistics information for the selected
interface

traffic-class Displays priority traffic classes for the selected interface

Group Management Commands 183


Examples
Displaying DCB Information

Display DCB information for a network interface:

> member select member3 eth select 0 dcb show


_____________________________ Eth DCB Information ____________________________
Name: eth0 DCB: on
Lossless-Priorities: on Traffic-Classes: on
Congestion Notification: off iSCSI-Priority: 4

Displaying Congestion Notification Information

Display congestion notification for an interface:

> member select member3 eth select 0 dcb congestion-notification show


Priority Status
---------- ----------
0 off
1 off
2 off
3 off
4 off
5 off
6 off
7 off

Displaying Lossless Priority Configuration

Display the lossless priority configuration for an interface:

> member select member3 eth select 0 dcb lossless-priority show


Priority Status
---------- ----------
0 off
1 off
2 off
3 off
4 off
5 off
6 off
7 off

Displaying DCB Packet Statistics

Display DCB control packet statistics information for an interface:

> member select member3 eth select 0 dcb statistics show


Priority Pause Rx Unpause Rx Congestion Rx Data Tx Data Rx
---------- ---------- ---------- --------------- ---------- ----------
0 0 0 0 2095617 2242585646
1 0 0 0 0 0
2 0 0 0 0 0
3 0 0 0 0 0
4 0 0 0 0 0
5 0 0 0 0 0
6 0 0 0 0 0
7 0 0 0 0 0

184 Group Management Commands


Displaying Traffic Classes

Display priority traffic classes for an interface:

> member select member3 eth select 0 dcb traffic-class show


Traffic Class Bandwidth Priorities
--------------- ---------- ----------
0 10% 1,2,3
1 80% 4
2 10% 5,6,7

member select eth select show


Shows the configuration of the selected network interface.

Format
member select member_name eth select port_number show

Variables
Variable Description
member_name Name of a member

port_number Port number of the network interface to modify or configure. For


example, specify 2 for eth2.

Example
Show the configuration of a network interface:

> member select member7 eth select 1 show


_______________________________ Eth Information ______________________________
Name: eth1 Status: up
Changed: Wed Jun 17 02:23:39 2015 Type: ethernet-csmacd
DesiredStatus: up Mtu: 9000
Speed: 1 Gbps HardwareAddress: 00:09:8A:08:83:CC
IPAddress: 192.0.2.53 NetMask: 255.255.248.0
IPv6Address: Description:
SupportsManagement: no ManagementStatus: disabled
DCB: off
______________________________________________________________________________

member select eth show


Shows the configuration of the network interfaces on the selected member.

Format
member select member_name eth show

Group Management Commands 185


Variable
Variable Description
member_name Name of a member

Example
Show the configuration of the network interfaces on a member:

> member select member7 eth show


Name ifType ifSpeed Mtu Ipaddress Status Errors DCB
---- ---------------- --------- ---- --------------- ------ ------ ----
eth0 ethernet-csmacd 1 Gbps 9000 192.0.2.24 up 61 off
eth1 ethernet-csmacd 1 Gbps 9000 192.0.2.32 up 61 off
eth2 ethernet-csmacd 1 Gbps 9000 192.0.2.33 up 62 off
eth3 ethernet-csmacd 10 Mbps 1500 down 0 off

member select sed-backup-key


Manages key shares for group members that use encrypted drives.
NOTE: The key shares prevent unauthorized access to the data on the drives. To restore key shares
to a group member, contact your support provider.

Format
member select member_name sed-backup-key subcommand

Variable
Variable Description
member_name Name of a group member with encrypted drives

Subcommands
Subcommand Description
generate Generates a new set of key shares for the member

verify Validates a set of key shares. You are prompted for each share one at a
time. Press Enter after entering each share to display the prompt for the
next one.

Examples
Generating Key Shares

Generate a new set of key shares that can be used to unlock the encrypted drives in the member:

> member select cryp1 sed-backup-key generate


_______________________________ SED Backup Keys ______________________________

186 Group Management Commands


Key-Share 1:
113d02521bf928f66090a048a01a58769fe824060000f0c5010235000166ac3568b5a4db7
bbbf188ca5485a2832d86c5cad7ba5150df1e14c8dd269564227b5d406660e14004e463661870-
56a19db38172
Key-Share 2:
113d02521bf928f66090a048a01a58769fe824060000f0c50102350002c1214e3761c997fddb5-
903fd9f08e67d26aec0b26c479a25a6f5d08a1f4b3f999ca2db19375cc7a6fbe83b434b6e8cbd-
79070ca6
Key-Share 3:
113d02521bf928f66090a048a01a58769fe824060000f-
0c50102350003555a67022d1b5a76fbc87a-
192f73daded6b6c39a05e52aff78ac65b4a899593bf61c502ef1482c0daeecfaa97a643340256
b77ea

Verifying Key Shares

NOTE: Because the key shares are very long, it is good practice to widen the CLI window as much
as possible so that each key share fits on one line. Making the window wider also helps with visually
scanning a share to check for data entry (or pasting) errors. Due to the page size of this document,
the example does not show each share on one line.

Verify a set of key shares for the member:

> member select cryp1 sed-backup-key verify


Key 1:
Key-Share 1:
113d02521bf928f66090a048a01a58769fe824060000f0c5010235000166ac3568b5a4db7
bbbf188ca5485a2832d86c5cad7ba5150df1e14c8dd269564227b5d406660e14004e463661870-
56a19db38172
Key-Share 2:
113d02521bf928f66090a048a01a58769fe824060000f0c50102350002c1214e3761c997f
ddb5903fd9f08e67d26aec0b26c479a25a6f5d08a1f4b3f999ca2db19375cc7a6fbe83b434b6e-
8cbd79070ca6
Key-Share 3:
113d02521bf928f66090a048a01a58769fe824060000f0c50102350003555a67022d1b5a7
6fbc87a192f73daded6b6c39a05e52-
aff78ac65b4a899593bf61c502ef1482c0daeecfaa97a64334
0256b77ea

Backup Share Keys Verified

member select show


Shows detailed information about a group member, including member status and RAID status, or a
member component. Different array models show slightly different information.

Format
member select member_name show [component]

Variables
Variable Description
member_name Name of a member

component Member component for which to show information:


channelcards

Group Management Commands 187


Variable Description
connections
controllers
disks [n]
enclosure
eths [n]
version
volumes

Examples
Displaying Member Information

Show general information about a member:

> member select spark52 show


_____________________________ Member Information _____________________________
Name: spark52 Status: online
TotalSpace: 11.34TB UsedSpace: 1.3TB
SnapSpace: 0MB Description: PS6000 Type 7 quad
Def-Gateway: 192.0.2.42 Serial-Number: SHU0935411YC6E9
Disks: 16 Spares: 1
Controllers: 2 CacheMode: write-back
Connections: 4 RaidStatus: ok
RaidPercentage: 0.000% LostBlocks: false
HealthStatus: normal LocateMember: disable
Controller-Safe: disabled Low-Battery-Safe: enabled
Version: V7.0.0 (R345131) Delay-Data-Move: disable
ChassisType: 1603 Accelerated RAID Capable: no
Pool: default Raid-policy: raid6
Service Tag: H0VKWP1 Product Family: PS6000
All-Disks-SED: no SectorSize: 512
Language-Kit-Version: not installed

______________________________________________________________________________
____________________________ Health Status Details ___________________________
Critical conditions::
None
Warning conditions::
None

______________________________________________________________________________
____________________________ Operations InProgress ___________________________
ID StartTime Progress Operation Details
-- -------------------- -------- ---------------------------------------------

Displaying Control Module Details

Show information about the control modules in an array:

> member select gigan34mem1 show controllers


___________________________ Controller Information ___________________________
SlotID: 0 Status: secondary
Model: 70-0202(TYPE 7) BatteryStatus: ok
ProcessorTemperature: 51 ChipsetTemperature: 22
LastBootTime: 2015-06-11:14:09:00 SerialNumber: RMS0935328G27C5
Manufactured: 1611 ECOLevel: C00

188 Group Management Commands


CM Rev.: A04 FW Rev.: Unreleased V7.0.0 (R345131)
NVRAM Battery: good BootRomVersion: 2.3.3
BootRomBuilDate: Tue Mar 31 16:37:31
EDT 2010

______________________________________________________________________________
______________________________________________________________________________
SlotID: 1 Status: active
Model: 70-0202(TYPE 7) BatteryStatus: ok
ProcessorTemperature: 51 ChipsetTemperature: 25
LastBootTime: 2015-06-11:14:03:25 SerialNumber: RMS0935328G27RY
Manufactured: 1611 ECOLevel: C00
CM Rev.: A04 FW Rev.: Unreleased V7.0.0 (R345131)
NVRAM Battery: good BootRomVersion: 2.3.3
BootRomBuilDate: Tue Mar 31 16:37:31
EDT 2010

______________________________________________________________________________
______________________________ Cache Information _____________________________
CacheMode: write-back Controller-Safe: disabled
Low-Battery-Safe: enabled

______________________________________________________________________________

Displaying Channel Card Details

Show information about the channel cards in an array (applies only to some PS Series array models):

> member select member1 show channelcards


____________________ Channelcard Information _____________________
SlotID: 0 Status: good
SerialNumber: ICS7139100029EA FW Rev.: V2.c
Init Rev.: V03.1

__________________________________________________________________
__________________________________________________________________
SlotID: 1 Status: good
SerialNumber: ICS713910002A25 FW Rev.: V2.c
Init Rev.: V03.1

__________________________________________________________________

Displaying Disk Details

Show the disks installed in a member:

> member select member1 show disks


Slot Type Model Size RPM Status Errors SMART Health
---- -------- ---------------- ----------- ----- --------- ------ ------------
0 SATA(HDD SEAGATE ST310003 931.51GB 7200 online 0 ok
) 40NS
1 SATA(HDD SEAGATE ST310003 931.51GB 7200 online 0 ok
) 40NS
2 SATA(HDD ST31000340NS 931.51GB 7200 online 0 ok
)
3 SATA(HDD Unavailable 0MB 7200 failed 0 unavailable
)
4 SATA(HDD SEAGATE ST310003 931.51GB 7200 online 0 ok
) 40NS
5 SATA(HDD Unavailable 0MB 7200 failed 0 unavailable
)
6 SATA(HDD SEAGATE ST310003 931.51GB 7200 online 0 ok
) 40NS

Group Management Commands 189


7 SATA(HDD SEAGATE ST310003 931.51GB 7200 online 0 ok
) 40NS
8 SATA(HDD SEAGATE ST310003 931.51GB 7200 online 0 ok
) 40NS
9 SATA(HDD SEAGATE ST310003 931.51GB 7200 online 0 ok
) 40NS
10 SATA(HDD SEAGATE ST310003 931.51GB 7200 online 0 tripped
) 40NS
11 SATA(HDD SEAGATE ST310003 931.51GB 7200 online 0 ok

Displaying Information for a Specific Disk

Show information about the disk in slot 0:

> member select gigan34mem1 show disks 0


______________________________ Disk Information ______________________________
Slot: 0 Status: online
Model: ST31000524NS Revision: KD03
Size: 931.51GB Errors: 0
Rpm: 7200 SectorSize: 512

______________________________________________________________________________

Displaying Hardware Components in a Member

Show information about the hardware components in the member enclosure:

> member select mem1 show enclosure


_____________________________ Temperature Sensors ____________________________
Name Value Normal Range Status
----------------------------------- --------- --------------- ---------------
Control module 0 processor 51 10-75 normal
Control module 0 chipset 22 10-50 normal
Control module 1 processor 51 10-75 normal
Control module 1 chipset 24 10-50 normal
Control module 0 SAS Controller 56 10-110 normal
Control module 0 SAS Expander 76 10-110 normal
Control module 1 SAS Controller 61 10-110 normal
Control module 1 SAS Expander 74 10-110 normal
Control module 1 SES Enclosure 43 10-65 normal
Control module 0 Battery 21 10-45 normal
Control module 1 Battery 21 10-45 normal
____________________________________ Fans ____________________________________
Name Speed Normal Range Status
------------------------------ --------- --------------- ---------------
Power Cooling Module 0 Fan 0 5040 2100-5350 normal
Power Cooling Module 0 Fan 1 4830 2100-5350 normal
Power Cooling Module 1 Fan 0 4800 2100-5350 normal
Power Cooling Module 1 Fan 1 4740 2100-5350 normal
_______________________________ Power Supplies _______________________________
Name Status FanStatus
---------------------------------------- -------- ---------------
Power Cooling Module 0 on not-applicable
Power Cooling Module 1 on not-applicable
_____________________________________ EIP ____________________________________
Name SerialNo Firmware Status
--------------- ------------------------- --------------- ---------------
OPS Panel Not Available 02.03 good

Displaying Member Network Ports

190 Group Management Commands


Show information about the network ports:

> member select mem1 show eths


Name ifType ifSpeed Mtu Ipaddress Status Errors
---- --------------- ---------- ---- --------------------------- ------ ------
eth0 ethernet-csmacd 1 Gbps 9000 192.0.2.41 up 0
eth1 ethernet-csmacd 1 Gbps 9000 192.0.2.42 up 0
eth2 ethernet-csmacd 1 Gbps 9000 192.0.2.43 up 0
eth3 ethernet-csmacd 1 Gbps 9000 192.0.2.44 up 0

Displaying Details About a Specific Port

Show information about the status of Ethernet port 0:

> member select mem1 show eth 0


_______________________________ Eth Information ______________________________
Name: eth0 Status: up
Changed: Mon Jun 22 14:02:15 2015 Type: ethernet-csmacd
DesiredStatus: up Mtu: 9000
Speed: 1 Gbps HardwareAddress: 00:09:8A:0A:5F:36
IPAddress: 192.0.2.36 NetMask: 255.255.248.0
IPv6Address: Description:
SupportsManagement: no ManagementStatus: normal
DCB: off

Displaying Component Version Information

Show the component version information:

> member select mem1 show version


Component Part# Rev SN ECO
-------------------- --------- ------- -------------------- -------
Backplane 62532 NA SHU94874000282D NA
PMC0 64362 NA PMA846270006927 NA
PMC1 64362 NA PMA846270009306 NA
PMC2 64362 NA PMA846270006923 NA
CM0 70-0202 A03 RMS0935328G001Q C00
CM1 70-0202 A03 RMS0935328G002S C00
Channel card 0 V2.c ICS713910002F22
Channel card 1 V2.c ICS713910002F22
EIP Card 03.0e Not Available

___________________________________ Disks ____________________________________


Slot Type Model Revision Serial Number
---- -------- ------------------------- -------- --------------------
0 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGJLDAT)
1 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGKKZ2T)
2 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGKY9VT)
3 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGKY3JT)
4 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGJ5D2T)
5 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGLNWHT)
6 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGKR9ET)
7 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGLAE3T)
8 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGKKN1T)
9 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGLLZNT)
10 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGKKJBT)
11 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGKWKKT)
12 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGJX3GT)
13 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGLMY4T)
14 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGL7YXT)
15 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGL0U4T)
16 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGLP9HT)

Group Management Commands 191


17 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGLDN3T)
18 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGLA1BT)
19 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGLEP9T)
20 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGLNZ8T)
21 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGJM33T)
22 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGL88ZT)
23 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGLE0UT)
24 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGKWEDT)
25 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGKGGNT)
26 SATA(HDD Hitachi HUA722020ALA330 JKAOA25A JK1130YAGKVRRT)

Displaying Volumes Hosted by the Member

Show the volumes that have data stored on a member:

> member select spark52 show volumes


Volume Name Contribution (Reported Size)
--------------- ----------------------------
spark52-vol1 513.75GB
spark52-vol2 513.75GB
testTemplate 444.01GB
wednesday 250GB
test 444.01GB
vol1 22GB
vol2 35.01GB
testvol03.1 1.01GB
ABTestVol.1 1.01GB
Rtest.1 1.01GB
test2 444.01GB
Rwedtest 1.01GB
testvol02.1 1.01GB
testtemplate2 1.01GB

member show
Shows information about all the group members or a specific member, including any in-progress
operations. Different array models show slightly different information.

Format
member show [member_name] [-poolinfo]

Variable
Variable Description
member_name Name of a member

Parameter
Parameter Description
[-poolinfo] Displays pool information for the member

192 Group Management Commands


Examples
Displaying All Group Members

Show all members in the group:

> member show


Name Status Version Disks Capacity FreeSpace Connections
---------- ------- ---------- ----- ---------- ---------- -----------
king10 online V5.0.0 48 40.84TB 40.7TB 0
king44 online V5.0.0 48 74.58TB 58.71TB 17
king32 online V5.0.0 48 51.5TB 41.86TB 30
moth20 online V5.0.0 14 1.3TB 1.24TB 1
king22 online V5.0.0 48 40.84TB 34.55TB 5
king1 online V5.0.0 16 8.5TB 8.5TB 0
king11 online V5.0.0 48 40.84TB 33.46TB 7
giraffe13 online V5.0.0 16 2.74TB 2.72TB 0
king21 online V5.0.0 48 39.07TB 31.57TB 11
king33 online V5.0.0 48 40.84TB 37.01TB 8
king43 online V5.0.0 48 69.26TB 51.74TB 39

Displaying Pool Membership

Show pool information for the member:

> member show -poolinfo


NName Status Version Disks Capacity FreeSpace Connections Pool
--------- ------ ---------- ----- ---------- ---------- ----------- ----
king10 online V5.0.0 48 40.84TB 40.7TB 0 default
king44 online V5.0.0 48 74.58TB 58.71TB 17 default
king32 online V5.0.0 48 51.5TB 41.86TB 30 default
moth20 online V5.0.0 14 1.3TB 1.24TB 1 2
king22 online V5.0.0 48 40.84TB 34.55TB 5 default
king1 online V5.0.0 16 8.5TB 8.5TB 0 3
king11 online V5.0.0 48 40.84TB 33.46TB 7 default
giraffe13 online V5.0.0 16 2.74TB 2.72TB 0 4
king21 online V5.0.0 48 39.07TB 31.57TB 11 default
king33 online V5.0.0 48 40.84TB 37.01TB 8 default
king43 online V5.0.0 48 69.26TB 51.74TB 39 default

Displaying Detailed Member Information

Show detailed information about a specific member:

> member show king10


_____________________________ Member Information _____________________________
Name: king10 Status: online
TotalSpace: 40.84TB UsedSpace: 137.53GB
SnapSpace: 0MB Description:
Def-Gateway: 192.0.2.50 Serial-Number: SHU94874000282D
Disks: 48 Spares: 2
Controllers: 2 CacheMode: write-back
Connections: 0 RaidStatus: ok
RaidPercentage: 0% LostBlocks: false
HealthStatus: normal LocateMember: disable
Controller-Safe: disabled Low-Battery-Safe: enabled
Version: V5.0.0 (R118494) Delay-Data-Move: disable
ChassisType: 4835 Accelerated RAID Capable: no
Pool: default Raid-policy: raid10
Service Tag: GD6H9F1 Product Family: PS6500
______________________________________________________________________________

Group Management Commands 193


___________________________ Health Status Details ____________________________

Critical conditions:: None


Warning conditions:: None
______________________________________________________________________________

____________________________ Operations InProgress ___________________________

ID StartTime Progress Operation Details


-- -------------------- -------- ---------------------------------------------

monitor
Shows information about host tools that are used for monitoring the group.

Format
monitor subcommand

Subcommands
Subcommand Description
delete monitor_index Removes monitoring information for a specific host, by its index
number.
For example, if a host has been permanently removed from the network
or is no longer serving as a monitoring host, use this command to
delete old index references to it.

select monitor_index Displays information about a particular host tools monitoring instance

show Shows information about host tools monitoring the group, including the
index numbers for the monitoring instances

Examples
Display all hosts that are currently monitoring the group:

> monitor show


Index Host Ipaddress Last Monitor
---------- ---------------------------- ---------------------- ---------------
1686781286 QASTSERVERS-S01.lab.mycompany.com fc00:2496::94df:b243:f1bf:4ed0 2015-04-22:16:20
1964720370 ROTATE-S29.lab.mycompany.com fc00:2496::7171:66f3:ef93:4ea9 2015-04-24:12:27

Select an index number to display more details about the host monitoring the group:

> monitor select 1686781286 show


_____________________________ Monitor Information ____________________________
Host: QASTSERVERS-S01.lab.mycompany.com
IPAddress: fc00:2496::94df:b243:f1bf:4ed0
Last Monitor: 2015-04-22:16:20:51
Last Support Assist: None
Description:

194 Group Management Commands


Delete an index number for a stale monitoring instance:

> monitor delete 1686781286

nas
Manages the NAS cluster in the group.
The nas command structure is identical to, and is a built-in alias for, the nas-cluster select command
structure. With the exception of creating, deleting, or renaming a NAS cluster, you can perform the same
operations with the nas command that you can with the nas-cluster commands.

Because only one NAS cluster can be in a PS Series group, by default the nas command selects the
existing NAS cluster (equivalent to entering nas-cluster select cluster_name).

The full nas command structure is not documented in this guide. See the corresponding nas-cluster
select command for full syntax and usage details, or see the CLI help.

Format
nas subcommand

Subcommands
The nas command supports all the same subcommands as the nas-cluster select command. See nas-
cluster select for the complete list.

nas show
Displays information about the NAS cluster.

Format
nas show

Example
Display NAS cluster information:

> nas show

___________________________ NAS Cluster Information ___________________________


Name: cluster1
Type: nas
IPAddress: 192.0.2.35
NASreserve: 3TB
Used Space Warn: 10%
Available-Space-Warn: 20%
No Of Controllers: 2
Gateway IP: 192.0.2.23
Desired Service Mode: normal
Service Mode Status: normal
FTP-service: enabled
NFSv4-mode: disabled
Cluster MPV: 4
TotalContainerCapacity: 2.63TB

Group Management Commands 195


AllocatedContainerSpace: 834.73GB
InUseContainerSpace: 3MB
FreeContainerSpace: 42.67TB
FreeContainerSpaceReserved: 834.72GB
FreeContainerSpaceUnReserved: 1.81TB
FreeContainerSpaceOverCommitted: 40.05TB
SnapSpace: 0MB
No Of Containers: 15
No Of NFS Exports: 0
No Of SMB Shares: 0
No Of Snapshots: 0
Total-DataReduction-Space-Savings: 0MB
FS-Scan-Rate: normal

nas-cluster
Manages the NAS cluster in the group.

Format
nas-cluster subcommand

Subcommands
Subcommand Description
create Creates a NAS cluster

delete Deletes a NAS cluster

rename Renames a NAS cluster

select Modifies a NAS cluster or shows details about a NAS cluster

show Shows details about the NAS cluster

nas-cluster create
Creates a NAS cluster in the group. You can configure only one NAS cluster per PS Series group.
The maximum size of the NAS cluster cannot exceed 510TB.

Format
nas-cluster create cluster_name controller_count nas_reserve_size pool
parameters

196 Group Management Commands


Variables
Variable Description
cluster_name NAS cluster name. The NAS cluster name can contain up to 15
ASCII characters (letters, numbers, and hyphens), but must begin with a
letter.

controller_count Number of NAS controllers for the cluster. either 2 or 4.


If you start with 2 controllers, you can increase to 4 controllers, but
cannot later return to 2 controllers.

nas_reserve_size NAS reserve size in MB (default), GB, or TB.


The minimum reserve amount is 250GB for 2 controllers, and 500GB
for 4 controllers.

NOTE: For the NAS overhead, these minimum values are absolute.
If you select the minimum values, no space will be left for
containers. However, you can increase the NAS reserve later.

pool Storage pool from which the NAS reserve will be taken.

NOTE: After you set it initially, you cannot change the pool for the
NAS reserve.

Parameters
NOTE: You must enter the percent sign with these values.

Parameter Description
def-snap-reserve n% NAS clusterwide default snapshot reserve setting, as a percentage of the
container size. Minimum: 0%. Maximum: 90%.

def-snap-warn n% NAS clusterwide default in-use snapshot space warning limit, as a


percentage of the snapshot reserve. Minimum: 10%. Maximum: 100%.

def-space-warn n% NAS clusterwide default in-use space warning limit, as a percentage of


the container size. Minimum: 10%. Maximum: 100%.

Example
To create a NAS cluster, use the following sequence of commands:

1. discover-devices
(Obtain the service tag for each NAS controller that you want to use in the NAS cluster.)

See discover-devices.
2. nas-cluster create cluster_name controller_count nas_reserve_size pool
For example:

nas-cluster create NAS1 2 800GB default

Group Management Commands 197


3. nas-cluster select cluster_name controller add service_tag
For example:

nas-cluster select NAS1 controller add 7BQZFN1


nas-cluster select NAS1 controller add C9QZFN1

(Repeat for each NAS controller, specifying the service tag for each controller. You can add
controllers only in pairs, and the current limit is 2 pairs per cluster.)

See nas-cluster select controller add.


4. nas-cluster select cluster_name network create san cluster_management_ip
For example:

nas-cluster select NAS1 network create san 192.0.2.21

See nas-cluster select network create.


5. nas-cluster select cluster_name network select san controller select
controller_name controller-ip-addr-list controller-ip-list
(Repeat for each NAS controller, specifying the controller name and two or four IP addresses. The
number of SAN IP addresses must be the same on each NAS controller in the NAS cluster.)

For example:

nas-cluster select NAS1 network select san controller select controller0


controller-ip-addr-list 192.0.2.31,192.0.2.33
nas-cluster select NAS1 network select san controller select controller1
controller-ip-addr-list 192.0.2.32,192.0.2.34

See nas-cluster select network select controller select.


6. nas-cluster select cluster_name network create client cluster_ip netmask
For example:

nas-cluster select NAS1 network create client 192.0.2.41 255.255.255.0

See nas-cluster select network create.


7. nas-cluster select cluster_name network select client controller select
controller_name controller-ip-addr-list controller_ip_list
(Repeat for each NAS controller, specifying the controller name and one IP address.)

For example:

nas-cluster select NAS1 network select client controller select controller0


controller-ip-addr-list 192.0..52
nas-cluster select NAS1 network select client controller select controller1
controller-ip-addr-list 192.0.2.53

See nas-cluster select network select controller select.


8. nas-cluster select cluster_name def-gateway ip_address
For example:

nas-cluster select NAS1 def-gateway 192.0.2.41

See nas-cluster select def-gateway


9. nas-cluster select cluster_name initialize-cluster

198 Group Management Commands


For example:

nas-cluster select NAS1 initialize-cluster

See nas-cluster initialize-cluster.

nas-cluster delete
Deletes a NAS cluster from the group.

Format
nas-cluster delete cluster_name

Variable
Variable Description
cluster_name NAS cluster to delete

nas-cluster rename
Renames the NAS cluster in the group.

Format
nas-cluster rename cluster_name new_name

Variables
Variable Description
cluster_name Current name of the NAS cluster

new_name New name for the NAS cluster. The NAS cluster name can contain up to
15 ASCII characters (letters, numbers, and hyphens), but must begin
with a letter.

nas-cluster select
Selects the NAS cluster in the group for additional operations.

Format
NOTE: Because only one NAS cluster is supported in a PS Series group, you can use either the nas-
cluster command or the nas command to manage an existing NAS cluster. See nas for more
information.
nas-cluster select cluster_name subcommand parameters

Group Management Commands 199


Variable
Variable Description
cluster_name NAS cluster name

Subcommands
Subcommand Description
active-client- Displays all the active NFS or SMB sessions from a client
sessions nfs|smb show

ad-users Manages Active Directory users

add-pair Adds a pair of NAS nodes to a NAS cluster

all-users Manages all users of the NAS cluster

antivirus-servers Configures the NAS antivirus servers

appliance Manages NAS appliances in the NAS cluster

container Manages the NAS cluster containers

controller Manages NAS controllers in the NAS cluster

credentials Manages authentication for a NAS cluster

data-reduction Manages the data reduction settings and schedules

diagnostics Runs diagnostic reports on the NAS cluster

failback Manages NAS container failback operations

fs-scan-rate Specifies the rate of file system scanning

ftp-service Enables or disables FTP service to the NAS cluster

initialize-cluster Starts the NAS cluster configuration using the configuration information
previously specified in the CLI

local-group Manages local groups in the NAS cluster

local-user Manages local users in the NAS cluster

mass-failback Moves client connections to a NAS node that is no longer in a failed


state

mass-rebalance Rebalances client connections across the available NAS nodes

ndmp Manages NDMP in a NAS cluster

network Manages the network configuration for the NAS cluster

200 Group Management Commands


Subcommand Description
nfsv4-mode Enables or disable NFS version 4 mode on the NAS cluster

operation Manages operations in the NAS cluster

replicate-to-partner Manages NAS container replication operations

resize Modifies the size of the NAS reserve

service-mode Sets the NAS cluster service mode

show Displays information about the NAS cluster

unix-users Manages the UNIX users of the NAS cluster

update Manages the NAS cluster firmware update

user-mapping Manages user mapping for the NAS cluster

Parameters
NOTE: Some of these parameters are used only with certain subcommands.

Parameter Description
def-access-security Specifies the default file security style for new containers

def-smb-antivirus Enables or disables (default) the antivirus service for an SMB share

def-smb-avexcludedirs Manages the directory paths to exclude from antivirus scanning

def-smb-avextensions Manages the file extensions (types) to exclude from antivirus scanning

def-data-reduction Manages the default data reduction policy settings

def-dir-permission Specifies the default UNIX permissions for new directories created by
clients

def-file-permission Specifies the default UNIX permissions for new files created by clients

def-gateway Specifies the default gateway for the NAS cluster

def-nfs-permission Specifies the default permission setting for new NFS exports (read-write
or read-only)

def-nfs-trusted-user Specifies the default trusted user setting for new NFS exports (all-
except-root, nobody, or all). Other users will be identified as guests.

NOTE: To specify all, you must also restrict the client IP addresses
to a specific range. See nas-cluster select container select nfs-
export select.

def-snap-reserve Specifies, as a percentage of the container size, the default snapshot


reserve setting for new containers

Group Management Commands 201


Parameter Description
def-snap-warn Specifies, as a percentage of the snapshot reserve size, the default in-
use snapshot space warning limit for new containers

def-space-warn Specifies, as a percentage of the container size, the default in-use space
warning limit for new containers

nas-cluster select active-client-sessions nfs show


Displays all the active NFS sessions from a client.

Format
nas-cluster select cluster_name active-client-sessions nfs show

Variable
Variable Description
cluster_name NAS cluster name

Example
Display the active NFS sessions:

> nas-cluster select cluster1 select active-client-sessions nfs show

Proto Control NFS User Computer # Open Connecte idle Guest


col ler ID Session Files d Time Time
ID
NFS 3 1 1126 192.0.2. 0 00:07:26 00:03:37 No
88320 21
5741
92.0.2.
21
192.0.2
.52

NOTE: NFS3 protocol displays connection-related information, such as IP the address or controller
ID. Unlike SMB3, NFS3 does not contain session-related information such as user names or number
of open files.

nas-cluster select active-client-sessions smb show


Displays all the active SMB sessions from a client.

Format
nas-cluster select cluster_name active-client-sessions smb show

202 Group Management Commands


Variable
Variables Description
cluster_name NAS cluster name

Example
Display the active SMB sessions:

> nas-cluster select cluster1 select active-client-sessions smb show

nas-cluster select ad-users search


Searches for Active Directory users in the NAS cluster.

Format
nas-cluster select cluster_name ad-users search search_string

Variables
Variable Description
cluster_name Name of a NAS cluster

search_string Searches for users in the Active Directory database that match the terms
in the search string

Example
Search for specific users in the Active Directory database:

> nas-cluster select NAS1 ad-users search "admin"

nas-cluster select alerts available-space-threshold


Sets the available space threshold to get the notification if the NAS reserve size goes below the specified
value.

Format
nas-cluster select cluster_name alerts available-space-threshold percentage

Variables
Variable Description
cluster_name NAS cluster name

percentage Percentage of the NAS reserve size

Group Management Commands 203


Example
Set the threshold for notification if the NAS reserve size falls below the specified value:

> nas-cluster select cluster1 alerts available-space-threshold 15

nas-cluster select alerts used-space-threshold


Sets the NAS reserve used space alert as a percentage of the NAS reserve size.

Format
nas-cluster select cluster_name alerts used-space-threshold percentage

Variables
Variable Description
cluster_name NAS cluster name

percentage Percentage of the NAS reserve size

Example
Set the NAS reserve used space alert as the specified percentage of the reserve size:

> nas-cluster select controller1 alerts used-space-threshold 80

nas-cluster select alerts show


Displays all NAS reserve alerts for the NAS appliance.

Format
nas-cluster select cluster_name alerts show

Variable
Variable Description
cluster_name NAS cluster name

Example
Display the NAS reserve alerts:

> nas-cluster select NAS_1 alerts show


___________________________ NAS Alerts Information ____________________________
Used Space Warn: 10%
Available-Space-Warn: 20%

204 Group Management Commands


nas-cluster select all-users
Manages local users in the NAS cluster.

Format
nas-cluster select cluster_name all-users subcommand

Variable
Variable Description
cluster_name NAS cluster name

Subcommand
Subcommand Description
search search_string Searches for users that match the terms in the search string in all of the
configured user databases

Example
Search for a specific set of users n a NAS cluster:

> nas-cluster select NASCLU1 all-users search "K"

nas-cluster select antivirus-servers


Manages antivirus servers for the NAS cluster.

Format
nas-cluster select cluster_name antivirus-servers subcommand

Variable
Variable Description
cluster_name NAS cluster name

Subcommands
Subcommand Description
create Configures antivirus servers for the cluster

deleteAll Deletes all configured antivirus servers

show Displays all antivirus server information

Group Management Commands 205


Example
Display all antivirus servers for a NAS cluster:

> nas-cluster select Spar14NAS antivirus-servers show


Antivirus Servers::192.0.2.29,192.0.2.25

nas-cluster select antivirus-servers create


Configures antivirus servers for the NAS cluster.
The Support Matrix provides details about supported antivirus servers and versions.

Format
nas-cluster select cluster_name antivirus-servers create server_list

Variables
Variable Description
cluster_name NAS cluster name

server_list Comma-separated list of up to four (4) antivirus servers.


You can specify either an IP address or a server host name. The server
and port must be entered in this format: IP|hostname:port

Examples
Configure three antivirus servers using host names and ports:

> nas-cluster select NAScluster14 antivirus-servers create


AVserver1:2001,AVserver2:2027,AVserver3:2020

Configure two antivirus servers using IP addresses:

> nas-cluster select 14NAS antivirus-servers create 192.0.2.39,192.0.2.40

nas-cluster select antivirus-servers deleteAll


Deletes all configured antivirus servers for the NAS cluster.

Format
nas-cluster select cluster_name antivirus-servers deleteAll

Variable
Variable Description
cluster_name NAS cluster name

206 Group Management Commands


Example
Delete all the configured antivirus servers for a NAS cluster:

> nas-cluster select 14NAS antivirus-servers deleteAll

nas-cluster select appliance


Manages NAS appliances in the NAS cluster. This command applies only to FS7600 or FS7610 model
hardware.

Format
nas-cluster select cluster_name appliance appliance_name subcommand parameters

Variables
Variable Description
cluster_name NAS cluster name

appliance_name Name of a NAS appliance (either ID or service tag)

Subcommands
Subcommand Description
select Selects an appliance in the NAS cluster

show Displays information about all appliances or the selected appliance

Parameters
Parameter Description
fan Displays information about the fans in the appliance

power-supply Displays information about the power supplies in the appliance

Examples
Display all the appliances in the NAS cluster:

> nas-cluster select NAS2 appliance show

Display the fan status for an appliance in the NAS cluster:

> nas-cluster select NAS2 appliance select NAME fan show


Name Status Rpm Rpm Range
-------------------- -------------------- ---------- --------------------
Fan1 optimal 4896 544,14000
Fan2 optimal 5032 544,14000
Fan3 optimal 5100 544,14000

Group Management Commands 207


Fan4 optimal 5032 544,14000
Fan5 optimal 5032 544,14000
Fan6 optimal 4828 544,14000

nas-cluster select appliance select


Selects a NAS appliance for further operations.

Format
nas-cluster select cluster_name appliance select appliance parameters

Variables
Variable Description
cluster_name NAS cluster name

appliance Name of a NAS appliance (ID or service tag)

Subcommands
Subcommand Description
select Selects an appliance in the NAS cluster

show Displays information about all appliances or the selected appliance

Parameters
Parameter Description
fan Displays fan information for the specified appliance

power-supply Displays power supply information for the specified appliance

show Displays all information for the specified appliance

Examples
Display information for a fan in an appliance in a NAS cluster:

> nas-cluster select ROOK appliance select 6MF37W1 fan show


Name Status Rpm Rpm Range
-------------------- -------------------- ---------- --------------------
Fan1 optimal 4896 544,14000
Fan2 optimal 5032 544,14000
Fan3 optimal 5100 544,14000
Fan4 optimal 5032 544,14000
Fan5 optimal 5032 544,14000
Fan6 optimal 4828 544,14000

208 Group Management Commands


Display information for the power supply in an appliance in a NAS cluster:

> nas-cluster select ROOK appliance select 6MF37W1 power-supply show


Name Status
-------------------- --------------------
PS 1 optimal
PS 2 optimal

Display all information for an appliance in a NAS cluster:

> nas-cluster select ROOK appliance select 6MF37W1 show


___________________________ NAS Chassis Information __________________________
Model: fs7600
Overall Status: optimal
San Type: eql
Overall Controller Status: optimal
Client Network Speed: 1GB ethernet
Internal Network Speed: 1GB ethernet
San Network Speed: 1GB ethernet
Client Network Status: optimal
Internal Network Status: not available
San Network Status: optimal
Overall Fan Status: optimal
Overall Power Supply Status: redundant
______________________________________________________________________________

nas-cluster select client-load-balance action move load-


ip access-ip controller
Moves a local client connection to the specified controller.

Format
nas-cluster select cluster_name client-load-balance action move load-ip load_ip
access-ip access_ip controller controller_name

Variables
Variable Description
cluster_name NAS cluster name

controller_name Name of the controller

load-ip Client IP address

access-ip Access IP address

Example
Move the local client connection to the specified controller:

> nas-cluster select cluster1 client-load-balance action move load-ip


192.0.2.31 access-ip 192.0.2.21 controller controller1

Group Management Commands 209


nas-cluster select client-load-balance action pin load-ip
access-ip controller
Pins a client connection to the specified controller and, optionally, to the specified interface.

Format
nas-cluster select cluster_name client-load-balance action pin load-ip load_ip
access-ip access_ip controller controller_name [interface]

Variables
Variable Description
cluster_name NAS cluster name

controller_name Name of the controller

access-ip Access IP address

load-ip Client IP address

interface Name of the interface

Example
Pin a client load to the specified controller and specified interface:

> nas-cluster select cluster1 client-load-balance action pin load-ip 192.0.2.30


access-ip 192.0.0.51 controller controller1 eth0

nas-cluster select client-load-balance action unpin load-


ip access-ip controller
Unpins a client load from a controller that had been pinned previously.

Format
nas-cluster select cluster_name client-load-balance action unpin load-ip
load_ip access-ip access_ip controller controller_name [interface]

Variables
Variable Description
cluster_name NAS cluster name

access_ip Access IP address

load_ip Client IP address

controller_name Name of the controller

210 Group Management Commands


Variable Description
interface Name of the interface

Example
Unpins a client load from the specified controller and interface:

> nas-cluster select cluster1 client-load-balance action unpin load-ip


192.0.2.51 access-ip 192.0.2.41 controller controller1 eth0

nas-cluster select client-load-balance show


Displays the client load.

Format
nas-cluster select cluster_name client-load-balance show

Variable
Variable Description
cluster_name NAS cluster name

Example
Display information about the load for a client:

> nas-cluster select cluster1 client-load-balance show


Load-IP Access-IP Current If Assign Pin Pin-If Type Manual-FB
--------------- --------------- ------- ---- ------ ----- ------ ----- ---------
192.0.2.32 192.0.2.45 ctrl0 eth3 ctrl0 ctrl0 eth3 other no

nas-cluster select container


Manages NAS containers.

Format
nas-cluster select cluster_name container subcommand

Variable
Variable Description
cluster_name NAS cluster name

Group Management Commands 211


Subcommands
Subcommand Description
create Creates a container

delete Deletes the selected container

rename Renames the container

select Selects a container for additional operations

show Displays all the containers in the NAS cluster or displays the specified
container

Example
Display all containers for a NAS cluster:

> nas-cluster select spark14NAS container show


Name Size Used Space Snap Res Used Snap NFS SMB Data Reduction
---------- ------- ---------- --------- --------- --- ---- -----------------
katest 22GB 0MB 11GB 0MB 0 1 disable
cn1 25GB 5MB 12.5GB 0MB 1 0 disable
cn2 33GB 5MB 16.5GB 0MB 0 2 disable
test 1GB 4MB N/A N/A 1 0 enable
data1 1GB 9MB N/A N/A 0 1 enable
SM_Test 10GB 0MB 5GB 0MB 0 1 disable
smtest 10GB 4MB N/A N/A 0 1 enable

nas-cluster select container create


Creates a NAS container.

Format
nas-cluster select cluster_name container create container_name size parameters

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container.


Valid characters include letters, numbers, and underscores. Names must
begin with a letter or underscore.

size Size of the container in MB (default), GB, or TB.


The maximum container size is the size of the NAS reserve minus the
overhead (250GB for 2 controllers, 500GB for 4 controllers).

212 Group Management Commands


Parameters
Parameter Description
space-warn percent In-use space warning limit, as a percentage of the container size.
If not specified, uses the clusterwide default value.

Minimum: 10%. Maximum: 100%. Default: 80%.

snap-reserve percent Snapshot reserve, as a percentage of the container size.


If not specified, uses the clusterwide default value.

Minimum: 0%. Maximum: 90%. Default: 50%.

snap-warn percent Snapshot reserve in-use space warning limit, as a percentage of the
snapshot reserve size.
If not specified, uses the clusterwide default value.

Minimum: 10%. Maximum: 100%. Default: 80%.

file-permission Sets the 3-digit octal UNIX file permissions, such as 777 or 744 (default).
octal_value
If not specified, uses the clusterwide default value.

dir-permission Sets the 3-digit octal UNIX directory permissions, such as 777 or 755
octal_value (default).
If not specified, uses the clusterwide default value.

thin-provision thin- Specifies the following values:


reserve percent
available-space-warn thin-provision enables thin provisioning for the container.
percent thin-reserve reserves the minimum space for the container.
available-space-warn enables the alert for the thin-provisioned
container if the physical available space falls below the threshold.

few-writers Enables the distribution of workloads for few writers across domains

Examples
Create a container in the NAS cluster:

> nas-cluster select NAS_1 container create CON_2 1GB

Create a container with few writers workloads enabled in the NAS cluster:

> nas-cluster select NAS_1 container create CON_3 1GB few-writers

Group Management Commands 213


nas-cluster select container delete
Deletes a NAS container.

Format
nas-cluster select cluster_name container delete container_name

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Example
Delete a container:

> nas-cluster select NAS_1 container delete container3

nas-cluster select container rename


Renames a NAS container.

Format
nas-cluster select cluster_name container rename current_name new_name

Variables
Variable Description
cluster_name NAS cluster name

current_name Current name of the container

new_name New name for the container.


Valid characters include letters, numbers, and underscores. Names must
begin with a letter or underscore.

Example
Rename a container:

> nas-cluster select NAS1 container rename fs1 sales_files

214 Group Management Commands


nas-cluster select container select
Selects a NAS container for additional operations.

Format
nas-cluster select cluster_name container select container_name parameter
subcommand

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Parameters
Parameter Description
access-security policy Sets the file security for the container to either:
ntfs (default)
mixed
unix

dir-permission Sets the 3-digit octal UNIX directory permissions, such as 777 or 744
octal_value (default)

file-permission Sets the 3-digit octal UNIX file permissions, such as 777 or 755 (default)
octal_value

size size Modifies the container size (capacity). Enter the new size in MB (default)
or GB.

snap-reserve percent Snapshot reserve, as a percentage of the container size:


Minimum0%
Maximum90%
Default50%

snap-warn percent Snapshot reserve in-use space warning limit, as a percentage of the
snapshot reserve size:
Minimum10%
Maximum100%
Default80%

space-warn percent In-use space warning limit, as a percentage of the container size:
Minimum10%
Maximum100%
Default80%

Group Management Commands 215


Parameter Description
thin-reserve Reserves the minimum space for the container
percentage

available-space-warn Enables an alert for the thin-provisioned container if the physical


percentage available space falls below the threshold

Subcommands
Subcommand Description
smb-share Manages SMB shares on the container

def-group-quota Manages the default group quota for the container

def-user-quota Manages the default user quota for the container

delete-failback Deletes the ability to demote the replica container

group-quota Manages group quotas for the container

group-quota-effective Displays the group quota effective rule for this container

nfs-export Manages NFS exports on the container

quota-usage Displays usage data associated with this container

rename new_name Specifies a new name for the container

replication Manages container replication

schedule Manages snapshot schedules for the container

show Displays information about the container

snapshot Manages snapshots of the container

user-quota Manages user quotas for the container

user-quota-effective Displays the user quota effective rule for a specific user for this
container

useringroup-quota Manages quotas for each user in a group for the container

nas-cluster select container select access-security


Selects the access security policy for a NAS container.

Format
nas-cluster select cluster_name container select container_name access-security
policy

216 Group Management Commands


Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

policy Sets the file security policy for the container to either:
mixed
ntfs (default)
unix

nas-cluster select container select data-reduction


Enables data reduction on a NAS container.
Data reduction has these policy attributes:

Deduplication (always enabled)


Compression (optional)
Access Time filter (default=30)
Modify Time filter (default=30).

Format
nas-cluster select cluster_name container select container_name data-reduction
parameter subcommand

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Parameters
Parameter Description
access-time-filter Excludes files from data reduction that have been accessed in the
num_days specified number of days (5 to 365)

compression enable| Enables or disables compression


disable

filter-mode use- Filters files by the specified access time and modify time values or
filters|ignore-filters ignores the filters, and makes all files candidates for data reduction

Group Management Commands 217


Parameter Description

NOTE: The ignore-filters option should not be used on data


that is active. It is intended for archived files only.

rehydrate-on-read Enables/disables rehydrate-on-read on a container when data


enable|disable reduction is disabled

Subcommands
Subcommand Description
disable Disables data reduction

enable Enables data reduction

modify-time-filter Excludes files from data reduction that have been modified in the
num_days specified number of days (5 to 365)

Examples
Enable only data reduction on a container:

> nas-cluster select NAS1 container select data1 data-reduction enable

Enable data reduction and compression on a container:

> nas-cluster select NAS1 container select data1 data-reduction compression


enable

Exclude files from data reduction that have not been accessed within the past 45 days:

> nas-cluster select NAS1 container select data1 data-reduction access-time-


filter 45

Enable or disable rehydrate on read for a container. You must combine modifying rehydration with
disabling data reduction or it has no effect.

> nas-cluster select NAS1 container select data1 data-reduction rehydrate-on-


read [enable|disable]

nas-cluster select container select def-group-quota


Manages the default group quota for a NAS container.

Format
nas-cluster select cluster_name container select container_name def-group-quota
subcommand

218 Group Management Commands


Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Subcommands
Subcommand Description
delete Deletes the default group quota for the selected container

modify Modifies the default group quota for the selected container

show Displays the default group quota for the selected container

Example
Show the group quota limit and warning percentage for a container:

> nas-cluster select NAS_1 container select container1 def-group-quota show


______________________________ Quota Information _____________________________
Name: defgroup Warning Limit: 55%
Quota Limit: 500MB Quota Used: 0MB
______________________________________________________________________________

nas-cluster select container select def-group-quota


modify
Sets or modifies the default group quota for a NAS container.

Format
nas-cluster select cluster_name container select container_name def-group-quota
modify parameters

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Group Management Commands 219


Parameters
Parameter Description
quota size Specifies the default group quota for the selected container in MB
(default) or GB

warn-percentage n% Specifies the default warning limit as a percentage of the default group
quota size. You must enter the percent sign.

Example
Set a group quota and a warning limit on a container:

> nas-cluster select NAS_1 container select container1 def-group-quota modify


quota 500MB warn-percentage 55%

nas-cluster select container select def-user-quota


Manages the default user quota for a NAS container.

Format
nas-cluster select cluster_name container select container_name def-user-quota
subcommand

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Subcommands
Subcommand Description
delete Deletes the default user quota for the selected container

modify Specifies the default user quota for the selected container

show Displays the default user quota for the selected container

Examples
Displaying User Quotas

Display the default user quota for a container:

> nas-cluster select NAS1 container select container1 def-user-quota show


______________________________ Quota Information _____________________________
Name: defuser Warning Limit: 0%

220 Group Management Commands


Quota Limit: 0MB Quota Used: 0MB
______________________________________________________________________________

Deleting User Quotas

Delete the default user quota for a container:

> nas-cluster select NAS1 container select container1 def-user-quota delete


defuser has been successfully deleted.

nas-cluster select container select def-user-quota modify


Sets or modifies the default user quota for a NAS container.

Format
nas-cluster select cluster_name container select container_name def-user-quota
modify parameters

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Parameters
Parameter Description
quota size Specifies the default user quota for the selected container in MB
(default) or GB

warn-percentage n% Specifies the default warning limit as a percentage of the default user
quota size. You must enter the percent sign.

nas-cluster select container select dir-permission


Sets the UNIX directory permissions for a container in a NAS cluster.

Formats
nas-cluster select cluster_name container select container_name dir-permission
octal_value

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Group Management Commands 221


Variable Description
octal_value Sets the UNIX directory permissions using a 3-digit octal value such as
644 or 755

Example
Set the directory permission for a container:

> nas-cluster select NAS_1 container select container1 dir-permission 555

nas-cluster select container select few-writers


Defines the way workloads are distributed across domains for few writers. When this feature is enabled, it
favors readers over writers, providing maximum resource utilization for reading files and lower resource
utilization when writing files.

Format
nas-cluster select cluster_name container select container_name enable|disable

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of a container

Example
Enable workload distribution for few writers on a container:

> nas-cluster select NAS_1 container select CON_2 few-writers enable

nas-cluster select container select file-permission


Sets the UNIX file permissions for a container in a NAS cluster.

Formats
nas-cluster select cluster_name container select container_name file-permission
octal_value

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

222 Group Management Commands


Variable Description
octal_value Sets the UNIX file permissions using a 3-digit octal value such as 644 or
755

Example
Set the default UNIX permissions for files created from SMB shares for a container:

> nas-cluster select NAS_1 container select container1 file-permission 555

nas-cluster select container select group-quota


Manages group quotas on a NAS container.
For replicated containers, if user and group quota rules are in place for the source container, the system
will apply those quotas to the recovery container as follows:

If you are using an external server (such as Active Directory, LDAP, or NIS) to authenticate users and
groups on the destination cluster, quotas will be applied to the recovery container.
If you are using only local users and groups, quotas will not be applied.
If you are using both local users and groups and externally authenticated users and groups, user and
group quotas are applied for the externally authenticated accounts. Quotas will also be applied for the
local users and groups, but they might not be applied correctly.

For more information about this behavior, see the Dell EqualLogic Group Manager Administrator's Guide.

Format
nas-cluster select cluster_name container select container_name group-quota
subcommand

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Subcommands
Subcommand Description
create Creates a group quota for a container

delete Deletes the specified group quota for a container

modify Modifies the selected group quota for a container

select Manages the selected group quota for a container

show Displays information about the group quota for a container

Group Management Commands 223


nas-cluster select container select group-quota create
Creates a group quota on a NAS container.

Format
nas-cluster select cluster_name container select container_name group-quota
create group_name quota_value warn_level

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

group_name Name of the group to which the quota applies

quota_value Amount of container space the group can use, in MB, GB, or TB

warn_level% (Optional) Percentage of quota size at which a warning is generated. By


default, no warning occurs.
You must specify the percent sign (%).

Example
Specify a group quota and a warning level for a group:

> nas-cluster select NAS1 container select container1 group-quota create Qgroup
50GB 75%

nas-cluster select container select group-quota delete


Deletes a group quota on a NAS container.

Format
nas-cluster select cluster_name container select container_name group-quota
delete group_name

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

group_name Name of the group for which you are deleting the quota

224 Group Management Commands


nas-cluster select container select group-quota-
effective-rule select show
Displays the quota in effect for a group using a container, when that group does not have its own quota.
For groups without a quota, the default group quota on the container applies.

Format
nas-cluster select cluster_name container select container_name group-quota-
effective-rule select group_name show

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

group_name Name of the user group to select

nas-cluster select container select group-quota modify


Modifies a group quota on a NAS container.

Format
nas-cluster select cluster_name container select container_name group-quota
modify group_name quota_value [warn_level]

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

group_name Name of the group to which the quota applies

quota_value Amount of container space the group can use, in MB, GB, or TB

warn_level% (Optional) Percentage of quota size at which a warning is generated. By


default, no warning occurs.
You must specify the percent sign (%).

Group Management Commands 225


Example
Increase the quota for a group and decrease the warning level:

> nas-cluster select NAS1 container select container1 group-quota modify Qgroup
80GB 60%

nas-cluster select container select group-quota select


show
Displays a specific group quota on a NAS container.

Format
nas-cluster select cluster_name container select container_name group-quota
select group_name show

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

group_name Name of the group quota to display

nas-cluster select container select group-quota show


Displays all group quotas or a specific group quota on a NAS container.

Format
nas-cluster select cluster_name container select container_name group-quota
show [group_name]

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

group_name Name of the group quota to display

226 Group Management Commands


nas-cluster select container select nfs-export
Manages NFS exports on a NAS container.

Format
nas-cluster select cluster_name container select container_name nfs-export
subcommand

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Subcommands
Subcommand Description
create Creates an NFS export on the container

delete Deletes the specified NFS export

select Selects an NFS export for additional operations

show Displays information about the NFS exports on the container

nas-cluster select container select nfs-export create


Creates an NFS export on a NAS container.

Format
nas-cluster select cluster_name container select container_name nfs-export
create export_name export_dir [parameters]

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

export_name Name of the NFS export, up to 63 characters. Valid characters include


letters, numbers, and underscores. Names must begin with a letter or
underscore.

export_dir Full path of the directory to export.

Group Management Commands 227


Variable Description
The maximum length of the entire directory path is 511 characters,
including all slashes (/). The maximum length of any individual directory
name is 256 characters, including one slash.

For example, the path can be a/b/c/d/e/f/g/.... up to a total length of


511 characters, or reallylongdirectoryname/... where each directory
name (and one slash) is 256 characters, for a total of 511 characters,
including all slashes.

Parameters
Parameter Description
client-IP address (Optional) IP address for client access to the export. The default is all
clients, or you can limit access to one specific IP address.

NOTE: You must specify a range of client IP addresses if you want


to set the trusted-user parameter to all.
Specify either client-IP or netgroup. If you specify both parameters,
FluidFS gives precedence to netgroup over client-IP.

access read-only|read- (Optional) Permission for the export, either read-only or read-write
write (default).
If not specified, uses the clusterwide default value.

limit-size size (Optional) Limits the container size reported to clients to the specified
value (in MB, GB, TB).
If not specified, uses the clusterwide default value.

trusted-users nobody| (Optional) Trusted user setting. Options are:


all|all-except-root
nobody
all
all-except-root (default)

NOTE: To specify all, you must also restrict the client-IP


parameter to a specific range.

netgroup netgroup_name (Optional) Name for the netgroup.

NOTE: Specify either client-IP or netgroup. If you specify both


parameters, FluidFS gives precedence to netgroup over client-
IP.

Examples
Create an NFS export for a container:

> nas-cluster select NAS_1 container select container1 nfs-export create


export1 /dir1

228 Group Management Commands


Restrict the client IP address range, and allow all users to connect as trusted users to any address in that
range:

> nas-cluster select NAS_1 container select container2 nfs-export create


export1 /dir1 client-IP 192.0.2.* trusted-user all

nas-cluster select container select nfs-export delete


Deletes an NFS export on a NAS container.

Format
nas-cluster select cluster_name container select container_name nfs-export
delete export_name

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

export_name Name of the NFS export to delete

Example
Delete an export from a container in the NAS cluster:

> nas-cluster select NAS_1 container sel container1 nfs-export delete export1

nas-cluster select container select nfs-export select


Selects an NFS export on a NAS container for additional operations.

Format
nas-cluster select cluster_name container select container_name nfs-export
select export_name [parameters] | show

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

export_name Name of the NFS export

Group Management Commands 229


Parameters
Parameter Description
client-IP address[es] IP address for client access to the export. The default is all clients, or
you can limit access to one specific IP address.

NOTE: If you want to set the trusted-user parameter to all,


you must specify a range of client IP addresses.

directory export-dir Full path of the directory to export. The maximum length of the entire
directory path is 511 characters, including all slashes (/). The maximum
length of any individual directory name is 256 characters, including one
slash.
For example, the path can be /a/b/c/d/e/f/g/.... up to a total length of
511 characters, or reallylongdirectoryname/... where each directory
name (and one slash) is 256 characters, for a total of 511 characters,
including all slashes.

limit-size [size|none] Limits the container size reported to clients to the specified value (in
MB, GB, TB).
To remove a limit, specify none.

read-only|read-write Permission for the export, either read-only or read-write (default)

trusted-users nobody| Trusted user setting. Options are:


all|all-except-root
nobody
all
all-except-root (default)

NOTE: To specify all, you must also specify a range of IP


addresses for the client-IP parameter.

security-methods Associates one or more of the following security methods with the NAS
method1,method2,... container:
comma-separated list
sys UNIX style
krb5 Kerberos v5
krb5i Kerberos v5 integrity
krb5p Kerberos v5 privacy

NOTE: By default, all security methods are enabled. If you specify


one or more parameter values, you will override the default setting.
Overriding the default disables the remaining unspecified values.

Subcommand
Subcommand Description
show Displays information about the NFS export

230 Group Management Commands


Examples
Assign a client IP address to an export directory:

> nas-cluster select NAS_1 container select container1 nfs-export select


export1 client-ip 192.0.2.28

Specify a directory path for an export directory:

> nas-cluster select NAS_1 container select container1 nfs-export select


export1 directory /dir1new

Limit the container size (reported to clients) for an export:

> nas-cluster select NAS_1 container select container1 nfs-export select


export1 limit-size 55mb

Set the permission on an export to read-only:

> nas-cluster select NAS_1 container select container1 nfs-export select


export1 read-only

Set the trusted users on an export to all users, and also (required) restrict the range of client IP addresses
that users can access:

> nas-cluster select NAS_1 container select container1 nfs-export select


export1 client-IP 192.2.*.* trusted-users all

Create only sys and krb5p security methods for the specified cluster and disable krb5 and krb5i:

> nas-cluster select NAS1 container select VOL1 nfs-export select NFS security-
methods sys,krb5p

nas-cluster select container select nfs-export show


Displays information about all NFS exports or a specific NFS export on a NAS container.

Format
nas-cluster select cluster_name container select container_name nfs-export show
[export_name]

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

export_name Name of a specific NFS export to display information about

Example
Display information about an NFS export:

Group Management Commands 231


> nas-cluster select cluster1 container select NASc1 nfs-export NFS show c1_sp47

___________________________ NFS Export Information ____________________________


Name: c1_sp47
Shared-Dir: /dir2
AccessType: read-write
Limit-Size: N/A
Client-IP: *.*.*.*
NFS-Trusted-Users: all-except-root
Security Methods:sys,krb5,krb5i,krb5p
______________________________________________________________________________
nas-cluster select cluster2 container select NASc1 nfs-export show
Name Exported Dir Access Client IP Trusted Users Security Methods
------------- --------------- ---------- --------------- ------------------ ----------------
c1_sp47 /dir2 read-write *.*.*.* all-except-rootsys, krb5,krb5i,krb5p
c1_fffff /dir2 read-write *.*.*.* all-except-root sys,krb5,krb5i,krb5p

nas-cluster select container select quota-dir create


Creates a quota directory rule for the specified directory, which needs to be empty. If the directory itself
does not exist, this command creates it and then creates the quota directory rule.

Format
nas-cluster select cluster_name container select container_name quota-dir
create directory_name [hardLimit size [softLimit size]

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

directory_name Full path for the quota directory rule. The maximum path length is 112
characters.

Parameters
Parameter Description
hardLimit size (Required) Sets a higher limit for quota directory usage and triggers an
error message when the limit is exceeded. This error prevents more
space from being used than the quota directory rule specifies.
The default unit is MB. If the size is specified in GB or TB, then the unit
must follow the value. For example: 2GB or 1TB

softLimit size (Optional) Sets a lower limit for directory quota usage and triggers a
warning message when the limit is exceeded.
The default unit is MB. If the size is specified in GB or TB, then the unit
must follow the value. For example: 2GB or 1TB

232 Group Management Commands


Example
Create a quota directory rule for a directory with a hard limit:

> nas-cluster select NAS_1 container select CON_2 quota-dir create /DIR_5
hardLimit 2GB

nas-cluster select container select quota-dir delete


Deletes the existing quota directory rule for the specified directory. The directory reverts to behaving like
a normal directory.

Format
nas-cluster select cluster_name container select container_name quota-dir
delete directory_name

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

directory_name Full path for the quota directory rule. The maximum path length is 112
characters.

Example
Delete the quota directory rule for a directory in a NAS container:

> nas-cluster select NAS_1 container select CON_2 quota-dir delete /DIR_5

nas-cluster select container select quota-dir select


modify
Modifies a previously created quota directory rule.

Format
nas-cluster select cluster_name container select container_name quota-dir
select directory_name modify hardLimit|softLimit

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Group Management Commands 233


Variable Description
directory_name Full path for the quota directory rule. The maximum path length is 112
characters.

Parameters
Parameter Description
hardLimit size Sets a higher limit for the quota directory and triggers an error message
when the limit is exceeded. This error prevents more space from being
used than the quota directory rule specifies.
The default size is MB. If the size is specified in GB or TB, then the size
must follow the value. For example: 2GB or 1TB

softLimit size Sets a lower limit for the quota directory and triggers a warning
message when the limit is exceeded.
The default size is MB. If the size is specified in GB or TB, then the size
must follow the value. For example: 2GB or 1TB

Example
Modify the quota directory rule for a directory by specifying a soft limit:

> nas-cluster select NAS_1 container select CON_2 quota-dir select /DIR_5
modify softLimit 1GB

nas-cluster select container select quota-dir show


Displays the existing quota directories for the specified container, if any directories have quota directory
rules.

Format
nas-cluster select cluster_name container select container_name quota-dir show

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Example
Display the quota directories for a NAS container. Quota usage indicates the quota currently used by a
quota directory.

> nas-cluster select NAS_1 container select CON_2 quota-dir show


DirectoryName SoftLimit HardLimit QuotaUsage
------------------------ ---------- ---------- ----------

234 Group Management Commands


/a1 1MB 2MB 0MB
/a2 2MB 3MB 0MB

nas-cluster select container select quota-usage


Displays quota usage information for all users and groups using the NAS container.

Format
nas-cluster select cluster_name container select container_name quota-usage show

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Example
Display quota usage information for all users and groups using a NAS container:

> nas-cluster select NAS1 container select c1 quota-usage show

nas-cluster select container select rename


Renames a NAS container.

Format
nas-cluster select cluster_name container select container_name rename new_name

Variables
Variable Description
cluster_name NAS cluster name

container_name Current name of the container

new_name New name for the container. Valid characters include letters, numbers,
and underscores. Names must begin with a letter or underscore.

nas-cluster select container select replication


Configures and manages replication of a NAS container.

Format
nas-cluster select cluster_name container select container_name replication
parameter

Group Management Commands 235


Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Parameters
Parameter Description
apply-access-config Applies the replication configuration from a source container to this
container

enable partner Enables replication on the container to the specified partner. Optionally
[destination] names the destination container.
To disable (delete) replication on a container, see partner select
outbound-nas-replication.

pause | resume Pauses or resumes replication of the container to the specified partner
partner_name

read-only-access Disables read-only access to a replica container that previously had


[disable] read-only access enabled (see partner select inbound-nas-replication
select)

Subcommands
Subcommand Description
cancel Cancels an in-progress container replication

demote partner_name Demotes a standalone container, reestablishing the replication


relationship

promote [keep-demote] Promotes the replica container. Optionally, specify one or both of the
[keep-dest-config] following parameters:
partner_name
keep-demote Applies the configuration from a source container
to this container.
keep-dest-config Keeps the original replica container
configuration. Opposite of the nas-cluster select container select
replication apply-access-config command.

replicate partner_name Starts container replication to the specified partner

select partner_name Selects a replication partner

show Displays container replication information

236 Group Management Commands


Example
Display replication information for a container in a NAS cluster:

> nas-cluster select NCLU1 container select BIN1 replication show


___________________________ Replication Partners _____________________________
Partner Name Replica Container Status % Transferred
--------------- ----------------- ----------- --------------
cash BIN1_1160 Idle 24657MB
StartTime EndTime Data Transfer
-------------------- -------------------- ---------- ---------------

nas-cluster select container select schedule


Manages snapshot schedules on a NAS container.

Format
nas-cluster select cluster_name container select container_name schedule
subcommand

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Subcommands
Subcommand Description
create Creates a snapshot schedule

delete Deletes the specified schedule

select Manages the selected schedule

rename Renames the selected schedule

show Displays information about the schedules

nas-cluster select container select schedule create


Creates a snapshot or replication schedule on a NAS container.
When you create a replication schedule, you must specify a replication partner.

Format
nas-cluster select cluster_name container select container_name schedule create
schedule_name parameters

Group Management Commands 237


Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

schedule_name Name of the schedule, up to 63 characters (letters, numbers, and


underscores)

Parameters
Parameter Description
type run_type Specifies when the schedule will run:
once
hourly
daily

start-time time Specifies when the schedule will start. For example: 6, 7AM, 08:30AM,
3:30PM, 23:00

end-time time Specifies when the schedule will end. For example: 6, 7AM, 08:30AM,
3:30PM, 23:00
The default is the time for start-time.

max-keep n Specifies how many snapshots or replicas, created by the schedule, to


keep. Range: 1 to 512. Default: 10.

frequency frequency Specifies how often the schedule will run. For example: 5mins, 1hour,
90mins, 2hours
Does not apply if type is once.

start-date date Specifies the start date for a schedule in MM/DD/YY format. Default is
the date the schedule is created.
Does not apply if type is once.

end-date date Specifies the end date for a schedule in MM/DD/YY format. Default is no
end date.
Does not apply if type is once.

repeat-interval Applies only to type daily.


interval
Specifies the number of days between snapshot or replica creations (for
example, 2days). Range: 1 to 100 days.

partner partner_name Applies only to replication schedules. Specifies the name of the partner
to which this replication schedule applies.

238 Group Management Commands


nas-cluster select container select schedule delete
Deletes a snapshot or replication schedule for a NAS container.

Format
nas-cluster select cluster_name container select container_name schedule delete
schedule_name

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

schedule_name Name of the schedule to delete

nas-cluster select container select schedule rename


Renames a snapshot or replication schedule for a NAS container.

Format
nas-cluster select cluster_name container select container_name schedule rename
schedule_name new_name

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

schedule_name Current name of the schedule. If the schedule name contains spaces,
enclose the name in quotation marks (for example, schedule for daily
backups).

NOTE: You cannot create schedule names with spaces using the
CLI; however, you can in the GUI.

new_name New name for the schedule.


Name can be up to 63 characters, and is case insensitive. Valid
characters include any printable Unicode character except for ! " # $ %
& ' ( ) * + , / ; < = > ?@ [ \ ] ^ _ ` { | } ~. First and last characters cannot
be a period, dash or colon. Fewer characters are accepted for this field
if you enter the value as a Unicode character string, which takes up a
variable number of bytes, depending on the specific character.

Group Management Commands 239


nas-cluster select container select schedule select
Selects a snapshot or replication schedule for a NAS container for additional operations.

Format
nas-cluster select cluster_name container select container_name schedule select
schedule_name parameters

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

schedule_name Name of the schedule to select.


If the schedule name contains spaces, enclose the name in quotation
marks (for example, schedule for daily backups).

NOTE: You cannot create schedule names with spaces using the
CLI; however, you can in the GUI.

Parameters
Parameter Description
enable|disable Enables or disables the selected schedule

type run_type Specifies when the schedule will run:


once
hourly
daily

start-time time Specifies when the schedule will start. For example: 6, 7AM, 08:30AM,
3:30PM, 23:00

end-time time Specifies when the schedule will end. For example: 6, 7AM, 08:30AM,
3:30PM, 23:00
The default is the time for start-time.

max-keep n Specifies how many snapshots or replicas, created by the schedule, to


keep.
Range: 1 to 512. Default: 10

frequency frequency Specifies how often the schedule will run. For example: 5mins, 1hour,
90mins, 2hours
Does not apply if type is once.

240 Group Management Commands


Parameter Description
start-date date Specifies the start date for a schedule in MM/DD/YY format. Default is
the date the schedule is created.
Does not apply if type is once

end-date date Specifies the end date for a schedule in MM/DD/YY format. Default is no
end date.
Does not apply if type is once.

repeat-interval Applies only to type daily.


interval
Specifies the number of days between snapshot or replica creations (for
example, 2days). Range: 1 to 100 days

nas-cluster select container select schedule show


Displays information about all snapshot or replication schedules or a specific schedule for a NAS
container.

Format
nas-cluster select cluster_name container select container_name schedule show
[schedule_name]

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

schedule_name Name of a schedule to display. If the schedule name contains spaces,


enclose the name in quotation marks (for example, schedule for daily
backups).

NOTE: You cannot create schedule names with spaces using the
CLI; however, you can in the GUI.

nas-cluster select container select show


Displays information about a specific container in a NAS cluster.

Format
nas-cluster select cluster_name container select container_name show

Group Management Commands 241


Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Example
Display information about a container.

> nas-cluster select NAS_1 container select CON_2 show

____________________________ Container Information ___________________________


Name: CON_2 ContainerCapacity: 1GB
Space-Warn: 80% Snap-Reserve: N/A
Snap-Reserve-Avail: 100% (1GB) Snap-Warn: N/A
File-Access-Security: ntfs Dir-Permission: 755
File-Permission: 744 AllocatedContainerSpace: 1GB
InUseContainerSpace: 9MB FreeContainerSpace: 1014MB
SnapSpaceUsedByUserData: N/A SnapSpaceUsedBySnapshots: N/A
No Of Snapshots: 1 NFS-Exports: 0
SMB-Shares: 1 Type: Standalone
Thin-Clone: No
InodeDistribution: enabled
_________________________ Data Reduction Information _________________________
DataReduction: enabled DataReduction-Status: enabled
Rehydrate on read: enabled
Deduplication: enabled Compression: enabled
DataReduction-Space-Savings: 0MB Filter-Mode: use-filters
Access-Time-Filter: 45 days Modify-Time-Filter: 45 days
DataReduction-Free-Space-Condition:
Current free space is below 5GB
required to run data reduction on
this container. Increase the free
space available.
______________________________________________________________________________

nas-cluster select container select size


Modifies the size of a NAS container.

Format
nas-cluster select cluster_name container select container_name size new_size

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

new_size Specifies the new size of the container (capacity) in MB (default) or GB

242 Group Management Commands


nas-cluster select container select smb-share
Manages SMB shares on a NAS container.

Format
nas-cluster select cluster_name container select container_name smb-share
subcommand

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Subcommands
Subcommand Description
create Creates an SMB share on the container

delete Deletes the SMB share

select Manages the SMB share

show Displays information about the SMB shares on the container

nas-cluster select container select smb-share create


Creates an SMB share on a NAS container.

Format
nas-cluster select cluster_name container select container_name smb-share
create parameters share_name directory

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

share_name Name for the SMB share.


Valid characters include letters, numbers, and underscores. Names must
begin with a letter or underscore.

directory Specifies a path for the SMB share directory.

Group Management Commands 243


Variable Description
The maximum length of the directory path is 511 characters, including
all slashes (/). The maximum length of any individual directory name is
256 characters, including one slash.

For example, the path can be a/b/c/d/e/f/g/.... up to a total length of 511


characters, or reallylongdirectoryname/... where each directory name
(and one slash) is up to 256 characters, for a total of 511 characters,
including all slashes.

Parameters
Parameter Description
antivirus enable| Enables or disables antivirus detection on the SMB share
disable

avexcludedirs Specifies a path within the SMB share to exclude from antivirus scanning
directory_path

avextensions Comma-separated list of file extensions in the SMB share to exclude


extension_list from antivirus scans. Wildcards are not allowed.

continuousavailability Enables or disables the tracking of file operations on a highly available


enable|disable share so that clients can fail over to another node of the cluster without
interruption

messageencryption Enables or disables making data transfers secure by encrypting data in-
enable|disable flight

Example
Create an SMB share on a directory:

> nas-cluster select NAS1 container select container1 smb-share create share1
/smbdir1

NOTE: The default antivirus exclude path is no longer available. Directory paths must already exist in
the SMB share before they can be excluded.
To exclude directory paths from antivirus scanning:

1. Create the SMB share without the exclude option. See the Dell EqualLogic Group Manager
Administrator's Guide for details.
2. Go to the SMB share and create the directory paths you want to exclude from the antivirus
scanning.
3. In the Group Manager GUI, modify the antivirus setting by specifying the file extensions and/or
directory paths to exclude.
CAUTION: Any default antivirus exclude path that you have set in previous versions will be lost.

244 Group Management Commands


nas-cluster select container select smb-share delete
Deletes an SMB share on a NAS container.

Format
nas-cluster select cluster_name container select container_name smb-share
delete share_name

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

share_name Name of the SMB share to delete

Example
Delete an SMB share in a container:

> nas-cluster select NAS_1 select kris1 smb-share delete k1

nas-cluster select container select smb-share select


Selects an SMB share on a NAS container for additional operations.
Suspicious or infected files are always quarantined.

Format
nas-cluster select cluster_name container select container_name smb-share
select share_name parameters

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

share_name Name of the SMB share

Group Management Commands 245


Parameters
Parameter Description
antivirus enable|disable Enables or disables antivirus scanning on the SMB share

avexcludedirs Specifies a path to exclude from antivirus scanning


directory_path

avextensions Comma-separated list of file extensions to exclude from antivirus


extension_list scans. Wildcards are not allowed.

directory Specifies a path for the SMB share directory.


If you do not specify a slash (/), the command assumes the root of
the SMB share.

The maximum length of the entire directory path is 511 characters,


including all slashes (/). The maximum length of any individual
directory name is 256 characters, including one slash.

For example, the path can be a/b/c/d/e/f/g/.... up to a total length of


511 characters, or reallylongdirectoryname/... where each directory
name (and one slash) is 256 characters, for a total of 511 characters,
including all slashes.

continuousavailability Enables or disables the tracking of file operations on a highly


enable|disable available share so that clients can fail over to another node of the
cluster without interruption

messageencryption Enable or disable making data transfers secure by encrypting data in-
enable|disable flight

show Displays information about the selected SMB share

Examples
Displaying SMB Share Details

Display details about an SMB share:

> nas-cluster select NAS1 container select container1 smb-share select SMB_1
show
___________________________ SMB Share Information ___________________________
Name: test Shared-Dir: /
SMB-Antivirus: disable SMB-FileExtensions:
SMB-ExcludeDirPaths:

______________________________________________________________________________

Excluding Directories from Antivirus Scanning

Exclude two directories from antivirus scanning within an SMB share:

> nas-cluster select NAS1 container select container1 smb-share select


avexcludedirs var,bin

246 Group Management Commands


Excluding File Types from Antivirus Scanning

Exclude file extensions for graphics from antivirus scanning within an SMB share:

> nas-cluster select NAS1 container select container1 smb-share select


avextensions jpg,bmp,tiff,gif,png

NOTE: The default antivirus exclude path is no longer available. Directory paths must already exist in
the SMB share before they can be excluded.
To exclude directory paths from antivirus scanning:

1. Create the SMB share without the exclude option. See the Dell EqualLogic Group Manager
Administrator's Guide for more details.
2. Go to the SMB share and create the directory paths you want to exclude from the antivirus
scanning.
3. In the Group Manager GUI, modify the antivirus setting by specifying the file extensions and/or
directory paths to exclude.
CAUTION: Any default antivirus exclude path that you have set in previous versions will be lost.

nas-cluster select container select smb-share select


continuousavailability
Enables or disables the tracking of file operations on a highly available share so that clients can fail over
to another node of the cluster without a connection drop.

Format
nas-cluster select cluster_name container select container_name smb-share
select share_name continuousavailabilty enable|disable

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

share_name Name of the SMB share

Example
Enable continuous availability on a share:

> nas-cluster select cluster6 container select container1 smb-share select


share3 continuousavailability enable

Group Management Commands 247


nas-cluster select container select smb-share select
messageencryption
Enables or disables traffic encryption while connected to the share. If enabled, system-level settings take
precedence over share-level settings.

Format
nas-cluster select cluster_name container select container_name smb-share
select share_name messageencryption enable|disable

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

share_name Name of the SMB share

Example
Enable traffic encryption while connected to a share:

> nas-cluster select cluster6 container select container1 smb-share select


share3 messageencryption enable

nas-cluster select container select smb-share show


Displays all SMB shares or a specific SMB share on a NAS container.

Format
nas-cluster select cluster_name container select container_name smb-share show
[share_name]

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

share_name Name of the SMB share

248 Group Management Commands


Example
Display information about an SMB share:

> nas-cluster select NAS1 container select sales smb-share show SMB_1
___________________________ SMB Share Information ___________________________
Name: SMB_1 Exported-Dir: /smbdir1new

______________________________________________________________________________

The following information is displayed with the advanced options for this command:

> nas-cluster select NAS1 container select sales smb-share select SMB_1 show
___________________________ SMB Share Information ___________________________
Name: SMB_1
Shared-Dir: /
AMB-Antivirus: disable
SMB-ThreatActionPolicy: quarantine
SMB-FileExtensions:
SMB-ExcludedDirPaths:
SMB-LargeFileSize: 3072MB
SMB-LargeFileOpenPolicy: denied
SMB-Access-Based_Enumeration: disable
SMB-Continuous-Availability: disable
SMB-Message-Encryption: disable
______________________________________________________________________________

nas-cluster select container select snap-reserve


Modifies the snapshot reserve for a NAS container.

Format
nas-cluster select cluster_name container select container_name snap-reserve
percent

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

percent Snapshot reserve, as a percentage of the container size:


Minimum0%
Maximum90%
Default80%

Group Management Commands 249


nas-cluster select container select snap-warn
Modifies the in-use snapshot space warning limit for a NAS container.

Format
nas-cluster select cluster_name container select container_name snap-warn
percent

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

percent Snapshot reserve in-use space warning limit, as a percentage of the


snapshot reserve size:
Minimum10%
Maximum100%
Default80%

nas-cluster select container select snapshot


Manages snapshots of a NAS container.

Format
nas-cluster select cluster_name container select container_name snapshot
subcommand

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Subcommands
Subcommand Description
create-now Creates a snapshot of the container

delete Deletes the specified snapshot

rename Renames a snapshot

select Selects a snapshot for additional operations

250 Group Management Commands


Subcommand Description
show Displays all the snapshots for the container

nas-cluster select container select snapshot create-now


Creates a snapshot immediately of a NAS container.

Format
nas-cluster select cluster_name container select container_name snapshot create-
now snapshot_name

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

snapshot_name Name of the snapshot

Example
Create a snapshot of a container:

> nas-cluster select NAS_1 container select container3 snapshot create-now


container3snap1

nas-cluster select container select snapshot delete


Deletes a snapshot of a NAS container.

Format
nas-cluster select cluster_name container select container_name snapshot delete
snapshot_name

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

snapshot_name Name of the snapshot to delete

Group Management Commands 251


Example
Delete a snapshot of a container:

> nas-cluster select NAS_1 container select container3 snapshot delete


container3snap1a

nas-cluster select container select snapshot rename


Renames a snapshot of a NAS container.

Format
nas-cluster select cluster_name container select container_name snapshot rename
snapshot_name new_name

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

snapshot_name Current name of the snapshot

new_name New name for the snapshot

Example
Rename a snapshot of a container:

> nas-cluster select NAS_1 container select container3 snapshot rename


container3snap1 container3snap1a

nas-cluster select container select snapshot select


Selects a snapshot of a NAS container for additional operations.

Format
nas-cluster select cluster_name container select container_name snapshot select
snapshot_name subcommand

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

252 Group Management Commands


Variable Description
snapshot_name Name of the snapshot

Subcommands
Subcommand Description
restore Restores the container from the selected snapshot

thin-clone create Creates a clone from the select snapshot. See nas-cluster select
container select snapshot select thin-clone create.

show Displays information about the selected snapshot

Examples
Display information about a snapshot of a container:

> nas-cluster select NAS_1 container select container1 snapshot select


container1_snap_2015_05_20_12_49_47_8794040_4 show
____________________________ Snapshot Information ____________________________
Name: Size: 2647MB
container1_snap_2015_05_20_12_49_47 DateAndTime: 2015-05-20:13:49:50
_8794040_4 Schedule:
______________________________________________________________________________

Restore a container from a snapshot:

> nas-cluster select NAS_1 container select container1 snapshot select


container1_snap_2015_05_20_12_49_47_8794040_4 restore
container container1 was successfully restored from the snapshot.

nas-cluster select container select snapshot select thin-


clone create
Creates a clone for a container based on the specified snapshot.

Format
nas-cluster select cluster_name container select container_name snapshot select
snapshot_name thin-clone create thin_clone_name [size]

Variables
Variables Description
cluster_name NAS cluster name

container_name Name of the container

snapshot_name Name of the snapshot

thin_clone_name Name of the thin clone

Group Management Commands 253


Variables Description
size (Optional) Size of the thin clone

Example
Create a clone for the container based on the specified snapshot:

> nas-cluster select NASclstr1 container select c1 snapshot select snap1 thin-
clone create c1_snap1_clone

nas-cluster select container select snapshot show


Displays the snapshots for the specified container.

Format
nas-cluster select cluster_name container select container_name snapshot show

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Example
Display the snapshots for a container:

> nas-cluster select NASclstr1 container select c3 snapshot show

Name Size Schedule timestamp Clones


------------------------ ----- ------------------- -------
c3_s1 0MB 2015-02-12:16:16:19 1
c3_s2 1MB 2015-02-12:16:16:22 0
rep_2015_02_12__16_17_43 1MB 2015-02-12:16:17:44 0

nas-cluster select container select space-warn


Modifies the in-use space warning limit for a NAS container.

Format
nas-cluster select cluster_name container select container_name space-warn
percent%

254 Group Management Commands


Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

percent% In-use space warning limit, as a percentage of the container size:


Minimum 10%
Maximum 90%
Default 80%

Example
Set an in-use space warning percent for a container:

> nas-cluster select NAS_1 container select container1 space-warn 75%

nas-cluster select container select thin-clone show


Displays a list of clones that were created based on the specified container. To show more details, you
can select an individual clone NAS container and show its configuration and statistics.

Format
nas-cluster select cluster_name container select container_name thin-clone show

Variables
Variables Description
cluster_name NAS cluster name

container_name Name of the container

Example
Display the clones for a container:

> nas-cluster select nasgrp1 container select c11 thin-clone show

Name Used Space NFS exports SMB shares


---- --------- ---------- -------------
c11_clone 3MB 0 0
c11_clone11 3MB 0 0

Group Management Commands 255


nas-cluster select container select thin-provision disable
Disables thin provisioning if enough space is available to allocate the full container size. Otherwise, an
error is generated.

Format
nas-cluster select cluster_name container select container_name thin-provision
disable

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Example
Disable thin provisioning on the specified container:

> nas-cluster select cluster1 container select c1 thin-provision disable

nas-cluster select container select thin-provision enable


Enables thin provisioning on the container. If thin provisioning is already enabled, no action is taken. The
container reserve size is set to the containers used space or clusterwide default settings, whichever is
greater.

Format
nas-cluster select cluster_name container select container_name thin-provision
enable

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Example
Enable thin provisioning on the specified container:

> nas-cluster select cluster1 container select c1 thin-provision enable

256 Group Management Commands


nas-cluster select container select thin-provision enable
thin-reserve
Enables thin provisioning for the existing container.

Format
nas-cluster select cluster_name container select container_name thin-provision
enable thin-reserve [percent]%

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

percent% Percentage of the reserve on the NAS container

Example
Set the percentage of the reserve on the specified container:

> nas-cluster select cluster1 container select c1 thin-provision enable thin-


reserve 30%

nas-cluster select container select user-quota


Modifies the user quotas for a NAS container.
If user and group quota rules are in place for the source container, the system will apply those quotas to
the recovery container as follows:

If you are using an external server (such as Active Directory, LDAP, or NIS) to authenticate users and
groups on the destination cluster, quotas will be applied to the recovery container.
If you are using only local users and groups, quotas will not be applied.
If you are using both local users and groups and externally authenticated users and groups, user and
group quotas are applied for the externally authenticated accounts. Quotas will also be applied for the
local users and groups, but they might not be applied correctly.

For more information about this behavior, see the Dell EqualLogic Group Manager Administrator's Guide.

Format
nas-cluster select cluster_name container select container_name user-quota
subcommand

Group Management Commands 257


Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Subcommands
Subcommand Description
create Creates a quota for the specified user

delete Deletes the specified user quota

modify Modifies the quota for the specified user

select show Displays the specified user quota

show Displays the user quotas for the container or the specified user quota

Example
Display the user quotas for a NAS container:

> nas-cluster select NAS1 container select container_fs5 user-quota show


Name Limit Warn Usage
--------------------------------------------- ---------- ---------- ----------
usr1 100MB 0% 0MB

nas-cluster select container select user-quota create


Creates a quota for a user of a NAS container.

Format
nas-cluster select cluster_name container select container_name user-quota
create user_name quota [percent]

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

user_name Name of the user whose quota you are creating

quota Quota size (amount of container space that the user can consume)

258 Group Management Commands


Variable Description
percent Quota space warning limit at which a warning is generated, specified as
a percentage of the quota size. If not specified, no warning is generated.

nas-cluster select container select user-quota delete


Deletes a user quota for a NAS container.

Format
nas-cluster select cluster_name container select container_name user-quota
delete user_name

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

user_name Name of the user quota to be deleted

nas-cluster select container select user-quota-effective-


rule select show
Displays the quota in effect for a user using a container, when that user does not have his or her own
quota. For users without a quota, the default user quota on the container applies.

Format
nas-cluster select cluster_name container select container_name user-quota-
effective-rule select user_name show

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

user_name Name of the user to select

Subcommands
Subcommand Description
select show Selects a user to display information about the quota applied to that
user based on the container's default user quota

Group Management Commands 259


nas-cluster select container select user-quota modify
Modifies a user quota for a NAS container.

Format
nas-cluster select cluster_name container select container_name user-quota
modify user_name quota_value warn_level

NOTE: You must enter a value for both the quota and the warning limit. To change one value
without changing the other, use the show command to display the current values (see nas-cluster
select container select user-quota). Then enter this command, specifying both the value that stays
the same and the value that changes. See the examples.

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

user_name Name of the user whose quota you are changing

Parameters
Parameter Description
quota_value Quota size (amount of container space the user can consume) in MB,
GB, or TB

warn_level Quota space warning limit (specified as a percentage of the quota size)
that, when reached, generates a warning. If not specified, no warning is
generated. The percent sign (%) is required.

Examples
Change the user quota for a user for a container in a NAS cluster. The new quota value for the user is
200GB, with a warning level of 75 percent. When the user consumes 75 percent of the quota, a warning
is generated.

> nas-cluster select NAS1 container select usr user-quota modify koala 200GB 75%

koala has been successfully updated.

Change only the quota value, leaving the warning level as is. (First, use the show command to display the
current values if you are unsure.) In this example, the warning level stays at 75 percent, but the quota
value increases to 300GB for the user.

> nas-cluster select NAS1 container select usr user-quota modify koala 300GB 75%

koala has been successfully updated.

260 Group Management Commands


Change only the warning level, leaving the quota value as is. (First, use the show command to display the
current values if you are unsure.) In this example, the quota value stays at 300GB, but the warning level
decreases to 60 percent per user.

> nas-cluster select NAS1 container select usr user-quota modify koala 300GB 60%

koala has been successfully updated.

nas-cluster select container select user-quota select


show
Displays quota values for a user.

Format
nas-cluster select cluster_name container select container_name user-quota
select user_name show

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

user_name Name of the user to display the quota values of

Example
Display the quota for a user for a NAS container:

> nas-cluster select NAS1 container select con34 user-quota select admin show

nas-cluster select container select useringroup-quota


Manages quotas for each user in a group for a NAS container.
If user and group quota rules are in place for the source container, the system will apply those quotas to
the recovery container as follows:

If you are using an external server (such as Active Directory, LDAP, or NIS) to authenticate users and
groups on the destination cluster, quotas will be applied to the recovery container.
If you are using only local users and groups, quotas will not be applied.
If you are using both local users and groups and externally authenticated users and groups, user and
group quotas are applied for the externally authenticated accounts. Quotas will also be applied for the
local users and groups, but they might not be applied correctly.
For more information about this behavior, see the Dell EqualLogic Group Manager Administrator's Guide.

Format
nas-cluster select cluster_name container select container_name useringroup-
quota subcommand

Group Management Commands 261


Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Subcommands
Subcommand Description
create Creates a quota for each user in a group

delete Deletes the individual user quota for the specified group

modify Modifies the user-in-group quota for the specified group

select show Displays the user-in-group quota for the specified group

show Displays all the user-in-group quotas

Example
Display the user-in-group quotas for a container in a NAS cluster:

> nas-cluster select NAS1 container select usr useringroup-quota show

Name Limit Warn Usage


-------------------------------------------- --------- ---------- ---------
grp1 300MB 50% 0MB

nas-cluster select container select useringroup-quota


create
Creates a quota for each user in a group for a NAS container.

Format
nas-cluster select cluster_name container select container_name useringroup-
quota create group_name quota_value warn_level%

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

group_name Name of the user group for the container

262 Group Management Commands


Variable Description
quota_value Quota size (amount of container space each user can consume) in MB,
GB, or TB:
Minimum 0 (no quota; user can use any amount of available
space)
Maximum Depends on the size of the container

warn_level% Quota space warning limit (specified as a percentage of the quota size)
that, when reached, generates a warning. If not specified, no warning is
generated.
Minimum 0% (default)
Maximum 99%

Examples
Create a user group for a container in a NAS cluster, and set the quota for all users in that group and a
warning level:

> nas-cluster select NAS1 container select usr useringroup-quota create group1
150GB 75%

nas-cluster select container select useringroup-quota


delete
Deletes the individual user quota for the specified group for a NAS container.

Format
nas-cluster select cluster_name container select container_name useringroup-
quota delete group_name

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

group_name Name of the user group for the container

Example
Delete the user quotas for a group for a container in a NAS cluster:

> nas-cluster select NAS1 container select usr useringroup-quota delete group1

Group Management Commands 263


nas-cluster select container select useringroup-quota
modify
Modifies the user-in-group quota for the specified group for a NAS container.

Format
nas-cluster select cluster_name container select container_name useringroup-
quota modify group_name quota_value warn_level

NOTE: You must enter a value for both the quota and the warning limit. To change one value
without changing the other, use the show command to display the current values (see nas-cluster
select container select useringroup-quota). Then enter this command, specifying both the value
that stays the same and the value that changes.

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

group_name Name of the user group whose values you are changing

quota_value Quota size (amount of container space each user in the group can
consume) in MB, GB, or TB

warn_level% Quota space warning limit (specified as a percentage of the quota size)
that, when reached, generates a warning.
The percent sign (%) is required.

Examples
Change the quota value without changing the warning level. (First, use the show command to display the
current values if you are unsure.) In this example, the warning level stays at 75 percent, but the quota
value increases to 300GB for each user.

> nas-cluster select NAS1 container select users useringroup-quota modify sales
300GB 75%

Change the warning level without changing the quota value. (First, use the show command to display the
current values if you are unsure.) In this example, the quota value stays at 300GB, but the warning level
decreases to 60 percent per user.

> nas-cluster select NAS1 container select users useringroup-quota modify sales
300GB 60%

264 Group Management Commands


nas-cluster select container select useringroup-quota
select show
Displays the configured user-in-group quotas for a NAS container and the amount of quota space that is
currently being used.
NOTE: The system does not display quota usage values for the default user or default group. In
these cases, quota usage is always displayed as zero. However, the system does show quota usage
for all other groups and users.

Format
nas-cluster select cluster_name container select container_name useringroup-
quota select group_name show

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

group_name Name of the user group for the container

Example
Display the user-in-group quotas for the specified group:

> nas-cluster select NAS1 container select usr useringroup-quota select grp1
show

Name Limit Warn Usage


--------------------------------------------- ---------- ---------- ----------
grp1 300MB 50% 0MB

nas-cluster select container show


Displays information about snapshot usage as well as snapshot reserve limits on a NAS container.

Format
nas-cluster select cluster_name container show

Variable
Variable Description
cluster_name NAS cluster name

Group Management Commands 265


Example
Display snapshot information for the specified cluster:

> nas-cluster select nasgrp1 container show

Name Size Used Space Snap Res Used Snap NFS SMB Data Red Clone Thin
---------- ------- ---------- -------- --------- --- ---- -------- ----- ----
c1 5GB 6MB 2.5GB 0MB 0 0 disable no N
Container1 10GB 3GB 5GB 0MB 0 1 disable no N
Container1 10GB 3GB 0MB 0MB 0 1 disable yes Y
Clone1
Container1 10GB 9GB 0MB 0MB 0 1 disable yes N
Clone2
Container1 10GB 1MB 5GB 0MB 0 0 disable yes N
Clone3

nas-cluster select controller


Manages NAS nodes (controllers) in a NAS cluster.

Format
nas-cluster select cluster_name controller subcommand

Variable
Variable Description
cluster_name NAS cluster name

Subcommands
Subcommand Description
add Adds the controller with the specified service tag to the NAS cluster

select Manages the selected controller

show Displays information about all the controllers or the specified controller

Examples
Display information about all controllers in a NAS cluster:

> nas-cluster select NAS1 controller show


Name Service Tag Version NAS Controller State
------------ ----------- ---------- --------------------
controller0 C93MTQ1 V3.0.7441 online
controller1 G93MTQ1 V3.0.7441 online

266 Group Management Commands


Display information about a specific controller in a NAS cluster:

> nas-cluster select NAS1 controller show controller1


______________________ Appliance Controller Information ______________________
Name: controller1 Service Tag: G93MTQ1
Model: FS7500 Vendor: Dell
Product Type: FS7500 Version: V3.0.7441
Peer Name: controller0 Config State: configured
DesiredStatus: on Status: critical
State: online Location: irrelevant
Temperature Status: optimal Temperature Value: 23
System Controller Id: G93MTQ1 BPS Status: not available
BPS Is Accessible: false BPS Model: Not Available
BPS Charge: 0% CPU Overall Status: optimal
CPU Core Count: 8 Overall Fan Status: optimal
Overall Local Disk Status: optimal Overall Raid Controller Status:
Overall Virutal Disk Status: optimal optimal
Memory Status: optimal Memory Size: 24576
Client Network Status: optimal Client Network Speed: 1GB
ethernet
Internal Network Status: optimal Internal Network Speed: 1GB
ethernet
San Network Status: optimal San Network Speed: 1GB ethernet
Overall Power Supply Status: partial
______________________________________________________________________________

nas-cluster select controller add


Adds a NAS controller to a NAS cluster.

Format
nas-cluster select cluster_name controller add service_tag

Variables
Variable Description
cluster_name NAS cluster name

service_tag Service tag for the controller.


Use the discover-devices command to obtain service tags.

nas-cluster select controller select


Manages a NAS controller in a NAS cluster.

Format
nas-cluster select cluster_name controller select controller_name subcommand

Group Management Commands 267


Variables
Variable Description
cluster_name NAS cluster name

controller_name Name of the controller

Subcommands
Subcommand Description
attach Attaches the NAS controller with the specified service tag to the NAS
cluster

client-connection show Displays the client connection for the NAS controller

detach Detaches the selected NAS controller from the NAS cluster, returning
the controller to a preconfigured state

disk show Displays disk information for the selected NAS controller

eth show Displays network (Ethernet) port information for the selected NAS
controller

power-supply show Displays power supply information for the selected NAS controller

show Displays information about the selected controller

Examples
Display general information about a NAS controller:

> nas-cluster select NAS1 controller select controller0 show


______________________ Appliance Controller Information ______________________
Name: controller0 Service Tag: C93MTQ1
Model: FS7500 Vendor: Dell
Product Type: FS7500 Version: V3.0.7441
Peer Name: controller1 Config State: configured
DesiredStatus: on Status: critical
State: online Location: irrelevant
Temperature Status: optimal Temperature Value: 20
System Controller Id: C93MTQ1 BPS Status: not available
BPS Is Accessible: false BPS Model: Not Available
BPS Charge: 0% CPU Overall Status: optimal
CPU Core Count: 8 Overall Fan Status: optimal
Overall Local Disk Status: optimal Overall Raid Controller Status:
Overall Virtual Disk Status: optimal optimal
Memory Status: optimal Memory Size: 24576
Client Network Status: optimal Client Network Speed: 1GB
ethernet
Internal Network Status: optimal Internal Network Speed: 1GB
ethernet
San Network Status: optimal San Network Speed: 1GB ethernet
Overall Power Supply Status: partial
______________________________________________________________________________

268 Group Management Commands


Display the client connection for a NAS controller:

> nas-cluster select NAS1 controller select controller0 client-connection show


Client IP User Name Open Files Connected Time Idle Time Guest
Type
----------- ---------- ---------- --------------- ---------- -----
----
192.0.2.29 th18\nandesh 1 22hr 32min 56secs 0secs N
smb

Display the disk information for a NAS controller:

> nas-cluster select NAS1 controller select controller0 disk show


Name Status
--------------- --------------------
Physical Disk 0 optimal
:0:0:0
Physical Disk 0 optimal
:0:0:1

Display the fan information for a NAS controller:

> nas-cluster select NAS1 controller select controller0 fan show


Name Status Rpm Rpm Range
------------------------------ -------------------- ---------- ---------------
System Board FAN MOD 1A RPM optimal 4440 NotAvailable
System Board FAN MOD 1B RPM optimal 3120 NotAvailable
System Board FAN MOD 2A RPM optimal 4440 NotAvailable
System Board FAN MOD 2B RPM optimal 3000 NotAvailable
System Board FAN MOD 3A RPM optimal 4440 NotAvailable
System Board FAN MOD 3B RPM optimal 3000 NotAvailable
System Board FAN MOD 4A RPM optimal 4440 NotAvailable
System Board FAN MOD 4B RPM optimal 3000 NotAvailable
System Board FAN MOD 5A RPM optimal 4440 NotAvailable
System Board FAN MOD 5B RPM optimal 3000 NotAvailable
System Board FAN MOD 6A RPM optimal 4560 NotAvailable
System Board FAN MOD 6B RPM optimal 3600 NotAvailable

Display the power supply information for a NAS controller:

> nas-cluster select NAS1 controller select controller0 power-supply show


Name Status
--------------- --------------------
PS 1 optimal
PS 2 critical

Display the Ethernet port information for a NAS controller:

> nas-cluster select NAS1 controller select controller0 eth show


Name Type State Speed Slot Port Duplex Flow Control
-------- --------- ------- ------------- -------- ---- ------- -------------
eth20 internal on 1GB ethernet 1 0 full on
eth21 internal on 1GB ethernet 1 1 full on
eth22 internal on 1GB ethernet 2 0 full on
eth23 internal on 1GB ethernet 2 1 full on
eth30 san on 1GB ethernet 1 2 full on
eth31 san on 1GB ethernet 1 3 full on
eth32 san on 1GB ethernet 2 2 full on
eth33 san on 1GB ethernet 2 3 full on

Group Management Commands 269


eth0 client on 1GB ethernet onboard 1 full on
eth1 client on 1GB ethernet onboard 2 full on
eth2 client on 1GB ethernet onboard 3 full on
eth3 client on 1GB ethernet onboard 4 full on

nas-cluster select controller select attach


Attaches a NAS controller to a NAS cluster.

Format
nas-cluster select cluster_name controller select controller_name attach
service_tag subcommand

Variables
Variable Description
cluster_name NAS cluster name

controller_name Name of the controller

service_tag Service tag for the controller.


Use the discover-devices command to obtain the service tag for the
NAS controller.

Subcommands
Subcommand Description
retry Retries the controller attach operation

continue Continues the attach operation, ignoring any errors

Examples
Attach a controller with a service tag as a controller to a NAS cluster:

> nas-cluster select NAS1 controller select controller0 attach C93MTQ1

Retry an attach operation:

> nas-cluster select NAS1 controller select controller0 attach retry

nas-cluster select controller select detach


Detaches a NAS controller from a NAS cluster.
CAUTION: Use this command only at the instruction of an authorized service representative.

Format
nas-cluster select cluster_name controller select controller_name detach

270 Group Management Commands


Variables
Variable Description
cluster_name NAS cluster name

controller_name Name of the controller to detach

Example
Detach a controller from a NAS cluster:

> nas-cluster select Group1NAS controller select controller1 detach

nas-cluster select controller select load show


Displays network load statistics for the controller.

Format
nas-cluster select cluster_name controller select controller_name load show
[parameter]

Variables
Variable Description
cluster_name NAS cluster name

controller_name Name of the controller

Parameter
Parameter Description
period current|day| Specifies the time period. If you do not specify a period, the command
week|month|year displays the current statistics.
Current Data is shown for a one-time interval.
Day Last 24 hours. Data is shown for each hour.
Week Last week. Data is shown every 6 hours in the last 7 days.
Month Last month. Daily for the last month.
Year Last year. Data is shown for every two weeks of the last year.

Example
Display current load statistics for the specified controller:

> nas-cluster select NAS_1 controller select controllerA load show

_______________________________________________________________________________
Period: current Controller: A

Group Management Commands 271


Timestamp: 2015-01-15:09:45:02 CPU Load Percentage: 21
Total SMB Connections: 7
_______________________________________________________________________________

nas-cluster select controller select traffic show


Displays network traffic statistics for the controller.

Format
nas-cluster select cluster_name controller select controller_name traffic show
[parameter]

Variables
Variable Description
cluster_name NAS cluster name

controller_name Name of the controller

Parameters
Parameter Description
period current|day| Specifies the time period. If you do not specify a period, the command
week|month|year displays the current statistics.
Current Data is shown for a one-time interval.
Day Last 24 hours. Data is shown for each hour.
Week Last week. Data is shown every 6 hours in the last 7 days.
Month Last month. Daily for the last month.
Year Last year. Data is shown for every 2 weeks of the last year.

Example
Display current traffic statistics for the specified controller:

> nas-cluster select NAS_1 controller select controllerA traffic show

_______________________________________________________________________________
Period: current Controller: A
Timestamp: 2015-01-15:09:44:06 NFS Read MB/s: 0
NFS Write MB/s: 112 NDMP Read MB/s: 0
NDMP Write MB/s: 0 SMB Read MBs/s: 13
SMB Write MB/s: 5 Replication Read MB/s: 0
Replication Write MB/s: 0 Storage Subsystem Read MB/s: 34
Storage Subsystem Write MB/s: 258 Network Overhead Read MBs/s: 3
Network Overhead Write MBs/s: 13 Network Packet Drops: 0
NFS IOPS Read: 0 NFS IOPS Write: 3593
NFS IOPS Other: 0 SMB IOPS Read: 429
SMB IOPS Write: 208 SMB IOPS Other: 0
Total Primary MB/s: 149 Total Primary MB/s vs average: N/A
Total Secondary MB/s: 0
_______________________________________________________________________________

272 Group Management Commands


nas-cluster select credentials
Manages extended authentication methods for a NAS cluster (Active Directory, NIS, or LDAP).

Format
nas-cluster select cluster_name credentials subcommand

Variable
Variable Description
cluster_name NAS cluster name

Subcommands
Subcommand Description
create Configures Active Directory (AD), LDAP, or NIS for authentication

delete Deletes the LDAP or NIS configuration for authentication

modify Enables you to add the preferred domain controller after joining AD

select AD Enables or disables the Active Directory configuration

nas-cluster select credentials create


Creates an authentication method for a NAS cluster.
You can create any of the following combinations of credentials:

Active Directory (AD) only


LDAP only
NIS only
Active Directory and LDAP
Active Directory and NIS

Format
nas-cluster select cluster_name credentials create AD|LDAP|NIS parameters

Variable
Variable Description
cluster_name NAS cluster name

Group Management Commands 273


AD Parameters
Parameter Description
netbios_name NetBIOS name. Typically, the NAS cluster name.

NOTE: The NAS cluster name must be in the Domain Name Server.

NOTE: The NAS cluster name can contain up to 15 ASCII letters,


numbers, and hyphens.

domain_name Active Directory domain name. Valid characters include letters,


numbers, and underscores. Names must begin with a letter or an
underscore.

user_name Name of the AD administrator

password Password for the AD administrator

domain-netbiosname (Optional) Specifies the domain NetBIOS to which the user belongs
name

domain-controller name (Optional) Specifies the domain controller running the Active Directory
service

LDAP Parameters
Parameter Description
server_name LDAP server name

base_dn Base domain name, in the following format:


dc=hostname_or_domain_name,dc=top-level_domain

The top-level domain is the website extension, such as .com, .net,


or .edu. For example:
dc=companyA,dc=com

bind_dn Supports the secure bind functionality. An anonymous bind is enabled


by default; when it is specified, you must specify a bind domain name
and password, which will be authenticated by the LDAP server.
The value specified for bind_dn must contain the Common Name (cn)
of the user account on the topmost level and one of the following
RDNs on the bottom level:
Domain Component (dc)
Organization Name (o)
Country Name (c)
Locality Name(l)

For example:

'cn=username,ou=org_unit,dc=company,dc=com

274 Group Management Commands


Parameter Description
secure-protocol value Secure protocol to use. Options are none, tls, or tls-with-certificate.
The default is none.
When tls is specified, LDAP TLS functionality is enabled; the traffic will
be encrypted.

When tls-with-certificate is specified:

1. Create a certificate directory in the /mgtdb/update folder.


2. Export the TLS certificate from the LDAP service.
3. Upload the certificate to that directory.

The LDAP client certificate should be less than 4KB in size.

extended-schema Supports extended schema when using LDAP with Active Directory. Also
used by FluidFS to authenticate that the LDAP server is the server to use.
The default is not to use extended schema.

For more information about using distinguished names, see Formatting Distinguished Names.

NIS Parameters
Parameter Description
domain_name NIS domain name. Valid characters include letters, numbers, and
underscores. Names must begin with a letter or an underscore.

nis_server_list Comma-separated list (maximum of 512 characters) of up to three NIS


servers, in the following format:
server1,server2,server3

Examples
Create Active Directory credentials:

> nas-cluster select NAS1 credentials create AD NAS1 EQLDOM1 AdmJim JiM123456

Create NIS credentials:

> nas-cluster select NAS1 credentials create NIS NISDOM1 NISserver1,NISserver2

Create LDAP credentials:

> nas-cluster select NAS1 credentials create LDAP Lserver1 dc=MyCompany,dc=com

nas-cluster select credentials delete


Deletes an extended authentication method for a NAS cluster.

Formats
nas-cluster select cluster_name credentials delete auth_method

Group Management Commands 275


Variables
Variable Description
cluster_name NAS cluster name

auth_method Authentication method that you want to delete: AD, LDAP, or NIS

Example
Delete the credentials for the LDAP configuration:

> nas-cluster select NAS1 credentials delete LDAP

nas-cluster select credentials modify ad-preferred-dc


Modifies or displays the preferred domain controller (DC) list. This command overrides any existing
preferred DC list with a new preferred DC list.

Format
nas-cluster select cluster_name credentials modify ad-preferred-dc ?|dc_list

Variables
Variable Description
cluster_name NAS cluster name

dc_list The new list for the Active Directory preferred domain controllers. This
list can consist of IP addresses or host names separated by commas.
The maximum list size is 127 characters.

NOTE: You can include both IP addresses and host names for the
preferred DC list within the same command line.

Parameter
Parameter Description
? Lists the Active Directory preferred domain controllers

Examples
Replace the existing preferred DC list with a new preferred DC list of IP addresses:

> nas-cluster select NAS_1 credentials modify ad-preferred-dc 192.0.2.28,


192.0.2.30

Replace the existing preferred DC list with a new preferred DC list of host names:

> nas-cluster select NAS_1 credentials modify ad-preferred-dc


eqlwizards1.wizardsdc1.lab, eqlwizards2.wizardsdc2.lab

276 Group Management Commands


Replace the existing preferred DC list with a new preferred DC list of IP addresses and host names:

> nas-cluster select NAS_1 credentials modify ad-preferred-dc 192.0.2.28,


eqlwizards1.wizardsdc1.lab

List the preferred domain controllers:

> nas-cluster select NAS_1 credentials modify ad-preferred-dc ?

nas-cluster select credentials select AD


Enables or disables AD authentication for a NAS cluster.

Formats
nas-cluster select cluster_name credentials select AD enable|disable

Variable
Variable Description
cluster_name NAS cluster name

nas-cluster select data-reduction schedule


Manages data reduction schedules for the NAS cluster.

Format
nas-cluster select cluster_name data-reduction schedule subcommand

Variable
Variable Description
cluster_name NAS cluster name

Subcommands
Subcommand Description
create Creates a data reduction schedule

delete Deletes a data reduction schedule

rename Renames a data reduction schedule

select Selects a data reduction schedule

show Displays all data reduction schedules

Group Management Commands 277


Examples
Displays the data reduction schedules for the NAS cluster:

> nas-cluster select NAS1 data-reduction schedule show


Name Days TimeRange Default
--------- ------------------------------ ---------------- ---------
default Mon,Tue,Wed,Thu,Fri,Sat,Sun 12:00AM-06:00AM Yes

nas-cluster select data-reduction schedule create


Creates data reduction schedules for the NAS cluster.

Format
nas-cluster select cluster_name data-reduction schedule create schedule_name
parameters

Variables
Variable Description
cluster_name NAS cluster name

schedule_name Schedule name, up to 63 characters. The first character cannot be an


underscore. If the schedule name contains spaces, enclose the name in
quotation marks. For example: "schedule for data reduction"
Fewer characters are accepted for this field if you enter the value as a
Unicode character string, which takes up a variable number of bytes,
depending on the specific character.

Parameters
Parameter Description
days Days of the week that the schedule will run. For example: Sat,Sun,Mon

start-time Schedule starting time. For example: 7AM, 08:30AM, 3:30PM, 23:00

end-time End time for the schedule. For example: 7AM, 08:30AM, 3:30PM, 23:00

Example
Create a data reduction schedule that runs once a week.:

> nas-cluster select NAS1 data-reduction schedule create dr1 days Mon start-
time 7AM end-time 9PM
Schedule creation succeeded.

278 Group Management Commands


nas-cluster select data-reduction schedule delete
Deletes a data reduction schedule for the NAS cluster.

Format
nas-cluster select cluster_name data-reduction schedule delete schedule_name

Variables
Variable Description
cluster_name NAS cluster name

schedule_name Name of the data reduction schedule to delete

Example
Delete a data reduction schedule:

> nas-cluster select NAS1 data-reduction schedule delete dr1

If command confirmation is enabled, you are prompted to confirm that you want to delete the schedule.
See cli-settings.

nas-cluster select data-reduction schedule rename


Renames a data reduction schedule for the NAS cluster.

Format
nas-cluster select cluster_name data-reduction schedule rename schedule_name
new_name

Variables
Variable Description
cluster_name NAS cluster name

schedule_name Current name of the data reduction schedule

new_name New schedule name, up to 63 characters. The first character cannot be


an underscore. If the schedule name contains spaces, enclose the name
in quotation marks. For example: "schedule for data reduction"
Fewer characters are accepted for this field if you enter the value as a
Unicode character string, which takes up a variable number of bytes,
depending on the specific character.

Group Management Commands 279


Example
Rename a data reduction schedule:

> nas-cluster select NAS1 data-reduction schedule rename dr1 MonSch

nas-cluster select data-reduction schedule select


Selects a data reduction schedule for additional operations.

Format
nas-cluster select cluster_name data-reduction schedule select schedule_name
parameters

Variables
Variable Description
cluster_name NAS cluster name

schedule_name Name of the data reduction schedule to select

Parameters
Parameter Description
days days Days of the week that the schedule will run. For example: Sat,Sun,Mon

end-time time Ending time for the schedule. For example: 7AM, 08:30AM, 3:30PM,
23:00

start-time time Schedule starting time. For example: 7AM, 08:30AM, 3:30PM, 23:00

Subcommands
Subcommand Description
disable Disables the selected schedule

enable Enables the selected schedule

show Displays detailed information about the schedule

Examples
Enable a data reduction schedule:

> nas-cluster select NAS1 data-reduction schedule select MonSch enable

280 Group Management Commands


Display details for a data reduction schedule:

> nas-cluster select NAS1 data-reduction schedule select MonSch show


_____________________ Data Reduction Schedule Information ____________________
Name: MonSch Days: Mon
Start-Time: 07:00AM End-Time: 09:00PM
Desired Status: enable Default: No
______________________________________________________________________________

nas-cluster select def-access-security


Sets the servicewide default file access security policy for new containers.

Formats
nas-cluster select cluster_name def-access-security access_type

Variables
Variable Description
cluster_name NAS cluster name

access_type Specifies the default file access security policy. Options are:
mixed
ntfs (default)
unix

Example
Set the default file access security policy for new containers:

> nas-cluster select NAS_1 def-access-security unix

nas-cluster select def-available-space-warn


Enables the default available space warning to be set for new NAS containers. This setting applies to thin-
provisioned NAS containers only.

Format
nas-cluster select cluster_name def-available-space-warn
container_size_percentage

Variables
Variable Description
cluster_name NAS cluster name

container_size_percent Percentage of the container size. The cluster default value is 10 percent;
age 0 percent means it is disabled.

Group Management Commands 281


nas-cluster select def-data-reduction
Sets the default data reduction parameter for the NAS cluster.
You can configure data reduction to ignore files based on the last time they were accessed or by the last
time they were changed. Each of these settings can be a minimum of 30 days and a maximum of 365
days.

Format
nas-cluster select cluster_name def-data-reduction parameter

Variable
Variable Description
cluster_name NAS cluster name

Parameters
Parameter Description
access-time-filter nn Excludes files by the last time they were accessed, from 30 to 365 days.
Files that have been accessed between 0 and the specified number of
days are not subject to data reduction.

compression enable| Enables or disables file compression on files


disable

modify-time-filter nn Excludes files by the last time they were modified, from 30 to 365 days.
Files that have been modified between 0 and the specified number of
days are not subject to data reduction.

Example
Configure the default data reduction policy to exclude files that have been accessed within the past 45
days:

> nas-cluster select NAS_1 data-reduction access-time-filter 45

nas-cluster select def-dir-permission


Sets the servicewide default UNIX directory permissions for new containers.

Format
nas-cluster select cluster_name def-dir-permission octal_value

282 Group Management Commands


Variables
Variable Description
cluster_name NAS cluster name

octal_value 3-digit octal permission value for the directory, such as 644 or 755

Example
Set the default directory permission for new containers:

> nas-cluster select NAS_1 def-dir-permission 755

nas-cluster select def-file-permission


Sets the servicewide default UNIX file permissions for new containers.

Format
nas-cluster select cluster_name def-file-permission octal_value

Variables
Variable Description
cluster_name NAS cluster name

octal_value 3-digit octal permission value for the files, such as 644 or 755

Example
Set the default file permission for new containers:

> nas-cluster select NAS_1 def-file-permission 555

nas-cluster select def-gateway


Sets the default gateway for the NAS cluster.

Format
nas-cluster select cluster_name def-gateway ip_address

Group Management Commands 283


Variables
Variable Description
cluster_name NAS cluster name

ip_address IP address for the default gateway for the NAS cluster in dotted-quad
notation (for example, 192.0.2.36)

Example
Configure the default gateway for a NAS cluster:

> nas-cluster select NAS_1 def-gateway 192.0.2.44

nas-cluster select def-nfs-permission


Sets the servicewide default permission for NFS exports.

Format
nas-cluster select cluster_name def-nfs-permission permission

Variables
Variable Description
cluster_name NAS cluster name

permission Permission setting: read-write or read-only

Example
Set the default permissions for new NFS exports:

> nas-cluster select NAS_1 def-nfs-permission read-only

nas-cluster select def-nfs-trusted-users


Sets the servicewide default for trusted users for new NFS exports.

Format
nas-cluster select cluster_name def-nfs-trusted-users trusted_users

284 Group Management Commands


Variables
Variable Description
cluster_name NAS cluster name

trusted_users Set of trusted users for the containers. Options are:


all-except-root (default)
nobody
all

Example
Set the default trusted users setting for new NFS exports:

> nas-cluster select NAS_1 def-nfs-trusted-users all

nas-cluster select def-smb-access-based-enum


Configures the default value for access-based enumeration for subsequent SMB share creation
operations. You can set the value of access-based enumeration to enable or disable.

Format
nas-cluster select cluster_name def-smb-access-based-enum enable|disable

Variable
Variable Description
cluster_name NAS cluster name

Subcommands
Subcommand Description
enable Enables access-based enumeration t during the SMB share create
operations

disable Disables access-based enumeration during the SMB share create


operations. This setting is the default.

nas-cluster select def-smb-antivirus


Sets the servicewide default file access security policy for new containers.

Formats
nas-cluster select cluster_name def-smb-antivirus enable|disable

Group Management Commands 285


Variable
Variable Description
cluster_name NAS cluster name

Example
Enable the default antivirus service for new containers:

> nas-cluster select NAS_1 def-smb-antivirus enable

nas-cluster select def-smb-avexcludedirs


Specifies a comma-separated list of directory paths to exclude from antivirus scanning.

Format
nas-cluster select cluster_name def-smb-avexcludedirs dir_paths

Variables
Variable Description
cluster_name NAS cluster name

dir_paths Directory path names to exclude from antivirus scanning

Example
Exclude directories from antivirus scanning:

> nas-cluster select NAS_1 def-smb-avexcludedirs /junk,/tmp

nas-cluster select def-smb-avextensions


Specifies the types of files, by file extension, that will be excluded from antivirus scanning for new SMB
shares.
NOTE: You must configure at least one antivirus server before specifying file types to exclude. See
nas-cluster select antivirus-servers for more information.

Format
nas-cluster select cluster_name def-smb-avextensions extensions

286 Group Management Commands


Variables
Variable Description
cluster_name NAS cluster name

extensions Comma-separated list of file types (extensions) to exclude from


antivirus scanning

Example
Add a list of image file extensions to exclude from antivirus scanning:

> nas-cluster select NAS_1 def-smb-avextensions bmp,png,tiff,gif,jpg

(To change the list of file extensions to exclude, reenter the command with a new comma-separated list
of extensions.)

nas-cluster select def-snap-reserve


Specifies the servicewide default amount of snapshot reserve for new containers.

Format
nas-cluster select cluster_name def-snap-reserve n%

Variables
Variable Description
cluster_name NAS cluster name

n% Default snapshot reserve setting, specified as a percentage of the


container size:
Minimum 0%
Maximum 90%

You must enter the percent sign (%).

Example
Set the default snapshot space reserve amount for new containers:

> nas-cluster select NAS_1 def-snap-reserve 67%

Group Management Commands 287


nas-cluster select def-snap-warn
Specifies, as a percentage of the snapshot reserve size, the servicewide default in-use snapshot space
warning limit for new containers.

Format
nas-cluster select cluster_name def-snap-warn n%

Variables
Variable Description
cluster_name NAS cluster name

n% Default in-use space warning limit, specified as a percentage of the


snapshot reserve size:
Minimum 10%
Maximum 100%

You must enter the percent sign (%).

Example
Set the default snapshot space warning value for new containers:

> nas-cluster select NAS_1 def-snap-warn 67%

nas-cluster select def-space-provision thin|thick


Sets the clusterwide default for container space provisioning for new containers. Existing containers are
not affected. By default, the setting is thick. If the setting is changed to thin, the NAS container is created
as thin provisioned with no reserved space.

Format
nas-cluster select cluster_name def-space-provision thin|thick

Variable
Variable Description
cluster_name NAS cluster name

Parameter
Parameter Description
thick|thin Specifies thin or thick space provisioning

288 Group Management Commands


nas-cluster select def-space-warn
Specifies, as a percentage of the container size, the servicewide default in-use space warning limit for
new containers.

Format
nas-cluster select cluster_name def-space-warn n%

Variables
Variable Description
cluster_name NAS cluster name

n% Default in-use space warning limit, specified as a percentage of the


container size:
Minimum 10%
Maximum 100%

You must enter the percent sign (%).

Example
Set the default in-use space warning value for new containers:

> nas-cluster select NAS_1 def-space-warn 67%

nas-cluster select def-thin-reserve


Sets the NAS reserve default setting. All thin-provisioned containers have the thin reserve defined by this
value, if the thin reserve was not specified with the nas-container create command. The default value for
the cluster is 0 percent.

Format
nas-cluster select cluster_name def-thin-reserve container_size_percentage

Variables
Variable Description
cluster_name NAS cluster name

container_size_percentage Percentage size of the container (default is 0%)

Group Management Commands 289


nas-cluster select diagnostics
Collects diagnostic information for the NAS cluster or displays the diagnostic status of the cluster.
This command is unrelated to the diag command that is available for group members.

NOTE: To retrieve the diagnostic data from the NAS cluster, you must enable FTP service. See nas-
cluster select ftp-service.

Format
nas-cluster select cluster_name diagnostics subcommand

Variable
Variable Description
cluster_name NAS cluster name

Subcommands
Subcommand Description
show Displays the diagnostic state of the NAS cluster

start-client Starts client connectivity diagnostics

start-file Starts file system diagnostics

start-general Starts general diagnostics

start-network Starts client network diagnostics

start-nfs Starts NFS file accessibility diagnostics

start-performance Starts NAS container performance diagnostics for the specified NAS
container

start-protocols Starts diagnostics for the SMB and NFS protocols

start-smb Starts SMB file accessibility diagnostics

start-smb-homeshare Starts SMB homeshare file accessibility diagnostics

nas-cluster select diagnostics show


Lists the names of the diagnotics running or, if none are running, displays Idle.

Format
nas-cluster select cluster_name diagnostics show

290 Group Management Commands


Variable
Variable Description
cluster_name NAS cluster name

Example
Display the diagnostic state of the NAS cluster:

> nas-cluster select NAS1 diagnostics show

NAS Diagnostics State: Idle

nas-cluster select diagnostics start-client


Starts client connectivity diagnostics.

Format
nas-cluster select cluster_name diagnostics start-client remote_ip_address [NFS|
SMB] case_number

Variables
Variable Description
cluster_name NAS cluster name

remote_ip_address Remote IP address

case_number Case ID number, which is a 4- to 10-digit integer with a range of 1000


9999999999

Parameter
Parameter Description
NFS|SMB Diagnostics for either NFS protocol or SMB protocol.

nas-cluster select diagnostics start-file


Starts file system diagnostics.

Format
nas-cluster select cluster_name diagnostics start-file [case_number]

Group Management Commands 291


Variables
Variable Description
cluster_name NAS cluster name

case_number Case ID number, which is a 4- to 10-digit integer with a range of 1000


9999999999

nas-cluster select diagnostics start-general


Starts general diagnostics.

Format
nas-cluster select name diagnostics start-general [case_number]

Variables
Variable Description
name NAS cluster name

case_number Case ID number, which is a 4- to 10-digit integer with a range of 1000


9999999999

nas-cluster select diagnostics start-network


Starts client network diagnostics.

Format
nas-cluster select cluster_name diagnostics start-network ip_address
[case_number]

Variables
Variable Description
cluster_name NAS cluster name

ip_address Network IP address

case_number Case ID number, which is a 4- to 10-digit integer with a range of 1000


9999999999

292 Group Management Commands


nas-cluster select diagnostics start-nfs
Starts NFS file accessibility diagnostics.
The remote IP address is the address of the external client computer. The NAS system pings the remote
client computer to test connectivity. If the ping fails, the diagnostic stops.

Format
nas-cluster select cluster_name diagnostics start-nfs remote_ip_address
container_name export_name [case_number]

Variables
Variable Description
cluster_name NAS cluster name

remote_ip_address Remote IP address

container_name Name of the container

export_name Name of the export

case_number Case ID number, which is a 4- to 10-digit integer with a range of 1000


9999999999

nas-cluster select diagnostics start-performance


Starts performance diagnostics for the specified NAS container.

Format
nas-cluster select cluster_name diagnostics start-performance container_name
[case_number]

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

case_number Case ID number, which is a 4- to 10-digit integer with a range of 1000


9999999999

Group Management Commands 293


nas-cluster select diagnostics start-protocols
Starts diagnostics for the SMB and NFS protocols.

Format
nas-cluster select cluster_name diagnostics start-protocols [case_number]

Variables
Variable Description
cluster_name NAS cluster name

case_number Case ID number, which is a 4- to 10-digit integer with a range of 1000


9999999999

nas-cluster select diagnostics start-smb


Starts SMB file accessibility diagnostics.
The remote IP address is the address of the external client computer. The NAS system pings the remote
client computer to test connectivity. If the ping fails, the diagnostic stops.

Format
nas-cluster select cluster_name diagnostics start-smb remote_ip_address
share_name path case_number

Variables
Variable Description
cluster_name NAS cluster name

remote_ip_address Remote IP address

share_name Share name

path File path relative to the SMB home share folder

case_number Case ID number, which is a 4- to 10-digit integer with a range of 1000


9999999999

294 Group Management Commands


nas-cluster select diagnostics start-smb-homeshare
Troubleshoots file access on an SMB home share from a specific SMB client. The NAS system pings the
remote client computer to test connectivity. If the ping fails, the diagnostics stop.

Format
nas-cluster select cluster_name diagnostics start-smb-homeshare
remote_ip_address homeshare_user_name file_path case_number

Variables
Variable Description
cluster_name NAS cluster name

remote_ip_address IP address of the external SMB client computer

homeshare_user_name Home share user name. Identifies which home share user cannot
access files. For example: DOMAIN\edugan

file_path File path relative to the SMB home share folder

case_number Case ID number, which is a 4 to 10-digit integer with a range of 1000


9999999999

Example
Start diagnostics on an SMB home share from an SMB client, and assign the diagnostics a case number:

> nas-cluster select NAS_1 diagnostics start-smb-homeshare 192.0.2.40 edugan


/home 9597

nas-cluster select failback


Performs a NAS replication failback operation on a NAS cluster in the group.

Format
nas-cluster select cluster_name failback subcommand [container_name]

Variables
Variable Description
cluster_name NAS cluster name

container_name Name of the container

Group Management Commands 295


Subcommands
Subcommand Description
retry Retries a NAS replication failback operation for a container

show Displays the status of a NAS replication failback operation

start Starts a NAS replication failback operation for a container

stop Stops a NAS replication failback operation for a container

nas-cluster select fs-scan-rate


Sets the rate of the file-system integrity scanner.
NOTE: Do not use this command without the guidance of a Dell support representative. Under
normal circumstances, you should not change this setting.

Formats
nas-cluster select cluster_name fs-scan-rate scan_rate

Variables
Variable Description
cluster_name NAS cluster name

scan_rate File system scan rate. The rate can be:


normal Set scan rate to normal
maintenance Set scan rate to maintenance
off Turn off FS scanning

Example
Set the file-system scan rate:

> nas-cluster select NAS_1 fs-scan-rate maintenance

nas-cluster select ftp-service


Enables FTP service on the NAS cluster. By default, FTP service is disabled to prevent accidental or
malicious access to the NAS controllers.
NOTE: FTP service must be enabled to retrieve the diagnostic data from the NAS cluster. See nas-
cluster select diagnostics.

Format
nas-cluster select cluster_name ftp-service enable|disable

296 Group Management Commands


Variable
Variable Description
cluster_name NAS cluster name

Examples
Enable FTP service for a NAS cluster:

> nas-cluster select NAS1 ftp-service enable

nas-cluster select initialize-cluster


Initializes a NAS cluster in the group.

Format
nas-cluster select cluster_name initialize-cluster [subcommand]

Variable
Variable Description
cluster_name NAS cluster name

Subcommands
Subcommand Description
continue Continues the NAS cluster initialization, ignoring any errors

retry Retries the NAS cluster initialization

nas-cluster select local-group


Manages local groups for a NAS cluster.

Format
nas-cluster select cluster_name local-group subcommand

Variable
Variable Description
cluster_name NAS cluster name

Group Management Commands 297


Subcommands
Subcommand Description
create Creates a local group

delete Deletes a local group

select show Displays information about the selected local group

show Displays information for all local groups

nas-cluster select local-group create


Creates a local group in a NAS cluster.

Format
nas-cluster select cluster_name local-group create group_name [gid]

Variables
Variable Description
cluster_name NAS cluster name

group_name Local group name, up to 20 ASCII characters.


Valid characters include letters, numbers, and underscores. Names must
begin with a letter or an underscore.

You can change the group name at any time.

gid (Optional) Group ID number for the local group, up to 45 digits

Example
Create a local group in a NAS cluster:

> nas-cluster select MyNAS4 local-group create Group1 150

nas-cluster select local-group delete


Deletes a local group in a NAS cluster.

Format
nas-cluster select cluster_name local-group delete group_name

298 Group Management Commands


Variables
Variable Description
cluster_name NAS cluster name

group_name Name of the local group to delete

Example
Delete a local group in a NAS cluster:

> nas-cluster select MyNAS4 local-group delete Group1

nas-cluster select local-group select show


Displays information about a specific local group in a NAS cluster.
NOTE: This command is the same as nas-cluster select cluster_name local-group show
group_name.

Format
nas-cluster select cluster_name local-group select group_name show

Variables
Variable Description
cluster_name NAS cluster name

group_name Name of the local group to display information about

Example
Display information about a local group:

> nas-cluster select MyNAS4 local-group select locgrp2 show

___________________________ Local Group Information __________________________


Group Name: locgrp2 GID: 1000
GSID: S-0-0
______________________________________________________________________________

nas-cluster select local-group show


Displays information about a specific local group in a NAS cluster.
NOTE: This command is the same as nas-cluster select cluster_name local-group select
group_name show.

To see all local groups, use the Group Manager GUI.

Group Management Commands 299


Format
nas-cluster select cluster_name local-group show group_name

Variables
Variable Description
cluster_name NAS cluster name

group_name Name of the local group to display information about

Example
Display information about a local group:

> nas-cluster select MyNAS4 local-group show storage

___________________________ Local Group Information __________________________


Group Name: storage GID: 200
GSID:
S-1-5-21-3013153020-774773256-2344179283-1401
______________________________________________________________________________

nas-cluster select local-user


Manages local users for a NAS cluster.

Format
nas-cluster select cluster_name local-user subcommand

Variable
Variable Description
cluster_name NAS cluster name

Subcommands
Subcommand Description
create Creates a local user

delete Deletes a local user

modify Changes attributes for a local user

select show Displays information about the selected local user

show Displays information for all local users

300 Group Management Commands


nas-cluster select local-user create
Creates a local user in a NAS cluster.

Format
nas-cluster select cluster_name local-user create user_name password
primary_group [parameters]

Variables
Variable Description
cluster_name NAS cluster name

user_name Name of the local user, up to 31 ASCII characters.


Valid characters include letters, numbers, spaces, and underscores.
Names must begin with a letter or an underscore.

password Password for the local user. Local user passwords must contain
between 7 and 239 ASCII characters.

primary_group Primary group for the local user. This group's name can contain up to
16 alphanumeric characters, spaces, periods, underscores, or hyphens.
The first character must be a letter or a number. Consecutive periods
and consecutive spaces are not allowed in the group name.

Parameters
Parameter Description
contact name (Optional) Contact name for the local user, up to 127 ASCII characters

description text (Optional) Description for the local user, up to 127 ASCII characters

group-list list (Optional) List of additional groups for the local user, up to five (5) group
names. Group names can contain up to 16 alphanumeric characters,
spaces, periods, underscores, or hyphens. The first character must be a
letter or a number. A name cannot contain consecutive spaces or
consecutive periods.
If any group name includes a space, all of the group names must be
enclosed in quotation marks and separated by commas but not spaces
(for example: Lab-Users,Lab,Local Users).

uid user_id (Optional) User ID for the local user. Use this parameter to recreate a
local user from a previously defined user ID (if the original was
accidentally deleted). User IDs are generated automatically by the
system.

Group Management Commands 301


Example
Create a local user in a NAS cluster:

> nas-cluster select spark2 local-user create Ravi QA contact "Ravi Prasad"
group-list "Lab-Users,Lab,Local Users"

nas-cluster select local-user delete


Deletes a local user in a NAS cluster.

Format
nas-cluster select cluster_name local-user delete user_name

Variables
Variable Description
cluster_name NAS cluster name

user_name Name of the local user to delete

Example
Delete a local user in a NAS cluster:

> nas-cluster select MyNAS4 local-user delete Shelly

nas-cluster select local-user modify


Modifies a local user in a NAS cluster. You can modify multiple attributes of a user in one command-line
operation.

Format
nas-cluster select cluster_name local-user modify user_name parameters

Variables
Variable Description
cluster_name NAS cluster name

user_name Name of the local user to modify

302 Group Management Commands


Parameters
Parameter Description
password password Modifies the users password. Local user passwords must contain
between 7 and 239 ASCII characters.

primarygroup Modifies the users primary group


group_name

contact name Modifies the users contact information

description desc Modifies the users description

group-list list Modifies the list of groups for the local user. The list can include up to
five (5) group names, separated by commas and no spaces.

Example
Change the password, primary group, contact information, description, and list of groups for a user:

> nas-cluster select MyNAS4 local-user koala password Kit1234 primarygroup


group1 description "Dell EQL Groups" group-list group1,users,techpubs

nas-cluster select local-user select show


Displays information about a specific local user in a NAS cluster.
NOTE: This command is the same as nas-cluster select cluster_name local-user show user_name.

To see all local users, use the Group Manager GUI.

Format
nas-cluster select cluster_name local-user select user_name show

Variables
Variable Description
cluster_name NAS cluster name

user_name Name of the local user to display information about

Example
Display information about a local user in a NAS cluster:

> nas-cluster select MyNAS4 local-user select Laura show


___________________________ Local User Information ___________________________
User Name: Laura UID: 173
Primary Group: QA Contact: Laura Wallace
SID: S-0-0 Description: Quality Assurance

Group Management Commands 303


Additional Groups: LabUsers
______________________________________________________________________________

nas-cluster select local-user show


Displays information about a specific local user in a NAS cluster.
NOTE: This command is the same as nas-cluster select cluster_name local-user select user_name
show.

To see all local users, use the Group Manager GUI.

Format
nas-cluster select cluster_name local-user show user_name

Variables
Variable Description
cluster_name NAS cluster name

user_name Name of the local user to display information about

Example
Display information about a local user in a NAS cluster:

> nas-cluster select MyNAS4 local-user show Chris


___________________________ Local User Information ___________________________
User Name: Chris UID: 1003
Primary Group: Eng Contact: Chris Loomis
SID: S-0-0 Description: Software Engineer
Additional Groups: LabUsers
______________________________________________________________________________

nas-cluster select mass-failback


Performs a mass failback operation on a NAS cluster in the group. This operation is not available in the
Group Manager GUI.
NOTE: Use this command after controller maintenance or recovery.

This command is effective only if it is used within 10 minutes of restoring a controller. The command
disconnects any clients that were previously connected to the failed controller but have since
reconnected to other controllers after the failure. When those clients reconnect to the NAS cluster, the
automatic balancer distributes them evenly among all the functioning controllers.

If two controllers in different controller pairs fail, this command will disconnect all the clients that were
previously connected to each of the failed controllers.

NOTE: If both controllers in a pair fail, the entire NAS cluster is down. This command does not
restore the NAS cluster.

304 Group Management Commands


If the controller recovery takes more than 10 minutes, use the nas-cluster select mass-rebalance
command instead.

Format
nas-cluster select cluster_name mass-failback

Variable
Variable Description
cluster_name NAS cluster name

nas-cluster select mass-rebalance


Performs a mass rebalance operation on a NAS cluster in the group. This operation is available in the
Group Manager GUI as well as in the CLI.
This command disconnects all clients currently connected to the NAS cluster. When those clients
reconnect, the automatic balancer distributes the connections evenly among all the active nodes.

Format
nas-cluster select cluster_name mass-rebalance

Variable
Variable Description
cluster_name NAS cluster name

nas-cluster select max-supported-nfs-version


Sets the NFS protocol version to one of three supported versions (v3, v4.0, or v4.1). The default value is
NFS v3. Use this command to navigate between the supported versions or to upgrade to the maximum
supported version.

Format
nas-cluster select cluster_name max-supported-nfs-version nfs-v3|nfs-v4|nfs-v41

Variable
Variable Description
cluster_name NAS cluster name

Example
Upgrade from the default NFS protocol version to the maximum supported NFS version:

> nas-cluster select NAS_1 max-supported-nfs-version nfs-v4-1

Group Management Commands 305


nas-cluster select ndmp
Configures Network Data Management Protocol (NDMP) service for a NAS cluster.

Format
nas-cluster select cluster_name ndmp subcommand

Variable
Variable Description
cluster_name NAS cluster name

Subcommands
Subcommand Description
dma-server-list Lists IP addresses for the DMA servers

passwd Password required to access NDMP service

port Configures a port for the NDMP service

show Displays the NDMP service configuration

start Starts NDMP service

stop Stops NDMP service

username Configures the NDMP service user name to enable the NAS cluster to
support backups

nas-cluster select ndmp dma-server-list


Configures DMA IP addresses for a NAS cluster.

Format
nas-cluster select cluster_name ndmp dma-server-list ip_address,...

Variables
Variable Description
cluster_name NAS cluster name

ip_address One to three IP addresses for DMA servers, separated by commas and
no spaces

306 Group Management Commands


Example
Add a DMA server for the NAS cluster:

> nas-cluster select NAS_1 ndmp dma-server-list 192.0.2.27

nas-cluster select ndmp passwd


Sets a password to access the NDMP service for a NAS cluster.
You do not enter the password on the same command line as the command. Instead, type the command
and press Enter. You are then prompted to enter the password. The password can be up to 31 ASCII
characters, spaces, and punctuation (except quotation marks).

Format
nas-cluster select cluster_name ndmp passwd

Variable
Variable Description
cluster_name NAS cluster name

Example
Enter a password for an NDMP service:

> nas-cluster select NAS1 ndmp passwd

Password for NDMP Access:


Retype password:

nas-cluster select ndmp port


Configures a port for the NDMP service for a NAS cluster.

Format
nas-cluster select cluster_name ndmp port port_number

Variables
Variable Description
cluster_name NAS cluster name

port_number Port number (up to five digits) for the NDMP service.
Use the port number configured by your IT personnel for the firewall.

Group Management Commands 307


Example
Configure a port for NDMP service:

> nas-cluster select NAS1 ndmp port 253

nas-cluster select ndmp show


Displays the NDMP service information for a NAS cluster.

Format
nas-cluster select cluster_name ndmp show

Variable
Variable Description
cluster_name NAS cluster name

Example
Display the NDMP service configuration for a NAS cluster:

> nas-cluster select NAS1 ndmp show

_____________________________ NDMP configuration _____________________________


UserName: backup_user Port: 10000
Admin State: stop
______________________________________________________________________________
DMA Server List:

nas-cluster select ndmp start


Starts NDMP service for a NAS cluster.

Format
nas-cluster select cluster_name ndmp start

Variable
Variable Description
cluster_name NAS cluster name

Example
Start NDMP service for a NAS cluster:

> nas-cluster select NAS1 ndmp start

308 Group Management Commands


nas-cluster select ndmp stop
Stops NDMP service for a NAS cluster.

Format
nas-cluster select cluster_name ndmp stop

Variable
Variable Description
cluster_name NAS cluster name

Example
Stop NDMP service for a NAS cluster:

> nas-cluster select NAS1 ndmp stop

This action may interrupt any backups/restores in progress.


Do you really want to continue? (y/n) [n]

nas-cluster select ndmp username


Configures the NDMP service user name to enable the NAS cluster to support backups.

Format
nas-cluster select cluster_name ndmp username user_name

Variables
Variable Description
cluster_name NAS cluster name

user_name User name for the NDMP service, up to 63 ASCII characters and
underscores

Example
Configure a user name for the NDMP service:

> nas-cluster select NAS1 ndmp username admin21

Group Management Commands 309


nas-cluster select network
Manages networks for a NAS cluster.

Format
nas-cluster select cluster_name network subcommand

Variable
Variable Description
cluster_name NAS cluster name

Subcommands
Subcommand Description
create Configures the client and SAN networks in the NAS cluster

create client- Configures a secondary client subnet for the NAS cluster
secondary

delete Deletes the network configuration for the NAS cluster

select Manages the selected network for the NAS cluster

show Displays the network configuration for the NAS cluster

nas-cluster select network create


Creates networks used in a NAS system.
NOTE: If you do not specify the network type, this command applies the parameters to the default
client network.

Format
nas-cluster select cluster_name network create network_type parameters

Variables
Variable Description
cluster_name NAS cluster name

network_type Type of network that you are creating. Options are:


client
client-secondary
san

310 Group Management Commands


Variable Description

NOTE: You must create client and SAN networks, but a secondary
client network is not mandatory.

NOTE: The maximum allowed number of secondary client


networks is eight.

Client Network Parameters


Parameter Description
service_ip_list NAS cluster IP addresses that clients use to access the NAS cluster.
Minimum: 2. Maximum: 8 (2-controller) or 16 (4-controller).

netmask Specifies the netmask for the client network. For example, to specify
255 addresses in the 192.0.2.23 network, enter a netmask of
255.255.255.0.

vlan (Optional) Creates a VLAN on the NAS cluster

SAN Network Parameters


Parameter Description
service_ip_address Specifies the management IP address used by the SAN network

Examples
Create a client network for the NAS cluster:

> nas-cluster select NAS_1 network create client 192.0.2.29,192.0.2.40


255.255.255.0

Create a SAN network for the NAS cluster:

> nas-cluster select NAS_1 network create san 192.0.2.25

nas-cluster select network create client-secondary


Creates a secondary client subnet by configuring the public IP address, cluster IP list, and netmask
associated with the subnet, along with the private IP address and optional VLAN.

Format
nas-cluster select cluster_name network create client-secondary
client_secondary_name cluster_ip_list netmask controller_ip_list [vlan]

Group Management Commands 311


Variables
Variable Description
cluster_name NAS cluster name

client_secondary name Name of the secondary client network

cluster_ip_list Cluster IP list

netmask Netmask

controller_ip_list Controller IP list

vlan (Optional) Configures the VLAN to the subnet. The default value is zero.

nas-cluster select network delete


Deletes the configuration associated with the specified secondary client subnet.

Format
nas-cluster select cluster_name network delete client_secondary_name

Variables
Variable Description
cluster_name NAS cluster name

client_secondary_name Name of the secondary client network

nas-cluster select network select


Selects a network in the NAS cluster for additional operations.

Format
nas-cluster select cluster_name network select network_type parameters
subcommand

Variables
Variable Description
cluster_name NAS cluster name

network_type Network to select:


client
client-secondary
san

312 Group Management Commands


Parameters
Parameter Description
block-ipaddress Initial IP address in a block of IP addresses used in a network
initial_block_ip

bonding-mode mode Bonding mode for the client network, either alb or lacp

cluster-ip-list Management IP address for the SAN network, or the list of NAS cluster
cluster_ip_list IP addresses for the client network

controller ip_address IP address assigned to a NAS controller

mtu mtu_size Maximum transfer unit (MTU) size for the selected network, either 1500
or 9000

netmask netmask Netmask for the client network

static-route Manages static routes for the selected network


subcommand

vlan Valid values are 0 to 4094. Use 0 for untagged traffic.

Subcommands
Subcommand Description
apply-changes Applies the network modifications to the NAS cluster. If you use this
subcommand with any other subcommands, this subcommand must be
the last one specified for the modifications to take effect.

cancel-changes Cancels the network modifications that were not applied using the
apply-changes subcommand.

show Displays information about the selected network. Use this subcommand
alone in the command line.

Example
Select a client network and set the bonding mode and the MTU size:

> nas-cluster select NAS_1 network select client bonding-mode lacp 1500

nas-cluster select network select apply-changes


Commits the configuration associated with the secondary client subnet to the cluster. Any configuration
changes associated with the secondary client subnet, excluding create and delete, require this command
for the changes to be committed.

Format
nas-cluster select cluster_name network select client_secondary_name apply-
changes

Group Management Commands 313


Variables
Variable Description
cluster_name NAS cluster name

client_secondary_name Name of the secondary client network

nas-cluster select network select cancel-changes


Cancels the network modifications that were not applied using the apply-changes subcommand. Use this
subcommand alone on the command line.

Format
nas-cluster select cluster_name network select cancel-changes

Variable
Variable Description
cluster_name NAS cluster name

nas-cluster select network select cluster-ip-list


Modifies the cluster IP address list associated with the specified secondary client subnet.

Format
nas-cluster select cluster_name network select client_secondary_name cluster-ip-
list cluster_ip_list

Variables
Variable Description
cluster_name NAS cluster name

client_secondary_name Name of the secondary client network

cluster_ip_list Cluster IP list

nas-cluster select network select controller select


Modifies a network configuration for a NAS controller in a NAS cluster.

Format
nas-cluster select cluster_name network select network_type controller select
controller_name subcommand

314 Group Management Commands


Variables
Variable Description
cluster_name NAS cluster name

network_type Network to select. Options are client and san.

controller_name Network controller to select

Subcommands
Subcommand Description
controller-ip-addr- For the selected network, specifies a comma-separated list of IP
list addresses for the selected NAS controller

show Displays the IP addresses for the controller

Example
The following commands configure the controller IP address list for both controllers in the client network
for a NAS cluster:

> nas-cluster select NAS_1 network select client controller select controller0
controller-ip-addr-list 192.0.2.28
> nas-cluster select NAS_1 network select client controller select controller1
controller-ip-addr-list 192.0.2.33

nas-cluster select network select controller select


controller-ip-addr-list
Modifies the controller IP address list associated with the specified controller for the secondary client
subnet.

Format
nas-cluster select cluster_name network select client_secondary_name controller
select controller_name controller-ip-addr-list controller_ip_address-list

Variables
Variable Description
cluster_name NAS cluster name

client_secondary_name Name of the secondary client network

controller_name Name of the controller

controller_ip_address_ Controller IP address list


list

Group Management Commands 315


nas-cluster select network select controller select show
Displays the controller IP address associated with the specific controller for the secondary client subnet.

Format
nas-cluster select cluster_name network select client_secondary_name controller
select controller_name show

Variables
Variable Description
cluster_name NAS cluster name

client_secondary_name Name of the secondary client network

controller_name Name of the controller

nas-cluster select network select netmask


Modifies the netmask associated with the specified secondary client subnet.

Format
nas-cluster select cluster_name network select client_secondary_name netmask
netmask_name

Variables
Variable Description
cluster_name NAS cluster name

client_secondary_name Name of the secondary client network

netmask_name Name of the netmask

nas-cluster select network select show


Displays the cluster-level configuration associated with the specified secondary client subnet.

Format
nas-cluster select cluster_name network select client_secondary_name show

316 Group Management Commands


Variables
Variable Description
cluster_name NAS cluster name

client_secondary_name Name of the secondary client network

nas-cluster select network select static-route


Manages static routes for the client and SAN networks of a NAS cluster.
Use this command to add or delete entries from the static route table for the client or SAN networks on
the NAS appliances. For example:

If your network has multiple subnets, and more than one of them is routed.
To gain efficiency if your network has multiple routers and you can access different subnets through
different gateways. In this case, use this command to prevent routers from redirecting packets by
defining which subnets are behind the different gateways.
To load balance the network traffic when all subnets are accessible from all gateways.

Only the default group administration account, grpadmin, can add or delete static routes. Use of this
command is recorded in the audit logs and the output of the save-config command for the group.

This command is available only in the CLI, and only on PS Series groups running firmware version 7.0 or
higher, with FluidFS firmware version 3.0 or higher.

NOTE: Under normal circumstances, you will not need to create static routes. This command is
provided to help you resolve topology problems in your network.

Format
nas-cluster select cluster_name network select network_type static-route
subcommand

Variables
Variable Description
cluster_name NAS cluster name

network_type Type of network that you are selecting. Options are san and client.

Subcommands
Subcommand Description
add Adds a static route to the client interface route table

delete Deletes a static route from the client interface route table. To change an
entry, delete the route and then re-add it.

Group Management Commands 317


Subcommand Description
show Displays the state of the client interface static route table

nas-cluster select network select static-route add


Adds static routes to the client or SAN network interface route table for a NAS cluster. Only the grpadmin
account can add or modify static routes.

Format
nas-cluster select cluster_name network select network_type static-route add
destination mask gateway

Variables
Variable Description
cluster_name NAS cluster name

network_type Type of network to which you are adding a static route. Options are san
and client.

destination IPv4 address of the destination network

mask IPv4 netmask to apply to the destination IP network address

gateway IPv4 gateway associated with this route

Example
Adds a static route for the SAN network for a NAS cluster:

> nas-cluster select NAS_1 network select san static-route add 192.0.2.40
255.255.255.0 192.0.2.51

nas-cluster select network select static-route delete


Deletes a static route from the client interface route table for a NAS cluster.

Format
nas-cluster select cluster_name network select network_type static-route delete
destination

Variables
Variable Description
cluster_name NAS cluster name

network_type Type of network from which you are deleting a static route. Options are san
and client.

318 Group Management Commands


Variable Description
destination Destination IP address to delete. To identify which destination to delete, use
the nas-cluster select network select static-route show command.

Example
Deletes the destination IP address from the static route for the SAN network for a NAS cluster:

> nas-cluster select NAS_1 network select san static-route delete 192.0.2.50

nas-cluster select network select static-route show


Displays the client interface route table for a NAS cluster.

Format
nas-cluster select cluster_name network select network_type static-route show

Variables
Variable Description
cluster_name NAS cluster name

network_type Type of network you are selecting to display. Options are san and
client.

Example
Displays the static route entry table for the SAN network for a NAS cluster:

> nas-cluster select NAS_1 network select san static-route show

Destination Netmask Gateway


------------ ------- -------
192.0.2.30 255.255.255.0 192.0.2.46
192.0.2.34 255.255.255.0 192.0.2.49

nas-cluster select network select vlan


Modifies the VLAN associated with the specified secondary client subnet.

Format
nas-cluster select cluster_name network select client_secondary_name vlan vlan

Group Management Commands 319


Variables
Variable Description
cluster_name NAS cluster name

client_secondary_name Name of the secondary client network

vlan VLAN associated with the specified secondary client subnet. Valid values
are 0 to 4094. Use 0 for untagged traffic.

nas-cluster select nfsv4-mode


Enables NFS v4 mode on the NAS cluster. By default, the NAS cluster uses NFS v3.

Format
nas-cluster select cluster_name nfsv4-mode enable|disable

Variable
Variable Description
cluster_name NAS cluster name

Examples
Enable NFS v4 mode for the NAS cluster:

> nas-cluster select NAS1 nfsv4-mode enable

nas-cluster select operation


Manages a NAS cluster operation.

Format
nas-cluster select cluster_name operation subcommand

Variable
Variable Description
cluster_name NAS cluster name

320 Group Management Commands


Subcommands
Subcommand Description
continue Continues the operation, ignoring any errors, and proceeds to the next
state

delete Deletes an in-progress operation

retry Retries the operation by restarting the current state

show Displays the state of an in-progress operation

nas-cluster select replicate-to-partner


Manages NAS cluster replication for containers.

Format
nas-cluster select cluster_name replicate-to-partner subcommand

Variable
Variable Description
cluster_name NAS cluster name

Subcommands
Subcommand Description
retry Retries a replication operation for a specified container

show Displays any replication operations

start Starts a replication operation for a specified container

stop Stops a replication operation for a specified container

Examples
Display all in-progess container replication operations for a NAS cluster:

> nas-cluster select NAS1 replicate-to-partner show

Start replication for a container:

> nas-cluster select NAS1 replicate-to-partner start data1


nasgrp> nas replicate-to-partner start repdata1
The container on the primary group will be made a replica
container before the recovery container is replicated to the primary
group. This will result in the loss of any data written to the primary

Group Management Commands 321


group container since the most recent replication. Do you want to replicate
the recovery container? (y/n) [n]

nas-cluster select resize


Changes the size of the NAS reserve for a NAS cluster.

Formats
nas-cluster select cluster_name resize nas_reserve
nas-cluster select cluster_name resize retry

Variables
Variable Description
cluster_name NAS cluster name

nas_reserve New NAS reserve size in MB (default), GB, or TB

Subcommand
Subcommand Description
retry Retries the NAS reserve resize operation

nas-cluster select service-mode


Changes the service mode of the NAS cluster (FluidFS version 3.0 or higher only).
If you need to change the group IP address of a PS Series group that has a NAS cluster configured, you
must set the NAS cluster to maintenance mode. Afterward, set the cluster back to normal mode.

NOTE: Use this command only with a PS Series group running firmware version 7.0 or higher with a
NAS cluster running FluidFS version 3.0 or higher.

Formats
nas-cluster select cluster_name service-mode parameter

Variable
Variable Description
cluster_name NAS cluster name

322 Group Management Commands


Parameters
Parameter Description
maintenance Sets the service mode of the cluster to maintenance

normal Sets the service mode of the cluster to normal operation

nas-cluster select show


Displays information about a NAS cluster.
You can display all the attributes of a NAS cluster or each one individually. You cannot specify multiple
parameters in the same command line.

Format
nas-cluster select cluster_name show parameter

Variable
Variable Description
cluster_name NAS cluster name

Parameters
Parameter Description
AD Displays the Active Directory configuration

all-groups Displays all the groups in the NAS cluster

credentials Displays the credentials that are configured in the NAS cluster

local-groups Displays the local groups in the NAS cluster

local-users Displays the local users in the NAS cluster

user-mapping-policy Displays the user-mapping definitions in the NAS cluster

Examples
Display information about the NAS cluster:

> nas-cluster select NASCluster1 show

___________________________ NAS Cluster Information ___________________________


Name: NASCluster1
Type: nas
IPAddress: 192.0.2.23
NASreserve: 1TB
Used Space Warn: 80%Available-Space-Warn: 10%No Of Controllers: 2
Gateway IP: 192.0.2.45

Group Management Commands 323


Desired Service Mode: normal
Service Mode Status: normal
FTP-service: enabled
MaxNFSVersionSupported: NFS-V4.1
Cluster MPV: 3
TotalContainerCapacity: 650.85GB
AllocatedContainerSpace: 5GB
InUseContainerSpace: 4MB
FreeContainerSpace: 5GB
FreeContainerSpaceUnReserved:598.85GBFreeContainerSpaceOverCommitted:
0MBSnapSpace: 0MB
No Of Containers: 1
No of Thin-ClonesNo Of NFS Exports: 0
No Of SMB Shares: 5
No Of Snapshots: 1
Total-DataReduction-Space-Savings: 0MB
FS-Scan-Rate: normal
_______________________________________________________________________________
____________________________ Cluster-Wide Defaults ____________________________
Space-Warn: 80%
Def-Snap-Reserve: 50%
Def-Snap-Warn: 80%
File-Permission: 744
Dir-Permission: 755
File-Access-Security: ntfs
SMB-Guest-Access: N
SMB-Antivirus: disable
SMB-FileExtensions:
SMB-ExcludeDirPaths:
NFS-Permission: read-write
NFS-Trusted-Users: all-except-root
SMB-Access-Based-Enumeration: disable
NFS-FileId-32bit-Compatibility: enabled
SMB-LargeFileSize: 3GB
SMB-LargeFileOpenPolicy: denied
_______________________________________________________________________________
____________________ Cluster-Wide Data Reduction Defaults _____________________
Compression: disabled
Access-Time-Filter: 30 days
Modify-Time-Filter: 30 days
_______________________________________________________________________________
_________________________ NAS Controller Information __________________________
_______________________________________________________________________________
Name Service Tag Version NAS Controller State
------------ ----------- ---------- --------------------
controller0 0000000 V3.0.8331 online
controller1 0000000 V3.0.8331 online
_____________________________ NAS Cluster Status ______________________________
_______________________________________________________________________________

Critical conditions::

Warning conditions::
NAS controller power supply status is not redundant.
______________________ NAS Antivirus Server Information _______________________
_______________________________________________________________________________

Antivirus Hosts::
Eqlspartan11>

324 Group Management Commands


Display the Active Directory configuration for the NAS cluster:

> nas-cluster select NASCluster1 show AD


_______________________ Active Directory Configuration ________________________
Status: Optimal
Configured: Yes
Domain: WIZARDSDC1.LAB
_______________________________________________________________________________
______________________ Active Directory Trusted Domains _______________________
_______________________________________________________________________________
Domain Name DC Name DC IP DC Trust
DC Status
-------------------- ------------------------------ ---------------- ----------
----------
wizardsdc1.lab eqlwizards1.wizardsdc1.lab 192.0.2.32 Primary
Online
wizardsdc2.lab eqlwizards2.wizardsdc2.lab 192.0.2.33 Two-Way
Online
wizardsdc3.lab eqlwizards3.wizardsdc3.lab 192.0.2.34 Two-Way
Online
wizardsdc4.lab eqlwizards4.wizardsdc4.lab 192.0.2.35 Two-Way
Online
wizardsdc5.lab eqlwizards5.wizardsdc5.lab 192.0.2.36 Two-Way
Online
________________ Active Directory Preferred Domain Controllers ________________
_______________________________________________________________________________
DC Name DC IP
------------------------------ -----------------
eqlwizards1.wizardsdc1.lab 192.0.2.32
eqlwizards5.wizardsdc5.lab 192.0.02.36

nas-cluster select show credentials


Displays the credential database information that is associated to the NAS cluster.

Format
nas-cluster select cluster_name show credentials

Variable
Variable Description
cluster_name NAS cluster name

Example
Display the credential database information for the specified cluster:

> nas-cluster select NAS_Cluster1 show credentials

_______________________ Credential Database Information _______________________


Database Type: LDAP
BaseDn: dc=NAS_C,dc=com
LDAP Server Address: 192.0.2.26
Anonymous Access Disabled: yes
BindDn: cn=manager,dc=NAS_C,dc=com
Secure Protocol: tls
Extended-Schema: No

Group Management Commands 325


NIS Domain:
NIS Server Address:

nas-cluster select smb-home-share create


Enables the SMB home share feature.
NOTE: The CLI command smb-home-share create does not actually create a home share; rather, it
enables the feature to automatically create an SMB home share for each user accessing the FluidFS
cluster.

Format
nas-cluster select cluster_name smb-home-share create container_name
path_prefix parameters

Variables
Variable Descriptions
cluster_name NAS cluster name

container_name Name of the container

path_prefix Path prefix for the location of the share folder

Parameters
Parameter Description
path-template The domain-user option specifies that the share is automatically
domain_user|user generated for users on one or more Windows domains. This option is
the default setting.

The user option can be used for either a single Windows domain or
when the users are in a Windows Workgroup.

accessbasedenum Specifies whether or not access-based enumeration will display only


enable|disable the files and folders that a user has permission to access in the shared
folder

antivirus enable| Specifies whether or the home share will be set for antivirus scanning
disable

avextensions Specifies a comma-delimited set of file extensions to be excluded from


extension_list antivirus scanning. The maximum length is 255 bytes.

avexcludedirs Specifies a comma-delimited list of directory paths to be excluded from


directory_list antivirus scanning. The maximum length is 511 bytes.

avlargefilesize size Specifies an unsigned integer value to exclude files that are larger than
this size from being scanned for viruses. The value is a number of
megabytes that must fit within 4 bytes (that is, it must be a 4-digit
number). The default value is 1500.

326 Group Management Commands


Parameter Description
avlargefileopen deny| Enables or disables user access to files that are larger than the size of
allow the files specified by avlargefilesize and were not scanned

homefolderautocreate Enables or disables automatic creation of the home folder. Disabled is


enable|disable the default.

Example
Create an SMB home share for users that are in a Windows Workgroup or for a single window domain:

> nas-cluster select NAS_1 smb-home-share create s10fs1 /home path-template user

NOTE: The default antivirus exclude path is no longer available. Directory paths must already exist in
the SMB home share before they can be excluded.
To exclude directory paths from antivirus scanning:

1. Create the SMB home share without the exclude parameter.


2. Go to the SMB home share and create the directory paths that you want to exclude from
antivirus scanning.
3. Modify the antivirus settings by specifying values for the following parameters:

avexcludedirs extension_list
avextensions directory_list
avlargefilesize size

nas-cluster select smb-home-share delete


Disables the SMB home share feature.
This command does not delete any shared user data. It just disables the feature.

Format
nas-cluster select cluster_name smb-home-share delete

Variable
Variable Desription
cluster_name NAS cluster name

Example
Disable SMB home shares for the specified cluster:

> nas-cluster select NAS_1 smb-home-share delete

Group Management Commands 327


nas-cluster select smb-home-share modify
Modifies the SMB home share feature.

Format
nas-cluster select cluster_name smb-home-share modify parameter

Variable
Variable Description
cluster_name NAS cluster name

Parameters
Parameter Description
accessbasedenum Specifies whether or not access-based enumeration will display only
enable|disable the files and folders that a user has permission to access in the shared
folder

antivirus enable| Specifies whether or not the home share will be set for antivirus
disable scanning

avextensions Specifies a comma-delimited set of file extensions to be excluded from


extension_list antivirus scanning. The maximum length is 255 bytes.

avexcludedirs Specifies a comma-delimited list of directory paths to be excluded from


directory_list antivirus scanning. The maximum length is 511 bytes.

avlargefilesize size Specifies an unsigned integer value to exclude files that are larger than
this size from being scanned for viruses. The value is a number of
megabytes that must fit within 4 bytes (that is, it must be a 4-digit
number). The default value is 1500MB.

avlargefileopen deny| Enables or disables user access to files that are larger than the size of
allow the files specified by avlargefilesize and were not scanned.

homefolderautocreate Enables or disables automatic creation of the home folder. The default
enable|disable is disable.

Examples
Modify an SMB home share to enable automatic home folder creation:

> nas-cluster select NAS_1 smb-home-share modify homefolderautocreate enable

Modify an SMB home share to exclude files larger than 1750MB from being scanned for viruses.

> nas-cluster select NAS_1 smb-home-share modify antivirus enable


avlargefilesize 1750

328 Group Management Commands


NOTE: The default antivirus exclude path is no longer available. Directory paths must already exist in
the SMB home share before they can be excluded.
To exclude directory paths from antivirus scanning:

1. Create the SMB home share without the exclude parameter.


2. Go to the SMB home share and create the directory paths that you want to exclude from
antivirus scanning.
3. Modify the antivirus settings by specifying values for the following parameters:

avexcludedirs extension_list
avextensions directory_list
avlargefilesize size

nas-cluster select smb-home-share show


Displays details about the SMB home share.

Format
nas-cluster select cluster_name smb-home-share show

Variable
Variable Description
cluster_name NAS cluster name

Example
Display the SMB home share details for a NAS cluster:

> nas-cluster select NAS_1 smb-home-share show

_________________________ SMB Home Share Information _________________________


SMB-Home-Share-ContainerName: c1
SMB-Home-Share-PathPrefix: /users
SMB-Home-Share-PathTemplate: domain-user
SMB-Home-Share-Access-Based-Enumeration: enabled
SMB-Home-Share-Antivirus: enabled
SMB-Home-Share-FileExtensions: bar,loo,goo
SMB-Home-Share-ExcludeDirPaths: /aaa,/bbb,/ccc/ddd
SMB-Home-Share-LargeFileSize: 1500
SMB-Home-Share-LargeFileOpenPolicy: denied
SMB-Home-Share-HomeFolderAutoCreate: enabled__________________________________

If SMB home shares are not enabled, the following text is displayed:

_________________________ SMB Home Share Information _________________________


SMB-Home-Share: disabled
_______________________________________________________________________________

Group Management Commands 329


nas-cluster select smb-protocol maxsupportedversion
Sets the SMB protocol version to one of three supported versions (v1, v2, or v3). The default value is SMB
v3.
Use this command to revert to an earlier version of the SMB protocol or to upgrade to the maximum
supported version.

Format
nas-cluster select cluster_name smb-protocol maxsupportedversion smb-v1|smb-v2|
smb-v3

Variable
Variable Description
cluster_name NAS cluster name

Example
Set the SMB protocol:

> nas-cluster select NAS_1 smb-protocol maxsupportedversion smb-v2

nas-cluster select smb-protocol message-encryption


Specifies whether SMB3 traffic connected to all SMB shares is to be encrypted.

Format
nas-cluster select cluster_name smb-protocol message-encryption enable|disable

Variable
Variable Description
cluster_name NAS cluster name

Example
Require encryption for traffic while connected to a share on a NAS cluster:

> nas-cluster select cluster6 smb-protocol message-encryption enable

330 Group Management Commands


nas-cluster select smb-protocol message-signing
Specifies whether SMB3 traffic connected to a share is to be signed. All shares will require signing when
this command is enabled.

Format
nas-cluster select cluster_name smb-protocol message-signing enable|disable

Variable
Variable Description
cluster_name NAS cluster name

Example
Require signing for traffic while connected to a share on a NAS cluster:

> nas-cluster select cluster6 smb-protocol message-signing enable

nas-cluster select smb-protocol ntlm-config ntlm-set-


name
Sets the cluster name or controller name as the NetBIOS server name in NTLM SSP authentication.

Format
nas-cluster select cluster_name smb-protocol ntlm-config ntlm-set-name
cluster_name|controller_name|

Variables
Variable Description
cluster_name NAS cluster name to use as the NetBIOS server name

controller_name Controller name to use as the NetBIOS server name

Example
Set the cluster name as the NetBIOS server name:

> nas-cluster select cluster6 smb-protocol ntlm-config ntlm-set-name cluster6

Group Management Commands 331


nas-cluster select smb-protocol ntlm-config show
Displays the current NTLM configuration.

Format
nas-cluster select cluster_name smb-protocol ntlm-config show

Variable
Variable Description
cluster_name NAS cluster name

Example
Display the current NTLM configuration:

> nas-cluster select cluster6 smb-protocol ntlm-config show


__________________ NTLM Configuration _________________
NTLM Context Name: controller-name
_______________________________________________________

nas-cluster select smb-protocol show


Displays the current configuration for the SMB maximum supported version. The supported versions are
SMB v1, v2, and v3.
This command also displays message-encryption and signing status.

Format
nas-cluster select cluster_name smb-protocol show

Variable
Variable Description
cluster_name NAS cluster name

Example
Display the current configuration for the SMB maximum supported version.

> nas-cluster select NAS_1 smb-protocol show


__________________ SMB Protocol Configuration _________________
Maximum Version Supported:smb-v3
Message Signing: enabled
Message Encryption: enabled

332 Group Management Commands


nas-cluster select traffic show
Manages NAS network traffic statistics by specifying different time periods for displaying statistics.

Format
nas-cluster select cluster_name traffic show [parameter]

Variable
Variable Description
cluster_name NAS cluster name

Parameter
Parameter Description
period current|day| Specifies the time period. If you do not specify the period, the
week|month|year command displays the current statistics.
Current Data is shown for a one-time interval.
Day Last 24 hours. Data is shown for each hour.
Week Last week. Data is shown every 6 hours in the last 7 days.
Month Last month. Daily for the last month.
Year Last year. Data is shown for every 2 weeks of the last year.

Example
Display current traffic statistics for the specified cluster:

> nas-cluster select NAS_1 traffic show

_______________________________________________________________________________
Period: current Timestamp: 2015-01-15:09:42:45
NFS Read MB/s: 0 NFS Write MB/s: 112
NDMP Read MB/s: 0 NDMP Write MB/s: 0
SMB Read MBs/s: 56 SMB Write MB/s: 36
Replication Read MB/s: 0 Replication Write MB/s: 21
Storage Subsystem Read MB/s: 279 Storage Subsystem Write MB/s: 368
Network Overhead Read MBs/s: 2 Network Overhead Write MBs/s: 16
Network Packet Drops: 0 NFS IOPS Read: 0
NFS IOPS Write: 3593 NFS IOPS Other: 10
SMB IOPS Read: 1763 SMB IOPS Write: 928
SMB IOPS Other: 4 Total Primary MB/s: 251
Total Secondary MB/s: 0
_______________________________________________________________________________

nas-cluster select unix-users search


Searches for UNIX users in the NAS cluster.

Group Management Commands 333


Format
nas-cluster select cluster_name unix-users search search_string

Variables
Variable Description
cluster_name NAS cluster name

search_string Terms to use for searching for users in the NIS database

Example
Search for specific users in the NIS database for a NAS cluster:

> nas-cluster select NAS1 unix-users search "*admin*"

nas-cluster select update start


Updates the FluidFS firmware on all the NAS controllers in a NAS cluster.
NOTE: This command applies only to NAS clusters running FluidFS version 3.0, to upgrade to a
higher version. For NAS clusters running earlier versions, see Updating Firmware for Dell EqualLogic
PS Series Storage Arrays and FS Series Appliances on the Dell support site.

The Dell FluidFS firmware kit is available on the support site. To download it to the NAS cluster
controllers, you must enable FTP service on the NAS cluster (see nas-cluster select ftp-service).

Download the NAS service pack to all the appliances or controllers in the NAS cluster.

Formats
nas-cluster select cluster_name update start service_pack

Variables
Variable Description
cluster_name NAS cluster name

service_pack File name of the NAS service pack update script. For example:
DellFluidFS-3.0.7862-SP.sh

Example
This example shows all the steps involved in updating the FluidFS firmware on all controllers in a NAS
cluster.

1. Enable FTP service on the cluster so that you can download the service pack to the controllers:
> nas-cluster select NASCLU1 ftp-service enable

334 Group Management Commands


2. Identify the NAS cluster management address. You will need this address later.
> nas-cluster show

Name Pool Size Mgmt Address


--------------- ---------- -------------
NASCLU1 1TB 192.0.2.35
3. Use FTP to put the update script on all the NAS controllers on the cluster:

a. Open a telnet window and log in to the NAS cluster management IP address that you identified
in step 2, specifying port 44421:
#ftp 192.0.2.35 44421
Connected to 192.0.2.35.
220-This is system maintenance FTP service
220-======================================
220-
220-Use this service to download diagnostic files and to upload signed
220-service-pack packages.
220-
220
b. When promtped, enter the grpadmin account name and password:
Name (192.0.2.35:user): grpadmin
331 Please specify the password.
Password:
c. Change to the servicepack directory:
ftp> cd servicepack
d. Use FTP to put the service pack in the servicepack directory:
ftp> put DellFluidFS-3.0.7862-SP.sh
local: DellFluidFS-3.0.7862-SP.sh remote: DellFluidFS-3.0.7862-SP.sh
200 PORT command successful. Consider using PASV.
150 Ok to send data.
1830647467 bytes sent in 266.15 secs (6717.0 kB/s)
e. Exit the FTP utility.
4. In the Group Manager CLI session, start the update:
> nas-cluster select NASCLU1 update start DellFluidFS-3.0.7862-SP.sh
5. Monitor the update status:
> nas-cluster select NASCLU1 operation show
6. When the update is complete, run the mass rebalance command to rebalance all the SMB
connections between the NAS controllers:
> nas-cluster select NASCLU1 mass-rebalance

See Also
nas-cluster select ftp-service
nas-cluster select mass-rebalance

nas-cluster select user-mapping


Configures user mapping between Windows and UNIX users in a NAS cluster.

Formats
nas-cluster select cluster_name user-mapping subcommand

Group Management Commands 335


Variable
Variable Description
cluster_name NAS cluster name

Subcommands
Subcommand Description
automatic Enables or disables user mapping

create Creates a user-mapping definition

delete Deletes the specified user-mapping definition

show Displays all the user mappings or the specified user mapping

nas-cluster select user-mapping automatic


Enables or disables automatic user mapping between Windows and UNIX users with the same name in a
NAS cluster.
You can also enable or disable automatic mapping of users to a guest account.

Format
nas-cluster select cluster_name user-mapping automatic enable|disable
[guestmapping enable|disable]

Variable
Variable Description
cluster_name NAS cluster name

Subcommand
Subcommand Description
guestmapping enable| (Optional) Enables or disables guest mapping for unmapped users
disable

nas-cluster select user-mapping create


Creates a mapping definition between a Windows user and a UNIX user in a NAS cluster.
NOTE: The NAS cluster must use AD and either NIS or LDAP to support user mapping.

336 Group Management Commands


Format
nas-cluster select cluster_name user-mapping create mapping_source_username
mapped_to_username direction

Variables
Variable Description
cluster_name NAS cluster name

mapping_source_username Source user for the mapping definition

mapped_to_username Target user for the mapping definition

direction Mapping direction. Either:


unixtowindows
windowstounix

nas-cluster select user-mapping delete


Deletes a local user-mapping definition on a NAS cluster.

Format
nas-cluster select cluster_name user-mapping delete mapping_source_username

Variables
Variable Description
cluster_name NAS cluster name

mapping_source_ Source user for the mapping definition to delete


username

nas-cluster select user-mapping show


Displays one or more local user-mapping definitions on a NAS cluster.

Format
nas-cluster select cluster_name user-mapping show [mapping_source_username]

Group Management Commands 337


Variables
Variable Description
cluster_name NAS cluster name

mapping_source_ Source user for the mapping definition


username

nas-cluster show
Displays all NAS clusters in the group or details about a specific NAS cluster.

Format
nas-cluster select cluster_name show

Variable
Variable Description
cluster_name NAS cluster name

Examples
Display basic information about the NAS cluster in the group:

> nas-cluster show


Name Pool Size Mgmt Address
--------------- ---------- -------------
NAS1 802.5GB 192.0.2.35

Display detailed information about a specific NAS cluster:

> nas-cluster select NAS1 show

___________________________ NAS Cluster Information __________________________


Name: NAS1 Type: nas
IPAddress: 192.0.2.35 NASreserve: 802.5GB
No Of Controllers: 2 Gateway IP: 192.0.2.21
DesiredStatus: up Status: on
TotalcontainerCapacity: 553.92GB AllocatedcontainerSpace: 0MB
InUsecontainerSpace: 0MB FreecontainerSpace: 0MB
SnapSpace: 0MB No Of containers: 0
No of Cloned Containers:2
No Of NFS Exports: 0 No Of SMB Shares: 0
No Of Snapshots: 0
______________________________________________________________________________
____________________________ Cluster-Wide Defaults
___________________________
Container-Space-Provision: thick Space-Warn: 80%
Def-Snap-Reserve: 50% Def-Snap-Warn: 80%
File-Permission: 744 Dir-Permission: 755
File-Access-Security: ntfs SMB-Guest-Access: N
SMB-Antivirus: disable SMB-FileExtensions:
SMB-ExcludeDirPaths: NFS-Permission: read-write

338 Group Management Commands


NFS-Trusted-Users: all-except-root SMB-Access-Based-Enumeration:
NFS-FileId-32bit-Compatibility: disable
enabled SMB-LargeFileSize: 3GB
SMB-LargeFileOpenPolicy: denied
______________________________________________________________________________
____________________________ NAS Controller Information ______________________
Name Service Tag Version Controller State
---------- ------------- -------- ---------- ------
controller0 CYCWFN1 V1.0.0 online
controller1 FYCWFN1 V1.0.0 online
_____________________________ NAS Cluster Status _____________________________
Critical conditions: None
Warning conditions: None
______________________________________________________________________________

nfs-export select access


Manages NFS exports.

Format
nfs-export select nfs_export_name access subcommand

Variable
Variable Description
nfs_export_name Name of the NFS export

Subcommands
Subcommand Description
create Creates the user access to the NFS export

delete Deletes a specified ACL for a specified share

select Specifies the user access for the NFS export

show Displays a list of all the ACLs on the specified NFS export

nfs-export select access create


Creates the user access to the NFS export.

Formats
nfs-export select nfs_export_name access create netgroup netgroup_name trusted-
user trusted_user
nfs-export select nfs_export_name access create client-ip ip_netmask trusted-
user trusted_user

Group Management Commands 339


Variable
Variable Description
nfs_export_name Name of the NFS export

Parameters
Parameter Description
netgroup netgroup_name Name of the netgroup

client-ip ip_netmask Netmask IP address

trusted user Either nobody, all, or all-except-root


trusted_user

nfs-export select access delete


Deletes a specified ACL for a specified share.
NOTE: You can delete a netgroup from the NFS export only if it is not active.

Format
nfs-export select nfs_export_name access delete access_number

Variables
Variable Description
nfs_export_name Name of the NFS that the ACL number is assigned to

access_number ACL number to be deleted

nfs-export select access select


Specifies user access for the NFS export.

Formats
nfs-export select nfs_export_name access select access_number client-ip
ip_netmask trusted-user trusted_user
nfs-export select nfs_export_name access select access_number netgroup
netgroup_name trusted-user trusted_user

340 Group Management Commands


Variables
Variable Description
nfs_export_name NFS export name

access_number Access number

Parameters
Parameter Description
client-ip ip_netmask IP netmask

netgroup netgroup_name Name of the netgroup

trusted-user Either nobody, all, or all-except-root


trusted_user

nfs-export select access show


Displays a list of all the ACLs on a specified NFS export.

Format
nfs-export select nfs_export_name access show

Variable
Variable Description
nfs_export_name NFS export name

nsfv4-mode
Enables or disables nsfv4-mode for NAS clusters.

Format
nsfv4-mode [enable|disable]

Example
Enable or disable nsfv4-mode for NAS clusters:

> nfsv4-mode
enable - Enables NFSv4 mode.
disable - Disables NFSv4 mode.
> nfsv4-mode enable
> nfsv4-mode disable

Group Management Commands 341


partner
Creates and manages the replication partners for a group for volume replication or NAS container
replication.

About Volume Replication


Replicating volume data from one group to another protects the data from catastrophic failures. A replica
represents the data in the volume at the time that replication started. A replica set is the set of replicas for
a volume.

To replicate volume data, you must configure two groups as replication partners. Each group plays a role
in the replication operation:

The group where the original volume is stored is the primary group. The direction of the replication is
outbound from the primary group.
The group where the volume replicas are stored is the secondary group. The direction of the
replication is inbound to the secondary group. If a disaster occurs on the primary group, you can
recover data from the replica set on the secondary group.

NOTE: This command does not apply when configuring synchronous replication for a volume.
Synchronous replication is the process of replicating a volume to a different pool in the same group.
For more information, see the Dell EqualLogic Group Manager Administrator's Guide.

Setting up volume replication is a three-part process:

1. Set up a replication partnership between two groups. Log in to each group and configure the other
group as a replication partner. The secondary group (the group that will be storing replicas) must
delegate space to the primary group.
See partner create.
2. Enable a volume for replication.Select each volume to replicate and specify the replication partner
that will store the replicas, the portion of delegated space to reserve for storing the replicas (replica
reserve), and the amount of space on the primary group to reserve for use during replication and,
optionally, to store the failback snapshot (local replication reserve).
See volume select replication.
3. Create a replica at the current time (or set up a replica schedule). Specify how to transfer the volume
data: either over the network (default) or by using manual transfer replication. The first replica is a
complete copy of the volume data. Subsequent replicas contain only the data that changed since
the previous replica.
See volume select replication create-replica.

For detailed information about replication, see the Dell EqualLogic Group Manager Administrator's Guide.

About NAS Replication


If you have two or more PS Series groups, each with a NAS cluster configured, you can replicate
NAS containers between the groups.

Setting up NAS container replication involves the following steps:

1. Configure a NAS cluster on each group. See nas-cluster create.


2. Configure one or more containers. See nas-cluster select container.

342 Group Management Commands


3. Configure the groups as replication partners. See partner create.
4. Configure a NAS container on one group to replicate to the NAS cluster on the partner. See nas-
cluster select container select replication.
5. Replicate the NAS container. See nas-cluster select container select replication.

Format
partner subcommand

Subcommands
Subcommand Description
create Creates a partner

delete Deletes a partner

rename Renames a partner

select Selects a replication partner for additional operations

show Shows information about all configured partners

partner create
Sets up a replication partnership between two groups. You can configure volume replication (the default),
NAS replication, or both, to the same partner.
Before configuring a partner, make sure that all members of both groups have network connectivity.

NOTE: The partner create command must be run on both the primary group and the secondary
group.

The following parameters are required:

Partner group name and group IP address, in either IPv4 or IPv6 format, as appropriate.
Passwords for mutual authentication. Replication between groups cannot occur until the reciprocal
passwords are set on both groups.
An inbound password is required, which allows the partner to replicate to the primary group. The
inbound password for the secondary group is the outbound password from the primary group. If the
secondary group will also replicate back to the primary group, you must enter the outbound
password (which is the inbound password on the primary group).
For volume replication, amount of space to delegate to the partner. Delegated space is automatically
taken from free pool space and can only be used to store replica sets from the partner.
When you configure a volume to replicate to a partner, you specify the portion of delegated space to
store the volumes replica sets (the replica reserve). See the Dell EqualLogic Group Manager
Administrator's Guide for more information about calculating the appropriate amount of delegated
space and replica reserve.

Replication is supported between partners as long as they use a common Internet Protocol, as follows:

If both partners are using only IPv4 addressing or only IPv6 addressing, replication is supported. This
setup means that each partner has only one group IP address configured and their addresses use the
same protocol.

Group Management Commands 343


If one partner uses only IPv4 or only IPv6 and the other uses a combination of IPv4 and IPv6,
replication is supported. This setup means that one partner has only one IP address configured, and
the other has both an IPv4 address and an IPv6 address. The partners will replicate using the protocol
common to both.
If one partner uses only IPv4 and the other uses only IPv6, replication is not supported.

The two groups configured as replication partners do not communicate until replication is enabled on a
volume or NAS container, or a replication operation is attempted. Therefore:

You will not know about password or configuration problems until replication is enabled on a volume
or NAS container. If you receive a login error message, make sure the reciprocal passwords on the
partners agree.
Delegated space will not be shown in the CLI output until a volume replication starts.
If you increase the size of a replicated volume, the secondary group will not update the information
until the next replication starts.

After creating a replication partnership between two groups, you can log in to the group where the
volume or NAS container is stored (the primary group) and enable replication on the volume or container.
See volume select replication enable and nas-cluster select container select replication. Then, you can
create replicas.

Formats
partner create partner_name ipaddress ipv4address parameters...
partner create partner_name ipv6address ipv6address parameters...

Variable
Variable Description
partner_name Partner group name

Parameters
Parameter Description
ipaddress ipv4address Group IP address of the partner in IPv4 format

ipv6address Group IP address of the partner in IPv6 format


ipv6address

inbound-password Password for group authentication of the partner, up to 16 ASCII


password characters.
The partners administrator must specify this exact password with the
outbound-password parameter.

The inbound password is required, but the inbound-password


parameter is optional. If you do not enter a password using the
parameter, the CLI prompts you for the password as an additional step
before creating the partner.

outbound-password Password for partner authentication of the group, up to 16 ASCII


password characters.

344 Group Management Commands


Parameter Description
The partners administrator must specify this exact password with the
inbound-password parameter.

The outbound password is required, but the outbound-password


parameter is optional. If you do not enter a password using the
parameter, the CLI prompts you for the password as an additional step
before creating the partner.

contact name (Optional) Name of the person responsible for the partner, up to 63
ASCII characters. If the name contains spaces, enclose it in quotation
marks (for example, M Chenille).

email email_address (Optional) Email address, up to 63 ASCII characters, for the person
responsible for the partner group

mobile number (Optional) Mobile phone number (up to 31 ASCII characters) for the
person responsible for the partner. Note: If you use a #, make sure it is
inside quotation marks (for example: "test#test"). Otherwise, characters
that follow the # will be ignored.

phone number (Optional) Telephone number (up to 31 ASCII characters) for the person
responsible for the partner. Note: If you use a #, make sure it is inside
quotation marks (for example: "test#test"). Otherwise, characters that
follow the # will be ignored.

description text (Optional) Description for the partner, up to 63 ASCII characters. If the
text contains spaces, enclose it in quotation marks.

pool-delegated pool (Optional; applies to volume replication only) Pool from which
delegated space will be taken. The default pool is the default.

space-delegated size (Applies to volume replication only) Specifies the amount of delegated
space for storing partner replica sets. Size is in megabytes unless you
specify gigabytes. You can specify size with any of the following
suffixes: m, mb, MB, g, gb, GB.
Delegated space is immediately taken from free space either in the
default pool or in the pool specified.

nas-replication Enables replication for NAS containers between this group and another
enable|disable group that also has a NAS cluster configured

volume-replication (Default) You do not need to explicitly specify this parameter unless you
enable|disable are also configuring NAS replication to the same partner.
Enables replication for iSCSI volumes between this group and another
group that you are specifying as the replication partner.

Group Management Commands 345


Examples

Configuring Volume Replication Between IPv4 Partners


The following commands create a partnership between two groups, AGroup and CGroup. AGroup
(primary group) is replicating volumes to CGroup (secondary group), and both are using the IPv4
protocol.

In the output for the example, the passwords are readable to show that the inbound password for one
group is the outbound password on the partner, and vice versa. On an actual system, passwords are
encrypted for security.

On AGroup:

AGroup> partner create CGroup ipaddress 192.0.2.29 inbound-password hello


outbound-password greetings
_____________________________ Partner Information ____________________________
Name: CGroup IPAddress: 192.0.2.29
Space-Received: 0MB Space-Received-Used: 0MB
Outbound-Password: ********* OutboundDesiredStatus: enabled
Description: Space-Delegated: 0MB
Space-Delegated-Used: 0MB Inbound-Password: *****
InboundDesiredStatus: enabled Contact:
Email: Phone:
Mobile: Pool-Delegated: default
FailbackReservedSpace: 0MB Space-Unmanaged: 0MB
______________________________________________________________________________

On CGroup:

CGroup> partner create AGroup ipaddress 192.0.2.35 space-delegated 200GB


inbound-password greetings outbound-password hello
Partner creation succeeded.
_____________________________ Partner Information ____________________________
Name: AGroup IPAddress: 192.0.2.35
Space-Received: 0MB Space-Received-Used: 0MB
Outbound-Password: ***** OutboundDesiredStatus: enabled
Description: Space-Delegated: 0MB
Space-Delegated-Used: 0MB Inbound-Password: *********
Email: Phone:
Mobile: Pool-Delegated: default
FailbackReservedSpace: 0MB Space-Unmanaged: 0MB
______________________________________________________________________________

Configuring Volume Replication Between IPv6 Partners


The following commands create a partnership between two groups, called Alpha and Beta. Both Alpha
and Beta will delegate 1TB of space to the other, and both are using the IPv6 protocol.

In the output for the example, the passwords are readable to show that the inbound password for one
group is the outbound password on the partner, and vice versa. On an actual system, passwords are
encrypted for security.

On group Alpha:

AGroup> partner create Beta ipv6address fc00::10aa:127b:cd25:ef170 space-


delegated 1000GB inbound-password helloAlpha999 outbound-password helloBeta111

346 Group Management Commands


Partner creation succeeded.
_____________________________ Partner Information ____________________________
Name: test IPAddress: fc00::10aa:127b:cd25:ef170
Space-Received: 0MB Space-Received-Used: 0MB
Outbound-Password: ************ OutboundDesiredStatus: enabled
Description: Space-Delegated: 1000GB
Space-Delegated-Used: 0MB Inbound-Password: *************
InboundDesiredStatus: enabled Contact:
Email: Phone:
Mobile: Pool-Delegated: default
FailbackReservedSpace: 0MB Space-Unmanaged: 0MB
__________________________________________________________________

On group Beta:

CGroup> partner create Alpha ipv6address fc00::a1a1:b2b2:cc33:def8 space-


delegated 1000GB inbound-password helloBeta111 outbound-password helloAlpha999
_____________________________ Partner Information ____________________________
Name: Alpha IPAddress: fc00::a1a1:b2b2:cc33:def8
Space-Received: 0MB Space-Received-Used: 0MB
Outbound-Password: ************* OutboundDesiredStatus: enabled
Description: Space-Delegated: 1000GB
Space-Delegated-Used: 0MB Inbound-Password: ************
InboundDesiredStatus: enabled Contact:
Email: Phone:
Mobile: Pool-Delegated: default
FailbackReservedSpace: 0MB Space-Unmanaged: 0MB
__________________________________________________________________

_________________________ Partner Information ____________________

Configuring NAS Container Replication Between IPv4 Partners


Configure NAS container replication to another group. Both groups must have a NAS cluster configured.

You do not specify a pool for delegated space with NAS replication, but you must specify the inbound
and outbound passwords, just as for volume replication.

Additionally, although volume replication is the default, when you configure NAS replication you must
explicitly specify whether to enable volume replication also to the same partner.

> partner create nasgroup2 ipaddress 192.0.2.47 nas-replication enable inbound-


password ********* outbound-password ******** volume-replication enable

partner delete
Breaks the relationship between the group and a replication partner.
Before you can delete a partner, you must pause inbound replication from the partner to the group. See
partner select inbound-pause and nas-cluster select container select replication to pause NAS container
replication.

Group Management Commands 347


NOTE: If the partner you are deleting has recovery volumes, then before you delete the partner you
must either demote the recovery volumes to inbound replica sets (which will be deleted when you
delete the partner) or make the promotion permanent, which breaks the association between the
volume and its group of origin.
To demote a recovery volume, see volume select replication demote.

To permanently promote a recovery volume, see volume select delete-failback.

Deleting a Volume Replication Partner


When you delete a replication partner, the partners replicas stored on the group are also deleted, and the
delegated space is released. However, if you delete a replication partner that is storing replicas from the
group, the replicas are not deleted and can be accessed from the partner.

For example, if you are on Group-B and you delete the partner Group-A, the following results occur:

If Group-B is storing replicas from Group-A, those replica sets are deleted.
If Group-A is storing replicas from Group-B, those replica sets are not deleted.

Deleting a NAS Replication Partner


Before you can delete a partner configured for NAS container replication, you must delete replication on
the NAS containers on both groups (in each partners NAS cluster) that are replicating to each other.
Deleting replication on a container also deletes the replica containers stored on the partner. See partner
select outbound-nas-replication for information about deleting replication on a NAS container.

Format
partner delete partner_name

Variable
Variable Description
partner_name Partner group name

Example
Delete a replication partner:

> partner delete psgroup2


Deleting partner results in deletion of all inbound replicasets
associated with this partner. Do you really want to delete the
partner? (y/n) [n] y
Partner deletion succeeded.

partner rename
Renames a replication partner.
NOTE: You can rename a replication partner only if the partners group name has changed.

348 Group Management Commands


Format
partner rename current_name new_name

Variables
Variable Description
current_name Current partner group name

new_name New partner group name

Example
Rename a partner:

> partner rename group2 staffgroup2

partner select
Selects a replication partner for additional operations.

Format
partner select partner_name subcommand | parameter

Variable
Variable Description
partner_name Partner group name

Subcommands
Subcommand Description
cancel-operation Cancels in-progress operation for the specified ID number. To display
id_number the ID number of all in-process replications, see partner select show.

failback-replicaset Manages a failback replica set in the group. You can promote a failback
replica set to a volume, move it to another pool, convert it to an
inbound replica set, cancel an operation, create and delete basic access
points (to support manual transfer replication), or show details.

inbound-nas- Manages inbound NAS replication (replica containers stored on this


replication group)

inbound-pause Pauses (temporarily suspends) replication from the partner to the group

inbound-repcol Manages the partner replica collections stored in the group, including
deleting replica collections and showing replicas in a collection

Group Management Commands 349


Subcommand Description
inbound-repcolset Manages the partner replica collection sets stored in the group,
including deleting replica collection sets and showing the replica
collections in a replica collection set

inbound-replicaset Manages the partner replica sets stored in the group, including showing,
deleting, and cloning replicas and promoting replica sets

inbound-resume Resumes suspended replication from the partner to the group

move-space-delegated Moves delegated space from one pool to another

nas-replication Enables or disables partnership for NAS container replication. If you


want to enable both NAS replication and volume replication to the same
partner, you must also specify the volume-replication
subcommand.

nas-replication Upgrades the replication communication protocol from v2 to v3


upgrade-protocol-
version

outbound-nas- Manages outbound NAS replication (replica containers stored on a


replication partner)

outbound-pause Pauses (temporarily suspends) all replication from the group to the
partner

outbound-repcol Manages the group replica collections stored on the partner, including
deleting replica collections and showing replicas in a collection

outbound-repcolset Manages the group replica collection sets stored on the partner,
including deleting replica collection sets and showing replica
collections in a replica collection set

outbound-replicaset Manages the group replica sets stored on the partner, including
showing and deleting replicas

outbound-resume Resumes suspended replication from the group to the partner

pool-map Manages the mapping between the storage pool of the primary volume
on the primary group and the storage pool of the replica set on the
secondary group

pool-space-delegated Manages delegated space on the partner

show [-poolinfo] Shows partner configuration information. With -poolinfo, shows the
name of the pool in which space is delegated for this partner.

volume-replication Enables or disables partnership for volume replication. This


subcommand is the default. If you want to enable both NAS replication
and volume replication to the same partner, you must also specify the
nas-replication subcommand.

350 Group Management Commands


Parameters
Parameter Description
contact name Name of the person responsible for the partner, up to 63
ASCII characters. If the name contains spaces, enclose it in quotation
marks (for example, M Chenille).

description text Description of the partner, up to 63 characters. If the text contains


spaces, enclose it in quotation marks.

email email_address Email address, up to 31 characters, for the person responsible for the
partner

inbound-password Password for partner authentication, up to 254 ASCII characters.


password
NOTE: You must change the inbound and outbound passwords on
separate command lines.
Make sure the partner group administrator changes the outbound-
password parameter.

ipaddress address Group IP address of the partner in IPv4 format

ipv6address address Group IP address of the partner in IPv6 format.


In some cases, replication between partners using different IP address
formats is not supported. See partner create.

mobile number Mobile phone number, up to 31 ASCII characters, for the person
responsible for the partner. Note: If you use a #, make sure it is inside
quotation marks (for example: "test#test"). Otherwise, characters that
follow the # will be ignored.

outbound-password Password for group authentication, up to 254 ASCII characters.


password
NOTE: You must change the inbound and outbound passwords on
separate command lines.
Make sure the partner group administrator changes the inbound-
password parameter.

phone number Telephone number, up to 31 characters, for the person responsible for
the partner. Note: If you use a #, make sure it is inside quotation marks
(for example: "test#test"). Otherwise, characters that follow the # will be
ignored.

pool-delegated pool (Applies to volume replication only) Moves the delegated space and all
the replica sets and recovery volumes for the partner from the original
pool into the specified pool

space-delegated size (Applies to volume replication only) Specifies the amount of delegated
space for storing partner replicas. Size is in megabytes by default. You
can specify size with any of the following suffixes: m, mb, MB, g, gb, GB,
t, tb, or TB.

Group Management Commands 351


Parameter Description
Delegated space is immediately taken from free pool space.

Examples
Change the partners inbound password:

> partner select group10 inbound-password alpha12345

Change the delegated space pool for a partner:

> partner select group1 pool-delegated staff_pool

partner select cancel-operation


Cancels an in-progress operation.

Format
partner select cancel-operation id_number

Variable
Variable Description
id_number ID number of the in-progress operation

Example
Cancel an in-progress operation:

> partner select cancel-operation 123456

partner select failback-replicaset


Selects a failback replica set that is stored in the group. A failback replica set is created by demoting a
replicated volume.
With a failback replica set, you can:

Promote it to the original volume


Move it to a different pool
Convert it to an inbound replica set
Cancel a pool move operation
Create, delete, and display basic access points (only to support manual transfer replication)
Show details about it

Format
partner select partner_name failback-replicaset subcommand

352 Group Management Commands


Variable
Variable Description
partner_name Group name of the partner to which the volume was replicated

Subcommands
Subcommand Description
select Selects a failback replica set for additional operations

show Shows information about failback replica sets

partner select failback-replicaset select


Selects a failback replica set stored in the group.

Format
partner select partner_name failback-replicaset select set_name subcommand

Variables
Variable Description
partner_name Name of the partner to which you replicated the volume

set_name Name of a failback replica set in the group

Subcommands
Subcommand Description
access Creates, displays, or deletes a basic access point for a failback replica
set, to support manual transfer replication using the CLI

assign Assigns a failback replica set to the specified volume administrator

cancel-operation Cancels an in-progress pool change operation

delete-failback Converts a failback replica set to an inbound replica set, making the
operation permanent. You can no longer return to the original volume.
You cannot delete a failback replica set until you change it.

pool pool Moves the replica set to the specified pool.


If you later promote the failback replica set, the volume will be located
in the new pool.

promote Promotes the failback replica set to a volume, returning it to its original
state.

Group Management Commands 353


Subcommand Description
You must pause inbound replication before you can promote a failback
replica set.

show Shows information about the failback replica set

unassign Unassigns a failback replica set from its volume administrator

partner select failback-replicaset select access


Creates, displays, and deletes a basic access point for a failback replica set (used only with the CLI version
of the Manual Transfer Utility).
Before you can load transfer files into a volumes replica placeholder on the secondary group, you must
configure the system running the Manual Transfer Utility CLI to connect to the failback replica set, which
has an iSCSI target associated with it.

NOTE: If the replication partners are configured to use only the IPv6 protocol, you must create a
basic access point for the failback replica set using either the initiator name or a CHAP account.
Basic access points for IPv6 initiator client system addresses are not currently supported.

Format
partner select partner_name failback-replicaset select set_name access
subcommand

Variables
Variable Description
partner_name Group name of the partner to which the volume was replicated

set_name Name of a failback replica set in the group

Subcommands
Subcommand Description
create Creates a basic access point for a failback replica set

delete Deletes a basic access point for a failback replica set

select Selects a basic access point for a failback replica set

select show Shows information about the basic access points for the failback replica
set

354 Group Management Commands


partner select failback-replicaset select access create
Creates a basic access point for the failback replica set for a manual transfer replication operation (used
only with the CLI version of the Manual Transfer Utility).
Before you can load transfer files into a volumes failback replica set on the secondary group, you must
configure the system running the Manual Transfer Utility CLI to connect to the failback replica set, which
has an iSCSI target associated with it.

NOTE: If the replication partners are configured to use only the IPv6 protocol, you must create a
basic access point for the failback replica set using either the initiator name or a CHAP account.
Basic access points for IPv6 initiator client system addresses are not currently supported.

Format
partner select partner_name failback-replicaset select set_name access create
parameter

Variables
Variable Description
partner_name Partner group name

set_name Name of a failback replica set that represents a replica placeholder

Parameters
Parameter Description
ipaddress address IPv4 address to which access is restricted. An asterisk (*) in any of the
four parts of an IP address is interpreted as a wildcard character; that is,
any value is accepted for that 8-bit field.
For example, specify *.*.*.* for unrestricted host access (not
recommended except for testing).

NOTE: Creating a basic access point for an IPv6 address is not


currently supported.

initiator name Name of the iSCSI initiator to which access is restricted. For example:
iqn.2002-10.com.companyA.qla-4000.sn00044

authmethod chap|none Specifies whether the record uses CHAP authentication (chap) to
restrict access to the failback replica set. The default is none; CHAP
authentication is not used.
You must also specify the username chap_name parameter for CHAP
authentication.

username chap_name Specifies the CHAP user name (up to 63 ASCII characters) to which
access is limited. The name must match a local CHAP account or an
account on an external RADIUS server that is known to the group.

Group Management Commands 355


Examples
Create a basic access point to grant access to a specific CHAP user and set the authentication method to
CHAP:

> partner select Group2 failback-replicaset select db2vol access create


authmethod chap username dbuser

Created access entry with ID 2.

Create a basic access point for a specific IP address (supported only for IPv4 addresses):

> partner select Group2 failback-replicaset select db2vol access create


ipaddress 192.0.2.28

Created access entry with ID 3.

Create a basic access point for an initiator name:

> partner select Group2 failback-replicaset select db2vol access create


initiator iqn.1995-07.com.mycompany:admin-pc.company.com

partner select failback-replicaset select access delete


Deletes a basic access point for the failback replica set for a volumes manual transfer replication
operation (used only with the CLI version of the Manual Transfer Utility).
This command applies only to basic access points that were created for a manual transfer replication
operation. After you have completed manual replication, use this command to delete the temporary basic
access points.

Format
partner select partner_name failback-replicaset select set_name access delete
access_entry_id

Variables
Variable Description
partner_name Partner group name

set_name Name of a failback replica set that represents a replica placeholder

access_entry_id Basic access point identification number (from the output of the show
subcommand; see partner select failback-replicaset select show)

Example
Delete a basic access point:

> partner select Group2 failback-replicaset select db2vol access delete 4

Do you really want to delete? (y/n) [n] y


Access entry deletion succeeded.

356 Group Management Commands


partner select failback-replicaset select access select
Modifies or shows a basic access point for the failback replica set for a volumes manual transfer
replication operation (used only with the CLI version of the Manual Transfer Utility).
This command applies only to basic access points that were created for a manual transfer replication
operation.

Format
partner select partner_name failback-replicaset select set_name access select
access_entry_id parameter

Variables
Variable Description
partner_name Partner group name

set_name Name of a failback replica set that represents a replica placeholder

access_entry_id Basic access point identification number (from the output of the show
subcommand; see partner select inbound-replicaset select access
select show)

Parameters
Parameter Description
authmethod chap|none Specifies whether the record uses CHAP authentication (chap) to
restrict access to the volume. The default is none; CHAP authentication
is not used.
You must also specify the username chap_name parameter for CHAP
authentication.

username chap_name Specifies the CHAP user name (up to 63 ASCII characters) to which
access is limited. The name must match a local CHAP account or an
account on an external RADIUS server that is known to the group.

initiator name Name of the iSCSI initiator to which access is restricted. For example:
iqn.2002-10.com.companyA.qla-4000.sn00044

ipaddress address IP address to which access is restricted. An asterisk (*) in any of the four
parts of an IP address is interpreted as a wildcard character; that is, any
value is accepted for that 8-bit field.
For example, specify *.*.*.* for unrestricted host access (not
recommended except for testing).

Group Management Commands 357


Example
The following commands modify the CHAP user name for a basic access point, and show detailed
information for the record before and after the change:

> partner select Group2 failback-replicaset select db2vol access select 2 show

______________________ Access Information ________________________


Initiator: Ipaddress: *.*.*.*
AuthMethod: chap UserName: jsmith
Apply-To: both

__________________________________________________________________
primary> partner select Group2 failback-replicaset select db2vol access select
2 username dbuser
primary> partner select Group2 failback-replicaset select db2vol access select
2 show
_______________________ Access Information _______________________
Initiator: Ipaddress: *.*.*.*
AuthMethod: chap UserName: dbuser
Apply-To: both

partner select failback-replicaset select access select


show
Shows information about a specific basic access point for a failback replica set.
This command applies only to basic access points that were created for a manual transfer replication
operation.

Format
partner select partner_name failback-replicaset select set_name access select
access_entry_id show

Variables
Variable Description
partner_name Partner group name

set_name Name of a failback replica set that represents a replica placeholder

access_entry_id Basic access point identification number (from the output of the show
subcommand; see partner select inbound-replicaset select access)

Example
Show detailed information about a basic access point for a failback replica set:

> partner select Group2 failback-replicaset select db2vol access select 1 show

_______________________ Access Information _______________________


Initiator: Ipaddress: *.*.*.*
AuthMethod: chap-local UserName: secondary
Apply-To: both

358 Group Management Commands


partner select failback-replicaset select assign
Assigns a failback replica set to a volume administrator.

Format
partner select partner_name failback-replicaset select set_name assign
volume_admin

Variables
Variable Description
partner_name Name of the partner to which you replicated the volume

set_name Name of the failback replica set

volume_admin Volume administrator to assign the set to

Example
Assign a failback replica set to a volume administrator:

> partner select failback-replicaset select assign voladmin3

partner select failback-replicaset select cancel-operation


Cancels an in-progress pool change operation for a failback replica set in the group.

Format
partner select partner_name failback-replicaset select set_name cancel-
operation op_id

Variables
Variable Description
partner_name Group name of the partner to which the volume was replicated

set_name Name of a failback replica set in the group

op_id Identification number for the operation to cancel

Example
The following commands show the identification number of a pool move operation in progress and then
cancel the operation:

> partner select group2 failback-replicaset select vol2 show

> partner select group2 failback-replicaset select vol2 cancel-operation 12

Group Management Commands 359


partner select failback-replicaset select delete-failback
Converts a failback replica set to an inbound replica set, making the demote operation permanent and
disabling the ability to return to the original volume.
You must change a failback replica set to an inbound replica set before you can delete it.

Format
partner select partner_name failback-replicaset select set_name delete-failback

Variables
Variable Description
partner_name Group name of the partner to which the volume was replicated

set_name Name of a failback replica set in the group

Example
Change a failback replica set to an inbound replica set:

> partner select group2 failback-replicaset select vol3 delete-failback

Failback replica set 'vol3' has been successfully converted to a replica set
with failback deleted.

partner select failback-replicaset select pool


Changes the pool for a failback replica set. If you later promote the failback replica set, the resulting
volume will be located in the specified pool.
If the original replicated volume was in a pool other than the pool containing the space delegated to the
partner, and you demoted the volume to a failback replica set, you must move the failback replica set to
the pool with the delegated space before you can promote it.

Format
partner select partner_name failback-replicaset select set_name pool pool_name

Variables
Variable Description
partner_name Group name of the partner to which the volume was replicated

set_name Name of a failback replica set in the group

pool_name Name of the pool to which to move the failback replica set

360 Group Management Commands


Example
Move a failback replica set to a different pool:

> partner select group2 failback-replicaset select vol5 pool pool2

partner select failback-replicaset select promote


Promotes a failback replica set stored in the group to the original volume.
You must pause inbound replication from the partner, and demote the recovery volume on the partner,
before you can promote the failback replica set to the original volume.

To maintain failback on the volume, after you promote it you must replicate the volume to set the new
failback baseline.

Format
partner select partner_name failback-replicaset select set_name promote

Variables
Variable Description
partner_name Group name of the partner to which the volume was replicated

set_name Name of a failback replica set in the group

Example
The following commands pause inbound replication from the partner and promote a failback replica set
to its original volume:

> partner select group2 inbound-pause

> partner select group2 failback-replicaset select vol6 promote

Failback replica set promotion succeeded. In order to establish a failback


baseline, a new replica will be created.

The promoted volume is offline. You must set it online to use it. See volume select.

To set the new failback baseline, replicate the volume immediately. See volume select replication create-
replica.

partner select failback-replicaset select show


Shows detailed information about a failback replica set stored in the group.

Format
partner select partner_name failback-replicaset select set_name show

Group Management Commands 361


Variables
Variable Description
partner_name Group name of the partner to which the volume was replicated

set_name Name of a failback replica set in the group

Example
Show detailed information about a failback replica set:

> partner select PartnerA failback-replicaset select FailbackVolH show

Name: FailbackVolH PrimaryIscsiName:


FailbackSize: 63.69GB iqn.2001-05.com.equallogic:0-af1ff6-
Pool: default 82d97d1ce-e6a00000054536a8-failbackv
Administrator: olh.1
Size: 25GB ReservedSpace: 63.69GB
FreeSpace: 0MB Borrowed Space: 17.4GB
Replicas: 10 Status: ready
Operational Status: offline Manual-Xfer: disabled
StartingTime: None Thin-Provision: enabled
Thin-Min-Reserve: 10% Thin-Growth-Warn: 60%
Thin-Growth-Max: 100% Type: failback
Local-Pool: default Remote-Pool:
_______________________________________________________________________________

______________________________ Inbound-Replicas _______________________________

Name TimeStamp Size Status


--------------------------------------- ----------- ---------- -----------
FailbackVolH-2015-05-07-15:11:02.31.1 Wed May 6 25GB completed
15:11:02
2015
FailbackVolH-2015-05-07-15:38:35.45.1 Wed May 6 25GB completed
15:38:35
2015
FailbackVolH-2015-05-07-15:53:37.47.1 Wed May 6 25GB completed
15:53:37
2015
FailbackVolH-2015-05-08-11:43:19.242.1 Thu May 7 25GB completed
11:43:19
2015
FailbackVolH-2015-05-08-11:43:44.243.1 Thu May 7 25GB completed
11:43:44
2015
FailbackVolH-2015-05-08-11:51:00.245.1 Thu May 7 25GB completed
11:51:00
2015
FailbackVolH-2015-05-08-12:53:49.253.1 Thu May 7 25GB completed
12:53:49
2015
FailbackVolH-2015-05-08-13:36:43.263.1 Thu May 7 25GB completed
13:36:43
2015
FailbackVolH-2015-05-08-16:17:19.282.1 Thu May 7 25GB completed
16:17:19

362 Group Management Commands


2015
FailbackVolH-2015-05-09-14:46:30.421.1 Fri May 8 25GB completed
14:46:30
2015

____________________________ Operations InProgress ____________________________

ID StartTime Progress Operation Details

-- -------------------- -------- -----------------------------------------------

partner select failback-replicaset select unassign


Unassigns a failback replica set from its volume administrator.

Format
partner select partner_name failback-replicaset select set_name unassign
volume_admin

Variables
Variable Description
partner_name Name of the partner to which you replicated the volume

set_name Name of the failback replica set

volume_admin Name of the volume administrator to unassign the set from

Example
Unassign a failback replica set from a volume administrator:

> partner select failback-replicaset select unassign voladmin3

partner select failback-replicaset show


Shows information about the failback replicat sets in the group.

Format
partner select partner_name failback-replicaset show [parameter]

Variable
Variable Description
partner_name Name of the replication partner

Group Management Commands 363


Parameters
Parameter Description
-template Displays only failback template replica sets stored on the partner

-volume Displays only failback replica sets stored on the partner

Example
Show the failback replica sets in the group:

> partner select group2 failback-replicaset show

Name ReservedSpace FreeSpace Replicas Status


--------------- ------------- ------------- -------- -------------------------
dbvol2 80GB 36.98GB 21 ready
vol5 2.01GB 1.01GB 3 ready
uservol8 40.01GB 20GB 4 ready
clonevol1 16.03GB 8.01GB 0 ready

partner select inbound-nas-replication


Manages NAS replication.

Format
partner select partner_name inbound-nas-replication subcommand

Variable
Variable Description
partner_name Partner group name

Subcommands
Subcommand Description
delete Deletes a partners inbound NAS replica container stored in the group

select Selects a partners NAS replica container for additional operations

show Displays all the inbound NAS replica containers

partner select inbound-nas-replication delete


Deletes an inbound NAS replica container for a NAS replication partner.

Format
partner select partner_name inbound-nas-replication delete container_name

364 Group Management Commands


Variables
Variable Description
partner_name Partner group name

container_name Name of an inbound NAS container to delete

Example
Delete an inbound NAS replica container for a partner:

> partner select NASgroup1 inbound-nas-replication delete redFox6_4474

partner select inbound-nas-replication select


Selects an inbound NAS replica container for a NAS replication partner.

Format
partner select partner_name inbound-nas-replication select container_name
subcommand

Variables
Variable Description
partner_name Partner group name

container_name Name of an inbound NAS container

Subcommands
Subcommand Description
pause Pauses inbound replication to the NAS container

promote Promotes an inbound NAS container

read-only-access Enables (or disables) read-only access on a replica container, allowing


the local administrator to see details about it

resume Resumes inbound replication to the NAS container

partner select inbound-nas-replication select pause


Pauses inbound replication to the NAS container

Format
partner select partner_name inbound-nas-replication select container_name pause

Group Management Commands 365


Variables
Variable Description
partner_name Partner group name

container_name Name of an inbound NAS container

Example
Pause replication for an inbound NAS replica container for a partner:

> partner select NASgroup1 inbound-nas-replication select redFox5_4632 pause

partner select inbound-nas-replication select promote


Promotes an inbound NAS replica container for a NAS replication partner.
If user and group quota rules are in place for the source container, the system will apply those quotas to
the recovery container as follows:

If you are using an external server (such as Active Directory, LDAP, or NIS) to authenticate users and
groups on the destination cluster, quotas will be applied to the recovery container.
If you are using only local users and groups, quotas will not be applied.
If you are using both local users and groups and externally authenticated users and groups, user and
group quotas are applied for the externally authenticated accounts. Quotas will also be applied for the
local users and groups, but they might not be applied correctly.

For more information about this behavior, see the Dell EqualLogic Group Manager Administrator's Guide.

Format
partner select partner_name inbound-nas-replication select container_name
promote parameters

Variables
Variable Description
partner_name Partner group name

container_name Name of an inbound NAS container to select

Parameters
Parameter Description
keep-demote Applies the configuration from the source container to this container

keep-dest-config Keeps the configuration of the original replica container

366 Group Management Commands


Examples
Promote an inbound NAS replica container for a partner:

> partner select NASgroup1 inbound-nas-replication select lcn021_8928 promote

Promote an inbound NAS replica container for a partner and specify that it keep its current configuration:

> partner select NASgroup1 inbound-nas-replication select lcn022_6911 promote


keep-dest-config

partner select inbound-nas-replication select read-only-


access
Enables read-only access on a replica container, allowing the local administrator to see details about it.
This command makes the inbound replica container visible in the output from the nas-cluster container
select show command. Normally, inbound replica containers do not appear in that output.

Format
partner select partner_name inbound-nas-replication select container_name read-
only-access enable|disable

Variables
Variable Description
partner_name Partner group name

container_name Name of an inbound NAS container

Example
Set read-only access on an inbound NAS replica container for a partner:

> partner select NASgroup1 inbound-nas-replication select redFox6_4474 read-


only-access enable

partner select inbound-nas-replication resume


Resumes inbound replication to the NAS container

Format
partner select partner_name inbound-nas-replication select container_name resume

Group Management Commands 367


Variables
Variable Description
partner_name Partner group name

container_name Name of an inbound NAS container

Example
Resume replication for an inbound NAS replica container for a partner:

> partner select NASgroup1 inbound-nas-replication select redFox5_4632 resume

partner select inbound-nas-replication show


Shows information about all the inbound NAS replica containers on the group.

Format
partner select partner_name inbound-nas-replication show

Variable
Variable Description
partner_name Partner group name

Example
Show all the inbound NAS replica containers on the group:

> partner select NASgroup1 inbound-nas-replication show

__________________________ Inbound-NAS-replication ___________________________

Source Container Replica Container Status % Transferred


----------------- ----------------- ----------- --------------
lcn021 lcn021_8928 Idle N/A
lcn022 lcn022_6911 Idle N/A

partner select inbound-pause


Pauses (temporarily stops) inbound replication data transfer from the partner to the group.

Format
partner select partner_name inbound-pause

368 Group Management Commands


Variable
Variable Description
partner_name Partner group name

Example
Pause replication data transfer from the partner to the group:

> partner select psgroup2 inbound-pause

partner select inbound-repcol


Manages the replica collections stored in the group.
NOTE: You cannot delete the most recent replica or the only replica in a set.

Format
partner select partner_name inbound-repcol subcommand

Variable
Variable Description
partner_name Partner group name

Subcommands
Subcommand Description
delete repcol Deletes an inbound replica collection stored in the group (the replicas
in the collection). You must pause inbound replication from the partner
before deleting an inbound replica collection. See partner select
inbound-pause.

select repcol Selects a partners replica collection and shows the replicas in the
collection

show [custom] Shows the partners replica collections stored in the group. Specify
custom to display custom replica collections.

Examples
Show a partners replica collections stored in the group:

> partner select psgroup2 inbound-repcol show

Show the replicas in an inbound replica collection:

> partner select psgroup2 inbound-repcol select vc1.1-2015-03-10-10:49:04.464


show

Group Management Commands 369


Delete an inbound replica collection:

> partner select psgroup2 inbound-repcol delete repcol


vc1.1-2015-03-10-10:22:04.465

partner select inbound-repcolset


Manages the replica collection sets stored in the group.

Format
partner select partner_name inbound-repcolset subcommand

Variable
Variable Description
partner_name Partner group name

Subcommands
Subcommand Description
delete repcolset Deletes an inbound replica collection set from the group

select repcolset Selects a partners replica collection set and shows the replica
collections in the set

show Shows the partners replica collection sets stored in the group

Examples
Show a partners replica collection sets stored in the group:

> partner select psgroup2 inbound-repcolset show

Show the replica collections in an inbound replica collection set:

> partner select psgroup2 inbound-repcolset select vc1.1 show

Delete an inbound replica collection set:

> partner select psgroup2 inbound-repcolset delete vcol.1

It is strongly recommended that you perform this operation with caution and
only in the event of a disaster at the group where the original volume
collection resides. Are you sure you want to delete the inbound-replica
collection set? (y/n) [n] y

370 Group Management Commands


partner select inbound-replicaset
Manages inbound replica sets for a partner.

Format
partner select partner_name inbound-replicaset subcommand

Variable
Variable Description
partner_name Partner group name

Subcommands
Subcommand Description
delete Deletes a partners inbound replica set stored in the group

select Selects a partners replica set for additional operations

show Shows information about inbound replica sets

partner select inbound-replicaset delete


Deletes a partners inbound replica set stored in the group.
Be careful when deleting a replica set that belongs to a partner, because deleting the set deletes the
partners replicas, and the partner will not be able to recover the data that was in those replicas. If
possible, manage replicas and replica sets from the primary group.

Before deleting an inbound replica set, you must pause inbound replication from the partner. See partner
select inbound-pause.

Format
partner select partner_name inbound-replicaset delete set_name

Variables
Variable Description
partner_name Partner group name

set_name Name of a replica set

Group Management Commands 371


Example
Delete an inbound replica set:

> partner select psgroup2 inbound-replicaset delete v1.1

partner select inbound-replicaset select


Selects a partners inbound replica set for additional operations.

Format
partner select partner_name inbound-replicaset select set_name subcommand

Variables
Variable Description
partner_name Partner group name

set_name Name of an inbound replica set

Subcommands
Subcommand Description
access Manages basic access points for a replica placeholder used in a manual
transfer replication operation

cancel-operation Cancels an in-progress operation for the replica set

clone Clones a replica

delete Deletes a replica

lost-blocks mark-valid Sets the replica online and marks the lost cached blocks as valid

manual-xfer done Sends a confirmation message to the primary group

pool Moves the replica set to the specified pool, if this pool has delegated
space for the partner

promote Permanently promotes an inbound replica set to a new volume, and


loses the ability to be demoted to an inbound replica set

show Shows information about the replica set and replicas

372 Group Management Commands


partner select inbound-replicaset select access
Manages basic access points for the replica placeholder for a volumes manual transfer replication
operation (used only with the CLI version of the Manual Transfer Utility).
Before you can load transfer files into a volumes replica placeholder on the secondary group, you must
configure the system running the Manual Transfer Utility CLI to connect to the replica placeholder, which
has an iSCSI target associated with it.

You can create, modify, and delete basic access points only for the replica placeholder created for a
volume that is configured to use manual transfer replication. After the manual transfer of the volume data
is complete, you can delete the basic access point.

By default, the inbound replica set has a basic access point inherited from the original replicated volume.
This basic access point only sets up communication between the partner groups.

Format
partner select partner_name inbound-replicaset select set_name access subcommand

Variables
Variable Description
partner_name Partner group name

set_name Name of an inbound replica set that represents a replica placeholder

Subcommands
Subcommand Description
create Creates a basic access point

delete Deletes a basic access point

select Selects a basic access point for additional operations

show Shows information about the replica set and replicas

partner select inbound-replicaset select access create


Creates a basic access point for the replica placeholder for a volumes manual transfer replication
operation. (Used only with the CLI version of the Manual Transfer Utility.)
Before you can load transfer files into a volumes replica placeholder on the secondary group, you must
configure the system running the Manual Transfer Utility CLI to connect to the replica placeholder, which
has an iSCSI target associated with it.

Group Management Commands 373


NOTE: If the replication partners are configured to use only the IPv6 protocol, you must create a
basic access point for the replica set using either the initiator name or a CHAP account. Basic
access points for IPv6 initiator client system addresses are not currently supported.

Format
partner select partner_name inbound-replicaset select set_name access create
parameter

Variables
Variable Description
partner_name Partner group name

set_name Name of an inbound replica set that represents a replica placeholder

Parameters
Parameter Description
ipaddress address IPv4 address to which access is restricted. An asterisk (*) in any of the
four parts of an IP address is interpreted as a wildcard character; that is,
any value is accepted for that 8-bit field.
For example, specify *.*.*.* for unrestricted host access (not
recommended except for testing).

Creating a basic access point for an IPv6 address is not currently


supported.

initiator name Name of the iSCSI initiator to which access is restricted. For example:
iqn.2002-10.com.companyA.qla-4000.sn00044

authmethod chap|none Specifies whether the record uses CHAP authentication (chap) to
restrict access to the volume. The default is none; CHAP authentication
is not used.
You must also specify the username chap_name parameter for CHAP
authentication.

username chap_name Specifies the CHAP user name to which access is limited. The name
must match a local CHAP account or an account on an external RADIUS
server that is known to the group.

Examples
Create a basic access point that sets the authentication method to CHAP and grants access to a specific
CHAP user:

> partner select secondary inbound-replicaset select vol-1.1 access


createdbuser authmethod chap username

Created access entry with ID 2.

374 Group Management Commands


Create a basic access point for a specific IP address (supported only for IPv4 addresses):

> partner select secondary inbound-replicaset select vol-1.1 access create


ipaddress 192.0.2.34

Created access entry with ID 3.

Create a basic access point for an initiator name:

> partner select secondary inbound-replicaset select vol-1.1 access create


initiator iqn.1995-07.com.mycompany:admin-pc.company.com

partner select inbound-replicaset select access delete


Deletes a basic access point for the replica placeholder for a volumes manual transfer replication
operation (used only with the CLI version of the Manual Transfer Utility).
This command applies only to replica sets that were created for a manual transfer replication operation.
After you have completed manual replication, use this command to delete the temporary basic access
points.

Format
partner select partner_name inbound-replicaset select set_name access delete
access_entry_id

Variables
Variable Description
partner_name Partner group name

set_name Name of an inbound replica set that represents a replica placeholder

access_entry_id Basic access point identification number (from the output of the show
subcommand; see partner select inbound-replicaset select access)

Example
Delete a basic access point:

> partner select secondary inbound-replicaset select vol.1 access delete 4

Do you really want to delete? (y/n) [n] y


Access entry deletion succeeded.

partner select inbound-replicaset select access select


Modifies or shows a basic access point for the replica placeholder for a volumes manual transfer
replication operation (used only with the CLI version of the Manual Transfer Utility).
This command applies only to replica sets that were created for a manual transfer replication operation.

Group Management Commands 375


Format
partner select partner_name inbound-replicaset select set_name access select
access_entry_id subcommand | parameter

Variables
Variable Description
partner_name Partner group name

set_name Name of an inbound replica set that represents a replica placeholder

access_entry_id Basic access point identification number (from the output of the show
subcommand; see partner select inbound-replicaset select access)

Subcommand
Subcommand Description
show Shows detailed information about the specified basic access point
number

Parameters
Parameter Description
authmethod chap|none Specifies whether the record uses CHAP authentication (chap) to
restrict access to the volume. The default is none; CHAP authentication
is not used.
You must also specify the username chap_name parameter for CHAP
authentication.

username chap_name Specifies the CHAP user name to which access is limited. The name
must match a local CHAP account or an account on an external RADIUS
server that is known to the group.

initiator name Name of the iSCSI initiator to which access is restricted. For example:
iqn.2005-07.com.companyA.qla-4000.sn00044

ipaddress address IP address to which access is restricted. An asterisk (*) in any of the four
parts of an IP address is interpreted as a wildcard character; that is, any
value is accepted for that 8-bit field.
For example, specify *.*.*.* for unrestricted host access (not
recommended except for testing).

Examples
Show detailed information about a particular basic access point for an inbound replica set:

> partner select GroupB inbound-replicaset select vol-1.1 access select 1 show

376 Group Management Commands


_______________________ Access Information _______________________
Initiator: Ipaddress: *.*.*.*
AuthMethod: chap-local UserName: secondary
Apply-To: both
__________________________________________________________________

The following commands modify the CHAP user name for a basic access point and show the detail
information for the record before and after the change:

> partner select GroupB inbound-replicaset select vol-1.1 access select 2 show

______________________ Access Information ________________________


Initiator: Ipaddress: *.*.*.*
AuthMethod: chap UserName: jsmith
Apply-To: snapshot
_________________________________________________________________
> partner select GroupB inbound-replicaset select vol-1.1 access select 2
username dbuser

> partner select GroupB inbound-replicaset select vol-1.1 access select 2 show

_______________________ Access Information _______________________


Initiator: Ipaddress: *.*.*.*
AuthMethod: chap UserName: dbuser
Apply-To: snapshot

partner select inbound-replicaset select access show


Shows information about the replica set and replicas.

Format
partner select partner_name inbound-replicaset select set_name access show

Variables
Variable Description
partner_name Partner group name

set_name Name of an inbound replica set that represents a replica placeholder

Example
Show the basic access point for the replica placeholder for a volume that is configured to use manual
transfer replication:

> partner select group1 inbound-replicaset select test1.1 access show

ID Initiator Ipaddress AuthMethod UserName Apply-To


--- -------------- --------------- ---------- ---------- -------
1 *.*.*.* chap-local group1 both

Group Management Commands 377


partner select inbound-replicaset select cancel-
operation
Cancels an in-progress operation for the replica set.
To obtain the operations ID number, use the partner select show command.

Format
partner select partner_name inbound-replicaset select set_name cancel-operation
op_id

Variables
Variable Description
partner_name Partner group name

set_name Name of an inbound replica set

op_id ID number of the operation to cancel

Example
Cancel an in-progress operation for a replica set:

> partner select psgroup2 inbound-replicaset select vol2.1 cancel-operation 8

partner select inbound-replicaset select clone


Selects an inbound replica set stored in the group and clones a replica from that set, creating a new
volume.
Cloning different objects has different results:

Cloning an inbound replica creates a new standard volume.


Cloning a template replica creates a new template volume.
Cloning a thin clone replica creates a new thin clone volume, which remains attached to the thin
clone replica set unless you detach it.
All replicas are thin provisioned by default. Therefore, when you clone a replica to create a new volume,
the new volume will also be thin provisioned, regardless of whether the original volume was thin
provisioned at the time the replica was created.

In all cases, the new volume has a different iSCSI target name, but the same contents as the volume
when the replica was created and will be available immediately through the IP address of the secondary
group (not the primary group, where the original volume resides). You can use and modify the new
volume as you would any other volume, within the restrictions for the volume type.

By default, the new volume will be set online, have read-write permission, and use the groupwide
snapshot space and iSCSI settings, unless you override them.

You can clone complete replicas only. The replica is still available after the cloning operation completes.

378 Group Management Commands


Cloning a replica consumes 100 percent of the original volume reserve from free secondary group pool
space. If you create snapshots or replicas of the new volume, additional space is needed.

Format
partner select partner_name inbound-replicaset select set_name clone
replica_name new_volume [parameter...]

Variables
Variable Description
partner_name Partner group name

set_name Name of an inbound replica set

replica_name Name of a replica

new_volume Name of new volume

Parameters
Parameter Description
description text Description for the new volume. If the text contains spaces, enclose it in
quotation marks.

read-write|read-only New volume permission (default is read-write)

offline|online New volume status (default is online)

snap-reserve n% Amount of space, as a percentage of the new volume reserve, to


reserve for snapshots. You must include the percent sign (%).
The default setting is groupwide (see grpparams def-snap-reserve).

snap-warn n% Threshold at which an alarm occurs because the amount of free space
reserved for snapshots of the new volume has fallen below this value, as
a percentage of the total reserved snapshot space. You must include
the percent sign (%).
The default setting is groupwide (see grpparams def-snap-warn).

snap-depletion action Specifies the default snapshot space recovery policy, either delete-
oldest (delete the oldest snapshots, the default) or volume-offline
(set the volume and its snapshots offline).
The default setting is groupwide (see grpparams def-snap-depletion).

iscsi-alias alias iSCSI target alias for the new volume. Some iSCSI initiators can see the
alias.
The default setting is groupwide (see grpparams def-iscsi-alias.

unrestricted Grants unrestricted host access to the new volume. Unrestricted access
is not recommended. Instead, after cloning the replica, you should

Group Management Commands 379


Parameter Description
create one or more basic access points to restrict host access to the
new volume.
See volume select access create.

bind member Binds the new volume to the specified member. Volume data will be
restricted to this member.
Binding a volume to a member will override any RAID preference and
will disable performance load balancing for the volume.

Example
Clone an inbound replica to create a volume:

> partner select psgroup11 inbound-replicaset select v1.1 clone


v1.1-2015-01-26-11:19:27.15 v1-clone

partner select inbound-replicaset select delete


Selects an inbound replica set and deletes a replica stored in the group.
NOTE: You cannot delete the most recent replica, or the only replica in a set.

Before deleting an inbound replica, pause inbound replication from the partner to the group. See partner
select inbound-pause.

If possible, manage replicas and replica sets from the primary group (where the original volume is stored).

Format
partner select partner_name inbound-replicaset select set_name delete
replica_name

Variables
Variable Description
partner_name Partner group name

set_name Name of an inbound replica set

replica_name Name of a replica

Example
> partner select psarray11 inbound-replicaset select dbvol.1 delete dbvol.
1-2015-01-24-16:17:32.9

380 Group Management Commands


partner select inbound-replicaset select lost-blocks
mark-valid
Sets the replica set online and marks the lost cached blocks as valid.
Lost cached blocks can occur if a power failure lasts longer than 72 hours.

NOTE: This option might present a security risk, and the blocks might contain old data.

Format
partner select partner_name inbound-replicaset select set_name lost-blocks mark-
valid

Variables
Variable Description
partner_name Partner group name

set_name Name of an inbound replica set

Example
Set a replica set online and mark any lost cached blocks as valid:

> partner select psgroup2 inbound-replicaset select vol2.1 lost-blocks mark-


valid

partner select inbound-replicaset select manual-xfer


done
Selects a partner and sends a confirmation message that all the transfer files created for a volume using
manual transfer replication have been loaded to the replica placeholder (only with the Manual Transfer
Utility CLI).
Run this command only on the secondary group, specifying the primary group and the inbound replica
set that represents the replica placeholder, after loading the transfer files to the replica.

The primary group periodically polls the secondary group for the status of replication transfers. This
command sends a confirmation status back to the primary group and changes the volume and replica
status on both groups.

Format
partner select partner_name inbound-replicaset select set_name manual-xfer done

Group Management Commands 381


Variables
Variable Description
partner_name Group name of the primary group (where the replicated volume is
located)

set_name Name of an inbound replica set that represents the replica placeholder

Example
Configure a confirmation message for a manual transfer replication for a volume that originated on
group2:

> partner select group2 inbound-replicaset select emailvol manual-xfer done

partner select inbound-replicaset select pool


Moves an inbound replica set to the specified pool, if this pool has delegated space for the partner

Format
partner select partner_name inbound-replicaset select set_name pool pool_name

Variables
Variable Description
partner_name Partner group name

set_name Name of an inbound replica set

pool_name Name of the pool to move the replica set to

Example
Move a replica set to a different pool:

> partner select psgroup2 inbound-replicaset select vol2.1 pool pool2

partner select inbound-replicaset select promote


Selects an inbound replica set from a partner and promotes it to a recovery volume (or a volume) and
snapshots.
The new volume will contain the data of the most recent replica. Additional replicas will be changed into
snapshots.

You can promote an inbound replica set the following ways:

Temporary promotion to a recovery volume, recovery template volume, or recovery thin clone
volume

382 Group Management Commands


Replication of the original volume stops, although the replication relationship is retained so that you
can later fail back to the primary group. The recovery volume optionally uses the same iSCSI target
name as the original volume. After the recovery volume is no longer needed, you can demote the
recovery volume to an inbound replica set, returning it to its original state.

To fail back the changes to the primary group, you must demote the volume on the primary group to
a failback replica set and replicate the changes. You can then demote the recovery volume and
promote the failback replica set to return to the original replication configuration. You cannot fail
back a template volume.
Permanent promotion to a volume, template volume, or thin clone volume
Replication of the original volume stops and the replica set is deleted from the group. This promotion
is permanent; the volume cannot later be demoted to the original inbound replica set (although it can
be demoted to a failback replica set).

By default when you promote permanently, the volume will have a new, unique iSCSI target name,
and hosts must access the volume through the IP address of the current group. Optionally, you can
specify that the new volume retain the iSCSI target name (and SCSI identification number) of the
original volume. However, only one volume can be associated with a particular target name and SCSI
ID.

To permanently promote a template volume, you must first permanently promote all its thin clones.

See the Dell EqualLogic Group Manager Administrator's Guide for detailed information about failback
procedures.

NOTE: Promoting a replica set will fail if replication is in progress for the replica set that you are
trying to promote. You must pause inbound replication before promoting a replica set, then resume
it after the promotion. See partner select inbound-pause.

Promoting a replica set does not consume additional pool space on the secondary group. The volume
and its snapshot reserve will use exactly the amount of space that was allocated to the replica set in its
storage pool, and the delegated space on the recovery group will be reduced by that same amount.

Formats
For permanent promotion:

partner select partner_name inbound-replicaset select set_name promote


new_volume [parameter...]

For temporary promotion:

partner select partner_name inbound-replicaset select set_name promote keep-


demote [retain-iscsi-name]

Variables
Variable Description
partner_name Partner group name

set_name Name of an inbound replica set

new_volume Name of new volume

Group Management Commands 383


Parameters
Parameter Description
description text Description for the new volume. If the text contains spaces, enclose it in
quotation marks.

read-write|read-only New volume permission (default is read-write)

offline|online New volume status (default is online)

snap-warn n% Threshold at which an alarm occurs because the amount of free space
reserved for snapshots of the new volume has fallen below this value, as
a percentage of the total reserved snapshot space. You must include
the percent sign (%).
The default is the groupwide setting (see grpparams def-snap-warn).

snap-depletion action Specifies the default snapshot space recovery policy, either delete-
oldest (delete the oldest snapshots; the default) or volume-offline
(set the volume and its snapshots offline).
The default is the groupwide setting (see grpparams def-snap-
depletion).

iscsi-alias alias iSCSI target alias for the new volume.


The default is the groupwide setting (see grpparams def-iscsi-alias).

unrestricted Grants unrestricted host access to the new volume.


Unrestricted access is not recommended. Instead, after cloning the
replica, you should create one or more basic access points to restrict
host access to the volume. See volume select access create.

retain-iscsi-name Sets the new volume target iSCSI name identical to the iSCSI target
name (and SCSI ID) of the original volume

keep-demote Retains the ability to be demoted to an inbound replica set

Examples
Permanently promote an inbound replica set to a volume:

> partner select psg1 inbound-replicaset select v1.1 promote v1-new

Promoting is in progress. Successfully created volume 'v1-new'

Temporarily promote an inbound replica set to a recovery volume:

> partner select group2 inbound-replicaset select vol3 promote keep-demote

Replica set promoted to recovery volume. You can demote the original volume and
then configure replication to the primary group.

384 Group Management Commands


partner select inbound-replicaset select show
Shows information about an inbound replica set that is stored in the group.

Format
partner select partner_name inbound-replicaset select set_name show

Variables
Variable Description
partner_name Partner group name

set_name Name of an inbound replica set

Example
Show information about an inbound replica set:

> partner select dev16grp inbound-replicaset select v2.7 show

_______________________ Inbound ReplicaSet Information ________________________


Name: v2.7 PrimaryIscsiName:
Size: 1GB iqn.2001-05.com.equallogic:0-8a0906-
ReservedSpace: 780MB a04375504-1da00000032533c8-v2
FreeSpace: 240MB Borrowed Space: 0MB
Replicas: 14 Status: ready
Operational Status: offline Manual-Xfer: disabled
StartingTime: None Thin-Provision: enabled
Thin-Min-Reserve: 10% Thin-Growth-Warn: 100%
Thin-Growth-Max: 100% Type: regular
Local-Pool: default Remote-Pool: default
_______________________________________________________________________________

______________________________ Inbound-Replicas _______________________________

Name TimeStamp Size Status


--------------------------------------- ----------- ---------- -----------
v2.7-2015-04-02-09:24:17.33.1 Thu Apr 2 1GB completed
09:24:17
2015
v2.7-2015-04-03-05:08:15.34.1 Fri Apr 3 1GB completed
05:08:15
2015

partner select inbound-replicaset show


Displays the inbound replica sets for a partner stored in the group.

Format
partner select partner_name inbound-replicaset show [-template|
-volume]

Group Management Commands 385


Variable
Variable Description
partner_name Partner group name

Parameters
Parameter Description
-template Displays only inbound template replica sets stored on the partner

-volume Displays only inbound replica sets stored on the partner

Example
Show the inbound replica sets from a partner:

> partner select PartnerA inbound-replicaset show


Name ReservedSpace FreeSpace BorrowedSpace Replicas Local-Pool Remote-Pool Status
--------------- ------------- ------------- ------------- ---------- ----------- ----------- ------------
mcp-RepSetA4.1 9.93GB 0MB 10.54GB 9 default PartnerAPoo ready
mcp-RepSetA3.1 24.02GB 0MB 21.62GB 9 default PartnerAPoo ready
mcp-RepSetA1.1 104.5GB 0MB 92.51GB 6 default PartnerAPoo ready
A-ReplResvFree. 8.09GB 7.07GB 0MB 1 default PartnerAPoo ready

partner select inbound-resume


Resumes inbound replication from the selected partner to the group.

Format
partner select partner_name inbound-resume

Variable
Variable Description
partner_name Partner group name

Example
Resume replication from the partner to the group:

> partner select psgroup2 inbound-resume

partner select move-space-delegated


Moves delegated space from the source pool to a destination pool.
While the delegated space is being transferred, the amount of space in the pool remains reserved. The
command will fail if the destination already contains delegated space and not enough space is available
for the space from the source.

386 Group Management Commands


Format
partner select partner_name move-space-delegated pool_source pool_destination

Variables
Variable Description
partner_name Name of the partner on which the storage pools reside

pool_source Name of the pool from which delegated space is being transferred

pool_destination Name of the pool to which delegated space is being transferred

Example
Transfer delegated space from one pool to another:

> partner select howdy move-space-delegated pool1 pool2

partner select nas-replication


Enables or disables NAS replication.
Before you can enable NAS replication, both groups must have a NAS cluster configured, and the groups
must be configured as replication partners. See partner create.

Format
partner select partner_name nas-replication enable|disable

Variable
Variable Description
partner_name Partner group name

Example
Enable NAS replication to a partner:

> partner select NASgroup1 nas-replication enable

partner select nas-replication upgrade-protocol-version


Upgrades the replication communication protocol from v2 to v3. Replication partners must run the same
protocol version so that replication does not break.
To upgrade the protocol:

1. Ensure that you have a live network connection.


2. Run this command on both clusters in a replication relationship to ensure that the protocol is v3.

Group Management Commands 387


3. Upgrade to the FS Series v4.0 firmware.

Format
partner select partner_name nas-replication upgrade-protocol-version [v3]

Variables
Variable Description
partner_name Partner group name

Example
Set the communication protocol to v3 for NAS replication:

> partner select NAS_5 nas-replication upgrade-protocol-version v3

partner select outbound-nas-replication


Manages outbound NAS replication and replica containers.

Format
partner select partner_name outbound-nas-replication subcommand

Variable
Variable Description
partner_name Partner group name

Subcommands
Subcommand Description
delete Disables (deletes) replication on the source container and deletes any
replica containers stored on the partner

show Displays all the containers on this group that have replica containers on
the specified partner

Examples
Show all the containers on the group that have replica containers on a partner. In the output, the names
under Source Container are the containers on this group (the group on which you run the command).
The output shows the replica containers on the partner.

> partner select NASgroup1 outbound-nas-replication show

__________________________ Outbound-NAS-replication __________________________

Source Container Replica Container Status % Transferred


----------------- ----------------- ----------- --------------

388 Group Management Commands


earth17 earth17_2830 Idle N/A
earth18 earth18_6674 Idle N/A

Delete a replica container that is stored on the partner:

> partner select NASgroup1 outbound-nas-replication delete earth18_6674

partner select outbound-pause


Pauses (temporarily suspends) outbound replication data transfer from the group to the selected partner.

Format
partner select partner_name outbound-pause

Variable
Variable Description
partner_name Partner group name

Example
Pause outbound replication on a partner:

> partner select AGroup outbound-pause

partner select outbound-repcol


Manages the replica collections that are stored on a partner.
NOTE: You cannot delete the most recent replica or the only replica in a set.

Format
partner select partner_name outbound-repcol subcommand

Variable
Variable Description
partner_name Partner group name

Subcommands
Subcommand Description
delete repcol Deletes the specified outbound replica collection and all the replicas in
the collection

select repcol Displays the replicas in the specified replica collection

Group Management Commands 389


Subcommand Description
show [custom] Shows the replica collections stored on the partner. Specify custom to
display custom replica collections.

Examples
Show the replica collections stored on the partner:

> partner select psgroupa outbound-repcol show

Show the replicas in an outbound replica collection:

> partner select psgroupa outbound-repcol select vc1.1-2015-03-10-11:15:49.473


show

Delete an outbound replica collection:

> partner select psgroupa outbound-repcol delete vc1.1-2015-03-10-11:15:49.473

partner select outbound-repcolset


Manages the replica collection sets that are stored on the partner.

Format
partner select partner_name outbound-repcolset subcommand

Variable
Variable Description
partner_name Partner group name

Subcommands
Subcommand Description
delete repcolset Deletes the specified outbound replica collection set and the replicas in
the collection

select repcolset show Displays replica collections in the specified collection set

show Shows the replica collection sets stored on the partner

Examples
Show the group replica collection sets that are stored on the partner:

> partner select psgroupa outbound-repcolset show


Collection NoOfRepcols Status
-------------------- --------------------- ----------
volcol34 2 enabled
newcol 1 enabled

390 Group Management Commands


Show the replica collections in an outbound replica collection set:

> partner select psgroupa outbound-repcolset select vc1 show


__________________________ Replication Information ___________________________
PartnerName: panda31-grp DesiredStatus: enabled
NoOfRepcols: 1
______________________________________________________________________________
_____________________________ Outbound-repcols _______________________________
Name Collection TimeStamp Replicas Schedule
--------------------------- ---------- ------------------- -------- --------
newcol.1-2015-03-25-12:02:57 newcol 2015-03-25:12:02:57 2 5192

Delete an outbound replica collection set:

> partner select psgroupa outbound-repcolset delete vc1


Outbound-replica collection set deletion succeeded.

partner select outbound-replicaset


Selects a partners outbound replica sets for additional operations.

Format
partner select partner_name outbound-replicaset subcommand

Variable
Variable Description
partner_name Partner group name

Subcommands
Subcommand Description
delete Deletes a replica set

select Selects a replica set for additional operations

show Shows information about outbound replica sets

partner select outbound-replicaset delete


Deletes a partners outbound replica set.

Format
partner select partner_name outbound-replicaset delete set_name

Group Management Commands 391


Variables
Variable Description
partner_name Partner group name

set_name Name of a replica set

Example
Delete an outbound replica set for a partner:

> partner select psgroup1 outbound-replicaset delete vol3

partner select outbound-replicaset select


Selects a partners outbound replica set for additional operations.

Format
partner select partner_name outbound-replicaset select set_name subcommand

Variables
Variable Description
partner_name Partner group name

set_name Name of a replica set

Subcommands
Subcommand Description
delete Deletes a replica set

show Shows information about the replica set and its replicas

partner select outbound-replicaset select delete


Deletes a replica in a partners outbound replica set.
NOTE: You cannot delete the most recent replica or the only replica in a set.
You can delete an outbound replica only if the status is complete. Do not disable replication on the
volume or the deletion will fail.

Format
partner select partner_name outbound-replicaset select set_name delete
replica_name

392 Group Management Commands


Variables
Variable Description
partner_name Partner group name

set_name Name of a replica set

replica_name Name of a replica in the set

Example
Delete an outbound replica in a set:

> partner select psa11 outbound-replicaset select vol3 delete


vol3.1-2015-02-10-09:54:5
Do you really want to delete the outbound replica? (y/n) [n] y

partner select outbound-replicaset select show


Displays a partners outbound replica sets.

Format
partner select partner_name outbound-replicaset select set_name show

Variables
Variable Description
partner_name Partner group name

set_name Name of a replica set

Example
Display details about an outbound replica set for a partner:

> partner select PartnerA outbound-replicaset select C1LocalVol show

_______________________ Outbound-Replicaset Information _______________________


Name: C1LocalVol Remote-Rep-Reserve: 200%
Remote-Rep-Reserve-Avail: 16.52GB Remote-Rep-Borrowed: 0MB
Local-Rep-Reserve: 50% Borrow-Space: enabled
DesiredStatus: enabled Status: ready
RemoteISCSIName: Remaining Data: 0MB
iqn.2001-05.com.equallogic:0-af1ff6- Completed Data: 0MB
01c97d1ce-64c000000bd536a9-c1localvo StartingTime: None
l.1 Keep-Failback: enabled
_______________________________________________________________________________

______________________________ Outbound-Replicas ______________________________

Group Management Commands 393


Name TimeStamp Schedule Status
---------------------------------- ------------------------ -------- ----------
C1LocalVol.1-2015-05-07-15:57:48.3 Thu May 7 15:57:48 2015 completed
2.1

partner select outbound-replicaset show


Displays a partners outbound replica sets.

Format
partner select partner_name outbound-replicaset show [-template|
-volume]

Variable
Variable Description
partner_name Partner group name

Parameters
Parameter Description
-template Displays only outbound template replica sets stored on the partner

volume Displays only outbound replica sets stored on the partner

Example
Show the replica sets outbound to a partner:

> partner select psgroup1 outbound-replicaset show


ReplicaSetName CurrReplicas Status Remaining StartingTime
--------------- ------------ ---------------- ---------- ---------------------
Vol1 2 ready 0MB None
Vol2 2 ready 0MB None
ktemp 1 ready 0MB None
newvol 1 ready 0MB None
oldvol 1 ready 0MB None
abcvol 1 ready 0MB None

partner select outbound-resume


Resumes outbound replication from the group to the selected partner.

Format
partner select partner_name outbound-resume

394 Group Management Commands


Variable
Variable Description
partner_name Partner group name

Example
Resume outbound replication to a partner:

> partner select psgroup2 outbound-resume

partner select pool-map


Manages the mapping of storage pools between primary and secondary groups.
NOTE: In the context of this command, the primary pool is the storage pool of the primary volume
on the primary group. The secondary pool is the storage pool of the replica set on the secondary
group.

Formats
partner select partner_name pool-map add|modify primary_pool_name
secondary_pool_name

partner select partner_name pool-map delete primary_pool_name

Variables
Variable Description
partner_name Name of the partner (the primary group)

primary_pool_name Name of the pool on the primary group

secondary_pool_name Name of the pool on the secondary group

Subcommands
Subcommand Description
add Maps the primary pool to the secondary pool for initial placement of the
replica set

modify Changes the mapping entry for the primary pool that is mapped to the
secondary pool for initial placement of the replica set

delete Removes the mapping entry for the primary pool

Group Management Commands 395


Examples
Change the mapping entry of a primary pool:

> partner select banc pool-map modify pool1 pool2

Remove the mapping entry for a primary pool to a secondary pool:

> partner select business pool-map delete pool3

partner select pool-space-delegated


Manages the delegated space of a storage pool on the secondary group.

Formats
partner select partner_name pool-space-delegated add|modify pool_name size

partner select partner_name pool-space-delegated delete pool_name

Variables
Variable Description
partner_name Name of the partner (the primary group)

pool_name Name of the pool that contains the delegated space

size Size of the delegated space for the specified pool, in either m, mb, g,
gb, t, or tb

Subcommands
Subcommand Description
add Creates delegated space of the specified size in a particular pool

modify Changes the size of delegated space in the specified pool

delete Removes delegated space for the partner from the specified pool

Examples
Create delegated space on a pool:

> partner select dance pool-space-delegated add pool1 100GB

Remove delegated space for the partner from a pool:

> partner select business pool-space-delegated delete pool3

396 Group Management Commands


partner select show
Displays information about a replication partner.

Format
partner select partner_name show [parameter]

Variable
Variable Description
partner_name Partner group name

Parameters
Parameter Description
failback-replicasets Shows the partners failback replica sets stored in the group:
[-template | -volume] Use -template to display only failback template replica sets stored
on the partner.
Use -volume to display only failback replica sets stored on the
partner.

inbound-replicas Shows the partners replicas stored in the group

inbound-replicasets Shows the partners replica sets stored in the group:


[-template | -volume] Use-template to display only inbound template replica sets stored
on the partner.
Use -volume to display only inbound replica sets stored on the
partner.

outbound-replicas Shows the groups replicas stored on the partner

outbound-replicasets Shows the groups replica sets stored on the partner:


[-template | -volume] Use -template to display only outbound template replica sets
stored on the partner.
Use -volume to display only outbound replica sets stored on the
partner.

Examples
Show configuration details for a specific partner:

> partner select PartnerA show


______________________________ Partner Information _____________________________
Name: PartnerA IPAddress: 192.0.2.28
Space-Received: 171.74GB Space-Received-Used: 166.05GB
Space-RecvBorrow: 150.81GB Outbound-Password: ******
OutboundDesiredStatus: enabled Description:
Space-Delegated: 150GB Space-Delegated-Used: 146.54GB
Space-Delegated-Borrow: 151.67GB Inbound-Password: ******
InboundDesiredStatus: enabled Contact:
Email: Phone:
Mobile: Pool-Delegated: default

Group Management Commands 397


FailbackReservedSpace: 142.73GB Space-Unmanaged: 0MB
NAS Replication Enabled: N Volume Replication Enabled: Y
Inbound-Expanded-Size: 411.17GB Inbound-Compressed-Size: 411.17GB
Inbound-Compression-Savings: 0MB
_______________________________________________________________________________

____________________________ Outbound-replicasets _____________________________

ReplicaSetName CurrReplicas Status Remaining StartingTime


--------------- ------------ ---------------- ---------- ---------------------
C1LocalVol 1 ready 0MB None
C2LocalVol 1 ready 0MB None
FailbackVolF 14 ready 0MB None

_____________________________ Outbound-repcolsets _____________________________

Collection NoOfRepcols Status


-------------------- --------------------- ----------

_____________________________ Inbound-replicasets _____________________________

Name ReservedSpace FreeSpace BorrowedSpace Replicas Local-Pool Remote-Pool Status


--------------- ------------- ------------- ------------- ---------- ----------- ----------- ------------
mcp-RepSetA4.1 9.93GB 0MB 10.54GB 9 default PartnerAPoo ready

l
mcp-RepSetA3.1 24.02GB 0MB 21.62GB 9 default PartnerAPoo ready

l
mcp-RepSetA1.1 104.5GB 0MB 92.51GB 6 default PartnerAPoo ready

l
A-ReplResvFree. 8.09GB 7.07GB 0MB 1 default PartnerAPoo ready
1
_____________________________ Inbound-repcolsets ______________________________

Name Inbound-replicasets Inbound-repcols


-------------------- -------------------- --------------------

____________________________ Failback-replicasets _____________________________

Name ReservedSpace FreeSpace BorrowedSpace Replicas Status


--------------- ------------- ------------- ------------- -------- ------------
FailbackVolH 63.69GB 0MB 17.4GB 10 ready

FailbackVolJ 79.04GB 0MB 9.58GB 278 ready

____________________________ Operations InProgress ____________________________

ID StartTime Progress Operation Details

-- -------------------- -------- -----------------------------------------------

_______________________________ Delegated Space _______________________________

Pool Name Space-Delegated Space-Delegated-Used


------------------------------ --------------------- ---------------------
default 150GB 146.54GB

partner select volume-replication


Enables (default) or disables volume replication.

Format
partner select partner_name volume-replication enable|disable

398 Group Management Commands


Variable
Variable Description
partner_name Partner group name

Example
Disable volume replication to a partner:

> partner select group2 volume-replication disable

partner show
Displays details about the groups replication partners.
This command displays the following details about the partners:

Name Name of the partner


Received Total partner space delegated to the group
RecvBorrow Amount of space borrowed by the group
RecvUsed Used partner space delegated to the group (not shown with the -poolinfo option)
Delegated Total group space delegated to the partner
DelegBorrow Amount of space borrowed by the partner
DelegUsed Used group space delegated to the partner
OutboundStatus Status of replication from the group to the partner (enabled or paused)
InboundStatus Status of replication from the partner to the group (enabled or paused)
Pool Pool containing the delegated space for the partner (shown with the -poolinfo option)

Format
partner show [-poolinfo]

Examples
Show details about the groups replication partner:

> partner show


Name Received RecvUsed RecvBorrow Delegated DelegUsed DelegBorrow OutboundStatus InboundStatus NASEnabled BlockEnabled
---------- -------- -------- ---------- --------- --------- ----------- -------------- -------------- ---------- ------------
b9grp 171.74GB 166.05GB 150.81GB 150GB 146.54GB 151.67GB enabled enabled N Y
PartnerA

b4grp 0MB 0MB 0MB 80.01GB 65.65GB 55.31GB enabled enabled N Y


PartnerB

Show details about the pool from which delegated space is consumed:

> partner show -poolinfo


Name Received Delegated DelegUsed DelegBorrow OutboundStatus InboundStatus NASEnabled BlockEnabled Pool
---------- -------- --------- --------- ----------- -------------- -------------- ---------- ------------ ----------
b9grp 171.74GB 150GB 146.54GB 151.67GB enabled enabled N Y default PartnerA

b4grp 0MB 80.01GB 65.65GB 55.31GB enabled enabled N Y default PartnerB

Table 4. Partner Replication Status lists possible replication status values between partners.

Group Management Commands 399


Table 4. Partner Replication Status

Status Description
authfailure Authentication between the partners failed.

NOTE: Make sure the passwords configured on the partners are


correct.

cancelling Administrator canceled the replication operation.

completed A replication operation completed over the network or, for manual
replication, the administrator on the secondary group sent a
confirmation message to the primary group.

disabled Volume replication has been manually disabled.

failed Volume replication has failed.

NOTE: Examine the event log to identify why the replication


operation failed.

farenddown The partner group cannot be reached. Make sure the partners have
network connectivity.

inprogress Volume replication is currently in progress.

manual-transfer-in- Manual replication of a volume has begun. Administrator intervention


progress might be required to complete the transfer.

partner-down Volume replication is disabled because the partner cannot be reached.

NOTE: Make sure the network connection between partners is


available.

partner-paused-inbound Partner administrator paused inbound replication.

partner-paused- Partner administrator paused outbound replication.


outbound

paused Administrator paused replication to the partner.

pause-max-snaps- Volume replication paused because the partner has reached the
reached maximum number of replicas or snapshots for a group.
To continue the replication, you must delete replicas (or snapshots) on
the partner. If a schedule is being used to create replicas, you can
decrease the maximum number of replicas to keep.

paused-remote-reserve- Volume replication was paused because the replica reserve must be
low increased. An event message will display the amount to which the
replica reserve must be increased in order for the replication to
complete.

NOTE: See volume for information about increasing the replica


reserve.

400 Group Management Commands


Status Description
paused-remote-resize- Volume size or usage increase, but the automatic replica reserve resize
failed operation on the partner failed. To increase the replica reserve for a
volume, delegated space must be available on the partner.

remote-disallow- Volume replication was paused because the partner group must be
downgrade-not-set prevented from reverting to a firmware version prior to v3.2. See
grpparams.

remote-partner-needs- Volume replication was paused because the partner is running firmware
upgrade that does not support the latest features.

stopped Replication between the partners was stopped.

waiting Volume replication data transfer has not yet started because the
maximum number of in-use replication iSCSI sessions has been
reached.

pool
Manages pools in the group. The storage in a group can be organized into one to four pools. A pool
contains the storage space on the members that belong to the pool.
A member can belong to only one pool at a time. Unless otherwise specified, a member is added to the
default pool (by default, this pool is named default). If you delete a pool, the members in the pool are
automatically moved to the default pool.

Volumes are created in the default pool, unless you specify otherwise.

You can remove a member or volume from a pool and add it to a different pool:

When you move a member from one pool to another, the remaining pool members must have
sufficient free space to store the volume data from the removed member. See member select to
move a member to a different pool.
When you move a volume to a different pool, the new pool must have sufficient free space to store
the volume data. See volume select to move a volume to a different pool.

NOTE: Pool move operations can be slow because the data movement will compete with user I/O
for computational and network bandwidth.

You can merge one pool into another pool, called the destination pool.

Only one member or volume at a time can be moved into or out of a pool, unless you are merging one
pool into another.

Format
pool subcommand

Group Management Commands 401


Subcommands
Subcommand Description
create Creates a pool

delete Deletes a pool

merge Merges one pool into another pool

rename Renames a pool

select Shows or modifies a pool or shows details about a pool

show Shows all the pools in the group

pool create
Creates a pool in the group with an optional description.

Format
pool create pool_name [description]

Variables
Variable Description
pool_name Name for the pool. Name can be up to 63 bytes and is case insensitive.
You can use any printable Unicode character except for ! " # $ % & ' ( ) *
+ , / ; < = > ?@ [ \ ] ^ _ ` { | } ~. First and last characters cannot be a
period, hyphen, or colon. Fewer characters are accepted for this field if
you enter the value as a Unicode character string, which takes up a
variable number of bytes, depending on the specific character.

description Description for the pool, up to 127 characters. Fewer characters are
accepted for this field if you enter the value as a Unicode character
string, which takes up a variable number of bytes, depending on the
specific character. If the description contains spaces, enclose it in
quotation marks.

Example
Create a pool with a description:

> pool create staffpool Pool for staff data


Pool creation succeeded.

402 Group Management Commands


pool delete
Deletes a pool from the group. The members in the pool are immediately moved to the default pool.
If the group has more than one pool, delegated space in the deleted pool (along with any replica sets) is
also moved to the default pool. Any mappings to the deleted pool are updated to point to the default
pool.

You cannot delete the default pool.

Format
pool delete pool_name

Variable
Variable Description
pool_name Name of the pool to delete

Example
Delete a pool (immediately moving the members in this pool to the default pool):

> pool delete testpool

Do you really want to delete the pool? (y/n) [n] y


Pool deletion succeeded.

pool merge
Merges one pool into another pool called the destination pool.
The group adds the members and volumes from the merged pool to the destination pool and then
deletes the empty pool.

If the group has more than one pool, delegated space in the deleted pool (along with any replica sets) is
also moved to the destination pool. Any mappings to the deleted pool are updated to point to the
destination pool.

Format
pool merge source_pool destination_pool

Variables
Variable Description
source_pool Pool to merge into the destination pool

destination_pool Destination pool to which the group adds members and volumes from
the merged pool

Group Management Commands 403


Example
Merge the members and volumes from one pool into another pool:

> pool merge staff default

In this example, merging the source pool (staff) into the destination pool (default) moves the members
and volumes from staff to default and then deletes staff..

pool rename
Renames a pool. You can rename the default pool.

Format
pool rename pool_name new_name

Variables
Variable Description
pool_name Pool to rename

new_name New name for the pool. Name can be up to 63 bytes and is case
insensitive. You can use any printable Unicode character except for ! " #
$ % & ' ( ) * + , / ; < = > ?@ [ \ ] ^ _ ` { | } ~. First and last characters
cannot be a period, hyphen, or colon. Fewer characters are accepted
for this field if you enter the value as a Unicode character string, which
takes up a variable number of bytes, depending on the specific
character.

Example
Rename a pool:

> pool rename pool2 engpool

pool select
Selects a pool for additional operations.

Format
pool select pool_name subcommand parameter

Variable
Variable Description
pool_name Pool name

404 Group Management Commands


Subcommand
Subcommand Description
show [borrow|free] Displays information about the pool:
With no options, displays comprehensive pool information.
With the borrow option, displays details about the amount of pool
space being borrowed.
With the free option, displays information about the pools free
space for borrowing or other uses.

Parameter
Parameter Description
description text Description of the pool, up to 127 characters. If the text contains
spaces, enclose it in quotation marks. To remove a pool description,
type empty quotation marks (). Fewer characters are accepted for this
field if you enter the value as a Unicode character string, which takes up
a variable number of bytes, depending on the specific character.

Examples
Show details about a pool:

> pool select default show

______________________________ Pool Information _______________________________


Name: default Description:
Default: true Data-Reduction: no-capable-hardware
TotalVolumes: 16 VolumesOnline: 16
VolumesInUse: 6 StorageContainers: 0
StorageContainerSpaceReserved: 0MB NonStorageContainerVolumes: 16
StorageContainerVolumes: 0 NonStorageContainerOnlineVolumes: 16
StorageContainerOnlineVolumes: 0 NonStorageContainerSnapshots: 50
StorageContainerSnapshots: 0 TotalSnapshots: 50
SnapshotsOnline: 0 SnapshotsInUse: 0
TotalMembers: 1 MembersOnline: 1
MembersInUse: 1 TotalCapacity: 1.82TB
VolumeReserve: 324.26GB VolumeReportedSpace: 381.09GB
SnapReservedSpace: 266.63GB SnapReservedSpaceInUse: 166.61GB
ReplicationReservedSpace: 19.01GB DelegatedSpace: 230.01GB
DelegatedSpaceInUse: 212.2GB FreeSpace: 882.68GB
FailbackSpace: 142.73GB ThinProvFreeSpace: 8.61TB
AvailableForBorrowing: 373.61GB TotalSpaceBorrowing: 456.88GB
Connections: 8 ExpandedSnapDataSize: N/A
CompressedSnapDataSize: N/A CompressionSavings: N/A
_______________________________________________________________________________

___________________________________ Members ___________________________________

Name Status Model Version Disks Capacity FreeSpace Connections


---------- ------- ------- ---------- ----- ---------- ---------- -----------
battra10 online 70-0202 V8.0.0 (R3 16 1.82TB 602.41GB 8

Group Management Commands 405


91724)

___________________________________ Volumes ___________________________________

Name Size Snapshots Status Permission Connections


--------------- ---------- --------- -------- ---------- -----------
C1LocalVol 20GB 0 online read-write 1
C2LocalVol 20GB 0 online read-write 1
C3VolE 30GB 5 online read-write 1
FailbackVolF 50GB 4 online read-write 1
C5VolG 25GB 3 online read-write 1
C7Voli 35GB 3 online read-write 1
6GB 6GB 0 online read-write 0
20GB 20GB 0 online read-write 0
30GB 30GB 0 online read-write 0
25GIG 25GB 2 online read-write 0
5GB 5GB 0 online read-write 0
Create5GB 5GB 0 online read-write 0
mcp-RecoveryVol 10GB 10 online read-write 0
A4.1
mcp-RecoveryVol 30GB 6 online read-write 0
A2.1
B2RecoveryVol.2 25GB 7 online read-write 0
B4RecoveryVol.2 45GB 10 online read-write 0

_____________________________ Storage Containers ______________________________

Name Physical Size


------------------ -------------

Remove the description for a pool:

> pool select kapool description ""

Show the borrowed space in a pool:

> pool select default show borrow

_________________________ Pool Borrowing Information __________________________


Name: default Description:
AvailableForBorrowing: 373.61GB TotalSpaceBorrowing: 456.88GB
FreeSpaceBorrowing: 328.95GB OtherSpaceBorrowing: 127.94GB
RecoverableVolBorrowing: 75.01GB SnapShotBorrowing: 146.46GB
LocalReplicaBorrowing: 28.43GB DelegatedBorrowing: 206.98GB
_______________________________________________________________________________

Show the free space in a pool:

> pool select default show free

_________________________ Pool Free Space Information _________________________


Name: default Description:
FreeSpace: 882.69GB UnusedFreeSpace: 407.29GB
FreeSpaceBorrowing: 328.95GB
_______________________________________________________________________________

406 Group Management Commands


pool show
Shows information about all the pools in a group.

Format
pool show

Example
Display all the pools in the group:

> pool show


Name Default Members Volumes Capacity FreeSpace
-------------------- ------- ------- ------- ---------- ----------
default true 1 6 2.18TB 1.54TB
syncpool false 1 2 2.18TB 2.1TB

recovery-bin
Manages recoverable volumes on the group.
For detailed information about recovering deleted volumes, see the Dell EqualLogic Group Manager
Administrator's Guide

Format
recovery-bin volume subcommand

Subcommands
Subcommand Description
disable Disables recoverable volumes

enable Enables recoverable volumes

purge volume Permanently deletes a single recoverable volume

purge-all Permanently deletes all recoverable volumes

restore volume Restores a recoverable volume

show [volume] Displays all recoverable volumes or a specific volume

Examples
Enable volume recovery on the group:

> recovery-bin volume enable

Purge (permanently delete) a volume in the recovery bin:

> recovery-bin volume purge vol24

Group Management Commands 407


Purge (permanently delete) all the volumes in the recovery bin:

> recovery-bin volume purge-all

Display all the deleted volumes in the recovery bin:

> recovery-bin volume show


__________________________ Recently Deleted Volumes __________________________
Name Size Will Be Deleted Description
----------------------------- -------- ------------------- ----------------
kvol1-2015-05-31-13:16:44.11.1 10GB 2015-06-07:13:16:44

Restore (undelete) a volume in the recovery bin:

> recovery-bin volume restore kvol1-2015-05-31-13:16:44.11.1


Volume successfully restored as "kvol1".

save-config
Saves the group configuration to a file. You can use the information in this file to restore a group in the
event of a complete group failure.

Restrictions
The save-config command does not save or allow you to restore the following information:

Volume dataYou must have backups of your data, and restore the data from backups after restoring
the group configuration.
Partner inbound or outbound passwordsYou must reenter the partner passwords to restore
replication between groups.
The groups IPsec certificate configurationThe save-config command saves the CLI commands that
were used to configure IPsec, but it does not save certificates that have been transferred to the array
using FTP. Therefore, when you restore a configuration, you must manually restore any configuration
options set using the ipsec certificate load and ipsec security-params create certificate commands.

Command Behavior
The save-config command creates a restoration file on the array, which contains the CLI commands
needed to re-create the group and its objects (such as pools and volumes). For safekeeping, use FTP or
SCP to copy the file from the array (specify the group IP address in the ftpopen or scp command) to a
host. For more information about using FTP or SCP commands to copy data off of an array, see diag.

By default, the restoration file is named config.cli, but you can specify a different name. For example, you
can name the file for the date or group on which it was created. If you have several PS Series groups, you
can give each groups file a unique name to prevent confusion.

Restoration File Contents


The restoration file contains the following information:

Group information and customization, including lists of servers and all IP security settings
Local CHAP account configuration
Member information (RAID level, pool, and network interface configuration data are saved as
comments in -grouponly mode)
Replication partner configuration (partner names, IP addresses, and delegated space settings)

408 Group Management Commands


Storage pool information
Storage container information (applies to VMware only)
Volume and volume collection configuration, including access control policies, policy groups, and
basic access points; volume collections
Schedules for snapshots and replication
Event settings
Account configuration
NAS cluster information, including appliance and controller configurations, containers (including
shares and exports), local users and groups, antivirus servers and policies, quotas, schedules, and
replication settings

Modes of Operation
The save-config command can be run in the following modes:

The default mode saves the configuration as a set of commands that you can run to restore the
configuration.
The group-only mode saves some of the information as commands and some as commented text,
which you must edit manually.

Use Cases
Whenever any group configuration information changes, run the save-config command again to create
an updated restoration file. For example, run the command again after you:

Add, remove, or rename members


Create, modify, or delete volumes or volume collections
Create, modify, or delete schedules
Add, remove, or rename replication partners
Configure (or remove) a management network on the group
Configure a NAS cluster
Create, delete, rename, or modify containers, shares, and exports
Configure NAS replication and replication schedules
Add, delete, or change antivirus server data

Format
save-config [-verbose] [-grouponly] [file_name]

Parameters
Parameter Description
-verbose Specifies verbose mode; commands saved in the file are also shown on-
screen

-grouponly Saves the member network and pool configuration as commented-out


commands in the file

Group Management Commands 409


Variable
Variable Description
file_name (Optional) Name of the file to which the group configuration will be saved,
up to 254 ASCII characters. If a file name is not specified, the default name
is config.cli. The file is overwritten each time you run the command.
Use a unique file name so that you can easily identify the restoration file for
a group.

The default path is /mgtdb/update/usr. If your file is in that directory, you


do not need to specify the path.

Otherwise, specify the path relative to the /mgtdb/update/usr directory. For


example, for a file in the /mgtdb/update directory, use ../myFile.

Examples
Save the group configuration to a specified file name:

> save-config group23.cli


configuration saved to group23.cli
You can retrieve the file using ftp or scp.

Save the group configuration to the default file name, but omit the member and pool configuration:

> save-config -grouponly


configuration saved to config.cli
You can retrieve the file using ftp or scp.

Restrictions
The following restrictions apply when restoring a group:

If the group does not have the same number of members as it had before the failure, or if the member
names have changed, manually edit the restoration file to reflect the new group configuration.
If the group members are not running the same firmware version that they were running when you
created the restoration file, the restoration might not succeed.
Before restoring a group, make sure the groups replication partners still have the group configured as
a replication partner.
If a replication between the group being restored and any partner occurred before the restoration, the
partner will have replica sets. The save-config command does not restore the relationship between
restored volumes and any preexisting replica sets on partner groups.

If the replica sets are empty (contain no actual replicas), delete the replica sets on the partner.
If the replica sets contain replicas, you can either delete them (and the replica sets) and reenable
replication from the restored volumes to the partner, or manually edit the save-config file so that
the replicated volumes are not re-created. Instead, after the group is completely restored and
running, replicate those volumes back to the restored group. This method will reestablish the
relationship between the original volumes and their replica sets on the partner.

410 Group Management Commands


Restoring a Group
1. Contact your PS Series support provider for guidance on group restoration.
2. Run the reset command on each member.
Resetting a member deletes all configuration information and all volume data from the member.
Perform this task only when requested by your PS Series support provider.
3. Run setup on each member and specify the member configuration (member name, IP address,
netmask, and default gateway) and the group configuration (group name, IP address, and
passwords).
4. If you used the -grouponly parameter to create the restoration file, set up the pools. Then, for
each member, select the pool and RAID level, and configure the network interfaces.
5. Use FTP or SCP to copy the saved restoration file to an array in the group that you are restoring (see
update). On the ftpopen or scp command line, specify the group IP address.
6. Use telnet or SSH to connect to the group IP address and log in to the group. At the CLI prompt, use
the following format to run the commands in the restoration file:
exec -echo -ignore [path/]file_name

The default path is /mgtdb/update/usr. If your file is in that directory, you do not need to specify the
path.

For example:

> exec -echo -ignore group23restore.cli


Otherwise, specify the path relative to the /mgtdb/update/usr directory. If the file is in the /mgtdb/
update directory, use ../myFile.

For example:

> exec -echo -ignore ../group23restore.cli


7. Restore the contents of the volumes from your backups.

show
Shows a summary of the group configuration or detailed information about a specific group component.

Format
show parameter | -poolinfo

Option
Option Description
-poolinfo When used by itself or following certain parameters, displays the pool
name in the output sections for members, volumes, and partners

Group Management Commands 411


Parameters
Parameter Description
account [active] Shows the group administration accounts and information about
accounts that are currently logged in to the group. The output is the
same as for the account show command.

alerts Shows the priorities for the event notification methods. The output is
the same as for the alerts show command.

audit-log [name] Shows the audit logs for the group, or for a specific account, optionally
[number number] limiting the display to a specified number of log records

chapuser Shows local CHAP accounts, including the account name, password,
and status

collections Shows the volume collections in the group. The output is the same as
for the collections show command.

grpparams Shows all the group parameters and their values. The output is the same
as for the grpparams show command.

member member_name| Shows the group members or details about a specific member. The
-poolinfo output is the same as for the member show command.
With the -poolinfo option, shows pool information for the members.

nas-cluster Shows information about the NAS cluster (if configured) for the group
[cluster_name]

partners [-poolinfo] Shows information about configured replication partners. The output is
the same as for the partner show command.
With the -poolinfo option, also shows pool information, but not the
amount of space used on the partners.

pool Shows the pools in the group and the number of members in each
pool. The output is the same as for the pool show command.

recentevents Shows event messages in the group, starting with the most recent

snapcol Shows the snapshot collections in the group. The output is the same as
for the snapcol show command.

usersessions Shows a list of accounts that are currently logged in to the group. The
output is the same as for the show accounts active and account show
active commands.

volume volume_name| Shows the volumes or details about a specific volume in the group. The
-options output is the same as for the volume show command.
See show volume for the list of options.

412 Group Management Commands


show account
Shows all the group administration accounts.
Specify the active parameter to display the accounts currently logged in to the group. For users logged
in through the GUI, the active parameter also shows the remote IP address of the user and the local IP
address (that is, the group or member IP address to which the user is connected).

Format
show account [active]

Examples
Show information about group administration accounts:

> show account


_______________________________ Local Accounts _______________________________
Name Account Type Status LastLogin
---------------- ----------------- -------- -------------------------
grpadmin group-admin enable 2015-06-14:14:06:10
autopilot-ro read-only enable None
Kris group-admin enable 2015-06-07:14:06:16
____________________ Remotely Authenticated User Accounts ____________________
Name Account Type Status Type LastLogin
---------------- ----------------- -------- -------- -------------------------

Show the users currently logged in to the group:

> show account active


Name Type StartTime Remote IP Local IP
---------------- --------- -------------------- --------------- --------------
grpadmin ssh 2015-02-15:17:14:05
grpadmin gui-ssl 2015-02-18:17:48:18 192.0.2.21 192.0.2.22

show alerts
Shows the event priorities (info, warning, error, fatal, or audit) for email and syslog notification, if
notification is enabled.

Format
show alerts

Example
Show the priorities for email and syslog notification:

> show alerts


Notification Method Priority
------------------------------ ------------------------------
Email error,fatal
SysLog warning,error,fatal,audit

Group Management Commands 413


show audit-log
Displays the contents of the audit log. You can filter the audit log by administrator user name and specify
the number of entries to be returned. The log output is in reverse chronological order, with the most
recent entries displayed first.
NOTE: The audit log is also accessible from the Monitoring section of the Group Manager GUI,
where it can also be filtered.

Format
show audit-log [account-name name number n]

Variables
Variable Description
name Administrator account name

n Number of log entries

Parameters
Parameter Description
account-name name (Optional) Filters the log output to include events for the specified
administrator account.
If you do not specify an account name, the audit log for the account
logged in to the CLI is shown. If you are logged in with a volume
administrator account, you cannot see log entries for other accounts. If
you are logged in with a pool administrator account, you can see log
entries for other accounts only if your account has group-read access.

All accounts can always view their own audit log information, and new
accounts with previously used account names will be able to view audit
records for the old account. Therefore, as a security precaution, Dell
recommends that administrator account names not be reused after
they have been deleted.

number n (Optional) Specifies the number of log entries to display

Example
Display the three most recent audit log entries for the grpadmin account:

> show audit-log account-name grpadmin number 3


AUDIT grpadmin 5-Feb-2015 18:35:11.510950 ort20 :GUI: Account
grpadmin from 192.0.2.23 to 192.0.2.53 logged out.

AUDIT grpadmin 5-Feb-2015 17:42:49.310946 ort20 :GUI: Account


grpadmin logged in from 192.0.2.23 to 192.0.2.53, using local authentication.
User privilege is group-admin.

414 Group Management Commands


AUDIT grpadmin 5-Feb-2015 17:27:45.480944 ort20 :GUI: Account
grpadmin from 192.0.2.23 to 192.0.2.53 logged out.

show chapuser
Shows the local CHAP accounts in the group that are configured for iSCSI initiator authentication.

Format
show chapuser

Example
Show the local CHAP accounts:

> show chapuser


Name Password Status Admin Account
------------------------------ ---------------- ---------- ----------------
garyCHAP GaRy978*& enable grpadmin

show collections
Shows information about the volume collections in the group.

Format
show collections

Example
Show the volume collections in the group:

> show collections


Name NoOfVolumes NoOfSnapcols
-------------------- ----------- -------------
mycollection 1 2
vc1 2 3

show-devices
Displays available, uninitialized NAS devices on the network.
For more information about NAS, see nas-cluster.

Format
show-devices

Example
Display all the available, uninitialized NAS devices on the network:

> show-devices

Product Type Service Tag Product Vendor Version

Group Management Commands 415


------------- ------------- ---------- --------- --------
nas 2L3KKQ1 FS7500 Dell V1.0.0
nas 2TC1BP1 FS7500 Dell V1.0.0
nas 2TC3BP1 FS7500 Dell V1.0.0
nas 2TD0BP1 FS7500 Dell V1.0.0
nas 2TD1BP1 FS7500 Dell V1.0.0
nas 2TF0BP1 FS7500 Dell V1.0.0
nas 2TF2BP1 FS7500 Dell V1.0.0
nas 2TH1BP1 FS7500 Dell V1.0.0
nas 2TH2BP1 FS7500 Dell V1.0.0
nas 3KLLBM1 FS7500 Dell V1.0.0
nas 4CQZFN1 FS7500 Dell V1.0.0
nas 5L3KKQ1 FS7500 Dell V1.0.0
nas 5R3KKQ1 FS7500 Dell V1.0.0
nas 5X3KKQ1 FS7500 Dell V1.0.0
nas 6L3KKQ1 FS7500 Dell V1.0.0
nas 7L3KKQ1 FS7500 Dell V1.0.0
nas 7R3KKQ1 FS7500 Dell V1.0.0
nas CBQZFN1 FS7500 Dell V1.0.0
nas FJLLBM1 FS7500 Dell V1.0.0
nas FX3KKQ1 FS7500 Dell V1.0.0
nas H9QZFN1 FS7500 Dell V1.0.0
nas HK3KKQ1 FS7500 Dell V1.0.0
nas HYCWFN1 FS7500 Dell V1.0.0
nas JJLLBM1 FS7500 Dell V1.0.0

show grpparams
Shows the group parameters and their current values.

Format
show grpparams

Example
Display the current values for all the group parameters:

> show grpparams

______________________________ Group Information _____________________________


Name: nasgrpbl13 Group-Ipaddress: 192.0.2.34
Def-Snap-Reserve: 100% Def-Snap-Warn: 10%
Def-Snap-Depletion: delete-oldest Def-Thin-Growth-Warn: 60%
Def-Thin-Growth-Max: 100% DateAndTime: Fri Jun 5 10:54:42 2015
TimeZone: America/New_York Description:
Def-Iscsi-Prefix: Def-Iscsi-Alias: yes
iqn.2002-10.com.companyA Info-Messages: enabled
Webaccess: enabled Webaccess-noencrypt: enabled
Cliaccess-SSH: enabled Cliaccess-Telnet: enabled
Email-Notify: disabled Syslog-Notify: disabled
iSNS-Server-List: Email-List:
NtpServers: 192.0.2.54 Smtp-Server-List:
DNS-Server-List: 192.0.2.44 DNS-Suffix-List: compAspark.com
Syslog-Server-List: Target-Auth-UserName:
Target-Auth-Password: hJZj2RPXrPrHjPR2
H8hJ2jBZpX8X2HPX Email-From:
Location: default Conn-Balancing: enabled
Discovery-Use-Chap: disabled Email-Contact:
Perf-balancing: enabled Disallow-Downgrades: yes
Management-Ipaddress: SSH-V1-Protocol: enabled

416 Group Management Commands


FTP-service: enabled Standby-Button: disabled
DCB: enabled Def-DCB-VLAN-Id: 2
Thermal-Shutdown: enabled Crypto-Legacy-Protocols: enabled
Volume-Recovery: enabled Session-Idle-Timeout: 30
Session-Idle-Timeout-Enable: disabled Session-Banner-Enable: disabled
Def-Snapshot-Borrow: enabled Def-Sector-Size: 512
Default-Snapshot-Sched: enabled
______________________________________________________________________________
_____________________________ Radius Information _____________________________
radius-auth-list: login-radius-auth: disabled
radius-auth-retries: 1 radius-auth-timeout: 2secs
login-radius-acct: disabled radius-acct-retries: 1
radius-acct-timeout: 2secs iscsi-radius-auth: disabled
iscsi-local-auth: enabled radius-acct-list:
login-radius-attr: enabled
______________________________________________________________________________
______________________________ Snmp Information ______________________________
read-only-comms: read-write-comms:
trap-community: SNMP-trap snmp-managers:
______________________________________________________________________________

show member
Shows the members in the group or details about a specific member. This information includes any in-
progress member operation, such as removing a member from a pool.

Format
show member [member_name | -poolinfo]

Variable
Variable Description
member_name Name of a member

Option
Option Description
-poolinfo Includes the pool information for the group members in the command
output

Examples
Show a summary of the group members:

> show member


Name Status Version Disks Capacity FreeSpace Connections
---------- ------- ---------- ----- ---------- ---------- -----------
gigan34mem online V6.0.0 14 2.62TB 2.59TB 2

Show a summary of the group members and pool information:

> show member -poolinfo


Name Status Version Disks Capacity FreeSpace Connections Pool
---------- ------- ---------- ----- ---------- ---------- ----------- -------

Group Management Commands 417


panda31 online V6.0.0 14 2.18TB 2.14TB 0 syncpool
gigan34 online V6.0.0 14 2.18TB 2.11TB 4 default

Show details about a member:

> show member mem1


_____________________________ Member Information _____________________________
Name: panda31 Status: online
TotalSpace: 2.18TB UsedSpace: 40.02GB
SnapSpace: 0MB Description:
Def-Gateway: 192.0.2.37 Serial-Number: B038889
Disks: 14 Spares: 2
Controllers: 2 CacheMode: write-back
Connections: 0 RaidStatus: ok
RaidPercentage: 0% LostBlocks: false
HealthStatus: normal LocateMember: disable
Controller-Safe: disabled Low-Battery-Safe: enabled
Version: V6.0.0 (R249640) Delay-Data-Move: disable
ChassisType: 1403 Accelerated RAID Capable: no
Pool: syncpool Raid-policy: raid50
Service Tag: Product Family: PS100
All-Disks-SED: no Language-Kit-Version: not installed
______________________________________________________________________________
____________________________ Health Status Details ___________________________
Critical conditions::
None
Warning conditions::
None
______________________________________________________________________________
____________________________ Operations InProgress ___________________________
ID StartTime Progress Operation Details
-- ----------- -------- -------- ---------------------------------------------

show nas-cluster
Shows information about the NAS cluster configured in the group (if applicable).

Format
show nas-cluster [name]

Variable
Variable Description
name (Optional) Name of a NAS cluster. The name is optional because a PS
Series group can have only one NAS cluster.

Examples
Display basic information about NAS clusters in the group:

> show nas-cluster


Name Pool Size Mgmt Address
--------------- ---------- -------------
srm-repl-1 2TB 192.0.2.26

418 Group Management Commands


Display detailed information about a NAS cluster:

> show nas-cluster srm-repl-1


___________________________ NAS Cluster Information __________________________
Name: srm-repl-1 Type: nas
IPAddress: 192.0.2.26 NASreserve: 1TB
No Of Controllers: 2 Gateway IP: 192.0.2.47
Desired Service Mode: normal Service Mode Status: normal
FTP-service: disabled NFSv4-mode: disabled
Cluster MPV: 3 TotalContainerCapacity: 642.47GB
AllocatedContainerSpace: 102GB InUseContainerSpace: 72MB
FreeContainerSpace: 101.93GB SnapSpace: 3MB
No Of Containers: 7 No Of NFS Exports: 2
No Of SMB Shares: 6 No Of Snapshots: 14
Total-DataReduction-Space-Savings: FS-Scan-Rate: normal
0MB
______________________________________________________________________________
____________________________ Cluster-Wide Defaults ___________________________
Space-Warn: 80% Def-Snap-Reserve: 50%
Def-Snap-Warn: 80% File-Permission: 744
Dir-Permission: 755 File-Access-Security: ntfs
SMB-Guest-Access: N SMB-Antivirus: enable
SMB-FileExtensions: SMB-ExcludeDirPaths:
NFS-Permission: read-write NFS-Trusted-Users: all-except-root
______________________________________________________________________________
____________________ Cluster-Wide Data Reduction Defaults ____________________
Compression: enabled Access-Time-Filter: 30 days
Modify-Time-Filter: 30 days
______________________________________________________________________________

show partners
Shows information about the groups replication partners.
This command displays the following information:

Name Name of the partner group


Received Total partner space delegated to the group
RecvUsed Used partner space delegated to the group (not shown with the -poolinfo option)
Delegated Total group space delegated to the partner (applies only to volume replication)
DelegUsed Used group space delegated to the partner
OutboundStatus Status of replication from the group to the partner (enabled or paused)
InboundStatus Status of replication from the partner to the group (enabled or paused)
NASEnabled Indicates whether the partner is configured for NAS replication
BlockEnabled Indicates whether the partner is configured for volume replication

Format
show partners [-poolinfo]

Example
Display the partners for the group (the output wraps onto subsequent lines of the display):

> show partners


Name Received RecvUsed Delegated DelegUsed OutboundStatus InboundStatus NASEnabled BlockEnabled
---------- -------- -------- --------- --------- -------------- -------------- ---------- ------------

Group Management Commands 419


spark8 100GB 4.04GB 100GB 4.45GB enabled enabled Y Y
rctest 100GB 4.8GB 100GB 2.02GB enabled enabled Y Y

show pool
Shows information about the pools in the group.

Format
show pool

Example
Show information about the pools in the group:

> show pool


Name Default Members Volumes Capacity FreeSpace
-------------------- ------- ------- ------- ---------- ----------
default true 1 6 2.18TB 1.54TB
syncpool false 1 2 2.18TB 2.1TB

show recentevents
Shows event messages in the group, starting with the most recent.
When an event occurs (such as the creation of a volume or the removal of a power supply), a message is
sent. These messages help you monitor normal operations, and identify and correct problems before
they disrupt operations.

The show recentevents command shows one screen of information at a time, unless paging has been
turned off with the cli-settings paging off command. If paging has been turned off, the command shows
all events.

Each event has a priority. See alerts for a list of event priorities and descriptions.

Each event message includes the following information:

Group member that reported the event


Date and time of the event, in the format mm/dd/yy hh:mm:ss
Event priority level
Message text

Format
show recentevents

Example
Show event messages for the group, starting with the most recent:

> show recentevents


170:61:member2:SP:30-Jun-2015 20:08:29.320062:verify.c:338:INFO:14.2.14:0:
Parity verification completed on RAID LUN 0 after 16385 seconds.
.
.
.

420 Group Management Commands


312:189:member1:MgmtExec: 1-May-2015 00:00:00.230190:SnapColSchedule.cc:
950:WARNING:8.3.11:
Replica collection schedule 'coll1-sched' failed to create a replica collection.
.
.
.
58:52:member1:SP: 4-Apr-2015
13:32:56.470053:emm.c:1371:WARNING:28.3.51:
Warning health conditions currently exist. Investigate these conditions before
they affect array operation.
Control modules are initializing. Control module failover cannot occur until
the initialization completes.
There are 1 outstanding health conditions. Investigate these conditions before
they affect array operation.
.
.
.
4:2:member2:SP:30-Mar-2015 13:11:09.170003:emm.c:920:ERROR:28.4.50:
Control module in slot 1 is not functioning or not installed.

See Also
For more information about group and NAS cluster events, see the Dell EqualLogic Events Guide.

show snapcol
Shows information about the snapshot collections in the group.

Format
show snapcol [custom]

Examples
Display all snapshot collections in the group:

> show snapcol


Name Snapshots Collection Schedule
------------------------------ ---------------- ------------ ------------
test-2015-05-23-15:18:36.9279 1/1
custcoll-2015-06-06-11:00:43.9 2/2 custcoll
280
mycoll-2015-06-06-11:00:58.928 1/1 mycoll
1

Display all custom snapshot collections in the group:

> show snapcol custom


Name Snapshots Collection Schedule
------------------------------ ---------------- ------------ ------------
test-2015-05-23-15:18:36.9279 1/1

Group Management Commands 421


show usersessions
Shows information about the administration accounts that are currently logged in to the group.
For users logged in through the GUI, the following information is shown:

Type Users method of connection (console or GUI-SSL)


Start time Time that the user logged in
Remote IP address IP address of the users system
Local IP address Group or member IP address to which the user is connected

Format
show usersessions

Example
Show the accounts that are currently logged in to the group:

> show usersessions


Name Type StartTime Remote IP Local IP
---------------- --------- -------------------- --------------- --------------
grpadmin gui-ssl 2015-06-11:14:57:42 192.0.2.24 192.0.2.34
buzz console 2015-06-11:15:03:02 not available not available
crest ssh 2015-06-11:15:08:02 192.0.2.25 192.0.2.35
sparks telnet 2015-06-11:15:10:50 192.0.2.26 not available
home telnet 2015-06-11:15:11:46 192.0.2.27 not available

show volume
Shows the group volumes or information about a specific volume. This information includes replication
partners (if replication is enabled), basic access points, and in-progress operations for the volume (for
example, replication, bind, or pool move operations).
You can also display pool information for all the volumes, restrict the output to show only template
volumes, or exclude template volumes from the output.

Format
show volume [volume_name] | [-poolinfo|-template|-volume]

Variable
Variable Description
volume_name Name of a volume

422 Group Management Commands


Options
Option Description
-poolinfo Includes the pool information for the group volumes in the command
output

-template Displays all template volumes in the group

-volume Displays all volumes except template volumes in the group

Examples
Show all the volumes in the group and their status, including whether the volume has thin provisioning
enabled (in the column labeled T):

> show volume


Name Size Snapshots Status Permission Connections T
--------------- ---------- --------- ------- ---------- ----------- -
kris 100MB 0 online read-write 0 N
bigvol 102400MB 0 online read-write 0 N
ABVol1 1024MB 0 online read-write 0 N
ABVol2 1024MB 0 online read-write 0 N
CDag01 5120MB 1 online read-only 0 Y
CDag02 10MB 1 online read-only 0 Y

Show pool information (instead of permissions) for all volumes:

> show volume -poolinfo


Name Size Snapshots Status Connections Pool T
--------------- ---------- --------- ------- ----------- ---------- -
kris 100MB 0 online 0 default N
bigvol 102400MB 0 online 0 default N
ABVol1 1024MB 0 online 0 default N
ABVol2 1024MB 0 online 0 default N
CDag01 5120MB 1 online 0 default Y
CDag02 10MB 1 online 0 default Y

Show only the template volumes in a group:

> show volume -template


Name Size Snapshots Status Permission Connections T
--------------- ---------- --------- ------- ---------- ----------- -
CDag02 10MB 1 online read-only 0 Y

Show all volumes except the template volumes in a group:

> show volume -volume


Name Size Snapshots Status Permission Connections T
--------------- ---------- --------- ------- ---------- ----------- -
kris 100MB 0 online read-write 0 N
bigvol 102400MB 0 online read-write 0 N
ABVol1 1024MB 0 online read-write 0 N
ABVol2 1024MB 0 online read-write 0 N
CDag01 5120MB 1 online read-only 0 Y

Show detailed information about a volume:

> show volume CDag01

Group Management Commands 423


snapcol
Creates and manages the snapshot collections in a group.
A snapshot collection contains snapshots of multiple volumes. A snapshot collection is created each time
you create snapshots of the volumes in a volume collection. A custom snapshot collection is created
when you create a snapshot of two or more individual volumes at the same time.

To restore data, you can restore or clone an individual snapshot in a collection.

Format
snapcol subcommand

Subcommands
Subcommand Description
create Creates a snapshot collection

delete Deletes a snapshot collection and all the snapshots in the collection

rename Renames a snapshot collection

select Selects a snapshot collection for additional operations

show Shows all snapshot collections or all custom snapshot collections

snapcol create
Creates a collection of simultaneous snapshots of the volumes in a volume collection, or volumes that
you specify individually.

Format
snapcol create {collection_name|volume_name} [snapcol_name] [description text]

Variables
Variable Description
collection_name Name of a volume collection. Name can be up to 63 bytes and is case
insensitive. You can use any printable Unicode character except for ! " #
$ % & ' ( ) * + , / ; < = > ?@ [ \ ] ^ _ ` { | } ~. First and last characters
cannot be a period, hyphen, or colon. Fewer characters are accepted
for this field if you enter the value as a Unicode character string, which
takes up a variable number of bytes, depending on the specific
character.

volume_name One or more volume names, separated by commas and no spaces

424 Group Management Commands


Variable Description
snapcol_name Name of the snapshot collection, up to 63 ASCII characters. Both
automatic names and user-defined names are appended with a
timestamp, which is not part of the length limit.

Parameter
Parameter Description
description text Description of a snapshot collection, up to 127 characters. Fewer
characters are accepted for this field if you enter the value as a Unicode
character string, which takes up a variable number of bytes, depending
on the specific character.
If the text contains spaces, enclose it in quotation marks.

Examples
Create a snapshot collection from a volume collection that contains two volumes:

> snapcol create coll23 sc23monday description Database Snaps


Snapshot creation succeeded.

The actual snapshot collection name will have a timestamp appended (for example,
sc23monday-2015-06-15-13:28:54.49). If the name with the timestamp is longer than 30 characters,
the name wraps in the output of the snapcol show command.

The timestamp portion of the name is always 23 characters long, and includes the leading hyphen, year,
month, day, and hour (separated by hyphens), then the minute and second (separated by colons), a
period, and an incremental number. Seven (7) characters remain available on the output line for the user-
defined part of the name.

Create a snapshot collection from the specified volumes (the snapshot collection name is created
automatically):

> snapcol create vol1,vol2,vol3


Snapshot collection creation succeeded.

For this example, the snapshot collection name is snapcol followed by a hyphen and the timestamp. For
example: snapcol-2015-05-01-09:36:42.149

snapcol delete
Deletes a snapshot collection and all the snapshots in the collection.

Format
snapcol delete snapshot_collection

Group Management Commands 425


Variable
Variable Description
snapshot_collection Name of a snapshot collection

Example
Delete a specified snapshot collection:

> snapcol delete scwednesday-2015-06-18-14:27:46.27

Do you really want to delete the snapshot collection? (y/n) [n] y


Snapshot collection deletion succeeded.

snapcol rename
Renames a snapshot collection. The new name is not automatically appended with a timestamp.

Format
snapcol rename current_name new_name

Variables
Variable Description
current_name Current name of a snapshot collection

new_name New snapshot collection name, up to 63 ASCII characters.

NOTE: Names are not case sensitive. For example, snap-01 and
SNAP-01 are the same.

Example
Rename a snapshot collection:

> snapcol rename snapcol-2015-06-18-14:27:46.27 June18

snapcol select
Selects a snapshot collection for additional operations.

Format
snapcol select snapcol_name [description text]|show

426 Group Management Commands


Variable
Variable Description
snapcol_name Name of a snapshot collection

Parameter
Parameter Description
description text Description for the snapshot collection, up to 127 characters. Fewer
characters are accepted for this field if you enter the value as a Unicode
character string, which takes up a variable number of bytes, depending
on the specific character.
If the text contains spaces, enclose it in quotation marks. To remove a
description, enter empty quotation marks ().

Example
> snapcol select staff2-2015-03-09-14:52:16.52 show

snapcol show
Shows all snapshot collections or all custom snapshot collections in the group.

Format
snapcol show [custom]

Examples
Show the snapshot collections in the group:

> snapcol show

Show the custom snapshot collections in the group:

> snapcol show custom

storage-container
Manages storage containers on the group.

Format
storage-container subcommand

Group Management Commands 427


Subcommands
Subcommand Description
create Creates a storage container

delete Deletes a storage container

rename Renames a storage container

select Modifies the values of a storage container

show Shows the properties of existing storage containers

storage-container create
Creates a storage container.

Format
storage-container create container_name parameters

Variables
Variable Description
container_name Name of a new storage container, up to 42 characters. The container
name is not case-sensitive.

Parameters
Parameter Description
description text Description for the storage container, up to 127 characters. If the text
contains spaces, enclose it in quotation marks.

pool pool_name Identifies the pool on the group where the storage container will be
placed

physical-size size Specifies the physical size for the storage container. The size is in
megabytes unless you specify otherwise. You can specify the size with
any of the following suffixes: m, mb, MB, g, gb, or GB, t, tb, or TB.
Because of rounding algorithms, the groups actual capacity might be
less than the capacity shown in the CLI or GUI. If you try to create a
storage container larger than the available space on the group, the
command fails, and an error message shows the actual amount of
available space.

logical-size size Specifies the logical size for the storage container.

NOTE: Dell recommends setting the logical size to 0 (zero), which


indicates unlimited.

428 Group Management Commands


Example
Create a storage container in a pool, and specify a description, physical size, and logical size for the
container:

> storage-container create pcontainer description "production pool container"


pool default physical-size 1tb logical-size 0

storage-container delete
Deletes a storage container.

Format
storage-container delete container_name

Variable
Variable Description
container_name Name of the storage container

Example
Delete a storage container:

> storage container delete pcontainer

storage-container rename
Renames a storage container.

Format
storage-container rename container_name new_name

Variables
Variable Description
container_name Current name of the storage container

new_name New name for the storage container

Example
Rename a storage container:

> storage-container rename production1 production2

Group Management Commands 429


storage-container select
Modifies the values of a storage container.

Format
storage-container select container_name [description text]
[free-warn-threshold threshold] [pool select pool_name physical-size size] |
show

Variable
Variable Description
container_name Name of a storage container

Parameters
Parameter Description
description text Description for the storage container, up to 127 characters. If the text
contains spaces, enclose it in quotation marks.

free-warn-threshold Specifies the value of the threshold for a warning about free space
threshold% available.
You must include the percent sign (%).

pool select pool_name Specifies a pool for the storage container

physical-size size Specifies the physical size for the storage container. The size is in
megabytes unless you specify otherwise. You can specify the size with
any of the following suffixes: m, mb, MB, g, gb, or GB, t, tb, or TB.
Because of rounding algorithms, the groups actual capacity might be
less than the capacity shown in the CLI or GUI. If you try to create a
volume larger than the available space on the group, the command
fails, and an error message shows the actual amount of available space.

show Displays the values that are set for the storage container

Examples
Set the physical size for a storage container:

> storage-container select Mcon pool select default physical-size 2t

Set the free-warn-threshold for a storage container:

> storage-container select Mcon free-warn-threshold 50%

430 Group Management Commands


Display information about a storage container:

> storage-container select Mcon show


________________________ Storage Container Information ________________________
name: Mcon UUID:
Description: 6090a0b8-8046-a979-ef40-b5a303009054
Logical Size: unlimited Logical Used: 0MB
Logical Free: unlimited Aggr Physical Size: 2TB
Aggr Physical Used: 0MB Aggr Physical Free: 2TB
Volumes: 0 Snapshots: 0
VolumesOnline: 0
_______________________________________________________________________________
_____________________ Storage Container Pool Information ______________________
Pool Name: default Physical Size: 2TB
Physical Used: 0MB Physical Free: 2TB
Free Space Warn Percentage: 50% Volumes: 0
Snapshots: 0 VolumesOnline: 0
_______________________________________________________________________________

storage-container show
Shows the properties of existing storage containers.

Format
storage-container show

Example
Display the properties of all storage containers:

> storage-container show


Name Logical Size Pool Physical Size
--------- ------------ --------- -------------
j-sc3 unlimited default 1TB
j-sc2 unlimited default 1TB
p-sc1 unlimited default 5TB

tag
Manages tags for volumes.

Format
tag subcommand

Subcommands
Subcommand Description
create Creates a new tag

delete Deletes a tag and all of its uses

rename Renames an existing tag

Group Management Commands 431


Subcommand Description
select Selects a tag for additional operations

show Displays tag names and values

tag create
Creates a new tag. The tag value is optional; if not provided, the tag will be a simple tag.

Format
tag create tag_name[=tag_value]

Variable
Variable Description
tag_name[=tag_value] Name of the tag and the value of the tag that you want to create. If you
do not specify a value, the tag becomes a simple tag.

Example
Create a new name for a tag:

> tag create test=tag

tag delete
Deletes the tag and all uses of the tag.

Format
tag delete tag_name

Variable
Variable Description
tag_name Name of the tag that you want to delete

Example
Delete an existing tag:

> tag delete test

Deleting this tag type will unassign it from any volumes as well as delete all
tag values for this tag type. Do you still want to delete it? (y/n) y

432 Group Management Commands


tag rename
Specifies a new name for an existing tag.

Format
tag rename tag_name new_name

Variables
Variable Description
tag_name Name of the current tag that you want to rename

new_name New name for the current tag

Example
Rename an existing tag:

> tag rename test tagtest

tag select show


Displays the data for the selected tag, including the associated volumes.

Format
tag select tag_name show

Variable
Variable Description
tag_name Name of the tag

Example
Display information about a tag:

> tag select tagtest show

_______________________________ Tag Information _______________________________


Name: tagtest
_______________________________________________________________________________

_________________________________ Tag Values __________________________________

Tag Value Uses


----------------- --------
0

Group Management Commands 433


tag 1

_________________________ Tag To Volume Associations __________________________

Volume Name Tag Value


--------------- -----------
Rtestvol tag

tag select value add


Adds a new value for a tag.

Format
tag select tag_name value add tag_value

NOTE: A simple tag can be converted to a tag with values only if the simple tag is not assigned to
any volume.

Variables
Variables Description
tag_name Name of the selected tag

tag_value Name of the new tag value

Example
Add a new value for a tag:

> tag select tagtest value add value1

tag select value delete


Deletes a tag value from the selected tag.

Format
tag select tag_name value delete tag_value

Variables
Variables Description
tag_name Name of the selected tag

tag_value Name of the tag value

434 Group Management Commands


Example
Delete a value associated to a tag:

> tag select tagtest value delete value1

Deleting this tag value will unassign it from any volumes. Do you still want to
delete it? (y/n) y

tag select value rename


Renames a tag value.

Format
tag select tag_name value rename tag_value new_tag_value

Variables
Variables Description
tag_name Name of the selected tag

tag_value Name of the current tag value

new_tag_value Name of the new tag value

Example
Rename a tag:

> tag select tagtest value rename tag value1

tag show
Displays all tag names and values that can be filtered using a combination of comma-delimited pairs.

Format
tag show [tag_name_1=tag_value_1, tag_value_2,...>; <tag_name_2=tag_value_1,
tag_value_2,...]

Variable
Variable Description
tag_name[=tag_value] Tag name and optional value that you want to show

Group Management Commands 435


Example
Display the tag names:

> tag show tagtest=tag1;Applications=Database-Server;

Desktops;
Tag Name Tag Value Uses
------------------------- ----------------- --------
Applications Database-Server 0
Desktops 0
tagtest tag1 1

unix-groups search
Searches in the defined UNIX group for the specified search string.

Format
unix-groups search search_string

Variable
Variable Description
search_string Searches for users in the Active Directory database that match the terms
in the search string

Example
> unix-groups search a

Name Type Source


---------------------------------------- -------- --------
<eqlnas12.com>+admin2 Unix External
<eqlnas12.com>+adminit Unix External
<eqlnas12.com>+admindev Unix External
<eqlnas12.com>+adminldap Unix External
<eqlnas12.com>+administration Unix External

volume
Manages the volumes in a group.

Format
volume subcommand

436 Group Management Commands


Subcommands
Subcommand Description
create Creates a volume

delete Deletes a volume

rename Renames a volume

select Selects a volume for additional operations

show Shows all group volumes or detailed information about a specific


volume

volume create
Creates a volume in the group.
You must specify the volume name and the reported volume size. All other attributes are set from the
groupwide defaults, unless otherwise specified.

The reported volume size is seen by iSCSI initiators. The volume reserve is the actual amount of space
allocated to the volume. Snapshot reserve is based on a percentage of the volume reserve.

NOTE: The actual amount of volume space is rounded up to the nearest multiple of 15MB.

You can also optionally enable thin provisioning on the volume. Thin provisioning can provide you with a
more efficient method of allocating storage space to users. However, it should be used only in
environments with administrators who can closely monitor disk space usage. When you enable thin
provisioning on a volume, you can change the default minimum and maximum volume reserve values, in
addition to the in-use space warning threshold. See the Dell EqualLogic Group Manager Administrator's
Guide for more information about thin-provisioned volumes.

When you create a volume, the group creates an iSCSI target name. iSCSI initiators use this name to
access the volume through TCP/IP port 3260 (the standard iSCSI port). The iSCSI target name starts with
the iSCSI target prefix (iqn.2002-10.com.companyA), followed by a string, followed by the volume
name.

The following example shows an iSCSI target name for a volume:

iqn.2002-10.com.companyA:6-4b0200-062460afe-13000011cd5c1-dbvol

Format
volume create volume_name size [parameter...]

Variables
Variable Description
volume_name Volume name is unique in the group. Name can be up to 63 bytes and is
case insensitive. You can use any printable Unicode character except

Group Management Commands 437


Variable Description
for ! " # $ % & ' ( ) * + , / ; < = > ?@ [ \ ] ^ _ ` { | } ~. First and last
characters cannot be a period, hyphen, or colon. Fewer characters are
accepted for this field if you enter the value as a Unicode character
string, which takes up a variable number of bytes, depending on the
specific character.
Access to a volume is always through the iSCSI target name, not
through the volume name.

size Reported volume size (seen by initiators). Volume size is in megabytes


unless you specify otherwise. You can specify the size with any of the
following suffixes: m, mb, MB, g, gb, or GB.
Because of rounding algorithms, the groups actual capacity might be
less than the capacity shown in the CLI or GUI. If you try to create a
volume larger than the available space on the group, the command
fails, and an error message shows the actual amount of available space.

Parameters
Parameter Description
description text Description for the volume, up to 127 characters. Fewer characters are
accepted for this field if you enter the value as a Unicode character
string, which takes up a variable number of bytes, depending on the
specific character. If the text contains spaces, enclose it in quotation
marks.

read-write|read-only Volume permission (default is read-write)

online|offline Volume status (default is online)

iscsi-alias alias iSCSI target alias, up to 63 ASCII characters, for the volume. Some iSCSI
initiators can see the alias.
The default alias is the groupwide setting (see grpparams def-iscsi-
alias).

unrestricted (Not recommended) Grants unrestricted host access to the volume and
its snapshots.
Dell recommends that, instead, you create basic access points to limit
host access.

See volume select access create.

snap-reserve n% Amount of space, as a percentage of the volume reserve, for snapshots.


You must include the percent sign (%).

The default amount is the groupwide setting (see grpparams def-snap-


reserve).

438 Group Management Commands


Parameter Description
snap-warn n% Threshold at which an alarm occurs because the amount of free space
reserved for snapshots has fallen below this value, as a percentage of
the snapshot reserve. You must include the percent sign (%).
The default threshold is the groupwide setting (see grpparams def-
snap-warn).

snap-depletion action Specifies the default snapshot space recovery policy. Either:
delete-oldest (default) Deletes the oldest snapshot
volume-offline Sets the volume and its snapshots offline

The default policy is the groupwide setting (see grpparams def-snap-


depletion).

bind member Binds the new volume to the specified member. Volume data is
restricted to this member.
Binding a volume to a member overrides any RAID preference and
automatically performs load balancing for the volume.

pool pool_name Pool in which the volume data will reside. The default is the default
pool.

thin-provision Enables thin provisioning on the volume

thin-min-reserve n% Minimum volume reserve (default is 10% of the reported volume size)
for a thin-provisioned volume. This percentage is the amount of
immediately writeable, guaranteed space reserved for the volume.

thin-growth-warn n% (Applies to thin-provisioned volumes only) When the amount of in-use


space reaches this value, as a percentage of the reported volume size, a
warning alarm and event message occur.
The default limit is the groupwide setting (see grpparams def-thin-
growth-warn).

thin-growth-max n% When in-use space for a thin-provisioned volume reaches this limit, as a
percentage of the reported volume size:
If the maximum in-use space value is less than 100% and an initiator
write will exceed this limit, the write fails, and the group sets the
volume offline and generates event messages.
If the maximum in-use space value is 100% and an initiator write will
exceed this limit, the volume is not set offline. However, the write
fails and the group generates event messages.

The default limit is the groupwide setting (see grpparams def-thin-


growth-max).

thin-warn-soft- Specifies whether to send a warning when the volume passes the in-use
threshold enable| warning threshold
disable

thin-warn-hard- Specifies whether the volume will remain online after it reashes the
threshold enable| thin-growth-max threshold
disable

Group Management Commands 439


Parameter Description
sector-size Specifies the volume sector size: either 512 (bytes; the default) or 4096
(4KB). If specified, overrides the groupwide default sector size (see
grpparams def-sector-size). Otherwise, the groupwide default applies, if
set.

Examples
Create a volume in a pool:

> volume create dbvol 100GB pool perf1

Volume creation succeeded.


iSCSI target name is iqn.2002-10.com.companyA:6-4b0200-062460afe-13000011cd5c1-
dbvol

This example shows the error that is displayed when you try to create a volume that is larger than the free
space in the default pool. The error message shows the actual amount of free pool space.

> volume create total 3.05GB snap-reserve 0%

% Error - Available space is less than requested


Available Group space= 3120MB
Requested Volume size= 3123MB Requested Reserved Space= 0MB

This example shows the error that is displayed when you try to create a volume in a pool that has enough
space for the volume, but not enough space for the specified snapshot reserve:

> volume create hugevol 1200gb snap-reserve 200%

% Error - Available space is less than requested


Available Group space = 1690785MB
Requested Volume size = 1228800MB Requested Reserved Space = 2457600MB

Create a thin-provisioned volume with the specified thresholds:

> volume create vol-thin1 200GB thin-provision thin-min-reserve 20% thin-growth-


warn 75% thin-growth-max 85%

Volume creation succeeded.


iSCSI target name is iqn.2002-10.com.companyA:0-8a0906-5041d1a02-
61cffd39bde46374-vol-thin1

volume delete
Deletes a volume, which returns free space to the group.
Deleting a volume also deletes all its snapshots (if any). If a template volume has thin clones associated
with it, you must first delete the thin clones before you can delete the template volume.

Deleting a volume moves the volume but not its snapshots to the groups recovery bin, if the
recovery bin feature is enabled. Deleted volumes are subject to permanent deletion after 1 (one) week if
they are not restored.

The volume must be offline before you can delete it. Either set it offline or make sure that it is.

440 Group Management Commands


NOTE: If you cannot delete the volume because a member containing some of its data is offline, set
the member online, if possible, and then try again to delete the volume.

Format
volume delete volume_name

Variable
Variable Description
volume_name Name of a volume

Example
Delete a volume (and all its snapshots):

> volume delete tempvol

One of the following messages is displayed, depending on whether or not the recovery bin feature is
enabled.

Without the recovery bin feature:


Deleting this volume will cause all volume data to be lost.
The volume will NOT be placed in the recovery bin.
All 100GB (70GB in use) of data will be lost.
Do you want this volume's data to be permanently deleted? (y/n) [n]
With the recovery bin feature:
Deleting this volume will move all volume data to the recovery bin.
Snapshots for this volume will NOT be preserved in the recovery bin.
Recovery is not guaranteed, putting 20GB (150MB in use) of data at risk.
Do you want this volume's data to be at risk of permanent loss? (y/n) [n]

volume rename
Renames a volume.
The iSCSI target name does not change if you rename the volume, so no host modifications are needed.
However, if the iSCSI target alias for the volume is set to the volume name, the alias will change to match
the new volume name.

Format
volume rename volume_name new_name

Variables
Variable Description
volume_name Current name of a volume

new_name New name for the volume. Name can be up to 63 bytes and is case
insensitive. You can use any printable Unicode character except for ! " #

Group Management Commands 441


Variable Description
$ % & ' ( ) * + , / ; < = > ?@ [ \ ] ^ _ ` { | } ~. First and last characters
cannot be a period, hyphen, or colon. Fewer characters are accepted
for this field if you enter the value as a Unicode character string, which
takes up a variable number of bytes, depending on the specific
character.

Example
Rename a volume:

> volume rename staffvol vol2

volume select
Selects a volume for additional operations.
NOTE: You can perform only the following operations on a NAS volume:

Change the name or description


Bind and unbind the NAS volume to a member
Set or change a RAID preference

Format
volume select volume_name subcommand | parameters

Variable
Variable Description
volume_name Name of a volume

Subcommands
Subcommand Description
access Manages basic access points for the volume

assign admin_name Assigns the volume to the specified volume administrator. A volume
cannot be assigned to more than one volume administrator.

bind member Binds the volume to the specified member. Volume data will be
restricted to this member.

NOTE: Binding volumes is not recommended. Binding a volume to


a member overrides any RAID preference for the volume, and
defeats the groups automatic performance load-balancing
functionality.
If a template volume has thin clones associated with it, all the thin
clones are bound to the same member as the template volume. You

442 Group Management Commands


Subcommand Description
cannot bind volumes for which synchronous replication (SyncRep) is
enabled.

cancel-operation op_id Cancels an in-progress operation for the volume. For example, you can
cancel an in-progress replication, bind, or pool move operation.
Use the volume select show command to obtain the operations ID
number.

clone Clones the volume, which creates a new volume

convert-to template| Converts a standard volume to a template volume or converts a


volume template volume to a standard volume

create-thin-clone name Creates a thin clone volume with the specified name from the selected
template volume

delete-failback Makes an inbound replica set promotion permanent. (Used only with a
new_volume recovery volume, which is created by promoting an inbound replica
set.)
The resulting volume will no longer be flagged as a recovery volume
and cannot be demoted to the original inbound replica set.

detach-thin-clone Detaches the selected thin clone from its template volume

replicate-to-primary Performs one of the following operations to replicate a recovery


option volume (on a secondary group) to the primary group: start
[manual-replica], stop, show, or retry.
Not applicable for a recovery template volume.

replication Manages volume replication and promotion

schedule Manages snapshot and replication schedules for the volume.


Not applicable for a template volume.

show Shows details about the volume or iSCSI connections to the volume

shrink [no-snap] Decreases the volume to the specified size. Size is in megabytes unless
[no-adjust-snap- you specify otherwise. You can specify size with any of the following
resv] size
suffixes: m, mb, MB, g, gb, or GB.
See volume.

size [no-snap] size Increases the (reported) volume size. Size is in megabytes unless you
specify otherwise. You can specify size with any of the following
suffixes: m, mb, MB, g, gb, or GB.
The new size will not be recognized by hosts currently connected to
the volume unless they support container expansion. Before increasing
the volume size, understand the possible effect on the operating
system, container, or application using the volume, and set the volume
offline first if necessary for your environment.

Group Management Commands 443


Subcommand Description
Some operating systems cannot support volumes larger than 2TB. A
warning message is shown when you try to increase a volume beyond
2TB. Make sure your operating system will recognize the new, larger
size.

See volume.

snapshot Manages volume snapshots or restores the volume from a snapshot

sync-rep Configures volume replication with another pool in the group

unassign Unassigns the volume from its volume administrator. The volume can
now be managed by any administrator with management privilege for
the group or the pool that contains the volume.

Parameters
Parameter Description
description text Description for the volume, up to 127 characters. Fewer characters are
accepted for this field if you enter the value as a Unicode character
string, which takes up a variable number of bytes, depending on the
specific character.
If the text variable contains spaces, surround it with quotation marks. To
remove a description, enter two quotation marks ().

iscsi-alias alias iSCSI target alias for the volume, up to 63 alphanumeric characters.
Some iSCSI initiators can see the alias

isns-discovery enable| Enables or disables (default) automatic discovery by iSNS servers.


disable
By default, iSNS servers cannot discover iSCSI targets in a group. To
allow discovery by iSNS servers, you must enable this functionality on a
volume.

lost-blocks action Default policy when a volume has lost cache blocks:
return-error Sets the volume online, but keeps the lost cached
block state. If an application tries to read a lost block, an error will
occur. If the block is rewritten, no error will occur, and the volume
status will be changed to online-lost-cached-blocks.
mark-valid Sets the volume online and marks the lost cached
blocks as valid. This action might present a security risk, and the
blocks might contain old data.

NOTE: Lost cached blocks can occur if a power failure lasts longer
than 72 hours.

multihost-access Enables or disables multihost access to a volume. Used primarily in


enable|disable cluster environments, or for servers that run multiple initiators and can
safely manage simultaneous connections to a volume.

offline|online Sets a volume offline or online

444 Group Management Commands


Parameter Description
pool Pool in which the volume data will be located.
Moving a volume across pools can be a lengthy operation because all
the volume data must be moved from the members in the current pool
to the members in the new pool. The data movement will compete with
user I/O for computational and network bandwidth.

If a template volume has thin clones associated with it, all the thin
clones move to the target pool with the template volume.

A recovery volume can be moved to a pool containing delegated space


for the primary partner as long as enough delegated space is available
to fit the volume.

pref-raid-policy RAID policy preference for the volume data. The group will try to place
policy the volume data on a pool member with the specified RAID policy.
Policy options include:
raid5
raid6 raid6-accelerated
raid10
raid50
none (default; allows the group to identify the optimal RAID policy
for the volume data)

NOTE: Volume clones do not inherit the RAID preference policy of


the parent volume. They are set to none by default.

read-only|read-write Sets the volume permission to read-only or read-write (default). (To


make a volume read-only, you must first set it offline.)

NOTE: You cannot set template volumes to read-write.

snap-borrowing enable| Enables or disables snapshot borrowing for the volume. This option
disable allows or prevents the volume from borrowing from free pool space to
create snapshots if the volume does not have enough snapshot reserve.

snap-depletion action Specifies the default snapshot space recovery policy, either delete-
oldest (default; deletes the oldest snapshots until enough space is
recovered) or volume-offline (sets the volume and its snapshots
offline)

snap-reserve n% Space reserved for snapshots as a percentage of volume reserve. You


must include the percent sign (for example, 150%).

snap-warn n% Threshold at which an alarm occurs because the amount of free space
reserved for snapshots has fallen below the specified value, as a
percentage of the total reserved snapshot space. You must include the
percent sign (for example, 20%).

NOTE: To effectively disable this warning, set the snap-warn


threshold to zero (0%). No alerts will be sent when the free
snapshot space falls below the reserved snapshot space.

Group Management Commands 445


Parameter Description
thin-provision Disables or enables thin provisioning on a volume.
disable|enable
[options] NOTE: You cannot disable thin provisioning on a template volume.

When you disable thin provisioning on a volume, the volume reserve


increases to the volumes reported size.

For example, if you disable thin provisioning on a volume with a


reported size of 500GB and a volume reserve of 300GB, the amount of
volume reserve increases to 500GB.

When enabling thin provisioning, the thin-min-reserve, thin-


growth-warn, and thin-growth-max parameters are optional. If they
are not specified, the volume uses the groupwide defaults.

See the Dell EqualLogic Group Manager Administrator's Guide for


information about volume space.

thin-min-reserve n% Minimum volume reserve (default is 10% of the total volume size) for a
thin-provisioned volume. This percentage is the amount of guaranteed
space (volume reserve) for the volume.

thin-growth-warn When the amount of in-use space for a thin-provisioned volume


reaches this value, as a percentage of the volume size, a warning alarm
and event message occur.

thin-growth-max n% When in-use space for a thin-provisioned volume reaches this limit, as a
percentage of the reported volume size:
If the maximum in-use space value is less than 100% and an initiator
write will exceed this limit, the write fails, and the group sets the
volume offline and generates event messages.
If the maximum in-use space value is 100% and an initiator write will
exceed this limit, the volume is not set offline. However, the write
fails and the group generates event messages.

thin-warn-hard- Enables or disables a thin-provisioned volumes behavior when the


threshold enable| volume reaches its hard threshold. When enabled, the volume remains
disable
online when the thin-growth-max threshold is exceeded. When
disabled, the volume is set offline when the thin-growth-max
threshold is exceeded.

thin-warn-soft- Enables or disables a warning when a thin-provisioned volume reaches


threshold enable| its soft threshold. When enabled, the group sends an indication to the
disable
host when the volume exceeds the thin-growth-warn threshold.
When disabled, no indication is sent.

unbind Cancels any member binding for the volume

Examples
Set a volume offline and change its permission to read-only:

> volume select dbvol offline


> volume select dbvol read-only

446 Group Management Commands


Identify and then cancel an operation (identification number 1) to move a volume to a different pool:

> volume select vol-A show

______________________ Operations InProgress ____________________


...
ID StartTime Operation Details
-- ---------------- ------------------------------------------
1 2015-07-18:15:42:38 Moving from pool default to pool pool2

> volume select vol-A cancel-operation 1

Display detailed information about a NAS volume. The output shows that it is used for a NAS container.

> volume select vol2 show

_____________________________ Volume Information _____________________________


Name: vol2 Size: 401.25GB
VolReserve: 401.25GB VolReserveInUse: 401.25GB
ReplReserveInUse: 0MB iSCSI Alias:
iSCSI Name: ActualMembers: 1
iqn.2002-10.com.companyA:0-8a0906- Snap-Warn: 0%
99ecb8308-22c000000544db71-vol2 Snap-Depletion: delete-oldest
Description: nas volume Snap-Reserve: 0%
Snap-Reserve-Avail: 0% (0MB) Permission: read-write
DesiredStatus: online Status: online
Connections: 2 Snapshots: 0
Bind: Type: not-replicated
ReplicationReserveSpace: 0MB Replicas: 0
ReplicationPartner: Pool: default
Transmitted-Data: 85.69GB Received-Data: 23.44GB
Pref-Raid-Policy: raid6 Pref-Raid-Policy-Status: none
Thin-Provision: disabled Thin-Min-Reserve: 0% (0MB)
Thin-Growth-Warn: 0% (0MB) Thin-Growth-Max: 0% (0MB)
ReplicationTxData: 0MB MultiHostAccess: enabled
iSNS-Discovery: disabled Replica-Volume-Reserve: 0MB
Thin-Clone: N Template: N
NAS container: Y Administrator:
Thin-Warn-Mode: offline
______________________________________________________________________________
_______________________________ Access Records _______________________________
ID Initiator Ipaddress AuthMethod UserName Apply-To
--- ----------------------------- --------------- ---------- ---------- ------
1 iqn.1994-05.com.dsfs:node0-b7 none both
10ec35b317
2 iqn.1994-05.com.dsfs:node1-26 none both
a0fac7eb28
____________________________ Operations InProgress ___________________________
ID StartTime Progress Operation Details
-- -------------------- -------- ---------------------------------------------

volume select access


Manages basic access points for the selected volume and its snapshots.
Dell strongly recommends that you use basic access points (up to 16) to restrict host (iSCSI initiator)
access to a volume and its snapshots (iSCSI targets). Using basic access points prevents multiple hosts
from simultaneously accessing the same volume or snapshot and possibly corrupting data.

Group Management Commands 447


A volume and its snapshots share a list of basic access points; however, you can specify that a record
apply only to the volume, only to the volumes snapshots, or to both. If a volume or snapshot does not
have at least one basic access point, no host can access it. To prevent any host access, delete all the
basic access points for the volume and its snapshots.

Each basic access point can restrict host access according to IP address, iSCSI initiator name, CHAP
(Challenge Handshake Authentication Protocol) account name, or any combination of these methods. A
host must match all the requirements specified in one record in order to access the volume or snapshot.

For testing purposes only, you can set up a basic access point that grants unrestricted host access to the
volume and snapshots.

Format
volume select volume_name access subcommand

Variable
Variable Description
volume_name Name of a volume

Subcommands
Subcommand Description
create Creates a basic access point

delete Deletes a basic access point

select Selects a basic access point for additional operations

show Shows a basic access point

volume select access create


Creates a basic access point for a volume, its snapshots, or both.
A host must match all the requirements specified in one basic access point. In each record, you can
specify one or more of the following IDs:

CHAP user name To use CHAP for initiator authentication, you must set up local CHAP accounts or
specify an external RADIUS server. See chapuser and grpparams cliaccess-ssh. You can allow or
prevent (default) unauthorized hosts from discovering targets that are authenticated only with CHAP.
See grpparams discovery-use-chap.
IP address Create a basic access point for each IP address presented by an authorized host
iSCSI initiator name Create a basic access point for each iSCSI initiator name presented by an
authorized host

When you create a basic access point, the record is automatically given an identification number. Use this
number to manage the record with the CLI.

448 Group Management Commands


Format
volume select volume_name access create parameter...

Variable
Variable Description
volume_name Name of a volume

Parameters
Parameter Description
apply-to type Specifies whether the record restricts access to the volume, its
snapshots, or both the volume and its snapshots (default). Type can be:
volume
snapshot
both

authmethod chap|none Specifies whether the record uses CHAP authentication to restrict
access to the volume. The default is none; CHAP authentication is not
used.
For CHAP authentication, you must also specify the username
chap_name parameter.

username chap_name CHAP account name to which access is restricted. The name must
match one of the local CHAP accounts or an account on an external
RADIUS server.
For CHAP authentication, you must also specify the authmethod chap
parameter.

initiator name Name of the iSCSI initiator to which access is restricted. For example:
iqn.2002-10.com.companyA.qla-4000.sn00044

ipaddress address IP address to which access is restricted. An asterisk (*) in any of the four
parts of an IP address is interpreted as a wildcard character; that is, any
value is accepted for that 8-bit field.
For example, specify *.*.*.* for unrestricted host access (not
recommended except for testing).

Example
Create a basic access point that restricts volume access to a host with the specified IP address:

> volume select dbvol access create ipaddress 192.0.2.36

Created access entry with ID 2.

Group Management Commands 449


volume select access delete
Deletes a basic access point for the selected volume.

Format
volume select volume_name access delete n

Variables
Variable Description
volume_name Name of a volume

n Identification number for a basic access point (created automatically).


Use the volume select access show command to display the
identification numbers for a volumes basic access points.

Example
Delete a basic access point for the specified volume:

> volume select dbvol access delete 2

Access entry deletion succeeded.

volume select access select


Shows or modifies the selected basic access point for a volume.
When you modify a basic access point, all requirements in the record are overwritten. See the examples.

Format
volume select volume_name access select n show | parameter...

Variables
Variable Description
volume_name Name of a volume

n Identification number for a basic access point (created automatically)

Parameters
Parameter Description
apply-to type Specifies whether the record restricts access to the volume, its
snapshots, or both the volume and its snapshots (default). Type variable
can be:
volume

450 Group Management Commands


Parameter Description
snapshot
both

authmethod chap|none Specifies whether the record uses CHAP authentication to restrict
access to the volume.
For CHAP authentication, you must also specify the username
chap_name parameter.

username chap_name CHAP account name to which access is restricted. The name must
match one of the local CHAP accounts or an account on an external
RADIUS server.
See chapuser and grpparams discovery-use-chap for information about
configuring CHAP authentication in the group.

initiator name Name of the iSCSI initiator to which access is restricted. For example:
iqn.2002-10.com.companyA.qla-4000.sn00044

ipaddress address IP address to which access is restricted. An asterisk (*) in any of the four
parts of an IP address is interpreted as a wildcard character; that is, any
value is accepted for that 8-bit field.
For example, specify *.*.*.* for unrestricted host access (not
recommended except for testing).

Examples
Show information about a basic access point for the specified volume:

> volume select dbvol access select 1 show

______________________ Access Information _______________________


Initiator: Ipaddress: 192.0.2.45
AuthMethod: chap UserName: tbase
Apply-To: both

Change the basic access point in the previous example so that it includes only the specified IP address:

> volume select dbvol access select 1 ipaddress 192.0.2.45

volume select access show


Shows the basic access points for the selected volume.

Format
volume select volume_name access show

Variable
Variable Description
volume_name Name of a volume

Group Management Commands 451


Example
Show the two basic access points for the specified volume:

> volume select mailvol access show

ID Initiator Ipaddress AuthMethod UserName Apply-To


--- --------------------------- --------------- ---------- ---------- --------
1 192.0.2.24 chap jchenille volume
2 192.0.2.25 none both

volume select clone


Clones the selected volume, creating a new volume of the same type as the selected volume (standard,
thin clone, or template).
The new volume will have a different name, but the same size and contents as the original volume at the
time of the cloning. By default, the new volume will be online, have read-write permission, and use the
groupwide snapshot and iSCSI settings unless you override them.

Cloning a standard or template volume consumes 100 percent of the original volume reserve from free
pool space. Cloned volumes inherit the original volumes size and thin-provision status. If the original
volume has thin provisioning enabled, so will the clone, with all the same attributes as the original.
However, a volume clone does not inherit the RAID preference policy of the parent volume; the RAID
policy for the clone is set to none by default.

The new volume does not inherit the original volumes snapshot reserve settings; the new volume is
created with the groupwide default value for snapshot reserve. The new volume also does not inherit the
original volumes replication space settings or configuration. To create replicas of the new volume, you
must configure replication on the new volume.

The new volume is available immediately. You can use and modify it as you would any other volume.

The cloned volume will reside in the same pool as the original volume. To change the pool, modify the
new volume. The original volume is still available after the cloning operation completes.

Format
volume select volume_name clone new_name parameter...

Variables
Variable Description
volume_name Name of a volume to clone

new_name New name for the cloned volume. Name can be up to 63 bytes and is
case insensitive. You can use any printable Unicode character except
for ! " # $ % & ' ( ) * + , / ; < = > ?@ [ \ ] ^ _ ` { | } ~. First and last
characters cannot be a period, hyphen, or colon. Fewer characters are
accepted for this field if you enter the value as a Unicode character
string, which takes up a variable number of bytes, depending on the
specific character.

452 Group Management Commands


Parameters
Parameter Description
bind member Binds the new volume to the specified member. Volume data is
restricted to this member.
Binding a volume to a member overrides any RAID preference for the
volume.

description text Description for the new volume, up to 127 characters. Fewer characters
are accepted for this field if you enter the value as a Unicode character
string, which takes up a variable number of bytes, depending on the
specific character.
If the text contains spaces, enclose it in quotation marks.

iscsi-alias alias iSCSI target alias, up to 63 ASCII characters, for the new volume. Some
iSCSI initiators can see the alias.
The default alias is the groupwide setting (see grpparams def-iscsi-
alias).

offline|online New volume status (default is online)

read-write|read-only New volume permission (default is read-write)

snap-depletion action Specifies the default snapshot space recovery policy, either delete-
oldest (delete the oldest snapshots; the default) or volume-offline
(set the volume and its snapshots offline).
The default policy is the groupwide setting (see grpparams def-snap-
depletion).

snap-reserve n% Amount of space, as a percentage of the new volumes volume reserve,


to reserve for snapshots of the new volume. You must include the
percent sign (%).
The default percentage is the groupwide setting (see grpparams def-
snap-reserve).

snap-warn n% Threshold at which an alarm occurs because the amount of free space
reserved for snapshots of the new volume has fallen below this value, as
a percentage of the total reserved snapshot space. You must include
the percent sign (%).
The default threshold is the groupwide setting (see grpparams def-
snap-warn).

unrestricted Grants unrestricted host access to the new volume.


Unrestricted access is not recommended. Instead, after cloning the
volume, create one or more basic access points for the new volume to
restrict host access. See volume select access create.

Group Management Commands 453


Example
Clone a volume to create a new volume:

> volume select dbvol clone vol3


Volume creation succeeded.
iSCSI target name is iqn.2002-10.com.companyA:
6-8b0900-2ae20000-99e00000067405b5-vol3
Cloning is in progress.

volume select convert-to


Converts a standard volume to a template volume or vice versa.
This command has the following functions:

Selects a standard volume (must be thin-provisioned and have read-only permission) and converts it
to a template volume
Selects a template volume and converts it to a standard volume

Before converting a standard volume to a template volume, you must set the volume offline and change
the access type to read-only. However, you can convert a template volume to a volume while it is online.
(Changing the access type is not applicable; template volumes are always read-only.)

You cannot convert a volume if replication is active on the volume or template volume, and you cannot
convert a template volume to a standard volume if the template volume still has thin clones attached.

If you convert a volume that is part of a volume collection to a template volume, the template volume is
automatically deleted from the collection.

Format
volume select volume_name convert-to template|volume

Variable
Variable Description
volume_name Name of a volume to convert

Parameters
Parameter Description
template Converts a standard volume to a template volume

volume Converts a template volume to a standard volume

454 Group Management Commands


Example
The following commands set a thin-provisioned volume offline, set its access type to read-only, and
convert it to a template volume.

> volume select volthin1 offline


Do you want to set volume volthin1 offline? (y/n) [n] y

> volume select volthin1 read-only


> volume select volthin1 convert-to template

Convert a template volume to a volume. The volume can be online at the time.

> volume select volthin1 convert-to volume

volume select create-thin-clone


Creates a thin clone volume with the specified name from the selected template volume.
You must give the thin clone volume a new name.

Format
volume select volume_name create-thin-clone new_name

Variables
Variable Description
volume_name Name of a template volume

new_name Name for the new thin clone volume

Example
Create a thin clone from a template volume:

> volume select templateVol1 create-thin-clone tVol1-clone1

volume select delete-failback


Selects a recovery volume (a volume created by promoting an inbound replica set), and makes the
promotion permanent.
The resulting volume is no longer flagged as a recovery volume and cannot be demoted to the original
inbound replica set. You must give the volume a new name.

To replicate the volume, you must configure replication on the volume. The first replication requires a
complete transfer of the volume data.

Format
volume select volume_name delete-failback new_name

Group Management Commands 455


Variables
Variable Description
volume_name Name of a recovery volume

new_name New name for the volume

Example
Make a promotion permanent for a recovery volume:

> volume select dbvol2.1 delete-failback dbvol-new

Deleting failback for a recovery volume will break the replication relationship
between the partners. Are you sure you want to delete failback? (y/n) [n] y

volume select multihost-access


Enables or disables multihost access on a volume.
In a shared storage environment, you must control computer access to iSCSI targets (volumes and
snapshots), because multiple computers writing to a target in an uncoordinated manner might result in
volume corruption.

When an initiator tries to log in to a target, the group uses basic access points to determine if access
should be authorized. However, basic access points do not prevent multiple initiators, either on the same
computer or different computers, from accessing the same target.

By default, the group disables multihost access to a target; therefore, only one iSCSI qualified name (IQN)
can connect to a target at one time. However, if you have a certain environment, you might want to
enable multihost access to a target.

If all group members are not running PS Series firmware version 5.0 or higher, the group allows multihost
access to targets.

You can enable multihost access to a target if you meet any of the following conditions:

Your cluster environment assigns the initiators on each cluster computer a different IQN, and the
environment can manage multiple connections to a target. For example, the environment uses a
Distributed Lock Manager or SCSI reservations.
Your multipathing solution does not use the same IQN on all initiators, and you cannot modify the
names to be the same.
You use an environment, such as a virtual server, that can manage multiple connections to the same
iSCSI target (for example, through SCSI reservations).
Initiators on a single computer do not use the same IQN.

In all cases, use basic access points as the primary method of protecting targets in a group.

Format
volume select volume_name multihost-access enable|disable

456 Group Management Commands


Variable
Variable Description
volume_name Name of a volume

Examples
Enable multihost access for a volume:

> volume select dbase_vol2 multihost-access enable

Disable multihost access for a volume:

> volume select my_vol multihost-access disable

volume select pool


Moves a volume to a different pool.
The destination pool must have enough free space to store the volume.

Formats
volume select volume_name pool pool_name
volume select volume_name pool source source_pool destination destination_pool

Variables
Variable Description
volume_name Name of a volume

pool_name Name of the pool to which you want to move a volume from the
default pool

source_pool Name of the pool that the volume currently resides in, if other than the
default pool

destination_pool Name of the pool that you want to move the volume into from the
source pool

Examples
Move a volume from the default pool to another pool:

> volume select vol2 pool pool2

Move a volume from one pool (not the default pool) to another pool:

> volume select ExchgDBvol source pool2 destination BigPool

Group Management Commands 457


volume select replicate-to-primary
Enables you to select a recovery volume and start, stop, or retry the replication operation.
You can replicate a recovery volume only to the original primary group. You cannot replicate a recovery
template volume.

This replication operation is the second step in the manual failover and failback process. See failback.

You can also use manual transfer replication.

Format
volume select volume_name replicate-to-primary subcommand

Variable
Variable Description
volume_name Name of a volume

Subcommands
Subcommand Description
start [manual-replica] Starts the replication, optionally using manual transfer replication

stop Stops the replication

retry Retries an operation that you stopped

Examples
Retry a replication operation for a recovery volume to the primary group:

> volume select dbase_vol2.1 replicate-to-primary retry

Start a manual transfer replication operation for a recovery volume to the primary group:

> volume select vol_04.1 replicate-to-primary start manual-replica

volume select replication


Enables you to select a volume, enable replication on the volume, create replicas, and manage the
volume replication.
See the Dell EqualLogic Group Manager Administrator's Guide for detailed information about replication.

NOTE: You must replicate a template volume before you can replicate any thin clones of that
template volume.

458 Group Management Commands


Format
volume select volume_name replication subcommand

Variable
Variable Description
volume_name Name of a volume

Subcommands
Subcommand Description
cancel Cancels an in-progress replication to a partner

create-replica Creates a replica of the volume on the specified partner

demote Demotes a volume to a failback replica set or demotes a recovery


volume to an inbound replica set

disable Disables replication to a partner

enable Enables volume replication to a partner

pause Temporarily suspends volume replication to a partner

resume Resumes volume replication to a partner

select Shows or modifies the volume replication configuration, including


modifying the local replication reserve and the replica reserve

show Shows a summary of partners to which the volume is being replicated


and the status of any in-progress replication

volume select replication cancel


Cancels an in-progress replication to a partner.

Format
volume select volume_name replication cancel partner_name

Variables
Variable Description
volume_name Name of a volume

partner_name Partner group name

Group Management Commands 459


Example
Cancel the replication of a volume to partner:

> volume select staffvol replication cancel psgroup2

volume select replication create-replica


Creates a replica that represents the contents of the volume at the current time.
Before you can create a replica, you must set up two groups as replication partners (see partner create)
and enable replication on the volume (see volume).

A replica set is the set of replicas for a volume. The replica set name is based on the volume name. The
names of individual replicas are based on the volume name and a timestamp.

NOTE: If you plan to use manual transfer replication, do not create the first replica until you are
ready to start the transfer process.

You can replicate a template volume only once.

Format
volume select volume_name replication create-replica [manual] partner_name

Variables
Variable Description
volume_name Name of a volume

partner_name Name of a replication partner

Parameter
Parameter Description
manual Specifies using manual transfer replication for the replication operation.
See the Dell EqualLogic Manual Transfer Utility Installation and Users
Guide for more information.

Examples
Create a replica of a volume on a partner:

> volume select vol4 replication create-replica psgroup2

Create a replica of a volume, specifying manual replication for the data transfer:

> volume select vol-thin1 replication create-replica manual group2

460 Group Management Commands


volume select replication demote
Demotes a recovery volume to an inbound replica set, returning it to its original state, or demotes a
volume to a failback replica set in preparation for replication from the recovery group.
You must set a volume offline before you demote it.

You cannot demote a template volume to a failback replica set.

Format
volume select volume_name replication demote [partner_name]

Variables
Variable Description
volume_name Name of a volume

partner_name Partner group name (required only if you are demoting a volume to a
failback replica set)

Examples
The following commands set a recovery volume offline and demote it to an inbound replica set:

> volume select vol5.1 offline

> volume select vol5.1 replication demote

1553:125:member1:MgmtExec: 1-May-2015 10:34:10.180126:snapshotRestore.cc:


789:INFO:8.2.9:Volume successfully restored from snapshot
'vol1.1-2014-04-05-14:36:14.13'. A new snapshot
'vol1.1-2015-05-01-10:34:10.109' was created from volume prior to being
restored.

1558:130:member1:MgmtExec: 1-May-2014 10:34:10.410131:volumeSecondaryDemote.cc:


1590:INFO:7.2.38:Recovery volume 'vol1.1' has been successfully demoted to a
replica set.

The following commands set a volume offline and demote it to a failback replica set:

> volume select data45 offline

> volume select data45 replication demote group2

Demoting a volume to a failback replica set enables you to replicate the


recovery volume to the primary group. Do you want to demote the volume? (y/n)
[n] y

Group Management Commands 461


volume select replication disable
Disables replication of the selected volume to a replication partner.
NOTE: Disabling a volume for replication does not delete any replica sets on the partner. Access the
replica sets by logging in to the partner and using partner select inbound-replicaset commands.

If you disable replication to a partner and then later reenable replication to the partner, the initial replica
will be a complete transfer of the volume data. To stop replication temporarily, pause the replication
instead of disabling it.

Format
volume select volume_name replication disable partner_name

Variables
Variable Description
volume_name Name of a volume

partner_name Partner group name

Example
Disable replication of a volume to a partner:

> volume select staffvol replication disable psgroup2

volume select replication enable


Configures replication of the selected volume to a replication partner.
The replication partners must already be configured. See partner create.

Enabling replication on a volume does not create replicas. See volume select replication create-replica
and volume select schedule create for information about creating replicas.

You must replicate a template volume before you can replicate any of its thin clones.

To configure replication for a volume, specify:

The local replication reserve percentage. This space stores the data that changes while replication is
in progress, and stores the failback snapshot. You can also allow the volume to borrow pool space
temporarily if the local replication reserve is not big enough to store all the changes.
The partner that will store the replica set
The remote reserve percentage
Whether to keep the failback snapshot (most recent complete replica) in the local replication reserve.
If you choose to keep the failback snapshot, you will need more local replication reserve space. If you
have a failback snapshot, you might be able to synchronize the groups upon failback by replicating
volume changes only.
See the Dell EqualLogic Group Manager Administrator's Guide for more information about failback.

462 Group Management Commands


Format
volume select volume_name replication enable partner_name [parameter...]

Variables
Variable Description
volume_name Name of a volume

partner_name Partner group name

Parameters
Parameter Description
remote-rep-reserve n% Specifies the replica reserve for the volume, which is the portion of
delegated space allocated for storing the volumes replica set. The
replica reserve is based on a percentage of the replica volume reserve.
The default is 200%; the minimum is 105%. You must specify the
percent sign.
See the Dell EqualLogic Group Manager Administrator's Guide for
information about sizing the replica reserve.

local-rep-reserve n% Specifies the local replication reserve, which is used during replication
and, optionally, for storing the failback snapshot. The local replication
reserve is based on a percentage of the volume reserve.
The default is 100%; the minimum is 5%. You must specify the percent
sign.

If you are not keeping the failback snapshot, the recommended value is
100%. If you are keeping the failback snapshot, the recommended value
is 200%.

See the Dell EqualLogic Group Manager Administrator's Guide for


information about sizing the local replication reserve.

borrow-space enable| Controls whether to temporarily use free pool space if the local
disable replication reserve is insufficient.
Enable this parameter (the default) if you specify less than the
recommended value for the local replication reserve.

keep-failback Keep a failback snapshot in the local replication reserve.


The failback snapshot might enable you to fail back to the primary
group by synchronizing volume changes only.

Group Management Commands 463


Examples
Enable replication of a volume to a partner, using the default local replication reserve and replica reserve
values:

> volume select newvol replication enable group2

Enable replication of a volume to a partner, keeping the failback snapshot:

> volume select vol2 replication enable group2 keep-failback

volume select replication pause


Pauses replication of the selected volume to a replication partner.
To resume replication, see volume select replication resume.

Format
volume select volume_name replication pause partner_name

Variables
Variable Description
volume_name Name of a volume

partner_name Partner group name

Example
Pause replication of a volume to a partner:

> volume select dbvol replication pause psgroup2

volume select replication resume


Resumes replication of the selected volume to a replication partner.

Format
volume select volume_name replication resume partner_name

Variables
Variable Description
volume_name Name of a volume

partner_name Partner group name

464 Group Management Commands


Example
Resume replication of a volume to a partner:

> volume select dbvol replication resume psgroup2

volume select replication select


Shows or modifies the selected volume replication configuration.
You can modify the local replication reserve or the replica reserve for a volume or enable the temporary
use of free pool space if the group does not have enough local replication reserve.

You can also choose to keep a failback snapshot in local replication reserve space.

NOTE: When a volume replication data transfer is in progress, you can reduce the local replication
reserve only if the new local replication reserve size is more than what is currently being used to
track volume changes.
When a volume replication data transfer is in progress, you can reduce the replica reserve only if the
new replica reserve size is more than what is currently being used to store the replica set. Or, you
can delete replicas (oldest first) to free up replica reserve space and then reduce the size of the
replica reserve.

Format
volume select volume_name replication select partner_name show | [parameter]

Variables
Variable Description
volume_name Name of a volume

partner_name Partner group name

Parameters
Parameter Description
borrow-space enable| Controls whether to temporarily use free pool space if the local
disable replication reserve is not big enough.
Enable this parameter if you specify less than the recommended value
for the local replication reserve.

keep-failback enable| Enables or disables keeping a failback snapshot for the volume.
disable
You must create a replica to set the failback baseline.

local-rep-reserve n% Specifies the local replication reserve, which is used during replication
and, optionally, for storing the failback snapshot. The local replication
reserve is based on a percentage of the volume reserve.

Group Management Commands 465


Parameter Description
The minimum is 5%. You must specify the percent sign.

If you are not keeping the failback snapshot, the recommended value is
100%. If you are keeping the failback snapshot, the recommended value
is 200%.

See the Dell EqualLogic Group Manager Administrator's Guide for


information about sizing the local replication reserve.

remote-rep-reserve n% Specifies the replica reserve for the volume, which is the portion of
delegated space allocated for storing the volumes replica set. The
replica reserve is based on a percentage of the replica volume reserve.
The minimum is 105%. You must specify the percent sign.
See the Dell EqualLogic Group Manager Administrator's Guide for
information about sizing the replica reserve.

Replication Status
Table 5. Volume Replication Status lists possible replication status values for a volume in the output of the
show subcommand.

Table 5. Volume Replication Status

Status Description
disabled Replication of the volume has been disabled manually.

enabled Volume is enabled for replication.

paused Replication of the volume has been paused manually.

Example
Show the replication configuration for a volume on a partner:

> volume select vol4 replication select psgroup2 show

volume select replication show


Shows the replication partners for the selected volume and the status of any in-progress replication.

Format
volume select volume_name replication show

Variable
Variable Description
volume_name Name of a volume

466 Group Management Commands


Example
Shows the replication partner and status for a volume:

> volume select C1LocalVol replication show

Partner Name CurrReplicas Status Remaining StartingTime


--------------- ------------ ---------------- ---------- ---------------------
PartnerA 1 ready 0MB None

volume select schedule


Manages schedules for creating snapshots or replicas of the selected volume.
You cannot create a schedule for a template volume.

Schedules can create snapshots or replicas on an hourly, daily, or weekly basis. For example, you can set
up a schedule that creates a snapshot or replica once a day, once a week, or every 2 hours during work
hours.

Do not configure a replication schedule to start before you have completed the first transfer, if using
manual replication. The scheduled replication will be skipped if the first transfer is not complete.

NOTE: Using a schedule can result in the creation of many snapshots or replicas. To control the
number of snapshots or replicas, use the max-keep parameter when creating a schedule. In
addition, the size of the snapshot reserve limits the number of snapshots that you can create for a
volume, and the size of the replica reserve limits the number of replicas you can create for a
volume.

Format
volume select volume_name schedule subcommand

Variable
Variable Description
volume_name Name of a volume

Subcommands
Subcommand Description
create Creates a schedule

delete Deletes a schedule

rename Renames a schedule

select Selects a schedule for additional operations

show Shows all schedules

Group Management Commands 467


volume select schedule create
Creates a snapshot or replication schedule for the selected volume.
You cannot configure a schedule for a template volume. If you create a schedule for a volume and later
convert the volume to a template volume, the schedule will be suspended. Suspending the schedule
preserves any snapshots that contain differences from the original, unconverted volume. Because
template volumes cannot be written to, you do not need to schedule additional snapshots. (However,
you can create a snapshot of a template volume on demand. See volume).

To configure a replication schedule on a volume, the volume must already be configured for replication
to the partner you will specify for the schedule. If you are using manual transfer replication for the first
replication, do not configure a replication schedule to start before you have completed the first transfer.
The scheduled replication will be skipped if the first (manual) transfer is not complete.

For each schedule, you must specify:

Schedule name
Schedule type
Time to start creating the snapshots or replicas
Partner name (for replication schedules only)

Optionally, you can specify other parameters, based on the schedule type.

By default, the schedule will be a snapshot schedule unless you specify the partner parameter and a
valid partner name for the volume.

Format
volume select volume_name schedule create schedule_name parameter...

Variables
Variable Description
volume_name Name of a volume. Name can be up to 63 bytes and is case insensitive.
You can use any printable Unicode character except for ! " # $ % & ' ( ) *
+ , / ; < = > ?@ [ \ ] ^ _ ` { | } ~. First and last characters cannot be a
period, hyphen, or colon. Fewer characters are accepted for this field if
you enter the value as a Unicode character string, which takes up a
variable number of bytes, depending on the specific character.

schedule_name Name of the schedule, up to 63 ASCII characters.


If the schedule name contains spaces, enclose the name in quotation
marks (for example, daily schedule).

468 Group Management Commands


Parameters
Parameter Description
type type Type of schedule, either once, hourly, or daily. You must specify a
schedule type.

start-time hh:mm[AM| Time when the schedule will start creating snapshots or replicas. Use
PM] 24-hour time or specify AM or PM. You must specify a start time.

end-time hh:mm[AM|PM] Time when the schedule will stop creating a sequence of snapshots or
replicas. Use 24-hour time or specify AM or PM.
Applies only to schedules of type daily.

read-write|read-only Permission for snapshots created from the schedule. The default is
read-write.

max-keep n Maximum number of snapshots or replicas (created from the schedule)


to retain. The default is 10.
If you reach the maximum limit, the oldest snapshot or replica created
from the schedule is deleted before another snapshot or replica is
created.

frequency nmins| Interval between the creation of snapshots or replicas, in minutes or


nhour[s] hours (for example: 5mins, 1hour, 2hours).
Applies only to schedules of type hourly and daily.

start-date mm/dd/yy Month, day, and year that the schedule will start. The default is the day
that the schedule was created (or the following day, if the starting time
has already passed).

end-date mm/dd/yy Month, day, and year that the schedule will stop. The default is no
ending date.

repeat-interval ndays Number of days between the creation of snapshots or replicas.


Applies only to schedules of type daily.

partner partner_name Name of the partner that will store replicas created through the
schedule. You must specify a partner for replication schedules.

enable|disable Enables (default) or disables the schedule

Examples
Create a replication schedule that creates a replica of a volume on a partner every day at the same time:

> volume select db1 schedule create dailydb type daily start-time 11:30PM
repeat-interval 1days partner psgroup2

Schedule creation succeeded.

Group Management Commands 469


Create a snapshot schedule that creates snapshots of a volume every day, every 2 hours, from 7:00 a.m.
to 8:00 p.m.:

> volume select mail5 schedule create msnap type daily start-time 07:00AM end-
time 20:00 frequency 2hours repeat-interval 1days

volume select schedule delete


Deletes a snapshot or replication schedule for the selected volume.
Deleting a schedule does not delete snapshots or replicas created by the schedule.

Format
volume select volume_name schedule delete schedule_name

Variables
Variable Description
volume_name Name of a volume

schedule_name Name of a schedule to delete. If the schedule name contains spaces,


enclose the name in quotation marks (for example, daily schedule).

Example
Delete a schedule:

> volume select staffvol2 schedule delete backup2

Do you really want to delete? (y/n) [n] y


Schedule deletion succeeded.

volume select schedule rename


Renames a snapshot or replication schedule for the selected volume.

Format
volume select volume_name schedule rename schedule_name new_name

Variables
Variable Description
volume_name Name of a volume

schedule_name Current name of a schedule. If the schedule name contains spaces,


enclose the name in quotation marks (for example, schedule for daily
backups).

new_name New schedule name, up to 63 alphanumeric characters.

470 Group Management Commands


Variable Description
If the schedule name contains spaces, enclose the name in quotation
marks (for example, daily schedule).

Example
Rename a schedule:

> volume select staffvol2 schedule rename backup2 backupcopy

volume select schedule select


Modifies a snapshot or replication schedule or shows details about a schedule.
NOTE: You cannot modify the partner for a replication schedule. Instead, delete the schedule and
then create a new schedule with the correct partner.

Format
volume select volume_name schedule select schedule_name show|parameter ...

Variables
Variable Description
volume_name Name of a volume

schedule_name Name of a schedule. If the schedule name contains spaces, enclose the
name in quotation marks (for example, daily schedule).

Parameters
Parameter Description
enable|disable Enables or disables the schedule

end-date mm/dd/yy Month, day, and year that the schedule will stop

end-time hh:mm[AM|PM] Time when the schedule will stop creating a sequence of snapshots or
replicas. Use 24-hour time or specify AM or PM.
Applies only to schedules of type daily.

frequency nmins| Interval between the creation of snapshots or replicas, in minutes or


nhour[s] hours (for example: 5mins, 1hour, 2hours)
Applies only to schedules of type hourly and daily.

max-keep n Maximum number of snapshots or replicas (created from the schedule)


to retain.

Group Management Commands 471


Parameter Description
If you reach the maximum limit, the oldest snapshot or replica created
from the schedule is deleted before another snapshot or replica is
created.

read-only|read-write Permission for snapshots created from the schedule

repeat-interval ndays Number of days between the creation of snapshots or replicas.


Applies only to schedules of type daily.

start-date mm/dd/yy Month, day, and year that the schedule will start

start-time hh:mm[AM| Time when the schedule will start creating snapshots or replicas. Use
PM] 24-hour time or specify AM or PM.

type type Type of schedule, either once, hourly, or daily

Examples
Change the time that snapshots of a volume are created with a schedule:

> volume select staffvol2 schedule select bckup start-time 10:15PM

Show details about a replication schedule:

> volume select staff2 schedule select hourly2 show

____________________________ Schedule Information ____________________________


Name: RepSched Type: hourly
Start-Date: 03/18/15 End-Date: None
Start-Time: 12:00AM End-Time: 12:00AM
Frequency: 1hour Repeat-Interval:
Max-Keep: 10 NextCreation: Mon Mar 30 18:00:00
Partner: gigan34-grp 2015
Desired Status: enable Status: enable
______________________________________________________________________________

volume select schedule show


Shows the snapshot and replication schedules for the selected volume or shows details about a specific
schedule.

Format
volume select volume_name schedule show [schedule_name]

Variables
Variable Description
volume_name Name of a volume

schedule_name Name of a schedule. If the schedule name contains spaces, enclose the
name in quotation marks (for example, schedule for daily backups).

472 Group Management Commands


Example
Show the snapshot and replication schedules for a volume:

> volume select dbvol schedule show

Name Interval DateRange TimeRange Frequency NextCreate


--------- -------- ------------------- ---------------- --------- -----------

____________________________ Replication Schedules ___________________________

Name Interval DateRange TimeRange NextCreate Partner


--------- -------- -------------- ---------------- ----------- ---------
RepSched hourly 03/18/15-None 12:00AM-12:00AM Mon Mar 30 gog34-grp
18:00:00 2015

volume select show


Shows detailed information about the selected volume. You can specify (display) only one parameter at a
time.

Format
volume select volume_name show | [parameter]

Variable
Variable Description
volume_name Name of a volume

Parameters
Parameter Description
access Basic access points

connections Active iSCSI connections

members Members that contain volume data

replicas Volume replicas

replication Replication partners storing volume replicas

schedules Snapshot and replication schedules

snapshots Snapshots

Group Management Commands 473


Volume Status Values
A volume has the following status types:

Requested status (Table 6. Requested Volume Status), which is set by the administrator and can be
changed using commands
Current status (Table 7. Current Volume Status), which describes the actual status of the volume

Table 6. Requested Volume Status

Status Description
online Administrator set the volume online. Authorized hosts can access the
volume.

offline Administrator set the volume offline. Hosts cannot access the volume.

online-lost-cached- Administrator set the volume online with lost blocks. Authorized hosts
blocks can access the volume. If an application tries to read a lost block, an
error occurs. If the block is rewritten, no error occurs, and the block no
longer is marked as lost.

Table 7. Current Volume Status

Status Description and Solution


online Volume was set online by an administrator, and no failures have
occurred. Authorized hosts can access the volume.

offline Volume was set offline by an administrator, but no failures have


occurred. Hosts cannot access the volume.

offline-lost-cached- Volume was automatically set offline because blocks were lost.
blocks
Solution: Choose how to manage the lost blocks.

offline-max-grow-met Volume was automatically set offline because the in-use volume
reserve reached the maximum in-use value.
Solution: Increase the value of the maximum in-use space level for the
volume. You can also add more space to the pool (by adding a
member).

offline-member-down Volume was automatically set offline because a member that contains
volume data is down or cannot be reached by the other members over
the network.
Solution: Identify and correct the problem that caused the member to
become unreachable.

offline-missing-pages Volume or snapshot data is inconsistent.


Solution: Contact your support provider.

offline-nospace-auto- Volume was automatically set offline because the pool does not have
grow enough free space for the thin-provisioned volume to increase.

474 Group Management Commands


Status Description and Solution
Solution: Add more space to the pool (by adding a member).

offline-snap-reserve- Volume was automatically set offline because the reserved snapshot
met space was used and the snapshot recovery policy dictates that the
volume be set offline.
Solution: Increase the amount of reserved snapshot space. See volume
select.

Examples
Show detailed information about a volume:

> volume select newvol show

_____________________________ Volume Information _____________________________


Name: sp2block1 Size: 10GB
VolReserve: 10GB VolReserveInUse: 1.01GB
ReplReserveInUse: 0MB iSCSI Alias: sp2block1
iSCSI Name: ActualMembers: 1
iqn.2002-10.com.companyA:0-8a0906- Snap-Warn: 10%
a1646aa08-e850000000c4fdf6-sp2block1 Snap-Depletion: delete-oldest
Description: Snap-Reserve: 0%
Snap-Reserve-Avail: 0% (0MB) Permission: read-write
DesiredStatus: online Status: online
Connections: 0 Snapshots: 0
Bind: Type: replicated
ReplicationReserveSpace: 10GB Replicas: 1
ReplicationPartner: spark Pool: default
Transmitted-Data: 0MB Received-Data: 0MB
Pref-Raid-Policy: none Pref-Raid-Policy-Status: none
Thin-Provision: disabled Thin-Min-Reserve: 0% (0MB)
Thin-Growth-Warn: 0% (0MB) Thin-Growth-Max: 0% (0MB)
ReplicationTxData: 0MB MultiHostAccess: disabled
iSNS-Discovery: disabled Replica-Volume-Reserve: 2.02GB
Thin-Clone: N Template: N
NAS Container: N Administrator:
SyncReplStatus: SyncReplTxData: 0MB
Thin-Warn-Mode: offline Snap-space Borrowing: disabled
Space Borrowed: 0MB Folder:
______________________________________________________________________________
_______________________________ Access Records _______________________________
ID Initiator Ipaddress AuthMethod UserName Apply-To
--- ----------------------------- --------------- ---------- ---------- ------
____________________________ Replication Partners ____________________________
Partner Name CurrReplicas Status Remaining StartingTime
--------------- ------------ ---------------- ---------- ---------------------
spark8 1 ready 0MB None
____________________________ Operations InProgress ___________________________
ID StartTime Progress Operation Details
-- -------------------- -------- ---------------------------------------------

Display the pool-specific information for a volume with synchronous replication enabled:

> volume select cwreptest show

_____________________________ Volume Information _____________________________


Name: cwreptest Size: 20GB
VolReserve: 40GB VolReserveInUse: 0MB

Group Management Commands 475


ReplReserveInUse: 0MB iSCSI Alias: cwreptest
iSCSI Name: ActualMembers: 1
iqn.2002-10.com.companyA:0-8a0906- Snap-Warn: 10%
7814cd101-cb1000000044f82f-cwreptest Snap-Depletion: delete-oldest
Description: test replication to Snap-Reserve: 100%
glenross Snap-Reserve-Avail: 100% (40.01GB)
Permission: read-write DesiredStatus: offline
Status: offline Connections: 0
Snapshots: 3 Bind:
Type: not-replicated ReplicationReserveSpace: 0MB
Replicas: 0 ReplicationPartner:
Pool: <multiple> Transmitted-Data: 0MB
Received-Data: 0MB Pref-Raid-Policy: none
Pref-Raid-Policy-Status: none Thin-Provision: disabled
Thin-Min-Reserve: 0% (0MB) Thin-Growth-Warn: 0% (0MB)
Thin-Growth-Max: 0% (0MB) ReplicationTxData: 0MB
MultiHostAccess: disabled iSNS-Discovery: disabled
Replica-Volume-Reserve: 0MB Thin-Clone: N
Template: N NAS Container: N
Administrator: SyncReplStatus: In-sync
SyncReplTxData: 0MB Thin-Warn-Mode: offline
Snap-space Borrowing: enabled Space Borrowed: 0MB
Folder: sync

______________________________________________________________________________
_____________________ Volume syncpool Pool Information _______________________
VolReserveInUse: 0MB Snap-Reserve-Avail: 100% (20GB)
Snapshots: 1 Bind:
Transmitted-Data: 0MB Received-Data: 0MB
ActualMembers: 1 Pref-Raid-Policy-Status: none

______________________________________________________________________________
______________________ Volume default Pool Information _______________________
VolReserveInUse: 0MB Snap-Reserve-Avail: 100% (20GB)
Snapshots: 2 Bind:
Transmitted-Data: 0MB Received-Data: 0MB
ActualMembers: 1 Pref-Raid-Policy-Status: none

______________________________________________________________________________
______________________________ Access Records ________________________________
ID Initiator Ipaddress AuthMethod UserName Apply-To
--- --------------------------- --------------- ---------- ---------- --------

Show the basic access points for a volume:

> volume select dbvol2 show access

ID Initiator Ipaddress AuthMethod UserName Apply-To


-- --------- --------- ---------- -------- --------
1 192.0.2.25 none volume
2 192.0.2.27 chap dos3 both

Show volume replicas being stored on a partner:

> volume select staff30 show replicas

_________________________________ gigan34-grp ________________________________

Name TimeStamp Schedule Status


---------------------------------- ------------------------ -------- ---------
uvol.4-2015-03-15-14:22:50.50 Sun Mar 15 14:22:50 2015 completed

476 Group Management Commands


Show information about the active iSCSI connections to a volume:

> volume select dbvol2 show connections

Initiator UpTime RxData TxData


--------------- ----------------- --------------- ---------------
192.0.2.46 20hr 15min 55secs 169.09MB 196.47MB
192.0.2.42 9hr 4min 37secs 70.37MB 82.92MB
192.0.2.44 9hr 3min 43secs 70.63MB 80.88MB
192.0.2.41 1hr 7min 53secs 7.74MB 35.84MB
192.0.2.43 1hr 7min 52secs 7.91MB 37.15MB
192.0.2.45 1hr 7min 51secs 8.30MB 36.07MB

Show the amount of volume data on the members:

> volume select dbvol2 show members

Member Name Contribution


--------------- ------------
mem24 95.03GB
mem23 105.00GB

volume select shrink


Decreases (shrinks) the reported size of a volume.
You cannot shrink a template volume or a recovery volume.

Before you shrink a volume, make sure that the container, host, or application using the volume can
accept changing the size of a volume. Also, stop or quiesce applications using the volume, unmount
containers on the volume, and set the volume offline.

Decreasing the volume size might also decrease the snapshot reserve and local replication reserve,
because they are based on the volume reserve.

NOTE: If decreasing a volume size will result in the deletion of snapshots from the snapshot reserve,
the group will increase the snapshot reserve percentage. For example, if you shrink a 100GB volume
(no thin provisioning), with a 100 percent snapshot reserve that has 80GB in use by snapshots, to
50GB, a 100 percent snapshot reserve now represents only 50GB of snapshot reserve. Therefore,
the group will increase the snapshot reserve percentage to 160 percent to avoid deleting snapshots.
To leave the snapshot reserve percentage unchanged, even if it results in deleted snapshots, specify
the no-adjust-snap-resv parameter.

By default, a snapshot of the volume is created before the volume size is decreased. Specify the no-snap
parameter to skip the creation of a snapshot.

Format
volume select volume_name shrink new_size [parameters]

Group Management Commands 477


Variables
Variable Description
volume_name Name of a volume

new_size[unit] New smaller size for the volume. Size is in megabytes unless you specify
otherwise. You can specify size with any of the following suffixes: m,
mb, MB, g, gb, or GB.

Parameters
Parameter Description
no-snap Does not create a snapshot of the volume before reducing its size

no-adjust-snap-resv Maintains the same percentage of snapshot reserve for the volume,
based on the new volume size. Might result in the loss of snapshots.

Example
The following commands set a volume offline and shrink it from 100GB to 50GB, creating a snapshot:

> volume select bigvol offline

> volume select bigvol shrink 50g

Be sure the container and/or application using the volume supports volumes
getting smaller. Shrinking a volume could result in losing data. Using the no-
adjust-snap-resv option can result in losing old snapshots. Do you really want
to continue? (y/n) [n] y

Creating snapshot.

volume select size


Increases the size of a volume.
NOTE: You cannot change the size of a template volume.

The new size will not be recognized by hosts currently connected to the volume unless they support
container expansion. Before increasing the volume size, understand the possible effect on the operating
system, container, or application using the volume, and set the volume offline first if necessary for your
environment.

NOTE: Some operating systems cannot support volumes larger than 2TB. A warning message is
displayed when you try to increase a volume beyond 2TB. Make sure your operating system will
recognize the new, larger volume size.

If you specify a size larger than the amount of available pool space, an error message shows the actual
available space.

478 Group Management Commands


Unless you specify the no-snap parameter, a snapshot will be created for the volume before the volume
size is increased.

Format
volume select volume_name size new_size [no-snap]

Variables
Variable Description
volume_name Name of a volume

new_size[unit] New, larger size for the volume. Size is in megabytes unless you specify
otherwise. You can specify size with any of the following suffixes: m,
mb, MB, g, gb, or GB.

Parameter
Parameter Description
[no-snap] (Optional) Prevents a snapshot of the volume from being created before
the size of the volume is increased

Examples
Increase the size of a volume:

> volume select voldb size 200gb

Increase the size of a volume, without creating a snapshot first:

> volume select volexchg3 size 2048mb no-snap

volume select snapshot


Manages snapshots of the selected volume.

Format
volume select volume_name snapshot subcommand

Variable
Variable Description
volume_name Name of a volume

Group Management Commands 479


Subcommands
Subcommand Description
create-now Creates a snapshot at the current time

delete Deletes a snapshot

rename Renames a snapshot

select Selects a snapshot for additional operations

show Shows all the volumes snapshots or details for a specific snapshot

volume select snapshot create-now


Creates a snapshot of the selected volume at the current time.
The snapshot name and the snapshot iSCSI target name are created automatically. The snapshot name,
which is used to manage the snapshot in the group, is based on the volume name, with a timestamp and
an identification number. The iSCSI target name, which is used by hosts to access the snapshot, starts
with the iSCSI target prefix (, by default), followed by a string, followed by the snapshot name.

Format
volume select volume_name snapshot create-now [parameter...]

Variable
Variable Description
volume_name Name of a volume

Parameters
Parameter Description
offline|online Snapshot status (default is offline)

read-write|read-only Snapshot permission (default is read-write)

description text Snapshot description, up to 127 ASCII characters, including colons,


hyphens, and periods. Fewer characters are accepted for this field if you
enter the value as a Unicode character string, which takes up a variable
number of bytes, depending on the specific character. If the text
contains spaces, enclose it in quotation marks.

480 Group Management Commands


Example
Create a snapshot at the current time with read-only permission:

> volume select dbvol snapshot create-now read-only

Snapshot creation succeeded.


snapshot name is dbvol-2015-01-25-11:28:01.5

volume select snapshot delete


Deletes a snapshot of the selected volume.
To display snapshot names, see volume select snapshot show.

Format
volume select volume_name snapshot delete snapshot_name

Variables
Variable Description
volume_name Name of a volume

snapshot_name Name of a snapshot

Example
Delete a snapshot:

> volume select vol2 snapshot delete vol2-2015-04-30-11:43:46.5

Do you really want to delete? (y/n) [n] y


Snapshot deletion succeeded.

volume select snapshot rename


Renames a snapshot of the selected volume.
Renaming a snapshot does not change the iSCSI target name for the snapshot. However, if the iSCSI
target alias is set to be the same as the snapshot name, the alias will change to match the new snapshot
name.

To display snapshot names, see volume select snapshot show.

Format
volume select volume_name snapshot rename snapshot_name new_name

Group Management Commands 481


Variables
Variable Description
volume_name Name of a volume

snapshot_name Current name of the snapshot

new_name New snapshot name, up to 127 characters. Fewer characters are


accepted for this field if you enter the value as a Unicode character
string, which takes up a variable number of bytes, depending on the
specific character.

Example
Rename a snapshot:

> volume select dbv snapshot rename dbv-2015-03-30-11:46:48.5 db33

volume select snapshot select


Selects a snapshot for additional operations.
To display snapshot names, see volume select snapshot show.

Format
volume select volume_name snapshot select snapshot_name subcommand |
parameter...

Variables
Variable Description
volume_name Name of a volume

snapshot_name Name of a snapshot

Subcommands
Subcommand Description
clone Clones a snapshot to create a new volume

restore Restores the volume from a snapshot

show [connections] Shows detailed information about a snapshot or about iSCSI


connections to a snapshot

482 Group Management Commands


Parameters
Parameter Description
description text Description for the snapshot, up to 127characters. Fewer characters are
accepted for this field if you enter the value as a Unicode character
string, which takes up a variable number of bytes, depending on the
specific character.
If the text contains spaces, enclose it in quotation marks.

iscsi-alias alias iSCSI target alias for the snapshot, up to 63 ASCII characters. Some
iSCSI initiators can see this alias.

isns-discovery enable| Enables or disables (default) automatic discovery by iSNS servers.


disable
By default, iSNS servers cannot discover iSCSI targets in a group. To
allow discovery by iSNS servers, you must enable this functionality on a
snapshot.

multihost-access Enables or disables multihost access to a snapshot


enable|disable

lost-blocks action Default policy when a snapshot has lost cache blocks. Either:
return-errorSets the snapshot online but retains the lost
cached block state. If an application tries to read a lost block, an
error occurs. If the block is rewritten, no error occurs, and the
snapshot state is changed to online-lost-cached-blocks.
mark-validMarks the lost blocks as valid and sets the snapshot
online. This action might present a security risk, and the blocks
might contain old data.

NOTE: Lost cached blocks can occur if a power failure lasts longer
than 72 hours.

offline|online Sets the snapshot online (can be discovered by initiators) or offline

read-only|read-write Makes the snapshot readable only, or both readable and writable

Examples
Set a snapshot online:

> volume select db snapshot select db-2015-01-30-10:59:46.1 online

Enable multihost access for a snapshot:

> volume select vol1 snapshot select vol1-2015-03-17-17:13:01.40 multihost-


access enable

Group Management Commands 483


volume select snapshot select clone
Clones the selected volume snapshot.
Cloning a snapshot creates a new standard volume, template volume, or thin clone volume with the
same contents as the original volume at the time the snapshot was created. Hosts can connect to the
new volume, and you can manage the volume as usual.

By default, new standard volumes are set online with read-write permission, and use the groupwide
snapshot space and iSCSI settings.

The new volume is in the same pool as the original volume. The snapshot remains available.

Format
volume select volume_name snapshot select snapshot_name clone new_volume
[parameters]

Variables
Variable Description
volume_name Name of a volume

snapshot_name Name of a snapshot

new_volume Name for the new volume

Parameters
Parameter Description
bind member Binds the new volume to the specified member. Volume data will be
restricted to this member.
Binding a volume to a member overrides any RAID preference for the
volume.

Binding does not apply to a thin clone snapshot.

description text Snapshot description, up to 127 characters. Fewer characters are


accepted for this field if you enter the value as a Unicode character
string, which takes up a variable number of bytes, depending on the
specific character.
If the text contains spaces, enclose it in quotation marks.

iscsi-alias alias iSCSI target alias for the snapshot, up to 63 ASCII characters. Some
iSCSI initiators can see the alias.
The default alias is the groupwide setting (see grpparams def-iscsi-
alias).

offline|online New volume status (the default is online)

484 Group Management Commands


Parameter Description
read-only|read-write New permission for standard volumes (the default is read-write).
Not applicable to cloning a template volume snapshot.

snap-depletion action Specifies the default snapshot space recovery policy, either delete-
oldest (delete the oldest snapshots; the default) or volume-offline
(set the volume and its snapshots offline).
The default policy is the groupwide setting (see grpparams def-snap-
depletion).

snap-reserve n% Amount of space, as a percentage of the new volume reserve, reserved


for snapshots of the new volume. You must include the percent sign
(%).
The default percentage is the groupwide setting (see grpparams def-
snap-reserve).

snap-warn n% Threshold at which an alarm occurs because the amount of free space
reserved for snapshots of the new volume has fallen below this value, as
a percentage of the snapshot reserve. You must include the percent
sign (%).
The default threshold is the groupwide setting (see grpparams def-
snap-warn).

unrestricted Grants unrestricted host access to the new volume. Unrestricted access
is not recommended. Instead, after cloning the snapshot, you should
create one or more basic access points for the volume to restrict host
access. See volume select access create.

Example
Clone a snapshot, creating a new volume:

> volume select stf snapshot select stf-10-2015-01-11-15:44:35.11 clone stf2

volume select snapshot select restore


Restores the volume from the selected snapshot.
NOTE: You cannot restore a template volume from a snapshot.

The restored volume contains the data that was in the volume at the time the snapshot was created and
has the original volume name and iSCSI target name.

NOTE: Before restoring a volume from a snapshot, disconnect any iSCSI initiators from the volume.
Follow the instructions for your operating system and initiator. Otherwise, the restored volume
might be corrupted when initiators reconnect to it.

The snapshot remains available after the restore operation.

The restored volume belongs to the same pool as the original volume.

Group Management Commands 485


In addition, before the restore operation starts, a snapshot of the current volume is created automatically.
This snapshot is named according to the normal rules for naming snapshots; that is, the volume name
plus a timestamp plus an identification number. If the restore operation fails, or if you want to return to
the current volume, you can restore the snapshot of the current volume.

Format
volume select volume_name snapshot select snapshot_name restore

Variables
Variable Description
volume_name Name of a volume

snapshot_name Name of a snapshot

Example
Restore a volume from a snapshot:

> volume select db snapshot select db-2015-07-10-10:34:16.8 restore

volume select snapshot select show


Shows details about the selected snapshot or connections to the snapshot.

Format
volume select volume_name snapshot select snapshot_name show [connections]

Variables
Variable Description
volume_name Name of a volume

snapshot_name Name of a snapshot

Example
Show detailed information about a snapshot:

> volume select newvol2 snapshot select inst-snap show

Table 8. Current Snapshot Status lists the possible values for the current status of a snapshot (Status
field).

486 Group Management Commands


Table 8. Current Snapshot Status

Status Description and Solution


online Administrator set the snapshot online. Authorized hosts can access the
snapshot, and no failures have occurred.

offline Administrator set the snapshot offline. Hosts cannot access the
snapshot, but no failures have occurred.

offline-lost-cached- Snapshot was automatically set offline because lost blocks have
blocks occurred. Hosts cannot access the snapshot.
Solution: Choose how to manage the lost blocks. See volume select
snapshot select.

offline-inconsistent Snapshot was automatically set offline due to data inconsistencies.


Contact your PS Series service provider for information about how to
proceed.

offline-member-down Snapshot was automatically set offline because a member that contains
snapshot data is down or cannot be accessed by the other members
over the network. Hosts cannot access the snapshot.
Solution: Identify and correct the problem that caused the member to
become unreachable.

offline-nospace-auto- Thin-provisioned volume and its snapshots were automatically set


grow offline because the pool does not have enough free space to increase
the volume reserve.
Solution: Add more space to the pool (such as by adding another
member to the pool).

offline-snap-reserve- Snapshot was automatically set offline because the reserved snapshot
met space has been used and the snapshot recovery policy dictates that the
snapshots be set offline. Hosts cannot access the snapshot.
Solution: Increase the amount of reserved snapshot space. See volume
select.

offline-max-grow-met Volume and its snapshots were set offline because the in-use volume
reserve reached the maximum in-use value.
Solution: Increase the value of the maximum in-use space level for the
volume (see volume select) or increase the volume size.

Table 9. Requested Snapshot Status lists the possible values for the requested status of a snapshot, which
is set by an administrator (DesiredStatus field).

Group Management Commands 487


Table 9. Requested Snapshot Status

Status Description
online Administrator set the snapshot online. Authorized hosts can access the
snapshot.

offline Administrator set the snapshot offline. Hosts cannot access the
snapshot.

online-lost-cached- Administrator set the snapshot online, with lost blocks.


blocks
Authorized hosts can access the snapshot. If an application tries to read
a lost block, an error occurs. If the block is rewritten, no error occurs
and the block is no longer marked as lost.

volume select snapshot show


Shows the snapshots for the selected volume or detailed information about a specific snapshot.

Format
volume select volume_name snapshot show [snapshot_name]

Variables
Variable Description
volume_name Name of a volume

snapshot_name Name of a snapshot

Example
Display information about a snapshot:

> volume select dbvol1 snapshot show

volume select snap-borrowing


Manages the snapshot space borrowing policy for a volume.

Format
volume select volume_name snap-borrowing enable|disable [no-adjust-snap-reserve]

Variable
Variable Description
volume_name Name of a volume

488 Group Management Commands


Parameters
Parameter Description
enable Enables snapshot space borrowing for a volume

disable Disables snapshot space borrowing for a volume

no-adjust-snap-reserve (Optional) Maintains the same percentage of snapshot reserve for the
volume, based on the new volume size. Might result in the loss of
snapshots.

Examples
Enable snapshot space borrowing for a volume:

> volume select voldb snap-borrowing enable

Enable snapshot space borrowing for a volume, without changing the existing snapshot reserve value:

> volume select volexchg3 snap-borrowing enable no-adjust-snap-reserve

volume select sync-rep


Manages synchronous replication (SyncRep) on a volume.
See the Dell EqualLogic Group Manager Administrator's Guide for detailed information about
synchronous replication.

Format
volume select volume_name sync-rep subcommand | parameter

Variable
Variable Description
volume_name Name of a volume

Parameter
Parameter Description
sync-active-offline Sets the volume offline and prevents new connections to the
pool_name SyncActive pool

Subcommands
Subcommand Description
disable Disables synchronous replication

enable pool_name Enables synchronous replication to the specified pool

Group Management Commands 489


Subcommand Description
failover Changes the current SyncActive pool. Data that has not been replicated
will be unavailable to clients, but stored in a snapshot in the current
pool, subject to policy. See volume select sync-rep failover.

pause Suspends synchronous replication

resume Resumes synchronous replication

show [-poolinfo | Shows summary information about synchronous replication:


connections]
Use the -poolinfo option to show information about the
SyncActive and SyncAlternate pools for the volume.
Use the connections option to show all current synchronous
replication connections to the volume.

switch pool_name Changes the SyncActive pool for the volume to the specified pool

Examples
Enable synchronous replication on a volume in the specified pool:

> volume select vol01 sync-rep enable pool1

Disable synchronous replication on a volume:

> volume select vol01 sync-rep disable

Pause synchronous replication on a volume:

> volume select vol01 sync-rep pause

Switch the SyncActive and SyncAlternate pools for a volume:

> volume select vol01 sync-rep switch syncpool

Set the volume offline and prevent access to the SyncActive pool:

> volume select vol01 sync-rep sync-active-offline syncpool

Show summary information about synchronous replication for the specified volume:

> volume select vol01 sync-rep show

SyncActivePool SyncAlternatePool Remaining Status SyncActiveOffline


--------------- ----------------- ---------- ----------- -----------------
default syncpool 0MB In-sync false

Show detailed information about the SyncActive and SyncAlternate pools for the specified volume:

> volume select kvol1 sync-rep show -poolinfo

Pool Role Status


--------------- --------------- -------
syncpool Alternate online
default Access online

490 Group Management Commands


Show detailed information about the replication connections to the specified volume:

> volume select kvol1 sync-rep show connections


Access Pool Alternate Pool Initiator UpTime RxData TxData
-------------- -------------- ------------- ------------ ----------- -----------
default syncpool 192.0.2.29 1hr 31min 52secs 135.00MB 0.00KB

volume select sync-rep failover


Manages synchronous replication (SyncRep) on a volume.
See the Dell EqualLogic Group Manager Administrator's Guide for detailed information about
synchronous replication.

Format
volume select volume_name sync-rep failover pool_name [force]

Variables
Variable Description
volume_name Name of a volume

pool_name Name of the storage pool that will become the new SyncActive pool

Parameter
Parameter Description
force Force failover even if no members in the current SyncActive pool are
online

volume select tag assign


Associates an existing tag to the volume.

Format
volume select volume_name tag assign tag_name[=tag_value]

Variables
Variables Description
volume_name Name of the volume to which you want to assign a tag

tag_name[=tag_value] Name of the selected tag and an optional value. If you do not specify a
value, the tag becomes a simple tag.

Group Management Commands 491


Example
Assign a tag to a volume:

> volume select Rtestvol tag assign Location[New York]

volume select tag create


Creates a new tag and adds it to the volume.

Format
volume select volume_name tag create tag_name[=tag_value]

Variables
Variables Description
volume_name Name of the volume for which you want to create a tag

tag_name[=tag_value] Name of the new tag and an optional value. If you do not specify a
value, the tag becomes a simple tag and has no value associated to it.

Example
Create a tag for a volume:

> volume select Rtestvol tag create Marketing=Technical

volume select tag show


Displays the tags associated to a specific volume.

Format
volume select volume_name tag show

Variable
Variable Description
volume_name Name of the volume for which you want to show tag information

Example
Show the tags associated to a volume:

> volume select Rtestvol tag show

Tag Name Tag Value


-------------------- --------------------
Location

492 Group Management Commands


tagtest tag1
Marketing Technical

volume select tag unassign


Disassociates a tag from a volume; however, it does not delete the tag.

Format
volume select volume_name tag unassign tag_name

Variables
Variables Description
volume_name Name of the volume that you want to unassign a tag from

tag_name Name of the selected tag

Example
Disassociate a tag from a volume:

> volume select Rtestvol tag unassign Location

volume show tag


Displays the volumes associated to the set of tag names and values. Tags can be filtered by using a
combination of commadelimited tag_name=tag_value pairs.

Format
volume show -tag [tag_name_1=tag_value_1,
tag_value_2, ...>;<tag_name_2=tag_value_1, tag_value_2,...]

Variable
Variable Description
tag_name[=tag_value] Name of the simple tag or tag with values that you want to show

Example
> volume show -tag tagtest=tag1;Marketing=Technical

Volume Name Tags


--------------- ------------------------------------------------------------
Rtestvol tagtest=tag1
Rtestvol Marketing=Technical

Group Management Commands 493


volume show
Shows the group volumes or detailed information about a specific volume, including basic access points
and in-progress operations (for example, replication, bind, or pool move operations).

Formats
volume show volume_name
volume show [-poolinfo] [-template] [-volume]

Variable
Variable Description
volume_name Name of a volume

Parameters
NOTE: Parameters can be specified in any order and any combination. However, if you specify both
-template and -volume, all volumes are displayed (-volume takes precedence).

Parameter Description
-poolinfo Includes the pool information in the command output. Cannot be used
when specifying a volume name.

-template Displays only the template volumes in the group. Cannot be used when
specifying a volume name.
When used with -poolinfo, shows the pool information for the
template volumes.

-volume Displays only regular volumes in the group (does not include template
volume information). Cannot be used when specifying a volume name.
When used with -poolinfo, shows the pool information for the
volumes.

Examples
Display all volumes on the group:

> volume show

Name Size Snapshots Status Permission Connections T


--------------- ---------- --------- ------- ---------- ----------- -
AP-1 10GB 1 online read-write 1 N
AP-RAID 10GB 2 online read-write 1 N
cwreptest 20GB 3 offline read-write 0 N
cwsyncrep2 20GB 1 offline read-write 0 N
purgetest-cw 10GB 0 offline read-write 0 N
crashtestdummy 100MB 11 online read-write 0 N

494 Group Management Commands


Display detailed information about a specific volume:

> volume show cranberry

_____________________________ Volume Information _____________________________


Name: cranberry Size: 100MB
VolReserve: 105MB VolReserveInUse: 0MB
ReplReserveInUse: 0MB iSCSI Alias: crashtestdummy
iSCSI Name: ActualMembers: 1
iqn.2002-10.com.companyA:0-8a0906- Snap-Warn: 10%
cfa4cd101-a3d001b6f9e4fc7b-crashtest Snap-Depletion: delete-oldest
dummy Description:
Snap-Reserve: 100% Snap-Reserve-Avail: 100% (105MB)
Permission: read-write DesiredStatus: online
Status: online Connections: 0
Snapshots: 11 Bind:
Type: not-replicated ReplicationReserveSpace: 0MB
Replicas: 0 ReplicationPartner:
Pool: default Transmitted-Data: 0MB
Received-Data: 0MB Pref-Raid-Policy: none
Pref-Raid-Policy-Status: none Thin-Provision: disabled
Thin-Min-Reserve: 0% (0MB) Thin-Growth-Warn: 0% (0MB)
Thin-Growth-Max: 0% (0MB) ReplicationTxData: 0MB
MultiHostAccess: disabled iSNS-Discovery: disabled
Replica-Volume-Reserve: 0MB Thin-Clone: N
Template: N NAS Container: N
Administrator: SyncReplStatus:
SyncReplTxData: 0MB Thin-Warn-Mode: offline
Snap-space Borrowing: enabled Space Borrowed: 0MB
Folder:
______________________________________________________________________________
_______________________________ Access Records _______________________________
ID Initiator Ipaddress AuthMethod UserName Apply-To
--- ----------------------------- --------------- ---------- ---------- ------
____________________________ Operations InProgress ___________________________
ID StartTime Progress Operation Details
-- -------------------- -------- ---------------------------------------------

Group Management Commands 495


3
Array Management Commands
The array management CLI commands act on an individual storage array and are often used to perform
maintenance.
NOTE: If you have a NAS cluster configured and you need to manage a NAS appliance, see nas-
cluster select appliance.

The description of each command includes the following information:


Command name
Brief description
Command format, options, variables, subcommands, and parameters
Examples

Running Array Management Commands


If you have a network connection, use telnet or ssh to connect to an IP address assigned to one of the
arrays network interfaces. Do not connect to the group IP address.

If you do not have a network connection, connect the serial cable that was shipped with the array to the
serial port on the active control module (ACT LED is lit and green) and to a console or computer running
a terminal emulator.

The serial connection must have these characteristics:

9600 baud
1 STOP bit
No parity
8 data bits
No hardware flow control

clearlostdata
Clears lost data blocks on an array.
CAUTION: Before using the clearlostdata command, contact your support provider.

You use the clearlostdata command when blocks have been lost, but the array does not know which
blocks have been lost. In this case, the array is not able to boot or is no longer accessible from the
network.

To access the CLI to run the clearlostdata command, see Running Array Management Commands.

After connecting to the array (either through a serial connection or a network connection to an IP
address for a network interface), press the Enter key and log in to a group administration account that has

496 Array Management Commands


read-write permission (for example, the grpadmin account). The console will describe the problem and
recommend that you use the clearlostdata command to try to correct the lost block problem. At the CLI
prompt, enter the clearlostdata command.

The clearlostdata command might or might not be able to correct the entire lost blocks problem. In
some cases, the problem might be corrected enough to boot the array. If volumes remain offline, you
might not be able to recover the data on them. In these cases, you must delete the volumes, recreate
them, and recover the data from a backup or replica.

If the array is a member of a group and the clearlostdata command does not resolve the problem, the
array will not boot and you might have to delete the member from the group. If you delete the member,
the array will be reset and returned to its factory defaults. Delete an offline member only in extreme
circumstances, because resetting the array will remove any data on the array. See member delete.

Format
clearlostdata

Example
Log in to the grpadmin account from a console terminal and run the clearlostdata command on the
array:

login: grpadmin
Password:
Welcome to Group Manager
Copyright 2001-2013 Dell Inc.
Data loss has occurred. The array will not initialize until the error condition
has been cleared.
> clearlostdata
cleaning luns
raid firing scan complete
.
.
.
>

diag
Collects diagnostic information from an array and sends it in an email message to your support provider.
Run the diag command only if instructed by your support provider.
NOTE: The diag output does not contain any data from user volumes in any form. This command
also does not collect any diagnostic data for a NAS cluster, if configured.

You can retrieve data collected from the diag command as follows:

Email If email event notification is enabled, and if at least one Ethernet interface on the array is up
and operational, the diag command output is automatically mailed to the email addresses configured
for notification or to those you specify with the -e option. The output is sent in one to eight separate
email messages, which are encoded for efficient transmission and are not human-readable. See
grpparams email-notify for information about configuring email event notification.
If a problem occurs between the SMTP server and the destination email client, the messages might
not be sent.
FTP or SCP If email notification is not enabled, or if the messages are not sent, you can log in to the
array with FTP or SCP and retrieve the files manually. However, this method relies on having at least

Array Management Commands 497


one Ethernet interface up and operational. Make sure that FTP service is enabled for the group; see
grpparams ftp-service.
Capturing the output using the console interface This method should be tried only if email and FTP
or SCP do not work. To use this method, configure your terminal emulator, telnet, or ssh client to
collect all the text that is sent to the screen, and answer y to the final prompt.

To access the CLI to run the diag command, see Running Array Management Commands.

After connecting to the array (either through a serial connection or a network connection to an IP
address for a network interface), press the Enter key and log in to a group administration account that has
read-write permission (for example, the grpadmin account). At the CLI prompt, enter the diag command.

Format
diag [support_arguments]

The available arguments will be explained by your support provider, who will guide you in using this
command. All options used must be enclosed in one set of quotation marks.

Examples

Collecting Diagnostic Data


In this example, email notification has already been configured to send the output to user@email.com:

PS Series Storage Arrays


Unauthorized Access Prohibited
login: grpadmin
Password:
Welcome to Group Manager
Copyright 2001 2015 Dell Inc.
> diag
The diag command will gather configuration data from this array
for support and troubleshooting purposes. No user information will
be included in this data.
Results will be sent to "user@mail.com" through e-mail.
If this is unsuccessful, other options for retrieving the results
will be presented at the end of the procedure.
Do you wish to proceed (y/n) [y]: y
Starting data collection on Mon Apr 6 11:44:53 EDT 2015.
Section 1 of 15: ..
Finished in 1 seconds
Section 2 of 15: .........0.........0...
Finished in 11 seconds
Section 3 of 15: ....
Finished in 8 seconds
Section 4 of 15: .........0......
Finished in 2 seconds
Section 5 of 15: .........0......
Finished in 4 seconds
Section 6 of 15: .........0........
Finished in 3 seconds
Section 7 of 15: .
Finished in 6 seconds
Section 8 of 15: ....
Finished in 1 seconds
Section 9 of 15: .........0.........0.
Finished in 1 seconds
Section 10 of 15: ...
Finished in 0 seconds

498 Array Management Commands


Section 11 of 15: .........0.........0........
Finished in 32 seconds
Section 12 of 15: ..
Finished in 0 seconds
Section 13 of 15: .
Finished in 30 seconds
Section 14 of 15: ...
0....0...0...0...0...0...0...0...0...0...0...0...0...0...0...0...0...
Finished in 55 seconds
Section 15 of 15: .
Finished in 0 seconds
Sending e-mail 1 of 5.
Sending e-mail 2 of 5.
Sending e-mail 3 of 5.
Sending e-mail 4 of 5.
Sending e-mail 5 of 5.
You have the option of retrieving the diagnostic data using FTP or SCP. To use
FTP, use the 'mget' command to retrieve all files matching the specification
"Seg_*.dgo". You must use the "grpadmin" account and password, and connect to
one of the IP addresses from the list below.
To use SCP, enter the command: 'scp -r grpadmin@x.x.x.x:. destdir' where
"x.x.x.x" is one of the IP addresses from the list below. Then, in the
destination location, look for files with the name "Seg_*.dgo". You can delete
any other files retrieved by scp.
Here are the IP addresses you can use to retrieve files from this member:
192.0.2.20
192.0.2.21
192.0.2.22
192.0.2.23
192.0.2.24
You also have the option to capture the output by using the "text capture"
feature of your Telnet or terminal emulator program.
Do you want to do this (y/n) [n]: n

Sending the Diagnostic Data to the Host


The following example shows how to use the FTP utility to copy the diag output file from the array to a
host. Use FTP on the host and enter the FTP open command, specifying an IP address for one of the
arrays network interfaces.

When prompted, enter the grpadmin account and password. Specify the diag output file with the mget
command.

$ ftp
ftp> open 192.0.2.46
Connected to 192.0.2.46.
220 192.0.2.46 FTP server ready.
User: grpadmin
331 Password required for grpadmin.
Password:
230 User grpadmin logged in.
Using binary mode to transfer files.
ftp> mget Seg_*.dgo
mget Seg_1.dgo? y
227 Entering Passive Mode (192,0,2,46,255,102)
150 Opening BINARY mode data connection for 'Seg_1.dgo' (614247 bytes).
226 Transfer complete.
614247 bytes received in 1.33 secs (4.5e+02 Kbytes/sec)
mget Seg_2.dgo? y
227 Entering Passive Mode (192,0,2,46,255,101)
150 Opening BINARY mode data connection for 'Seg_2.dgo' (880243 bytes).
226 Transfer complete.

Array Management Commands 499


880243 bytes received in 1.17 secs (7.3e+02 Kbytes/sec)
mget Seg_3.dgo? y
227 Entering Passive Mode (192,0,2,46,255,100)
150 Opening BINARY mode data connection for 'Seg_3.dgo' (317761 bytes).
226 Transfer complete.
317761 bytes received in 1.02 secs (3e+02 Kbytes/sec)
ftp> bye
221-
Data traffic for this session was 1812251 bytes in 3 files.
Total traffic for this session was 1813753 bytes in 6 transfers.
221 Thank you for using the FTP service on 192.0.2.46.

ping
Verifies connectivity from an array to other hosts on the network.
For example, you can use the ping command to test connectivity from an array to the host bus adapters
(HBAs) or NICs on a server. The command is also useful for verifying connectivity to the groups SMTP
server, NTP server, or default gateway.

If multiple network interfaces are configured on an array, you can specify the network interface from
which you want to test connectivity. If you do not specify a network interface on the array, any
configured interface will be used.

To access the CLI to run the ping command, see Running Array Management Commands.

After connecting to the array (either through a serial connection or a network connection to an IP
address for a network interface), press the Enter key and log in to a group administration account that has
read-write permission (for example, the grpadmin account). At the CLI prompt, enter the ping command.

To stop the command, enter Ctrl/C.

Format
ping [arguments]

Variable
Variable Description
arguments String consisting of arguments to the command enclosed in quotation
marks ().
To see all the valid arguments, run ping with no arguments.

Example
The following ping commands test connectivity from an array to a server and from a specific network
interface on an array to a server:

psg1> ping 192.0.2.25


PING 192.0.2.25 (192.0.2.22): 56 data bytes
64 bytes from 192.0.2.25: icmp_seq=0 ttl=59 time=0.000 ms
64 bytes from 192.0.2.25: icmp_seq=5 ttl=59 time=0.000 ms
^C
----192.0.2.22 PING Statistics----

500 Array Management Commands


6 packets transmitted, 6 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = 0.000/0.000/0.000/0.000 ms

psg1> ping "-I 192.0.26. 192.0.2.23"


PING 192.0.2.23 (192.0.2.23): 56 data bytes
64 bytes from 192.0.2.23: icmp_seq=0 ttl=127 time=0.000 ms
64 bytes from 192.0.2.23: icmp_seq=3 ttl=127 time=0.000 ms

^C
----192.0.2.26 PING Statistics----
4 packets transmitted, 4 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = 0.000/0.000/0.000/0.000 ms

ping6
Verifies connectivity from an array to other hosts on the IPv6 network.
For example, you can use the ping6 command to test connectivity from an array to the host bus adapters
(HBAs) or NICs on a server. The command is also useful for verifying connectivity to the groups SMTP
server, NTP server, or default gateway.

If multiple network interfaces are configured on an array, you can specify the network interface from
which you want to test connectivity. If you do not specify a network interface on the array, any
configured interface will be used.

To access the CLI to run the ping6 command, see Running Array Management Commands.

After connecting to the array (either through a serial connection or a network connection to an IPv6
address for a network interface), press the Enter key and log in to a group administration account that has
read-write permission (for example, the grpadmin account). At the CLI prompt, enter the ping6
command.

To stop the command, enter Ctrl/C.

Format
ping6 [arguments]

Variable
Variable Description
arguments String consisting of arguments to the command enclosed in quotation
marks ().
To see all the valid arguments, run ping6 with no arguments.

Examples
The following command tests connectivity between an array and an IPv6 host address on the network:

> ping6 fc00::192:0:2:29


PING6(56=40+8+8 bytes) fc00::309b:a426:a089:9bf3 --> fc00::192:0:2:29
16 bytes from fc00::192:0:2:29, icmp_seq=0 hlim=64 time=0 ms
16 bytes from fc00::192:0:2:29, icmp_seq=1 hlim=64 time=0 ms
16 bytes from fc00::192:0:2:29, icmp_seq=2 hlim=64 time=0 ms

Array Management Commands 501


16 bytes from fc00::192:0:2:29, icmp_seq=3 hlim=64 time=0 ms
16 bytes from fc00::192:0:2:29, icmp_seq=4 hlim=64 time=0 ms
16 bytes from fc00::192:0:2:29, icmp_seq=5 hlim=64 time=0 ms
^C
--- fc00::192:0:2:29 ping6 statistics ---
6 packets transmitted, 6 packets received, 0% packet loss
round-trip min/avg/max/std-dev = 0.000/0.000/0.000/0.000 ms

The following command also tests connectivity, but for a count of 4:

> ping6 "-c 4 fc00::192:0:2:29"


PING6(56=40+8+8 bytes) fc00::309b:a426:a089:9bf3 --> fc00::192:0:2:29
16 bytes from fc00::192:0:2:29, icmp_seq=0 hlim=64 time=0 ms
16 bytes from fc00::192:0:2:29, icmp_seq=1 hlim=64 time=0 ms
16 bytes from fc00::192:0:2:29, icmp_seq=2 hlim=64 time=0 ms
16 bytes from fc00::192:0:2:29, icmp_seq=3 hlim=64 time=0 ms
--- fc00::192:0:2:29 ping6 statistics ---
4 packets transmitted, 4 packets received, 0% packet loss
round-trip min/avg/max/std-dev = 0.000/0.000/0.000/0.000 ms

reset
Resets an array to the factory defaults (original condition).
The reset command shows a confirmation message to which you must agree before it starts the
operation and, in a multimember group, logs an event message on the remaining members.

CAUTION: Before resetting an array, call your PS Series support provider. The reset command
irretrievably removes all group, member, and volume configuration information and any volume
data on the array. The array will not be able to connect to a group until you add it to the group.

If an array is a member of a multimember group, use the member delete command to remove the
member from the group, which automatically runs the reset command. Volume data on the array is
automatically moved to the remaining group members if possible. See member delete.

If the array is the only remaining member of a group, run the reset command. (You cannot use the
member delete command on the last member of a group.)

To access the CLI to run the reset command, see Running Array Management Commands.

When you are connected to the array (either through a serial connection or a network connection to an
IP address for a network interface), press the Enter key and log in to a group administration account that
has read-write permission (for example, the grpadmin account). At the CLI prompt, enter the reset
command. When you agree to reset the array, network connections are closed.

Format
reset

Example
When you run the reset command and agree to the operation, the network connection closes:

PS Series Storage Arrays


Unauthorized Access Prohibited

login: grpadmin

502 Array Management Commands


Password:
Welcome to Group Manager
Copyright 2001-2015 Dell Inc.
member2> reset
Warning: This command resets an array to the factory
defaults (original condition). The result is the
elimination of all group and volume configuration
information and any volume data residing on the array.
Before resetting an array that is a member of a group,
it is recommended that you delete the member from the
group.
This member member2
IP Addresses associated with this member:
inet 192.0.2.28
inet6 fc00::28a6:b228:5f19:7f6c
inet 192.0.2.29
inet6 fc00::d49a:4461:e30b:990c
inet 192.0.2.30
inet6 fc00::cc3f:f0d9:5ec1:c900
Reset this array to factory defaults? [n/DeleteAllMyDataNow]

restart
Shuts down and restarts an array.
Restarting an array has no effect on member, volume, or group configuration information or volume
data. When the restart completes, the member rejoins the group automatically. Volumes with data
located on the member will be unavailable until the restart completes.

NOTE: Restart an array only when you are updating the array firmware. Do not restart an array
repeatedly.

To access the CLI to run the restart command, see Running Array Management Commands.

When you are connected to the array (either through a serial connection or a network connection to an
IP address for a network interface), press the Enter key and log in to a group administration account that
has read-write permission (for example, the grpadmin account). At the CLI prompt, enter the restart
command.

When you restart an array, network connections are closed and the array is shut down. Then, the array
restarts automatically.

NOTE: If you physically connect a serial cable to the secondary control module and run the restart
command, only the secondary control module will be restarted.
To restart both control modules, connect the cable to the active control module (ACT LED will be
green) and run the restart command. Then, connect the cable to the other control module (now the
active control module) and run the restart command again.

Format
restart

Array Management Commands 503


Example
When you run the restart command and type yes at the confirmation prompt, the network connection
closes.

PS Series Storage Arrays


Unauthorized Access Prohibited

login: grpadmin
Password:

Welcome to Group Manager


Copyright 2001-2014 Dell Inc.

psg22> restart
Do you really want to restart the system? (yes/no) [no] yes
Connection closed by foreign host.$

setup
Configures an array as either the first member of a new group or as an additional member to an existing
group.
NOTE: If you are adding multiple members to an existing group, or creating a new group with
multiple members, run the setup command on one array at a time. Wait until the new group is
created with one member or until each new member is added to an existing group before adding
the next member.

Format
setup [ipv6] [def_dcb_vlan_id] [show-version]

Options
Option Description
ipv6 Sets up a group to use IPv6 addresses

def_dcb_vlan_id Sets up a group to use data center bridging (DCB) or adds a member to
a group already using DCB. Enter an ID in the range of 0 to 4095. The
default is 2.

show-version Displays the arrays firmware version

Internet Protocol Options


When creating a new group, you can use the IPv4 or IPv6 protocol, depending on your network
environment.

When adding a member to an existing group, the new member must use the same protocol as the group.
If the member is joining an IPv6 group, specify the ipv6 option with the command.

504 Array Management Commands


After a group is set up, you can later change its protocol with some restrictions. If the group has a
configured replication partner, you must change the partner network address on both groups.

Both groups must use a common protocol for replication to succeed. For example, if one group uses
only IPv4 and the other group can use either IPv4 or IPv6, replication is supported. If one group uses only
IPv4 and the other uses only IPv6, replication is not supported.

For more information about the supported protocol configurations on replication partners, see partner
create.

Creating and Joining IPsec-Enabled Groups


The setup command attempts to join existing groups using IPsec, a process that takes approximately 30
seconds to complete. If the member cannot be added to the group using IPsec, setup will attempt to add
the group without using IPsec.

IPsec is not enabled automatically when creating a new group. It must be enabled manually after the
group has been created.

If you attempt to add a member that does not support IPsec to an existing group in which IPsec is used,
setup will be unable to add the member to the group. See the Dell EqualLogic PS Series Storage Arrays
Release Notes for information about which array models support IPsec.

During the setup process, you might see a series of repeating error messages. For example:

# 3255:1361:quicksecpm:17-May-2015
13:37:22.431122:util_render.c:254:ERROR::65.4.1:IPsec (IKEv2) negotiation
failed as responder to remote identity: '192.0.2.37: (null)', using local
identity: '192.0.2.37: (null)'.
3257:1363:quicksecpm:17-May-2015
13:37:22.431124:util_render.c:323:ERROR::65.4.7:The IPsec or IKE protocols or
algorithms proposed by the peer do not match what is available on the array.

You can safely ignore these messages. The member is being added to the group successfully. These error
messages will be removed in a future release.

Data Center Bridging


If you are adding a member to a group that uses data center bridging (DCB), or creating a new group that
will use DCB, you must use the def_dcb_vlan_id parameter and specify the DCB VLAN ID for the new
or existing group.

To find the DCB VLAN ID of an existing group, log in to the Group Manager GUI or CLI.

In the GUI, click Group Group Configuration Advanced. The DCB VLAN ID is displayed in the
Network Management pane.
In the CLI, enter grpparams show. The DCB VLAN ID is displayed in the output.

By default, when you log in to an unconfigured array, the array prompts you to set it up. If you enter y,
the array starts the default setup operation. You must enter Ctrl-C to cancel out of the setup, and then
type the following command line at the prompt to enable DCB, specifying a number from to 4094,
inclusive:

> setup def_dcb_vlan_id

Array Management Commands 505


Continue with the remaining setup steps as usual.

Examples

Creating an IPv4 Group


Create a new group using the default IPv4 protocol for the network interface and the group address. IPv4
is the only supported protocol for all versions of PS Series firmware prior to v5.0.

> setup
Group Manager Setup Utility

The setup utility establishes the initial network and storage configuration for
a storage array and then configures the array as a member of a new or existing
group of arrays.

For help, enter a question mark (?) at a prompt.

Do you want to proceed (yes | no) [no]: yes

Initializing. This may take several minutes to complete..


Enter the network configuration for the array.

Member name []: member1


Network interface [eth0]:
IP address for network interface []: 192.0.2.51
Netmask [255.255.255.0]: 255.255.0.0
Default gateway [192.0.2.38]:

Initializing interface eth0. This may take a minute.....

Enter the IP address and name of the group that the array will join.

Group name []; v4group


Group IP address []: 192.0.2.50

Searching to see if the group exists. This may take a few minutes.

The group does not exist or currently cannot be reached. Make sure
you have entered the correct group IP address and group name.

Do you want to create a new group (yes | no) [yes]: yes


Group Configuration

Group Name: v4group


Group IP address: 192.0.2.50
Do you want to use the group settings shown above (yes | no) [yes]: yes
Password for managing group membership: ********
Retype password for verification: ********

Password for the default group administration (grpadmin) account: *******


Retype password for verification: *******

Saving the configuration...

Waiting for configuration to become active.....

Group v4group has been created with one member.


Use the Group Manager GUI or CLI to set the RAID policy for the member. You
can then create a volume which a host can connect to using an iSCSI initiator.

506 Array Management Commands


To access the Group Manager GUI, specify http://group_ip_address in a web
browser window. To access the CLI, use telnet or SSH to connect to the group
IP address from a remote terminal, or attach a console terminal directly to a
serial port on a group member's active control module. See the Group
Administration manual for more information.

v4group>

Joining an IPsec-Enabled Group (IPv4)


Join an existing group that is using IPsec. The array being added to the group must also be IPsec-
capable.

> setup
login: grpadmin
Password:

Welcome to Group Manager

Copyright 2001-2015 Dell Inc.

It appears that the storage array has not been configured.


Would you like to configure the array now ? (y/n) [n] yes

Group Manager Setup Utility


The setup utility establishes the initial network and storage configuration for
a storage array and then configures the array as a member of a new or existing
group of arrays.

For help, enter a question mark (?) at a prompt.


Do you want to proceed (yes | no ) [no]: yes

Initializing. This may take several minutes to complete.

Enter the network configuration for the array.


Member name []: gigan39
Member name []: gigan39
Network interface [eth0]:
IP address for network interface []: 192.0.2.51
Netmask [255.255.255.0]: 255.255.0.0
Default gateway [192.0.2.38]:

Initializing interface eth0. This may take a minute.....

Enter the IP address and name of the group that the array will join.

Group name []: gigan38-grp


Group IP address [192.0.2.40]:

Searching to see if the group exists. This may take a few minutes.

The specified group exists with IPSec enabled. Will attempt to connect with
IPSec, which requires the membership password.

Password for managing group membership:

Attempting to connect to the group with IPSec...

Do you want to add this array to group gigan38-grp (yes | no ) [yes]: yes

Synchronizing configuration data with the group. This may take several
minutes.--

Array Management Commands 507


Saving the configuration...

Waiting for configuration to become active...

Group member gigan39 now active in the group.

Done

The array has successfully become a member of group gigan38-grp.


You must now configure the RAID set using the Group manager GUI or CLI.
Configuration of the RAID set requires that the raid-level be selected.

Group member gigan38 now active in the group.

Creating an IPv6 Group


An IPv4 setup and an IPv6 setup include the following differences:

The first time you log in to an uninitialized array (when creating a new group or when adding a
member to a group),setup starts automatically and, by default, uses the IPv4 protocol. Cancel the
setup (enter n at the prompt that asks if you want to set up the array) and enter the command: setup
ipv6.
You do not have to enter an IP address for the network interface (eth0). Your router broadcasts
available addresses (shown during the setup) and the network interface uses one of those addresses.
No subnet mask is required or applicable for IPv6.
When creating a new group or specifying the group that a member will join, enter the group IP
address in IPv6 format (for example, fc00::abc1:def2:cba3:fed4) instead of IPv4 format (for
example, 192.0.2.33).

The following example shows how to set up a new group using the IPv6 protocol for the Ethernet 0
network interface and the group address. Note that you do not have to enter an IP address for the
Ethernet 0 interface. Press Enter at the prompt to let the interface use one of the broadcast addresses.

> setup ipv6

Group Manager Setup Utility

The setup utility establishes the initial network and storage


configuration for a storage array and then configures the array
as a member of a new or existing group of arrays.

For help, enter a question mark (?) at a prompt.

Do you want to proceed (yes | no) [no]: yes

Initializing. This may take several minutes to complete.


Enter the network configuration for the array.

Member name []: member1


Network interface [eth0]:
Acquiring dynamic addresses on interface eth0...
IPv6: name[eth0] addr[fe80:2::50d4:f757:9006:f0f0]
IPv6: name[eth0] addr[fc00::50d4:f757:9006:f0f0]
IP address for network interface []: [Enter]

Initializing interface eth0. This may take a minute.....


Enter the IP address and name of the group that the array will join.
Group name []: v6group
Group IP address []: fc00::abc1:def2:cba3:fed4

508 Array Management Commands


Searching to see if the group exists. This may take a few minutes.

Attempting to connect to the group with IPsec...


Attempting to connect to the group without IPsec...

The group does not exist or currently cannot be reached. Make sure you have
entered the correct group IP address and group name.

Do you want to create a new group (yes | no) [yes]: yes


Group Configuration

Group Name: v6group


Group IP address: fc00::abc1:def2:cba3:fed4

Do you want to use the group settings shown above (yes | no) [yes]:

Do you want to use the group settings shown above (yes | no) [yes]: yes
Password for managing group membership:**********
Retype password for verification:**********

Password for the default group administration account:**********


Retype password for verification:**********
Saving the configuration...

Waiting for configuration to become active.....

Group v6group has been created with one member.


Use the Group Manager GUI or CLI to set the RAID policy
for the member. You can then create a volume which
a host can connect to using an iSCSI initiator.

To access the Group Manager GUI, specify http://group_ip_address in a Web


browser window. To access the CLI, use telnet or SSH to connect to the group
IP address from a remote terminal, or attach a console terminal directly to a
serial port on a group member's active control module. See the Dell EqualLogic
Group Manager Administrator's Manual for more information.

v6group>

shutdown
Cleanly shuts down an array.

Format
shutdown

About Shutting Down an Array


Shutting down an array has no effect on member, volume, or group configuration information or volume
data stored on the member. Any volumes with data on the array will be set offline until the array is
completely restarted. When the array is restarted, it rejoins the group automatically.

NOTE: The shutdown command does not power off the array. To power off the array, you must
turn off both power supplies after the array shuts down.

Do not repeatedly shut down and restart an array.

Array Management Commands 509


To access the CLI to run the shutdown command, see Running Array Management Commands.

When you are connected to the array (either through a serial connection to the active control module or
a network connection to an IP address for a network interface), press the Enter key and log in to a group
administration account that has read-write permission (for example, the grpadmin account). At the CLI
prompt, enter the shutdown command. After you agree to shut down the array, network connections are
closed and the array is shut down.

The shutdown procedure differs depending on the type of connection that you are using:
Network connections
The session will be disconnected before the array is shut down. Make sure that the ACT LED on each
control module is off (not lit) before turning off power to both power supplies.
Serial connections
The shutdown procedure differs depending on the type of controller that you are using:
Types 78, 1014, and 17 (for example, on PS6110 arrays)
When it is safe to turn off power to both power supplies, the system displays the following
message on the console:
Press any key to reboot.

Both controllers will start up.


Types 15, 18, and 19 (for example, on PS6210 arrays)
The system displays information similar to the following output:
Main power usage is 67.6798 watts
sbs_ship_mode:Ship Mode request sent to battery

PLEASE WAIT FOR SHIP MODE CONFIRMATION MESSAGE!!

Waiting for Ship Mode entry:5 sec


Waiting for Ship Mode entry:10 sec
Waiting for Ship Mode entry:15 sec
Waiting for Ship Mode entry:20 sec
Check peer controller completion
No peer responding, peer battery is off
Batteries are now in Ship Mode - it is safe to power the array off!

To fully restart the array, turn power off, and then on, to both power supplies. When the array
restart completes, volumes will be set online.

NOTE: If you physically connect a serial cable to the secondary control module and run the
shutdown command, only the secondary control module will be shut down. To shut down both
control modules, connect the serial cable to the active control module (ACT LED will be green)
and run the shutdown command.

Example
When you run the shutdown command and agree to the operation, the network connection closes.

PS Series Storage Arrays


Unauthorized Access Prohibited

login: grpadmin
Password:

Welcome to Group Manager


Copyright 2001-2015 Dell Inc.

510 Array Management Commands


psg22> shutdown
Do you really want to shutdown the system? (yes/n) [n] y
Connection closed by foreign host.$

update
Updates array firmware.
A storage array includes single or dual control modules, each with a compact flash or microSD card
running the firmware. You should always run the latest storage array firmware to take advantage of new
product features, enhancements, and fixes. All group members must be running the current firmware
version for the latest features and fixes to known issues for the update to take effect.

NOTE: If the group has the Email Home feature enabled, email is sent to customer support when
you update the group members. To prevent this action, temporarily disable the Email Home feature
(either in the GUI or with the grpparams email-contact command) or, during the update, respond
with no to the prompt asking whether to send email to customer support. See the example below.

Requirements
Read Updating Firmware for Dell EqualLogic PS Series Storage Arrays and FS Series Appliances on the Dell
support site for prerequisites, instructions, limitations, and supported upgrade paths for updating array
firmware. Also read the current Dell EqualLogic PS Series Storage Arrays Release Notes before starting the
update.

Format
update

Example
The following example shows the update process.

login as: grpadmin


grpadmin@192.0.2.36's password:

Welcome to Group Manager

Copyright 2001-2015 Dell Inc.

glasgow> update
13:36:51 Updating from kit file "kit_V6.0.0-R257672_1974509013.tgz"

This command will update the firmware on the array's flash card memory
using the update kit file that was copied to the array.

If you choose to proceed, you will be shown the current firmware version
and the version to which you will update. You will then be given the
choice to proceed again.

Do you want to proceed (y/n) [y]: y

13:36:56 Verifying kit integrity.


13:37:26 Active and secondary controllers detected.
13:37:32

Array Management Commands 511


13:37:32 To better support our customers, your PS Series support provider
13:37:32 requests that you notify us when you update storage array firmware.
13:37:32
13:37:33 When the update procedure completes, the update procedure
13:37:33 will automatically send e-mail to the e-mail addresses
13:37:33 you have configured for event notification:
13:37:33
13:37:33 admin@company.com
13:37:33
13:37:33 E-mail notification requires connectivity from the array to the
13:37:33 Internet through the SMTP server at address 192.0.2.42. If
13:37:33 the SMTP server is not available or does not have access to the
13:37:34 Internet, you can forward the message from one of the e-mail
13:37:34 addresses configured for event notification to
13:37:34 update-notice@dell.com.
Do you want to automatically send a notification e-mail when
the update completes: (y/n) [y]: y
13:37:46
13:37:46 Currently running version is: Unreleased V6.0.0 (R249640)
13:37:46 You will be updating to version: Storage Array Firmware V6.0.0
(R257672)
13:37:46
The firmware update will not take effect until you restart the array.
Do you want to proceed (y/n) [n]: y
13:38:35 Preparing to update active controller.
13:38:37 Updating flash memory on active controller.
13:38:37 This will take several minutes.
13:41:30 Update of flash memory on active controller completed.
13:41:35 Updating flash memory on secondary controller.
13:41:35 This will take several minutes.
13:41:39 Preparing to update secondary controller.
13:49:15
13:49:16 Update completed successfully.
13:49:16
13:49:16 The firmware update will take effect when the array is restarted. To
13:49:16 restart the array, enter the restart command at the CLI prompt.

512 Array Management Commands


4
Global Commands
The global commands control the behavior of the Group Manager command-line interface (CLI).
The description of each command includes the following information:

Brief description
Command format
Variables, subcommands, and parameters
Examples

alias
Performs text substitution.

Format
alias alias_name original_text

Variables
Variable Description
alias_name Text to use as the alias

original_text Text that alias_name replaces.


If the original_text variable contains spaces, enclose it in quotation
marks.

Example
Create an alias to select member1:

> alias ms1 "member select member1"

clear
Clears the screen.

Format
clear

Global Commands 513


cli-settings
Specifies certain CLI settings.

Format
cli-settings show|parameter

Parameters
Parameter Description
confirmation on|off Prompts (default) or does not prompt for confirmation for all
commands.

NOTE: Disabling confirmation can be dangerous. Some critical


commands prompt for a response before starting the operation
(such as delete, logout, passwd, restart, and shutdown).
Changes take effect immediately for the user who changed it and for
users who subsequently log in as grpadmin. Any other current grpadmin
CLI sessions are not changed.

displayinMB on|off Shows group, volume, and member sizes in megabytes (default) or
gigabytes

events on|off Shows (default) or does not show events on the console

formatoutput on|off Formats (default) or does not format command output for show
commands

idlelogout on|off Enables or disables automatic logout of a CLI session that has been
inactive for 60 minutes

paging on|off Shows one screen (page) of output at a time and prompts you to show
the next screen (default) or shows all the output at once

reprintBadInput on|off Specifies whether or not to reprint erroneous command-line input back
to the CLI during telnet sessions to the group. Default is on (bad input
will be reprinted).

Examples

Changing the Unit of Measure


Turn off displayinMB:

> cli-settings displayinMB off

> volume show

Name Size Snapshots Status Permission Connections T


--------------- ---------- --------- ------- ---------- ----------- -
A 2GB 2 online read-write 0 N
B 3GB 2 online read-write 0 N

514 Global Commands


C 1GB 2 online read-write 0 N
D 1GB 2 online read-write 0 N
E 1GB 2 online read-write 0 N
F 4GB 2 online read-write 0 Y
G 4GB 2 online read-write 0 Y
H 1GB 2 online read-write 0 N
I 1GB 2 online read-write 0 N
J 4GB 2 online read-write 0 Y
K 4GB 2 online read-write 0 Y

Turn on displayinMB:

> cli-settings displayinMB on

> volume show

Name Size Snapshots Status Permission Connections T


--------------- ---------- --------- ------- ---------- ----------- -
A 2048MB 2 online read-write 0 N
B 3072MB 2 online read-write 0 N
C 1024MB 2 online read-write 0 N
D 1024MB 2 online read-write 0 N
E 1024MB 2 online read-write 0 N
F 4096MB 2 online read-write 0 Y
G 4096MB 2 online read-write 0 Y
H 1024MB 2 online read-write 0 N
I 1024MB 2 online read-write 0 N
J 4096MB 2 online read-write 0 Y
K 4096MB 2 online read-write 0 Y

Disabling Formatted Output


Turn off formatoutput:

> cli-settings formatoutput off

> grpparams show

_______________________________ Group Information ____________________________


Name: Pirates
Group-Ipaddress: 192.0.2.34
Def-Snap-Reserve: 150%
Def-Snap-Warn: 10%
Def-Snap-Depletion: delete-oldest
Def-Thin-Growth-Warn: 60%
Def-Thin-Growth-Max: 100%
DateAndTime: Mon Feb 09 16:52:01 2015
TimeZone: America/New_York
Description:
Def-Iscsi-Prefix: iqn.2002-10.com.companyA
Def-Iscsi-Alias: yes
Info-Messages: enabled
Webaccess: enabled
Webaccess-noencrypt: enabled
Cliaccess-SSH: enabled
Cliaccess-Telnet: enabled
Email-Notify: enabled
Syslog-Notify: disabled
iSNS-Server-List:
Email-List:
NtpServers:
Smtp-Server-List:
DNS-Server-List:

Global Commands 515


DNS-Suffix-List:
Syslog-Server-List:
Target-Auth-UserName: 8pZ2RbJbXBPBRzJB
Target-Auth-Password: jBrXJjzHJhJBHXxH
Email-From: Pirates_group@equallogic.com
Location: default
Conn-Balancing: enabled
Discovery-Use-Chap: disabled
Email-Contact:
Perf-balancing: enabled
Disallow-Downgrades: yes
Management-Ipaddress:
Aggressive-Congestion-Avoidance: none
SSH-V1-Protocol: enabled
FTP-service: enabled
Standby-Button: disabled
DCB: enabled
Def-DCB-VLAN-Id: 0
Thermal-Shutdown: enabled
Crypto-Legacy-Protocols: enabled
______________________________________________________________________________
_____________________________ Radius Information _____________________________
radius-auth-list:
login-radius-auth: disabled
radius-auth-retries: 1
radius-auth-timeout: 2secs
login-radius-acct: disabled
radius-acct-retries: 1
radius-acct-timeout: 2secs
iscsi-radius-auth: disabled
iscsi-local-auth: enabled
radius-acct-list:
login-radius-attr: enabled
______________________________________________________________________________
______________________________ Snmp Information ______________________________
read-only-comms:
read-write-comms:
trap-community: SNMP-trap
snmp-managers:
______________________________________________________________________________

Enabling Formatted Output


Turn on formatoutput (default):

> cli-settings formatoutput on

> grpparams show

______________________________ Group Information _____________________________


Name: Pirates Group-Ipaddress: 192.0.2.34
Def-Snap-Reserve: 150% Def-Snap-Warn: 10%
Def-Snap-Depletion: delete-oldest Def-Thin-Growth-Warn: 60%
Def-Thin-Growth-Max: 100% DateAndTime: Mon Feb 09 16:49:12 2015
TimeZone: America/New_York Description:
Def-Iscsi-Prefix: Def-Iscsi-Alias: yes
iqn.2002-10.com.companyA Info-Messages: enabled
Webaccess: enabled Webaccess-noencrypt: enabled
Cliaccess-SSH: enabled Cliaccess-Telnet: enabled
Email-Notify: enabled Syslog-Notify: disabled
iSNS-Server-List: Email-List:
NtpServers: Smtp-Server-List:
DNS-Server-List: DNS-Suffix-List:

516 Global Commands


Syslog-Server-List: Target-Auth-UserName:
Target-Auth-Password: 8pZ2RbJbXBPBRzJB
jBrXJjzHJhJBHXxH Email-From:
Location: default Penguins_group@companyA.com
Conn-Balancing: enabled Discovery-Use-Chap: disabled
Email-Contact: Perf-balancing: enabled
Disallow-Downgrades: yes Management-Ipaddress:
Aggressive-Congestion-Avoidance: none SSH-V1-Protocol: enabled
FTP-service: enabled Standby-Button: disabled
DCB: enabled Def-DCB-VLAN-Id: 0
Thermal-Shutdown: enabled Crypto-Legacy-Protocols: enabled
______________________________________________________________________________
_____________________________ Radius Information _____________________________
adius-auth-list: login-radius-auth: disabled
radius-auth-retries: 1 radius-auth-timeout: 2secs
login-radius-acct: disabled radius-acct-retries: 1
radius-acct-timeout: 2secs iscsi-radius-auth: disabled
iscsi-local-auth: enabled radius-acct-list:
login-radius-attr: enabled
______________________________________________________________________________
______________________________ Snmp Information ______________________________
read-only-comms: read-write-comms:
trap-community: SNMP-trap snmp-managers:
______________________________________________________________________________

exec
Runs the commands contained in a CLI script file (a file containing other CLI commands). A script can
change terminal settings, perform basic group administration tasks, and collect system information.
NOTE: Make sure you are in the usr subdirectory when you put the script file on the array, as shown
in the example below, whether using the ftp command line or Windows Explorer.

Format
exec [parameter] [path]/filename

Parameters
Parameter Description
-echo Echoes contents of the file during execution

-ignore When errors occur, ignores them and continues execution

-history Captures script execution to the history buffer

Variables
Variable Description
filename Name of the file to execute.

path Path of the file to execute.


The default path is /mgtdb/update/usr. If your file is in that directory,
you do not need to specify the path.

Global Commands 517


Variable Description
Otherwise, specify the path relative to the /mgtdb/update/usr directory.
For example, for a file in the /mgtdb/update directory, use ../myFile.

Examples

Transferring a Script to the Array


Transfer a script file to the array using ftp:

C:\Users\george>ftp 192.0.2.45
Connected to 192.0.2.45.
220 192.0.2.45 FTP server (NetBSD-ftpd 20040809) ready.
User (192.0.2.45:(none)): grpadmin
331 Password required for grpadmin.
Password:
230 User grpadmin logged in.
ftp> dir
200 PORT command successful.
150 Opening ASCII mode data connection for '/bin/ls'.
total 90
-rw------- 1 0 0 67 Feb 18 15:45 .bash_history
-rw-r--r-- 1 0 0 10944 Feb 18 17:50 gigan-grp-config
-rw-r--r-- 1 0 0 10944 Feb 18 17:50 gigan-grp-config.cfg
-rw-r--r-- 1 0 0 9559 Feb 18 17:50 index.html
-rw-r--r-- 1 0 0 10944 Feb 18 17:49 mrtg.cfg
drwxrwxrwx 2 0 0 512 Feb 9 11:22 usr
226 Transfer complete.
ftp: 326 bytes received in 0.00Seconds 108.67Kbytes/sec.
ftp> cd usr <-- Make sure you change to the usr directory.
250 CWD command successful.
ftp> put script.txt
200 PORT command successful.
150 Opening BINARY mode data connection for 'script.txt'.
226 Transfer complete.
ftp: 34 bytes sent in 0.20Seconds 0.17Kbytes/sec.
ftp> dir
200 PORT command successful.
150 Opening ASCII mode data connection for '/bin/ls'.
total 2
-rw-r----- 1 1001 0 34 Mar 3 14:59 script.txt
226 Transfer complete.
ftp: 60 bytes received in 0.00Seconds 60.00Kbytes/sec.
ftp> bye
221-
Data traffic for this session was 34 bytes in 1 file.
Total traffic for this session was 1211 bytes in 3 transfers.
221 Thank you for using the FTP service on 192.0.2.45.
C:\Users\george>

Running a Script
Run the script myScript.txt, which displays the following information:

Current user name (whoami command)


Group configuration (grpparams show command)

518 Global Commands


Volumes on the group (volume show command)

> exec myScript.txt


grpadmin
______________________________ Group Information _____________________________
Name: gigan34-grp Group-Ipaddress: 192.0.2.53
Def-Snap-Reserve: 100% Def-Snap-Warn: 10%
Def-Snap-Depletion: delete-oldest Def-Thin-Growth-Warn: 60%
Def-Thin-Growth-Max: 100% DateAndTime: Wed Mar 11 15:00:25 2015
TimeZone: America/New_York Description:
Def-Iscsi-Prefix: Def-Iscsi-Alias: yes
iqn.2002-10.com.companyA Info-Messages: enabled
Webaccess: enabled Webaccess-noencrypt: enabled
Cliaccess-SSH: enabled Cliaccess-Telnet: enabled
Email-Notify: disabled Syslog-Notify: disabled
iSNS-Server-List: Email-List:
NtpServers: Smtp-Server-List:
Syslog-Server-List: Target-Auth-UserName:
Target-Auth-Password: 8Hxx8xR8HrPXRXP8
H2ZXJbX2XjrX8BRH Email-From:
Location: default Conn-Balancing: enabled
Discovery-Use-Chap: disabled Email-Contact:
Perf-balancing: enabled Disallow-Downgrades: yes
Management-Ipaddress: Aggressive-Congestion-Avoidance: none
SSH-V1-Protocol: enabled FTP-service: enabled
______________________________________________________________________________
_____________________________ Radius Information _____________________________
radius-auth-list: login-radius-auth: disabled
radius-auth-retries: 1 radius-auth-timeout: 2secs
login-radius-acct: disabled radius-acct-retries: 1
radius-acct-timeout: 2secs iscsi-radius-auth: disabled
iscsi-local-auth: enabled radius-acct-list:
login-radius-attr: enabled
______________________________________________________________________________
______________________________ Snmp Information ______________________________
read-only-comms: public read-write-comms:
trap-community: SNMP-trap snmp-managers:
______________________________________________________________________________
Name Size Snapshots Status Permission Connections TP
--------------- ---------- --------- ------- ---------- ----------- -
collie-trial 10GB 0 online read-write 0 Y
vol1 100MB 1 online read-write 0 N
volthin1 150GB 1 online read-only 0 Y
volthin2 100GB 1 online read-only 0 Y
voltest 100MB 0 online read-write 0 N
kvoladmin.1 10GB 3 online read-write 0 Y
test123 2GB 0 online read-write 0 N
dragontest.1 3GB 3 online read-write 0 Y

exit
Moves the user up one or all command levels from subcommand mode.

Format
exit [all]

Global Commands 519


Option
Option Description
all Returns you to the root CLI prompt when you are more than one level
deep in a command

help
Shows information about CLI commands.
You can obtain help on any of the group administration, array management, or global commands. You
can also get information about the available editing keystrokes.

Format
help command [commands|edit]

Variable
Variable Description
command Name of command for which to show help

Subcommands
Subcommand Description
commands Shows the global CLI commands with help text

edit Shows information about the available editing keystrokes

Examples
Show help on the account CLI command:

> help account


account - Manages administration accounts.
create - Creates a new account.
delete - Deletes an account.
select - Selects an account.
show - Shows all administration accounts or information about
a specific account.

Show help on the global CLI commands:

> help commands


alias - Performs text substitution.
clear - Clears the screen.
cli-settings - Specifies certain CLI settings.
exec - Executes a CLI script file.
exit - Brings the user up a command level from subcommand mode.
help - Shows information about CLI commands.
history - Shows the command history.
logout - Logs out a group administrator.

520 Global Commands


stty - Shows terminal settings.
tree - Shows the full CLI command syntax in a tree structure.

Show the available editing keystrokes:

> help edit


Available editing keystrokes
Delete current character.....................Ctrl-d
Delete text up to cursor.....................Ctrl-u
Delete from cursor to end of line............Ctrl-k
Move to beginning of line....................Ctrl-a
Move to end of line..........................Ctrl-e
Get prior command from history...............Ctrl-p
Get next command from history................Ctrl-n
Move cursor left.............................Ctrl-b
Move cursor right............................Ctrl-f
Move back one word...........................Esc-b
Move forward one word........................Esc-f
Convert rest of word to uppercase............Esc-c
Convert rest of word to lowercase............Esc-l
Delete remainder of word.....................Esc-d
Delete word up to cursor.....................Ctrl-w
Transpose current and previous character.....Ctrl-t
Enter command and return to root prompt......Ctrl-z
Refresh input line...........................Ctrl-l

history
Shows the CLI command history for the current user since the current login session began.

Format
history

Example
> history
1 tree -syntax grpparams session-banner
2 pool show
3 show collections
4 show chapuser
5 show grpparams
6 show account
7 show account active
8 show alerts
9 show audit-log
10 show mem
11 show member -poolinfo
12 show member panda31
13 show nas-cluster
14 show pool
15 show pool default
16 pool select default show
17 show recentevents
18 show snapcol
19 show usersessions
20 vol show
21 vol sel cwreptest replication select capecodshow
22 vol sel cranberry replication select capecod show
23 volume show

Global Commands 521


24 vol show cranberry
25 history

logout
Logs out an administration account user from the group.

Format
logout

stty
Shows or changes the terminal settings.

Format
stty parameter ...

Parameters
Parameter Description
rows n Sets the screen height. The n variable indicates the number of rows and
must be an integer from 10 to 254, inclusive.

columns n Sets the screen width. The n variable indicates the number of columns
and must be an integer from 20 to 255, inclusive.

hardwrap on|off Turns on (default) or off wrapping the output at the screen width

status Shows terminal status

Example
Show the current terminal settings:

> stty status


Terminal Type: telnet
Screen width : 80
Screen height: 25
Hard wrap : Off

tree
Shows the CLI command syntax in a tree structure, optionally showing the complete command syntax.

Format
tree [-syntax] [command]

522 Global Commands


Variable
Variable Description
command Name of command for which to show syntax

Examples
The following example shows part of the output from a tree -syntax command:

> tree -syntax


|+---account
| |
| +---create [description <String>] [contact <String>]
[email <String>] [phone <String>] [mobile <String>] <name>
[<read-write|read-only>] [<enable|disable>]
| |
| +---delete <name>
| |
| +---select <name>
| | |
| | +---contact <contact>
| | |
| | +---description <description>
...

The following example shows only the basic syntax of the failback command:

> tree failback

failback
|
+---retry
|
+---show
|
+---start
|
+---stop

whoami
Shows the account name of the logged-in user.
NOTE: This command shows only the name of the account, not the account type. For information
about displaying all account names and their types (privilege levels), see the account show
command.

Format
whoami

Global Commands 523


Example
Show the currently logged-in user account:

> whoami
grpadmin

524 Global Commands


A
Dell FluidFS Diagnostic Tool
The Dell FluidFS Diagnostic Tool provides a way to perform quick troubleshooting.
While the system is online and running, you can run a variety of commands and reports to determine
what issues are present. Then, after running the reports, you can send the log files to your customer
support representative for further investigation and follow-up.

With the tool, you can gather diagnostic information including:

FluidFS cluster information

Basic FluidFS cluster information (site configuration information, client network parameters, and
Ethernet connections)
System version information (model, version, and date)
BIOS version for each controller
FluidFS system health status
Services that appear to have problems
General diagnostic information Provides a brief summary of the system
Quick diagnostics Runs multiple commands at one time
Network tools Verify network settings and NIC information
Disk tools Provide the following information:

SAN discovery IP address


Current iSCSI session information
Current number of logins
Multipath disk configuration information
Disk devices

Start the Dell FluidFS Diagnostic Tool


The Dell FluidFS Diagnostic Tool is a command-line utility. You run the tool from one of the
NAS controllers.

NOTE: Run this tool only under the supervision of your support provider.

1. Using ssh, log in to the support account on the FluidFS system. The password is the grpadmin
password. For example:
ssh support@TestSys

The main menu appears with the options shown in the following table.

Dell FluidFS Diagnostic Tool 525


Option Description Shortcut
Cluster Displays FluidFS cluster-related information. See Run the C
Dell Support Diagnostic Tool Cluster Options.
Diagnostics Runs various diagnostic reports. See Run FluidFS D
Diagnostic Tool Diagnostics Tools.
NetworkTools Runs network-related tools. See Run the Dell Support N
Diagnostic Tool Network Tools.
DiskTools Runs several disk tools. See Run the Dell Support D
Diagnostic Tool Disk Tools.
QuickDiagnostics Performs a quick run of most of these commands in one Q
pass. See Run the FluidFS Diagnostic Tool Quick
Diagnostics.
2. To select a menu item, use the up arrow and down arrow keys to scroll up and down in the menu, or
enter the first character of the command name. (This character is shown in bold type on the menu
display.) If multiple menu items begin with the same character, pressing that character key
repeatedly alternates between them. The currently selected menu item is highlighted in blue.
The action buttons appear below the menu. Most menus have both the OK and Cancel action
buttons. To select an action button, use the Tab key to alternate between them. As with menu items,
the currently selected button is highlighted in blue.

To use a menu option, select the menu item, click the OK button, and press the Enter key.

If you are directly connected to the FluidFS system and have a mouse, or if you are connected
remotely and your terminal emulator program and connection protocol support mouse control, you
might be able to choose menu items and action buttons by using the mouse to point and click.
Mouse support depends on your particular configuration. (Try using your mouse to determine if it is
supported by your configuration.) To execute a menu option using the mouse, click the menu item
to select it and then click the OK button.

NOTE: Double-clicking is not supported. It has the same effect as a single click.

Run the Dell Support Diagnostic Tool Cluster Options


The Cluster menu provides options for viewing cluster-related information.
The menu includes the options shown in the following table.

Option Description Shortcut


basic_cluster_ Displays basic FluidFS cluster configuration information such as n
info network parameters and management configuration:
Site configuration (cluster name, cluster serial number, number
of storage nodes, and management VIP)
Client network parameters (controller IP address[es], gateway
IP address, client netmask, and client LAN MTU)
Ethernet connections (the platform being run on, the Ethernet
port being used, interface MAC addresses, PCI locations, path,

526 Dell FluidFS Diagnostic Tool


Option Description Shortcut
status, driver information, speed, maximum speed, location,
and what the node is connected to)

system-version Displays system model and file system information, along with the s
date of installation

bios-version Displays the BIOS version for each controller (manufacturer, b


version, and release date)

system-status Displays the following information: s


System model
System type
Version of FluidFS installed
First installation version of the system or software
Installation dates (cluster installation date, Service Pack
installation date)

problem- Displays any services that appear to be having problems. If no p


services problems are found, nothing is listed.

Main Returns to the main menu M

Display Basic Cluster Information


To display basic cluster information:

1. Select basic_cluster_info from the Cluster menu, click OK, and press Enter.
2. When you are done viewing the information, click OK and then press Enter to return to the Cluster
menu.

Display FluidFS System Version Information


To display the FluidFS system version information:

1. Select system-version from the Cluster menu, click OK, and press Enter.
2. When you are done viewing the information, click OK and then press Enter to return to the Cluster
menu.

Display Hardware BIOS Version Information


To display the hardware BIOS information:

1. Select bios-version from the Cluster menu, click OK, and press Enter.
2. To view the BIOS version information for a specific node, click OK and then press Enter.

The BIOS Version window appears. You can select a specific node from this window or return to the
Cluster or main menu. When you are done viewing the information, click OK and then press Enter to
return to the Cluster menu.

Dell FluidFS Diagnostic Tool 527


Check FluidFS System Status
To check and display the FluidFS system status:

1. Select system-status from the Cluster menu, click OK, and press Enter.
2. When you are done viewing the information, click OK, and then press Enter to return to the Cluster
menu.

Check for Services Having Problems


To check and display services having problems:

1. Select problem-services from the Cluster menu, click OK, and press Enter.
2. When you are done viewing the information, click OK and then press Enter to return to the Cluster
menu.

Run the FluidFS Diagnostic Tool Diagnostics Tools


The Diagnostics menu allows you to run the following diagnostic tests:

General system diagnostics


All of the diagnostics in one pass

After running diagnostic tests, you can also upload the log file using FTP to a local machine.

The Diagnostics menu includes the options shown in the following table.

Option Description Shortcut


Ftp_SystemDiags Sends a SystemDiagnosticBundle to a specified FTP server F

General Runs and shows results of FluidFS general system diagnostics G


Diagnostics

QuickDiagnostics Runs all the diagnostics in one pass Q

Main Returns to the main menu M

FTP Your System Diagnostics Log to a Local System


To upload your system diagnostics log file to another system using FTP:

1. Select Ftp_SystemDiags from the Diagnostics menu, click OK, and press Enter.
2. Enter the IP address of an FTP server, click OK, and press Enter.
3. Enter the name of the remote folder for the FTP upload, click OK, and press Enter.
4. Enter an FTP user name, click OK, and press Enter.
5. Enter the password for the FTP user, click OK, and press Enter.
6. The FTP Status screen shows whether the FTP operation connected or not. If it connected, the
success / fail status appears.

528 Dell FluidFS Diagnostic Tool


Run General Diagnostics
General system diagnostics return the following results:

Current status
Last run (date and time the diagnostics were last run)
General system diagnostics file (file name for the diagnostics file)
File size (size of the diagnostics file)
Log diagnostics file
File size (size of the log diagnostic file)

To run general system diagnostics:

1. Select General Diagnostics from the Diagnostics menu, click OK, and press Enter.
2. In the General System Diagnostics Results window, select YES.

An information message appears, stating that the operation might take up to 10 minutes.

Run Quick Diagnostics


The Quick Diagnostics menu includes the options shown in the following table.

Option Description Shortcut


node0 Runs Quick Diagnostics for node 0 n

node1 Runs Quick Diagnostics for node 1 n

Diagnostics Returns you to the Diagnostics menu D

Main Returns you to the main menu M

Quick diagnostics for a node are created with the name


QuickDiagnostics_year_month__date_hour_minutes_seconds.tgz. You can download this file from ftp://
support@10.125.170.51:nnnnn/diagnostics/archive.

To run quick diagnostics:

1. Select QuickDiagnostics from the Diagnostics menu, click OK, and press Enter.
2. In the Quick Diagnostics window, select the node on which to run quick diagnostics (node 0 or 1),
click OK, and press Enter.
An information message appears, stating that the operation might take up to 5 minutes. The exact
name of the log file that is created is displayed along with the FTP address where you can download
the log file.
3. The Quick Diagnostic tool returns the following results:

Product name
Product version
System status for both nodes
General system status:

Dell FluidFS Diagnostic Tool 529


Expected status (on or off)
File system (up or down)
Health status (any problems detected on node 0 or node 1)
FS domain status for all connected domains

Run the Dell Support Diagnostic Tool Network Tools


You can display and view several types of network details for each node.
The Network page includes the options shown in the following table.

Option Description Shortcut


network_ Verifies network settings for the available ports for a single n
verification node only. For each port, the Link Detected Status, Speed
Status, and Flow Control Negotiated results are reported,
either as PASS or FAIL.

ping Executes different ping types between systems p

nic_info Displays information about ifconfig, flow control, port status, n


bonding, and so on

nslookup Checks and looks up a DNS n

host Looks up the DNS for a host name h

Main Returns you to the main menu M

Verify Network Settings for a Node


You can verify the following settings for each port on a node:

Link Detected Status


Speed Status
Flow Control Negotiated

To verify network settings for a node:

1. From the Network menu, select network_verification, click OK, and press Enter.
The verification results are displayed.
2. When you are done viewing the information, click OK and then press Enter to return to the Network
menu.

Determine Connectivity Using the Ping Options


You can check connectivity between systems using pings. The options that are available from the Ping
dialog box are shown in the following table.

530 Dell FluidFS Diagnostic Tool


Option Description Shortcut
ping Pings between systems p

ping-s Pings between systems using jumbo frames p

ping-I Pings between systems specifying which source NIC to ping p


from

NetworkTools Returns you to the Network menu N

Main Returns you to the main menu M

To ping an IP address:

1. From the Network Ping menu, select ping, click OK, and press Enter.
2. Enter the IP address to ping in the IP address to ping field and click OK.
The ping results and statistics are displayed.
3. When you are done viewing the information, click OK and then press Enter to return to the Ping
menu.

To ping between systems using jumbo frames:

1. From the Network Ping menu, select ping-s, click OK, and press Enter.
2. Enter the IP address to ping in the IP address to ping field and click OK.
The ping results and statistics are displayed.
3. When you are done viewing the information, click OK and then press Enter to return to the Ping
menu.

To ping between systems, specifying which source NIC to ping from:

1. From the Network Ping menu, select ping-I, click OK, and press Enter.
2. Specify which NIC you want to ping from in the Choose one field.
3. Enter one of the NICs displayed above the field and click OK.
4. Enter the IP address to ping in the IP address to ping field and click OK.
The ping results and statistics are displayed.
5. When you are done viewing the information, click OK and then press Enter to return to the Ping
menu.

Display NIC Information


You can display NIC information for a network using the options shown in the following table.

Option Description Shortcut


ifconfig Checks system networking configuration i

flowcontrol Verifies flow control is enabled on all network interfaces f

nic_port_status Shows details of the status of all NICs n

bonding_status Shows any NIC bonding b

Dell FluidFS Diagnostic Tool 531


Option Description Shortcut
NetworkTools Returns you to the Network menu N

Main Returns you to the main menu M

To display and view NIC information:

1. From the Network dialog box, select nic_info, click OK, and press Enter.
2. Select the option you want to view from the menu, click OK, and press Enter.
The results are displayed in a new window.
3. When you are done viewing the information, click OK and then press Enter to return to the Network
NIC menu.

Look Up the DNS for a Host Name


To look up and check a DNS for a specified host name:

1. From the Network dialog box, select nslookup, click OK, and press Enter.
2. Enter the host name to look up in the Hostname to look up field, click OK, and press Enter.
The results are displayed in a new window.
3. When you are done viewing the information, click OK and then press Enter to return to the Network
menu.

Look Up the Host Name


To look up the name of a host:

1. From the Network dialog box, select nslookup, click OK, and press Enter.
2. Enter the name of the host to look up in the Hostname to look up field.
The results are displayed in a new dialog box.
3. When you are done viewing the information, click OK and then press Enter to return to the Network
menu.

Run the Dell Support Diagnostic Tool Disk Tools


You can display and view detailed information related to disk operation for a selected node.
The Disk Tools menu includes the options shown in the following table.

Option Description Shortcut


multipath Checks all multipath disk configurations m

lsscsi Lists iSCSI disk devices l

discovery_ip Displays discovery IP addresses for verification d

iscsi_sessions Displays detailed information about current iSCSI sessions i

iscsi_logins Displays the current number of iSCSI logins on each node i

532 Dell FluidFS Diagnostic Tool


Option Description Shortcut
Main Returns you to the main menu M

Check Multipath Disk Configuration


You can check the multipath information for the nodes in a cluster using the options shown in the
following table.

Option Description Shortcut


node0 Returns the multipath information for node 0 n

node1 Returns the multipath information for node 1 n

Disk Returns you to the Disk Tools menu D

Main Returns you to the main menu M

To display multipath information:

1. From the Dell Support Diagnostic Tool Disk dialog box, select multipath, click OK, and press
Enter.
2. Select the node to display multipath information about (either node 0 or node 1), click OK, and press
Enter.
The results are displayed in a new window.
3. To return to the Disk Tools menu, select Disk, click OK, and then press Enter.
To return to the main menu, select Main, click OK, and then press Enter.

View iSCSI Devices


You can list the iSCSI devices for each node using the options shown in the following table.

Option Description Shortcut


node0 Displays iSCSI information for node 0 n

node1 Displays iSCSI information for node 1 n

Disk Returns you to the Disk Tools menu D

Main Returns you to the main menu M

To display iSCSI information:

1. From the Dell Support Diagnostic Tool Disk dialog box, select lsscii, click OK, and press Enter.
2. Select the node to display iSCSI information for (either node 0 or node 1), click OK, and press Enter.
The results are displayed in a new window.
3. To return to the Disk Tools menu, select Disk, click OK, and press Enter.
To return to the main menu, select Main, click OK, and press Enter.

Dell FluidFS Diagnostic Tool 533


Return the Discovery IP Address
To display the discovery IP address and information about the discovery IP:

1. From the Dell Support Diagnostic Tool Disk dialog box, select discovery_ip, click OK, and press
Enter.
The results are displayed in a new window.
2. To return to the Disk Tools menu, select Disk, click OK, and press Enter.
To return to the main menu, select Main, click OK, and press Enter.

View the iSCSI Sessions Information


You can view detailed information about current iSCSI sessions using the options shown in the following
table.

Option Description Shortcut


node0 Displays iSCSI information for node 0 n

node1 Displays iSCSI information for node 1 n

Disk Returns you to the Disk Tools menu D

Main Returns you to the main menu M

To display iSCSI information about sessions:

1. From the Dell Support Diagnostic Tool Disk dialog box, select lsscii, click OK, and press Enter.
2. Select the node to display iSCSI information for (either node 0 or node 1), click OK, and then press
Enter.
The results are displayed in a new window.
3. To return to the Disk Tools menu, select Disk, click OK, and press Enter.
To return to the main menu, select Main, click OK, and press Enter.

View the Number of iSCSI Logins


You can view the current number of iSCSI logins on each node using the options shown in the following
table.

Option Description Shortcut


node0 Displays iSCSI logins for node 0 n

node1 Displays iSCSI logins for node 1 n

Disk Returns you to the Disk Tools menu D

Main Returns you to the main menu M

To display the number of iSCSI logins on a node:

1. From the Dell Support Diagnostic Tool Disk dialog box, select iscsi_logins, click OK, and press
Enter.

534 Dell FluidFS Diagnostic Tool


2. Select the node to display the number of iSCSI logins for (either node 0 or node 1), click OK, and
press Enter.
The results are displayed in a new window.
3. To return to the Disk Tools menu, select Disk, click OK, and press Enter.
To return to the main menu, select Main, click OK, and press Enter.

Run the FluidFS Diagnostic Tool Quick Diagnostics


The Quick Diagnostics tool runs multiple diagnostic tests at once.
You can display information about node 0 and node 1 using the options shown in the following table.

Option Description Shortcut


node0 Displays the quick diagnostic results for node 0 n

node1 Displays the quick diagnostic results for node 1 m

Diagnostics Returns to the Diagnostics menu D


Menu

Main Returns to the main menu M

NOTE: The diagnostics file can be downloaded using the FTP link provided.

To run the Quick Diagnostics tool on a specific node:

1. From the Dell Support Diagnostic Tool Quick Diagnostics dialog box, select the node to run quick
diagnostics on (either node 0 or node 1), click OK, and press Enter.
The diagnostic results appear in a new window.
2. In the dialog box that opens with the name of the tgz file containing the quick diagnostic results,
click OK to display the results.
3. To return to the Quick Diagnostics menu, click OK and then press Enter.

Dell FluidFS Diagnostic Tool 535


536 Dell FluidFS Diagnostic Tool
B
Third-Party Copyrights
All third-party copyrights for software used in the product are listed below.

This product contains portions of the NetBSD operating system:

For the most part, the software constituting the NetBSD operating system is not in the public domain; its
authors retain their copyright.

Copyright 1999-2001 The NetBSD Foundation, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided
that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the
following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with the distribution.

All advertising materials mentioning features or use of this software must display the following
acknowledgement:This product includes software developed by the NetBSD Foundation, Inc. and its
contributors.

Neither the name of the NetBSD Foundation nor the names of its contributors may be used to endorse or
promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS AS IS' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This code is derived from software contributed to The NetBSD Foundation by Charles M. Hannum and by
Jason R. Thorpe of the Numerical Aerospace Simulation Facility, NASA Ames Research Center.

This code is derived from software contributed to The NetBSD Foundation by John T. Kohl and Charles
M. Hannum.

This code is derived from software contributed to The NetBSD Foundation by Kevin M. Lahey of the
Numerical Aerospace Simulation Facility, NASA Ames Research Center.

Third-Party Copyrights 537


This code is derived from software contributed to The NetBSD Foundation by Jun-ichiro Hagino.

This product includes software developed by Christopher G. Demetriou for the NetBSD Project.

Copyright 1995, 1996, 1997, 1998 Christopher G. Demetriou.

This code is derived from software contributed to The NetBSD Foundation by Luke Mewburn.

This code is derived from software contributed to The NetBSD Foundation by Klaus Klein.

This code is derived from software contributed to The NetBSD Foundation by Jonathan Stone.

This code is derived from software contributed to The NetBSD Foundation by Jason R. Thorpe.

This code is derived from software contributed to The NetBSD Foundation by UCHIYAMA Yasushi.

This product includes software developed for the NetBSD Project by Wasabi Systems, Inc.

Copyright 2000-2001 Wasabi Systems, Inc. All rights reserved.

This product includes software developed by the University of California, Berkeley and its contributors.
This product includes software developed by the University of California, Lawrence Berkeley Laboratory.

Copyright 1985-1995 The Regents of the University of California.

Copyright 1997-2000 Niels Provos.

This code is derived from software contributed to Berkeley by Ralph Campbell.

This code is derived from software contributed to Berkeley by Rick Macklem.

Copyright 1989 Digital Equipment Corporation.

This product includes software developed by Manuel Bouyer.

Copyright 1999 Manuel Bouyer.

This product includes software developed by Adam Glass.

Copyright 1994 Adam Glass.

This code is derived from software contributed to Berkeley by Paul Vixie.

This code is derived from software contributed to Berkeley by Chris Torek.

This code is derived from software contributed to Berkeley by Mike Hibler.

This code is derived from software contributed to Berkeley by Paul Borman at Krystal Technologies.

This code is derived from software contributed to Berkeley by Peter McIlroy.

This code is derived from software contributed to Berkeley by Peter McIlroy and by Dan Bernstein at New
York University.

538 Third-Party Copyrights


This code is derived from software contributed to Berkeley by Stephen Deering of Stanford University.

This code is derived from software contributed to Berkeley by Jeffrey Mogul.

Copyright 1996 The Board of Trustees of The Leland Stanford Junior University.

This product includes software developed by the Computer Systems Laboratory at the University of Utah.
Copyright 1990,1994 The University of Utah and the Computer Systems Laboratory (CSL). All rights
reserved.

This code is derived from software contributed to Berkeley by the Systems Programming Group of the
University of Utah Computer Science Department.

Copyright (c) 2000 Soren S. Jorvang.

Copyright (c) 1993 John Brezak. All rights reserved.

Copyright 1995 - 2000 WIDE Project. All rights reserved.

UNIX System Laboratories, Inc.

All or some portions of this file are derived from material licensed to the University of California by
American Telephone and Telegraph Co. or UNIX System Laboratories, Inc. and are reproduced herein
with the permission of UNIX System Laboratories, Inc.

Copyright 1999 Shuichiro URATA.

This product includes software developed by Matthias Pfaller.

Copyright 1996 Matthias Pfaller.

Copyright 1993 Jan-Simon Pendry.

This product includes software developed by Gordon W. Ross.

Copyright 1995 Gordon W. Ross.

This product includes software developed by Philip A. Nelson.

Copyright 1993 Philip A. Nelson.

Copyright 1999 Ross Harvey.

This product includes software developed by Christos Zoulas.

Copyright 1996 Christos Zoulas.

Copyright 1997 Zubin D. Dittia.

This product includes software developed by SiByte, Inc.

Copyright 2000 SiByte, Inc.

Copyright 1996, 2000 Intel Corporation.

Third-Party Copyrights 539


Copyright 1996 - 1998 Microsoft Corporation.

Copyright 1990,1994 The University of Utah and the Computer Systems Laboratory (CSL).

Copyright 1991 Bell Communications Research, Inc. (Bellcore).

Copyright 2000 Caldera Systems, Inc. All rights reserved.

Copyright 1995 - 2000 Kungliga Tekniska Hgskolan.

(Royal Institute of Technology, Stockholm, Sweden). All rights reserved.

Copyright 1993-1995 HEWLETT-PACKARD COMPANY

Copyright 1995-1997 Eric Young. All rights reserved.

Copyright 1992 Simmule Turner and Rich Salz. All rights reserved.

Copyright 1999 - 2001, PADL Software Pty Ltd. All rights reserved.

Copyright 1985 - 1988 by the Massachusetts Institute of Technology.

Copyright 1995 by Wietse Venema. All rights reserved.

Copyright 1999 The OpenSSL Project. All rights reserved.

Copyright 1992 1999 Theo de Raadt. All rights reserved.

Copyright 1999 Dug Song. All rights reserved.

Copyright 2000-2002 Markus Friedl. All rights reserved.

Copyright 2001 Per Allansson. All rights reserved.

Copyright 1998 CORE SDI S.A., Buenos Aires, Argentina.

Copyright 2001-2002 Damien Miller. All rights reserved.

Copyright 2001 Kevin Steves. All rights reserved.

Copyright 1999 Aaron Campbell. All rights reserved.

Copyright 2002 Nils Nordman. All rights reserved.

Copyright 2000 Todd C. Miller. All rights reserved.

Copyright 1995, 1996 by David Mazieres.

Copyright 2000 Zembu Labs, Inc. All rights reserved.

Copyright 2000 Takuya SHIOZAKI. All rights reserved.

Copyright 1992 Keith Muller.

540 Third-Party Copyrights


Copyright 1994, Jason Downs. All rights reserved.

Copyright 1997 Matthew R. Green. All rights reserved.

Copyright 1999 Citrus Project. All rights reserved.

Copyright 1990-2, RSA Data Security, Inc. All rights reserved.

Copyright 1995 by International Business Machines, Inc.

Copyright 1996 by Internet Software Consortium.

Copyright 1995, 1999 Berkeley Software Design, Inc. All rights reserved.

Copyright 1993 Carlos Leandro and Rui Salgueiro Dep. Matematica Universidade de Coimbra, Portugal,
Europe.

Copyright 1992, 1993, 1994 Henry Spencer.

Copyright 1986-1991 by Sun Microsystems, Inc.

Copyright 1993 Martin Birgmeier.

Copyright 1991 by AT&T.

Copyright 1997 Frank van der Linden. All rights reserved.

Copyright 1999 Michael Graff. All rights reserved.

This product includes software developed by Alistair G. Crooks.

Copyright 1999 Alistair G. Crooks. All rights reserved.

Copyright 2001 Cerbero Associates Inc.

Copyright 1995-1998 Mark Adler.

Copyright 1995-1998 Jean-loup Gailly.

Copyright 1998-1999 Brett Lymn. All rights reserved.

Copyright 1996-1999 SciTech Software, Inc.

Copyright 2001,2002 Brian Stafford.

Copyright 1999-2001 Bruno Haible.

Copyright 2001 Alex Rozin, Optical Access. All rights reserved.

Copyright 1989 TGV, Incorporated. All rights reserved.

Copyright 2000 Frank Strauss. All rights reserved.

Copyright 1997 Niels Baggesen. All rights reserved.

Third-Party Copyrights 541


Copyright 2000 National Aeronautics & Space Administration. All rights reserved.

Copyright 1990-2000 Robins Nest Software, Inc.

Copyright 1989-1996 Carnegie Mellon University. All rights reserved.

Redistribution and use in source and binary forms are permitted provided that the above copyright notice
and this paragraph are duplicated in all such forms and that any documentation, advertising materials,
and other materials related to such distribution and use acknowledge that the software was developed by
Carnegie Mellon University. The name of the University may not be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED AS IS AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,


INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS
FOR A PARTICULAR PURPOSE.

542 Third-Party Copyrights

You might also like