Clustered Data ONTAP 83 Commands Manual Page PDF

Clustered Data ONTAP 8.
3
Commands: Manual Page Reference
NetApp, Inc.
495 East Java Drive
Sunnyvale, CA 94089
U.S.
Telephone: +1(408) 822-6000

Fax: +1(408) 822-4501
Support telephone: +1(888) 4-NETAPP
Web: www.netapp.com
Feedback: doccomments@netapp.com
Part number: 215-09144_D0

Updated for Data ONTAP 8.3 in December 2015
Contents
Copyright ....................................................................................................................
Trademarks ................................................................................................................
About the Clustered Data ONTAP Commands: Manual Page Reference ..................
cd ...............................................................................................................................
exit ..............................................................................................................................
history .........................................................................................................................
man ............................................................................................................................
redo ............................................................................................................................
rows ............................................................................................................................
set ..............................................................................................................................
top ..............................................................................................................................
up ...............................................................................................................................
autobalance aggregate show-aggregate-state ...........................................................
autobalance aggregate show-unbalanced-volume-state ............................................
autobalance aggregate config modify ........................................................................
autobalance aggregate config show ..........................................................................
autobalance volume rebalance show ........................................................................
autobalance volume rebalance start ..........................................................................
autobalance volume rebalance stop ..........................................................................
cluster create .............................................................................................................
cluster join ..................................................................................................................
cluster modify .............................................................................................................
cluster ping-cluster .....................................................................................................
cluster setup ..............................................................................................................
cluster show ...............................................................................................................
cluster unjoin ..............................................................................................................
cluster contact-info modify .........................................................................................
cluster contact-info show ...........................................................................................
cluster date modify ....................................................................................................
cluster date show .......................................................................................................
cluster ha modify .......................................................................................................
cluster ha show ..........................................................................................................
cluster identity modify ................................................................................................
cluster identity show ..................................................................................................
cluster image cancel-update ......................................................................................
cluster image pause-update ......................................................................................
cluster image resume-update ....................................................................................
32
33
34
35
36
36
38
38
40
41
45
46
47
51
55
57
58
60
61
64
66
67
68
70
76
77
78
80
81
82
85
85
86
87
89
90
90
Clustered Data ONTAP 8.3 Commands: Manual Page Reference
cluster image show-update-history ............................................................................ 91

cluster image show-update-log-detail ........................................................................ 94
cluster image show-update-log .................................................................................. 97
cluster image show-update-progress ....................................................................... 100
cluster image show .................................................................................................. 102
cluster image update ............................................................................................... 104
cluster image validate .............................................................................................. 107
cluster image package delete .................................................................................. 109
cluster image package get ....................................................................................... 109
cluster image package show-repository .................................................................. 110
cluster image package show ................................................................................... 111
cluster kernel-service show ..................................................................................... 112
cluster peer create ................................................................................................... 114
cluster peer delete ................................................................................................... 119
cluster peer modify .................................................................................................. 120
cluster peer ping ...................................................................................................... 123
cluster peer show .................................................................................................... 126
cluster peer connection show .................................................................................. 134
cluster peer health show ......................................................................................... 137
cluster peer offer cancel .......................................................................................... 140
cluster peer offer modify .......................................................................................... 140
cluster peer offer show ............................................................................................ 142
cluster peer policy modify ........................................................................................ 144
cluster peer policy show .......................................................................................... 146
cluster quorum-service options modify .................................................................... 146
cluster quorum-service options show ...................................................................... 148
cluster ring show ...................................................................................................... 149
cluster statistics show .............................................................................................. 151
cluster time-service ntp server create ...................................................................... 154
cluster time-service ntp server delete ...................................................................... 155
cluster time-service ntp server modify ..................................................................... 156
cluster time-service ntp server reset ........................................................................ 157
cluster time-service ntp server show ....................................................................... 158
dashboard alarm show ............................................................................................ 160
dashboard alarm thresholds modify ......................................................................... 162
dashboard alarm thresholds show ........................................................................... 163
dashboard health vserver show-aggregate .............................................................. 165
dashboard health vserver show-combined .............................................................. 167
dashboard health vserver show-lif ........................................................................... 170
dashboard health vserver show-port ....................................................................... 171
dashboard health vserver show-protocol ................................................................. 173
dashboard health vserver show-volume .................................................................. 175
dashboard health vserver show ............................................................................... 177
dashboard performance show .................................................................................

dashboard storage show .........................................................................................
event config modify ..................................................................................................
event config show ....................................................................................................
event destination create ...........................................................................................
event destination delete ...........................................................................................
event destination modify ..........................................................................................
event destination show ............................................................................................
event log show .........................................................................................................
event mailhistory delete ...........................................................................................
event mailhistory show ............................................................................................
event route add-destinations ...................................................................................
event route modify ...................................................................................................
event route remove-destinations ..............................................................................
event route show .....................................................................................................
event snmphistory delete .........................................................................................
event snmphistory show ..........................................................................................
event status show ....................................................................................................
job delete .................................................................................................................
job pause .................................................................................................................
job resume ...............................................................................................................
job show-bynode ......................................................................................................
job show-cluster .......................................................................................................
job show-completed .................................................................................................
job show ...................................................................................................................
job stop ....................................................................................................................
job unclaim ...............................................................................................................
job watch-progress ...................................................................................................
job history show .......................................................................................................
job initstate show .....................................................................................................
job private delete .....................................................................................................
job private pause .....................................................................................................
job private resume ...................................................................................................
job private show-completed .....................................................................................
job private show .......................................................................................................
job private stop ........................................................................................................
job private watch-progress .......................................................................................
job schedule delete ..................................................................................................
job schedule show-jobs ...........................................................................................
job schedule show ...................................................................................................
job schedule cron create .........................................................................................
job schedule cron delete .........................................................................................
job schedule cron modify .........................................................................................
182
186
192
194
196
199
201
204
207
212
213
215
217
219
221
224
225
227
233
234
235
236
238
242
246
250
251
252
252
256
259
260
261
262
265
268
268
269
271
273
275
276
277
job
job
job
job
job
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
lun
schedule cron show ...........................................................................................

schedule interval create .....................................................................................
schedule interval delete .....................................................................................
schedule interval modify ....................................................................................
schedule interval show ......................................................................................
create .................................................................................................................
delete .................................................................................................................
maxsize ..............................................................................................................
modify ................................................................................................................
move-in-volume ..................................................................................................
resize .................................................................................................................
show ...................................................................................................................
bind create .........................................................................................................
bind destroy .......................................................................................................
bind show ...........................................................................................................
copy cancel ........................................................................................................
copy modify ........................................................................................................
copy pause ........................................................................................................
copy resume ......................................................................................................
copy show ..........................................................................................................
copy start ...........................................................................................................
igroup add ..........................................................................................................
igroup bind .........................................................................................................
igroup create ......................................................................................................
igroup delete ......................................................................................................
igroup disable-aix-support ..................................................................................
igroup modify .....................................................................................................
igroup remove ....................................................................................................
igroup rename ....................................................................................................
igroup show .......................................................................................................
igroup unbind .....................................................................................................
import create ......................................................................................................
import delete ......................................................................................................
import pause ......................................................................................................
import resume ....................................................................................................
import show .......................................................................................................
import start .........................................................................................................
import stop .........................................................................................................
import verify start ...............................................................................................
import verify stop ...............................................................................................
mapping add-reporting-nodes ............................................................................
mapping create ..................................................................................................
mapping delete ..................................................................................................
279
281
283
284
286
288
292
294
297
300
302
305
311
312
313
315
316
317
318
319
322
324
326
328
331
332
333
335
337
339
342
343
344
346
347
348
352
353
354
355
356
358
360
lun mapping remove-reporting-nodes ......................................................................

lun mapping show ....................................................................................................
lun move cancel .......................................................................................................
lun move modify ......................................................................................................
lun move pause .......................................................................................................
lun move resume .....................................................................................................
lun move show .........................................................................................................
lun move start ..........................................................................................................
lun persistent-reservation clear ................................................................................
lun persistent-reservation show ...............................................................................
lun portset add .........................................................................................................
lun portset create .....................................................................................................
lun portset delete .....................................................................................................
lun portset remove ...................................................................................................
lun portset show ......................................................................................................
lun transition show ...................................................................................................
lun transition start ....................................................................................................
lun transition 7-mode delete ....................................................................................
lun transition 7-mode show ......................................................................................
metrocluster configure .............................................................................................
metrocluster heal .....................................................................................................
metrocluster modify ..................................................................................................
metrocluster show ....................................................................................................
metrocluster switchback ...........................................................................................
metrocluster switchover ...........................................................................................
metrocluster unconfigure .........................................................................................
metrocluster check run ............................................................................................
metrocluster check show .........................................................................................
metrocluster check aggregate show ........................................................................
metrocluster check config-replication show-aggregate-eligibility ..............................
metrocluster check config-replication show-capture-status ......................................
metrocluster check config-replication show .............................................................
metrocluster check lif repair-placement ...................................................................
metrocluster check lif show .....................................................................................
metrocluster check node show ................................................................................
metrocluster config-replication cluster-storage-configuration modify ........................
metrocluster config-replication cluster-storage-configuration show ..........................
metrocluster config-replication resync-status show .................................................
metrocluster interconnect adapter modify ................................................................
metrocluster interconnect adapter show ..................................................................
metrocluster interconnect mirror show .....................................................................
metrocluster interconnect mirror multipath show .....................................................
metrocluster node show ...........................................................................................
362
364
367
368
369
370
371
374
376
377
380
381
383
385
386
388
390
391
391
395
399
401
403
405
406
408
412
415
419
424
426
427
429
431
434
442
443
445
447
447
454
458
460
metrocluster operation show ....................................................................................

metrocluster operation history show ........................................................................
metrocluster vserver recover-from-partial-switchback ..............................................
metrocluster vserver recover-from-partial-switchover ..............................................
metrocluster vserver resync .....................................................................................
metrocluster vserver show .......................................................................................
network ping ............................................................................................................
network ping6 ..........................................................................................................
network traceroute ...................................................................................................
network traceroute6 .................................................................................................
network arp create ...................................................................................................
network arp delete ...................................................................................................
network arp show ....................................................................................................
network arp active-entry delete ...............................................................................
network arp active-entry show .................................................................................
network connections active show-clients .................................................................
network connections active show-lifs .......................................................................
network connections active show-protocols .............................................................
network connections active show-services ..............................................................
network connections active show ............................................................................
network connections listening show ........................................................................
network device-discovery show ...............................................................................
network fcp adapter modify .....................................................................................
network fcp adapter show .......................................................................................
network interface create ..........................................................................................
network interface delete ...........................................................................................
network interface migrate-all ....................................................................................
network interface migrate ........................................................................................
network interface modify ..........................................................................................
network interface rename ........................................................................................
network interface revert ...........................................................................................
network interface show-zones .................................................................................
network interface show ............................................................................................
network interface start-cluster-check .......................................................................
network interface dns-lb-stats show ........................................................................
network interface failover-groups add-targets ..........................................................
network interface failover-groups create ..................................................................
network interface failover-groups delete ..................................................................
network interface failover-groups modify .................................................................
network interface failover-groups remove-targets ....................................................
network interface failover-groups rename ................................................................
network interface failover-groups show ...................................................................
network interface lif-weights show ...........................................................................
466
467
469
470
471
472
475
477
480
482
485
485
486
488
490
492
494
497
499
501
504
507
510
512
517
522
523
524
525
530
530
532
534
540
541
543
543
544
545
546
547
547
550
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
network
ipspace create ............................................................................................

ipspace delete ............................................................................................
ipspace rename ..........................................................................................
ipspace show .............................................................................................
ndp default-router delete-all .......................................................................
ndp default-router show .............................................................................
ndp neighbor create ...................................................................................
ndp neighbor delete ...................................................................................
ndp neighbor show .....................................................................................
ndp neighbor active-entry delete ................................................................
ndp neighbor active-entry show .................................................................
ndp prefix delete-all ....................................................................................
ndp prefix show ..........................................................................................
options cluster-health-notifications modify ..................................................
options cluster-health-notifications show ....................................................
options ipv6 modify ....................................................................................
options ipv6 show ......................................................................................
options load-balancing modify ....................................................................
options load-balancing show ......................................................................
options send-soa modify ............................................................................
options send-soa show ..............................................................................
options switchless-cluster modify ...............................................................
options switchless-cluster show .................................................................
port delete ..................................................................................................
port modify .................................................................................................
port show ...................................................................................................
port broadcast-domain add-ports ...............................................................
port broadcast-domain create ....................................................................
port broadcast-domain delete ....................................................................
port broadcast-domain merge ....................................................................
port broadcast-domain modify ....................................................................
port broadcast-domain remove-ports .........................................................
port broadcast-domain rename ..................................................................
port broadcast-domain show ......................................................................
port broadcast-domain split ........................................................................
port ifgrp add-port ......................................................................................
port ifgrp create ..........................................................................................
port ifgrp delete ..........................................................................................
port ifgrp remove-port ................................................................................
port ifgrp show ...........................................................................................
port vlan create ..........................................................................................
port vlan delete ..........................................................................................
port vlan show ............................................................................................
552
552
553
554
556
556
558
558
559
561
563
565
565
568
569
570
571
571
573
573
575
575
576
577
577
580
584
584
585
586
587
588
588
589
592
594
596
598
599
599
602
603
603
network route create ................................................................................................

network route delete ................................................................................................
network route show-lifs ............................................................................................
network route show .................................................................................................
network route active-entry show ..............................................................................
network subnet add-ranges .....................................................................................
network subnet create .............................................................................................
network subnet delete ..............................................................................................
network subnet modify .............................................................................................
network subnet remove-ranges ...............................................................................
network subnet rename ...........................................................................................
network subnet show ...............................................................................................
qos policy-group create ...........................................................................................
qos policy-group delete ............................................................................................
qos policy-group modify ...........................................................................................
qos policy-group rename .........................................................................................
qos policy-group show .............................................................................................
qos statistics characteristics show ...........................................................................
qos statistics latency show ......................................................................................
qos statistics performance show .............................................................................
qos statistics resource cpu show .............................................................................
qos statistics resource disk show ............................................................................
qos statistics volume characteristics show ..............................................................
qos statistics volume latency show .........................................................................
qos statistics volume performance show .................................................................
qos statistics volume resource cpu show ................................................................
qos statistics volume resource disk show ................................................................
qos statistics workload characteristics show ...........................................................
qos statistics workload latency show .......................................................................
qos statistics workload performance show ..............................................................
qos statistics workload resource cpu show .............................................................
qos statistics workload resource disk show .............................................................
security snmpusers ..................................................................................................
security audit modify ................................................................................................
security audit show ..................................................................................................
security certificate create .........................................................................................
security certificate delete .........................................................................................
security certificate generate-csr ...............................................................................
security certificate install ..........................................................................................
security certificate show ...........................................................................................
security certificate sign ............................................................................................
security certificate ca-issued revoke ........................................................................
security certificate ca-issued show ..........................................................................
606
606
607
609
611
614
615
617
617
618
619
620
623
625
626
627
628
630
633
636
638
640
642
645
648
651
653
656
660
664
667
670
673
675
676
678
681
683
686
690
694
698
699
security login create .................................................................................................

security login delete .................................................................................................
security login lock ....................................................................................................
security login modify ................................................................................................
security login password ...........................................................................................
security login show ..................................................................................................
security login unlock ................................................................................................
security login whoami ..............................................................................................
security login domain-tunnel create .........................................................................
security login domain-tunnel delete .........................................................................
security login domain-tunnel modify ........................................................................
security login domain-tunnel show ...........................................................................
security login publickey create .................................................................................
security login publickey delete .................................................................................
security login publickey load-from-uri ......................................................................
security login publickey modify ................................................................................
security login publickey show ..................................................................................
security login role create .........................................................................................
security login role delete ..........................................................................................
security login role modify .........................................................................................
security login role show-ontapi ................................................................................
security login role show ...........................................................................................
security login role config modify ..............................................................................
security login role config reset .................................................................................
security login role config show ................................................................................
security ssh add .......................................................................................................
security ssh modify ..................................................................................................
security ssh prepare-to-downgrade .........................................................................
security ssh remove .................................................................................................
security ssh show ....................................................................................................
security ssl modify ...................................................................................................
security ssl show .....................................................................................................
snapmirror abort .......................................................................................................
snapmirror break ......................................................................................................
snapmirror create .....................................................................................................
snapmirror delete .....................................................................................................
snapmirror initialize-ls-set ........................................................................................
snapmirror initialize ..................................................................................................
snapmirror list-destinations ......................................................................................
snapmirror modify ....................................................................................................
snapmirror promote ..................................................................................................
snapmirror quiesce ..................................................................................................
snapmirror release ...................................................................................................
10
703
705
706
707
709
709
712
712
714
716
717
718
719
721
721
724
726
728
730
730
731
733
736
738
738
742
744
746
746
748
750
752
754
757
760
766
770
772
778
783
787
790
793
snapmirror restore ....................................................................................................

snapmirror resume ...................................................................................................
snapmirror resync ....................................................................................................
snapmirror set-options .............................................................................................
snapmirror show-history ...........................................................................................
snapmirror show ......................................................................................................
snapmirror update-ls-set ..........................................................................................
snapmirror update ....................................................................................................
snapmirror policy add-rule .......................................................................................
snapmirror policy create ..........................................................................................
snapmirror policy delete ...........................................................................................
snapmirror policy modify-rule ...................................................................................
snapmirror policy modify ..........................................................................................
snapmirror policy remove-rule .................................................................................
snapmirror policy show ............................................................................................
snapmirror snapshot-owner create ..........................................................................
snapmirror snapshot-owner delete ..........................................................................
snapmirror snapshot-owner show ............................................................................
statistics show-periodic ............................................................................................
statistics show ..........................................................................................................
statistics start ...........................................................................................................
statistics stop ...........................................................................................................
statistics aggregate show ........................................................................................
statistics cache flash-pool show ..............................................................................
statistics catalog counter show ................................................................................
statistics catalog instance show ..............................................................................
statistics catalog object show ..................................................................................
statistics disk show ..................................................................................................
statistics lif show ......................................................................................................
statistics lun show ....................................................................................................
statistics node show ................................................................................................
statistics oncrpc show-rpc-calls ...............................................................................
statistics port fcp show ............................................................................................
statistics preset delete .............................................................................................
statistics preset import .............................................................................................
statistics preset modify ............................................................................................
statistics preset show ..............................................................................................
statistics preset detail show .....................................................................................
statistics samples delete ..........................................................................................
statistics samples show ...........................................................................................
statistics secd show .................................................................................................
statistics settings modify ..........................................................................................
statistics settings show ............................................................................................
796
806
809
815
817
824
844
846
852
854
857
857
860
862
863
867
868
870
872
876
880
883
884
886
888
890
892
894
896
898
900
902
905
907
910
914
916
918
920
921
923
927
929
11
statistics system show ............................................................................................. 930

statistics volume show ............................................................................................. 932
statistics vserver show ............................................................................................. 934
statistics workload show .......................................................................................... 936
storage aggregate add-disks ................................................................................... 938
storage aggregate create ......................................................................................... 942
storage aggregate delete ......................................................................................... 945
storage aggregate mirror ......................................................................................... 947
storage aggregate modify ........................................................................................ 948
storage aggregate offline ......................................................................................... 953
storage aggregate online ......................................................................................... 954
storage aggregate remove-stale-record ................................................................... 955
storage aggregate rename ...................................................................................... 955
storage aggregate restrict ........................................................................................ 956
storage aggregate scrub .......................................................................................... 958
storage aggregate show-resync-status .................................................................... 961
storage aggregate show-scrub-status ...................................................................... 964
storage aggregate show-space ................................................................................ 966
storage aggregate show-spare-disks ....................................................................... 970
storage aggregate show-status ................................................................................ 975
storage aggregate show .......................................................................................... 977
storage aggregate verify .......................................................................................... 988
storage aggregate plex delete ................................................................................. 989
storage aggregate plex offline ................................................................................. 990
storage aggregate plex online ................................................................................. 990
storage aggregate plex show .................................................................................. 991
storage aggregate relocation show .......................................................................... 995
storage aggregate relocation start ........................................................................... 997
storage array modify ................................................................................................ 998
storage array remove .............................................................................................. 999
storage array rename ............................................................................................ 1000
storage array show ................................................................................................ 1000
storage array config show ..................................................................................... 1004
storage array port modify ....................................................................................... 1008
storage array port remove ..................................................................................... 1008
storage array port show ......................................................................................... 1009
storage bridge add ................................................................................................. 1013
storage bridge modify ............................................................................................ 1015
storage bridge refresh ............................................................................................ 1015
storage bridge remove ........................................................................................... 1017
storage bridge show .............................................................................................. 1019
storage disk assign ................................................................................................ 1037
storage disk fail ...................................................................................................... 1041
12
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
storage
disk modify ................................................................................................

disk reassign .............................................................................................
disk refresh-ownership ..............................................................................
disk remove-reservation ............................................................................
disk remove ..............................................................................................
disk removeowner .....................................................................................
disk replace ..............................................................................................
disk set-led ...............................................................................................
disk show ..................................................................................................
disk unfail ..................................................................................................
disk updatefirmware ..................................................................................
disk zerospares .........................................................................................
disk error show .........................................................................................
disk firmware revert ..................................................................................
disk firmware update ................................................................................
disk option modify .....................................................................................
disk option show .......................................................................................
errors show ...............................................................................................
failover giveback .......................................................................................
failover modify ...........................................................................................
failover show-giveback ..............................................................................
failover show-takeover ..............................................................................
failover show .............................................................................................
failover takeover .......................................................................................
failover hwassist show ..............................................................................
failover hwassist test ................................................................................
failover hwassist stats clear ......................................................................
failover hwassist stats show .....................................................................
failover interconnect show-link ..................................................................
failover interconnect status .......................................................................
failover interconnect statistics error show .................................................
failover interconnect statistics performance basic .....................................
failover interconnect statistics performance vi-if .......................................
failover internal-options modify .................................................................
failover internal-options show ...................................................................
failover mailbox-disk show ........................................................................
failover progress-table show .....................................................................
firmware download ....................................................................................
load balance .............................................................................................
load show .................................................................................................
path quiesce .............................................................................................
path resume ..............................................................................................
path show-by-initiator ................................................................................
1043
1045
1047
1047
1048
1050
1051
1053
1054
1078
1080
1081
1081
1084
1087
1092
1094
1096
1098
1101
1106
1108
1113
1136
1138
1141
1142
1142
1145
1147
1149
1151
1153
1155
1155
1161
1163
1166
1167
1168
1171
1172
1172
13
storage path show .................................................................................................

storage pool add ....................................................................................................
storage pool create ................................................................................................
storage pool delete ................................................................................................
storage pool reassign ............................................................................................
storage pool show-aggregate ................................................................................
storage pool show-available-capacity ....................................................................
storage pool show-disks ........................................................................................
storage pool show .................................................................................................
storage raid-options modify ...................................................................................
storage raid-options show ......................................................................................
storage shelf show .................................................................................................
storage switch add .................................................................................................
storage switch modify ............................................................................................
storage switch refresh ............................................................................................
storage switch remove ...........................................................................................
storage switch show ..............................................................................................
storage tape offline ................................................................................................
storage tape online ................................................................................................
storage tape position .............................................................................................
storage tape reset ..................................................................................................
storage tape show-errors .......................................................................................
storage tape show-media-changer ........................................................................
storage tape show-supported-status ......................................................................
storage tape show-tape-drive ................................................................................
storage tape show .................................................................................................
storage tape trace ..................................................................................................
storage tape alias clear .........................................................................................
storage tape alias set ............................................................................................
storage tape alias show .........................................................................................
storage tape library config show ............................................................................
storage tape library path show-by-initiator .............................................................
storage tape library path show ..............................................................................
system chassis show .............................................................................................
system chassis fru show .......................................................................................
system cluster-switch create ..................................................................................
system cluster-switch delete ..................................................................................
system cluster-switch modify .................................................................................
system cluster-switch prepare-to-downgrade ........................................................
system cluster-switch show-all ...............................................................................
system cluster-switch show ...................................................................................
system cluster-switch polling-interval modify .........................................................
system cluster-switch polling-interval show ...........................................................
14
1175
1181
1183
1185
1186
1188
1190
1193
1195
1199
1200
1202
1223
1225
1227
1228
1230
1262
1262
1263
1265
1266
1269
1272
1274
1277
1282
1282
1284
1285
1287
1289
1291
1295
1297
1300
1302
1302
1303
1305
1307
1309
1310
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
configuration backup copy .........................................................................

configuration backup create ......................................................................
configuration backup delete ......................................................................
configuration backup download .................................................................
configuration backup rename ....................................................................
configuration backup show ........................................................................
configuration backup upload .....................................................................
configuration backup settings modify ........................................................
configuration backup settings set-password ..............................................
configuration backup settings show ..........................................................
configuration recovery cluster modify ........................................................
configuration recovery cluster recreate .....................................................
configuration recovery cluster rejoin ..........................................................
configuration recovery cluster show ..........................................................
configuration recovery cluster sync ...........................................................
configuration recovery node restore ..........................................................
controller show ..........................................................................................
controller bootmedia show ........................................................................
controller config show-errors .....................................................................
controller config pci show-add-on-devices ................................................
controller config pci show-hierarchy ..........................................................
controller environment show .....................................................................
controller fru show .....................................................................................
controller ioxm show .................................................................................
controller memory dimm show ..................................................................
controller pci show ....................................................................................
controller sp config show ..........................................................................
controller sp upgrade show .......................................................................
feature-usage show-history .......................................................................
feature-usage show-summary ...................................................................
health alert delete ......................................................................................
health alert modify .....................................................................................
health alert show .......................................................................................
health alert definition show ........................................................................
health autosupport trigger history show ....................................................
health config show ....................................................................................
health node-connectivity adapter show .....................................................
health node-connectivity disk show ...........................................................
health node-connectivity shelf show ..........................................................
health policy definition modify ...................................................................
health policy definition show .....................................................................
health status show ....................................................................................
health subsystem show .............................................................................
1310
1312
1313
1314
1315
1316
1318
1318
1320
1321
1323
1323
1325
1326
1327
1328
1330
1333
1336
1338
1341
1345
1348
1351
1354
1357
1360
1363
1366
1368
1370
1370
1372
1376
1379
1382
1385
1389
1392
1395
1396
1399
1399
15
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
16
health system-connectivity shelf show ......................................................

license add ................................................................................................
license clean-up ........................................................................................
license delete ............................................................................................
license show ..............................................................................................
license status show ...................................................................................
node halt ...................................................................................................
node modify ...............................................................................................
node reboot ...............................................................................................
node rename .............................................................................................
node restore-backup .................................................................................
node revert-to ............................................................................................
node run-console .......................................................................................
node run ....................................................................................................
node show-discovered ...............................................................................
node show-memory-errors ........................................................................
node show .................................................................................................
node autosupport invoke-core-upload .......................................................
node autosupport invoke-performance-archive .........................................
node autosupport invoke-splog .................................................................
node autosupport invoke ...........................................................................
node autosupport modify ...........................................................................
node autosupport show .............................................................................
node autosupport destinations show .........................................................
node autosupport history cancel ...............................................................
node autosupport history retransmit ..........................................................
node autosupport history show-upload-details ..........................................
node autosupport history show .................................................................
node autosupport manifest show ..............................................................
node autosupport trigger modify ................................................................
node autosupport trigger show ..................................................................
node coredump delete-all ..........................................................................
node coredump delete ..............................................................................
node coredump save-all ............................................................................
node coredump save .................................................................................
node coredump show ................................................................................
node coredump status ...............................................................................
node coredump trigger ..............................................................................
node coredump upload .............................................................................
node coredump config modify ...................................................................
node coredump config show .....................................................................
node coredump reports delete ..................................................................
node coredump reports show ....................................................................
1402
1405
1406
1407
1408
1411
1413
1415
1417
1418
1420
1421
1421
1423
1426
1428
1431
1434
1436
1438
1440
1442
1447
1452
1454
1456
1458
1461
1465
1470
1472
1475
1475
1476
1478
1479
1483
1489
1491
1493
1495
1498
1498
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
node coredump reports upload .................................................................

node coredump segment delete-all ...........................................................
node coredump segment delete ................................................................
node coredump segment show .................................................................
node coredump segment start ..................................................................
node coredump segment status ................................................................
node coredump segment stop ...................................................................
node coredump segment config modify ....................................................
node coredump segment config show .......................................................
node environment sensors show ...............................................................
node firmware download ...........................................................................
node hardware tape drive show ................................................................
node hardware tape library show ..............................................................
node hardware unified-connect modify ......................................................
node hardware unified-connect show ........................................................
node image get .........................................................................................
node image modify ....................................................................................
node image show-update-progress ...........................................................
node image show ......................................................................................
node image update ...................................................................................
node image package delete ......................................................................
node image package show .......................................................................
node internal-switch show .........................................................................
node internal-switch dump eeprom ...........................................................
node internal-switch dump port-mapping ..................................................
node internal-switch dump stat .................................................................
node platform ifswitch stat .........................................................................
node platform ifswitch mode modify ..........................................................
node platform ifswitch mode show ............................................................
node power on ..........................................................................................
node power show ......................................................................................
node root-mount create .............................................................................
node root-mount delete .............................................................................
node root-mount show ..............................................................................
node upgrade-revert show ........................................................................
node upgrade-revert upgrade ....................................................................
node virtual-machine hypervisor modify-credentials ..................................
node virtual-machine hypervisor show-credentials ....................................
node virtual-machine hypervisor show ......................................................
node virtual-machine instance show-system-disks ....................................
node virtual-machine instance show .........................................................
script delete ...............................................................................................
script show ................................................................................................
1501
1502
1502
1503
1506
1506
1509
1509
1510
1512
1517
1517
1520
1522
1524
1527
1528
1528
1530
1533
1536
1536
1538
1541
1543
1545
1547
1549
1550
1551
1552
1553
1555
1556
1559
1562
1562
1564
1567
1572
1576
1579
1580
17
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
system
18
script start ..................................................................................................

script stop ..................................................................................................
script upload ..............................................................................................
service-processor reboot-sp ......................................................................
service-processor show .............................................................................
service-processor api-service modify ........................................................
service-processor api-service renew-certificates .......................................
service-processor api-service show ..........................................................
service-processor image modify ................................................................
service-processor image show ..................................................................
service-processor image update ...............................................................
service-processor image update-progress show .......................................
service-processor log show-allocations .....................................................
service-processor network modify .............................................................
service-processor network show ...............................................................
service-processor network auto-configuration disable ...............................
service-processor network auto-configuration enable ...............................
service-processor network auto-configuration show ..................................
service-processor ssh add-allowed-addresses ..........................................
service-processor ssh remove-allowed-addresses ....................................
service-processor ssh show ......................................................................
services firewall modify .............................................................................
services firewall show ...............................................................................
services firewall policy clone .....................................................................
services firewall policy create ....................................................................
services firewall policy delete ....................................................................
services firewall policy modify ...................................................................
services firewall policy show .....................................................................
services manager install show ..................................................................
services manager policy add .....................................................................
services manager policy remove ...............................................................
services manager policy setstate ..............................................................
services manager policy show ..................................................................
services manager status show ..................................................................
services ndmp kill-all .................................................................................
services ndmp kill ......................................................................................
services ndmp modify ...............................................................................
services ndmp off ......................................................................................
services ndmp on ......................................................................................
services ndmp password ...........................................................................
services ndmp probe .................................................................................
services ndmp show ..................................................................................
services ndmp start ...................................................................................
1582
1583
1584
1585
1587
1591
1593
1594
1594
1595
1599
1602
1604
1606
1611
1618
1620
1623
1624
1626
1628
1628
1629
1631
1631
1634
1636
1637
1639
1641
1641
1642
1644
1646
1648
1649
1650
1652
1654
1656
1657
1661
1664
system services ndmp status ................................................................................

system services ndmp stop ...................................................................................
system services ndmp terminate ...........................................................................
system services ndmp log start .............................................................................
system services ndmp log stop .............................................................................
system services ndmp node-scope-mode off ........................................................
system services ndmp node-scope-mode on ........................................................
system services ndmp node-scope-mode status ...................................................
system services ntp server create .........................................................................
system services ntp server delete .........................................................................
system services ntp server modify ........................................................................
system services ntp server show ..........................................................................
system services web modify ..................................................................................
system services web show ....................................................................................
system services web node show ...........................................................................
system smtape abort .............................................................................................
system smtape backup ..........................................................................................
system smtape break .............................................................................................
system smtape continue ........................................................................................
system smtape restore ..........................................................................................
system smtape showheader ..................................................................................
system smtape status clear ...................................................................................
system smtape status show ..................................................................................
system snmp authtrap ...........................................................................................
system snmp contact .............................................................................................
system snmp init ....................................................................................................
system snmp location ............................................................................................
system snmp prepare-to-downgrade .....................................................................
system snmp show ................................................................................................
system snmp community add ................................................................................
system snmp community delete ............................................................................
system snmp community show ..............................................................................
system snmp traphost add ....................................................................................
system snmp traphost delete .................................................................................
system snmp traphost show ..................................................................................
system timeout modify ...........................................................................................
system timeout show .............................................................................................
volume autosize .....................................................................................................
volume create ........................................................................................................
volume delete .........................................................................................................
volume make-vsroot ...............................................................................................
volume modify ........................................................................................................
volume mount ........................................................................................................
1665
1672
1673
1674
1678
1680
1681
1682
1683
1683
1684
1685
1688
1690
1692
1695
1696
1698
1699
1700
1702
1705
1706
1710
1711
1712
1713
1714
1714
1716
1716
1717
1718
1720
1721
1721
1722
1724
1728
1738
1740
1741
1754
19
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
20
offline .........................................................................................................
online .........................................................................................................
rename ......................................................................................................
restrict ........................................................................................................
show-footprint ............................................................................................
show-space ...............................................................................................
show ..........................................................................................................
size ............................................................................................................
unmount ....................................................................................................
aggregate vacate ......................................................................................
clone create ..............................................................................................
clone modify ..............................................................................................
clone show ................................................................................................
clone split estimate ...................................................................................
clone split show ........................................................................................
clone split start ..........................................................................................
clone split stop ..........................................................................................
efficiency check .........................................................................................
efficiency modify ........................................................................................
efficiency off ..............................................................................................
efficiency on ..............................................................................................
efficiency revert-to .....................................................................................
efficiency show ..........................................................................................
efficiency start ...........................................................................................
efficiency stat ............................................................................................
efficiency stop ...........................................................................................
efficiency undo ..........................................................................................
efficiency policy create ..............................................................................
efficiency policy delete ..............................................................................
efficiency policy modify .............................................................................
efficiency policy show ...............................................................................
file modify ..................................................................................................
file reservation ...........................................................................................
file show-disk-usage ..................................................................................
file show-filehandle ....................................................................................
file show-inode ..........................................................................................
file clone autodelete ..................................................................................
file clone create .........................................................................................
file clone show-autodelete .........................................................................
file clone deletion add-extension ...............................................................
file clone deletion modify ..........................................................................
file clone deletion remove-extension .........................................................
file clone deletion show .............................................................................
1755
1756
1757
1758
1759
1765
1773
1792
1793
1795
1796
1799
1800
1805
1809
1812
1813
1813
1814
1816
1817
1819
1820
1827
1829
1834
1834
1837
1839
1839
1842
1845
1846
1847
1850
1852
1856
1857
1861
1862
1863
1863
1864
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
volume
file clone split load modify .........................................................................

file clone split load show ...........................................................................
move abort ................................................................................................
move show ................................................................................................
move start .................................................................................................
move trigger-cutover .................................................................................
move recommend show ............................................................................
move target-aggr show .............................................................................
qtree create ...............................................................................................
qtree delete ...............................................................................................
qtree modify ..............................................................................................
qtree oplocks .............................................................................................
qtree rename .............................................................................................
qtree security .............................................................................................
qtree show ................................................................................................
qtree statistics-reset ..................................................................................
qtree statistics ...........................................................................................
quota modify ..............................................................................................
quota off ....................................................................................................
quota on ....................................................................................................
quota report ...............................................................................................
quota resize ..............................................................................................
quota show ................................................................................................
quota policy copy ......................................................................................
quota policy create ....................................................................................
quota policy delete ....................................................................................
quota policy rename ..................................................................................
quota policy show .....................................................................................
quota policy rule create .............................................................................
quota policy rule delete .............................................................................
quota policy rule modify ............................................................................
quota policy rule show ..............................................................................
snapshot compute-reclaimable ..................................................................
snapshot create .........................................................................................
snapshot delete .........................................................................................
snapshot modify ........................................................................................
snapshot partial-restore-file .......................................................................
snapshot prepare-for-revert .......................................................................
snapshot rename ......................................................................................
snapshot restore-file ..................................................................................
snapshot restore .......................................................................................
snapshot show ..........................................................................................
snapshot autodelete modify ......................................................................
1867
1867
1870
1872
1878
1879
1881
1883
1885
1887
1889
1891
1893
1894
1896
1899
1899
1903
1906
1908
1910
1918
1920
1926
1926
1927
1928
1929
1931
1937
1939
1942
1945
1946
1947
1948
1949
1951
1951
1953
1954
1955
1962
21
volume snapshot autodelete show ........................................................................

volume snapshot policy add-schedule ...................................................................
volume snapshot policy create ..............................................................................
volume snapshot policy delete ..............................................................................
volume snapshot policy modify-schedule ..............................................................
volume snapshot policy modify ..............................................................................
volume snapshot policy remove-schedule .............................................................
volume snapshot policy show ................................................................................
vserver add-aggregates .........................................................................................
vserver add-protocols ............................................................................................
vserver context .......................................................................................................
vserver create ........................................................................................................
vserver delete ........................................................................................................
vserver modify ........................................................................................................
vserver prepare-for-revert ......................................................................................
vserver remove-aggregates ...................................................................................
vserver remove-protocols .......................................................................................
vserver rename ......................................................................................................
vserver show-protocols ..........................................................................................
vserver show ..........................................................................................................
vserver start ...........................................................................................................
vserver stop ...........................................................................................................
vserver unlock ........................................................................................................
vserver active-directory create ...............................................................................
vserver active-directory delete ...............................................................................
vserver active-directory modify ..............................................................................
vserver active-directory password-change .............................................................
vserver active-directory password-reset ................................................................
vserver active-directory show ................................................................................
vserver audit create ...............................................................................................
vserver audit delete ...............................................................................................
vserver audit disable ..............................................................................................
vserver audit enable ..............................................................................................
vserver audit modify ..............................................................................................
vserver audit rotate-log ..........................................................................................
vserver audit show .................................................................................................
vserver check lif-multitenancy run .........................................................................
vserver check lif-multitenancy show-results ...........................................................
vserver check lif-multitenancy show ......................................................................
vserver cifs add-netbios-aliases .............................................................................
vserver cifs create .................................................................................................
vserver cifs delete ..................................................................................................
vserver cifs modify .................................................................................................
22
1966
1969
1971
1975
1975
1976
1977
1978
1982
1982
1983
1985
1988
1988
1990
1991
1991
1992
1993
1994
2000
2000
2001
2002
2005
2006
2007
2007
2008
2011
2014
2014
2015
2015
2018
2018
2023
2026
2029
2032
2034
2036
2036
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
cifs nbtstat .................................................................................................

cifs remove-netbios-aliases .......................................................................
cifs show ...................................................................................................
cifs start ....................................................................................................
cifs stop .....................................................................................................
cifs branchcache create ............................................................................
cifs branchcache delete ............................................................................
cifs branchcache hash-create ...................................................................
cifs branchcache hash-flush .....................................................................
cifs branchcache modify ...........................................................................
cifs branchcache show .............................................................................
cifs character-mapping create ...................................................................
cifs character-mapping delete ...................................................................
cifs character-mapping modify ..................................................................
cifs character-mapping show ....................................................................
cifs domain discovered-servers reset-servers ...........................................
cifs domain discovered-servers show .......................................................
cifs domain name-mapping-search add ....................................................
cifs domain name-mapping-search modify ...............................................
cifs domain name-mapping-search remove ..............................................
cifs domain name-mapping-search show ..................................................
cifs domain password change ..................................................................
cifs domain password reset ......................................................................
cifs domain password schedule modify ....................................................
cifs domain password schedule show .......................................................
cifs domain preferred-dc add ....................................................................
cifs domain preferred-dc remove ..............................................................
cifs domain preferred-dc show ..................................................................
cifs domain trusts rediscover ....................................................................
cifs domain trusts show ............................................................................
cifs group-policy modify ............................................................................
cifs group-policy show-applied ..................................................................
cifs group-policy show-defined ..................................................................
cifs group-policy show ..............................................................................
cifs group-policy update ............................................................................
cifs group-policy central-access-policy show-applied ................................
cifs group-policy central-access-policy show-defined ................................
cifs group-policy central-access-rule show-applied ...................................
cifs group-policy central-access-rule show-defined ...................................
cifs group-policy restricted-group show-applied ........................................
cifs group-policy restricted-group show-defined ........................................
cifs home-directory modify ........................................................................
cifs home-directory show-user ..................................................................
2039
2043
2045
2048
2049
2049
2052
2052
2053
2054
2057
2060
2062
2062
2065
2067
2067
2070
2070
2071
2072
2074
2074
2075
2077
2080
2081
2081
2083
2083
2085
2085
2093
2100
2101
2101
2104
2107
2110
2113
2116
2119
2120
23
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
24
cifs home-directory show ..........................................................................

cifs home-directory search-path add .........................................................
cifs home-directory search-path remove ...................................................
cifs home-directory search-path reorder ...................................................
cifs home-directory search-path show ......................................................
cifs netbios-alias prepare-to-downgrade ...................................................
cifs options modify ....................................................................................
cifs options prepare-to-downgrade ............................................................
cifs options show ......................................................................................
cifs security modify ...................................................................................
cifs security show ......................................................................................
cifs session close ......................................................................................
cifs session show ......................................................................................
cifs session file close ................................................................................
cifs session file show ................................................................................
cifs share create .......................................................................................
cifs share delete .......................................................................................
cifs share modify .......................................................................................
cifs share show .........................................................................................
cifs share access-control create ...............................................................
cifs share access-control delete ................................................................
cifs share access-control modify ...............................................................
cifs share access-control show .................................................................
cifs share properties add ..........................................................................
cifs share properties remove ....................................................................
cifs share properties show ........................................................................
cifs superuser create ................................................................................
cifs superuser delete .................................................................................
cifs superuser show ..................................................................................
cifs symlink create ....................................................................................
cifs symlink delete .....................................................................................
cifs symlink modify ....................................................................................
cifs symlink show ......................................................................................
cifs users-and-groups update-names ........................................................
cifs users-and-groups local-group add-members ......................................
cifs users-and-groups local-group create ..................................................
cifs users-and-groups local-group delete ..................................................
cifs users-and-groups local-group modify .................................................
cifs users-and-groups local-group remove-members ................................
cifs users-and-groups local-group rename ................................................
cifs users-and-groups local-group show-members ....................................
cifs users-and-groups local-group show ...................................................
cifs users-and-groups local-user create ....................................................
2122
2124
2124
2125
2126
2127
2127
2133
2133
2140
2143
2146
2148
2154
2155
2160
2165
2165
2169
2174
2176
2177
2179
2181
2183
2185
2188
2188
2189
2191
2193
2193
2196
2199
2201
2202
2203
2203
2204
2206
2207
2209
2211
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
cifs users-and-groups local-user delete ....................................................

cifs users-and-groups local-user modify ...................................................
cifs users-and-groups local-user rename ..................................................
cifs users-and-groups local-user set-password .........................................
cifs users-and-groups local-user show-membership .................................
cifs users-and-groups local-user show ......................................................
cifs users-and-groups privilege add-privilege ............................................
cifs users-and-groups privilege remove-privilege ......................................
cifs users-and-groups privilege reset-privilege ..........................................
cifs users-and-groups privilege show ........................................................
config-replication pause ............................................................................
config-replication resume ..........................................................................
config-replication show ..............................................................................
data-policy export ......................................................................................
data-policy import ......................................................................................
data-policy validate ...................................................................................
export-policy check-access .......................................................................
export-policy copy .....................................................................................
export-policy create ...................................................................................
export-policy delete ...................................................................................
export-policy rename .................................................................................
export-policy show ....................................................................................
export-policy cache flush ..........................................................................
export-policy netgroup check-membership ...............................................
export-policy netgroup cache show ..........................................................
export-policy netgroup queue show ..........................................................
export-policy rule create ............................................................................
export-policy rule delete ............................................................................
export-policy rule modify ...........................................................................
export-policy rule setindex ........................................................................
export-policy rule show .............................................................................
fcp create ..................................................................................................
fcp delete ..................................................................................................
fcp modify .................................................................................................
fcp show ....................................................................................................
fcp start .....................................................................................................
fcp stop .....................................................................................................
fcp initiator show .......................................................................................
fcp interface show .....................................................................................
fcp portname set .......................................................................................
fcp portname show ...................................................................................
fcp wwn blacklist show .............................................................................
fcp wwpn-alias remove .............................................................................
2212
2214
2214
2216
2218
2220
2222
2223
2225
2227
2229
2230
2231
2232
2234
2236
2238
2241
2241
2243
2243
2244
2246
2247
2250
2253
2256
2263
2264
2271
2273
2281
2283
2284
2285
2287
2288
2289
2291
2294
2296
2298
2300
25
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
26
fcp wwpn-alias set ....................................................................................

fcp wwpn-alias show .................................................................................
fpolicy disable ...........................................................................................
fpolicy enable ............................................................................................
fpolicy engine-connect ..............................................................................
fpolicy engine-disconnect ..........................................................................
fpolicy show-enabled .................................................................................
fpolicy show-engine ..................................................................................
fpolicy show-passthrough-read-connection ...............................................
fpolicy show ..............................................................................................
fpolicy policy create ..................................................................................
fpolicy policy delete ...................................................................................
fpolicy policy modify ..................................................................................
fpolicy policy show ....................................................................................
fpolicy policy event create .........................................................................
fpolicy policy event delete .........................................................................
fpolicy policy event modify ........................................................................
fpolicy policy event show ..........................................................................
fpolicy policy external-engine create .........................................................
fpolicy policy external-engine delete .........................................................
fpolicy policy external-engine modify ........................................................
fpolicy policy external-engine show ..........................................................
fpolicy policy scope create ........................................................................
fpolicy policy scope delete ........................................................................
fpolicy policy scope modify .......................................................................
fpolicy policy scope show .........................................................................
group-mapping create ...............................................................................
group-mapping delete ...............................................................................
group-mapping insert ................................................................................
group-mapping modify ..............................................................................
group-mapping show .................................................................................
group-mapping swap .................................................................................
iscsi create ................................................................................................
iscsi delete ................................................................................................
iscsi modify ...............................................................................................
iscsi show .................................................................................................
iscsi start ...................................................................................................
iscsi stop ...................................................................................................
iscsi command show .................................................................................
iscsi connection show ...............................................................................
iscsi connection shutdown ........................................................................
iscsi initiator show .....................................................................................
iscsi interface disable ................................................................................
2301
2302
2304
2306
2308
2310
2312
2314
2318
2322
2325
2328
2328
2332
2335
2341
2341
2347
2350
2355
2357
2362
2368
2372
2372
2377
2380
2382
2382
2384
2385
2388
2389
2391
2392
2395
2398
2399
2400
2403
2406
2407
2409
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
iscsi interface enable ................................................................................

iscsi interface show ...................................................................................
iscsi interface accesslist add ....................................................................
iscsi interface accesslist remove ...............................................................
iscsi interface accesslist show ..................................................................
iscsi isns create ........................................................................................
iscsi isns delete ........................................................................................
iscsi isns modify ........................................................................................
iscsi isns show ..........................................................................................
iscsi isns start ...........................................................................................
iscsi isns stop ...........................................................................................
iscsi isns update .......................................................................................
iscsi security create ..................................................................................
iscsi security default ..................................................................................
iscsi security delete ...................................................................................
iscsi security generate ..............................................................................
iscsi security modify ..................................................................................
iscsi security show ....................................................................................
iscsi session show ....................................................................................
iscsi session shutdown .............................................................................
iscsi session parameter show ...................................................................
locks break ................................................................................................
locks show ................................................................................................
name-mapping create ...............................................................................
name-mapping delete ...............................................................................
name-mapping insert ................................................................................
name-mapping modify ...............................................................................
name-mapping show .................................................................................
name-mapping swap .................................................................................
nfs create ..................................................................................................
nfs delete ..................................................................................................
nfs modify .................................................................................................
nfs off ........................................................................................................
nfs on ........................................................................................................
nfs show ....................................................................................................
nfs start .....................................................................................................
nfs status ..................................................................................................
nfs stop .....................................................................................................
nfs kerberos interface disable ...................................................................
nfs kerberos interface enable ...................................................................
nfs kerberos interface modify ....................................................................
nfs kerberos interface show ......................................................................
nfs kerberos realm create .........................................................................
2410
2411
2414
2416
2418
2420
2422
2423
2425
2427
2428
2429
2430
2432
2434
2435
2436
2438
2440
2444
2445
2449
2450
2460
2462
2462
2464
2465
2468
2469
2478
2478
2488
2488
2489
2499
2499
2500
2500
2501
2503
2505
2507
27
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
28
nfs kerberos realm delete .........................................................................

nfs kerberos realm modify ........................................................................
nfs kerberos realm show ..........................................................................
nfs pnfs devices create .............................................................................
nfs pnfs devices delete .............................................................................
nfs pnfs devices show ..............................................................................
nfs pnfs devices cache show ....................................................................
nfs pnfs devices mappings show ..............................................................
peer accept ...............................................................................................
peer create ................................................................................................
peer delete ................................................................................................
peer modify ...............................................................................................
peer reject .................................................................................................
peer resume ..............................................................................................
peer show-all .............................................................................................
peer show .................................................................................................
peer suspend ............................................................................................
peer transition create ................................................................................
peer transition delete ................................................................................
peer transition modify ...............................................................................
peer transition show ..................................................................................
security file-directory apply .......................................................................
security file-directory remove-slag ............................................................
security file-directory show ........................................................................
security file-directory job show ..................................................................
security file-directory ntfs create ...............................................................
security file-directory ntfs delete ...............................................................
security file-directory ntfs modify ...............................................................
security file-directory ntfs show .................................................................
security file-directory ntfs dacl add ...........................................................
security file-directory ntfs dacl modify .......................................................
security file-directory ntfs dacl remove ......................................................
security file-directory ntfs dacl show .........................................................
security file-directory ntfs sacl add ............................................................
security file-directory ntfs sacl modify .......................................................
security file-directory ntfs sacl remove ......................................................
security file-directory ntfs sacl show .........................................................
security file-directory policy create ............................................................
security file-directory policy delete ............................................................
security file-directory policy show .............................................................
security file-directory policy task add ........................................................
security file-directory policy task modify ....................................................
security file-directory policy task remove ..................................................
2509
2509
2512
2515
2517
2518
2521
2522
2524
2525
2527
2528
2529
2530
2531
2534
2536
2537
2538
2539
2541
2543
2544
2547
2553
2557
2561
2561
2564
2566
2571
2575
2576
2580
2585
2589
2590
2594
2596
2596
2599
2603
2606
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
security file-directory policy task show ......................................................

security trace filter create ..........................................................................
security trace filter delete ..........................................................................
security trace filter modify .........................................................................
security trace filter show ...........................................................................
security trace trace-result delete ...............................................................
security trace trace-result show ................................................................
services name-service dns clear-statistics ................................................
services name-service dns create ............................................................
services name-service dns delete .............................................................
services name-service dns modify ............................................................
services name-service dns show-statistics ...............................................
services name-service dns show ..............................................................
services name-service dns hosts create ...................................................
services name-service dns hosts delete ...................................................
services name-service dns hosts modify ..................................................
services name-service dns hosts show ....................................................
services name-service getxxbyyy getaddrinfo ...........................................
services name-service getxxbyyy getgrbygid ............................................
services name-service getxxbyyy getgrbyname ........................................
services name-service getxxbyyy getgrlist ................................................
services name-service getxxbyyy gethostbyaddr ......................................
services name-service getxxbyyy gethostbyname ....................................
services name-service getxxbyyy getnameinfo .........................................
services name-service getxxbyyy getpwbyname ......................................
services name-service getxxbyyy getpwbyuid ..........................................
services name-service getxxbyyy netgrp ..................................................
services name-service getxxbyyy netgrpbyhost ........................................
services name-service ldap create ...........................................................
services name-service ldap delete ............................................................
services name-service ldap modify ...........................................................
services name-service ldap show .............................................................
services name-service ldap client create ..................................................
services name-service ldap client delete ..................................................
services name-service ldap client modify-bind-password ..........................
services name-service ldap client modify .................................................
services name-service ldap client show ....................................................
services name-service ldap client schema copy .......................................
services name-service ldap client schema delete .....................................
services name-service ldap client schema modify ....................................
services name-service ldap client schema show ......................................
services name-service netgroup load .......................................................
services name-service netgroup status .....................................................
2607
2610
2611
2613
2614
2617
2617
2628
2630
2631
2632
2634
2638
2640
2640
2641
2642
2644
2646
2647
2648
2649
2650
2652
2653
2655
2657
2658
2660
2661
2661
2663
2665
2670
2670
2671
2677
2681
2681
2682
2686
2690
2691
29
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
30
services name-service netgroup file delete ...............................................

services name-service netgroup file show ................................................
services name-service nis-domain clear-statistics ....................................
services name-service nis-domain create .................................................
services name-service nis-domain delete .................................................
services name-service nis-domain modify ................................................
services name-service nis-domain show-bound .......................................
services name-service nis-domain show-statistics ....................................
services name-service nis-domain show ..................................................
services name-service ns-switch create ...................................................
services name-service ns-switch delete ....................................................
services name-service ns-switch modify ...................................................
services name-service ns-switch show .....................................................
services name-service unix-group adduser ...............................................
services name-service unix-group create .................................................
services name-service unix-group delete ..................................................
services name-service unix-group deluser ................................................
services name-service unix-group load-from-uri .......................................
services name-service unix-group modify .................................................
services name-service unix-group show ...................................................
services name-service unix-group max-limit modify ..................................
services name-service unix-group max-limit show ....................................
services name-service unix-user create ....................................................
services name-service unix-user delete ....................................................
services name-service unix-user load-from-uri .........................................
services name-service unix-user modify ...................................................
services name-service unix-user show .....................................................
services name-service unix-user max-limit modify ....................................
services name-service unix-user max-limit show ......................................
services ndmp generate-password ...........................................................
services ndmp kill-all .................................................................................
services ndmp kill .....................................................................................
services ndmp modify ...............................................................................
services ndmp off ......................................................................................
services ndmp on ......................................................................................
services ndmp probe ................................................................................
services ndmp show .................................................................................
services ndmp status ................................................................................
services ndmp extensions modify .............................................................
services ndmp extensions show ...............................................................
services ndmp log start .............................................................................
services ndmp log stop .............................................................................
services web modify .................................................................................
2693
2693
2696
2698
2699
2700
2702
2704
2708
2710
2713
2714
2716
2718
2718
2719
2720
2721
2722
2722
2725
2725
2727
2727
2728
2729
2730
2733
2733
2735
2736
2736
2738
2745
2753
2761
2765
2775
2782
2782
2783
2785
2786
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
vserver
services web show ....................................................................................

services web access create ......................................................................
services web access delete ......................................................................
services web access show .......................................................................
smtape break ............................................................................................
vscan disable ............................................................................................
vscan enable .............................................................................................
vscan reset ...............................................................................................
vscan show ...............................................................................................
vscan connection-status show-all .............................................................
vscan connection-status show-connected .................................................
vscan connection-status show-not-connected ...........................................
vscan connection-status show ..................................................................
vscan on-access-policy create ..................................................................
vscan on-access-policy delete ..................................................................
vscan on-access-policy disable .................................................................
vscan on-access-policy enable .................................................................
vscan on-access-policy modify .................................................................
vscan on-access-policy show ...................................................................
vscan scanner-pool apply-policy ...............................................................
vscan scanner-pool create ........................................................................
vscan scanner-pool delete ........................................................................
vscan scanner-pool modify .......................................................................
vscan scanner-pool show-active ...............................................................
vscan scanner-pool show .........................................................................
vscan scanner-pool privileged-users add ..................................................
vscan scanner-pool privileged-users remove ............................................
vscan scanner-pool privileged-users show ...............................................
vscan scanner-pool servers add ...............................................................
vscan scanner-pool servers remove .........................................................
vscan scanner-pool servers show .............................................................
2788
2791
2792
2793
2795
2796
2796
2797
2799
2800
2804
2807
2810
2812
2815
2816
2818
2820
2823
2826
2828
2831
2832
2835
2838
2842
2844
2846
2848
2850
2852
31
Copyright
Copyright 1994-2015 NetApp, Inc. All rights reserved. Printed in the U.S.
No part of this document covered by copyright may be reproduced in any form or by any
meansgraphic, electronic, or mechanical, including photocopying, recording, taping, or
storage in an electronic retrieval systemwithout prior written permission of the copyright
owner.
Software derived from copyrighted NetApp material is subject to the following license
and disclaimer:
THIS SOFTWARE IS PROVIDED BY NETAPP "AS IS" AND WITHOUT ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE, WHICH ARE HEREBY DISCLAIMED. IN NO EVENT
SHALL NETAPP 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.
NetApp reserves the right to change any products described herein at any time, and
without notice. NetApp assumes no responsibility or liability arising from the use of
products described herein, except as expressly agreed to in writing by NetApp. The
use or purchase of this product does not convey a license under any patent rights,
trademark rights, or any other intellectual property rights of NetApp.
The product described in this manual may be protected by one or more U.S. patents,
foreign patents, or pending applications.
RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by the government is
subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical
Data and Computer Software clause at DFARS 252.277-7103 (October 1988) and FAR
52-227-19 (June 1987).
32
Trademarks
NetApp, the NetApp logo, Go Further, Faster, AltaVault, ASUP, AutoSupport,
Campaign Express, Cloud ONTAP, Clustered Data ONTAP, Customer Fitness, Data
ONTAP, DataMotion, Fitness, Flash Accel, Flash Cache, Flash Pool, FlashRay,
FlexArray, FlexCache, FlexClone, FlexPod, FlexScale, FlexShare, FlexVol, FPolicy,
GetSuccessful, LockVault, Manage ONTAP, Mars, MetroCluster, MultiStore, NetApp
Insight, OnCommand, ONTAP, ONTAPI, RAID DP, RAID-TEC, SANtricity, SecureShare,
Simplicity, Simulate ONTAP, Snap Creator, SnapCenter, SnapCopy, SnapDrive,
SnapIntegrator, SnapLock, SnapManager, SnapMirror, SnapMover, SnapProtect,
SnapRestore, Snapshot, SnapValidator, SnapVault, StorageGRID, Tech OnTap,
Unbound Cloud, and WAFL and other names are trademarks or registered trademarks
of NetApp, Inc., in the United States, and/or other countries. All other brands or products
are trademarks or registered trademarks of their respective holders and should be
treated as such. A current list of NetApp trademarks is available on the web at http://
www.netapp.com/us/legal/netapptmlist.aspx.
33
About the Clustered Data ONTAP Commands:

Manual Page Reference
The Commands: Manual Page Reference document is a compilation of all the manual
(man) pages for clustered Data ONTAP commands.
This includes admin and advanced level commands.
Manual pages are grouped into sections according to families to which the commands
belong.
Viewing manual pages at the command line

To view a manual page for a command at your storage system command line (console),
enter the following:
man command
Note: Data ONTAP commands are case sensitive.
To see a list of all commands from the storage system command line, enter a question
mark (?) after the host prompt.
34
cd
Change default directory
Availability: This command is available to cluster and Vserver administrators at the
admin privilege level.
Description
The cd command changes the current working directory of the command prompt to the
directory you specify. Using this command with the value ".." has the same effect as
using the up command.
Parameters
[<text>] - Valid CLI Directory
Use this parameter to specify the name of the directory to which you wish to change.
If the directory name contains multiple parts, enclose the directory name in quotation
marks (").
Examples
The following example changes the working directory of the CLI from the top directory to
the dashboard directory. The command prompt displays the new working directory.
cluster1::> cd dashboard
cluster1::dashboard>
The following example changes the working directory from the top directory to the
storage aggregate directory.
cluster1::> cd "storage aggregate"
cluster1::storage aggregate>
See Also
up
35
exit
Quit the CLI session
Description
The exit command ends the current CLI session.
Parameters
None
Examples
The following example ends the current CLI session:
cluster1::> exit
Goodbye
history
Show the history of commands for this CLI session
Description
The history command displays the command history of the current CLI session. A
numeric ID precedes each command. Use this number with the redo command to reexecute that history item.
Parameters
None
Examples
The following example displays the command history of the current CLI session:
36
cluster1::> history
1
vserver show
man volume show
volume delete -vserver vs0 -volume temporary2
volume modify { -volume temp* } -state offline
cluster1::> redo 3
See Also
redo
37
man
Display the online manual pages
Description
The man command displays the manual page of the command you specify. If you do not
specify a command, command displays the man page index.
Parameters
[<text>] - Valid CLI command
The command for which you'd like to see the manual page. The syntax of the command
is the same as the command itself. The man command supports abbreviations and tab
completion of the command name.
Examples
The following example displays the manual page for the storage aggregate create
command.
cluster1::> man sto aggr cre
That example could also have been fully specified as:

cluster1::> man storage aggregate create
redo
Execute a previous command
Description
The redo command re-executes a command that has been executed previously in the
current CLI session. Specify a previously run command using:
38
A string that matches part of a previous command. For example, if the only
volume command you have run is volume show, enter redo vol to re-execute
the command.
The numeric ID of a previous command, as listed by the history command. For
example, enter redo 4 to re-execute the fourth command in the history list.
A negative offset from the end of the history list. For example, enter redo -2 to
re-execute the command that you ran two commands ago.
Parameters
[<text>] - String, Event Number, or Negative Offset
Use this parameter to specify a string, a numeric ID from the command history, or a
negative number that identifies the command to be re-executed.
Examples
The following example re-executes command number 10 in the command history:
cluster1::> redo 10
See Also
history
39
rows
Show/Set the rows for the CLI session
Description
The rows command displays the number of rows that can be displayed in the current
CLI session before the interface pauses output. If you do not set this value, it adjusts
automatically based on the actual height of your terminal. If the actual height is
undefined, the default number of rows is 24.
Specify a number to set the number of rows that can be displayed. Setting this value
manually disables auto-adjustment. Specify zero (0) to disable pausing.
You can also set this value using the set -rows command.
Parameters
[<integer>] - Number of Rows the Screen Can Display
Use this parameter to specify the number of rows your terminal can display.
Examples
The following example displays the current number of rows, then resets the number of
rows to 48:
cluster1::> rows
36
cluster1::> rows 48
See Also
set
40
set
Display/Set CLI session settings
Description
The set command changes attributes of the user interface.
Parameters
[-privilege <PrivilegeLevel>] - Privilege Level
Use this parameter to specify the privilege level of the command session. Possible
values are
admin - Used for routine system management commands
advanced - Used for infrequent, dangerous, or complicated commands
diagnostic - Used for detailed diagnostic commands that are used only by support
personnel
[-confirmations {on|off}] - Confirmation Messages
Use this parameter with the value on to specify that the interface prompt for
confirmation before executing potentially dangerous commands. Use this parameter
with the value off to specify that the interface not prompt for confirmation, even before
potentially dangerous commands execute. The default setting is on.
[-showallfields {true|false}] - Show All Fields
Use this parameter with the value true to specify that the interface display all field
columns when displaying tabular output. Use this parameter with the value false to
specify that the interface display only selected columns. The default setting is false.
[-showseparator <text>] - Show Separator
Use this parameter to specify the characters to use as the field separator. The field
separator is used between field columns when -showallfields is set to "true". The
separator can be from one to three characters in length. When specifying the separator,
enclose it in quotation marks ("). Set the separator to one or more spaces to disable this
feature.
41
[-active-help {true|false}] - Active Help

Use this parameter with the value true to specify that pressing the question mark (?)
key is sufficient to execute a help request. Use this parameter with the value false to
specify that you must press the Return key after the question mark key to execute a
help request. The default setting is true.
[-units {auto|raw|B|KB|MB|GB|TB|PB}] - Data Units
Use this parameter to specify the default units used when reporting data sizes. Possible
values are:
auto - Auto-scale data size for human-readable output
raw - Bytes without unit designation
B - Bytes
KB - Kilobytes
MB - Megabytes
GB - Gigabytes
TB - Terabytes
PB - Petabytes
The default setting is auto.
[-rows <integer>] - Pagination Rows ('0' disables)
Use this parameter to specify the number of rows that can be displayed in the current
CLI session before the interface pauses output. If you do not set this value, it adjusts
automatically based on the actual height of your terminal. If the actual height is
undefined, the default number of rows is 24.
Setting this value manually disables auto-adjustment. Specify zero (0) to disable
pausing.
You can also set this value using the rows command.
[-vserver <text>] - Default Vserver
Use this parameter to specify the name of the Vserver to use as the default value for the
-vserver parameter of commands.
[-node <text>] - Default Node
Use this parameter to specify the name of the node to use as the default value for the node parameter of commands.
42
[-stop-on-error {true|false}] - Stop On Error

Use this parameter with the value true to specify that continuing commands should
stop if they encounter an error. Use this parameter with the value false to specify that
continuing commands should continue if they encounter an error.
Examples
The following example sets the privilege level to advanced.
cluster1::> set -privilege advanced
Warning: These advanced commands are potentially dangerous; use them only when
directed to do so by NetApp personnel.
Do you wish to continue? (y or n): y
cluster1::*>
The following examples cause all columns to be shown in output rows, with a comma
used as the field separator.
cluster1::> set -showallfields true
cluster1::> set -showseparator ","
cluster1::> network port show
node,port,role,link,mtu,autonegotiate-admin,autonegotiate-oper,duplexadmin,duplex-oper,speed-admin,speed-oper,flowcontrol-admin,flowcontroloper,mac,up-admin,type,ifgrp-node,ifgrp-port,ifgrp-distr-func,ifgrp-mode,vlannode,vlan-port,vlan-tag,
Node,Port,Role,Link,MTU,Auto-Negotiation Administrative,Auto-Negotiation
Operational,Duplex Mode Administrative,Duplex Mode Operational,Speed
Administrative,Speed Operational,Flow Control Administrative,Flow Control
Operational,MAC Address,Up Administrative,Port Type,Interface Group Parent
Node,Interface Group Parent Port,Distribution,Create Policy,Parent VLAN
Node,Parent VLAN Port,VLAN Tag,
node1,e0a,cluster,up,1500,true,true,full,full,auto,1000,full,none,00:0c:29:90:20:e9,true,
physical,-,-,-,-,-,-,-,
node1,e0b,cluster,up,1500,true,true,full,full,auto,1000,full,none,00:0c:29:90:20:f3,true,
physical,-,-,-,-,-,-,-,
node1,e0c,data,up,1500,true,true,full,full,auto,1000,full,none,00:0c:29:90:20:fd,true,
physical,-,-,-,-,-,-,-,
node1,e0d,data,up,1500,true,true,full,full,auto,1000,full,none,00:0c:29:90:20:07,true,
physical,-,-,-,-,-,-,-,
node2,e0a,cluster,up,1500,true,true,full,full,auto,1000,full,none,00:0c:29:2e:b6:62,true,
physical,-,-,-,-,-,-,-,
node2,e0b,cluster,up,1500,true,true,full,full,auto,1000,full,none,00:0c:29:2e:b6:6c,true,
physical,-,-,-,-,-,-,-,
43
node2,e0c,data,up,1500,true,true,full,full,auto,1000,full,none,00:0c:29:2e:b6:76,true,
physical,-,-,-,-,-,-,-,
node2,e0d,data,up,1500,true,true,full,full,auto,1000,full,none,00:0c:29:2e:b6:80,true,
physical,-,-,-,-,-,-,-,
See Also
rows
44
top
Go to the top-level directory
Description
The top command changes the current working directory of the command prompt to the
top-level command directory.
Parameters
None
Examples
The following example returns the command prompt from the storage aggregate
directory to the top-level directory:
cluster1::storage aggregate> top
cluster1::>
See Also
storage aggregate
45
up
Go up one directory
Description
The up command, which can also be specified as two dots (..), changes the current
working directory of the command prompt to the directory that is up one level in the
command hierarchy.
Parameters
None
Examples
The following example takes the command prompt up one level from the storage
aggregate directory:
cluster1::storage aggregate> up
cluster1::storage>
See Also
storage aggregate
46
autobalance aggregate show-aggregate-state

Display the Auto Balance Aggregate state for an aggregate
Availability: This command is available to cluster administrators at the advanced
privilege level.
Description
The autobalance aggregate show-aggregate-state command displays
information about an aggregate state that is considered by the Auto Balance Aggregate
feature.
Parameters
{ [-fields <fieldname>, ...]
If you specify the -fields <fieldname>, ... parameter, the command output
also includes the specified field or fields. You can use '-fields ?' to display the fields to
specify.
| [-instance ] }
If you specify the -instance parameter, the command displays detailed information
about all fields.
[-node {<nodename>|local}] - Node Name
If this parameter is specified, the display will be limited to only those aggregates with a
node that matches the specified value.
[-aggregate <aggregate name>] - Name of the Aggregate
If this parameter is specified, the display will be limited to only that aggregate with a
name that matches the specified value.
[-total-size {<integer>[KB|MB|GB|TB|PB]}] - Total Size of the Aggregate
total-size that matches the specified value.
[-used-size {<integer>[KB|MB|GB|TB|PB]}] - Used Size of the Aggregate
used-size that matches the specified value.
47
[-aggregate-unbalanced-threshold {<integer>[KB|MB|GB|TB|PB]}] - Threshold When

Aggregate Is Considered Unbalanced
threshold that matches the specified value.
[-outgoing-size {<integer>[KB|MB|GB|TB|PB]}] - Size of Outgoing Volumes in the
Aggregate
If this parameter is specified, the display will be limited to only those aggregates with an
outgoing-size that matches the specified value. Outgoing size will be equal to the total
size of the volumes that move away from each one of those aggregate.
[-incoming-size {<integer>[KB|MB|GB|TB|PB]}] - Size of Incoming Volumes in the
Aggregate
If this parameter is specified, the display will be limited to only those aggregates with an
incoming-size that matches the specified value. Incoming size will be equal to the total
size of the volumes that move towards to each one of those aggregates.
[-raidtype {raid_dp|raid4}] - RAID Type
raidtype that matches the specified value.
[-home-cluster <UUID>] - Home Cluster ID
home-cluster ID that matches the specified value.
[-is-hybrid {true|false}] - Aggregate Is a Hybrid
If this parameter is specified as true, the display will be limited to only hybrid
aggregates. If the parameter is specified as false, the display will be limited to only nonhybrid aggregates.
[-is-incoming-volume-thin {true|false}] - An Incoming Volume Is Thin
When you use thin provisioning for a volume, it can run out of space even if it has not
yet consumed its nominal size and you should carefully monitor space utilization to
avoid unexpected errors due to the volume running out of space. If this parameter is
specified as true, the display will be limited to only those aggregates which are the
target of a move of thin volume. If the parameter is specified as false, the display will be
limited to only those aggregates which are not the target of a move of thin volume.
[-is-balanceable {true|false}] - Is Balanceable
If this parameter is specified as true, the display will be limited to only balanceable
aggregates. If the parameter is specified as false, the display will be limited to only nonbalanceable aggregates.
48
[-is-move-target {true|false}] - Aggregate Is a Volume Move Target

If this parameter is specified as true, the display will be limited to only those aggregates
which are target of a volume move. If the parameter is specified as false, the display will
be limited to only those aggregates which are not the target of a volume move.
[-attributes <text>, ...] - Aggregate Attributes
If this parameter is specified, the display will be limited to only those aggregates with
attributes that matches the specified values.
Examples
The following example displays information about the state for all aggregates in the
cluster.
cluster1::*> autobalance aggregate show-aggregate-state
Aggregate: aggr0
Total Size: 3.18GB
Used Size: 3.03GB
Outgoing Size: 0B
Incoming Size: 0B
Aggregate Used Space Threshold: 2.22GB
RAID Type: raid_dp
Home Cluster ID: bae89a50-a926-11e3-ac74-123478563412
Attributes: CFO
Excluded
Mroot
Aggregate: aggr_1
Total Size: 56.04MB
Used Size: 40.72MB
Outgoing Size: 0B
Incoming Size: 0B
Aggregate Used Space Threshold: 39.23MB
RAID Type: raid_dp
Home Cluster ID: bae89a50-a926-11e3-ac74-123478563412
Attributes: Excluded
The following example displays information about all entries of the aggregate state, for
all aggregates in the cluster.
49
cluster1::*> autobalance aggregate show-aggregate-state -instance

Node Name: cluster-1-01
Name of the Aggregate: aggr0
Total Size of the Aggregate: 3.18GB
Used Size of the Aggregate: 3.03GB
Threshold When Aggregate Is Considered Unbalanced: 2.22GB
Size of Outgoing Volumes in the Aggregate: 0B
Size of Incoming Volumes in the Aggregate: 0B
RAID Type: raid_dp
Home Cluster ID: bae89a50-a926-11e3ac74-123478563412
Aggregate Is a Hybrid: false
An Incoming Volume Is Thin: false
Is Balanceable: false
Aggregate Is a Volume Move Target: false
Aggregate Attributes: CFO
Excluded
Mroot
Name of the Aggregate: aggr_1
Total Size of the Aggregate: 56.04MB
Used Size of the Aggregate: 40.72MB
Threshold When Aggregate Is Considered Unbalanced: 39.23MB
Size of Outgoing Volumes in the Aggregate: 0B
Size of Incoming Volumes in the Aggregate: 0B
RAID Type: raid_dp
Home Cluster ID: bae89a50-a926-11e3ac74-123478563412
Aggregate Is a Hybrid: false
An Incoming Volume Is Thin: false
Is Balanceable: false
Aggregate Is a Volume Move Target: false
Aggregate Attributes: Excluded
50
autobalance aggregate show-unbalanced-volumestate

Display the Auto Balance Aggregate state for a volume
privilege level.
Description
The autobalance aggregate show-unbalanced-volume-state command
displays information about a volume that is considered by the Auto Balance Aggregate
feature.
Parameters
specify.
| [-instance ] }
about all fields.
If this parameter is specified, the display will be limited to only those volumes with a
node that matches the specified value.
[-DSID <integer>] - DSID of the Last Volume Queried
DSID that matches the specified value.
[-aggregate <aggregate name>] - Aggregate
If this parameter is specified, the display will be limited to only those volumes with an
aggregate name that matches the specified value.
[-volume-name <text>] - Name of the Volume
If this parameter is specified, the display will be limited to only that volume with a name
that matches the specified value.
51
[-last-threshold-crossed-time <MM/DD/YYYY HH:MM:SS>] - Last Time Threshold

Crossed
threshold crossing time that matches the specified value.
[-last-placed-time <MM/DD/YYYY HH:MM:SS>] - Last Time Volume Was Moved
If this parameter is specified, the display will be limited to only those volumes with a last
time they have been moved that matches the specified value.
[-is-moving {true|false}] - Is Volume Currently Moving
If this parameter is specified as true, the display will be limited to only the moving
volumes. If the parameter is specified as false, the display will be limited to only the nonmoving volumes.
[-is-quiesced {true|false}] - Is Volume Quiesced
If this parameter is specified as true, the display will be limited to only the quiesced
volumes. If the parameter is specified as false, the display will be limited to only the nonquiesced volumes.
[-total-footprint {<integer>[KB|MB|GB|TB|PB]}] - Total Size of the Volume
If this parameter is specified, the display will be limited to only those volumes with a total
footprint that matches the specified value.
[-attributes <text>, ...] - Volume's Attributes
If this parameter is specified, the display will be limited to only those volumes with
attributes that matches the specified value.
[-last-checked <MM/DD/YYYY HH:MM:SS>] - Last Time Volume State Was Checked
If this parameter is specified, the display will be limited to only those volumes with a last
time their state was checked that matches the specified value.
Examples
The following example display information about all of the unbalanced volumes that the
Auto Balance Aggregate feature is aware of.
cluster1::*> autobalance aggregate show-unbalanced-volume-state
Last Checked On: 3/13/2014 14:32:01
Volume: ro10
Footprint: 20.20MB
Last Time Over IOPS Threshold: 3/12/2014 16:20:18
52
Last Placed: 3/11/2014 10:16:04

Attributes: Over IOPS Threshold
Stabilizing
Volume: test
Footprint: 20.20MB
Last Time Over IOPS Threshold: 3/12/2014 16:20:18
Last Placed: 3/11/2014 10:16:42
Attributes: Over IOPS Threshold
In Mirror
Stabilizing
The following example displays all of the information that the Auto Balance Aggregate
feature has collected for all of the unbalanced volumes it is aware of.
cluster1::*> autobalance aggregate show-unbalanced-volume-state -instance
DSID of the Last Volume Queried: 1025
Aggregate: aggr_1
Name of the Volume: ro10
Last Time Threshold Crossed: 3/12/2014 16:20:18
Last Time Volume Was Moved: 3/11/2014 10:16:04
Is Volume Currently Moving: false
Is Volume Quiesced: false
Total Size of the Volume: 20.20MB
Volume's Attributes: Over IOPS Threshold
Stabilizing
Last Time Volume State Was Checked: 3/13/2014 08:20:18
DSID of the Last Volume Queried: 1026
Aggregate: aggr_1
Name of the Volume: test
Last Time Threshold Crossed: 3/12/2014 16:20:18
Last Time Volume Was Moved: 3/11/2014 10:16:42
Is Volume Currently Moving: false
Is Volume Quiesced: false
Total Size of the Volume: 20.20MB
Volume's Attributes: Over IOPS Threshold
In Mirror
53
Stabilizing
Last Time Volume State Was Checked: 3/13/2014 08:20:18
54
autobalance aggregate config modify

Modify the Auto Balance Aggregate feature configuration
privilege level.
Description
The autobalance aggregate config modify command allows the user to
customize the parameters that determine when volumes should be considered for
automatic move or recommendation by the Auto Balance Aggregate feature.
Parameters
[-is-enabled {true|false}] - Is the Auto Balance Aggregate Feature Enabled
This specifies whether the Auto Balance Aggregate feature is enabled and running.
[-aggregate-unbalanced-threshold-percent <integer>] - Threshold When Aggregate Is
Considered Unbalanced (%)
This specifies the space used threshold percentage that will cause the Auto Balance
Aggregate feature to consider an aggregate as unbalanced.
[-aggregate-available-threshold-percent <integer>] - Threshold When Aggregate Is
Considered Balanced (%)
This specifies the threshold percentage which will determine if an aggregate is a target
destination for a move. The Auto Balance Aggregate feature will attempt to move
volumes from an unbalanced aggregate until it is under this percentage.
Examples
The following example displays a modification for the default configuration of the Auto
Balance Aggregate feature
cluster1::*> autobalance aggregate config show
Is the Auto Balance Aggregate Feature Enabled: false
Threshold When Aggregate Is Considered Unbalanced (%): 70
Threshold When Aggregate Is Considered Balanced (%): 40
cluster1::*> autobalance aggregate config modify -is-enabled true
55

Is the Auto Balance Aggregate Feature Enabled: true
56
autobalance aggregate config show

Display the Auto Balance Aggregate feature configuration
privilege level.
Description
The autobalance aggregate config show command displays information about
parameters that determine when volumes should be considered for automatic move or
recommendation by the Auto Balance Aggregate feature.
Parameters
None
Examples
The following example displays the default configuration for the Auto Balance Aggregate
feature
Is the Auto Balance Aggregate Feature Enabled: false
57
autobalance volume rebalance show

Display Auto Balance Volume progress for an Infinite Volume
advanced privilege level.
Description
The autobalance volume rebalance show command displays information about
Auto Balance Volume operations for an Infinite Volume. The command output depends
on the parameter or parameters specified with the command. The autobalance
volume rebalance show command is only supported for Infinite Volumes.
Parameters
This specifies the fields that need to be displayed.
| [-instance ] }
If this parameter is specified, the command displays information about all entries.
[-vserver <vserver name>] - Vserver
If this parameter is specified, the command displays information about capacity
balancing for each Infinite Volume and storage service on the specified Vserver.
[-volume <volume name>] - Volume Name
balancing for each storage service on the specified Infinite Volume.
[-storage-service <storage service name>] - Storage Service
balancing for the specified storage-service.
[-state <Auto Balance Volume state>] - State
If this parameter is specified, the command displays information about operations in the
specified state.
[-progress <text>] - Progress
If this parameter is specified, the command displays information about operations with
the specified progress.
58
[-transferred {<integer>[KB|MB|GB|TB|PB]}] - Amount Transferred

the specified amount already transferred.
[-target {<integer>[KB|MB|GB|TB|PB]}] - Target Amount
the specified target amount of data to transfer.
[-transferred-percent <percent_no_limit>] - Percentage Transferred
the specified percentage of the transfer complete.
Examples
The following example displays information about all operations on the Vserver named
vs0:
cluster1::*> autobalance volume rebalance show -vserver vs1
Storage
Vserver
Volume
Service
Percent
State
Target
Transferred
---------------- ------------ ----------- --------- ------- ----------vs0
repo_vol
running
36.44TB
8%
The following example displays information about all operations on the gold storage
service on the Infinite Volume named repo_vol on the Vserver named vs1:
cluster1::*> autobalance volume show rebalance -vserver vs1 -volume repo_vol storage-service gold
Storage
Vserver
Volume
Service
Percent
State
Target
Transferred
---------------- ------------ ----------- --------- ------- ----------vs1
repo_managed gold
running
17.22TB
18%
vs1
repo_managed silver
complete
19.25TB
100%
59
autobalance volume rebalance start

Start Auto Balance Volume for an Infinite Volume
Description
The autobalance volume rebalance start command allows the user to start
Auto Balance Volume and rebalance the used data capacity in an Infinite Volume after
files are created. Auto Balance Volume moves data between data constituents of an
Infinite Volume. If the Infinite Volume uses storage services, Auto Balance Volume
moves data between data constituents of a storage service in an Infinite Volume. Auto
Balance Volume ensures that all data constituents in an Infinite Volume or all data
constituents in a storage service of an Infinite Volume have similar amounts of used
data capacity. The autobalance volume rebalance start command is only
supported for Infinite Volumes.
Parameters
-vserver <vserver name> - Vserver
This specifies the Vserver on which the Infinite Volume to be rebalanced is located.
-volume <volume name> - Volume Name
This specifies the Infinite Volume to be rebalanced.
-storage-service <storage service name> - Storage Service
If the Infinite Volume uses storage services, the storage-service parameter is
required to specify the storage service to be rebalanced. If the Infinite Volume does not
use storage services, the storage-service parameter cannot be specified, and the
entire Infinite Volume will be rebalanced.
Examples
The following example starts rebalancing used capacity in the gold storage service for
an Infinite Volume named vol:
cluster1::*> autobalance volume rebalance start
-vserver vs0 -volume vol -storage-service gold
The following example starts rebalancing used capacity in an Infinite Volume named vol:
60
cluster1::*> autobalance volume rebalance start

-vserver vs1 -volume vol
autobalance volume rebalance stop

Stop Auto Balance Volume for an Infinite Volume
Description
The autobalance volume rebalance stop command allows the user to stop Auto
Balance Volume. The autobalance volume rebalance stop command is only
supported for Infinite Volumes.
Parameters
This specifies the Vserver on which the Infinite Volume being rebalanced is located.
This specifies the Infinite Volume being rebalanced.
-storage-service <storage service name> - Storage Service
If the Infinite Volume being rebalanced uses storage services, the storage-service
parameter is required to specify the storage service being rebalanced. If the Infinite
Volume being rebalanced does not use storage services, the storage-service
parameter cannot be specified because the entire Infinite Volume is being rebalanced.
Examples
The following example stops rebalancing used capacity for the gold storage service for
an Infinite Volume named vol:
cluster1::*> autobalance volume rebalance stop
-vserver vs0 -volume vol -storage-service gold
The following example stops rebalancing used capacity for an Infinite Volume named
vol:
cluster1::*> autobalance volume rebalance stop
-vserver vs1 -volume vol
61
62
63
cluster create
Create a cluster
Availability: This command is available to cluster administrators at the admin privilege
level.
Description
The cluster create command creates a cluster with one node. Once you create the
cluster, add additional nodes to the cluster by using the cluster join command.
Note that single-node clusters do not require configuring the cluster network. A cluster
network interface must be configured before other nodes can join the cluster.
Parameters
[-license <License Code V2>] - Base License
Use this optional parameter to specify the base license for the cluster. Obtain this value
from your sales or support representative.
-clustername <text> - Cluster Name
Use this parameter to specify the name of the cluster you are creating.
The name must contain only the following characters: A-Z, a-z, 0-9, ".", "-" or "_".
The first character of each label, delimited by ".", must be one of the following
characters: A-Z or a-z.
The last character of each label, delimited by ".", must be one of the following
characters: A-Z, a-z or 0-9.
The maximum supported length is 44 characters.
The system reserves the following names: "all", "cluster", "local" and "localhost".
Examples
The following example creates a cluster named cluster1.
cluster1::> cluster create -license ABCDEFGHIJKLMN -clustername cluster1
See Also
64
cluster join
65
cluster join
Join an existing cluster using the specified member's IP address or by cluster name
level.
Description
The cluster join command adds a node to an existing cluster. Use the cluster
create command to create a cluster if one does not already exist.
Note that a cluster network interface must be configured for the cluster before other
nodes can join the cluster.
Parameters
{ -clusteripaddr <IP Address> - IP Address of a Cluster Interface from a Node in the
Cluster
Use this parameter to specify the IP address of a cluster interface. This must be the IP
address of a cluster interface of a node that is already in the cluster. This parameter is
mutually exclusive with the -cluster-name parameter.
| -cluster-name <text> } - Cluster Name of the Cluster to Join
Use this parameter to specify the name of an existing cluster to join. This parameter is
mutually exclusive with the -clusteripaddr parameter.
Examples
The following example joins the local node to a cluster. The IP address 192.0.2.66 is the
address of a cluster interface of a node that already belongs to the cluster.
node::> cluster join -clusteripaddr 192.0.2.66
This next example joins the local node to a cluster named "cluster1". "cluster1" is a
cluster that already exists.
node::> cluster join -cluster-name cluster1
See Also
cluster create
66
cluster modify
Modify cluster node membership attributes
level.
Description
The cluster modify command modifies the cluster attributes of a node, including its
eligibility to participate in the cluster.
At the advanced privilege level, you can use the command to specify whether a node
holds epsilon. Epsilon is an extra fractional vote that enables quorum to form using
slightly weaker requirements. For example, two out of four eligible nodes are sufficient
to form quorum if one of those two nodes holds epsilon.
Parameters
-node {<nodename>|local} - Node
Use this parameter to specify the name of the node to modify. If you do not specify a
node, the command runs on the local node.
[-epsilon {true|false}] - Epsilon (privilege: advanced)
Use this parameter with the value true to specify that the node holds Epsilon in the
cluster. Use this parameter with the value false to specify that the node does not hold
Epsilon in the cluster. In a cluster, only one node can be designated as Epsilon at any
given time. You can designate a node as Epsilon to add weight to its voting in a cluster
with an even number of nodes.
[-eligibility {true|false}] - Eligibility (privilege: advanced)
Use this parameter with the value true to specify that the node is eligible to participate
in the cluster. Use this parameter with the value false to specify that the node is not
eligible to participate in the cluster.
If you modify a node as ineligible to participate in the cluster, the command prompts you
for confirmation before it runs.
Examples
This example modifies a node to make it eligible to participate in the cluster.
cluster1::*> cluster modify -node node3 -eligibility true
67
The following example removes epsilon from the node named node0 and adds it to the
node named node1:
cluster1::*> cluster modify -node node0 -epsilon false
cluster1::*> cluster modify -node node1 -epsilon true
cluster ping-cluster
Ping remote cluster interfaces and perform RPC server check
privilege level.
Description
The cluster ping-cluster command probes network connectivity to remote cluster
interfaces, and performs an RPC server check.
Parameters
-node <nodename> - Node
Use this parameter to send the ping from the node you specify.
[-use-sitelist {true|false}] - Use Sitelist for Cluster Interfaces
Use this parameter with the value true to specify that the command use the sitelist
to determine any incomplete cluster IP information. Use this parameter with the value
false to specify that the command not use the sitelist.
[-skip-rpccheck {true|false}] - Skip RPC Server Check
Use this parameter with the value true to specify that the command not perform the
rpcinfo check of remote hosts. Use this parameter with the value false to specify that
the command perform the rpcinfo check. The rpcinfo check checks the status of the
RPC servers on the remote hosts. By default, the rpcinfo check runs on the program
number of the portmapper. Use the -rpc-prognum parameter to override this default.
[-rpc-prognum <integer>] - RPC Server to Check
Use this parameter to override default behavior and run the rpcinfo check on the
program number you specify. By default, the rpcinfo check runs on the program number
of the portmapper.
68
Examples
The following example shows typical output for this command.
cluster1::*> cluster ping-cluster -node node1
Host is node1
Getting addresses from network interface table...
Local = 10.254.231.102
Remote = 10.254.42.25
10.254.91.42
10.254.16.228
Ping status:
....
Basic connectivity succeeds on 4 path(s)
Basic connectivity fails on 0 path(s)
................
Detected 1500 byte MTU on 4 path(s):
Local 10.254.231.102 to Remote 10.254.16.228
Local 10.254.231.102 to Remote 10.254.42.25
Local 10.254.91.42 to Remote 10.254.16.228
Local 10.254.91.42 to Remote 10.254.42.25
Larger than PMTU communication succeeds on 4 path(s)
RPC status:
2 paths up, 0 paths down (tcp check)
2 paths up, 0 paths down (udp check)
69
cluster setup
Setup wizard
level.
Description
The cluster setup command runs the cluster setup wizard, which can be used to
either create a cluster or join a node to an existing cluster. When you run the cluster
setup wizard, enter the appropriate information at the prompts. You will be asked to
provide the following information to create a cluster:
Cluster name
Cluster base license key
Feature license keys
Cluster administrator's password
Cluster management interface port, IP address, netmask, default gateway
Node management interface port, IP address, netmask, default gateway
DNS domain names
Name server IP addresses
Location
You will be asked to provide the following information to join a cluster:
Cluster name
Node management interface port, IP address, netmask, default gateway
The cluster management interface is used for managing the cluster. It provides one IP
address to manage the cluster and will fail over to another node, if necessary. This is the
preferred IP address for managing the cluster, but you can also manage the cluster by
logging in to the node management IP address of a node in the cluster. Since the cluster
management interface must be able to fail over, the port role for the interface must be
"data" and typically the best choice for an IP address is one on the data network. The
node management interface will not fail over, so an IP address on the management
network and a port with the role "node management" is the best choice. Alternatively,
you can assign an IP address on the data network to the cluster management interface
70
- if that is better in your network topology - but the port must be a data port. The two
examples below illustrate the cluster create and cluster join operations, respectively.
Parameters
None
Examples
The following example shows the create option of cluster setup.
node::> cluster setup
Welcome to the cluster setup wizard.
You can enter the following commands at any time:
"help" or "?" - if you want to have a question clarified,
"back" - if you want to change previously answered questions, and
"exit" or "quit" - if you want to quit the cluster setup wizard.
Any changes you made before quitting will be saved.
You can return to cluster setup at any time by typing "cluster setup".
To accept a default or omit a question, do not enter a value.
Do you want to create a new cluster or join an existing cluster? {create, join}:
create
Do you intend for this node to be used as a single node cluster? {yes, no} [no]:
no
Will the cluster network be configured to use network switches? [yes]:
yes
System Defaults:
Private cluster network ports [e0a,e0b].
Cluster port MTU values will be set to 9000.
Cluster interface IP addresses will be automatically generated.
Do you want to use these defaults? {yes, no} [yes]:
It can take several minutes to create cluster interfaces...
71
Step 1 of 5: Create a Cluster

You can type "back", "exit", or "help" at any question.
Enter the cluster name: cluster1
Enter the cluster base license key: ABCDEFGHIJKLMN
Creating cluster cluster1
Starting cluster support services .....
Cluster cluster1 has been created.
Step 2 of 5: Add Feature License Keys

Enter an additional license key []:
Step 3 of 5: Set Up a Vserver for Cluster Administration

Enter the cluster administrator's (username "admin") password:
Retype the password:
Enter the cluster management interface port [e0c]:
Enter the cluster management interface IP address: 192.0.2.60
Enter the cluster management interface netmask: 255.255.255.192
Enter the cluster management interface default gateway: 192.0.2.1
A cluster management interface on port e0c with IP address 192.0.2.60 has been
created. You can use this address to connect to and manage the cluster.
Enter the DNS domain names: data.example.com
Enter the name server IP addresses: 192.0.2.147
DNS lookup for the admin Vserver will use the data.example.com domain.
72
Step 4 of 5: Configure Storage Failover (SFO)

SFO is licensed.
SFO will be enabled when the partner joins the cluster.
Step 5 of 5: Set Up the Node

Where is the controller located []: Sunnyvale
Enter the node management interface port [e0c]: e0d
Enter the node management interface IP address: 192.0.2.66
Enter the node management interface netmask: 255.255.255.192
Enter the node management interface default gateway: 192.0.2.1
A node management interface on port e0d with IP address 192.0.2.66 has been
created.
Cluster setup is now complete.

To begin storing and serving data on this cluster, log in to the command-line
interface (for example, ssh admin@192.0.2.60) and complete the following
additional tasks if they have not already been completed:
- Join additional nodes to the cluster by running "cluster setup" on
those nodes.
- For HA configurations, verify that storage failover is enabled by
running the "storage failover show" command.
- Create a Vserver by running the "vserver create" command.
In addition to using the CLI to perform cluster management tasks, you can manage
your cluster using OnCommand System Manager, which features a graphical user
interface that simplifies many cluster management tasks. This software is
available from the NetApp Support Site.
Exiting the cluster setup wizard.
73
An example of using cluster setup to join a cluster is shown below.

node::> cluster setup
Welcome to the cluster setup wizard.
You can enter the following commands at any time:
"help" or "?" - if you want to have a question clarified,
"back" - if you want to change previously answered questions, and
"exit" or "quit" - if you want to quit the cluster setup wizard.
Any changes you made before quitting will be saved.
You can return to cluster setup at any time by typing "cluster setup".
To accept a default or omit a question, do not enter a value.
Do you want to create a new cluster or join an existing cluster? {create, join}:
join
System Defaults:
Private cluster network ports [e0a,e0b].
Cluster port MTU values will be set to 9000.
Cluster interface IP addresses will be automatically generated.
Do you want to use these defaults? {yes, no} [yes]:
It can take several minutes to create cluster interfaces...
Step 1 of 3: Join an Existing Cluster

Enter the name of the cluster you would like to join [cluster1]:
Joining cluster cluster1
Step 2 of 3: Configure Storage Failover (SFO)
74

SFO is licensed.
SFO will be enabled when the partner joins the cluster.
Step 3 of 3: Set Up the Node

Enter the node management interface port [e0c]:
Enter the node management interface IP address: 192.0.2.67
Enter the node management interface netmask [255.255.255.192]:
Enter the node management interface default gateway [192.0.2.1]:
A node management interface on port e0c with IP address 192.0.2.67 has been
created.
Cluster setup is now complete.

To begin storing and serving data on this cluster, log in to the command-line
interface (for example, ssh admin@192.0.2.60) and complete the following
additional tasks if they have not already been completed:
- Join additional nodes to the cluster by running "cluster setup" on
those nodes.
- For HA configurations, verify that storage failover is enabled by
running the "storage failover show" command.
- Create a Vserver by running the "vserver create" command.
In addition to using the CLI to perform cluster management tasks, you can manage
your cluster using OnCommand System Manager, which features a graphical user
interface that simplifies many cluster management tasks. This software is
available from the NetApp Support Site.
Exiting the cluster setup wizard.
See Also
cluster create cluster join
75
cluster show
Display cluster node members
level.
Description
The cluster show command displays information about the nodes in a cluster.
Parameters
specify.
| [-instance ] }
about all fields.
[-node {<nodename>|local}] - Node
Selects the nodes that match this parameter value.
[-node-uuid <UUID>] - UUID (privilege: advanced)
Selects the nodes that match this parameter value. In a cluster, only one node can be
designated as Epsilon at any given time. You can designate a node as Epsilon to add
weight to its voting in a cluster with an even number of nodes.
[-eligibility {true|false}] - Eligibility
Selects the nodes that match this parameter value (true means eligible to participate in
the cluster).
[-health {true|false}] - Health
Selects the nodes that match this parameter value (true means online).
Examples
76
The following example displays information about all nodes in the cluster:
cluster1::> cluster show
Node
Health
Eligibility
--------------------- ------- -----------node0
true
true
node1
true
true
node2
true
true
node3
true
true
The following example displays information about the node named node1:
cluster1::> cluster show -node node1
Node: node1
Eligibility: true
Health: true
cluster unjoin
Unjoin or remove a node from the cluster
privilege level.
Description
The cluster unjoin command removes a node from a cluster.
Before you can remove a node from a cluster, you must shut down all of the node's
shared resources, such as virtual interfaces to clients. If any of a node's shared
resources are still active, the command fails. The failure message will display which
active resources must be shut down before the node can be removed from the cluster.
Parameters
-node <nodename> - Node to unjoin
Use this parameter to specify the name of the node to remove from the cluster.
Examples
The following example shows how to remove the node named node4 from the cluster.
77
cluster1::*> cluster unjoin -node node4
cluster contact-info modify

Modify contact information for the cluster
level.
Description
The cluster contact-info modify command modifies contact information for the
cluster administrators. If any values contain spaces, you must enclose those values in
quotes.
Use the cluster contact-info show command to display contact information for
the cluster administrators.
Parameters
[-primary-name <text>] - Name of Primary Contact
Use this parameter to specify the name of the primary contact.
[-primary-phone <text>] - Phone Number of Primary Contact
Use this parameter to specify the phone number of the primary contact.
[-primary-alt-phone <text>] - Alternate Phone Number of Primary Contact
Use this parameter to specify the alternate phone number of the primary contact.
[-primary-email <text>] - Email Address or User ID of Primary Contact
Use this parameter to specify the email address of the primary contact.
[-secondary-name <text>] - Name of Secondary Contact
Use this parameter to specify the name of the secondary contact.
[-secondary-phone <text>] - Phone Number of Secondary Contact
Use this parameter to specify the phone number of the secondary contact.
[-secondary-alt-phone <text>] - Alternate Phone Number of Secondary Contact
Use this parameter to specify the alternate phone number of the secondary contact.
[-secondary-email <text>] - Email Address or User ID of Secondary Contact
78
Use this parameter to specify the email address of the secondary contact.
[-business-name <text>] - Business Name
Use this parameter to specify the name of the business responsible for this cluster.
[-address <text>] - Business Address
Use this parameter to specify the street address of the business responsible for this
cluster.
[-city <text>] - City Where Business Resides
Use this parameter to specify the name of the city in which the business is located.
[-state <text>] - State Where Business Resides
Use this parameter to specify the name of the state or province in which the business is
located.
[-country <Country Code>] - 2-Character Country Code
Use this parameter to specify the 2-character country code of the country in which the
business is located.
[-zip-code <text>] - Postal Code Where Business Resides
Use this parameter to specify the postal or ZIP code area in which the business is
located.
Examples
The following example changes the name and phone numbers of the secondary contact
person for the cluster.
cluster1::> cluster contact-info modify -secondary-name "John Doe" -secondaryphone 123.555.0156 -secondary-alt-phone 123.555.0178
The following example changes the mailing address of the business responsible for the
cluster.
cluster1::> cluster contact-info modify -address "123 Example Avenue" -city
Exampleville -state "New Example" -zip-code 99999 -country US
See Also
cluster contact-info show
79
cluster contact-info show

Display contact information for the cluster
level.
Description
The cluster contact-info show command displays contact information for the
cluster administrators.
Parameters
None
Examples
The following example shows example output for this command.
cluster1::> cluster contact-info show
Name of Primary Contact : Richard Roe
Phone Number of Primary Contact : 123.555.0123
Alternate Phone Number of Primary Contact : 123.555.0145
Email Address or User Id of Primary Contact : roe@example.com
Name of Secondary Contact : John Doe
Phone Number of Secondary Contact : 123.555.0167
Alternate Phone Number of Secondary Contact : 123.555.0189
Email Address or User Id of Secondary Contact : doe@example.com
Business Name : Example Dot Com
Business Address : 123 Example Avenue
City Where Business Resides : Exampleville
State Where Business Resides : New Example
2-Character Country Code : US
Postal Code Where Business Resides : 99999
80
cluster date modify

Modify the current date and time for the nodes in the cluster
level.
Description
The cluster date modify command sets the time zone, date, and time on every
node in the cluster.
Parameters
[-timezone <Area/Location Timezone>] - Time Zone
This parameter sets the timezone, specified in the Olson format.
[-date {MM/DD/YYYY HH:MM:SS [{+|-}hh:mm]}] - Date and Time
This parameter sets the date and time, in the format MM/DD/YYYY HH:MM:SS.
[-dateandtime <[[[[[cc]yy]mm]dd]hhmm[.ss]]>] - Date and Time
This parameter sets the date and time information, in the format
[[[[[cc]yy]mm]dd]hhmm[.ss]]. The argument for setting the date and time is interpreted as
follows:
cc First 2 digits of the year (e.g., 20 for 2011).
yy Last 2 digits of year (e.g., 10 for 2010).
mm Numeric month, a number from 01 to 12.
dd Day, a number from 01 to 31.
hh Hour, a number from 00 to 23.
mm Minute, a number from 00 to 59.
ss Second, a number from 00 to 59.
If the first two digits of the year are omitted, and the last two digits are greater than 68,
a date in the 1900s is used. Otherwise, a date in the 2000s is used. If all four digits of
the year are omitted, the default is the current year. If the month or day is omitted, the
default is the current month or day, respectively. If the seconds are omitted, the default
81
is set to 00. The system automatically handles the time changes for Daylight Saving and
Standard time, and for leap seconds and years.
[-utcdateandtime | -u <[[[[[cc]yy]mm]dd]hhmm[.ss]]>] - UTC Date and Time
This parameter sets the date and time information in Coordinated Universal Time
(UTC), in the format [[[[[cc]yy]mm]dd]hhmm[.ss]]. -u is an alias for -utcdateandtime. The
argument for setting the date and time is interpreted as follows:
If the first two digits of the year are omitted, and the last two digits are greater than 68,
a date in the 1900s is used. Otherwise, a date in the 2000s is used. If all four digits of
the year are omitted, the default is the current year. If the month or day is omitted, the
default is the current month or day, respectively. If the seconds are omitted, the default
is set to 00. Time changes for Daylight Saving and Standard time, and for leap seconds
and years, are handled automatically.
Examples
The following example sets the date and time to January 1 2011, at 1:00 a.m.:
cluster1::> cluster date modify -date "01/01/2011 01:00:00"
The following example sets the date and time in the UTC format to May 22, 2011, at
09:25:00 a.m.:
cluster1::> cluster date modify -u 201105220925.00.
cluster date show

Display the current date and time for the nodes in the cluster
82

level.
Description
The cluster date show command displays the time zone, date, and time settings
for one or more nodes in the cluster. By default, the command displays date and time
settings for all nodes in the cluster.
Parameters
specify.
| [-utc ]
Displays date and time information in Coordinated Universal Time (UTC).
| [-utcdate ]
Displays date and time information in UTC.
| [-instance ] }
about all fields.
[-timezone <Area/Location Timezone>] - Time Zone
Selects the nodes that match this parameter value (specified in the Olson format).
[-date {MM/DD/YYYY HH:MM:SS [{+|-}hh:mm]}] - Date and Time
[-utc-date <MM/DD/YYYY HH:MM:SS>] - UTC Date and Time
[-dateandtime <[[[[[cc]yy]mm]dd]hhmm[.ss]]>] - Date and Time
Selects the nodes that match this parameter value (interpreted as follows):
83

[-utcdateandtime | -u <[[[[[cc]yy]mm]dd]hhmm[.ss]]>] - UTC Date and Time
-u is used as an alias for -utcdateandtime. Selects the nodes that match this parameter
value (interpreted as follows):
Examples
The following example displays the date and time settings for all nodes in the cluster:
cluster1::> cluster date show
Node
Date
Timezone
--------- ------------------- ----------------node0
10/06/2011 09:35:15 America/New_York
node1
10/06/2011 09:35:15 America/New_York
node2
10/06/2011 09:35:15 America/New_York
node3
10/06/2011 09:35:15 America/New_York
4 entries were displayed.
84
cluster ha modify
Modify high-availability configuration of cluster management services
level.
Description
The cluster ha modify command enables or disables cluster high availability in a
two-node cluster. Enable high availability when performing some procedures, such as
replacing hardware.
Note:
This command is required to enable high availability if the cluster only has two nodes.
Do not run this command in a cluster that has three or more nodes.
Note:
Cluster high availability for two-node clusters differs from the storage failover technology
used between two nodes for storage high availability.
Parameters
[-configured {true|false}] - HA Configured
Use this parameter with the value true to enable high availability mode in the cluster.
Use this parameter with the value false to disable high availability mode in the cluster.
Examples
The following example enables cluster high availability in a cluster.
cluster1::> cluster ha modify -configured true
cluster ha show
Show high-availability configuration status for the cluster
85

level.
Description
The cluster ha show command displays the high-availability status of the cluster.
Cluster high-availability mode applies only to two-node clusters.
Parameters
None
Examples
The following example displays the high-availability status for a two-node cluster:
cluster1::> cluster ha show
High Availability Configured: true
cluster identity modify

Modify the cluster's attributes
level.
Description
The cluster identity modify command changes a cluster's identity information.
Parameters
[-name <Cluster name>] - Cluster Name
Use this parameter to specify a new name for the cluster.
86
[-location <text>] - Cluster Location
Use this parameter to specify the physical location of the cluster. For example, "Lab 5".
[-contact <text>] - Cluster Contact
Use this parameter to specify contact information for the cluster, such as a name or email address.
Examples
The following example renames the current cluster to cluster2:
cluster1::> cluster identity modify -name cluster2
cluster identity show

Display the cluster's attributes including Name, Serial Number, Cluster UUID, Location
and Contact
level.
Description
The cluster identity show command displays the identity information of the
cluster.
Parameters
None
Examples
The following example displays the cluster's UUID, name, serial number, location and
contact information:
cluster1::> cluster identity show
Cluster UUID: 1cd8a442-86d1-11e0-ae1c-123478563412
Cluster Name: cluster1
Cluster Serial Number: 1-80-123456
87
Cluster Location: Lab2

Cluster Contact: jsmith@example.com
cluster1::>
88
cluster image cancel-update

Cancel an update
level.
Description
The cluster image cancel-update command is used to cancel an update that is
in either paused-by-user or paused-by-error state. The update cannot be canceled if it is
not in a paused state.
Parameters
None
Examples
The following example displays an cancel-update operation:
cluster1::> cluster image cancel-update
Warning: The cancel operation can result in a mixed version
cluster and/or mixed version HA pair. The cancel
operation can take several minutes to complete.
Do you want to proceed with the cancel operation? {y|n}: y
Info: Canceling update. It may take a few minutes to finish canceling the update
89
cluster image pause-update

Pause an update
level.
Description
The cluster image pause-update command is used to pause a currently running
update. The update pauses at the next predefined pause point (for example, after
validation, download to the boot device, takeover completion, or giveback completion)
which might take some time to reach. When the update reaches the pause point, it
transitions into the pause-by-user state.
Parameters
None
Examples
The following example displays pause-update operation:
cluster1::> cluster image pause-update
Info: Pausing update. It may take a few minutes to finish pausing the update
cluster image resume-update

Resume an update
level.
Description
The cluster image resume-update command is used to resume an update that is
currently paused in paused-by-user or paused-by-error state. If the update is not paused
then an error is returned.
90
Parameters
None
Examples
The following example shows an resume-update operation:
cluster1::> cluster image resume-update
Info: Resuming update...
cluster image show-update-history

Display the update history
level.
Description
The cluster image show-update-history command displays the update history
for each node. By default, the command displays the following information:
Status
Package version
Start time
Completion time
Component ID
Previous version
Updated version
Parameters
91
specify.
| [-instance ] }
about all fields.
[-component-id <text>] - Component Id
Displays updates for the specified component.
[-start-time <MM/DD/YYYY HH:MM:SS>] - Start Time
Displays updates with the specified start time.
[-package-version <text>] - Package Version
Displays updates for the specified package version.
[-status {successful|canceled|back-out}] - Status
Displays updates that completed with the specified status.
[-completion-time <MM/DD/YYYY HH:MM:SS>] - Completion Time
Displays updates with the specified completion time.
[-previous-version <text>] - Previous Version
Displays updates with the specified previous version.
[-updated-version <text>] - Updated Version
Displays updates with the specified updated version.
Examples
The following example displays history of automated nondisruptive updates:
cluster1::> cluster image show-update-history
Package
Start
Status
Version
Previous
Updated
Time
Time
Component ID
Version
Version
---------- ---------
----------
----------
------------
--------- ---------
canceled
2/11/2014
2/11/2014
ssan-3240-
8.3
8.3
12:05:51
12:05:51
55a
2/11/2014
2/11/2014
ssan-3240-
8.3
8.3
14:23:58
15:02:19
55a
2/13/2014
2/18/2014
ssan-3240-
8.3
8.3
8.3
successful 8.3
successful 8.3
92
Completion
successful 8.3
canceled
8.3
successful 8.3
successful 8.3
successful 8.3
16:48:42
09:45:30
55a
2/18/2014
2/18/2014
ssan-3240-
10:33:10
11:02:45
55a
2/11/2014
2/11/2014
ssan-3240-
12:05:51
12:05:51
55b
2/11/2014
2/11/2014
ssan-3240-
14:23:58
15:54:43
55b
2/13/2014
2/18/2014
ssan-3240-
16:48:42
10:05:02
55b
2/18/2014
2/18/2014
ssan-3240-
10:33:10
11:22:02
55b
8.3
8.3
8.3
8.3
8.3
8.3
8.3
8.3
8.3
8.3
93
cluster image show-update-log-detail

Display detailed information about nondisruptive update events
privilege level.
Description
The cluster image show-update-log-detail command displays detailed
information about the currently running and previously run nondisruptive update events.
By default, the command displays the following information:
Node
Transaction ID
Time stamp
Destination node
Task phase
Task name
Task status
Message
Parameters
specify.
| [-instance ] }
about all fields.
Displays information only for the specified node.
[-task-id <integer>] - Task Id
Displays information only for the specified task ID.
94
[-posted-time <MM/DD/YYYY HH:MM:SS>] - Posted Time

Displays information that occurred at the specified time.
[-msg-seq-no <integer>] - Message Sequence
Displays information only for the specified message sequence number.
[-current-pid <integer>] - Process ID
Displays information only for the specified process ID.
[-destination <text>] - Task Target node
Displays information only for the specified destination node.
[-ndu-phase {validation|prereq-updates|ontap-updates|package-management|defaultphase}] - Update phase
Displays information only for the specified phase.
[-task-name {initialize|mount-image|restart-hm|get-health|run-scripts|unmount-image|
clear-alert|post-restart-hm|cleanup-rd|synch-image|do-download-job|do-failover-job|dogiveback-job|check-progress|complete-validation|invalid-task|default-task }] - Task Name
Displays information only for the specified task name.
[-status {created|ready-to-run|running|completed|failed|pause_req|paused|pausederror|cancel_req|canceled|resume_req|default_status}] - Status Of Task
Displays information only for items with the specified status.
[-message <text>] - Update Log Message
Displays information only for items with the specified message.
[-msg-type <text>] - Type of Message
Displays information only for items with the specified message type.
[-src-info <text>] - Source Information
Displays information only for items for the specified source.
Examples
The following example displays detailed information automated nondisruptive updates:
cluster1::*> cluster image show-update-log-detail
Time
Node
TID Stamp
Dest
Task
Task
Task
Node
Phase
Name
Status Message
------ --- -------- -------- ------ ------ ------ --------------------------
95
node1
node1
node1
15
15
16
3/19/
MUM
2014
update lize
13:52:38
3/19/
MUM
update lize
13:52:38
3/19/
node1
3/19/
s
node1
2014
17
3/19/
3/19/
runnin Updated Task Status
ad-job
ontap- do-
ready- Created Task
update downlo to-run
13:52:38
17
ad-job
ontap- dos
node2
2014
node2
ready- Created Task
update downlo g
13:52:39
node1
ontap- do-
update downlo to-run
13:52:38
16
to-run
ontap- initia runnin Updated Task Status
2014
2014
node1
ontap- initia ready- Created Task
s
node2
ad-job
ontap- do-
runnin Updated Task Status
2014
update downlo g
13:52:38
ad-job
96
cluster image show-update-log

Display the update transaction log
level.
Description
The cluster image show-update-log command displays detailed information
about the currently running, or previously run nondisruptive updates. By default, the
command displays the following information:
Phase
Transaction
Transaction ID
Component ID
Time stamp
Status
Parameters
specify.
| [-instance ] }
about all fields.
[-trans-id <integer>] - Transaction ID
Displays information for the step associated with the specified transaction ID.
[-timestamp <MM/DD/YYYY HH:MM:SS>] - Timestamp
Displays information for steps associated with the specified timestamp.
[-phase <text>] - Transaction phase
Displays information for steps associated with the specified update phase.
97
[-trans-name <text>] - Transaction Name

Displays information for steps associated with the specified transaction.
[-component-id <text>] - Component Id
Displays information for steps associated with the specified component.
[-status {waiting|started|completed|paused-on-error|paused-by-user|pause-pending|
cancel-pending|canceled|failed}] - Status
Displays information for steps matching the specified status.
[-detailed-status <text>] - Detailed Status
Displays information for steps with the specified detailed status.
Examples
The following example displays information about automated nondisruptive update
events:
cluster1::> cluster image show-update-log
Trans
Phase
Transaction
Id
Component Id
Time Stamp
Status
------------- -----------
----- -----------------
----------- ---------------
validation
50
2/18/2014
initialize
MUM
completed
10:32:57
validation
mount-image
51
node1
2/18/2014
completed
10:32:52
validation
mount-image
52
node2
2/18/2014
completed
10:32:53
validation
get-health
53
MUM
2/18/2014
completed
10:32:53
validation
run-scripts
54
node1
2/18/2014
completed
10:32:53
validation
run-scripts
55
node2
2/18/2014
completed
10:32:57
validation
98
unmount-
56
node1
2/18/2014
completed
image
validation
unmount-
10:32:57
57
node2
image
validation
complete-
cleanup-
management
package
package-
cleanup-
management
package
package-
process-
management
package
package-
synch-image
completed
10:32:57
58
MUM
validation
package-
2/18/2014
2/18/2014
completed
10:32:57
66
node1
3/14/2014
completed
09:11:51
67
node2
3/14/2014
completed
09:11:51
68
node1
3/14/2014
completed
09:13:41
69
node2
management
3/14/2014
completed
09:14:25
99
cluster image show-update-progress

Display the update progress
level.
Description
The cluster image show-update-progress command displays information
about the current state of an update. By default, the command displays the following
information:
Update phase
Status
Duration
Comments
Parameters
specify.
| [-instance ] }
about all fields.
[-ndu-phase {validation|prereq-updates|ontap-updates|package-management|defaultphase}] - Update Phase
Displays information about the specified update phase.
[-phase-status {in-progress|waiting|paused-by-user|paused-on-error|completed|
canceled|failed|pause-pending|cancel-pending}] - Phase Status
Displays information about progress matching the specified phase status.
[-phase-duration <text>] - Phase Duration
Displays information about progress matching the specified phase duration.
100
[-phase-comments <text>] - Phase Comments

Displays information about progress matching the specified phase comments.
Examples
The following example displays progress information about the currently running
automated nondisruptive update:
cluster1::> cluster image show-update-progress
Update Phase
Status
Duration
Comments
------------
------------
------------
-------------------------------------
validation
completed
0 min, 6 sec
2 of 2 validated.
ontap-
in-progress
Est: 77 min
0 of 2 updated.
updates
Total estimated duration: 87 minutes, 0 seconds

Current elapsed time: 0 minutes, 38 seconds
101
cluster image show

Display currently running image information
level.
Description
The cluster image show command displays information about the version of Data
ONTAP that is running on each node and the date/time when it was installed. By default,
the command displays the following information:
Node name
Current version
Installation date and time
Parameters
specify.
| [-instance ] }
about all fields.
Displays information about the specified node.
[-version <text>] - Current Version
Displays information about the nodes running the specified version.
[-date <MM/DD/YYYY HH:MM:SS>] - Date Installed
Displays information about the nodes with the specified installation date.
Examples
102
The following example displays information about currently running images on all nodes
of the cluster:
cluster1::> cluster image show
Current
Installation
Node
Version
Date
----------------
-----------------------
------------
node1
8.3
node2
8.3
103
cluster image update

Manage an update
level.
Description
The cluster image update command is used to initiate a Data ONTAP update. The
update is preceded by a validation of the cluster to ensure that any issues that might
affect the update are identified. There are two types of updates of a cluster. A rolling
update updates Data ONTAP one HA pair at a time. This type of update is performed for
clusters with fewer than eight nodes or when the -force-rolling option is specified
for clusters with eight or more nodes. A batch update is used for clusters of eight or
more nodes, and performs updates of multiple HA pairs at the same time.
There are predefined points in the update when the update can be paused (either by
the user or by an error). These pause points occur after validation, after download to the
boot device, after takeover has completed, and after giveback has completed.
Parameters
-version <text> - Update Version
Specifies the Data ONTAP version to use to update the cluster.
[-nodes {<nodename>|local}, ...] - Node
Specifies the nodes that are to be updated.
[-estimate-only [true]] - Estimate Only
Creates a report of the steps that occur during the update without actually doing them.
[-pause-after {none|all}] - Update Pause
Specifies that the update should pause at each predefined pause points (for example,
after validation, after download to the boot device, after takeover, and after giveback)
during the update.
[-ignore-validation-warning {true|false}] - Ignore Validation
Specifies that the update should proceed even if the validation reports warnings.
[-skip-confirmation {true|false}] - Skip Confirmation
104
Specifies that a validation that does not detect any error issues should not ask the user
to confirm the update but simply proceed with the update.
[-force-rolling [true]] - Force Rolling Update
This option is used for clusters with eight or more nodes to specify that a rolling update
(one HA pair at a time) should be done.
[-stabilize-minutes <integer>] - Minutes to stabilize
Specifies the number of minutes that the update should wait after a takeover or
giveback is completed. This allows time for the clients to recover from the pause in I/O
that occurs during takeover and giveback.
Examples
The following example shows the update operation:
cluster1::> cluster image update -version 8.3
It can take several minutes to complete validation...
Pre-update Check
Status
Error-Action
---------------------
---------
-------------------------------------------
Aggregate status
OK
CIFS status
OK
Cluster health
OK
status
Disk status
OK
High Availability
OK
status
LIF status
OK
LIFs on home node
OK
MetroCluster
OK
configuration status
SnapMirror status
OK
Volume status
OK
mgmt epoch status
OK
mgmt RDB ring status
OK
vifmgr epoch status
OK
vifmgr RDB ring
OK
status
vldb epoch status
OK
vldb RDB ring status
OK
105
Overall Status
OK
Would you like to proceed with update ? {y|n}: y

Starting update...
106
cluster image validate

Validates the cluster's update eligibility
level.
Description
The cluster image validate command checks for issues within the cluster that
might lead to problems during the update.
Parameters
specify.
| [-instance ] }
about all fields.
[-version <text>] - Update Version
Specifies the Data ONTAP version to use to validate the cluster.
Examples
The following example shows the validate operation:
cluster1::> cluster image validate -version 8.3
It can take several minutes to complete validation...
Pre-update Check
Status
Error-Action
---------------------
---------
-------------------------------------------
Aggregate status
OK
CIFS status
OK
Cluster health
OK
status
Disk status
OK
High Availability
OK
107
status
LIF status
OK
LIFs on home node
OK
MetroCluster
OK
configuration status
SnapMirror status
OK
Volume status
OK
mgmt epoch status
OK
mgmt RDB ring status
OK
vifmgr epoch status
OK
vifmgr RDB ring
OK
status
vldb epoch status
OK
vldb RDB ring status
OK
Overall Status
OK
108
cluster image package delete

Remove a package from the cluster image package repository
level.
Description
The cluster image package delete command deletes the specified version
of the package from the package repository. The associated information about the
package is also deleted from the update database.
Parameters
-version <text> - Version To Be Deleted
Specifies the package version that is to be deleted.
Examples
The following example deletes the package with version 8.3:
cluster1::> cluster image package delete -version 8.3
Package Delete Operation Completed Successfully
cluster image package get

Fetch a package file from a URL into the cluster image package repository
level.
Description
The cluster image package get command fetches a Data ONTAP package file
specified by the URL into the cluster. The package is stored in the cluster package
respository and the information from the package is stored in the update database.
109
Parameters
-url <text> - Package URL
Specifies the URL from which to get the package.
Examples
The following example displays how to get a package from a URL:
cluster1::> cluster image package get -url http://example.com/image.tgz
cluster image package show-repository

Display information about packages available in the cluster image package repository
level.
Description
The cluster image package show-repository command displays the package
versions that are in the cluster package repository. By default, the command displays
the following information:
Package version
Parameters
specify.
| [-detail ]
This parameter specifies that detailed information should be displayed.
| [-instance ] }
about all fields.
[-download-ver <text>] - Downloaded Version
110
Displays packages with the specified download version.

[-component-name <text>, ...] - Component Name
Displays packages for the specified component.
[-component-version <text>, ...] - Component Version
Displays packages with the specified component version.
Examples
The following example displays the packages in the cluster package repository:
cluster1::> cluster image package show-repository
Package Version
--------------8.3
cluster image package show

Display currently installed image information
level.
Description
The cluster image package show command displays the version of the package
that is currently running in the cluster.
Parameters
None
Examples
The following example displays information about currently running image:
cluster1::> cluster image package show
Package Version
---------------8.3
111
cluster kernel-service show

Display cluster service state in the kernel
privilege level.
Description
The cluster kernel-service show command displays the following information
from the master node for each node in the cluster:
Node name
The quorum status of that node
The connectivity status of that node
The operational status of that node
Parameters
specify.
| [-instance ] }
about all fields.
[-master-node {<nodename>|local}] - Node
The node in the cluster where the information be being reported from. If this parameter
is not specified, the command displays information about all nodes in the cluster.
[-cluster-node <text>] - Cluster Node
The node in the cluster that the information listed is regarding. If this parameter is
specified, the command displays information only about the nodes with the specified
state value.
[-status-quorum {out of quorum|in quorum}] - Quorum Status
112
The quorum status of the node specified by -cluster-node. If this parameter is

state value.
[-status-avail {true|false}] - Availability Status
The availability status of the node specified by -cluster-node. If this parameter is
state value.
[-status-oper {unknown|operational|not-operational}] - Operational Status
The operational status of the node specified by -cluster-node. If this parameter is
state value.
Examples
cluster1::*> cluster kernel-service show
Master
Cluster
Quorum
Availability
Operational
Node
Node
Status
Status
Status
----------------- ----------------- ------------- ------------- ------------cluster1-01
cluster1-01
in-quorum
true
operational
cluster1-02
in-quorum
true
operational

cluster1::*> cluster kernel-service show -instance
Master Node: cluster1-01
Cluster Node: cluster1-01
Quorum Status: in-quorum
Availability Status: true
Operational Status: operational
Master Node: cluster1-01
Cluster Node: cluster1-02
Quorum Status: in-quorum
Availability Status: true
Operational Status: operational
113
cluster peer create

Create a new cluster peer relationship
level.
Description
The cluster peer create command establishes a peer relationship between two
clusters. Cluster peering enables independent clusters to coordinate and exchange
data.
Before creating a new cluster peer relationship, make sure that both clusters are
individually healthy and that there are no other peer relationships between the two
clusters that might interfere with the new relationship.
You can create a cluster peer relationship using the IPv4 or IPv6 protocol. All
subsequently created relationships must belong to the same address-family as that of
the relationship created first.
Use the cluster show and cluster peer show commands on each cluster to
display health, peering eligibility, and peering information about the two clusters.
Parameters
-peer-addrs <Remote InetAddress>, ... - Remote Intercluster Addresses
Use this parameter to specify the names or IP addresses of the logical interfaces used
for intercluster communication. Separate the addresses with commas.
The addresses you provide here are associated with the remote cluster until you modify
or delete the relationship, regardless of whether the addresses are valid. Make sure to
provide addresses which you know will remain available on the remote cluster. You can
use the hostnames of the remote cluster's intercluster addresses, the IP addresses of
the remote cluster's intercluster LIFs or both.
[-username <text>] - Remote User Name
Use this optional parameter to specify a username that runs a reciprocal cluster
peer create command on the peered cluster. If you choose not to use the reciprocal
creation option, by not supplying a username for reciprocal creation, you must run
cluster peer create again on the remote cluster to complete the peering
relationship.
114
If you specify the username for the remote cluster, you will be prompted to enter the
associated remote password. These credentials are not stored, they are used only
during creation to authenticate with the remote cluster and to enable the remote cluster
to authorize the peering request. The provided username's profile must have access to
the console application in the remote cluster.
Use the security login role show and security login show commands on
each cluster to find user names and their privilege levels.
[-no-authentication [true]] - Do Not Use Authentication
Use this optional parameter when omitting the -username parameter to indicate that
you will create an unauthenticated peering relationship.
[-timeout <integer>] - Operation Timeout (seconds) (privilege: advanced)
Use this optional parameter to specify a timeout value for peer communications. Specify
the value in seconds. The default timeout value is 60 seconds.
[-address-family {ipv4|ipv6}] - Address Family of Relationship
Use this optional parameter to specify the address family of the cluster peer relationship.
The default is based on existing relationships, existing local intercluster LIFs belonging
to a particular address-family, and the addresses supplied to the cluster peer
create command.
[-offer-expiration <MM/DD/YYYY HH:MM:SS>] - Passphrase Match Deadline
Specifying cluster peer create normally creates an offer to establish
authentication with a cluster that is a potential cluster peer to this cluster. Such offers
expire unless they are accepted within some definite time. Use this optional parameter
to specify the date and time at which this offer should expire, the time after which the
offer will no longer be accepted.
[-rpc-connect-timeout <integer>] - Timeout for RPC Connect (seconds) (privilege:
advanced)
Use this optional parameter to specify a timeout value for the RPC connect during peer
communications. Specify the value in seconds. The default timeout value is 10 seconds.
[-update-ping-timeout <integer>] - Timeout for Update Pings (seconds) (privilege:
advanced)
Use this optional parameter to specify a timeout value for pings while updating remote
cluster information. Specify the value in seconds. The default timeout value is 5
seconds. This parameter applies only to cluster peer relationships using the IPv4
protocol.
115
Examples
This example creates a peer relationship between cluster1 and cluster2. This reciprocal
create executes the create command on both the local cluster and the remote cluster.
The cluster peer create command can use the hostnames of cluster2's intercluster
addresses, the IP addresses of cluster2's intercluster LIFs or both. Note that the admin
user's password was typed at the prompt, but was not displayed.
cluster1::> cluster peer create -peer-addrs cluster2-d2,10.98.234.246 -username
admin
Remote Password:
cluster1::> cluster peer show -instance
Peer Cluster Name: cluster2
Remote Intercluster Addresses: cluster2-d2, 10.98.234.246
Availability of the Remote Cluster: Available
Remote Cluster Name: cluster2
Active IP Addresses: 10.98.234.246, 10.98.234.243
Address Family of Relationship: ipv4
Authentication Status Administrative: no-authentication
Authentication Status Operational: absent
Last Update Time: 02/05 21:05:41
This example shows coordinated peer creation. The cluster peer create
command was issued locally on each cluster. This does not require you to provide the
username and password for the remote cluster. There is a password prompt, but if you
are logged in as the admin user, you may simply press enter.
cluster1::> cluster peer create -peer-addrs cluster2-d2, 10.98.234.246 -noauthentication
Remote Password:
NOTICE: Addition of the local cluster information to the remote cluster has
failed with the following error: not authorized for that command. You may
need to repeat this command on the remote cluster.
cluster1::> cluster peer show
Peer Cluster Name
Cluster Serial Number Availability
Authentication
------------------------- --------------------- -------------- --------------
116
cluster2
1-80-123456
Available
absent
cluster2::> cluster peer create -peer-addrs cluster1-d2 -no-authentication

Remote Password:
NOTICE: Addition of the local cluster information to the remote cluster has
failed with the following error: not authorized for that command. You may
need to repeat this command on the remote cluster.
Peer Cluster Name
Authentication
------------------------- --------------------- -------------- -------------cluster1
1-80-654321
Available
absent
This example shows a reciprocal cluster peer create over IPv6 addresses, that
establishes a cluster peer relationship with an IPv6 address family.
cluster1::> cluster peer create -peer-addrs
FD20:8B1E:B255:C222:6A17:0BBD:E92C:4523 -username admin
Remote Password:
Remote Intercluster Addresses: FD20:8B1E:B255:C222:6A17:0BBD:E92C:4523
Active IP Addresses: FD20:8B1E:B255:C222:6A17:0BBD:E92C:4523
Authentication Status Administrative: no-authentication
Authentication Status Operational: absent
This example shows creation of an authenticated peering relationship. It is an example

of using the coordinated method to create a cluster peer relationship. The cluster
peer create command is issued locally on each cluster. Before executing this pair
of commands, a passphrase to be used with the commands is chosen and given at the
prompts. The passphrase can be any text; it is prompted for twice on each cluster, and
117
all four copies of the passphrase must agree. The passphrase does not echo on the
screen. The passphrase must be longer than the minimum length as specified by the
cluster peer policy on both clusters.
cluster1::> cluster peer create -peer-addrs cluster2-d2, 10.98.234.246
Enter the passphrase:
Enter the passphrase again:
Notice: Now use the same passphrase in the "cluster peer create" command in the
other cluster.
Peer Cluster Name
Authentication
------------------------- --------------------- -------------- -------------cluster2
Unavailable
pending
cluster2::> cluster peer create -peer-addrs cluster1-d2

Enter the passphrase:
Enter the passphrase again:
Peer Cluster Name
Authentication
------------------------- --------------------- -------------- -------------cluster1
1-80-654321
Available
ok
See Also
security login role show security login show cluster show cluster peer show
cluster peer policy
118
cluster peer delete

Delete a cluster peer relationship
level.
Description
The cluster peer delete command removes a peering relationship. It removes the
relationship records, state data, and all associated jobs.
Before removing the relationship, the command verifies that no resources depend
on the relationship. For example, if any SnapMirror relationships exist, the
command denies the request to delete the peering relationship. You must remove all
dependencies for the deletion to succeed. The cluster peer delete command
removes only the local instance of the peer relationship. An administrator in the peer
cluster must use the cluster peer delete command there as well to completely
remove the relationship.
Parameters
-cluster <text> - Peer Cluster Name
Use this parameter to specify the peering relationship to delete by specifying the name
of the peered cluster.
Examples
This example shows a failed deletion due to a SnapMirror dependency.
cluster2::> cluster peer delete -cluster cluster1
Error: command failed: Unable to delete peer relationship.
Reason: A
SnapMirror source exists in this cluster
119
cluster peer modify

Modify cluster peer relationships
level.
Description
The cluster peer modify command modifies the attributes of a peering
relationship. When you modify a peer relationship and specify -peer-addrs, all of the
remote addresses must respond, must be intercluster addresses, and must belong to
the remote cluster that is being modified; or the modification request is denied.
Parameters
Use this parameter to specify the peering relationship to modify by specifying the name
of the peered cluster.
[-peer-addrs <Remote InetAddress>, ...] - Remote Intercluster Addresses
Use this parameter to specify the names or IP addresses of the logical interfaces
used for intercluster communication. Separate the addresses with commas. The list of
addresses you provide replaces the existing list of addresses.
Use this parameter to specify a timeout value for peer communications. Specify the
value in seconds.
[-auth-status-admin <cluster_peer_authnstate>] - Authentication Status Administrative
Use this parameter to adjust the authentication in use for the peer relationship. The
defined values for this field are as follows.
no-authentication - The cluster peer relationship uses no authentication.
use-authentication - The cluster peer relationship is to be authenticated. After you
use this value, you will be prompted for a passphrase to be used in determining
a new authentication key, just as in the authenticated cluster peer create
command.
revoked - The cluster peer relationship is no longer to be trusted. Peering
communication with this cluster peer is suspended until the two clusters set
120
their auth-status-admin attributes either both to no-authentication or both to useauthentication.

Changes should be reflected on both clusters involved in a peering relationship.
[-rpc-connect-timeout <integer>] - Timeout for RPC Connect (privilege: advanced)
Use this optional parameter to specify a timeout value for the RPC connect during peer
communications. Specify the value in seconds.
[-update-ping-timeout <integer>] - Timeout for Update Pings (privilege: advanced)
Use this optional parameter to specify a timeout value for pings while updating remote
cluster information. Specify the value in seconds. This parameter applies only to cluster
peer relationships using the IPv4 protocol.
Examples
This example modifies the peering relationship to use a new IP address in the remote
cluster for intercluster communications and revoke authentication.
View existing cluster peer configuration using following command :
Remote Cluster Nodes: cluster2-01, cluster2-02
Remote Cluster Health: true
Unreachable Local Nodes: Address Family of Relationship: ipv4
Authentication Status Administrative: use-authentication
Authentication Status Operational: ok
Modify the cluster peer configuration using following command :

cluster1::> cluster peer modify -cluster cluster2 -peer-addrs cluster2d2,10.98.234.264 -auth-status-admin revoked
Warning: This will discard the authentication key.
121
Warning: You are removing authentication from the peering relationship with
cluster "cluster2". Use the "cluster peer modify" command on
cluster "cluster2" with the "-auth-status-admin
no-authentication" parameter to complete authentication removal from
the peering relationship.
Do you want to continue?{y|n}:y
See Also
cluster peer create
122
cluster peer ping

Initiate intercluster connectivity test
level.
Description
The cluster peer ping command displays the status of the network mesh used
by the peering relationship. The command checks the network connection to each
remote IP address known by the cluster. This includes all intercluster addresses. It is
possible for a known address to be not present during the ping. These addresses are
not checked, but the absence is temporary.
The most useful parameters for diagnosing problems are -count and -packet-size.
Use the -count and -packet-size parameters to diagnose problems similarly to how
you use them with the standard ping utility.
To display network connection status within a cluster, use the network ping
command.
Parameters
specify.
| [-instance ] }
about all fields.
[-originating-node {<nodename>|local}] - Node that Initiates Ping
[-destination-cluster <Cluster name>] - Cluster to Ping
Use this parameter to specify the peer cluster you wish to ping.
[-destination-node <Peer Node Name>] - Node to Ping in Destination Cluster
Use this parameter to specify a specific node in the destination cluster to ping.
123
[-ip-address <IP Address>] - Active IP Address

Use this parameter to specify the active IP address you wish to ping.
[-count <integer>] - Ping Count
Use this parameter to specify the number of requests to be sent to the destination.
[-status {unknown_node|internal_error|unreachable|session_reachable|
interface_reachable}] - Status of Ping Operation
Use this parameter to display only ping results that have the status you specify.
[-timeout <integer>] - Ping Timeout in Seconds
Use this parameter to specify a timeout value in seconds for the ping operation.
[-packet-size <integer>] - Size of Packet
Use this parameter to specify the number of data bytes to be sent in the ping packet.
[-ttl <integer>] - Time to Live/ Number of Hops
Use this parameter to specify the maximum number of network hops a packet may
make before it is considered a failure.
[-response-time <double>] - Response Time (ms)
Use this parameter to display only nodes that have the response time (in milliseconds)
that you specify. This parameter is most useful when specified with a range of values,
such as >500
Examples
This example shows a ping of cluster1 and cluster2 from cluster2. All nodes are
reachable.
cluster2::> cluster peer ping
Node: node1
Destination Cluster: cluster2
Destination Node IP Address
Count
TTL RTT(ms) Status
---------------- ---------------- ----- ---- ------- ------------------------node1
10.98.228.230
255
0.209 interface_reachable
node2
10.98.228.234
255
Node: node2
Count
TTL RTT(ms) Status
---------------- ---------------- ----- ---- ------- ------------------------node1
10.98.228.230
255
node2
10.98.228.234
255
Node: node1
124
Count
TTL RTT(ms) Status
---------------- ---------------- ----- ---- ------- ------------------------node3
10.98.229.22
255
node4
10.98.229.29
255
Node: node2
Count
TTL RTT(ms) Status
---------------- ---------------- ----- ---- ------- ------------------------node3
10.98.229.22
255
node4
10.98.229.29
255
See Also
network ping
125
cluster peer show

Display peer cluster information
level.
Description
The cluster peer show command displays information about the peering
relationships between the current cluster and other clusters. Cluster peering enables
independent clusters to coordinate and exchange data.
Parameters
specify.
| [-instance ] }
about all fields.
[-cluster <text>] - Peer Cluster Name
Selects the peered clusters that match this parameter value.
[-cluster-uuid <UUID>] - Cluster UUID (privilege: advanced)
[-peer-addrs <Remote InetAddress>, ...] - Remote Intercluster Addresses
Selects the peered clusters that match this parameter value (remote-host name or IP
address).
[-availability <availability>] - Availability of the Remote Cluster
Selects the peered clusters that match this parameter value. This parameter can have
four different values:
Available - The peer cluster availability status will be Available only if all the nodes
in the local cluster are able to contact all the nodes in the remote cluster.
126
Partial - The peer cluster availability status will be Partial only if some nodes in the
local cluster are not able to contact some or all nodes in the peer cluster.
Unavailable - The peer cluster availability status will be Unavailable only if all the
nodes in the local cluster are not able to contact any node in the peer cluster.
Pending - The peer cluster availability status will be Pending while the system is
creating in-memory health data.
Note: If one or more nodes in the local cluster are offline or unreachable, then those
nodes are not used to determine the availability status for the remote nodes.
[-rcluster <text>] - Remote Cluster Name
[-ip-addrs <Remote InetAddress>, ...] - Active IP Addresses
[-serialnumber <Cluster Serial Number>] - Cluster Serial Number
[-remote-cluster-nodes <text>, ...] - Remote Cluster Nodes
[-remote-cluster-health {true|false}] - Remote Cluster Health
true - This means that there is cluster quorum in the peer cluster.
false - This means that there is no cluster quorum in the peer cluster.
[-unreachable-local-nodes <text>, ...] - Unreachable Local Nodes
[-address-family {ipv4|ipv6}] - Address Family of Relationship
Selects the peered clusters that have a relationship established using this protocol.
Selects the peered clusters that match this parameter value, which must be chosen from
the following values.
127
no-authentication - The cluster peer relationship uses no authentication.

use-authentication - The cluster peer relationship is authenticated.
revoked - The cluster peer relationship is revoked until agreement can be
reached.
[-auth-status-operational <cluster_peer_authnshow>] - Authentication Status
Operational
Selects the peered clusters that match this parameter value, which must be one of the
following values.
ok - The clusters both use authentication and they have agreed on an
authentication key.
absent - The clusters agree not to use authentication.
pending - This cluster has made an outstanding offer to authenticate with the
other cluster, but agreement has not yet been reached.
expired - This cluster's offer to authenticate with the other cluster expired before
agreement was reached.
revoked - This cluster has revoked any prior authentication agreement.
declined - The other cluster has revoked the authentication agreement and is
declining to communicate with this cluster.
refused - The other cluster actively refuses the communication attempts, perhaps
because its part of the peering relationship has been deleted.
ok-and-offer - The clusters agree on an authentication key and are using it. In
addition, this cluster has made an outstanding offer to re-authenticate with the
other cluster.
absent-but-offer - The clusters currently agree that neither side requires
authentication of the other, but this cluster has made an outstanding offer to
authenticate.
revoked-but-offer - This cluster has revoked any authentication agreement, but it
has made an outstanding offer to authenticate.
intent-mismatch - The two clusters disagree on whether authentication is required.
key-mismatch - The two clusters both believe that they are authenticated, but one
of the shared secrets has become corrupted.
incapable - The other cluster is no longer running a version of Data ONTAP that
supports authenticated cluster peering.
128
[-rpc-connect-timeout <integer>] - Timeout for RPC Connect (privilege: advanced)

[-update-ping-timeout <integer>] - Timeout for Update Pings (privilege: advanced)
[-last-updated <MM/DD/YYYY HH:MM:SS>] - Last Update Time
Examples
This example shows the output of the cluster peer show command when all nodes in
the local cluster are able to contact all nodes in the remote peer cluster. Additionally, the
peer relationship is authenticated and operating correctly.
Peer Cluster Name
Authentication
------------------------- --------------------- -------------- -------------cluster2
1-80-123456
Available
ok
Detailed information for this scenario is shown below.

129
This example shows the output of the cluster peer show command when some nodes
in the local cluster are not able to contact some or all of the nodes in the remote peer
cluster.
Peer Cluster Name
Authentication
------------------------- --------------------- -------------- -------------cluster2
1-80-123456
Available
ok

Availability of the Remote Cluster: Partial
Remote Cluster Health: false
in the local cluster cannot be contacted from the node where the command is executed,
but all the other nodes including node on which command is executed are able to
contact all nodes in the remote peer cluster.
Peer Cluster Name
Authentication
------------------------- --------------------- -------------- -------------cluster2
1-80-123456
Available
ok

130

Unreachable Local Nodes: cluster1-01
in the local cluster cannot be contacted from the node where the command is executed,
and the node on which command is executed is also not able to contact the remote peer
cluster.
Peer Cluster Name
Authentication
------------------------- --------------------- -------------- -------------cluster2
1-80-123456
Unavailable
ok

Availability of the Remote Cluster: Unavailable
Remote Cluster Health: Unreachable Local Nodes: cluster1-01
131
This example shows the output of the cluster peer show command when all the nodes in
the local cluster are not able to contact any nodes in the remote peer cluster.
Peer Cluster Name
Authentication
------------------------- --------------------- -------------- -------------cluster2
1-80-123456
Unavailable
ok

Availability of the Remote Cluster: Unavailable
Remote Cluster Health: Unreachable Local Nodes: Address Family of Relationship: ipv4
This example shows the output of the cluster peer show command while the system is
creating in-memory health data.
Peer Cluster Name
Authentication
------------------------- --------------------- -------------- -------------cluster2
1-80-123456
Pending
ok

Availability of the Remote Cluster: Pending
132

Remote Cluster Nodes: Remote Cluster Health: Unreachable Local Nodes: Address Family of Relationship: ipv4
133
cluster peer connection show

Show current peering connections for a cluster
level.
Description
The cluster peer connection show command displays information about the
current TCP connections and how they are supporting the set of peering relationships.
Parameters
specify.
| [-instance ] }
about all fields.
[-cluster-name <text>] - Remote Cluster
Selects the connections associated with the named peered cluster.
Selects the connections hosted by the given node.
[-connection-type <cluster_peer_conntype>] - Cluster Peering Connection Type
Selects the connections of the named type. This parameter can have one of three
different values:
Dsmdb-client - DSMDB client connections, created so that this node may make
dsmdb requests of other nodes.
Dsmdb-server - DSMDB server connections, over which this node services
requests made by other nodes' dsmdb-client connections.
Spinnp - Connections made by CSM as part of a CSM/SpinNP session
[-fd <integer>] - File Descriptor
134
Selects the connections with the given file descriptor value.

[-cluster-uuid <UUID>] - Cluster UUID
Selects the connections to the cluster with the given cluster UUID.
Selects connections to the peered clusters whose intended authentication matches this
parameter value.
Operational
Selects connections to the peered clusters whose authentication state matches this
parameter value.
[-authenticated {true|false}] - Authenticated
Selects connections that have been authenticated, or not, according to this parameter
value.
[-port <integer>] - Network Port
Selects the connections that match this parameter value.
[-idle <[<integer>h][<integer>m][<integer>s]>] - Idle Time
Selects the connections whose idle times match this parameter value.
[-address <IP Address>] - Remote Network Address
Selects the connections that have this parameter value as the remote network address.
Examples
This example shows the output of the cluster peer connection show command.
cluster1::> cluster peer connection show
Cluster Node
------- -------------------cfe-cluster3
Connection Type
Auth
Idle
---------------
----- ----
Remote Address
---------------
Authentication: ok
everhart-vsim1
-
dsmf-client
true
56s
10.98.232.114
e04e199543d980f
spinnp
true
22s
10.98.233.53
e04e199432a993a
spinnp
true
42s
10.98.232.114
e04e199432a993a
spinnp
true
56s
10.98.232.114
e04e199432a993a
spinnp
true
40s
10.98.232.114
e04e199432a993a
spinnp
true
40s
10.98.232.114
e04e199543d980f
spinnp
true
22s
10.98.233.53
135
e04e199432a993a
spinnp
true
40s
10.98.232.114
e04e199432a993a
spinnp
true
40s
10.98.232.114
e04e199543d980f
spinnp
true
56s
10.98.233.53
e04e199543d980f
spinnp
true
11s
10.98.233.53
e04e199543d980f
spinnp
true
22s
10.98.233.53
e04e199543d980f
spinnp
true
22s
10.98.233.53
cfe-cluster3
Authentication: ok
everhart-vsim2
136
e04e1a0c42f7104
spinnp
true
35s
10.98.232.114
e04e1a0c42f7104
spinnp
true
35s
10.98.232.114
e04e1a0c42f7104
spinnp
true
35s
10.98.232.114
e04e1a0c42f7104
spinnp
true
35s
10.98.232.114
e04e1a0c42f7104
spinnp
true
42s
10.98.232.114
e04e1a0c42f7104
spinnp
true
55s
10.98.232.114
e04e1a0c561627a
spinnp
true
14s
10.98.233.53
e04e1a0c561627a
spinnp
true
14s
10.98.233.53
e04e1a0c561627a
spinnp
true
14s
10.98.233.53
e04e1a0c561627a
spinnp
true
11s
10.98.233.53
e04e1a0c561627a
spinnp
true
55s
10.98.233.53
e04e1a0c561627a
spinnp
true
14s
10.98.233.53
cluster peer health show

Check peer cluster health
level.
Description
The cluster peer health show command displays information about the health
of the nodes in peer clusters from the perspective of the nodes in the local cluster. The
command obtains health information by performing connectivity and status probes of
each peer cluster's nodes from each node in the local cluster.
To enable quick access to remote cluster health information, remote cluster health
status is periodically checked and cached. These cached results enable users and
system features to quickly assess the availability of remote resources. By default, this
command accesses cached results. Use the -bypass-cache true option to force a
current, non-cached check of remote cluster health.
Parameters
specify.
| [-instance ] }
about all fields.
[-originating-node {<nodename>|local}] - Local Node
Selects the node that matches this parameter value.
[-destination-cluster <Cluster name>] - Peer Cluster
Selects the cluster that matches this parameter value.
[-destination-node <Peer Node Name>] - Peer Node
Selects the node that matches this parameter value.
[-destination-cluster-uuid <UUID>] - Peer UUID
137
Selects the cluster that matches this parameter value.

[-data-ping {unknown_node|internal_error|unreachable|session_reachable|
interface_reachable}] - Status of Data Ping Operation
[-icmp-ping {unknown_node|internal_error|unreachable|session_reachable|
interface_reachable}] - Status of ICMP Ping Operation
[-node-health {true|false}] - RDB Health of the Node
Selects the nodes that match this parameter value (true means healthy).
[-cluster-health {true|false}] - Cluster Health
Selects the nodes that match this parameter value (true means healthy).
[-availability {true|false}] - Communication Indicator
Selects the nodes that match this parameter value (true means communicating).
[-bypass-cache {true|false}] - Bypass Cache and Determine Health
Bypasses cached results to determine current cluster health (true means bypass the
cache). Cached results may not be current, but they are displayed more quickly.
[-last-updated <MM/DD/YYYY HH:MM:SS>] - Last Update Time
Examples
The following example shows typical output for this command in a cluster of two nodes
that has a peer cluster of two nodes.
cluster1::> cluster peer health show
Node
Cluster-Name
Node-Name
Ping-Status
RDB-Health Cluster-Health Availability
---------- --------------------------- --------- --------------- -----------node1

cluster2
node3
Data: interface_reachable
ICMP: interface_reachable true
true
true
true
true
node4
node2
138
cluster2
node3
true
true
true
true
node4
The following example shows detailed health information for node3 in cluster2 from the
perspective of node1 in cluster1.
cluster1::> cluster peer health show -originating-node node1 -destination-cluster
cluster2 -destination-node node3 -instance
Local Node: node1
Peer Cluster: cluster2
Peer Node: node3
Peer UUID: 5e4befb2-1f36-11d0-98c9-123476563412
Status of Data Ping Operation: interface_reachable
Status of ICMP Ping Operation: interface_reachable
RDB health of the node: true
Cluster Health: true
Communication Indicator: true
139
cluster peer offer cancel

Cancel the outstanding offer to authenticate with a peer cluster
level.
Description
The cluster peer offer cancel command cancels an outstanding offer to
authenticate with a potentially peered cluster. After the command completes, the given
cluster can no longer establish authentication using the given authentication offer.
Parameters
Use this parameter to specify which offer should be cancelled, by specifying the name of
the cluster to which the offer is extended.
Examples
The following example cancels the authentication offer to cluster2.
cluster1::> cluster peer offer cancel -cluster cluster2
cluster peer offer modify

Modify an outstanding offer to authenticate with a peer cluster
level.
Description
The cluster peer offer modify command modifies the outstanding offer
to authenticate with a potentially peered cluster. Every authentication offer has an
expiration time, after which the offer will no longer be honored. This command is used
to change that expiration time. To cancel the offer outright, use the cluster peer
offer cancel command instead.
140
Parameters
Use this parameter to specify the offer to be modified by indicating the name of the
cluster to which it has been extended.
[-offer-expiration <MM/DD/YYYY HH:MM:SS>] - Authentication Offer Expiration Time
Use this parameter to specify the new expiration time for the offer.
Examples
This example modifies the expiration time for the authentication offer to push it out by an
hour.
cluster1::> cluster peer offer show
Peer Cluster Name
Authentication Creation
Expiration
----------------------- -------------- ------------------- ------------------cluster2
absent_but_offer
7/23/2013 14:45:47
7/23/2013 15:45:47
cluster1::> cluster peer offer modify -cluster cluster2 -offer-expiration

"7/23/2013 16:45:47"
Peer Cluster Name
Expiration
----------------------- -------------- ------------------- ------------------cluster2
absent_but_offer
7/23/2013 14:45:47
7/23/2013 16:45:47
See Also
cluster peer offer cancel
141
cluster peer offer show

Display outstanding offers to authenticate with a peer cluster
level.
Description
The cluster peer offer show command displays information about authentication
offers still pending with potential peer clusters. By default, the command displays
information about all unexpired offers made by the local cluster.
To display detailed information about a specific offer, run the command with the cluster parameter.
Parameters
specify.
| [-instance ] }
about all fields.
[-cluster <text>] - Peer Cluster Name
Selects the offer that matches this parameter value.
Operational
Selects the offers that match this parameter value.
[-offer-creation <MM/DD/YYYY HH:MM:SS>] - Authentication Offer Creation Time
[-offer-expiration <MM/DD/YYYY HH:MM:SS>] - Authentication Offer Expiration Time
Examples
142
The following example displays information about the outstanding authentication offers:
Peer Cluster Name
Expiration
----------------------- -------------- ------------------- ------------------cluster2
absent_but_offer 7/11/2013 22:22:52 7/11/2013 23:22:52
143
cluster peer policy modify

Modify the policy configuration for the cluster peering service
level.
Description
The cluster peer policy modify command modifies the prevailing policy
settings. One setting governs whether unauthenticated cluster peer relationships can
exist. The other setting specifies a minimum length for passphrases.
Parameters
[-is-unauthenticated-access-permitted {true|false}] - Is Unauthenticated Cluster Peer
Access Permitted
Use this parameter to specify whether unauthenticated peering relationships are allowed
to exist. Setting the parameter value to true allows such relationships to exist. Setting
the value to false prevents both the creation of unauthenticated peering relationships
as well as the modification of existing peering relationships to be unauthenticated.
Setting the value to false is not possible if the cluster currently is in any unauthenticated
relationships.
[-passphrase-minlength <integer>] - Passphrase Length Minimum
Use this parameter to specify a minimum length for passphrases as given to the
cluster peer create or cluster peer modify commands in the future. The
default value for this parameter is 8.
Examples
This example modifies the peering policy to disallow unauthenticated intercluster
communications.
cluster1::> cluster peer policy show
Is Unauthenticated Cluster Peer Communication Permitted:
Minimum Length for a Passphrase:
true
8
cluster1::> cluster peer policy modify -is-unauthenticated-access-permitted false

144
false
See Also
cluster peer create cluster peer modify
145
cluster peer policy show

Display the policy configuration for the cluster peering service
level.
Description
The cluster peer policy show command displays the prevailing cluster peer
authentication policy. There are two policies at present: one to control whether any
cluster peer relationships can be unauthenticated, and one to control the minimum
length for a passphrase. If the policy is set to preclude unauthenticated peering
relationships, then unauthenticated relationships cannot be created inadvertently.
Passphrases of less than the minimum length may not be used. By default, this
minimum length is set to 8, so passphrases must be 8 characters long or longer.
Parameters
None
Examples
This example shows the cluster peer policy when unauthenticated relationships may not
be created inadvertently.
false
9
cluster quorum-service options modify

Modify the settings for cluster quorum-service
privilege level.
Description
The cluster quorum-service options modify command modifies the values of
cluster quorum services options.
146
Parameters
[-ignore-quorum-warning-confirmations {true|false}] - Whether or Not Warnings Are
Enabled
Specifies whether cluster quorum warnings and confirmations should be ignored when
cluster operations could negatively impact cluster quorum:
Halting a node (system node halt)
Rebooting a node (system node reboot)
Issuing a planned takeover (storage failover takeover)
The default setting is false.
Examples
The following example shows the usage of this command:
cluster1::> set advanced
Do you want to continue? {y|n}: y
cluster1::*> cluster quorum-service options modify -ignore-quorum-warningconfirmations true
See Also
system node halt system node reboot storage failover takeover
147
cluster quorum-service options show

Display the settings for cluster quorum-service
privilege level.
Description
The cluster quorum-service options show command displays the values of
cluster quorum services options.
Parameters
None
Examples
The following example demonstrates showing the state of ignore-quorum-warningconfirmations when it is false and true.
cluster1::*> set advanced
cluster1::*> cluster quorum-service options show
Ignore Quorum Warning Confirmations
----------------------------------false
148
cluster ring show

Display cluster node member's replication rings
privilege level.
Description
The cluster ring show command displays a cluster's ring-replication status.
Support personnel might ask you to run this command to assist with troubleshooting.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the rings that match this parameter value.
[-unitname {mgmt|vldb|vifmgr|bcomd|crs}] - Unit Name
Selects the rings that match this parameter value. Possible values are:
mgmt - The management application
vldb - The volume location database
vifmgr - The virtual-interface manager
bcomd - The SAN management daemon
crs - The configuration replication service
[-online {master|secondary|offline}] - Status
[-epoch <integer>] - Epoch
149

[-master <nodename>] - Master Node
[-local <nodename>] - Local Node
[-db-epoch <integer>] - DB Epoch
[-db-trnxs <integer>] - DB Transaction
[-num-online <integer>] - Number Online
[-rdb-uuid <UUID>] - RDB UUID
Examples
The following example displays information about all replication rings in a two-node
cluster:
cluster1::*> cluster ring show
Node
UnitName Epoch
DB Epoch DB Trnxs Master
Online
--------- -------- -------- -------- -------- --------- --------node0
mgmt
1068
node0
master
node0
vldb
98
node0
master
node0
vifmgr
350
node0
master
node0
bcomd
56
node0
master
node0
crs
88
node0
master
node1
mgmt
1068
node0
secondary
node1
vldb
98
node0
secondary
node1
vifmgr
350
node0
secondary
node1
bcomd
56
node0
secondary
node1
crs
88
node0
secondary
150
cluster statistics show

Display cluster-wide statistics
level.
Description
The cluster statistics show command displays the following information. Each
item lists the current value and; if applicable, the change (delta) from the previous
reported value.
CPU busy percentage
Average of CPU busy percentage (advanced privilege level only)
Total number of NFS and CIFS operations
Number of NFS operations
Number of CIFS operations
Number of cache operations (advanced privilege level only)
Total amount of network data received (advanced privilege level only)
Total amount of network data sent (advanced privilege level only)
Number of packets received (advanced privilege level only)
Number of packets sent (advanced privilege level only)
Busy percentage for the data network
Amount of data received on the data network
Amount of data sent on the data network
Busy percentage for the cluster network
Amount of data received on the cluster network
Amount of data sent on the cluster network
Amount of data read from disk
Amount of data written to disk
At the diagnostic privilege level, the command displays the following information:
151
Average of CPU busy percentage

CPU busy percentage
Total number of operations
Number of NFS operations
Number of CIFS operations
Number of Fcache operations
Number of SpinFS operations
Total amount of network traffic received
Total amount of network traffic sent
Percentage of data-network utilization
Amount of data-network traffic received
Amount of data-network traffic sent
Percentage of cluster-network utilization
Amount of cluster-network traffic received
Amount of cluster-network traffic sent
Amount of data read from disk
Amount of data written to disk
Number of packets received
Number of packets sent
Parameters
None
Examples
The following example displays cluster statistics:
cluster1::> cluster statistics show
Counter
Value
Delta
------------- ------------- ------------CPU Busy:
84%
+27
951471448
7210/s:11s
Operations:
Total:
152
NFS:
12957951479
13759/s:11s
CIFS:
342195460
230/s:11s
Data Network:
Busy:
0%
Received:
1.98TB
3.18MB/s:11s
Sent:
6.20TB
903KB/s:11s
Cluster Network:
Busy:
0%
Received:
6.33TB
1.34MB/s:11s
Sent:
6.24TB
3.54MB/s:11s
Read:
207TB
82.7MB/s:11s
Write:
53.3TB
53.5MB/s:11s
Storage Disk:
153
cluster time-service ntp server create

Add a NTP Server
level.
Description
The cluster time-service ntp server create command associates the
cluster with an external network time server for time correction and adjustment by using
the Network Time Protocol (NTP).
The command resolves the time server host name to an IP address and performs
several validation checks. If an error is detected during validation, it is reported.
The validation checks performed by this command include the following:
The NTP replies to an NTP query with the specified protocol version.
The NTP reply indicates that the external time server is synchronized to another
time server.
The distance and dispersion of the NTP reply from the "root" or source clock are
within the required limits.
Parameters
-server <text> - NTP Server Host Name, IPv4 or IPv6 Address
This specifies the host name or IP address of the external NTP server that is to be
associated with the cluster for time correction and adjustment.
[-version {3|4|auto}] - NTP Version for Server (default: auto)
This optionally specifies the NTP protocol version that should be used for
communicating with the external NTP server. If the external NTP server does not
support the specified protocol version, time exchange cannot take place.
The supported values for this parameter include the following:
3 - Use NTP protocol version 3, which is based on Internet Standard Request For
Comments (RFC) #1305.
4 - Use NTP protocol version 4, which is based on Internet Standard RFC #5905.
auto - Have Data ONTAP select the NTP protocol version.
154

[-is-preferred {true|false}] - Is Preferred NTP Server (default: false) (privilege:
advanced)
This optionally specifies whether the external NTP server is the primary time source for
correcting and adjusting the cluster time. The responses from this source will be used
unless its time is outside the accepted selection range.
You use this parameter when a high quality radio (or GPS) based time server is being
used with a set of non-radio based backup time servers.
Examples
The following example associates the cluster with an NTP server named
ntp1.example.com.
cluster1::> cluster time-service ntp server create -server ntp1.example.com
cluster time-service ntp server delete

Delete a NTP Server
level.
Description
The cluster time-service ntp server delete command removes the
association between the cluster and an external network time server that uses the
Network Time Protocol (NTP).
Parameters
This specifies the host name or IP address of an existing external NTP server that the
cluster will disassociate from.
Examples
The following example disassociates an NTP server named ntp2.example.com from the
cluster:
155
cluster1::> cluster time-service ntp server delete -server ntp2.example.com
cluster time-service ntp server modify

Modify NTP Server Options
level.
Description
The cluster time-service ntp server modify command modifies the
configuration of an existing external network time server that uses the Network Time
Protocol (NTP) for time correction and adjustment.
Parameters
This specifies the host name or IP address of an existing external NTP server that is to
be modified.
This optionally specifies the NTP protocol version that should be used for
communicating with the external NTP server. If the external NTP server does not
support the specified protocol version, time exchange cannot take place.
The supported values for this parameter include the following:
3 - Use NTP protocol version 3, which is based on Internet Standard Request For
Comments (RFC) #1305.
4 - Use NTP protocol version 4, which is based on Internet Standard RFC #5905.
auto - Have Data ONTAP select the NTP protocol version.
advanced)
This optionally specifies whether the external NTP server is the primary time source for
correcting and adjusting the cluster time. The responses from this source will be used
unless its time is outside the accepted selection range
156
You use this parameter when a high quality radio (or GPS) based time server is being
used with a set of non-radio based backup time servers.
This parameter is available only at the advanced privilege level and higher.
Examples
The following example modifies the NTP version of an NTP server named
ntp1.example.com. The NTP version is changed to 4.
cluster1::> cluster time-service ntp server create -server ntp1.example.com version 4
cluster time-service ntp server reset

Reset NTP server list to a default selection
privilege level.
Description
The cluster time-service ntp server reset command replaces the current
configuration with one of the selected configurations.
If none or more than one time service configuration is selected, the command will fail.
Parameters
[-use-public {true|false}] - Reset Server List to Public Identified Defaults (default: false)
When set to true, this specifies that the public NTP server list used by Data ONTAP
should replace the current configuration.
Examples
The following example replaces the current time service configuration with the default
public NTP server list that is used by Data ONTAP.
cluster1::> cluster time-service ntp server reset -use-public true
157
cluster time-service ntp server show

Display a list of NTP Servers
level.
Description
The cluster time-service ntp server show command displays the
association between the cluster and external network time servers that use the Network
Time Protocol (NTP).
Parameters
If you specify the -fields <fieldname>,... parameter, the command only displays
the fields that you specify. For example: -fields server,version.
| [-instance ] }
If the -instance parameter is specified, the command displays all the available field
information.
[-server <text>] - NTP Server Host Name, IPv4 or IPv6 Address
If this parameter is specified, the command displays the external NTP servers that
match the specified server name or IP address.
If this parameter is specified, the command displays the external NTP servers that use
the specified NTP version.
advanced)
If this parameter is specified, the command displays the external NTP server or servers
that match the specified preferred server status.
[-is-public {true|false}] - Is Public NTP Server Default (privilege: advanced)
If this parameter is specified, the command displays the information for the external NTP
servers that are either on the NTP server list defined by Data ONTAP (`true') or not on
the list (`false').
158
Examples
The following example displays information about all external NTP time servers that are
associated with the cluster:
cluster1::> cluster time-service ntp server show
Server
Version
-------------------- ----------ntp1.example.com
auto
ntp2.example.com
auto
159
dashboard alarm show

(DEPRECATED)-Display current over-threshold alarms
level.
Description
Note: This command has been deprecated. It will be removed in the next major release
of Data ONTAP.
The dashboard alarm show command displays information about over-threshold
alarms. Over-threshold alarms are generated when a value exceeds the configured
threshold.
Parameters
specify.
| [-instance ] }
about all fields.
[-type <Metric Type>] - Metric Type
Use this parameter to display information only about alarms with the object type you
specify, such as cpu-busy, port-util, op-latency, or aggregate-used.
Selects the alarms that match this parameter value.
[-name <text>] - Object Name
Selects the alarms that match this parameter value (such as an aggregate named
aggr0).
[-state <Alarm Monitoring State>] - Alarm State
160
Selects the alarms that match this parameter value. Possible states are ok, warning,
and critical. States are displayed according to the configured thresholds. Use the
dashboard alarm thresholds modify command to configure alarm thresholds.
[-ems-state <EMS State>] - EMS State
Selects the alarms that match this parameter value. Possible states are rising and
falling.
[-value <Counter>] - Last Value
[-high-value <Counter>] - High Value
Selects the alarms that match this parameter value. This parameter is most useful when
used with a range, such as ">90%".
Examples
The following example shows the default alarm dashboard output when an alarm
exceeds its threshold:
cluster1::> dashboard alarm show
ObjectType
Node
Name
State
LastValue
HighValue
-------------- ------ ------ --------- ---------- ---------aggregate-used node1
aggr0
critical
57%
57%
See Also
dashboard alarm thresholds modify
161
dashboard alarm thresholds modify

(DEPRECATED)-Modify alarm thresholds
level.
Description
of Data ONTAP.
The dashboard alarm thresholds modify command modifies the cluster-wide
configuration of alarm thresholds.
Parameters
-type <Metric Type> - Metric Type
Use this parameter to specify the type of object to monitor, such as cpu-busy, portutil, op-latency, port-problems, or aggregate-used.
[-warning <Counter>] - Warning Threshold
Use this parameter to specify the threshold value that generates a a warning alarm for
an event.
[-critical <Counter>] - Critical Threshold
Use this parameter to specify the threshold value that generates a critical alarm for an
event.
[-send-ems {true|false}] - Send EMS
Use this parameter with the value true to specify that an EMS (Event Management
System) message is sent when the alarm is generated or cleared. Use this parameter
with the value false to specify that an EMS message is not sent.
[-interval <integer>] - Interval (secs)
Use this parameter to specify the interval in seconds at which the alarm dashboard
monitors objects. Valid values are between 60 and 6,000 seconds.
Examples
The following example modifies the warning and critical alarm thresholds for space used
on aggregates. When 50% of the aggregate's space is consumed, a warning message
162
is generated. When 60% of the aggregate's space is consumed, a critical message is

generated. EMS messages are sent both when the value rises to the critical threshold,
and when it subsequently falls to the warning threshold. The system checks values
every 5 minutes.
cluster1::> dashboard alarm thresholds modify -type aggregate-used -warning 50 critical 60 -send-ems true -interval 300
dashboard alarm thresholds show

(DEPRECATED)-Display alarm thresholds
level.
Description
of Data ONTAP.
The dashboard alarm thresholds show command displays information about
alarm thresholds.
Parameters
specify.
| [-instance ] }
about all fields.
[-type <Metric Type>] - Metric Type
[-warning <Counter>] - Warning Threshold
[-critical <Counter>] - Critical Threshold
163
[-send-ems {true|false}] - Send EMS

[-interval <integer>] - Interval (secs)
[-critical-ems <text>] - Critical EMS
[-normal-ems <text>] - Normal EMS
Selects the alarms that match this parameter value. The normal EMS message is sent
when a value returns to the warning threshold after having reached the critical threshold.
Examples
The following example shows the default dashboard alarm threshold information:
cluster1::> dashboard alarm thresholds show
----Thresholds---ObjectType
-------------cpu-busy
port-util
op-latency
aggregate-used
port-problems
164
Warning
Critical SendEMS
-------- --------- ------100%
false
100%
false
100ms
500ms
false
85%
95%
true
1%
5%
false
dashboard health vserver show-aggregate

(DEPRECATED)-Display Vserver aggregate issues
Description
of Data ONTAP.
The dashboard health vserver show-aggregate command displays
information about aggregate health.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display health information only about the Vserver you specify.
Use this parameter to display health information only about the aggregate you specify.
[-time <MM/DD HH:MM:SS>] - Time
Use this parameter to display information only about health issues occurring at the date
and time you specify.
Use this parameter to display health information only about the node you specify.
[-severity {ok|info|warning|critical}] - Severity
165
Use this parameter to display information about health issues that have the severity you
specify. Possible values for this parameter are ok, warning, and critical.
[-description <text>] - Description
Use this parameter to display information only about health issues whose descriptions
match the text you specify.
Examples
The following example shows health information for all aggregates in the cluster:
cluster1::> dashboard health vserver show-aggregate
Vserver
Aggregate
Time
Node
Severity
--------------- ---------- -------------- ------ -------vs0
aggr1
4/9
17:08:16
node1
warning
mgmtgwd.aggregate-used.rising: Percentage used on

aggregate aggr1 has a value of 95.
vs0
aggr2
4/9
17:08:51
node1
warning

vs1
aggr1
4/6
16:03:53
node2
warning

vs1
aggr2
4/6
16:03:53
node2
warning

166
dashboard health vserver show-combined

(DEPRECATED)-Display all aggregate, LIF, port, protocol or volume issues
Description
of Data ONTAP.
The dashboard health vserver show-combined command displays the health
status of aggregates, LIFs, ports, protocols, and volumes in Vservers.
Parameters
specify.
| [-instance ] }
about all fields.
[-category <Health Categories>] - Health Issue Type
Use this parameter to display health information only about health issues in the category
you specify, such as protocol, lif, volume, port, or aggregate.
[-objectname <text>] - Object Name
Use this parameter to display health information only about the object you specify, such
as the name of a node.
Use this parameter to display health information only about issues occurring at the date
[-node {<nodename>|local}] - Issuing Node
167
[-event <text>] - Event name
Use this parameter to display health information only about the event you specify.
Use this parameter to display information only about health issues that have the severity
you specify. Possible values for this parameter are ok, warning, and critical.
Examples
The following example shows Vserver health information:
cluster1::> dashboard health vserver show-combined
Vserver
Category Object Name Time
Severity
--------------- -------- ----------- ------------- -------vs0
lif
datalif1
4/12 11:30:13 critical
lifmgr.lifdown.noports: LIF datalif1 (on Vserver vs0),

IP address 192.0.2.132, currently cannot be hosted
on node node1, port e0d, or anywhere else, and is
being marked as down.
vs0
volume
root_vs0
4/6
15:57:00 warning
wafl.vvol.offline: Volume
'root_vs0@vserver:67a42b95-e454-11db-80e8-000423b7394e'
has been set temporarily offline
vs0
volume
vol0
4/6
12:53:22 warning
wafl.vol.full: file system on volume datalif1vol0@

vserver:67a42b95-e454-11db-80e8-000423b7394e is full
vs0
volume
vol1
4/6
12:53:24 warning
'vol1@vserver:67a42b95-e454-11db-80e8-000423b7394e'
vs0
volume
vol2
4/6
12:53:26 warning
'vol2@vserver:67a42b95-e454-11db-80e8-000423b7394e'
168
169
dashboard health vserver show-lif

(DEPRECATED)-Display Vserver LIF issues
Description
of Data ONTAP.
The dashboard health vserver show-lif command displays information about
the health of logical interfaces (LIFs).
Parameters
specify.
| [-instance ] }
about all fields.
[-lif <lif-name>] - Logical Interface
Use this parameter to display health information only about the LIF you specify.
Use this parameter to display health information only about health issues that occurred
at the date and time you specify.
170
Examples
The following example shows health information for a Vserver on which all logical
interfaces are working properly:
cluster1::> dashboard health vserver show-lif
There are no logical interface issues.
dashboard health vserver show-port

(DEPRECATED)-Display Vserver port issues
Description
of Data ONTAP.
The dashboard health vserver show-port command displays information about
port health.
Parameters
specify.
| [-instance ] }
about all fields.
171
[-port <text>] - Port
Use this parameter to display health information only about the network port you specify.
Examples
The following example shows health information for all network ports in the cluster that
have a health issue:
cluster1::> dashboard health vserver show-port
Vserver
Node
Port
Time
Severity
--------------- ------ ----- ------------- -------vs1
node3
e0d
3/22 01:43:00 warning
vifmgr.portdown: A link down event was

received on node node3, port e0d.
172
dashboard health vserver show-protocol

(DEPRECATED)-Display Vserver protocol issues
Description
of Data ONTAP.
The dashboard health vserver show-protocol command displays information
about protocol health.
Parameters
specify.
| [-instance ] }
about all fields.
[-component-type <component type>] - Component Type
Use this parameter to display health information only about the component type you
specify.
[-component-name <text>] - Component Name
Use this parameter to display health information only about the component name you
specify.
173
Examples
The following example shows health dashboard information for a cluster in which all
protocols are working properly:
cluster1::> dashboard health vserver show-protocol
There are no protocol issues.
The following example shows health information about a Vserver on which there are two
warnings about protocols:
cluster1::> dashboard health vserver show-protocol -vserver vs0
Component
Vserver Type
Component
Name
Time
Node
Severity
------- ---------- --------- ------------- ----- -------vs0
CIFSSERV
cifsserv0 3/21 14:13:54 node1 warning
mgmt.cifsserver.failure: Failed to configure CIFS

server.
vs0
CIFSSHARE
cifshome
3/21 14:16:04 node1 warning
mgmt.cifsshare.failure: Failed to configure CIFS

share.
174
dashboard health vserver show-volume

(DEPRECATED)-Display Vserver volume issues
Description
of Data ONTAP.
The dashboard health vserver show-volume command displays health
information about volumes.
Parameters
specify.
| [-instance ] }
about all fields.
[-volume <volume name>] - Volume
Use this parameter to display health information only about the volume you specify.
175
Examples
The following example shows health information about volumes named vol0 and
root_vs0 on node1:
cluster1::> dashboard health vserver show-volume -volume vol0,root_vs0 -node
node1
Vserver
Volume
Time
Node
Severity
--------------- --------- ------------- ------ -------vs0
vol0
3/12 12:10:17 node1
warning
'vol0@vserver:f18b00c4-d0b0-11db-891f-423b6f0a2'
vs0
root_vs0
3/12 12:11:43 node1
warning
'root_vs0@vserver:f18b00c4-d0b0-11db-891f-423b6f0a2'
176
dashboard health vserver show

(DEPRECATED)-Display Vserver health dashboard
Description
of Data ONTAP.
The dashboard health vserver show command displays information about
Vserver health. This information includes current operational state and status, critical
alerts, warnings, informational messages, and comments.
Parameters
specify.
| [-instance ] }
about all fields.
[-vserver <vserver name>] - Vserver Name
Selects the items that match this parameter value.
[-vstatus {online|offline}] - Status
[-vhealth {ok|info|warning|critical}] - Health
[-critical <integer>] - Critical Issues
[-warning <integer>] - Warning Issues
177
[-informational <integer>] - Informational Issues

[-nfs-config-status {configured|notconfigured|disabled}] - NFS Configuration Status
[-nfs-health-status {ok|info|warning|critical}] - NFS Operational Status
[-cifs-config-status {configured|notconfigured|disabled}] - CIFS Configuration Status
[-cifs-health-status {ok|info|warning|critical}] - CIFS Operational Status
[-lif-total <integer>] - Number of LIFs
[-lif-online <integer>] - LIFs Online
[-lif-offline <integer>] - LIFs Offline
[-lif-nothome <integer>] - LIFs not home
[-lif-no-failover <integer>] - LIFs without Failover Rules
[-lif-nothosted <integer>] - Number of LIFS not hosted
[-lif-home-port-down <integer>] - LIFs With Home Port Down
[-vol-total <integer>] - Number of Volumes
[-vol-online <integer>] - Online Volumes
178
[-vol-offline <integer>] - Offline Volumes

[-vol-full <integer>] - Volumes Currently Full
[-vol-restricted <integer>] - Volumes Restricted
[-root-vol-status {online|offline}] - Root Volume State
[-root-vol-state {ok|info|warning|critical}] - Root Volume Health
[-root-vol-mirrors-total <integer>] - Root LS Mirrors
[-root-vol-mirrors-online <integer>] - Root LS Mirrors Online
[-aggr-total <integer>] - Aggregates
[-aggr-online <integer>] - Aggregates Online
[-aggr-offline <integer>] - Aggregates Offline
[-aggr-failedover <integer>] - Aggregates Failed-Over
Selects the items that match this parameter value. "Failed over" aggregates have failed
over to a partner node.
[-aggr-full <integer>] - Aggregates That Are Full
Selects the items that match this parameter value. "Full" aggregates have exceeded
their configured threshold.
[-ports-total <integer>] - Network Ports
[-ports-shared <integer>] - Network Ports Sharing Resources with Migrated LIFs
179
Selects the items that match this parameter value. "Shared" ports contain active logical
interfaces that have failed over to a partner node.
[-issues <text>, ...] - Health Issues
Examples
The following example shows default Vserver health information:
cluster1::> dashboard health vserver show
EMS Issues
Vserver
Status
Health
----------------- -------- ------node1
online
warning
Crit
Warn
Info
----- ----- ----0
Issues: The Vserver root volume is online however there

are no mirrors of the root volume.
node2
online
warning
node3
online
warning
The following example shows detailed Vserver health information:

cluster1::> dashboard health vserver show -vserver node1 -instance
Vserver
-------------- -----------------------------------------node1
Status: online
EMS Critical: 0
Health: warning
Warning: 0
Informational: 0
Issues: The Vserver root volume is online however there

are no load-sharing mirrors online.
Protocols
NFS
Status: configured
Health: ok
CIFS
Status: configured
Health: ok
LIFs
Total: 4
Online: 4
Offline: 0
LIFs Not Home: 0
LIFs Without Failover Rules: 4
180
LIFs Not Hosted: 0

LIFs With Home Port Down: 0
Volumes
Total: 11
Online: 11
Offline: 0
Restricted: 0
Full: 0
Root Volume
State: online
Health: warning
Mirrors: 0
Mirrors Online: 0
Resources
Aggregates
Total: 1
Online: 1
Offline: 0
Failed Over To Partner: 0
Full: 0
Network Ports
Total: 4
Ports With LIFs Not Home: 0
181
dashboard performance show

(DEPRECATED)-Display per-second performance figures
level.
Description
of Data ONTAP.
The dashboard performance show command displays information about the
performance of individual nodes and the cluster as a whole.
Parameters
specify.
| [-operations ]
Displays the following information:
Node name or cluster summary
Average latency
Total operations per second
NFS latency
NFS operations per second
CIFS latency
CIFS operations per second
SPIN latency
SPIN operations per second
| [-instance ] }
182
about all fields.
[-avg-latency <Counter64>] - Average Latency (usec)
[-cpu-busy <Counter>] - CPU Busy
Selects the items that match this parameter value (percentage of CPU utilization).
[-total-ops <Counter64>] - Total Ops/s
[-nfs-ops <Counter64>] - NFS Ops/s
[-cifs-ops <Counter64>] - CIFS Ops/s
[-data-busy <Counter>] - Data Network Utilization
Selects the items that match this parameter value (percentage of data network
utilization).
[-data-recv <Counter64>] - Data Network Received (per sec)
[-data-sent <Counter64>] - Data Network Sent (per sec)
Selects the items that match this parameter value (MB per second sent to the data
network).
[-cluster-busy <Counter>] - Cluster Network Utilization
Selects the items that match this parameter value (percentage of cluster network
utilization).
[-cluster-recv <Counter64>] - Cluster Network Received (per sec)
Selects the items that match this parameter value (MB per second received from the
cluster network).
[-cluster-sent <Counter64>] - Cluster Network Sent (per sec)
183
Selects the items that match this parameter value (MB per second sent to the cluster
network).
[-storage-read <Counter64>] - Storage Read (per sec)
Selects the items that match this parameter value (MB per second read from storage).
[-storage-write <Counter64>] - Storage Write (per sec)
Selects the items that match this parameter value (MB per second written to storage).
[-cifs-latency <Counter64>] - CIFS Average Latency
Selects the items that match this parameter value (in microseconds).
[-nfs-latency <Counter64>] - NFS Average Latency
Selects the items that match this parameter value (in microseconds).
Examples
The following example shows standard performance dashboard information for a
cluster:
cluster1::> dashboard performance show
Average
Total Latency
---Data-Network--- -Cluster--Network- ----Storage--CPU Busy
Recv
Sent Busy
Recv
Sent
Read
Write
Ops/s in usec Busy Util
MB/s
MB/s Util
MB/s
MB/s
MB/s
MB/s
------ ------- ---- ---- ------ ------ ---- ------ ------ ------ -----node1
0
2%
0%
0%
2%
0%
0%
2%
0%
0%
node2
cluster:summary
0
The following example shows detailed performance-dashboard information for the node
named node2:
cluster1::> dashboard performance show -node node2
Node: node2
Average Latency (usec): 624us
CPU Busy: 84%
Total Ops/s: 27275
184
NFS Ops/s: 27275

CIFS Ops/s: 0
Data Network Utilization: 0%
Data Network Received (MB/s): 0
Data Network Sent (MB/s): 0
Cluster Network Utilization: 0%
Cluster Network Received (MB/s): 0
Cluster Network Sent (MB/s): 0
Storage Read (MB/s): 0
Storage Write (MB/s): 0
CIFS Average Latency: 0us
NFS Average Latency: 624us
185
dashboard storage show

(DEPRECATED)-Display storage dashboard
level.
Description
of Data ONTAP.
The dashboard storage show command displays information about storage
utilization.
Parameters
specify.
| [-performance ]
Displays storage space utilization and the current performance of I/O operations,
including:
Aggregate name
Size
Used space
Percentage of space used
Number of volumes
Data read rate
Number of I/O read operations per second
Data write rate
Number of I/O write operations per second
Node names
186
| [-week ]
Displays the storage space utilization trend over the past seven days, including:
Aggregate name
Size
Used space
Number of volumes
One-day change in used size
One-day change in number of volumes
Two-day change in used size
Two-day change in number of volumes
Three-day change in used size
Three-day change in number of volumes
Seven-day change in used size
Seven-day change in number of volumes
| [-instance ] }
about all fields.
Selects the aggregates that match this parameter value.
[-size {<integer>[KB|MB|GB|TB|PB]}] - Size
[-usedsize {<integer>[KB|MB|GB|TB|PB]}] - Used Size
[-availsize {<integer>[KB|MB|GB|TB|PB]}] - Avail Size
[-percent-used <percent>] - Used%
[-nodes {<nodename>|local}] - Nodes
187

[-volcount <integer>] - Volumes
Selects the aggregates that match this parameter value (number of volumes).
[-read-data <Counter64>] - Read Data MB/s
[-read-iops <Counter64>] - Read IOPs
[-write-data <Counter64>] - Write Data MB/s
Selects the aggregates that match this parameter value (MB per second written to
storage).
[-write-iops <Counter64>] - Write IOPs
[-status <text>, ...] - Status
Selects the aggregates that match this parameter value. Possible values are:
creating
failed
offline
online
partial
restricted
unknown
normal
verifying
snapmirrored
copying
ironing
mirrored
resyncing
mirror degraded
188
invalid
needs check
initialized
growing
partial
degraded
noparity
reconstruct
out-of-date
foreign
Separate multiple values with commas.
[-4h-change-used {<integer>[KB|MB|GB|TB|PB]}] - 4-hour Change in Used Size
[-4h-change-vols <integer>] - 4-hour Change in Number of Volumes
[-8h-change-used {<integer>[KB|MB|GB|TB|PB]}] - 8-hour Change in Used Size
[-8h-change-vols <integer>] - 8-hour Change in Number of Volumes
[-1d-change-used {<integer>[KB|MB|GB|TB|PB]}] - 1-day Change in Used Size
[-1d-change-vols <integer>] - 1-day Change in Number of Volumes
189

Examples
The following example shows storage utilization information about the aggregate named
aggr1:
cluster1::> dashboard storage show -aggregate aggr1
Aggregate: aggr1
Size: 6.21TB
Used Size: 5.14TB
Avail Size: 1.06TB
Used%: 83%
Nodes: node1
Volumes: 49
Read Data MB/s: 5904283
Read IOPs: 0
Write Data MB/s: 0
Write IOPs: 0
Status: online
4-hour Change in Used Size: 2.75GB
4-hour Change in #Volumes: 0
8-hour Change in Used Size: 15.81GB
8-hour Change in #Volumes: 0
1-day Change in Used Size: 16.50GB
1-day Change in #Volumes: 0
190
191
event config modify

Modify log configuration parameters
level.
Description
Use the event config modify command to configure event notification and logging
for the cluster.
Parameters
[-mailfrom <mail address>] - Mail From
Use this parameter to configure the e-mail address from which e-mail notifications will
be sent. You can configure the cluster to send e-mail notifications when specific events
occur. Use the event route add-destinations and event destination
create commands to configure e-mail destinations for events.
[-mailserver <text>] - Mail Server (SMTP)
Use this parameter to configure the name or IP address of the SMTP server used by the
cluster when sending e-mail notification of events.
[-suppression {on|off}] - Event Throttling/Suppression (privilege: advanced)
Use this parameter to configure whether event suppression algorithms are enabled
("on") or disabled ("off"). The event processing system implements several algorithms
to throttle events. The documentation for event show-suppression describes the
suppression algorithms in detail.
Note:
The suppression parameter can disable both autosuppression and duplicate
suppression, but timer suppression cannot be disabled.
[-console {on|off}] - Console Logging (privilege: advanced)
Use this parameter to configure whether events are displayed on the console port ("on")
or not ("off").
Examples
192
The following command sets the "Mail From" address for event notifications to
"admin@example.com" and the "Mail Server" to "mail.example.com".
cluster1::> event config modify -mailfrom admin@example.com -mailserver
mail.example.com
The following example turns on event suppression and console logging.

cluster1::> event config modify -suppression on -console on
See Also
event route add-destinations event destination create event show-suppression
event log show event tracelog log show
193
event config show

Display log configuration parameters
level.
Description
The event config show command displays information about the configuration of
event notification and event logging for the cluster.
"Mail From" is the e-mail address that the event notification system uses as the "From"
address for e-mail notifications.
"Mail Server" is the name or IP address of the SMTP server that the event notification
system uses to send e-mail notification of events.
"Event Throttling/Suppression" indicates whether event suppression algorithms are
enabled ("on") or disabled ("off"). The event processing system implements several
algorithms to throttle events. See event show-suppression for suppression
algorithm details.
Note:
The suppression parameter can disable both autosuppression and duplicate
suppression, but not timer suppression.
"Console Logging" indicates whether events are displayed on the console port ("on") or
not ("off").
Parameters
None
Examples
The following example displays the configuration of event notification for the cluster:
cluster1::> event config show
Mail From: admin@example.com
Mail Server: mail.example.com
194
See Also
event show-suppression event log show event tracelog log show
195
event destination create

Create an event destination
level.
Description
The event destination create command creates a new event destination. An
event destination is a list of addresses that receive event notifications. These addresses
can be e-mail addresses, SNMP trap hosts, and syslog servers. Event destinations are
used by event routes. Event routes describe which events generate notifications, and
event destinations describe where to send those notifications.
When you create a destination, you can add e-mail addresses, SNMP trap hosts, and
syslog hosts to the definition of the destination. Once the destination is fully defined,
use the event route add-destinations command to associate the destination
with event routes so that notifications of those events are sent to the recipients in the
destination.
To see the current list of all destinations and their recipients, use the event
destination show command.
There are several default destinations provided for your use.
allevents - A useful destination for all system events, though no events are routed
to this destination by default.
asup - Events routed to this destination trigger AutoSupport(tm). Only use
this destination to send notifications to technical support. See system node
autosupport for more information.
criticals - A useful destination for critical events though no events are routed to
this destination by default.
pager - A useful destination for all events that are urgent enough to page a
system administrator, though no events are routed to this destination by default.
traphost - The default destination for all SNMP traps. You can also use the
system snmp traphost add command to add SNMP recipients to the
traphost default destination.
To add recipients to the default destinations, use the event destination modify
command.
196
You should not create a destination that sends events to more than one type of
recipient. Use separate destinations for e-mail, SNMP, and syslog activity. Also, use
the traphost default destination for all SNMP activity. You must not create any other
destination that sends traps to SNMP trap hosts. The traphost default destination is not
required to be added to any event route.
Parameters
-name <text> - Name
This mandatory parameter specifies name of the event destination to create.
[-mail <mail address>, ...] - Mail Destination
Use this parameter to specify one or more e-mail addresses to which event notifications
will be sent. For events to properly generate e-mail notifications, the event system must
also be configured with an address and mail server from which to send mail. See event
config modify for more information.
[-snmp <Remote IP>, ...] - SNMP Destination
To send traps to SNMP trap hosts, use this parameter with the host names or IP
addresses of those trap hosts.
[-syslog <Remote IP>, ...] - Syslog Destination
Use this parameter with the host names or IP addresses of any remote syslog daemons
to which syslog entries will be sent.
[-syslog-facility <Syslog Facility>] - Syslog Facility
This parameter optionally specifies a syslog facility with which the syslog is sent.
Possible values for this parameter are default, local0, local1, local2, local3, local4,
local5, local6, and local7. If you specify the default syslog facility, syslogs are tagged
LOG_KERN or LOG_USER.
[-snmp-community <text>] - SNMP Trap Community
To specify an SNMP trap community, use this parameter with that string.
[-hide-parameters {true|false}] - Hide Parameter Values?
Use this parameter with the value "true" to hide event parameters by removing them
from event notifications. This is useful to prevent sensitive information from being sent
over non-secure channels.
Examples
197
The following example creates an event destination named support.email that e-mails
events to the addresses supportmgr@example.com, techsupport@example.com, and
oncall@example.com.
cluster1::> event destination create -name support.email -mail
supportmgr@example.com,techsupport@example.com,oncall@example.com
This example creates an event destination named support.bucket01 that sends the
notifications to a syslog host.
cluster1::> event destination create -name support.bucket01 -syslog
loghost.example.com
See Also
event config modify event route add-destinations event destination show
system node autosupport system snmp traphost add event destination modify
198
event destination delete

Delete an event destination
level.
Description
The event destination delete command removes a specified destination from
the list of valid destinations. An event destination is a list of addresses that receive event
notifications. These addresses can be e-mail addresses, SNMP trap hosts, and syslog
servers. Event destinations are used by event routes. Event routes describe which
events generate notifications, and event destinations describe where to send those
notifications.
Once you delete a destination, you will not be able to add that destination to any event
route.
You will not be able to delete a destination if it is in use by any event routes. To remove
a destination from all event routes, so that you can delete it, use the event route
remove-destinations -messagename * -destination name command.
There are several default destinations that cannot be deleted:
criticals - A useful destination for critical events though no events are routed to
system snmp traphost delete command to delete SNMP recipients from
the traphost default destination.
To see the current list of all destinations, use the event destination show
command. To add a new destination to the list, use the event destination create
command.
199
Parameters
-name <text> - Name
This mandatory parameter specifies the event destination to delete.
Examples
The following example deletes an event destination named manager.pager:
cluster1::> event destination delete -name manager.pager
See Also
event route remove-destinations system node autosupport
system snmp traphost delete event destination show event destination create
200
event destination modify

Modify an event destination
level.
Description
The event destination modify command changes the definition of an existing
event destination. An event destination is a list of addresses that receive event
notifications. These addresses can be e-mail addresses, SNMP traphosts, and syslog
notifications.
Modifying a parameter writes over the existing value of the parameter. To extend a
parameter, make sure to include the current value of that parameter. For instance,
to add an e-mail address to a destination, include all of the current e-mail addresses
assigned to that destination along with the new address. To see the current definition of
a destination, use the event destination show -name name command.
You must not create a destination that sends events to more than one type of recipient.
Use separate destinations for e-mail, SNMP, and syslog activity. Also, use the traphost
default destination for all SNMP activity. You should not create any other destination that
sends to SNMP traphosts. The traphost default destination is not required to be added
to any event route.
Parameters
-name <text> - Name
This mandatory parameter specifies name of the event destination to modify.
Use this parameter to specify one or more e-mail addresses to which event notifications
will be sent. For events to properly generate e-mail notifications, the event system must
also be configured with an address and mail server from which to send mail. See event
config modify for more information.
To send traps to SNMP trap hosts, use this parameter with the host names or IP
addresses of those trap hosts.
201

Use this parameter with the host names or IP addresses of any remote syslog daemons
to which syslog entries will be sent.
This parameter optionally specifies a syslog facility with which the syslog is sent.
Possible values for this parameter are default, local0, local1, local2, local3, local4,
local5, local6, and local7. If you specify the default syslog facility, syslogs are tagged
LOG_KERN or LOG_USER.
To specify an SNMP trap community, use this parameter with that string.
Enter this parameter with the value "true" to hide event parameters by removing them
from event notifications. This is useful to prevent sensitive information from being sent
over non-secure channels. Enter it with the value "false" to turn off parameter hiding.
Examples
The following example modifies an event destination named snmp.hosts to send events
to SNMP trap hosts named traphost1 and traphost2:
cluster1::> event destination modify -name snmp.hosts -snmp
traphost1.example.com,traphost2.example.com
This example adds the e-mail address of a remote support facility to an existing list of email recipients.
cluster1::> event destination show -name support
Name: support
Mail Destination: support.hq@company.com
SNMP Destination: Syslog Destination: Syslog Facility: SNMP Trap Community: Hide Parameter Values?: cluster1::> event destination modify -name support -mail
support.hq@company.com,support.remote@company.com
cluster1::> event destination show -name support
202
Name: support
Mail Destination: support.hq@company.com, support.remote@company.com
SNMP Destination: Syslog Destination: Syslog Facility: SNMP Trap Community: Hide Parameter Values?: -
See Also
event config modify event destination show
203
event destination show

Display event destinations
level.
Description
The event destination show command displays information about configured
event destinations. An event destination is a list of addresses that receive event
notifications. These addresses can be e-mail addresses, SNMP trap hosts, and syslog
notifications.
Default destinations:
criticals - A useful destination for critical events although no events are routed to
system snmp traphost show command to view SNMP recipients for the
traphost default destination.
To add recipients to the default destination, use the event destination modify
command.
Note:
While you can use both host names and IP addresses with parameters, only IP
addresses are stored. Unless all DNS and reverse-DNS operations complete
successfully, IP addresses might appear in command output.
204
Parameters
specify.
| [-facility ]
Displays only the syslog destinations and syslog facilities.
| [-instance ] }
about all fields.
[-name <text>] - Name
Selects the destinations that match this parameter value.
Selects the destinations that match this parameter value (SNMP trap hosts).
Selects the destinations that match this parameter value (syslog event notification
daemons).
Selects the destinations that match this parameter value. Valid values are: default,
local0, local1, local2, local3, local4, local5, local6, and local7.
Selects the destinations that match this parameter value (true selects destinations that
do not receive full event parameters, false selects destinations that receive full event
parameters). Event parameters may be hidden to prevent sensitive information from
being sent over non-secure channels.
Examples
205
The following example displays information about all event destinations:

cluster1::> event destination show
Hide
Name
Mail Dest.
SNMP Dest.
Syslog Dest.
Params
---------------- ----------------- ------------------ ------------------ -----allevents
logger.example.com -
asup
criticals
oncall
pager
pager@example.com -
support.email
supportmgr
@example.com
th0.example.com,
@example.com
@example.com,
techsupport
@example.com,
oncall
traphost
th1.example.com
See Also
system node autosupport system snmp traphost show event destination modify
206
event log show

Display latest log events
level.
Description
The event log show command displays the contents of the event log, which lists
significant occurrences within the cluster. Events are categorized by type. Use the
event route show command to display general information about each type of
event.
By default, the command displays non-DEBUG severity level events with the following
information, with the most recent events listed first:
The time at which the event occurred
The node on which the event occurred
The severity of the event
The event's message
To display detailed information about events, use one or more of the optional
parameters that affect how the command output is displayed and the amount of detail
that is included. For example, to display all detailed event information, use the -detail
parameter.
To display DEBUG severity level events, use the -severity parameter.
At the advanced privilege level and higher, the command displays the following
additional information:
The internal EMS severity of the event
The event's kernel generation number, if applicable
The event's kernel sequence number, if applicable
Parameters
207
specify.
| [-detail ]
Displays all detailed event information.
| [-detailtime ]
Displays detailed event information in reverse chronological order.
| [-instance ] }
about all fields.
Displays a list of events for the node you specify. Use this parameter with the -seqnum
parameter to display detailed information.
[-seqnum <Sequence Number>] - Sequence#
Selects the events that match this parameter value. Use with the -node parameter to
display detailed information.
[-time <MM/DD/YYYY HH:MM:SS>] - Time
Selects the events that match this parameter value. Use the format: MM/DD/YYYY
HH:MM:SS [+- HH:MM]. You can specify a time range by using the ".." operator between
two time statements.
show -time "08/13/2010 05:55:00".."08/13/2010 06:10:00"
Comparative time values are relative to "now". For example, to display only events that
occurred within the last minute:
show -time >1m
[-severity {EMERGENCY|ALERT|CRITICAL|ERROR|WARNING|NOTICE|
INFORMATIONAL|DEBUG}] - Severity
Selects the events that match this parameter value. Severity levels:
EMERGENCY - The system is unusable
ALERT - Action must be taken immediately
CRITICAL - Critical condition
ERROR - Error condition
208
WARNING - Warning condition

NOTICE - Normal but significant condition
INFORMATIONAL - Information message
DEBUG - Debugging message
To display all events, including ones with a severity of DEBUG, specify severity as
follows:
show -severity <=DEBUG
[-ems-severity {NODE_FAULT|SVC_FAULT|NODE_ERROR|SVC_ERROR|WARNING|
NOTICE|INFO|DEBUG|VAR}] - EMS Severity (privilege: advanced)
Selects the events that match this parameter value. Severity levels:
NODE_FAULT - Data corruption has been detected or the node is unable to
provide client service
SVC_FAULT - A temporary loss of service, typically a transient software fault, has
been detected
NODE_ERROR - A hardware error that is not immediately fatal has been detected
SVC_ERROR - A software error that is not immediately fatal has been detected
WARNING - A high-priority message that does not indicate a fault
NOTICE - A normal-priority message that does not indicate a fault
INFO - A low-priority message that does not indicate a fault
DEBUG - A debugging message
VAR - A message with variable severity, selected at runtime.
[-source <text>] - Source
Selects the events that match this parameter value (typically a software module).
[-messagename <Message Name>] - Message Name
Selects the events that match this parameter value (string). Message names are
descriptive, so filtering output by message name displays messages of a specific type.
[-event <text>] - Event
Selects the events that match this parameter value. This parameter is most useful when
entered with wildcards. The "event" field contains the full text of the event, including any
209
parameters. For example, a wafl.vol.offline event will contain the name of the volume
taken offline.
[-kernelgen <integer>] - Kernel Generation Number (privilege: advanced)
Selects the events that match this parameter value. Only events that emanate from the
kernel have kernel generation numbers.
[-kernelseqnum <integer>] - Kernel Sequence Number (privilege: advanced)
Selects the events that match this parameter value. Only events that emanate from the
kernel have kernel sequence numbers.
[-action <text>] - Corrective Action
entered with wildcards. The "action" field describes what steps, if any, you must take to
remedy the situation.
entered with wildcards. The "description" field describes why the event was encountered
and what it means.
Examples
The following example displays the event log:
cluster1::> event log show
Time
Node
Severity
Event
------------------- ---------------- ------------- -----------------------11/9/2010 13:54:19 node1

INFORMATIONAL vifmgr.portup: A link up event
was received on node node1, port e0a.
11/9/2010 13:54:19 node1
was received on node node1, port e0d.
11/9/2010 13:54:19 node1
was received on node node1, port e0c.
11/9/2010 13:54:19 node1
was received on node node1, port e0b.
...
This example demonstrates how to use a range with the -time parameter to display all
events that occurred during an extended time period. It displays all events that occurred
between 1:45pm and 1:50pm on November 9, 2010.
cluster1::> event log show -time "11/9/2010 13:45:00".."11/9/2010 13:50:0"
210
The -time parameter also accepts values that are relative to "now". The following
example displays events that occurred more than one hour ago.
cluster1::event log> show -time <1h
Time
Node
Severity
Event
------------------- ---------------- ------------- -----------------------11/9/2010 13:02:03 node1

system's global status is normal.
INFORMATIONAL monitor.globalStatus.ok: The
11/9/2010 13:02:03 node2

system's global status is normal.
INFORMATIONAL monitor.globalStatus.ok: The
...
Severity levels sort in the order opposite to what you might expect. The following
example displays all events that have a severity level of CRITICAL or more severe.
cluster1::> event log show -severity <CRITICAL
See Also
event route show
211
event mailhistory delete

Delete an e-mail history record
level.
Description
The event mailhistory delete command deletes a record from the e-mail history.
To delete a record, you must know which node contains the record, and the record's
sequence number. Use the event mailhistory show command to view this
information.
Parameters
Use this parameter to specify the name of the node that contains the e-mail history
record to delete.
-seqnum <Sequence Number> - Sequence Number
Use this parameter to specify the sequence number of the e-mail history record to
delete.
Examples
The following example deletes all mail-history records on node1:
cluster1::> event mailhistory delete -node node1 -seqnum *
See Also
event mailhistory show
212
event mailhistory show

Display a list of e-mail history records
level.
Description
The event mailhistory show command displays a list of the event notifications
that have been e-mailed. The command output depends on the parameters you specify
with the command. By default, the command displays basic information about all
notification e-mails that were sent.
To display detailed information about a specific mail-history record, run the command
with the -seqnum parameter.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the mail-history records that match this parameter value.
[-seqnum <Sequence Number>] - Sequence Number
[-address <mail address>, ...] - Mail Address
[-time <MM/DD/YYYY HH:MM:SS>] - Transmission Time
213

[-message <text>] - Alert Message
Selects the mail-history records that match this parameter value (text pattern).
[-previous-time <MM/DD/YYYY HH:MM:SS>] - Previous Transmission Time
[-num-drops-since-previous <integer>] - Number of Drops Since Previous
Transmission
Selects the mail-history records that match this parameter value (number of event drops
since last transmission).
Examples
The following example displays detailed information about the mail-history record with
the sequence number 20520:
cluster1::> event mailhistory show -seqnum 20520
Sequence Number:
Message Name:
Address:
20520
wafl.vol.full
admin@example.com
Time:
10/1/2008 14:06:24
Node:
node3
Previous Time:
# Drops Since Prev:
Mail Message:
5/31/2007 00:33:22
0
wafl.vol.full: file system on volume
vol0@vserver:28558fe3-2462-11da-85ab
-000423bacd20 is full
214
event route add-destinations

Add destination(s) to an event definition
level.
Description
The event route add-destinations command adds destinations to an event
route. Any existing destinations assigned to the route are not removed.
The destinations you add must already exist. See the documentation for the event
destination create command for information about creating destinations. To
show all existing destinations and their attributes, use the event destination
show command. To remove destinations from an event route, use the event route
remove-destinations command.
You can use extended queries with such parameters as -severity and -snmpsupport to specify multiple events that meet certain criteria. See examples below that
show how to use extended queries.
Parameters
-messagename <Message Name> - Message Name
Specify the message name of the event you are modifying. You can use wildcards to
specify a family of events or type of event.
Use this optional parameter to specify a set of events that match this parameter value.
You must use the -messagename parameter with wildcards to specify the family of
events or type of events.
-destinations <Event Destination>, ... - Destinations
Specify a comma-separated list of destinations to which notifications for the named
event are sent. These destinations will be added to any existing destinations assigned to
this event route.
Examples
The following example specifies that all RAID events go to the destinations named
support.email, mgr.email, and sreng.pager:
215
cluster1::> event route add-destinations -messagename raid* -destinations

support.email,mgr.email,sreng.pager
The following example specifies that all critical, alert, and emergency events go to the
destination named test_dest:
cluster1::> event route add-destinations -messagename * -severity <=CRITICAL destinations test_dest
The following example specifies that all critical or alert events that support a SNMP trap
go to the destination named traphost. In this example, because the -snmp-support
parameter is specified as part of extended queries, the -severity parameter must
also be specified in the extended queries:
cluster1::> event route add-destinations {-snmp-support true -severity CRITICAL|
ALERT} -destinations traphost
See Also
event destination create event destination show event route remove-destinations
216
event route modify

Modify an event's destination, reporting threshold, or both
level.
Description
Use the event route modify command to modify an event's destination, frequency
threshold, and time threshold. The event's destination must already exist; see the
documentation for the event destination create command for information about
creating destinations. The frequency threshold and time threshold prevent multiple event
notifications in a brief period of time.
You can use extended queries with such parameters as -severity and -snmpsupport to specify multiple events that meet certain criteria. See examples provided
in the event route add-destinations command manpage that show how to use
extended queries.
The frequency threshold specifies the number of times an event occurs before a repeat
notification of the event is sent; for instance, a frequency threshold of 5 indicates that
a notification is sent every fifth time an event occurs. The time threshold specifies the
number of seconds between notifications for an event; for instance, a time threshold of
120 indicates that a notification is sent only if it has been two minutes or more since the
last notification for that event was sent.
If both the frequency threshold and time threshold are set, a notification is sent if
either threshold is met. For instance, if the frequency threshold is set to 5 and the time
threshold is set to 120, and the event occurs more than five times within two minutes, a
notification is sent. If both thresholds are set to 0 (zero) or empty ("-" or ""), there is no
suppression of multiple event notifications.
Parameters
217
[-destinations <Event Destination>, ...] - Destinations
Use this optional parameter to specify a comma-separated list of destinations to which
notifications for the named event are sent. Using this parameter replaces the current
list of destinations with the list of destinations you specify. To add or remove individual
destinations from the current list, use event route add-destinations or event
route remove-destinations.
[-frequencythreshold <integer>] - Number of Drops Between Transmissions
Specifies the number of event notifications that must occur within the timethreshold
period before a repeat notification is sent.
[-timethreshold <integer>] - Dropping Interval (Seconds) Between Transmissions
If multiple notifications of an event occur within this many seconds, only the first
notification is sent. Multiple notifications will be sent during this time period only if the
frequencythreshold quantity is exceeded.
Examples
The following example modifies all RAID events to send messages to a destination
named "support.email", and specify that multiple messages should only be sent if and
event occurs more than five times within 60 seconds.
cluster1::> event route modify -messagename raid* -destinations support.email frequencythreshold 5 -timethreshold 60
See Also
event route add-destinations event route remove-destinations
event destination create
218
event route remove-destinations

Remove destination(s) from an event definition
level.
Description
The event route remove-destinations command can be used to remove
existing destinations from an event route. This command removes only the specified
destinations from the route, leaving any other destinations assigned to that route.
The named destinations are not deleted, just removed from the specified event route.
To delete a destination entirely, use the event destination delete command. To
show all existing destinations and their attributes, use the event destination show
command.
You can use extended queries with such parameters as -severity and -snmpsupport to specify multiple events that meet certain criteria. See examples provided
in the event route add-destinations command manpage that show how to use
extended queries.
Parameters
-destinations <Event Destination>, ... - Destinations
Specify a comma-separated list of destinations to remove from the event's list of
destinations.
Examples
The following example specifies that the destination named "mgr.email" should no
longer receive notifications of RAID events.
219
cluster1::> event route remove-destinations -messagename raid* -destinations

mgr.email
See Also
event destination delete event destination show event route add-destinations
220
event route show

Display event routes
level.
Description
This command displays information about event routes. Event routes describe which
events generate notifications. A route specifies what to watch for, whom to notify,
and what to do should a particular event occur. By default, the command displays the
following information:
Message name of the event
Severity of the event
Destinations for event notifications
Frequency threshold for event notifications
Time threshold for event notifications
To display detailed information about a specific event route, run the command with the
-messagename parameter, and specify the name of the message. The detailed view
adds the following information:
Full description of the event
Action to be taken to address the event
You can specify additional parameters to limit output to the information that matches
those parameters. For example, to display information only about events with a
message name that begins with "raid", run the command with the -messagename
raid* parameter. You can enter either a specific text string or a wildcard pattern.
Parameters
specify.
| [-instance ] }
221
about all fields.
Selects the event routes that match this parameter value.
Selects the event routes that match this parameter value. Valid values:
EMERGENCY - The system is unusable
ALERT - Action must be taken immediately
CRITICAL - Critical condition
ERROR - Error condition
WARNING - Warning condition
NOTICE - Normal but significant condition
INFORMATIONAL - Information message
DEBUG - Debugging message
[-action <text>] - Corrective Action
entered with wildcards. The "action" field describes what steps, if any, you must take to
remedy the situation.
entered with wildcards. The "description" field describes why the event was encountered
and what it means.
[-snmp-support {true|false}] - Supports SNMP trap
[-destinations <Event Destination>, ...] - Destinations
Selects the event routes that match this parameter value. A destination is a list of email
addresses, SNMP clients, and syslogs.
[-frequencythreshold <integer>] - Number of Drops Between Transmissions
Selects the event routes that match this parameter value (number of events since
previous notification).
222
[-timethreshold <integer>] - Dropping Interval (Seconds) Between Transmissions

Examples
The following example displays information about all event routes:
cluster1::> event route show
Freq
Message
Severity
Destinations
Time
Threshd Threshd
--------------------- --------- -------------- ------- ------admin.config.backup.

push.fail
ERROR
allevents,pager
120
admin.config.changed
INFO
allevents
unreachable
WARNING
allevents
admin.file.deleted
INFO
allevents
admin.login.failure
INFO
allevents
ERROR
criticals,allevents
INFO
allevents
INFO
allevents
INFO
allevents
NOTICE
allevents
ERROR
pager,admin
300
admin.config.url.
admin.software.
commit.failure
admin.software.
commit.success
admin.software.
committing
admin.software.
installed
aggrcopy.dst.
autoRestrictMsg
aggrcopy.dst.
noMemory
...
223
event snmphistory delete

Delete an SNMP trap history record
level.
Description
The event snmphistory delete command deletes an SNMP trap-history record.
To delete a record, you will need to know which node generated the event, and you will
need to know the sequence number of that event in the trap-history.
Use the event snmphistory show command to display a list of trap-history records
and their sequence numbers.
Parameters
Use this parameter to specify the name of the node that contains the snmp history
record to delete.
-seqnum <Sequence Number> - Sequence Number
Use this parameter to specify the sequence number of the SNMP trap-history record to
delete.
Examples
The following example deletes all SNMP trap-history records on node1:
cluster1::> event snmphistory delete -node node1 -seqnum *
See Also
event snmphistory show
224
event snmphistory show

Display a list of SNMP trap history records
level.
Description
The event snmphistory show command displays a list of event notifications that
have been sent to SNMP traps. The command output depends on the parameters
specified with the command. By default, the command displays general information
about all trap-history records.
To display detailed information about a specific trap-history record, run the command
with the -seqnum parameter.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the trap-history records that match this parameter value (text pattern).
[-seqnum <Sequence Number>] - Sequence Number
Selects the trap-history records that match this parameter value (sequence number).
Selects the trap-history records that match this parameter value.
[-address <text>, ...] - SNMP Client Address
Selects the trap-history records that match this parameter value (IP address).
[-time <MM/DD/YYYY HH:MM:SS>] - Transmission Time
225

[-message <text>] - Alert Message
Selects the trap-history records that match this parameter value (text pattern).
[-previous-time <MM/DD/YYYY HH:MM:SS>] - Previous Transmission Time
[-num-drops-since-previous <integer>] - Number of Drops Since Previous
Transmission
Selects the trap-history records that match this parameter value (number of event drops
since last transmission).
Examples
The following example displays information about all SNMP trap-history records:
cluster1::> event snmphistory show
Seq # Message Name
Address
Node
Time
----- --------------------- --------- ----- -----------------12481 raid.mirror.restrict
10.0.2.20 node0 4/14/2008 15:11:04
12482 aggrcopy.dst.noMemory 10.0.2.20 node0 4/14/2008 14:52:54

12483 raid.mirror.restrict
226
10.0.2.21 node1 4/14/2008 14:41:04
event status show

Display event status
level.
Description
The event status show command summarizes information about occurrences of
events. For detailed information about specific occurrences of events, use the event
log show command.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the event records that match this parameter value. Events are tracked on a
node-by-node basis, rather than being rolled up cluster-wide.
Selects the event records that match this parameter value. The message name is a
short descriptive string. Filtering output by message name displays messages of a
specific type.
[-indications <integer>] - Number of Indications
Selects the event records that match this parameter value. This parameter is most
useful when used with a range, such as using the range ">20" to display only events
that have been posted more than 20 times.
[-drops <integer>] - Number of Drops
Selects the event records that match this parameter value.
227
[-last-time-occurred <MM/DD/YYYY HH:MM:SS>] - Last Indication Time

[-last-time-dropped <MM/DD/YYYY HH:MM:SS>] - Last Suppressed Indication Time
[-last-time-processed <MM/DD/YYYY HH:MM:SS>] - Last Processed Indication Time
[-stat-starting-time <MM/DD/YYYY HH:MM:SS>] - Stat Starting Time
[-last-hour-histogram <integer>, ...] - 60-minute Histogram (privilege: advanced)
Use this parameter with the -fields parameter to display the "last hour" histogram
for each event type. The last hour histogram records the number of times each event
occurred in the last hour. The histogram is divided into sixty buckets, and each bucket
collects one minute's events. The buckets display with the most recent event first.
[-last-day-histogram <integer>, ...] - 24-hour Histogram (privilege: advanced)
Use this parameter with the -fields parameter to display the "last day" histogram
for each event type. The last day histogram records the number of times each event
occurred in the last day. The histogram is divided into 24 buckets, and each bucket
collects one hour's events. The buckets display with the most recent event first.
[-last-week-histogram <integer>, ...] - 7-day Histogram (privilege: advanced)
Use this parameter with the -fields parameter to display the "last week" histogram
for each event type. The last week histogram records the number of times each event
occurred in the last week. The histogram is divided into 7 buckets, and each bucket
collects one day's events. The buckets display with the most recent event first.
[-severity {NODE_FAULT|SVC_FAULT|NODE_ERROR|SVC_ERROR|WARNING|
NOTICE|INFO|DEBUG|VAR}] - Severity
Selects events that have the event severity you specify. Severity levels sort with the
most severe levels first. Severity levels:
NODE_FAULT - The node has detected data corruption, or is unable to provide
client service.
SVC_FAULT - The node has detected a temporary loss of service. Typically, this
is caused by a transient software fault.
NODE_ERROR - The node has detected a hardware error that is not immediately
fatal.
228
SVC_ERROR - The node has detected a software error that is not immediately
fatal.
WARNING - A high-priority message that does not indicate a fault.
NOTICE - A normal-priority message that does not indicate a fault.
INFO - A low-priority message that does not indicate a fault.
DEBUG - A debugging message. These messages are typically suppressed.
VAR - These messages have variable severity. Severity level for these messages
is selected at runtime.
The examples below illustrate how to query on severity.
Examples
The following example displays recent event-occurrence status for node1:
cluster1::> event status show -node node1
Node
Message
Occurs Drops Last Time
----------------- ---------------------------- ------ ----- ------------------node1
raid.spares.media_scrub.start
6
3/11/2010 15:59:00
3/11/2010 15:58:28
3/11/2010 15:58:29
3/11/2010 15:58:28
node1
raid.uninitialized.parity.vol
node1
raid.vol.state.online
node1
reg.defaultCommit.set.timeTaken
node1
scsitgt.ha.state.changed
3/11/2010 15:58:28
node1
ses.multipath.notSupported
3/11/2010 15:58:43
node1
shelf.config.mpha
3/11/2010 15:58:48
node1
sk.hog.runtime
3/11/2010 15:58:28
node1
snmp.agent.msg.access.denied 1
3/11/2010 15:58:28
node1
snmp.link.up
3/11/2010 15:58:28
node1
tar.csum.mismatch
3/11/2010 15:58:28
node1
tar.extract.success
3/11/2010 15:58:28
node1
vifmgr.lifsuccessfullymoved
3/11/2010 15:58:46
node1
vifmgr.portdown
3/11/2010 15:58:48
node1
vifmgr.portup
3/11/2010 15:58:48
node1
vifmgr.startedsuccessfully
3/11/2010 15:58:43
The following example displays a summary of events which are warnings or more
severe:
229
cluster1::> event status show -node node1 -severity <=warning -fields

indications,drops,severity
node
messagename
indications drops severity
------- ------------------------ ----------- ----- -------node1
api.output.invalidSchema 5463
840
WARNING
node1
callhome.dsk.config
WARNING
node1
callhome.sys.config
SVC_ERROR
node1
cecc_log.dropped
145
WARNING
node1
cecc_log.entry
WARNING
node1
cecc_log.entry_no_syslog 4540
218
WARNING
node1
cecc_log.summary
WARNING
node1
cf.fm.noPartnerVariable
5469
839
WARNING
node1
cf.fm.notkoverBadMbox
WARNING
node1
cf.fm.notkoverClusterDisable 1
WARNING
node1
cf.fsm.backupMailboxError 1
WARNING
node1
cf.takeover.disabled
23
WARNING
node1
cmds.sysconf.logErr
NODE_ERROR
node1
config.noPartnerDisks
NODE_ERROR
node1
fci.initialization.failed 2
NODE_ERROR
node1
fcp.service.adapter
WARNING
node1
fmmb.BlobNotFound
WARNING
node1
ha.takeoverImpNotDef
WARNING
node1
httpd.config.mime.missing 2
WARNING
node1
mgr.opsmgr.autoreg.norec 1
WARNING
node1
monitor.globalStatus.critical 1
NODE_ERROR
node1
raid.mirror.vote.versionZero 1
SVC_ERROR
node1
ses.multipath.notSupported 2
NODE_ERROR
node1
snmp.agent.msg.access.denied 1
WARNING
The above example makes use of several features which are common to all show
commands:
A query is specified for the severity parameter. A query restricts the output of the
show command; only rows matching the query will be displayed. In this case, the
query indicates that only events which have a severity of "WARNING" or more
severe will be displayed.
The fields parameter selects the fields to display. Note that the severity field is not
displayed in the default output.
See Also
230
event show-suppression event config modify event log show
231
232
job delete
Delete a job
Description
The job delete command deletes a job. Use the job show command to view a list
of running jobs that can be deleted.
Parameters
-id <integer> - Job ID
The numeric ID of the job you want to delete. A job ID is a positive integer.
[-vserver <vserver name>] - Owning Vserver
Use this parameter to specify the name of the Vserver that owns the job.
Examples
The following example deletes the job that has ID 99:
cluster1::> job delete -id 99
See Also
job show
233
job pause
Pause a job
Description
The job pause command pauses a job. Use the job resume command to resume
a paused job. Use the job show command to view a list of running jobs that can be
paused.
Parameters
The numeric ID of the job you want to pause. A job ID is a positive integer.
Examples
The following example pauses the job that has ID 183:
cluster1::> job pause -id 183
See Also
job resume job show
234
job resume
Resume a job
Description
The job resume command resumes a job that was previously paused by using the
job pause command. Use the job show command to view a list of paused jobs that
can be resumed.
Parameters
The numeric ID of the paused job to be resumed. A job ID is a positive integer.
Examples
The following example resumes the paused job that has ID 183:
cluster1::> job resume -id 183
See Also
job pause job show
235
job show-bynode
Display a list of jobs by node
Description
The job show-bynode command displays information about jobs on a per-node basis.
The command output depends on the parameters specified with the command. If no
parameters are specified, the command displays information about all jobs in the cluster
that are currently owned by a node.
To display detailed information about a specific job, run the command with the -id
parameter. The detailed view includes all of the default information plus additional items.
You can specify additional parameters to display only information that matches the
values you specify for those parameters. For example, to display information only about
jobs running on a specific node, run the command with the -node parameter.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display information only about the jobs that are associated with
the node you specify.
[-id <integer>] - Job ID
Use this parameter to display information only about the jobs that match the ID or range
of IDs you specify.
236
Use this parameter with the name of a Vserver to display only jobs that are owned by
that Vserver.
Use this parameter to display information only about the jobs that match the job name
you specify.
Use this parameter to display information only about the jobs that match the description
you specify.
[-affinity {Cluster|Node}] - Affinity
Use this parameter with an affinity value to display only jobs that match the affinity you
specify.
[-username <text>] - User Name
Use this parameter with a username to display only jobs that are associated with that
user.
Examples
The following example displays information about all jobs on a per-node basis:
node::> job show-bynode
Owning
Node
Job ID Name
Vserver
Affinity
-------------- ------ --------------- ---------- -------node0
1501
log-rotation
node-vserver
Cluster
Descr:logrotation job
node1
1498
log-rotation
node-vserver
Cluster
node2
1499
log-rotation
node-vserver
Cluster
node3
1500
log-rotation
node-vserver
Cluster
237
job show-cluster
Display a list of cluster jobs
Description
The job show-cluster command displays information about cluster-affiliated jobs.
parameters are specified, the command displays information about all cluster-affiliated
jobs.
You can specify additional parameters to display only information that matches the
values you specify for those parameters. For example, to display information only about
jobs running on a specific node, run the command with the -node parameter.
Parameters
specify.
| [-instance ] }
about all fields.
of IDs you specify.
that Vserver.
238
Use this parameter to display information only about the jobs that match the job name
you specify.
you specify.
[-priority {Low|Medium|High|Exclusive}] - Priority
Use this parameter to display information only about the jobs that match the priority you
specify.
[-node <nodename>] - Node
specify.
[-schedule <job_schedule>] - Schedule
Use this parameter to display information only about the jobs that run on the schedule
you specify.
[-queuetime <MM/DD HH:MM:SS>] - Queue Time
Use this parameter to display information only about the jobs that match the queue time
you specify.
[-starttime <MM/DD HH:MM:SS>] - Start Time
Use this parameter to display information only about the jobs that match the start time
you specify.
[-endtime <MM/DD HH:MM:SS>] - End Time
Use this parameter to display information only about the jobs that match the end time
you specify.
[-dropdeadtime <MM/DD HH:MM:SS>] - Drop-dead Time
Use this parameter to display information only about the jobs that match the final
timeout time you specify.
[-restarted {true|false}] - Restarted?
Use this parameter to display information only about the jobs that match the restart
value you specify.
239
[-state {Initial|Queued|Running|Waiting|Pausing|Paused|Quitting|Success|Failure|
Reschedule|Error|Quit|Dead|Unknown|Restart|Dormant}] - State
Use this parameter to display information only about the jobs that match the job state
you specify.
[-code <integer>] - Status Code
Use this parameter to display information only about the jobs that match the status code
you specify.
[-completion <text>] - Completion String
Use this parameter to display information only about the jobs that match the completion
text you specify.
[-jobtype <text>] - Job Type
Use this parameter to display information only about the jobs that match the job type
you specify.
[-category <text>] - Job Category
Use this parameter to display information only about the jobs that match the job
category you specify.
[-uuid <UUID>] - UUID
Use this parameter to display information only about the jobs that match the UUID you
specify.
Use this parameter with a username to display only jobs that are associated with the
user you specify.
Examples
The following example displays information about all cluster-affiliated jobs:
cluster1::> job show-cluster
Owning
Job ID Name
Vserver
Node
State
------ ---------------- --------- -------------- ----------305
Auto_Mirror
node-vserver
6202
mirror-03_10
node-vserver
Running
Queued
Descr:Auto mirror
240
6203
mirror-04_10
node-vserver
-
Queued
Descr:Auto mirror
6204
mirror-01_10
node-vserver
-
Queued
Descr:Auto mirror
6205
mirror-02_10
node-vserver
-
Queued
Descr:Auto mirror
6206
mirror-05_10
node-vserver
-
Queued
Descr:Auto mirror
241
job show-completed
Display a list of completed jobs
Description
The job show-completed command displays information about completed jobs. The
command output depends on the parameters you specify with the command. If you do
not use any parameters, the command displays information about all completed jobs.
You can specify additional parameters to display only information that matches those
parameters. For instance, to display information only about jobs running on a specific
node, run the command with the -node parameter.
Parameters
specify.
| [-instance ] }
about all fields.
of IDs you specify.
that Vserver.
Use this parameter to display information only about the jobs that match the name you
specify.
242

you specify.
Use this parameter to display information only about the jobs that match the priority you
specify.
specify.
If you use this parameter, the command displays information only about the jobs that
have the schedule you specify.
If you use this parameter, the command displays information only about the jobs that
have the queue time you specify.
Use this parameter to display information only about the jobs that have the start time
you specify.
Use this parameter to display information only about the jobs that have the end time you
specify.
Use this parameter to display information only about the jobs that time out at the time
you specify.
Use this parameter to display information only about the jobs that match the restart
value you specify.
243
Use this parameter to display information only about the jobs that match the job state
you specify.
Use this parameter to display information only about the jobs that match the status code
you specify.
Use this parameter to display information only about the jobs that match the completion
text you specify.
Use this parameter to display information only about the jobs that match the job type
you specify.
Use this parameter to display information only about the jobs that match the job
Use this parameter to display information only about the jobs that match the UUID you
specify.
Use this parameter with a username to display only jobs that are associated with that
user.
Examples
The following example displays information about all completed jobs:
node::> job show-completed
Owning
Job ID Name
Vserver
End Time
Code
Completion String
------ --------------- -------- -------------- ---------- -------------------305
Auto_Mirror
node-vserver
6202
mirror-03_10
node-vserver
6203
mirror-04_10
node-vserver
6204
mirror-01_10
node-vserver
10/10 08:07:05 0
Succeeded
10/10 11:10:07 0
10/10 12:10:09 0
10/10 09:10:03 0
244
6205
mirror-02_10
node-vserver
6206
mirror-05_10
node-vserver
10/10 10:10:08 0
10/10 05:10:04 0
245
job show
Display a list of jobs
Description
The job show command displays information about jobs. By default, the command
displays information about all current jobs.
parameter.
You can specify additional parameters to select information that matches the values
you specify for those parameters. For example, to display information only about jobs
running on a specific node, run the command with the -node parameter.
Parameters
specify.
| [-inprogress ]
Displays the job ID, the job name, the owning Vserver, and the progress of the job.
| [-jobstate ]
Displays information about each job's state, including the queue state, whether the job
was restarted, and when the job has completely timed out.
| [-sched ]
Displays the job ID, the job name, the owning Vserver, and the schedule on which the
job runs.
| [-times ]
Displays the job ID, the job name, the owning Vserver, the time when the job was last
queued, the time when the job was last started, and the time when the job most recently
ended.
246
| [-type ]
Displays the job ID, the job name, the job type, and the job category.
| [-jobuuid ] (privilege: advanced)
Displays the job ID, the job name, the owning Vserver, and the job UUID.
| [-instance ] }
about all fields.
Selects the jobs that match the ID or range of IDs that you specify.
Selects jobs that are owned by the specified Vserver.
Selects the jobs that match this parameter value.
247

[-uuid <UUID>] - UUID (privilege: advanced)
[-progress <text>] - Execution Progress
[-restart-is-delayed-by-module <text>] - Restart Is Delayed by Module
Selects jobs which are or were delayed by the specified module during the restart. For
example: MCC_SWITCHBACK
Examples
The following example displays information about all jobs on the node named node1:
cluster1::> job show -node node1
Owning
Job ID Name
Vserver
Node
State
------ ---------------- --------- ------------ ----------
248
308114 mirror-daily-3587206
node-vserver
node1
Running
Descr:Auto-replicate to 1 mirror(s)
node-vserver
node1
Running
node-vserver
node1
Queued
node-vserver
node1
Queued
249
job stop
Stop a job
Description
The job stop command stops a running job. A stopped job cannot be resumed. Use
the job pause command to pause a job so that you can later resume it. Use the job
show command to view a list of running jobs.
Parameters
The numeric ID of the job to stop. A job ID is a positive integer.
Examples
The following example stops the job that has ID 101:
cluster1::> job stop -id 101
See Also
job pause job show
250
job unclaim
Unclaim a cluster job
Description
The job unclaim command causes a cluster-affiliated job that is owned by an
unavailable node to be unclaimed by that node. Another node in the cluster can then
take ownership of the job. Use the job show-cluster command to obtain a list of
cluster-affiliated jobs.
Parameters
Use this parameter to specify the ID number of the job to unclaim.
Examples
The following example shows how to unclaim the cluster-affiliated job with the ID 27 that
is owned by the Vserver vs1:
cluster1::*> job unclaim -vserver vs1 -id 27
See Also
job show-cluster
251
job watch-progress
Watch the progress of a job
Description
The job watch-progress command displays the progress of a job, and periodically
updates that display. You can specify the frequency of the updates.
Parameters
Use this parameter to specify the numeric ID of the job to monitor.
[-interval <integer>] - Refresh Interval (seconds)
Use this parameter to specify the number of seconds between updates.
Examples
The following example show how to monitor the progress of the job that has ID 222 on
Vserver vs0. The progress display updates every 3 seconds.
cluster1::> job watch-progress -vserver vs0 -id 222 -interval 3
job history show

Display a history of jobs
Description
The job history show command displays a history of completed jobs with newer
entries displayed first. You can specify optional parameters to select information about
252
job history items that match only those parameters. For example, to display information
about jobs that were completed on February 27 at noon, run the command with endtime "02/27 12:00:00".
Parameters
specify.
| [-instance ] }
about all fields.
Selects the completed jobs that match this parameter value.
[-record <Sequence Number>] - Record ID
Selects the completed jobs that match the record ID or range of record IDs you specify.
Note that record IDs are unique for each node, not for the cluster as a whole. As a
result, there can be two records with the same record ID within the cluster.
Selects the completed jobs that are owned by the Vserver you specify.
Selects jobs that completed at the time you specify. This parameter is most useful when
used with a range of times.
Selects completed jobs that were started at the time you specify. This parameter is most
useful when used with a range of times.
253

Selects the completed jobs that match this parameter value. Each job defines its own
status codes. The completion text is more informative, but support technicians may
request this numeric code.
[-progress <text>] - Progress String
[-jobuuid <UUID>] - Job UUID (privilege: advanced)
[-event-type {Idle|Running|Succeeded|Failed|Paused|Stopped|Deleted|Error}] - Event
Type
[-event-time <MM/DD HH:MM:SS>] - Event Time
Selects the completed jobs that match this parameter value. This parameter is most
useful when used with a range of times.
[-error-code <integer>] - Job Manager Error Code
[-error-text <text>] - Job Manager Error Text
Examples
The following example displays information about all completed jobs:
cluster1::> job history show
Owning
Time
Node
Vserver
Name
Event
Job ID
-------------- -------------- ---------- -------------------- --------- -----08/23 08:58:24 node1
node1-vs
Vol Create
Succeeded
76
Description: Create testvol

Completion: Successful
254
08/23 08:58:22 node1
node1-vs
Vol Create
Running
76
Description: Create testvol

08/22 08:16:36 node1
node1-vs
CLUSTER BACKUP AUTO weekly

Succeeded
Description: Cluster Backup Job

08/22 08:15:49 node1
node1-vs

Running

08/22 08:15:08 node1
node1-vs

Idle

08/22 08:15:03 node1
node1-vs

Running

The following example shows how to use a range with the "endtime" parameter to select
only the events that ended between 8:15 and 8:16 on August 22nd.
cluster1::> job history show -endtime "08/22 08:15:00".."08/22 08:16:00"
Owning
Time
Node
Vserver
Name
Event
Job ID
-------------- -------------- ---------- -------------------- --------- -----08/22 08:15:49 node1
node1-vs

Running

08/22 08:15:08 node1
node1-vs

Idle

08/22 08:15:03 node1
node1-vs

Running

255
job initstate show

Display init state for job managers
privilege level.
Description
The job initstate show command displays information about the initialization
states of job-manager processes.
Parameters
specify.
| [-instance ] }
about all fields.
[-process <process_name>] - Process Name
[-initialized {true|false}] - Initialized?
Selects the nodes that match this parameter value (true means initialized; false
means not initialized).
[-cache-root <text>] - Cache Root
[-siteid <UUID>] - Site ID
[-hp-threads <integer>] - High Priority Threads
Selects the nodes that have the number of high-priority threads you specify.
256
[-mp-threads <integer>] - Medium Priority Threads

Selects the nodes that have the number of medium-priority threads you specify.
[-lp-threads <integer>] - Low Priority Threads
Selects the nodes that have the number of low-priority threads you specify.
[-tx-interval <integer>] - Transaction Interval
Selects the nodes that have the number of seconds you specify as their transaction
interval.
[-initmsg <text>] - Initialization Message
[-thread-initmsg <text>] - Thread Initialization Message
Selects the nodes that match this parameter value. The thread initialization message
contains information about thread status. If there is no information to communicate, this
message is empty.
[-recovery-enabled {true|false}] - Job Failover Enabled?
Selects the nodes that match this parameter value (true means enabled, false
means not enabled).
[-ex-threads <integer>] - Exclusive Priority Threads
Examples
The following example shows how to display general job-manager initialization-state
information for a cluster.
cluster1::*> job initstate show
HP
Node
Process
Init? Thr
MP
LP
EX
Thr
Thr
Thr
TX Int Failover?
----------------- ----------- ----- ---- ---- ---- ---- ------ --------node1
mgwd
true
300
true
node2
mgwd
true
300
true
The following example shows how to display detailed job-manager initialization-state

information for a node named node0.
cluster1::*> job initstate show -instance -node node0
257
Node: node0
Process Name: mgwd
Initialized?: true
Cache Root: /mroot/jm_cache
Site ID: 824e8f7d-f49-1d9-84af-00423b7352
High Priority Threads: 2
Medium Priority Threads: 3
Low Priority Threads: 5
Transaction Interval: 300
Initialization Message: Initialized
Are Threads Running?: Job Failover Enabled?: true
Exclusive Priority Threads: 8
258
job private delete

Delete a job
Description
The job private delete command deletes a private job. Private jobs are affiliated
with a specific node and do not use any cluster facilities, such as the replicated
database.
If you use this command on a job that does not support the delete operation, the
command returns an error message.
Use the job private show command to view a list of private jobs that can be
deleted.
Parameters
Use this parameter to specify the node with which the private job is associated.
Use this parameter to specify the numeric ID of the private job to be deleted. A job ID is
a positive integer.
Examples
The following example shows how to delete the job that has ID 273 from the node
named node2:
cluster1::*> job private delete -node node2 -id 273
See Also
job private show
259
job private pause

Pause a job
Description
The job private pause command pauses a private job. Private jobs are affiliated
with a specific node and do not use any cluster facilities, such as the replicated
database.
If you use this command to pause a job that does not support it, the command returns
an error message.
Use the job private resume command to resume a paused private job.
Use the job private show command to view a list of private jobs.
Parameters
Use this parameter to specify the node with which the private job is associated.
Use this parameter to specify the numeric ID of the paused private job to be paused. A
job ID is a positive integer.
Examples
The following example pauses the private job that has ID 99 on the node node1:
cluster1::*> jobs private pause -node node1 -id 99
See Also
job private resume job private show
260
job private resume

Resume a job
Description
The job private resume command resumes a private job that was paused by using
the job private pause command. Private jobs are affiliated with a specific node and
do not use any cluster facilities, such as the replicated database.
Use the job private show command to view a list of paused private jobs that can be
resumed.
Parameters
Use this parameter to specify the node with which the paused private job is associated.
Use this parameter to specify the numeric ID of the paused private job to be resumed. A
job ID is a positive integer.
Examples
The following example resumes the paused private job that has ID 99 on a node named
node2:
cluster1::*> job private resume -node node2 -id 99
See Also
job private pause job private show
261
job private show-completed

Display a list of completed jobs
Description
The job private show-completed command displays information about completed
private jobs. Private jobs are affiliated with a specific node and do not use any cluster
facilities, such as the replicated database.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display information only about completed jobs that are associated
with the node you specify.
Use this parameter to display information only about completed jobs that have the ID
you specify.
Use this parameter to display only completed jobs that are owned by the Vserver you
specify.
Use this parameter to display information only about completed jobs that have the name
you specify.
262
Use this parameter to display information only about completed jobs that have the
description you specify.
priority you specify.
schedule you specify.
queue time you specify.
Use this parameter to display information only about completed jobs that have the start
time you specify.
Use this parameter to display information only about completed jobs that have the end
time you specify.
Use this parameter to display information only about completed jobs that have the final
timeout time you specify.
restart value you specify.
Use this parameter to display information only about completed jobs that have the job
state you specify.
Use this parameter to display information only about completed jobs that have the status
code you specify.
263
completion text you specify.
type you specify.
Use this parameter to display information only about completed jobs that have the UUID
you specify.
Use this parameter to display information only about completed jobs that are associated
with the user you specify.
Examples
The following example shows how to display information about all completed private
jobs on the node named node1:
cluster1::*> job private show-completed -node node1
Node: node1
Owning
Job ID Name
Vserver
End Time
Code
Completion String
------ -------------- ---------- -------------- -------- --------------------1
sync task
node1
02/17 15:03:23 0
load_balancing node1
02/17 16:29:28 0
snap-hourly
node1
02/17 16:05:00 0
snap-daily
node1
02/17 00:10:00 0
snap-weekly
node1
02/13 00:15:00 0
Cross-Cluster Manager node1 02/17 16:27:27 0
reconcile service policy node1 02/17 15:03:12 0
DONE_VIF_STATS
complete
264
job private show

Display a list of jobs
Description
The job private show command displays information about private jobs. Private
jobs are affiliated with a specific node and do not use any cluster facilities, such as the
replicated database.
Parameters
specify.
| [-inprogress ]
Displays the job ID, name, owning Vserver, and progress of each private job.
| [-jobstate ]
Displays information about each private job's state, including the queue state, whether
the job was restarted, and when the job has timed out.
| [-jobuuid ]
Displays the ID, name, owning Vserver, and UUID of each private job.
| [-sched ]
Displays the job ID, name, owning Vserver, and run schedule of each private job.
| [-times ]
Displays the queue time, start time, and end time of each private job.
| [-type ]
Displays the type and category of each private job.
| [-instance ] }
265
about all fields.
Selects the private jobs that match this parameter value. .
Selects the private jobs that match the ID or range of IDs that you specify.
Selects the private jobs that match this parameter value.
266

Examples
The following example displays information about all private jobs on the local node:
cluster1::*> job private show -node local
Node: node1
Owning
Job ID Name
Vserver
State
------ -------------------- ---------- ----------3
snap-hourly
cluster1
Queued
Description: Auto-Snapshot
4
snap-daily
cluster1
Queued
5
snap-weekly
cluster1
Queued
6
sync task
cluster1
Queued
Description: sync task

7
ldap-certs
cluster1
Queued
Description: ldap resync

267
job private stop

Stop a job
Description
The job private stop command stops a running private job. A private job is a job
that is associated with a specific node and does not use cluster facilities. A stopped job
cannot be restarted.
Parameters
This specifies the node on which the job is running.
This specifies the numeric ID of the job that is to be stopped.
Examples
The following example stops a private job with the ID 416 on a node named node0:
cluster1::*> job private stop -node node0 -id 416
job private watch-progress

Watch the progress of a job
Description
The job private watch-progress command displays and periodically updates
the progress of a private job. A private job is a job that is associated with a specific
268
node and does not use cluster facilities. You can specify the frequency of the progress
updates.
Parameters
This specifies the node on which the job is running.
This specifies the numeric ID of the job whose progress is to be monitored.
Use this parameter to specify the Vserver with which the paused private job is
associated.Use this parameter to specify the name of the Vserver that owns the job.
[-interval <integer>] - Refresh Interval (seconds)
This optionally specifies, in seconds, the frequency of the updates.
Examples
The following example monitors the progress of the private job that has ID 127 on a
node named node1. The progress is updated every 2 seconds.
cluster1::*> job private watch-progress -node node1 -id 127 -interval 2
Queued
job schedule delete

Delete a schedule
level.
Description
The job schedule delete command deletes a schedule. Use the job schedule
show command to display all current schedules.
You cannot delete any schedules that are in use by jobs. Use the job schedule
show-jobs command to display jobs by schedule.
You cannot delete any schedules that are referenced by:
269
Volume Snapshot copy policy entries

SnapMirror entries
SIS policy entries
configuration backup settings
You must remove all references to a schedule before you can delete it. If you attempt to
delete a schedule that is referenced, an error message will list which entries reference
the schedule you want to delete. Use the show command for each of the items listed
by the error message to display which entries reference the schedule. You may need to
use the -instance parameter to display more detail.
Parameters
-name <text> - Schedule Name
Use this parameter with the name of an existing schedule to specify the schedule you
want to delete.
Examples
The following example deletes a schedule named overnightbackup:
cluster1::> job schedule delete -name overnightbackup
See Also
job schedule show job schedule show-jobs
270
job schedule show-jobs

Display the list of jobs by schedule
level.
Description
The job schedule show-jobs command displays information about jobs that are
associated with schedules.
Parameters
specify.
| [-instance ] }
about all fields.
[-name <text>] - Schedule Name
the schedule you specify.
[-affinity {Cluster|Node}] - Cluster / Node
Use this parameter to display information only about the jobs that match the affinity
value you specify.
[-owner <text>] - Owner
Use this parameter to display information only about the jobs that are owned by the
nodes you specify.
[-jobid <integer>] - ID
of IDs that you specify.
[-jobname <text>] - Job Name
271
Use this parameter to display information only about the jobs that match the name you
specify.
Examples
The following example shows information about schedules that are associated with jobs:
cluster1::> job schedule show-jobs
Name
Type
Owner
Job ID
Job Name
------------
--------- ---------------------
---------- --------------------
hourly
Cluster
98644
mirror-hourly
weeklylog
Node
node0
1501
log-rotation
weeklylog
Node
node1
1498
log-rotation
weeklylog
Node
node2
1499
log-rotation
weeklylog
Node
node3
1500
log-rotation
272
job schedule show

Display a list of available schedules
Description
The job schedule show command displays information about schedules.
Parameters
specify.
| [-instance ] }
about all fields.
[-name <text>] - Schedule Name
Selects the schedules that match this parameter value.
[-type {cron|interval|builtin}] - Schedule Type
Examples
The following example displays information about all cron schedules:
cluster1::> job schedule show -type cron
Name
Type
-----------
--------- -----------------------------------------------------
5min
cron
@:00,:05,:10,:15,:20,:25,:30,:35,:40,:45,:50,:55
daily
cron
@0:10
hourly
cron
@:05
midnightcron cron
Description
Sun@0:00
273
weekendcron
274
cron
Sun,Sat@3:15
job schedule cron create

Create a cron schedule
level.
Description
The job schedule cron create command creates a cron schedule. A cron
schedule, like a UNIX cron job, runs at a specified time. You can also specify months,
days of the month, or days of the week on which the schedule will run.
If you specify values for both days of the month and days of the week, they are
considered independently. For example, a cron schedule with the day specification
Friday, 13 runs every Friday and on the 13th day of each month, not just on every Friday
the 13th.
Parameters
-name <text> - Name
Use this parameter to specify the name of the interval schedule that you want to create.
[-month <cron_month>, ...] - Month
Use this parameter to specify months in which the schedule runs. Valid values are
January, February, March, April, May, June, July, August, September, October,
November, December, and all. Specify "all" to run the schedule every month.
[-dayofweek <cron_dayofweek>, ...] - Day of Week
Use this parameter to specify days of the week on which the schedule runs. Valid values
are Sunday, Monday, Tuesday, Thursday, Friday, and Saturday, and all. Specify "all" to
run the schedule every day.
[-day <cron_dayofmonth>, ...] - Day
Use this parameter to specify days of the month on which the schedule runs. Valid
values range from 1 to 31.
[-hour <cron_hour>, ...] - Hour
Use this parameter to specify the hours value of the time of day at which the schedule
runs. Valid values range from 0 (midnight) to 23 (11:00 p.m.). Specify "all" to run the
schedule every hour.
275
-minute <cron_minute>, ... - Minute

Use this parameter to specify the minutes portion of the time of day at which the
schedule runs. Valid values range from 0 to 59.
Examples
The following example creates a cron schedule named weekendcron that runs on
weekend days (Saturday and Sunday) at 3:00 a.m.
cluster1::> job schedule cron create -name weekendcron -dayofweek "Saturday,
Sunday" -hour 3 -minute 0
job schedule cron delete

Delete a cron schedule
level.
Description
The job schedule cron delete command deletes a cron schedule. Use the job
schedule cron show command to display all current cron schedules.
You cannot delete any cron schedules that are associated with jobs. Use the job
schedule show-jobs command to display jobs by schedule.
Parameters
-name <text> - Name
Use this parameter with the name of an existing cron schedule to specify the cron
schedule that you want to delete.
Examples
The following example deletes a cron schedule named midnightcron:
cluster1::> job schedule cron delete -name midnightcron
See Also
job schedule cron show job schedule show-jobs
276
job schedule cron modify

Modify a cron schedule
level.
Description
The job schedule cron modify command modifies a cron schedule. A cron
schedule, like a UNIX cron job, runs at a specified time. You can also specify months,
days of the month, or days of the week on which the schedule runs. Use the job
schedule cron show command to display all current cron schedules. See the
documentation for job schedule cron show for more information about how cron
schedules work.
Modifying one parameter of a cron schedule does not affect the other parameters. For
example, if cron schedule is set to run at 3:15 AM, and you modify the "hour" parameter
to 4, the schedule's new time will be 4:15am. To clear a parameter of the schedule's
interval, you must explicitly set that portion to "0" or "-" Some parameters can also be
set to "all".
Parameters
-name <text> - Name
Use this parameter with the name of an existing cron schedule to specify the cron
schedule you want to modify.
Use this parameter to specify a new "month" value for the cron schedule. Valid values
are January, February, March, April, May, June, July, August, September, October,
November, December, or all. Specify "all" to run the schedule every month.
Use this parameter to specify a new "day of week" value for the cron schedule. Valid
values include Sunday, Monday, Tuesday, Thursday, Friday, Saturday, or all. Specify
"all" to run the schedule every day.
Use this parameter to specify a new "day of month" value for the cron schedule. Valid
values range from 1 to 31.
277

Use this parameter to specify a new "hour of the day" value for the cron schedule. Valid
values range from 0 (midnight) to 23 (11:00 p.m.), Specify "all" to run the schedule every
hour.
[-minute <cron_minute>, ...] - Minute
Use this parameter to specify a new "minute of the hour" value for the cron schedule.
Valid values range from 0 to 59.
Examples
The following example modifies a cron schedule named weekendcron so that it runs at
3:15 a.m.:
cluster1::> job schedule cron modify -name weekendcron -hour 3 -minute 15
See Also
job schedule cron show
278
job schedule cron show

Show cron schedules
Description
The job schedule cron show command displays information about cron schedules.
A cron schedule runs a job at a specified time on specified days.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the cron schedules that match this parameter value.
Selects the cron schedules that match this parameter value. Valid values are January,
February, March, April, May, June, July, August, September, October,
November, December, or all.
Selects the cron schedules that match this parameter value. Valid values include
Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, or all.
Selects the cron schedules that match this parameter value. Valid values range from 1
to 31.
279
[-minute <cron_minute>, ...] - Minute

Selects the cron schedules that match the minute or range of minutes that you specify.
Examples
The following example displays information about all current cron schedules:
cluster1::> job schedule cron show
Name
Description
----------------
-----------------------------------------------------
weekendcron
Sun,Sat@3:15
The following example displays information about the cron schedule named
weekendcron:
cluster1::> job schedule cron show -name weekendcron
Name: weekendcron
Month: Day of Week: Sunday, Saturday
Day: Hour: 3
Minute: 15
Description: Sun,Sat@3:15
280
job schedule interval create

Create a schedule that runs on an interval
level.
Description
The job schedule interval create creates an interval schedule. An interval
schedule runs jobs at specified intervals after the previous job finishes. For instance, if
a job uses an interval schedule of 12 hours and takes 30 minutes to complete, the job
runs at the following times:
Day one at 8:00 a.m. (the job's initial run)
Day one at 8:30 p.m.
Day two at 9:00 a.m.
Day two at 9:30 p.m.
Each of the numerical parameters of the interval must be a whole number. These
parameters can be used individually, or combined to define complex time values. For
example, use a value of 1 day, 12 hours to create an interval of 1.5 days.
Large parameter values are converted into larger units. For example, if you create a
schedule with an interval of 36 hours, the job schedule interval show command
will display it with an interval of 1 day 12 hours.
Parameters
-name <text> - Name
Use this parameter to specify the name of the interval schedule you want to create.
[-days <integer>] - Days
Use this parameter to specify the "days" portion of the schedule's interval. A day is one
calendar day.
[-hours <integer>] - Hours
Use this parameter to specify the "hours" portion of the schedule's interval.
[-minutes <integer>] - Minutes
281
Use this parameter to specify the "minutes" portion of the schedule's interval.
[-seconds <integer>] - Seconds
Use this parameter to specify the "seconds" portion of the schedule's interval.
Examples
The following example creates an interval schedule named rollingdaily that runs six
hours after the completion of the previous occurrence of the job:
cluster1::> job schedule interval create -name rollingdaily -hours 6
See Also
job schedule interval show
282
job schedule interval delete

Delete an interval schedule
level.
Description
The job schedule interval delete command deletes an interval schedule.
Use the job schedule interval show command to display all current interval
schedules.
You cannot delete interval schedules that are currently being run. Use the job
schedule show-jobs command to display jobs by schedule.
Parameters
-name <text> - Name
Use this parameter with the name of an existing interval schedule to specify the interval
schedule you want to delete.
Examples
The following example deletes an interval schedule named rollingdaily:
cluster1::> job schedule interval delete -name rollingdaily
See Also
job schedule interval show job schedule show-jobs
283
job schedule interval modify

Modify an interval schedule
level.
Description
The job schedule interval modify command modifies an interval schedule. An
interval schedule runs jobs at a specified interval after the previous job finishes. Use the
job schedule interval show command to display all current interval schedules.
See the documentation of job schedule interval show for more information on
how interval schedules work.
Modifying one parameter of a schedule's interval does not affect the other parameters.
For example, if a schedule's interval is 1 day 12 hours, and you modify the "hours"
parameter to 16, the schedule's new interval is 1 day 16 hours. To clear a parameter of
the schedule's interval, you must explicitly set that parameter to "0" or "-".
Parameters
-name <text> - Name
Use this parameter with the name of an existing interval schedule to specify the interval
schedule you want to modify.
Use this parameter to specify a different "days" value for the schedule's interval.
Use this parameter to specify a different "hours" value for the schedule's interval.
Use this parameter to specify a different "minutes" value for the schedule's interval.
Use this parameter to specify a different "seconds" value for the schedule's interval.
Examples
The following example sets the schedule named rollingdaily to run every eight hours:
cluster1::> job schedule interval modify -name rollingdaily -hours 8
284
See Also
285

Show interval schedules
Description
The job schedule interval show command displays information about interval
schedules.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the interval schedules that match this parameter value.
Selects the interval schedules that match the day value or range of values you specify.
Selects the interval schedules that match the hour value or range of values you specify.
Selects the interval schedules that match the minute value or range of values you
specify.
Selects the interval schedules that match the second value or range of values you
specify.
286
Selects the interval schedules that match the description you specify.
Examples
The following example displays information about all interval schedules:
cluster1::> job schedule interval show
Name
Description
----------------
-----------------------------------------------------
rollingdaily
Every 8h
287
lun create
Create a new LUN
Description
This command creates a new LUN of a specific size. You cannot create a LUN at a path
that already exists. You must create LUNs at the root of a volume or qtree. You can not
create LUNs in the Vserver root volume.
You might find it useful to provide a meaningful path name for the LUN and containing
volume. For example, you might choose a name that describes how the LUN is used,
such as the name of the application, the type of data that it stores, or the user accessing
the data. Examples are /vol/database/lun0, /vol/finance/lun1, and /vol/bill/lun2.
It is recommended that you distribute LUNs across the cluster.
When you can create a LUN, the size of the LUN could be larger than what you
specified. The system generates a message if the size of the LUN is different from what
you specified.
By default, when you create a LUN, it is online and it is space-reserved. Use the lun
offline command to take a LUN offline. When you set space reserved to false, the
LUN is thinly provisioned.
Note:
When you thinly provision a LUN, write operations to that LUN might fail due to
insufficient disk space. As a result, the host application or operating system might crash.
Note:
When you create a LUN from a file, that file cannot be deleted without deleting the LUN
itself.
Note:
This command is not supported for a Vserver with Infinite Volume.
Parameters
288
-vserver <Vserver Name> - Vserver Name

Specifies the Vserver.
{ -path <path> - LUN Path
Specifies the path of the new LUN. The LUN path cannot contain any files. Examples of
correct LUN paths are /vol/vol1/lun1 and /vol/vol1/qtree1/lun1.
| -volume <volume name> - Volume Name
Specifies the volume that contains the new LUN.
[-qtree <text>] - Qtree Name
Specifies the qtree that contains the new LUN.
-lun <text> } - LUN Name
Specifies the new LUN name. A LUN name is a case-sensitive name and has the
following requirements:
Must contain one to 255 characters. Spaces are not allowed.
Can contain the letters A-Z, a-z, numbers 0-9, "-", "_", "}", "{", and ".".
{ -size | -s <size> - LUN Size
Specifies the size of the LUN in bytes. You can specify a one-character multiplier suffix:
c (1 byte)
w (2 bytes)
B (512 bytes)
k (1024 bytes)
M (k*k bytes)
G (k*m bytes)
T (m*m bytes)
| -file-path | -f <text> - File Path
Creates a LUN using the file path as the source.
| [-foreign-disk <text>] } - Foreign Disk Serial number (privilege: advanced)
LUN is created with the same attributes (size, alignment, bytes per sector and so on) as
the specified foreign disk.
[-prefix-size | -P <size>] - Prefix Size (privilege: advanced)
289
Specifies the size of the prefix stream for the new LUN.
-ostype | -t <os_enum> - OS Type
Specifies the OS type for the new LUN. The OS types are:
aix - the LUN stores AIX data.
hpux - the LUN stores HP-UX data.
hyper_v - the LUN stores Windows Server 2008 or Windows Server 2012 Hyper-V
data
linux - the LUN stores a Linux raw disk without a partition table.
netware - the LUN stores NetWare data.
openvms - the LUN stores Open-VMS data
solaris - the LUN stores Solaris raw disk in a single-slice partition.
solaris_efi - the LUN stores Solaris_EFI data.
vmware - the LUN stores VMware data
windows - the LUN stores a raw disk type in a single-partition Windows disk using
the Master Boot Record (MBR) partitioning style.
windows_gpt - the LUN stores Windows data using the GUID Partition Type
(GPT) partitioning style.
windows_2008 - the LUN stores Windows data for Windows 2008 and 2012
systems.
xen - the LUN stores Xen data
[-space-reserve {enabled|disabled}] - Space Reservation
Specifies whether the space reservation setting is enabled or disabled for the new LUN.
If you set the parameter to enabled, the LUN is space-reserved. If you set the parameter
to disable, the LUN is thinly provisioned. The default is enabled.
[-comment <text>] - Comment
A description for the LUN you want to create. If the comment string contains white
space, you must enclose the comment string in double quotes. The limit is 254
characters.
[-space-allocation {enabled|disabled}] - Space Allocation
Specifies whether space allocation is enabled or disabled for a LUN. If you set this
parameter to enabled, space allocation is enabled and provisioning threshold events
for the LUN are reported. If you set this parameter to disabled, space allocation is not
290
enabled and provisioning threshold events for the LUN are not reported. The default is
disabled.
[-class {regular|protocol-endpoint|vvol}] - Class
Specifies the class of the new LUN. The class types are:
regular - the LUN is for normal blocks protocol access. This is the default value.
protocol-endpoint - the LUN is a vvol protocol endpoint.
vvol - the LUN is a vvol data LUN.
[-qos-policy-group <text>] - QoS Policy Group
This optionally specifies which QoS policy group to apply to the LUN. This policy group
defines measurable service level objectives (SLOs) that apply to the storage objects
with which the policy group is associated. If you do not assign a policy group to a LUN,
the system will not monitor and control the traffic to it.
Note:
If you specify this parameter for a LUN that you want to create from a file and that file
belongs to a QoS policy group, Data ONTAP adds the LUN to the specified policy group
and removes the file from its policy group. Both the file and the LUN that you created
from the file cannot belong to QoS policy groups.
Examples
cluster1::> lun create -vserver vs1 -path /vol/vol1/lun1 -size 100M -ostype linux
Creates a 100MB LUN at path /vol/vol1/lun1 in Vserver vs1. The OS type is Linux, and
the state is online.
See Also
lun offline
291
lun delete
Delete the LUN
Description
This command deletes a LUN from a specified Vserver and volume. If the LUN is
mapped and online, the force option is required to delete it.
If a LUN is mapped to an initiator group, you can unmap it by using the lun unmap
command. If a LUN is online, you take it offline by using the lun offline command.
Note:
If you create a LUN from a file, you cannot remove the file while the LUN is linked to
it. If you want to remove the file, you must first delete the LUN. This command is not
supported for a Vserver with Infinite Volume.
Parameters
Specifies the path of the LUN you want to delete. Examples of correct LUN paths are /
vol/vol1/lun1 and /vol/vol1/qtree1/lun1.
Specifies the volume that contains the LUN you want to delete.
Specifies the qtree that contains the LUN you want to delete.
Specifies the LUN that you want to delete.
[-force | -f [true]] - Force Deletion of an Online and Mapped LUN
Force deletion of an online LUN that is mapped to an initiator group.
292
[-force-fenced [true]] - Force Deletion of a Fenced LUN

Force deletion of a LUN that is currently fenced.
Examples
cluster1::> lun delete -vserver vs1 -path /vol/vol1/lun1
Deletes the LUN at path /vol/vol1/lun1 on Vserver vs1.
See Also
lun unmap lun offline
293
lun maxsize
Display the maximum possible size of a LUN on a given volume or qtree.
Description
This command returns the maximum size of LUNs for different OS types in a volume
or qtree. The command also includes possible maximum size for LUNs with Snapshots
or without Snapshots. You can specify the path of the volume or qtree to determine the
maximum size of a LUN that you want to create within that volume or qtree.
If you do not specify a path, the command returns the maximum LUN size for each OS
type for all volumes and qtrees in a cluster.
The available space in a volume can change over time which means that the size
reported by lun maxsize can change as well. In addition, the maximum LUN size
allowed in a lun resize command may be less than the size reported by lun
maxsize.
Note:
Parameters
specify.
| [-instance ] }
about all fields.
[-vserver <Vserver Name>] - Vserver Name
{ [-path <qtree path>] - Volume or Qtree Path
294
Specifies the path of the root volume or qtree. Examples of correct LUN paths are /vol/
vol1/lun1 and /vol/vol1/qtree1/lun1.
| [-volume <volume name>] - Volume Name
Specifies the volume that contains the LUN you want to get the maximum size for.
[-qtree <qtree name>] } - Qtree Name
Specifies the qtree that contains the LUN you want to get the maximum size for.
[-ostype | -t <os_enum_ui>] - OS Type
Specifies OS type of the LUN. The OS types are:
hyper_v - the LUN stores Windows Server 2008 or Windows Server 2012 Hyper-V
data
windows - the LUN stores a raw disk type in a single-partition Windows disk using
the Master Boot Record (MBR) partitioning style.
systems.
[-complete-ss-reserve <size>] - With Complete Snapshot Reserve
Shows the maximum size possible of a LUN if you have the complete Snapshot reserve
enabled.
[-ss-reserve <size>] - With Snapshot Reserve
Shows the maximum size possible of a LUN if you have the Snapshot reserve enabled.
295
[-without-ss-reserve <size>] - Without Snapshot Reserve

Shows the maximum size possible of a LUN if you have no Snapshot reserve enabled.
Examples
cluster1::> lun maxsize -volume vol0 -ostype netware
Virtual
Server
Without
Volume
Qtree
OS Type
With SS
SS Reserve Reserve
Complete
SS Reserve
---------- ------------ ------------ -------- ---------- --------- ---------vs0
vol0
""
netware
45MB
45MB
45MB
With SS
Complete
Displays the maximum size of a LUN for the OS type netware.

cluster1::> lun maxsize
Without
Vserver
Volume
Qtree
OS Type
SS Reserve
Reserve SS Reserve
---------- ------------ ------------ -------- ---------- --------- ---------vs1
vol1
""
hyper_v
172.6MB
172.6MB
172.6MB
windows_2008
172.6MB
172.6MB
172.6MB
windows_gpt 172.6MB
172.6MB
172.6MB
windows
172.6MB
172.6MB
172.6MB
linux
178MB
178MB
178MB
xen
178MB
178MB
178MB
solaris
178MB
178MB
178MB
solaris_efi
178MB
178MB
178MB
hpux
178MB
178MB
178MB
aix
178MB
178MB
178MB
netware
178MB
178MB
178MB
openvms
178MB
178MB
178MB
Displays the maximum size of LUNs for all OS types on volume vol1.
See Also
lun resize
296
lun modify
Modify a LUN
Description
This command modifies LUN attributes. Because LUN modifications can result in data
corruption or other problems, we recommend that you call technical support if you are
unsure of the possible consequences of modifying a LUN.
Note:
Parameters
Specifies the path for the LUN you want to modify. Examples of correct LUN paths are /
Specifies the volume for the LUN you want to modify.
-qtree <text> - Qtree Name
Specifies the qtree for the LUN you want to modify.
Specifies the name for the LUN you want to modify. A LUN name is a case-sensitive
name and has the following requirements:
Can contain the letters A through Z, a through z, numbers 0 through 9, hyphen (-),
underscore (_), right bracket (}), left bracket ({) and period (.).
Must start with a letter or number.
297

Specifies whether the space reservation setting is enabled or disabled for a LUN. If you
set the parameter to enabled, the LUN is space-reserved. If you set the parameter to
disable, the LUN is thinly provisioned. The default is enabled.
[-serial <text>] - Serial Number
Specifies the serial number for the LUN you want to modify.
Specifies the comment for the LUN you want to modify.
Specifies whether space allocation is enabled or disabled for a LUN. If you set this
parameter to enabled, space allocation is enabled and provisioning threshold events
for the LUN are reported. If you set this parameter to disabled, space allocation is not
enabled and provisioning threshold events for the LUN are not reported. The default is
disabled.
[-state {online|offline|nvfail|space-error|foreign-lun-error}] - State
Specifies the administrative state of a LUN. The options are:
online
offline
{ [-device-legacy-id <integer>] - Device Legacy ID
Specifies the device legacy ID for the LUN you want to modify.
| [-device-binary-id <text>] - Device Binary ID
Specifies the device binary ID for the LUN you want to modify.
| [-clear-binary-id [true]] } - Clear Device Binary ID
Clears the binary format of the optional device ID.
{ [-device-text-id <text>] - Device Text ID
Specifies the device text ID for the LUN you want to modify.
| [-clear-text-id [true]] } - Clear Device Text ID
Clears the text format of the optional device ID.
This optionally specifies which QoS policy group to apply to the lun. This policy group
defines measurable service level objectives (SLOs) that apply to the storage objects
298
with which the policy group is associated. If you do not assign a policy group to a lun,
the system will not monitor and control the traffic to it. To remove this lun from a policy
group, enter the reserved keyword "none".
Examples
cluster1::> lun modify -path /vol/vol1/lun1 -space-reserve disable
Disables the space reserve attribute for LUN /vol/vol1/lun1.

cluster1::> lun modify -path /vol/vol1/lun1 -state offline
Takes the LUN /vol/vol1/lun1 offline.

cluster1::> lun modify -path /vol/vol1/lun1 -comment "new comment"
Adds the comment "new comment" to the LUN /vol/vol1/lun1.
299
lun move-in-volume
Move a LUN within a volume
Description
This command moves a LUN to a new path in the same volume or renames a LUN.
If you are organizing LUNs in a qtree, the command moves a LUN from one qtree to
another. You can perform a LUN move while the LUN is online and serving data. The
process is non-disruptive. Use the lun move start command to move a LUN to a
different volume within the same Vserver.
Note:
Parameters
Specifies the path of the LUN you want to move. Examples of correct LUN paths are /
Specifies the volume of the LUN you want to move.
Specifies the qtree of the LUN you want to move.
Specifies the name of the LUN that you want to move.
{ -new-path <path> - New LUN Path
Specifies the new path of the LUN. Examples of correct LUN paths are /vol/vol1/lun1
and /vol/vol1/qtree1/lun1.
300
| [-new-qtree <text>] - New Qtree Name

Specifies the new qtree name that you want to move the LUN to.
-new-lun <text> } - New LUN Name
Specifies the new name of the LUN.
Examples
cluster1::> lun move-in-volume -vserver vs1 -volume vol1 -lun lun1 -new-lun
newlun1
Renames lun1 to newlun1 on Vserver vs1 and volume vol1.

cluster1::> lun show -vserver vs1 -volume vol1
Vserver
Path
State
Mapped
Type
Size
--------- ------------------------------- ------- -------- -------- -------vs1
/vol/vol1/A/lun1
online
mapped
linux
10MB
cluster1::> lun move-in-volume -vserver vs1 -path /vol/vol1/A/lun1 -new-path /

vol/vol1/B/lun1
Vserver
Path
State
Mapped
Type
Size
--------- ------------------------------- ------- -------- -------- -------vs1
/vol/vol1/B/lun1
online
mapped
linux
10MB
Moves LUN lun1 from qtree A to qtree B on volume vol1.
See Also
lun move start
301
lun resize
Changes the size of the LUN to the input value size.
Description
This command resizes a LUN. You can resize a LUN that is mapped and online.
However, to prevent any potential problems, take the LUN offline before resizing it.
When you reduce the size of the LUN, the data in the LUN could be truncated. You
will receive an error message if you reduce the size of the LUN. To avoid this error
message, use the force parameter.
When you increase the size of a LUN, the maximum resize size is based on the initial
geometry of the LUN and the currently available space in the volume. You will receive
an error message if you exceed this limit. The lun show -instance command reports
the "Maximum Resize Size" for a LUN based on the initial geometry. The lun maxsize
command reports the maximum LUN size based on the available space. The maximum
size of the LUN is the smaller of the two limits issued by the lun show -instance
command or the lun maxsize command.
Note:
Parameters
Specifies the path of the LUN that you want to resize. Examples of correct LUN paths
are /vol/vol1/lun1 and /vol/vol1/qtree1/lun1.
Specifies the volume that contains the LUN that you want to resize.
Specifies the qtree that contains the LUN that you want to resize.
302

Specifies the LUN name that you want to resize.
[-force | -f [true]] - Force Reduce LUN Size
Overrides any warnings if you are reducing the size of the LUN. If you use this
parameter without a value, it is set to true, and the command does not prompt you when
reducing the size of a LUN would produce warnings. If you do not use this parameter,
the command displays an error if reducing the size of a LUN would create a problem.
[-size <size>] - New Size
Specifies the new size of the LUN.
c (1 byte)
w (2 bytes)
B (512 bytes)
k (1024 bytes)
M (k*k bytes)
G (k*m bytes)
T (m*m bytes)
Examples
cluster1::> lun resize -vserver vs1 -path /vol/vol1/lun1 -size 500M -force
Resizes LUN /vol/vol1/lun1 on Vserver vs1 to 500M, overriding all warnings.

cluster1::> lun resize -vserver vs1 -path /vol/vol1/lun1 -size +5m
Vserver
Path
State
Mapped
Type
Size
--------- ------------------------------- ------- -------- -------- -------vs1

/vol/vol1/lun1
online
mapped
linux
15MB
Adds 5M of space to LUN /vol/vol1/lun1 for a total of 15MB.

cluster1::> lun resize -vserver vs1 -path /vol/vol1/lun1 -size -10m
303
Error: command failed: Reducing LUN size without coordination with the host
system
may cause permanent data loss or corruption. Use the force flag to allow
LUN size reduction.
cluster1::> lun resize -path /vol/vol1/lun1 -size -5m -f
Vserver
Path
State
Mapped
Type
Size
--------- ------------------------------- ------- -------- -------- -------vs1

/vol/vol1/lun1
online
mapped
linux
10MB
Resizes the LUN /vol/vol1/lun1 from 15MB to 10MB, overriding all warnings.
See Also
lun show lun maxsize
304
lun show
Display a list of LUNs
Description
The command displays information for LUNs. Use the instance option to display
additional LUN details, such as serial number and space-reservation settings.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the LUNs that match this parameter value.
{ [-path <path>] - LUN Path
Selects the LUNs that match this parameter value. Examples of correct LUN paths are /
[-lun <text>] } - LUN Name
[-size | -s <size>] - LUN Size
305
[-prefix-size | -P <size>] - Prefix Size (privilege: advanced)

Selects the LUNs that match the prefix stream size that you specify.
[-ostype | -t <os_enum>] - OS Type
Selects the LUNs that match this parameter value. The OS types are:
hyper_v - the LUN stores Windows Server 2008 or Windows Server 2012 HyperV data
windows - the LUN stores a raw disk type in a single-partition Windows disk
using the Master Boot Record (MBR) partitioning style.
systems.
Selects the LUNs that match this parameter value. If true, the LUN is space-reserved.
If false, the LUN is thinly provisioned. The default is true.
[-space-reserve-honored {true|false}] - Space Reservations Honored
306
Selects the LUNs that match this parameter value. A value of true displays the LUNs
that have space reservation honored by the container volume. A value of false
displays the LUNs that are thinly provisioned.
Selects the LUNs that match this parameter value. If you set this parameter to
enabled, space allocation is enabled and provisioning threshold events for the LUN are
reported. If you set this parameter to disabled, space allocation is not enabled and
provisioning threshold events for the LUN are not reported.
[-state {online|offline|nvfail|space-error|foreign-lun-error}] - State
Selects the LUNs that match this parameter value. The states are:
online - the LUN is online.
offline - the LUN is administratively offline, or a more detailed offline reason is
not available,
foreign-lun-error - the LUN has been automatically taken offline due to a
media error on the associated foreign LUN.
nvfail - the LUN has been automatically taken offline due to an NVRAM failure.
space-error - the LUN has been automatically taken offline due to insufficient
space.
[-uuid <UUID>] - LUN UUID
[-mapped {mapped|unmapped}] - Mapped
Selects the LUNs that match this parameter value. A value of mapped selects the LUNs
that are mapped to an initiator group.
[-block-size <size>] - Block Size
[-device-legacy-id <integer>] - Device Legacy ID
[-device-binary-id <text>] - Device Binary ID
[-device-text-id <text>] - Device Text ID
307
[-read-only {true|false}] - Read Only

[-restore-inaccessible {true|false}] - Fenced Due to Restore
Selects the LUNs that match the state you specify. A value of true means that a LUN is
fenced for I/O and management due to a restore operation.
[-size-used <size>] - Used Size
[-max-resize-size <size>] - Maximum Resize Size
[-creation-timestamp <MM/DD/YYYY HH:MM:SS>] - Creation Time
[-class {regular|protocol-endpoint|vvol}] - Class
[-node <nodename>] - Node Hosting the LUN
A policy group defines measurable service level objectives (SLOs) that apply to the
storage objects with which the policy group is associated. If you do not assign a policy
group to a lun, the system will not monitor and control the traffic to it.
[-is-clone {true|false}] - Clone
[-is-clone-autodelete-enabled {true|false}] - Clone Autodelete Enabled
[-inconsistent-import {true|false}] - Inconsistent import
Selects the LUNs that match this parameter value. A value of true means that the data
in the LUN is inconsistent because of an active or aborted import relationship.Selects
the LUNs that match this parameter value. A value of true means that the import of this
LUN is incomplete.
[-serial-7-mode <text>] - 7-mode Serial Number (privilege: advanced)
308
LUNs transitioned from Data ONTAP 7-Mode are assigned new serial numbers for use
with Clustered Data ONTAP. The original 7-Mode serial number is displayed in this field
for reference.
Examples
cluster1::> lun show -vserver vs0 -path /vol/vol1/lun1 -instance
Vserver Name: vs0
LUN Path: /vol/vol1/lun1
Volume Name: vol1
Qtree Name: ""
LUN Name: lun1
LUN Size: 10MB
OS Type: linux
Space Reservation: disable
Serial Number: 1k/wc+9Cpbls
Comment: new comment
Space Reservations Honored: true
Space Allocation: disable
State: offline
LUN UUID: 6435dcaa-e360-11df-aa84-00a0980cb0eb
Mapped: unmapped
Block Size: 512.00B
Device Legacy ID: Device Binary ID: Device Text ID: Read Only: false
Used Size: 0.00B
The example above dislays details of the LUN at path /vol/vol1/lun1 in Vserver vs0.
cluster1::> lun show -serial 1r/wc+9Cpbls
Vserver
Path
State
Mapped
Type
Size
--------- ------------------------------- ------- -------- -------- -------vs1
/vol/vol1/linux
offline mapped
linux
10MB
The example above displays information for the LUN with serial number 1r/wc+9Cpbls.
309

Vserver
Path
State
Mapped
Type
Size
--------- ------------------------------- ------- -------- -------- -------vs1
/vol/vol1/linux
offline mapped
linux
vs1
/vol/vol1/windows
online
windows
mapped
10MB
47.07MB
The example above displays all the LUNs on Vserver vs1 and volume vol1.
310
lun bind create

Bind a VVol LUN to a protocol endpoint
Description
This command creates a new binding between a protocol endpoint and a vvol LUN. If a
binding between the specified endpoint and vvol already exists, the reference count for
the binding is incremented by one.
Note:
For optimal results, the protocol endpoint and vvol must be hosted by the same node in
the cluster.
Parameters
-vserver <Vserver Name> - Vserver name
Specifies the name of the Vserver.
-protocol-endpoint-path <path> - Protocol Endpoint
Specifies the path to the protocol endpoint. The specified LUN must already exist and
be of class "protocol-endpoint". Examples of correct LUN paths are /vol/vol1/lun1 and /
vol/vol1/qtree1/lun1.
-vvol-path <path> - VVol Path
Specifies the path to the vvol. The specified LUN must already exist and be of the class
"vvol". Examples of correct LUN paths are /vol/vol1/lun1 and /vol/vol1/qtree1/lun1.
Examples
cluster1::*> lun bind create -vserver vs1 -protocol-endpoint-path /vol/VV1/PE1 vvol-path /vol/VV3/234ace
Bind the vvol /vol/VV3/234ace to the protocol endpoint /vol/VV1/PE1 in Vserver vs1.
311
lun bind destroy

Unbind a VVol LUN from a protocol endpoint
Description
Decrement the reference count of the binding between a protocol endpoint and vvol
LUN. If the resulting reference count is zero, the binding is removed.
Parameters
-vserver <Vserver Name> - Vserver name
-protocol-endpoint-path <path> - Protocol Endpoint
Specifies the path of the protocol endpoint LUN. Examples of correct LUN paths are /
-vvol-path <path> - VVol Path
Specifies the path of the vvol LUN. Examples of correct LUN paths are /vol/vol1/lun1
and /vol/vol1/qtree1/lun1.
[-force [true]] - If true, unbind the Vvol completely even if the current reference count is
greater than 1. The default is false.
Completely remove the specified binding, regardless of the current reference count.
Examples
cluster1::*> lun bind destroy -protocol-endpoint-path /vol/VV2/PE2 -vvol-path /
vol/VV2/30dfab -vserver vs1
Remove the binding between the vvol /vol/VV2/30dfab and the protocol endpoint /vol/
VV2/PE2 on Vserver vs1.
312
lun bind show

Show list of Vvol bindings
Description
Shows the configured VVol to protocol endpoint bindings.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the bindings that match this parameter value.
[-protocol-endpoint-msid <integer>] - PE MSID
[-protocol-endpoint-vdisk-id <text>] - PE Vdisk ID
[-vvol-msid <integer>] - VVol MSID
[-vvol-vdisk-id <text>] - VVol Vdisk ID
[-vserver-uuid <UUID>] - Vserver UUID
[-protocol-endpoint-path <path>] - Protocol Endpoint
313
Selects the bindings that match this parameter value. Examples of correct LUN paths
[-protocol-endpoint-node <nodename>] - PE Node
[-vvol-path <path>] - VVol
Selects the bindings that match this parameter value. Examples of correct LUN paths
[-vvol-node <nodename>] - VVol Node
[-secondary-lun <Hex 64bit Integer>] - Secondary LUN
[-is-optimal {true|false}] - Optimal binding
[-reference-count <integer>] - Reference Count
Examples
cluster1::*> lun bind show -vserver vs1
Vserver
Protocol Endpoint
Node
Vvol LUN
Secondary LUN Optimal?
-------------- -------------------------------------- -------------- -------vs1
/vol/VV1/PE1
cluster-node1
/vol/VV2/30dfab
d20000010000 false
/vol/VV3/234ace
d20000020000 true
/vol/VV3/234acf
/vol/VV2/PE2
d20000030000 true
cluster-node2
/vol/VV2/30dfab
d20000010000 true
The example above displays all the LUN bindings on Vserver vs1.
314
lun copy cancel

Cancel a LUN copy operation before the new LUN has been created
Description
The lun copy cancel command cancels an ongoing LUN copy operation prior to
creation of the new LUN. The command fails if the LUN already exists at the destination
path; in that case, use the lun delete command to delete the LUN at the destination
path.
All data transfers will be halted.
Note:
This is an advanced command because the preferred way to cancel a LUN copy
operation is to wait until the new LUN becomes visible, and then use the lun delete
command to delete the LUN.
Parameters
{ -vserver <Vserver Name> - Vserver Name
Specifies the name of the Vserver that will host the destination LUN.
-destination-path <path> - Destination Path
Specifies the full path to the new LUN, in the format /vol/<volume>[/<qtree>]/<lun>.
Examples
cluster1::*> lun copy cancel -vserver vs1 -destination-path /vol/vol2/lun2
Cancels the copy operation identified by Vserver vs1 and destination path /vol/vol2/lun2.
See Also
lun delete
315
lun copy modify

Modify an ongoing LUN copy operation
Description
The lun copy modify command modifies the maximum throughput of an ongoing
copy operation.
Parameters
-max-throughput {<integer>[KB|MB|GB|TB|PB]} - Maximum Transfer Rate (per sec)
Specifies the maximum amount of data, in bytes, that can be transferred per second in
support of this operation. This mechanism can be used to throttle a transfer, to reduce
its impact on the performance of the source and destination nodes.
Note:
The specified value will be rounded up to the nearest megabyte.
Examples
cluster1::> lun copy modify -vserver vs1 -destination-path /vol/vol2/lun2 -maxthroughput 25MB
Modifies the maximum throughput for the ongoing copy job identified by Vserver vs1
and destination path /vol/vol2/lun2 to 25 MB/sec.
316
lun copy pause

Pause an ongoing LUN copy operation
Description
The lun copy pause command pauses an ongoing copy operation. Use the lun
copy resume command to resume the copy operation.
Parameters
Examples
cluster1::> lun copy pause -vserver vs1 -destination-path /vol/vol2/lun2
Pauses the ongoing copy operation identified by Vserver vs1 and destination path /vol/
vol2/lun2.
See Also
lun copy resume
317
lun copy resume

Resume a paused LUN copy operation
Description
The lun copy resume command resumes a paused copy operation.
Parameters
Examples
cluster1::> lun copy resume -vserver vs1 -destination-path /vol/vol2/lun2
Resumes the paused copy operation identified by Vserver vs1 and destination path /vol/
vol2/lun2.
See Also
lun copy pause
318
lun copy show

Display a list of LUNs currently being copied
Description
The lun copy show command shows information about LUNs currently being copied
in the cluster.
Parameters
specify.
| [-instance ] }
about all fields.
[-vserver <Vserver Name>] - Destination Vserver Name
Selects LUN copy operations that match this parameter value.
[-destination-path <path>] - Destination Path
[-source-vserver <Vserver Name>] - Source Vserver Name
[-source-path <path>] - Source Path
[-source-snapshot <snapshot name>] - Source Snapshot Name
[-is-promoted-early {true|false}] - Is Destination Promoted Early
319
[-max-throughput {<integer>[KB|MB|GB|TB|PB]}] - Maximum Transfer Rate (per sec)

[-job-status {Preparing|Allocation-Map|Data|Destroying|Paused-Admin|Paused-Error|
Complete|Destroyed}] - LUN Copy Status
Selects LUN copy operations that match this parameter value. The possible values are:
Preparing - the LUN copy job is in Preparing status.
Allocation-Map - the LUN copy job is in Allocating status.
Data - the LUN copy job is in Moving Data status.
Destroying - the LUN copy job is in Destroying status.
Paused-Admin - the LUN copy job is in Paused By Admin status.
Paused-Error - the LUN copy job is in Paused By Error status.
Complete - the LUN copy job is in Complete status.
Destroyed - the LUN copy job is in Destroyed status.
[-progress-percent <percent>] - LUN Copy Progress (%)
[-elapsed-time <time_interval>] - Elapsed Time
[-cutover-time <time_interval>] - Cutover Time
[-is-snapshot-fenced {true|false}] - Is Snapshot Fenced
[-is-destination-ready {true|false}] - Is Destination Ready
[-last-failure-reason <text>] - Last Failure Reason
Examples
cluster1::> lun copy show
Vserver
320
Destination Path
Status
Progress
--------- ------------------------------- --------------- -------vs1
/vol/vol2/lun1
Data
35%
vs1
/vol/vol2/lun2
Complete
100%
The example above displays information about all the LUN copy operations in the
cluster.
cluster1::> lun copy show -vserver vs1 -destination-path /vol/vol2/lun1 -instance
Destination Vserver Name: vs1
Destination Path: /vol/vol2/lun1
Source Vserver Name: vs1
Source Path: /vol/vol1/lun1
Source Snapshot Name: Is Destination Promoted Early: false
Maximum Transfer Rate (per sec): 0B
LUN Copy Status: Data
LUN Copy Progress (%): 35%
Elapsed Time: 145s
Cutover Time (secs): 0s
Is Snapshot Fenced: true
Is Destination Ready: true
Last Failure Reason: -
The example above displays all information about the LUN being copied to /vol/vol2/lun1
in Vserver vs1.
321
lun copy start

Start copying a LUN from one volume to another within a cluster
Description
The lun copy start command initiates copying of a LUN from one volume to
another. The destination volume can be located in the same Vserver as the source
volume (intra-Vserver copy) or in a different Vserver (inter-Vserver). Intra-Vserver copy
can be initiated by both cluster and Vserver administrators. Inter-Vserver copy can be
initiated by cluster administrators only.
Note:
LUNs cannot be copied to a Vserver with Infinite Volume.
Parameters
-vserver <Vserver Name> - Destination Vserver Name
Specifies the name of the Vserver that will host the new LUN.
| -destination-path <path> - Destination Path
-source-path <path> } - Source Path
Specifies the full path to the source LUN, in the format /vol/<volume>[/.snapshot/
<snapshot>][/<qtree>]/<lun>.
[-source-vserver <Vserver Name>] - Source Vserver Name
Optionally specifies the name of the Vserver hosting the LUN to be copied.
If this parameter is not specified, it is assumed that an intra-Vserver copy operation
is being initiated. The source volume is expected to be in the same Vserver as the
destination volume.
Note:
This parameter is only available for cluster administrators.
322
[-promote-early [true]] - Promote Early

Optionally specifies that the destination LUN needs to be promoted early.
If the destination is promoted early, the new LUN will be visible immediately. However,
Snapshot copies of the volume containing the new LUN cannot be taken until the LUN
copy operation reaches 'Moving Data' status.
If the destination is promoted late, the new LUN will be visible only after it has been fully
framed. However, the LUN copy job will not block the creation of Snapshot copies of the
volume containing the new LUN.
If this parameter is not specified, the destination LUN will be promoted late.
Optionally specifies the maximum amount of data, in bytes, that can be transferred per
second in support of this operation. This mechanism can be used to throttle a transfer,
to reduce its impact on the performance of the source and destination nodes.
If this parameter is not specified, throttling is not applied to the data transfer.
Note:
Examples
cluster1::> lun copy start -vserver vs2 -destination-path /vol/vol2/lun2 -sourcevserver vs1 -source-path /vol/vol1/lun1
Starts an inter-Vserver copy of LUN lun1 from volume vol1 in Vserver vs1 to lun2 on
volume vol2 in Vserver vs2.
cluster1::> lun copy start -vserver vs1 -destination-path /vol/vol2/lun2 -sourcepath /vol/vol1/lun1
Starts an intra-Vserver copy of LUN lun1 from volume vol1 in Vserver vs1 to lun2 on
volume vol2 in Vserver vs1.
cluster1::> lun copy start -vserver vs1 -destination-path /vol/vol2/lun2 -sourcepath /vol/vol1/.snapshot/snap1/lun1
Starts an intra-Vserver copy of LUN lun1 from Snapshot copy snap1 of volume vol1 in
Vserver vs1 to lun2 on volume vol2 in Vserver vs1.
See Also
lun copy resume lun copy modify lun copy pause lun copy show
323
lun igroup add

Add initiators to an initiator group
Description
This command adds initiators to an existing initiator group (igroup). You can add
an initiator to an initiator group only if there are no LUN mapping conflicts. Mapping
conflicts occur when an initiator is already paired with a LUN. If you attempt to run this
command and there are LUN mapping conflicts, the command returns an error.
An initiator cannot be a member of two igroups of different OS types. For example, if
you have an initiator that belongs to a Solaris igroup, the command does not allow you
to add this initiator to an AIX igroup.
When you add FCP initiators, you can specify an alias instead of the initiator's World
Wide Port Name (WWPN) or the iSCSI Qualified name (IQN).
Note:
Parameters
-igroup <text> - Igroup Name
Specifies the initiator group to which you want to add a new initiator.
-initiator <text>, ... - Initiators
Specifies the initiator that you want to add. You can specify the WWPN, IQN, or alias of
the initiator.
Examples
cluster1::> lun igroup add -vserver vs1 -igroup ig1 -initiator
iqn.1992-08.com.mv.mvinitiator
324
Adds the initiator iqn.1992-08.com.mv.mvinitiator to the initiator group ig1 on Vserver

vs1.
325
lun igroup bind

Bind an existing initiator group to a given portset
Description
This command binds an initiator group to a port set so the host knows which LIFs or
TPGs to access. When you bind a port set to an igroup, the host knows which iSCSI or
FCP LIF to access. If you do not bind an igroup to a port set, and you map a LUN to the
igroup, then the initiators in the igroup can access the LUN on any port on the Vserver.
The initiator group cannot be bound to another port set when you use this command. If
you attempt to bind a port set to an initiator group that is already bound to an existing
port set, the command returns an error. You can only bind an initiator group to one port
set at a time.
If the initiator group is bound, use the lun igroup unbind command to unbind the
initiator group from the port set. After the initiator group is unbound, you can bind it to
another port set.
You can only bind an initiator group to a non-empty port set.
Note:
Parameters
Specifies the initiator group that you want to bind a port set to.
-portset <text> - Portset Binding Igroup
Specifies the port set name that you want to bind an initiator group to.
Examples
cluster1::> lun igroup bind -vserver vs1 -igroup ig1 -portset-name ps1
326
Binds igroup ig1 to port set ps1.
See Also
lun igroup unbind
327
lun igroup create

Create a new initiator group
Description
This command creates a new initiator group (igroup). Use igroups to control which hosts
have access to specific LUNs. When you bind an igroup to a port set, a host in the
igroup can access the LUNs only by connecting to the target ports in the port set.
When you create an igroup, you can add multiple existing initiators by specifying them
in a list, separating them with commas. Later, you can add or remove initiators from
the initiator group. Use the lun igroup add command to add initiators. Use the lun
igroup remove command to remove an initiator. Unless the -initiator option is
supplied, no initiators are added to a new igroup.
You can also bind a port set to an initiator when you create an initiator group. You
can modify the port set binding of an initiator group by using the lun igroup bind
command or the lun igroup unbind command.
The name you assign to an igroup is independent of the name of the host that is used
by the host operating system, host files, or Domain Name Service (DNS). If you name
an igroup aix1, for example, it is not mapped to the actual IP host name (DNS name) of
the host.
Note:
Parameters
Specifies the name of the new initiator group. An initiator group name is a case-sensitive
name that must contain one to 96 characters. Spaces are not allowed.
Note:
328
It might be useful to provide meaningful names for igroups, ones that describe the hosts
that can access the LUNs mapped to them.
{ [-protocol <protocol_enum>] - Protocol
Specifies if the initiator group protocol is fcp, iscsi, or mixed.
| [-fcp | -f [true]] - FCP
Specifies FCP as the protocol type of the new igroup.
| [-iscsi | -i [true]] } - iSCSI
Specifies iSCSI as the protocol type of the new igroup.
-ostype | -t {solaris|windows|hpux|aix|linux|netware|vmware|openvms|xen|hyper_v} OS Type
Specifies the operating system type for the new initiator group. The operating system
type indicates the type of host operating system used by all of the initiators in the igroup.
All initiators in an igroup must be of the same operating system type. The operating
system types of initiators are
solaris
windows
hpux
aix
linux
netware
vmware
openvms
xen
hyper_v
[-portset | -a <text>] - Portset Binding Igroup
Specifies that a port set is bound to the initiator.
Specifies the initiators that are attached to the new initiator group. By default, no
initiators are added to the new igroup.
329
Examples
cluster1::> lun igroup create -vserver vs1 -igroup ig1 -protocol mixed -ostype
linux -initiator iqn.2001-04.com.example:abc123
Creates initiator group ig1 on Vserver vs1 with a mixed protocol type on a Linux
operating system with the initiator iqn.2001-04.com.example:abc123.
See Also
lun igroup add lun igroup remove lun igroup bind lun igroup unbind
330
lun igroup delete

Delete an initiator group
Description
This command deletes an existing initiator group. By default, you cannot delete an
initiator group if LUN maps for that initiator group exist. You need to unmap all the LUNs
that are associated with that initiator group before you can delete the initiator group. Use
the lun unmap command to remove LUNS from an initiator group.
You can specify the force option to delete an initiator group and remove existing LUN
maps defined for that initiator group.
Note:
Parameters
Specifies the initiator group that you want to delete.
[-force | -f [true]] - Force
Deletes an initiator group and all associated LUN maps.
Examples
cluster1::> lun igroup delete -vserver vs1 -igroup ig1
Deletes the initiator group ig1 on Vserver vs1.
See Also
lun unmap
331
lun igroup disable-aix-support

Disables SAN AIX support on the cluster
Description
This command disables the SAN AIX support across the cluster (all Vservers and all AIX
initiator groups). However, before you can disable SAN AIX support, you must remove
all SAN AIX related objects from the cluster. You need to unmap all the LUNs that are
associated with the AIX initiator groups. Then you need to delete all of the AIX initiator
groups. Use the lun unmap command to remove LUNS from an initiator group. Use the
igroup delete command to delete an initiator group.
Note:
This command is not intended to be used in normal operation. Use only when you are
downgrading to a release that does not support SAN AIX operation.
Parameters
None
Examples
cluster1::> lun igroup disable-aix-support
Disables the SAN AIX support for cluster1.
See Also
lun unmap igroup delete
332
lun igroup modify

Modify an existing initiator group
Description
This command modifies an attribute for an initiator group. Currently, the only settable
attribute is the operating system.
Note:
Parameters
Specifies the initiator group whose attribute you want to modify.
[-ostype | -t {solaris|windows|hpux|aix|linux|netware|vmware|openvms|xen|hyper_v}] OS Type
Specifies the operating system that you want to modify. The operating system types of
initiators are
solaris
windows
hpux
aix
linux
netware
vmware
openvms
333
xen
hyper_v
Examples
cluster1::> lun igroup modify -vserver vs1 -igroup ig1 -ostype windows
Changes the operating system to windows for initiator group ig1 on Vserver vs1.
334
lun igroup remove

Remove initiators from an initiator group
Description
This command removes an initiator from an initiator group. You can only remove an
initiator if no existing LUN maps are defined for that initiator group. You must unmap the
LUNs from the initiator group with the lun unmap command before you can remove
initiators from the initiator group.
You can use the force option to remove an initiator and associated LUN maps.
Note:
Parameters
Specifies the initiator group from which you want to remove an initiator.
Specifies the initiator name you want to remove. Use the WWPN, IQN or the alias of the
initiator.
Forcibly removes an initiator and any associated LUN maps.
Examples
cluster1::> lun igroup remove -vserver vs1 -igroup ig1 -initiator
iqn.1992-08.com.mv.mvinitiator
335
Removes the initiator iqn.1992-08.com.mv.mvinitiator from Vserver vs1 and initiator

group ig1.
See Also
lun unmap
336
lun igroup rename

Rename an existing initiator group
Description
This command renames an existing initiator group. When you rename an initiator group,
this action does not affect access to the LUNs mapped to the initiator group you want to
rename.
An initiator group name is a case-sensitive name and must meet the following
requirements:
Can contain the letters A through Z, a through z, numbers 0 through 9, hyphen (-),
underscore (_), colon (:), and period (.).
Must start with a letter or number.
Note:
Parameters
Specifies the initiator group you want to rename.
-new-name <text> - New Igroup Name
Specifies the new name of the initiator group.
Examples
cluster1::> lun igroup rename -vserver vs1 -igroup ig1 -new-name ignew1
337
Renames an initiator group from ig1 to ignew1 on Vserver vs1.
338
lun igroup show

Display a list of initiator groups
Description
This command displays status information for initiator groups (igroup). By default, the
command displays status for all initiator groups.
Parameters
specify.
| [-instance ] }
about all fields.
[-igroup <text>] - Igroup Name
Selects the initiator groups that match this parameter value.
[-protocol <protocol_enum>] - Protocol
Selects the initiator groups that match this parameter value (FCP, iSCSI, or mixed).
[-ostype | -t {solaris|windows|hpux|aix|linux|netware|vmware|openvms|xen|hyper_v}] OS Type
Selects the initiator groups that match this parameter value. The operating system types
are
solaris
windows
hpux
339
aix
linux
netware
vmware
openvms
xen
hyper_v
[-portset | -a <text>] - Portset Binding Igroup
[-initiator <text>, ...] - Initiators
[-uuid <UUID>] - Igroup UUID
Examples
cluster1::> igroup show -instance
Vserver Name: vs0
Igroup Name: ig1
Protocol: mixed
OS Type: linux
Portset Binding Igroup: Igroup UUID: 358338ba-cfd6-11df-a9ab-123478563412
Initiators: iqn.1992-08.com.mv:abc (not logged in)
Vserver Name: vs0
Igroup Name: ig2
Protocol: mixed
OS Type: linux
Portset Binding Igroup: Igroup UUID: 3fb136c7-cfd6-11df-a9ab-123478563412
Initiators: Vserver Name: vs1
Igroup Name: ig1
340
Protocol: mixed
OS Type: windows
Portset Binding Igroup: p1
Igroup UUID: 03accf6b-d08c-11df-a9ab-123478563412
Initiators: 3 entries were displayed.
The example above displays information about all initiator groups.
341
lun igroup unbind

Unbind an existing initiator group from a portset
Description
This command unbinds an initiator group from a port set. When you unbind an initiator
group from a port set, all of the initiators in the initiator group have access to all target
LUNs on all network interfaces.
Note:
Parameters
Specifies the initiator group that you want to unbind from the port set.
Examples
cluster1::> lun igroup unbind -vserver vs1 -igroup ig1
Unbinds the initiator group ig1 from the port set on Vserver vs1.
342
lun import create

Create an import relationship
privilege level.
Description
This command creates an import relationship between a specified LUN and a specified
foreign disk so you can import the foreign disk data into a LUN.
The foreign disk must be marked as foreign using storage disk modify command
before you can begin the import progress.
The LUN must be of the same size as the foreign disk.
Parameters
Specifies the Vserver that contains the LUN where you import data to from the foreign
disk data.
-foreign-disk <text> - Foreign Disk Serial Number
Specifies the serial number of the Foreign Disk.
-path <path> - LUN Path
Specifies the path of the LUN where you want to import the data of the foreign disk to.
Examples of correct LUN paths are /vol/vol1/lun1 and /vol/vol1/qtree1/lun1.
Examples
cluster1::> lun import create -vserver vs1 -path /vol/dvol1/lun1 -foreign-disk
6000B5D0006A0000006A020E00040000
Creates an import relationship between lun1 at the path /vol/dvol1/lun1 and foreign disk
with serial number 6000B5D0006A0000006A020E00040000.
See Also
storage disk modify
343
lun import delete

Deletes the import relationship of the specified LUN or the specified foreign disk
privilege level.
Description
This command deletes the import relationship of a specified LUN or a specified foreign
disk.
You cannot use this command if an import is in-progress between the foreign disk
and the LUN unless you use the force option. The import has to either successfully
completed or be stopped before deleting the import relationship.
You can use the lun import stop command to stop the data import, and then you
delete the import relationship.
Parameters
Specifies the Vserver that contains the LUN that you want to delete the import
relationship.
Specifies the path of the LUN where you want to delete the import relationship.
| -foreign-disk <text> } - Foreign Disk Serial Number
Specifies the serial number of the foreign disk.
[-force {true|false}] - Force Delete
When set to true, stops the in progress data import.
Examples
cluster1::> lun import delete -vserver vs1 -path /vol/vol2/lun2
Deletes the import relationship of lun2 at the path /vol/vol2/lun2.
344
cluster1::> lun import delete -vserver vs0 -foreign-disk

6000B5D0006A0000006A020E00040000
Deletes the import relationship of the foreign disk with serial number
6000B5D0006A0000006A020E00040000.
See Also
lun import stop
345
lun import pause

Pause the import for the specified LUN
privilege level.
Description
This command pauses the data import to a specified LUN.
This command does not reset all import checkpoints. To resume a paused import, use
the lun import resume command to retart from the last checkpoint taken before you
paused the data import.
If you want to resume the data import from the beginning, use the lun import stop
command. Then use the lun import start command.
Parameters
Specifies the Vserver that contains the LUN you want to pause the data import to.
Specifies the path of the LUN you want to pause the data import to. Examples of correct
LUN paths are /vol/vol1/lun1 and /vol/vol1/qtree1/lun1.
Examples
cluster1::> lun import pause -vserver vs1 -path /vol/vol2/lun2
Pauses the data import for lun2 at the path /vol/vol2/lun2
346
lun import resume

Resume the import for the specified LUN
privilege level.
Description
Resumes the data import to a specified LUN.
The import starts from the last checkpoint taken before you paused the data import.
If you want to resume the data import from the beginning, use the lun import stop
command. Then use the lun import start command.
Parameters
Specifies the Vserver that contains the LUN you want to resume the data import to.
Specifies the path of the LUN that you want to resume the data import to. Examples of
Examples
cluster1::> lun import resume -vserver vs1 -path /vol/vol2/lun2
Resumes the data import to lun2 at the path /vol/vol2/lun2
347
lun import show

Display a list of import relationships
privilege level.
Description
This command displays information about the import relationships.
Parameters
specify.
| [-instance ] }
about all fields.
Displays import relationships for a specified Vserver.
[-foreign-disk <text>] - Foreign Disk Serial Number
Enables you to see the import relationship for a particular foreign disk with the specified
serial number.
[-path <path>] - LUN Path
Enables you to see the import relationship for a particular LUN path. Examples of
[-import-home-node {<nodename>|local}] - Import Home Node
Enables you to see the node that initially started the data import and where the I/O for
the foreign disk is directed. If failover occurs, any in-progress data import restarts on the
partner node.
[-import-current-node {<nodename>|local}] - Import Current Node
348
Displays the node that is currently importing data and where the I/O for the foreign disk
is directed. During giveback and if the import home node is different from the current
home node , import restarts on the initial node (import-home-node).
[-operation-in-progress {import|verify}] - Operation in Progress
Enables you to see the imports in progress or import verification in progress.
[-admin-state {stopped|started|paused}] - Admin State
Enables you to see the import relationships for a specified administrative state. For
example, you can list all the imports that have started in a cluster.
[-operational-state {in_progress|failed|completed|stopped|paused}] - Operational State
Enables you to see the import relationships for a specified operational state. For
example, you can list all the imports that have completed in a cluster.
[-percent-complete <integer>] - Percent Complete
Enables you to see the percentage of completion for both import and verification. If you
want to see all the complete imports and verifications, you would specify 100.
[-imported-blocks <integer>] - Blocks Imported
Enables you to see the number of blocks that have been imported to the LUN.
[-compared-blocks <integer>] - Blocks Compared
Enables you to see the number of LUN and foreign disk blocks that have been
compared.
[-total-blocks <integer>] - Total Blocks
Enables you to see the total number of blocks that must be imported to complete the
data import to a LUN or the number of blocks that must be compared to complete the
import verification.
[-estimated-remaining-duration {<seconds>|[<d> days] <hh>:<mm>[:<ss>]}] Estimated Remaining Duration
If this parameter is specified, the command displays import or verify operations that
match the specified time.
[-failure-reason <text>] - Failure Reason
Selects LUN import operations that match this parameter value.
Examples
cluster1::> lun import show
349
vserver
foreign-disk
operation-in-progress
admin-state
path
operational-state percent-complete
---------------------------------------------------------------------------------------------vs1
import
6000B5D0006A0000006A020E00040000
stopped
stopped
/vol/dvol1/lun1
0
vs1
import
60060480343631336433336538366537
started
failed
/vol/vol1/lun1
11
vs2
verify
6000B5D0006A0000006A020E00040001
started
in_progress
/vol/dvol1/lun2
5
Display information about all import relationships in the cluster

cluster1::> lun import show -instance
Vserver Name: vs1
LUN Path: /vol/dvol1/lun1
Foreign Disk Serial Number: 6000B5D0006A0000006A020E00040000
Import Home Node: cluster1-01
Current Import Node: cluster1-01
Operation in Progress: import
Admin State: started
Operational State: in-progress
Percent Complete: 0%
Blocks Imported: 0
Blocks Compared: 0
Total Blocks to Import: 10000000
Estimated Remaining Duration: 00:01:23
Failure Reason: Vserver Name: vs2
LUN Path: /vol/dvol1/lun2
Foreign Disk Serial Number: 6000B5D0006A0000006A020E00040001
Operation in Progress: verify
Operational State: in-progress
Percent Complete: 5%
Blocks Imported: 10000000
Blocks Compared: 500000
Total Blocks to Import: 10000000
Estimated Remaining Duration: 00:00:59
Failure Reason: -
350
Vserver Name: vs1

Foreign Disk Serial Number: 60060480343631336433336538366537
Operation in Progress: import
Operational State: failed
Percent Complete: 11
Blocks Imported: 932352
Blocks Compared: Total Blocks: 8388608
Estimated Remaining Duration: Failure Reason: Source read error - reservation conflict.
Display detailed information about all import relationships in the cluster.

cluster1::> lun import show -vserver vs1
vserver
path
operational-state
foreign-disk
percent-complete
admin-state
---------------------------------------------------------------------------------------------vs1
/vol/dvol1/lun1
0%
vgv3040f46a:vgbr300s70:9.126L1
stop
Display information about the LUNs in an import relationships in a specific vserver.

cluster1::> lun import show -admin-state start
vserver
path
operational-state
foreign-disk
percent-complete
admin-state
---------------------------------------------------------------------------------------------vs2
/vol/dvol1/lun2
in-progress
5%
vgv3040f46a:vgbr300s70:9.126L2
start
Display active LUN import sessions in a cluster.
351
lun import start

Start the import for the specified LUN
privilege level.
Description
This command initiates the data import to a specified LUN.
You must use the lun import create command to create an import relationship between a
LUN and a foreign disk before you can initiate the data import.
Parameters
Specifies the Vserver that contains the LUN you want to import data to.
Specifies the path of the LUN that you want to import data to. Examples of correct LUN
paths are /vol/vol1/lun1 and /vol/vol1/qtree1/lun1.
Examples
cluster1::> lun import start -vserver vs1 -path /vol/vol2/lun2
Starts the data import to lun2 at the path /vol/vol2/lun2.
352
lun import stop

Stop the import for the specified LUN
privilege level.
Description
This command stops the data import into a specified LUN.
After you stop the data import and if you start the import again using lun import
start command, then the import restarts from the beginning.
Parameters
Specifies the Vserver that contains the LUN you want to stop importing data to.
Specifies the path of the LUN that you want to stop the data import to.
Examples
cluster1::> lun import stop -vserver vs1 -path /vol/vol2/lun2
Stops data import to lun2 at the path /vol/vol2/lun2
See Also
lun import start
353
lun import verify start

Start the verification of the foreign disk and LUN data
privilege level.
Description
This command compares the LUN and the foreign disk block by block. You are not
required to run this command; it is optional. Before you can do this verification process,
the operation state must be stopped or completed. Use the lun import show command to
determine the operation state.
If a block mismatch occurs, the verification process stops.
Verification must be done offline. Ensure the foreign disk and LUN cannot be
accessed by a host. To prevent access of the LUN, the LUN should be taken offline
administratively using the lun offline command.
Note: The specified LUN must be in an import relationship with a foreign disk before you
can verify the data import.
Parameters
Specifies the Vserver that contains the LUN you want to compare block by block with
the foreign disk.
Specifies the path of the LUN that you want to compare the foreign disk to. Examples of
Examples
cluster1::> lun import verify start -vserver vs1 -path /vol/vol2/lun2
Starts the import verification on lun2 at path /vol/vol2/lun2.
354
lun import verify stop

Stop the verify for the specified LUN
privilege level.
Description
This command stops the block by block verification of the foreign disk and LUN data.
Parameters
Specifies the Vserver that contains the LUN you want to stop block by block comparison
with the foreign disk.
Specifies the path of the LUN that you want to stop the block by block comparison.
Examples
cluster1::> lun import verify stop -vserver vs1 -path /vol/vol2/lun2
Stops the import verify on lun at path /vol/vol2/lun2.
See Also
lun import verify start
355
lun mapping add-reporting-nodes

Add Reporting Nodes
Description
This command is used before or after a data mobility event that modifies the owning
node of the LUN to add the new optimized nodes to the specified LUN mapping's
reporting nodes.
For more information on managing reporting nodes in response to data mobility events,
please see the Data ONTAP SAN Administration Guide.
Note:
Parameters
Specifies the name of the Vserver containing the LUN.
Specifies the path of the LUN. Examples of correct LUN paths are /vol/vol1/lun1 and /
Specifies the volume that contains the LUN.
Specifies the qtree that contains the LUN.
Specifies the LUN name.
-igroup | -g <text> - Igroup Name
Specifies the igroup the LUN is mapped to.
{ -local-nodes [true] - Add Nodes for Current LUN Location
356
Add the current LUN owner node and HA partner to the LUN mapping's reporting nodes.
This option should be used after a LUN mobility event to restore optimized access to the
LUN.
| -destination-aggregate <aggregate name> - Add Nodes for Aggregate
Add the specified aggregate's owner node and HA partner to the LUN mapping's
reporting nodes.
This option may be used prior to a LUN mobility event that changes the LUN's
containing aggregate.
| -destination-volume <volume name> - Add Nodes for Volume
Add the specified volume's owner node and HA partner to the LUN mapping's reporting
nodes.
This option may be used prior to a LUN mobility event that changes the LUN's
containing volume.
| -all [true] } - Add All Nodes (privilege: advanced)
Set the LUN mapping to report on all nodes in preparation for a revert to a previous
version of Data ONTAP.
Examples
cluster1::> lun mapping add-reporting-nodes -vserver vs1 -path /vol/vol1/lun1 igroup ig1
Add the current owner node and HA partner for the LUN mapping of /vol/vol1/lun1 to
igroup ig1
cluster1::> lun mapping add-reporting-nodes -vserver vs1 -volume vol1 -lun * igroup ig1 -destination-aggregate aggr2
Add the aggregate owner node and HA partner for aggregate aggr2 to all LUN
mappings in volume vol1 to igroup ig1 prior to starting a volume move operation.
357
lun mapping create

Map a LUN to an initiator group
Description
This command maps a LUN to all of the initiators in an initiator group (igroup). After you
map the LUN, the LUN is visible to all initiators in the igroup.
Data ONTAP ensures that there are no LUN map conflicts whether the LUN is offline or
online. A LUN map conflict is a mapping that would violate either of the following rules:
Each LUN can be mapped to an initiator only once. A LUN can be mapped to
multiple igroups as long as each igroup has a distinct set of initiators.
LUN IDs must be unique such that every initiator has a unique ID for each LUN to
which it is mapped. If you map a LUN to an igroup, the LUN ID for that mapping
cannot be reused by any of the initiators in that igroup.
In order to determine if a LUN ID is valid for a mapping, Data ONTAP checks
each initiator in the igroup to make sure that the LUN ID is not used for another
mapping that includes that initiator.
Note:
Parameters
Specifies the Vserver that contains the LUN you want to map.
Specifies the path of the LUN that you want to map. Examples of correct LUN paths
Specifies the volume that contains the LUN you want to map.
358

Specifies the qtree that contains the LUN you want to map.
Specifies the LUN name that you want to map.
Specifies the igroup that you want to map.
[-lun-id <integer>] - LUN ID
Specifies the LUN ID for the mapping. The LUN ID is specific to the mapping, not to the
LUN itself. This is used by the initiators in the igroup as the Logical Unit Number for the
initiator when accessing the storage.
[-additional-reporting-node <nodename>] - Additional Reporting Node (privilege:
advanced)
Specifies an additional node to populate the -reporting-nodes list when creating
the LUN mapping. The specified node's high availability partner will be automatically
populated as well. Use this parameter when preferred data mobility destinations are
known ahead of time and the appropriate paths can be pre-configured.
Examples
cluster1::> lun mapping create -vserver vs1 -path /vol/vol1/lun1 -igroup ig1 lun-id 8
Maps a LUN at /vol/vol1/lun1 on Vserver vs1 to the igroup ig1 with LUN ID 8.
359
lun mapping delete

Unmap a LUN from an initiator group
Description
This command unmaps a LUN from an initiator group. After you use this command, the
LUN is not visible to any of the initiators in the initiator group.
Note:
Parameters
Selects the LUN maps for the Vserver that matches the parameter value.
Specifies the path of the LUN you want to unmap. Examples of correct LUN paths are /
Specifies the volume of the LUN you want to unmap.
-qtree <text> - Qtree Name
Specifies the qtree of the LUN you want to unmap.
Specifies the name of the LUN you want to unmap.
Specifies the initiator group that you want to unmap the LUN from.
Examples
cluster1::> lun mapping delete -vserver vs1 -path /vol/vol1/lun1 -igroup ig1
360
Unmaps LUN at path /vol/vol1/lun1 from the initiator group ig1 on Vserver vs1.
361
lun mapping remove-reporting-nodes

Remove Reporting Nodes
Description
This command is used after a data mobility event to remove reporting nodes that are no
longer required for optimized access from the specified LUN mapping.
For more information on managing reporting nodes in response to data mobility events,
please see the Data ONTAP SAN Administration Guide.
Note:
Parameters
Specifies the name of the Vserver containing the LUN.
Specifies the volume that contains the LUN.
Specifies the qtree that contains the LUN.
Specifies the LUN name.
Specifies the igroup the LUN is mapped to.
-remote-nodes [true] - Remove Remote Nodes for LUN Location
362
If specified, remove all nodes other than the LUN's owner and HA partner from the LUN
mapping's reporting nodes.
Examples
cluster1::> lun mapping remove-reporting-nodes -vserver vs1 -path /vol/vol1/lun1
-igroup ig1
Remove excess remote nodes from the LUN mapping of /vol/vol1/lun1 to igroup ig1
363
lun mapping show

Lists the mappings between LUNs and initiator groups.
Description
This command lists the mappings between LUNs and initiator groups.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the LUN maps for the Vserver that matches the parameter value.
{ [-path <path>] - LUN Path
Selects the LUN maps for the LUN with the path that matches the parameter value.
Selects the LUN maps for the volumes that match the parameter value.
Selects the LUN maps for the queue trees that match the parameter value.
[-lun <text>] } - LUN Name
Selects the LUN maps for the LUNs with a name that matches the parameter value.
[-igroup | -g <text>] - Igroup Name
Selects the LUN maps for the igroup that matches the parameter value.
364
[-ostype {solaris|windows|hpux|aix|linux|netware|vmware|openvms|xen|hyper_v}] Igroup OS Type

Selects the LUN maps for the initiator groups with the OS type that matches the
parameter value. The possible OS types are:
windows - the LUN stores a raw disk type in a single-partition Windows disk
using the Master Boot Record (MBR) partitioning style.
vmware - the LUN stores VMware data.
openvms - the LUN stores Open-VMS data.
xen - the LUN stores Xen data.
hyper_v - the LUN stores Windows Server 2008 or Windows Server 2012 HyperV data.
[-protocol <protocol_enum>] - Igroup Protocol Type
Selects the LUN maps for initiator groups with a protocol that matches the parameter
value. Possible values include FCP, iSCSI, or mixed.
[-lun-id <integer>] - LUN ID
Selects the LUN maps with a LUN ID that matches the parameter value.
[-portset <text>] - Portset Binding Igroup
Selects the LUN maps for initiator groups bound to the portset that matches the
parameter value.
[-alua {true|false}] - ALUA
Selects the LUN maps with ALUA settings that match the parameter value.
[-initiators | -n <text>, ...] - Initiators
Selects the LUN maps for initiator groups containing the initiators that match the
parameter value.
[-node <nodename>] - LUN Node
Selects the LUN maps for nodes that match the parameter value.
365
[-reporting-nodes <nodename>, ...] - Reporting Nodes

Selects the LUN maps that match the parameter value.
Examples
cluster1::> lun mapping show
Vserver
Igroup
LUN ID
Protocol
---------- ----------------------------------------
Path
-------
------
--------
vs1
/vol/vol1/lun1
igroup1
10
mixed
vs1
/vol/vol1/lun1
igroup2
mixed
vs1
/vol/vol5/lun1
igroup3
mixed
vs1
/vol/vol5/lun2
igroup3
mixed
The example above lists all of the mappings between LUNs and initiator groups and the
LUN ID for each mapping.
366
lun move cancel

Cancel a LUN move operation before the new LUN has been created
Description
The lun move cancel command cancels an ongoing LUN move operation prior to
creation of the new LUN. The command fails if the LUN already exists at the destination
path; in that case, allow the current move operation to complete and then move it back
using the lun move start command.
All data transfers will be halted. If the source LUN was quiesced, it will be restored to
normal operation.
Note:
This is an advanced command because the preferred way to cancel a LUN move
operation is to wait until the new LUN becomes visible, and then move it back.
Parameters
Examples
cluster1::*> lun move cancel -vserver vs1 -destination-path /vol/vol2/lun2
Cancels the move operation identified by Vserver vs1 and destination path /vol/vol2/
lun2.
See Also
lun move start
367
lun move modify

Modify an ongoing LUN move operation
Description
The lun move modify command modifies the maximum throughput of an ongoing
move operation.
Parameters
-max-throughput {<integer>[KB|MB|GB|TB|PB]} - Maximum Transfer Rate (per sec)
Specifies the maximum amount of data, in bytes, that can be transferred per second in
support of this operation. This mechanism can be used to throttle a transfer, to reduce
its impact on the performance of the source and destination nodes.
Note:
Examples
cluster1::> lun move modify -vserver vs1 -destination-path /vol/vol2/lun2 -maxthroughput 25MB
Modifies the maximum throughput for the ongoing move job identified by Vserver vs1
and destination path /vol/vol2/lun2 to 25 MB/sec.
368
lun move pause

Pause an ongoing LUN move operation
Description
The lun move pause command pauses an ongoing move operation. Use the lun
move resume command to resume the move operation.
Parameters
Examples
cluster1::> lun move pause -vserver vs1 -destination-path /vol/vol2/lun2
Pauses the ongoing move operation identified by Vserver vs1 and destination path /vol/
vol2/lun2.
See Also
lun move resume
369
lun move resume

Resume a paused LUN move operation
Description
The lun move resume command resumes a paused move operation.
Parameters
Examples
cluster1::> lun move resume -vserver vs1 -destination-path /vol/vol2/lun2
Resumes the paused move operation identified by Vserver vs1 and destination path /
vol/vol2/lun2.
See Also
lun move pause
370
lun move show

Display a list LUNs currently being moved
Description
The lun move show command shows information about LUNs currently being moved
in the cluster.
Parameters
specify.
| [-instance ] }
about all fields.
Selects LUN move operations that match this parameter value.
[-destination-path <path>] - Destination Path
[-source-path <path>] - Source Path
[-is-promoted-late {true|false}] - Is Destination Promoted Late
[-job-status {Preparing|Allocation-Map|Data|Destroying|Paused-Admin|Paused-Error|
Complete|Destroyed}] - LUN Move Status
Selects LUN move operations that match this parameter value. The possible values are:
371
Preparing - the LUN move job is in Preparing status.

Allocation-Map - the LUN move job is in Allocating status.
Data - the LUN move job is in Moving Data status.
Destroying - the LUN move job is in Destroying status.
Paused-Admin - the LUN move job is in Paused By Admin status.
Paused-Error - the LUN move job is in Paused By Error status.
Complete - the LUN move job is in Complete status.
Destroyed - the LUN move job is in Destroyed status.
[-progress-percent <percent>] - LUN Move Progress (%)
[-elapsed-time <time_interval>] - Elapsed Time
[-cutover-time <time_interval>] - Cutover Time
[-is-snapshot-fenced {true|false}] - Is Snapshot Fenced
[-is-destination-ready {true|false}] - Is Destination Ready
[-last-failure-reason <text>] - Last Failure Reason
Examples
cluster1::> lun move show
Vserver
Destination Path
Status
Progress
--------- ------------------------------- --------------- -------vs1
/vol/vol2/lun1
Data
35%
vs1
/vol/vol2/lun2
Complete
100%
372
The example above displays information about all the LUN move operations in the
cluster.
cluster1::> lun move show -vserver vs1 -destination-path /vol/vol2/lun1 -instance
Destination Vserver Name: vs1
Destination Path: /vol/vol2/lun1
Source Path: /vol/vol1/lun1
Is Destination Promoted Early: false
Maximum Transfer Rate (per sec): 0B
LUN Move Status: Data
LUN Move Progress (%): 35%
Elapsed Time: 145s
Cutover Time (secs): 0s
Is Snapshot Fenced: true
Is Destination Ready: true
Last Failure Reason: -
The example above displays all information about the LUN being moved to /vol/vol2/
lun1 in Vserver vs1.
373
lun move start

Start moving a LUN from one volume to another within a Vserver
Description
The lun move start command initiates moving of a LUN from one volume to
another. The destination volume can be located on the same node as the original
volume or on a different node.
Note:
Use lun move-in-volume command if you want to rename the LUN or move it within
the same volume.
Note:
This command does not support movement of LUNs that are created from files.
Parameters
Specifies the name of the Vserver that will host the new LUN.
| -destination-path <path> - Destination Path
-source-path <path> } - Source Path
Specifies the full path to the source LUN, in the format /vol/<volume>[/<qtree>]/<lun>.
[-promote-late [true]] - Promote Late
Optionally specifies that the destination LUN needs to be promoted late.
If the destination is promoted early, the new LUN will be visible immediately. However,
Snapshot copies of the volume containing the new LUN cannot be taken until the LUN
move operation reaches 'Moving Data' status.
374
If the destination is promoted late, the new LUN will be visible only after it has been fully
framed. However, the LUN move job will not block the creation of Snapshot copies of
the volume containing the new LUN.
If this parameter is not specified, the destination LUN will be promoted early.
Optionally specifies the maximum amount of data, in bytes, that can be transferred per
second in support of this operation. This mechanism can be used to throttle a transfer,
to reduce its impact on the performance of the source and destination nodes.
If this parameter is not specified, throttling is not applied to the data transfer.
Note:
Examples
cluster1::> lun move start -vserver vs1 -destination-path /vol/vol2/lun2 -sourcepath /vol/vol1/lun1
Starts moving LUN lun1 from volume vol1 in Vserver vs1 to lun2 on volume vol2 in
Vserver vs1.
See Also
lun move resume lun move-in-volume lun move modify lun move pause
lun move show
375
lun persistent-reservation clear

Clear the SCSI-3 persistent reservation information for a given LUN
Description
Clears the persistent reservation for the specified LUN.
Note:
Parameters
Specifies the volume.
-lun <text> - LUN Name
Specifies the name of the LUN.
[-qtree <text>] } - Qtree Name
Specifies the qtree.
Examples
cluster1::*> lun persistent-reservation clear -vserver vs_1 -path /vol/vol_1/
lun_1
Clears the persistent reservation data for lun lun_1 in volume vol_1 for Vserver vs_1.
376
lun persistent-reservation show

Display the current reservation information for a given LUN
Description
Displays reservation information for a specified LUN in a Vserver. Unlike other show
commands, the user must specify the LUN.
Parameters
specify.
| [-instance ] }
about all fields.
Specifies the volume.
-lun <text> - LUN Name
Specifies the name of the LUN.
[-qtree <text>] } - Qtree Name
Specifies the qtree.
[-scsi-revision {scsi2|scsi3}] - SCSI Revision
Selects the reservations that match this parameter value.
377
[-entry-type {reservation|registration}] - Reservation or Registration

[-protocol {fcp|iscsi}] - Protocol
[-reservation-key <text>] - Reservation Key
[-reservation-type-code <text>] - Reservation Type
Selects the reservations that match this parameter value. The possible values for
SCSI-3 reservations are:
write exclusive
exclusive access
write exclusive registrants only
exclusive access registrants only
write exclusive all registrants
exclusive access all registrants
and for SCSI-2 are:
regular
third party
[-initiator-name <text>] - Initiator Name
[-aptpl {true|false}] - Persist Through Power Loss
Selects the reservations that match this parameter value. If true, the reservation will be
preserved over a power loss. If false, it will not. This value is for SCSI-3 reservations
only.
[-target-wwpn <text>] - FCP Target WWPN
Selects the reservations that match the specified World Wide Port Name (WWPN).
[-isid <text>] - Initiator Session ID
[-tpgroup-tag <integer>] - TPGroup Tag
378
Selects the reservations that match the specified target portal group tag. The tag
identifies the tpgroup the reservation was made over.
[-third-party-initiator-name <text>] - Third Party Initiator Name
Selects the reservations that match this parameter value (the initiator name that the
reservation was made for). This is specific to third party reservation types, which is
indicated by reservation-type-code.
Examples
cluster1::*> lun persistent-reservation show -vserver vs_1 /vol/vol_1/lun_1
Key
Protocol Type
Initiator Name
----------------------- -------- -------------------------------------------APTPL: true

a0:00:00:00:00:00:00:01 iscsi
iqn.1993-08.org.debian:01:fa752b8a5a3a
write exclusive
a0:00:00:00:00:00:00:01 iscsi
The example above displays the current reservations for lun_1 on Vsever vs_1.
379
lun portset add

Add iSCSI/FCP LIFs to a portset
Description
This command adds existing iSCSI and FCP LIFs to a port set. To create a new port set,
use the lun portset create command.
Use the network interface create command to create new LIFs.
Note:
Parameters
-portset <text> - Portset Name
Specifies the port set you want to add the LIFs to.
-port-name <port_name>, ... - LIF or TPG Name
Specifies the LIF name you want to add to the port set.
Examples
cluster1::> portset add -vserver vs1 -portset ps1 -port-name lif1
Adds port lif1 to port set ps1 on Vserver vs1.
See Also
lun portset create network interface create
380
lun portset create

Creates a new portset
Description
This command creates a new port set for FCP and iSCSI. The port set name can
include a maximum of 96 characters. You can add LIFs to the new port set. If you do not
add a LIF to the port set, you create an empty port set. To add LIFs to an existing port
set, use the lun portset add command.
After you create a port set, you must bind the port set to an igroup so the host knows
which FC or iSCSI LIFs to access. If you do not bind an igroup to a port set, and you
map a LUN to an igroup, then the initiators in the igroup can access the LUN on any LIF
on the Vserver.
Note:
You cannot bind an igroup to an empty port set because the initiators in the igroup
would have no LIFs to access the LUN.
Note:
Parameters
Specifies the name of the new port set. A port set name is a case-sensitive name that
must contain one to 96 characters. Spaces are not allowed.
[-port-name <port_name>, ...] - LIF Or TPG Name
Specifies the name of the logical interface that you want to add to the portset you want
to create.
{ [-protocol <protocol_enum>] - Protocol
381
Specifies if the portset protocol type is fcp, iscsi, or mixed. The default is mixed.
| [-fcp | -f [true]] - FCP
Specifies FCP as the protocol type of the new port set.
| [-iscsi | -i [true]] } - iSCSI
Specifies iSCSI as the protocol type of the new port set.
Examples
cluster1::> portset create -vserver vs1 -portset ps1 -protocol mixed
Creates a port set ps1 on Vserver vs1 with the protocol type of mixed.
cluster1::> portset create -vserver vs1 -portset iscsips -protocol iscsi
Creates a port set iscsips on Vserver vs1 with the protocol type of iscsi.
cluster1::> portset create -vserver vs1 -portset fcppc -protocol fcp
Creates a port set fcppc on Vserver vs1 with the protocol type of fcp.
cluster1::> portset create -vserver vs1 -portset ps2 -protocol mixed -port-name
l11
Creates a port set ps2 on Vserver vs1 with the protocol type of mixed and LIF l11.
See Also
lun portset add
382
lun portset delete

Delete the portset
Description
This command deletes an existing port set. By default, you cannot delete a port set if it
is bound to an initiator group. If a port set is bound to an initiator group, you can do one
of the following:
specify the force option to unbind the port set from the initiator group and delete
the port set.
use the lun igroup unbind command to unbind the port set from the initiator
group. Then you can delete the port set.
Note:
Parameters
Specifies the port set you want to delete.
Forcibly unbinds the port set from the initiator group.
Examples
cluster1::> portset delete -vserver vs1 -portset ps1
Deletes port set ps1 on Vserver vs1.
See Also
383
lun igroup unbind
384
lun portset remove

Remove iSCSI/FCP LIFs from a portset
Description
This command removes a LIF from a port set.
You cannot remove the last LIF in a port set if the port set is bound to an initiator group
(igroup). To remove the last LIF in a port set, use the lun igroup unbind command
to unbind the port set from the igroup. Then you can remove the last LIF in the port set.
Note:
Parameters
Specifies the port set you want to remove a LIF from.
-port-name <port_name>, ... - LIF or TPG Name
Specifies the LIF name you want to remove from the port set.
Examples
cluster1::> port set remove -vserver vs1 -portset ps1 -port-name lif1
Removes port lif1 from port set ps1 on Vserver vs1.
See Also
lun igroup unbind
385
lun portset show

Displays a list of portsets
Description
This command displays the LIFs in a port set. By default, the command displays all LIFs
in all port sets.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the port sets that match this parameter value.
[-portset <text>] - Portset Name
[-port-name <port_name>, ...] - LIF Or TPG Name
[-protocol <protocol_enum>] - Protocol
[-port-count <integer>] - Number Of Ports
[-igroups <igroup>, ...] - Bound To Igroups
386
Examples
cluster1::> lun portset show
Vserver
Portset
Protocol Port Names
Igroups
--------- ------------ -------- ----------------------- -----------vs1
ps0
mixed
lif1, lif2
igroup1
ps1
iscsi
lif3
igroup2
ps2
fcp
lif4
The example above displays all port sets.

cluster1::> lun portset show -port-count 0
Vserver
Portset
Protocol Port Names
Igroups
--------- ------------ -------- ----------------------- -----------vs1
p1
iscsi
The example above displays the port sets that contain zero LIFs.
cluster1::> lun portset show -protocol iscsi
Vserver
Portset
Protocol Port Names
Igroups
--------- ------------ -------- ----------------------- -----------vs1
p1
iscsi
vs1
iscsips
iscsi
lif1
igroup1
The example above displays the port sets that have the iSCSI protocol.
cluster1::> lun portset show -port-name lif1
Vserver
Portset
Protocol Port Names
Igroups
--------- ------------ -------- ----------------------- -----------vs1
iscsips
iscsi
lif1
igroup1
The example above displays the port sets that contain LIF lif1.
387
lun transition show

Display the status of LUN transition processing
privilege level.
Description
The lun transition show command displays information about the LUN transition
processing status of volumes. If no parameters are specified, the command displays the
following information about all volumes:
Vserver name
Volume name
Transition status
Parameters
specify.
| [-instance ] }
about all fields.
Selects the volumes in the specified Vserver.
Selects the volumes with the specified name.
[-status {none|complete|failed}] - Transition Status
Selects the volumes that match the specified transition status. The possible status
values are:
complete - LUN transition has completed for the volume.
failed - LUN transition has failed for the volume.
388
none - The volume did not contain LUNs to transition from Data ONTAP 7-Mode.
Selects the volumes in the Vserver that matches the specified UUID.
[-node <nodename>] - Filer ID
Selects the volumes that match the specified node.
Examples
The following example displays LUN transition information for all volumes in a Vserver
named vs1:
cluster1::*> lun transition show -vserver vs1
Vserver
Volume
Transition Status
-------------------- ------------------ ----------------vs1
vol0
none
vol1
complete
vol2
failed
389
lun transition start

Start LUN Transition Processing
privilege level.
Description
The lun transition start command starts LUN transition for the specified
volume. Normally, transition is started automatically when snapmirror break
is issued for the volume, this command allows restarting in the event automatic
transitioning was interrupted or failed.
Parameters
The name of the Vserver containing the volume. If only one data Vserver exists, you do
not need to specify this parameter.
The name of the volume to restart LUN transition.
Examples
The following example starts LUN transition on a volume named volume1 in a Vserver
named vs1:
cluster1::*> lun transition start -vserver vs1 -volume vol1
See Also
snapmirror break
390
lun transition 7-mode delete

Delete an Untransitioned 7-Mode LUN
privilege level.
Description
The lun transition 7-mode delete command deletes an untransitioned LUN
copied from a Data ONTAP 7-Mode system. This allows the admin to recover space
from the volume for LUNs that may not be transitioned to clustered Data ONTAP without
distrupting LUNs that have transitioned, for example, if the LUN is an unsupported OS
type.
Parameters
This specifies the name of the Vserver from which the LUN is to be deleted. If only one
data Vserver exists, you do not need to specify this parameter.
This specifies the path to the LUN to delete.
Examples
The following example deletes the LUN /vol/vol1/lun1 in a Vserver named vs1:
cluster1::*> lun transition 7-mode delete -vserver vs1 -path /vol/vol1/lun1
lun transition 7-mode show

Display the 7-Mode LUN Inventory
privilege level.
Description
391
The lun transition 7-mode show command displays information about LUNs
copied from a Data ONTAP 7-Mode system. If no parameters are specified, the
command displays the following information about all 7-Mode LUNs:
Vserver name
LUN path
Operating system type
Size
Whether or not the LUN has been transitioned to clustered Data ONTAP
Parameters
specify.
| [-instance ] }
about all fields.
Selects the 7-Mode LUNs in the specified Vserver.
[-path <path>] - LUN Path
Selects the 7-Mode LUNs with the specified path.
Selects the 7-Mode LUNs that match the specified volume.
[-ostype <os_enum>] - OS Type
Selects the 7-Mode LUNs that match the specified operating system type.
[-size <size>] - LUN Size
Selects the 7-Mode LUNs that match the specified size.
[-prefix-size <size>] - Prefix Stream Size
Selects the 7-Mode LUNs that match the specified prefix stream size.
[-suffix-size <size>] - Suffix Stream Size
Selects the 7-Mode LUNs that match the specified suffix stream size.
392

Selects the 7-Mode LUNs that match the specified serial number for clustered Data
ONTAP. LUNs where is-transitioned is false do not have a serial number assigned
for clustered Data ONTAP.
Selects the 7-Mode LUNs that match the specified UUID for clustered Data ONTAP.
LUNs where is-transitioned is false do not have a UUID assigned for clustered
Data ONTAP.
[-serial-7-mode <text>] - 7-mode Serial Number
Selects the 7-Mode LUNs that match the specified serial number from 7-Mode.
[-is-transitioned {true|false}] - Transition Complete
Selects the 7-Mode LUNs that match the specified transition state. LUNs where this
value is true have been transitioned and are available to be mapped for client access.
LUNs where this value is false have not yet been transitioned and may not be mapped.
Selects the 7-Mode LUNs that match the specified Vserver UUID.
Selects the 7-Mode LUNs that match the specified node name.
Examples
The following example displays a summary of all 7-Mode LUNs for the volume vol1 in a
Vserver named vs1:
cluster1::*> lun transition 7-mode show -vserver vs1 -volume vol1
Vserver
Path
Type
Size
Transitioned
--------- ---------------------------- -------- ------ -----------vs1
/vol/vol1/lun1
linux
/vol/vol1/lun2
linux
500MB true
10MB false
/vol/vol1/lun3
linux
500MB true
The following example displays detailed information for the 7-Mode LUN /vol/vol1/lun2 in
a Vserver named vs1:
cluster1::*> lun transition 7-mode show -vserver vs1 -path /vol/vol1/lun2
393
Vserver Name: vs1

Volume Name: vol1
OS Type: linux
LUN Size: 500MB
Prefix Stream Size: 0
Suffix Stream Size: 0
Serial Number: BCVvv$DLZu8g
UUID: f53d603b-9663-4567-9680-95c1a9cc6d9e
7-mode Serial Number: C4eqKotPI8Ui
Transition Complete: true
Vserver UUID: be4cc135-163f-11e3-931f-123478563412
Node: cluster-01
394
metrocluster configure
Configure MetroCluster and start DR mirroring for the node and its DR group
level.
Description
The metrocluster configure command creates a MetroCluster configuration on
either all the nodes in both MetroCluster clusters or solely on nodes in a DR group. The
command configures a HA partner, DR partner, and a DR auxiliary partner for the nodes
and also starts NVRAM mirroring between the configured DR partner nodes.
In MetroCluster, a DR group is a group of four nodes, two in each of the MetroCluster
clusters:
In the local cluster, a node and its HA partner,
In the peer cluster, a node and its HA partner. These nodes are DR partners to the
nodes in the local cluster.
There can be several DR groups in the MetroCluster configuration. MetroCluster
provides synchronous DR protection to all data sets belonging to nodes within a
properly configured DR group.
Without the -node parameter, the metrocluster configure command configures
all the DR groups in both the MetroCluster clusters.
With the -node mynode parameter, the command configures both the mynode node
and its HA partner node from the local cluster, and its DR partner and DR auxiliary
partner from the peer cluster.
Before running the metrocluster configure command, the aggregates and
Vservers on each node must be prepared for the MetroCluster configuration. Each node
should have:
At least one non-root, mirrored aggregate of size greater than 10GB. This nonroot aggregate should not have any volumes in it.
No other non-root aggregates. Any other non-root, unmirrored aggregates and
volumes should be deleted.
No Vservers other than Vservers of type "node" or "admin." Any Vservers that are
not of type "node" or "admin" should be deleted.
395
A mirrored and healthy root aggregate.

After the command is successful all nodes in the local and remote clusters will have
HA, DR, and DR auxiliary partners and NVRAM mirroring between the DR partners
will be turned on. The same conditions apply for before running the metrocluster
configure -node mynode command, except that only one DR group is configured.
Parameters
[-node-name {<nodename>|local}] - Node to Configure
This optional parameter specifies the name of a single node in the local cluster. The
command creates MetroCluster configuration on the local node specified by this
parameter and the three other nodes belonging to the same DR group.
[-refresh {true|false}] - Refresh Configuration (privilege: advanced)
This optional parameter specifies if the node partner configuration steps should be
done again. Not specifying this parameter will cause the MetroCluster configuration to
continue using the current node partner information.
Examples
The following example shows the creation of the MetroCluster configuration for a single
DR group:
clusA::> metrocluster show
Cluster
Configuration State
Mode
------------------------------ --------------------------------------------Local: clusA
not-configured
Remote: clusB
not-configured
clusA::> metrocluster node show

DR
Configuration
DR
Group Cluster Node
State
Mirroring Mode
----- ------- ------------------ -------------- ----------------------------
clusA
clusA-01
ready to configure
clusA-02
ready to configure
clusA-03
ready to configure
clusA-04
ready to configure
396

clusA::> metrocluster configure -node clusA-01
[Job 45] Job succeeded: Configure is successful
Cluster
Configuration State
Mode
------------------------------ --------------------------------------------Local: clusA
partially-configured
normal
Remote: clusB
normal

DR
Configuration
DR
Group Cluster Node
State
Mirroring Mode
----- ------- ------------------ -------------- ----------------------------
clusA
clusA-03
ready to configure
clusA-04
ready to configure
-
clusA-01
configured
enabled
normal
clusA-02
configured
enabled
normal
clusB-01
configured
enabled
normal
clusB-02
configured
enabled
normal
clusA
clusB
The following example shows the creation of the MetroCluster configuration for all DR
groups:
Cluster
Configuration State
Mode
------------------------------ --------------------------------------------Local: clusA
not-configured
Remote: clusB
not-configured

DR
Configuration
DR
Group Cluster Node
State
Mirroring Mode
397
----- ------- ------------------ -------------- ----------------------------
clusA
clusA-01
ready to configure
-
clusA-02
ready to configure
clusA-03
ready to configure
clusA-04
ready to configure

clusA::> metrocluster configure
[Job 45] Job succeeded: Configure is successful
Cluster
Configuration State
Mode
------------------------------ --------------------------------------------Local: clusA
configured
normal
Remote: clusB
configured
normal

DR
Configuration
DR
Group Cluster Node
State
Mirroring Mode
----- ------- ------------------ -------------- ---------------------------1
clusA
clusB
clusA
clusB
clusA-01
configured
enabled
normal
clusA-02
configured
enabled
normal
clusB-01
configured
enabled
normal
clusB-02
configured
enabled
normal
clusA-03
configured
enabled
normal
clusA-04
configured
enabled
normal
clusB-03
configured
enabled
normal
clusB-04
configured
enabled
normal
See Also
metrocluster show metrocluster unconfigure
398
metrocluster heal
Heal DR data aggregates and DR root aggregates
level.
Description
The metrocluster heal command heals DR data aggregates and DR root
aggregates in preparation for a DR switchback. You must issue this command twice
to complete the two phases of the healing process: first to heal the aggregates by
resynchronizing the mirrored plexes and then to heal the root aggregates by switching
them back to the disaster site. The DR partner nodes must be powered off and remote
disk shelves must be powered on before running this command.
Parameters
-phase {aggregates|root-aggregates} - MetroCluster Healing Phase
This parameter specifies the healing phase. The first phase, aggregates, heals
aggregates by resynchronizing mirrored plexes. The second phase, root-aggregates,
heals the root aggregates of partner nodes. Healing root aggregates switches them
back to the disaster site, allowing the site to boot up.
[-override-vetoes [true]] - Override All Soft Vetoes
This optional parameter overrides almost all heal operation soft vetoes. If this optional
parameter is set to true, the system overrides subsystem soft vetoes that might
prevent the heal operation. Hard vetoes cannot be overridden and can still prevent the
switchback operation.
Examples
The following example performs the healing of both the aggregates and root
aggregates:
cluster1::> metrocluster heal -phase aggregates
[Job 136] Job succeeded: Heal Aggregates is successful
cluster1::> metrocluster heal -phase root-aggregates
[Job 137] Job succeeded: Heal Root Aggregates is successful
399
400
metrocluster modify
Modify MetroCluster configuration options
privilege level.
Description
The metrocluster modify command modifies MetroCluster parameters for nodes in
the MetroCluster configuration.
Parameters
-node-name {<nodename>|local} - Node to Change the Option On
Specifies the node in the cluster for which the parameter needs to be modified.
-node-object-limit {on|off} - Node Object Limit Option
This parameter specifies whether the node-object-limit for the node is enforced or not.
The possible values for this field are on or off and by default this option is set to on. The
very first metrocluster configure command for a node sets the option to on. If all
the nodes in a DR group have this option enabled (the default state), then all the nodes
in that DR group are protected from double failures.
A double failure is a scenario where a single node would require to serve data for
more than one partner node. There are two double failure cases. In the first case, a
switchover occurs (the first failure) followed by a local HA takeover within the surviving
site (the second failure). For example, a failure at one site causes a switchover. Node A
is on the surviving site and begins serving data for its DR partner. Now a failure occurs
on a node A's HA partner, and node A takes over its HA partner. In the second case, a
takeover has occurred (the first failure) followed by a switchover at the same site where
takeover happened due to failure at partner site (the second failure). For example,
a failure at one site causes a takeover at node A. Node A starts serving data for its
HA partner node after takeover. Now a failure occurs at the partner site and node A
switches over its DR partner. In both these double failure cases, node A must serve data
for both its DR partner (on the failed site) and its local HA partner.
Note that an HA takeover followed by a disaster at the same site where the takeover
happened it treated as a single failure.
If this option is disabled on any node in a DR group, all the nodes in that DR group are
not protected from a double failure and nodes in the DR group would be unable to serve
data for more than one partner node. In the case of a two-node cluster configuration, the
401
failure of a node that is already in switchover mode can result the inability of the entire
cluster (including the final surviving node) to serve data, resulting in client disruption.
If the metrocluster unconfigure command is issued, the option will be set to off
and node will continue to operate without being configured as part of the MetroCluster
configuration.
Examples
clusA::*> metrocluster modify -node-name clusA-01 -node-object-limit on
[Job 168] Job succeeded: Modify is successful
See Also
metrocluster configure metrocluster unconfigure
402
metrocluster show
Display MetroCluster configuration information
level.
Description
The metrocluster show command displays configuration information for the pair of
clusters configured in MetroCluster.
This command displays the following details about the local cluster and the DR partner
cluster:
Configuration State: This field specifies the configuration state of the cluster.
Mode: This field specifies the operational mode of the cluster.
Parameters
None
Examples
The following example shows the output of the command before MetroCluster
configuration is done:
Cluster
Configuration State
Mode
------------------------------ --------------------------------------------Local: clusA
not-configured
Remote: clusB
not-configured
The following example shows the output of the command after MetroCluster
configuration is done only for some DR groups:
Cluster
Configuration State
Mode
------------------------------ --------------------------------------------Local: clusA
403
Remote: clusB
The following example shows the output of the command after MetroCluster
Cluster
Configuration State
Mode
------------------------------ --------------------------------------------Local: clusA
configured
Remote: clusB
configured
The following example shows the output of the command in switchover mode:
Cluster
Configuration State
Mode
------------------------------ --------------------------------------------Local: clusA

Remote: clusB
configured
switchover
not-reachable
See Also
metrocluster node show metrocluster configure metrocluster unconfigure
404
metrocluster switchback
Switch back storage and client access
level.
Description
The metrocluster switchback command initiates the switchback of storage and
client access from nodes in the DR site to their home nodes. The home nodes and
storage shelves must be powered on and reachable by nodes in the DR site. The
metrocluster heal -phase aggregates and metrocluster heal -phase
root-aggregates commands must have successfully completed before running the
metrocluster switchback command.
Parameters
[-override-vetoes | -f [true]] - Override All Soft Vetoes
This optional parameter overrides all switchback operation soft vetoes. If this optional
parameter is used, the system overrides subsystem soft vetoes that might prevent
the switchback operation. Hard vetoes cannot be overridden and can still prevent the
switchover operation.
[-simulate [true]] - Simulate Switchback (privilege: advanced)
If this optional parameter is used, the system runs a simulation of the switchback
operation to make sure all the prerequisites for the operation are met. This parameter
cannot be used with switchback operations performed for switching back left-behind
aggregates or for retrying a partially successful switchback.
Examples
The following is an example of how to start the switchback operation.
clusA::> metrocluster switchback
See Also
metrocluster heal
405
metrocluster switchover
Switch over storage and client access
level.
Description
The metrocluster switchover command initiates the switchover of storage
and client access from the source cluster to the disaster recovery (DR) site. This
command is to be used after a disaster that renders all the nodes in the source cluster
unreachable and powered off. It can also be used for negotiated switchover when the
outage of the source cluster is anticipated as in cases such as disaster recovery testing
or a site going offline for maintenance. If a switchover operation previously failed on
certain nodes on the DR site then issuing the command retries the operation on all of
those nodes.
Parameters
{ [-forced-on-disaster [true]] - Force Switchover on Disaster
This optional parameter forces a switchover on disaster. This parameter should be used
if all the nodes on the disaster stricken site are powered off and unreachable. In the
absence of this parameter, the command attempts to perform a negotiated switchover
operation.
| [-simulate [true]] } - Simulate Negotiated Switchover (privilege: advanced)
If this optional parameter is used, the system runs a simulation of the negotiated
switchover operation to make sure all the prerequisites for the operation are met.
This parameter cannot be used with switchover with the -forced-on-disaster
parameter.
[-force-nvfail-all [true]] - Sets in-nvfailed-state on All Volumes (privilege: advanced)
If this parameter is used, the switchover command will set the in-nvfailed-state
parameter to true for all volumes being switched over and will set the -dr-forcenvfail parameter to true for any volumes that do not already have it enabled. This
parameter has no effect when performning a negotiated switchover.
[-override-vetoes [true]] - Override All Soft Vetoes
This optional parameter overrides all switchover operation soft vetoes. If this parameter
is used, the system overrides all subsystem soft vetoes that might prevent the
406
switchover operation. Hard vetoes cannot be overridden and can still prevent the
switchover operation.
[-retry-failed-nodes <Node name>, ...] - Nodes to Switchover
This optional parameter takes the list of nodes that previously failed the switchover
operation and it retries the switchover operation on each of the nodes. This parameter is
applicable only for a switchover with the -forced-on-disaster parameter.
Examples
When a disaster strikes one site, the metrocluster switchover command is issued
on the disaster recovery site as follows:
cluster1::> metrocluster switchover -forced-on-disaster true
Warning: MetroCluster switchover is a Disaster Recovery operation that could
cause some data loss. The cluster on the other site must either be
prevented from serving data or be simply powered off (nodes and disk
shelves)
The following nodes ( cluster1-01 cluster1-02 ) will participate in
the switchover operation
Queued job. Use 'metrocluster operation show' to check status of the DR
operation.
cluster1::> metrocluster operation show
Operation: switchover
State: successful
Start time: 10/3/2013 22:11:47
End time: 10/3/2013 22:11:53
Errors: -
See Also
metrocluster show metrocluster operation show metrocluster heal
metrocluster switchback
407
metrocluster unconfigure
Unconfigure MetroCluster
privilege level.
Description
The metrocluster unconfigure command removes the MetroCluster configuration
on either all the nodes in a MetroCluster cluster or solely on the nodes in a DR group.
This command must be run on both the local cluster and remote cluster to fully remove
the MetroCluster configuration.
In a MetroCluster configuration, a DR group is a group of four nodes, two in each of the
MetroCluster clusters:
In the local cluster, a node and its HA partner,
In the peer cluster, a node and its HA partner. These nodes are DR partners to the
nodes in the local cluster.
MetroCluster provides synchronous DR protection to all data sets belonging to nodes
within a properly configured DR group.
Without the -dr-group-id parameter, the metrocluster unconfigure command
unconfigures all the DR groups in the local MetroCluster cluster.
With the -dr-group-id parameter, the command removes all the nodes in the
specified DR group in the local MetroCluster cluster. Before running metrocluster
unconfigure -dr-group-id, all data resources (aggregates, volumes, data LIFs,
etc.) owned by the affected nodes must be either migrated to nodes remaining in the
MetroCluster configuration or they must be deleted. After running this command, all the
nodes in the DR group must be unjoined from the cluster.
Note:
After removing the MetroCluster configuration on either a DR group or all the nodes
in both MetroCluster clusters, all Fibre Channel resources used by the affected nodes
must be dismantled. This includes FC-VI adapters, FCP adapters, FC switches and
ATTO bridges.
Parameters
408
[-dr-group-id <integer>] - Identifier of the DR Group to Unconfigure

This optional parameter specifies the DR group identifier for a group of nodes
configured as partners in the MetroCluster configuration. The command removes the
MetroCluster configuration from all nodes that belong to the DR group in the local
cluster only.
Examples
The following example shows the removal of the MetroCluster configuration:
clusA::>metrocluster show
Cluster
Configuration State
Mode
------------------------------ ---------------------- -----------------------Local: clusA
configured
normal
Remote: clusB
configured
normal

DR
Configuration
DR
Group Cluster Node
State
Mirroring Mode
----- ------- ------------------ -------------- --------- -------------------1
clusA
clusB
clusA-01
configured
enabled
normal
clusA-02
configured
enabled
normal
clusB-01
configured
enabled
normal
clusB-02
configured
enabled
normal

clusA::*> metrocluster unconfigure -dr-group-id 1
Warning: the nodes removed from the MetroCluster setup will lose their DR
protection.
Warning: only the local nodes "clusA-01 clusA-02 " will be removed
from the MetroCluster setup. Re-issue the command on the peer cluster
"clusB" to remove the other nodes in the DR group from the
MetroCluster configuration.
[Job 62] Job succeeded: Unconfigure is successful
clusA::*> metrocluster show
Cluster
Configuration State
Mode
------------------------------ ---------------------- -----------------------Local: clusA
not-configured
409
Remote: clusB
configured
normal
clusA::*> metrocluster node show

DR
Configuration
DR
Group Cluster Node
State
Mirroring Mode
----- ------- ------------------ -------------- --------- --------------------
clusA
clusA-01
ready to configure
-
clusA-02
ready to configure
-
clusB::> metrocluster show

Cluster
Configuration State
Mode
------------------------------ ---------------------- -----------------------Local: clusB
configured
normal
not-configured
Remote: clusA
clusB::> metrocluster node show
DR
Configuration
DR
Group Cluster Node
State
Mirroring Mode
----- ------- ------------------ -------------- --------- -------------------1
clusB
clusA
clusB-01
configured
enabled
normal
clusB-02
configured
enabled
normal
clusA-01
ready to configure
clusA-02
ready to configure

clusB::*> metrocluster unconfigure
Warning: all nodes in the local cluster ("clusB") will lose their synchronous
disaster recovery protection. You must manually repeat the operation
on the peer cluster ("clusA"). When this is complete, the nodes in
both clusters will not be protected.
[Job 61] Job succeeded: Unconfigure is successful
clusB::*> metrocluster show
Cluster
410
Configuration State
Mode
------------------------------ ---------------------- -----------------------Local: clusB
not-configured
Remote: clusA
not-configured
clusB::*> metrocluster node show

DR
Configuration
DR
Group Cluster Node
State
Mirroring Mode
----- ------- ------------------ -------------- --------- --------------------
clusB
clusB-01
ready to configure
clusB-02
ready to configure
See Also
metrocluster show metrocluster configure cluster unjoin
411
metrocluster check run

Check the MetroCluster setup
level.
Description
The metrocluster check run command performs checks on the MetroCluster
configuration and reports configuration errors if any.
Note:
This command only checks if the MetroCluster software configuration components listed
in the sub-directories have been following the MetroCluster best practice guidelines.
This command does not check the health of the components such as hardware or backend fabric. To check if the nodes are ready to do a switchover or switchback operation,
run "metrocluster switchover -simulate" or "metrocluster switchback simulate", respectively.
To run this command, at least one DR group needs to be configured. The command
checks the following parts of the configuration:
Node Configuration:
node-reachable: This check verifies that the node is reachable.
metrocluster-ready: This check verifies that the node is ready for MetroCluster
configuration.
local-ha-partner: This check verifies that the HA partner node is in the same
cluster.
ha-mirroring-on: This check verifies that HA mirroring for the node is configured.
symmetric-ha-relationship: This check verifies that the relationship between the
node and its HA partner is symmetric.
remote-dr-partner: This check verifies that the DR partner node is in the remote
cluster.
dr-mirroring-on: This check verifies that DR mirroring for the node is configured.
symmetric-dr-relationship: This check verifies that the relationship between the
node and its DR partner is symmetric.
412
remote-dr-auxiliary-partner: This check verifies that the DR auxiliary partner node

is in the remote cluster.
symmetric-dr-auxiliary-relationship: This check verifies that the relationship
between the node and its DR auxiliary partner is symmetric.
storage-failover-enabled: This check verifies that storage failover is enabled.
has-intercluster-lif: This check verifies that the node has an intercluster LIF.
node-object-limit: This check verifies that the node object limit option for the node
is turned on.
Aggregate Configuration:
mirroring-status: This check verifies that the aggregate is mirrored.
disk-pool-allocation: This check verifies that the disks belonging to this aggregate
have been correctly allocated to the right pools.
At the end of the check the command displays a summary of the results. This summary
output can be viewed again by running metrocluster check show. If any of the
rows in this output show any warnings more details can be viewed by running the
metrocluster check show command for that component.
Parameters
None
Examples
The following example shows the execution of the command when there are no
warnings:
clusA::> metrocluster check run
Last Checked On: 4/9/2014 20:11:46
Component
Result
------------ --------nodes
ok
lifs
ok
aggregates
ok
413
Command completed. Use the "metrocluster check show -instance" or

"metrocluster check" commands to view detailed status.
The following example shows the execution of the command when there are some
warnings:
clusA::> metrocluster check run
Last Checked On: 4/9/2014 20:11:46
Component
Result
------------ --------nodes
warning
lifs
ok
aggregates
ok

Command completed. Use the "metrocluster check show -instance" or
"metrocluster check" commands to view detailed status.
See Also
metrocluster switchover -simulate metrocluster switchback -simulate
metrocluster check show metrocluster check node show metrocluster check lifs show
metrocluster check aggregate show
414
metrocluster check show

Show the results of the last instance of MetroCluster check
level.
Description
The metrocluster check show command displays the results of metrocluster
check run command.
This command displays the high-level verification results for each of the components.
If there any errors for a component, running the show command for that component
(for example metrocluster check node show or metrocluster check
aggregate show) will display more information about the warning.
Note:
This command only shows the result of checking if the MetroCluster software
configuration components listed in the sub-directories have been following the
MetroCluster best practice guidelines. This command does not display the health of
the components such as hardware or back-end fabric. To check if the nodes are ready
to do a switchover or switchback operation, run "metrocluster switchover simulate" or "metrocluster switchback -simulate", respectively.
Note:
Please note that this command does not run the checks but only displays the results of
checks. To look at the latest results, run the metrocluster check run command
and then run this command.
Parameters
specify.
| [-instance ] }
415
about all fields.
[-timestamp <MM/DD/YYYY HH:MM:SS>] - Time of Check
This is the time at which the metrocluster check run command was last run in this
cluster and these results were produced. If this parameter is specified, only rows with
this timestamp will be displayed.
[-component <MetroCluster Component>] - Name of the Component
This is the name of the component. If this parameter is specified, only rows with this
component will be displayed.
[-result <MetroCluster Check Result>] - Result of the Check
This is the result of the check for the component. If this parameter is specified, only rows
with this result will be displayed.
[-additional-info <text>] - Additional Information/Recovery Steps
This is the additional info for the verification for this component. This field will have
detailed information about the warning and recovery steps. If this parameter is specified,
only rows with this additional info will be displayed.
Examples
The following example shows the execution of the command when there are no
warnings:
clusA::> metrocluster check show
Last Checked On: 4/9/2014 20:11:46
Component
Result
------------------ --------nodes
ok
lifs
ok
config-replication ok
aggregates
ok
The following example shows the execution of the command when there are some
warnings:
416
clusA::> metrocluster check show

Last Checked On: 4/9/2014 20:11:46
Component
Result
------------------ --------nodes
warning
lifs
ok
config-replication ok
aggregates
ok
The following example shows the execution of the command with -instance option:
clusA::> metrocluster check show -instance
Time of Check: 1/7/2014 00:42:58
Name of the Component: nodes
Result of the Check: warning
Additional Information/Recovery Steps:
Time of Check: 1/7/2014 00:42:58
Name of the Component: lifs
Result of the Check: ok
Time of Check: 1/7/2014 00:42:58
Name of the Component: config-replication
Time of Check: 1/7/2014 00:42:58
Name of the Component: aggregates
417
See Also
metrocluster check run metrocluster check node show
metrocluster check aggregate show metrocluster switchover -simulate
metrocluster switchback -simulate metrocluster check lifs show
metrocluster check config-replication show
418

Show results of MetroCluster check for aggregates
level.
Description
The metrocluster check aggregate show command displays the results of
aggregate checks performed by the metrocluster check run command.
The command verifies the following aspects of the configuration of all aggregates in
MetroCluster:
mirroring-status: This check verifies that the aggregate is mirrored.
disk-pool-allocation: This check verifies that the disks belonging to this aggregate
have been correctly allocated to the right pools.
Additional information about the warnings (if any) and recovery steps can be viewed by
running the command with the -instance option.
Parameters
specify.
| [-instance ] }
about all fields.
[-node <Node name>] - Node Name
This is the name of the node for which the check was run. If this parameter is specified,
only rows with this node will be displayed.
[-aggregate <aggregate name>] - Name of the Aggregate
This is the name of the aggregate for which the check was run. If this parameter is
specified, only rows with this aggregate will be displayed.
[-check <MetroCluster Aggregate Check>] - Type of Check
419
This is the type of the check performed. If this parameter is specified, only rows with this
check will be displayed.
[-cluster <Cluster name>] - Name of Cluster
This is the name of the cluster the node belongs to. If this parameter is specified, only
rows with this cluster will be displayed.
This is the result of the check. If this parameter is specified, only rows with this result will
be displayed.
[-additional-info <text>, ...] - Additional Information/Recovery Steps
This is additional information about the check. This field has more information and
recovery steps for the warning. If this parameter is specified, only rows with this
additional info will be displayed.
Examples
The following example shows the execution of the command in a MetroCluster
configuration with two nodes per cluster:
clusA::> metrocluster check aggregate show
Last Checked On: 4/9/2014 20:11:46
Node
Aggregate
Check
Result
--------------------- --------------------- --------------------- --------clusA-01
a1_required_data_aggr
mirroring-status
ok
disk-pool-allocation
ok
mirroring-status
ok
ok
mirroring-status
ok
ok
mirroring-status
ok
ok
mirroring-status
ok
aggr0_a1
clusA-02
a2_required_data_aggr
aggr0_a2
clusB-01
420
b1_required_data_aggr
ok
mirroring-status
ok
ok
mirroring-status
ok
ok
mirroring-status
ok
ok
aggr0_b1
clusB-02
aggr0_b2
b2_required_data_aggr
clusA::> metrocluster check aggregate show -instance
Node Name: clusA-01
Name of the Aggregate: a1_required_data_aggr_1
Type of Check: mirroring-status
Name of Cluster: clusA
Additional Information/Recovery Steps: Node Name: clusA-01
Type of Check: disk-pool-allocation
421

Name of the Aggregate: aggr0_a1
Additional Information/Recovery Steps: Root aggregate "aggr0_a1" is un-mirrored.
Root aggregates should be mirrored in a MetroCluster configuration.
Node Name: clusA-01
Name of the Aggregate: aggr0_a1
Additional Information/Recovery Steps: Node Name: clusB-01
Name of the Aggregate: aggr0_b1
Name of Cluster: clusB
Name of the Aggregate: aggr0_b1
Name of the Aggregate: b1_required_data_aggr_1
422

Additional Information/Recovery Steps: 12 entries were displayed.
See Also
metrocluster check run metrocluster check show metrocluster check node show
metrocluster check lifs show
423
metrocluster check config-replication showaggregate-eligibility

level.
Description
The metrocluster check config-replication show-aggregateeligibility command displays the MetroCluster configuration replication aggregate
eligibility.
Parameters
specify.
| [-instance ] }
about all fields.
This is the aggregate name. If this parameter is specified, only rows with this aggregate
will be displayed.
[-hosted-configuration-replication-volumes <volume name>, ...] - Currently Hosted
Configuration Replication Volumes
This is the list of the configuration replication volumes hosted on this aggregate. If this
parameter is specified, only rows with these configuration replication volumes will be
displayed.
[-is-eligible-to-host-additional-volumes {true|false}] - Eligibility to Host Another
Configuration Replication Volume
This is the eligibility of the aggregate to host additional configuration replication
volumes. If this parameter is specified, only rows with this eligibility will be displayed.
[-comment <text>] - Comment for Eligibility Status
424
This is a comment regarding the eligibility of the aggregate to host configuration

replication volumes. If this parameter is specified, only rows with this comment will be
displayed.
Examples
configuration with thirteen aggregates in the cluster:
clusA::metrocluster check config-replication> show-aggregate-eligibility
Eligible to
Aggregate
Hosted Config Replication Vols
Host Addl Vols Comments
------------ ------------------------------------------ -------------- -------a0

Aggregate
false
Root
a1
MDV_CRS_1bc7134a5ddf11e3b63f123478563412_A true
a2
MDV_CRS_1bc7134a5ddf11e3b63f123478563412_B true
a3
determine available space of aggregate
false
Unable to
a4
Aggregate
false
Non-Local
a5
Aggregate
false
Non-Home
a6
determine mirror configuration
false
Unable to
a7
configuration does not match requirement
false
Mirror
a8
Aggregate
false
Disallowed
a9
Insufficient Space - 10GB required
false
a10
Offline
false
a11
Inconsistent Aggregate
false
a12
Full
false
Aggregate
Aggregate
See Also
metrocluster check run metrocluster check show metrocluster check configreplication show
425
metrocluster check config-replication showcapture-status

Display MetroCluster capture status information
privilege level.
Description
The metrocluster check config-replication show-capture-status
command indicates whether or not a configuration change that would prevent a
negotiated switchover is currently being captured for replication.
Parameters
None
Examples
configuration when capture is not in progress:
cluster1::*> metrocluster check config-replication show-capture-status
Is Capture in Progress: false
See Also
metrocluster check run metrocluster check show
426
metrocluster check config-replication show

Display MetroCluster config-replication status information
level.
Description
The metrocluster check config-replication show command displays the
results of MetroCluster configuration replication.
The command verifies the following aspects of MetroCluster configuration replication :
Enabled: Verifies that MetroCluster configuration replication is enabled on the
cluster.
Running: Verifies that MetroCluster configuration replication is running on the
cluster.
Remote Heartbeat: Verifies that the MetroCluster configuration replication
heartbeat with the remote cluster is healthy.
Last Heartbeat Sent: Prints the timestamp of the last MetroCluster configuration
replication heartbeat sent to the remote cluster.
Last Heartbeat Received: Prints the timestamp of the last MetroCluster
configuration replication hearbeat received from the remote cluster.
Storage Status: Verifies that MetroCluster configuration replication storage is
healthy.
Storage In Use: Prints the location of MetroCluster configuration replication
storage.
Storage Remarks: Prints the underlying root cause for non healthy MetroCluster
configuration storage.
Vserver Streams: Verifies that MetroCluster configuration replication Vserver
streams are healthy.
Cluster Streams: Verifies that MetroCluster configuration replication Cluster
streams are healthy.
427
Parameters
[-instance ]
If you specify the -instance parameter, the command displays detailed information about
all fields.
Examples
The following example shows the output of metrocluster check configreplication show:
clusA::metrocluster check config-replication> show
Enabled: true
Running: true
Remote Heartbeat: ok
Last Heartbeat Sent: 12/12/2013 14:24:59
Last Heartbeat Received: 12/12/2013 14:25:00
Storage Status: ok
Storage In Use: Cluster-wide Volume:
MDV_CRS_1bc7134a5ddf11e3b63f123478563412_A
Storage Remarks: Vserver Streams: ok
Cluster Streams: ok
See Also
metrocluster check run metrocluster check show metrocluster check configreplication show-aggregate-eligibility
428
metrocluster check lif repair-placement

Repair LIF placement for the sync-source Vserver LIFs in the destination cluster
level.
Description
The metrocluster check lif repair-placement command reruns LIF
placement for those LIFs displayed by the metrocluster check lif show
command. This command is expected to be run after the admin manually rectifies
the LIF placement failures displayed in the metrocluster check lif show
command output. The command is successful if the LIF placement rerun does not
encounter any LIF placement failure. This is to be confirmed by subsequent running of
the metrocluster check lif show .
Parameters
-vserver <Vserver Name> - sync-source Vserver Name
This is the name of the sync source Vserver that has LIF placement failures as reported
by the metrocluster check lif show command. This input ensures that the
command is run on the specified Vserver.
[-lif <lif-name>] - Logical Interface Name
This is the Logical Interface name that belongs to the sync source Vserver that has
a LIF placement failure in the destination cluster as reported by the metrocluster
check lif show command. This input ensures that the command is run on the
specified LIF only.
Examples
The following example shows the execution of the command with a sync source Vserver
and a LIF specified:
clusA::> metrocluster check lif repair-placement -vserver vs1.example.com -lif
fcplif1
Command completed. Run the "metrocluster check lif show" command for results.
clusA::> metrocluster check lif repair-placement -vserver vs1.example.com -lif
iscsilif1
429
The following example shows the execution of the command with only a sync-source
Vserver specified:
clusA::> metrocluster check lif repair-placement -vserver
vs1.example.com
clusA::>
See Also
metrocluster check lif show
430
metrocluster check lif show

Show LIF placement failures in MetroCluster configuration
level.
Description
The metrocluster check lif show command displays the LIF placement failures
of sync source Vservers in the MetroCluster configuration. The LIF placement failures
are mostly fabric/network connectivity issues that require manual intervention. Once the
connectivity issues are resolved manually, the admin is expected to run metrocluster
check lif repair-placement command to resolve the LIF placement issues for
the sync source Vserver.
Parameters
specify.
| [-instance ] }
about all fields.
[-vserver <Vserver Name>] - sync-source vserver in MetroCluster configuration
This is the name of the sync source Vserver in the MetroCluster configuration
This is the name of the LIF of the sync-source Vserver
[-data-protocol {nfs|cifs|iscsi|fcp|fcache|none}, ...] - Data protocol
This is the name of the data protocols that the sync source Vserver LIF belongs to. The
supported data protocols are fcp, iscsi, nfs, cifs and fcache
[-lif-placement-failure <text>] - LIF placement Failure Type
This is the type of LIF placement failure that occurred on the sync source Vserver LIF.
The LIF placement failure can be categorized from any of the below, depending on the
type of failure discovered.
431
Port hosting the sync source vserver FC LIF in the source cluster is not connected
to any fabric: This failure is reported due to a lack of fabric connectivity of the FC
port hosting the sync source Vserver FC LIF in the source cluster.
No ports found on MetroCluster DR node connected to fabric with fabric name :
The fabric name obtained at the source cluster and the fabric name obtained at
the destination cluster do not match. This may be due to FC ports at the source
and destination clusters not connected to the same fabric.
MetroCluster DR Node is offline: The home node of the sync-dest Vserver LIF in
the destination cluster is offline. The home-node needs to become online to rectify
this failure
No ports found on MetroCluster DR node of CNA adapter-type: The MetroCluster
DR node does not have a port of CNA adapter type to host the sync dest Vserver
LIF
No ports found on MetroCluster DR node of FC adapter-type: The MetroCluster
DR node does not have a port of FC adapter type to host the sync dest Vserver
LIF.
No ports found on MetroCluster DR node connected to the required subnet : The
MetroCluster DR node does not have ports connected to the required subnet to
host the sync dest Vserver LIF.
Examples
clusA:*> metrocluster check lif show
Vserver
LIF
Protocol
Failure
--------------
--------------
---------
----------
---------------
vs1.example.com
fcplif1
fcp
No ports found on MetroCluster DR
node Node2 connected to fabric with fabric name 20:05:00:05:73:bd:a3:01
vs1.example.com
offline
fcplif2
fcp
MetroCluster DR node Node1 is
vs1.example.com
fcplif3
node Node1 of FC adapter-type
fcp
vs1.example.com
fcplif4
node Node1 of CNA adapter-type
fcp
vs1.example.com
iplif1
nfs
node Node2 connected to the required subnet 10.1.0.0
vs1.example.com
offline
iplif2
nfs
vs1.example.com
iscsilif1
iscsi
node Node2 connected to the required subnet 10.1.0.0
432
vs1.example.com
offline
iscsilif2
iscsi
See Also
metrocluster check lif repair-placement
433
metrocluster check node show

Show results of MetroCluster check for nodes
level.
Description
The metrocluster check node show command displays the results of node
checks performed by the metrocluster check run command.
The command verifies the following aspects of the configuration of all nodes in
MetroCluster:
node-reachable: This check verifies that the node is reachable.
metrocluster-ready: This check verifies that the node is ready for MetroCluster
configuration.
local-ha-partner: This check verifies that the HA partner node is in the same
cluster.
ha-mirroring-on: This check verifies that HA mirroring for the node is configured.
symmetric-ha-relationship: This check verifies that the relationship between the
node and its HA partner is symmetric.
remote-dr-partner: This check verifies that the DR partner node is in the remote
cluster.
dr-mirroring-on: This check verifies that DR mirroring for the node is configured.
symmetric-dr-relationship: This check verifies that the relationship between the
node and its DR partner is symmetric.
remote-dr-auxiliary-partner: This check verifies that the DR auxiliary partner node
is in the remote cluster.
symmetric-dr-auxiliary-relationship: This check verifies that the relationship
between the node and its DR auxiliary partner is symmetric.
storage-failover-enabled: This check verifies that storage failover is enabled.
has-intercluster-lif: This check verifies that the node has an intercluster LIF.
node-object-limit: This check verifies that the node object limit option for the node
is turned on.
434
Parameters
specify.
| [-instance ] }
about all fields.
This is the name of the node for which the check was run. If this parameter is specified,
only rows with this node will be displayed.
[-check <MetroCluster Node Check>] - Type of Check
This is the type of the check performed. If this parameter is specified, only rows with this
check will be displayed.
[-cluster <Cluster name>] - Cluster Name
This is the name of the cluster the node belongs to. If this parameter is specified, only
rows with this cluster will be displayed.
This is the result of the check. If this parameter is specified, only rows with this result will
be displayed.
[-additional-info <text>] - Additional Information/Recovery Steps
This is additional information about the check. This field has more information and
recovery steps for the warning. If this parameter is specified, only rows with this
additional info will be displayed.
Examples
clusA::> metrocluster check node show
435
Last Checked On: 4/9/2014 20:11:46

Node
Check
Result
--------------------- ------------------------------------ --------clusA-01

node-reachable
ok
metrocluster-ready
ok
local-ha-partner
ok
ha-mirroring-on
warning
symmetric-ha-relationship
warning
remote-dr-partner
ok
dr-mirroring-on
ok
symmetric-dr-relationship
ok
remote-dr-auxiliary-partner
ok
symmetric-dr-auxiliary-relationship
warning
storage-failover-enabled
ok
has-intercluster-lif
ok
node-object-limit
ok
node-reachable
ok
metrocluster-ready
ok
local-ha-partner
ok
ha-mirroring-on
warning
warning
remote-dr-partner
ok
dr-mirroring-on
ok
ok
ok
warning
ok
ok
node-object-limit
ok
node-reachable
ok
metrocluster-ready
ok
local-ha-partner
ok
ha-mirroring-on
warning
warning
remote-dr-partner
ok
dr-mirroring-on
ok
ok
clusA-02
clusB-01
436
ok
warning
ok
ok
node-object-limit
ok
node-reachable
ok
metrocluster-ready
ok
local-ha-partner
ok
ha-mirroring-on
warning
warning
remote-dr-partner
ok
dr-mirroring-on
ok
ok
ok
warning
ok
ok
node-object-limit
ok
clusB-02
clusA::> metrocluster check node show -instance
Node Name: clusA-01
Type of Check: node-reachable
Cluster Name: clusA
Node Name: clusA-01
Type of Check: metrocluster-ready
Cluster Name: clusA
Node Name: clusA-01
Type of Check: local-ha-partner
Cluster Name: clusA
437

Node Name: clusA-01
Type of Check: ha-mirroring-on
Cluster Name: clusA
Additional Information/Recovery Steps: Node's HA mirroring is not active. Enable
it on using "storage failover" commands.
Node Name: clusA-01
Type of Check: symmetric-ha-relationship
Cluster Name: clusA
Additional Information/Recovery Steps: Partner not found. Check if node
"clusA-01's HA partner" is configured in MetroCluster.
Node Name: clusA-01
Type of Check: remote-dr-partner
Cluster Name: clusA
Node Name: clusA-01
Type of Check: dr-mirroring-on
Cluster Name: clusA
Node Name: clusA-01
Type of Check: symmetric-dr-relationship
Cluster Name: clusA
Node Name: clusA-01
Type of Check: remote-dr-auxiliary-partner
Cluster Name: clusA
438
Node Name: clusA-01

Type of Check: symmetric-dr-auxiliary-relationship
Cluster Name: clusA
"clusA-01's DR auxiliary partner" is configured in MetroCluster.
Node Name: clusA-01
Type of Check: storage-failover-enabled
Cluster Name: clusA
Additional Information/Recovery Steps: Node's storage failover is disabled.
Enable using "storage failover" commands.
Node Name: clusA-01
Type of Check: has-intercluster-lif
Cluster Name: clusA
Node Name: clusA-01
Type of Check: node-object-limit
Cluster Name: clusA
Node Name: clusB-01
Type of Check: node-reachable
Cluster Name: clusB
Node Name: clusB-01
Type of Check: metrocluster-ready
Cluster Name: clusB
Node Name: clusB-01
Type of Check: local-ha-partner
Cluster Name: clusB
439

Node Name: clusB-01
Type of Check: ha-mirroring-on
Cluster Name: clusB
Additional Information/Recovery Steps: Node's HA mirroring is not active. Enable
it on using "storage failover" commands.
Node Name: clusB-01
Type of Check: symmetric-ha-relationship
Cluster Name: clusB
"clusB-01's HA partner" is configured in MetroCluster.
Node Name: clusB-01
Type of Check: remote-dr-partner
Cluster Name: clusB
Node Name: clusB-01
Type of Check: dr-mirroring-on
Cluster Name: clusB
Node Name: clusB-01
Type of Check: symmetric-dr-relationship
Cluster Name: clusB
Node Name: clusB-01
Type of Check: remote-dr-auxiliary-partner
Cluster Name: clusB
Node Name: clusB-01
440
Type of Check: symmetric-dr-auxiliary-relationship

Cluster Name: clusB
"clusB-01's DR auxiliary partner" is configured in MetroCluster.
Node Name: clusB-01
Type of Check: storage-failover-enabled
Cluster Name: clusB
Additional Information/Recovery Steps: Node's storage failover is disabled.
Enable using "storage failover" commands.
Node Name: clusB-01
Type of Check: has-intercluster-lif
Cluster Name: clusB
Node Name: clusB-01
Type of Check: node-object-limit
Cluster Name: clusB
See Also
metrocluster check run metrocluster check show metrocluster check lifs show
441
metrocluster config-replication cluster-storageconfiguration modify

Modify MetroCluster storage configuration information
privilege level.
Description
The metrocluster config-replication cluster-storage-configuration
modify command modifies the configuration of storage used for configuration
replication.
Parameters
[-disallowed-aggregates <aggregate name>, ...] - Disallowed Aggregates
Use this parameter to set the list of storage aggregates that are not available to host
storage for configuration replication.
Examples
The following example disallows two aggregates named aggr1 and aggr2:
cluster1::*> metrocluster config-replication cluster-storage-configuration modify
-disallowed-aggregates aggr1,aggr2
See Also
metrocluster config-replication cluster-storage-configuration show
442
metrocluster config-replication cluster-storageconfiguration show

Display MetroCluster storage configuration information
privilege level.
Description
The metrocluster config-replication cluster-storage-configuration
show command shows details of the configuration of the storage used for configuration
replication.
The information displayed is the following:
Disallowed Aggregates - The list of storage aggregates that are configured as not
allowed to host storage areas.
Auto-Repair - Displays true if the automatic repair of storage areas used by
configuration replication is enabled.
Auto-Recreate - Displays true if the automatic recreation of storage volumes used
by configuration replication is enabled.
Use Mirrored Aggregate - Displays true if storage areas for configuration
replication are to be hosted on a mirrored aggregate.
Parameters
None
Examples
The following is an example of the metrocluster config-replication
cluster-storage-configuration show command:
cluster1::*> metrocluster config-replication cluster-storage-configuration show
Disallowed Aggregates: Auto-Repair: true
Auto-Recreate: true
Use Mirrored Aggregate: true
443
See Also
metrocluster config-replication cluster-storage-configuration modify
444
metrocluster config-replication resync-status show

Display MetroCluster Configuration Resynchronization Status
privilege level.
Description
The metrocluster config-replication resync-status show command
displays the state of the configuration synchronization operation between the two
clusters in the MetroCluster configuration.
This command displays the following details about the local cluster and the peer cluster:
Source: This is the source side whose configuration is being replicated to the
destination side.
Destination: This is the destination side where the configuration is being replicated
to from the source side.
State: This is the state of the synchronization operation.
% Complete: This is completion percentage of the operation.
Parameters
None
Examples
The following example shows the output of the command when synchronization is in
progress:
clusterA::> metrocluster config-replication resync-status show
Source
Destination
State
% Complete
----------------------- ----------------------- ----------- ---------clusterA
clusterB
complete
clusterB
clusterA
complete
The following example shows the output of the command when synchronization from
clusB to clusA is in progress:
445
clusA::> metrocluster config-replication resync-status show

Source
Destination
State
% Complete
----------------------- ----------------------- ----------- ---------clusterA
clusterB
complete
clusterB
clusterA
messaging
95
See Also
metrocluster show metrocluster check config-replication show
446
metrocluster interconnect adapter modify

Modify MetroCluster interconnect adapter settings
privilege level.
Description
The metrocluster interconnect adapter modify command enables you to
modify settings of the MetroCluster interconnect adapter.
Parameters
-node {<nodename>|local} - Node Name
This parameter specifies the node name.
-adapter-port-name <text> - Adapter Port Name
This parameter specifies the port name on the adapter.
-is-ood-enabled {true|false} - Is Out-of-Order Delivery Enabled?
This parameter specifies the out-of-order delivery setting on the adapter.
Examples
The following example enables out-of-order delivery for the port 'fcvi_device_0' on the
node 'clusA-01':
clusA::*> metrocluster interconnect adapter modify -node clusA-01 adapter-port-name fcvi_device_0 -is-ood-enabled true
metrocluster interconnect adapter show

Display MetroCluster interconnect adapter information
level.
Description
447
The metrocluster interconnect adapter show command displays

interconnect adapter information for the nodes in a MetroCluster configuration.
This command displays the following details about the local node and the HA partner
node:
Node: This field specifies the name of the node in the cluster.
Adapter Name: This field specifies the name of the interconnect adapter.
Adapter Type: This field specifies the type of the interconnect adapter.
Link Status: This field specifies the physical link status of the interconnect adapter.
Is OOD Enabled: This field specifies the out-of-order delivery status of the
interconnect adapter.
IP Address: This field specifies the IP address assigned to the interconnect
adapter.
Port Number: This field specifies the port number of the interconnect adapter.
Parameters
specify.
| [-connectivity ]
Displays the connectivity information from all the interconnect adapters to the connected
nodes.
| [-switch ]
Displays details of switches connected to all the interconnect adapters.
| [-connectivity-hidden ] (privilege: advanced)
Displays additional connectivity information (IP address, Area ID, Port ID) from all the
interconnect adapters to the connected nodes.
| [-instance ] }
about all fields.
448
Displays information only about the interconnect adapters that are hosted by the
specified node.
[-adapter <text>] - Adapter
Displays information only about the interconnect adapters that match the specified
name.
[-port-name <text>] - Port Name
Displays information only about the interconnect adapters that host the specified port
name.
[-type <text>] - Adapter Type
adapter type.
[-physical-status <text>] - Physical Status
physical status.
[-wwn <text>] - Adapter Port World Wide Name
Displays information only about the interconnect adapters that match the specified world
wide name.
[-address <text>] - IP Address
Displays information only about the interconnect adapters that match the specified IP
address.
[-firmware-version <text>] - Firmware Version
firmware version.
[-link-speed <text>] - Link Speed
Displays information only about the interconnect adapters that match the specified link
speed.
[-link-speed-neg-type <text>] - Link Speed Negotiation Type
negotiated link speed type.
[-switch-name <text>] - Switch Name
Displays information only about the interconnect adapters that are connected to the
specified switch.
449
[-switch-model <text>] - Switch Model

switch with the specified model.
[-switch-wwn <text>] - Switch WWName
switch with the specified world wide name.
[-switch-vendor <text>] - Switch Vendor
switch with the specified vendor.
[-switch-status <text>] - Switch Status
switch with the specified operational status.
[-switch-port-number <text>] - Switch Port Number
switch with the specified port number.
[-switch-port-wwpn <text>] - Switch Port WWPN
switch with the specified word wide port name.
[-remote-adapter-name-list <text>, ...] - Remote Adapter Name List
specified remote adapters.
[-remote-adapter-wwn-list <text>, ...] - Remote Adapter WWName List
remote adapters with the specified world wide names.
[-remote-adapter-address-list <text>, ...] - Remote Adapter IP Address List
remote adapters with the specified IP addresses.
[-remote-adapter-port-id-list <Hex Integer>, ...] - Remote Adapter Port ID List
remote adapters with the specified port IDs.
[-remote-adapter-domain-id-list <integer>, ...] - Remote Adapter Domain ID List
450
remote adapters with the specified domain IDs.
[-remote-adapter-area-id-list <integer>, ...] - Remote Adapter Area ID List
remote adapters with the specified Area IDs.
[-remote-partner-system-id-list <integer>, ...] - Remote Partner System ID List
remote nodes with the specified System IDs.
[-remote-partner-name-list {<nodename>|local}, ...] - Remote Partner Name List
specified remote nodes.
[-is-ood-enabled {true|false}] - Is Out-of-Order Delivery Enabled?
Displays information only about the interconnect adapters that match the specified outof-order delivery setting.
Examples
The following example shows the output of the command during normal operation
(neither cluster is in switchover state):
clusA::> metrocluster interconnect adapter show
Link
Node
Adapter
Type
Is OOD
Status Enabled? IP Address
Port Number
------------ --------------- ----- ------ -------- ----------- ----------clusA-01
cxgb3_0
iWARP Up
false
10.0.1.1
c0a
clusA-01
cxgb3_0
iWARP Down
false
10.0.2.1
c0b
clusA-01
fcvi_device_0
FC-VI Up
false
1.0.0.1
1a
clusA-01
fcvi_device_1
FC-VI Up
false
2.0.0.3
1b
clusA-02
cxgb3_0
iWARP Up
false
10.0.1.2
c0a
clusA-02
cxgb3_0
iWARP Down
false
10.0.2.2
c0b
clusA-02
fcvi_device_0
FC-VI Up
false
1.0.1.1
1a
clusA-02
fcvi_device_1
FC-VI Up
false
2.0.1.3
1b
The following example shows the output of the command after MetroCluster switchover
is performed:
clusA::> metrocluster interconnect adapter show
451
Link
Node
Adapter
Type
Is OOD
Status Enabled? IP Address
Port Number
------------ --------------- ----- ------ -------- ----------- ----------clusA-01
cxgb3_0
iWARP Up
false
10.0.1.1
c0a
clusA-01
cxgb3_0
iWARP Down
false
10.0.2.1
c0b
clusA-01
fcvi_device_0
FC-VI Down
false
1.0.0.1
1a
clusA-01
fcvi_device_1
FC-VI Down
false
2.0.0.3
1b
clusA-02
cxgb3_0
iWARP Up
false
10.0.1.2
c0a
clusA-02
cxgb3_0
iWARP Down
false
10.0.2.2
c0b
clusA-02
fcvi_device_0
FC-VI Down
false
1.0.1.1
1a
clusA-02
fcvi_device_1
FC-VI Down
false
2.0.1.3
1b
The following example shows the output of the command with connectivity field during
normal operation (neither cluster is in swithover state):
clusA::> metrocluster interconnect adapter show -connectivity -node local
-type FC-VI
Adapter Name: fcvi_device_0
WWName: 21:00:00:24:ff:32:01:68
PortNo: 1a
Remote Adapters:
Adapter Name Partner Node Name World Wide Name
PortId
------------ ----------------- ----------------------- -----fcvi_device_0

clusA-01
21:00:00:24:ff:32:01:80
65536
fcvi_device_0
clusB-01
21:00:00:24:ff:32:01:54 131072
fcvi_device_0
clusB-02
21:00:00:24:ff:32:01:60 131328

WWName: 21:00:00:24:ff:32:01:69
PortNo: 1b
Remote Adapters:
452
PortId
------------ ----------------- ----------------------- -----fcvi_device_1

clusA-01
21:00:00:24:ff:32:01:81 196608
fcvi_device_1
clusB-01
21:00:00:24:ff:32:01:55 262144
fcvi_device_1
clusB-02
21:00:00:24:ff:32:01:61 262400
The following example shows the output of the command with connectivity field after
MetroCluster swithover is performed.
clusA::> metrocluster interconnect adapter show -connectivity -node local
-type FC-VI
WWName: 21:00:00:24:ff:32:01:68
PortNo: 1a
Remote Adapters:
PortId
------------ ----------------- ----------------------- -----fcvi_device_0

clusA-01
21:00:00:24:ff:32:01:80
65536

WWName: 21:00:00:24:ff:32:01:69
PortNo: 1b
Remote Adapters:
PortId
------------ ----------------- ----------------------- -----fcvi_device_1

clusA-01
21:00:00:24:ff:32:01:81 196608
453
metrocluster interconnect mirror show

Display MetroCluster interconnect mirror information
level.
Description
The metrocluster interconnect mirror show command displays NVRAM
mirror information for the nodes configured in a MetroCluster.
node:
Partner Name: This field specifies the name of the partner node.
Partner Type: This field specifies the type of the partner.
Mirror Admin Status: This field specifies the administrative status of the NVRAM
mirror between partner nodes.
Mirror Oper Status: This field specifies the operational status of the NVRAM mirror
between partner nodes.
Adapter: This field specifies the name of the interconnect adapter used for
NVRAM mirroring.
Type: This field specifies the type of the interconnect adapter used for NVRAM
mirroring.
Status: This field specifies the physical status of the interconnect adapter used for
NVRAM mirroring.
Parameters
specify.
| [-instance ] }
454
about all fields.
If this parameter is specified, mirror details of the specified node are displayed.
[-partner-type {HA|DR|AUX}] - Partner Type
If this parameter is specified, mirror details of the specified partner type are displayed.
If this parameter is specified, mirror details of the specified adapter are displayed.
[-type <text>] - Adapter Type
If this parameter is specified, mirror details of the specified adapter type are displayed.
[-status <text>] - Status
If this parameter is specified, mirror details of the adapter with the specified status are
displayed.
[-mirror-oper-status {unknown|online|offline}] - Mirror Operational Status
If this parameter is specified, only mirror details with the specified operational status are
displayed.
[-partner-name <text>] - Partner Name
If this parameter is specified, mirror details of the specified partner are displayed.
[-mirror-admin-status {enabled|disabled}] - Mirror Administrative Status
If this parameter is specified, only mirror details with the specified administrative status
are displayed.
Examples
The following example shows the output of the command during normal operation
(neither cluster is in switchover state):
clusA::> metrocluster interconnect mirror show
Mirror
Partner Admin
Node Partner Name Type
Status
Mirror
Oper
Status
Adapter Type
Status
---- ------------ ------- -------- ------- ------- ------ -----clusA-01

clusA-02
455
HA
enabled
online
cxgb3_0 iWARP
Up
cxgb3_0 iWARP
Up
clusB-01
DR
enabled
online
fcvi_device_0
FC-VI
Up
fcvi_device_1
FC-VI
Up
cxgb3_0 iWARP
Up
cxgb3_0 iWARP
Up
clusA-02
clusA-01
HA
enabled
online
clusB-02
DR
enabled
online
fcvi_device_0
FC-VI
Up
fcvi_device_1
FC-VI
Up
The following example shows the output of the command after MetroCluster switchover
is performed:
clusA::> metrocluster interconnect mirror show
Mirror
Partner Admin
Node Partner Name Type
Status
Mirror
Oper
Status
Adapter Type
Status
---- ------------ ------- -------- ------- ------- ------ -----clusA-01

clusA-02
HA
enabled
online
cxgb3_0 iWARP
Up
cxgb3_0 iWARP
Up
clusB-01
DR
disabled offline
fcvi_device_0
FC-VI
Up
fcvi_device_1
FC-VI
456
Up
clusA-02
clusA-01
HA
enabled
online
cxgb3_0 iWARP
Up
cxgb3_0 iWARP
Up
clusB-02
DR
disabled offline
fcvi_device_0
FC-VI
Up
fcvi_device_1
FC-VI
Up
457
metrocluster interconnect mirror multipath show

Display multipath information
level.
Description
The metrocluster interconnect mirror multipath show command displays
the NVRAM mirror multipath policy for the nodes configured in a MetroCluster.
node:
Multipath Policy: This field specifies the multipath policy used for NVRAM
mirroring.
Parameters
specify.
| [-instance ] }
about all fields.
If this parameter is specified, mirror details of the specified node are displayed.
[-multipath-policy {no-mp|static-map|dynamic-map|round-robin}] - Multipath Policy
If this parameter is specified, nodes with the specidifed multipath policy are displayed.
Examples
The following example shows the output of the command:
clusA::> metrocluster interconnect mirror multipath show
Node
458
Multipath Policy
--------------- ----------------clusA-1
static-map
clusA-2
static-map
459
metrocluster node show

Display MetroCluster node configuration information
level.
Description
The metrocluster node show command displays configuration information for the
nodes in the MetroCluster configuration.
Parameters
specify.
| [-partners ]
If this option is used the MetroCluster node partnership view will be displayed.
| [-instance ] }
about all fields.
[-dr-group-id <integer>] - DR Group ID
If this parameter is specified, all nodes belonging to the specified DR group are
displayed.
If this parameter is specified, all nodes belonging to the specified cluster are displayed.
If this parameter is specified, the specified node is displayed.
[-ha-partner <Node name>] - HA Partner Name
If this parameter is specified, the node with the specified HA partner is displayed.
[-dr-cluster <Cluster name>] - DR Cluster Name
460
[-dr-partner <Node name>] - DR Partner Name

If this parameter is specified, the node with the specified DR partner is displayed.
[-dr-auxiliary <Node name>] - DR Auxiliary Name
If this parameter is specified, the node with the specified DR auxiliary partner is
displayed.
[-node-uuid <UUID>] - Node UUID
If this parameter is specified, the node with the specified Uuid is displayed.
[-ha-partner-uuid <UUID>] - HA Partner UUID
If this parameter is specified, the nodes with the specified HA partner is displayed.
[-dr-partner-uuid <UUID>] - DR Partner UUID
If this parameter is specified, the node with the specified DR partner is displayed.
[-dr-auxiliary-uuid <UUID>] - DR Auxiliary UUID
If this parameter is specified, the node with the specified DR auxiliary partner is
displayed.
[-node-cluster-uuid <UUID>] - Node Cluster UUID
[-ha-partner-cluster-uuid <UUID>] - HA Partner Cluster UUID
If this parameter is specified, all nodes whose HA partner belong to the specified cluster
are displayed.
[-dr-partner-cluster-uuid <UUID>] - DR Partner Cluster UUID
If this parameter is specified, all nodes whose DR partner belong to the specified cluster
are displayed.
[-dr-auxiliary-cluster-uuid <UUID>] - DR Auxiliary Cluster UUID
If this parameter is specified, all nodes whose DR auxiliary partner belong to the
specified cluster are displayed.
[-node-systemid <integer>] - Node System ID
If this parameter is specified, all nodes with the specified system ID are displayed.
[-ha-partner-systemid <integer>] - HA Partner System ID
If this parameter is specified, all nodes with an HA partner with the specified system ID
are displayed.
461
[-dr-partner-systemid <integer>] - DR Partner System ID

If this parameter is specified, all nodes with a DR partner with the specified system ID
are displayed.
[-dr-auxiliary-systemid <integer>] - DR Auxiliary System ID
If this parameter is specified, all nodes with a DR auxiliary partner with the specified
system ID are displayed.
[-dr-mirroring-state <text>] - State of DR Mirroring Config
If this parameter is specified, all nodes with this field set to the specified value are
displayed. This field specifies if the NVRAM mirroring to the DR partner is enabled
through the metrocluster configure command. This field needs to be set to
"enabled" for the DR mirroring to be active.
[-configuration-state <text>] - Configuration State of Node
displayed.
[-additional-configuration-info <text>] - Additional Configuration Info
displayed.
[-dr-operation-state <text>] - DR Operation State
displayed.
[-dr-operation-time <integer>] - Time to Complete Operation (secs)
displayed.
[-node-object-limit {on|off}] - Specifies if the Node Object Limits are Enforced
displayed.
[-node-ha-partner <text>] - Node and it's HA partner
displayed.
Examples
The following example shows the output of the command before the MetroCluster
462

DR
Configuration
DR
Group Cluster Node
State
Mirroring Mode
----- ------- ------------------ -------------- ----------------------------
clusA
clusA-01
ready to configure
clusA-02
ready to configure
clusA-03
ready to configure
clusA-04
ready to configure

clusA::> metrocluster node show -partners
Node (HA Partner) DR Partner (DR Auxiliary)
-----------------------------------------------------------------------------Cluster:
clusA clusA-01 (-) - (-)

clusA-02 (-) - (-)
clusA-03 (-) - (-)
clusA-04 (-) - (-)
The following example shows the output of the command when some DR groups in the
MetroCluster configuration are not yet configured:
DR
Configuration
DR
Group Cluster Node
State
Mirroring Mode
----- ------- ------------------ -------------- ----------------------------
clusA
clusA-03
ready to configure
-
clusA
clusB
clusA-04
ready to configure
-
clusA-01
configured
enabled
normal
clusA-02
configured
enabled
normal
clusB-01
configured
enabled
normal
463
clusB-02
configured
enabled
normal

-----------------------------------------------------------------------------Cluster:
clusA clusA-03 (-) - (-)

clusA-04 (-) - (-)
Cluster:
clusA clusB
clusA-01 (clusA-02) clusB-01 (clusB-02)
Cluster:
clusB clusA
clusB-01 (clusB-02) clusA-01 (clusA-02)
The following example shows the output of the command after after all DR groups in the
MetroCluster configuration are configured:
DR
Configuration
DR
Group Cluster Node
State
Mirroring Mode
----- ------- ------------------ -------------- ---------------------------1
clusA
clusB
clusA
clusB
clusA-01
configured
enabled
normal
clusA-02
configured
enabled
normal
clusB-01
configured
enabled
normal
clusB-02
configured
enabled
normal
clusA-03
configured
enabled
normal
clusA-04
configured
enabled
normal
clusB-03
configured
enabled
normal
clusB-04
configured
enabled
normal

-----------------------------------------------------------------------------Cluster:
464
clusA clusB

Cluster:
clusB clusA
Cluster:
clusA clusB
Cluster:
clusB clusA
See Also
metrocluster configure metrocluster show metrocluster unconfigure
465
metrocluster operation show

Display details of the last MetroCluster operation
level.
Description
The metrocluster operation show command displays information about the most
recent MetroCluster operation run on the local cluster.
This command will display information about all MetroCluster commands except
for the commands in the metrocluster check directory. This command will not
display any information after MetroCluster has been completely unconfigured using the
metrocluster unconfigure command.
Parameters
None
Examples
The following example shows the output of metrocluster operation show after
running a metrocluster configure command was successful:
clusA::> metrocluster operation show
Operation: configure
State: successful
Start time: 2/15/2013 18:22:46
End time: 2/15/2013 18:25:18
Errors: -
See Also
metrocluster check metrocluster unconfigure metrocluster configure
metrocluster operation history show
466
metrocluster operation history show

Display details of all MetroCluster operations
level.
Description
The metrocluster operation history show command displays information
about all the MetroCluster operations run on the local cluster.
This command will display information about all MetroCluster commands except
for the commands in the metrocluster check directory. This command will not
display any information after MetroCluster has been completely unconfigured using the
metrocluster unconfigure command.
Parameters
specify.
| [-instance ] }
about all fields.
[-operation-uuid <UUID>] - Identifier for the Operation
This is the UUID of the operation. If this parameter is specified, only the operation with
this UUID is displayed.
[-cluster <Cluster name>] - Cluster Where the Command Was Run
This is the name of the cluster where the command was run. If this parameter is
specified, only the operations that were run in this cluster are displayed.
[-node-name <Node name>] - Node Where the Command Was run
This is the name of the node where the command was run. If this parameter is
specificed, only the operations that were run on this node are displayed.
[-operation <MetroCluster Operation Name>] - Name of the Operation
467
This is the name of the operation. If this parameter is specificed, only the operations
with this name are displayed.
This is the time the operation started execution. If this parameter is specificed, only the
operations that were started at this time are displayed.
[-state <MetroCluster Operation state>] - State of the Operation
This is the state of the operation. If this parameter is specificed, only the operations that
are in this state are displayed.
[-end-time <MM/DD/YYYY HH:MM:SS>] - End Time
This is the time the operation completed. If this parameter is specificed, only the
operations that completed at this time are displayed.
[-error-list <text>, ...] - Error List For the Operation
This is the list of errors that were encountered during an operation's execution. If this
parameter is specificed, only the operations that have the matching errors are displayed.
[-job-id <integer>] - Identifier for the Job
This is the job id for the operation. If this parameter is specificed, only the operation that
has the matching job id displayed.
Examples
The following example shows the output of metrocluster operation history
show after some MetroCluster operations have been performed:
clusA::> metrocluster operation history show
Operation
State
Start time
End time
---------------- -------------- ---------------- -----------------configure
successful
2/15/2013 18:22:46
2/15/2013 18:25:18
configure
failed
2/15/2013 18:13:45
2/15/2013 18:13:45
See Also
metrocluster check metrocluster unconfigure metrocluster operation show
468
metrocluster vserver recover-from-partialswitchback

Recover vservers from partial switchback
privilege level.
Description
The metrocluster vserver recover-from-partial-switchback command
executes the necessary steps needed for a Vserver to be in healthy state after partial
completion of the Switchback.
Parameters
None
Examples
cluster::> metrocluster vserver recover-from-partial-switchback
See Also
metrocluster vserver recover-from-partial-switchover
469
metrocluster vserver recover-from-partialswitchover

Recover vservers from partial switchover
privilege level.
Description
The metrocluster vserver recover-from-partial-switchover command
executes the necessary steps needed for a Vserver to be in healthy state after partial
completion of the Switchover.
Parameters
None
Examples
cluster::> metrocluster vserver recover-from-partial-switchover
See Also
metrocluster vserver recover-from-partial-switchback
470
metrocluster vserver resync

Resynchronize Vserver with it's partner Vserver
level.
Description
The metrocluster vserver resync command resynchronizes the Vserver with it's
partner Vserver
Parameters
-cluster <Cluster name> - Cluster Name
Name of the cluster where the Vserver belongs
-vserver <vserver> - Vserver
Name of the Vserver to be resynchronized
Examples
cluster::> metrocluster vserver resync -cluster clus1 -vserver vs1
See Also
metrocluster vserver show
471
metrocluster vserver show

Display MetroCluster Vserver relationships
level.
Description
The metrocluster vserver show command displays configuration information for
all pairs of Vservers in MetroCluster.
Parameters
The command output includes the specified field or fields
| [-creation-time ] (privilege: advanced)
Shows the last configuration modification time on the Vserver
| [-instance ] }
about all fields.
Name of the cluster where the Vserver belongs
[-vserver <vserver>] - Vserver
Name of the Vserver
[-partner-vserver <vserver>] - Partner Vserver
Name of the partner Vserver
[-configuration-state {healthy|unhealthy|degraded|pending-setup|syncing|replicationpaused}] - Configuration State
Configuration states include:
healthy
unhealthy
degraded indicates that Vservers are not in sync
472
syncing indicates that the Vserver configuration is being synchronized

replication-paused indicates that the configuration replication was manually
paused
pending-setup indicates that partner Vserver creation is pending
[-corrective-action <text>] - Corrective Action
Corrective action which can be followed to successfully create the partner Vserver
[-creation-time-of-last-applied-change <MM/DD/YYYY HH:MM:SS>] - Creation Time
on the source
Last configuration modification time on the Vserver
[-out-of-sync [true]] - Is out of sync
Indicates that the Vserver configuration replication is not in sync
[-config-resume-time <MM/DD/YYYY HH:MM:SS>] - configuration Resume Time
Displays the resume time of the Vserver configuration replication
Examples
The following example shows the output of the command when partner Vservers are
created
clusA::> metrocluster vserver show
Cluster: clusA
Partner
Configuration
Vserver
-----------------------------------
Vserver
State
----------------------
clusA
clusB
healthy
vs1
vs1-mc
healthy
Cluster: clusB
Partner
Configuration
Vserver
----------------------------------clusB
Vserver
State
---------------------clusA
healthy
473
The following example shows the output of the command when the partner Vserver
creation is pending
clusA::> metrocluster vserver show
Cluster: clusA
Partner
Configuration
Vserver
Vserver
-----------------------------------
State
----------------------
clusA
clusB
healthy
vs1
pending-
setup
Corrective Action: Create Ipspace ips1 on the partner cluster.
See Also
metrocluster vserver resync
474
network ping
Ping
Description
The network ping command displays whether a remote address is reachable and
responsive, the (if specified) number of transmitted and received packets, and their
round-trip time. The command requires a source node or logical interface from where
the ping will be run, and a destination IP address. You can specify the source node by
name, or a logical interface and its Vserver.
Parameters
{ -node <nodename> - Node
| -lif <lif-name> } - Logical Interface
Use this parameter to send the ping from the logical interface you specify.
Use this parameter to send the ping from the Vserver where the intended logical
interface resides.
[-use-source-port {true|false}] - Use Source Port of Logical Interface (privilege:
advanced)
This parameter is only applicable when the -lif parameter is specified. When set
to true, the ping packet will be sent out via the port which is currently hosting the IP
address of the logical interface. Otherwise, the ping packet will be sent out via a port
based on the routing table.
-destination <Remote InetAddress> - Destination
Use this parameter to specify the remote internet address destination of the ping.
[-show-detail | -s [true]] - Show Detail Output
Use this parameter to display detailed output about the ping.
[-record-route | -R [true]] - Record Route
475
Use this parameter to display the route followed by the ping. You should set this option
to false for pinging to succeed.
[-verbose | -v [true]] - Show All ICMP Packets
Use this parameter to display all ICMP packets.
[-packet-size <integer>] - Packet Size
Use this parameter to specify the number of data bytes to be sent in the ping packet.
The default is 56 bytes, which is 64 ICMP data bytes total after 8 bytes of ICMP header
data is added.
[-count <integer>] - Count
Use this parameter to specify the number of ECHO_REQUESTS to be sent to the
destination. The default is 20 requests.
[-wait <integer>] - Packet Send Wait Time (secs)
Use this parameter to specify the number of seconds to wait between sending packets.
The default is one second.
[-flood [true]] - Flood Ping (privilege: advanced)
Use this parameter to execute the command in flood mode. In flood mode, the
command issues pings as fast as they are received, unless you specify a wait time.
[-disallow-fragmentation | -D [true]] - Disallow Packet Fragmentation
Use this parameter to prevent transport mechanisms from fragmenting ping packets in
transit. Preventing fragmentation assures consistent packet size, making it easier to see
transport bottlenecks.
[-wait-response <integer>] - Packet Response Wait Time (ms)
Use this parameter to specify the number of milliseconds to wait for each response
packet. The default is 10000 milliseconds (10 seconds).
Examples
This example shows a ping from node xena to the destination server 10.98.16.164 with
the server responding that it is up and running.
cluster1::> network ping -node xena -destination 10.98.16.164
(network ping)
10.98.16.164 is alive
476
network ping6
Ping an IPv6 address
Description
The network ping6 command uses the ICMPv6 protocol's mandatory
ICMP6_ECHO_REQUEST datagram to elicit an ICMP6_ECHO_REPLY from a host
or gateway. ICMP6_ECHO_REQUEST datagrams ("pings") have an IPv6 header, and
ICMPv6 header formatted as documented in RFC2463.
Parameters
{ -node <nodename> - Node Name
Use this parameter to originate ping6 from the specified node.
Use this parameter to originate ping6 from the specified logical interface.
-vserver <vserver name> - Vserver Name
Use this parameter to originate ping6 from the specified Vserver. The default is system
Vserver for cluster administrators.
Use this parameter to specify the IPv6 address of the destination node.
[-buffer-size | -b <integer>] - Socket Buffer Size
Use this parameter to set the socket buffer size.
[-count | -c <integer>] - Max Requests to Send/Recieve
Use this parameter to specify the maximum number of requests and replies. The default
value is 20.
[-reverse-lookup | -H [true]] - Reverse-lookup of IPv6 addresses
Use this parameter to specify reverse-lookup of IPv6 addresses. Unless this parameter
is specified, ping6 command does not attempt reverse lookup.
[-interval | -i <integer>] - Wait between Packets (secs)
477
Use this parameter to specify the delay time between packets in seconds. The default
value is 1 second. This parameter is incompatible with the flood parameter.
[-preload | -l <integer>] - Send Packets as Fast as Possible (privilege: advanced)
Use this parameter if preload is required. If specified, ping6 sends that many packets as
fast as possibile before falling into its normal mode of behaviour.
[-use-source-port {true|false}] - Use Source Port of Logical Interface (privilege:
advanced)
This parameter is only applicable when the -lif parameter is specified. When set
to true, the ping packet will be sent out via the port which is currently hosting the IP
address of the logical interface. Otherwise, the ping packet will be sent out via a port
based on the routing table.
[-pattern | -p <text>] - Up to 16 'pad' Specified for Out Packet
Use this parameter to fill the -16 'pad' bytes in the sent packet. This is useful for
diagnosing data dependent problems in a network. For example, -pattern ff causes the
sent packet to be filled with all ones.
Use this parameter to specify the number of data bytes to be sent. The default is 56,
which translates to 64 ICMP data bytes when combined with the 8 bytes of ICMP
header data.
[-verbose | -v [true]] - Show All ICMP Packets
Use this parameter to get verbose output. Verbose output displays both source address
and destination addresses. Received ICMP packets other than ECHO_RESPONSE are
listed. This parameter can be used only in conjunction with the show-detail parameter.
[-fqdn-query | -w [true]] - FQDN Query
Use this parameter to generate ICMPv6 Node Information FQDN query, rather than
echo-request.
[-fqdn-query-03-draft | -W [true]] - FQDN Query but with 03 Draft
Use this parameter to generate FQDN query with old packet format based on 03 draft.
This option is available for backward compatibility.
[-show-detail | -s [true]] - Show Detail Output
Use this parameter to display detailed output about the ping.
[-flood | -f [true]] - Flood Ping (privilege: advanced)
Use this parameter to output packets as fast as they come back or one hundred times
per second, whichever is more. For every ECHO_REQUEST sent a period "." is printed,
478
while for every ECHO_REPLY received a backspace is printed. This provides a rapid
display of how many packets are being dropped. This can be very hard on a network
and should be used with caution.
Examples
This example shows a ping6 from node 'node1' to the destination server
ipv6.google.com with the server responding that it is up and running.
cluster1::> network ping6 -node node1 -destination ipv6.google.com
ipv6.google.com is alive.
See Also
network ping network traceroute network traceroute6
479
network traceroute
Traceroute
Description
The network traceroute command performs a network probe from a node to a
specified IP address. The command requires a source node or logical interface and
a destination IP address. You can specify the source node by name, or specify a
logical interface and its Vserver. The traceroute is performed between the source and
destination.
Parameters
Use this parameter to originate the traceroute from the node you specify.
Use this parameter to originate the traceroute from the interface group you specify.
-vserver <vserver> - LIF Owner
Use this parameter to originate the traceroute from the Vserver where the intended
logical interface resides.
Use this parameter to specify the remote internet address destination of the traceroute.
[-maxttl | -m <integer>] - Maximum Number of Hops
Use this parameter to specify the maximum number of hops (time-to-live) setting used
by outgoing probe packets. The default is 30 hops.
[-numeric | -n [true]] - Print Hop Numerically
Use this parameter to print the hop addresses only numerically rather than symbolically
and numerically.
[-port <integer>] - Base UDP Port Number
Use this parameter to specify the base UDP port number used in probes. The default is
port 33434.
480

Use this parameter to specify the size of probe packets, in bytes.
[-nqueries | -q <integer>] - Number of Queries
Use this parameter to specify the number of probes per hop. The default is 3 probes.
[-verbose | -v [true]] - Verbose Output
Use this parameter to display all received ICMP packets, rather than just
TIME_EXCEEDED and UNREACHABLE packets.
[-waittime | -w <integer>] - Wait Between Packets (secs)
Use this parameter to specify the time (in seconds) to wait for the response to a probe.
The default is 5 seconds.
Examples
This example shows a traceroute from node node1 to a destination address of
10.98.16.164, showing a maximum of five hops.
cluster1::> traceroute -node node1 -destination 10.98.16.164 -maxttl 5
1
10.68.208.1 <10.68.208.1> 0.307 ms 293 ms 305 ms
152.164.13.205 <152.164.13.205> 3.754 ms 3.722 ms 3.981 ms
68.137.122.222 <68.137.122.222> 25.603 ms 24.947 ms 24,565 ms
* * *
* * *
traceroute to 10.98.16.164, 5 hops max, 52 byte packets
481
network traceroute6
traceroute6
Description
The network traceroute6 command performs a network probe from a node to
a specified IPv6 address. The command requires a source node or logical interface,
Vserver from where traceroute6 will originate and a destination IPv6 address.
traceroute6 is performed between the source and destination.
Parameters
Use this parameter to originate traceroute6 from the node you specify. This parameter is
available only to cluster administrators.
Use this parameter to originate traceroute6 from the logical interface you specify.
-vserver <vserver name> - LIF Owner
Use this parameter to originate traceroute6 from the Vserver you specify. The default
value is system Vserver for cluster administrators.
[-debug-mode | -d [true]] - Debug Mode
Use this parameter to enable socket level debugging. The default value is false.
{ [-icmp6 | -I [true]] - ICMP6 ECHO instead of UDP
Use this parameter to specify the use of ICMP6 ECHO instead of UDP datagrams for
the probes. The default value is false.
| [-udp | -U [true]] } - UDP
Use this parameter to specify the use of UDP datagrams for the probes. The default
value is true.
[-numeric | -n [true]] - Print Hops Numerically
Use this parameter to print the hop addresses only numerically rather than symbolically
and numerically. The default value is false.
482
[-verbose | -v [true]] - Verbose Output

Use this parameter to display all received ICMP packets, rather than just
TIME_EXCEEDED and UNREACHABLE packets. The default value is false.
[-first-hop | -f <integer>] - Number of Hops to Skip in Trace
Use this parameter to specify the number of hops to skip in trace. The default value is 1.
[-gateway | -g <Remote InetAddress>] - Intermediate Gateway
Use this parameter to specify the intermediate gateway.
[-hop-limit | -m <integer>] - Maximum Number of Hops
Use this parameter to specify the maximum hoplimit, upto 255. The default value is 64
hops.
[-port | -p <integer>] - Base UDP Port Number
Use this parameter to specify the base UDP port number used in probes. The default
value is port 33434.
[-nqueries | -q <integer>] - Number of Queries
Use this parameter to specify the number of probes per hop. The default value is 3
probes.
[-wait-time | -w <integer>] - Wait Between Packets (secs)
Use this parameter to specify the delay time between probes in seconds. The default
value is 5 seconds.
Use this parameter to specify the remote IPv6 address destination of traceroute6.
Use this parameter to specify the size of probe packets, in bytes. The default value is 16
bytes for ICMP6 ECHO and 12 bytes for UDP datagrams.
Examples
The following example shows traceroute6 from node node1 to the destination
fd20:8b1e:b255:4071:d255:1fcd:a8cd:b9e8.
cluster1::> network traceroute6 -node node1 -vserver vs1
-destination 3ffe:b00:c18:1::10
traceroute6 to 3ffe:b00:c18:1::10 (3ffe:b00:c18:1::10)
from 2001:0db8:0000:f101::2,
483
64 hops max, 12 byte packets

1
2001:0db8:0000:f101::1 4.249 ms
3ffe:2000:0:400::1
0.831 ms
3ffe:2000:0:1::132
227.693 ms
227.596 ms
227.439 ms
3ffe:c00:8023:2b::2 229.028 ms
228.267 ms
231.891 ms
3ffe:2e00:e:c::3
3ffe:b00:c18:1::10
227.929 ms
2.021 ms
0.864 ms
0.579 ms
228.696 ms
228.558 ms
227.702 ms 227.806 ms
227.439 ms
See Also
network traceroute network ping6 network ping
484
network arp create

Create static ARP entry
Description
The network arp create command creates a static ARP entry for a given Vserver.
Statically created ARP entries will be stored permanently in the Vserver context and will
be used by the network stack.
Parameters
Use this parameter to specify the name of the Vserver on which the ARP entry is
created.
-remotehost <IP Address> - Remote IP Address
Use this parameter to specify the IP address to be added as an ARP entry.
-mac <MAC Address> - MAC Address
Use this parameter to specify the MAC address (Ethernet address) for the host specified
with -remotehost. Specify the MAC address as six hex bytes separated by colons.
Examples
The following example creates a static ARP entry on Vserver vs1 for the remote host
with the IP address 10.63.0.2 having MAC address 40:55:39:25:27:c1
cluster1::> network arp create -vserver vs1 -remotehost 10.63.0.2 -mac
40:55:39:25:27:c1
network arp delete

Delete static ARP entry
485
Description
The network arp delete command deletes static ARP entries from the Vserver and
from the network stack.
Parameters
Use this parameter to specify the name of the Vserver from which the ARP entry is
deleted.
-remotehost <IP Address> - Remote IP Address
Use this parameter to specify the IP address of the ARP entry being deleted.
Examples
The following example deletes the ARP entry for IP address 10.63.0.2 from the Vserver
vs1.
cluster1::> network arp delete -vserver vs1 -remotehost 10.63.0.2
network arp show

Display static ARP entries
Description
The network arp show command displays static ARP entries present in a given
Vserver. This command will not display dynamically learnt ARP entries in the network
stack. Use the network arp active-entry show command to display dynamically
learned ARP entries in the network stack.
Parameters
Use this parameter to display only certain fields of the ARP table.
| [-instance ] }
486
Use this parameter to display all the fields of the ARP table.
Use this parameter to display ARP entries that are specific to a given Vserver.
[-remotehost <IP Address>] - Remote IP Address
Use this parameter to display ARP entries for the specified IP address
[-mac <MAC Address>] - MAC Address
Use this parameter to display ARP entry for the specified MAC address
[-ipspace <IPspace>] - IPspace
Use this parameter to specify the IPspace associated with the Vserver
Examples
The following example displays static ARP entries from the Vserver vs1.
cluster1::> network arp show -vserver vs1
Vserver
Remote Host
MAC Address
----------- ----------------- ----------------vs1

10.238.0.2
40:55:39:25:27:c1
See Also
network arp active-entry show
487
network arp active-entry delete

Delete active ARP entry
privilege level.
Description
The network arp active-entry delete command deletes ARP entry from
the network stack of node. Using this command, you can delete only dynamically
learned ARP entries. To delete statically configured ARP entries use the network arp
delete command
Parameters
Use this parameter to specify the name of the node in which the ARP entry is deleted.
-vserver <vserver> - Vserver Name
Use this parameter to specify the name of the Vserver in which the ARP entry is
deleted.
-subnet-group <IP Address/Mask> - Subnet Group Name
Use this parameter to specify the name of the routing group in which the ARP entry is
deleted.
-remotehost <text> - Remote IP Address
Use this parameter to specify the IP address to be deleted from the active ARP entries.
-port <text> - Port
Use this parameter to specify the name of the Port to be deleted from the active ARP
entries. This is an optional parameter. If Port is not specified then command will be
applied to all the matching Ports
Examples
The following example deletes the ARP entry for IP address 169.254.42.9 from the
Vserver vs1 and from the subnet group 169.254.0.0/16 and from port lo.
cluster1::*> network arp active-entry delete -vserver vs1 -subnet-group
169.254.0.0/16 -remotehost 169.254.42.9 -port lo
488
See Also
network arp delete
489
network arp active-entry show

Display active ARP entries
privilege level.
Description
The network arp active-entry show command displays ARP entries present
in the network stack of the node. The entries includes both dynamically learned ARP
entries and user configured static ARP entries.
Parameters
Use this parameter to display only certain fields of the active ARP table.
| [-instance ] }
Use this parameter to display all the fields of the active ARP table.
Use this parameter to display active ARP entries that are specific to a given node.
[-vserver <vserver>] - Vserver Name
Use this parameter to display active ARP entries that are specific to a given Vserver.
[-subnet-group <IP Address/Mask>] - Subnet Group Name
Use this parameter to display active ARP entries that are specific to a given subnet
group.
[-remotehost <text>] - Remote IP Address
Use this parameter to display active ARP entries for the specified IP address
Use this parameter to display active ARP entries for the specified Port name
[-mac <text>] - MAC Address
Use this parameter to display active ARP entry for the specified MAC address
[-ipspace <IPspace>] - IPspace
490
Use this parameter to specify the IPspace associated with the Vserver
Examples
The following example displays active ARP entries from the Vserver vs1.
cluster1::*> network arp active-entry show -vserver vs1
Node: node-01
Vserver: vs1
Subnet Group: 169.254.0.0/16
Remote IP Address MAC Address
Port
----------------- ----------------- ------169.254.106.95
0:55:39:27:d1:c1
lo
491
network connections active show-clients

Show a count of the active connections by client
Description
The network connections active show-clients command displays
information about client connections, including the client's IP address and the number of
client connections.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display information only about the connections on the node you
specify.
This parameter is used by the system to break down the output per vserver.
[-remote-address <Remote IP>] - Remote IP Address
Use this parameter to display information only about the connections that use the
remote IP address you specify.
[-count <integer>] - Client Count
Use this parameter to only clients with the number of active client connections you
specify.
Examples
The following example displays information about active client connections:
492
cluster1::> network connections active show-clients

Node
Vserver Name
Client IP Address
Count
------
--------------
-----------------
------
node0
vs1
192.0.2.253
vs2
192.0.2.252
vs3
192.0.2.251
vs1
192.0.2.250
vs2
192.0.2.252
vs2
customer.example.com
node1
493
network connections active show-lifs

Show a count of the active connections by logical interface
Description
The network connections active show-lifs command displays the number of
active connections on each logical interface, organized by node and Vserver.
Parameters
specify.
| [-instance ] }
about all fields.
specify.
Use this parameter to display information only about the connections that are using the
node or Vserver you specify.
[-lif-name <lif-name>] - Logical Interface Name
Use this parameter to display information only about the connections that are using the
logical interface you specify.
Use this parameter to display only logical interfaces with the number of active client
connections you specify.
[-blocked-count <integer>] - Load Balancing Blocking Count
494
Use this parameter to display information only about data logical interfaces blocked from
migrating and the connection that is blocking it.
Examples
The following example displays information about the servers and logical interfaces
being used by all active connections:
cluster1::> network connections active show-lifs
Node
Vserver Name
Interface Name
Count
--------
------------
--------------- ------
vs0
datalif1
vs0
cluslif1
vs0
cluslif2
vs0
datalif2
vs0
cluslif1
vs0
cluslif2
vs1
datalif2
vs1
cluslif1
vs1
cluslif2
vs1
datalif1
vs1
cluslif1
vs1
cluslif2
node0
node1
node2
node3
At privilege levels above "admin", the command displays an extra column.

cluster1::*> network connections active show-lifs
LB Migrate
Node
Vserver Name
Interface Name
--------
------------
--------------- ------ ----------
Count
Blocking
vs0
datalif1
vs0
cluslif1
vs0
cluslif2
vs0
datalif2
vs0
cluslif1
node0
node1
495
vs0
cluslif2
vs1
datalif2
vs1
cluslif1
vs1
cluslif2
vs1
datalif1
vs1
cluslif1
vs1
cluslif2
node2
node3
496
network connections active show-protocols

Show a count of the active connections by protocol
Description
The network connections active show-protocols command displays the
number of active connections per protocol, organized by node.
Parameters
specify.
| [-instance ] }
about all fields.
specify.
This parameter is used by the system to break down the output per vserver.
[-proto {UDP|TCP}] - Protocol
network protocol you specify. Possible values include tcp (TCP), udp (UDP), and NA
(not applicable).
Use this parameter to display only protocols with the number of active client connections
you specify.
Examples
497
The following example displays information about all network protocols being used by
active connections:
cluster1::> network connections active show-protocols
Node
Vserver Name
Protocol
Count
-------
--------------
---------
------
vs1
UDP
19
vs1
TCP
11
vs2
UDP
17
vs1
UDP
14
vs2
TCP
10
node0
node1
498
network connections active show-services

Show a count of the active connections by service
Description
The network connections active show-services command displays the
number of active connections by protocol service, organized by node.
Parameters
specify.
| [-instance ] }
about all fields.
specify.
This parameter is used by the system to break down the output per vserver
[-service <protocol service>] - Protocol Service
protocol service you specify. Possible values include: nfs, iscsi, and loopback.
Use this parameter to display information only about protocol services with the number
of active client connections you specify.
Examples
The following example displays information about all protocol services being used by
active connections:
499
cluster1::> network connections active show-services

Node
Vserver Name
Service
Count
---------
--------------
---------
------
vs1
mount
vs1
nfs
vs1
nlm_v4
vs1
cifs_srv
vs1
port_map
18
vs2
rclopcp
27
vs1
nfs
vs2
rclopcp
vs2
nfs
vs2
port_map
node0
3
14
4
node1
500
5
12
network connections active show

Show the active connections in this cluster
Description
The network connections active show command displays information about
active network connections.
Parameters
specify.
| [-instance ] }
about all fields.
[-cid <Cid>] - Connection ID
[-local-address <IP Address>] - Local IP address
[-local-port <integer>] - Local Port
501
[-remote-ip <InetAddress>] - Remote IP Address

[-remote-host <Remote IP>] - Remote Host
[-remote-port <integer>] - Remote Port
Selects the connections that match this parameter value. Possible values are tcp (TCP),
udp (UDP), and NA (not applicable).
[-lifid <integer>] - Logical Interface ID
Selects the connections that match this parameter value. Possible values include: nfs,
iscsi, and loopback.
[-lru {yes|no}] - Least Recently Used
[-blocks-lb {true|false}] - Connection Blocks Load Balance Migrate
Selects the logical interfaces that are blocked (true) or not blocked (false) from migrating
due to an active client connection.
Examples
The following example displays information about active network connections for the
node named node0:
cluster1::> network connections active show node -node0
Vserver Interface
Remote
Name
IP Address:Port
Name:Local Port
Protocol/Service
------- ---------------- ----------------- ----------------
502
node0
cluslif1:7070
192.0.2.253:48621 UDP/rclopcp
node0
cluslif1:7070
192.0.2.253:48622 UDP/rclopcp
node0
cluslif2:7070
192.0.2.252:48644 UDP/rclopcp
node0
cluslif2:7070
192.0.2.250:48646 UDP/rclopcp
node0
cluslif1:7070
192.0.2.245:48621 UDP/rclopcp
node0
cluslif1:7070
192.0.2.245:48622 UDP/rclopcp
node0
cluslif2:7070
192.0.2.251:48644 UDP/rclopcp
node0
cluslif2:7070
192.0.2.251:48646 UDP/rclopcp
node0
cluslif1:7070
192.0.2.248:48621 UDP/rclopcp
node0
cluslif1:7070
192.0.2.246:48622 UDP/rclopcp
node0
cluslif2:7070
192.0.2.252:48644 UDP/rclopcp
node0
cluslif2:7070
192.0.2.250:48646 UDP/rclopcp
node0
cluslif1:7070
192.0.2.254:48621 UDP/rclopcp
node0
cluslif1:7070
192.0.2.253:48622 UDP/rclopcp
[...]
At privilege levels above "admin", the command displays an extra column.

cluster1::*> network connections active show node -node0
Blocks
Vserver Interface
Remote
Name
IP Address:Port
Name:Local Port
LB
Protocol/Service Migrate
------- ---------------- ----------------- ---------------- ------node0
cluslif1:7070
192.0.2.253:48621 UDP/rclopcp
false
node0
cluslif1:7070
192.0.2.253:48622 UDP/rclopcp
false
node0
cluslif2:7070
192.0.2.252:48644 UDP/rclopcp
false
node0
cluslif2:7070
192.0.2.250:48646 UDP/rclopcp
false
node0
cluslif1:7070
192.0.2.245:48621 UDP/rclopcp
false
node0
cluslif1:7070
192.0.2.245:48622 UDP/rclopcp
false
node0
cluslif2:7070
192.0.2.251:48644 UDP/rclopcp
false
node0
cluslif2:7070
192.0.2.251:48646 UDP/rclopcp
false
node0
cluslif1:7070
192.0.2.248:48621 UDP/rclopcp
false
node0
cluslif1:7070
192.0.2.246:48622 UDP/rclopcp
false
node0
cluslif2:7070
192.0.2.252:48644 UDP/rclopcp
false
node0
cluslif2:7070
192.0.2.250:48646 UDP/rclopcp
false
node0
cluslif1:7070
192.0.2.254:48621 UDP/rclopcp
false
node0
cluslif1:7070
192.0.2.253:48622 UDP/rclopcp
false
[...]
503
network connections listening show

Show the listening connections in this cluster
Description
The network connections listening show command displays information about
network connections that are in an open and listening state.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the listening connections that match this parameter value.
[-mgmt-cid <integer>] - Management Connection ID
[-cid <integer>] - System Connection ID
[-local-address <IP Address>] - Local IP Address
504
[-local-port <integer>] - Local Port

[-remote-ip <InetAddress>] - Remote IP Address
[-remote-host <Remote IP>] - Remote Host
[-remote-port <integer>] - Remote Port
Selects the listening connections that match this parameter value. Possible values
include tcp (TCP), udp (UDP), and NA (not applicable).
[-lifid <integer>] - Logical Interface ID
Selects the listening connections that match this parameter value. Possible values
include: nfs, iscsi, and loopback.
[-lru {yes|no}] - Least Recently Used
Examples
The following example displays information about all listening network connections:
cluster1::> network connections listening show
Vserver Name Interface Name:Local Port
Protocol/Service
------------ -------------------------- ----------------node0
cluslif1:7700
UDP/rclopcp
node0
cluslif2:7700
UDP/rclopcp
node1
cluslif1:7700
UDP/rclopcp
node1
cluslif2:7700
UDP/rclopcp
node2
cluslif1:7700
UDP/rclopcp
node2
cluslif2:7700
UDP/rclopcp
node3
cluslif1:7700
UDP/rclopcp
node3
cluslif2:7700
UDP/rclopcp
505
The following example displays detailed information about listening network connections
for the node named node0:
cluster1::> network connections listening show -node node0
Node: node0
Management Connection Id: 0
System Connection Id: 0
Vserver: vs0
Logical Interface Name: datalif1
Local IP address: 192.0.2.130
Local Port: 111
Remote IP address:
Remote Port: 0
Protocol: UDP
Logical Interface Id: 1029
Protocol Service: port_map
least recently used: yes
Node: node0
Management Connection Id: 1
System Connection Id: 0
Server: vs0
Logical Interface Name: datalif2
Local IP address: 192.0.2.131
Local Port: 111
Remote IP address:
Remote Port: 0
Protocol: UDP
Logical Interface Id: 1030
Protocol Service: port_map
least recently used: yes
506
network device-discovery show

Display device discovery information
level.
Description
The network device-discovery show command displays information about discovered
devices. This information may be useful in determining the network topology or
investigating connectivity issues. By default, the command displays the following
information:
Local interface
Discovered device
Discovered interface
Discovered platform
Parameters
Include the specified field or fields in the command output. Use '-fields ?' to display the
valid fields.
| [-instance ] }
Use this parameter to display detailed information about all fields.
Displays the discovery ports that match the node name.
Displays the discovery ports that match the physical network port. For example, e0a will
display devices discovered on port e0a.
[-discovered-device <text>] - Discovered Device
Displays the discovered devices that match the discovered device name.
[-interface <text>] - Discovered Device Interface
507
Displays the discovered devices that match this interface port name. The format is
dependent on the reporting device. For example: FastEthernet0/12
[-device-ip <IP Address>, ...] - Discovered Device IP Addresses
Displays the discovered devices that match the IP address(es). At present, only IPv4
addresses are included. It is recommended to use wildcards around the desired value.
[-platform <text>] - Discovered Device Platform
Displays the discovery ports that contain the platform of discovered devices. For
example: N5K-C5010P-BF
[-version <text>] - Discovered Device Version
Displays the discovery ports that contain the version of discovered devices.
[-hold-time-remaining <integer>] - Discovered Device's Remaining Hold Time
Displays the discovered devices that match the remaining packet hold time in seconds.
If an advertisement from the device isn't received before this time reaches zero,
the entry will expire and be removed from the list. For example, "<120" will display
discovered devices which will expire within the next 120 seconds.
[-capabilities {router|trans-bridge|source-route-bridge|switch|host|igmp|repeater|
phone}, ...] - Discovered Device Capabilities
Displays the discovered devices that match the capability or capabilities. Possible
values:
"router" - Router
"trans-bridge" - Trans Bridge
"source-route-bridge" - Source Route Bridge
"switch" - Switch
"host" - Host
"igmp" - IGMP
"repeater" - Repeater
"phone" - Phone
Examples
cluster1::> network device-discovery show
Local
508
Discovered
Node
Port
Device
Interface
Platform
----------- ------ ------------------------- ----------------
----------------
node1
e0a
US-LS01-5010-F11-NX.example.com(SSI142311PD)
e0b
e1a
Ethernet100/1/17
Ethernet100/1/18
N5K-C5010P-BF
Ethernet100/1/2
N5K-C5010P-BF
N5K-C5010P-BF
node2
e0a
e0b
e1a
e1c
Ethernet100/1/19
Ethernet100/1/20
N5K-C5010P-BF
Ethernet100/1/4
N5K-C5010P-BF
Ethernet100/1/36
N5K-C5010P-BF
e1d
N5K-C5010P-BF
Ethernet100/1/35
N5K-C5010P-BF
509
network fcp adapter modify

Modify the fcp adapter settings
level.
Description
Modifies the FCP target adapter information.
The adapter argument is in the form Xy or Xy_z where X and z are integers and y is a
letter. An example is 4a or 4a_1.
You cannot bring an adapter offline until all logical interfaces connected to that adapter
are offline. Use the network interface modify command to take your logical
interfaces offline.
The speed option sets the Fibre Channel link speed of an adapter. You can set adapters
that support:
10Gb/s to 10 or auto
8Gb/s to 2, 4, 8 or auto
4Gb/s to 2, 4 or auto
2Gb/s to 2 or auto
By default, the link speed option is set to auto for auto negotiation. If you set the link
speed to a specific value, this change disables the auto negotiation. Under certain
conditions, a speed mismatch can prevent the adapter from coming online.
Note:
The system reports the actual link speed with the "Link Data Rate" parameter in the
output of network fcp adapter show -instance.
Parameters
Specifies the node of the target adapter.
-adapter <text> - Adapter
510
Specifies the target adapter.

[-speed {1|2|4|8|10|16|auto}] - Configured Speed
Specifies the adapter configuration speed in Gigabytes.
[-state {down|up}] - Configured State
Species the state of a target adapter. If up, the FCP port is online. If down, the FCP port
is offline.
Examples
cluster1::> network fcp adapter modify -node node1 -adapter 0d -speed 2
Configures the speed of FCP adapter 0d on node1 to 2 Gb/s.
See Also
network interface modify network fcp adapter show -instance
511
network fcp adapter show

Display FCP adapters
level.
Description
Displays FCP target adapter information. You can also use this information to determine
if adapters are active and online.
The adapter argument is in the form Xy or Xy_z where X and z are integers and y is a
letter. An example is 4a or 4a_1.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the FCP adapters that match this parameter value.
[-physical-protocol {fibre-channel|ethernet}] - Physical Protocol
[-max-speed {1|2|4|8|10|16|auto}] - Maximum Speed
512

[-substatus <text>] - Substatus
Selects the FCP adapters that match this parameter value. A substatus contains more
detailed information than a status.
[-portaddr <Hex Integer>] - Host Port Address
Selects the FCP adapters that match this parameter value. This port address refers to
the address assigned to the port by the fabric.
[-firmware-rev <text>] - Firmware Revision
[-data-link-rate <integer>] - Data Link Rate (Gbit)
[-fabric-established {true|false}] - Fabric Established
Selects the FCP adapters that match this parameter value. True displays all FCP
adapters that are logged into the fabric. False displays all the FCP adapters that are not
logged into the fabric.
[-fabric-name <text>] - Fabric Name
Selects the FCP adapters that match this parameter value (Fabric Name).
[-conn-established {loop|ptp}] - Connection Established
Selects the FCP adapters that match this parameter value (loop or point-to-point loop).
[-media-type {loop|ptp|auto}] - Mediatype
[-speed {1|2|4|8|10|16|auto}] - Configured Speed
[-state {down|up}] - Configured State
[-fc-wwnn <text>] - Adapter WWNN
Selects the FCP adapters that match this parameter value (World Wide Node Name).
[-fc-wwpn <text>] - Adapter WWPN
Selects the FCP adapters that match this parameter value (World Wide Port Number).
[-switch-port <text>] - Switch Port
513

[-sfp-formfactor <text>] - Form Factor Of Transceiver
Selects the FCP adapters that match this SFP form factor.
[-sfp-vendor-name <text>] - Vendor Name Of Transceiver
Selects the FCP adapters that match this SFP vendor name.
[-sfp-part-number <text>] - Part Number Of Transceiver
Selects the FCP adapters that match this SFP part number.
[-sfp-rev <text>] - Revision Of Transceiver
Selects the FCP adapters that match this SFP revision.
[-sfp-serial-number <text>] - Serial Number Of Transceiver
Selects the FCP adapters that match this SFP serial number.
[-sfp-fc-speed-capabilities <text>] - FC Capabilities Of Transceiver
Selects the FCP adapters that match this SFP speed capability.
[-sfp-vendor-oui <text>] - Vendor OUI Of Transceiver
Selects the FCP adapters that match this SFP vendor OUI.
[-sfp-wavelength <integer>] - Wavelength In Nanometers
Selects the FCP adapters that match this SFP wavelength.
[-sfp-date-code <text>] - Date Code Of Transceiver
Selects the FCP adapters that match this SFP data code.
[-is-sfp-optical-transceiver-valid {true|false}] - Validity Of Transceiver
Selects the FCP adapters that match this parameter value. Identifies if the SFP optical
transciever on the specified adapter is valid or not.
[-sfp-connector <text>] - Connector Used
Selects the FCP adapters that match this connector.
[-sfp-encoding <text>] - Encoding Used
Selects the FCP adapters that match this encoding.
[-is-sfp-diagnostics-internally-calibrated {true|false}] - Is Internally Calibrated
Selects the FCP adapters that match this parameter value. Identifies if the SFP
diagnostics have been internally calibrated.
514
[-sfp-rx-power <text>] - Received Optical Power

Selects the FCP adapters that match this SFP receive power level.
[-is-sfp-rx-power-in-range {true|false}] - Is Received Power In Range
Selects the FCP adapters that match this parameter value. Indicates if the SFP receive
power for the specified adapter is in range.
[-sfp-tx-power <text>] - SPF Transmitted Optical Power
Selects the FCP adapters that match this SFP transmit power level.
[-is-sfp-tx-power-in-range {true|false}] - Is Xmit Power In Range
Selects the FCP adapters that match this parameter value. Indicates if the transmit
power for the specified adapter is in range.
Examples
cluster1::> fcp adapter show
Connection
Node
Host
Adapter Established Port Address
------------ ------- ----------- -----------sti6280-021
0a
ptp
30012c
The example above displays information regarding FCP adapters within cluster1.
cluster1::> fcp adapter show -instance -node sti6280-021 -adapter 0a
Node: sti6280-021
Adapter: 0a
Description: Fibre Channel Target Adapter 0a (QLogic 2532
(2562), rev. 2, 8G)
Physical Protocol: fibre-channel
Maximum Speed: 8
Status: online
Substatus: ADAPTER UP
Host Port Address: 30012c
Firmware Revision: 5.8.0
Data Link Rate (Gbit): 4
Fabric Established: true
Fabric Name: 20:14:54:7f:ee:54:b9:01
Connection Established: ptp
515
Mediatype: ptp
Configured Speed: auto
Configured State: up
Adapter WWNN: 50:0a:09:80:8f:7f:8b:1c
Adapter WWPN: 50:0a:09:81:8f:7f:8b:1c
Switch Port: RTP-AG01-410B51:1/41
Form Factor Of Transceiver: SFP
Vendor Name Of Transceiver: OPNEXT,INC
Part Number Of Transceiver: TRS2000EN-SC01
Revision Of Transceiver: 0000
Serial Number Of Transceiver: T10H64793
FC Capabilities Of Transceiver: 10 (Gbit/sec)
Vendor OUI Of Transceiver: 0:11:64
Wavelength In Nanometers: 850
Date Code Of Transceiver: 10:08:17
Validity Of Transceiver: true
Connector Used: LC
Encoding Used: 64B66B
Is Internally Calibrated: true
Received Optical Power: 441.3 (uWatts)
Is Received Power In Range: true
SPF Transmitted Optical Power: 600.4 (uWatts)
Is Xmit Power In Range: true
The example above displays detailed information regarding FCP adapter 0a in

sti6280-021 within cluster1.
516
network interface create

Create a logical interface
level.
Description
The network interface create command creates a logical interface (LIF).
Note:
A logical interface is an IP address associated with a physical network port. For logical
interfaces using NAS data protocols, the interface can fail over or be migrated to a
different physical port in the event of component failures, thereby continuing to provide
network access despite the component failure. Logical interfaces using SAN data
protocols do not support migration or failover.
Parameters
Use this parameter to specify the Vserver on which the LIF is created.
-lif <lif-name> - Logical Interface Name
Use this parameter to specify the name of the LIF that is created. For iSCSI and FC
LIFs, the name cannot be more than 254 characters.
-role {cluster|data|node-mgmt|intercluster|cluster-mgmt} - Role
Use this parameter to specify the role of the LIF. Typically, the role of the LIF matches
the role of the network port on which the LIF is associated. A network port is the
physical entity by which a LIF routes network traffic. Ports have four roles:
Cluster ports, which provide communication among the nodes in a cluster
Intercluster ports, which provide communication among peered clusters
Data ports, which provide data access to NAS and SAN clients
Node-management ports, which provide access to node management
functionality.
517
LIFs with the cluster-management role behave as LIFs with the node-management role
except that cluster-management LIFs can failover between nodes.
[-data-protocol {nfs|cifs|iscsi|fcp|fcache|none}, ...] - Data Protocol
Use this parameter to specify the list of data protocols that can be configured on the LIF.
The supported protocols are NFS, CIFS, FlexCache, iSCSI, and FCP. NFS, CIFS, and
FlexCache are available by default when you create a LIF. If you specify "none", the LIF
does not support any data protocols. Also, none, iscsi, or fcp cannot be combined with
any other protocols.
Note:
The data-protocol field must be specified when the LIF is created and cannot be
modified later.
-home-node <nodename> - Home Node
Use this parameter to specify the LIF's home node. The home node is the node to which
the LIF returns when the network interface revert command is run on the LIF.
-home-port {<netport>|<ifgrp>} - Home Port
Use this parameter to specify the LIF's home port or interface group. The home port is
the port or interface group to which the LIF returns when the network interface
revert command is run on the LIF.
-address <IP Address> - Network Address
Use this parameter to specify the LIF's IP address.
Note:
A cluster LIF cannot be on the same subnet as a management or data LIF.
{ -netmask <IP Address> - Netmask
Use this parameter to specify the LIF's netmask.
| -netmask-length <integer> - Bits in the Netmask
Use this parameter to specify the length (in bits) of the LIF's netmask.
{ -auto {true|false} - IPv4 Link Local
Use this parameter to specify whether IPv4 link local addressing is enabled for this LIF.
| [-subnet-name <subnet name>] } - Subnet Name
518
Use this parameter to allocate the interface address from a subnet. If needed, a default
route will be created for this subnet.
[-status-admin {up|down}] - Administrative Status
Use this parameter to specify whether the initial administrative status of the LIF is up or
down. The default setting is up. The administrative status can differ from the operational
status For example, if you specify the status as up but a network problem prevents the
interface from functioning, the operational status remains as down.
[-failover-policy {system-defined|local-only|sfo-partner-only|ipspace-wide|disabled|
broadcast-domain-wide}] - Failover Policy
Use this parameter to specify the failover policy for the LIF.
local-only - The LIF fails over to a port on the local or home node of the LIF.
sfo-partner-only - The LIF fails over to port on the home node or SFO partner only.
broadcast-domain-wide - The LIF fails over to a port in the same broadcast
domain as the home port.
disabled - Failover is disabled for the LIF.
The failover policy for cluster ports is system-defined and cannot be changed. A default
failover policy is assigned to data ports, but the default can be changed.
Note:
Logical interfaces for SAN protocols do not support failover. Thus, such interfaces will
always show this parameter as disabled.
[-firewall-policy <policy>] - Firewall Policy
Use this parameter to specify the firewall policy for the LIF. A LIF can use a default
firewall policy that corresponds to its role (management, cluster, intercluster, or data) or
a custom firewall policy created by an administrator. View and modify existing firewall
policies using the system services firewall policy show and system
services firewall policy modify commands, respectively.
[-auto-revert {true|false}] - Auto Revert
Use this parameter to specify whether a data LIF is automatically reverted to its home
node under certain circumstances. These circumstances include startup, when the
status of the management database changes to either master or secondary, or when the
network connection is made. The default setting is false. If you set the value of this
parameter to true, load balancing migration capability of the data LIF is disabled (the allow-lb-migrate parameter is set to false).
519
Note:
Logical interfaces for SAN traffic do not support auto-revet. Thus, this parameter is
always false on such interfaces.
[-dns-zone {zone-name|none}] - Fully Qualified DNS Zone Name
Use this parameter to specify a unique, fully qualified domain name of a DNS zone to
which this data LIF is added. You can associate a data LIF with a single DNS zone. All
data LIFs included in a zone must be on the same Vserver. If a LIF is not added to a
DNS zone the data LIF is created with the value none.
[-listen-for-dns-query {true|false}] - DNS Query Listen Enable
Use this parameter to specify if the LIF has to listen for DNS queries. The default value
for this parameter is true.
[-allow-lb-migrate {true|false}] - Load Balancing Migrate Allowed (privilege: advanced)
Use this parameter to specify whether load balancing migration is activated for this data
LIF. The default value of this parameter is false. If you set the value of this parameter
to true, automatic revert capability for this data LIF is disabled (the -auto-revert
parameter is set to false). Also, data LIFs that migrate as a result of load balancing
adhere to network interface failover rules.
Note:
During times when a LIF is hosting active NFSv4, CIFS, or NRV connections, load
balancing based LIF migrations between nodes will be temporarily disabled.
[-lb-weight {load|0..100}] - Load Balanced Weight (privilege: advanced)
Use this parameter to specify a load balancing weight for a data LIF. A valid numeric
load balancing weight is any integer between 0 and 100. When you specify the same
load balancing weight for all data LIFs in a DNS zone, client requests are uniformly
distributed, similar to round-robin DNS. A data LIF with a low load balancing weight
is made available for client requests less frequently than one that has a high load
balancing weight. "load" is the default value of this parameter. If set to "load", node
utilization statistics are used to dynamically assign the load balancing weight.
[-failover-group <failover-group>] - Failover Group Name
Use this parameter to specify the name of the failover group to associate with the LIF.
Manage failover groups by using the network interface failover-groups
command. A "clusterwide" failover group exists by default and includes all of the ports
available in the cluster for failover. Furthermore, the failover group of the cluster-
520
management LIF, which you specify when you create a cluster (see the cluster
create command), is automatically set to "clusterwide".
Note:
Logical interfaces for SAN protocols do not support failover. Thus, this parameter cannot
be specified for such interfaces.
Use this parameter to specify the comment to associate with the LIF.
[-force-subnet-association [true]] - Force the LIF's Subnet Association
This command will fail if the IP address falls within the address range of a named
subnet. Set this to true to acquire the address from the named subnet and assign the
subnet to the LIF.
Examples
The following example creates an IPv4 LIF named datalif1 and an IPv6 LIF named
datalif2 on a Vserver named vs0. Their home node is node0 and home port is e0c. The
failover policy nextavail is assigned to both LIFs. The firewall policy is data and the LIFs
are automatically reverted to their home node at startup and under other circumstances.
The datalif1 has the IP address 192.0.2.130 and netmask 255.255.255.128, and datalif2
has the IP address 3ffe:1::aaaa and netmask length of 64.
cluster1::> network interface create -vserver vs0 -lif datalif1 -role data home-node node0 -home-port e0c -address 192.0.2.130 -netmask 255.255.255.128 failover-policy broadcast-domain-wide -firewall-policy data -auto-revert true
cluster1::> network interface create -vserver vs0 -lif datalif2 -role data -homenode node0 -home-port e0c -address 3ffe:1::aaaa -netmask-length 64 -failoverpolicy nextavail -firewall-policy data -auto-revert true
See Also
network interface revert system services firewall policy show
system services firewall policy modify network interface failover-groups
cluster create
521
network interface delete

Delete a logical interface
level.
Description
The network interface delete command deletes a logical interface from a
Vserver.
Note:
If you are using SAN protocols and the LIF you want to delete is in a port set, you must
remove the LIF from the port set before you can delete the LIF. To determine if a LIF is
in a port set, use the lun portset show command. To remove the LIF from the port
set, use the lun portset remove command.
Parameters
Use this parameter to specify the Vserver on which the logical interface to be deleted is
located.
Use this parameter to specify the logical interface to delete.
Examples
The following example deletes a logical interface named cluslif3 that is located on a
Vserver named vs0.
cluster1::> network interface delete -vserver vs0 -lif cluslif3
See Also
lun portset show lun portset remove
522
network interface migrate-all

Migrate all data and cluster management logical interfaces away from the specified
node
level.
Description
The network interface migrate-all command migrates all data logical
interfaces from the node you specify.
Note:
Manual migration of a logical interface can take up to 15 seconds to complete.
Logical interface migration is a best-effort command and can only be completed if the
destination node and port are operational. Logical interface migration requires that
the logical interface be pre-configured with valid failover rules to facilitate failover to a
remote node.
Note:
Logical interfaces for SAN protocols do not support migration. Attempts to do so will
result in an error.
Parameters
Use this parameter to specify the node from which all logical interfaces are migrated.
Each data logical interface is migrated to another node in the cluster, assuming that the
logical interface is configured with failover rules that specify an operational node and
port.
[-port {<netport>|<ifgrp>}] - Port
Use this parameter to specify the port from which all logical interfaces are migrated. This
option cannot be used with ansychronous migrations. If this parameter is not specified,
then logical interfaces will be migrated away from all ports on the specified node.
Examples
The following example migrates all data logical interfaces from the current (local) node.
523
cluster1::> network interface migrate-all -node local
network interface migrate

Migrate a logical interface to a different port
level.
Description
The network interface migrate command migrates a logical interface to a port or
interface group on the node you specify.
Note:
Manual migration of a logical interface can take up to 15 seconds to complete. Also,
when you migrate a cluster logical interface, you must do so from the local node.
Logical interface migration is a best-effort command, and can only be completed if the
destination node and port are operational
Note:
Logical interfaces for SAN protocols do not support migration. Attempts to do so will
result in an error.
Parameters
Use this parameter to specify the Vserver that owns the logical interface that is to be
migrated.
Use this parameter to specify the logical interface that is to be migrated.
[-source-node <nodename>] - Source Node
Use this parameter to specify the node from which the logical interface is to be migrated.
-destination-node <nodename> - Destination Node
Use this parameter to specify the node to which the logical interface is to be migrated.
524
[-destination-port {<netport>|<ifgrp>}] - Destination Port

Use this parameter to specify the port or interface group to which the logical interface is
to be migrated.
[-force [true]] - Force Migrate Data LIF Flag (privilege: advanced)
Use this parameter to force the migration operation.
Examples
The following example migrates a logical interface named datalif1 on a Vserver named
vs0 to port e0c on a node named node2:
cluster1::> network interface migrate -vserver vs0 -lif datalif1 -source-node vs0
-dest-node node2 -dest-port e0c
network interface modify

Modify a logical interface
level.
Description
The network interface modify command modifies attributes of a logical interface
(LIF).
Note:
You cannot modify some properties of an iSCSI or FCP LIF, such as -home-node
or -home-port, if the LIF is in a port set. To modify these properties, first remove
the LIF from the port set. To determine if a LIF is in a port set, use the lun portset
show command. To remove the LIF from the port set, use the lun portset remove
command.
Parameters
Use this parameter to specify the Vserver on which the LIF to be modified is located.
525
Use this parameter to specify the name of the LIF that is to be modified
[-home-node <nodename>] - Home Node
Use this parameter to modify the LIF's home node. The home node is the node to which
the LIF returns when the network interface revert command is run on that LIF.
[-home-port {<netport>|<ifgrp>}] - Home Port
Use this parameter to modify the LIF's home port. The home port is the port or interface
group to which the LIF returns when the network interface revert command is
run on that LIF.
Note:
If you change this parameter for a cluster or management LIF, you must reboot the
storage system to force the change to take effect.
[-address <IP Address>] - Network Address
Use this parameter to modify the LIF's IP address.
Note:
A cluster LIF cannot be on the same subnet as a data or management LIF.
{ [-netmask <IP Address>] - Netmask
Use this parameter to modify the LIF's netmask.
| [-netmask-length <integer>] - Bits in the Netmask
Use this parameter to modify the length (in bits) of the LIF's netmask.
{ [-auto {true|false}] - IPv4 Link Local
Use this parameter to modify the LIF's IPv4 Link Local IP address.
| [-subnet-name <subnet name>] } - Subnet Name
Use this parameter to allocate the interface address from a subnet. Modifying this
parameter will cause a new IP address to be allocated and assigned to the interface.
Use this parameter to modify the administrative status of the LIF. The administrative
status can differ from the operational status. For example, if you specify the status as
up but a network problem prevents the interface from functioning, the operational status
remains as down.
526
Use this parameter to modify the failover policy for the LIF.
system-defined - The system determines appropriate failover targets for the LIF.
local-only - The LIF fails over to a port on the local or home node of the LIF.
sfo-partner-only - The LIF fails over to a port on the home node or SFO partner
only.
broadcast-domain-wide - The LIF fails over to a port in the same broadcast
domain as the home port.
disabled - Failover is disabled for the LIF.
Note:
The failover policy for cluster logical interfaces is local-only and cannot be changed.
A default failover policy is assigned to data logical interfaces, but the default can be
changed.
Note:
Logical interfaces for SAN protocols do not support failover. Thus, such interfaces
always show this parameter as disabled.
Use this parameter to set the firewall policy for the LIF. A LIF can use a default firewall
policy that corresponds to its role (management, cluster, or data) or a custom firewall
policy created by an administrator. When using a custom policy, the interface will
fallback on its role's default policy for unspecified services. View existing firewall
policies with the "system services firewall policy show" command. Modify
existing firewall policies with the "system services firewall policy modify"
command.
Use this parameter to modify whether a data LIF is reverted automatically to its home
node under certain circumstances. These circumstances would include startup, when
the status of the management database changes to either master or secondary, and
when the network connection is made. The default setting is false. If you set the value
of this parameter to true, the load balancing migration capability of the data LIF is
disabled (the -allow-lb-migrate parameter is set to false).
527
Note:
Logical interfaces for SAN traffic do not support auto-revert. Thus, this parameter is
always false on such interfaces.
Use this parameter to modify the unique, fully qualified domain name of the DNS zone
to which this data LIF belongs. You can associate a data LIF with a single DNS zone. All
data LIFs included in a zone must be on the same Vserver. If you do not specify a value
for this parameter, the data LIF is created with the value none.
Use this parameter to specify if the LIF has to listen for DNS queries. The default value
for this parameter is true.
Use this parameter to modify whether or not load balancing migration is enabled for
this data LIF. The default value of this parameter is false. If you set the value of this
parameter to true, the automatic revert capability of the data LIF is disabled (the auto-revert parameter is set to false). Also, data LIFs that migrate as a result of
load balancing adhere to network interface failover rules.
Note:
During times when a LIF is hosting active NFSv4, CIFS, or NRV connections, load
balancing based LIF migrations between nodes will be temporarily disabled.
Use this parameter to modify the load balancing weight of the data LIF. A valid
load balancing weight is any integer between 1 and 100. If you specify the same
load balancing weight for all data LIFs in a DNS zone, client requests are uniformly
distributed, similar to round-robin DNS. A data LIF with a low load balancing weight
is made available for client requests less frequently than one that has a high load
balancing weight.
Use this parameter to modify the name of the failover group to associate with the
network interface. Create failover groups using the network interface failover
create command. A "clusterwide" failover group exists by default and includes all
of the ports available in the cluster for LIF failover. Furthermore, the failover group of
the cluster management LIF, which you specify when you create a cluster (see the
cluster create command), is automatically set to "clusterwide".
528
Note:
Logical interfaces for SAN protocols do not support failover. Thus, this parameter cannot
be specified for such interfaces.
Use this parameter to modify the comment associated with the LIF.
[-force-subnet-association [true]] - Force the LIF's Subnet Association
This command will fail if the IP address falls within the address range of a named
subnet. Set this to true to acquire the address from the named subnet and assign the
subnet to the LIF.
Examples
The following example modifies a LIF named datalif1 on a logical server named vs0.
The LIF's netmask is modified to 255.255.255.128.
cluster1::> network interface modify -vserver vs0 -lif datalif1 -netmask
255.255.255.128
See Also
network interface revert system services firewall policy show
system services firewall policy modify network interface failover create cluster create
lun portset show lun portset remove
529
network interface rename

Rename a logical interface
level.
Description
Use the network interface rename command to change the name of an existing
logical interface.
Parameters
Use this parameter to specify the Vserver on which the logical interface to rename is
located.
Use this parameter to specify the name of the logical interface to rename.
-newname <text> - LIF
Use this parameter to specify the new name of the logical interface. For iSCSI and FC
LIFs, the name cannot be more than 254 characters.
Examples
The following example renames a cluster logical interface named cluslif1 to cluslif4 on a
Vserver named vs0.
cluster1::> network interface rename -vserver vs0 -lif cluslif1 -newname cluslif4
network interface revert

Revert a logical interface to its home port
level.
Description
530
The network interface revert command reverts a logical interface that is not
currently on its home port to its home port, assuming that the home node and port are
both operational. A logical interface's home port is specified when the logical interface is
created. Determine a logical interface's home port by using the network interface
show command.
Parameters
Use this parameter to specify the Vserver on which the logical interface to be reverted is
located.
Use this parameter to specify the logical interface that is to be reverted.
Note:
Logical interfaces for SAN protocols are always home. Thus, this command has no
effect on such interfaces. The same applies to logical interfaces for NAS protocols that
are already home.
Examples
The following example returns any logical interfaces that are not currently on their home
ports to their home ports.
cluster1::> network interface revert -vserver * -lif *
See Also
network interface show
531
network interface show-zones

Show the DNS zone names of LIFs
Description
The network interface show-zones command displays information about logical
interfaces and whether the interface is associated with a Domain Name System (DNS)
load balancing zone.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display information only about logical interfaces on the Vserver
you specify.
Use this parameter plus the -lif parameter to display information only about the
Use this parameter to display information only about logical interfaces that match the
name you specify.
Use this parameter with the -vserver parameter to display information only about the
Use this parameter to display only information about logical interfaces that are
associated with the DNS zone you specify.
532

Use this parameter to display information about logical interfaces which are either
listening or not listening for DNS queries.
Examples
The following example displays general information about all logical interfaces and DNS
zones.
cluster1::> network interface show-zones
Listen For
Vserver
Interface Name
DNS Zone
--------------
--------------
---------------- ----------
DNS Query
data1
www.example1.com true
data2
www.example1.com false
data1
data2
clus1
none
false
clus2
none
false
mgmt1
none
false
clus1
none
false
clus2
none
false
mgmt1
none
false
cluster_mgmt
none
false
vs1
vs2
node1
node2
cluster
533
network interface show

Display logical interfaces
Description
The network interface show command displays information about logical
interfaces.
Running the command with the -failover parameter displays information relevant to
logical interface failover rules.
Running the command with the -by-ipspace parameter displays information relevant
to logical interfaces on a specific IPspace.
See the examples for more information.
You can specify additional parameters to display only information that matches
those parameters. For example, to display information only about logical interfaces
whose operational status is down, run the command with the -status-oper down
parameter.
Parameters
If you specify the -fields <fieldname>,... parameter, the command displays only
the fields that you specify.
| [-by-ipspace ]
Use this parameter to display logical-interfaces sorted by IPspace and Vserver.
| [-failover ]
Use this parameter to display logical-interface failover information.
| [-instance ] }
Use this parameter to display all the fields for the specified logical-interfaces.
Use this parameter to display information only about logical interfaces on the Vserver
you specify.
534
Use this parameter plus the -lif parameter to display detailed information only about
the logical interface you specify.
name you specify.
Use this parameter with the -vserver parameter to display detailed information only
about the logical interface you specify.
[-role {cluster|data|node-mgmt|intercluster|cluster-mgmt}] - Role
Use this parameter to display information only about logical interfaces that are
associated with network ports that have the role you specify.
[-data-protocol {nfs|cifs|iscsi|fcp|fcache|none}, ...] - Data Protocol
Use this parameter to display information only about logical interfaces that have the
enabled data protocols you specify.
[-home-node <nodename>] - Home Node
home node you specify.
[-home-port {<netport>|<ifgrp>}] - Home Port
home port or interface group you specify.
[-curr-node <nodename>] - Current Node
Use this parameter to display information only about logical interfaces that are currently
located on the node you specify.
[-curr-port {<netport>|<ifgrp>}] - Current Port
Use this parameter to display information only about logical interfaces that are currently
located on the port or interface group you specify.
[-status-oper {up|down}] - Operational Status
operational status you specify.
[-status-extended <text>] - Extended Status
extended status that you specify. This applies only to FCP logical interfaces.
[-numeric-id <integer>] - Numeric ID (privilege: advanced)
535
Use this parameter to display information only about logical interfaces with the numeric
ID (or range of IDs) you specify. The numeric ID is an integer that identifies the logical
interface in the cluster.
[-is-home {true|false}] - Is Home
Use this parameter to display information only about logical interfaces that are (true) or
are not (false) currently located on their home node and port.
Use this parameter to display information only about logical interfaces that match the IP
address or address range you specify.
[-netmask <IP Address>] - Netmask
netmask you specify.
[-netmask-length <integer>] - Bits in the Netmask
Use this parameter to display information only about logical interfaces with a netmask
that has the number of bits you specify.
[-auto {true|false}] - IPv4 Link Local
Use this parameter to display information only about logical interfaces that have IPv4
link local IP addresses.
[-subnet-name <subnet name>] - Subnet Name
Use this parameter to display the logical interfaces that matches the subnet name.
administrative status you specify.
Use this parameter to display information only about logical interfaces that use the
failover policy you specify.
Use this parameter to display information only about logical interfaces that use the
firewall policies you specify.
536
Use this parameter to display information only about logical interfaces that have autorevert setting you specify.
[-sticky {true|false}] - Sticky Flag (privilege: advanced)
Use this parameter to display information only about logical interfaces that are "sticky".
A sticky logical interface is one that has been manually migrated to another node and
is not subject to auto-revert settings. A sticky logical interface remains at the migrated
location until it is manually reverted or until it fails over to another node.
Use this parameter to display information only about logical interfaces in the specified
DNS zone.
DNS query listen value you specify.
Use this parameter to display information only about logical interfaces for which load
balancing migration is activated (true) or not activated (false).
Use this parameter to display information only about logical interfaces that have the load
balancing weight you specify.
Use this parameter to display information only about logical interfaces that are in the
failover group you specify. Logical interfaces in the same failover group are capable of
failing over to the same set of ports.
[-wwpn <text>] - FCP WWPN
Fibre Channel Protocol port identifier (World Wide Port Name) you specify.
[-address-family {ipv4|ipv6|ipv6z}] - Address family
Use this parameter to view the address family that is in use on the interface. Only IPv4
and IPv6 non-zoned addresses can be configured. Configuration of IPv6z addresses is
not allowed.
comment you specify.
537
[-ipspace <IPspace>] - IPspace of LIF

Use this parameter to display information only about logical interfaces on the IPspace
you specify.
Examples
The following example displays general information about all logical interfaces.
cluster1::> network interface show
Vserver
Logical
Status
Network
Interface
Admin/Oper Address/Mask
Current
Current Is
Node
Port
Home
----------- ---------- ---------- ------------------ ------------- ------- ---cluster1

cluster_mgmt
up/up
192.0.2.1/192
node0
e0M
true
192.0.2.2/192
node0
e0M
true
192.0.2.3/192
node1
e0M
true
192.0.2.66/192
node0
e0a
true
192.0.2.67/192
node0
e0b
true
192.0.2.68/192
node1
e0a
true
192.0.2.69/192
node1
e0b
true
node0_mgmt1
up/up
node1_mgmt1
up/up
Cluster
node0_clus1
up/up
node0_clus2
up/up
node1_clus1
up/up
node1_clus2
up/up
The following example displays failover information about all logical interfaces.
cluster1::> network interface show -failover
Vserver
Logical
Home
Failover
Failover
Interface
Node:Port
Policy
Group
-------- --------------- --------------------- --------------- --------------cluster1

cluster_mgmt
node0:e0M
broadcast-domain-wide
Default
Failover Targets: node0:e0M,

node0:e0d,
538
node0:e0e,
node0:e0f,
node1:e0M,
node1:e0d,
node1:e0e,
node1:e0f
node0_mgmt1
node0:e0M
local-only
Default

node0:e0d,
node0:e0e,
node0:e0f
node1_mgmt1
node1:e0M
local-only
Default

node1:e0d,
node1:e0e,
node1:e0f
Cluster
node0_clus1
node0:e0a
local-only
Cluster
Failover Targets: node0:e0a,

node0:e0b
node0_clus2
node0:e0a
local-only
Cluster
Failover Targets: node0:e0b,

node0:e0a
node1_clus1
node1:e0a
local-only
Cluster
Failover Targets: node1:e0a,

node1:e0b
node1_clus2
node1:e0a
local-only
Cluster
Failover Targets: node1:e0b,

node1:e0a
539
network interface start-cluster-check

Start the cluster check function
privilege level.
Description
The network interface start-cluster-check command initiates an
accessibility check from every logical interface to every aggregate. Automatic checks
run periodically, but this command manually initiates a check immediately.
This command produces no direct output. Any errors encountered during the check are
reported in the event log. See the event log show command for more information.
Parameters
None
Examples
This example shows an execution of this command, with all parameters and output.
cluster1::> network interface start-cluster-check
See Also
event log show
540
network interface dns-lb-stats show

Show the DNS load-balancer stats for this node
Description
The network interface dns-lb-stats show command displays the statistics
for DNS load-balancing lookups for the zones belonging to the specified Vserver. These
statistics represent the data for the Vserver on the local node. The following counts can
be seen in the statistics output:
success-count : Number of successful lookups.
authoritative-count : Number of authoritative answers sent.
nonauthoritative-count : Number of non authoritative answers sent.
rr-set-missing-count : Number of times the RR set was missing.
domain-missing-count : Number of times the domain was not be found.
failure-count : Number of failed lookups.
dropped-count : Number of lookups dropped.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display DNS load-balancer statistics only for the specified
Vservers.
[-zone <text>] - DNS Zone
541
Use this parameter to display DNS load-balancer statistics only for the specified DNS
zones.
[-success-count <integer>] - Successful Lookup Count
Use this parameter to display DNS load-balancer statistics only for the specified number
of successful lookups.
[-authoritative-count <integer>] - Authoritative Answer Count
of authoritative answers sent.
[-nonauthoritative-count <integer>] - Non Authoritative Answer Count
of non-authoritative answers sent.
[-rr-set-missing-count <integer>] - RR Set Missing Count
of times the RR set was missing.
[-domain-missing-count <integer>] - Name Missing Count
of times the domain was not found.
[-failure-count <integer>] - Failed Lookup Count
of failed lookups.
[-dropped-count <integer>] - Dropped Count
of dropped lookups.
Examples
The following example displays stats for the zone "x.com".
cluster1::> network interface dns-lb-stats show -zone x.com
Vserver
DNS Zone
SUCCESS
AUTH
---------
-----------------
-------
-----
NOAUTH
NORR
NODOM
FAILED
DROP
------ -----
-----
------ -----
vs2
x.com
542
network interface failover-groups add-targets

Add failover targets to a failover group
level.
Description
The network interface failover-groups add-targets command enables
you to add a list of failover targets such as network ports, interface groups, or VLANs to
an existing logical interface failover group.
Parameters
Use this parameter to specify the name of the Vservers from which this failover group is
accessible.
-failover-group <text> - Failover Group Name
Use this parameter to specify the failover group that you want to extend.
-targets <<node>:<port>>, ... - Failover Targets
Use this parameter to specify the failover targets such as network ports, interface
groups, or VLANs you wish to add to the failover group.
Examples
This example shows the failover group "clyde" being extended to include additional
failover targets.
cluster1::> network interface failover-group add-targets -vserver vs1 -failovergroup clyde -targets xena1:e0c, xena1:e0d-100, xena2:a0a
network interface failover-groups create

Create a new failover group
level.
543
Description
The network interface failover-groups create command creates a
grouping of failover targets for logical interfaces on one or more nodes. Use this
command to add a new network port or interface group to an existing failover group.
Note:
Interfaces for SAN protocols do not support failover. Such interfaces are not valid
failover targets.
Parameters
accessible.
Use this parameter to specify the name of the logical interface failover group that you
want to create.
Use this parameter to specify the list of failover targets (network ports, interface groups,
or VLANs on a node) belonging to this failover group.
Examples
The following example shows how to create a failover group named failover-group_2
containing ports e1e and e2e on node Xena.
cluster1::> network interface failover-groups create -vserver vs0 -failover-group
failover-group_2 -targets xena:e1e,xena:e2e
network interface failover-groups delete

Delete a failover group
level.
Description
544
The network interface failover-groups delete command deletes a logical

interface failover group.
Parameters
accessible.
Use this parameter to specify the name of the logical interface failover group to be
deleted.
Examples
The following example shows how to delete a failover group named failover-group_2.
cluster1::> network interface failover-groups delete -vserver vs1 -failover-group
failover-group_2
network interface failover-groups modify

Modify a failover group
level.
Description
The network interface failover-groups modify command enables you
modify the list of network ports, interface groups, or VLANs belonging to an existing
logical interface failover group. The specified list will overwrite the existing list of network
ports, interface groups, and VLANs currently belonging to the logical interface failover
group.
Parameters
Use this parameter to specify the name of the Vserver(s) from which this failover group
is accessible.
545
Use this parameter to specify the failover group that you want to modify.
[-targets <<node>:<port>>, ...] - Failover Targets
Use this parameter to specify the network ports, interface groups, or VLANs you wish to
now belong to the failover group.
Examples
This example shows the failover group "clyde" being modified to now contain the
specified network ports.
cluster1::> network interface failover-group modify -vserver vs1 -failover-group
clyde -targets xena1:e0c, xena1:e0d-100, xena2:a0a
network interface failover-groups remove-targets

Remove failover targets from a failover group
level.
Description
The network interface failover-groups remove-targets command
enables you to specify a list of failover targets such as network ports, interface groups,
or VLANs to be removed from an existing logical interface failover group.
Parameters
Use this parameter to specify the name of the Vserver(s) from which this failover group
is accessible.
Use this parameter to specify the failover group that you want to remove failover targets
from.
Use this parameter to specify the failover targets such as network ports, interface
groups, or VLANs you wish to remove from the failover group.
Examples
546
This example shows the failover targets xena1:e0c and xena1:e0d-100 being removed
from the failover group "clyde".
cluster1::> network interface failover-group remote-targets -vserver vs1 failover-group clyde -targets xena1:e0c, xena1:e0d-100, xena2:a0a
network interface failover-groups rename

Rename a logical interface failover Group
level.
Description
The network interface failover-groups rename command enables you to
rename an existing logical interface failover group.
Parameters
accessible.
Use this parameter to specify the failover group that you want to rename.
-new-failover-group-name <text> - New name
Use this parameter to specify the new name of the failover group.
Examples
This example shows the failover group "clusterwide" being renamed "clyde".
cluster1::> network interface failover-group rename -failover -vserver vs1 failover-group clusterwide -new-failover-group-name clyde
network interface failover-groups show

Display logical interface failover groups
547

Description
The network interface failover-groups show command displays information
about logical interface failover groups.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display information only about the logical interface failover groups
that have the target Vserver you specify.
[-failover-group <text>] - Failover Group Name
you specify.
[-targets <<node>:<port>>, ...] - Failover Targets
that have the failover target (physical port, interfacde group, or VLAN) you specify.
[-broadcast-domain <broadcast domain name>] - Broadcast Domain
that have the broadcast domain you specify.
Examples
The following example displays information about all logical interface failover groups on
a two node cluster.
cluster1::> network interface failover-groups show
Failover
Vserver
548
Group
Targets
---------------- ---------------- -------------------------------------------Cluster

Cluster
node1:e1a, node1:e2a,
node2:e1a, node2:e2a,
cluster1
Default
node1:e0M, node1:e0a,
node1:e0b, node1:e0c,
node1:e0d, node2:e0M,
node2:e0a, node2:e0b,
node2:e0c, node2:e0d
549
network interface lif-weights show

Show the load-balancer LIF weights
Description
The network interface lif-weights show command displays the weights
assigned to each LIF in a DNS load-balancing zone in a Vserver.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display information only for the specified Vservers.
[-zone <text>] - DNS Zone
Use this parameter to display information only for the specified DNS zones.
Use this parameter to display information only for the specified IP addresses.
[-weight <double>] - Load Balancer Weight
Use this parameter to display information only for the specified load balancer weights
Examples
The following example displays LIF weights for vserver "vs1".
cluster1::> network interface lif-weights show -vserver vs1
Network
Vserver
550
DNS Zone
Address
Weight
---------
------------------
------------
-------
a.com
4.4.4.4
12.4206
x.com
1.1.1.1
12.4206
x.com
10.72.46.236
12.4206
vs1
551
network ipspace create

Create a new IPspace
level.
Description
Create a new IPspace.
Parameters
-ipspace <IPspace> - IPspace name
The name of the IPspace to be created.
Examples
The following example creates IPspace "ips1".
cluster1::> network ipspace create -name ips1
network ipspace delete

Delete an IPspace
level.
Description
552
Delete an IPspace that contains no ports or Vservers.
Parameters
The name of the IPspace to be deleted. If the IPspace is associated with one or more
logical-interfaces, you must delete them before you can delete the IPspace.
Examples
The following example deletes the IPspace "ips1".
cluster1::> network ipspace delete -ipspace ips1
network ipspace rename

Rename an IPspace
level.
Description
Rename an IPspace.
Parameters
The name of the IPspace to be renamed.
-new-name <IPspace> - New Name
The new name for the IPspace.
553
Examples
The following example renames IPspace "ips1" to "ips2".
cluster1::> network ipspace rename -ipspace ips1 -new-name ips2
network ipspace show

Display IPspace information
level.
Description
Display network IPspaces.
Parameters
Specify the fields to be displayed for each IPspace.
| [-instance ] }
Display all parameters of the IPspace objects.
[-ipspace <IPspace>] - IPspace name
Display the names of the IPspaces.
[-ports <<node>:<port>>, ...] - Ports
The list of network ports assigned to each IPspace.
[-broadcast-domains <broadcast domain name>, ...] - Broadcast Domains
The list of broadcast domains that belong to the IPspace.
[-vservers <vserver name>, ...] - Vservers
The list of Vservers assigned to each IPspace.
Examples
554
The following example displays general information about IPspaces.

cluster1::> network ipspace show
IPspace
Vserver List
Broadcast Domains
------------------- ----------------------------- ---------------------------Cluster

Cluster
cluster1, vs1, vs2
br1, br2, br3
Default
555
network ndp default-router delete-all

Delete default routers on a given IPspace
privilege level.
Description
The network ndp default-router delete-all command deletes default router
lists from the specified IPspace.
Parameters
-ipspace <IPspace> - IPspace Name
Use this parameter to specify the IPspace where the default routers are to be deleted.
Examples
The following example deletes default routers from IPspace ips1.
cluster1::*> network ndp default-router delete-all -ipspace ips1
network ndp default-router show

Display default routers
privilege level.
Description
The network ndp default-router show command displays Neighbor Discovery
Protocol (NDP) default routers learned on a specified port.
Parameters
556
specify.
| [-instance ] }
about all fields.
Displays the NDP default routers from the specified node.
Displays the NDP default routers from the specified IPspace.
Displays the NDP default routers from the specified port.
[-router-addr <IP Address>] - Router Address
Displays the default routers that have the specified IPv6 addresses.
[-flag {none|managed-address-DHCPv6|other-DHCPv6}] - Flag
Displays the default routers that have the specified flag. The flag indicates whether
addresses are available via DHCPv6 or other configuration information is available via
DHCPv6.
[-expire-time {[<integer>d][<integer>h][<integer>m][<integer>s]|never|expired}] - Expire
Time
Displays the default routers that have the specified expire time.
Examples
The following example displays NDP default routers on local port e0f.
cluster1::*> network ndp default-router show -port e0f -node local
Node: node1
IPspace: Default
Port
Router Address
Flag
Expire Time
-------- -------------------------- --------------
--------------
e0f
0d0h23m9s
fe80::5:73ff:fea0:107
none
557
network ndp neighbor create

Create a static NDP neighbor entry
Description
The network ndp neighbor create command creates a static Neighbor Discovery
Protocol (NDP) neighbor entry within a Vserver.
Parameters
Use this parameter to specify the Vserver on which the NDP neighbor is to be created.
-neighbor <IP Address> - Neighbor Address
Use this parameter to specify the neighbor's IPv6 address.
-mac-address <MAC Address> - MAC Address
Use this parameter to specify the neighbor's MAC address.
Examples
The following example creates a NDP neighbor entry within Vserver vs0.
cluster1::*> network ndp neighbor create -vserver vs0 -neighbor 20:20::20 -macaddress 10:10:10:0:0:1
network ndp neighbor delete

Delete a static NDP neighbor entry
Description
558
The network ndp neighbor delete command deletes a static Neighbor Discovery
Protocol (NDP) neighbor from a Vserver.
Parameters
Use this parameter to specify the Vserver on which the NDP neighbor is to be deleted.
-neighbor <IP Address> - Neighbor Address
Use this parameter to specify the neighbor's IPv6 address.
Examples
The following example deletes a NDP neighbor entry within Vserver vs0.
cluster1::*> network ndp neighbor delete -vserver vs0 -neighbor 20:20::20
network ndp neighbor show

Display static NDP neighbor entries
Description
The network ndp neighbor show command displays a group of static Neighbor
Discovery Protocol (NDP) neighbors within one or more Vservers. You can view static
NDP neighbors within specified Vservers, neighbors with specified IPv6 address, and
neighbors with specified MAC address.
Parameters
specify.
| [-instance ] }
about all fields.
559

Displays the static NDP neighbors that have the specified Vserver as their origin.
[-neighbor <IP Address>] - Neighbor Address
Displays the static NDP neighbors that have the specified IPv6 address.
[-mac-address <MAC Address>] - MAC Address
Displays the static NDP neighbors that have the specified MAC address.
Examples
The following example displays all of the static NDP neighbors configured on Vserver
vs0.
cluster1::*> network ndp neighbor show -vserver vs0
Vserver
Neighbor
MAC Address
------------------ ------------------------ ------------------vs0

10:10::10
04:04:04:04:04:04
20:20::20
01:01:01:01:01:01
560
network ndp neighbor active-entry delete

Delete active neighbor entry
privilege level.
Description
The network ndp neigbhor active-entry delete command deletes a Network
Discovery Protocol (NDP) neighbor entry on the specified port from a given Vserver's
subnet group.
Parameters
Use this parameter to specify the node on which the neighbor entry is to be deleted.
Use this parameter to specify the Vserver on which the neighbor entry is to be deleted.
-subnet-group <IP Address/Mask> - Subnet Group
Use this parameter to specify the subnet group from which the neighbor entry is to be
deleted.
-neighbor <IP Address> - Neighbor
Use this parameter to specify the IPv6 address of the neighbor entry which is to be
deleted.
-port {<netport>|<ifgrp>} - Port
Use this parameter to specify the port on which the neighbor entry is to be deleted.
Examples
The following example deletes a neighbor entry from Vserver ips1.
cluster1::*> network ndp neighbor active-entry delete -vserver ips1 -node local subnet-group ::/0 -neighbor fe80:4::5:73ff:fea0:107 -port e0d
See Also
561
network ndp neigbhor active-entry delete
562
network ndp neighbor active-entry show

Display active neighbor entries
privilege level.
Description
The network ndp neighbor active-entry show command displays Network
Discovery Protocol (NDP) neighbor cache entries on one or more nodes. You can view
ndp neighbors within specified nodes and within specified Vservers.
Parameters
specify.
| [-verbose ]
Displays the expire time, state, is-router, and probe count fields.
| [-instance ] }
about all fields.
Displays the NDP neighbors from the specified node.
Displays the NDP neighbors from the specified Vserver.
[-subnet-group <IP Address/Mask>] - Subnet Group
Displays the NDP neighbors in the specified subnet group.
[-neighbor <IP Address>] - Neighbor
Displays the NDP neighbors that have the specified IPv6 address.
Displays the NDP neighbors on the specified port.
563
[-mac-address <MAC Address>] - MAC Address

Displays the NDP neighbors have the specified MAC address.
Time
Displays the NDP neighbors have the specified expire time.
[-state {<nostate|incomplete|reachable|stale|delay|probe|unknown>}] - State
Displays the NDP neighbors in the specified state.
[-is-router {true|false}] - Is Router
Displays the NDP neighbor which is a router.
[-probe-count <integer>] - Probe Count
Displays the NDP neighbors with the specified probe count. Probe count is the number
of times that this neighbor's MAC address has been queried.
[-is-static {true|false}] - Is Static
Displays the NDP neighbors which are statically configured.
Examples
The following example displays NDP neighbors on Vserver ips1.
cluster1::*> network ndp neighbor active-entry show -vserver ips1
Node: node1
Vserver: ips1
Subnet Group: ::/0
Neighbor
MAC Address
Port
------------------------------ -------------------- -------fe80:4::5:73ff:fea0:107
00:05:73:a0:01:07
e0d
fe80:4::226:98ff:fe0c:b6c1
00:26:98:0c:b6:c1
e0d
fe80:4::4255:39ff:fe25:27c1
40:55:39:25:27:c1
e0d
564
network ndp prefix delete-all

Delete IPv6 prefixes on a given IPspace
privilege level.
Description
The network ndp prefix delete-all command deletes all prefixes learned from
the specified IPspace.
Parameters
Use this parameter to specify the IPspace where the IPv6 prefixes are to be deleted.
Examples
The following example deletes all IPv6 prefixes within IPspace ips1.
cluster1::*> network ndp prefix delete-all -ipspace ips1
network ndp prefix show

Display IPv6 prefixes
privilege level.
Description
The network ndp prefix show command displays IPv6 prefixes on one or more
nodes.
Parameters
565
specify.
| [-verbose ]
Displays the valid-lifetime, preferred-lifetime, origin and advertising-router fields.
| [-instance ] }
about all fields.
Displays the IPv6 prefixes from the specified node.
Displays the IPv6 prefixes from the specified IPspace.
Displays the IPv6 prefixes on the specified port.
[-prefix <IP Address/Mask>] - Prefix
Displays the IPv6 prefixes with the specified prefix value.
[-flag {none|on-link|autonomous|on-link-autonomous}] - Flag
Displays the IPv6 prefixes with the specified flag. The flag indicates whether a prefix is
on-link and whether it can be used in autonomous address configuration.
[-valid-lifetime {<unsigned integer>|infinity}] - Valid Lifetime
Displays the IPv6 prefixes having the specified valid lifetime in seconds.
[-preferred-lifetime {<unsigned integer>|infinity}] - Preferred Lifetime
Displays the IPv6 prefixes having the specified preferred lifetime in seconds.
Time
Displays the IPv6 prefixes having the specified expire time.
[-origin {router-advertise|renumber-request|static|kernel|unknown}] - Origin of the Prefix
Displays the IPv6 prefixes with the specified origin.
[-advertising-router <IP Address>, ...] - Router that Advertised the Prefix
Displays the IPv6 prefixes which are propagated by the specified router list.
566
Examples
The following example displays IPv6 prefixes on port e0f.
cluster1::*> network ndp prefix show -port e0f -node local
Node: node1
IPspace: Default
Port
Prefix
Flag
Expire Time
--------- ------------------------- ------------------ ------------e0f
fd20:8b1e:b255:814e::/64
on-link-autonomous 29d23h56m48s
567
network options cluster-health-notifications modify

cluster health notification options
level.
Description
(Description not available)
Parameters
[-enabled {true|false}] - Cluster Health Notifications Enabled
Examples
568
network options cluster-health-notifications show

Display cluster health notification options
level.
Description
Parameters
| [-instance ] }
[-enabled {true|false}] - Cluster Health Notifications Enabled
Examples
569
network options ipv6 modify

Modify IPv6 options
level.
Description
This command sets the state of IPv6 options for the cluster.
Parameters
[-enabled [true]] - IPv6 Enabled
Setting this parameter to true enables IPv6 for the cluster. IPv6 cannot be disabled once
it is enabled for the cluster. Call technical support for guidance regarding disabling IPv6.
[-is-ra-processing-enabled {true|false}] - Router Advertisement (RA) Processing
Enabled
Setting this parameter to true enables cluster to process IPv6 router advertisements.
Setting it to false disables router advertisement processing by the cluster.
Examples
The following example enables IPv6 for the cluster:
cluster1::> network options ipv6 modify -enabled true
The following example enables IPv6 Router Advertisement processing for the
cluster:
cluster1::> network options ipv6 modify -is-ra-processing-enabled true
The following example disables IPv6 Router Advertisement processing for the
cluster:
cluster1::> network options ipv6 modify -is-ra-processing-enabled false
570
network options ipv6 show

Display IPv6 options
level.
Description
This command displays the current state of IPv6 options for the cluster.
Parameters
None
Examples
cluster1::> network options ipv6 show
IPv6 Enabled: false
Router Advertisement (RA) Processing Enabled: false
network options load-balancing modify

Modify load balancing algorithm
privilege level.
Description
This command sets the state of geometric mean algorithm for load balancing
Parameters
[-enable {true|false}] - Geometric Mean Algorithm for load balancing
Setting this parameter to true enables the geometric mean algorithm for load balancing.
Setting it to false disables the geometric mean algorithm for the cluster.
571
Examples
The following example will enable the geometric mean algorithm for
load
balancing.
cluster1::> network options load-balancing modify -enable true
The following example will disable the geometric mean algorithm for
load
balancing.
cluster1::> network options load-balancing modify -enable false
572
network options load-balancing show

Display load balancing algorithm
privilege level.
Description
This command displays the use of geometric mean load balancing algorithm.
Parameters
None
Examples
cluster1::> network options load-balancing show
Geometric Mean Algorithm for load balancing: false
network options send-soa modify

Modify Send SOA settings
privilege level.
Description
This command sets the status of sending statement of authority record in the DNS
response.
Parameters
[-enable {true|false}] - Enable sending SOA
Setting this parameter to true enables sending the statement of authority (SOA) record
in the DNS response. Setting it to false disables sending the statement of authority
(SOA) record in the DNS response for the cluster.
573
Examples
The following example will enable the sending of statement of
authority (SOA)
in the DNS response.
cluster1::> network options send-soa modify -enable true
The following example will disable the sending of statement of
authority (SOA)
in the DNS response.
cluster1::> network options send-soa modify -enable false
574
network options send-soa show

Display Send SOA settings
privilege level.
Description
This command displays whether sending the statement of authority record (SOA) in the
DNS response is enabled or not.
Parameters
None
Examples
cluster1::> network options send-soa show
Enable sending SOA: true
network options switchless-cluster modify

Modify switchless cluster network options
privilege level.
Description
This command sets whether the cluster network is in switchless or switched mode. A
switchless cluster is physically formed by connecting two nodes back-to-back, without a
switch between them.
Parameters
[-enabled {true|false}] - Enable Switchless Cluster
575
This parameter specifies whether the switchless cluster is enabled or not. Setting this
parameter to true enables the switchless cluster.
Examples
The following example enables the switchless cluster:
cluster1::*> network options switchless-cluster modify -enabled true
network options switchless-cluster show

Display switchless cluster network options
privilege level.
Description
The network options switchless-cluster show command displays the attributes of a
switchless cluster.
Parameters
None
Examples
The following example displays the attributes of the switchless cluster:
cluster1::*> network options switchless-cluster show
Enable Switchless Cluster: true
576
network port delete

Delete a network port
privilege level.
Description
The network port delete command deletes a network port that is no longer
physically present on the storage system.
Parameters
This specifies the node on which the port is located.
This specifies the port to delete.
Examples
The following example deletes port e0c from a node named node0. The command
works only when the port does not physically exist on the storage system.
cluster1::> network port delete -node node0 -port e0c
network port modify

Modify network port attributes
level.
Description
The network port modify command enables you to change the maximum
transmission unit (MTU) setting, autonegotiation setting, administrative duplex mode,
and administrative speed of a specified network port.
577
The MTU of ports that belong to broadcast-domains must be updated through the
broadcast-domain modify command.
Modification of a port's IPspace will only work before a node is added to a cluster, when
the cluster version is below Data ONTAP 8.3, or when the node is offline. To change
the IPspace of a port once the node is in a Data ONTAP 8.3 cluster, the port should be
added to a broadcast-domain that belongs to that IPspace.
Parameters
Use this parameter to specify the node on which the port is located.
Use this parameter to specify the port that you want to modify.
[-mtu <integer>] - MTU
The port's MTU setting. The default setting when you create a port is 9000.
[-autonegotiate-admin {true|false}] - Auto-Negotiation Administrative
Whether the port uses Ethernet autonegotiation to determine the highest speed and
duplex mode that the port and its endpoint can support. The default setting when you
create a port is true.
[-duplex-admin {auto|half|full}] - Duplex Mode Administrative
The administrative setting for the port's duplex mode. This is the duplex mode that you
prefer the port to use. Depending on network limitations, the operational value can be
different from the administrative setting. The default setting when you create a port is
full.
[-speed-admin {auto|10|100|1000|10000}] - Speed Administrative
The administrative speed setting, in megabits per second. This is the speed setting that
you prefer the port to use. Depending on network limitations, the operational value can
be lower than the administrative setting.
[-flowcontrol-admin {none|receive|send|full}] - Flow Control Administrative
The administrative flow control setting of the port. this is the flow control setting that you
prefer the port to use. Depending on network and port limitations, the operational value
can be different from the administrative setting.
[-up-admin {true|false}] - Up Administrative (privilege: advanced)
578
The administrative state of the port. If set to true, the port is used if it is operational. If
set to false, the port is configured down.
[-ipspace <IPspace>] - IPspace Name
Use this parameter to specify the IPspace the network port is assigned to. Modification
of a port's IPspace will only work before a node is added to a cluster, when the cluster
version is below Data ONTAP 8.3, or when the node is offline. To change the IPspace
of a port once the node is in a Data ONTAP 8.3 cluster, the port should be added to a
broadcast-domain that belongs to that IPspace. If there is an inconsistency between
the broadcast-domain and IPspace, this parameter can be set to bring the IPspace into
alignment with the broadcast-domain.
[-mtu-admin <integer>] - MTU Administrative
The administrative setting for the MTU value of the port. This is the MTU value that you
prefer the port to use. Depending on network and port limitations, the operational value
can be different from the administrative setting.
Examples
The following example modifies port e0a on a node named node0 not to use autonegotiation, to preferably use half duplex mode, and to preferably run at 100 Mbps.
cluster1::> network port modify -node node0 -port e0a -autonegotiate-admin false
-duplex-admin half -speed-admin 100
See Also
broadcast-domain modify
579
network port show

Display network port attributes
Description
The network port show command displays information about network ports. The
command output indicates any inactive links, and lists the reason for the inactive status.
Some parameters can have "administrative" and "operational" values. The
administrative setting is the preferred value for that parameter, which is set when the
port is created or modified. The operational value is the actual current value of that
parameter. For example, if the network is underperforming due to network problems, the
operational speed value can be lower than the administrative setting.
If the operational duplex mode and speed of a port cannot be determined (for instance,
if the link is down), that port's status is listed as undef, meaning undefined.
Parameters
| [-instance ] }
Use this parameter to display all the fields for the specified network ports.
Selects the network ports that match this parameter value. Use this parameter with the
-port parameter to select a port.
Selects the network ports that match this parameter value. If you do not use this
parameter, the command displays information about all network ports.
[-link {off|up|down}] - Link
Selects the network ports that match this parameter value.
[-mtu <integer>] - MTU
580

[-autonegotiate-admin {true|false}] - Auto-Negotiation Administrative
[-autonegotiate-oper {true|false}] - Auto-Negotiation Operational
[-duplex-admin {auto|half|full}] - Duplex Mode Administrative
[-duplex-oper {auto|half|full}] - Duplex Mode Operational
[-speed-admin {auto|10|100|1000|10000}] - Speed Administrative
[-speed-oper {auto|10|100|1000|10000}] - Speed Operational
[-flowcontrol-admin {none|receive|send|full}] - Flow Control Administrative
[-flowcontrol-oper {none|receive|send|full}] - Flow Control Operational
[-up-admin {true|false}] - Up Administrative (privilege: advanced)
[-type {physical|if-group|vlan}] - Port Type
[-ifgrp-node <nodename>] - Interface Group Parent Node
[-ifgrp-port {<netport>|<ifgrp>}] - Interface Group Parent Port
[-ifgrp-distr-func {mac|ip|sequential|port}] - Distribution Function
581

[-ifgrp-mode {multimode|multimode_lacp|singlemode}] - Create Policy
[-vlan-node <nodename>] - Parent VLAN Node
[-vlan-port {<netport>|<ifgrp>}] - Parent VLAN Port
[-vlan-tag <integer>] - VLAN Tag
[-remote-device-id <text>] - Remote Device ID
Use this parameter to display information only about the ports that match the IPspace
you specify.
Use this parameter to display information only about the ports that match the broadcastdomain you specify.
[-mtu-admin <integer>] - MTU Administrative
Examples
The following example displays information about all network ports.
cluster1::> network port show
Speed (Mbps)
Node
Port
IPspace
Broadcast Domain
------ ------ -------- ----------------
Link
MTU
Admin/Oper
----- ------- ------------
node0
e0a
cluster
clus
up
9000
1000/1000
e0b
cluster
clus
up
9000
1000/1000
e0c
default
data1
up
1500
1000/1000
e0d
default
data1
up
1500
1000/1000
e0M
default
mgmt
up
1500
1000/1000
node1
582
e0a
cluster
clus
up
9000
10/1000
e0b
cluster
clus
up
9000
10/1000
e0c
default
data2
up
1500
10/1000
e0d
default
data1
up
1500
10/1000
e0M
default
mgmt
up
1500
1000/1000
e0a
cluster
clus
up
9000
auto/1000
e0b
cluster
clus
up
9000
auto/1000
e0c
default
data2
up
1500
auto/1000
e0d
default
data1
up
1500
auto/1000
e0M
default
mgmt
up
1500
auto/1000
e0a
cluster
clus
up
9000
auto/1000
e0b
cluster
clus
up
9000
auto/1000
e0c
default
data2
up
1500
auto/1000
e0d
default
data2
up
1500
auto/1000
e0M
default
mgmt
up
1500
auto/1000
node2
node3
583
network port broadcast-domain add-ports

Add ports to a layer 2 broadcast domain
level.
Description
Add ports to a broadcast domain.
Note:
The IPSpace of the ports added will be updated to the IPSpace of the broadcastdomain. The ports will be added to the failover-group of the broadcast-domain. The
MTU of the ports will be updated to the MTU of the broadcast-domain.
Parameters
The IPspace of the broadcast domain.
-broadcast-domain <broadcast domain name> - Layer 2 Broadcast Domain
The broadcast domain for this port assignment.
-ports <<node>:<port>>, ... - List of ports
The ports to be added to this broadcast domain.
Examples
The following example adds the port "e0d" on node "cluster1-1" and port "e0d" on node
"cluster1-2" to broadcast domain "mgmt" in IPspace "Default".
cluster1::network port broadcast-domain> add-ports -ipspace Default -broadcastdomain mgmt -ports cluster1-1:e0d, cluster1-2:e0d
network port broadcast-domain create

Create a new layer 2 broadcast domain
584

level.
Description
Create a new broadcast domain.
Note:
The IPSpace of the ports added will be updated to the IPSpace of the broadcastdomain. A failover-group will be generated containing the ports of the broadcastdomain. The MTU of all of the ports in the broadcast-domain will be updated to the MTU
specified for the broadcast-domain.
Parameters
The IPspace to which the new broadcast domain belongs.
The name of the broadcast domain to be created. The name of the broadcast domain
needs to be unique within the IPspace.
-mtu <integer> - Configured MTU
MTU of the broadcast domain.
The network ports to be added to the broadcast domain. Ports need to be added to the
broadcast domain before interfaces can be hosted on the port. By default, no port will be
added to the broadcast domain.
Examples
The following example creates broadcast domain "mgmt" in IPspace "Default" with an
MTU of 1500 and network ports e0c from node "gx1" and node "gx2".
cluster1::> network port broadcast-domain create -ipspace Default -broadcastdomain mgmt -mtu 1500 -ports gx1:e0c,gx2:e0c
network port broadcast-domain delete
585
Delete a layer 2 broadcast domain

level.
Description
Delete a broadcast domain that contains no ports.
Parameters
The IPspace to which the broadcast domain belongs
The name of the broadcast domain to be deleted.
Examples
The following example deletes the broadcast domain "mgmt" in IPspace "Default".
cluster1::network port broadcast-domain> delete -ipspace Default -broadcastdomain mgmt
network port broadcast-domain merge

Merges two layer 2 broadcast domains
level.
Description
Merges a broadcast domain into an existing broadcast domain.
Parameters
The merging broadcast domain.
586
-into-broadcast-domain <broadcast domain name> - Merge with This Layer 2

Broadcast Domain
The target broadcast domain for the merge operation.
Examples
The following example merges broadcast domain "bd-mgmt" in IPspace "Default" to
broadcast domain "bd-data".
cluster1::network port broadcast-domain> merge -ipspace Default -broadcast-domain
bd-mgmt -into-broadcast-domain bd-data
network port broadcast-domain modify

Modify a layer 2 broadcast domain
level.
Description
Modify a broadcast domain.
Parameters
The IPspace to which the broadcast domain belongs.
The name of the broadcast domain.
[-mtu <integer>] - Configured MTU
MTU of the broadcast domain.
Examples
The following example modifies the mtu attribute of broadcast domain "mgmt" in
IPspace "Default" to 1500
cluster1::network port broadcast-domain*> modify -ipspace Default -broadcastdomain mgmt -mtu 1500
587
network port broadcast-domain remove-ports

Remove ports from a layer 2 broadcast domain
level.
Description
Remove port assignments from a broadcast domain.
Parameters
The broadcast domain of the ports.
-ports <<node>:<port>>, ... - List of ports
The ports to removed from the broadcast-domain.
Examples
The following example removes port "e0d" on node "cluster1-1" and port "e0d" on node
"cluster1-2" from broadcast domain "mgmt" in IPspace "Default".
cluster1::network port broadcast-domain> remove-ports -ipspace Default broadcast-domain mgmt -ports cluster1-1:e0d, cluster1-2:e0d
network port broadcast-domain rename

Rename a layer 2 broadcast domain
level.
Description
Rename a broadcast domain.
588
Parameters
The IPspace to which the broadcast domain belongs.
The name of the broadcast domain.
-new-name <text> - New Name
The new name of the broadcast domain.
Examples
The following example renames the broadcast domain named "mgmt" to "mgmt2" in
IPspace "Default".
cluster1::network port broadcast-domain> rename -ipspace Default -broadcastdomain mgmt -new-name mgmt2
network port broadcast-domain show

Display layer 2 broadcast domain information
level.
Description
Display broadcast domain information.
Parameters
specify.
| [-instance ] }
about all fields.
589

Selects the broadcast domains that match the IPspace name.
[-broadcast-domain <broadcast domain name>] - Layer 2 Broadcast Domain
Selects the broadcast domains that match the broadcast domain name.
[-mtu <integer>] - Configured MTU
Selects the broadcast domains that match the MTU value. This field is the MTU that was
configured by the user, which might be different from the operational MTU.
Selects the broadcast domains that contain the network ports. For example, node1:e0a
will display broadcast domains that contain node1:e0a network port.
[-port-update-status {complete|in-progress|error|overridden-while-offline}, ...] - Port
Update Status
Selects the broadcast domains that contain the network port status. For example,
specifying "error" will display broadcast domains that contain "Error" network port status.
[-port-update-status-details <text>, ...] - Status Detail Description
Selects the broadcast domains that contain the network port status detail text.
[-port-update-status-combined {complete|in-progress|error|overridden-while-offline}] Combined Port Update Status
Selects the broadcast domains that contain the combined network port status. For
example, specifying "error" will display broadcast domains that contain a combined
network port status of "Error".
[-failover-groups <failover-group>, ...] - Failover Groups
Selects the broadcast domains that contain the failover groups.
[-subnet-names <subnet name>, ...] - Subnet Names
Selects the broadcast domains that contain the subnet name or names.
Examples
The following example displays general information about broadcast domains.
cluster1::> network port broadcast-domain show
IPspace Broadcast
Name
Domain Name
Update
MTU
------- ----------- ------
590
Port List
Status Details
----------------------------- --------------
Cluster Cluster
Default Default
9000
node1:e0a
complete
node1:e0b
complete
node1:e0c
complete
node1:e0d
complete
1500
591
network port broadcast-domain split

Splits a layer 2 broadcast domain into two layer 2 broadcast domains.
level.
Description
Splits ports from a broadcast domain into a new broadcast domain.
The following restrictions apply to this command:
If the ports are in a failover group, all ports in the failover group must be provided.
Use network interface failover-groups show to see which ports are in
failover groups.
If the ports have LIFs associated with them, the LIFs cannot be part of a subnet's
ranges and the LIF's curr-port and home-port must both be provided. Use
network interface show -fields subnet-name, home-node, home-port,
curr-node, curr-port to see which ports have LIFs associated with them and
whether the LIFs are part of a subnet's ranges. Use network subnet removeranges with the LIF's IP address and -force-update-lif-associations
set to true to remove the LIF's association with a subnet.
Parameters
The broadcast domain to split.
-new-broadcast-domain <broadcast domain name> - New Layer 2 Broadcast Domain
Name
The new broadcast domain.
-ports <<node>:<port>>, ... - List of Ports
The ports to be split from this broadcast domain.
Examples
592
The following example splits port "e0d" on node "cluster1-1" and port "e0d" on node
"cluster1-2" from broadcast domain "bd-mgmt" in IPspace "Default" to broadcast domain
"bd-data".
cluster1::> network port broadcast-domain split -ipspace Default -broadcastdomain bd-mgmt -new-broadcast-domain bd-data -ports cluster1-1:e0d,
cluster1-2:e0d
See Also
network interface failover-groups show network interface show
network subnet remove-ranges
593
network port ifgrp add-port

Add a port to an interface group
level.
Description
The network port ifgrp add-port command adds a network port to a port
interface group. The port interface group must already exist. You can create a port
interface group by using the network port ifgrp create command.
The following restrictions apply to port interface groups:
A port that is already a member of a port interface group cannot be added to
another port interface group.
All ports in a port interface group must have the same port role (data).
Cluster ports and management ports cannot be in a port interface group.
A port to which a logical interface is already bound cannot be added to a port
interface group.
A port that already has an assigned failover role cannot be added to a port
interface group.
All ports in a port interface group must be physically located on the same node.
Parameters
The node on which the port interface group is located.
-ifgrp {<netport>|<ifgrp>} - Interface Group Name
The port interface group to which a port is to be added.
-port <netport> - Specifies the name of port.
The network port that is to be added to the port interface group.
Examples
The following example adds port e0c to port interface group a1a on a node named
node1:
594
cluster1::> network port ifgrp add-port -node node1 -ifgrp a1a -port e0c
See Also
network port ifgrp create
595
network port ifgrp create

Create a port interface group
level.
Description
The network port ifgrp create command creates a port interface group. See
the documentation for the network port ifgrp add-port command for a list of
restrictions on creating port interface groups.
Parameters
The node on which the port interface group will be created.
The name of the port interface group that will be created. Port interface groups must
be named using the syntax "a<number><letter>", where <number> is an integer in the
range [0-999] without leading zeros and <letter> is a lowercase letter. For example,
"a0a", "a0b", "a1c", and "a2a" are all valid port interface group names.
-distr-func {mac|ip|sequential|port} - Distribution Function
The distribution function of the port interface group that will be created. Valid values are:
mac - Network traffic is distributed based on MAC addresses
ip - Network traffic is distributed based on IP addresses
sequential - Network traffic is distributed as it is received
port - Network traffic is distributed evenly across all member ports of the interface
group
-mode {multimode|multimode_lacp|singlemode} - Create Policy
The create policy for the interface group that will be created. Valid values are:
multimode - Bundle multiple member ports of the interface group to act as a single
trunked port
596
multimode_lacp - Bundle multiple member ports of the interface group using Link
Aggregation Control Protocol
singlemode - Provide port redundancy using member ports of the interface group
for failover
Examples
The following example creates a port interface group named a0a on node node0 with a
distribution function of ip:
cluster1::> network port ifgrp create -node node0 -ifgrp a0a -distr-func ip -mode
multimode
See Also
network port ifgrp add-port
597
network port ifgrp delete

Destroy a port interface group
level.
Description
The network port ifgrp delete command destroys a port interface group. Before
deleting a port interface group, remove all ports from it with the network port ifgrp
remove-port command.
Note:
When you delete an interface group port, it is automatically removed from failover rules
and groups to which it belongs.
Parameters
The port interface group that will be deleted.
Examples
The following example deletes port interface group a0b from a node named node0.
cluster1::> network port ifgrp delete -node node0 -ifgrp a0b
See Also
network port ifgrp remove-port
598
network port ifgrp remove-port

Remove a port from an interface group
level.
Description
The network port ifgrp remove-port command removes a network port from a
port interface group.
Parameters
The port interface group from which a port will be removed.
-port <netport> - Specifies the name of port.
The network port that will be removed from the port interface group.
Examples
The following example removes port e0d from port interface group a1a on a node
named node1:
cluster1::> network port ifgrp remove-port -node node1 -ifgrp a1a -port e0d
network port ifgrp show

Display port interface groups
level.
Description
599
The network port ifgrp show command displays information about port interface
groups. By default, it displays information about all port interface groups on all nodes in
the cluster.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the port interface groups that match this parameter value. Use this parameter
with the -ifgrp parameter to select information about a specific port interface group.
[-ifgrp {<netport>|<ifgrp>}] - Interface Group Name
Selects the port interface groups that match this parameter value. Use this parameter
with the -node parameter, to select information about a specific port interface group.
[-distr-func {mac|ip|sequential|port}] - Distribution Function
Selects the port interface groups that match this parameter value.
[-mode {multimode|multimode_lacp|singlemode}] - Create Policy
[-activeports {full|partial|none}] - Port Participation
Selects the port interface groups that match this parameter value. The value "partial"
indicates that some but not all of the port interface group's ports are active. the value
"full" indicates that all of the port interface group's ports are active.
[-ports {<netport>|<ifgrp>}, ...] - Network Ports
[-up-ports {<netport>|<ifgrp>}, ...] - Up Ports
600
Selects the port interface groups that match this parameter value. Displays only the
ports that are up.
[-down-ports {<netport>|<ifgrp>}, ...] - Down Ports
Selects the port interface groups that match this parameter value. Displays only the
ports that are down.
Examples
The following example displays information about all port interface groups.
cluster1::> network port ifgrp show
Port
Distribution
Active
Node
ifgrp
Function
------
-------
------------ -------------- ------- ---------------
a0a
ip
b8:f8:7a:20:00 partial e0c
a1a
ip
07:26:60:02:00 full
MAC Address
Ports
Ports
node0
node1
e0d
601
network port vlan create

Create a virtual LAN (VLAN)
level.
Description
The network port vlan create command attaches a VLAN to a network port on a
specified node.
Parameters
The node to which the VLAN is to be attached.
Note:
You cannot attach a VLAN to a cluster port.
{ -vlan-name {<netport>|<ifgrp>} - VLAN Name
The name of the VLAN that is to be attached. This name should be a combination of the
name of the port or interface group and the VLAN ID, with a hyphen between, such as
"e1c-80".
| -port {<netport>|<ifgrp>} - Associated Network Port
The network port to which the VLAN is to be attached.
-vlan-id <integer> } - Network Switch VLAN Identifier
The ID tag of the created VLAN.
Examples
This example shows how to create VLAN e1c-80 attached to network port e1c on
node1.
cluster1::> network port vlan create -node node1 -vlan-name e1c-80
602
network port vlan delete

Delete a virtual LAN (VLAN)
level.
Description
The network port vlan delete command deletes a VLAN from a network port.
Note:
When you delete a VLAN port, it is automatically removed from all failover rules and
groups that use it.
Parameters
The node from which the VLAN is to be deleted.
{ -vlan-name {<netport>|<ifgrp>} - VLAN Name
The name of the VLAN that is to be deleted
| -port {<netport>|<ifgrp>} - Associated Network Port
The network port to which the VLAN is to be attached.
-vlan-id <integer> } - Network Switch VLAN Identifier
The ID tag of the deleted VLAN.
Examples
This example shows how to delete VLAN e1c-80 from network port e1c on node1.
cluster1::> network port vlan delete -node node1 -vlan-name e1c-80
network port vlan show

Display virtual LANs (VLANs)
603

level.
Description
The network port vlan show command displays information about network ports
that are attached to VLANs. The command output indicates any inactive links and lists
the reason for the inactive status.
If the operational duplex mode and speed cannot be determined (for instance, if the link
is down), they are listed as undef, meaning undefined.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the VLAN network ports that match this parameter value.
{ [-vlan-name {<netport>|<ifgrp>}] - VLAN Name
| [-port {<netport>|<ifgrp>}] - Associated Network Port
Selects the VLAN network ports that match this parameter value. If neither this
parameter nor -name are used, the command displays information about all network
ports.
[-vlan-id <integer>] } - Network Switch VLAN Identifier
[-mac <MAC Address>] - MAC address
Examples
The example below shows VLAN e1b-70 attached to port e1b on node1.
604
cluster1::> network port vlan show

Network Network
Node
VLAN Name Port
VLAN ID
MAC Address
------ --------- ------- -------
------------------
node1
00:15:17:76:7b:69
e1b-70
e1b
70
605
network route create

Create a static route
Description
The network route create command creates a static route within a Vserver.
Parameters
Use this parameter to specify the Vserver on which the route is to be created.
-destination <IP Address/Mask> - Destination/Mask
Use this parameter to specify the IP address and subnet mask of the route's destination.
The format for this value is: address, slash ("/"), mask. The example below has
0.0.0.0/0 as a valid value for the -destination parameter.
-gateway <IP Address> - Gateway
Use this parameter to specify the IP address of the gateway server leading to the route's
destination.
[-metric <integer>] - Metric
Use this parameter to specify the metric of the route.
Examples
The following example creates a route within Vserver vs0 for destination 0.0.0.0/0.
cluster1::> network route create -vserver vs0 -destination 0.0.0.0/0 -gateway
10.61.208.1
network route delete

Delete a static route
606

Description
The network route delete command deletes a static route from a Vserver.
Parameters
Use this parameter to specify the Vserver on which the route is to be deleted.
-destination <IP Address/Mask> - Destination/Mask
Use this parameter to specify the IP address and subnet mask of the route's destination.
The format for this value is: address, slash ("/"), mask. For example, 0.0.0.0/0 is a
correctly formatted value for the -destination parameter.
-gateway <IP Address> - Gateway
Use this parameter to specify the gateway on which the route is to be deleted.
Examples
The following example deletes a route within Vserver vs0 for destination 0.0.0.0/0.
cluster1::network route delete -vserver vs0 -destination 0.0.0.0/0
network route show-lifs

Show the Logical Interfaces for each route entry
Description
The network route show-lifs command displays the association of static
routes and Logical Interfaces (LIFs) within one or more Vservers. You can view routes
within specified Vservers, routes with specified destinations, and routes with specified
gateways.
Parameters
607

specify.
| [-instance ] }
about all fields.
Use this parameter to display only routes that have the specified Vserver as their origin.
[-destination <IP Address/Mask>] - Destination/Mask
Use this parameter to display only routes that have the specified IP address and subnet
mask as their destination. The format for this value is: address, slash ("/"), mask. For
example, 0.0.0.0/0 is a valid value for the -destination parameter.
[-gateway <IP Address>] - Gateway
Use this parameter to display only routes that have the specified IP address as their
gateway.
[-lifs <lif-name>, ...] - Logical Interfaces
Use this parameter to display only the routes that are associated with the specified
Logical Interfaces (LIFs).
[-address-family {ipv4|ipv6|ipv6z}] - Address Family
Use this parameter to display only the routes that belong to specified address family.
Examples
608
network route show

Display static routes
Description
The network route show command displays a group of static routes within one or
more Vservers. You can view routes within specified Vservers, routes with specified
destinations, and routes with specified gateways.
Parameters
Use this parameter to display only certain fields of the routing tables.
| [-instance ] }
Use this parameter to display all fields of the routing tables.
Use this parameter to display only routes that have the specified Vserver as their origin.
[-destination <IP Address/Mask>] - Destination/Mask
Use this parameter to display only routes that have the specified IP address and subnet
mask as their destination. The format for this value is: address, slash ("/"), mask. The
example below has 0.0.0.0/0 as a valid value for the -destination parameter.
Use this parameter to display only routes that have the specified IP address as their
gateway.
Use this parameter to display only routes that have the specified metric.
Use this parameter to optionally specify the IPspace associated with the Vserver. This
parameter can be used in conjunction with the Vserver parameter in order to configure
the same route across multiple Vservers within an IPspace.
609
[-address-family {ipv4|ipv6|ipv6z}] - Address family of the route

Use this parameter to display only the routes that have the specified address-family.
Examples
The following example displays information about all routing groups.
cluster1::> network route show
(network route show)
Server
Destination
Gateway
Metric
------------------- --------------- --------------- -----node1

0.0.0.0/0
10.61.208.1
20
0.0.0.0/0
10.61.208.1
20
0.0.0.0/0
10.61.208.1
20
node2
vs0
610
network route active-entry show

Display active routes
Description
The network route active-entry show command displays installed routes
on one or more nodes. You can view routes within specified nodes, within specified
Vservers, routes in specified subnet groups, and routes with specified destinations.
Parameters
specify.
| [-verbose ]
Use this parameter to display the reference count, use, interface, and Path MTU fields.
| [-instance ] }
about all fields.
Displays the routes that have the specified Vserver as their origin.
Displays the routes from the specified node.
[-address-type {ipv4|ipv6|ipv6z}] - Address Family
Displays the routes that have the specified IP address type.
[-subnet-group <IP Address/Mask>] - Subnet Group
Displays the group of routes that belong to the specified subnet. Routes within the
specified subnet group are used first before the default set. The "default" subnet group
is a system-provided set of default routes.
611
[-destination <text>] - Destination

Displays the routes that have the specified IP address or subnet as their destination.
The format for the subnet is: <address>/<mask>. IPv6 address includes the
scope value after percentage ("%"). 0.0.0.0/0, 169.254.4.60, ff02::%e0a/32 and
fe80::250:56ff:fea6:db7c%e0b are valid values for this parameter.
[-interface <text>] - Interface Name
Displays the routes that use the specified interface to transmit packets to the
destination. A valid interface has the format of {<netport>|<ifgrp>}, such as "e0a",
"e0a-1" and "a0a", or it can be a loopback interface, such as "lo" and "losk".
[-gateway <text>] - Gateway
Displays the routes that have the specified gateway. The gateway can be an IP address,
such as "10.10.2.1" and "fe80::1%lo", MAC address, such as "0:5:73:a0:1:7" or refer to
a local link, such as "link#3".
Displays the routes that have the specified metric.
[-flags <text>] - Flags
Displays the routes that have the specified flags. The type string for "-flags" needs to be
one or more of the following {U|G|H|R|D|S|1|2|L|C} in the order shown.
U - Usable
G - Gateway
H - Host
R - Reject
D - Dynamic
S - Static
1 - Protocol1
2 - Protocol2
L - Llinfo
C - Clone
Multiple values can be specified (for example: UHL).
[-reference-count <integer>] - Reference Count
Displays the routes that have the specified reference count in the system.
612
[-lookup-count <integer>] - Lookup Count

Displays the routes that have the specified use count (the count of lookups for the
route).
[-path-mtu <integer>] - Path MTU
Displays the routes that have the specified path maximum transmission unit.
Examples
The following example displays active routes on all nodes in Vserver vs0 with subnetgroup 10.10.10.0/24.
cluster1::*> network route active-entry show -vserver vs0 -subnet-group
10.10.10.0/24
(network route active-entry show)
Vserver: vs0
Node: node1
Subnet Group: 10.10.10.0/24
Destination
Gateway
Interface
Metric
Flags
----------------------
-------------------
---------
------
-----
default
10.10.10.1
e0c
UGS
Vserver: vs0
Node: node2
Subnet Group: 10.10.10.0/24
Destination
Gateway
Interface
Metric
Flags
----------------------
-------------------
---------
------
-----
default
10.10.10.1
e0c
UGS
See Also
network route show
613
network subnet add-ranges

Add new address ranges to a subnet
level.
Description
Add new address ranges to a subnet.
Note:
All addresses in a range must be the same address family (IPv4 or IPv6) and must
have the same subnet mask. Ranges that overlap or are next to existing ranges will be
merged with the existing ranges.
Parameters
The IPspace in which the range resides.
-subnet-name <subnet name> - Subnet Name
The name of the subnet.
-ip-ranges {<ipaddr>|<ipaddr>-<ipaddr>}, ... - IP Ranges
The list of ranges to add to the subnet.
[-force-update-lif-associations [true]] - Force Update LIF Associations
This command will fail if any service processor interfaces or network interfaces are
using the IP addresses in the ranges provided. Using this parameter will associate any
manually addressed interfaces with the subnet and will allow the command to succeed.
Examples
The following example allocates addresses for subnet s1 in IPspace Default.
cluster1::> network subnet add-ranges -ipspace Default -subnet-name s1
-ip-ranges "10.98.1.20-10.98.1.30, 10.98.1.35, 10.98.1.40-10.98.1.49"
614
network subnet create

Create a new layer 3 subnet
level.
Description
Create a new subnet.
Parameters
The IPspace to which the new subnet belongs.
The name of the subnet to be created. The name of the subnet needs to be unique
within the IPspace.
-broadcast-domain <broadcast domain name> - Broadcast Domain
The broadcast domain to which the new subnet belongs.
-subnet <IP Address/Mask> - Layer 3 Subnet
The address and mask of the subnet.
The gateway of the subnet.
[-ip-ranges {<ipaddr>|<ipaddr>-<ipaddr>}, ...] - IP Addresses or IP Address Ranges
The IP ranges associated with this subnet.
[-force-update-lif-associations [true]] - Change the subnet association
This command will fail if any service processor interfaces or network interfaces are
using the IP addresses in the ranges provided. Using this parameter will associate any
manually addressed interfaces with the subnet and will allow the command to succeed.
Examples
The following examples create subnets named s1 and s6 in IPspace Default.
615
cluster1::> network subnet create -ipspace Default -broadcast-domain bd1 -subnetname s1

-subnet 192.168.1.0/24 -gateway 192.168.1.1 -ip-ranges
"192.168.1.1-192.168.1.100, 192.168.1.112, 192.168.1.145"
cluster1::> network subnet create -ipspace Default -broadcast-domain bd1 -subnetname s6
-subnet 3FFE::/64 -gateway 3FFE::1 -ip-ranges "3FFE::10-3FFE::20"
616
network subnet delete

Delete an existing subnet object
level.
Description
Delete a subnet that contains no ports.
Parameters
The IPspace to which the subnet belongs.
The name of the subnet to be deleted.
This command will fail if the subnet has ranges containing any existing service
processor interface or network interface IP addresses. Setting this value to true will
remove the network interface associations with the subnet and allow the command to
succeed. However, it will not affect service processor interfaces.
Examples
The following example deletes subnet s1 in IPspace Default.
cluster1::> network subnet delete -ipspace Default -subnet-name s1
network subnet modify

Modify a layer 3 subnet
level.
Description
617
Modify a subnet.
Parameters
The name of the subnet to modify.
[-subnet <IP Address/Mask>] - Layer 3 Subnet
The new address and mask of the subnet.
The new gateway address.
The new IP ranges for this subnet.
This command will fail if any existing service processor interfaces or network interfaces
are using IP addresses in the IP ranges being added. It will also fail if any existing
service processor interfaces or network interfaces are using IP addresses in the IP
ranges being removed. Using this parameter will associate the interfaces with the IP
addresses in the ranges being added to the subnet. It will also remove the subnet's
association with the interfaces with IP addresses in the IP ranges being removed and
will allow the command to succeed.
Examples
The following example modifies the subnet address and gateway.
cluster1::> network subnet modify -ipspace Default -subnet-name s1 -subnet
192.168.2.0/24 -gateway 192.168.2.1
network subnet remove-ranges

Remove address ranges from a subnet
level.
618
Description
Remove address ranges from a subnet.
Parameters
The IPspace in which the range resides.
The name of the subnet.
-ip-ranges {<ipaddr>|<ipaddr>-<ipaddr>}, ... - IP Ranges
IP ranges to remove.
[-force-update-lif-associations [true]] - Force Update LIF Associations
This command will fail if any existing service processor interfaces or network interfaces
are using IP addresses in the ranges provided. Using this parameter will remove the
subnet's association with those interfaces and allow the command to succeed.
Examples
The following example removes an address range with starting address of 10.98.1.1
from subnet s1 in IPspace Default.
cluster1::> network subnet remove-ranges -ipspace Default -subnet-name s1
-ip-ranges "10.98.1.1-10.98.1.30"
network subnet rename

Rename a layer 3 subnet
level.
Description
Rename a Subnet.
Parameters
619

The name of the subnet to rename.
The new name for the subnet.
Examples
The following example renames subnet s1 to s3.
cluster1::> network subnet rename -ipspace Default -subnet s1 -new-name s3
network subnet show

Display subnet information
level.
Description
Display subnet information.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the subnets that match the given IPspace name.
[-subnet-name <subnet name>] - Subnet Name
620
Selects the subnets that match the given subnet name.

Selects the subnets that match the given broadcast domain name.
[-subnet <IP Address/Mask>] - Layer 3 Subnet
Selects the subnets that match the given address and mask.
Selects the subnets that match the given gateway address.
Selects the subnets that match the given IP range.
[-total-count <integer>] - Total Address Count
Selects the subnets that match the given total address count.
[-used-count <integer>] - Used Address Count
Selects the subnets that match the given number of addresses allocated.
[-available-count <integer>] - Available Address Count
Selects the subnets that match the given number of addresses available.
Examples
The following example displays general information about the subnets.
cluster1::> network subnet show
IPspace: Default
Subnet
Broadcast
Name
Subnet
Domain
Avail/
Gateway
Total
Ranges
--------- ---------------- --------- --------------- ----------------------s4

192.168.4.0/24
192.168.5.6-192.168.5.10
bd4
192.168.4.1
5/5
s6
192.168.6.0/24
192.168.6.6-192.168.6.10
bd4
192.168.6.1
5/5
IPspace: ips1
Subnet
Broadcast
Name
Subnet
Domain
Avail/
Gateway
Total
Ranges
--------- ---------------- --------- --------------- -----------------------
621
s10
192.168.6.0/24
bd10
192.168.6.1
0/0
622
qos policy-group create

Create a policy group
level.
Description
The qos policy-group create command creates a new policy group. You can use
a QoS policy group to control a set of storage objects known as "workloads" - LUNs,
volumes, files, or Vservers. Policy groups define measurable service level objectives
(SLOs) that apply to the storage objects with which the policy group is associated.
After you create a policy group, you use the storage object create command or the
storage object modify command to apply the policy group to a storage object.
Parameters
-policy-group <text> - Policy Group Name
Specifies the name of the policy group. Policy group names must be unique and are
restricted to 127 alphanumeric characters including underscores "_" and hyphens
"-". Policy group names must start with an alphanumeric character. You use the qos
policy-group rename command to change the policy group name.
Specifies the data Vserver to which this policy group belongs. You can apply this policy
group to only the storage objects contained in the specified Vserver. For example, if you
want to apply this policy group to a volume, that volume must belong to the specified
Vserver. Using this parameter does not apply the policy group's SLOs to the Vserver.
You need to use the vserver modify command if you want to apply this policy group to
the Vserver. If the system has only one Vserver, then the command uses that Vserver
by default. QoS policy groups cannot belong to Vservers with Infinite Volume.
[-max-throughput <qos_tput>] - Maximum Throughput
Specifies the maximum throughput for the policy group. A maximum throughput limit
specifies the throughput that the policy group must not exceed. It is specified in terms of
IOPS or MB/s, and the range is zero to infinity.
The values entered here are case-insensitive, and the units are base ten. There should
be no space between the number and the units. The default value for max-throughput is
623
infinity, which can be specified by the special value "INF". Note there is no default unit all numbers except zero require explicit specification of the units.
Two reserved keywords, "none" and "INF", are available for the situation that requires
removal of a value, and the situation that needs to specify the maximum available value.
Examples of valid throughput specifications are: "100B/s", "10KB/s", "1gb/s", "500MB/s",
"1tb/s", and "100iops".
Examples
cluster1::> qos policy-group create p1 -vserver vs1
Creates the "p1" policy group which belongs to Vserver "vs1" with default policy values.
cluster1::> qos policy-group create p2 -vserver vs1 -max-throughput 500MB/s
Creates the "p2" policy group which belongs to Vserver "vs1" with the maximum
throughput set to 500 MB/s.
See Also
qos policy-group rename
624
qos policy-group delete

Delete an existing QoS Policy Group
level.
Description
The qos policy-group delete command deletes a policy group from a cluster.
You cannot delete a policy group if a qos workload associated with storage object is
assigned to it unless you use "-force". Using "-force" will delete all the qos workloads for
storage objects associated with the specified policy groups.
You can only delete user-defined policy groups. You cannot delete preset policy groups.
Parameters
Specifies the name of the policy group that you want to delete.
[-force [true]] - Force Delete Workloads for the QoS Policy Group (privilege: advanced)
Specifies whether to delete a policy group along with any underlying workloads.
Examples
cluster1::> qos policy-group delete p1
Deletes the "p1" policy group.

cluster1::> qos policy-group delete p1 -force
Deletes the "p1" policy group along with any underlying qos workloads.
625
qos policy-group modify

Modify a policy group
level.
Description
The qos policy-group modify command modifies a user-created policy group.
Parameters
Specifies the name of the policy group that you want to modify.
Specifies the maximum throughput for the policy group. A maximum throughput limit
specifies the throughput that the policy group must not exceed. It is specified in terms of
IOPS or MB/s, and the range is zero to infinity.
The values entered here are case-insensitive, and the units are base ten. There should
be no space between the number and the units. The default value for max-throughput is
infinity, which can be specified by the special value "INF". Note there is no default unit all numbers except zero require explicit specification of the units.
Two reserved keywords, "none" and "INF", are available for the situation that requires
removal of a value, and the situation that needs to specify the maximum available value.
Examples of valid throughput specifications are: "100B/s", "10KB/s", "1gb/s", "500MB/s",
"1tb/s", and "100iops".
Examples
cluster1::> qos policy-group modify p1 -max-throughput 10IOPS
Modifies the "p1" policy group and sets its max throughput value to 10 IOPS.
626
qos policy-group rename

Rename a policy group
level.
Description
The qos policy-group rename command changes the name of an existing policy
group.
Parameters
Specifies the existing name of the policy group that you want to rename.
-new-name <text> - New Policy Group Name
Specifies the new name of the policy group. Policy group names must be unique and
are restricted to 127 alphanumeric characters including underscores "_" and hyphens
"-". Policy group names must start with an alphanumeric character.
Examples
cluster1::> qos policy-group rename -policy-group p1 -new-name p1_new
Renames the policy group from "p1" to "p1_new".
627
qos policy-group show

Display a list of policy groups
level.
Description
The qos policy-group show command shows the current settings of the policy
groups on a cluster. You can display a list of the policy groups and you can view detailed
information about a specific policy group.
Parameters
specify.
| [-instance ] }
about all fields.
[-policy-group <text>] - Policy Group Name
Selects the policy groups that match this parameter value
Policy groups define measurable service level objectives (SLOs) that apply to the
storage objects with which the policy group is associated.
[-uuid <UUID>] - Uuid
[-class {preset|user-defined|system-defined|autovolume}] - Policy Group Class
[-pgid <integer>] - Policy Group ID
628
This uniquely identifies the policy group

A maximum throughput limit specifies the throughput (in IOPS or MB/s) that the policy
group must not exceed.
[-num-workloads <integer>] - Number of Workloads
Selects the policy groups that match this parameter value.
[-throughput-policy <text>] - Throughput Policy
Selects the policy groups that match this parameter value. You can specify the
throughput range in terms of IOPS or data rate. For example, 0-INF, 0-400IOPS,
0-200KB/s, 0-400MB/s.
Examples
cluster1::> qos policy-group show
Name
Vserver
Class
Wklds Throughput
---------------- ----------- ------------ ----- -----------pg1
vs4
user-defined 0
0-200IOPS
pg2
vs0
user-defined 0
0-500IOPS
pg5
vs0
user-defined 0
0-300IOPS
pg6
vs0
user-defined 0
0-INF
The example above displays all policy groups on the cluster.
629
qos statistics characteristics show

Display QoS policy group characterization
level.
Description
The qos statistics characteristics show command displays data that
characterizes the behavior of QoS policy groups.
The command displays the following data:
The QoS policy group name (Policy Group)
Input/output operations performed per second (IOPS)
Throughput achieved in kilobytes per second (KB/s) or megabytes per second
(MB/s) as appropriate (Throughput)
Request size in bytes (B) (Request size)
Read percentage from total I/O (Read)
Concurrency, which indicates the number of concurrent users generating the I/O
traffic (Concurrency)
The results displayed per iteration are sorted by IOPS. Each iteration starts with a row
that displays the total IOPS used across all QoS policy groups. Other columns in this
row are either totals or averages.
Parameters
Selects the policy groups that match this parameter value. If you do not specify this
parameter, the command displays data for the entire cluster.
[-iterations <integer>] - Number of Iterations
Specifies the number of times the display is refreshed before terminating. If you do not
specify this parameter, the command iterates until interrupted by Ctrl-C.
{ [-rows <integer>] - Number of Rows in the Output
630
Specifies the number of busiest QoS policy groups to display. Valid values are from 1 to
20. The default value is 10.
| [-policy-group <text>] } - QoS Policy Group Name
Selects the QoS policy group whose name matches the specified value. If you do not
specify this parameter, the command displays data for all QoS policy groups.
[-refresh-display {true|false}] - Toggle Screen Refresh Between Each Iteration
Specifies the display style. If true, the command clears the display after each data
iteration. If false, the command displays each data iteration below the previous one. The
default is false.
Examples
cluster1::> qos statistics characteristics show -iterations 100 -rows 4
Policy Group
IOPS
Throughput Request size
Read Concurrency
-------------------- -------- --------------- ------------
---- -----------
-total-
31
304.00KB/s
10041B
0%
_System-Best-Effort
15
0KB/s
0B
0%
16
0
vol1
11
44.00KB/s
4096B
0%
40
vol2
256.00KB/s
65536B
0%
14
vs1vol0
4.00KB/s
4096B
0%
-total-
37
808.00KB/s
22361B
2%
_System-Best-Effort
15
0KB/s
0B
0%
vol2
12
768.00KB/s
65536B
0%
vs1vol0
32.00KB/s
4096B
12%
vol1
8.00KB/s
4096B
0%
The example above displays the characteristics of the 4 QoS policy groups with the
highest IOPS values and refreshes the display 100 times before terminating.
cluster1::> qos statistics characteristics show -iterations 100 -policy-group pg1
Policy Group
IOPS
Throughput Request size Read Concurrency
-------------------- -------- --------------- ------------ ---- -----------total-
293
3.02MB/s
54%
pg1
118
470.67KB/s
4096B 100%
-total-
181
478.14KB/s
2700B
65%
pg1
117
469.33KB/s
4096B 100%
-total-
226
525.78KB/s
2382B
60%
pg1
110
440.00KB/s
4096B 100%
-total-
233
1.67MB/s
7527B
10783B
49%
631
pg1
112
446.67KB/s
4096B 100%
The example above displays the system characteristics of the QoS policy group pg1 and
refreshes the display 100 times before terminating.
632
qos statistics latency show

Display latency breakdown data per QoS policy group
level.
Description
The qos statistics latency show command displays the average latencies for
QoS policy groups across the various Data ONTAP subsystems.
Total latency observed per I/O operation (Latency)
Latency observed per I/O operation in the Network subsystem (Network)
Latency observed per I/O operation across the internally connected nodes in a
Cluster (Cluster)
Latency observed per I/O operation in the Data management subsystem (Data)
Latency observed per I/O operation in the Storage subsystem (Disk)
Latency observed per I/O operation in the QoS subsystem (QoS)
Latency observed per I/O operation for NVRAM transfer (NVRAM)
The results displayed per iteration are sorted by the Latency field. Each iteration starts
with a row that displays the average latency, in microseconds (us) or milliseconds (ms),
observed across all QoS policy groups.
Parameters
633
default is false.
Examples
cluster1::> qos statistics latency show -iterations 100 -rows 3
Policy Group
QoS
NVRAM
Latency
Network
Cluster
Data
Disk
-------------------- ---------- ---------- ---------- ---------- ------------------- -----------
634
-total0ms
0ms
vs1vol0
0ms
0ms
vol1
0ms
0ms
vol2
0ms
0ms
-total0ms
0ms
vol2
0ms
0ms
vol1
0ms
0ms
vs1vol0
0ms
0ms
-total0ms
0ms
vol1
0ms
0ms
vol2
0ms
0ms
vs1vol0
0ms
0ms
-total0ms
0ms
vol2
0ms
0ms
110.35ms
110.02ms
0ms
327.00us
0ms
167.82ms
167.22ms
0ms
603.00us
0ms
117.76ms
117.56ms
0ms
191.00us
0ms
44.24ms
44.05ms
0ms
190.00us
0ms
38.89ms
38.63ms
0ms
256.00us
0ms
64.47ms
64.20ms
0ms
266.00us
0ms
27.28ms
27.03ms
0ms
253.00us
0ms
23.72ms
23.47ms
0ms
249.00us
0ms
409.81ms
409.65ms
0ms
169.00us
0ms
816.92ms
816.80ms
0ms
120.00us
0ms
407.88ms
407.66ms
0ms
219.00us
0ms
3.68ms
3.49ms
0ms
193.00us
0ms
1169.00us
107.00us
0ms
1062.00us
0ms
1169.00us
107.00us
0ms
1062.00us
0ms
The example above displays latencies for the 3 QoS policy groups with the highest
latencies and refreshes the display 100 times before terminating.
cluster1::> qos statistics latency show -iterations 100 -policy-group pg1
Policy Group
QoS
NVRAM
Latency
Network
Cluster
Data
Disk
-------------------- ---------- ---------- ---------- ---------- ------------------- ----------total0ms
0ms
pg1
0ms
0ms
-total0ms
0ms
pg1
0ms
0ms
-total0ms
0ms
pg1
0ms
0ms
-total0ms
0ms
pg1
0ms
0ms
5.88ms
308.00us
0ms
434.00us
5.14ms
5.88ms
308.00us
0ms
434.00us
5.14ms
4.17ms
280.00us
0ms
477.00us
3.42ms
4.17ms
280.00us
0ms
477.00us
3.42ms
4.43ms
274.00us
0ms
656.00us
3.50ms
4.43ms
274.00us
0ms
656.00us
3.50ms
4.89ms
276.00us
0ms
699.00us
3.92ms
4.89ms
276.00us
0ms
699.00us
3.92ms
The example above displays latencies for the QoS policy group pg1 and refreshes the
display 100 times before terminating.
635
qos statistics performance show

Display system performance data per QoS policy group
level.
Description
The qos statistics performance show command shows the current system
performance levels that QoS policy groups are achieving.
Throughput in kilobytes per second (KB/s) or megabytes per second (MB/s) as
appropriate (Throughput)
Latency observed per request in microseconds (us) or milliseconds (ms) as
appropriate (Latency)
that displays the total IOPS used across all QoS policy groups. Other columns in this
row are either totals or averages.
Parameters
636
default is false.
Examples
cluster1::> qos statistics performance show -iterations 100 -rows 4
Policy Group
IOPS
Throughput
Latency
-------------------- -------- --------------- ----------total-
79
1296.00KB/s
_System-Best-Effort
25
0KB/s
337.41ms
0ms
vol1
24
96.00KB/s
193.72ms
vol2
18
1152.00KB/s
750.98ms
vs1vol0
12
48.00KB/s
707.38ms
-total-
109
1.99MB/s
133.27ms
_System-Best-Effort
35
0KB/s
0ms
vol2
29
1.81MB/s
249.27ms
vs1vol0
24
96.00KB/s
48.32ms
vol1
21
84.00KB/s
292.30ms
The example above displays the system performance for the 4 QoS policy groups with
the highest IOPS and it refreshes the display 100 times before terminating.
cluster1::> qos statistics performance show -iterations 100 -policy-group pg1
Policy Group
IOPS
Throughput
Latency
-------------------- -------- --------------- ----------total-
2833
10.66MB/s
924.00us
pg1
2655
10.37MB/s
917.00us
-total-
2837
10.65MB/s
923.00us
pg1
2655
10.37MB/s
917.00us
-total-
2799
10.73MB/s
802.00us
pg1
2737
10.69MB/s
815.00us
-total-
2930
13.33MB/s
905.00us
pg1
2720
10.62MB/s
858.00us
The example above displays the system performance for the QoS policy group pg1 and
637
qos statistics resource cpu show

Display CPU resource utilization data per QoS policy group
level.
Description
The qos statistics resource cpu show command displays the CPU utilization
for QoS policy groups per node.
CPU utilization observed in percentage (CPU)
The results displayed per iteration are sorted by total CPU utilization. Each iteration
starts with a row that displays the total CPU utilization across all QoS policy groups.
Parameters
default is false.
638
Examples
cluster1::> qos statistics resource cpu show -node nodeA -iterations 100
-rows 3
Policy Group
CPU
-------------------- -----total- (100%)
9%
fast
1%
slow
3%
medium
5%
-total- (100%)
8%
slow
1%
fast
3%
medium
3%
The example above displays the total CPU utilization for the 3 QoS policy groups with
the highest CPU utilization and it refreshes the display 100 times before terminating.
cluster1::> qos statistics resource cpu show -node local -iterations 100
-policy-group pg1
Policy Group
CPU
-------------------- -----total- (100%)
7%
pg1
1%
-total- (100%)
7%
pg1
1%
-total- (100%)
7%
pg1
1%
-total- (100%)
pg1
10%
1%
The example above displays the total CPU utilization for the QoS policy group pg1 and
639
qos statistics resource disk show

Display disk resource utilization data per QoS policy group
level.
Description
The qos statistics resource disk show command displays the disk utilization
for QoS policy groups per node. The disk utilization shows the percentage of time spent
on the disk during read and write operations. The command displays disk utilization for
system-defined policy groups; however, their disk utilization is not included in the total
utilization. The command only supports hard disks.
Disk utilization (Disk)
The number of HDD data disks utilized (Number of HDD Disks)
The results displayed are sorted by total disk utilization. Each iteration starts with a row
that displays the total disk utilization across all QoS policy groups.
Parameters
640

default is false.
Examples
cluster1::> qos statistics resource disk show -node nodeA -iterations 100
-rows 3
Policy Group
Disk Number of HDD Disks
-------------------- ----- -------------------total-
40%
pg1
22%
slow
10%
10
fast
8%
12
_System_Default
27
7%
20
-total-
42%
27
pg1
22%
slow
12%
10
fast
8%
12
_System_Default
7%
20
The example above displays the total disk utilization for the 3 QoS policy groups with
the highest disk utilization and it refreshes the display 100 times before terminating.
cluster1::> qos statistics resource disk show -node local -iterations 100
-policy-group pg1
Policy Group
-------------------- ----- -------------------total-
3%
10
pg1
1%
24
-total-
3%
10
pg1
1%
24
-total-
3%
10
pg1
1%
24
-total-
3%
10
pg1
1%
24
The example above displays the total disk utilization for the QoS policy group pg1 and
641
qos statistics volume characteristics show

Display volume characteristics
level.
Description
The qos statistics volume characteristics show command displays data
that characterizes the behavior of volumes.
QoS volume name (Workload)
QoS workload ID (ID)
Input/output operations per second (IOPS)
Read percentage from total IOPS (Read)
that displays the total IOPS used across all volumes. Other columns in this row are
either totals or averages.
Parameters
Selects the volumes that match this parameter value. If you do not specify this
Specifies the number of busiest QoS policy groups to display. The default setting is 10.
The allowed range of values is 1 to 20.
| -vserver <vserver name> - Vserver Name
642
Specifies the Vserver to which the volume belongs.

-volume <volume name> } - Volume Name
Selects the characteristic data that match this parameter value. Enter a complete
volume name or press the <Tab> key to complete the name. Wildcard query characters
are not supported.
default is false.
Examples
cluster1::> qos statistics volume characteristics show -iterations 100 -rows
3
Workload
ID
IOPS
--------------- ------ -------- ---------------- ------------ ---- -----------total-
68
176.00KB/s
2650B
7%
vs1vol0-wid102
102
24
96.00KB/s
4096B
20%
13
vol_1-wid103
103
20
80.00KB/s
4096B
0%
12
vol_2-wid104
104
0KB/s
0B
0%
157
528.00KB/s
3443B
3%
vol_2-wid104
104
48
192.00KB/s
4096B
0%
vol_1-wid103
103
43
172.00KB/s
4096B
0%
vs1vol0-wid102
102
41
164.00KB/s
4096B
14%
274
1016.00KB/s
3797B
2%
vs1vol0-wid102
102
85
340.00KB/s
4096B
8%
vol_2-wid104
104
85
340.00KB/s
4096B
0%
vol_1-wid103
103
84
336.00KB/s
4096B
0%
-total-
-total-
The example above displays characteristics for the 3 volumes with the highest IOPS
and it refreshes the display 100 times before terminating.
cluster1::> qos statistics volume characteristics show -vserver vs0 -volume
vs0_vol0 -iterations 100
Workload
ID
IOPS
Throughput Request Size Read Concurrency
--------------- ------ -------- ---------------- ------------ ---- -----------
643
-totalvs0_vol0-wid1..
1567
783.33KB/s
512Kb
90%
15658
785
392.33KB/s
512Kb
89%
1521
760.50KB/s
512Kb
90%
15658
982
491.17KB/s
512Kb
90%
1482
741.00KB/s
512Kb
89%
15658
945
472.50KB/s
512Kb
90%
1482
741.00KB/s
512Kb
89%
15658
945
472.50KB/s
512Kb
90%
1702
850.83KB/s
512Kb
90%
15658
1018
509.00KB/s
512Kb
90%
The example above displays characteristics for volume vs0_vol0 in Vserver vs0 and it
644
qos statistics volume latency show

Display latency breakdown data per volume
level.
Description
The qos statistics volume latency show command displays the average
latencies for volumes on Data ONTAP subsystems.
The QoS volume name (Workload)
The QoS workload ID (ID)
Cluster (Cluster)
The results displayed per iteration are sorted by the total latency field. Each iteration
starts with a row that displays the average latency, in microseconds (us) or milliseconds
(ms) observed across all volumes.
Parameters
645

Selects the latency data that match this parameter value. Enter a complete volume
name or press the <Tab> key to complete the name. Wildcard query characters are not
supported.
Specifies the number of times that the command refreshes the display with updated
data before terminating. If you do not specify this parameter, the command iterates until
interrupted by Ctrl-C.
default is false.
Examples
cluster1::> qos statistics volume latency show -iterations 100 -rows 3
Workload
NVRAM
ID
Latency
Network
Cluster
Data
Disk
QoS
--------------- ------ -----------------
-------- --------
-------- -------- --------
-total-
110.35ms
110.02ms
0ms
327.00us
0ms
0ms
111 167.82ms
167.22ms
0ms
603.00us
0ms
0ms
1234 117.76ms
117.56ms
0ms
191.00us
0ms
0ms
0ms
vs1vol0
0ms
vol1
0ms
vol2
999
44.24ms
44.05ms
0ms
190.00us
0ms
0ms
38.89ms
38.63ms
0ms
256.00us
0ms
0ms
999
64.47ms
64.20ms
0ms
266.00us
0ms
0ms
1234
27.28ms
27.03ms
0ms
253.00us
0ms
0ms
111
23.72ms
23.47ms
0ms
249.00us
0ms
0ms
- 409.81ms
409.65ms
0ms
169.00us
0ms
0ms
1234 816.92ms
816.80ms
0ms
120.00us
0ms
0ms
999 407.88ms
407.66ms
0ms
219.00us
0ms
0ms
0ms
-total0ms
vol2
0ms
vol1
0ms
vs1vol0
0ms
-total0ms
vol1
0ms
vol2
0ms
646
vs1vol0
111
3.68ms
3.49ms
0ms
193.00us
0ms
0ms
0ms
The example above displays latencies for the 3 volumes with the highest latencies and it
cluster1::> qos statistics volume latency show -vserver vs0 -volume vs0_vol0
-iterations 100
Workload
QoS
ID
Latency
Network
Cluster
Data
Disk
NVRAM
--------------- ------ ---------- ---------- ---------- ---------- ------------------- ----------total0ms
455.00us
158.00us
0ms
297.00us
0ms
vs0_vol0-wid1.. 15658
0ms
0ms
428.00us
155.00us
0ms
273.00us
0ms
-total0ms
337.00us
130.00us
0ms
207.00us
0ms
vs0_vol0-wid1.. 15658
0ms
0ms
316.00us
128.00us
0ms
188.00us
0ms
-total0ms
464.00us
132.00us
0ms
332.00us
0ms
vs0_vol0-wid1.. 15658
0ms
0ms
471.00us
130.00us
0ms
341.00us
0ms
-total0ms
321.00us
138.00us
0ms
183.00us
0ms
vs0_vol0-wid1.. 15658
0ms
0ms
302.00us
137.00us
0ms
165.00us
0ms
-total0ms
418.00us
142.00us
0ms
276.00us
0ms
vs0_vol0-wid1.. 15658
0ms
0ms
424.00us
143.00us
0ms
281.00us
0ms
0ms
0ms
0ms
0ms
0ms
The example above displays latencies for volume vs0_vol0 in Vserver vs0 and it
647
qos statistics volume performance show

Display system performance data per volume
level.
Description
The qos statistics volume performance show command shows the current
system performance that each volume is achieving.
that displays the total IOPS used across all volumes. Other columns in this row are
either totals or averages.
Parameters
648
Selects the performance data that match this parameter value. Enter a complete volume
name or press the <Tab> key to complete the name. Wildcard query characters are not
supported.
default is false.
Examples
cluster1::> qos statistics volume performance show -iterations 100 -rows 3
Workload
ID
IOPS
Throughput
Latency
--------------- ------ -------- ---------------- ----------total-
97
1.90MB/s
216.87ms
vol_2-wid104
104
28
1.75MB/s
412.78ms
vol_1-wid103
103
25
100.00KB/s
169.16ms
vs1vol0-wid102
102
13
52.00KB/s
403.78ms
89.98ms
-total-
98
1276.00KB/s
vs1vol0-wid102
102
28
112.00KB/s
80.70ms
vol_1-wid103
103
19
76.00KB/s
114.72ms
vol_2-wid104
104
17
1088.00KB/s
257.60ms
78
1152.00KB/s
225.22ms
vol_1-wid103
103
17
68.00KB/s
452.27ms
vol_2-wid104
104
16
1024.00KB/s
419.93ms
vs1vol0-wid102
102
15
60.00KB/s
210.63ms
-total-
The example above displays the system performance for the 3 volumes with the highest
IOPS and it refreshes the display 100 times before terminating.
cluster1::> qos statistics volume performance show -vserver vs0 -volume
vs0_vol0 -iterations 100
Workload
ID
IOPS
Throughput
Latency
--------------- ------ -------- ---------------- ----------totalvs0_vol0-wid1..

-total-
1278
639.17KB/s
404.00us
15658
526
263.17KB/s
436.00us
1315
657.33KB/s
86.00us
649
vs0_vol0-wid1..
15658
528
264.17KB/s
88.00us
1220
609.83KB/s
418.00us
15658
515
257.33KB/s
531.00us
1202
600.83KB/s
815.00us
15658
519
259.67KB/s
924.00us
1240
620.17KB/s
311.00us
15658
525
262.50KB/s
297.00us
The example above displays the system performance for volume vs0_vol0 in Vserver
vs0 and it refreshes the display 100 times before terminating.
650
qos statistics volume resource cpu show

Display CPU resource utilization data per volume
level.
Description
The qos statistics volume resource cpu show command displays the CPU
utilization for volumes per node.
starts with a row that displays the total CPU utilization across all volumes.
Parameters
Selects the volumes that match this parameter value.
Selects the CPU utilization data that match this parameter value. Enter a complete
are not supported.
651

default is false.
Examples
cluster1::> qos statistics volume resource cpu show -node nodeA -iterations
100 -rows 3
Workload
ID
CPU
--------------- ----- ------total- (100%)
9%
vs0vol1-wid-102
102
5%
vs0vol2-wid-121
121
2%
vs2_vol0-wid-..
212
2%
-total- (100%)
8%
vs0vol1-wid-102
102
5%
vs0vol2-wid-121
121
2%
vs2_vol0-wid-..
212
1%
The example above displays total CPU utilization for the 3 volumes with the highest
CPU utilization and it refreshes the display 100 times before terminating.
cluster1::> qos statistics volume resource cpu show -node local -vserver vs0
-volume vs0_vol1 -iterations 100
Workload
ID
CPU
--------------- ----- -----total- (100%)

vs0_vol1-wid7..
-total- (100%)
vs0_vol1-wid7..
-total- (100%)
vs0_vol1-wid7..
-total- (100%)
vs0_vol1-wid7..
-total- (100%)
vs0_vol1-wid7..
2%
7916
2%
2%
7916
2%
1%
7916
1%
2%
7916
1%
2%
7916
2%
The example above displays total CPU utilization for volume vs0_vol1 in Vserver vs0
and it refreshes the display 100 times before terminating.
652
qos statistics volume resource disk show

Display disk resource utilization data per volume
level.
Description
The qos statistics volume resource disk show command displays the disk
utilization for volumes per node. The disk utilization shows the percentage of time spent
on the disk during read and write operations. The command only supports hard disks.
that displays the total disk utilization across all volumes.
Parameters
Selects the volumes that match this parameter value.
Selects the disk utilization data that match this parameter value. Enter a complete
are not supported.
653
default is false.
Examples
cluster1::> qos statistics volume resource disk show -node nodeB iterations 100 -rows 3
Workload
ID
--------------- ------ ----- -------------------total- (100%)
30%
vs0vol1-wid101
101
12%
vs0vol2-wid121
121
10%
1002
8%
-total- (100%)
30%
vs0vol1-wid101
101
12%
121
10%
1002
8%
vol0-wid1002
vs0vol2-wid121
vol0-wid1002
The example above displays total disk utilization for the 3 volumes with the highest disk
utilization and it refreshes the display 100 times before terminating.
cluster1::> qos statistics volume resource disk show -node local vserver vs0 -volume vs0_vol0 -iterations 100
Workload
ID
--------------- ------ ------ -------------------totalvs0_vol0-wid1..

654
5%
15658
1%
10
6
5%
10
15658
1%
6%
10
15658
2%
6%
10
15658
2%
6%
10
15658
2%
The example above displays total disk utilization for volume vs0_vol0 in Vserver vs0 and
it refreshes the display 100 times before terminating.
655
qos statistics workload characteristics show

Display QoS workload characterization
level.
Description
The qos statistics workload characteristics show command displays
data that characterizes the behavior of QoS workloads.
The QoS workload name (Workload)
Read percentage from total IOPS (Read)
that displays the total IOPS used across all QoS workloads. Other columns in this row
are either totals or averages.
Parameters
Selects the QOS workloads that match this parameter value. If you do not specify this
656
default is false.
[-policy-group <text>] - QoS Policy Group Name
Selects the QoS workloads that belong to the QoS policy group specified by this
parameter value. If you do not specify this parameter, the command displays data for all
QoS workloads.
| [-workload <text>] - QoS Workload Name
Selects the QoS workload that match this parameter value. If you do not specify this
parameter, the command displays data for all QoS workloads.
| [-workload-id <integer>] } - QoS Workload ID
Selects the QoS workload that match the QoS workload ID specified by this parameter
value.
Examples
cluster1::> qos statistics workload characteristics show -iterations 100 rows 4
Workload
ID
IOPS
--------------- ------ -------- ---------------- ------------ ---- -----------total-
68
176.00KB/s
2650B
7%
vs1vol0-wid102
102
24
96.00KB/s
4096B
20%
13
_Scan_Besteff..
101
23
0KB/s
0B
0%
vol_1-wid103
103
20
80.00KB/s
4096B
0%
12
vol_2-wid104
104
0KB/s
0B
0%
157
528.00KB/s
3443B
3%
vol_2-wid104
104
48
192.00KB/s
4096B
0%
vol_1-wid103
103
43
172.00KB/s
4096B
0%
vs1vol0-wid102
102
41
164.00KB/s
4096B
14%
_Scan_Besteff..
101
25
0KB/s
0B
0%
274
1016.00KB/s
3797B
2%
vs1vol0-wid102
102
85
340.00KB/s
4096B
8%
vol_2-wid104
104
85
340.00KB/s
4096B
0%
vol_1-wid103
103
84
336.00KB/s
4096B
0%
_Scan_Besteff..
101
20
0KB/s
0B
0%
-total-
-total-
657
The example above displays characteristics for the 4 QoS workloads with the highest
IOPS and it refreshes the display 100 times before terminating.
cluster1::> qos statistics workload characteristics
rows 2 -policy-group pg1
Workload
Concurrency
ID
IOPS
show -iterations 100 -
Throughput Request size Read
--------------- ------ -------- ---------------- ------------ --------------total-
243
546.86KB/s
2307B
61%
file-test1_a-..
6437
34
136.00KB/s
4096B 100%
file-test1_c-..
5078
33
133.33KB/s
4096B 100%
310
3.09MB/s
file-test1_a-..
6437
36
142.67KB/s
4096B 100%
file-test1_b-..
9492
35
138.67KB/s
4096B 100%
192
575.71KB/s
3075B
file-test1-wi..
7872
39
157.33KB/s
4096B 100%
file-test1_c-..
5078
38
153.33KB/s
4096B 100%
1
0
0
-total-
10428B
55%
1
0
0
-total-
71%
1
0
0
The example above displays the characteristics for the 2 QoS workloads belonging
to QoS policy group pg1 with the highest IOPS and it refreshes the display 100 times
before terminating.
cluster1::> qos statistics workload characteristics show -iterations 100 workload-id 9492
Workload
Concurrency
ID
IOPS
Throughput Request size Read
--------------- ------ -------- ---------------- ------------ --------------total-
737
2.14MB/s
9492
265
1058.67KB/s
717
4.26MB/s
9492
272
1086.67KB/s
623
2.50MB/s
9492
263
1050.67KB/s
3045B
79%
1
file-test1_b-..
4096B 100%
0
-total-
6235B
80%
1
file-test1_b-..
4096B 100%
1
-total-
4202B
86%
0
file-test1_b-..
4096B 100%
658
-total-
595
2.11MB/s
9492
266
1064.00KB/s
3712B
89%
0
file-test1_b-..
4096B 100%
The example above displays the characteristics for the QoS workload with QoS
workload ID 9492 and it refreshes the display 100 times before terminating.
659
qos statistics workload latency show

Display latency breakdown data per QoS workload
level.
Description
The qos statistics workload latency show command displays the average
latencies for QoS workloads on Data ONTAP subsystems.
Cluster (Cluster)
The results displayed per iteration are sorted by the total latency field. Each iteration
starts with a row that displays the average latency, in microseconds (us) or milliseconds
(ms) observed across all QoS workloads.
Parameters
660
Specifies the number of times that the command refreshes the display with updated
data before terminating. If you do not specify this parameter, the command continues to
run until you interrupt it by pressing Ctrl-C.
default is false.
QoS workloads.
value.
Examples
cluster1::> qos statistics workload latency show -iterations 100 -rows 3
Workload
NVRAM
ID
Latency
Network
Cluster
Data
Disk
QoS
--------------- ------ -----------------
-------- --------
-------- -------- --------
-total-
110.35ms
110.02ms
0ms
327.00us
0ms
0ms
111 167.82ms
167.22ms
0ms
603.00us
0ms
0ms
1234 117.76ms
117.56ms
0ms
191.00us
0ms
0ms
0ms
vs1vol0
0ms
vol1
0ms
vol2
999
44.24ms
44.05ms
0ms
190.00us
0ms
0ms
38.89ms
38.63ms
0ms
256.00us
0ms
0ms
999
64.47ms
64.20ms
0ms
266.00us
0ms
0ms
0ms
-total0ms
vol2
0ms
661
vol1
1234
27.28ms
27.03ms
0ms
253.00us
0ms
0ms
111
23.72ms
23.47ms
0ms
249.00us
0ms
0ms
- 409.81ms
409.65ms
0ms
169.00us
0ms
0ms
1234 816.92ms
816.80ms
0ms
120.00us
0ms
0ms
999 407.88ms
407.66ms
0ms
219.00us
0ms
0ms
3.49ms
0ms
193.00us
0ms
0ms
0ms
vs1vol0
0ms
-total0ms
vol1
0ms
vol2
0ms
vs1vol0
111
3.68ms
0ms
The example above displays latencies for the 3 QoS workloads with the highest
latencies and it refreshes the display 100 times before terminating.
cluster1::> qos statistics workload latency show -iterations 100 -rows 2 -policygroup pg1
Workload
QoS
ID
Latency
Network
Cluster
Data
Disk
NVRAM
--------------- ------ ---------- ---------- ---------- ---------- ------------------- ----------total0ms
4.80ms
287.00us
0ms
427.00us
4.08ms
file-test1-wi..
7872
0ms
0ms
9.60ms
265.00us
0ms
479.00us
8.85ms
file-test1_a-..
6437
0ms
0ms
8.22ms
262.00us
0ms
424.00us
7.53ms
-total0ms
4.20ms
296.00us
0ms
421.00us
3.48ms
file-test1-wi..
7872
0ms
0ms
8.70ms
211.00us
0ms
489.00us
8.00ms
file-test1_a-..
6437
0ms
0ms
6.70ms
297.00us
0ms
464.00us
5.94ms
-total0ms
5.90ms
303.00us
0ms
1.71ms
3.88ms
file-test1-wi..
7872
0ms
0ms
11.36ms
263.00us
0ms
2.06ms
9.04ms
file-test1_a-..
6437
0ms
0ms
9.48ms
250.00us
0ms
2.30ms
6.93ms
0ms
0ms
0ms
The example above displays latencies for the 2 QoS workloads belonging to QoS
policy group pg1 with the highest IOPS and it refreshes the display 100 times before
terminating.
cluster1::> qos statistics workload latency show -iterations 100 -workload-id
9492
Workload
QoS
ID
Latency
Network
Cluster
Data
Disk
NVRAM
--------------- ------ ---------- ---------- ---------- ---------- ------------------- ----------
662
-total0ms
443.00us
273.00us
0ms
170.00us
0ms
file-test1_b-..
9492
0ms
0ms
440.00us
272.00us
0ms
168.00us
0ms
-total0ms
577.00us
313.00us
0ms
264.00us
0ms
file-test1_b-..
9492
0ms
0ms
607.00us
316.00us
0ms
291.00us
0ms
-total0ms
475.00us
291.00us
0ms
184.00us
0ms
file-test1_b-..
9492
0ms
0ms
476.00us
293.00us
0ms
183.00us
0ms
-total0ms
628.00us
284.00us
0ms
344.00us
0ms
file-test1_b-..
9492
0ms
0ms
591.00us
281.00us
0ms
310.00us
0ms
0ms
0ms
0ms
0ms
The example above displays the latencies for the QoS workload with QoS workload ID
9492 and it refreshes the display 100 times before terminating.
663
qos statistics workload performance show

Display system performance data per QoS workload
level.
Description
The qos statistics workload performance show command shows the current
system performance that each QoS workload is achieving.
that displays the total IOPS used across all QoS workloads. Other columns in this row
are either totals or averages.
Parameters
default is false.
664

QoS workloads.
value.
Examples
cluster1::> qos statistics workload performance show -iterations 100 -rows 4
Workload
ID
IOPS
Throughput
Latency
--------------- ------ -------- ---------------- ----------total-
97
1.90MB/s
216.87ms
_Scan_Besteff..
101
31
0KB/s
0ms
vol_2-wid104
104
28
1.75MB/s
412.78ms
vol_1-wid103
103
25
100.00KB/s
169.16ms
vs1vol0-wid102
102
13
52.00KB/s
403.78ms
98
1276.00KB/s
89.98ms
_Scan_Besteff..
101
34
0KB/s
0ms
vs1vol0-wid102
102
28
112.00KB/s
80.70ms
vol_1-wid103
103
19
76.00KB/s
114.72ms
vol_2-wid104
104
17
1088.00KB/s
257.60ms
78
1152.00KB/s
225.22ms
_Scan_Besteff..
101
30
0KB/s
0ms
vol_1-wid103
103
17
68.00KB/s
452.27ms
vol_2-wid104
104
16
1024.00KB/s
419.93ms
vs1vol0-wid102
102
15
60.00KB/s
210.63ms
-total-
-total-
The example above displays the system performance for the 4 QoS workloads with the
highest IOPS and it refreshes the display 100 times before terminating.
665
cluster1::> qos statistics workload performance show -iterations 100 -rows 2 policy-group pg1
Workload
ID
IOPS
Throughput
Latency
--------------- ------ -------- ---------------- ----------total-
2598
9.96MB/s
1223.00us
file-testfile..
4228
650
2.54MB/s
1322.00us
file-testfile..
11201
635
2.48MB/s
1128.00us
2825
10.89MB/s
714.00us
file-testfile..
4228
707
2.76MB/s
759.00us
file-testfile..
11201
697
2.72MB/s
693.00us
2696
10.13MB/s
1149.00us
file-testfile..
4228
645
2.52MB/s
945.00us
file-testfile..
6827
634
2.48MB/s
1115.00us
-total-
-total-
The example above displays the system performance for the 2 QoS workloads
belonging to QoS policy group pg1 with the highest IOPS and it refreshes the display
100 times before terminating.
cluster1::> qos statistics workload performance show -iterations 100 -workload-id
11201
Workload
ID
IOPS
Throughput
Latency
--------------- ------ -------- ---------------- ----------totalfile-testfile..

-totalfile-testfile..
2866
10.92MB/s
11201
674
2.63MB/s
905.00us
889.00us
2761
10.55MB/s
1054.00us
11201
638
2.49MB/s
1055.00us
2810
10.58MB/s
832.00us
11201
685
2.68MB/s
909.00us
2593
9.86MB/s
1092.00us
11201
632
2.47MB/s
964.00us
The example above displays the system performance for the QoS workload with QoS
666
qos statistics workload resource cpu show

Display CPU resource utilization data per QoS workload
level.
Description
The qos statistics workload resource cpu show command displays the
CPU utilization for QoS workloads per node.
starts with a row that displays the total CPU utilization across all QoS workloads.
Parameters
Selects the QOS workloads that match this parameter value.
default is false.
667
QoS workloads.
value.
Examples
cluster1::> qos statistics workload resource cpu show -node nodeA -iterations
100 -rows 3
Workload
ID
CPU
--------------- ----- ------total- (100%)
9%
vs0-wid-102
102
5%
file-bigvmdk-..
121
2%
vs2_vol0-wid-..
212
2%
8%
vs0-wid-101
102
5%
file-bigvmdk-..
121
2%
vs2_vol0-wid-..
212
1%
-total- (100%)
The example above displays total CPU utilization for the 3 QoS workloads with the
highest CPU utilization and it refreshes the display 100 times before terminating.
cluster1::> qos statistics workload resource cpu show -node local -iterations
100 -rows 2 -policy-group pg1
Workload
ID
CPU
--------------- ----- -----total- (100%)
41%
file-test1_b-..
9492
16%
file-test1_c-..
5078
16%
43%
file-test1_c-..
5078
17%
file-test1_b-..
9492
16%
40%
5078
16%
-total- (100%)
-total- (100%)
file-test1_c-..
668
file-test1_b-..
9492
15%
The example above displays total CPU utilization for the 2 QoS workloads belonging
before terminating.
cluster1::> qos statistics workload resource cpu show -node local -iterations
100 -workload-id 9492
Workload
ID
CPU
--------------- ----- -----total- (100%)

file-test1_b-..
-total- (100%)
file-test1_b-..
-total- (100%)
file-test1_b-..
-total- (100%)
file-test1_b-..
15%
9492
3%
14%
9492
3%
14%
9492
2%
13%
9492
3%
The example above displays total CPU utilization for the QoS workload with QoS
669
qos statistics workload resource disk show

Display disk resource utilization data per QoS workload
level.
Description
The qos statistics workload resource disk show command displays the
disk utilization for QoS workloads per node. The disk utilization shows the percentage
of time spent on the disk during read and write operations. The command displays disk
utilization for system-defined workloads; however, their disk utilization is not included in
the total utilization. The command only supports hard disks.
that displays the total disk utilization across all QoS workloads.
Parameters
Selects the QOS workloads that match this parameter value.
default is false.
670
QoS workloads.
value.
Examples
cluster1::> qos statistics workload resource disk show -node nodeB iterations 100 -rows 3
Workload
ID
--------------- ------ ----- -------------------total- (100%)

_RAID
30%
20%
vs0-wid101
101
12%
file-1-wid121
121
10%
1002
8%
7%
vol0-wid1002
_WAFL
-total- (100%)
30%
vs0-wid101
101
12%
file-1-wid121
121
10%
10%
1002
8%
7%
_RAID
vol0-wid1002
_WAFL
The example above displays total disk utilization for the 3 QoS workloads with the
highest disk utilization and it refreshes the display 100 times before terminating.
cluster1::> qos statistics workload resource disk show -node local -iterations
100 -rows 2 -policy-group pg1
Workload
ID
--------------- ------ ----- -------------------
671
-total-
3%
10
file-test1_a-..
6437
6%
file-test1-wi..
7872
6%
-total-
3%
10
file-test1_a-..
6437
5%
file-test1-wi..
7872
5%
3%
10
file-test1_a-..
6437
6%
file-test1-wi..
7872
6%
-total-
The example above displays total disk utilization for the 2 QoS workloads belonging
before terminating.
cluster1::> qos statistics workload resource disk show -node local -iterations
100 -workload-id 6437
Workload
ID
--------------- ------ ----- -------------------totalfile-test1_a-..

-totalfile-test1_a-..
-totalfile-test1_a-..
3%
10
6437
6%
3%
10
6437
5%
3%
10
6437
6%
The example above displays total disk utilization for the QoS workload with QoS
672
security snmpusers
Show SNMP users
level.
Description
The security snmpusers displays the following information about SNMP users:
User name
Authentication method
Hexadecimal engine ID
Authentication protocol
Privacy protocol
Security group
Parameters
specify.
| [-instance ] }
about all fields.
If this parameter is specified, the command displays information only about the SNMP
user or users that belong to the specified Vserver.
user with the specified user name.
[-authmethod <text>] - Authentication Method
673
user or users that use the specified authentication method. Possible values include the
following:
community-SNMP community strings
usm-SNMP user security model
[-engineid <Hex String>] - Engine Id
user or users that use the specified engine ID, specified in hexadecimal format.
[-authprotocol <text>] - Authentication Protocol
user or users that use the specified authentication protocol.
[-privprotocol <text>] - Privacy Protocol
user or users that use the specified privacy protocol.
[-securitygroup <text>] - Security Group
user or users that belong to the specified security group.
Examples
The following example displays information about all SNMP users:
cluster1::> security snmpusers
Protocols Security
Vserver
UserName
AuthMethod EngineId
Auth Priv Group
---------- -------------- ---------- --------------------- ---- ---- --------cluster1
comm1
community
8000031504312d38302d313233343536
cluster1
private
community
8000031504312d38302d313233343536
vs1
snmpuser1
community
8000031504312d38302d31323334353632
vs1
snmpuser2
usm
readwrite
readwrite
readwrite
8000031504312d38302d31323334353632
-
674
readwrite
security audit modify

Set administrative audit logging settings
level.
Description
The security audit modify command modifies the following audit-logging settings
for the management interface:
Whether set requests for the CLI are audited
Whether set requests for the Data ONTAP API (ONTAPI) are audited
Whether get requests for the CLI are audited
Whether get requests for the Data ONTAP API (ONTAPI) are audited
Parameters
[-cliset {on|off}] - Enable auditing of CLI set operations
This specifies whether set requests for the CLI are audited. The default setting is on.
[-ontapiset {on|off}] - Enable auditing of Data ONTAP API set operations
This specifies whether set requests for the Data ONTAP API (ONTAPI) interface are
audited. The default setting is on.
[-cliget {on|off}] - Enable auditing of CLI get operations
This specifies whether get requests for the CLI are audited. The default setting is off.
[-ontapiget {on|off}] - Enable auditing of Data ONTAP API get operations
This specifies whether get requests for the Data ONTAP API (ONTAPI) interface are
audited. The default setting is off.
Examples
The following example turns off auditing of get and set requests for the CLI interface:
cluster1::> security audit modify -cliset off -cliget off
675
security audit show

Show administrative audit logging settings
level.
Description
The security audit show command displays the following audit-logging settings for
the management interface:
Whether set requests for the CLI are audited
Whether set requests for the Data ONTAP API (ONTAPI) are audited
Whether get requests for the CLI are audited
Whether get requests for the Data ONTAP API (ONTAPI) are audited
This security audit command family controls what audit info gets logged to the /
mroot/etc/log/mlog/mgwd.log file.
The /mroot/etc/log/mlog/command-history.log file always logs the "set" requests and
never logs the "get" requests. This behavior cannot be disabled and has no relationship
to security audit command family
Therefore, if you enable the "set" requests in the security audit modify
command, the "set" requests are also logged in the mgwd.log file, in addition to the
command-history.log file.
Parameters
None
Examples
The following example displays the audit-logging settings for the management interface:
cluster1::> security audit show
676
Auditing State for
Auditing State for
Set Requests:
Get Requests:
------------------
------------------
CLI:
off
off
ONTAPI:
on
on
See Also
security audit security audit modify
677
security certificate create

Create and Install a Self-Signed Digital Certificate
Description
This command creates and installs a self-signed digital certificate, which can be used
either for server authentication or for signing other certificates by acting as certificate
authority (CA). The certificate function is selected by the -type field. Self-signed digital
certificates are not as secure as certificates signed by a certificate authority (CA).
Therefore, they are not recommended in a production environment.
Parameters
-vserver <vserver name> - Name of Vserver
This specifies the name of the Vserver on which the certificate will exist.
-common-name <FQDN or Custom Common Name> - FQDN or Custom Common
Name
This specifies the desired certificate name as a fully qualified domain name (FQDN) or
custom common name or the name of a person.
-type <type of certificate> - Type of Certificate
This specifies the certificate type. Valid values are the following:
server - creates and installs a self-signed digital certificate and intermediate
certificates to be used for server authentication
root-ca - creates and installs a self-signed digital certificate to sign other
certificates by acting as a certificate authority (CA)
client - includes a self-signed digital certificate and private key to be used for Data
ONTAP as an SSL client
-size <size of requested certificate in bits> - Size of Requested Certificate in Bits
This specifies the number of bits in the private key. The larger the value, the more
secure is the key. The default is 2048. Possible values include 512, 1024, 1536 and
2048.
678
-country <text> - Country Name

This specifies the country where the Vserver resides. The country name is a two-letter
code. The default is US. Here is the list of country codes: Country Codes
-state <text> - State or Province Name
This specifies the state or province where the Vserver resides.
-locality <text> - Locality Name
This specifies the locality where the Vserver resides. For example, the name of a city.
-organization <text> - Organization Name
This specifies the organization where the Vserver resides. For example, the name of a
company.
-unit <text> - Organization Unit
This specifies the unit where the Vserver resides. For example, the name of a section or
a department within a company.
-email-addr <mail address> - Contact Administrator's Email Address
This specifies the email address of the contact administrator for the Vserver.
-expire-days <integer> - Number of Days until Expiration
This specifies the number of days until the certificate expires. The default is 365 days.
Possible values are between 1 and 36510.
-protocol <protocol> - Protocol
This specifies the protocol type. This parameter currently supports only the SSL protocol
type. The default is SSL.
-hash-function <hashing function> - Hashing Function
This specifies the cryptographic hashing function for signing the certificate. The default
is SHA256. Possible values include SHA1, SHA256 and MD5.
Examples
This example creates a server type, self-signed digital certificate for a Vserver named
vs0 at a company whose custom common name is www.example.com and whose
Vserver name is vs0.
cluster1::> security certificate create -vserver vs0 -common-name www.example.com
-type server
679
This example creates a root-ca type, self-signed digital certificate with a 2048-bit private
key generated by the SHA256 hashing function that will expire in 365 days for a Vserver
named vs0 for use by the Software group in IT at a company whose custom common
name is www.example.com, located in Sunnyvale, California, USA. The email address
of the contact administrator who manages the Vserver is web@example.com.
-type root-ca -size 2048 -country US -state California -locality Sunnyvale organization IT -unit Software -email-addr web@example.com -expire-days 365 hash-function SHA256
This example creates a client type of self-signed digital certificate for a Vserver named
vs0 at a company that uses Data ONTAP as an SSL client. The company's custom
common name is www.example.com and its Vserver name is vs0.
-type client -size 2048 -country US -state California -locality Sunnyvale organization IT -unit Software -email-addr web@example.com -expire-days 365 hash-function SHA256
680
security certificate delete

Delete an Installed Digital Certificate
Description
This command deletes an installed digital security certificate.
Parameters
This specifies the Vserver that contains the certificate.
Name
This specifies a fully qualified domain name (FQDN) or custom common name or the
name of a person.
[-serial <text>] - Serial Number of Certificate
This specifies the certificate serial number. The default value is "*".
-ca <text> - Certificate Authority
This specifies the certificate authority (CA).
server - includes server certificates and intermediate certificates
root-ca - includes a self-signed digital certificate to sign other certificates by acting
as a certificate authority (CA)
client-ca - includes the public key certificate for the root CA of the SSL client. If
this client-ca certificate is created as part of a root-ca, it will be deleted along with
the corresponding deletion of the root-ca.
server-ca - includes the public key certificate for the root CA of the SSL server to
which Data ONTAP is a client. If this server-ca certificate is created as part of a
root-ca, it will be deleted along with the corresponding deletion of the root-ca.
681
client - includes a public key certificate and private key to be used for Data
ONTAP as an SSL client
Examples
This example deletes the security certificate for a Vserver named vs0 in a company
named www.example.com.
cluster1::> security certificate delete -vserver vs0 -common-name www.example.com
-ca "Verisign Inc" -type server
This example deletes a root-ca type digital certificate for a Vserver named vs0 in a
company named www.example.com with serial number 4F57D3D1.
cluster1::> security certificate delete -vserver vs0 -common-name www.example.com
-ca www.example.com -type root-ca -serial 4F57D3D1
682
security certificate generate-csr

Generate a Digital Certificate Signing Request
Description
This command generates a digital certificate signing request and displays it on the
console. A certificate signing request (CSR or certification request) is a message sent
securely to a certificate authority (CA) via any electronic media, to apply for a digital
identity certificate.
Parameters
Name
This specifies the desired certificate name as a fully qualified domain name (FQDN) or
custom common name or the name of a person.
[-size <size of requested certificate in bits>] - Size of Requested Certificate in Bits
This specifies the number of bits in the private key. The higher the value, the more
secure is the key. The default is 2048. Possible values include 512, 1024, 1536 and
2048.
[-country <text>] - Country Name
This specifies the country where the Vserver resides. The country name is a two-letter
code. The default is US. Here is the list of country codes: Country Codes
[-state <text>] - State or Province Name
This specifies the state or province where the Vserver resides.
[-locality <text>] - Locality Name
This specifies the locality where the Vserver resides. For example, the name of a city.
[-organization <text>] - Organization Name
This specifies the organization where the Vserver resides. For example, the name of a
company.
[-unit <text>] - Organization Unit
683
This specifies the unit where the Vserver resides. For example, the name of a section or
a department within a company.
[-email-addr <mail address>] - Contact Administrator's Email Address
This specifies the email address of the contact administrator for the Vserver.
[-hash-function <hashing function>] - Hashing Function
This specifies the cryptographic hashing function for signing the certificate. The default
is SHA256. Possible values include SHA1, SHA256 and MD5.
Examples
This example creates a certificate-signing request with a 2048-bit private key generated
by the SHA256 hashing function for use by the Software group in IT at a company
whose custom common name is www.example.com, located in Sunnyvale, California,
USA. The email address of the contact administrator who manages the Vserver is
web@example.com.
cluster1::> security certificate generate-csr -common-name www.example.com
-size 2048 -country US -state California -locality Sunnyvale -organization IT unit Software
-email-addr web@example.com -hash-function SHA256
Certificate Signing Request :
-----BEGIN CERTIFICATE REQUEST----MIIBGjCBxQIBADBgMRQwEgYDVQQDEwtleGFtcGxlLmNvbTELMAkGA1UEBhMCVVMx
CTAHBgNVBAgTADEJMAcGA1UEBxMAMQkwBwYDVQQKEwAxCTAHBgNVBAsTADEPMA0G
CSqGSIb3DQEJARYAMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAPXFanNoJApT1nzS
xOcxixqImRRGZCR7tVmTYyqPSuTvfhVtwDJbmXuj6U3a1woUsb13wfEvQnHVFNci
2ninsJ8CAwEAAaAAMA0GCSqGSIb3DQEBCwUAA0EA6EagLfso5+4g+ejiRKKTUPQO
UqOUEoKuvxhOvPC2w7b//fNSFsFHvXloqEOhYECn/NX9h8mbphCoM5YZ4OfnKw==
-----END CERTIFICATE REQUEST-----
Private Key :
-----BEGIN RSA PRIVATE KEY----MIIBOwIBAAJBAPXFanNoJApT1nzSxOcxixqImRRGZCR7tVmTYyqPSuTvfhVtwDJb
mXuj6U3a1woUsb13wfEvQnHVFNci2ninsJ8CAwEAAQJAWt2AO+bW3FKezEuIrQlu
KoMyRYK455wtMk8BrOyJfhYsB20B28eifjJvRWdTOBEav99M7cEzgPv+p5kaZTTM
gQIhAPsp+j1hrUXSRj979LIJJY0sNez397i7ViFXWQScx/ehAiEA+oDbOooWlVvu
xj4aitxVBu6ByVckYU8LbsfeRNsZwD8CIQCbZ1/ENvmlJ/P7N9Exj2NCtEYxd0Q5
cwBZ5NfZeMBpwQIhAPk0KWQSLadGfsKO077itF+h9FGFNHbtuNTrVq4vPW3nAiAA
684
peMBQgEv28y2r8D4dkYzxcXmjzJluUSZSZ9c/wS6fA==
-----END RSA PRIVATE KEY----Note: Please keep a copy of your certificate request and private key for future
reference.
685
security certificate install

Install a Digital Certificate
Description
This command installs digital security certificates signed by a certificate authority (CA)
and the public key certificate of the root CA. Digital security certificates also include the
intermediate certificates to construct the chain for server certificates (the server type),
client-side root CA certificates (the client-ca type), or server-side root CA certificates
(the server-ca type).
Parameters
This specifies the Vserver that contains the certificate.
server - includes server certificates and intermediate certificates.
client-ca - includes the public key certificate for the root CA of the SSL client
server-ca - includes the public key certificate for the root CA of the SSL server to
which Data ONTAP is a client
client - includes a self-signed or CA-signed digital certificate and private key to be
used for Data ONTAP as an SSL client
Examples
This example installs a CA-signed certificate (along with intermediate certificates) for a
Vserver named vs0.
cluster1::> security certificate install -vserver vs0 -type server
Please enter Certificate: Press <Enter> when done
-----BEGIN CERTIFICATE----MIIB8TCCAZugAwIBAwIBADANBgkqhkiG9w0BAQQFADBfMRMwEQYDVQQDEwpuZXRh
cHAuY29tMQswCQYDVQQGEwJVUzEJMAcGA1UECBMAMQkwBwYDVQQHEwAxCTAHBgNV
686
BAoTADEJMAcGA1UECxMAMQ8wDQYJKoZIhvcNAQkBFgAwHhcNMTAwNDI2MTk0OTI4
WhcNMTAwNTI2MTk0OTI4WjBfMRMwEQYDVQQDEwpuZXRhcHAuY29tMQswCQYDVQQG
EwJVUzEJMAcGA1UECBMAMQkwBwYDVQQHEwAxCTAHBgNVBAoTADEJMAcGA1UECxMA
MQ8wDQYJKoZIhvcNAQkBFgAwXDANBgkqhkiG9w0BAQEFAANLADBIAkEAyXrK2sry
-----END CERTIFICATE-----
Please enter Private Key: Press <Enter> when done

-----BEGIN RSA PRIVATE KEY----MIIBPAIBAAJBAMl6ytrK8nQj82UsWeHOeT8gk0BPX+Y5MLycsUdXA7hXhumHNpvF
C61X2G32Sx8VEa1th94tx+vOEzq+UaqHlt0CAwEAAQJBAMZjDWlgmlm3qIr/n8VT
PFnnZnbVcXVM7OtbUsgPKw+QCCh9dF1jmuQKeDr+wUMWknlDeGrfhILpzfJGHrLJ
z7UCIQDr8d3gOG71UyX+BbFmo/N0uAKjS2cvUU+Y8a8pDxGLLwIhANqa99SuSl8U
DiPvdaKTj6+EcGuXfCXz+G0rfgTZK8uzAiEAr1mnrfYC8KwE9k7A0ylRzBLdUwK9
AvuJDn+/z+H1Bd0CIQDD93P/xpaJETNz53Au49VE5Jba/Jugckrbosd/lSd7nQIg
aEMAzt6qHHT4mndi8Bo8sDGedG2SKx6Qbn2IpuNZ7rc=
-----END RSA PRIVATE KEY----Do you want to continue entering root and/or intermediate certificates {y|n}: y
Please enter Intermediate Certificate: Press <Enter> when done
-----BEGIN CERTIFICATE----MIIE+zCCBGSgAwIBAgICAQ0wDQYJKoZIhvcNAQEFBQAwgbsxJDAiBgNVBAcTG1Zh
bGlDZXJ0IFZhbGlkYXRpb24gTmV0d29yazEXMBUGA1UEChMOVmFsaUNlcnQsIElu
Yy4xNTAzBgNVBAsTLFZhbGlDZXJ0IENsYXNzIDIgUG9saWN5IFZhbGlkYXRpb24g
QXV0aG9yaXR5MSEwHwYDVQQDExhodHRwOi8vd3d3LnZhbGljZXJ0LmNvbS8xIDAe
BgkqhkiG9w0BCQEWEWluZm9AdmFsaWNlcnQuY29tMB4XDTA0MDYyOTE3MDYyMFoX
DTI0MDYyOTE3MDYyMFowYzELMAkGA1UEBhMCVVMxITAfBgNVBAoTGFRoZSBHbyBE
YWRkeSBHcm91cCwgSW5jLjExMC8GA1UECxMoR28gRGFkZHkgQ2xhc3MgMiBDZXJ0
Do you want to continue entering root and/or intermediate certificates {y|n}: y

Please enter Intermediate Certificate: Press <Enter> when done
-----BEGIN CERTIFICATE----MIIC5zCCAlACAQEwDQYJKoZIhvcNAQEFBQAwgbsxJDAiBgNVBAcTG1ZhbGlDZXJ0
IFZhbGlkYXRpb24gTmV0d29yazEXMBUGA1UEChMOVmFsaUNlcnQsIEluYy4xNTAz
BgNVBAsTLFZhbGlDZXJ0IENsYXNzIDIgUG9saWN5IFZhbGlkYXRpb24gQXV0aG9y
aXR5MSEwHwYDVQQDExhodHRwOi8vd3d3LnZhbGljZXJ0LmNvbS8xIDAeBgkqhkiG
9w0BCQEWEWluZm9AdmFsaWNlcnQuY29tMB4XDTk5MDYyNjAwMTk1NFoXDTE5MDYy
687
NjAwMTk1NFowgbsxJDAiBgNVBAcTG1ZhbGlDZXJ0IFZhbGlkYXRpb24gTmV0d29y
azEXMBUGA1UEChMOVmFsaUNlcnQsIEluYy4xNTAzBgNVBAsTLFZhbGlDZXJ0IENs
YXNzIDIgUG9saWN5IFZhbGlkYXRpb24gQXV0aG9yaXR5MSEwHwYDVQQDExhodHRw
Do you want to continue entering root and/or intermediate certificates {y|n}: n

You should keep a copy of the private key and the CA-signed digital certificate
for future reference.
This example installs a CA certificate for client authentication for a Vserver named vs0.
cluster1::> security certificate install -vserver vs0 -type client-ca
-----BEGIN CERTIFICATE----MIIDNjCCAp+gAwIBAgIQNhIilsXjOKUgodJfTNcJVDANBgkqhkiG9w0BAQUFADCB
zjELMAkGA1UEBhMCWkExFTATBgNVBAgTDFdlc3Rlcm4gQ2FwZTESMBAGA1UEBxMJ
Q2FwZSBUb3duMR0wGwYDVQQKExRUaGF3dGUgQ29uc3VsdGluZyBjYzEoMCYGA1UE
CxMfQ2VydGlmaWNhdGlvbiBTZXJ2aWNlcyBEaXZpc2lvbjEhMB8GA1UEAxMYVGhh
d3RlIFByZW1pdW0gU2VydmVyIENBMSgwJgYJKoZIhvcNAQkBFhlwcmVtaXVtLXNl
cnZlckB0aGF3dGUuY29tMB4XDTk2MDgwMTAwMDAwMFoXDTIxMDEwMTIzNTk1OVow
gc4xCzAJBgNVBAYTAlpBMRUwEwYDVQQIEwxXZXN0ZXJuIENhcGUxEjAQBgNVBAcT
You should keep a copy of the CA-signed digital certificate for future
reference.
This example installs a CA certificate for server authentication for a Vserver named vs0.
In this case, Data ONTAP acts as an SSL client.
cluster1::> security certificate install -vserver vs0 -type server-ca
-----BEGIN CERTIFICATE----MIIDNjCCAp+gAwIBAgIQNhIilsXjOKUgodJfTNcJVDANBgkqhkiG9w0BAQUFADCB
zjELMAkGA1UEBhMCWkExFTATBgNVBAgTDFdlc3Rlcm4gQ2FwZTESMBAGA1UEBxMJ
Q2FwZSBUb3duMR0wGwYDVQQKExRUaGF3dGUgQ29uc3VsdGluZyBjYzEoMCYGA1UE
CxMfQ2VydGlmaWNhdGlvbiBTZXJ2aWNlcyBEaXZpc2lvbjEhMB8GA1UEAxMYVGhh
688
d3RlIFByZW1pdW0gU2VydmVyIENBMSgwJgYJKoZIhvcNAQkBFhlwcmVtaXVtLXNl
cnZlckB0aGF3dGUuY29tMB4XDTk2MDgwMTAwMDAwMFoXDTIxMDEwMTIzNTk1OVow
gc4xCzAJBgNVBAYTAlpBMRUwEwYDVQQIEwxXZXN0ZXJuIENhcGUxEjAQBgNVBAcT
You should keep a copy of the CA-signed digital certificate for future
reference.
689
security certificate show

Display Installed Digital Certificates
Description
This command displays the following information about the digital certificates:
Vserver
Serial number of certificate
FQDN or custom common name or the name of a person
Type of certificate (server, root-ca, client-ca, server-chain,
server-ca, client)
Certificate Authority
Expiration date
To display more details, run the command with the -instance parameter. This will add
Size in bits of the requested certificate (512, 1024, 1536, 2048)
Certificate start date
Public key certificate
Country name
State or province name
Locality name
Organization name
Organization unit
Contact administrator's email address
Protocol (SSL)
Hashing function (SHA1, SHA256, MD5)
690
Parameters
specify.
| [-instance ] }
about all fields.
[-vserver <vserver name>] - Name of Vserver
Selects the Vserver whose digital certificates you want to display.
[-common-name <FQDN or Custom Common Name>] - FQDN or Custom Common
Name
Selects the certificates that match this parameter value.
[-ca <text>] - Certificate Authority
[-type <type of certificate>] - Type of Certificate
[-size <size of requested certificate in bits>] - Size of Requested Certificate in Bits
[-start <Date>] - Certificate Start Date
[-expiration <Date>] - Certificate Expiration Date
[-public-cert <certificate>] - Public Key Certificate
[-country <text>] - Country Name
691
[-state <text>] - State or Province Name

[-locality <text>] - Locality Name
[-organization <text>] - Organization Name
[-unit <text>] - Organization Unit
[-email-addr <mail address>] - Contact Administrator's Email Address
[-protocol <protocol>] - Protocol
[-self-signed {true|false}] - Self-Signed Certificate
Examples
The examples below display information about digital certificates.
cluster1::> security certificate show
Vserver
Serial Number
Common Name
Type
---------- --------------- ----------------------------------------- --------vs0
4F4E4D7B
www.example.com
server
Certificate Authority: www.example.com

Expiration Date: Thu Feb 28 16:08:28 2013
cluster1::> security certificate show -instance
Vserver: vs0
FQDN or Custom Common Name: www.example.com
Serial Number of Certificate: 4F4E4D7B
Certificate Authority: www.example.com
692
Type of Certificate: server

Size of Requested Certificate(bits): 2048
Certificate Start Date: Fri Apr 30 14:14:46 2010
Certificate Expiration Date: Sat Apr 30 14:14:46 2011
Public Key Certificate: -----BEGIN CERTIFICATE----MIIDfTCCAmWgAwIBAwIBADANBgkqhkiG9w0BAQsFADBgMRQwEgYDVQQDEwtsYWIu
YWJjLmNvbTELMAkGA1UEBhMCVVMxCTAHBgNVBAgTADEJMAcGA1UEBxMAMQkwBwYD
VQQKEwAxCTAHBgNVBAsTADEPMA0GCSqGSIb3DQEJARYAMB4XDTEwMDQzMDE4MTQ0
BgNVHQ8BAf8EBAMCAQYwHQYDVR0OBBYEFCVG7dYGe51akE14ecaCdL+LOAxUMA0G
CSqGSIb3DQEBCwUAA4IBAQBJlE51pkDY3ZpsSrQeMOoWLteIR+1H0wKZOM1Bhy6Q
+gsE3XEtnN07AE4npjIT0eVP0nI9QIJAbP0uPKaCGAVBSBMoM2mOwbfswI7aJoEh
+XuEoNr0GOz+mltnfhgvl1fT6Ms
+xzd3LGZYQTworus2
-----END CERTIFICATE----Country Name (2 letter code): US
State or Province Name (full name): California
Locality Name (e.g. city): Sunnyvale
Organization Name (e.g. company): example
Organization Unit (e.g. section): IT
Email Address (Contact Name): web@example.com
Protocol: SSL
Hashing Function: SHA256
693
security certificate sign

Sign a Digital Certificate using Self-Signed Root CA
Description
This command signs a digital certificate signing request and generates a certificate
using a Self-Signed Root CA certificate in either PEM or PKCS12 format. You can
use the security certificate generate-csr command to generate a digital
certificate signing request.
Parameters
This specifies the name of the Vserver on which the signed certificate will exist.
-ca <text> - Certificate Authority to Sign
This specifies the name of the Certificate Authority that will sign the certificate.
-ca-serial <text> - Serial Number of CA Certificate
This specifies the serial number of the Certificate Authority that will sign the certificate.
[-expire-days <integer>] - Number of Days until Expiration
This specifies the number of days until the signed certificate expires. The default is 365
days. Possible values are between 1 and 36510.
[-format <certificate format>] - Certificate Format
This specifies the format of signed certificate. The default value is PEM. Possible values
include PEM and PKCS12.
[-destination {(ftp|http)://(hostname|IPv4 Address|'['IPv6 Address']')...}] - Where to Send
File
This specifies the destination to upload the signed certificate. This option can only be
used when the format is PKCS12.
This specifies the cryptographic hashing function for the self-signed certificate. The
default value is SHA256. Possible values include SHA1, SHA256 and MD5.
694
Examples
This example signs a digital certificate for a Vserver named vs0 using a Certificate
Authority certificate that has a ca of www.ca.com and a ca-serial of 4F4EB629 in PEM
format using the SHA256 hashing function.
cluster1::> security certificate sign -vserver vs0 -ca www.ca.com -ca-serial
4F4EB629 -expire-days 36 -format PEM -hash-function SHA256
Please enter Certificate Signing Request(CSR): Press <Enter> when done
Signed Certificate: :
-----BEGIN CERTIFICATE----MIICwDCCAaigAwIBAgIET1oskDANBgkqhkiG9w0BAQsFADBdMREwDwYDVQQDEwh2
czAuY2VydDELMAkGA1UEBhMCVVMxCTAHBgNVBAgTADEJMAcGA1UEBxMAMQkwBwYD
VQQKEwAxCTAHBgNVBAsTADEPMA0GCSqGSIb3DQEJARYAMB4XDTEyMDMwOTE2MTUx
M1oXDTEyMDQxNDE2MTUxM1owYDEUMBIGA1UEAxMLZXhhbXBsZS5jb20xCzAJBgNV
BAYTAlVTMQkwBwYDVQQIEwAxCTAHBgNVBAcTADEJMAcGA1UEChMAMQkwBwYDVQQL
EwAxDzANBgkqhkiG9w0BCQEWADBcMA0GCSqGSIb3DQEBAQUAA0sAMEgCQQD1xWpz
This example signs and exports a digital certificate to destination ftp://10.98.1.1//u/sam/

sign.pfx for a Vserver named vs0 using a Certificate Authority certificate that expires
in 36 days and has a ca value of www.ca.com and a ca-serial value of 4F4EB629 in
PKCS12 format by the MD5 hashing function.
cluster1::> security certificate sign -vserver vs0 -ca www.ca.com -ca-serial
4F4EB629
-expire-days 36 -format PKCS12 -destination ftp://10.98.1.1//u/sam/sign.pfx hash-function MD5
Please enter Certificate Signing Request(CSR): Press <Enter> when done
695

Signed Certificate: :
-----BEGIN CERTIFICATE----MIICwDCCAaigAwIBAgIET1ot8jANBgkqhkiG9w0BAQsFADBdMREwDwYDVQQDEwh2
czAuY2VydDELMAkGA1UEBhMCVVMxCTAHBgNVBAgTADEJMAcGA1UEBxMAMQkwBwYD
VQQKEwAxCTAHBgNVBAsTADEPMA0GCSqGSIb3DQEJARYAMB4XDTEyMDMwOTE2MjEw
NloXDTEyMDQxNDE2MjEwNlowYDEUMBIGA1UEAxMLZXhhbXBsZS5jb20xCzAJBgNV
BAYTAlVTMQkwBwYDVQQIEwAxCTAHBgNVBAcTADEJMAcGA1UEChMAMQkwBwYDVQQL
EwAxDzANBgkqhkiG9w0BCQEWADBcMA0GCSqGSIb3DQEBAQUAA0sAMEgCQQD1xWpz
oarXHSyDzv3T5QIxBGRJ0ACtgdjJuqtuAdmnKvKfLS1o4C90
Please enter Private Key: Press <Enter> when done

-----BEGIN RSA PRIVATE KEY----MIIBOwIBAAJBAPXFanNoJApT1nzSxOcxixqImRRGZCR7tVmTYyqPSuTvfhVtwDJb
mXuj6U3a1woUsb13wfEvQnHVFNci2ninsJ8CAwEAAQJAWt2AO+bW3FKezEuIrQlu
KoMyRYK455wtMk8BrOyJfhYsB20B28eifjJvRWdTOBEav99M7cEzgPv+p5kaZTTM
gQIhAPsp+j1hrUXSRj979LIJJY0sNez397i7ViFXWQScx/ehAiEA+oDbOooWlVvu
xj4aitxVBu6ByVckYU8LbsfeRNsZwD8CIQCbZ1/ENvmlJ/P7N9Exj2NCtEYxd0Q5
cwBZ5NfZeMBpwQIhAPk0KWQSLadGfsKO077itF+h9FGFNHbtuNTrVq4vPW3nAiAA
peMBQgEv28y2r8D4dkYzxcXmjzJluUSZSZ9c/wS6fA==
-----END RSA PRIVATE KEY-----
Please enter a password for pkcs12 file:

Please enter it again:
Enter User for Destination URI: sam
Enter Password:
696
See Also
security certificate generate-csr
697
security certificate ca-issued revoke

Revoke a Digital Certificate
Description
This command revokes a digital certificate signed by a Self-Signed Root CA.
Parameters
This specifies the name of the Vserver on which the certificate is stored.
-serial <text> - Serial Number of Certificate
This specifies the serial number of the certificate.
-ca <text> - Certificate Authority
This specifies the name of the Certificate Authority whose certificate will be revoked.
-ca-serial <text> - Serial Number of CA Certificate
This specifies the serial number of Certificate Authority.
Name
This specifies a fully qualified domain name (FQDN) or custom common name or the
name of a person. This field is optional if ca-serial is specified.
Examples
This example revokes a signed digital certificate for a Vserver named vs0 with serial as
4F5A2DF2 for a Certificate Authority certificate that has a ca of www.ca.com and a caserial of 4F4EB629.
cluster1::> security certificate ca-issued revoke -vserver vs0 -serial 4F5A2DF2 ca www.ca.com -ca-serial 4F4EB629
698
security certificate ca-issued show

Display CA-Issued Digital Certificates
Description
This command displays the following information about the digital certificates issued by
the self-signed root-ca:
Vserver
Serial number of certificate
FQDN or custom common name or the name of a person
Serial number of CA certificate
Status (active, revoked)
Certificate Authority
Expiration date
Revocation date
To display more details, run the command with the -instance parameter. This will add
Country name
State or province name
Locality name
Organization name
Organization unit
Contact administrator's email address
Parameters
699
specify.
| [-instance ] }
about all fields.
[-ca <text>] - Certificate Authority
[-ca-serial <text>] - Serial Number of CA Certificate
Name
[-status <status of certificate>] - Status of Certificate
Selects the certificates that match this parameter value. Possible values include active
and revoked.
[-expiration <Date>] - Certificate Expiration Date
[-revocation <Date>] - Certificate Revocation Date
[-country <text>] - Country Name (2 letter code)
[-state <text>] - State or Province Name (full name)
[-locality <text>] - Locality Name (e.g. city)
700
[-organization <text>] - Organization Name (e.g. company)

[-unit <text>] - Organization Unit (e.g. section)
[-email-addr <mail address>] - Email Address (Contact Name)
Examples
The examples below display information about CA issued digital certificates.
cluster1::> security certificate ca-issued show
Serial Number of
Vserver
Serial Number
Common Name
CA's Certificate Status
---------- --------------- --------------------------- ---------------- ------vs0
4F5A2C90
example.com
4F4EB629
active
4F4EB629
revoked
Certificate Authority: vs0.cert

Expiration Date: Sat Apr 14 16:15:13 2012
Revocation Date: vs0
4F5A2DF2
example.com

Expiration Date: Sat Apr 14 16:21:06 2012
Revocation Date: Fri Mar 09 17:08:30 2012
cluster1::> security certificate ca-issued show -instance
Vserver: vs0
Serial Number of Certificate: 4F5A2C90
Serial Number of CA Certificate: 4F4EB629
FQDN or Custom Common Name: example.com
Status of Certificate: active
Certificate Expiration Date: Sat Apr 14 16:15:13 2012
Certificate Revocation Date: Country Name (2 letter code): US
701
State or Province Name (full name): California

Locality Name (e.g. city): Sunnyvale
Organization Name (e.g. company): example
Organization Unit (e.g. section): IT
Email Address (Contact Name): web@example.com
702
security login create

Add a login method
level.
Description
The security login create command creates a login method for the management
utility. A login method consists of a user name, an application (access method), and an
authentication method. A user name can be associated with multiple applications. It can
optionally include an access-control role name. If an Active Directory group name is
used, the login method gives access to users belonging to the specified Active Directory
group.
Parameters
This specifies the Vserver name of the login method.
-user-or-group-name <text> - User Name or Active Directory Group Name
This specifies the user name or Active Directory group name of the login method. The
Active Directory group name can be specified only with the domain authentication
method, and ontapi and ssh applications.
-application <text> - Application
This specifies the application of the login method. Possible values include console, http,
ontapi, rsh, snmp, service-processor, ssh, and telnet.
Setting this parameter to service-processor grants the user access to the Service
Processor (SP). Because the SP supports only password authentication, when you set
this parameter to service-processor, you must also set the -authmethod parameter to
password. Vserver user accounts cannot access the SP. Therefore, you cannot use the
-vserver parameter when you set this parameter to service-processor.
-authmethod <text> - Authentication Method
This specifies the authentication method of the login method. Possible values include
the following:
cert - SSL certificate authentication
703
community - SNMP community strings

domain - Active Directory authentication
nsswitch - LDAP or NIS authentication
password - Password
publickey - Public-key authentication
usm - SNMP user security model. Refer to "security snmpusers" man page for
more details.
-role <text> - Role Name
This specifies an access-control role name for the login method.
[-comment <text>] - Comment Text
This specifies comment text for the user account, for example, "Guest account". The
maximum length is 128 characters.
Examples
The following command illustrates how to create a login that has the user name monitor,
the application ssh, the authentication method password, and the access-control role
guest for Vserver vs.
cluster1::> security login create -vserver vs -user-or-group-name monitor application ssh -authmethod password -role guest
the application ontapi, the authentication method password, and the access-control role
vsadmin for Vserver vs.
cluster1::> security login create -vserver vs -user-or-group-name monitor application ontapi -authmethod password -role vsadmin
the application ssh, the authentication method publickey, and the access-control role
guest for Vserver vs.
cluster1::> security login create -vserver vs -user-or-group-name monitor application ssh -authmethod publickey -role guest
704
the application http, the authentication method cert, and the access-control role admin
for Vserver vs.
cluster1::> security login create -vserver vs -user-or-group-name monitor application http -authmethod cert -role admin
The following command illustrates how to create a login that has the user name monitor
in DOMAIN1, the application ssh, the authentication method domain, and the accesscontrol role vsadmin for Vserver vs.
cluster1::> security login create -vserver vs -user-or-group-name DOMAIN1\monitor
-application ssh -authmethod domain -role vsadmin
The following command illustrates how to create a login that has the active directory
group name adgroup in DOMAIN1, the application ssh, the authentication method
domain, and the access-control role vsadmin for Vserver vs.
cluster1::> security login create -vserver vs -user-or-group-name DOMAIN1\adgroup
-application ssh -authmethod domain -role vsadmin
The following command illustrates how to create a login that has a user name monitor
in the LDAP or NIS server, the application ssh, the authentication method nsswitch, and
the access-control role vsadmin for Vserver vs.
cluster1::> security login create -vserver vs -user-or-group-name monitor application ssh -authmethod nsswitch -role vsadmin
security login delete

Delete a login method
level.
Description
The security login delete command deletes a login method.
Parameters
705
This optionally specifies the Vserver name of the login method.

This specifies the user name or Active Directory group name of the login method that is
to be deleted. A user name can be associated with multiple applications.
the following:
password - Password
usm - SNMP user security model
Examples
The following command illustrates how to delete a login that has the username guest,
the application ssh, and the authentication method password for Vserver vs.
cluster1::> security login delete -user-or-group-name guest -application ssh authmethod password -vserver vs
The following command illustrates how to delete a login that has the username guest,
the application ontapi, and the authentication method cert for Vserver vs.
cluster1::> security login delete -user-or-group-name guest -application ontapi authmethod cert -vserver vs
security login lock

Lock a user account with password auth method
706

level.
Description
The security login lock command locks a specified account, preventing it from
accessing the management interface.
Parameters
This optionally specifies the Vserver to which the user account belongs.
-username <text> - Username
This specifies the user name of the account that is to be locked.
Examples
The following example locks a user account named jdoe which belongs to the Vserver
vs1.
cluster1::> security login lock -vserver vs1 -username jdoe
security login modify

Modify a login method
level.
Description
The security login modify command modifies the access-control role name of a
login method.
Parameters
This specifies the Vserver name of the login method.
707
This specifies the user name or Active Directory group name of the login method that is
to be modified. A user name can be associated with multiple applications.
the following:
password - Password
[-role <text>] - Role Name
This modifies the access-control role name for the login method.
This specifies comment text for the user account, for example, "Guest account". The
maximum length is 128 characters.
Examples
The following command illustrates how to modify a login method that has the user
name guest, the application ontapi, and the authentication method password to use the
access-control role guest for Vserver vs.
cluster1::> security login modify -user-or-group-name guest -application ontapi authmethod password -role guest -vserver vs
The following command illustrates how to modify a login method that has the user name
guest, the application ssh, and the authentication method publickey to use the accesscontrol role vsadmin for Vserver vs.
cluster1::> security login modify -user-or-group-name guest -application ssh authmethod publickey -role vsadmin -vserver vs
708
security login password

Modify a password for a user
Description
The security login password command resets the password for a specified user.
The command prompts you for the user's old and new password.
Parameters
This optionally specifies the Vserver name of the login method.
This optionally specifies the user name whose password is to be changed. If you do not
specify a user, the command defaults to the user name admin.
Examples
The following command resets the password for a user named admin for Vserver vs.
cluster1::> security login password -username admin -vserver vs
security login show

Show user login methods
level.
Description
The security login show command displays the following information about user
login methods:
User name
709
Application (console, http, ontapi, rsh, snmp, service-processor, ssh, or telnet)

Authentication method (community, password, publickey, or usm)
Role name
Whether the account is locked
Parameters
specify.
| [-instance ] }
about all fields.
Selects the login methods that match this parameter value.
[-user-or-group-name <text>] - User Name or Active Directory Group Name
Selects the login methods that match this parameter value. Value can be a user name or
Active Directory group name.
[-application <text>] - Application
Selects the login methods that match this parameter value. Possible values include
console, http, ontapi, rsh, snmp, service-processor, ssh, and telnet.
[-authmethod <text>] - Authentication Method
Selects the login methods that match this parameter value. Possible values include the
following:
password - Password
710

[-acctlocked {yes|no}] - Account Locked
Examples
The example below illustrates how to display information about all user login methods:
cluster1::> security login show
Authentication
User/Group Name
Application Method
Acct
Role Name
Locked
---------------- ----------- -------------- ---------------- -----admin
console
password
admin
no
admin
http
password
admin
no
admin
ontapi
password
admin
no
admin
service-processor
password
admin
no
admin
ssh
password
admin
no
autosupport
console
password
autosupport
no
Vserver: vs1
Authentication
User/Group Name
Application Method
Acct
Role Name
Locked
---------------- ----------- -------------- ---------------- -----vsadmin
ontapi
password
vsadmin
yes
vsadmin
ssh
password
vsadmin
yes
711
security login unlock

Unlock a user account with password auth method
level.
Description
The security login unlock command unlocks a specified account, enabling it to
access the management interface.
Parameters
This optionally specifies the Vserver to which the user account belongs.
This specifies the user name of the account that is to be unlocked.
Examples
The following command unlocks a user account named jdoe which belongs to the
Vserver vs1.
cluster1::> security login unlock -vserver vs1 -username jdoe
security login whoami

Show the current user of this console session
level.
Description
The security login whoami command displays the name of the user logged
in at the current console session. This command supports only console and SSH
connections. It takes no options or other parameters.
712
Parameters
None
Examples
The following example shows that the current session is logged in by using the 'admin'
user account:
cluster1::> security login whoami
User : admin
See Also
security login show security login create
713
security login domain-tunnel create

Add authentication tunnel Vserver for administrative Vserver
level.
Description
This command establishes a gateway (tunnel) for authenticating Windows Active
Directory (AD) domain users' access to the cluster.
Before using this command to establish the tunnel, the following must take place:
You must use the security login create command to create one or more
AD domain user accounts that will be granted access to the cluster.
The -authmethod parameter of the security login create command
must be set to 'domain'.
The -username parameter of the security login create command
must be set to a valid AD domain user account that is defined in a Windows
Domain Controller's Active Directory. The user account must be specified
in the format of <domainname>\<username>, where "domainname" is the
name of the CIFS domain server.
You must identify or create a CIFS-enabled data Vserver that will be used for
Windows authentication with the Active Directory server. This Vserver is the
tunnel Vserver, and it must be running for this command to succeed.
Only one Vserver can be used as the tunnel. If you attempt to specify more than one
Vserver for the tunnel, Data ONTAP returns an error. If the tunnel Vserver is stopped or
deleted, AD domain users' authentication requests to the cluster will fail.
Parameters
-vserver <vserver> - Authentication Tunnel Vserver
This parameter specifies a data Vserver that has been configured with CIFS. This
Vserver will be used as the tunnel for authenticating AD domain users' access to the
cluster.
Examples
714
The following commands create an Active Directory domain user account

('DOMAIN1\Administrator') for the 'cluster1' cluster, create a data Vserver ('vs'), create a
CIFS server ('vscifs') for the Vserver, and specify 'vs' as the tunnel for authenticating the
domain user access to the cluster.
cluster1::> security login create -vserver cluster1 -username
DOMAIN1\Administrator -application ssh -authmethod domain -role admin
cluster1::> vserver create -vserver vs -rootvolume vol -aggregate
aggr -rootvolume-security-style mixed
cluster1::> vserver cifs create -vserver vs -cifs-server vscifs domain companyname.example.com -ou CN=Computers
cluster1::> security login domain-tunnel create -vserver vs
See Also
security login create vserver create vserver cifs create
715
security login domain-tunnel delete

Delete authentication tunnel Vserver for administrative Vserver
level.
Description
The security login domain-tunnel delete command deletes the tunnel
established by the security login domain-tunnel create command. An error
message will be generated if no tunnel exists.
Parameters
None
Examples
The following command deletes the tunnel established by security login domaintunnel create.
cluster1::> security login domain-tunnel delete
See Also
716
security login domain-tunnel modify

Modify authentication tunnel Vserver for administrative Vserver
level.
Description
The security login domain-tunnel modify command modifies or replaces
the tunnel Vserver. If a tunnel Vserver is not already specified, it sets the current tunnel
Vserver with this Vserver, otherwise, it replaces the current tunnel Vserver with the
Vserver that you specify. If the tunnel Vserver is changed, authentication requests via
previous Vserver will fail. See security login domain-tunnel create for more
information.
Parameters
[-vserver <vserver>] - Authentication Tunnel Vserver
This parameter specifies a Vserver that has been configured with CIFS and is
associated with a Windows Domain Controller's Active Directory authentication. This
Vserver will be used as an authentication tunnel for login accounts so that they can be
used with administrative Vservers.
Examples
The following command modifies the tunnel Vserver for administrative Vserver.
cluster1::> security login domain-tunnel modify -vserver vs
See Also
717
security login domain-tunnel show

Show authentication tunnel Vserver for administrative Vserver
level.
Description
The security login domain-tunnel show command shows the tunnel Vserver
that was specified by the security login domain-tunnel create or security
login domain-tunnel modify command.
Parameters
None
Examples
The example below shows the tunnel Vserver, vs, that is currently used as an
authentication tunnel. The output informs you that the table is currently empty if tunnel
Vserver has not been specified.
cluster1::> security login domain-tunnel show
Tunnel Vserver: vs
See Also
security login domain-tunnel create security login domain-tunnel modify
718
security login publickey create

Add a new public key
Description
The security login publickey create associates an existing public key with a
user account. This command requires that you enter a valid OpenSSH-formatted public
key, a user name, index number, and optionally, a comment.
Parameters
This parameter optionally specifies the Vserver of the user for whom you are adding the
public key.
This parameter specifies the name of the user for whom you are adding the public key. If
you do not specify a user, the user named admin is specified by default.
[-index <integer>] - Index
This parameter specifies an index number for the public key. Default value is zero if it is
the first public key created for the user, otherwise, one greater than the highest existing
index.
-publickey <certificate> - Public Key
This specifies the OpenSSH public key, which must be enclosed in double quotation
marks.
This optionally specifies comment text for the public key. Note that comment text should
be enclosed in quotation marks.
Examples
The following command associates a public key with a user named tsmith for Vserver
vs1. The public key is assigned index number 5 and the comment text is This is a new
key.
719
cluster1::> security login publickey create -vserver vs1 -username tsmith -index
5 -publickey
"ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAIEAspH64CYbUsDQCdW22JnK6J
/vU9upnKzd2zAk9C1f7YaWRUAFNs2Qe5lUmQ3ldi8AD0Vfbr5T6HZPCixNAIza
FciDy7hgnmdj9eNGedGr/JNrftQbLD1hZybX+72DpQB0tYWBhe6eDJ1oPLob
ZBGfMlPXh8VjeU44i7W4+s0hG0E=tsmith@publickey.example.com"
-comment "This is a new key"
720
security login publickey delete

Delete a public key
Description
The security login publickey delete command deletes a public key for a
specific user. To delete a public key, you must specify a user name and index number.
Parameters
This parameter optionally specifies the Vserver of the user for whom you are adding the
public key.
This parameter specifies the name of the user for whom you are deleting a public key. If
you do not specify a user, the user named admin is specified by default.
-index <integer> - Index
This parameter specifies an index number for the public key. Default value is zero if it is
index.
Examples
The following command deletes the public key for the user named tsmith with the index
number 5.
cluster1::> security login publickey delete -username tsmith -index 5
security login publickey load-from-uri

Load one or more public keys from a URI
721
Description
The security login publickey load-from-uri command loads one or more
public keys from a Universal Resource Identifier (URI). To load public keys from a URI,
you must specify a user name, the URI from which to load them, and optionally, whether
you want to overwrite the existing public keys.
Parameters
This parameter optionally specifies the Vserver for the user associated with the public
keys.
This parameter specifies the username for the public keys. If you do not specify a
username, the username "admin" is used by default.
-uri {(ftp|http)://(hostname|IPv4 Address|'['IPv6 Address']')...} - URI to load from
This parameter specifies the URI from which the public keys will be loaded.
-overwrite {true|false} - Overwrite Entries
This parameter optionally specifies whether you want to overwrite existing public keys.
The default value for this parameter is false. If the value is true and you confirm to
overwrite, then the existing public keys are overwritten with the new public keys. If you
use the value false or do not confirm the overwrite, then newly loaded public keys are
appended to the list of existing public keys using the next available index.
Examples
The following command shows how to load public keys for the user named tsmith
from the URI ftp://ftp.example.com/identity.pub. This user's existing public keys are not
overwritten.
cluster1::> security login publickey load-from-uri -username tsmith
-uri ftp://ftp.example.com/identity.pub -overwrite false
The following command shows how to load public keys for the user named tsmith
from the URI ftp:ftp://ftp.example.com/identity.pub. This user's existing public keys are
overwritten if user entered the option 'y' or 'Y'. The user's existing public keys are not
overwritten if user entered the option 'n' or 'N' and the newly loaded public keys are
appended to the list of existing public keys using the next available index.
cluster1::> security login publickey load-from-uri -username
722
tsmith -uri ftp://ftp.example.com/identity.pub -overwrite true -vserver

vs0
Enter User:
Enter Password:
Warning: You are about to overwrite the existing publickeys for the user
"tsmith" in Vserver "vs0". Do you want to proceed? {y|n}:
723
security login publickey modify

Modify a public key
Description
The security login publickey modify command modifies a public key and
optionally its comment text.
Parameters
Specifies the Vserver for the user associated with the public key.
Specifies the username for the public key. If you do not specify a username, the
username 'admin' is used by default.
-index <integer> - Index
Specifies the index number of the public key. The index number of the public key can be
found by using the security login publickey show command.
[-publickey <certificate>] - Public Key
Specifies the new public key. You must enclose the new public key in double quotation
marks.
Specifies the new comment text for the public key.
Examples
The following command modifies the public key at index number 10 for the user named
tsmith of Vserver vs1.
cluster1::> security login publickey modify -vserver vs1 -username tsmith -index
10 -publickey
"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDDD+pFzFgV/2dlowKRFgym9K910H/u
+BVTGitCtHteHyo8thmaXT
1GLCzaoC/12+XXiYKMRhJ00S9Svo4QQKUXHdCPXFSgR5PnAs39set39ECCLzmduplJnkWtX96pQH/
bg2g3upFcdC6z9
724
c37uqFtNVPfv8As1Si/9WDQmEJ2mRtJudJeU5GZwZw5ybgTaN1jxDWus9SO2C43F/vmoCKVT529UHt4/
ePcaaHOGTiQ
O8+Qmm59uTgcfnpg53zYkpeAQV8RdYtMdWlRr44neh1WZrmW7x5N4nXNvtEzr9cvb9sJyqTX1CkQGfDOdb
+7T7y3X7M
if/qKQY6FsovjvfZD"
See Also
security login publickey show
725
security login publickey show

Display public keys
Description
The security login publickey show command displays information about public
keys.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the public keys that match this parameter value.
[-username <text>] - Username
Selects the public keys that match this parameter value. The default value is zero if it is
index.
[-publickey <certificate>] - Public Key
[-fingerprint <text>] - Hex Fingerprint
[-bubblebabble <text>] - Bubblebabble Fingerprint
726

Examples
The example below displays public key information for the user named tsmith.
cluster1::> security login publickey show -username tsmith
UserName: tsmith Index: 5
Public Key:
ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAIEAspH64CYbUsDQCdW22JnK6J
/vU9upnKzd2zAk9C1f7YaWRUAFNs2Qe5lUmQ3ldi8AD0Vfbr5T6HZPCixNAIza
FciDy7hgnmdj9eNGedGr/JNrftQbLD1hZybX+72DpQB0tYWBhe6eDJ1oPLob
ZBGfMlPXh8VjeU44i7W4+s0hG0E=tsmith@publickey.example.com
Fingerprint:
07:b4:27:52:ce:7f:35:81:5a:f2:07:cf:c1:87:91:97
Bubblebabble fingerprint:
xuzom-nelug-bisih-nihyr-metig-kemal-puhut-somyd-mumuh-zomis-syxex
Comment:
This is a new key
727
security login role create

Add an access control role
level.
Description
The security login role create command creates an access-control role. An
access-control role consists of a role name and a command or directory to which the
role has access. It optionally includes an access level (none, readonly, or all) and a
query that applies to the specified command or command directory. After you create an
access-control role, you can apply it to a management-utility login account by using the
security login modify or security login create commands.
Parameters
This optionally specifies the Vserver name associated with the role.
This specifies the role that is to be created.
-cmddirname <text> - Command / Directory
This specifies the command or command directory to which the role has access. To
specify the default setting, use the special value "DEFAULT".
[-access <Access>] - Access Level
This optionally specifies an access level for the role. Possible access level settings are
none, readonly, and all. The default setting is all.
[-query <query>] - Query
This optionally specifies the object that the role is allowed to access. The query object
must be applicable to the command or directory name specified by -cmddirname. The
query object must be enclosed in double quotation marks (""), and it must be a valid field
name.
Examples
728
The following command creates an access-control role named "admin" for the
vs1.example.com Vserver. The role has all access to the "volume" command but only
within the "aggr0" aggregate.
cluster1::> security login role create -role admin -cmddirname volume -query "aggr aggr0" -access all -vserver vs1.example.com
See Also
security login modify security login create
729
security login role delete

Delete an access control role
level.
Description
The security login role delete command deletes an access-control role.
Parameters
This specifies the role that is to be deleted.
specify the default setting, use the special value "DEFAULT".
Examples
The following command deletes an access-control role with the role name readonly and
the command access "volume" for Vserver vs.example.com.
cluster1::> security login role delete -role readonly -cmddirname volume -vserver
vs.example.com
security login role modify

Modify an access control role
level.
Description
The security login role modify command modifies an access-control role.
730
Parameters
This specifies the role that is to be modified.
specify the default setting for a role, use the special value "DEFAULT". This value can
be modified only for the roles created for the admin Vserver.
This optionally specifies a new access level for the role. Possible access level settings
are none, readonly, and all. The default setting is all.
This optionally specifies the object that the role is allowed to access. The query object
must be applicable to the command or directory name specified by -cmddirname. The
query object must be enclosed in double quotation marks (""), and it must be a valid field
name.
Examples
The following command modifies an access-control role with the role name readonly
and the command access "volume" to have the access level readonly for Vserver
vs.example.com:
cluster1::> security login role modify -role readonly -cmddirname volume -access
readonly -vserver vs.example.com
security login role show-ontapi

Display the mapping between Data ONTAP APIs and CLI commands
Description
731
The security login role show-ontapi command displays Data ONTAP APIs
(ONTAPIs) and the CLI commands that they are mapped to.
Parameters
specify.
| [-instance ] }
about all fields.
[-ontapi <text>] - ONTAPI Name
Use this parameter to view the corresponding CLI command for the specified API.
[-command <text>] - CLI Command
Use this parameter to view the corresponding API or APIs for the specified CLI
command.
Examples
The following command displays all Data ONTAP APIs and their mapped CLI
commands:
cluster1::> security login role show-ontapi
ONTAPI
Command
--------------------------- --------------------------------------------------aggr-add
storage aggregate add-disks
aggr-check-spare-low
storage aggregate check_spare_low
aggr-create
storage aggregate create
aggr-destroy
storage aggregate delete
aggr-get-filer-info
aggr
aggr-get-iter
storage aggregate show-view
aggr-offline
storage aggregate offline
aggr-online
storage aggregate online
aggr-options-list-info
storage aggregate show
aggr-rename
storage aggregate rename
aggr-restrict
storage aggregate restrict
aggr-set-option
storage aggregate modify
autosupport-budget-get
system node autosupport budget show
autosupport-budget-get-iter system node autosupport budget show
732
autosupport-budget-get-total-records
system node autosupport budget show
autosupport-budget-modify
system node autosupport budget modify
autosupport-config-get
system node autosupport show
autosupport-config-get-iter system node autosupport show

autosupport-config-get-total-records
autosupport-config-modify
system node autosupport modify
Press <space> to page down, <return> for next line, or 'q' to quit...
The following example displays all Data ONTAP APIs which are mapped to the specified
CLI command:
cluster1::> security login role show-ontapi -command version
ONTAPI
Command
--------------------------- --------------------------------------------------system-get-ontapi-version
version
system-get-version
version
The following example displays the CLI command that is mapped to the specified Data
ONTAPI API:
cluster1::> security login role show-ontapi -ontapi aggr-create
ONTAPI Name: aggr-create
Command: storage aggregate create
security login role show

Show access control roles
level.
Description
The security login role show command displays the following information about
access-control roles:
Role name
Command or command directory to which the role has access
733
Access level (none, read-only, or all)

Query (detailed view only)
Parameters
specify.
| [-instance ] }
about all fields.
Selects the roles that match this parameter value.
Selects the roles that match this parameter value. If this parameter and the cmddirname parameter are both used, the command displays detailed information
about the specified access-control role.
[-cmddirname <text>] - Command / Directory
Selects the roles that match this parameter value. If this parameter and the -role
parameter are both used, the command displays detailed information about the
specified access-control role.
Examples
The example below displays information about all access-control roles:
cluster1::> security login role show
Vserver
RoleName
Command/Directory
Query AccessLevel
---------- ------------- -------------------------------- ----- ----------vs
734
vsadmin
DEFAULT
none
vs
vsadmin
dashboard health vserver
readonly
vs
vsadmin
job
readonly
vs
vsadmin
job schedule
none
vs
vsadmin
lun
all
vs
vsadmin
network connections
readonly
cluster1
admin
DEFAULT
all
cluster1
readonly
DEFAULT
readonly
cluster1
readonly
volume
none
735
security login role config modify

Modify local user account restrictions
level.
Description
The security login role config modify command modifies user account
restrictions.
Parameters
This specifies the Vserver name associated with the profile configuration.
This specifies the role whose account restrictions are to be modified.
[-username-minlength <integer>] - Minimum Username Length Required
This specifies the required minimum length of the user name. Possible values range
from 3 to 16 characters. The default setting is 3 characters.
[-username-alphanum {enabled|disabled}] - Username Alpha-Numeric
This specifies whether a mix of alphabetic and numeric characters are required in the
user name. If this parameter is enabled, a user name must contain at least one letter
and one number. The default setting is disabled.
[-passwd-minlength <integer>] - Minimum Password Length Required
This specifies the required minimum length of a password. Possible values range from 3
to 64 characters. The default setting is 8 characters.
[-passwd-alphanum {enabled|disabled}] - Password Alpha-Numeric
This specifies whether a mix of alphabetic and numeric characters is required in the
password. If this parameter is enabled, a password must contain at least one letter and
one number. The default setting is enabled.
[-passwd-min-special-chars <integer>] - Minimum Number of Special Characters
Required In The Password
736
This specifies the minimum number of special characters required in a password.

Possible values range from 0 to 64 special characters. The default setting is 0, which
requires no special characters.
[-passwd-expiry-time <unsigned32_or_unlimited>] - Password Expires In (Days)
This specifies password expiration in days. A value of 0 means all passwords
associated with the accounts in the role expire now. The default setting is unlimited,
which means the passwords never expire.
[-require-initial-passwd-update {enabled|disabled}] - Require Initial Password Update
on First Login
This specifies whether users must change their passwords when logging in for the
first time. Initial password changes can be done only through SSH or serial-console
connections. The default setting is disabled.
[-max-failed-login-attempts <integer>] - Maximum Number of Failed Attempts
This specifies the allowed maximum number of consecutive invalid login attempts.
When the failed login attempts reach the specified maximum, the account is
automatically locked. The default is 0, which means failed login attempts do not cause
an account to be locked.
[-lockout-duration <integer>] - Maximum Lockout Period (Days)
This optionally specifies the number of days for which an account is locked if the failed
login attempts reach the allowed maximum. The default is 0, which means accounts will
be locked for 1 day.
[-disallowed-reuse <integer>] - Disallow Last 'N' Passwords
This specifies the number of previous passwords that are disallowed for reuse. The
default setting is six, meaning that the user cannot reuse any of their last six passwords.
The minimum allowed value is 1.
[-change-delay <integer>] - Delay Between Password Changes (Days)
This specifies the number of days that must pass between password changes. The
default setting is 0.
Examples
The following command modifies the user-account restrictions for an account with the
role name admin for a Vserver named vs. The minimum size of the password is set to
12 characters.
cluster1::> security login role config modify -role admin -vserver vs
-passwd-minlength 12
737
security login role config reset

Reset RBAC characteristics supported on releases later than Data ONTAP 8.1.2
privilege level.
Description
The security login role config reset command resets the following role
based access control (RBAC) characteristics to their default values. The system
prompts you to run this command if you revert to Data ONTAP 8.1.2 or earlier. If you do
not reset these characteristics, the revert process will fail.
Minimum number of special characters required in password ("0")
Password-expiration time, in days ("unlimited")
Whether the password must be changed at the initial login ("disabled")
Maximum number of failed login attempts permitted before the account is locked
out ("0")
Number of days that the user account is locked out after the maximum number of
failed login attempts is reached ("0")
Parameters
None
Examples
The following command resets the above mentioned RBAC characteristics of all cluster
and Vserver roles to their default values.
cluster1::> security login role config reset
security login role config show

Show local user account restrictions
738

level.
Description
The security login role config show command displays the following
information about account restrictions for management-utility user accounts:
Role name (-role)
Minimum size of the password, in characters (-passwd-minlength)
Whether the password requires alphanumeric characters (-passwd-alphanum)
Number of previous passwords that cannot be reused (-disallowed-reuse)
Minimum number of days that must elapse before users can change their
passwords (-change-delay)
You can display detailed information about the restrictions on a specific account by
specifying the -role parameter. This adds the following information:
Minimum length of the user name, in characters (-username-minlength)
Whether the user name requires alphanumeric characters (-username-alphanum)
Minimum length of the password, in characters (-passwd-minlength)
Whether the password requires alphanumeric characters (-passwd-alphanum)
Minimum number of special characters required in password (-passwd-minspecial-chars)
Password-expiration time, in days (-passwd-expiry-time)
Whether the password must be changed at the initial login (-require-initialpasswd-update)
Maximum number of failed login attempts permitted before the account is locked
out (-max-failed-login-attempts)
Number of days for which the user account is locked after the maximum number
of failed login attempts is reached (-lockout-duration)
Number of previous passwords that cannot be reused (-disallowed-reuse)
Minimum number of days that must elapse before users can change their
passwords (-change-delay)
Parameters
739

specify.
| [-instance ] }
about all fields.
Selects the profile configurations that match this parameter value
If this parameter is specified, the command displays detailed information about
restrictions for the specified user account.
[-username-minlength <integer>] - Minimum Username Length Required
Selects the profile configurations that match this parameter value.
[-username-alphanum {enabled|disabled}] - Username Alpha-Numeric
Selects the profile configurations that match this parameter value. Enabled means a
user name must contain both letters and numbers.
[-passwd-minlength <integer>] - Minimum Password Length Required
[-passwd-alphanum {enabled|disabled}] - Password Alpha-Numeric
Selects the profile configurations that match this parameter value. Enabled means a
password must contain both letters and numbers.
[-passwd-min-special-chars <integer>] - Minimum Number of Special Characters
Required In The Password
[-passwd-expiry-time <unsigned32_or_unlimited>] - Password Expires In (Days)
[-require-initial-passwd-update {enabled|disabled}] - Require Initial Password Update
on First Login
[-max-failed-login-attempts <integer>] - Maximum Number of Failed Attempts
740

[-lockout-duration <integer>] - Maximum Lockout Period (Days)
[-disallowed-reuse <integer>] - Disallow Last 'N' Passwords
[-change-delay <integer>] - Delay Between Password Changes (Days)
Examples
The example below displays restriction information about all user accounts:
cluster1::> security login role config show
----- Password Restrictions ----Vserver
RoleName
Size AlphaNum NoReuse ChangeDelay
----------- ------------- ---- -------- ------- ----------vs
vsadmin
enabled
0 days
vs
vsadmin-protocol 8
enabled
0 days
vs
vsadmin-readonly 8
enabled
0 days
vs
vsadmin-volume
enabled
0 days
cluster1
admin
enabled
0 days
cluster1
readonly
enabled
0 days
741
security ssh add

Add SSH configuration options
Description
This command adds additional SSH key exchange algorithms or ciphers to the existing
configurations of the cluster or a Vserver. The added algorithms or ciphers are enabled
on the cluster or Vserver. If you changed the cluster configuration settings, it will
be used as the default for all newly created Vservers. Existing SSH key exchange
algorithms and ciphers remain unchanged in the configuration. If the SSH key exchange
algorithms or ciphers are already enabled in the current configuration, the command
will not fail. Data ONTAP supports the diffie-hellman-group-exchange-sha256 key
exchange algorithm for SHA-2. Data ONTAP also supports the diffie-hellman-groupexchange-sha1, diffie-hellman-group14-sha1, and diffie-hellman-group1-sha1 SSH key
exchange algorithms for SHA-1. The SHA-2 key exchange algorithm is more secure
than the SHA-1 key exchange algorithms. Data ONTAP also supports the AES and
3DES symmetric encryptions (also known as ciphers) of the following types: aes256-ctr,
aes192-ctr, aes128-ctr, aes256-cbc, aes192-cbc, aes128-cbc, and 3des-cbc.
Parameters
Identifies the Vserver to which you want to add additional SSH key exchange algorithms
or ciphers.
[-key-exchange-algorithms <algorithm name>, ...] - List of SSH Key Exchange
Algorithms to Add
Adds the specified SSH key exchange algorithm or algorithms to the Vserver.
[-ciphers <cipher name>, ...] - List of SSH Ciphers to Add
Adds the specified cipher or ciphers to the Vserver.
Examples
The following command adds the diffie-hellman-group-exchange-sha256 and diffiehellman-group-exchange-sha1 key exchange algorithms for the cluster1 Vserver. It also
adds the aes256-cbc and aes192-cbc ciphers to the cluster1 Vserver.
742
cluster1::> security ssh add -vserver cluster1 -key-exchange-algorithms diffiehellman-group-exchange-sha256,diffie-hellman-group-exchange-sha1 -ciphers aes256cbc,aes192-cbc
743
security ssh modify

Modify SSH configuration options
Description
This command replaces the existing configurations of the SSH key exchange algorithms
or ciphers for the cluster or a Vserver with the configuration settings you specify. If
you modify the cluster configuration settings, it will be used as the default for all newly
created Vservers. Data ONTAP supports the diffie-hellman-group-exchange-sha256
key exchange algorithm for SHA-2. Data ONTAP also supports the diffie-hellman-groupexchange-sha1, diffie-hellman-group14-sha1, and diffie-hellman-group1-sha1 SSH key
3DES symmetric encryptions (also known as ciphers) of the following types: aes256-ctr,
Parameters
Identifies the Vserver for which you want to replace the existing SSH key exchange
algorithm and cipher configurations.
[-key-exchange-algorithms <algorithm name>, ...] - Key Exchange Algorithms
Enables the specified SSH key exchange algorithm or algorithms for the Vserver. This
parameter also replaces all existing SSH key exchange algorithms with the specified
settings.
[-ciphers <cipher name>, ...] - Ciphers
Enables the specified cipher or ciphers for the Vserver. This parameter also replaces all
existing ciphers with the specified settings.
Examples
The following command enables the diffie-hellman-group-exchange-sha256 and diffiehellman-group14-sha1 key exchange algorithms for the cluster1 Vserver. It also enables
the aes256-ctr, aes192-ctr and aes128-ctr ciphers for the cluster1 Vserver.
744
cluster1::> security ssh modify -vserver cluster1 -key-exchange-algorithms

diffie-hellman-group-exchange-sha256,diffie-hellman-group14-sha1 -ciphers
aes256-ctr,aes192-ctr,aes128-ctr
745
security ssh prepare-to-downgrade

Restore SSH configuration to releases earlier than Data ONTAP 8.2.1.
privilege level.
Description
This command restores the configurations of SSH key exchange algorithms and ciphers
of all Vservers and the cluster to their default settings prior to Data ONTAP 8.2.1. You
must run this command in advanced privilege mode when prompted to do so during the
release downgrade. Otherwise, the release downgrade process will fail.
Parameters
None
Examples
The following command restores the SSH security configurations of all Vservers and the
cluster to the settings used before Data ONTAP 8.2.1.
cluster1::*> security ssh prepare-to-downgrade
security ssh remove

Remove SSH configuration options
Description
This command removes the specified SSH key exchange algorithms or ciphers from the
existing configurations of the cluster or a Vserver. The removed algorithms or ciphers
are disabled on the cluster or Vserver. If you changed the cluster configuration settings,
it will be used as the default for all newly created Vservers. If the SSH key exchange
algorithms or ciphers that you specify with this command are not currently enabled, the
command will not fail. Data ONTAP supports the diffie-hellman-group-exchange-sha256
key exchange algorithm for SHA-2. Data ONTAP also supports the diffie-hellman-group-
746
exchange-sha1, diffie-hellman-group14-sha1, and diffie-hellman-group1-sha1 SSH key

3DES symmetric encryption (also known as ciphers) of the following types: aes256-ctr,
Parameters
Identifies the Vserver from which you want to remove the SSH key exchange algorithms
or ciphers.
[-key-exchange-algorithms <algorithm name>, ...] - List of SSH Key Exchange
Algorithms to Remove
Removes the specified key exchange algorithm or algorithms from the Vserver.
[-ciphers <cipher name>, ...] - List of SSH Ciphers to Remove
Removes the specified cipher or ciphers from the Vserver.
Examples
The following command removes the diffie-hellman-group1-sha1 and diffie-hellmangroup-exchange-sha1 key exchange algorithms from the cluster1 Vserver. It also
removes the aes128-cbc and 3des-cbc ciphers from the cluster1 Vserver.
cluster1::> security ssh remove -vserver cluster1 -key-exchange-algorithms
diffie-hellman-group1-sha1,diffie-hellman-group-exchange-sha1 -ciphers aes128cbc,3des-cbc
747
security ssh show

Display SSH configuration options
Description
This command displays the configurations of the SSH key exchange algorithms and
ciphers for the cluster and Vservers. The SSH protocol uses a Diffie-Hellman based
key exchange method to establish a shared secret key during the SSH negotiation
phrase. The key exchange method specifies how one-time session keys are generated
for encryption and authentication and how the server authentication takes place. Data
ONTAP supports the diffie-hellman-group-exchange-sha256 key exchange algorithm
for SHA-2. Data ONTAP also supports the diffie-hellman-group-exchange-sha1, diffiehellman-group14-sha1, and diffie-hellman-group1-sha1 key exchange algorithms for
SHA-1. Data ONTAP also supports the AES and 3DES symmetric encryptions (also
known as ciphers) of the following types: aes256-ctr, aes192-ctr, aes128-ctr, aes256cbc, aes192-cbc, aes128-cbc, and 3des-cbc.
Parameters
specify.
| [-instance ] }
about all fields.
Identifies the Vserver for which you want to display the SSH key exchange algorithm
and cipher configurations.
[-key-exchange-algorithms <algorithm name>, ...] - Key Exchange Algorithms
Displays the Vserver or Vservers that have the specified key exchange algorithms
enabled.
[-ciphers <cipher name>, ...] - Ciphers
748
Displays the Vserver or Vservers that have the specified ciphers enabled.
Examples
The following command displays the enabled SSH key exchange algorithms and ciphers
for the cluster and all Vservers. The cluster settings are used as the default for all newly
created Vservers.
cluster1::> security ssh show
Vserver
Ciphers
Key Exchange Algorithms
--------------- ------------ ----------------------------------------cluster1
aes256-ctr,
diffie-hellman-group-exchange-sha256
aes192-ctr,
aes128-ctr
vs0
aes256-ctr,
diffie-hellman-group-exchange-sha256
aes192-ctr,
aes128-ctr
vs1
aes256-ctr,
diffie-hellman-group-exchange-sha256,
aes192-ctr,
diffie-hellman-group-exchange-sha1,
aes128-ctr,
diffie-hellman-group14-sha1,
aes256-cbc,
diffie-hellman-group1-sha1
aes192-cbc,
aes128-cbc,
3des-cbc
749
security ssl modify

Modify the SSL configuration for HTTP servers
Description
This command modifies the configuration of encrypted HTTP (SSL) for Vservers in the
cluster. Depending on the requirements of the individual node's or cluster's web services
(displayed by the vserver services web show command), this encryption might or
might not be used. If the Vserver does not have a certificate associated with it, SSL will
not be available.
Parameters
Identifies a Vserver for hosting SSL-encrypted web services.
[-ca <text>] - Server Certificate Issuing CA
Identifies a Certificate Authority (CA) of a certificate to be associated with the instance
of a given Vserver. If this parameter, along with serial, is omitted during modification, a
self-signed SSL certificate can be optionally generated for that Vserver.
[-serial <text>] - Server Certificate Serial Number
Identifies a serial number of a certificate to be associated with the instance of a given
Vserver. If this parameter, along with ca, is omitted during modification, a self-signed
SSL certificate can be optionally generated for that Vserver.
[-common-name <FQDN or Custom Common Name>] - Server Certificate Common
Name
Identifies the common name (CN) of a certificate to be associated with the instance of a
given Vserver. This parameter becomes optional if serial and ca are specified. You can
use the security certificate create and security certificate install
commands to add new certificates to Vservers.
Note:
The use of self-signed SSL certificates exposes users to man-in-the-middle security
attacks. Where possible, obtain a certificate that is signed by a reputable certificate
750
authority (CA) and use the security certificate install command to configure
it before enabling SSL on a Vserver.
[-server-enabled {true|false}] - SSL Server Authentication Enabled
Defines the working condition of SSL server authentication in an instance of the Vserver.
Any Vserver with a valid certificate of type server is server-enabled.
[-client-enabled {true|false}] - SSL Client Authentication Enabled
Defines the working condition of SSL client authentication in an instance of the Vserver.
Any Vserver with a valid certificate of type client-ca is client-enabled. It can only be
enabled if server-enabled is true.
Examples
The following example enables SSL server authentication for a Vserver named vs0 with
a certificate that has ca as www.example.com and serial as 4F4EB629.
cluster1::> security ssl modify -vserver vs0 -ca www.example.com -serial 4F4EB629
-server-enabled true
The following example disables SSL server authentication for a Vserver name vs0.
cluster1::> security ssl modify -vserver vs0 -server-enabled false
The following example enables SSL client authentication for a Vserver named vs0.
cluster1::> security ssl modify -vserver vs0 -client-enabled true
The following example disables SSL client authentication for a Vserver named vs0.
cluster1::> security ssl modify -vserver vs0 -client-enabled false
See Also
security certificate create security certificate install vserver services web show
751
security ssl show

Display the SSL configuration for HTTP servers
Description
This command displays the configuration of encrypted HTTP (SSL) for Vservers in the
cluster. Depending on the requirements of the individual node's or cluster's web services
(displayed by the vserver services web show command), this encryption might or
might not be used. If the Vserver does not have a certificate associated with it, SSL will
not be available.
Parameters
specify.
| [-instance ] }
about all fields.
Identifies a Vserver for hosting SSL-encrypted web services.
[-ca <text>] - Server Certificate Issuing CA
Filters the display of SSL configuration by specifying the Certificate Authority (CA) that
issued the server certificate.
[-serial <text>] - Server Certificate Serial Number
Filters the display of SSL configuration by specifying the serial number of a server
certificate.
[-common-name <FQDN or Custom Common Name>] - Server Certificate Common
Name
Filters the display of SSL configuration by specifying the common name for the server
certificate.
752
[-server-enabled {true|false}] - SSL Server Authentication Enabled

Filters the display of SSL configuration according to whether the SSL server
authentication is enabled or disabled. Vservers have self-signed certificates
automatically generated during their creation. These Vserver self-signed certificates are
server-enabled by default.
[-client-enabled {true|false}] - SSL Client Authentication Enabled
Filters the display of SSL configuration according to whether the SSL client
authentication is enabled or disabled. You can enable client authentication only when
server authentication is enabled.
Examples
The following example displays the configured certificates for Vservers.
cluster1::security ssl> show
Vserver
Serial
Server
Number Common Name
Enabled Enabled
Client
--------- ------ --------------------------------------- ------- ------cluster1
516C3CB3
vs0
516816D4
cluster1.company.com
vs0.company.com
true
true
true
false
See Also
vserver services web show
753
snapmirror abort
Abort an active transfer
Description
The snapmirror abort command stops SnapMirror transfers that might have started
and have not finished. A SnapMirror transfer is an operation on a given SnapMirror
relationship, and the relationship is identified by its destination volume. You identify the
SnapMirror relationship with this command and the command aborts the transfer for the
relationship, and for load-sharing mirrors, transfers for associated relationships.
Load-sharing mirrors are either up to date and serving data to clients, or they are
lagging and not serving data to clients. If the snapmirror abort command identifies
an up-to-date load-sharing mirror, then SnapMirror transfers to the up-to-date loadsharing mirror and associated up-to-date load-sharing mirrors in the set of load-sharing
mirrors are aborted. If the snapmirror abort command identifies a lagging loadsharing mirror, then only the SnapMirror transfer associated with the lagging loadsharing mirror is aborted.
After the snapmirror abort command successfully completes its operation, the
volume on the receiving side of the transfer might contain a restart checkpoint. The
restart checkpoint can be used by a subsequent transfer to restart and continue the
aborted SnapMirror transfer.
This command is supported for SnapMirror relationships with the field "Relationship
Capability" showing as either "8.2 and above" or "Pre 8.2" in the output of the
snapmirror show command.
The use of wildcards in parameter values is not supported from the source Vserver or
cluster for relationships with "Relationship Capability" of "8.2 and above".
You can use this command from the source or the destination Vserver or cluster for
FlexVol volume relationships or Infinite Volume relationships.
Parameters
{ [-source-path | -S {<[vserver:]volume>|<[[cluster:]//vserver/]volume>}] - Source Path
Specifies the source endpoint of the SnapMirror relationship in one of two path formats.
The normal format includes the names of the Vserver (vserver) and volume (volume).
To support relationships with "Relationship Capability" of "Pre 8.2", a format which also
754
includes the name of the cluster (cluster) is provided. The "Pre 8.2" format cannot be
used when operating in a Vserver context on relationships with "Relationship Capability"
of "8.2 and above".
| [-source-cluster <Cluster name>] - Source Cluster
Specifies the source cluster of the SnapMirror relationship. If this parameter is specified,
the -source-vserver and -source-volume parameters must also be specified.
This parameter is only applicable for relationships with "Relationship Capability" of
"Pre 8.2". This parameter cannot be specified when operating in a Vserver context on
relationships with "Relationship Capability" of "8.2 and above".
[-source-vserver <vserver name>] - Source Vserver
Specifies the source Vserver of the SnapMirror relationship. If this parameter is
specified, parameters -source-volume and for relationships with "Relationship
Capability" of "Pre 8.2", -source-cluster must also be specified.
[-source-volume <volume name>] } - Source Volume
Specifies the source volume of the SnapMirror relationship. If this parameter is
specified, parameters -source-vserver and for relationships with "Relationship
{ -destination-path {<[vserver:]volume>|<[[cluster:]//vserver/]volume>} - Destination
Path
Specifies the destination endpoint of the SnapMirror relationship in one of two path
formats. The normal format includes the names of the Vserver (vserver) and volume
(volume). To support relationships with "Relationship Capability" of "Pre 8.2", a format
which also includes the name of the cluster (cluster) is provided. The "Pre 8.2" format
cannot be used when operating in a Vserver context on relationships with "Relationship
Capability" of "8.2 and above".
| [-destination-cluster <Cluster name>] - Destination Cluster
Specifies the destination cluster of the SnapMirror relationship. If this parameter is
specified, parameters -destination-vserver and -destination-volume must
also be specified. This parameter is only applicable for relationships with "Relationship
Capability" of "Pre 8.2". This parameter cannot be specified when operating in a Vserver
context on relationships with "Relationship Capability" of "8.2 and above".
-destination-vserver <vserver name> - Destination Vserver
Specifies the destination Vserver of the SnapMirror relationship. If this parameter is
specified, parameters -destination-volume and for relationships with "Relationship
Capability" of "Pre 8.2", -destination-cluster must also be specified.
-destination-volume <volume name> } - Destination Volume
755
Specifies the destination volume of the SnapMirror relationship. If this parameter

is specified, parameters -destination-vserver and for relationships with
"Relationship Capability" of "Pre 8.2", -destination-cluster must also be
specified.
[-hard | -h [true]] - Discard Restart Checkpoint
If this option is specified true, the restart checkpoint is discarded and the destination
volume is restored to the last Snapshot copy that was successfully transferred. You
can use the -hard option to discard the restart checkpoint of a previous transfer
attempt which forces the subsequent transfer to start with a fresh Snapshot copy on the
destination volume. This option can only be used from the destination Vserver or cluster.
[-foreground | -w [true]] - Foreground Process
This specifies whether the operation runs as a foreground process. If this parameter is
specified, the default setting is true (the operation runs in the foreground). When set to
true, the command will not return until the process completes. This parameter is only
applicable to relationships with "Relationship Capability" of "Pre 8.2".
Examples
To stop the active SnapMirror replication to the destination volume
vs2.example.com:dept_eng_dp_mirror1, type the following command:
vs2.example.com::> snapmirror abort -destination-path
vs2.example.com:dept_eng_dp_mirror1
For relationships with "Relationship Capability" of "Pre 8.2", to stop the active
SnapMirror replication to the destination volume cluster2://vs2.example.com/
dept_eng_dp_mirror1, type the following command:
cluster2::> snapmirror abort -destination-path
cluster2://vs2.example.com/dept_eng_dp_mirror1
See Also
job stop snapmirror show
756
snapmirror break
Make SnapMirror destination writable
Description
The snapmirror break command breaks a SnapMirror relationship between a
source and destination volume of a data protection mirror. When Data ONTAP breaks
the relationship, the destination volume is made a read-write volume and can diverge
from the source volume, client redirection is turned off on the destination volume, the
restart checkpoint is cleared, and the clients can see the latest Snapshot copy.
Subsequent manual or scheduled SnapMirror updates to the broken relationship will
fail until the SnapMirror relationship is reestablished using the snapmirror resync
command.
This command applies to data protection mirrors. For vault relationships, this command
is only intended for use when preparing for a Data ONTAP revert operation (see the
-delete-snapshots parameter in advanced privilege level). This command is not
intended for use with load-sharing mirrors.
The snapmirror break command must be used from the destination Vserver or
cluster.
Parameters
of "8.2 and above".
757
Path
specified.
758

If this parameter is specified, the command proceeds without prompting for confirmation.
[-delete-snapshots [true]] - Delete Snapshots for Revert (privilege: advanced)
Using this parameter causes break to delete Snapshot copies on a vault destination so
that the system can be reverted. Note that the only Snapshot copies that will be deleted
are those that were created with the current version of Data ONTAP. Any Snapshot
copies that might be present created with a different version will not be deleted.
[-restore-destination-to-snapshot | -s <text>] - Restore Destination to Snapshot Copy
This optional parameter specifies the Snapshot copy to which the destination volume
is restored after a successful break operation. If the parameter is not specified, the
destination is restored to the latest Snapshot copy.
Examples
To stop the SnapMirror replication to the destination volume
vs2.example.com::> snapmirror break -destination-path
For relationships with "Relationship Capability" of "Pre 8.2", to stop the SnapMirror
replication to the destination volume cluster2://vs2.example.com/dept_eng_dp_mirror1,
type the following command:
cluster2::> snapmirror break
-destination-path cluster2://vs2.example.com/dept_eng_dp_mirror1
See Also
snapmirror resync snapmirror show
759
snapmirror create
Create a new SnapMirror relationship
Description
The snapmirror create command creates a SnapMirror relationship between a
source and destination endpoint. You can use this command to create a data protection
relationship, a vault relationship, or a load-sharing relationship between FlexVol
volumes. You can also use it to create a data protection relationship between Infinite
Volumes. Infinite Volumes support only data protection relationships.
Before using this command to create a volume SnapMirror relationship, you typically
create a source and destination volume using the volume create command. The
source volume should be in the online state and a read-write (RW) type. The destination
volume should be in the online state and a data protection (DP) type.
You must also take the volume style into consideration when creating volume level
SnapMirror relationships. Data ONTAP mirrors FlexVol volumes and Infinite Volumes.
For an Infinite Volume SnapMirror relationship, the destination Infinite Volume size must
be greater than or equal to the source Infinite Volume size in bytes. You can verify the
size in bytes by running set -units KB followed by volume show.
If all systems involved are running Data ONTAP version 8.2 and later, a Vserver peering
relationship must be set up using the vserver peer create command between
the source and the destination Vservers in order to create a relationship between the
source and destination volumes. To enable interoperability with Data ONTAP version
8.1, if the source volume is on a storage system running clustered Data ONTAP version
8.1, the cluster administrator can create a data protection relationship between the
source and destination volumes without a Vserver peering relationship between the
source and destination Vservers. These relationships are managed the same way as on
Data ONTAP 8.1 and the "Relationship Capability" field, as shown in the output of the
snapmirror show command, is set to "Pre 8.2".
Note:
SnapMirror relationships, except load-sharing relationships, which are created between
two volumes which are both on a storage system running Data ONTAP version 8.2 and
later have the "Relationship Capability" field set to "8.2 and above".
760
Load-sharing mirrors must be confined to a single Vserver; they are not allowed to span
Vservers. Load-sharing relationships are created with the "Relationship Capability"
field set to "Pre 8.2" even if both the source and destination volumes are on a storage
system running Data ONTAP version 8.2 and later. There is no "8.2 and above"
implementation for load-sharing relationships.
A set of load-sharing mirrors can have one or more destination volumes. You create
separate SnapMirror relationships between the common source volume and each
destination volume to create the set of load-sharing mirrors.
The source or destination of a load-sharing relationship cannot be the source or
destination of any other SnapMirror relationship.
After creating the relationship, the destination volume can be initialized using the
snapmirror initialize command. The destination volumes in a set of load-sharing
mirrors are initialized using the snapmirror initialize-ls-set command. Load
sharing mirrors are not supported for Infinite Volumes.
The snapmirror create command must be used from the destination Vserver or
cluster.
Parameters
{ -source-path | -S {<[vserver:]volume>|<[[cluster:]//vserver/]volume>} - Source Path
of "8.2 and above".
-source-vserver <vserver name> - Source Vserver
761

Path
specified.
[-type <snapmirrorType>] - Relationship Type
Specifies the type of SnapMirror relationship that will be created. You can create a data
protection (DP) relationship, an extended data protection (XDP) relationship, a transition
data protection relationship between a 7-Mode and a clustered Data ONTAP system
(TDP), or a load-sharing (LS) relationship. The default value is DP. Infinite Volumes
support only data protection (DP) relationships.
[-vserver <vserver name>] - Managing Vserver
If this optional parameter is specified, designates the managing Vserver. The managing
Vserver is authorized to use snapmirror commands to manage the SnapMirror
relationship. The -vserver parameter is currently a reserved parameter.
762
[-schedule <text>] - SnapMirror Schedule

This optional parameter designates the name of the schedule which is used to
update the SnapMirror relationship. If you do not designate a schedule, updates are
not scheduled, so you must update the SnapMirror relationship manually using the
snapmirror update command or, in the case of a set of load-sharing mirrors, using
the snapmirror update-ls-set command.
Note:
You define and name a schedule using the job schedule cron create command.
The schedules associated with an Infinite Volume SnapMirror relationship should not
have an interval shorter than hourly.
[-policy <sm_policy>] - SnapMirror Policy
This optional parameter designates the name of the SnapMirror policy which is
associated with the SnapMirror relationship. If you do not designate a policy, the
DPDefault policy is applied to data protection relationships and the XDPDefault policy
is applied to extended data protection relationships. This parameter is not applicable to
relationships with "Relationship Capability" of "Pre 8.2".
In clustered Data ONTAP 8.2 data protection (DP) relationships were used for mirroring,
while extended data protection (XDP) relationships were used for backup/vaulting. In
clustered Data ONTAP 8.3 extended data protection (XDP) relationships support two
more use cases, mirroring and unified mirror-vault. The exact behavior of an extended
data protection (XDP) relationship is governed by the snapmirror policy associated
with that relationship. In clustered ONTAP 8.3 the snapmirror policy has a new
field type to indicate how the relationships with that policy will behave. The supported
types are async-mirror (mirroring), vault (vaulting/backup) and mirror-vault (unified
mirroring and vault). Refer to the man page for the snapmirror policy create
command for more information.
Note:
You define and name a policy using the snapmirror policy create command.
[-tries <unsigned32_or_unlimited>] - Tries Limit
This optional parameter specifies the maximum number of times to attempt each
manual or scheduled transfer for a SnapMirror relationship. The default is eight times.
The -tries parameter can be set to 0 to disable manual and scheduled updates
for the SnapMirror relationship. This parameter is only applicable to relationships
with "Relationship Capability" of "Pre 8.2". For relationships with "8.2 and above"
763
capability, the tries limit is controlled by the value of tries in the SnapMirror policy which
is associated with the relationship.
[-throttle | -k <throttleType>] - Throttle (KB/sec)
This optional parameter limits the network bandwidth used for transfers. It configures for
the relationship the maximum rate (in Kbytes/sec) at which data can be transferred. If
no throttle is configured, by default the SnapMirror relationship fully utilizes the network
bandwidth available. You can also configure the relationship to fully use the network
bandwidth available by explicitly setting the throttle to unlimited or 0. The minimum
effective throttle value is four Kbytes/sec, so if you specify a throttle value between 1
and 4, it will be treated as 4. The -throttle parameter does not affect load-sharing
mirrors and other SnapMirror relationships with "Relationship Capability" of "Pre 8.2"
confined to a single cluster.
Examples
To create a data protection mirror between the source endpoint
vs1.example.com:dept_eng, and the destination endpoint
vs2.example.com::> snapmirror create -destination-path
vs2.example.com:dept_eng_dp_mirror2 -source-path
vs1.example.com:dept_eng
-type DP
To create a data protection mirror between the source endpoint cluster1://

vs1.example.com/dept_eng, and the destination endpoint cluster2://vs2.example.com/
dept_eng_dp_mirror2 when the source cluster is running Data ONTAP 8.1 software,
cluster2::> snapmirror create -destination-path
cluster2://vs2.example.com/dept_eng_dp_mirror2 -source-path
cluster1://vs1.example.com/dept_eng
-type DP
To create a load-sharing mirror between the source endpoint cluster1://

vs1.example.com/mkt1, and the destination endpoint cluster1://vs1.example.com/
mkt1_ls1 with the schedule named 5min used to update the relationship, type the
following command:
cluster1::> snapmirror create
-destination-path cluster1://vs1.example.com/mkt1_ls1
-source-path
764
cluster1://vs1.example.com/mkt1 -type LS -schedule 5min
See Also
snapmirror update snapmirror update-ls-set job schedule cron create
snapmirror policy snapmirror policy create volume create vserver peer create
snapmirror show snapmirror initialize snapmirror initialize-ls-set
765
snapmirror delete
Delete a SnapMirror relationship
Description
The snapmirror delete command removes only the SnapMirror relationship
between a source volume and a destination volume, the volumes are not destroyed and
Snapshot copies on the volumes are not removed.
The snapmirror delete command fails if a SnapMirror transfer for the SnapMirror
relationship is in progress for relationships with "Relationship Capability" of "Pre 8.2".
For relationships with "8.2 and above" capability the delete will succeed even if a
transfer is in progress and the transfer will ultimately stop.
A set of load-sharing mirrors can contain multiple destination volumes, each destination
volume having a separate SnapMirror relationship with the common source volume.
When used on one of the SnapMirror relationships from the set of load-sharing mirrors,
the snapmirror delete command deletes the specified SnapMirror relationship from
the set of load-sharing mirrors.
The snapmirror delete command preserves the read-write or read-only attributes
of the volumes of a SnapMirror relationship after the relationship is deleted. Therefore, a
read-write volume that was the source of a SnapMirror relationship retains its read-write
attributes, and a data protection volume or a load-sharing volume that was a destination
of a SnapMirror relationship retains its read-only attributes.
Note:
When a SnapMirror relationship from a set of load-sharing mirrors is deleted, the
destination volume becomes a data protection volume and retains the read-only
attributes of a data protection volume.
For relationships with "Relationship Capability" of "8.2 and above", the snapmirror
delete command must be used from the destination Vserver or cluster. The
SnapMirror relationship information is deleted from the destination Vserver, but no
cleanup or deletion is performed on the source Vserver. The snapmirror release
766
command must be issued on the source Vserver to delete the source relationship
information.
For relationships with "Relationship Capability" of "Pre 8.2", you can use this command
from the source or from the destination cluster. When used from the destination
cluster, the SnapMirror relationship information on the source and destination clusters
is deleted. When used from the source cluster, only the SnapMirror relationship
information on the source cluster is deleted. The use of snapmirror delete on a
source cluster is not supported for an Infinite Volume relationships in this release.
Parameters
of "8.2 and above".
Path
767

specified.
If specified, the delete proceeds even if it cannot clean up all artifacts of the relationship.
Examples
To delete the SnapMirror relationship with the destination endpoint
vs2.example.com::> snapmirror delete -destination-path
For relationships with "Relationship Capability" of "Pre 8.2", to delete the

SnapMirror relationship with the destination endpoint cluster2://vs2.example.com/
dept_eng_dp_mirror4, type the following command:
cluster2::> snapmirror delete -destination-path
768
See Also
snapmirror show snapmirror release
769
snapmirror initialize-ls-set
Start a baseline load-sharing set transfer
Description
The snapmirror initialize-ls-set command initializes and updates a set of
load-sharing mirrors. This command is usually used after the snapmirror create
command is used to create a SnapMirror relationship for each of the destination
volumes in the set of load-sharing mirrors. The initial transfers to empty load-sharing
mirrors are baseline transfers done in parallel. During a baseline transfer Data ONTAP
takes a Snapshot copy on the source volume to capture the current image of the source
volume and transfers all of the Snapshot copies on the source volume to each of the
destination volumes.
After the snapmirror initialize-ls-set command successfully completes, the
last Snapshot copy transferred is made the exported Snapshot copy on the destination
volumes.
The parameter that identifies the set of load-sharing mirrors is the source volume.
Data and Snapshot copies are transferred from the source volume to all up-to-date
destination volumes in the set of load-sharing mirrors.
Use the snapmirror initialize command to add and initialize a new destination
volume to an existing set of load-sharing mirrors.
Note:
Even if the load-sharing set only has one mirror, you still need to use the snapmirror
initialize-ls-set command to initialize the set. The snapmirror initialize
command can only be used to initialize a new destination volume, if the load-sharing set
has already been initialized.
This command is not supported on Infinite Volume snapmirror relationships.
This command is only supported for SnapMirror relationships with the field "Relationship
Capability" showing as "Pre 8.2" in the output of the snapmirror show command.
Parameters
770
of "8.2 and above".
-source-volume <volume name> } - Source Volume
Examples
To initialize the group of load-sharing mirrors for the source endpoint //vs1.example.com/
dept_eng, type the following command:
cluster1::> snapmirror initialize-ls-set -source-path
//vs1.example.com/dept_eng
See Also
snapmirror create snapmirror initialize snapmirror show
771
snapmirror initialize
Start a baseline transfer
Description
The snapmirror initialize command initializes the destination volume of a
SnapMirror relationship. The command behaves differently between data protection
(DP), extended data protection (XDP) and load-sharing (LS) relationships.
For data protection (DP) and extended data protection (XDP) relationships, the
snapmirror initialize command initializes the destination volume.
For load-sharing (LS) relationships, the snapmirror initialize command
initializes a new load-sharing mirror in an existing set of load-sharing mirrors. If the
command finishes before the start of a scheduled or manual transfer of the set of loadsharing mirrors, the load-sharing mirror is up to date with the set of load-sharing mirrors;
otherwise, the load-sharing mirror will be brought up to date at the next scheduled or
manual transfer of the set of load-sharing mirrors.
The initial transfer to an empty destination volume is called a baseline transfer. During
a baseline transfer for a data protection (DP) or extended data protection (XDP)
relationship, the snapmirror initialize command takes a Snapshot copy on the
source volume to capture the current image of the source volume. For data protection
relationships, the snapmirror initialize command transfers all of the Snapshot
copies up to and including the Snapshot copy created by it from the source volume
to the destination volume. For extended data protection (XDP) relationships, the
snapmirror initialize command behavior depends on the snapmirror policy
associated with the relationship. If the policy type is async-mirror then depending on the
rules in the policy it can transfer either all the Snapshot copies up to and including the
Snapshot copy created by it or only the Snapshot copy created by it from the source
volume to the destination volume. For extended data protection (XDP) relationships
with policy type vault or mirror-vault the snapmirror initialize transfers only the
Snapshot copy created by it.
After the snapmirror initialize command successfully completes, the last
Snapshot copy transferred is made the exported Snapshot copy on the destination
volume.
When an Infinite Volume SnapMirror relationship is initialized, the command will create
any needed constituent volumes for the destination Infinite Volume. The Infinite Volume
772
relationship will appear in the snapmirror show command output on the source
cluster after it is initialized.
You can use the snapmirror initialize command to initialize a specific loadsharing mirror that is new to the set of load-sharing mirrors. An initialize of the new loadsharing mirror should bring it up to date with the other up-to-date destination volumes in
the set of load-sharing mirrors.
Note:
Using the snapmirror initialize command to initialize a set of load-sharing
mirrors will not work. Use the snapmirror initialize-ls-set command to
initialize a set of load-sharing mirrors.
If a SnapMirror relationship does not already exist, that is, the relationship was not
created using the snapmirror create command, the snapmirror initialize
command will implicitly create the SnapMirror relationship, with the same behaviors as
described for the snapmirror create command before initializing the relationship.
This implicit create feature is not supported for Infinite Volumes.
For relationships with "Relationship Capability" of "8.2 and above", you can track the
progress of the operation using the snapmirror show command.
For relationships with "Relationship Capability" of "Pre 8.2", a job will be spawned to
operate on the SnapMirror relationship, and the job id will be shown in the command
output. The progress of the job can be tracked using the job show and job history
show commands.
The snapmirror initialize command must be used from the destination Vserver
or cluster.
Parameters
of "8.2 and above".
773
Path
specified.
774
[-source-snapshot | -s <text>] - Source Snapshot

This optional parameter specifies the Snapshot copy that snapmirror initialize
will use for the baseline transfer. For data protection (DP) relationships, the baseline
transfer will include all of the Snapshot copies up to and including the specified
Snapshot copy. For extended data protection (XDP) relationships, the snapmirror
initialize command behavior depends on the snapmirror policy associated
with the relationship. If the policy type is async-mirror then depending on the rules in
the policy it can transfer either all the Snapshot copies up to and including the specified
Snapshot copy or only the specified Snapshot copy from the source volume to the
destination volume. For extended data protection (XDP) relationships with policy
type vault or mirror-vault the snapmirror initialize transfers only the specified
Snapshot copy. This parameter is not supported for relationships with "Relationship
Capability" of "Pre 8.2". This parameter is not supported for Infinite Volume SnapMirror
relationships.
[-type <snapmirrorType>] - Snapmirror Relationship Type
Specifies the type of SnapMirror relationship if a relationship is implicitly created. This
parameter is the same as the one used in the snapmirror create command.
current policy will be retained. This parameter is not applicable to relationships with
"Relationship Capability" of "Pre 8.2". This parameter is not supported by this operation
for Infinite Volumes.
Note:
This optional parameter limits the network bandwidth used for the initialize transfer.
It sets the maximum rate (in Kbytes/sec) at which data can be transferred during
the operation. If this parameter is not specified, the throttle value configured for the
relationship with the snapmirror create or snapmirror modify commands will
be used. To specify fully using the network bandwidth available, set the throttle value
to unlimited or 0. The minimum throttle value is four Kbytes/sec, so if you specify a
throttle value between 1 and 4, it will be treated as if you specified 4. The -throttle
parameter does not affect load-sharing transfers and transfers for other relationships
with "Relationship Capability" of "Pre 8.2" confined to a single cluster.
[-transfer-priority {low|normal}] - Transfer Priority
775
This optional parameter specifies the priority at which the transfer runs. The default
value for this parameter is the value in the SnapMirror policy associated with this
relationship. This parameter is not applicable to relationships with a "Relationship
Capability" of "Pre 8.2".
Examples
To start the initial transfer for the SnapMirror relationship with the destination endpoint
vs2.example.com:dept_eng_dp_mirror2 after the relationship has been created with the
snapmirror create command, type the following command:
vs2.example.com::> snapmirror initialize -destination-path
For relationships with "Relationship Capability" of "Pre 8.2", to start the initial transfer for
the SnapMirror relationship with the destination endpoint cluster2://vs2.example.com/
dept_eng_dp_mirror2 after the relationship has been created with the snapmirror
create command, type the following command:
cluster2::> snapmirror initialize -destination-path
To create a data protection mirror relationship between the source

endpoint vs1.example.com:dept_mkt, and the destination endpoint
vs2.example.com:dep_mkt_dp_mirror, and start the initial transfer, type the following
command:
vs2.example.com::> snapmirror initialize -destination-path
vs.example.com2:dept_mkt_dp_mirror
-source-path vs1.example.com:dept_mkt
To create a data protection mirror relationship between the source endpoint cluster1://
vs1.example.com/dept_mkt, and the destination endpoint cluster2://vs2.example.com/
dep_mkt_dp_mirror, and start the initial transfer when the source cluster is running Data
ONTAP 8.1 software, type the following command:
776
cluster2::> snapmirror initialize -destination-path

cluster2://vs2.example.com/dept_mkt_dp_mirror
-source-path cluster1://vs1.example.com/dept_mkt
See Also
snapmirror policy snapmirror create snapmirror policy create snapmirror modify
snapmirror show snapmirror initialize-ls-set job show job history show
777
snapmirror list-destinations
Display a list of destinations for SnapMirror sources
Description
The snapmirror list-destinations command displays information including
the destination endpoints, the relationship status, and transfer progress, for SnapMirror
relationships whose source endpoints are in the current Vserver if you are in a Vserver
context, or the current cluster if you are in a cluster context.
The command might display several relationships that have the same source and
destination endpoints, but have different relationship IDs. If this is the case, some of
the information is stale. It corresponds to relationships that have been deleted on the
destination Vserver or cluster, and have not been released yet on the source Vserver or
source cluster.
The relationships and the information displayed are controlled by the parameters
that you specify. If no parameters are specified, the command displays the following
information associated with each SnapMirror relationship whose source endpoint is in
the current Vserver if you are in a Vserver context, or the current cluster if you are in a
cluster context:
Source path
Relationship Type
Destination Path
Relationship Status
Transfer Progress
Progress Last Updated
Relationship ID
Note the following limitations on the information displayed by the snapmirror listdestinations command:
The "Relationship Status" field is not valid after the node hosting the source
volume joins the cluster quorum, until at least one transfer is performed on the
SnapMirror relationship.
778
"Transfer Progress" and "Progress Last Updated" fields are only valid if a
Snapshot copy transfer is in progress.
The -instance and -fields parameters are mutually exclusive and select the
fields that are displayed. The -instance parameter if specified, displays detailed
information about the relationships. The other parameters of the snapmirror listdestinations command, select the SnapMirror relationships for which the information
is displayed.
Parameters
If you specify the -fields <fieldname>,... parameter, the command only displays
the fields that you have specified.
| [-instance ] }
about all relationships selected.
Selects SnapMirror relationships that have a matching source path name.
| [-source-vserver <vserver name>] - Source Vserver
Selects SnapMirror relationships that have a matching source Vserver name.
Selects SnapMirror relationships that have a matching source volume name.
{ [-destination-path {<[vserver:]volume>|<[[cluster:]//vserver/]volume>}] - Destination
Path
Selects SnapMirror relationships that have a matching destination path name.
| [-destination-vserver <vserver name>] - Destination Vserver
Selects SnapMirror relationships that have a matching destination Vserver name.
[-destination-volume <volume name>] } - Destination Volume
Selects SnapMirror relationships that have a matching destination volume name.
[-relationship-id <UUID>] - Relationship ID
Selects SnapMirror relationships that have a matching relationship identifier.
779
Selects SnapMirror relationships that have a matching relationship type. Possible values
are:
DP
XDP
RST
[-relationship-group-type {none|infinitevol}] - Relationship Group Type
Selects SnapMirror relationships that have a matching relationship group type. Possible
values are:
none
infinitevol
[-policy-type {vault|async-mirror|mirror-vault}] - SnapMirror Policy Type
Selects SnapMirror relationships that have a matching SnapMirror policy type. Possible
values are:
async-mirror
vault
mirror-vault
[-status <mirror status>] - Relationship Status
Selects SnapMirror relationships that have a matching relationship status. Possible
values are:
Idle
Transferring
[-transfer-progress {<integer>[KB|MB|GB|TB|PB]}] - Transfer Progress
Selects SnapMirror relationships that have a matching transfer progress. This option is
not supported for Infinite Volume SnapMirror relationships.
[-progress-last-updated <MM/DD HH:MM:SS>] - Timestamp of Last Progress Update
Selects SnapMirror relationships that have a matching transfer progress last updated
timestamp. This option is not supported for Infinite Volume SnapMirror relationships.
[-is-constituent {true|false}] - Constituent Relationship
Selects SnapMirror relationships that have a matching constituent condition.
780
[-source-volume-node <nodename>] - Source Volume Node Name

Selects SnapMirror relationships that have a matching source volume node name.
Examples
To display summary information about all relationships whose source endpoints are in
the current Vserver, type the following command:
vserver1.example.com::> snapmirror list-destinations
Progress
Source
Path
Destination
Type
Path
Last
Relationship
Progress
Updated
ID
Status
Transfer
----------- ----- ------------ ------- --------- --------- ---------------vserver1.example.com:dp_s1

DP
vserver2.example.com:dp_d1
Idle
06b4327b-954f-11e1-
a9c1db0b-954f-11e1-
af65-123478563412
vserver1.example.com:xdp_s1
XDP
vserver2.example.com:xdp_d1
Idle
af65-123478563412
To display detailed information about SnapMirror relationships whose source endpoints

are in the current Vserver, type the following command:
vserver1.example.com::> snapmirror list-destinations -instance
Source Path: vserver1.example.com:dp_s1
Destination Path: vserver2.example.com:dp_d1
Relationship Type: DP
Relationship Group Type: none
Relationship Status: Idle
Transfer Progress: Progress Last Updated: Source Volume Node: node1
Relationship ID: 06b4327b-954f-11e1-af65-123478563412
Source Path: vserver1.example.com:xdp_s1
Destination Path: vserver2.example.com:xdp_d1
781
Relationship Type: XDP

Transfer Progress: Progress Last Updated: Source Volume Node: node2
Relationship ID: a9c1db0b-954f-11e1-af65-123478563412
Restrictions/Limitations
The snapmirror list-destinations command does not return information about
load-sharing relationships or relationships whose source endpoints were in clustered
Data ONTAP 8.1 when they were created. You must run the snapmirror show
command to display information about these relationships.
SnapMirror relationship information on the source Vserver or cluster is populated during
the first transfer. Therefore, the snapmirror list-destinations command will not
return any information about newly created SnapMirror relationships until the baseline
transfer has started.
See Also
snapmirror show
782
snapmirror modify
Modify a SnapMirror relationship
Description
The snapmirror modify command allows you to change one or more properties of
SnapMirror relationships. The key parameter that identifies any SnapMirror relationship
is the destination volume.
For load-sharing mirrors, a change to a property affects all of the SnapMirror
relationships in the set of load-sharing mirrors. Destination volumes in a set of loadsharing mirrors do not have individual property settings.
Changes made by the snapmirror modify command do not take effect until the
next manual or scheduled update of the SnapMirror relationship. Changes do not affect
updates that have started and have not finished yet.
The snapmirror modify command must be used from the destination Vserver or
cluster.
Parameters
of "8.2 and above".
783
Path
specified.
784
If this optional parameter is specified, designates the managing Vserver. The managing
Vserver is authorized to use some snapmirror commands to manage the SnapMirror
relationship. The -vserver option is currently a reserved option.
This optional parameter designates the name of the schedule which is used to
update the SnapMirror relationship. If you do not designate a schedule, updates are
not scheduled, so you must update the SnapMirror relationship manually using the
snapmirror update command or, in the case of a set of load-sharing mirrors, using
the snapmirror update-ls-set command.
Note:
You define and name a schedule using the job schedule cron create command.
The schedules associated with an Infinite Volume SnapMirror relationship should not
have an interval shorter than hourly.
This optional parameter designates the name of the snapmirror policy which is
"Relationship Capability" of "Pre 8.2".
Note:
This optional parameter specifies the maximum number of times to attempt each
manual or scheduled transfer for a SnapMirror relationship. The default is eight times.
The -tries parameter can be set to 0 to disable manual and scheduled updates
for the SnapMirror relationship. This parameter is only applicable to relationships
with "Relationship Capability" of "Pre 8.2". For relationships with "8.2 and above"
capability, the tries limit is controlled by the value of tries in the SnapMirror policy which
is associated with the relationship.
This optional parameter limits the network bandwidth used for transfers. It configures for
the relationship the maximum rate (in Kbytes/sec) at which data can be transferred. If
no throttle is configured, by default the SnapMirror relationship fully utilizes the network
bandwidth available. You can also configure the relationship to fully use the network
bandwidth available by explicitly setting the throttle to unlimited or 0. The minimum
785
effective throttle value is four Kbytes/sec, so if you specify a throttle value between 1
and 4, it will be treated as 4. The -throttle parameter does not affect load-sharing
mirrors and other SnapMirror relationships with "Relationship Capability" of "Pre 8.2"
confined to a single cluster.
Examples
To change the schedule to halfhour for the SnapMirror relationship with the destination
endpoint vs2.example.com:dept_eng_dp_mirror2, type the following command:
vs2.example.com::> snapmirror modify -destination-path
vs2.example.com:dept_eng_dp_mirror2 -schedule halfhour
For relationships with "Relationship Capability" of "Pre 8.2", to change the schedule
to halfhour for the SnapMirror relationship with the destination endpoint cluster2://
vs2.example.com/dept_eng_dp_mirror2, type the following command:
cluster2::> snapmirror modify -destination-path
-schedule halfhour
See Also
snapmirror update snapmirror update-ls-set job schedule cron create
snapmirror policy create snapmirror show
786
snapmirror promote
Promote the destination to read-write
Description
The snapmirror promote command performs a failover to the destination volume
of a SnapMirror relationship. This command changes the destination volume from a
read-only volume to a read-write volume and makes the destination volume assume the
identity of the source volume. The command then destroys the original source volume.
The destination volume must be a load-sharing volume. Note that you can promote a
load-sharing volume that has been left in read-write state by a previously failed promote
operation.
Client accesses are redirected from the original source volume to the promoted
destination volume. The view clients see on the promoted destination volume is the
latest transferred Snapshot copy, which might lag behind the view clients had of the
original source volume before the promote.
The SnapMirror relationship is always deleted as part of the promotion process.
It is possible that the original source volume is the source of multiple SnapMirror
relationships. For such a configuration, the promoted destination volume becomes the
new source volume of the other SnapMirror relationships.
The snapmirror promote command fails if a SnapMirror transfer is in progress
for any SnapMirror relationship with "Relationship Capability" of "Pre 8.2" involving
the original source volume. It does not fail if a SnapMirror transfer is in progress for a
relationship with "Relationship Capability" of "8.2 and above".
Parameters
787
of "8.2 and above".
Path
788

specified.
Examples
To promote a mirror named dept_eng_ls_mirror1 to be the source read-write volume for
mirroring and client access, type the following command:
cluster1::> snapmirror promote -destination-path
//vs1.example.com/dept_eng_ls_mirror1
-source-path //vs1.example.com/dept_eng -f true
See Also
snapmirror show
789
snapmirror quiesce
Disable future transfers
Description
The snapmirror quiesce command disables future transfers for a SnapMirror
relationship. If there is no transfer in progress, the relationship becomes "Quiesced".
If there is a transfer in progress, it is not affected, and the relationship becomes
"Quiescing" until the transfer completes. If the current transfer aborts, it will be treated
like a future transfer and will not restart.
If applied to a load-sharing (LS) SnapMirror relationship, all the relationships in the loadsharing set will be quiesced.
When a SnapMirror relationship is quiesced, it remains quiesced across reboots and
fail-overs.
The snapmirror quiesce command must be used from the destination Vserver or
cluster.
The relationship must exist on the destination Vserver or cluster. When issuing
snapmirror quiesce, you must specify the destination endpoint. The specification of
the source endpoint of the relationship is optional.
Parameters
of "8.2 and above".
790
Path
specified.
791
Examples
To quiesce the SnapMirror relationship with the destination endpoint
vs2.example.com:dept_eng_mirror2, type the following command:
vs2.example.com::> snapmirror quiesce -destination-path
vs2.example.com:dept_eng_mirror2
For relationships with "Relationship Capability" of "Pre 8.2", to quiesce the SnapMirror
relationship with the destination endpoint cluster2://vs2.example.com/dept_eng_mirror2,
cluster2::> snapmirror quiesce -destination-path
cluster2://vs2.example.com/dept_eng_mirror2
See Also
snapmirror show snapmirror resume
792
snapmirror release
Remove source information for a SnapMirror relationship
Description
The snapmirror release command removes the relationship information from the
source Vserver. The command also removes any Snapshot copy owner tags and any
Snapshot copies which were created for the specified relationship from the source
volume. It does not destroy any volumes. This command must be used from the source
Vserver or cluster.
You can use the snapmirror list-destinations command to display source
Vservers' relationship information. This information is populated during the first
SnapMirror transfer, not when the snapmirror create command is issued.
This command is not supported for SnapMirror relationships with the field "Relationship
The snapmirror release operation fails if a SnapMirror transfer for the SnapMirror
relationship is in a data phase of the transfer.
Parameters
Specifies the source endpoint of the SnapMirror relationship in one of two formats.
The normal format includes the names of the Vserver (vserver), and volume (volume).
A format which also includes the name of the cluster (cluster) is also provided for
consistency with other snapmirror commands. The form of the pathname which includes
the cluster name cannot be used when operating in a Vserver context.
| [-source-vserver <vserver name>] - Source Vserver
specified, parameter -source-volume must also be specified.
specified, parameter -source-vserver must also be specified.
793

Path
Specifies the destination endpoint of the SnapMirror relationship in one of two formats.
The normal format includes the names of the Vserver (vserver), and volume (volume).
A format which also includes the name of the cluster (cluster) is also provided for
consistency with other snapmirror commands. The form of the pathname which includes
the cluster name cannot be used when operating in a Vserver context.
| -destination-vserver <vserver name> - Destination Vserver
specified, parameter -destination-volume must also be specified.
Specifies the destination volume of the SnapMirror relationship. If this parameter is
specified, parameter -destination-vserver must also be specified.
[-relationship-info-only [true]] - Remove relationship info only (skip cleanup of
snapshots)
If this parameter is specified, the cleanup of Snapshot copies is bypassed and only the
source relationship information is removed. It is recommended to specify this parameter
only when the source volume is not accessible.
This optional parameter specifies the relationship identifier of the relationship. It must
be specified when information for more than one relationship with the same source and
destination paths is present.
Examples
To release the source information for the SnapMirror relationship with the destination
endpoint vs2.example.com:dept_eng_dp_mirror4, type the following command:
vs1.example.com::> snapmirror release
-destination-path vs2.example.com:dept_eng_dp_mirror4
To release the source information for the SnapMirror relationship with the
destination endpoint vs2.example.com:dept_eng_dp_mirror4, and relationship-id
5f91a075-6a72-11e1-b562-123478563412, type the following command:
794
vs1.example.com::> snapmirror release

-destination-path vs2.example.com:dept_eng_dp_mirror4
-relationship-id 5f91a075-6a72-11e1-b562-123478563412
See Also
snapmirror list-destinations snapmirror create snapmirror show
795
snapmirror restore
Restore a Snapshot copy from a source volume to a destination volume
Description
The snapmirror restore command restores the entire contents of a Snapshot copy
or one or more files or LUNs of a Snapshot copy from one volume to another volume.
The source of the restore can be a volume that is:
the destination volume of a extended data protection (XDP) relationship
the destination volume of a data protection (DP) relationship with "Relationship
Capability" of "8.2 and above"
a data-protection volume which is not the destination endpoint of any SnapMirror
relationship
a read-write volume.
The following volumes cannot be used as either the source nor destination volume of a
restore:
a volume that is the source or destination endpoint of a SnapMirror load-sharing
relationship.
a volume that is the destination endpoint of a SnapMirror relationship with the
"Relationship Capability" of "Pre 8.2".
an Infinite Volume.
A SnapMirror relationship of type RST is created from the source volume to the
destination volume by the snapmirror restore command. This relationship lasts
for the duration of the restore operation and is deleted when the command completes
successfully.
The following paragraphs describe the behavior when restoring the entire contents of a
Snapshot copy to a destination volume.
By default the snapmirror restore will copy the latest Snapshot copy from the
source volume to the destination volume. A specific Snapshot copy can be selected with
the -source-snapshot parameter.
796
Any quota rules defined for the destination volume are deactivated prior to restoring
the entire contents of a Snapshot copy. Run the command volume quota modify
-vserver destination-volume-vserver -volume destination-volume-name -state
on to reactivate quota rules after the entire contents of the Snapshot copy have been
restored.
If the destination volume is an empty data protection volume, the snapmirror
restore command performs a baseline restore. For a baseline restore the following
steps are performed:
Create the RST SnapMirror relationship.
The entire contents of the Snapshot copy selected to be restored are copied to
the active file system of the destination volume.
The destination volume is made read-write.
The RST SnapMirror relationship is deleted.
If the destination volume is a read-write volume, an incremental restore is performed.
The incremental restore fails if it cannot find a common Snapshot copy between the
source and destination volumes. Restoring a Snapshot copy to an empty read-write
volume is not supported.
An incremental restore preserves all Snapshot copies on the destination volume but
does not preserve changes to the active file system since the latest Snapshot copy.
To preserve changes to the destination volume since the latest Snapshot copy use the
volume snapshot create command. Restore is a disruptive operation so client
access of the destination volume is not advised for the duration of the operation.
For an incremental restore the following steps are performed:
The active file system of the destination volume is reverted to the latest Snapshot
copy on the destination volume and the destination volume is made read-only.
This Snapshot copy is the exported Snapshot copy and it is the view to which
clients are redirected when accessing the destination volume.
The contents of the Snapshot copy selected to be restored are copied to the
active file system of the destination volume.
If snapmirror restore fails or is aborted, the RST relationship remains. Use the
snapmirror show command with the destination volume name to display the reason
797
for the error. An EMS is also generated when a failure occurs. There are two options to
recover when restore fails or is aborted:
Take corrective action suggested by the EMS and reissue the original command.
Use the original command with -clean-up-failure to cancel the request.
When specifying -clean-up-failure to cancel an incremental restore request, the
following steps are performed:
If the Snapshot copy has not been restored to the destination volume, all data
copied to the active file system by snapmirror restore to the destination
volume is reverted.
When specifying -clean-up-failure to cancel a baseline restore request, the
following steps are performed:
If the Snapshot copy has been restored to the destination volume, the volume is
made read-write.
The following paragraphs describe the behavior and requirements when restoring one or
more files or LUNs to the destination volume.
The destination volume must be a read-write volume. Restoring files or LUNs to a
data protection volume is not supported. When restoring files or LUNs the source and
destination volumes are not required to have a common Snapshot copy. If a common
Snapshot copy exists, an incremental restore is performed for those files or LUNs being
restored which exist in the common Snapshot copy.
The contents of the files or LUNs to which data is being restored on the destination
volume are not preserved by this command. To preserve the contents of the destination
files or LUNs, create a Snapshot copy on the destination volume prior to running this
command. Client I/O is not allowed to a file or LUN to which data is being restored on
the destination volume.
The -source-snapshot parameter is required when restoring files or LUNs. It
identifies the Snapshot copy on the source volume from which the files or LUNs to be
restored are copied. If all files or LUNs to be restored do not exist in this Snapshot copy
the command fails.
The source path for each file or LUN being restored is required. The source path of a
file or LUN is from the root of the source Snapshot copy of the source volume. The file
is restored to the same path on the destination volume unless an optional destination
798
path is specified. The destination path is from the root of the destination volume. If a file
or LUN to which data is being restored on the destination volume does not exist, the
file or LUN is created. If any directory in the path of the file or LUN being restored does
not exist on the destination volume, the command fails. Overwriting the contents of an
existing file with the contents of a different file or overwriting the contents of an existing
LUN with the contents of a different LUN is supported. Overwriting a file with a LUN or a
LUN with a file is not supported. Client I/O is not allowed to all files and LUNs to which
data is being restored on the destination volume.
If quota rules have been defined for the destination volume, resource usage is updated
during file restore, but limits of quota rules are not enforced. Therefore, resource limits
might be exceeded during a file restore.
Multiple concurrent snapmirror restore commands, restoring one or more files or
LUNs to the same destination volume, are not supported. The destination volume of
a snapmirror restore to which one or more file or LUNs are being restored, can
simultaneously be the source volume of a snapmirror update.
For a file or LUN restore the following steps are performed:
If any file or LUN being restored does not exist on the destination volume, create
all such files or LUNs.
Prevent client I/O to files or LUNs to which data is being restored on the
destination volume.
Revoke locks and space reservations held by NAS clients for files being restored.
Copy the contents of all source files or LUNs to the corresponding file or LUN on
the destination volume.
Allow client I/O to files or LUNs to which data has been restored on the
destination volume.
Delete the RST SnapMirror relationship.
Note:
Some file restore operations require a Snapshot copy to be created. This Snapshot copy
is temporary, it is deleted before the operation completes.
Since client I/O is not allowed to files or LUNs being restored, client I/O to files or LUNs
being restored should be quiesced. Mapped LUNs remain mapped throughout the
operation. SAN clients do not need to rediscover a mapped LUN that has been restored.
If snapmirror restore fails or is aborted, the RST relationship remains. Use the
snapmirror show command with the destination volume to display the reason for the
799
error. An EMS is also generated when a failure occurs. There are two options to recover
when restore fails or is aborted:
Take corrective action suggested by the EMS and reissue the original command.
Use snapmirror restore -clean-up-failure along with specifying the
destination volume to cancel the request.
When specifying -clean-up-failure to cancel a file restore request, the following
steps are performed:
Any files to which Client I/O is not allowed are removed.
Any Snapshot copy created for use during a file restore operation is deleted.
Note:
LUNs to which Client I/O is not allowed remain. For LUNs to which client I/O is not
allowed, do one of the following:
Use the snapmirror restore command to restore data to the LUN. Once the
command completes successfully, client I/O to the LUN is allowed.
Delete the LUN using the lun delete command with the -force-fenced
parameter.
The snapmirror restore command must be used from the destination Vserver or
cluster.
Parameters
Specifies the source endpoint in one of two formats. The basic format includes the
names of the Vserver (vserver) and volume (volume). A format which also includes
the name of the cluster (cluster) is supported for consistency with other snapmirror
commands. The form of the pathname which includes the cluster name is not valid when
operating in a Vserver context.
Specifies the cluster in which the source volume resides. This parameter is not needed;
it is provided for consistency with other snapmirror commands. If this parameter is
specified, the -source-vserver and -source-volume parameters must also be
specified. This parameter is not valid when operating in a Vserver context.
800

specified, the -source-volume parameter must also be specified.
specified, the -source-vserver parameter must also be specified.
Path
Specifies the destination endpoint in one of two formats. The basic format includes
the names of the Vserver (vserver) and volume (volume). A format that also includes
the name of the cluster (cluster) is supported for consistency with other snapmirror
commands. The form of the pathname which includes the cluster name is not valid when
operating in a Vserver context.
Specifies the cluster in which the destination volume resides. This parameter is not
needed; it is provided for consistency with other snapmirror commands. If this
parameter is specified, the -destination-vserver and -destination-volume
parameters must also be specified. This parameter is not valid when operating in a
Vserver context. This parameter is only applicable for relationships with "Relationship
Specifies the destination Vserver. If this parameter is specified, the -destinationvolume parameter must also be specified.
Specifies the destination volume. If this parameter is specified, the -destinationvserver parameter must also be specified.
When restoring the entire contents of a Snapshot copy, this optional parameter identifies
the Snapshot copy to be restored from the source volume to the destination volume.
The default value is the latest snapshot on the source volume. When restoring one or
more files or LUNs from a Snapshot copy, this parameter is required.
This optional parameter limits the network bandwidth used for the restore transfer when
the source and destination volumes belong to different clusters. It sets the maximum
rate (in Kbytes/sec) at which data can be transferred between the clusters during the
801
operation. To specify fully using the network bandwidth available between the clusters,
set the throttle value to unlimited or 0. The minimum throttle value is four Kbytes/sec, so
if you specify a throttle value between 1 and 4, it will be treated as if you specified 4.
value for this parameter is normal.
[-disable-storage-efficiency [true]] - Disable Storage Efficient Transfer
The default behavior of restore is to preserve storage efficiency when possible. Use this
optional parameter to turn off storage efficiency for data transferred over the wire and
written to the destination volume.
[-clean-up-failure [true]] - Clean up after Failure
Use this optional parameter to recover from an aborted or failed restore operation. Any
temporary RST relationship is removed from the destination Vserver. An attempt is
made to remove any temporary RST relationship from the source Vserver. If cleaning
up an incomplete restore of the entire contents of a Snapshot copy and the destination
volume was read-write prior to the failed or aborted restore operation, it is converted
back to read-write if necessary, while removing all data transferred or copied during the
restore operation. If cleaning up an incomplete restore of one or more files or LUNs of a
Snapshot copy, any file to which client I/O is not allowed is deleted.
Specifies the total number of attempts to transfer data in cases where a transfer is
interrupted by an error that SnapMirror can recover from. The value of this parameter
must be a positive integer or unlimited.
[-file-list <<source path>[,@<destination path>]>, ...] - File List
Specifies the files or LUNs to be restored. The list can contain specifications for up
to 8 files or LUNs. Specification for each file or LUN consists of a source_path and
an optional destination_path, and is of the form 'source_path[,@destination_path]'.
source_path is required and is the path of the file from the source Snapshot copy,
e.g. /dira/file1 or /lun1. The source path does not include the Snapshot name nor the
source volume name. The path to each file to be restored in the active file system of the
destination volume is the same as the path specified by source_path, unless an optional
destination_path is specified. destination_path begins with the @ symbol followed by
the path of the file from the root of the active file system of the destination volume, e.g.
@/file1 or @/dira/lun1. Each source_path and destination_path is a separate entity in
the list of paths. A destination_path is associated with the source_path that immediately
802
precedes it. If this parameter is specified, -source-snapshot must also be specified.

Examples:
/dira/file1
/dira/file1,@/dirb/file2
/dira/file1,@/dirb/file2,/dirc/file3
[-use-network-compression [true]] - Use Network Compression

Use this optional parameter to use network compression for data transfer over the wire.
Examples
The following example does an incremental restore between the restore source
volume vs2.example.com:dept_eng_dp_mirror2 and the restore destination volume
vs1.example.com:dept_eng:
vs1.example.com::> snapmirror restore
-destination-path vs1.example.com:dept_eng
-source-path vs2.example.com:dept_eng_dp_mirror2
-source-snapshot snap3
Warning: All data newer than Snapshot copy snap6 on volume
vs1.example.com:dept_eng will be deleted.
[Job 34] Job is queued: snapmirror restore from source
vs2.example.com:dept_eng_dp_mirror2 for the snapshot snap3.
vs1.example.com::>
The following example restores /file3 from the source Snapshot copy snap3 on the
source volume vs2.example.com:dept_eng_dp_mirror2 to the active file system of the
restore destination volume vs1.example.com:dept_eng:
-file-list /file3
Warning: This command will overwrite any file on destination
"vs1.example.com:dept_eng" that has the same path as any of
the files to be restored.
803

"vs2.example.com:dept_eng_dp_mirror2" for the snapshot snap3.
vs1.example.com::>
The following example restores /file3 from the source Snapshot copy snap3 on the
source volume vs2.example.com:dept_eng_dp_mirror2 to /file3.new in the active file
system of the restore destination volume vs1.example.com:dept_eng:
-file-list /file3,@/file3.new
vs1.example.com::>
The following example restores /file1, /file2, and /file3 from the source Snapshot copy
snap3 on the source volume vs2.example.com:dept_eng_dp_mirror2 respectively to /
file1.new, /file2, and /file3.new in the active file system of the restore destination volume
vs1.example.com:dept_eng:
-file-list /file1,@/file1.new,/file2,/file3,@/file3.new
vs1.example.com::>
See Also
804
snapmirror snapmirror check snapshot restore volume snapshot restore

volume clone snapmirror break volume quota modify volume snapshot create
snapmirror show snapmirror update lun delete volume show-space
805
snapmirror resume
Enable future transfers
Description
The snapmirror resume command enables future transfers for a SnapMirror
relationship that has been quiesced.
If there is a scheduled transfer for the relationship, it will be triggered on the next
schedule. If there is a restart checkpoint, it will be re-used if possible.
If applied on a load-sharing (LS) SnapMirror relationship, it enables future transfers for
all the relationships in the load-sharing set.
When a quiesced SnapMirror relationship is resumed, future transfers remain enabled
across reboots and fail-overs.
The snapmirror resume command must be used from the destination Vserver or
cluster.
The relationship must exist on the destination Vserver or cluster. When issuing
snapmirror resume, you must specify the destination endpoint. The specification of
the source endpoint of the relationship is optional.
Parameters
of "8.2 and above".
806
Path
specified.
807
Examples
To re-enable future transfers for the SnapMirror relationship with the destination
endpoint vs2.example.com:dept_eng_dp_mirror2 that has been previously quiesced,
vs2.example.com::> snapmirror resume -destination-path
To re-enable future transfers for the SnapMirror relationship with the destination
endpoint cluster2://vs2.example.com/dept_eng_dp_mirror2 that has been previously
quiesced, type the following command:
cluster2::> snapmirror resume -destination-path
See Also
snapmirror show snapmirror quiesce
808
snapmirror resync
Start a resynchronize operation
Description
The snapmirror resync command establishes or reestablishes a mirroring
relationship between a source volume and a destination volume, typically in the
following cases:
The destination mirror is broken (that is, the destination volume is a read-write
volume and no longer a data protection mirror). After the snapmirror resync
command completes, the destination volume is made a data protection mirror and
the mirror can be manually updated or scheduled for updates.
snapmirror update command failed because the required common Snapshot
copy was deleted on the source volume.
The volumes are the first and third endpoints in a cascade chain of relationships
and they have a common Snapshot copy. In this case, snapmirror resync
may implicitly create the SnapMirror relationship between them.
Attention:
The snapmirror resync command can cause data loss on the destination volume
because the command can remove the exported Snapshot copy on the destination
volume.
The default behavior of the snapmirror resync command is defined as follows:
Finds the most recent common Snapshot copy between the source and
destination volumes, removes Snapshot copies on the destination volume that are
newer than the common Snapshot copy and mounts the destination volume as a
DP volume with the common Snapshot copy as the exported Snapshot copy.
For data protection (DP) relationships, takes a Snapshot copy of the source
volume to capture the current image and transfers Snapshot copies that are
newer than the common Snapshot copy from the source volume to the destination
volume. For extended data protection (XDP) relationships, transfers Snapshot
copies newer than the common Snapshot copy according to the relationship
policy, i.e., Snapshot copies will match rules associated with the policy as defined
809
by the snapmirror policy commands. For relationships associated with

snapmirror policy of type async-mirror and mirror-vault the snapmirror
resync first takes a Snapshot copy of the source volume and includes it in the
Snapshot copies selected for transfer.
The snapmirror resync command supports an optional parameter "preserve".
The parameter "preserve" is only supported for extended data protection (XDP)
relationships. When used, the parameter "preserve" changes the behavior of
snapmirror resync command. Changed behavior of the command can be described
as follows:
Finds the most recent common Snapshot copy between the source and
destination volumes, preserves all Snapshot copies on the destination volume that
are newer than the common Snapshot copy, and mounts the destination volume
as a DP volume with the common Snapshot copy as the exported Snapshot copy.
Performs a local rollback transfer to make a copy of the common Snapshot
copy on the destination volume and establish it as the latest Snapshot copy
on the destination volume. The command then transfers all Snapshot copies
that are newer than the common Snapshot copy, from the source volume to the
destination volume. The command only transfers Snapshot copies that match the
relationship's policy, i.e., Snapshot copies will match rules associated with the
policy as defined by the snapmirror policy commands.
If a SnapMirror relationship does not already exist, that is, the relationship was not
created using the snapmirror create command, the snapmirror resync
command will implicitly create the SnapMirror relationship, with the same behaviors as
described for the snapmirror create command before resyncing it.
For Infinite Volumes, you must create Infinite Volume SnapMirror relationships using
the snapmirror create command before you run the snapmirror resync command. The
snapmirror resync command does not implicitly create the SnapMirror relationship.
show commands.
810
The snapmirror resync command fails if the destination volume does not have a
Snapshot copy in common with the source volume.
The snapmirror resync command does not work on load-sharing mirrors.
The snapmirror resync command must be used from the destination Vserver or
cluster.
Parameters
of "8.2 and above".
Path
811

specified.
This optional parameter specifies a Snapshot copy to transfer. The default behavior for a
data protection relationship with a read-write source is that Data ONTAP creates a new
Snapshot copy and uses it as the basis for determining what data are replicated; with
this option, the specified Snapshot copy will be used instead. The default behavior for
an extended data protection relationship depends on the relationship's policy type. For a
data protection relationship, the specified Snapshot copy must be newer than the latest
common Snapshot copy. For an extended data protection relationship, the specified
Snapshot copy may be newer or older than the common Snapshot copy. This parameter
is not supported for relationships with "Relationship Capability" of "Pre 8.2".
[-type <snapmirrorType>] - Snapmirror Relationship Type
Specifies the type of SnapMirror relationship if a relationship is implicitly created. The
default is data protection (DP).
"Relationship Capability" of "Pre 8.2". This parameter is not supported by this operation
Note:
812
This optional parameter limits the network bandwidth used for the resync transfer.
[-preserve [true]] - Preserve
This parameter is only supported for extended data protection (XDP) relationships. It
is not supported for data protection and load-sharing relationships. When specified,
it changes the behavior of snapmirror resync to preserve Snapshot copies on
the destination volume that are newer than the latest common Snapshot copy. This
parameter is not supported for relationships with "Relationship Capability" of "Pre 8.2".
This option is not supported for Infinite Volume SnapMirror relationships.
[-quick-resync [true]] - Quick Resync
This parameter is only supported for extended data protection (XDP) relationships.
Specifying this optional parameter reduces the resync time because the resync does
not incur storage efficiency overhead before the transfer of new data. Specifying this
parameter is recommended if the source of the resync does not have volume efficiency
enabled or if reducing resync time is more important than preserving all possible storage
efficiency. When this parameter is specified, resync does not preserve the storage
efficiency of the new data with existing data over the wire and on the destination.
813
Examples
To reestablish mirroring for the destination endpoint vs2.example.com:dept_mkt_mirror
that has been previously broken off with the snapmirror break command, type the
following command:
vs2.example.com::> snapmirror resync -destination-path
vs2.example.com:dept_mkt_dp_mirror
For relationships with "Relationship Capability" of "Pre 8.2", to reestablish mirroring

for the destination endpoint cluster2://vs2.example.com/dept_mkt_mirror that has
been previously broken off with the snapmirror break command, type the following
command:
cluster2::> snapmirror resync -destination-path
cluster2//vs2.example.com/dept_mkt_dp_mirror
To create a SnapMirror relationship and reestablish mirroring between the destination

endpoint named vs2.example.com:dept_eng_dp_mirror2 and the source endpoint
named vs1.example.com:dept_eng, type the following command:
vs2.example.com::> snapmirror resync -destination-path
-source-path vs1.example.com:dept_eng
To create a SnapMirror relationship and reestablish mirroring between the destination

endpoint named cluster2://vs2.example.com/dept_eng_dp_mirror2 and the source
endpoint named cluster1://vs1.example.com/dept_eng when the source cluster is
running Data ONTAP 8.1 software, type the following command:
cluster2::> snapmirror resync -destination-path
-source-path cluster1://vs1.example.com/dept_eng
See Also
snapmirror policy create snapmirror create snapmirror modify snapmirror update
snapmirror policy snapmirror show job show job history show snapmirror break
814
snapmirror set-options
Display/Set SnapMirror options
level.
Description
The snapmirror set-options command can be used to display or set snapmirror
options. This command is not supported for Infinite Volume SnapMirror relationships.
Parameters
[-dp-source-xfer-reserve-pct {0|25%|50%|75%|100%}] - Percentage Reserved for DP
Source Transfers
Specifies the percentage of maximum allowed concurrent transfers reserved for source
DP transfers
[-xdp-source-xfer-reserve-pct {0|25%|50%|75%|100%}] - Percentage Reserved for
XDP Source Transfers
Specifies the percentage of maximum allowed concurrent transfers reserved for source
XDP transfers
[-dp-destination-xfer-reserve-pct {0|25%|50%|75%|100%}] - Percentage Reserved for
DP Destination Transfers
Specifies the percentage of maximum allowed concurrent transfers reserved for
destination DP transfers
[-xdp-destination-xfer-reserve-pct {0|25%|50%|75%|100%}] - Percentage Reserved
for XDP Destination Transfers
Specifies the percentage of maximum allowed concurrent transfers reserved for
destination XDP transfers
Examples
The following example displays SnapMirror options:
cluster1::> snapmirror set-options
Percentage Reserved for DP Source Transfers:
Percentage Reserved for XDP Source Transfers:
815
Percentage Reserved for DP Destination Transfers:
Percentage Reserved for XDP Destination Transfers:
cluster1::> snapmirror set-options -dp-source-xfer-reserve-pct 25

-xdp-source-xfer-reserve-pct 50
-dp-destination-xfer
reserve-pct 0 -xdp-destination-xfer-reserve-pct 50
cluster1::> snapmirror set-options
Percentage Reserved for DP Source Transfers:
25
Percentage Reserved for XDP Source Transfers:
50
Percentage Reserved for DP Destination Transfers:

Percentage Reserved for XDP Destination Transfers:
816
0
50
snapmirror show-history
Displays history of SnapMirror operations.
Description
The snapmirror show-history command displays history of the SnapMirror
operations. By default, the command displays the following information:
Destination Path
Source Path
Operation
Start Time
End Time
Result
The snapmirror show-history command displays - in reverse chronological
order - the history of completed SnapMirror operations whose destination endpoints
are in the current Vserver for Vserver administrators, or the current cluster for cluster
administrators. This command does not return information about operations which
happened prior to installing Data ONTAP 8.3. Also, it does not return information for
relationships with the "Relationship Capability" field, as shown in the output of the
snapmirror show command, set to "Pre 8.2".
The -instance parameter displays the following detailed information:
Destination Path: Path of the destination endpoint.
Source Path: Path of the source endpoint.
Relationship ID: The unique identifier of the relationship.
Relationship Group Type: For FlexVol relationships, specifies the
type of the group relationship that
includes this FlexVol. For group
relationships, specifies the type of the
group relationship. Can be one of the
following:
- none: No group relationship.
817
- vserver: Vserver relationship.

- infinitevol: Infinite Volume
relationship.
Operation: Type of the operation.
May be one of the following:
- create
- modify
- quiesce
- resume
- delete
- initialize
- manual update
- scheduled update
- break
- resync
- abort
- restore
Operation ID: The unique identifier of the operation.
Start Time: Timestamp of the start of the operation.
End Time: Timestamp of the end of the operation.
Result: Result of the SnapMirror operation.
- success
- failure
Transfer Size: Total amount of data transferred during the
SnapMirror operation.
Additional Information: A message describing the cause of the
failure or additional information about a
successful operation such as if a checkpoint
was cleared as part of an abort operation.
Parameters
specify.
| [-instance ] }
818
about all fields.
Path
Select SnapMirror operations that have a matching destination path name.
| [-destination-vserver <vserver name>] - Destination Vserver
Select SnapMirror operations that have a matching destination Vserver name.
Select SnapMirror operations that have a matching destination volume name.
[-operation-id <UUID>] - Operation ID
Select SnapMirror operations that have a matching operation ID.
[-source-path {<[vserver:]volume>|<[[cluster:]//vserver/]volume>}] - Source Path
Select SnapMirror operations that have a matching source path name.
Select SnapMirror operations that have a matching source Vserver name.
[-source-volume <volume name>] - Source Volume
Select SnapMirror operations that have a matching source volume name.
[-operation-type {create|modify|quiesce|resume|delete|initialize|manual-update|
scheduled-update|break|resync|abort|restore}] - Operation Type
Select SnapMirror operations that have a matching operation type. Possible values are:
create
modify
quiesce
resume
delete
initialize
manual-update
scheduled-update
break
819
resync
abort
restore
Select SnapMirror operations that have a matching start time.
Select SnapMirror operations that have a matching end time.
Select SnapMirror operations that have a matching relationship ID.
Select SnapMirror relationships that have a matching relationship group type. Possible
values are:
none
infinitevol
[-result {success|failure}] - Result of the Operation
Select SnapMirror operations that have a matching result. Possible values are:
success
failure
[-transfer-size {<integer>[KB|MB|GB|TB|PB]}] - Transfer Size
Select SnapMirror operations that have a matching transfer size.
[-additional-info <text>] - Additional Information
Select SnapMirror operations that have a matching additional information.
[-max-rows-per-relationship <integer>] - Maximum Number of Rows per Relationship
Select matching number of SnapMirror operations per relationship.
Examples
The example below displays summary information for all SnapMirror operations on
relationships with destination endpoints in the current cluster:
820
cluster2::> snapmirror show-history

Destination Source
Path
Start
Path
Operation Time
End
Time
Result
----------- ----------- --------- ----------- ----------- ------vs1:vol1
vs1:aggr1
manual-update
8/15/2013 08:22:44
8/15/2013 08:22:44
failure
vs1:vol1
vs1:aggr1
initialize
8/15/2013 08:22:25
8/15/2013 08:22:26
success
vs1:vol1
vs1:aggr1
create
8/15/2013 08:22:15
8/15/2013 08:22:16
success
vs1:vol2
vs1:aggr1
initialize
8/15/2013 08:23:23
8/15/2013 08:23:23
failure
vs1:vol2
vs1:aggr1
create
8/15/2013 08:23:10
8/15/2013 08:23:10
success
The example below displays detailed information for the SnapMirror operation with
operation ID dc158715-0583-11e3-89bd-123478563412
cluster2::> snapmirror show-history -operation-id
dc158715-0583-11e3-89bd-123478563412
Destination Path: vs1:vol1
Source Path: vs1:aggr1
Relationship ID: cb3d30a0-0583-11e3-89bd-123478563412
Operation: manual-update
Operation ID: dc158715-0583-11e3-89bd-123478563412
Start Time: 8/15/2013 08:22:44
End Time: 8/15/2013 08:22:44
Result: failure
Transfer Size: Additional Information: Volume vs1:vol1 is restricted. Use the command
"volume online" to bring the volume online.
821
The example below displays detailed information for all SnapMirror operations on
relationships with the Result of "success" and whose destination endpoints are in the
current cluster.
cluster2::> snapmirror show-history -result success -instance
Destination Path: vs1:vol1
Operation: initialize
Operation ID: d03ce1db-0583-11e3-89bd-123478563412
Start Time: 8/15/2013 08:22:25
End Time: 8/15/2013 08:22:26
Result: success
Transfer Size: 1.09MB
Additional Information: Destination Path: vs1:vol1
Operation: create
Operation ID: cb3d305d-0583-11e3-89bd-123478563412
Start Time: 8/15/2013 08:22:15
End Time: 8/15/2013 08:22:16
Result: success
Transfer Size: Additional Information: Destination Path: vs1:vol2
Relationship ID: eb92c549-0583-11e3-89bd-123478563412
Operation: create
Operation ID: eb92c506-0583-11e3-89bd-123478563412
Start Time: 8/15/2013 08:23:10
End Time: 8/15/2013 08:23:10
Result: success
Transfer Size: Additional Information: -
822
The example below displays summary information for all SnapMirror operations on
relationships with max-rows-per-relationship of 1 and whose destination endpoints are in
the current cluster.
cluster2::> snapmirror show-history -max-rows-per-relationship 1
Destination Source
Path
Path
Start
Operation Time
End
Time
Result
----------- ----------- --------- ----------- ----------- ------vs1:vol1
vs1:aggr1
manual-update
8/15/2013 08:22:44
8/15/2013 08:22:44
failure
vs1:vol2
vs1:aggr1
initialize
8/15/2013 08:23:23
8/15/2013 08:23:23
failure
823
snapmirror show
Display a list of SnapMirror relationships
Description
The snapmirror show command displays information associated with SnapMirror
relationships. By default, the command displays the following information:
Source path
Relationship Type
Destination Path
Mirror State
Relationship Status
Total Progress
Healthy
Progress Last Updated
For backward compatibility with clustered Data ONTAP 8.1, and to accommodate loadsharing relationships which are only supported in a Data ONTAP 8.1 compatible way,
SnapMirror relationships, which match one of the following conditions are managed
as on clustered Data ONTAP 8.1: (1) The relationship is of type load-sharing; (2) The
source endpoint of the relationship is on a remote Data ONTAP 8.1 cluster; (3) The local
cluster was upgraded from clustered Data ONTAP 8.1, the relationship was created
before the upgrade, and the relationship has not yet been converted to one with Data
ONTAP 8.2 capabilities. These relationships have the same limitations as on clustered
Data ONTAP 8.1. Especially, they support the same set of information fields. The
"Relationship Capability" field is set to "Pre 8.2" for these relationships.
The snapmirror show command displays information for SnapMirror relationships
whose destination endpoints are in the current Vserver if you are in a Vserver context,
or in the current cluster if you are in a cluster context. For backward compatibility with
clustered Data ONTAP 8.1, the command also displays information for SnapMirror
relationships with the "Relationship Capability" of "Pre 8.2", and whose source
endpoints are in the current Vserver or cluster, and destination endpoints are in different
Vservers or clusters. You must use the snapmirror list-destinations command
824
to display information for SnapMirror relationships whose source endpoints are in the
current Vserver or current cluster.
Some of the SnapMirror relationship information is cached. The snapmirror show
command only returns the cached information, therefore there is a delay after the
information is changed before it is reflected in the snapmirror show output. Other
information, such as progress metrics during a transfer, is only updated periodically and
can be very delayed in the snapmirror show output.
The -instance and -fields parameters are mutually exclusive and select the
information fields that are displayed. The other parameters to the snapmirror show
command select the SnapMirror relationships for which information is displayed. The instance displays detailed information fields including:
Source Path: Path of the source endpoint.
Destination Path: Path of the destination endpoint.
Relationship Type: Type of the SnapMirror relationship. May be
one of the following:
- DP: Data protection relationship.
- LS: Load-sharing relationship.
- XDP: Extended data protection relationship.
- RST: Temporary relationship created
during a restore operation, and
deleted if the operation completes
successfully.
- TDP: 7-mode to clustered Data ONTAP
transition data protection
relationship.
Relationship Group Type: For FlexVol relationships, specifies the
type of the group relationship that includes
this FlexVol. For group relationships,
specifies the type of the group
relationship. Can be one of the following:
- none: No group relationship.
- infinitevol: Infinite Volume relationship.
Only for relationships with
"Relationship Capability"
of "8.2 and above".
Relationship Status: Status of the SnapMirror relationship.
- Idle: No transfer operation is in
progress and future transfers are
825
not disabled.
- Queued: A transfer operation has been
accepted and queued in the system,
and future transfers are not
disabled.
- Transferring: A transfer operation is in
not disabled.
- Preparing: Pre-transfer phase for
Vault incremental transfers.
For Vault relationships only.
- Finalizing: Post-transfer phase for
Vault incremental transfers.
Network traffic will be low as
processing is primarily on the
destination volume.
For Vault relationships only.
- Aborting: A transfer abort operation
that may include the removal of the
checkpoint is underway. Future
transfers are not disabled. Only
for relationships with
of "8.2 and above".
- Quiesced: No transfer operation is in
disabled.
- Quiescing: A transfer operation is in
progress and future transfers
are disabled.
- Checking: Destination volume is
undergoing a diagnostic check,
no transfer is in progress, and
future transfers are not disabled.
of "Pre 8.2".
- Breaking: The SnapMirror relationship is
being broken off and no transfer is
in progress.
Mirror State: State of the destination volume. May be one
826
of the following:
- Uninitialized: Destination volume has not
been initialized.
- Snapmirrored: Destination volume has been
initialized and is ready to
receive SnapMirror updates.
- Broken-off: Destination volume is RW
and snapshots are present.
Healthy: Condition of the relationship. May be one of
the following:
- true: The SnapMirror relationship is
healthy. It has not missed a
scheduled transfer, or experienced
a manual update failure.
- false: The SnapMirror relationship is not
healthy. It has missed a scheduled
transfer, or has experienced a manual
update failure.
Unhealthy Reason: Reason the SnapMirror relationship is not
healthy. Only for relationships with
of "8.2 and above"
Newest Snapshot: Name of the newest Snapshot copy on the
destination volume.
Newest Snapshot Timestamp: Timestamp of the newest Snapshot copy.
Exported Snapshot: Name of the exported Snapshot copy on the
destination volume.
Exported Snapshot Timestamp: Timestamp of the exported Snapshot copy.
Lag Time: Time since the exported Snapshot copy
was created. It is displayed in the
format: hours:minutes:seconds.
of "8.2 and above".
Transfer Type: Type of the current transfer operation.
- initialize
- update
- resync
- restore
827

of "8.2 and above".
Transfer Snapshot: Name of the Snapshot copy being transferred.
Snapshot Progress: Amount of data transferred for the transfer
snapshot.
Total Progress: Total amount of data transferred for the
current transfer operation.
Network Compression Ratio: The compression ratio achieved for the data
sent over the wire as a part of the current
transfer operation. The ratio is not
maintained across checkpoint restarts. If
network compression is disabled for the
transfer, the ratio will be set to 1:1.
of "8.2 and above".
Snapshot Checkpoint: The amount of data transferred as recorded in
the restart checkpoint of the current or most
recent transfer snapshot. If a restart
checkpoint is present the next transfer will
continue from the checkpoint.
Transfer Error: Possible transient error condition if any,
encountered by the current transfer
operation.
of "8.2 and above".
Current Throttle: The maximum transfer rate in Kilobytes
per second, used for the current transfer
between clusters.
of "8.2 and above".
Current Transfer Priority: Priority assigned to the current transfer.
Possible values are:
- low
- normal
of "8.2 and above".
828
Last Transfer Type: Type of the previous transfer operation:

- initialize
- update
- resync
- restore
of "8.2 and above".
Last Transfer Size: Total amount of data transferred during the
previous transfer operation if it was
successful.
of "8.2 and above".
Last Transfer Network Compression Ratio: The compression ratio achieved
for the data sent over the wire as a part of
the previous transfer operation. If network
compression was disabled for the transfer,
the ratio will be set to 1:1.
of "8.2 and above".
Last Transfer Duration: Duration of the previous transfer
operation if it was successful.
of "8.2 and above".
Last Transfer From: Source endpoint of the previous transfer
operation.
of "8.2 and above".
Last Transfer End Timestamp: Timestamp of the end of the previous
transfer operation.
of "8.2 and above".
Last Transfer Error: Cause of the failure of the previous
transfer operation.
829
of "8.2 and above".
Relationship Capability: Management and control compatibility:
- "Pre 8.2": Management and control of
the relationship is compatible with
clustered Data ONTAP 8.1.
- "8.2 and above": Full support of clustered
Data ONTAP 8.2 or later SnapMirror
relationship management and control.
Relationship ID: The unique identifier of the relationship.
of "8.2 and above".
Current Operation ID: Operation unique identifier of the currently
executing SnapMirror operation.
of "8.2 and above".
Throttle (KB/sec): Configured maximum transfer rate for
cross-cluster transfers.
SnapMirror Policy Type: Type of the SnapMirror policy associated
with the relationship. May be one of the
following:
- async-mirror
- vault
- mirror-vault
Refer to the man page for the snapmirror
policy create command for a description
of what these types mean.
of "8.2 and above".
SnapMirror Policy: Name of the SnapMirror policy associated
with the relationship.
of "8.2 and above".
SnapMirror Schedule: Name of the schedule (empty if there is
no schedule) associated with the
relationship.
Tries Limit: Maximum number of times a transfer will be
830
tried.
of "Pre 8.2".
Constituent Relationship: Whether or not the SnapMirror relationship
is between Infinite Volume constituent
volumes. May be:
- true:
The relationship is between

constituent volumes.
- false: The relationship is not between

constituent volumes.
Destination Volume Node: Node which owns the destination volume
of the relationship.
of "8.2 and above".
Number of Successful Updates: The number of successful SnapMirror update
operations for the relationship.
of "8.2 and above".
Number of Failed Updates: The number of failed SnapMirror update
of "8.2 and above".
Number of Successful Resyncs: The number of successful SnapMirror resync
of "8.2 and above".
Number of Failed Resyncs: The number of failed SnapMirror resync
of "8.2 and above".
Number of Successful Breaks: The number of successful SnapMirror break
831
of "8.2 and above".

Number of Failed Breaks: The number of failed SnapMirror break
of "8.2 and above".
Total Transfer Bytes: Cumulative bytes transferred for the
relationship.
of "8.2 and above".
Total Transfer Time: Cumulative total transfer time in seconds
for the relationship.
of "8.2 and above".
Parameters
specify.
| [-instance ] }
about all fields.
Select SnapMirror relationships that have a matching source path name.
Select SnapMirror relationships that have a matching source cluster name.
Select SnapMirror relationships that have a matching source Vserver name.
Select SnapMirror relationships that have a matching source volume name.
Path
832
Select SnapMirror relationships that have a matching destination path name.

Select SnapMirror relationships that have a matching destination cluster name.
[-destination-vserver <vserver name>] - Destination Vserver
Select SnapMirror relationships that have a matching destination Vserver name.
Select SnapMirror relationships that have a matching destination volume name.
Select SnapMirror relationships that have a matching relationship type. Infinite Volumes
support only DP SnapMirror relationships. Possible values are:
DP
LS
XDP
TDP
RST
Select SnapMirror relationships that have a matching relationship group type. Possible
values are:
none
infinitevol
Select SnapMirror relationships that have a matching managing Vserver name. The vserver option is currently a reserved option.
Select SnapMirror relationships that have a matching schedule.
[-policy-type {vault|async-mirror|mirror-vault}] - SnapMirror Policy Type
Selects SnapMirror relationships that have a matching SnapMirror policy type. Possible
values are:
async-mirror
833
vault
mirror-vault
Select SnapMirror relationships that have a matching SnapMirror policy.
Select SnapMirror relationships that have a matching tries limit.
Select SnapMirror relationships that have a matching throttle.
[-current-throttle <throttleType>] - Current Transfer Throttle (KB/sec)
Select SnapMirror relationships that have a matching current throttle.
[-state <mirror state>] - Mirror State
Select SnapMirror relationships that have a matching mirror state. Possible values are:
Uninitialized
Snapmirrored
Broken-off
[-status <mirror status>] - Relationship Status
Select SnapMirror relationships that have a matching relationship status. Possible
values are:
Idle
Queued
Transferring
Preparing
Finalizing
Aborting
Quiesced
Quiescing
Checking
834
Status values Finalizing, Checking and Waiting are not supported for Infinite Volume
SnapMirror relationships.
[-file-restore-file-count <integer>] - File Restore File Count
The number of files being restored by file restore.
[-file-restore-file-list <text>, ...] - File Restore File List
List of the destination file names of the files being restored by file restore.
[-transfer-snapshot <text>] - Transfer Snapshot
Select SnapMirror relationships that have a matching transfer Snapshot copy.
[-snapshot-progress {<integer>[KB|MB|GB|TB|PB]}] - Snapshot Progress
Select SnapMirror relationships that have a matching Snapshot progress.
[-total-progress {<integer>[KB|MB|GB|TB|PB]}] - Total Progress
Select SnapMirror relationships that have a matching total progress.
[-network-compression-ratio <text>] - Network Compression Ratio
Select SnapMirror relationships that have a matching network compression ratio.
[-snapshot-checkpoint {<integer>[KB|MB|GB|TB|PB]}] - Snapshot Checkpoint
Select SnapMirror relationships that have a matching Snapshot copy checkpoint.
[-newest-snapshot <text>] - Newest Snapshot
Select SnapMirror relationships that have a matching newest Snapshot copy.
[-newest-snapshot-timestamp <MM/DD HH:MM:SS>] - Newest Snapshot Timestamp
Select SnapMirror relationships that have a matching newest Snapshot copy timestamp.
[-exported-snapshot <text>] - Exported Snapshot
Select SnapMirror relationships that have a matching exported Snapshot copy name.
For load-sharing mirror relationships, if the exported-snapshot field for a relationship has
a dash (-), the load-sharing mirror is lagging behind the up-to-date mirrors in the set.
[-exported-snapshot-timestamp <MM/DD HH:MM:SS>] - Exported Snapshot
Timestamp
Select SnapMirror relationships that have a matching exported Snapshot copy
timestamp.
[-healthy {true|false}] - Healthy
Select SnapMirror relationships that have a matching healthy condition.
835

Select SnapMirror relationships that have a matching relationship ID.
[-current-operation-id <UUID>] - Current Operation ID
Select SnapMirror relationships that have a matching operation unique identifier of the
currently executing SnapMirror operation.
[-current-transfer-type {initialize|update|resync|restore|check|file_restore}] - Transfer
Type
Select SnapMirror relationships that have a matching current transfer type. Transfer
type Check is not supported for Infinite Volume SnapMirror relationships.
[-current-transfer-error <text>] - Transfer Error
Select SnapMirror relationships that have a matching current transfer error.
[-last-transfer-type {initialize|update|resync|restore|check|file_restore}] - Last Transfer
Type
Select SnapMirror relationships that have a matching last transfer type.
[-last-transfer-error <text>] - Last Transfer Error
Select SnapMirror relationships that have a matching last transfer error.
[-last-transfer-size {<integer>[KB|MB|GB|TB|PB]}] - Last Transfer Size
Select SnapMirror relationships that have a matching last transfer size.
[-last-transfer-network-compression-ratio <text>] - Last Transfer Network
Compression Ratio
Select SnapMirror relationships that have a matching last transfer network compression
ratio.
[-last-transfer-duration <[[<hours>:]<minutes>:]<seconds>>] - Last Transfer Duration
Select SnapMirror relationships that have a matching last transfer duration.
[-last-transfer-from <text>] - Last Transfer From
Select SnapMirror relationships that have a matching last transfer source.
[-last-transfer-end-timestamp <MM/DD HH:MM:SS>] - Last Transfer End Timestamp
Select SnapMirror relationships that have a matching last transfer end timestamp.
[-unhealthy-reason <text>] - Unhealthy Reason
Select SnapMirror relationships that have a matching unhealthy reason. This option is
836
[-progress-last-updated <MM/DD HH:MM:SS>] - Progress Last Updated

Select SnapMirror relationships that have a matching progress last updated.
[-relationship-capability <text>] - Relationship Capability
Select SnapMirror relationships that have a matching relationship capability.
[-lag-time <[[<hours>:]<minutes>:]<seconds>>] - Lag Time
Select SnapMirror relationships that have a matching lag time.
[-current-transfer-priority {low|normal}] - Current Transfer Priority
Select SnapMirror relationships that have a matching current transfer priority.
[-is-smtape-op {true|false}] - SMTape Operation
Select SnapMirror relationships that have a matching smtape operation. This option is
[-is-constituent {true|false}] - Constituent Relationship
Select SnapMirror relationships that have a matching constituent condition.
[-destination-volume-node <nodename>] - Destination Volume Node Name
Select SnapMirror relationships that have a matching destination volume node name.
[-update-successful-count <integer>] - Number of Successful Updates
Select SnapMirror relationships that have a matching number of successful updates.
[-update-failed-count <integer>] - Number of Failed Updates
Select SnapMirror relationships that have a matching number of failed updates.
[-resync-successful-count <integer>] - Number of Successful Resyncs
Select SnapMirror relationships that have a matching number of successful resyncs.
[-resync-failed-count <integer>] - Number of Failed Resyncs
Select SnapMirror relationships that have a matching number of failed resyncs.
[-break-successful-count <integer>] - Number of Successful Breaks
Select SnapMirror relationships that have a matching number of successful breaks.
[-break-failed-count <integer>] - Number of Failed Breaks
Select SnapMirror relationships that have a matching number of failed breaks.
[-total-transfer-bytes <integer>] - Total Transfer Bytes
Select SnapMirror relationships that have a matching total transfer bytes.
837
[-total-transfer-time-secs <integer>] - Total Transfer Time in Seconds

Select SnapMirror relationships that have a matching total transfer time in seconds.
Examples
The example below displays summary information for all SnapMirror relationships with
destination endpoints in the current cluster:
cluster2::> snapmirror show
Source
Path
Type
Destination
Mirror
Relationship
Total
Path
State
Status
Progress
Last
Healthy Updated
----------- ---- ------------ ------- -------------- --------- ------- -------cluster2-vs1.example.com:dp_src1

DP
cluster2-vs2.example.com:dp_dst1
Snapmirrored
Idle
true
true
true
true
cluster2-vs1.example.com:xdp_src1
XDP
cluster2-vs2.example.com:xdp_dst1
Snapmirrored
Idle
cluster2://cluster2-vs1.example.com/ls_src1
LS
cluster2://cluster2-vs1.example.com/ls_mr1
Snapmirrored
Idle
cluster2://cluster2-vs1.example.com/ls_mr2
Snapmirrored
Idle
The example below displays detailed information for the SnapMirror relationship with the
destination endpoint cluster2-vs2.example.com:dp_dst1.
cluster2::> snapmirror show -destination-path cluster2-vs2.example.com:dp_dst1
Source Path: cluster2-vs1.example.com:dp_src1
Destination Path: cluster2-vs2.example.com:dp_dst1
Relationship Type: DP
SnapMirror Schedule: SnapMirror Policy Type: async-mirror
838
SnapMirror Policy: DPDefault

Tries Limit: Throttle (KB/sec): unlimited
Mirror State: Snapmirrored
Transfer Snapshot: Snapshot Progress: Total Progress: Network Compression Ratio: Snapshot Checkpoint: Newest Snapshot:
snapmirror.3d19af37-8f5e-11e1-8c83-123478563412_2147484676.2012-04-27_025137
Newest Snapshot Timestamp: 04/27 02:51:42
Exported Snapshot:
snapmirror.3d19af37-8f5e-11e1-8c83-123478563412_2147484676.2012-04-27_025137
Exported Snapshot Timestamp: 04/27 02:51:42
Healthy: true
Unhealthy Reason: Constituent Relationship: false
Destination Volume Node: cluster2-node1
Relationship ID: cdc70a81-8f5f-11e1-8392-123478563412
Current Operation ID: Transfer Type: Transfer Error: Current Throttle: Current Transfer Priority: Last Transfer Type: update
Last Transfer Error: Last Transfer Size: 530.2MB
Last Transfer Network Compression Ratio: 111.7:1
Last Transfer Duration: 0:2:53
Last Transfer From: cluster2-vs1.example.com:dp_src1
Last Transfer End Timestamp: 04/27 02:51:45
Progress Last Updated: Relationship Capability: 8.2 and above
Lag Time: 133:50:40
Number of Successful Updates: 1
Number of Failed Updates: 0
Number of Successful Resyncs: 0
Number of Failed Resyncs: 0
Number of Successful Breaks: 0
Number of Failed Breaks: 0
839
Total Transfer Bytes: 663552

Total Transfer Time in Seconds: 3
The example below displays detailed information for SnapMirror relationships with
the Relationship Capability of "Pre 8.2" source or destination endpoints in the current
cluster.
cluster2::> snapmirror show -relationship-capability "Pre 8.2" -instance
Source Path: cluster2://cluster2-vs1.example.com/
ls_src1
Destination Path: cluster2://cluster2-vs1.example.com/
ls_mr1
Relationship Type: LS
Relationship Group Type: SnapMirror Schedule: SnapMirror Policy Type: SnapMirror Policy: Tries Limit: 8
Throttle (KB/sec): unlimited
snapmirror.3d4e52c5-8f5c-11e1-8392-123478563412_3_2147484684.2012-05-02_163506
Exported Snapshot:
Healthy: true
Destination Volume Node: Relationship ID: Current Operation ID: Transfer Type: Transfer Error: Last Transfer Type: Last Transfer Error: -
840
Last Transfer Size: Last Transfer Network Compression Ratio: Last Transfer Duration: Last Transfer From: Last Transfer End Timestamp: Progress Last Updated: Relationship Capability: Pre 8.2
Lag Time: SnapMirror Policy: Number of Successful Updates: Number of Failed Updates: Number of Successful Resyncs: Number of Failed Resyncs: Number of Successful Breaks: Number of Failed Breaks: Total Transfer Bytes: Total Transfer Time in Seconds: Source Path: cluster2://cluster2-vs1.example.com/
ls_src1
Destination Path: cluster2://cluster2-vs1.example.com/
ls_mr2
Relationship Type: LS
Relationship Group Type: SnapMirror Schedule: SnapMirror Policy Type: SnapMirror Policy: Tries Limit: 8
Throttle (KB/sec): unlimited
Exported Snapshot:
841
Healthy: true
Destination Volume Node: Relationship ID: Current Operation ID: Transfer Type: Transfer Error: Last Transfer Type: Last Transfer Error: Last Transfer Size: Last Transfer Network Compression Ratio: Last Transfer Duration: Last Transfer From: Last Transfer End Timestamp: Progress Last Updated: Relationship Capability: Pre 8.2
Lag Time: SnapMirror Policy: Number of Successful Updates: Number of Failed Updates: Number of Successful Resyncs: Number of Failed Resyncs: Number of Successful Breaks: Number of Failed Breaks: Total Transfer Bytes: Total Transfer Time in Seconds: 2 entries were displayed.
The snapmirror show command will display values only for the following fields
for relationships with "Relationship Capability" of "Pre 8.2", when run on the source
cluster of a cross-cluster relationship: source-path, source-cluster, source-vserver,
source-volume, destination-path, destination-cluster, destination-vserver, destinationvolume, type, status, state, is-constituent, relationship-capability. You must issue the
snapmirror show command on the destination cluster to have complete information
about SnapMirror relationships.
842
For SnapMirror relationships between Infinite Volumes, the Total Progress, Snapshot
Progress, Destination Volume Node, and Snapshot Checkpoint fields will not display
values in the snapmirror show output.
If the SnapMirror relationship is between Infinite Volumes, and the Source Path field's
value is SRC_VOLUME_UNRESOLVED, or the Destination Path field's value is
DST_VOLUME_UNRESOLVED, check the intercluster connectivity for that relationship.
See Also
snapmirror list-destinations snapmirror policy create
843
snapmirror update-ls-set
Start an incremental load-sharing set transfer
Description
The snapmirror update-ls-set command updates a set of load-sharing mirrors.
The command makes destination volumes, in the group of load-sharing mirrors, up-todate mirrors of the source volume.
The key parameter that identifies the set of load-sharing mirrors is the source volume.
SnapMirror transfers are performed from the source volume to each of the up-to-date
destination volumes in the set of load-sharing mirrors.
The snapmirror update-ls-set command performs an incremental transfer to
each of the destination volumes. During an incremental transfer, Data ONTAP takes a
Snapshot copy on the source volume to capture the current image of the source volume,
finds the most recent common Snapshot copy between the source and destination
volumes, and incrementally transfers Snapshot copies that are newer than the common
Snapshot copy to the destination volume.
Note:
You still need to use the snapmirror update-ls-set command to manually
update the set of load-sharing mirrors even if the set only has one destination mirror.
The snapmirror update command can only be used to bring up to date a specific
destination mirror that is lagging to the set.
After an update using the snapmirror update-ls-set command successfully
completes, the last Snapshot copy transferred is made the new exported Snapshot copy
on the destination volumes.
Parameters
844
of "8.2 and above".
-source-volume <volume name> } - Source Volume
Examples
To update the group of load-sharing mirrors for the source endpoint named //
vs1.example.com/dept_eng, type the following command:
cluster1::> snapmirror update-ls-set -source-path //vs1.example.com/dept_eng
See Also
snapmirror update snapmirror show
845
snapmirror update
Start an incremental transfer
Description
The snapmirror update command updates the destination volume of a SnapMirror
relationship. The snapmirror update command behaves differently for data
protection (DP), extended data protection (XDP) and load-sharing (LS) relationships.
Refer to parameter "type" from snapmirror create to understand different types of
relationships supported by SnapMirror.
The snapmirror update command performs an incremental transfer.
Before using this command, the relationship must be initialized using the snapmirror
initialize or snapmirror initialize-ls-set commands.
For data protection relationships, the snapmirror update command makes the
destination volume an up-to-date mirror of the source volume with the following steps:
If the source volume is read-write, takes a Snapshot copy on the source volume to
capture the current image of the source volume
Finds the most recent Snapshot copy on the destination volume and validates that
the corresponding Snapshot copy is still present on the source
Incrementally transfers Snapshot copies that are newer than the corresponding
Snapshot copy to the destination volume
You can use the snapmirror update command to update a specific load-sharing
mirror that lags behind up-to-date destination volumes in the set of load-sharing mirrors.
An update to the lagging load-sharing mirror should bring it up to date with the other upto-date destination volumes in the set of load-sharing mirrors.
Note:
Using the snapmirror update command to update a set of load-sharing mirrors will
not work. Use the snapmirror update-ls-set command to update a set of loadsharing mirrors.
For extended data protection (XDP) relationships with a snapmirror policy of type
async-mirror, a snapmirror update always creates a new Snapshot copy on the
846
source volume. Depending on the rules in the policy, the command may transfer just the
newly created Snapshot copy or all Snapshot copies that are newer than the common
Snapshot copy including the newly created Snapshot copy to the destination volume.
vault, a snapmirror update does not create a new Snapshot copy on the source
volume but transfers only selected Snapshot copies that are newer than the common
Snapshot copy to the destination volume. (Those older than the common copy can
be transferred by using the -source-snapshot parameter.) Snapshot copies are
selected by matching the value of -snapmirror-label of a Snapshot copy with the
value of -snapmirror-label of one of the rules from the corresponding SnapMirror
policy associated with the SnapMirror relationship. All matching Snapshot copies are
incrementally transferred to the destination volume.
mirror-vault, a snapmirror update always creates a new Snapshot copy on the
source volume and transfers only selected Snapshot copies that are newer than the
common snapshot copy. The newly created Snapshot copy is always selected.
vault or mirror-vault, the snapmirror update command also manages expiration
of Snapshot copies on the destination volume. It does so by deleting Snapshot copies
that have exceeded the value of -keep for the matching rule from the corresponding
SnapMirror policy associated with the SnapMirror relationship. Snapshot copies that
match the same -snapmirror-label will be deleted in oldest-first order.
For data protection relationships, the parameter -source-snapshot is optional and
only allows for the transfer of Snapshot copies newer than the common Snapshot copy
up to the specified -source-snapshot.
For extended data protection (XDP) relationships the parameter -source-snapshot is
optional.
vault or mirror-vault, the parameter -source-snapshot allows transfer of a Snapshot
copy that is older than the common Snapshot copy and/or may not be selected for
transfer based on policy-based selection of a scheduled update transfer.
For extended data protection (XDP) relationships with a snapmirror policy of
type async-mirror, the snapmirror update with parameter -source-snapshot
does not create a new Snapshot copy on the source volume. Depending on the rules
in the policy, the command may transfer just the specified Snapshot copy or Snapshot
copies that are newer than the common Snapshot copy upto and including the specified
Snapshot copy to the destination volume.
After the snapmirror update command successfully completes, the last Snapshot
copy transferred is designated as the new exported Snapshot copy on the destination
847
volume. If an update to an extended data protection (XDP) relationship specifies

a Snapshot copy using the -source-snapshot parameter that is older than the
common snapshot, after the snapmirror update successfully completes, the
exported Snapshot copy on the destination volume will remain unchanged.
If the snapmirror update does not finish successfully--for example, due to a network
failure or because a snapmirror abort command was issued--a restart checkpoint
might be recorded on the destination volume. If a restart checkpoint is recorded,
the next update restarts and continues the transfer from the restart checkpoint. For
extended data protection (XDP) relationships, the next update will restart and continue
the old transfer regardless of whether the Snapshot copy being transferred is a
matching Snapshot copy or not.
If you add an aggregate to the source Infinite Volume, you must also add an aggregate
of the same or greater size to the destination Infinite Volume before any snapmirror
update occurs.
show commands.
The snapmirror update command must be used from the destination Vserver or
cluster.
Parameters
of "8.2 and above".
848
Path
specified.
This optional parameter specifies a Snapshot copy to transfer. The default behavior for a
data protection relationship with a read-write source is that Data ONTAP creates a new
849
Snapshot copy and uses it as the basis for determining what data are replicated; with
this option, the specified Snapshot copy will be used instead. The default behavior for
an extended data protection relationship depends on the relationship's policy type. For a
data protection relationship, the specified Snapshot copy must be newer than the latest
common Snapshot copy. For an extended data protection relationship, the specified
Snapshot copy may be newer or older than the common Snapshot copy. This parameter
is not supported for relationships with "Relationship Capability" of "Pre 8.2".
This optional parameter limits the network bandwidth used for the update transfer.
[-enable-storage-efficiency [true]] - Enable Storage Efficient Transfers
This is an optional parameter. For an extended data protection (XDP) relationship that
is currently not storage efficient, set this parameter to true to enable storage efficient
transfers. Storage efficient in this context refers to both over the wire efficiency and
how the data is written to the destination volume. The transfer fails if storage efficiency
cannot be achieved. If the transfer succeeds, future transfers will continue being storage
efficient as long as it is still feasible, but will not fail if the transfer is not storage efficient.
The default value is false.
Examples
850
To update the mirror relationship between the destination endpoint

vs2.example.com:dept_eng_dp_mirror3 and its source endpoint, type the following
command:
vs2.example.com::> snapmirror update -destination-path
For relationships with "Relationship Capability" of "Pre 8.2", to update the mirror
relationship between the destination endpoint cluster2://vs2.example.com/
dept_eng_dp_mirror3 and its source endpoint, type the following command:
cluster2::> snapmirror update -destination-path
See Also
snapmirror create snapmirror modify snapmirror initialize snapmirror initialize-lsset snapmirror update-ls-set snapmirror policy snapmirror abort snapmirror show
job show job history show
851
snapmirror policy add-rule

Add a new rule to SnapMirror policy
Description
The snapmirror policy add-rule command adds a rule to a SnapMirror policy.
Rules define which Snapshot copies are protected by vault relationships. A rule must
not be added to a policy that will be associated with a SnapMirror data protection
relationship. A policy that will be associated with a SnapMirror vault relationship must
have at least one rule and at most ten rules.
Parameters
Specifies the Vserver for the SnapMirror policy.
-policy <sm_policy> - SnapMirror Policy Name
Specifies the SnapMirror policy name.
-snapmirror-label <text> - Snapshot Copy Label
This parameter is primarily used for the purpose of Snapshot copy selection for
extended data protection (XDP) relationships. Only Snapshot copies that have a
SnapMirror label that matches this parameter will be transferred to the SnapMirror
destination. The label can be 31 or fewer characters in length. SnapMirror policies
of type async-mirror and mirror-vault have a rule added for label sm_created at the
time of policy creation. This rule cannot be removed or modified by the user. This
rule when coupled with create-snapshot field set to true indicates that the SnapMirror
relationship using this policy shall create a new Snapshot copy and transfer it as part
of a snapmirror update operation. SnapMirror policies of type async-mirror support
one additional rule with SnapMirorr label all_source_snapshots. This rule along with
the rule for SnapMirror label sm_created indicates that all new Snapshot copies on
the primary volume along with the newly created Snapshot copy are transferred a
snapmirror update or snapmirror initialize operation. Rules with any other
SnapMirror labels may not be added to SnapMirror policies of type async-mirror. The
rule for label sm_created when added to a snapmirror policy of type vault indicates
that all SnapMirror created Snapshot copies of the primary volume are selected for
transfer.
852
-keep <text> - Snapshot Copy Retention Count

Specifies the maximum number of Snapshot copies that are retained on the SnapMirror
destination volume for a rule. The total number of Snapshot copies retained for all the
rules in a policy cannot exceed 251. For all the rules in SnapMirror policies of type
async-mirror, this parameter must be set to value 1.
[-preserve {true|false}] - Snapshot Copy Preserve Enabled
Specifies the behavior when the Snapshot copy retention count is reached on the
SnapMirror vault destination for the rule. The default value is false, which means that
the oldest Snapshot copy will be deleted to make room for new ones only if the number
of Snapshot copies has exceeded the retention count specified in the "keep" parameter.
When set to true, an incremental SnapMirror vault update will fail when the Snapshot
copies have reached the retention count. For all the rules in SnapMirror policies of type
async-mirror this parameter must be set to value false.
[-warn <integer>] - Warning Threshold Count
Specifies the warning threshold count for the rule. The default value is 0. When set to a
value greater than zero, an event is generated after the number of Snapshot copies (for
the particular rule) retained on a SnapMirror vault destination reaches the specified warn
limit. The preserve parameter for the rule must be true to set the warn parameter to a
value greater than zero.
Examples
The following example adds a rule named nightly to the SnapMirror policy named
TieredBackup on Vserver vs0.example.com. The rule will retain a maximum of 5 nightly
Snapshot copies.
vs0.example.com::> snapmirror policy add-rule -vserver vs0.example.com
-policy TieredBackup -snapmirror-label nightly -keep 5
See Also
snapmirror update snapmirror initialize snapmirror policy
853
snapmirror policy create

Create a new SnapMirror policy
Description
The snapmirror policy create command creates a SnapMirror policy. When
applied to a SnapMirror relationship, the SnapMirror policy controls the behavior of
the relationship and specifies the configuration attributes for that relationship. The
policies DPDefault, MirrorAllSnapshots, MirrorAndVault, MirrorLatest and XDPDefault
are created by the system.
Note:
All SnapMirror policies have a field create-snapshot. This field specifies whether
SnapMirror creates a new Snapshot copy on the primary volume at the beginning of a
snapmirror update or snapmirror resync operation. Currently this field cannot
be set or modified by the user. It is set to true for SnapMirror policies of type asyncmirror and mirror-vault at the time of creation. SnapMirror policies of type vault have
create-snapshot set to false at the time of creation.
Note:
Use the snapmirror policy add-rule command to add a rule to a policy.
Parameters
This parameter specifies the SnapMirror policy name. A policy name can be made
up of the characters A to Z, a to z, 0 to 9, ".", "-", and "_". The name can be up to 256
characters in length.
[-type {vault|async-mirror|mirror-vault}] - Snapmirror Policy Type
This parameter specifies the SnapMirror policy type. The supported values are asyncmirror, vault and mirror-vault. Data protection (DP) relationships support only async-
854
mirror policy type, while extended data protection (XDP) relationships support all three
policy types.
If the type is set to async-mirror then the policy is for Disaster Recovery. When
the policy type is associated with extended data protection (XDP) relationships,
snapmirror update and snapmirror resync operations transfer selected
Snapshot copies from the primary volume to the secondary volume. The selection
of Snapshot copies is governed by the rules in the policy. However snapmirror
initialize and snapmirror update operations on data protection (DP)
relationships ignore the rules in the policy and transfer all Snapshot copies of the
primary volume which are newer than the common Snapshot copy on the destination.
For both data protection (DP) and extended data protection (XDP) relationships,
the Snapshot copies are kept on the secondary volume as long as they exist on the
primary volume. Once a protected Snapshot copy is deleted from the primary volume,
it is deleted from the secondary volume as part of the next transfer. The policy type
supports rules with certain pre-defined label names only. Refer to the man page for the
snapmirror policy add-rule command for the details.
If the type is set to vault then the policy is used for Backup and Archive. The rules in
this policy type determine which Snapshot copies are protected and how long they
are retained on the secondary volume. This policy type is supported by extended data
protection (XDP) relationships only.
If the type is set to mirror-vault then the policy is used for unified data protection which
provides both Disaster Recovery and Backup using the same secondary volume. This
policy type is supported by extended data protection (XDP) relationships only.
Specifies a text comment for the SnapMirror policy. If the comment contains spaces, it
must be enclosed within quotes.
Determines the maximum number of times to attempt each manual or scheduled
transfer for a SnapMirror relationship. The value of this parameter must be a positive
integer or unlimited. The default value is 8.
[-transfer-priority {low|normal}] - Transfer Scheduling Priority
Specifies the priority at which a transfer runs. The supported values are normal or low.
The normal transfers are scheduled before the low priority transfers. The default is
normal.
[-ignore-atime {true|false}] - Ignore File Access Time
855
This parameter applies only to extended data protection (XDP) relationships. It specifies
whether incremental transfers will ignore files which have only their access time
changed. The supported values are true or false. The default is false.
[-restart {always|never|default}] - Restart Behavior
This parameter applies only to data protection relationships. It defines the behavior of
SnapMirror if an interrupted transfer exists. The supported values are always, never,
or default. If the value is set to always, an interrupted SnapMirror transfer always
restarts provided it has a restart checkpoint and the conditions are the same as they
were before the transfer was interrupted. In addition, a new SnapMirror Snapshot copy
is created which will then be transferred. If the value is set to never, an interrupted
SnapMirror transfer will never restart, even if a restart checkpoint exists. A new
SnapMirror Snapshot copy will still be created and transferred. Data ONTAP version 8.2
will interpret a value of default as being the same as always. Vault transfers will always
resume based on a restart checkpoint, provided the Snapshot copy still exists on the
source volume.
[-is-network-compression-enabled {true|false}] - Is Network Compression Enabled
Specifies whether network compression is enabled for transfers. The supported values
are true or false. The default is false.
Examples
The following example creates a SnapMirror policy named TieredBackup on a Vserver
named vs0.example.com.
vs0.example.com::> snapmirror policy create -vserver vs0.example.com
-policy TieredBackup -type vault -tries 10 -restart never
See Also
snapmirror update snapmirror resync snapmirror initialize snapmirror policy addrule
856
snapmirror policy delete

Delete a SnapMirror policy
Description
The snapmirror policy delete command deletes a SnapMirror policy. A policy
that is to be deleted must not be associated with any SnapMirror relationship. The
default policies DPDefault and XDPDefault cannot be deleted.
Parameters
Examples
The following example deletes a SnapMirror policy named TieredBackup on Vserver
vs0.example.com:
vs0.example.com::> snapmirror policy delete -vserver vs0.example.com
-policy TieredBackup
snapmirror policy modify-rule

Modify an existing rule in SnapMirror policy
Description
The snapmirror policy modify-rule command can be used to modify the
retention count, preserve setting, and warning threshold count for a rule in a SnapMirror
policy. Reducing the retention count or disabling the preserve setting for a rule in a
857
SnapMirror policy might result in the deletion of Snapshot copies on the vault destination
when the next transfer by the snapmirror update command occurs.
Note:
The rules in SnapMirror policies of type async-mirror cannot be modified.
Parameters
This parameter specifies the rule that is to be modified in a SnapMirror policy.
[-keep <text>] - Snapshot Copy Retention Count
Specifies the maximum number of Snapshot copies that are retained on the SnapMirror
destination volume for a rule. The total number of Snapshot copies retained for all the
rules in a policy cannot exceed 251. For all the rules in SnapMirror policies of type
async-mirror, this parameter must be set to value 1.
[-preserve {true|false}] - Snapshot Copy Preserve Enabled
Specifies the behavior when the Snapshot copy retention count is reached on the
SnapMirror vault destination for the rule. The default value is false, which means that
the oldest Snapshot copy will be deleted to make room for new ones only if the number
of Snapshot copies has exceeded the retention count specified in the "keep" parameter.
When set to true, an incremental SnapMirror vault update will fail when the Snapshot
copies have reached the retention count. For all the rules in SnapMirror policies of type
async-mirror this parameter must be set to value false.
[-warn <integer>] - Warning Threshold Count
Specifies the warning threshold count for the rule. The default value is 0. When set to a
value greater than zero, an event is generated after the number of Snapshot copies (for
the particular rule) retained on a SnapMirror vault destination reaches the specified warn
limit. The preserve parameter for the rule must be true to set the warn parameter to a
value greater than zero.
Examples
858
The following example changes the retention count for nightly Snapshot copies to
6 for a rule named nightly on a SnapMirror policy named TieredBackup on Vserver
vs0.example.com:
vs0.example.com::> snapmirror policy modify-rule -vserver vs0.example.com
-policy TieredBackup -snapmirror-label nightly -keep 6
See Also
snapmirror update
859
snapmirror policy modify

Modify a SnapMirror policy
Description
The snapmirror policy modify command can be used to modify the policy
attributes.
Note:
Use the snapmirror policy modify-rule command to modify a rule in a
SnapMirror policy.
Parameters
Specifies a text comment for the SnapMirror policy. If the comment contains spaces, it
must be enclosed within quotes.
Determines the maximum number of times to attempt each manual or scheduled
transfer for a SnapMirror relationship. The value of this parameter must be a positive
integer or unlimited. The default value is 8.
Specifies the priority at which a transfer runs. The supported values are normal or low.
The normal transfers are scheduled before the low priority transfers. The default is
normal.
860
This parameter applies only to extended data protection (XDP) relationships. It specifies
whether incremental transfers will ignore files which have only their access time
changed. The supported values are true or false. The default is false.
This parameter applies only to data protection relationships. It defines the behavior of
SnapMirror if an interrupted transfer exists. The supported values are always, never,
or default. If the value is set to always, an interrupted SnapMirror transfer always
restarts provided it has a restart checkpoint and the conditions are the same as they
were before the transfer was interrupted. In addition, a new SnapMirror Snapshot copy
is created which will then be transferred. If the value is set to never, an interrupted
SnapMirror transfer will never restart, even if a restart checkpoint exists. A new
SnapMirror Snapshot copy will still be created and transferred. Data ONTAP version 8.2
will interpret a value of default as being the same as always. Vault transfers will always
resume based on a restart checkpoint, provided the Snapshot copy still exists on the
source volume.
Specifies whether network compression is enabled for transfers. The supported values
are true or false. The default is false.
Examples
The following example changes the "transfer-priority" and the "comment" text of a
snapmirror policy named TieredBackup on Vserver vs0.example.com:
vs0.example.com::> snapmirror policy modify -vserver vs0.example.com -policy
TieredBackup -transfer-priority low -comment "Use for tiered backups"
See Also
snapmirror policy modify-rule
861
snapmirror policy remove-rule

Remove a rule from SnapMirror policy
Description
The snapmirror policy remove-rule command removes a rule from a
SnapMirror policy. On the destination of a SnapMirror relationship with snapmirror
policy of type vault or mirror-vault, all Snapshot copies with a SnapMirror label
matching the rule being removed are no longer processed by the snapmirror
update command and might need to be deleted manually. A snapMirror policy
of type vault must have at least one rule if that policy is associated with a SnapMirror
relationship.
Parameters
This parameter specifies the rule that is removed from the SnapMirror policy.
The rule for SnapMirror label sm_created cannot be removed from SnapMirror policies
of type async-mirror or mirror-vault.
Examples
The following example removes a rule named nightly from a SnapMirror policy named
TieredBackup on Vserver vs0.example.com:
vs0.example.com::> snapmirror policy remove-rule -vserver vs0.example.com -policy
TieredBackup -snapmirror-label nightly
See Also
snapmirror policy snapmirror update snapMirror policy
862
snapmirror policy show

Show SnapMirror policies
Description
The snapmirror policy show command displays the following information about
SnapMirror policies:
Vserver Name
SnapMirror Policy Name
SnapMirror Policy Type
Number of Rules in the policy
Tries
Transfer Priority
Comment for the policy
Individual Rule Names
Keep value for the Rule
Total of Keep values across all Rules in the policy
Parameters
specify.
| [-instance ] }
about all fields.
Selects the policies that match this parameter value.
863
[-policy <sm_policy>] - SnapMirror Policy Name

[-type {vault|async-mirror|mirror-vault}] - Snapmirror Policy Type
Selects the policies that match this parameter value. A policy can be of type asyncmirror, vault or mirror-vault.
[-owner {cluster-admin|vserver-admin}] - Owner of the Policy
Selects the policies that match this parameter value. A policy can be owned by either
the "Cluster Admin" or a "Vserver Admin".
[-create-snapshot {true|false}] - Create a New Snapshot Copy
[-snapmirror-label <text>, ...] - Snapshot Copy Label
[-keep <text>, ...] - Snapshot Copy Retention Count
[-preserve {true|false}, ...] - Snapshot Copy Preserve Enabled
[-warn <integer>, ...] - Warning Threshold Count
864

[-total-rules <integer>] - Total Rules in the Policy
[-total-keep <integer>] - Total Retention Count for All Rules in the Policy
Examples
The following example displays information about all SnapMirror policies:
cs::> snapmirror policy show
Vserver Policy
Policy Number
Name
Type
Name
Transfer
Of Rules Tries Priority Comment
------- ------------------ ------ -------- ----- -------- ---------cs

DPDefault
relationship.
async-mirror
normal
SnapMirror Label: sm_created
Default policy for DP
Keep:
Total Keep:
cs
MirrorAllSnapshots async-mirror 2
8 normal Asynchronous SnapMirror
policy for mirroring all snapshots and the latest active file system.
Keep:
all_source_snapshots
1
1
Total Keep:
cs
MirrorAndVault
mirror-vault 3
8 normal A unified Asynchronous
SnapMirror and SnapVault policy for mirroring the latest active file system and
daily and weekly snapshots.
Keep:
daily
weekly
52
Total Keep:
cs
MirrorLatest
async-mirror 1
8 normal
policy for mirroring the latest active file system.
cs
XDPDefault
vault
2
relationship with daily and weekly rules.
60
Asynchronous SnapMirror
Keep:
Total Keep:
SnapMirror Label: daily

weekly
normal
Default policy for XDP
Keep:
7
52
865
Total Keep:
59
vs0.example.com
TieredBackup
vault
normal
Snapmirror-label: -
Use for tiered backups
Keep:
Total Keep:
The following example shows all the policies with the following fields - vserver (default),
policy (default) and transfer-priority:
cs::> snapmirror policy show -fields transfer-priority
vserver
policy
transfer-priority
----------- --------- ----------------cs
DPDefault normal
cs
XDPDefault
normal
vs0.example.com
TieredBackup
normal
866
snapmirror snapshot-owner create

Add an owner to preserve a Snapshot copy for a SnapMirror mirror-to-vault cascade
configuration
Description
The snapmirror snapshot-owner create command adds an owner on the
specified Snapshot copy. A Snapshot copy can have at most one owner. An owner can
only be added to a Snapshot copy on a read-write volume. The Snapshot copy must
have a valid SnapMirror label.
Note:
Refer to the ONTAP Data Protection Guide for valid use cases to add an owner on a
Snapshot copy.
Parameters
This parameter specifies the Vserver on which the volume is located.
This parameter specifies the name of the volume.
-snapshot <snapshot name> - Snapshot Copy Name
This parameter specifies the name of the Snapshot copy.
[-owner <owner name>] - Snapshot Copy Owner Name
This parameter specifies the name of the owner for the Snapshot copy. The owner
name can be made up of the characters A to Z, a to z, 0 to 9, and "_". The name can
be up to 32 characters in length. When not specified, an owner will be added with a
system-generated default name.
Examples
The following example adds owner app1 on Snapshot copy snap1 on volume vol1 in
Vserver vs0.example.com.
867
cluster1::> snapmirror snapshot-owner create -vserver vs0.example.com

-volume vol1 -snapshot snap1 -owner app1
The following example adds a default owner on Snapshot copy snap2 on volume vol1 in
cluster1::> snapmirror snapshot-owner create -vserver vs0.example.com
-volume vol1 -snapshot snap2
snapmirror snapshot-owner delete

Delete an owner used to preserve a Snapshot copy for a SnapMirror mirror-to-vault
cascade configuration
Description
The snapmirror snapshot-owner delete command removes an owner on the
specified Snapshot copy, which was added using the snapmirror snapshot-owner
create command.
Parameters
-snapshot <snapshot name> - Snapshot Copy Name
This parameter specifies the name of the Snapshot copy.
[-owner <owner name>] - Snapshot Copy Owner Name
This parameter specifies the name of the owner for the Snapshot copy. When not
specified, the owner with the system-generated default name will be removed.
Examples
The following example removes owner app1 on Snapshot copy snap1 on volume vol1 in
cluster1::> snapmirror snapshot-owner delete -vserver vs0.example.com
868
-volume vol1 -snapshot snap1 -owner app1
The following example removes the default owner on Snapshot copy snap2 on volume
vol1 in Vserver vs0.example.com.
cluster1::> snapmirror snapshot-owner delete -vserver vs0.example.com
-volume vol1 -snapshot snap2
See Also
869
snapmirror snapshot-owner show

Display Snapshot Copies with Owners
Description
The snapmirror snapshot-owner show command is used to list all Snapshot
copies with owners that were added using the snapmirror snapshot-owner
create command.
Parameters
If this parameter is specified, the command displays information about the specified
fields.
| [-instance ] }
If this parameter is specified, the command displays detailed information about all fields.
[-snapshot <snapshot name>] - Snapshot Copy Name
If this parameter is specified, the command displays the owner name for the specified
Snapshot copy.
Examples
The following example lists all Snapshot copies with owners on volume vol1 in Vserver
vs0. The system-generated default owner name is displayed as "-".
cluster1::> snapmirror snapshot-owner show
-vserver vs0.example.com -volume vol1
Vserver
Volume
Snapshot
Owner Names
-------- -------------------- -------------------- -------------------vs0.example.com
870
vol1
snap2
snap1
app1
The following example displays the owner name for Snapshot copy snap1 on volume
vol1 in Vserver vs0.example.com.
cluster1::> snapmirror snapshot-owner show
-vserver vs0.example.com -volume vol1 -snapshot snap1
Vserver: vs0.example.com
Volume: vol1
Snapshot: snap1
Owner Names: app1
See Also
871
statistics show-periodic
Continuously display current performance data at regular interval
Description
This command continuously displays specified performance data at a regular interval.
The command output displays data in the following columns:
Note:
This command has been deprecated and may be removed from a future version of Data
ONTAP. Use the "statistics show" command with the tabular format instead.
cpu busy: Overall system utilization based on CPU utilization and subsystem
utilization. Examples of subsystems include the storage subsystem and RAID
subsystem.
total ops: The number of total operations per second.
nfs-ops: The number of NFS operations per second.
cifs-ops: The number of CIFS operations per second.
data busy: The percentage of time that data ports sent or received data.
data recv: Network traffic received on data ports (KBps).
data sent: Network traffic sent on data ports (KBps).
cluster busy: The percentage of time that cluster ports sent or received data.
cluster recv: Network traffic received on cluster ports (KBps).
cluster sent: Network traffic sent on cluster ports (KBps).
disk read: Data read from disk (KBps).
disk write: Data written to disk (KBps).
Parameters
[-object <text>] - Object
872
Selects the object for which you want to display performance data. The default object is
"cluster".
[-instance <text>] - Instance
Selects the instance for which you want to display performance data. This parameter is
required if you specify the -object parameter and enter any object other than "cluster".
Multiple values for this parameter are not supported.
For example, if you want to display disk object statistics, you can use this parameter to
specify the name of a specific disk whose statistics you want to view.
[-counter <text>] - Counter
Selects the counters for which you want to display performance data. If you do not
specify this parameter, the command displays statistics for all of the counters in the
specified objects. To specify multiple counters, use "|" between each counter.
[-preset <text>] - Preset
If this parameter is specified, the command displays statistics for the specified preset.
Selects the nodes for which you want to display performance data. The default node is
"cluster:summary".
Selects the Vserver for which you want to display performance data. If you do not
specify this parameter, the command displays statistics for all of the Vservers in the
cluster.
[-interval <integer>] - Interval in Seconds
Specifies, in seconds, the interval between statistics updates. The default setting is 1
second.
Specifies the number of iterations the command runs before terminating. The default
setting is 0 (zero); this means that the command continues to run until you interrupt it by
pressing Ctrl-C.
[-summary {true|false}] - Print Summary
Specifies whether the command prints a final summary of statistics after the command
has gone through all of its iterations. The default setting is true.
[-filter <text>] - Filter Data
873
Selects instances that match the specified filter criteria. For example, to display
instances from node1, specify -filter "node_name=node1".
Examples
The following example displays the "cluster" statistics for a node named node1.
Because no number of iterations is specified, this command will continue to run until you
interrupt it by pressing Ctrl-C.
cluster1::*> statistics show-periodic -node node1
cpu
total
disk
disk
data
data
data cluster
busy
ops nfs-ops cifs-ops busy

write
recv
sent
read
busy
cluster
cluster
recv
sent
---- -------- -------- -------- ---- -------- -------- ------- -------- --------------- -------54%
10378
10378
8.25KB
24.7KB
59%
66.9MB
99.6MB
72%
78.8MB
172MB
49%
8156
8156
7.92KB
7.92KB
47%
48.0MB
82.0MB
79%
83.9MB
190MB
49%
6000
15.8KB
6000
54%
24.3MB
87.0MB
76%
109MB
182MB
56%
10363
10363
8.00KB
24.0KB
71%
62.3MB
110MB
57%
96.8MB
136MB
54%
66%
65.8MB
106MB
59%
94.7MB
141MB
54%
7894
7894
2.68MB
11.0MB
62%
40.1MB
101MB
78%
99.0MB
186MB
56%
7135
7135
16.2KB
32.3KB
65%
30.5MB
104MB
86%
93.3MB
206MB
60%
78%
67.7MB
126MB
87%
88.5MB
209MB
72%
65.7MB
112MB
86%
87.1MB
205MB
56%
10130
10130
8.00KB
24.0KB
59%
64.9MB
98.9MB
84%
81.0MB
200MB
55%
9814
52%
63.8MB
76.4MB
94%
71.2MB
224MB
54%
7776
7776
24.5KB
8.16KB
49%
41.2MB
80.7MB
91%
86.4MB
218MB
52%
7400
7400
7.92KB
23.8KB
49%
38.0MB
80.8MB
87%
98.7MB
208MB
55%
9459
65%
56.4MB
105MB
65%
96.6MB
155MB
10529
65%
65.8MB
107MB
69%
89.0MB
165MB
57%
9950
9950
2.32MB
2.65MB
62%
64.9MB
95.3MB
89%
81.8MB
213MB
54%
8287
8287
8.16KB
8.16KB
48%
51.9MB
77.2MB
95%
73.3MB
226MB
54%
7612
15.8KB
40%
41.4MB
68.2MB
95%
88.6MB
228MB
10460
0B
10460
0B
11374
0B
0B
56%
10458
16.0KB
0B
11374
10458
9814
0B
874
0B
0B
9459
0B
0B
56%
10529
16.2KB
0B
7612
0B
54%
8728
8728
7.92KB
23.8KB
60%
48.9MB
92.8MB
89%
103MB
214MB
57%
70%
59.4MB
108MB
74%
95.7MB
176MB
9944
9944
0B
0B
[...]
The following example displays the "processor" statistics for an instance named
processor1. This command will display only five iterations.
cluster1::*> statistics show-periodic -object processor -instance processor1 iteration 5
instance
name
node processor
name
busy
elapsed
sk
time switches
-------- -------- --------- --------- -------processor0
2%
1022
processor0
1%
959
processor0
2%
1098
processor0
2%
870
processor0
2%
1107
[...]
The following example displays the processor statistics for an instance named
processor1 and counters "processor_busy" and "sk_switches". This command will
display only five iterations.
cluster1::*> statistics show-periodic -object processor -instance processor1 iteration 5 -counter processor_busy|sk_switches
processor
sk
busy switches
--------- -------5%
1267
4%
1163
7%
1512
5%
1245
4%
1128
[...]
875
statistics show
Display performance data for a time interval
Description
This command displays performance data for a period of time.
To display data for a period of time, collect a sample using the statistics start
and statistics stop commands. The data that displays is calculated data based on
the samples the cluster collects. To view the sample, specify the -sample-id parameter.
Parameters
specify.
| [-tab ] }
If this parameter is specified, the command displays performance data in tabular format.
Selects the objects for which you want to display performance data. To view a list of
valid object names, type statistics show -object ? or statistics catalog
object show. To specify multiple objects, use "|" between each object.
Caution:
You should limit the scope of this command to only a few objects at a time to avoid a
potentially significant impact on the performance of the system.
Selects the instances for which you want to display performance data. If you do
not specify this parameter, the command displays statistics for all of the instances
associated with the specified objects. To specify multiple instances, use "|" between
each instance.
876
For example, if you want to display disk object statistics, you can use this parameter
to specify the name of a specific disk whose statistics you want to view. If you do not
specify this parameter, the command displays statistics for all disks in the system.
Selects the counters for which you want to display performance data. To specify multiple
counters, use "|" between each counter.
Selects the nodes for which you want to display performance data.
Selects the Vserver for which you want to display performance data.
[-value <text>] - Text Value
Selects the performance data that matches the specified counter value.
[-labels <text>, ...] - List of Labels
Selects the performance data that matches the specified label.
[-values <text>, ...] - List of Values
Displays only the statistics that have the specified values.
Selects performance data for the instance that matches the specified filter criteria. For
example, to display the instances that match a value of greater than 50 for the total_ops
counter, specify -filter "total_ops>50".
[-sample-id <text>] - Sample Identifier
Displays performance data for the specified sample. You collect a sample by using the
statistics start and statistics stop commands.
[-interval <integer>] - Interval
seconds.
[-iterations <integer>] - Iterations
877
setting is 1. If the number is 0 (zero), the command continues to run until you interrupt it
by pressing Ctrl-C.
[-sort-key <text>] - Counter Used For Sorting
If this parameter is specified, the command displays statistics sorted by the specified
counter. Only one counter can be specified.
[-sort-order {Sort order ascending|descending}] - Sort Order
This parameter may be used in conjunction with the -sort-key parameter. This parameter
changes the order in which statistics are sorted. Possible values are ascending and
descending. The default setting is descending.
[-max <integer>] - Maximum Number of Instances
Specifies the maximum number of instances to display. The default setting is to display
all of the instances.
Examples
The following example starts collecting statistics and displays statistics for the sample
named smpl_1 for counters: avg_processor_busy and cpu_busy
cluster1::*> statistics start -object system -counter avg_processor_busy|cpu_busy
-sample-id smpl_1
Statistics collection is being started for Sample-id: smpl_1
cluster1::*> statistics show -sample-id smpl_1
Object: system
Instance: cluster
Start-time: 8/2/2012 18:27:53
End-time: 8/2/2012 18:27:56
Cluster: cluster1
Counter
Value
-------------------------------- -------------------------------avg_processor_busy
6%
cpu_busy
6%
The following example starts and stops data collection and displays statistics for the
sample named smpl_1 for counters: avg_processor_busy and cpu_busy
-sample-id smpl_1
878
cluster1::*> statistics stop -sample-id smpl_1

Statistics collection is being stopped for Sample-id: smpl_1
cluster1::*> statistics show -sample-id smpl_1
Object: system
Instance: cluster
Start-time: 8/2/2012 18:27:53
End-time: 8/2/2012 18:27:56
Cluster: cluster1
Counter
Value
-------------------------------- -------------------------------avg_processor_busy
6%
cpu_busy
6%
See Also
statistics catalog object show statistics start statistics stop
879
statistics start
Start data collection for a sample
Description
This command starts the collection of performance data. Use the statistics stop
command to stop the collection. You view the sample of performance data by using the
statistics show command. You can collect more than one sample at a time.
Parameters
Selects the objects for which you want to collect performance data. This parameter is
required. To view a list of valid object names, type statistics catalog object
show at the command prompt. To specify multiple objects, use "|" between each object.
Caution:
You should limit the scope of this command to only a few objects at a time to avoid a
potentially significant impact on the performance of the system.
Selects the instances for which you want to collect performance data. If you do
not specify this parameter, the command collects statistics for all of the instances
associated with the specified objects. To specify multiple instances, use "|" between
each instance.
For example, if you want to collect disk object statistics, you can use this parameter
to specify the name of a specific disk whose statistics you want to view. If you do not
specify this parameter, the command will collect statistics for all disks in the system.
Selects the counters for which you want to collect performance data. If you do not
specify this parameter, the command collects statistics for all of the counters in the
specified objects. To specify multiple counters, use "|" between each counter.
880
Specifies an identifier for the sample. Identifiers must be unique and are restricted to
the characters 0-9, a-z, A-Z, and "_". If you do not specify this parameter, the command
generates a sample identifier for you and defines this sample as the default sample for
the CLI session. When you run the statistics show command without specifying
the -sample-id parameter, data from the default sample displays. If you run this
command during the same CLI session and do not specify the -sample-id parameter,
the command overwrites the previous sample. The command does not delete the
default sample when you close your session.
Selects the vserver for which you want to collect performance data. If you do not specify
this parameter, the command collects statistics for all of the Vservers in the cluster.
Selects the node for which you want to collect performance data. If you do not specify
this parameter, the command collects statistics for all of the nodes in the cluster.
[-filter <text>] - Filter
Selects performance data for the instance that matches the specified filter
criteria. For example, to display the instances from node1, specify -filter
"node_name=node1".
[-duration <integer>] - Sample Duration in Minutes
If this parameter is specified, the command will collect the closing sample after the time
specified. Duration can be specified in minutes.
Examples
The following example starts statistics collection for sample "smpl_1":
cluster1::*> statistics start -object system -sample-id smpl_1
The following example starts collecting statistics for the sample named smpl_1 for
counters: avg_processor_busy and cpu_busy
-sample-id smpl_1
881
See Also
statistics catalog object show statistics show statistics stop
882
statistics stop
Stop data collection for a sample
Description
This command stops the collection of performance data. You view the sample of
performance data by using the statistics show command.
Parameters
Specifies the identifier of the sample for which you want to stop data collection. If you do
not specify this parameter, the command stops data collection for the last sample that
you started by running the statistics start command without the -sample-id
parameter.
Examples
The following example stops data collection for sample "smpl_1":
cluster1::*> statistics stop -sample-id smpl_1
Statistics collection is being stopped for Sample-id: smpl_1
See Also
statistics start statistics show
883
statistics aggregate show

Aggregate throughput and latency metrics
level.
Description
This command continuously displays performance data for aggregates at a regular
interval. The command output displays data in the following columns:
Aggregate - aggregate name.
Node - node name.
Total Ops - total number of operations per second.
Read Ops - read operations per second.
Write Ops - write operations per second.
Parameters
[-aggregate <text>] - Aggregate
Selects the aggregate for which you want to display performance data.
Selects the node for which you want to display performance data.
[-sort-key <text>] - Column to Sort By
column.
-interval <integer> - Interval
seconds.
-iterations <integer> - Iterations
by pressing Ctrl-C.
-max <integer> - Maximum Number of Instances
884
Specifies maximum number of aggregates to display. The default setting is 25.
Examples
The following example displays aggregate statistics:
cluster1::> statistics aggregate show
cluster-1 : 12/31/1969 16:00:04
*Total Read Write
Aggregate
Node
Ops
Ops
Ops
--------------------- ------------- ------ ---- ----aggr0_cluster_node2_0 cluster-node2
aggr0 cluster-node1
[...]
885
statistics cache flash-pool show

Flash pool throughput metrics
Description
This command continuously displays performance data for flash pool caches at a
regular interval. The command output displays data in the following columns:
Vserver - vserver name.
Volume - volume name.
Read Hit - percent of IOs serviced from a cache level.
Write Hit - percent of IOs serviced from a cache level.
Cache Used - percent of cache used.
Read Blocks - read blocks.
Write Blocks - write blocks.
Rejects - cache rejects.
Parameters
Selects the vserver for which you want to display performance data.
[-volume <text>] - Volume
Selects the volume for which you want to display performance data.
column.
886
seconds.
by pressing Ctrl-C.
Specifies the maximum number of flash pools to display. The default setting is 25.
Examples
The following example displays flash pool statistics:
cluster1::> statistics cache flash-pool show
cluster1 : 12/31/2013 16:00:04
Read Write
Aggregate
Vserver
Volume
Cache
Hit
Hit
Used
Read
(%)
(%)
(%)
Blocks
Write
Blocks Rejects
----------- -------- ------- ---- ----- ----------- ------- ------- ------aggr1
- -total-
aggr2
vs1
vol1
[...]
887
statistics catalog counter show

Display the list of counters in an object
Description
This command displays the names and descriptions of counters. The displayed data is
either node-specific or cluster-wide, depending on the objects specified.
Parameters
specify.
| [-describe ] }
Displays detailed information about each counter, including privilege level, label, and
whether the counter is a key counter.
Selects the object for which you want to display the list of counters. This parameter is
required. To view a list of valid object names, type statistics catalog counter
show -object ? or statistics catalog object show.
Selects the counters that match this parameter value. If you do not specify this
parameter, the command displays details for all counters.
Selects the counters that match this parameter value. For example, to display counters
from node1, specify -filter "node_name=node1".
[-label <text>, ...] - Labels for Array Counters
Selects the counters that match this parameter value. A label is the name of the bucket
to which an array counter belongs.
888
Selects the counters that match this parameter value.

[-privilege <text>] - Privilegel Level
Selects the counters that match this parameter value.
[-is-key-counter {true|false}] - Is Key Counter
Selects the counters that are key counters (true) or are not key counters (false). A key
counter is a counter that uniquely identifies an instance across the cluster. The default
setting is false. For example, "vserver_name" and "node_name" are key counters
because they identify the specific Vserver or node to which the instance belongs.
[-is-deprecated {true|false}] - Is Counter Deprecated
Selects the counters that are deprecated (true) or are not deprecated (false).
[-replaced-by <text>] - Replaced By Counter If Deprecated
Selects all deprecated counters that are replaced by the counter provided to this
parameter.
Examples
The following example displays the list of counters in the processor object.
cluster1::> statistics catalog counter show -object processor
Object: processor
Counter
Description
--------------------------- ---------------------------------------------instance_name
Instance Name
instance_uuid
Instance UUID
node_name
System node name
node_uuid
System node id
process_name
Ontap process that provided this instance
processor_busy
Percentage of elapsed time that the processor

is executing non-idle processes
processor_elapsed_time
Wall-clock time since boot used for

calculating processor utilization
sk_switches
Number of sk switches per second
See Also
statistics catalog object show
889
statistics catalog instance show

Display the list of instances associated with an object
Description
This command displays the names of instances associated with the specified object.
The displayed data is either node-specific or cluster-wide, depending on the objects
specified.
Parameters
[-fields <fieldname>, ...]
specify.
Selects the object for which you want to display the list of instances. This parameter is
required. To view a list of valid object names, type statistics catalog instance
show -object ? or statistics catalog object show.
[-instance <text>] - Instance Name
Selects the instances that match this parameter value. If you do not specify this
parameter, the command displays all the instances.
Selects the instances that match this parameter value. For example, to display
instances from vserver1, specify -filter "vserver_name=vserver1".
[-vserver <vserver name>, ...] - Vserver Name
parameter, the command displays instances for all of the Vservers in the cluster.
[-node {<nodename>|local}, ...] - Node Name
parameter, the command displays instances for all of the nodes in the cluster.
890
Examples
The following example displays the list of instances associated with the processor
object.
cluster1::> statistics catalog instance show -object processor
Object: processor
processor0
processor0
processor1
processor1
See Also
891

Display the list of objects
Description
This command displays the names and descriptions of objects from which you can
obtain performance data. The displayed data is either node-specific or cluster-wide,
depending on the objects specified.
Parameters
specify.
| [-describe ] }
Displays detailed information about each object, including privilege level.
Selects the objects for which you want to display information. If you do not specify this
parameter, the command displays details for all of the objects.
[-privilege <text>] - Privilege Level
Selects the objects that match this parameter value.
[-is-deprecated {true|false}] - Is Object Deprecated
Selects the objects that are deprecated (true) or are not deprecated (false).
[-replaced-by <text>] - Replaced By Object If Deprecated
Selects all deprecated objects that are replaced by the object provided to this
parameter.
Selects the objects that match this parameter value.
Examples
892
The following example displays descriptions of all objects in the cluster:

cluster1::> statistics catalog object show
aggregate
CM object for exporting aggregate performance

counters
audit_ng
CM object for exporting audit_ng performance

counters
cifs
These counters report activity from both SMB

and SMB2 revisions of the CIFS protocol. For
information isolated to SMB, see the 'smb1'
object. For SMB2, see the 'smb2' object.
cifs:node

cifs:vserver

cluster_peer
The cluster peer object contains peer

counters.
[...]
893
statistics disk show

Disk throughput and latency metrics
privilege level.
Description
This command continuously displays performance data for disks at a regular interval.
Disk - disk name.
Node - node name.
Busy (%) - percentage of time there was at least one outstanding request to the
disk.
Total Ops - total operations per second.
Parameters
[-disk <text>] - Disk
Selects the disk for which you want to display performance data.
column.
seconds.
894
by pressing Ctrl-C.
Specifies the maximum number of disks to display. The default setting is 25.
Examples
The following example displays disk statistics:
cluster1::*> statistics disk show
cluster1 : 12/31/1969 16:00:04
Busy *Total Read Write
Disk
Node
(%)
Ops
Ops
Ops
-------- -------- ---- ------ ---- ----VMw-1.31
node2
VMw-1.30
node2
VMw-1.3
node1
VMw-1.29
node2
[...]
895
statistics lif show

Logical network interface throughput and latency metrics
Description
This command continuously displays performance data for LIFs at a regular interval.
LIF - logical interface name.
Recv Packet - packets received per second.
Recv Data (Bps) - bytes received per second.
Recv Errors - receive errors per second.
Sent Packet - packets sent per second.
Sent Data (Bps) - bytes sent per second.
Sent Errors - transfer errors per second.
Current Port - current use port.
Parameters
[-lif <text>] - LIF
Selects the LIF for which you want to display performance data.
column.
seconds.
896

by pressing Ctrl-C.
Specifies the maximum number of LIFs to display. The default setting is 25.
Examples
The following example displays LIFs statistics:
cluster1::> statistics lif show
cluster1 : 12/31/1969 16:00:04
Recv
Recv
LIF
Data
Sent
Recv
Sent
Data
Sent Current
Vserver Packet (Bps) Errors Packet (Bps) Errors
Port
------------ ---------- ------ ----- ------ ------ ----- ------ ------node2_clus_1
Cluster
536
338
e0a
node2_clus_2
Cluster
398
287
e0b
node1_clus_2
Cluster
338
536
e0b
node1_clus_1
Cluster
287
398
e0a
node2_mgmt1 ncluster-1
e0c
node1_mgmt1 ncluster-1
e0c
[...]
897
statistics lun show

LUN throughput and latency metrics
Description
This command continuously displays performance data for LUNs at a regular interval.
Lun - LUN name.
Other Ops - other operations per second.
Read (Bps) - read throughput in bytes per second.
Write (Bps) - write throughput in bytes per second.
Latency (ms) - average latency for an operation in milliseconds.
Parameters
[-lun <text>] - Lun
Selects the LUN for which you want to display performance data.
column.
seconds.
898

by pressing Ctrl-C.
Specifies the maximum number of LUNs to display. The default setting is 25.
Examples
The following example displays LUN statistics:
cluster1::> statistics lun show
cluster1 : 12/31/2013 16:00:04
*Total Read Write Other
Lun Vserver
Ops
Ops
Ops
Ops
Read Write Latency

(Bps) (Bps)
(ms)
---- ------- ------ ---- ----- ----- ------ ----- ------lun1
vs1
58
13
15
29 310585
lun0
vs2
56
11
45
3014
39
8192 28826
47
[...]
899
statistics node show

System utilization metrics for each node in the cluster
level.
Description
This command continuously displays performance data for nodes at a regular interval.
Node - node name.
CPU (%) - CPU utilization.
Parameters
column.
seconds.
by pressing Ctrl-C.
Specifies the maximum number of aggregates to display. The default setting is 25.
Examples
900
The following example displays node statistics:

cluster1::> statistics node show
cluster1 : 12/31/2013 16:00:04
CPU *Total Latency
Node (%)
Ops
(ms)
----- --- ------ ------node2
76
113
node1
58
10
[...]
901
statistics oncrpc show-rpc-calls

Display ONC RPC Call Statistics
privilege level.
Description
Attention:
This command is deprecated and will be removed in a future major release.
The statistics oncrpc show-rpc-calls command displays information about
the Open Network Computing Remote Procedure Call (ONC RPC) calls performed by
the nodes of a cluster.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display information only about the RPC calls performed by the
node you specify.
[-protocol {TCP|UDP}] - Transport Protocol
Use this parameter to display information only about the RPC calls performed using the
network protocol you specify.
[-badproc <Counter with Delta>] - Bad Procedure Calls
Use this parameter to display information only about the RPC calls that have the
number of bad procedure calls you specify. Bad procedure calls are RPC requests that
contain invalid procedure numbers and cannot be completed.
902
[-badlen <Counter with Delta>] - Bad Length Calls

number of bad length calls you specify.
[-badhdr <Counter with Delta>] - Bad Header Calls
number of bad header calls you specify.
[-badcalls <Counter with Delta>] - Bad Calls
number of bad calls you specify.
[-badprogcalls <Counter with Delta>] - Bad Program Calls
number of bad program calls you specify.
[-calls <Counter64 with Delta>] - Total Calls
Use this parameter to display information only about the RPC calls that have the total
number of bad calls you specify.
Examples
cluster1::> statistics oncrpc show-rpc-calls
Node
Value
node1
Delta
------------tcp-------------
Bad Proc:
Bad Len:
Bad Hdr:
Bad Calls:
Bad Prog Calls:
Total Calls:
Node
Value
node1
Delta
------------udp-------------
Bad Proc:
Bad Len:
Bad Hdr:
Bad Calls:
Bad Prog Calls:
Total Calls:
903
Node
node2
Value
Delta
------------tcp-------------
Bad Proc:
Bad Len:
Bad Hdr:
Bad Calls:
Bad Prog Calls:
Total Calls:
Node
node2
Value
Delta
------------udp-------------
Bad Proc:
Bad Len:
Bad Hdr:
Bad Calls:
Bad Prog Calls:
Total Calls:
904
statistics port fcp show

FCP port interface throughput and latency metrics
level.
Description
This command continuously displays performance data for FCP ports at a regular
Port - port name.
Parameters
Selects the port for which you want to display performance data.
column.
seconds.
by pressing Ctrl-C.
Specifies the maximum number of ports to display. The default setting is 25.
Examples
905
The following example displays port statistics:

cluster1::> statistics port fcp
show
cluster1 : 12/31/2013 16:00:04

*Total Read Write
Port
Ops
Ops
Ops
----- ------ ---- ----port1
port2
[...]
906
statistics preset delete

Delete an existing Performance Preset
privilege level.
Description
Deletes a performance preset configuration and all of its associated details.
Parameters
-preset <text> - Preset Name
Specifies the name of the performance presets that you want to delete.
Examples
cluster1::*> statistics preset show
Preset Name: asup-event
Preset UUID: 55c03699-01db-11e2-8e3e-123478563412
Comment: The event-based AutoSupport Data ONTAP Performance Archive
preset configuration. This preset configuration is used
whenever an event-based AutoSupport is triggered.
Privilege: diagnostic
Read-Only: true
Archive Enabled: false
Generation ID: 0
Preset Name: asup-hourly
Preset UUID: 56178a2a-01db-11e2-8e3e-123478563412
Comment: The hourly AutoSupport Data ONTAP Performance Archive
preset configuration. This preset configuration is used by
the hourly AutoSupport collection events.
Read-Only: true
Archive Enabled: true
Generation ID: 0
Preset Name: default
907
Preset UUID: 55ac6297-01db-11e2-8e3e-123478563412

Comment: The default Data ONTAP Performance Archive preset
configuration. This preset configuration includes
essential counters to assist in general troubleshooting of
system performance.
Read-Only: true
Generation ID: 0
Preset Name: diagnostic
Preset UUID: 561db291-01db-11e2-8e3e-123478563412
Comment: The diagnostic Data ONTAP Performance Archive preset
configuration. This preset configuration includes more
counters at faster sample periods than the default
configuration to assist in abnormal troubleshooting of
system performance.
Read-Only: true
Generation ID: 0
Preset Name: foo
Preset UUID: 7a04f19d-02a7-11e2-8e40-123478563412
Comment: Test preset
Read-Only: false
Generation ID: 0
cluster1::*> statistics preset delete -preset foo
908
Read-Only: true
Generation ID: 0
Read-Only: true
Generation ID: 0
system performance.
Read-Only: true
Generation ID: 0
system performance.
Read-Only: true
Generation ID: 0
909
statistics preset import

Import Performance Preset configuration from source URI
privilege level.
Description
Imports a Performance Preset and all of its details from a source URI. The performance
preset will be created right after it is imported.
Parameters
-source-uri {(ftp|http)://(hostname|IPv4 Address|'['IPv6 Address']')...} - Source URI
pointing to a preset file
Specifies the URI from which to import a Performance Preset.
[-uri-username <text>] - Source URI username
Specifies the URI username if needed.
[-uri-password <text>] - Source URI password
Specifies the URI password if needed.
[-preset <text>] - Preset name
Preset Name
[-comment <text>] - Preset Description
Specifies the comment of the Performance Preset that you want to import.
[-privilege <PrivilegeLevel>] - Preset Privilege Level
Specifies the privilege level that this preset can be created at. Possible values: admin,
advanced, diagnostic.
[-is-archive-enabled {true|false}] - Is Preset Archive-Enabled?
Specifies whether or not the Performance Preset will be archived. The preset will be
archived if this option is set to true.
[-expiration-length <integer>] - Default Expiration Length (Minutes)
Specifies the duration of time until this preset expires in minutes.
910
Examples
Read-Only: true
Generation ID: 0
Read-Only: true
Generation ID: 0
system performance.
Read-Only: true
Generation ID: 0
911

system performance.
Read-Only: true
Generation ID: 0
cluster1::*> statistics preset import -source-uri http://www.netapp.com/support/
nfs_monitor.xml -comment "New NFS Monitor preset."
Read-Only: true
Generation ID: 0
Read-Only: true
Generation ID: 0
system performance.
Read-Only: true
912

Generation ID: 0
system performance.
Read-Only: true
Generation ID: 0
Preset Name: nfs_monitor
Preset UUID: 571db391-02dc-12e3-5e3f-123478563412
Comment: New NFS Monitor preset.
Read-Only: true
Generation ID: 0
913
statistics preset modify

Modify an existing Performance Preset
privilege level.
Description
Modifies an existing Performance Preset configuration. The command modifies the
global properties of a Preset, but does not modify the details of the Preset, such as
specific the objects and counters sampled.
Parameters
-preset <text> - Preset Name
Name of the Performance Preset to be modified.
[-new-name <text>] - New Preset Name
New Preset Name
Set comment to the given value.
Set privilege level at which this Preset can be viewed and/or modified to the given value.
Possible values: admin, advanced, diagnostic.
Examples
Preset Name: delta
Comment: custom preset description
Read-Only: false
Generation ID: 0
1 entry was displayed.
914
cluster1::*> statistics preset modify -preset delta -comment "new comment"

Preset Name: delta
Comment: new comment
Read-Only: false
Generation ID: 0
1 entry was displayed.
915
Read-only Performance Preset configurations cannot be modified.
statistics preset show

Display information about Performance Presets
privilege level.
Description
Displays information about performance preset configurations.
Parameters
Selects which performance preset attributes to display.
| [-instance ] }
Shows details of all attributes of performance preset configuration.
[-preset <text>] - Preset Name
Selects the performance presets that match the specified preset name.
Selects the performance presets that match the specified comment.
Selects the performance presets that are available with the specified privilege.
[-is-read-only {true|false}] - Is Preset Read-Only?
Selects the performance presets that are read-only (true) or are not read-only (false).
Read-only presets cannot be modified.
[-store <text>] - Name of Store Where Data is Saved
Selects the store where data is saved.
Examples
916

Preset Name
Privilege
Read-Only Comment
------------------- ---------- --------- -------------------------------------aggregate_overview
admin
true
This preset configuration is used by

statistics aggregate show command.
Provides overview of aggregate object.
disk_overview
advanced
true

statistics disk show command.
Provides overview of disk object.
fcp_port_overview
admin
true

statistics port fcp show command.
Provides overview of fcp port object.
flash_pool_overview admin
true

statistics cache flash-pool show
command. Provides overview of flash
pool object.
[...]
917
statistics preset detail show

Display information about Performance Preset Details
privilege level.
Description
Displays the specific details of each preset, including the objects sampled, the counter
sample periods, and the counters sampled.
Parameters
Selects which performance preset detail attributes to display.
| [-instance ] }
Displays all of the performance preset detail attributes.
[-preset <text>] - Preset Name
Selects the performance preset details that match the specified preset name.
[-object <text>] - Performance Object
Selects the performance preset details that match the specified object name.
[-sample-period <sample_period>] - Archive Sample period
Selects the performance preset details that are collected at the specified sample period.
[-counter-set <text>, ...] - Performance Counter Name Set
Selects the performance preset details that match the specified counters in the counter
set. Use "|" to separate multiple counters.
[-instance-filters <text>, ...] - Performance Instance Filters
Selects the performance preset details that match the specified instance filters. Use "|"
to separate multiple instance filters. This field is reserved for future use.
Examples
cluster1::*> statistics preset detail show
Sample Counter
918
Instance
Preset Name Object
Period Set
Filters
----------- ------------ ------ -------------- -------------------------------asup-event
aggregate
1w
instance_name, node_name,
process_name,
parent_host,
total_
transfers,
user_reads,
user_writes,
cp_reads,
user_read_
blocks,
user_write_
blocks,
cp_read_
blocks,
wv_fsid,
wv_vol_type,
wv_fsinfo_fs_
version,
wv_volinfo_fs_
options,
. . .
919
statistics samples delete

Delete statistics samples
Description
This command deletes samples that you created using the statistics start
command.
Parameters
Selects the Vserver for which you want to delete the sample. The default Vserver is
admin Vserver.
-sample-id <text> - Sample Identifier
Specifies the sample that you want to delete. This is a required parameter.
Examples
The following example deletes the sample "smpl_1":
cluster1::*> statistics samples delete -sample-id smpl_1
See Also
statistics start
920
statistics samples show

Display statistics samples
Description
This command displays information about the samples that you created using the
statistics start command.
Parameters
specify.
| [-describe ] }
Displays detailed information about each sample.
Selects the samples that match this parameter value. If you omit this parameter, the
command displays details for all samples.
Selects the samples that match this parameter value. If you do not specify this
parameter, the command will display information about all the samples in the cluster.
Examples
The following example displays information for sample "smpl_1":
cluster1::*> statistics samples show -sample-id smpl_1
Vserver
Sample ID
Start Time
Stop Time
Status
---------------- -------------------- -------------- -------------- ---------cluster-d1
smpl_1
09/13 18:06:46 -
Ready
The following example displays detailed information for sample "smpl_1":

cluster1::*> statistics samples show -sample-id smpl_1 -describe
921
Vserver: vs1
Sample ID: smpl_1
Object: processor
Instance: Counter: Start Time: 09/13 18:06:46
Stop Time: Status: Ready
- -
Privilege: admin
See Also
statistics start
922
statistics secd show

Display SecD Statistics
privilege level.
Description
Attention:
This command is deprecated and will be removed in a future major release.
The statistics secd show command displays information about SecD RPC usage
statistics on the nodes in a cluster. You can view the following information:
Number of times an RPC was called
Number of successful RPC calls
Number of failed RPC calls
Maximum time taken to process an RPC
Minimum time taken to process an RPC
Total collective time spent on an RPC
Use this command only as directed by support personnel to help analyze performance
and diagnose problems.
Parameters
specify.
| [-instance ] }
about all fields.
923

[-secdstat-type <secdStatType>] - SecdStatType
Selects the nodes that match this parameter value (SecD RPC type).
[-count <Counter>] - Count
Selects the nodes that match this parameter value (number of times an RPC was
called).
[-succeeded <Counter>] - Success
Selects the nodes that match this parameter value (number of times an RPC
succeeded).
[-failed <Counter>] - Failure
Selects the nodes that match this parameter value (number of times an RPC failed).
[-total-time <Counter>] - TotalTime
Selects the nodes that match this parameter value (total time for an RPC).
[-max-time <Counter>] - MaxTime
Selects the nodes that match this parameter value (maximum time for an RPC).
[-min-time <Counter>] - MinTime
Selects the nodes that match this parameter value (minimum time for an RPC).
Examples
The following example displays SecD RPC call statistics for a node named node1:
cluster1::*> statistics secd show -node node1
Node:
node1
Vserver:
SecdStatType
vs1
Count
Success
Failure
TotalTime
MaxTime
MinTime
--------------------- -------- -------- -------- ---------- -------- -------auth_extended
auth_passthrough
10
371240
279338
716
ontap_admin_cifs_auth_extended
0
ontap_admin_cifs_auth_basic
0
924
auth_get_creds
auth_user_name_to_ontap_admin_unix_creds
0
auth_user_name_to_unix_creds
0
auth_user_id_to_unix_creds
0
auth_user_name_to_unix_ids
0
auth_user_id_to_unix_owner_names
0
auth_user_name_to_id
auth_user_id_to_name
group_name_to_id
group_id_to_name
2857
616
318
auth_sid_to_name
auth_name_to_sid
2864
783
283
auth_sid_to_uid
auth_sid_to_uid_with_uuid
auth_uid_to_sid
auth_uid_to_sid_with_uuid
0
create_cifs_server
ds_change_password
ds_reset_password
515480
427772
29334
ds_ad_account_delete
dce_rpc_passthrough
nmap_map_name
discover_servers
discover_service
server_information
get_cifs_setup_server 0
nfs_krb_bind_spn
1306
461
398
nfs_krb_change_key
500443
429675
70768
nfs_krb_set_key
nfs_krb_get_key
netgroup_get_addrs
flush_netgroup_cache
accept_gss_token
handoff_gss_token
925
gpo_get_cap
gpo_get_car
gpo_get_rootdomain
gpo_get_list
926
statistics settings modify

Modify settings for the statistics commands
privilege level.
Description
This command modifies the settings for all of the statistics commands.
Parameters
[-display-rates {true|false}] - Display Rates
Specifies whether the statistics commands display rate counters in rates/second.
The default is true.
[-client-stats {enabled|disabled}] - Collect Per-Client Statistics
Specifies whether statistics commands display per-client information. The default is
disabled.
Note:
If you enable this setting, you might significantly impact system performance.
[-max-clients-to-view <integer>] - Specify the Max Number of Clients to View
Specifies the maximum number of clients to view. You can specify a positive integer
between 1 and 10240 as a value for this parameter. The default number of clients to
view is 50.
[-counter-display-units {Counter Units B|KB|MB|GB}] - Counter Display Units
Specifies display units for the counters. The default setting is MB.
[-display-count-exponent <integer>] - Display Count Exponent
Specifies display exponent value for the counters representing counts. The default
setting is 3 (thousand).
Examples
The following example sets the value of the -display-rates parameter to false:
cluster1::*> statistics settings modify -display-rates false
927
See Also
statistics
928
statistics settings show

Display settings for the statistics commands
privilege level.
Description
This command displays the current settings for all of the statistics commands.
Parameters
None
Examples
The following example displays the current settings for all statistics commands:
cluster1::*> statistics settings show
Display rate Counters in rate/sec: true
Counter Display: full
Counter Display Units: MB
Display Count Exponent: 3
See Also
statistics
929
statistics system show

System utilization metrics for the cluster
level.
Description
This command continuously displays performance data for cluster at a regular interval.
System - cluster name.
CPU (%) - CPU utilization.
Parameters
[-system <text>] - System
Selects the cluster for which you want to display performance data.
column.
seconds.
by pressing Ctrl-C.
Specifies the maximum number of systems to display. The default setting is 25.
Examples
930
The following example displays system statistics:

cluster1::> statistics system show
cluster1 : 12/31/2013 16:00:04
CPU *Total Latency
System (%)
Ops
(ms)
------- --- ------ ------Cluster
76
113
[...]
931
statistics volume show

Volume throughput and latency metrics
Description
This command continuously displays performance data for volumes at a regular interval.
Volume - volume name.
Latency (us) - average latency for an operation in microseconds.
Parameters
[-volume <text>] - Volume
Selects the volume for which you want to display performance data.
column.
932

seconds.
by pressing Ctrl-C.
Specifies the maximum number of volumes to display. The default setting is 25.
Examples
The following example displays volume statistics:
cluster1::> statistics volume show
cluster1 : 12/31/2013 16:00:04
Volume Vserver Aggregate
Ops
Ops
Ops
Ops
Read Write Latency

(Bps) (Bps)
(us)
------ ------- --------- ------ ---- ----- ----- ------ ----- ------vol0
aggr0
58
13
15
29 310585
vol0
aggr0_n0
56
11
45
3014
39
8192 28826
47
[...]
933
statistics vserver show

Vserver throughput and latency metrics
level.
Description
This command continuously displays performance data for Vservers at a regular
Vserver - Vserver name.
Parameters
column.
seconds.
by pressing Ctrl-C.
934

Specifies the maximum number of Vservers to display. The default setting is 25.
Examples
The following example displays Vserver statistics:
cluster1::> statistics vserver show
cluster1 : 12/31/2013 16:00:04
Vserver
Ops
Ops
Ops
Ops
Read Write Latency

(Bps) (Bps)
(us)
------- ------ ---- ----- ----- ------ ----- ------vs1
58
13
15
29 310585
vs2
56
11
45
3014
39
8192 28826
47
[...]
935
statistics workload show

QoS workload throughput and latency metrics
privilege level.
Description
This command continuously displays performance data for workloads at a regular
Workload - workload name.
Parameters
[-workload <text>] - Workload
Selects the workload for which you want to display performance data.
column.
seconds.
by pressing Ctrl-C.
936

Specifies the maximum number of workloads to display. The default setting is 25.
Examples
The following example displays workload statistics:
cluster1::*> statistics workload show
cluster1 : 12/31/2013 16:00:04
Workload
Ops
Ops
Ops
Ops
Read Write Latency

(Bps) (Bps)
(us)
--------------- ------ ---- ----- ----- ------ ----- ------_USERSPACE_APPS
30
8553
_WAFL_SCAN
20
30765
0
_WAFL_CP
[...]
937

Add disks to an aggregate
level.
Description
The storage aggregate add-disks command adds disks to an existing
aggregate. You must specify the number of disks or provide a list of disks to be added. If
you specify the number of disks without providing a list of disks, the system selects the
disks.
Parameters
-aggregate <aggregate name> - Aggregate
This parameter specifies the aggregate to which disks are to be added.
{ [-diskcount <integer>] - Disk Count
This parameter specifies the number of disks that are to be added to the aggregate.
[-disktype | -T {ATA | BSAS | FCAL | FSAS | LUN | MSATA | SAS | SATA | SSD |
VMDISK}] - Disk Type
This parameter specifies the type of disk that is to be added. It must be specified with
the -diskcount parameter when adding disks to a Flash Pool.
Use this parameter when adding spare SSDs to an aggregate to convert it to a Flash
Pool.
Note:
Only the aggregates marked as hybrid-enabled can be converted to Flash Pools.
Use storage aggregate modify to mark the aggregate as hybrid-enabled.
[-chksumstyle <aggrChecksumStyle>] - Checksum Style
This parameter specifies the checksum style for the disks to be added to an aggregate.
It is not applicable if -disklist or -mirror-disklist is specified. The possible
values are block for block checksum, zoned for zoned checksum and advanced_zoned
for advanced zoned checksum (AZCS). By default, disks with the same checksum style
as the aggregate are selected. This behavior can be overridden by using this parameter
938
to create a mixed checksum aggregate. A mixed checksum aggregate can support only
the block and advanced_zoned checksum styles.
| [-disklist | -d <disk path name>, ...] - Disks
This parameter specifies a list of disks to be added. If you specify the -disklist
parameter, you cannot further qualify the list of disks to be added by count, checksum
style or type.
[-mirror-disklist <disk path name>, ...] - Disks for Mirrored Plex
This parameter specifies a list of mirror disks to be added. It must contain the same
number of disks specified in -disklist parameter. If you specify the -mirrordisklist parameter, you cannot further qualify the list of disks to be added by count,
checksum style or type.
{ [-ignore-pool-checks [true]] - Don't Enforce Plex Pool Best Practices
The disks in a plex are normally required to come from the same SyncMirror pool. This
behavior can be overridden with this parameter when it is set to true.
[-allow-same-carrier [true]] - Allow Same RAID Group Within Carrier
This parameter can be used to allow two disks housed in the same carrier to be in the
same RAID group when you add disks to an aggregate.
Having disks in the same carrier in the same RAID group is not desirable because a
carrier failure can cause a simultaneous outage for two disks in the same RAID group.
You can add a disk to an aggregate that causes this situation, but when an alternate
disk becomes available, Data ONTAP automatically initiates a series of disk copy
operations to put the disks into different RAID groups. For this reason, you should use
this parameter only when necessary. When possible, allow Data ONTAP to choose
disks that need to be added to the aggregate.
This parameter affects only the add-disks operation. It is not a persistent attribute of the
aggregate.
| [-storage-pool <storage pool name>] - Storage Pool
This parameter specifies the name of the SSD storage pool from which available
allocation units are added to a given aggregate. This parameter cannot be used with the
-disk-list or -disk-count parameters.
[-allocation-units <integer>] } - Allocation Units
This parameter specifies the number of allocation units to be added to a given
aggregate from an SSD storage pool. Number of allocation units available and size
of each unit can be found using the storage pool show-available-capacity
command. This parameter works only when you also use the -storage-pool
parameter.
939
[-simulate | -n [true]] - Simulate Addition of Disks

This parameter is used with the disktype and diskcount parameters to determine which
disks would be added without actually performing the addition of disks operation.
[-raidgroup | -g {new|all|<raidgroup>}] - RAID Group
This parameter enables the administrator to specify which RAID group will receive the
added disks. If this parameter is not used, the disks are added to the most recently
created RAID group until it is full, then new raid groups are created and filled until all
the disks are added. If a RAID group name rgX is specified, the disks are added to that
RAID group. If new is specified, the disks are added to a new RAID group, even if the
disks would fit into an existing RAID group. If all is specified, the disks are added to
existing RAID groups until all existing RAID groups are full. Then Data ONTAP creates
one or more new RAID groups and adds the remaining disks to the new groups. If the
disk type or checksum style parameters are specified with this parameter, the command
operates only on the RAID groups with the matching disk type or checksum style, even
if all is specified.
[-allow-mixed-rpm | -f [true]] - Allow Disks With Different RPM Values
This parameter specifies whether disks that have different RPM values can be added.
For example, SAS disks can rotate at 10,000 or 15,000 RPM. If this parameter is set to
true and a list of disks are provided by using the -disklist parameter, the disks will
be added even if the SAS disks you specify have different RPM values. This parameter
works similarly for ATA disks, which can rotate at 5,400 or 7,200 RPM.
Note:
This parameter is applicable only when the -disklist or -mirror-disklist
parameter is used.
[-cache-raid-group-size <integer>] - RAID Group Size for Cache Tier
This parameter specifies the maximum number of disks that can be included in an SSD
RAID group for this aggregate.
Note:
This parameter is applicable only when adding SSDs for the first time to a hybridenabled aggregate. If this parameter is not used when the first SSDs are added to the
aggregate, the maximum RAID group size for the SSD cache is set to the default SSD
RAID group size for the RAID type of the SSD cache.
[-raidtype | -t {raid_dp|raid4}] - RAID Type
940
This parameter specifies the type for the new RAID groups that would be created while
adding disks to the aggregate. Use this parameter when you add the first RAID group
comprised of SSDs to a hybrid-enabled aggregate. The values are raid4 for RAID 4
and raid_dp for RAID Double Parity. The default value is the type of RAID groups of the
aggregate.
Examples
The following example adds 10 disks to an aggregate named aggr0. The disks are
added to a RAID group named rg1:
cluster1::> storage aggregate add-disks -aggregate aggr0 -diskcount 10 -raidgroup
rg1
In this example, an aggregate is converted to a Flash Pool aggregate using SSD

capacity from a storage pool. The aggregate was created using RAID-DP for the hard
disks and the SSDs are added using RAID4.
cluster1::> storage aggregate add-disks -aggregate FlashPool -storage-pool SP1 allocation-units 1 -raidtype raid4
See Also
storage aggregate modify storage pool show-available-capacity
941
storage aggregate create

Create an aggregate
level.
Description
The storage aggregate create command creates an aggregate. An aggregate
consists of disks. You must specify the number of disks or provide a list of disks to be
added to the new aggregate. If you specify the number of disks without providing a list of
disks, the system selects the disks.
When creating an aggregate, you can optionally specify the aggregate's home node, the
RAID type for RAID groups on the aggregate, and the maximum number of disks that
can be included in a RAID group.
Parameters
This parameter specifies the name of the aggregate that is to be created.
{ [-chksumstyle <aggrChecksumStyle>] - Checksum Style
This parameter specifies the checksum style for the aggregate. The values are block for
Block Checksum and advanced_zoned for Advanced Zoned Checksum (AZCS).
-diskcount <integer> - Number Of Disks
This parameter specifies the number of disks that are to be included in the aggregate,
including the parity disks. The disks in this newly created aggregate come from the pool
of spare disks. The smallest disks in this pool are added to the aggregate first, unless
you specify the -disksize parameter.
[-diskrpm | -R <integer>] - Disk RPM
This parameter specifies the RPM of the disks on which the aggregate is to be created.
Possible values include 5400, 7200, 10000, and 15000.
[-disksize <integer>] - Disk Size(GB)
This parameter specifies the size, in GB, of the disks on which the aggregate is to be
created. Disks with a usable size between 90% and 105% of the specified size are
selected.
942
This parameter specifies the type of disk on which the aggregate is to be created.
[-mirror | -m [true]] - Mirror
This parameter specifies that the new aggregate be mirrored (have two plexes). If this
parameter is set to true, the specified disks are split between the two plexes. By default,
the new aggregate will not be mirrored. You cannot use the -mirror parameter when
supplying a specific list of disks with either the -disklist or -mirror-disklist
parameters.
This parameter specifies the home node for the aggregate. If this parameter is not
specified, Data ONTAP selects the node where the aggregate is created.
| -disklist | -d <disk path name>, ... - Disks for First Plex
This parameter specifies a list of disks to be added to the new aggregate. If you specify
the -disklist parameter, you cannot further qualify the list of disks to be added by
count, checksum style, type, size, or RPM. You cannot use the -disklist parameter
when the -mirror parameter is set to true.
This parameter specifies a list of mirror disks to be added to the new mirrored
aggregate. It must contain the same number of disks specified in -disklist
parameter. If you specify the -mirror-disklist parameter, you cannot further qualify
the list of disks to be added by count, checksum style, type, size, or RPM. You cannot
use the -mirror-disklist parameter when the -mirror parameter is set to true.
[-ignore-pool-checks [true]] - Don't Enforce Plex Pool Best Practices
The disks in a plex are normally required to come from the same SyncMirror pool. This
behavior can be overridden with this parameter when it is set to true. This option cannot
be used when the -mirror option is set to true
same RAID group when you add disks to an aggregate.
You create an aggregate with this characteristic, but when an alternate disk becomes
available, Data ONTAP automatically initiates a series of disk copy operations to put the
disks into different RAID groups. For this reason, you should use this parameter only
943
when necessary. When possible, allow Data ONTAP to choose the disks from which to
create the aggregate.
This parameter affects only the aggregate creation operation. It is not a persistent
attribute of the aggregate.
This parameter specifies whether the aggregate can contain disks that have different
RPM values. For example, SAS disks can rotate at 10,000 or 15,000 RPM. If this
parameter is set to true and a list of disks are provided by using the -disklist
parameter, the aggregate will be created even if the SAS disks you specify have
different RPM values. This parameter works similarly for ATA disks, which can rotate at
5,400 or 7,200 RPM.
[-maxraidsize | -s <integer>] - Max RAID Size
This parameter specifies the maximum number of disks that can be included in a RAID
group.
This parameter specifies the type for RAID groups on the aggregate. The values are
raid4 for RAID 4 and raid_dp for RAID Double Parity. The default setting is raid_dp .
This parameter is not needed for array LUNs because they are always created with the
RAID0 raidtype.
[-simulate [true]] - Simulate Aggregate creation
This option simulates the aggregate creation and prints the list of disks that would be
used for the aggregate.
[-force-small-aggregate [true]] - Force the Creation of a Small Aggregate (privilege:
advanced)
This parameter can be used to force the creation of a 2-disk RAID4 aggregate, or a 3disk or 4-disk RAID-DP aggregate.
[-is-autobalance-eligible {true|false}] - Is Eligible for Auto Balance Aggregate (privilege:
advanced)
This specifies whether the aggregate will be considered by the Auto Balance Aggregate
feature. If the Auto Balance Aggregate feature is not used, this field is not used. When
this parameter is set to true the Auto Balance Aggregate feature might recommend
moving volumes to or from this aggregate in order to balance system workload. When
this parameter is set to false the aggregate will not be considered as a destination for
the Auto Balance Aggregate feature allowing for predictability in data placement. The
default value is false.
944
Examples
The following example creates an aggregate named aggr0 on a home node named
node0. The aggregate contains 20 disks and uses RAID-DP. The aggregate contains
regular FlexVol volumes:
cluster1::> storage aggregate create -aggregate aggr0 -nodes node0
-diskcount 20 -raidtype raid_dp -volume-style flex
node0. The aggregate contains the disks specified and uses RAID-DP
-disklist 1.0.15,1.0.16,1.0.17,1.0.18,1.0.19 -raidtype raid_dp
node0. The aggregate contains 20 disks of size 10GB and of type SAS:
-diskcount 20 -disksize 10 -disktype SAS
The following example creates a mirrored aggregate named aggr0 on the local node.
The aggregate contains 10 disks in each plex:
cluster1::> storage aggregate create -aggregate aggr0 -mirror
-diskcount 20
storage aggregate delete

Delete an aggregate
level.
Description
The storage aggregate delete command deletes a storage aggregate. No
volumes can exist on an aggregate that is to be deleted; the command fails if volumes
are present on the aggregate. The command prompts you for confirmation before
945
running. You can use the set command with the -confirmations off parameter to
disable confirmation messages.
Parameters
This parameter specifies the aggregate that is to be deleted.
[-preserve-config-data [true]] - Delete Physical Aggregate but Preserve Configuration
Data (privilege: advanced)
Deletes the physical aggregate, but preserves the aggregate configuration data. The
aggregate must not have any disks associated with it. If the parameter -preserveconfig-data is specified without a value, the default value is true; if this parameter is
not specified, the default value is false.
Examples
The following example deletes an aggregate named aggr1:
cluster1::> storage aggregate delete -aggregate aggr1
See Also
set
946
storage aggregate mirror

Mirror an existing aggregate
level.
Description
The storage aggregate mirror command adds a plex to an existing unmirrored
aggregate. You can specify a list of disks to be used for the mirrored plex. If you do not
specify the disks, the system automatically selects the disks based on the aggregate's
existing plex.
Parameters
This parameter specifies the aggregate to mirror.
This parameter specifies whether disks that have different RPM values can be used.
For example, SAS disks can rotate at 10,000 or 15,000 RPM. If this parameter is set to
true and a list of disks are provided by using the -mirror-disklist parameter, the
disks will be added even if the SAS disks you specify have different RPM values. This
parameter works similarly for ATA disks, which can rotate at 5,400 or 7,200 RPM.
Note:
This parameter is only applicable when the -mirror-disklist parameter is used.
[-mirror-disklist | -d <disk path name>, ...] - Disks for Mirrored Plex
This parameter specifies a list of disks to be used for the plex to be added. It must
contain the same number of disks as the existing plex of the unmirrored aggregate
specified using the -aggregate parameter.
[-ignore-pool-checks [true]] - Don't Enforce Plex Pool Best Practices
For maximum reliability, all disks from a plex should come from the same SyncMirror
pool, and the disks for the second plex should all come from the other pool. If needed,
this behavior can be overridden by setting this parameter to true. This parameter can be
used only with the -mirror-disklist parameter.
947
[-allow-same-carrier | -f [true]] - Allow Same RAID Group Within Carrier

same RAID group for a mirrored aggregate. Having disks in the same carrier in the
same RAID group is not desirable, because a carrier failure can cause a simultaneous
outage for two disks in the same RAID group. For this reason, this configuration is not
allowed by default. This restriction can be overridden by setting this parameter to true.
Note:
This parameter is accepted only when the -mirror-disklist parameter is used.
Examples
The following example mirrors an unmirrored aggregate aggr1:
cluster1::> storage aggregate mirror -aggregate aggr1
The following example mirrors an unmirrored aggregate aggr1. The specified disks are
used for the new plex.
cluster1::> storage aggregate mirror -aggregate aggr1 -mirror-disklist 1.2.12,
1.2.14, 1.2.16
storage aggregate modify

Modify aggregate attributes
level.
Description
The storage aggregate modify command can be used to modify an aggregate's
state, RAID type, or maximum RAID group size.
Changing the RAID type immediately changes the RAID group type for all RAID
groups on the aggregate. If you change the RAID type from RAID4 to RAID-DP, each
RAID group allocates a spare disk for the group's second parity disk and begins a
reconstruction process.
948
Changing the maximum RAID size does not cause existing RAID groups to grow or to
shrink; rather, it affects the size of RAID groups created in the future, and determines
whether more disks can be added to the RAID group that was most recently created.
Parameters
This parameter specifies the storage aggregate that is to be modified.
This parameter specifies either the HDD tier or the SSD tier when changing the RAID
type of a Flash Pool. If the HDD tier is composed of more than one type of disk,
specifying any of the disk types in use causes that tier to be modified.
[-free-space-realloc {on|off|no_redirect}] - Free Space Reallocation
This parameter specifies whether free space reallocation is enabled on the aggregate.
Free space reallocation optimizes the free space in an aggregate immediately before
Data ONTAP writes data to the blocks in that aggregate.
The default setting is off.
no_redirect is available at the diagnostic privilege level. Use the no_redirect
option only under the guidance of support personnel.
[-ha-policy {sfo|cfo}] - HA Policy
This parameter specifies the high-availability policy to be used in the context of a root
recovery procedure. Do not modify this setting unless directed to do so by a customer
support representative.
[-percent-snapshot-space <percent>] - Space Reserved for Snapshot Copies
This parameter is used to set the space reserved for Snapshot copies to the specified
value. For example, to set the snapshot reserve to 5%, you should enter -percentsnapshot-space 5.
[-space-nearly-full-threshold-percent <percent>] - Aggregate Nearly Full Threshold
Percent
This optionally specifies the percentage at which the aggregate is considered nearly
full, and above which an EMS warning will be generated. The default value is 95%. The
maximum value for this option is 99%. Setting this threshold to 0 disables the aggregate
nearly full space alerts.
[-space-full-threshold-percent <percent>] - Aggregate Full Threshold Percent
949
This optionally specifies the percentage at which the aggregate is considered full,
and above which a critical EMS error will be generated. The default value is 98%.
The maximum value for this option is 100%. Setting this threshold to 0 disables the
aggregate full space alerts.
[-hybrid-enabled {true|false}] - Hybrid Enabled
If the hybrid-enabled option is set to "true", the aggregate is marked as hybrid_enabled,
that is, the aggregate can contain a mix of SSDs and HDDs (Hard Disk Drives, e.g.,
SAS, SATA, and/or FC). By default, aggregates cannot be marked "hybrid_enabled" if
the aggregate contains FlexVols that cannot be write cached. A FlexVol cannot be writecached if it is part of an aggregate created in Data ONTAP 7. Use -force-hybridenabled to over-ride this behavior.
[-force-hybrid-enabled | -f [true]] - Force Marking of Aggregate as Hybrid Enabled
By default, aggregates cannot be marked "hybrid_enabled" if the aggregate contains
FlexVols that cannot be write cached. A FlexVol cannot be write-cached if it is part of
an aggregate created in Data ONTAP 7. Use -force-hybrid-enabled to override this behavior. Note that read caching will be enabled on these FlexVols, but write
caching will be disabled.Setting this parameter to true would mark the aggregate as
hybrid_enabled; this means that the aggregate can contain a mix of SSDs and HDDs
(Hard Disk Drives, for example, SAS, SATA and/or FC). This parameter is used to
force marking aggregates which have FlexVols that cannot be write cached as hybrid
enabled. FlexVols in the aggregate marked as hybrid enabled using this parameter
which cannot participate in write-caching will only have read-caching enabled. All other
FlexVols in the aggregate can participate in both read and write caching.
This parameter specifies the maximum number of disks that can be included in a RAID
group for this aggregate.
Note:
For Flash Pools, this option controls the maximum size of the HDD RAID groups.
[-cache-raid-group-size <integer>] - Flash Pool SSD Tier Maximum RAID Group Size
This parameter specifies the maximum number of disks that can be included in a SSD
RAID group for this Flash Pool.
Note:
This parameter is applicable only for Flash Pools.
950
This parameter specifies the RAID type for RAID groups on the aggregate. Possible
values are raid4 for RAID 4 and raid_dp for RAID-DP.
[-resyncsnaptime <integer>] - SyncMirror Resync Snapshot Frequency in Minutes
This parameter sets the mirror resynchronization snapshot frequency to be the given
number of minutes. The default value is 60 (minutes).
[-state <aggregate state>] - State
This deprecated parameter specifies the state of the aggregate. Possible values are as
follows:
online - Immediately sets the aggregate online. All volumes on the aggregate are
set to the state they were in when the aggregate was taken offline or restricted.
The preferred command to bring an aggregate online is storage aggregate
online.
offline - Takes an aggregate offline. You cannot take an aggregate offline if any
of its volumes are online. The preferred command to take an aggregate offline is
storage aggregate offline.
restricted - Restricts the aggregate. You cannot restrict an aggregate if any of its
volumes are online. The preferred command to restrict an aggregate is storage
aggregate restrict.
advanced)
This specifies whether the aggregate is considered by the Auto Balance Aggregate
feature. If the Auto Balance Aggregate feature is not used, this field is not used. When
this parameter is set to true the Auto Balance Aggregate feature might recommend
moving volumes to or from this aggregate in order to balance system workload. When
this parameter is set to false the aggregate will not be considered as a destination for
the Auto Balance Aggregate feature allowing for predictability in data placement. The
Examples
The following example changes all RAID groups on an aggregate named aggr0 to use
RAID-DP.
cluster1::> storage aggregate modify -aggregate aggr0 -raidtype raid_dp
See Also
951
storage aggregate scrub storage aggregate online. storage aggregate offline.

storage aggregate restrict.
952
storage aggregate offline

Offline an aggregate
level.
Description
The storage aggregate offline command takes an aggregate offline.
If you are taking a root aggregate offline, the node owning the aggregate must be in
maintenance mode.
Parameters
The name of the aggregate to be taken offline.
Examples
The following example takes an aggregate named aggr1 offline:
cluster1::> storage aggregate offline -aggregate aggr1
See Also
953

Online an aggregate
level.
Description
The storage aggregate online command brings an aggregate online if the
aggregate is in offline or restricted state. If an aggregate is in an inconsistent state, it
must be brought to a consistent state before it can be brought online. If you have an
aggregate that is in an inconsistent state, contact technical support.
Parameters
The name of the aggregate to be brought online.
Examples
The following example brings an aggregate named aggr1 online:
cluster1::> storage aggregate online -aggregate aggr1
See Also
storage aggregate offline storage aggregate restrict
954
storage aggregate remove-stale-record

Remove a stale aggregate record
privilege level.
Description
The storage aggregate remove-stale-record command removes a stale
storage aggregate record on disk. A stale aggregate record refers to an aggregate that
has been removed from the storage system, but whose information remains recorded
on disk. Stale aggregate records are displayed in the nodeshell aggr status -r command,
but the storage aggregate show command does not show the aggregate as hosted on
that node.
Parameters
This parameter specifies the aggregate that corresponds to the stale aggregate record
that is to be deleted.
-nodename {<nodename>|local} - Node Name
This parameter specifies the node that contains the aggregate.
Examples
The following example removes a stale aggregate record that refers to aggregate
"aggr1":
cluster1::> storage aggregate remove-stale-record -aggregate aggr1 -nodename
node1
storage aggregate rename

Rename an aggregate
level.
955
Description
The storage aggregate rename command renames an aggregate.
Parameters
This parameter specifies the aggregate to be renamed.
-newname <aggregate name> - New Name
This parameter specifies the new name for the aggregate.
Examples
The following example renames an aggregate named aggr5 as sales-aggr:
cluster1::> storage aggregate rename -aggregate aggr5 -newname sales-aggr
storage aggregate restrict

Restrict an aggregate
level.
Description
The storage aggregate restrict command puts an aggregate in restricted state
to make data in the aggregate's volumes unavailable to clients. When an aggregate is in
restricted state data access is not allowed. However, few operations such as aggregate
copy, parity recomputation, scrub and RAID reconstruction are allowed. You can also
use this command if you want the aggregate to be the target of an aggregate copy or
SnapMirror replication operation.
Parameters
The name of the aggregate to be restricted.
Examples
956
The following example restricts an aggregate named aggr1:

cluster1::> storage aggregate restrict -aggregate aggr1
See Also
957
storage aggregate scrub

Aggregate parity scrubbing
level.
Description
The storage aggregate scrub command scrubs an aggregate for media and parity
errors. Parity scrubbing compares the data disks to the parity disks in their RAID group
and corrects the parity disks contents, as required. If no name is given, parity scrubbing
is started on all online aggregates.
Note:
By default, scrubs are scheduled to run for a specified time on a weekly basis. However,
you can use this command to run scrubs manually to check for errors and data
inconsistencies.
Parameters
This parameter specifies the aggregate to be scrubbed for errors.
[-plex <text>] - Plex
This parameter specifies the name of the plex to scrub. If this parameter is not specified,
the command scrubs the entire aggregate.
[-raidgroup <text>] - RAID Group
This parameter specifies the RAID group to be scrubbed. If this parameter is not
specified, the command scrubs the entire aggregate.
-action {start|stop|resume|suspend|status} - Action
This parameter specifies the action to be taken. The possible actions are:
start - Starts a scrub.
stop - Permanently stops a scrub. A stopped scrub cannot be resumed.
resume - Resumes a suspended parity scrub.
suspend - Suspends a parity scrub.
958
status - Displays the current status of a scrub.
Examples
The following example starts a scrub on a RAID group named rg0 on an aggregate
named aggr0:
cluster1::> storage aggregate scrub -aggregate aggr0 -raidgroup rg0 -action start
The following example queries the status of a scrub:

cluster1::> storage aggregate scrub -aggregate aggr0 -raidgroup rg0 -action
status
Raid Group:/aggr0/plex0/rg0, Is Suspended:false, Last Scrub:Sun Nov 13
01:30:55 2011
, Percentage Completed:7%
The following example starts a scrub on plex1 of an aggregate named aggr1:

cluster1::> storage aggregate scrub -aggregate aggr1 -plex plex1 -action start
The following example queries the status of plex1 of an aggregate named aggr1:
cluster1::> storage aggregate scrub -aggregate aggr1 -plex plex1 -action status
Raid Group:/aggr1/plex1/rg0, Is Suspended:false, Last Scrub:Sun Nov 13 02:07:29

2011
The following example queries the status of all the plexes for an aggregate named
aggr1:
cluster1::> storage aggregate scrub -aggregate aggr1 -action status
2011
2011
959
960
storage aggregate show-resync-status

Display aggregate resynchronization status
level.
Description
The storage aggregate show-resync-status command displays resync
status information for each plex. The command output depends on the parameter or
parameters specified with the command. If no parameters are specified, the command
displays the following information about all aggregates:
Aggregate Name
Resyncing Plex Name
Resyncing Percentage
Parameters
specify.
| [-instance ] }
about all fields.
This parameter specifies the name of the aggregate.
[-plex <text>] - Plex Name
This parameter specifies the name of the plex.
Displays plex status. Possible values are:
normal
failed
961
empty
invalid
uninitialized
failed assimilation
limbo
active
inactive
resyncing
These values may appear by themselves or in combination separated by commas; for
example, "normal,active".
[-is-online {true|false}] - Is Online
Indicates whether the plex is online.
[-in-progress {true|false}] - Resync is in Progress
Indicates whether the plex is currently resyncing.
[-resyncing-percent <percent>] - Resyncing Percentage
Displays the resynchronization completion percentage if the plex is currently being
resynced, '-' otherwise.
[-resync-level <integer>] - Resync Level
Displays the resync level if the plex is currently being resynced, '-' otherwise.
[-pool <integer>] - Pool
The pool number to which the majority of disks in the plex belong.
Examples
The following example displays resynchronization status for all the aggregates:
cluster1::> storage aggregate show-resync-status
Complete
Aggregate Resyncing Plex
Percentage
--------- ------------------------- ----------
962
aggr0
plex0
aggr1
plex0
aggr1
plex1
10%
aggr2
plex0
aggr2
plex2
See Also
storage aggregate plex show
963
storage aggregate show-scrub-status

Display aggregate scrubbing status
level.
Description
The storage aggregate show-scrub-status command displays the following
information about the scrub status of aggregates:
Aggregate name
RAID groups
Whether the scrub is suspended
Percentage of the scrub that is completed
Last scrub time of the aggregate
Parameters
specify.
| [-instance ] }
about all fields.
If this parameter is specified, the command displays detailed scrub-status information
about the specified aggregate.
[-raidgroup <text>] - RAID Group
If this parameter is specified, the command displays information only about the
aggregate that contains the specified RAID group.
[-suspended {true|false}] - Is Suspended
964
aggregates that have the specified scrub-suspension state (true or false).
[-complete-percentage <percent>] - Percentage Completed
aggregates whose scrubs have the specified completed percentage.
[-last-scrub-time <MM/DD/YYYY HH:MM:SS>] - Last Scrub Time
aggregates that have the specified last-scrub time, in the format MM/DD/YYYY
HH:MM:SS.
Examples
The following example displays scrub-status information for all the aggregates:
cluster1::> storage aggregate show-scrub-status
Aggregate RAID Groups
Suspended
Percentage Last Scrub Time
--------- ------------------- ---------- ---------- -------------------aggr0
/aggr0/plex0/rg0
true
0% 3/31/2011
21:23:02
aggr1
/aggr1/plex0/rg1
true
45% 3/30/2011
01:05:00
aggr2
/aggr2/plex0/rg0
true
33% 3/30/2011
23:43:34
aggr3
/aggr3/plex0/rg1
true
79% 3/29/2011
00:34:36
The following example displays detailed information about the aggregate named aggr1:
cluster1::> storage aggregate show-scrub-status -instance -aggregate aggr1
Aggregate: aggr1
RAID Group: /aggr1/plex0/rg0
Is Suspended: false
Percentage Completed: 2%
Last Scrub Time: 3/31/2011 22:02:50
See Also
storage aggregate scrub
965
storage aggregate show-space

Display details of space utilization within an aggregate.
level.
Description
The storage aggregate show-space command displays information about space
utilization within aggregates. The command output breaks down space usage in the
specified aggregate by feature. If no parameters are specified, the command displays
this information about all aggregates:
Parameters
specify.
| [-instance ] }
about all fields.
[-aggregate <text>] - Aggregate Name
If this parameter is specified, the command displays information only about space used
in the specified aggregate or aggregates.
[-volume-footprints {<integer>[KB|MB|GB|TB|PB]}] - Volume Footprints
aggregate or aggregates that have the specified amount of space in use by volume
footprints. A volume's footprint is the overall amount of space that a volume occupies in
the aggregate, including the volume metadata and data.
[-volume-footprints-percent <percent_no_limit>] - Volume Footprints Percent
aggregate or aggregates whose volume footprints occupy the specified percentage of
space.
966
[-snap-size-total {<integer>[KB|MB|GB|TB|PB]}] - Total Space for Snapshot Copies in

Bytes
aggregate or aggregates that have the specified amount of space in use by aggregate
Snapshot copies. This field includes the space that is reserved for Snapshot copies and
is not available to volumes or aggregate data and metadata. It is set to 0 by default.
aggregate or aggregates that have the specified percentage of space in use by
aggregate Snapshot copies.
[-aggregate-metadata {<integer>[KB|MB|GB|TB|PB]}] - Aggregate Metadata
aggregate or aggregates that have the specified amount of space in use by aggregate
metadata.
[-aggregate-metadata-percent <percent_no_limit>] - Aggregate Metadata Percent
aggregate or aggregates that have the specified percentage of space in use by
aggregate metadata.
[-used-including-snapshot-reserve {<integer>[KB|MB|GB|TB|PB]}] - Total Used
aggregate or aggregates that have the specified amount of space in use in the
aggregate.
It is important to note that this parameter treats the entire Snapshot reserve as used
space since it is not available for volumes.
[-used-including-snapshot-reserve-percent <percent_no_limit>] - Total Used Percent
aggregate or aggregates that have the specified percentage of space in use in the
aggregate and its Snapshot reserve.
[-aggregate-size {<integer>[KB|MB|GB|TB|PB]}] - Size
aggregate or aggregates that have the specified size.
[-snapshot-reserve-unusable {<integer>[KB|MB|GB|TB|PB]}] - Snapshot Reserve
Unusable
967
aggregate or aggregates that have the specified amount of space reserved but unusable
in the volume.
Snapshot reserve can be diminished under certain conditions to accomodate volume
metadata. Creating space in the aggregate will make this space available.
[-snapshot-reserve-unusable-percent <percent_no_limit>] - Snapshot Reserve
Unusable Percent
aggregate or aggregates that have the specified percentage of space reserved but
unusable.
[-physical-used {<integer>[KB|MB|GB|TB|PB]}] - Total Physical Used Size
aggregate or aggregates that have the specified amount of physical space in use by the
aggregate.
This differs from total-used space by the space that is guaranteed for future writes. The
value includes blocks in use by Snapshot copies.
[-physical-used-percent <percent_no_limit>] - Physical Used Percentage
aggregate or aggregates that have the specified percentage of physical space in use in
the aggregates.
Examples
The following example displays information about all aggregates:
cluster1::> storage aggregate show-space

Aggregate : aggr0
Feature
-------------------------------Volume Footprints
Aggregate Metadata
Snapshot Reserve
Total Used
968
Used
Used%
----------
------
5.75GB
91%
380KB
0%
325.3MB
5%
6.07GB
96%
Total Physical Used
221.9MB
3%
Aggregate : aggr1
Feature
Used
Used%
----------
------
2.03GB
33%
304KB
0%
Total Used
2.03GB
33%
Total Physical Used
2.23MB
0%
-------------------------------Volume Footprints
Aggregate Metadata
969
storage aggregate show-spare-disks

Display spare disks
level.
Description
The command storage aggregate show-spare-disks displays information about
spare disks. The command output depends on the parameter or parameters specified
with the command. If no parameters are specified, the command displays information
about all spare disks in the cluster.
Parameters
specify.
| [-instance ] }
If this parameter is specified, the command displays detailed information about each
spare disk.
[-original-owner <text>] - Original Owner
Selects the spare disks that match this parameter value.
[-disk <disk path name>] - Disk Name
[-checksum-style {advanced_zoned | block | none | zoned/advanced_zoned}] Checksum Style
Selects the spare disks that match this parameter value. Possible values are:
block -- Supports block checksum
advanced_zoned -- Supports advanced zone checksum
zoned/advanced_zoned -- Supports zoned and advanced zoned checksums
none -- No checksum support
970
[-disk-type {ATA | BSAS | EATA | FCAL | FSAS | LUN | MSATA | SAS | SATA | SCSI |
SSD | XATA | XSAS | VMDISK}] - Disk Type
[-effective-disk-type {ATA | BSAS | EATA | FCAL | FSAS | LUN | MSATA | SAS | SATA |
SCSI | SSD | XATA | XSAS | VMDISK}] - Effective Disk Type
Hard disk drives with the same effective-disk-type value may be mixed together
in the same aggregate depending upon the system's raid.mix.hdd.disktype.capacity and
raid.mix.hdd.disktype.performance option settings.
[-disk-rpm <integer>] - Disk RPM
[-effective-disk-rpm <integer>] - Effective Disk RPM
Hard disk drives with the same effective-disk-rpm value may be mixed together
in the same aggregate depending upon the system's raid.mix.hdd.rpm.capacity and
raid.mix.hdd.rpm.performance option settings.
[-syncmirror-pool <text>] - Pool Number
[-owner-name {<nodename>|local}] - Current Owner
[-home-owner-name {<nodename>|local}] - Home Owner
[-dr-owner-name {<nodename>|local}] - DR Home Owner
[-usable-size-blks <integer>] - Disk Usable Size in 4K blocks
[-local-usable-data-size-blks <integer>] - Local Node Data Usable Size in 4K blocks
Disks that have two partitions can be used for one root aggregate and one data
aggregate.
This value describes the data partition size in 4KB blocks.
971
[-local-usable-root-size-blks <integer>] - Local Node Root Usable Size in 4K blocks

aggregate.
This value describes the root partition size in 4KB blocks.
[-usable-size {<integer>[KB|MB|GB|TB|PB]}] - Disk Usable Size
[-total-size {<integer>[KB|MB|GB|TB|PB]}] - Total Size
[-local-usable-data-size {<integer>[KB|MB|GB|TB|PB]}] - Local Node Data Usable Size
aggregate.
This value describes the data partition size in auto-scaled units.
[-local-usable-root-size {<integer>[KB|MB|GB|TB|PB]}] - Local Node Root Usable Size
aggregate.
This value describes the root partition size in auto-scaled units.
[-is-disk-zeroed {true|false}] - Is Disk Zeroed?
When disks are zeroed, they can be provisioned directly into aggregates which avoids a
lengthy zeroing process.
[-is-disk-zeroing {true|false}] - Is Disk Zeroing?
[-zeroing-percent <percent>] - Zeroing Percentage Completed
[-is-sparecore {true|false}] - Sparecore Disk?
[-sparecore-status <Spare core status>] - Sparecore Status
972

[-sparecore-percent <percent>] - Sparecore Percentage Completed
[-is-disk-shared {true|false}] - Is Disk Shared?
Shared disks have partitions that allow them to be used in multiple aggregates and
between nodes in an HA pair. When set to true, this parameter selects shared disks in
which the root partition and/or the data partition is a spare. When set to false only spare
disks without partitions are displayed. When this parameter is not used, all spare disks
are displayed.
[-is-disk-offline {true|false}] - Is Disk Offline?
Disk offline events are typically temporary events which allow Data ONTAP to perform
background error recovery activity.
[-is-disk-sick {true|false}] - Is Disk Sick?
A sick disk triggers Rapid RAID Recovery to copy data to a spare drive. At the end of
the process the sick disk is marked as broken.
[-is-disk-left-behind {true|false}] - Is Disk Left Behind Spare?
Disks are left behind if they are not responding during a giveback or switchback event.
Examples
Display spare disks owned by node node-b.
cluster1::> storage aggregate show-spare-disks -owner-name node-b
Original Owner: node-b
Pool0
Spare Pool
Usable Physical
Disk
Type
RPM Checksum
Size
Size Status
--------------------------- ----- ------ -------------- -------- ---------------
973
1.1.13
BSAS
7200 block
827.7GB
828.0GB zeroed
1.1.15
BSAS
7200 block
413.2GB
414.0GB zeroed

Pool0
Shared HDD Spares
Local
Local
Data
Root
Usable
Usable
Physical
Disk
Size Status
Type
RPM Checksum
--------------------------- ----- ------ -------------- -------- --------------- -------1.0.8

547.1GB zeroed
SAS
10000 block
472.9GB
73.89GB
Check on the progress of a previous disk zeroing command.

cluster1::> storage aggregate show-spare-disks -owner-name node-b -zeroingpercent >0
Pool0
Spare Pool
Usable Physical
Disk
Type
RPM Checksum
Size
Size Status
--------------------------- ----- ------ -------------- -------- --------------1.1.13

zeroing, 17% done
BSAS
7200 block
827.7GB
828.0GB
1.1.15
zeroing, 28% done
BSAS
7200 block
413.2GB
414.0GB
See Also
storage disk zerospares storage raid-options
974
storage aggregate show-status

Display aggregate configuration
level.
Description
The storage aggregate show-status command displays the RAID layout and
disk configuration of aggregates. The command output depends on the parameter or
displays information about all aggregates in the cluster.
Note:
This command does not use pagination. You can reduce the output by filtering with the
parameters below.
Parameters
specify.
| [-instance ] }
This parameter currently has no effect.
[-aggregate-uuid <UUID>] - Aggregate UUID
Examples
Display the RAID layout of a Flash Pool aggregate.
975
cluster1::> storage aggregate show-status -aggregate nodeB_flashpool_1

Owner Node: node-b
Aggregate: nodeB_flashpool_1 (online, raid_dp, hybrid) (block checksums)
Plex: /nodeB_flashpool_1/plex0 (online, normal, active, pool0)
RAID Group /nodeB_flashpool_1/plex0/rg0 (normal, block checksums)
Usable Physical
Position Disk
Status
Pool Type
RPM
Size
Size
-------- --------------------------- ---- ----- ------ -------- ----------------dparity

(normal)
1.1.7
BSAS
7200
827.7GB
828.0GB
parity
(normal)
1.1.8
BSAS
7200
827.7GB
828.0GB
data
(normal)
1.1.10
BSAS
7200
827.7GB
828.0GB
data
(normal)
1.1.11
BSAS
7200
827.7GB
828.0GB
data
(normal)
1.1.12
BSAS
7200
827.7GB
828.0GB
RAID Group /nodeB_flashpool_1/plex0/rg1 (normal, block checksums) (Storage

Pool: SP2)
Usable Physical
Position Disk
Status
Pool Type
RPM
Size
Size
-------- --------------------------- ---- ----- ------ -------- -----------------
976
shared
(normal)
1.0.22
SSD
186.2GB
745.2GB
shared
(normal)
1.0.20
SSD
186.2GB
745.2GB
shared
(normal)
1.0.18
SSD
186.2GB
745.2GB
shared
(normal)
1.0.16
SSD
186.2GB
745.2GB

Display a list of aggregates
level.
Description
The storage aggregate show command displays information about aggregates.
The command output depends on the parameter or parameters specified with the
command. If no parameters are specified, the command displays the following
information about all aggregates:
Aggregate name
Size
Available size
Percentage used
State
Number of volumes
Node on which the aggregate is located
RAID status
To display detailed information about a single aggregate, use the -aggregate
parameter.
Parameters
specify.
| [-checksum ]
If this parameter is specified, the command displays information about the checksum for
all aggregates in the cluster:
Aggregate name
977
Checksum status (active, off, reverting, none, unknown, initializing, reinitializing,

reinitialized, upgrading_phase1, upgrading_phase2)
Checksum style (none, advanced_zoned, zoned, block, mixed, WAFL, or
unknown)
| [-disk ]
If this parameter is specified, the command displays disk names for all aggregates in the
cluster:
Aggregate name
Number and names of disks in the aggregate
| [-raid-info ]
If this parameter is specified, the command displays information about RAID groups,
RAID type, maximum RAID size, checksum state, checksum style and whether the
RAID status is inconsistent.
| [-instance ] }
If this parameter is specified, the command displays detailed information about all
aggregates in the cluster.
If this parameter is specified, the command displays detailed information about the
specified aggregate.
[-chksumstyle <aggrChecksumStyle>] - Checksum Style
aggregates that use the specified checksum style.
[-diskcount <integer>] - Number Of Disks
aggregates that have the specified number of disks.
[-mirror | -m [true]] - Mirror
aggregates that have the specified mirrored value.
aggregates that are located on the specified node.
978
[-disklist | -d <disk path name>, ...] - Disks for First Plex

aggregates that have the specified disk or disks.
aggregates that has the specified disk or disks present in the mirrored plex.
[-free-space-realloc {on|off|no_redirect}] - Free Space Reallocation
If this parameter is specified, the command displays whether free space reallocation is
enabled on the specified aggregate.
[-ha-policy {sfo|cfo}] - HA Policy
This optionally specifies the high-availability policy to be used in the context of a root
recovery procedure. Do not modify this setting unless directed to do so by a customer
support representative.
aggregate or aggregates that have the specified space reserved for Snapshot copies.
[-space-nearly-full-threshold-percent <percent>] - Aggregate Nearly Full Threshold
Percent
aggregate or aggregates that have the specified nearly full threshold percent.
[-space-full-threshold-percent <percent>] - Aggregate Full Threshold Percent
aggregate or aggregates that have the specified full threshold percent.
[-hybrid-enabled {true|false}] - Hybrid Enabled
aggregates that are eligible to contain both SSD and non-SSD RAID groups.
[-availsize {<integer>[KB|MB|GB|TB|PB]}] - Available Size
aggregates that have the specified available size.
[-chksumenabled {true|false}] - Checksum Enabled
aggregates that have the specified checksum setting.
979
[-chksumstatus <text>] - Checksum Status

aggregates that have the specified checksum status. Possible values for checksum
status include the following: active, off, reverting, none, unknown, initializing,
reinitializing, reinitialized, upgrading_phase1, and upgrading_phase2.
[-cluster <text>] - Cluster
aggregates that are owned by nodes in the specified cluster. By default, only local
cluster aggregates are displayed.
[-cluster-id <UUID>] - Home Cluster ID
aggregates that are owned by nodes in the cluster specified by the cluster UUID. By
default, only local cluster aggregates are displayed.
[-dr-home-id <integer>] - DR Home ID
aggregates whose Disaster Recovery home node has the specified system ID.
[-dr-home-name <text>] - DR Home Name
aggregates whose Disaster Recovery home is the specified node.
[-has-mroot {true|false}] - Has Mroot Volume
If this parameter is specified, the command displays information about only the
aggregates that contain their owning node's management root directory.
[-has-partner-mroot {true|false}] - Has Partner Node Mroot Volume
aggregates that contain the management root directory of their owning node's failover
partner.
[-home-id <integer>] - Home ID
aggregates whose home node has the specified system ID.
[-home-name <text>] - Home Name
aggregates whose home node is the specified node.
[-hybrid-cache-size-total {<integer>[KB|MB|GB|TB|PB]}] - Total Hybrid Cache Size
980
aggregates that have the specified total cache size in a Flash Pool.
[-hybrid {true|false}] - Hybrid
aggregates that currently contain both SSD and non-SSD RAID groups.
[-inconsistent {true|false}] - Inconsistent
aggregates that have the specified consistency.
[-is-home {true|false}] - Is Aggregate Home
aggregates whose home node and owner node have the same system ID.
aggregates that have the specified maximum number of disks for RAID groups.
Note:
For Flash Pools, this option controls the maximum size of the HDD RAID groups.
[-cache-raid-group-size <integer>] - Flash Pool SSD Tier Maximum RAID Group Size
If this parameter is specified, the command displays information about the maximum
RAID group size for the SSD tier for Flash Pools.
Note:
This parameter is applicable only for Flash Pools.
[-owner-id <integer>] - Owner ID
aggregates that are owned by the node with the specified system ID.
[-owner-name <text>] - Owner Name
aggregates that are owned by the specified node.
[-percent-used <percent>] - Used Percentage
aggregates that have the specified used size, as a percentage.
981
[-plexes <text>, ...] - Plexes

aggregates that have the specified plex or plexes.
[-raidgroups <text>, ...] - RAID Groups
aggregates that have the specified RAID group or groups.
[-raidstatus <text>] - RAID Status
aggregates that have the specified RAID status. Possible values for RAID status are
normal, copying, ironing, degraded, mirror degraded, growing, initializing, invalid, needs
check, partial, reconstruct, raid4, raid0, raid_dp, redirect, and wafl inconsistent. You can
specify multiple values (for example, reconstruct,growing).
aggregates that use the specified RAID type.
[-resyncsnaptime <integer>] - SyncMirror Resync Snapshot Frequency in Minutes
aggregates whose SyncMirror Resynchronization Snapshot Frequency is the specified
value.
[-root {true|false}] - Is Root
If this parameter is specified, the command displays information about only the root
aggregates in the cluster.
[-sis-metadata-space-used {<integer>[KB|MB|GB|TB|PB]}] - Space Used by Metadata
for Volume Efficiency
aggregates with the specified space used by A-SIS metafiles for volume efficiency. This
parameter is deprecated in Data ONTAP 8.2 and later. Use the volume-footprint-list-info
API for details related to space usage by deduplication metadata
[-size {<integer>[KB|MB|GB|TB|PB]}] - Size
aggregates that have the specified size.
[-state <aggregate state>] - State
aggregates that have the specified state.
982
[-usedsize {<integer>[KB|MB|GB|TB|PB]}] - Used Size

aggregates that have the specified used size.
[-uses-shared-disks {true|false}] - Uses Shared Disks
Selects the aggregates that match this parameter value. This parameter is used to list
all the aggregates that use shared HDDs or shared SSDs.
[-uuid <text>] - UUID String (privilege: advanced)
aggregate that has the specified UUID. This parameter is available only at the advanced
privilege level and higher.
[-volcount <integer>] - Number Of Volumes
aggregates that have the specified number of volumes.
advanced)
aggregate or aggregates that are considered by the Auto Balance Aggregate feature.
[-autobalance-state <Auto Balance Aggregate state>] - State of the aggregate being
balanced (privilege: advanced)
aggregate or aggregates that have the specified state.
aggregate or aggregates that have the specified physical used size. This differs from
total-used space by the space that is guaranteed for future writes. The value includes
blocks in use by Snapshot copies.
aggregate or aggregates that have the specified physical used percent.
[-autobalance-state-change-counter <integer>] - State Change Counter for Auto
Balancer (privilege: advanced)
aggregate or aggregates that have the specified number of state change caused by the
Auto Balance Aggregate feature.
983
[-aggregate-type {hdd | hybrid | lun | ssd | vmdisk}] - Aggregate Type

aggregates with the specified aggregate type. Possible values are hdd, hybrid, lun, ssd
and vmdisk.
Examples
The following example displays information about all aggregates that are owned by
nodes in the local cluster:
cluster1::> storage aggregate show
Aggregate
Size Available Used% State
#Vols Nodes
RAID Status
--------- -------- --------- ----- ------- ------ ---------------
------------
aggr0
raid_dp,
6.21TB
1.78TB
71% online
49 cluster1-01
normal
aggr1
56.04MB
55.89MB
0% online
0 cluster1-02
raid_dp,
mirrored,
normal
aggr2
1.77TB
1.63TB
8% online
1 cluster1-01
raid_dp,
normal
aggr3
1.77TB
1.73TB
2% online
2 cluster1-02
raid_dp,
normal
The following example displays information about an aggregate name aggr1:

cluster1::> storage aggregate show -aggregate aggr1
Aggregate: aggr1
Checksum Style: block
Number Of Disks: 6
Mirror: true
Nodes: cluster1-02
Disks for First Plex: 1.1.2,
1.1.10,
1.1.11
Disks for Mirrored Plex: 1.1.6,
1.1.8,
1.1.9
984
Free Space Reallocation: off

HA Policy: sfo
Space Reserved for Snapshot Copies: 5%
Hybrid Enabled: false
Available Size: 53.10MB
Block Type: 64-bit
Checksum Enabled: true
Checksum Status: active
Cluster: cluster1
Home Cluster ID:
686964a0-2172-11e3-837d-123478563412
DR Home ID: DR Home Name: Has Mroot Volume: false
Has Partner Node Mroot Volume: false
Home ID: 4050409551
Home Name: cluster1-02
Total Hybrid Cache Size: 0B
Hybrid: false
Inconsistent: false
Is Aggregate Home: true
Max RAID Size: 16
Hybrid Aggregate SSD Tier Maximum RAID Group Size: Owner ID: 4050409551
Owner Name: cluster1-02
Used Percentage: 0%
Plexes: /aggr1/plex0, /aggr1/plex1
RAID Groups: /aggr1/plex0/rg0 (block)
/aggr1/plex1/rg0 (block)
RAID Status: raid_dp, mirrored, normal
RAID Type: raid_dp
SyncMirror Resync Snapshot Frequency in Minutes: 60
Is Root: false
Space Used By metadata for Volume Efficiency: 0B
Size: 53.24MB
State: online
Used Size: 144KB
Number Of Volumes: 0
Is Flash Pool Caching: Is Eligible for Auto Balance Aggregate: false
State of the aggregate being balanced: ineligible
985
State Change Counter for Auto Balancer: 0
The following example displays information about aggregates that are owned by nodes
in cluster1:
cluster1::> storage aggregate show -cluster cluster1
cluster1:
Aggregate
#Vols
Nodes
RAID Status
--------- -------- --------- ----- ------- ------ ---------------- -----------aggr0
6.04GB
3.13GB
48% online
2 cluster1-01
raid_dp,
mirrored,
normal
aggr1
53.24MB
12.59MB
76% online
2 cluster1-02
raid_dp,
mirrored,
normal
in the remote cluster named cluster2:
cluster1::> storage aggregate show -cluster cluster2
cluster2:
Aggregate
#Vols
Nodes
RAID Status
--------- -------- --------- ----- ------- ------ ---------------- -----------aggr2
- remote_cluster
aggr3
- remote_cluster
- -
- -
in all the clusters:
cluster1::> storage aggregate show -cluster *
cluster2:
Aggregate
986
#Vols
Nodes
RAID Status
--------- -------- --------- ----- ------- ------ ---------------- -----------aggr2
- remote_cluster
aggr3
- remote_cluster
- - -
cluster1:
Aggregate
#Vols
Nodes
RAID Status
--------- -------- --------- ----- ------- ------ ---------------- -----------aggr0
6.04GB
3.14GB
48% online
2 cluster1-01
raid_dp,
mirrored,
normal
aggr1
53.24MB
12.59MB
76% online
2 cluster1-02
raid_dp,
mirrored,
normal
987
storage aggregate verify

Verify an aggregate
level.
Description
The storage aggregate verify command verifies the two plexes of an aggregate.
It compares the data in the two plexes to ensure that the plexes are identical. It can be
used whenever the administrator needs to ensure that the two plexes are completely
synchronized with each other.
Parameters
This parameter specifies the aggregate to be verified. If no aggregate is specified then
the action specified by the parameter -action will be taken on all the aggregates.
-action {start|stop|resume|suspend|status} - Action
This parameter specifies the action to be taken. The possible actions are:
start - Starts a verify.
stop - Permanently stops a verify. A stopped verify cannot be resumed.
resume - Resumes a suspended verify.
suspend - Suspends a verify.
status - Displays the current status of a verify.
[-plex-to-fix <text>] - Plex to be Corrected in Case of Mismatches
This parameter specifies the name of a plex to fix in case the two plexes of the
aggregate do not match. The default behavior is to log any discrepancies instead of
fixing them.
Note:
This parameter is only applicable when the command is used to start a verify.
Examples
988
The following example starts a verify on an aggregate named aggr1.

cluster1::> storage aggregate verify -aggregate aggr1 -action start
The following example queries the status of a verify on an aggregate named aggr1.
cluster1::> storage aggregate verify -aggregate aggr1 -action status
Aggregate:aggr1, Is Suspended:false, Percentage Completed:7%
The following example starts a verify on all the aggregates.

cluster1::> storage aggregate verify -action start
storage aggregate plex delete

Delete a plex
level.
Description
The storage aggregate plex delete command deletes the specified plex.
The aggregate specified with then -aggregate will be unmirrored and contain the
remaining plex. The disks in the deleted plex become spare disks.
Parameters
Name of an existing aggregate which contains the plex specified with the -plex
parameter.
-plex <text> - Plex
Name of a plex which belongs to the aggregate specified with the -aggregate
parameter.
Examples
The following example deletes plex0 of aggregate aggr1:
989
cluster1::> storage aggregate plex delete -aggregate aggr1 -plex plex0
storage aggregate plex offline

Offline a plex
level.
Description
The storage aggregate plex offline command takes the specified plex offline.
The aggregate specified with the -aggregate parameter must be a mirrored aggregate
and both plexes must be online. Prior to taking a plex offline, the system will flush all
internally-buffered data associated with the plex and create a snapshot that is written
out to both plexes. The snapshot allows for efficient resynchronization when the plex is
subsequently brought back online.
Parameters
parameter.
-plex <text> - Plex
parameter.
Examples
The following example takes plex0 of aggregate aggr1 offline:
cluster1::> storage aggregate plex offline -aggregate aggr1 -plex plex0
storage aggregate plex online

Online a plex
level.
990
Description
The storage aggregate plex online command brings the specified plex online.
The aggregate specified with the -aggregate parameter must be an online mirrored
aggregate. The system will initiate resynchronization of the plex as part of online
processing.
Parameters
parameter.
-plex <text> - Plex
parameter.
Examples
The following example brings plex0 of aggregate aggr1 online:
cluster1::> storage aggregate plex online -aggregate aggr1 -plex plex0
storage aggregate plex show

Show plex details
level.
Description
The storage aggregate plex show command displays information for the
specified plex. By default, the command displays the following information about all
plexes:
Aggregate Name
Plex Name
Is Online
Is Resyncing
991
Resyncing Percentage
Plex Status
To display detailed information about a single plex, use the -aggregate and -plex
parameter.
Parameters
specify.
| [-instance ] }
about all fields.
parameter.
parameter.
Displays plex status. Possible values are:
normal
failed
empty
invalid
uninitialized
failed assimilation
limbo
active
inactive
992
resyncing
These values may appear by themselves or in combination separated by commas, for
example, "normal,active".
[-is-online {true|false}] - Is Online
Selects the plexes that match this parameter value.
[-in-progress {true|false}] - Resync is in Progress
[-resyncing-percent <percent>] - Resyncing Percentage
[-resync-level <integer>] - Resync Level
[-pool <integer>] - Pool
Examples
The following example displays information about all the plexes for all the aggregates:
cluster1::> storage aggregate plex show
Aggregate Plex
Is
Is
Online
Resyncing
Resyncing
Percent Status
--------- --------- ------- ---------- --------- --------------aggr0
plex0
true
false
- normal,active
aggr1
plex0
true
false
- normal,active
aggr1
plex1
true
false
- normal,active
aggr2
plex0
true
false
- normal,active
aggr2
plex2
true
false
- normal,active
The following example displays information about plex1 of aggregate aggr1:

cluster1::> storage aggregate plex show -aggregate aggr1 -plex plex1
Aggregate: aggr1
Plex Name: plex1
993
Status: normal,active
Is Online: true
Resync is in Progress: false
Resyncing Percentage: Resync Level: Pool: 1
994
storage aggregate relocation show

Display relocation status of an aggregate
level.
Description
The storage aggregate relocation show command displays status of
aggregates which were relocated in the last instance of relocation operation.
Parameters
If you specify the -fields <fieldname>, ... parameter, the command only
displays the fields that you specify.
| [-instance ] }
about all entries.
Selects aggregates from the specified source node.
[-relocation-status <text>] - Aggregates Relocation Status
Selects the aggregates whose relocation status matches this parameter value.
[-destination <text>] - Destination for Relocation
Selects the aggregates that are designated for relocation on the specified destination
node.
Examples
The following example displays the relocation status of aggregates on all nodes in the
cluster:
cluster1::> storage aggregate relocation show
Source
Aggregate
Destination
Relocation Status
995
-------------- ---------- -----------
-----------------
node0
-
Not attempted yet
aggr1
node0
Done
aggr2
node0
In progress
aggr3
node0
Not attempted yet
node1
996
storage aggregate relocation start

Relocate aggregates to the specified destination
level.
Description
The storage aggregate relocation start command initiates the relocation of
the aggregates from one node to the other node in the same cluster.
Parameters
-node {<nodename>|local} - Name of the Node that currently owns the aggregate
This specifies the source node where the aggregates to be relocated reside.
-destination {<nodename>|local} - Destination node
This specifies the destination node where aggregates are to be relocated.
-aggregate-list <aggregate name>, ... - List of Aggregates to be relocated
This specifies the list of aggregate names to be relocated from source node to
destination node.
[-override-vetoes {true|false}] - Override Vetoes
This specifies whether to override the veto checks for relocation operation. Initiating
aggregate relocation with vetoes overridden will result in relocation proceeding even if
the node detects outstanding issues that would make aggregate relocation dangerous or
disruptive. The default value is false.
[-relocate-to-higher-version {true|false}] - Relocate To Higher Version
This specifies if the aggregates are to be relocated to a node which is running on a
higher version of Data ONTAP than the source node. If an aggregate is relocated to
this destination then that aggregate cannot be relocated back to the source node till the
source is also upgraded to the same or higher Data ONTAP version. This option is not
required if the destination node is running on higher minor version, but the same major
version. The default value is false.
[-override-destination-checks {true|false}] - Override Destination Checks
This specifies if the relocation operation should override the check done on destination
node. This option could be used to force a relocation of aggregates even if the
997
destination has outstanding issues. Note that this could make the relocation dangerous
or disruptive. The default value is false.
[-ndo-controller-upgrade {true|false}] - Relocate Aggregates for NDO Controller
Upgrade (privilege: advanced)
This specifies if the relocation operation is being done as a part of non-disruptive
controller upgrade process. Aggregate relocation will not change the home ownerships
of the aggregates while relocating as part of controller upgrade. The default value is
false.
Examples
The following example relocates aggregates name aggr1 and aggr2 from source node
node0 to destination node node1:
cluster1::> storage aggregate relocation start -node node0 -destination node1 aggregate-list aggr1, aggr2
storage array modify

Make changes to an array's profile.
level.
Description
The storage array modify command lets the user change several array
parameters.
Parameters
-name <text> - Name
Storage array name, either generated by Data ONTAP or assigned by the user.
[-prefix <text>] - Prefix
Abbreviation for the named array.
[-vendor <text>] - Vendor
Array manufacturer.
[-model <text>] - Model
998
Array model number.

[-options <text>] - options
Vendor specific array settings.
[-max-queue-depth <integer>] - Target Port Queue Depth (privilege: advanced)
The target port queue depth for all target ports on this array.
[-lun-queue-depth <integer>] - LUN Queue Depth (privilege: advanced)
The queue depth assigned to array LUNs from this array.
[-is-upgrade-pending {true|false}] - Upgrade Pending (privilege: advanced)
The is-upgrade-pending status for the array.
Examples
This command changes the model to FastT.
cluster1::> storage array modify -name IBM_1722_1 -model FastT
storage array remove

Remove a storage array record from the array profile database.
level.
Description
The storage array remove command discards array profile records for a particular
storage array from the cluster database. Upon command completion, if a storage array
is still connected to the cluster, the array profile record is re-created with default values.
Parameters
-name <text> - Name
Name of the storage array you want to remove from the database.
Examples
cluster1::> storage array remove IBM_1722_1
999
storage array rename

Change the name of a storage array in the array profile database.
level.
Description
The storage array rename command permits substitution of the array profile
name which Data ONTAP assigned during device discovery. By default, the name that
Data ONTAP assigned to the storage array during discovery is shown in Data ONTAP
displays and command output.
Parameters
-name <text> - Name
Storage array name either generated by Data ONTAP or assigned by the user.
-new-name <text> - The new name to assign to this array profile. (28 chars max)
New name to assign to the storage array.
Examples
cluster1::> storage array rename -name HITACHI_DF600F_1 -new-name MyArray
storage array show

Display information about SAN-attached storage arrays.
level.
Description
The storage array show command displays information about arrays visible to the
cluster. If no parameters are specified, the command displays the following information
about all storage arrays:
1000
Prefix
Name
Vendor
Model
Options
To display detailed information about a single array, use the -name parameter. The
detailed view adds the following information:
Serial Number
Optimization Policy
Affinity
Errors
Parameters
specify.
| [-instance ] }
about all fields.
Selects the arrays that match this parameter value.
[-prefix <text>] - Prefix
Abbreviation for the named array.
Array manufacturer.
Array model number.
[-options <text>] - options
Vendor specific array settings.
1001
[-serial-number <text>] - Serial Number

Array product identifier.
[-max-queue-depth <integer>] - Target Port Queue Depth (privilege: advanced)
[-lun-queue-depth <integer>] - LUN Queue Depth (privilege: advanced)
[-is-upgrade-pending {true|false}] - Upgrade Pending (privilege: advanced)
[-optimization-policy {iALUA|eALUA|symmetric|proprietary|mixed|unknown}] Optimization Policy
[-affinity {none|aaa|ap|mixed|unknown}] - Affinity
[-error-text <text>, ...] - Error Text
Examples
The following example displays information about all arrays.
cluster1::> storage array show
Prefix
Name
Vendor
Model Options
------ ---------------------------- -------- ---------------- ---------HITACHI_DF600F_1
HITACHI
DF600F
IBM_1722_1
IBM
1722
The following example displays detailed information about a specific array:

cluster1::> storage array show -name HITACHI_DF600F_1
Name: HITACHI_DF600F_1
Prefix: abc
Vendor: HITACHI
Model: DF600F
1002
options:
Serial Number: 4291000000000000
Optimization Policy: iALUA
Affinity: aaa
Error Text:
1003
storage array config show

Display connectivity to back-end storage arrays.
level.
Description
The storage array config show command displays information about how the
storage arrays connect to the cluster, LUN groups, number of LUNS, and more. Use this
command to validate the configuration and to assist in troubleshooting.
Parameters
specify.
| [-switch ]
If you specify this parameter, switch port information is shown.
| [-instance ] }
about all fields.
[-node {<nodename>|local}] - Controller Name
[-group <integer>] - LUN Group
Selects the arrays that match this parameter value. A LUN group is a set of LUNs that
shares the same path set.
[-target-wwpn <text>] - Array Target Ports
Selects the arrays that match this parameter value (the World Wide Port Name of a
storage array port).
[-initiator <text>] - Initiator
Selects the arrays that match this parameter value (the host bus adapter that the
clustered node uses to connect to storage arrays).
1004
[-array-name <array name>] - Array Name

[-target-side-switch-port <text>] - Target Side Switch Port
[-initiator-side-switch-port <text>] - Initiator Side Switch Port
[-lun-count <integer>] - Number of array LUNs
[-ownership {all|assigned|unassigned}] - Ownership
Examples
cluster1::> storage array config show
LUN
Node
Initiator
LUN
Group Count
Array Name
Array Target Port
------------ ----- ----- ---------------------------- ------------------------------vnv3070f19a

0d
20
DGC_RAID5_1
5006016030229f13
5006016130229f13
0c
5006016830229f13
0b
5006016930229f13
0a
1
21
HITACHI_OPEN_1
50060e80034fe704
0c
0d
50060e80034fe714
0a
0b
50060e80034fe715
0b
50060e80034fe716
0c
0d
2
EMC_SYMMETRIX_1
50060482cb1bce1d
0a
1005
0b
5006048acb1bce0c
0c
0d
3
10
IBM_UniversalXport_1
202600a0b8322d10
0c
0d
204700a0b8322d10
0a
0b
vnv3070f19b
0d
20
DGC_RAID5_1
5006016030229f13
5006016130229f13
0c
5006016830229f13
0b
5006016930229f13
0a
1
21
HITACHI_OPEN_1
50060e80034fe704
0c
0d
50060e80034fe714
0a
0b
50060e80034fe715
0b
50060e80034fe716
0c
0d
2
EMC_SYMMETRIX_1
50060482cb1bce1d
0a
0b
5006048acb1bce0c
0c
0d
3
10
IBM_UniversalXport_1
202600a0b8322d10
0c
0d
204700a0b8322d10
0a
0b
1006
Warning: Configuration errors were detected.

detailed information.
Use 'storage errors show' for
1007
storage array port modify

Make changes to a target port record.
level.
Description
The storage array port modify command lets the user change array target port
parameters.
Parameters
-name <text> - Name
Selects the array ports that match this parameter value. The storage array name is
either generated by Data ONTAP or assigned by the user.
-wwnn <text> - WWNN
Selects the array ports that match this parameter value.
-wwpn <text> - WWPN
[-max-queue-depth <integer>] - Target Port Queue Depth
The target port queue depth for this target port.
[-utilization-policy {normal|defer}] - Utilization Policy
The policy used in automatically adjusting the queue depth of the target port based on
its utilization.
Examples
This command changes the maximum queue depth for this target port to 32.
cluster1::> storage array port modify -name HITACHI_DF600F_1 -wwnn
50060e80004291c0 -wwpn 50060e80004291c0 -max-queue-depth 32
storage array port remove

1008
Remove a port record from an array profile.

level.
Description
The storage array port remove command removes a port from the array
database. You might want to remove ports that are no longer connected to the clustered
node. Port information can change after hardware replacement, rezoning, or similar
configuration activities. The database retains the records about previous ports unless
you remove the information.
Parameters
-name <text> - Name
-wwnn <text> - WWNN
-wwpn <text> - WWPN
Examples
This command removes a port record from the array profiles database.
cluster1::> storage array port remove -name HITACHI_DF600F_1 -wwnn
50060e80004291c0 -wwpn 50060e80004291c0
storage array port show

Display information about a storage array's target ports.
level.
Description
The storage array port show command displays all the target ports known to the
cluster for a given storage array (if an array name is specified) or for all storage arrays
1009
if no storage array name is specified. Target ports remain in the database as part of an
array profile unless you explicitly remove them from the database.
Parameters
specify.
| [-instance ] }
about all fields.
[-wwnn <text>] - WWNN
[-wwpn <text>] - WWPN
[-max-queue-depth <integer>] - Target Port Queue Depth
[-node {<nodename>|local}, ...] - Controller Name
[-initiator-port <text>, ...] - Initiator Port
[-average-dynamic-queue-depth <integer>, ...] - Average Dynamic Queue Depth
(privilege: advanced)
The average value of the dynamic target port queue depth.
[-average-latency-per-iop <integer>, ...] - Average Latency Per IOP
[-average-pending <integer>, ...] - Average Pending (privilege: advanced)
1010
Selects the array ports that match this parameter value (average over time of how many
commands are on the outstanding queue).
[-average-waiting <integer>, ...] - Average Waiting (privilege: advanced)
Selects the array ports that match this parameter value (average over time of how many
commands are on the waiting queue).
[-connection-type {direct|fabric}] - Connection Type
Selects the array ports that match this parameter value (type of connection between the
controller and the back end storage).
[-dynamic-queue-depth <integer>, ...] - Dynamic Queue Depth (privilege: advanced)
Current dynamic target port queue depth, the maximum number of commands allowed
outstanding.
[-max-pending <integer>, ...] - Max Pending (privilege: advanced)
Selects the array ports that match this parameter value (largest number of commands
observed on the outstanding queue).
[-max-waiting <integer>, ...] - Max Waiting (privilege: advanced)
Selects the array ports that match this parameter value (largest number of commands
observed on the waiting queue).
[-path-link-errors <integer>, ...] - Link Error count on path
[-percent-busy <integer>, ...] - Percent Busy
Selects the array ports that match this parameter value (percentage of time I/Os are
outstanding on the port).
[-percent-waiting <integer>, ...] - Percent Waiting
Selects the array ports that match this parameter value (percentage of time there are I/
Os waiting on the throttle list on the target port).
Selects the array ports that match this parameter value (for fabric attached connections,
the switch port the array target port is connected to; N/A for direct attached).
[-target-io-kbps <integer>, ...] - Kbytes of I/O per second to Target (Rolling Average)
[-target-iops <integer>, ...] - Number of IOPS to Target (Rolling Average)
1011

[-target-lun-in-use-count <integer>, ...] - Target LUN In Use Count
Selects the array ports that match this parameter value (number of IN-USE disks on this
target port).
[-target-port-speed <text>] - Target Port Speed
Selects the array ports that match this parameter value (speed that the target port has
negotiated with its connected switch port, or initiator port if direct attached).
[-utilization-policy {normal|defer}] - Utilization Policy
The policy used when sending I/O to an array target port when it reaches maximum
queue depth. Possible values are:
normal - This policy aggressively competes for target port resources, in effect
competing with other hosts. (default)
defer - This policy does not aggressively compete for target port resources, in
effect deferring to other hosts.
Examples
The example below displays the port information for a single port.
cluster1::> storage array port show -wwpn 50060e80004291c0
Array Name: HITACHI_DF600F_1
WWNN: 50060e80004291c0
WWPN: 50060e80004291c0
Connection Type: fabric
Switch Port: vgbr300s89:9
Link Speed: 4 GB/s
Max Queue Depth: 1024
Utilization Policy: normal
LUN
1012
Link
Node
Initiator
Count
IOPS
KB/s
%busy
%waiting
Errs
----------------
---------
-----
------
------
-------
----------
----
vnv3070f20a
0b
vnv3070f20b
0b
storage bridge add

Add a bridge for monitoring
level.
Description
The storage bridge add command enables you to add FC-to-SAS bridges for
SNMP monitoring in a MetroCluster configuration.
Parameters
-address <IP Address> - Bridge Management Port IP Address
This parameter specifies the IP address of the bridge that is being added for monitoring.
[-snmp-community <text>] - SNMP Community
This parameter specifies the SNMP community set on the bridge that is being added for
monitoring.
[-veto-backend-fabric-check {true|false}] - Veto Backend Fabric Check (privilege:
advanced)
If specified, the storage bridge add command will not check if the bridge is present
in the MetroCluster's backend fabric. By default, it does not let you add bridges that are
not present.
Examples
The following command adds a bridge with IP address '10.226.197.16' for monitoring:
cluster1::> storage bridge add -address 10.226.197.16
cluster1::> storage bridge show
Is
Bridge
Symbolic Name Vendor
Model
Bridge WWN
Monitor
Monitored Status
---------- ------------- ------- --------- ---------------- --------- ------ATTO_10.226.197.16

Bridge Number 16
Atto
FibreBridge 6500N
2000001086603824 true
1013
ATTO_FibreBridge6500N_2
Not Set
Atto
FibreBridge 6500N
20000010866037e8 false
Not Set
Atto
FibreBridge 6500N
2000001086609e0e false
Not Set
Atto
FibreBridge 6500N
2000001086609c06 false

cluster1::>
1014
storage bridge modify

Modify a bridge's configuration information
level.
Description
The storage bridge modify enables you to modify certain parameters for
identifying and accessing the FC-to-SAS bridges added for monitoring in a MetroCluster
configuration.
Parameters
-name <text> - Bridge Name
This parameter specifies the name of the bridge.
[-address <IP Address>] - Bridge IP Address
This parameter specifies the IP address of the bridge.
[-snmp-community <text>] - SNMP Community Set on the Bridge
This parameter specifies the SNMP community set on the bridge.
Examples
The following command modifies 'ATTO_10.226.197.16' bridge SNMP community to
'public':
cluster1::> storage bridge modify -name ATTO_10.226.197.16 -address
10.226.197.16 -snmp-community public
cluster1::>
storage bridge refresh

Refresh storage bridge info
1015

privilege level.
Description
The storage bridge refresh command triggers a refresh of the SNMP data for
the MetroCluster FC switches and FC-to-SAS bridges. It does not do anything if the
refresh is already going on. The FC switches and FC-to-SAS bridges must have been
previously added for monitoring by using the storage switch add and storage
bridge add commands respectectively.
Parameters
None
Examples
The following command triggers a refresh for the SNMP data:
cluster1::*> storage bridge refresh
cluster1::*>
See Also
storage switch add storage bridge add
1016
storage bridge remove

Remove a bridge from monitoring
level.
Description
The storage bridge remove enables you to remove FC-to-SAS bridges that were
previously added for SNMP monitoring.
Parameters
-name <text> - Bridge Name
This parameter specifies the name of the bridge added for monitoring.
Examples
The following command removes 'ATTO_10.226.197.16' bridge from monitoring:
cluster1::> storage bridge remove -name ATTO_10.226.197.16
Is
Bridge
Model
Bridge WWN
Monitor
Monitored Status
---------- ------------- ------- --------- ---------------- --------- ------ATTO_FibreBridge6500N_1

Bridge Number 16
Atto
FibreBridge 6500N
2000001086603824 false
Not Set
Atto
FibreBridge 6500N
20000010866037e8 false
Not Set
Atto
FibreBridge 6500N
2000001086609e0e false
Not Set
Atto
FibreBridge 6500N
2000001086609c06 false
1017
1018
storage bridge show

Display bridge information
level.
Description
The storage bridge show command displays information about all the storage
bridges in the MetroCluster configuration. The bridges must have been previously
added for monitoring using the storage bridge add command. If no parameters
are specified, the default command displays the following information about the storage
bridges:
Bridge
Symbolic Name
Vendor
Model
Bridge WWN
Is Monitored
Monitor Status
To display detailed profile information about a single storage bridge, use the -name
parameter.
Parameters
Displays the specified fields for all the storage bridges, in column style output.
| [-connectivity ]
Displays the following details about the connectivity from different entities to the storage
bridge:
Node
Initiator
Initiator Side Switch Port
1019
Target Side Switch Port

Target Port WWN
Target Port Number
| [-cooling ]
Displays the following details about the chassis temperature sensor(s) on the storage
bridge:
Sensor Name
Reading in degree Celsius (C)
Fan operational status
Minimum Safe Operating Temperature in degree Celsius (C)
Maximum Safe Operating Temperature in degree Celsius (C)
Sensor Status
| [-error ]
Displays the errors related to the storage bridge.
| [-ports ]
Displays the following details about the storage bridge FC ports:
Port number
Port administrative status
Port operational status
Port operating mode
Port negotiated speed
Peer world wide name
Displays the following details about the storage bridge SAS ports:
Port number
Port negotiated data rate
Port data rate capability
Port PHY1 operational status
1020

Peer world wide name
| [-sfp ]
Displays the following details about the storage bridge FC ports Small Form-factor
Pluggable (SFP):
Port number
SFP vendor
SFP serial number
SFP part number
SFP speed capability
Displays the following details about the storage bridge FC ports Quad Small Form-factor
Pluggable (QSFP):
Port number
QSFP vendor
QSFP serial number
QSFP type
QSFP part number
| [-stats ]
Displays the following details about the storage bridge FC ports:
Port number
Port operational mode
Port link failure count
Port synchronization loss count
1021
Port CRC error count

Port operational mode
Port received word count (Rx)
Port transmitted word count (Tx)
Displays the following details about the storage bridge SAS ports:
Port number
PHY port number
Port speed capability
Port invalid DWORD count
Port disparity error count
Port synchronization loss count
Port PHY reset count
Port link changed count
Port CRC error count
| [-instance ] }
Displays expanded information about all the storage bridges in the system. If a storage
bridge is specified, then this parameter displays the same detailed information for the
storage bridge you specify as does the -name parameter.
[-name <text>] - Bridge Name
Displays information only about the storage bridges that match the name you specify.
[-wwn <text>] - Bridge World Wide Name
Displays information only about the storage bridges that match the bridge wwn you
specify.
[-model <text>] - Bridge Model
Displays information only about the storage bridges that match the bridge model you
specify.
[-vendor {unknown|Atto}] - Bridge Vendor
1022
Displays information only about the storage bridges that match the bridge vendor you
specify.
[-fw-version <text>] - Bridge Firmware Version
Displays information only about the storage bridges that match the bridge firmware
version you specify.
[-serial-number <text>] - Bridge Serial Number
Displays information only about the storage bridges that match the bridge serial number
you specify.
[-address <IP Address>] - Bridge IP Address
Displays information only about the storage bridges that match the bridge IP address
you specify.
[-is-monitoring-enabled {true|false}] - Is Monitoring Enabled for Bridge?
Displays information only about the storage bridges that match the bridge monitoring
value you specify.
[-status {unknown|ok|error}] - Bridge Status
Displays information only about the storage bridges that match the bridge monitoring
status you specify.
[-profile-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Bridge Profile Data Last Successful Refresh Timestamp
Displays information only about the storage bridges that match the profile data last
successful refresh timestamp you specify.
[-symbolic-name <text>] - Bridge Symbolic Name
Displays information only about the storage bridges that match the symbolic name you
specify.
[-snmp-community <text>] - SNMP Community Set on the Bridge
Displays information only about the storage bridges that match the bridge SNMP
community you specify.
[-error-text-list <text>, ...] - Bridge Error Description List
Displays information only about the storage bridges that have the errors you specify.
[-temp-sensor-name <text>] - Temperature Sensor Name
Displays information only about the storage bridges that have the temperature sensor
with the name you specify.
1023
[-min-safe-oper-temp <integer>] - Minimum Safe Operating Temperature in Degree

Celsius
with the minimum safe operating temperature you specify.
[-max-safe-oper-temp <integer>] - Maximum Safe Operating Temperature in Degree
Celsius
with the maximum safe operating temperature you specify.
[-temp-reading <integer>] - Chassis Temperature Sensor Reading in Degree Celsius
Displays information only about the storage bridges that have the temperature sensors
with the reading you specify.
[-temp-sensor-status {normal|warning|critical}] - Chassis Temperature Sensor Status
with the status you specify.
[-temp-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Bridge Chassis Temperature Data Last Successful Refresh Timestamp
Displays information only about the storage bridges that match the temperature sensor
data last successful refresh timestamp you specify.
[-fc-port-index-list <integer>, ...] - Bridge FC Port Index List
Displays information only about the storage bridges that have the ports with the indexes
you specify.
[-fc-port-oper-state-list {unknown|online|offline}, ...] - Bridge FC Port Operational State
List
Displays information only about the storage bridges that have the ports with the
operational states you specify.
[-fc-port-admin-state-list {unknown|disabled|enabled}, ...] - Bridge FC Port Admin
State List
administrative states you specify.
[-fc-port-negotiated-data-rate-list {unknown|2|4|8}, ...] - Bridge FC Port Negotiated
Data Rate List
negotiated data rates you specify.
1024
[-fc-port-negotiated-conn-mode-list {unknown|loop|n-port}, ...] - Bridge FC Port

Negotiated Connection Mode List
negotiated connection modes you specify.
[-fc-port-wwn-list <text>, ...] - Bridge FC Port WWN List
Displays information only about the storage bridges that have the ports with the world
wide names you specify.
[-fc-port-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Bridge FC Port Data Last Successful Refresh Timestamp
Displays information only about the storage bridges that match the FC ports data last
[-fc-port-stats-index-list <integer>, ...] - Bridge FC Port Index List
Displays information only about the storage bridges that have the ports with the indexes
you specify.
[-fc-port-tx-words-list <integer>, ...] - Bridge FC Port Transmitted Word Count List
Displays information only about the storage bridges that have the ports with the number
of transmitted words you specify.
[-fc-port-rx-words-list <integer>, ...] - Bridge FC Port Received Word Count List
of received words you specify.
[-fc-port-link-failures-list <integer>, ...] - Bridge FC Port Link Failure Count List
of link failures you specify.
[-fc-port-sync-losses-list <integer>, ...] - Bridge FC Port Sync Loss Count List
of synchronization losses you specify.
[-fc-port-invalid-crc-list <integer>, ...] - Bridge FC Port Invalid CRC Count List
of invalid CRCs you specify.
[-fc-port-stats-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Bridge FC Port Stats Last Successful Refresh Timestamp
Displays information only about the storage bridges that match the fc port stats data last
1025
[-sas-port-index-list <integer>, ...] - Bridge SAS Port Index List

Displays information only about the storage bridges that have the SAS ports with the
indexes you specify.
[-sas-port-oper-state-list {unknown|online|offline|degraded}, ...] - Bridge SAS Port
Operational State List
operational states you specify.
[-sas-port-phy1-oper-state-list {unknown|online|offline}, ...] - Bridge SAS Port PHY1
PHY1 operational states you specify.
[-sas-port-admin-state-list {unknown|disabled|enabled}, ...] - Bridge SAS Port
Administrative State List
administrative states you specify.
[-sas-port-data-rate-capability-list {unknown|1.5Gbps|3Gbps|6Gbps}, ...] - Bridge SAS
Port Data Rate Capability List
data rate capabilities you specify.
[-sas-port-negotiated-data-rate-list {unknown|1.5Gbps|3Gbps|6Gbps}, ...] - Bridge
SAS Port Negotiated Data Rate List
1026
[-sas-port-wwn-list <text>, ...] - Bridge SAS Port WWN List
world wide names you specify.
[-sas-port-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Bridge SAS Port DB Data Last Successful Refresh Timestamp
Displays information only about the storage bridges that match the SAS ports data last
[-sas-port-stats-phy-index-list <integer>, ...] - Bridge SAS Port PHY Index List
PHY indexes you specify.
[-sas-port-link-changed-list <integer>, ...] - Bridge SAS Port Link Changed Count List
Displays information only about the storage bridges that have the SAS ports with the link
changed count you specify.
[-sas-port-invalid-crc-list <integer>, ...] - Bridge SAS Port Invalid CRC Count List
invalid CRCs you specify.
[-sas-port-phy-reset-list <integer>, ...] - Bridge SAS Port PHY Reset Count List
PHY reset count you specify.
[-sas-port-sync-losses-list <integer>, ...] - Bridge SAS Port Sync Loss Count List
synchronization losses you specify.
[-sas-port-disparity-count-list <integer>, ...] - Bridge SAS Port Disparity Count List
disparity count you specify.
[-sas-port-invalid-dword-list <integer>, ...] - Bridge SAS Port Invalid DWORD Count
List
invalid DWORD count you specify.
[-sas-port-stats-index-list <integer>, ...] - Bridge SAS Port Index List
1027
[-sas-port-stats-data-rate-capability-list {unknown|1.5Gbps|3Gbps|6Gbps}, ...] Bridge SAS Port Data Rate Capability List
[-sas-port-stats-negotiated-data-rate-list {unknown|1.5Gbps|3Gbps|6Gbps}, ...] Bridge SAS Port Negotiated Data Rate List
[-sas-port-stats-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Bridge SAS Port Statistics Data Last Successful Refresh Timestamp
Displays information only about the storage bridges that match the SAS port stats data
last successful refresh timestamp you specify.
[-fc-sfp-port-index-list <integer>, ...] - Bridge FC Port Index List
Displays information only about the storage bridges that have the FC ports with the
[-fc-port-sfp-vendor-list <text>, ...] - Bridge FC Port SFP Vendor List
Displays information only about the storage bridges that have the FC ports with the SFP
vendors you specify.
[-fc-port-sfp-serial-number-list <text>, ...] - Bridge FC Port SFP Serial Number List
serial numbers you specify.
[-fc-port-sfp-part-number-list <text>, ...] - Bridge FC Port SFP Part Number List
part numbers you specify.
[-fc-port-sfp-data-rate-capability-list {2Gb|4Gb|8Gb|16Gb}, ...] - Bridge FC Port SFP
Data Rate Capability List
[-fc-port-sfp-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Bridge FC Port SFP Data Last Successful Refresh Timestamp
1028
Displays information only about the storage bridges that match the FC ports SFP data
[-sas-qsfp-port-index-list <integer>, ...] - Bridge SAS Port Index List
[-sas-port-qsfp-vendor-list <text>, ...] - Bridge SAS Port QSFP Vendor List
QSFP vendors you specify.
[-sas-port-qsfp-serial-number-list <text>, ...] - Bridge SAS Port QSFP Serial Number
List
QSFP serial numbers you specify.
[-sas-port-qsfp-type-list {unknown|optical|active-copper|passive-copper}, ...] - Bridge
SAS Port QSFP Type List
QSFP types you specify.
[-sas-port-qsfp-part-number-list <text>, ...] - Bridge SAS Port QSFP Part Number List
QSFP part numbers you specify.
[-sas-port-qsfp-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Bridge SAS Port QSFP Data Last Successful Refresh Timestamp
Displays information only about the storage bridges that match the SAS ports QSFP
[-node-list {<nodename>|local}, ...] - Node Name List
Displays information only about the storage bridges that are connected to the nodes you
specify.
[-initiator-list <text>, ...] - Initiator List
Displays information only about the storage bridges that are connected to the nodes
hosting the initiators you specify.
[-initiator-side-switch-port-name-list <text>, ...] - Initiator Side Switch Port Name List
Displays information only about the storage bridges that are connected to the initiator
side switch ports you specify.
[-target-side-switch-port-name-list <text>, ...] - Target Side Switch Port Name List
1029
Displays information only about the storage bridges that are connected to the target side
switch ports you specify.
[-target-port-wwn-list <text>, ...] - Target Port WWN List
Displays information only about the storage bridges that match the target ports with
world wide names you specify.
[-target-port-index-list <integer>, ...] - Target Port Index List
Displays information only about the storage bridges that match the target ports with
Examples
The following example displays information about all storage bridges:
Is
Bridge
Model
Bridge WWN
Monitor
Monitored Status
---------- ------------- ------- --------- ---------------- --------- ------ATTO_10.226.197.16

Bridge Number 16 retyped
Atto
FibreBridge 6500N
2000001086603824 true
ok
ATTO_10.226.197.17
Not Set
Atto
FibreBridge 6500N
20000010866037e8 true
ok
ATTO_10.226.197.18
Not Set
Atto
FibreBridge 6500N
2000001086609e0e true
ok
ATTO_10.226.197.19
Not Set
Atto
FibreBridge 6500N
2000001086609c06 true
ok

cluster1::>
The following example displays connectivity (node to bridge) information about all
storage bridges:
1030
cluster1::> storage bridge show -connectivity

Bridge Name: ATTO_10.226.197.16
Bridge WWN: 2000001086603824
Vendor: Atto
Model: FibreBridge 6500N
Serial Number: FB6500N101405
Firmware Version: 1.60 A68E 51.01
Management IP: 10.226.197.16
Errors: Initiator Side Target Side
Node
Initiator
Port
Switch Port Switch Port Target Port WWN
No
------------ --------- -------------- ----------- ---------------- ---dpg-mcc-3240-15-b1
0c mcc-cisco-8Gb-fab-3:1-29
mcc-cisco-8Gb-fab-1:1-25
2100001086603824
dpg-mcc-3240-15-b2
0c mcc-cisco-8Gb-fab-3:1-30
mcc-cisco-8Gb-fab-1:1-25
2100001086603824
The following command displays cooling (temperature sensors) information about all
storage bridges:
cluster1::> storage bridge show -cooling
Bridge WWN: 2000001086603824
Vendor: Atto
Errors: Chassis Temperature Sensor:
Min Safe
Max Safe
Sensor Name Reading Oper Temp Oper Temp Status

----------- ------- --------- --------- -------
1031
Chassis
42
70 normal
Temperature
Sensor
The following command displays the error information about all storage bridges:
cluster1::> storage bridge show -error
Bridge WWN: 2000001086603824
-----------------------------------------------------------------------------ATTO_10.226.197.16(2000001086603824):Bridge is Unreachable over Management
Network.

Bridge WWN: 20000010866037e8
-----------------------------------------------------------------------------ATTO_10.226.197.17(20000010866037e8):Bridge is Unreachable over Management
Network.

Bridge WWN: 2000001086609e0e
-----------------------------------------------------------------------------ATTO_10.226.197.18(2000001086609e0e):Bridge is Unreachable over Management
Network.

Bridge WWN: 2000001086609c06
-----------------------------------------------------------------------------ATTO_10.226.197.19(2000001086609c06):Bridge is Unreachable over Management
Network.
The following command displays the detailed information about all the storage bridges:
1032
cluster1::> storage bridge show -instance

Bridge WWN: 2000001086603824
Vendor: Atto
Errors: -
The following command displays port information about all storage bridges:
cluster1::> storage bridge show -ports
Bridge WWN: 2000001086603824
Vendor: Atto
Errors: FC Ports:
Admin
Oper
Ports Status
Status
Neg
Port Mode
Speed WWPN
----- -------- ------- ------------- ------- ---------------1 enabled
online
2 enabled
offline unknown
n-port
8gb 2100001086603824
unknown 2200001086603824
Last Update Time: 8/12/2014 12:34:36 -04:00

SAS Ports:
Neg Data
Data Rate PHY1
Ports Rate
Cap Status
PHY2
PHY3
PHY4
Admin
Oper
Status
Status
Status
Status
Status
WWPN
----- ---- ---- ------- ------- ------- ------- -------- ------- -----------1
3Gbps
1033
6Gbps online
5001086000603824
online
online
online
enabled
online
2
6Gbps
6Gbps offline offline offline offline disabled offline
0000000000000000
The following command displays port SFP information about all storage bridges:
cluster1::> storage bridge show -sfp
Bridge WWN: 2000001086603824
Vendor: Atto
Errors: FC SFP:
Speed
Ports Vendor Serial Number Part Number Capability
----- ------ ------------- ----------- ---------1 AVAGO
AA1119A173Z
AFBR-57D7APZ
8Gbps
2 AVAGO
AA1119A173W
AFBR-57D7APZ
8Gbps
Last Update Timestamp: 8/12/2014 12:34:36 -04:00

SAS QSFP:
Ports Vendor
Serial Number SFP Type
Part Number
----- ---------- ------------- ------------- ----------1 WL GORE
010411-780
passive-copper
2 -
unknown
112-00176
-
The following command displays port statistics information about all storage bridges:
1034
cluster1::> storage bridge show -stats

Bridge WWN: 2000001086603824
Vendor: Atto
Errors: FC Ports:
Oper
Neg
Link
Sync
CRC
Rx
Speed Failure Losses Error
Words
Tx
Ports Status
Words
Port Mode
----- ------- ------------- ------- ------- ------ ----- ------------------1 online

3049186605
n-port
0 2721271731
unknown
2 offline unknown
8gb
0
Last Update Time: 8/12/2014 12:34:37 -04:00
SAS Ports:
Invalid Disparity
SAS
PHY
Neg
Port Port
Sync
PHY
Speed
Dword
Error
Speed Capability
Count
Count Count Count
Link
CRC
Loss Reset Changed Error

Count Count
---- ---- ------- ---------- ------- --------- ----- ----- ------- ----1
3Gbps
6Gbps
28262
26665
3Gbps
6Gbps
2110
1794
20
3Gbps
6Gbps
20435
18857
13
3Gbps
6Gbps
4573
3353
16
6Gbps
6Gbps
66
53
6Gbps
6Gbps
27478
25137
6Gbps
6Gbps
20537
17322
6Gbps
6Gbps
23629
21767
10
1035
See Also
storage bridge add
1036
storage disk assign

Assign ownership of a disk to a system
level.
Description
The storage disk assign command is used to assign ownership of an unowned
disk or array LUN to a specific node. You can also use this command to change the
ownership of a disk or an array LUN to another node. You can designate disk ownership
by specifying disk names, array LUN names, wildcards, or all (for all disks or array LUNs
visible to the node). For disks, you can also set up disk ownership autoassignment.
You can also assign disks to a particular pool. You can also assign disks by copying
ownership from another disk.
Parameters
{ [-disk <disk path name>] - Disk Path
This specifies the disk or array LUN that is to be assigned. Disk names take one of the
following forms:
Disks are named in the form <stack-id>.<shelf>.<bay>
Disks on multi-disk carriers are named in the form <stack-id>.<shelf>.<bay>.<lun>
Virtual disks are named in the form <prefix>.<number>, where prefix is the
storage array's prefix and number is a unique ascending number.
Disk names take one of the following forms on clusters that are not yet fully upgraded to
Data ONTAP 8.3:
Disks that are not attached to a switch are named in the form
<node>:<host_adapter>.<loop_ID>. For disks with a LUN, the form is
<node>:<host_adapter>.<loop_ID>L<LUN>. For instance, disk number 16 on host
adapter 1a on a node named node0a is named node0a:1a.16. The same disk on
LUN lun0 is named node0a:1a.16Llun0.
Disks that are attached to a switch are named in the form
<node>:<switch_name>:<switch_port>.<loop_ID>. For disks with a LUN, the
form is <node>:<switch_name>:<switch_port>.<loop_ID>L<LUN>. For instance,
1037
disk number 08 on port 11 of switch fc1 on a node named node0a is named

node0a:fc1:11.08. The same disk on LUN lun1 is named node0a:fc1:11.08Llun1.
Before the cluster is upgraded to Data ONTAP 8.3, the same disk can have multiple
disk names, depending on how the disk is connected. For example, a disk known to a
node named alpha as alpha:1a.19 can be known to a node named beta as beta:0b.37.
All names are listed in the output of queries and are equally valid. To determine a disk's
unique identity, run a detailed query and look for the disk's universal unique identifier
(UUID) or serial number.
A subset of disks or array LUNs can be assigned using the wildcard character (*) in
the -disk parameter. Either the -owner, the -sysid, or the -copy-ownershipfrom parameter must be specified with the -disk parameter. Do not use the -node
parameter with the -disk parameter.
| -all [true] - Assign All Disks
This optional parameter causes assignment of all visible unowned disks or array LUNs
to the node specified in the -node parameter. The -node parameter must be specified
with the -all parameter. When the -copy-ownership-from parameter is specified
with the -node parameter, it assign disk ownership based on the -copy-ownershipfrom parameter; otherwise it assigns ownership of the disks based on the -node
parameter. Do not use the -owner or the -sysid parameter with the -all parameter.
| [-type | -T {ATA | BSAS | FCAL | FSAS | LUN | MSATA | SAS | SATA | SSD | VMDISK}]
- Storage Type
This optional parameter assigns ownership of a specific type of disk or array LUN (or a
set of disks/array LUNs) to a node. The -count parameter must be specified with the type parameter.
-count | -n <integer> - Disk Count
This optional parameter assigns ownership of a number of disks or array LUNs specified
in the -count parameter, to a node.
| -auto [true] } - Auto Assign
This optional parameter causes all visible disks eligible for autoassignment to be
immediately assigned to the node specified in the -node parameter, regardless of the
setting of the disk.auto_assign option. Only unowned disks on loops or stacks owned
wholly by that system and which have the same pool information will be assigned. The node parameter must be specified with the -auto parameter. Do not use the -owner,
the -sysid, or the -copy-ownership-from parameter with the -auto parameter.
When possible, use the -auto parameter rather than the -all parameter to conform to
disk ownership best practices. The -auto parameter is ignored for array LUNs.
[-pool | -p <integer>] - Pool
1038
This optional parameter specifies the pool to which a disk must be assigned. It can take
values of Pool0 or Pool1.
{ [-owner | -o <nodename>] - Owner Name
This optional parameter specifies the node to which the disk or array LUN has to be
assigned.
[-sysid | -s <nvramid>] - New Owner ID
This optional parameter specifies the serial number (NVRAM ID) of the node to which
the disk or array LUN has to be assigned.
| [-copy-ownership-from <disk path name>] } - Disk Name to Copy Ownership
This optional parameter specifies the disk name from where the node needs to copy
disk ownership information. You can use this parameter for disks to have the same
ownership as the provided input disk.
[-checksum | -c {block|zoned}] - Checksum Compatibility
This optional parameter is used to specify the checksum type for a disk or an array
LUN. The possible values are block or zoned. Data ONTAP 8.1.1 supports a new
checksum scheme called advanced zoned checksum (AZCS). Existing zoned checksum
aggregates are still supported. A newly created aggregate with zoned checksum
array LUNs is assigned AZCS checksum type. AZCS checksum type provides more
functionality than the "version 1" zoned checksum type which has been supported
in previous Data ONTAP releases. Zoned checksum spare array LUNs added to
an existing zoned checksum aggregate continue to be zoned checksum. Zoned
checksum spare array LUNs added to an AZCS checksum type aggregate use the
AZCS checksum scheme for managing checksums. For some disks (e.g. FCAL, SSD,
SAS disks), the checksum type cannot be modified. For more information on modifying
the checksum type, refer to the "Physical Storage Management Guide".
[-force | -f [true]] - Force Flag
This optional parameter forces the assignment of ownership of an already owned disk to
a node. This parameter could also be used to assign an array LUN with a redundancy
error, for example, if the array LUN is available on only one path. For a disk which is
part of a live aggregate, even specification of the -force parameter would not force the
assignment, since it would be catastrophic.
[-node | -N <nodename>] - Node Name (For Auto Assign)
This optional parameter is used with either the -auto or the -all parameter. If used
with the -auto parameter, all disks which are visible to the node specified in the -node
parameter and which are eligible for autoassignment would be assigned to it. If used
1039
with the -all parameter, all unowned disks or array LUNs visible to the node would be
assigned to it.
{ [-root [true]] - Root Partition (privilege: advanced)
This optional parameter assigns the root partition of a partitioned disk. You cannot use
this parameter with disks that are part of a storage pool. The default value is false.
| [-data [true]] } - Data Partition (privilege: advanced)
This optional parameter assigns the data partition of a partitioned disk. You cannot use
this parameter with disks that are part of a storage pool. The default value is false.
Examples
The following example assigns ownership of an unowned disk named 1.1.16 to a node
named node1:
cluster1::> storage disk assign -disk 1.1.16 -owner node1
The following example assigns all unowned disks or array LUNs visible to a node
named node1 to itself:
cluster1::> storage disk assign -all -node node1
The following example autoassigns all unowned disks (eligible for autoassignment)
visible to a node named node1 to itself:
cluster1::> storage disk assign -auto -node node1
The following two examples show the working of the -force parameter with a spare
disk that is already owned by another system:
cluster1::> storage disk assign -disk 1.1.16 -owner node1
Error: command failed: Failed to assign disks. Reason: Disk 1.1.16 is
already owned.
cluster1::> storage disk assign -disk 1.1.16 -owner node1 -force

Success.
The following example assigns ownership of the set of unowned disks on <stack> 1, to a
node named node1:
cluster1::> storage disk assign -disk 1.* -owner node1
1040
The following example assigns ownership of unowned disk 1.1.16 by copying ownership
from disk 1.1.18:
cluster1::> storage disk assign -disk 1.1.16
-copy-ownership-from 1.1.18
The following example assigns all unowned disks visible to a node named node1 by
copying ownership from disk 1.1.18:
cluster1::> storage disk assign -all -node node1
-copy-ownership-from 1.1.18
The following example assigns the root partition of disk 1.1.16 to node1.
cluster1::> storage disk assign -disk 1.1.16 -owner node1 -root true
The following example assigns the data partition of disk 1.1.16 to node1.
cluster1::> storage disk assign -disk 1.1.16 -owner node1 -data true
storage disk fail

Fail the file system disk
level.
Description
The storage disk fail command can be used to manually force a file system disk
to fail. It is used to remove a file system disk that may be logging excessive errors and
requires replacement. To unfail a disk, use the storage disk unfail command.
Parameters
-disk <disk path name> - Disk Name
This parameter specifies the disk to be failed.
[-immediate | -i [true]] - Fail immediately
1041
This parameter optionally specifies whether the disk is to be failed immediately. It is

used to avoid Rapid RAID Recovery and remove the disk from the RAID configuration
immediately. Note that when a file system disk has been removed in this manner, the
RAID group to which the disk belongs enters degraded mode (meaning a disk is missing
from the RAID group). If a suitable spare disk is available, the contents of the disk being
removed are reconstructed onto that spare disk.
Examples
The following example fails a disk named 1.1.16 immediately:
cluster1::> storage disk fail -disk 1.1.16 -i true
WARNING: The system will not prefail the disk and its contents will not be
copied to a replacement disk before being failed out. Do you want to
fail out the disk immediately? {y|n}: y
See Also
storage disk unfail
1042
storage disk modify

(DEPRECATED)-Modify disk attributes
level.
Description
The storage disk modify command can be used to designate an array LUN as a
foreign LUN. This command is deprecated and will be removed in a future release of
Data ONTAP.
Parameters
This specifies the disk that is to be modified. Disk names take one of the following
forms:
Data ONTAP 8.3:
1043
[-is-foreign {true|false}] - Foreign LUN
This optionally specifies whether the array LUN should be marked as foreign or not. This
supports 2 values (true or false). The true value indicates that an array LUN has been
designated as a foreign LUN and cannot be assigned. The default value is false.
Examples
1044
storage disk reassign

Change the default owner of all disks from one node to another
privilege level.
Description
The storage disk reassign command changes the ownership of all disks on a
node to the ownership of another node. Use this command only when a node has a
complete failure (for instance, a motherboard failure) and is replaced by another node. If
the node's disks have already been taken over by its storage failover partner, use the force parameter.
Parameters
-homeid | -s <nvramid> - Current Home ID
This specifies the serial number of the failed node.
-newhomeid | -d <nvramid> - New Home ID
This specifies the serial number of the node that is to take ownership of the failed node's
disks.
This optionally specifies whether to force the reassignment operation. The default
setting is false .
Examples
In the following example, a node named node0 and having serial number 12345678 has
failed. Its disks have not been taken over by its storage failover partner. A replacement
node with serial number 23456789 was installed and connected to node0's disk shelves.
To assign node0's disks to the new node, start the new node and run the following
command:
cluster::*> storage disk reassign -homeid 12345678 -newhomeid 23456789
node0's disks 1.1.11, 1.1.12, 1.1.13, 1.1.14, 1.1.15, 1.1.16, 1.1.23 and 1.1.24
were reassigned to new owner with serial number 23456789.
1045
In the following example, a similar failure has occurred, except that node0's disks
have been taken over by its storage failover partner, node1. A new node with serial
number 23456789 has been installed and configured. To assign the disks that previously
belonged to node0 to this new node, run the following command:
cluster::*> storage disk reassign -homeid 12345678 -newhomeid 23456789 -force
true
node0's disks 1.1.11, 1.1.12, 1.1.13, 1.1.14, 1.1.15, 1.1.16, 1.1.23 and 1.1.24
were reassigned to new owner with serial number 23456789.
1046
storage disk refresh-ownership

Refresh the disk ownership information on a node
privilege level.
Description
This command updates the disk ownership information for all the disks attached to a
node to the latest view for all the nodes in the cluster. During normal operations, disk
ownership is kept up to date automatically. In certain circumstances, however, disk
ownership must be updated manually. If this is required, EMS messages will indicate
that this command should be run. If the -node parameter is provided, the disk ownership
information is updated only on the node specified.
Parameters
If this parameter is provided, the disk ownership information is updated only on the node
specified.
Examples
The following example refreshes the disk ownership information for all the nodes in the
cluster:
cluster1::> storage disk refresh-ownership
storage disk remove-reservation

Removes reservation from an array LUN marked as foreign.
privilege level.
Description
The storage disk remove-reservation command removes persistent
reservation from a specified foreign array LUN.
1047
Parameters
This specifies the disk from which persistent reservation is to be removed.
Examples
The following example removes the persistent reservation from a disk named
node1:switch01:port.126L1.
cluster1::> storage disk remove-reservation -disk node1:switch01:port.126L1
storage disk remove

Remove a spare disk
level.
Description
The storage disk remove command removes the specified spare disk from the
RAID configuration, spinning the disk down when removal is complete.
This command does not remove disk ownership information from the disk. Therefore, if
you plan to reuse the disk in a different storage system, you should use the storage
disk removeowner command instead. See the "Physical Storage Management
Guide" for the complete procedure.
NOTE: For systems with multi-disk carriers, it is important to ensure that none of
the disks in the carrier are filesystem disks before attempting removal. To convert a
filesystem disk to a spare disk, see storage disk replace .
Parameters
This parameter specifies the disk to be removed.
Examples
The following example removes a spare disk named 1.1.16:
cluster1::> storage disk remove -disk 1.1.16
1048
See Also
storage disk removeowner storage disk replace
1049
storage disk removeowner

Remove disk ownership
level.
Description
The storage disk removeowner command removes ownership from a specified
disk. Then disk can then be reassigned to a new owner.
Parameters
This specifies the disk whose ownership is to be removed.
[-force [true]] - Force the Ownership Removal
This option tells ONTAP to override the normal restriction preventing the removal of
spare disks.For disks which are part of a live aggregate, even specification of force
parameter would not force the disk ownership removal, since it would be catastrophic.
{ [-root [true]] - Root Partition (privilege: advanced)
This optional parameter removes ownership of the root partition of a partitioned disk.
You cannot use this parameter with disks that are part of a storage pool. The default
value is false.
| [-data [true]] } - Data Partition (privilege: advanced)
This optional parameter removes ownership of the data partition of a partitioned disk.
You cannot use this parameter with disks that are part of a storage pool. The default
value is false.
Examples
The following example removes the ownership from a disk named 1.1.27.
cluster1::> storage disk removeowner -disk 1.1.27
The following example removes ownership of the root partition on disk 1.1.16.
cluster1::> storage disk removeowner -disk 1.1.16 -root true
1050
The following example removes ownership of the data partition on disk 1.1.16.
cluster1::> storage disk removeowner -disk 1.1.16 -data true
storage disk replace

Initiate or stop replacing a file-system disk
level.
Description
The storage disk replace command starts or stops the replacement of a file
system disk with spare disk. When you start a replacement, Rapid RAID Recovery
begins copying data from the specified file system disk to a spare disk. When the
process is complete, the spare disk becomes the active file system disk and the file
system disk becomes a spare disk. If you stop a replacement, the data copy is halted,
and the file system disk and spare disk retain their initial roles.
Parameters
This specifies the file system disk that is to be replaced. Disk names take one of the
following forms:
Data ONTAP 8.3:
1051

-action {start | stop} - Action
This specifies whether to start or stop the replacement process.
[-replacement <disk path name>] - Replacement
This specifies the spare disk that is to replace the file system disk.
same RAID group when you replace a disk in an aggregate.
You can replace a disk in an aggregate with a disk that causes this situation, but when
an alternate disk becomes available, Data ONTAP automatically initiates a series of disk
copy operations to put the disks into different RAID groups. For this reason, you should
use this parameter only when necessary. When possible, ensure that disks housed in
the same carrier are in different RAID groups.
This parameter affects only the disk replace operation. It is not a persistent attribute of
the aggregate.
[-allow-mixing | -m [true]] - Allow Mixing of Disks of Different RPM or Pool
This optional parameter specifies whether the disk can be replaced with another disk
of different RPM or from different Pool. This parameter affects only the current disk
replacement operation.
Examples
The following example begins replacing a file system disk named 1.0.16 with a spare
disk named 1.1.14.
cluster1::> storage disk replace -disk 1.0.16 -replacement 1.1.14 -action start
1052
storage disk set-led

Turn on a disk's red LED for a number of minutes
level.
Description
The storage disk set-led controls the LED of a specified disk.
You can turn an LED on or off, cause it to blink or stop blinking, or test it.
This command is useful for locating a disk in its shelf.
Parameters
This specifies the disk whose LED is to be set. Disk names take one of the following
forms:
Data ONTAP 8.3:
1053
-action {on|off|blink|blinkoff|test} - Action
This specifies the state to which the LED is to be set. Possible values include the
following:
on-The LED lights up steadily
off-The LED does not light up
blink-The LED blinks
blinkoff-The LED stops blinking
test-This tests the operation of the disk enclosure's hardware and drivers. Do not
use this value in normal operation.
[-time <integer>] - Time (Min)
This specifies the time, in minutes, that the LED is to remain in the specified state.
Examples
The following example causes the LEDs on all disks whose names match the pattern
cluster1* to turn on:
cluster1::> storage disk set-led -disk cluster1* -action on
storage disk show

Display a list of disk drives and array LUNs
level.
Description
The storage disk show command displays information about disks and array LUNs.
Where it appears in the remainder of this document "disk" may refer to either a disk
or an array LUN. By default, the command displays the following information about all
disks in column style output:
Disk name
1054
Usable space on the disk, in human readable units

Shelf number
Bay number
Container type (aggregate, broken, foreign, labelmaint, maintenance, shared,
spare, unassigned, unknown, or volume)
Position (copy, data, dparity, orphan, parity, pending, or present)
Aggregate name
Owning node name
To display detailed information about a single disk, use the -disk parameter.
Parameters
Displays the specified fields for all disks, in column style output.
| [-broken ]
Displays the following RAID-related information about broken disks:
Original owning node name
Checksum compatibility
Disk name
Outage reason
Host bus adapter
Shelf number
Bay number
Primary port / Channel
Pool
Disk type
RPM (Revolutions per minute)
Usable size in human readable units
Physical size in human readable units
1055
Current owner node

| [-errors ]
Displays the following disk information about the disks which have errors.
Disk Name
Error Type
Error Decription and corresponding corrective action
| [-longop ]
Displays the following information about long-running disk operations, in column style
output:
Disk name
Whether the disk is marked as prefailed
Whether the disk is being replaced
Whether the disk is zeroed
Copy destination
Percentage of copy complete
Percentage of zeroing complete
Percentage of reconstruction complete
| [-maintenance ]
Displays the following RAID-related information about disks in the maintenance center:
Disk name
Outage Reason
Host bus adapter
Shelf number
Bay number
Pool
1056
Disk type
Current owner node
| [-ownership ]
Displays the following ownership-related information:
Disk name
Aggregate name
Home node name
Owning node name
Disaster recovery home node name
Home node system id
Owning node system id
Disaster recovery home node system id
Reservation node system id
SyncMirror pool
| [-partition-ownership ]
Displays the following ownership-related information for partitioned disks:
Disk name
Aggregate name
Owner of root partition on a partitioned disk
Owner system id of root partition on a partitioned disk
Owner of data partition on a partitioned disk
Owner system id of data partition on a partitioned disk
Owner of the disk which is partitioned
Owner system id of the disk which is partitioned
1057
| [-physical ]
Displays the following information about the disk's physical attributes, in column style
output:
Disk name
Disk type
Disk vendor
Disk model
Firmware revision level
BPS (Bytes per sector)
| [-port ]
Displays the following path-related information:
Disk name and disk port associated with disk primary path
Disk name and disk port associated with the disk secondary path, for a multipath
configuration
Type, shelf, and bay information for the disks
| [-raid ]
Displays the following RAID-related information:
Disk name
Container type (aggregate, broken, labelmaint, maintenance, shared, spare,
unassigned, unknown, or volume)
Outage reason
RAID group name
Aggregate name
| [-raid-info-for-aggregate ]
Displays the following RAID-related information about the disks used in an aggregate:
Owning node name
1058
Aggregate name
Plex name
RAID group name
Disk name
Host bus adapter
Shelf number
Bay number
Pool
Disk type
When this parameter is specified, RAID groups that use shared disks are not included.
Use storage aggregate show-status to show information for all RAID groups and
aggregates.
| [-spare ]
Displays the following RAID-related information about available spare disks:
Disk name
Host bus adapter
Shelf number
Bay number
Pool
Disk type
1059

Current owner node
| [-virtual-machine-disk-info ]
Displays information about Data ONTAP virtual disks, their mapped datastores and their
specific backing device attributes, such as: disk or LUN, adapter and initiator details (if
applicable).
Disk name.
Name of the node.
Data ONTAP-supplied serial number of the system disk.
Size of the system disk.
Name of the disk backing store. A backing store represents a storage location for
virtual machine files. It can be a VMFS volume, a directory on network-attached
storage, or a local file system path.
File name of the virtual disk used by the hypervisor. Each Data ONTAP disk is
mapped to a unique VM disk file.
Type of the disk backing store. It can be a VMFS volume, a directory on networkattached storage, or a local file system path.
Size of the disk backing store.
Full path to the backing store for network-attached storage. This field is valid only
for NAS connections.
Backing adapter PCI device ID for the virtual disk, for example "50:00.0".
Backing adapter device name, for example "vmhba32".
Backing adapter model type, for example "LSI1064E".
Backing adapter driver name of the initiator.
The iSCSI name of the disk backing target. This field is valid only for iSCSI
connections.
The iSCSI IP address of the disk backing target. This field is valid only for iSCSI
connections.
SCSI device name for the backing disk. It takes the form target-id:lun-id, for
example "2:1".
1060
Hypervisor-assigned unique ID of the backing device (disk or LUN).

Backing disk partition number where the corresponding VM disk file resides.
Size of the backing device (disk or LUN).
Backing device manufacturer, for example "FUJITSU" or "IBM".
Backing device model, for example "MBE2073RC" or "LUN".
Error (if any) while retrieving virtual disk details.
| [-vmdisk-backing-info ]
Displays information about the backing disks on certain Data ONTAP-v models:
Disk name
Backing disk vendor
Backing disk model
Backing disk serial number
Backing disk device id
| [-foreign ] (privilege: advanced)
Displays the following foreign LUN import related information about foreign disks:
Disk name
Array name
Capacity in sectors
Capacity in mb
Serial Number
| [-instance ] }
Displays detailed disk information. If no disk path name is specified, this parameter
displays the same detailed information for all disks as does the -disk parameter. If a disk
path name is specified, then this parameter displays the same detailed information for
the specified disks as does the -disk parameter.
[-disk <disk path name>] - Disk Name
Displays detailed information about the specified disks. Disk names take one of the
following forms:
1061

Data ONTAP 8.3:
[-owner {<nodename>|local}] - Owner
Selects information about disks that are owned by the specified node.
[-owner-id <nvramid>] - Owner System ID
Selects the disks that are owned by the node with the specified system ID.
[-is-foreign {true|false}] - Foreign LUN
Selects information about array LUNs that have been declared to be foreign LUNs.
[-uid <text>] - Disk Unique ID
Selects the disks whose unique id matches this

parameter value. A disk unique identifier has the form:
20000000:875D4C32:00000000:00000000:00000000:00000000:00000000:00000000:000
Selects information about disks that belong to the specified aggregate.
1062

Selects information about the LUNs presented by the specified storage array.
[-average-latency <integer>] - Average I/O Latency Across All Active Paths
Selects information about disks that have the specified average latency.
[-bay <integer>] - Bay
Selects information about disks that are located in the carrier within the specified shelf
bay.
[-bps <integer>] - Bytes Per Sector
Selects information about disks that have the specified number of bytes per sector.
Possible settings are 512, 520, 4096, and 4160.
[-carrier-id <text>] - Carrier ID
Selects information about disks that are located within the specified multi-disk carrier.
[-checksum-compatibility {advanced_zoned | block | none | zoned/advanced_zoned}] Checksum Compatibility
Selects information about disks that have the specified checksum compatibility.
[-container-type {aggregate | broken | foreign | labelmaint | maintenance | shared |
spare | unassigned | unknown | volume | unsupported}] - Container Type
Selects information about disks that have the specified container type.
Aggregate = Disk is used as a physical disk in an aggregate.
Broken = Disk is in broken pool.
Foreign = Array LUN has been marked foreign.
Labelmaint = Disk is in online label maintenance list.
Maintenance = Disk is in maintenance center.
Shared = Disk is partitioned or in a storage pool.
Spare = Disk is a spare disk.
Unassigned = Disk ownership has not been assigned.
Unknown = Container is currently unknown. This is the default setting.
Volume = This container-type is deprecated.
Unsupported = Disk is not supported.
1063
[-container-name <text>] - Container Name

Selects information about disks that have the specified container name.
If a disk is in an aggregate or storage pool, the container name is the name of the
aggregate or storage pool.
Partitioned disks could return multiple aggregate names.
[-copy-destination <disk path name>] - Copy Destination Name
Selects information about disks whose contents are being copied (due to either Rapid
RAID Recovery or disk replacement) to the specified spare disk.
[-copy-percent <integer>] - Percentage of Copy Complete
Selects information about disks that are involved as either a source or destination of a
copy operation, (due to either disk replacement or Rapid RAID Recovery) and that have
the specified percentage of the copy operation completed.
[-data-owner {<nodename>|local}] - Owner of Data Partition
Selects information about disks that have the specified data partition owner name. Used
with disks that have root and data partitions.
[-data-owner-id <nvramid>] - Data Partition owner System ID
Selects information about disks that have the specified data partition owner system ID.
Used with disks that have root and data partitions.
[-disk-io-kbps-total <integer>] - Total Disk Throughput in KBPS Across All Active Paths
Selects information about disks that have attained the specified I/O throughput on all
connected paths.
[-disk-iops-total <integer>] - Total Disk IOPs Across All Active Paths
Selects information about disks that have achieved the specified number of IOPs per
second on all connected paths.
[-diskpathnames <disk path name>, ...] - list of path based disk names
Selects information about disks that have all of the specified path names.
[-effective-rpm <integer>] - Effective RPM
Selects information about disks with the specified effective rotational speed.
[-dr-home {<nodename>|local}] - Disaster Recovery Home
Selects information about disks that have the specified Disaster home node.
[-dr-home-id <nvramid>] - Disaster Recovery Home System ID
1064
Selects information about disks whose Disaster home node has the specified system id.
[-error-type {onepath|onedomain|control|foreign|toobig|toosmall|invalidblocksize|
targetasymmap|deviceassymmap|failovermisconfig|unknown|netapp|fwdownrev|qualfail|
diskfail|notallflashdisk}, ...] - Error Type
Selects information about disks that have the specified error types.
onepath = The array LUN is accessible only via a single path.
onedomain = The array LUN is accessible only via a single fault domain.
control = The array LUN cannot be used because it is a control device.
foreign = The array LUN is marked as foreign and has some external SCSI
reservations other than those from Data ONTAP.
toobig = The array LUN exceeds the maximum array LUN size that Data ONTAP
supports.
toosmall = The array LUN is less than the minimum array LUN size that Data
ONTAP supports.
invalidblocksize = The array LUN is not a valid block size.
targetasymmap = The array LUN is presented more than once on a single target
port.
deviceassymmap = The array LUN is presented with multiple IDs.
failovermisconfig = The array LUN is configured with inconsistent failover
methods.
unknown = The array LUN from a storage array that is not supported by this
netapp = A SAN front-end LUN from one Data ONTAP system that is presented
as external storage to another Data ONTAP system.
fwdownrev = The disk firmware is a down version.
qualfail = The disk is not supported.
diskfail = The disk is in a failed state.
notallflashdisk = The disk does not match the All-Flash Optimized personality of
the system.
[-firmware-revision <text>] - Firmware Revision
Selects information about disks that have the specified firmware revision level.
1065
[-home {<nodename>|local}] - Home

Selects information about disks that have the specified home node.
[-home-id <nvramid>] - Home System ID
Selects information about disks whose home node has the specified system ID.
[-host-adapter <text>] - Primary Path Host Adapter
Selects information about disks that are currently using the specified Host Bus Adapter.
[-import-in-progress {true|false}] - Foreign LUN import in progress
Selects information about the array LUNs that are currently being imported If this
parameter is specified, the command displays information only about the disk or disks
that are currently being used for importing data.
[-initiator <text>, ...] - Initiator Port
Selects information about disks that are visible to the initiator specified. Disks that are
not currently in use by that initiator are included.
[-initiator-iops <integer>, ...] - Number of IOPS on Initiator (Rolling Average)
Selects information about disks that are visible to an initiator that has executed the
specified number of IOPs.
[-initiator-io-kbps <integer>, ...] - Kbytes of I/O per second on Initiator (Rolling
Average)
Selects information about disks visible to an initiator that has executed I/O at the
specified throughput.
[-initiator-lun-in-use-count <integer>, ...] - Number of LUNs in the in-use state on this
initiator
Selects information about disks with a path through an initiator that has the specified inuse-count.
[-initiator-side-switch-port <text>, ...] - Initiator Side Switch Port
Selects information about disks that are visible to an initiator connected to the specified
switch port.
[-is-multidisk-carrier {true|false}] - Multi Disk Carrier?
Selects information about disks that are located within a multi-disk carrier.
[-is-local-attach {true|false}] - Indicates If the Disk Is Local to This Cluster
Selects information about disks attached to the local(true) or remote(false) MetroCluster
site.
1066
[-lun <integer>, ...] - LUN ID

Selects information about the specified LUNs.
[-lun-iops <integer>, ...] - Number IOPS per second on disk (Rolling Average)
Selects information about the LUNs that have reached the specified number of IOPs.
[-lun-io-kbps <integer>, ...] - Kbytes/sec on Disk (Rolling Average)
Selects information about the LUNs that have reached the specified I/O throughput.
[-lun-path-use-state <text>, ...] - The Use State of the LUN on this path
Selects information about LUNs reporting the specified in-use state.
Selects information about disks of the specified model.
[-nodelist {<nodename>|local}, ...] - Controller name
Selects information about disks that are visible to all of the specified nodes .
[-outage-reason <text>] - Outage Reason
Selects information about disks that are not in service for the specified reason.
Possible values are: admin failed, admin removed, admin testing, evacuated, bad label,
bypassed, failed, init failed, label version, labeled broken, labelmaint, LUN resized,
missing, not responding, predict failure, rawsize shrank, recovering, sanitizing, sanitized,
SnapLock Disk, testing, unassigned, unknown.
[-path-error-count <integer>] - Path Error Count
Selects information about disks that are visible on a path that has incurred the specified
number of errors.
[-path-iops <integer>, ...] - Number of IOPS on Path (Rolling Average)
Selects information about disks on those paths that have reached the specified number
of IOPs.
[-path-io-kbps <integer>, ...] - Kbytes of I/O per second on Path (Rolling Average)
Selects information about disk with paths that have reached the specified I/O throughput
[-path-link-errors <integer>, ...] - Link Error count on path
Selects information about disks with paths that have incurred the specified number of
FC link errors.
[-path-lun-in-use-count <integer>, ...] - Number of LUNs in the in-use state on this path
Selects information about disks with paths that have the specified in-use-count.
1067
[-path-quality <integer>, ...] - Percentage of weighted error threshold

Selects information about disks on paths that have incurred the specified number
of errors. The value displayed is a measure of the health of a path expressed as a
percentage of an error threshold. Once a path has reached or surpassed the error
threshold, another path will be selected for I/O transfer, if there is one available.
[-physical-size-mb <integer>] - Physical Size (MB)
Selects information about disks that have the specified physical capacity, in megabytes.
[-physical-size {<integer>[KB|MB|GB|TB|PB]}] - Physical Size
Selects information about disks that have the specified physical capacity, in human
readable units.
[-physical-size-512b <integer>] - Physical Size in Units of 512 Bytes
Selects information about disks that have the specified physical capacity, in 512-byte
chunks. This parameter is present only for backwards compatibility with Data ONTAP
8.0.
Selects information about disks that belong to the specified RAID plex.
[-pool <text>] - Assigned Pool
Selects information about disks that belong to the specified SyncMirror pool (pool0 or
pool1).
[-port-speed <text>, ...] - Port Speed
Selects information about disks that are served by a Host Bus Adapter that is running at
the specified port speed.
[-position <diskPositionType>] - Disk Position
Selects information about disks that have the specified position within their disk
container.
[-prefailed {true|false}] - Marked for Rapid RAID Recovery?
Selects information about disks that match the specified parameter value indicating
whether the disk is either awaiting or is in process of Rapid RAID Recovery.
[-preferred-target-port {true|false}, ...] - Whether or not target port group is preferred
Selects information about disks that match the specified parameter value indicating
whether the backing storage is ALUA (Assymetric Logical Unit Access) capable and has
specified the array target port on this path to be a preferred target port for I/O.
1068
[-primary-port <text>] - Primary Path Disk Port

Selects information about disks that use the specified primary port.
[-raid-group <text>] - Raid Group Name
Selects information about disks that belong to the specified RAID group.
[-reconstruction-percent <integer>] - Percentage of Reconstruction Complete
Selects information about disks that are being reconstructed and that have the specified
percentage of the reconstruction operation completed.
[-replacing {true|false}] - Being Replaced?
Selects information about disks that match the specified boolean value indicating
whether the disk is either awaiting or in process of disk replacement.
[-reservation-key <text>] - Reservation Key
If this parameter is specified, the command displays information only about the disk or
disks that have the specified persistent reservation key.
[-reservation-type {rs|we|re|ea|sa|wero|earo|wear|eaar|none}] - Reservation Type
If this parameter is specified, the command displays information only about the disk or
disks that have the specified persistent reservation type. Possible values are: rs, we, re,
ea, sa, wero, earo, wear, eaar, or none.
[-reserver-id <integer>] - Reservation System ID
Selects information about disks that are reserved by the node with the specified system
ID.
[-root-owner {<nodename>|local}] - Owner of Root Partition
Selects information about disks that have the specified root partition owner name. Used
with disks that have root and data partitions.
[-root-owner-id <nvramid>] - Root Partition owner System ID
Selects information about disks that have the specified root partition owner system ID.
Used with disks that have root and data partitions.
[-rpm <integer>] - Revolutions Per Minute
Selects information about disks that have the specified rotational speed.
[-secondary-name <disk path name>] - Secondary Path Name
Selects information about disks that use the specified secondary path name, for
multipath configuration.
1069
[-secondary-port <text>] - Secondary Path Disk Port

Selects information about disks that use the specified secondary port.
Selects information about the disk that has the specified serial number.
[-storage-pool <text>] - Storage Pool Name
Selects information about disks that belong to the specified SSD storage pool.
[-shelf <integer>] - Shelf
Selects information about disks that are located within the specified shelf.
[-shelf-uid <text>] - Shelf UID
Selects information about disks that are located within a shelf with the specified Shelf
UID.
[-stack-id <integer>] - Stack ID
A cluster unique id for a collection of one or more interconnected shelves.
[-target-iops <integer>, ...] - Number of IOPS to Target (Rolling Average)
Selects information about disks that are visible on target ports that have performed the
specified number of IOPs.
[-target-io-kbps <integer>, ...] - Kbytes of I/O per second to Target (Rolling Average)
Selects information about disks that are visible on target ports that have reached the
specified I/O throughput.
[-target-lun-in-use-count <integer>, ...] - Number of LUNs in the in-use state on this
target
Selects information about disks with a path through a target port that has the specified
in-use-count.
[-target-port-access-state <text>, ...] - Failover optimization type
Selects information about disks that are visible on target ports that have the specified
access state.
[-target-side-switch-port <text>, ...] - Target Side Switch Port
Selects information about disks that are visible on target ports identified by the switch
port to which they are connected.
[-target-wwpn <text>, ...] - Target Port
1070
Selects information about disks that are visible on target ports identified by their World
Wide Port Name.
[-tpgn <integer>, ...] - Target Port Group Number
Selects information about disks that belong to the specified Target Port Group Number.
[-type {ATA | BSAS | EATA | FCAL | FSAS | LUN | MSATA | SAS | SATA | SCSI | SSD |
XATA | XSAS | VMDISK}] - Disk Type
Selects information about disks that have the specified disk type.
[-usable-size-mb <integer>] - Usable Size (MB)
Selects information about disks that have the specified usable space, in megabytes.
[-usable-size {<integer>[KB|MB|GB|TB|PB]}] - Usable Size
Selects information about disks that have the specified usable space, in human
readable units.
[-vendor <text>] - Vendor Name
Selects information about disks that have the specified vendor.
[-vmdisk-device-id <integer>, ...] - Virtual Disk Device ID
Selects information about disks that have the specified virtual disk device ID.
[-zeroed {true|false}] - Zeroed?
Selects information about disks that have (true) or have not (false) been fully prezeroed.
[-zeroing-percent <integer>] - Percentage of Zeroing Complete
Selects information about disks that are zeroing and have the specified percentage
complete.
Examples
The following example displays information about all disks:
cluster1::> storage disk show
Usable
Disk
Container
Size Shelf Bay Type
Position
Aggregate Owner
---------------- ---------- ----- --- ----------- ---------- --------- -------1.1.1
10GB
1.1.4
78.59GB
10GB
1.1.12
1 spare
present
node1
4 spare
present
node1
12 spare
present
node1
1071
1.2.12
10GB
12 broken
present
1.3.7
78.59GB
1.1.6
78.59GB
1.2.10
78.59GB
10 aggregate
1.4.9
78.59GB
1.1.0
10GB
1.4.1
10GB
1.1.2
10GB
1.1.3
node1
7 aggregate
parity
aggr0_u23 node1
6 broken
present
dparity
aggr0_u23 node1
9 aggregate
data
aggr0_u23 node1
0 aggregate
dparity
aggr0_u22 node2
1 aggregate
data
dp_degraded node2
2 spare
present
node2
20GB
3 spare
present
node2
1.4.4
20GB
4 spare
present
node2
1.4.6
10GB
6 aggregate
data
dp_sdc
node2
1.1.5
268.0GB
5 maintenance present
node2
1.3.0
10GB
0 aggregate
parity
aggr0_u22 node2
1.4.11
10GB
11 spare
present
node2
1.4.13
20GB
13 broken
present
node2
node1
[...]
The following example displays detailed information about a disk named 1.0.75
cluster1::> storage disk show -disk 1.0.75
Disk: 1.0.75
Container Type: spare
Owner/Home: node2 / node2
DR Home: Stack ID/Shelf/Bay: 1 / 0 / 75
LUN: 0
Array: N/A
Vendor: NETAPP
Model: X267_HKURO500SSX
Serial Number: ZAKAS0GH
UID:
1FF17846:0A419201:9325845A:3ABD5075:00000000:00000000:00000000:00000000:00000000:00000000
BPS: 512
Physical Size: 10.15GB
Position: present
Checksum Compatibility: block
Aggregate: Plex: Paths:
LUN
Controller
Initiator
Acc Use Target Port
1072
ID
Initiator Side
Link
Target Side
Switch Port
TPGN
Speed
Switch Port
I/O KB/s
IOPS
------------------ --------- ----- -------------------- ---------------------- --- ----------------------- ------ ------- ------------ -----------node1
AO INU
0d
220a000a3384e4d2
node1
AO RDY
0c
2209000a3384e4d2
node2
AO INU
0d
2209000a3384e4d2
N/A
21
2 Gb/S
N/A
N/A
62
2 Gb/S
N/A
N/A
62
N/A
2 Gb/S
Errors:
-
The following example displays RAID-related information about disks used in an

aggregate:
cluster1::> storage disk show -raid-info-for-aggregate
Owner Node: node1
Aggregate: aggr0_node1_0
Plex: plex0
RAID Group: rg0
Usable Physical
Position Disk
Size
Size
HA Shelf Bay Chan Pool
Type
RPM
-------- --------------------- ------------ ---- ------ ----- ------------- -------data

9.93GB
2.11.2
2d
11
2 B
Pool0
SAS
15000
9.77GB
dparity
9.93GB
2.11.0
2d
11
0 B
Pool0
SAS
15000
9.77GB
parity
9.93GB
2.11.1
2d
11
1 B
Pool0
SAS
15000
9.77GB
Owner Node: node2

Aggregate: a1
Plex: plex0
RAID Group: rg0
Usable Physical
Size
Position Disk
Size
Type
RPM
-------- --------------------- ------------ ---- ------ ----- ------------- -------data

9.91GB
2.1.8
2a
8 B
Pool0
BSAS
7200
9.77GB
dparity
9.91GB
2.1.6
2a
6 B
Pool0
BSAS
7200
9.77GB
parity
9.91GB
2.1.7
2a
7 B
Pool0
BSAS
7200
9.77GB
Owner Node: node2
1073
Aggregate: a1
Plex: plex0
RAID Group: rg1
Usable Physical
Position Disk
Size
Size
Type
RPM
-------- --------------------- ------------ ---- ------ ----- ------------- -------data

9.91GB
2.1.11
2a
11 B
Pool0
BSAS
7200
9.77GB
dparity
9.91GB
2.1.9
2a
9 B
Pool0
BSAS
7200
9.77GB
parity
9.91GB
2.1.10
2a
10 B
Pool0
BSAS
7200
9.77GB
Type
RPM
Owner Node: node2

Aggregate: aggr0
Plex: plex0
RAID Group: rg0
Usable Physical
Position Disk
Size
Size
-------- --------------------- ------------ ---- ------ ----- ------------- -------data

10.03GB
2.1.5
2a
5 B
Pool0
BSAS
7200
9.71GB
dparity
10.03GB
2.1.2
2a
2 B
Pool0
BSAS
7200
9.71GB
parity
10.03GB
2.1.4
2a
4 B
Pool0
BSAS
7200
9.71GB
The following example displays RAID-related information about spares:

cluster1::> storage disk show -spare
Original Owner: node1
Usable Physical
Disk
HA Shelf Bay Chan
Pool
Type
RPM
Size
Size Owner
--------------- ------------ ---- ------ ----- ------ -------- --------------1.1.23
0b
23
Pool0
FCAL
10000
132.8GB
134.2GB node1
1.1.25
0b
25
Pool0
FCAL
10000
132.8GB
133.9GB node1
1.1.26
0b
26
Pool1
FCAL
10000
132.8GB
133.9GB node1
1.1.27
0b
27
Pool1
FCAL
10000
132.8GB
134.2GB node1
Home Owner: node2
1074

Usable Physical
Disk
HA Shelf Bay Chan
Pool
Type
RPM
Size
Size Owner
--------------- ------------ ---- ------ ----- ------ -------- --------------1.1.19
0a
19
Pool1
FCAL
10000
132.8GB
133.9GB node2
1.1.20
0a
20
Pool0
FCAL
10000
132.8GB
133.9GB node2
1.1.21
0a
21
Pool0
FCAL
10000
132.8GB
133.9GB node2
[...]
The following example displays RAID-related information about broken disks:

cluster1::> storage disk show -broken
Usable
Physical
Disk
Size
Outage Reason HA Shelf Bay Chan
Pool
Type
RPM
Size
--------------- ------------- ------------ ---- ------ ----- ------ --------------1.1.0

133.9GB
admin failed
0b
Pool0
FCAL
10000
132.8GB
1.2.6
134.2GB
admin removed 0b
Pool1
FCAL
10000
132.8GB

Usable
Physical
Disk
Size
Pool
Type
RPM
Size
--------------- ------------- ------------ ---- ------ ----- ------ --------------1.1.0

133.9GB
admin failed
0a
Pool0
FCAL
10000
132.8GB
1.1.13
133.9GB
admin removed 0a
13
Pool0
FCAL
10000
132.8GB
The following example displays RAID-related information about disks in maintenance

center:
cluster1::> storage disk show -maintenance
Usable
Physical
1075
Disk
Size
Pool
Type
RPM
Size
--------------- ------------- ------------ ---- ------ ----- ------ --------------1.1.8

133.9GB
admin testing 0b
Pool0
FCAL
10000
132.8GB
1.2.11
134.2GB
admin testing 0b
11
Pool1
FCAL
10000
132.8GB

Usable
Physical
Disk
Size
Pool
Type
RPM
Size
--------------- ------------- ------------ ---- ------ ----- ------ --------------1.2.10

133.9GB
admin testing 0a
10
Pool1
FCAL
10000
132.8GB
1.2.13
134.2GB
admin testing 0a
13
Pool1
FCAL
10000
132.8GB
The following example displays partition-related information about disks:

cluster1::> storage disk show -partition-ownership
Root
Data
Container
Owner ID
Owner
Container
Disk
Aggregate Root Owner

Owner ID
Owner ID
Data Owner
-------- --------- ------------- ----------- ------------- ----------------------- ----------1.1.0

-
1076
1.1.1
1574237083
node1
1574237083
node1
1.1.2
-
1.1.3
1574237083
node1
1574237083
node1
1.1.4
aggr0
1574237083
node1
1.1.5
-
1.1.6
-
1.1.7
-
1.1.8
-
See Also
storage aggregate show-status
1077
storage disk unfail

Unfail a broken disk
privilege level.
Description
The storage disk unfail command can be used to unfail a broken disk.
If the attempt to unfail the disk is unsuccessful, the disk remains in the broken state.
The disk unfail command prompts for confirmation unless you specify the "-quiet"
parameter.
Parameters
This parameter specifies the disk to be unfailed.
[-spare | -s [true]] - Make the Disk Spare
This parameter specifies whether the unfailed disk will be made a spare disk. The disk is
forced to become a spare disk if this parameter is specified.
If this parameter is not specified, the disk is brought back into its parent aggregate.
Setting this parameter might result in the aggregate coming back online if it is not
complete or online. The default value is false.
[-quiet | -q [true]] - Confirmations off
You can set this parameter to true to suppress the confirmation messages. However,
before proceeding with the command, you should be aware that the confirmation
message contains important information about the effect of unfailing a disk. This
command cannot be reversed once it is invoked. The default value is false.
Examples
The following example unfails a disk named 1.1.16 to become a spare disk:
cluster1::*> storage disk unfail -disk 1.1.16 -spare
Warning: Failed disk "1.1.16" may have aggregate labels and file system data present.
In that case use of this command to release this disk as a spare disk, will lead to
1078
permanent loss of any file system data that may be on this disk, and may prevent
recovery of a failed aggregate. Are you sure you want to continue with disk unfail? {y|n}:
1079
storage disk updatefirmware

(DEPRECATED) - Update disk firmware
level.
Description
Note:
This command is deprecated and may be removed in a future release of Data ONTAP.
Use the "storage disk firmware update" command.
The storage disk updatefirmware command updates the firmware on one or
more disks.
You can download the latest firmware by using the storage firmware download
command.
You can specify a list of one or more disks whose firmware is to be updated by using the
-disk
parameter, or you can update the firmware on all local disks by omitting the -disk
parameter.
Parameters
[-disk <disk path name>, ...] - Disk
This specifies the disk or disks whose firmware is to be updated.
If you do not specify this option, all local disks' firmware is updated.
Examples
The following example updates the firmware on all disks:
cluster1::> storage disk updatefirmware
See Also
storage disk firmware update storage firmware download
1080
storage disk zerospares

Zero non-zeroed spare disks
level.
Description
The storage disk zerospares command zeroes all non-zeroed spare disks in all
nodes or a specified node in the cluster. A node must be online to zero disks. Zeroing
a disk writes zeros to the entire disk and must be done before a disk can be reused in
another aggregate.
Parameters
[-owner {<nodename>|local}] - Owner
If this parameter is specified, only non-zeroed spares assigned to the specified node will
be zeroed. Otherwise, all non-zeroed spares in the cluster will be zeroed.
Examples
The following example zeroes all non-zeroed spares owned by a node named node4:
cluster1::> storage disk zerospares -owner node4
storage disk error show

Display disk component and array LUN configuration errors.
level.
Description
The storage disk error show command displays disk component and array LUN
configuration errors.
Parameters
1081
specify.
| [-instance ] }
about all fields.
[-uid <text>] - UID
Displays the error information of the disk whose unique ID matches

the value you specify. A disk unique identifier has the form:
20000000:875D4C32:00000000:00000000:00000000:00000000:00000000:00000000:000
Displays the errors of the storage array whose name you specified.
Displays the error information for the disks on the clustered node whose name you
specified.
[-disk <disk path name>] - Disk
Displays detailed error information about the disk you specified.
Displays the error information for the disk whose serial number you specified.
[-error-id <integer>, ...] - Error ID
Displays the error information for the disks whose Error IDs match IDs you specified.
Displays all disk errors of the error types you specified, grouped by type.
onepath = The array LUN is accessible only via a single path.
onedomain = The array LUN is accessible only via a single fault domain.
control = The array LUN cannot be used because it is a control device.
foreign = The array LUN is marked as foreign and has some external SCSI
reservations other than those from Data ONTAP.
toobig = The array LUN exceeds the maximum array LUN size that Data ONTAP
supports.
1082
toosmall = The array LUN is less than the minimum array LUN size that Data
ONTAP supports.
invalidblocksize = The array LUN is not a valid block size.
targetasymmap = The array LUN is presented more than once on a single target
port.
deviceassymmap = The array LUN is presented with multiple IDs.
failovermisconfig = The array LUN is configured with inconsistent failover
methods.
unknown = The array LUN from a storage array that is not supported by this
netapp = A SAN front-end LUN from one Data ONTAP system that is presented
as external storage to another Data ONTAP system.
fwdownrev = The disk firmware is a down version.
qualfail = The disk is not supported.
diskfail = The disk is in a failed state.
notallflashdisk = The disk does not match the All-Flash Optimized personality of
the system.
Examples
The following example displays configuration errors seen in the system:
cluster1::> storage disk error show
Disk
Error Type
Error Text
---------------- ----------------- -------------------------------------------1.02.0

qualfail
This disk failed dynamic disk qualification.
Update the Disk Qaulification Package.
1083
storage disk firmware revert

Revert disk firmware
privilege level.
Description
The storage disk firmware revert command reverts firmware on all disks or a
specified list of disks on a node.
You can specify a list of one or more disks whose firmware is to be reverted by using the
-disk parameter.
You can revert the firmware on all the disks owned by a node by using the -node
parameter.
This command can make the disks inaccessible for up to five minutes after the start of
its execution. Therefore, the network sessions that use the concerned node must be
terminated before running the storage disk firmware revert command. This
is particularly true for CIFS sessions that might be terminated when this command is
executed.
If you need to view the current firmware versions, use the storage disk show fields firmware-revision command. The following example displays partial output from
the storage disk show -fields firmware-revision command, where the firmware
version for the disks is NA02:
cluster1::> storage disk show -fields firmware-revision
disk
firmware-revision
-------- ----------------1.0.0
NA02
1.0.1
NA02
1.0.2
NA02
1.0.3
NA02
1.0.4
NA02
1.0.5
NA02
The firmware files are stored in the /mroot/etc/disk_fw directory on the node. The
firmware file name is in the form of "product-ID.revision.LOD". For example, if the
firmware file is for Seagate disks with product ID X225_ST336704FC and the firmware
1084
version is NA01, the file name is X225_ST336704FC.NA01.LOD. If the node in

this example contains disks with firmware version NA02, the /mroot/etc/disk_fw/
X225_ST336704FC.NA01.LOD file is downloaded to every disk when you execute this
command.
How to Revert the Firmware for an HA Pair in a Cluster
Use the following procedure to perform a revert on the disks in an HA environment:
Make sure that the nodes are not in takeover or giveback mode.
Download the latest firmware on both nodes by using the storage firmware
download command.
Revert the disk firmware on Node A's disks by entering the storage disk
firmware revert -node node-A command.
Wait until the storage disk firmware revert command completes on
Node A, and then revert the firmware on Node B's disks by entering the storage
disk firmware revert -node node-B command.
Parameters
{ -disk <disk path name>, ... - Disk Name
Specifies the disk or disks whose firmware is to be reverted.
| -node {<nodename>|local} } - Node Name
Specifies the node name. The disk firmware will be reverted on all the disks owned by
the node specified by this parameter.
Examples
The following example reverts the firmware on all disks owned by cluster-node-01:
cluster1::*> storage disk firmware revert -node cluster-node-01
Warning: Disk firmware reverts can be disruptive to the system. Reverts
involve
power cycling all of the affected disks, as well as suspending disk
I/O to the disks being reverted. This delay can cause client
disruption. Takeover/giveback operations on a high-availability
(HA)
group will be delayed until the firmware revert process is
complete.
Disk firmware reverts should only be done one node at a time. Disk
firmware reverts can only be performed when the HA group is
healthy;
they cannot be performed if the group is in takeover mode.
1085
Do you want to continue with disk firmware reverts? {y|n}: y

Info: Reverting disk firmware for disks on cluster-node-01.
The following example reverts the firmware on disk 1.5.0 which is owned by node
cluster-node-04:
cluster1::*> storage disk firmware revert -disk 1.5.0
Warning: Disk firmware reverts can be disruptive to the system. Reverts
involve
power cycling all of the affected disks, as well as suspending disk
I/O to the disks being reverted. This delay can cause client
(HA)
group will be delayed until the firmware revert process is
complete.
Disk firmware reverts should only be done one node at a time. Disk
firmware reverts can only be performed when the HA group is
healthy;
Do you want to continue with disk firmware reverts? {y|n}: y
Info: Reverting disk firmware for disks on cluster-node-04.
See Also
storage disk show storage firmware download
1086
storage disk firmware update

Update disk firmware
privilege level.
Description
Use the storage disk firmware update command to manually update firmware
on all disks or a specified list of disks on a node. However, the recommended way to
update disk firmware in a cluster is to enable automatic background firmware update
by enabling the -bkg-firmware-update parameter for all of the nodes in the cluster.
You can do this by entering the storage disk option modify -node * -bkgfirmware-update on command.
You can download the latest firmware on the node by using the storage firmware
download command.
You can specify a list of one or more disks whose firmware is to be updated by using the
-disk parameter.
You can update the firmware on all the disks owned by a node by using the -node
parameter.
This command can make the disks inaccessible for up to five minutes after the start of
its execution. Therefore, the network sessions that use the concerned node must be
terminated before running the storage disk firmware update command. This
is particularly true for CIFS sessions that might be terminated when this command is
executed.
The firmware is automatically downloaded to disks, which report previous versions of
the firmware. For information on automatic firmware update downloads, see "Automatic
versus Manual Firmware Download".
If you need to view the current firmware versions, use the storage disk show fields firmware-revision command. The following example displays partial output from
the storage disk show -fields firmware-revision command, where the firmware
version for the disks is NA01:
cluster1::> storage disk show -fields firmware-revision
disk
firmware-revision
-------- ----------------1.0.0
NA01
1087
1.0.1
NA01
1.0.2
NA01
1.0.3
NA01
1.0.4
NA01
1.0.5
NA01
The firmware files are stored in the /mroot/etc/disk_fw directory on the node. The
firmware file name is in the form of "product-ID.revision.LOD". For example, if the
firmware file is for Seagate disks with product ID X225_ST336704FC and the firmware
version is NA02, the filename is X225_ST336704FC.NA02.LOD. The revision part of the
file name is the number against which the node compares each disk's current firmware
version. If the node in this example contains disks with firmware version NA01, the /
mroot/etc/disk_fw/X225_ST336704FC.NA02.LOD file is used to update every eligible
disk when you execute this command.
Automatic versus Manual Firmware Download
The firmware is automatically downloaded to those disks that report previous versions of
firmware following a system boot or disk insertion. Note that:
A manual download is a disruptive operation that makes disks inaccessible for up
to five minutes after the download is started. Network sessions that use the node
must be terminated before running the storage disk firmware update
command.
The firmware is not automatically downloaded to the node's partner node in an HA
pair.
The firmware is not automatically downloaded to unowned disks on nodes
configured to use software-based disk ownership.
The bkg-firmware-update parameter controls how the automatic firmware
download feature works:
If the bkg-firmware-update parameter is set to off, then the storage disk
firmware update will update the firmware on the drives in parallel.
If the bkg-firmware-update parameter is set to on, then the storage
disk firmware update will only automatically update filesystem
disks contained in RAID4 volumes. Firmware updates for spares and
filesystem disks contained within RAID-DP, mirrored RAID-DP and mirrored
RAID4 volumes will be done in a nondisruptive manner in the background
after boot. Firmware downloads for these disks will be done sequentially
by temporarily taking them offline one at a time for the duration of the
1088
download. After the firmware is updated, the disk will be brought back online
and restored to its normal operation.
During an automatic download to an HA environment, the firmware is not downloaded to
the disks owned by the HA partner.
When you use the storage disk firmware update command, the firmware is:
Updated on every disk regardless of whether it is on the A-loop, the B-loop, or in
an HA environment.
If the node is configured in a software-based disk ownership system, only disks
owned by this node are updated.
Follow the instructions in "How to Update the Firmware for an HA Pair in a Cluster"
to ensure that the updating process is successful. Data ONTAP supports redundant
path configurations for disks in a non-HA configuration. The firmware is automatically
downloaded to disks on the A-loop or B-loop of redundant configurations that are not
configured in an HA pair and are not configured to use software-based disk ownership.
Automatic Backgroud Firmware Update
The firmware can be updated in the background so that the firmware update process
does not impact the clients. This functionality is controlled with the bkg-firmware-update
parameter. You can modify the parameter by using the CLI storage disk option
modify -node node_name -bkg-firmware-update on|off command. The default
value for this parameter is "on".
When disabled or set to "off", storage disk firmware update will update the
firmware in automated mode. This means that all disks which had older firmware
revision will be updated regardless of whether they are spare or filesystem disks.
When enabled or set to "on", the background storage disk firmware update
will update firmware in automated mode only on disks that can be successfully taken
offline from active filesystem RAID groups and from the spare pool. For filesystem
disks, this capability currently exists within RAID-DP, mirrored RAID-DP, and mirrored
RAID4 volume types. To ensure a faster boot process, no firmware is downloaded to
spares and filesystem disks contained in the previous volume types. However, firmware
updates for disks within RAID4 volumes are done at boot. RAID4 volumes can be
temporarily (or permanently) upgraded to RAID-DP to automatically enable background
firmware update capability.
This provides the highest degree of safety available, without the cost of copying data
from each disk in the system twice. Disks are taken offline one at a time and then the
firmware is updated on them. The disk is brought online after the firmware update and
a mini/optimized reconstruct happens for any writes, which occurred while the disk
1089
was offline. Background disk firmware update will not occur for a disk if its containing
RAID group or the volume is not in a normal state (for example, if the volume/plex is
offline or the RAID group is degraded). However, due to the continuous polling nature of
background disk firmware update, firmware updates will resume after the RAID group/
plex/volume is restored to a normal mode. Similarly, background disk firmware updates
are suspended for the duration of any reconstruction within the system.
How to Update the Firmware for an HA Pair in a Cluster
The best way to update the firmware in a cluster with HA pairs is to use automatic
background firmware update by enabling the option bkg-firmware-update parameter
for each node. Enable the -bkg-firmware-update parameter on all the nodes by
entering the storage disk option modify -node node_name -bkg-firmwareupdate on command. Alternatively, use the following procedure to successfully perform
a manual update on the disks in an HA environment:
Make sure that the nodes are not in takeover or giveback mode.
Download the latest firmware on both the nodes by using the storage
firmware download command.
Install the new disk firmware on Node A's disks by entering the storage disk
firmware update -node node-A command.
Wait until the storage disk firmware update command completes on
Node A, and then install the new disk firmware on Node B's disks by entering the
storage disk firmware update -node node-B command.
Parameters
{ -disk <disk path name>, ... - Disk
Specifies the disk or disks whose firmware is to be updated.
| -node {<nodename>|local} } - node
Specifies the node name. The disk firmware will be updated on all the disks owned by
the node specified by this parameter.
Examples
The following example updates the firmware on all disks owned by clusternode-01:
cluster1::*> storage disk firmware update -node cluster-node-01
Warning: Disk firmware updates can be disruptive to the system. Updates
involve
1090
power cycling all of the affected disks, as well as suspending

disk
I/O to the disks being updated. This delay can cause client
(HA)
group will be delayed until the firmware update process is
complete.
Disk firmware updates should only be done one node at a time. Disk
firmware updates can only be performed when the HA group is
healthy;
Do you want to continue with disk firmware updates? {y|n}: y
Info: Updating disk firmware for disks on cluster-node-01.
The following example updates the firmware on disk 1.5.0 which is owned by
node cluster-node-04:
cluster1::*> storage disk firmware update -disk 1.5.0
Warning: Disk firmware updates can be disruptive to the system. Updates
involve
power cycling all of the affected disks, as well as suspending
disk
I/O to the disks being updated. This delay can cause client
(HA)
group will be delayed until the firmware update process is
complete.
Disk firmware updates should only be done one node at a time. Disk
firmware updates can only be performed when the HA group is
healthy;
Do you want to continue with disk firmware updates? {y|n}: y
Info: Updating disk firmware for disks on cluster-node-04.
See Also
storage disk option modify storage firmware download storage disk show
1091
storage disk option modify

Modify disk options
level.
Description
The storage disk option modify command modifies the background firmware
update setting, automatic copy setting, controls automatic disk assignment of all disks
assigned to a specified node, or modifies the policy of automatic disk assignment of
unowned disks.
Parameters
This parameter specifies the node that owns the disks whose options are to be modified.
[-bkg-firmware-update {on|off}] - Background Firmware Update
This parameter specifies whether firmware updates run as a background process.
The default setting is on, which specifies that firmware updates to spare disks and file
system disks is performed nondisruptively via a background process. If the option is
turned off, automatic firmware updates occur at system startup or during disk insertion.
[-autocopy {on|off}] - Auto Copy
This parameter specifies whether data is to be automatically copied from a failing
disk to a spare disk in the event of a predictive failure. The default setting is on. It is
sometimes possible to predict a disk failure based on a pattern of recovered errors that
have occurred. In such cases, the disk reports a predictive failure. If this option is set
to on, the system initiates Rapid RAID Recovery to copy data from the failing disk to
an available spare disk. When data is copied, the disk is marked as failed and placed
in the pool of broken disks. If a spare is not available, the node continues to use the
disk until it fails. If the option is set to off, the disk is immediately marked as failed and
placed in the pool of broken disks. A spare is selected and data from the missing disk
is reconstructed from other disks in the RAID group. The disk does not fail if the RAID
group is already degraded or is being reconstructed. This ensures that a disk failure
does not lead to the failure of the entire RAID group.
[-autoassign {on|off}] - Auto Assign
1092
This parameter specifies whether automatic assignment of unowned disks is enabled or

disabled. The default setting is on. This parameter is used to set both a node-specific
and a cluster-wide disk option.
[-autoassign-policy {default|bay|shelf|stack}] - Auto Assignment Policy
This parameter defines the granularity at which auto assign should work. This option is
ignored if the -autoassign option is off. Auto assignment can be done at the stack/loop,
shelf, or bay level. The possible values for the option are default, stack, shelf, and bay.
The default value is platform dependent. It is stack for all non-entry platforms and singlenode systems, whereas it is bay for entry-level platforms.
Examples
The following example sets the background firmware update setting to on for all disks
belonging to a node named node0:
cluster1::> storage disk option modify -node node0 -bkg-firmware-update on
The following example shows how to enable auto assignment for the disks on node1:
cluster1::> storage disk option modify -node node1 -autoassign on
cluster1::> storage disk option show
Node
BKg. FW. Upd.
Auto Copy
Auto Assign
Auto Assign Policy
-------------
-------------
------------
-------------
-----------------
node1
on
on
on
default
node2
on
on
off
default
The following example shows how to modify the auto assignment policy on node1:
cluster1::> storage disk option modify -node node1 -autoassign-policy bay
Node
BKg. FW. Upd.
Auto Copy
Auto Assign
Auto Assign Policy
-------------
-------------
------------
-------------
-----------------
node1
on
on
on
bay
node2
on
on
off
default
1093
storage disk option show

Display a list of disk options
level.
Description
The storage disk option show command displays the settings of the following
disk options:
Background firmware update
Automatic copying of data to a spare disk in the event of a predictive failure
Automatic assignment of disks
Policy that governs automatic assignment of unowned disks
Parameters
specify.
| [-instance ] }
about all fields.
Selects the node that owns the disks. If this parameter is not specified, the command
displays information about the disk options on all the nodes.
[-bkg-firmware-update {on|off}] - Background Firmware Update
Selects the disks that match this parameter value.
[-autocopy {on|off}] - Auto Copy
[-autoassign {on|off}] - Auto Assign
Displays the auto assignment status of unowned disks. The default value is on.
1094
[-autoassign-policy {default|bay|shelf|stack}] - Auto Assignment Policy

Selects the disks that match the automatic assignment policy value:
Default
Stack/loop
Shelf
Bay
Examples
The following example displays disk-option settings for disks owned by all nodes in the
cluster:
Node
Policy
BKg. FW. Upd.
Auto Copy
Auto Assign
Auto Assign
------------- ------------------------------
------------
-------------
node0
on
on
on
default
node1
on
on
on
stack
node2
on
on
on
bay
node3
on
on
on
bay
1095
storage errors show

Display storage configuration errors.
level.
Description
The storage errors show command displays configuration errors with back end
storage arrays.
Parameters
specify.
| [-instance ] }
about all fields.
[-uid <text>] - UID
Selects the disks that have the specified name for the storage array that is connected to
the cluster.
[-disk <disk path name>] - Disk
[-error-id <integer>, ...] - Error ID
Selects the disks with error-id values that match this parameter value.
1096
Selects the disks with error types values that match this parameter value.
Examples
The following example displays configuration errors seen in the system:
cluster1::> storage errors show
Disk: vnv3070f20b:vnci9124s54:1-24.126L23
-------------------vnci9124s54:1-24.126L23 (600a0b800019e999000036b24bac3983): This array LUN
reports an invalid block size and is not usable. Only a block size of 512 is
supported.
1097
storage failover giveback

Return failed-over storage to its home node
level.
Description
The storage failover giveback command returns storage that has failed over to
a node's partner back to the home node. This operation fails if other resource-intensive
operations (for instance, system dumps) are running and make the giveback operation
potentially dangerous or disruptive. Some options are available only at the advanced
privilege level and higher. Run the storage failover show-giveback command
to check the status of giveback operations.
Note:
If the system ID of the partner has changed while the node is in takeover mode,
the storage failover giveback command updates the ownership of the
partner's disks to the new system ID while giving back.
If the giveback operation fails due to the operation being vetoed by a subsystem,
check the syslog or EMS output for a subsystem-specific reason for the abort.
The corrective action is subsystem-specific and is detailed in the corrective action
portion of the message. Follow the corrective action specified by the subsystem
and then reissue the storage failover giveback command. If you cannot
perform the corrective action, then use the override-vetoes option in the
storage failover giveback command to force the giveback.
If the giveback operation fails because the node cannot communicate with its
partner, check the EMS output for the corrective action. Follow the corrective
action and then reissue the storage failover giveback command. If
you cannot perform the corrective action, then use the -require-partnerwaiting false option in the storage failover giveback command to
force the giveback. This parameter is available only at the advanced privilege
level and higher.
If the node does not receive notification that the partner has brought online
the given-back aggregate and its volumes, the storage failover showgiveback command displays the giveback status for the aggregate as failed.
A possible reason for this failure is that the partner is overloaded and slow in
bringing the aggregate online. Run the storage aggregate show command
to verify that the aggregate and its volumes are online on the partner node. The
1098
node will not attempt the giveback operation for remaining aggregates. To force
the giveback, use the -require-partner-waiting false option in the
storage failover giveback command. This parameter is available only at
the advanced privilege level and higher.
Parameters
{ -ofnode {<nodename>|local} - Node to which Control is Givenback
Specifies the node whose storage is currently taken over by its partner and will be given
back by the giveback operation.
| -fromnode {<nodename>|local} } - Node Initiating Giveback
Specifies the node that currently holds the storage that is to be returned to the partner
node.
[-require-partner-waiting {true|false}] - Require Partner in Waiting (privilege: advanced)
If this optional parameter is used and set to false, the storage is given back regardless
of whether the partner node is available to take back the storage or not. If this parameter
is used and set to true, the storage will not be given back if the partner node is not
available to take back the storage. If this parameter is not used, the behavior defaults to
the setting of the -check-partner option set with the storage failover modify
command.
[-override-vetoes [true]] - Override All Vetoes
If this optional parameter is used, the system overrides veto votes during a giveback
operation. If this parameter is not used, the system does not proceed with a giveback if
it is vetoed. This parameter, if used, can only be set to true.
[-only-cfo-aggregates [true]] - Giveback Only CFO Aggregates
If this optional parameter is used, giveback of only the CFO aggregates (root aggregate
and CFO style data aggregates) will be attempted. If this parameter is not used,
giveback of all the aggregates (CFO and SFO aggregates) will be attempted. This
parameter, if used, can only be set to true.
Examples
The following example gives back storage that is currently held by a node named
node1. The partner must be available for the giveback operation to occur.
node::> storage failover giveback -fromnode node1
The following example gives back only the CFO aggregates to a node named node2
(the aggregates are currently held by a node named node1). The partner must be
1099
available for the giveback operation to occur, and the veto-giveback process can be
overridden.
node::> storage failover giveback -ofnode node2
-override-vetoes true -only-cfo-aggregates true
See Also
storage failover modify storage failover show-giveback storage aggregate show
1100
storage failover modify

Modify storage failover attributes
level.
Description
The storage failover modify command changes the storage-failover options for
a node. Some options are available only at the advanced privilege level and higher.
Parameters
This specifies the node whose storage-failover options are to be modified.
{ [-enabled {true|false}] - Takeover Enabled
This optionally specifies whether storage failover is enabled. The default setting is true
.
| [-mode {ha|non_ha}] } - HA Mode
This specifies whether the node is set up in high-availability mode or stand-alone mode.
If the node is a member of a high-availability configuration, set the value to ha. If the
node is stand-alone, set the value to non_ha. Before setting the HA mode, you must
complete the platform dependent steps to set up the system in a stand-alone or HA
configuration as shown in the documentation for your platform.
[-auto-giveback {true|false}] - Auto Giveback Enabled
This optionally specifies whether automatic giveback operations are enabled. An
automatic giveback operation is invoked when one node of a failover pair is in takeover
mode and the failed node is repaired and restarts. When the repaired node boots, the
node in takeover mode detects this and initiates a giveback operation. The default
setting is false, except for two-node clusters where the default setting is true.
[-check-partner {true|false}] - Check Partner Enabled
This optionally specifies whether the node checks its partner's readiness before initiating
a giveback operation when the storage failover giveback command is run. The
default setting is true , which reduces downtime caused by a giveback operation.
[-detection-time <integer>] - Takeover Detection Time (secs)
1101
This optionally specifies the amount of time, in seconds, that a node remains
unresponsive before its partner initiates a takeover operation. Possible values range
from 10 to 180 seconds. The default setting is 15 seconds.
[-onfailure {true|false}] - Takeover on Failure Enabled (privilege: advanced)
This optionally specifies whether the node automatically takes over for its partner node if
the partner node fails. The default setting is true.This parameter is available only at the
advanced privilege level and higher.
[-onpanic {true|false}] - Takeover on Panic Enabled
This optionally specifies whether the node automatically takes over for its partner node
if the partner node panics. The default setting is true . Changing this parameter on one
node automatically makes the same change on its partner node.
[-onshort-uptime {true|false}] - Takeover on Short Uptime Enabled (privilege:
advanced)
This optionally specifies whether the node takes over for its partner node if the partner
node fails within 60 seconds of starting up; the time period is modifiable by using the short-uptime parameter. The default setting is true . This parameter is available
only at the advanced privilege level and higher.
[-short-uptime <integer>] - Short Uptime (secs) (privilege: advanced)
This optionally specifies the time period used by the -onshort-uptime parameter.
The default setting is 60 seconds. This parameter is available only at the advanced
[-attempts <integer>] - Number of Giveback Attempts (privilege: advanced)
This optionally specifies the number of times the node attempts an automatic giveback
operation within 10 minutes; the time period is modifiable by using the -attemptstime parameter. The default setting is 3 attempts. This parameter is available only at
[-attempts-time <integer>] - Giveback Attempts Period (minutes) (privilege: advanced)
This optionally specifies the time period used by the -attempts parameter. The default
setting is 10 minutes. This parameter is available only at the advanced privilege level
and higher.
[-propagate {true|false}] - Propagate Status via Mailbox (privilege: advanced)
This optionally specifies whether storage-failover status is communicated via mailbox
disks. The default setting is true . This parameter is available only at the advanced
[-read-interval <integer>] - Node Status Read Interval (secs) (privilege: advanced)
1102
This optionally specifies, in seconds, how frequently the node reads its partner node's
status from the mailbox disks. The default setting is 5 seconds. This parameter is
available only at the advanced privilege level and higher.
[-write-interval <integer>] - Node Status Write Interval (secs) (privilege: advanced)
This optionally specifies, in seconds, how frequently the node writes its status to the
mailbox disks. The default setting is 5 seconds. This parameter is available only at the
[-onreboot {true|false}] - Takeover on Reboot Enabled
This optionally specifies whether the node automatically takes over for its partner if the
partner reboots. The default setting is true . Takeover can occur if the partner exceeds
the expected time to reboot even when this option is set to false. The expected time to
reboot is different for different platforms. The minimum expected time to reboot is 180
seconds. The -inhibit-takeover option of the system node reboot command
overrides this option: if a node is rebooted with -inhibit-takeover set to true then
takeover does not occur, even if the takeover on reboot option is true. If a node
does takeover due to the partner rebooting, then it will automatically giveback after the
reboot, even if the -auto-giveback option is set to false . This is non-persistent
behavior: if the node does takeover due to partner reboot and then itself reboots (prior to
giveback) then it will not automatically giveback if the -auto-giveback option is set to
false .
[-delay-seconds <integer>] - Delay Before Auto Giveback (secs)
This optionally specifies the minimum time that a node will stay in takeover state prior to
performing an automatic giveback. If the taken over node recovers quickly (for example,
if the takeover was due to a reboot), by delaying the giveback for a few minutes the
outage during the takeover and giveback can be reduced to two short outages instead
of one longer one. The allowed range is 0 to 600, inclusive. The default setting is 300
seconds. This option affects all types of auto-giveback. This parameter is available only
at the advanced privilege level and higher.
Note:
This delay does not affect manual giveback.
[-hwassist {true|false}] - Hardware Assist Enabled
This optionally specifies whether the hardware assist feature is enabled. If set to true
this feature helps in fast takeover detection times in certain cases.
[-hwassist-partner-ip <IP Address>] - Partner's Hwassist IP
1103
This optionally specifies the Ip address on which the partner node receives hardware
assist alerts. For the hardware assist feature to be active,the value of this option should
be equal to partner's node managemant Ip address.
[-hwassist-partner-port <integer>] - Partner's Hwassist Port
This optionally specifies the port number on which partner node listens to hardware
assist alerts.It is recommended to have this value to be between 4000-4500. The default
value is 4444.
[-hwassist-health-check-interval <integer>] - Hwassist Health Check Interval (secs)
This optionally specifies,in seconds, how frequently the hardware assist hardware on a
node sends a heartbeart to it's partner.The default value is 180.
[-hwassist-retry-count <integer>] - Hwassist Retry Count
This optionally specifies the number of times we repeat sending an hardware assist
alert. The default value is 2.
[-auto-giveback-after-panic {true|false}] - Auto Giveback After Takeover On Panic
This optionally specifies whether a node should attempt automatic giveback operations
if takeover was because of a disruption in the partner's operation. An automatic
giveback operation is invoked when one node of a failover pair is in takeover mode
and the failed node is repaired and restarts. When the repaired node boots, the node in
takeover mode detects this and initiates a giveback operation automatically. The default
setting is true.
[-bypass-takeover-optimization {true|false}] - Bypass Takeover Optimization Enabled
This optionally specifies whether operator-initiated planned takeovers will be optimized.
If the option is set to true, the takeover optimization will be bypassed. If the option is
set to false, the operator-initiated planned takeover will be optimized. If the planned
takeover is optimized, then all SFO aggregates will be relocated serially to the node that
is taking over, prior to takeover. This reduces client outage. The default value for this
option is false.
[-aggregate-migration-timeout <integer>] - Aggregate Migration Timeout (secs)
This optionally specifies the amount of time, in seconds, the source node has to wait for
the destination node to complete the aggregate migration before declaring the migration
as failed. The default setting is 120 seconds.
[-auto-giveback-override-vetoes {true|false}] - Auto-giveback Override Vetoes Enabled
This optionally specifies whether long-running operations (for instance, NDMP dump/
restoration, volume verification, etc.) are terminated and partner veto votes are
overriden when an automatic giveback operation is initiated. When this option is set to
1104
false, the automatic giveback operation is deferred until the long-running operations
have completed and will also take into consideration partner veto votes. The default
setting is false .
[-auto-giveback-cifs-terminate-minutes <integer>] - Auto Giveback Delay Before
Terminating CIFS (minutes)
This option can be used to specify the number of minutes to delay an automatic
giveback before terminating CIFS clients that have open files. During the delay, the
system periodically sends notices to the affected workstations. If 0 (zero) minutes are
specified, then CIFS clients will be terminated immediately.
Examples
The following example enables the storage-failover service on a node named node0:
node::> storage failover modify -node node0 -enabled true
The following examples enable storage-failover takeover on a short uptime of 30

seconds on a node named node0:
node::*> storage failover modify -node node0 -onshort-uptime true -short-uptime
30
See Also
storage failover giveback system node reboot
1105
storage failover show-giveback

Display giveback status
level.
Description
The storage failover show-giveback command displays information about the
giveback status of high-availability (HA) partner aggregates. The command displays the
following information when no parameters are specified:
Node name
Partner aggregate name
Giveback Status
You can specify additional parameters to display only the information that matches
those parameters. For example, to display information only about a particular aggregate,
run the command with the -aggregate aggregate_name parameter.
Parameters
specify.
| [-instance ] }
about all fields.
If this parameter is used, the command displays information about the giveback status
of the aggregates belonging to the HA partner of the specified node.
of the specified aggregate.
[-giveback-status <text>, ...] - Aggregates Giveback State
1106
If this parameter is used, the command displays information about the aggregates with
the specified giveback status.
[-destination <text>] - Destination for Giveback
of the aggregates whose destination after the giveback is the specified node.
Examples
The following example displays information about giveback status on all nodes:
node::> storage failover show-giveback
Partner
Node
Aggregate
Giveback Status
-------------- ----------------- ------------------------------------------node0

-
No aggregates to give back
node1
node2
node3
1107
storage failover show-takeover

Display takeover status
level.
Description
The storage failover show-takeover command displays information about the
takeover status of nodes in a cluster. The command also displays the takeover status
of aggregates being taken over. During each phase of takeover, the takeover node and
the node being taken over display their takeover status and the status of the aggregates
being taken over. The command displays the following information when no parameters
are specified:
Node name
Node takeover status - This contains a descriptive information about the phase of
takeover.
Aggregate
Aggregate takeover status - This contains the following information:
Takeover status of the aggregate, such as "Done", "Failed", "In progress"
and "Not attempted yet".
Reason for an aggregate takeover failure.
Corrective action, in case of an aggregate takeover failure.
those parameters. For example, to display information only about a particular node, run
the command with the -node node_name parameter.
Parameters
If this parameter is specified, the command displays the specified fields for all nodes, in
column style output.
| [-instance ] }
1108
If this parameter is specified, the command displays the same detailed information as
for the -node parameter, but for all nodes.
If this parameter is specified, the command displays information about the takeover
status of the specified node, and the takeover status of the aggregates being taken over.
[-node-takeover-status <text>] - Node's Takeover Status
status of the nodes with the specified node-takeover-status. The command also displays
the takeover status of the aggregates belonging to the node being taken over.
[-aggregate <text>] - Aggregate Being Taken Over
status of the specified aggregate, and the takeover status of the nodes containing the
specified aggregate.
[-aggregate-takeover-status <text>] - Aggregate's Takeover Status
status of the aggregates with the specified aggregate takeover status, and the takeover
status of the nodes containing those aggregates.
Examples
The following example shows the takeover status of two nodes, nodeA and nodeB, in an
High Availability (HA) pair, when both are in normal mode; neither node has taken over
its HA partner. In this case, there is no takeover status for the aggregates.
cluster1::> storage failover show-takeover
Node
Node Status
Aggregate
Takeover Status
---------- --------------------- -------------- ------------------------------nodeA
Takeover not
attempted.
-
nodeB
Takeover not
attempted.
-
The following example shows the takeover status of two nodes, nodeA and nodeB,
in an HA pair, when nodeA is in the SFO phase of an optimized takeover of nodeB.
1109
In this case, nodeA does not have information about the takeover status of nodeB's
aggregates.
Node
Node Status
Aggregate
Takeover Status
---------- --------------------- -------------- ------------------------------nodeA
Optimized takeover
of partner in
progress. Partner,
("nodeB"), is
relocating its SFO
aggregates. Run the
command "storage
failover
show-takeover -node
nodeB" to display the
relocation status of
the partner.
nodeB
aggr1
In progress, Module:
Being taken over.
backup.
aggr2
Not attempted yet
CFO aggregates Not attempted yet.
HA pair, when nodeA has completed the SFO phase of an optimized takeover of nodeB
(but has not completed the CFO phase of the optimized takeover). In this case, nodeA
has information about the takeover status of nodeB's aggregates.
Node
Node Status
Aggregate
Takeover Status
---------- --------------------- -------------- ------------------------------nodeA
Partner has
relocated its
aggregates. Takeover
in progress.
aggr1
Done
aggr2
Done
CFO aggregates In progress.
1110
nodeB
Relocated aggregates
to partner. Waiting
for partner to
takeover.
aggr1
Done
aggr2
Done
CFO aggregates Not attempted

yet.
The following example shows the takeover status of two nodes, nodeA and nodeB,
in an HA pair, when nodeA has completed the SFO and CFO phases of an optimized
takeover of nodeB. In this case, nodeA has information about the takeover status of
nodeB's aggregates. Since nodeB is not operational, an Remote Procedure Call(RPC)
error is indicated in the command output.
Node
Node Status
Aggregate
Takeover Status
---------- --------------------- -------------- ------------------------------nodeA
Partner has
relocated its
aggregates. In
takeover.
aggr1
Done
aggr2
Done
CFO aggregates Done.

Warning: Unable to list entries on node nodeB. RPC: Port mapper failure - RPC:
Timed out
HA pair, when nodeA has aborted the SFO phase of an optimized takeover of nodeB.
In this case, nodeA does not have information about the takeover status of nodeB's
aggregates.
Node
Node Status
Aggregate
Takeover Status
---------- --------------------- -------------- ------------------------------nodeA
Optimized takeover
of partner aborted.
Run the command
"storage failover
1111
show-takeover -node
nodeB" to display the
relocation status of
the partner.
nodeB
aggr1
Failed:
Optimized takeover
by partner aborted.
Destination node did

not
online the aggregate on
time. To
takeover the
remaining
aggregates, run the
"storage
failover takeover
-ofnode
nodeB
-bypassoptimization true"
command.
To giveback the
relocated
aggregates, run the
"storage
failover giveback
-ofnode
nodeB" command.
aggr2
Not attempted
yet
CFO aggregates Not attempted
yet.
1112
storage failover show

Display storage failover status
level.
Description
The storage failover show command displays information about storage-failover
configurations. By default, the command displays the following information:
Node name.
Partner node name.
Whether storage failover is possible.
The current state of storage failover. If the takeover is disabled the appropriate
reason would be displayed.
To display detailed information about storage failover on a specific node, run the
command with the -node parameter. The detailed view adds the following information:
Node NVRAM ID.
Partner NVRAM ID.
Whether storage failover is enabled.
Whether the storage-failover interconnect is available.
Status of individual storage-failover interconnect links.
Type and vendor of the storage-failover interconnect.
Partner State
Status codes from the takeover-by-partner process. Possible values include:
NVRAM_DOWN
OPERATOR_DISABLE_NVRAM
PARTNER_RESET
FM_TAKEOVER
NVRAM_MISMATCH
1113
OPERATOR_DENY
CLUSTER_DISABLE
VERSION
SHELF_HOT
REVERT_IN_PROGRESS
HALT_NOTKOVER
TAKEOVER_ON_PANIC
Reasons why takeover is not possible, if applicable. Possible values include:
NOT_INIT
DISABLED
DEGRADED
MBX_UNKNOWN
FM_VERSION
PARTNER_DISABLED
OPERATOR_DENY
NVRAM_MISMATCH
VERSION
IC_ERROR
BOOTING
SHELF_HOT
PARTNER_REVERT_IN_PROGRESS
LOCAL_REVERT_IN_PROGRESS
PARTNER_TAKEOVER
LOCAL_TAKEOVER
HALT_NOTKOVER
LOG_UNSYNC
UNKNOWN
WAITING_FOR_PARTNER
1114
LOW_MEMORY
HALTING
MBX_UNCERTAIN
NO_AUTO_TKOVER
Time until takeover, in seconds.
Time until auto giveback, in seconds.
Delay for auto giveback, in seconds.
List of local mailbox disks.
List of partner mailbox disks.
Whether operator-initiated planned takeover will be optimized for performance by
relocating SFO (non-root) aggregates serially to the partner prior to takeover.
You can specify additional parameters to select the displayed information. For example,
to display information only about storage-failover configurations whose interconnect is
down, run the command with -interconnect-up false.
Parameters
specify.
| [-options ]
Node name
Whether automatic giveback operations are enabled
Whether long-running operations are terminated when an automatic giveback
operation is initiated
Whether the node checks its partner's readiness before initiating a giveback
operation
The time, in seconds, that the node remains unresponsive before its partner
initiates a takeover operation
Whether the node automatically takes over for its partner if the partner fails
1115
Whether the node automatically takes over for its partner if the partner panics
Whether the node automatically takes over for its partner if the partner reboots
whether Hardware Assisted Takeover is enabled
Ip address on which the partner node listens to the Hardware Assist alerts
Port number on which the partner node listens to the Hardware Assist alerts
Whether operator-initiated planned takeover will be optimized for performance by
relocating SFO (non-root) aggregates serially to the partner prior to takeover
If this parameter is specified when the privilege level is set to advanced or higher,
the command displays the information in the previous list and the following additional
information:
Whether the node takes over for its partner if its partner fails after a period of time,
which is listed in the following field
The number of seconds before the node takes over for its partner
The number of times the node attempts an automatic giveback operation within a
period of time
The number of minutes in which the automatic giveback attempts can occur
Whether storage-failover status is communicated via mailbox disks
The interval at which the node reads its partner node's status from the mailbox
disks
The interval at which the node writes its status to the mailbox disks
The interval at which Hardware assist h/w sends a heartbeat
The number of times the Hardware assist alert is sent
| [-takeover-status ]
Node name
Partner name
Takeover enabled
Takeover possible
Interconnect up
State
1116
Node NVRAM ID
Partner NVRAM ID
Reason Takeover Not Possible By Partner
Reason Takeover Not Possible
Time Until Takeover
| [-advanced ] (privilege: advanced)
Node name
Whether kill messages are issued during a takeover operation
Whether the node controls its partner's storage aggregates
The time when firmware notification was received
The time when booting notification was received
The time at which the last takeover or giveback operation occurred, in
microseconds
The number of times the failover log was unsynchronized
| [-iotime ] (privilege: advanced)
Node name
Primary normal I/O time
Primary transition I/O time
Backup normal I/O time
Backup transition I/O time
| [-mailbox-status ] (privilege: advanced)
Node name
Primary mailbox status
Backup mailbox status
1117
| [-more-options ] (privilege: advanced)

Node name
Whether takeover on short uptime is enabled
Short uptime, in seconds
Number of giveback attempts
Interval of giveback attempts, in minutes
Whether the primary mailbox is online
Mailbox status read interval, in seconds
Mailbox status write interval, in seconds
| [-progress ] (privilege: advanced)
Node name
Maximum resource-table index number
Current resource-table index number
Current resource-table entry
| [-timeout ] (privilege: advanced)
Node name
Fast timeout
Slow timeout
Mailbox timeout
Connection timeout
Operator timeout
Firmware timeout
Dump-core timeout
Booting timeout
1118
Reboot timeout
| [-transit ] (privilege: advanced)
Node name
Transit Timer Enabled
Transit Timeout
| [-instance ] }
about all fields.
Selects the nodes whose name matches this parameter value.
[-partner-name <text>] - Partner Name
Selects the nodes that have the specified partner-name setting.
[-nvramid <integer>] - Node NVRAM ID
Selects the nodes that have the specified NVRAM ID setting.
[-partner-nvramid <integer>] - Partner NVRAM ID
Selects the nodes that have the specified partner NVRAM ID setting.
[-enabled {true|false}] - Takeover Enabled
Selects the nodes that have the specified takeover-enabled setting.
[-mode {ha|non_ha}] - HA Mode
Selects the nodes that have the specified HA-mode setting. If the value is set to ha then
the node is a member of a storage-failover configuration. If it is set to non-ha then it is in
a stand alone configuration.
[-possible {true|false}] - Takeover Possible
Selects the nodes that have the specified failover-possible setting.
[-reason <text>, ...] - Reason Takeover not Possible
Selects the nodes that have the specified reason-not-possible setting. Possible values
include:
NOT_INIT
1119
DISABLED
DEGRADED
MBX_UNKNOWN
FM_VERSION
PARTNER_DISABLED
OPERATOR_DENY
NVRAM_MISMATCH
VERSION
IC_ERROR
BOOTING
SHELF_HOT
PARTNER_REVERT_IN_PROGRESS
LOCAL_REVERT_IN_PROGRESS
PARTNER_TAKEOVER
LOCAL_TAKEOVER
HALT_NOTKOVER
LOG_UNSYNC
UNKNOWN
WAITING_FOR_PARTNER
LOW_MEMORY
HALTING
MBX_UNCERTAIN
NO_AUTO_TKOVER
[-interconnect-up {true|false}] - Interconnect Up
Selects the nodes that have the specified interconnect-up setting.
[-interconnect-links <text>] - Interconnect Links
Selects the nodes that have the specified interconnect-links setting.
[-interconnect-type <text>] - Interconnect Type
1120
Selects the nodes that have the specified interconnect-type setting.

[-state-description <text>] - State Description
Selects the nodes that have the specified state-description setting.
[-partner-state <text>] - Partner State
Selects the nodes that have the specified partner-state setting. Possible values include:
OPERATOR COMPLETED
DEBUGGUER COMPLETED
PROGRESS COUNTER
I/O ERROR
BAD CHECKSUM
RESERVED
UNKNOWN
INITIALIZING
IN POWER-ON SELF TEST
BOOTING
BOOT FAILED
WAITING
KERNEL LOADED
UP
IN DEBUGGER
WAITING FOR OPERATOR INPUT
DUMPING CORE
HALTED
REBOOTING
WAITING FOR GIVEBACK (DISK RESERVATIONS)
WAITING FOR GIVEBACK (HA MAILBOXES)
DUMPING SPARECORE
MULTI-DISK PANIC
1121
IN TAKEOVER
[-time-until-takeover <integer>] - Time Until Takeover
Selects the nodes that have the specified time-until-takeover setting.
[-partner-reason <text>, ...] - Reason Takeover not Possible by Partner
Selects the nodes that have the specified partner-reason text setting.
[-killpackets {true|false}] - Issue Kill Packets (privilege: advanced)
Selects the nodes that have the specified kill packets setting.
[-partner-aggregates {true|false}] - Control Partner Aggregates (privilege: advanced)
Selects the nodes that have the specified partner aggregates setting.
[-current-index <integer>] - Current Progress Index (privilege: advanced)
Selects the nodes that have the specified current-progress index setting.
[-current-entry <text>] - Current Progress Entry (privilege: advanced)
Selects the nodes that have the specified current-progress entry setting.
[-maximum-index <integer>] - Maximum Progress Index (privilege: advanced)
Selects the nodes that have the specified maximum-progress index setting.
[-pmbox-status <text>, ...] - Primary Mailbox Status (privilege: advanced)
Selects the nodes that have the specified primary mailbox status setting. Possible
values include:
MBX_STATUS_NODISKS
MBX_STATUS_UNCERTAIN
MBX_STATUS_STALE
MBX_STATUS_CONFLICTED
MBX_STATUS_OLD_VERSION
MBX_STATUS_NOT_FOUND
MBX_STATUS_WRONG_STATE
MBX_STATUS_BACKUP
[-bmbox-status <text>, ...] - Backup Mailbox Status (privilege: advanced)
1122
Selects the nodes that have the specified backup-mailbox status setting. See the
description of the -pmbox-status parameter for a list of possible values.
[-major-seq-num-local <integer>] - Local Major Sequence Number (privilege:
advanced)
Selects the nodes that have the specified mailbox heartbeat major sequence number on
the local node.
[-minor-seq-num-local <integer>] - Local Minor Sequence Number (privilege:
advanced)
Selects the nodes that have the specified mailbox heartbeat minor sequence number on
the local node.
[-major-seq-num-partner <integer>] - Partner Major Sequence Number (privilege:
advanced)
Selects the nodes that have the specified mailbox heartbeat major sequence number on
the partner node.
[-minor-seq-num-partner <integer>] - Partner Minor Sequence Number (privilege:
advanced)
Selects the nodes that have the specified mailbox heartbeat minor sequence number on
the partner node.
[-local-mbx-node-status <Mailbox Status>] - Local Mailbox Node Status (privilege:
advanced)
Selects the nodes that have the specified local mailbox node status. Possible values
include:
MBX_UNKNOWN - Local node is up, mailbox uninitialized
MBX_TAKEOVER_DISABLED - Local node is up but takeover is disallowed
MBX_TAKEOVER_ENABLED - Local node is up and takeover is allowed
MBX_TAKEOVER_ACTIVE - Partner node has taken over
MBX_GIVEBACK_DONE - Giveback completed, but local node has not yet
restarted
[-mbx-abs-time-local <integer>] - Local Mailbox Absolute Time (privilege: advanced)
Selects the nodes that have the specified local mailbox channel absolute time. This time
is measured in msecs since 1/1/1970 (epoch).
[-mbx-sk-time-local <integer>] - Local Mailbox Kernel Time (privilege: advanced)
1123
Selects the nodes that have the specified local mailbox channel Kernel Time.
[-mbx-sk-cycles-local <integer>] - Local Mailbox CPU Cycles (privilege: advanced)
Selects the nodes that have the specified local mailbox channel CPU Cycle count.
[-ic-abs-time-local <integer>] - Local IC Absolute Time (privilege: advanced)
Selects the nodes that have the specified local Interconnect channel absolute time. This
time is measured in msecs since 1/1/1970 (epoch).
[-ic-sk-time-local <integer>] - Local IC Kernel Time (privilege: advanced)
Selects the nodes that have the specified local Interconnect channel Kernel Time.
[-ic-sk-cycles-local <integer>] - Local IC CPU Cycles (privilege: advanced)
Selects the nodes that have the specified local Interconnect channel CPU Cycle count.
[-partner-mbx-node-status <Mailbox Status>] - Partner Mailbox Node Status (privilege:
advanced)
Selects the nodes that have the specified partner mailbox node status. Possible values
include:
MBX_UNKNOWN
MBX_TAKEOVER_DISABLED
MBX_TAKEOVER_ENABLED
MBX_TAKEOVER_ACTIVE
MBX_GIVEBACK_DONE
[-mbx-abs-time-partner <integer>] - Partner Mailbox Absolute Time (privilege:
advanced)
Selects the nodes that have the specified partner mailbox channel absolute time. This
time is measured in msecs since 1/1/1970 (epoch).
[-mbx-sk-time-partner <integer>] - Partner Mailbox Kernel Time (privilege: advanced)
Selects the nodes that have the specified partner mailbox channel Kernel Time.
[-mbx-sk-cycles-partner <integer>] - Partner Mailbox CPU Cycles (privilege:
advanced)
Selects the nodes that have the specified partner mailbox channel CPU Cycle count.
[-mbx-major-seq-num-partner <integer>] - Partner Mailbox Major Sequence Number
1124
Selects the nodes that have the specified partner mailbox channel major sequence
number.
[-mbx-minor-seq-num-partner <integer>] - Partner Mailbox Minor Sequence Number
Selects the nodes that have the specified partner mailbox channel minor sequence
number.
[-ic-abs-time-partner <integer>] - Partner IC Absolute Time (privilege: advanced)
Selects the nodes that have the specified partner Interconnect channel absolute time.
This time is measured in msecs since 1/1/1970 (epoch).
[-ic-sk-time-partner <integer>] - Partner IC Kernel Time (privilege: advanced)
Selects the nodes that have the specified partner Interconnect channel Kernel Time.
[-ic-sk-cycles-partner <integer>] - Partner IC CPU Cycles (privilege: advanced)
Selects the nodes that have the specified partner Interconnect channel CPU Cycle
count.
[-ic-major-seq-num-partner <integer>] - Partner IC Major Sequence Number (privilege:
advanced)
Selects the nodes that have the specified partner Interconnect channel major sequence
number.
[-ic-minor-seq-num-partner <integer>] - Partner IC Minor Sequence Number (privilege:
advanced)
Selects the nodes that have the specified partner Interconnect channel minor sequence
number.
[-local-takeover-info <text>] - Local Takeover Info (privilege: advanced)
Selects the nodes that have the specified local node takeover information. This includes
the type of negotiated failover request, or if takeover is not possible, the reason why
takeover is disabled. Possible values include:
NOTKOVER_NVRAM_DOWN - NVRAM mirror is down
NOTKOVER_OPERATOR_DISABLE_NVRAM - Operator disabled
NOTKOVER_PARTNER_RESET - A link reset is in progress
NOTKOVER_FM_TAKEOVER - The failover monitor has declared takeover
NOTKOVER_NVRAM_MISMATCH - NVRAM sizes mismatch
NOTKOVER_OPERATOR_DENY - Operator denies takeover
1125
NOTKOVER_CLUSTER_DISABLE - Cluster is disabled

NOTKOVER_VERSION - Version mismatch
NOTKOVER_SHELF_HOT - Disk shelf is too hot
NOTKOVER_REVERT_IN_PROGRESS - Revert is in progress
NOTKOVER_HALT_NOTKOVER - Node halted in no-takeover mode
TKOVER_ON_REBOOT - Enable takeover on reboot
TKOVER_ON_PANIC - Enabled takeover on panic
TKOVER_ON_STUTTER_DISABLED - Disable takeover on short uptime
NFO_DISK_SHELF_ENABLED - Negotiated failover for disk shelf module is
enabled
NFO_NWK_IF_ENABLED - Negotiated failover for network module is enabled
NFO_ISCSI_ENABLED - Negotiated failover for network interfaces module is
enabled
NFO_FCP_TARGET_ENABLED - Negotiated failover for fcp target module is
enabled
[-partner-takeover-info <text>] - Partner Takeover Info (privilege: advanced)
Selects the nodes that have the specified partner node takeover information. This
includes the type of negotiated failover request, or if takeover is not possible, the reason
why takeover is disabled. Possible values include:
NOTKOVER_NVRAM_DOWN - NVRAM mirror is down
NOTKOVER_OPERATOR_DISABLE_NVRAM - Operator disabled
NOTKOVER_PARTNER_RESET - A link reset is in progress
NOTKOVER_FM_TAKEOVER - The failover monitor has declared takeover
NOTKOVER_NVRAM_MISMATCH - NVRAM sizes mismatch
NOTKOVER_OPERATOR_DENY - Operator denies takeover
NOTKOVER_CLUSTER_DISABLE - Cluster is disabled
NOTKOVER_VERSION - Version mismatch
NOTKOVER_SHELF_HOT - Disk shelf is too hot
NOTKOVER_REVERT_IN_PROGRESS - Revert is in progress
NOTKOVER_HALT_NOTKOVER - Node halted in no-takeover mode
1126
TKOVER_ON_REBOOT - Takeover on reboot is enabled

TKOVER_ON_PANIC - Takeover on panic is enabled
TKOVER_ON_STUTTER_DISABLED - Disable takeover on short uptime
NFO_DISK_SHELF_ENABLED - Negotiated failover for disk shelf module is
enabled
NFO_NWK_IF_ENABLED - Negotiated failover for network module is enabled
NFO_ISCSI_ENABLED - Negotiated failover for network interfaces module is
enabled
NFO_FCP_TARGET_ENABLED - Negotiated failover for fcp target module is
enabled
[-local-headswap-state <Headswap State>] - Local Head Swap State (privilege:
advanced)
Selects the nodes that have the specified local node headswap state. Possible values
are:
HEADSWAP_NONE - head swap not in progress
HEADSWAP_START - head swap started
HEADSWAP_CFO_START - CFO phase of head swap started
HEADSWAP_CFO_END - CFO phase of head swap completed
HEADSWAP_SFO_START - SFO phase of head swap started
[-partner-headswap-state <Headswap State>] - Partner Head Swap State (privilege:
advanced)
Selects the nodes that have the specified partner node headswap state. Possible values
are:
HEADSWAP_NONE - head swap not in progress
HEADSWAP_START - head swap started
HEADSWAP_CFO_START - CFO phase of head swap started
HEADSWAP_CFO_END - CFO phase of head swap completed
HEADSWAP_SFO_START - SFO phase of head swap started
[-fast-timeout <integer>] - Fast Timeout (privilege: advanced)
Selects the nodes that have the specified fast-timeout configuration setting.
1127
[-slow-timeout <integer>] - Slow Timeout (privilege: advanced)

Selects the nodes that have the specified slow-timeout setting.
[-mailbox-timeout <integer>] - Mailbox Timeout (privilege: advanced)
Selects the nodes that have the specified mailbox-timeout setting.
[-connect-timeout <integer>] - Connect Timeout (privilege: advanced)
Selects the nodes that have the specified connect-timeout setting.
[-operator-timeout <integer>] - Operator Timeout (privilege: advanced)
Selects the nodes that have the specified operator-timeout setting.
[-firmware-timeout <integer>] - Firmware Timeout (privilege: advanced)
Selects the nodes that have the specified firmware-timeout setting.
[-dumpcore-timeout <integer>] - Dumpcore Timeout (privilege: advanced)
Selects the nodes that have the specified dump-core timeout setting.
[-booting-timeout <integer>] - Booting Timeout (privilege: advanced)
Selects the nodes that have the specified booting-timeout setting.
[-transit-timer {true|false}] - Transit Timer Enabled (privilege: advanced)
Selects the nodes that have the specified transit-timer setting.
[-transit-timeout <integer>] - Transit Timeout (privilege: advanced)
Selects the nodes that have the specified transit timeout.
[-firmware-received <integer>] - Firmware Received (privilege: advanced)
Selects the nodes that have the specified firmware-reception time.
[-firmware-received-cycles <integer>] - Firmware Received in CPU Cycles (privilege:
advanced)
Selects the nodes that have the specified firmware-reception time in CPU Cycles.
[-booting-received <integer>] - Booting Received (privilege: advanced)
Selects the nodes that have the specified booting-reception time.
[-transit-time <integer>] - Transit Event Time (privilege: advanced)
Selects the nodes whose last failover event occurred at the specified time.
[-pnormal <integer>] - Primary Normal IO Time (privilege: advanced)
Selects the nodes that have the specified normal primary-mailbox I/O time.
1128
[-ptransition <integer>] - Primary Transition IO Time (privilege: advanced)

Selects the nodes that have the specified transitional primary-mailbox I/O time.
[-bnormal <integer>] - Backup Normal IO Time (privilege: advanced)
Selects the nodes that have the specified normal backup-mailbox I/O time.
[-btransition <integer>] - Backup Transition IO Time (privilege: advanced)
Selects the nodes that have the specified transitional backup-mailbox I/O time.
[-logs-unsynced <integer>] - Logs Unsynced Count (privilege: advanced)
Selects the nodes that have the specified count of unsynchronized logs.
Selects the nodes that have the specified auto-giveback setting.
Selects the nodes that have the specified partner-checking setting.
Selects the nodes that have the specified detection-time setting.
[-onfailure {true|false}] - Takeover on Failure Enabled (privilege: advanced)
Selects the nodes that have the specified takeover-on-failure setting.
Selects the nodes that have the specified takeover-on-panic setting.
[-onshort-uptime {true|false}] - Takeover on Short Uptime Enabled (privilege:
advanced)
Selects the storage-failover configurations that match this parameter value.
[-short-uptime <integer>] - Short Uptime (secs) (privilege: advanced)
Selects the nodes that have the specified short-uptime value.
[-attempts <integer>] - Number of Giveback Attempts (privilege: advanced)
Selects the nodes that have the specified number of giveback attempts.
[-attempts-time <integer>] - Giveback Attempts Period (minutes) (privilege: advanced)
Selects the nodes that have the specified time setting for giveback attempts.
[-propagate {true|false}] - Propagate Status via Mailbox (privilege: advanced)
Selects the nodes that have the specified propagate-status-via-mailbox setting.
1129
[-read-interval <integer>] - Node Status Read Interval (secs) (privilege: advanced)

Selects the nodes that have the specified read interval.
[-write-interval <integer>] - Node Status Write Interval (secs) (privilege: advanced)
Selects the nodes that have the specified write interval.
Selects the nodes that have the specified takeover-on-reboot setting.
Selects the nodes that have the specified delay (in seconds) for the auto giveback.
[-hwassist {true|false}] - Hardware Assist Enabled
Selects the nodes that have the specified hwassist setting.
[-hwassist-partner-ip <IP Address>] - Partner's Hwassist IP
Selects the nodes that have the specified hwassist-partner-ip setting.
Selects the nodes that have the specified hwassist-partner-port setting.
Selects the nodes that have the specified hwassist health check interval, in seconds.
Selects the nodes that have the specified hwassist retry count, in seconds.
[-hwassist-status <text>] - Hwassist Status
Selects the nodes that have the specified hwassist-status setting.
[-time-until-autogiveback <integer>] - Time Until Auto Giveback (secs)
Selects the nodes that have the specified time(in seconds) until auto giveback.
[-local-mailbox-disks <text>] - Local Mailbox Disks
Selects the nodes that have the specified mailbox disks on the local node.
[-partner-mailbox-disks <text>] - Partner Mailbox Disks
Selects the nodes that have the specified mailbox disks on the partner node.
[-local-firmware-state <text>] - Local Firmware State (privilege: advanced)
Selects the nodes that have the specified firmware state on the local node.
1130
[-local-firmware-progress <integer>] - Local Firmware Progress Counter (privilege:

advanced)
Selects the nodes that have the specified firmware progress counter for the local node.
[-partner-firmware-state <text>] - Partner Firmware State (privilege: advanced)
Selects the nodes that have the specified firmware state of the partner node.
[-partner-firmware-progress <integer>] - Partner Firmware Progress Counter
Selects the nodes that have the specified firmware progress counter for the partner
node.
[-local-missing-disks <text>] - Missing Disks on Local Node
Selects the nodes that have the specified missing disks on the local node.
[-partner-missing-disks <text>] - Missing Disks on Partner Node
Selects the nodes that have the specified missing disks on the partner node.
[-reboot-timeout <integer>] - Reboot Timeout (privilege: advanced)
Selects the nodes that have the specified reboot timeout.
[-time-since-takeover <text>] - Time Since Takeover
Selects the nodes that have been in takeover mode for the specified amount of time.
[-auto-giveback-after-panic {true|false}] - Auto Giveback After Takeover On Panic
Selects the nodes that have the specified auto-giveback-after-panic setting. If true then
an automatic giveback operation is invoked when the failover node of an HA pair is
repaired and rebooted. The takeover node of the HA pair detects this and initiates a
giveback operation automatically.
[-is-giveback-requested {true|false}] - Giveback Requested (privilege: advanced)
Selects the nodes that have the specified is-giveback-requested setting. If true, a
deferred giveback request has been made by the local node.
[-auto-giveback-last-veto-check <integer>] - Auto Giveback Last Veto Check
Selects the nodes that have the specified auto-giveback-last-veto-check time. This
setting indicates the time, in milliseconds, when the local node made the most recent
giveback veto check.
[-is-auto-giveback-attempts-exceeded {true|false}] - Auto Giveback Attempts
Exceeded (privilege: advanced)
1131
Selects the nodes that have the specified is-auto-giveback-attempts-exceeded setting.

If true, the local node has exceeded the maximum number of allowed auto giveback
attempts.
[-was-auto-giveback-done {true|false}] - Was Auto Giveback Done (privilege:
advanced)
Selects the nodes that have the specified was-auto-giveback-done setting. If true, the
last giveback was automatic (as opposed to a manual giveback).
[-is-cifs-auto-giveback-stopping {true|false}] - Is CIFS Auto Giveback Stopping
Selects the nodes that have the specified is-cifs-auto-giveback-stopping setting. If true,
the local node has initiated CIFS termination as part of an automatic giveback.
Selects the nodes that have the specified bypass-takeover-optimization setting. If the
value is set to true then optimized operator-initiated planned takeover is bypassed.
Operator initiated planned takeover is optimized when SFO aggregates are relocated
serially to the partner prior to takeover. This reduces client outage. If the value is set to
false then optimized operator-initiated planned takeover is enabled on this node.
[-aggregate-migration-timeout <integer>] - Aggregate Migration Timeout (secs)
Selects the nodes that have the specified aggregate migration timeout.
[-auto-giveback-override-vetoes {true|false}] - Auto-giveback Override Vetoes Enabled
Selects the nodes that have the specified auto-giveback-override-vetoes setting.
[-is-mirror-enabled {true|false}] - Is NVRAM Mirroring Enabled (privilege: advanced)
Selects the nodes that have the specified is-mirror-enabled setting. If true, then NVRAM
mirroring is enabled.
[-is-mirror-consistency-required {true|false}] - Is Mirror Consistency Required
Selects the nodes that have the specified is-mirror-consistency-required setting. If true,
then NVRAM mirror consistency is required.
[-is-memory-insufficient {true|false}] - Is Memory Insufficient To Takeover (privilege:
advanced)
Selects the nodes that have the specified is-memory-insufficient setting. If true, the local
node does not have enough memory to perform a takeover.
[-memio-state <memio status>] - Current State of Memio Link (privilege: advanced)
1132
Selects the nodes that have the specified memio layer link current state. Possible values
are:
UNINIT - Uninitialized
CLOSED - Closed
HB_LISTEN - Listening for connect
SYN_SENT - Sent generation information
ESTABLISHED - Connection established
[-is-degraded {true|false}] - Are Partner Mailbox Disks Not Known (privilege: advanced)
Selects the nodes that have the specified is-degraded setting. If true, takeovers are
deferred because partner mailbox disks are not known.
[-reserve-policy <reserve policy>] - FM Reservation Policy (privilege: advanced)
Selects the nodes that have the specified disk reservation policy. Possible values are:
RESERVE_NO_DISKS - no disk reservations made during takeover, nor are disk
reservations released during giveback
RESERVE_LOCK_DISKS_ONLY - only mailbox disks are released during
takeover and released during giveback
RESERVE_ONLY_AT_TAKEOVER - reservations are issued only at takeover
time. All disks are reserved. All reservations are released at giveback
RESERVE_ALWAYS_AFTER_TAKEOVER - reservations are issued at at
takeover. When disks are subsequently added, they are also reserved. All disks
are released at giveback
[-reset-disks {true|false}] - Issue Disk Resets during Failover (privilege: advanced)
Selects the nodes that have the specified reset-disks setting. If true, disks are reset
during takeover/giveback.
[-total-system-uptime <integer>] - Total System Uptime (privilege: advanced)
Selects the nodes that have the specified total system uptime, in milliseconds.
[-current-time <integer>] - Current System Time (privilege: advanced)
Selects the nodes that have the specified current time on the node.
[-fm-takeover-state <FM Takeover/Giveback Transition>] - FM Takeover State
Selects the nodes that have the specified takeover state. Possible values are:
1133
FT_NONE - Not in takeover

FT_TAKEOVER_STARTED - Local node has initiated takeover
FT_TAKEOVER_COMMITTED - Takeover has been committed
FT_TAKEOVER_DONE_OK - Local node successfully completed takeover
FT_TAKEOVER_DONE_FAILED - Takeover failed
[-fm-giveback-state <FM Takeover/Giveback Transition>] - FM Giveback State
Selects the nodes that have the specified giveback state. Possible values are:
FT_NONE - Not in giveback
FT_GIVEBACK_READY - Partner node is ready for giveback
FT_GIVEBACK_STARTED - Local node has initiated giveback
FT_GIVEBACK_COMMITTED - Giveback has been committed
FT_GIVEBACK_DONE_OK - Giveback completed successfully
[-auto-giveback-cifs-terminate-minutes <integer>] - Auto Giveback Delay Before
Terminating CIFS (minutes)
If this parameter is specified, the command displays information only about the storagefailover configuration or configurations that have the specified auto giveback delay
before terminating CIFS.
[-takeover-reason <FM Takeover Reason>] - Reason why takeover triggered (privilege:
advanced)
Selects the nodes that have the specified takeover reason. Possible values are:
TAKEOVER_NONE - Not in takeover
TAKEOVER_IMMEDIATE - Operator initiated forced takeover
TAKEOVER_NDU - Takeover initiated as part of NDU
TAKEOVER_FORCED - Operator initiated forced takeover, possible data loss
TAKEOVER_EARLY - Takeover occured during the boot process
TAKEOVER_OPERATOR_EXP - Takeover occured after the operator timeout
expired
TAKEOVER_POST_FAILED - Takeover occured on POST failure
TAKEOVER_PANIC - Takeover on panic
1134
TAKEOVER_SHORTUPTIME - Takeover after rapid toggling between up and

down states
TAKEOVER_SPARECORE_EXP - Takeover on panic timeout expiration
TAKEOVER_REBOOT_EXP - Takeover on reboot timer expiration
TAKEOVER_BOOTING_EXP - Takeover on booting timer expiration
TAKEOVER_FIRMWARE_EXP - Takeover on firmware timer expiration
TAKEOVER_NFO_SHUTDOWN - Takeover on negotiated failover shutdown
TAKEOVER_NFO_TIMER - Takeover on negotiated failover timer expiration
TAKEOVER_MDP - Takeover on multi-disk panic
TAKEOVER_REBOOT - Takeover on reboot
TAKEOVER_HALT - Takeover on halt
TAKEOVER_CLAM - CLAM-triggered takeover
TAKEOVER_HWASSIST - Hardware-assisted takeover
TAKEOVER_NORMAL - Operator initiated takeover
Examples
The following example displays information about all storage-failover configurations:
cluster1::> storage failover show
Takeover
Node
Partner
Possible State
-------- -------- -------- -----------------node0
node1
true
Connected to node1
node2
node3
true
Connected to node3
node1
node0
true
Connected to node0
node3
node2
true
Connected to node2
1135
storage failover takeover

Take over the storage of a node's partner
level.
Description
The storage failover takeover command initiates a takeover of the partner
node's storage.
Parameters
{ -ofnode {<nodename>|local} - Node to Takeover
This specifies the node that is taken over. It is shut down and its partner takes over its
storage.
| -bynode {<nodename>|local} } - Node Initiating Takeover
This specifies the node that is to take over its partner's storage.
[-option <takeover option>] - Takeover Option
This optionally specifies the style of takeover operation. Possible values include the
following:
normal - Specifies a normal takeover operation; that is, the partner is given the
time to close its storage resources gracefully before the takeover operation
proceeds. This is the default value.
immediate - Specifies an immediate takeover. In an immediate takeover, the
takeover operation is initiated before the partner is given the time to close its
storage resources gracefully. The use of this option results in an immediate
takeover which does not do a clean shutdown. In case of NDU this can result in a
NDU failure.
Attention:
If this option is specified, negotiated takeover optimization is bypassed even if the
-bypass-optimization option is set to false.
Attention:
1136
If this option is specified, migration of data LIFs from the partner will be delayed
even if the -skip-lif-migration-before-takeover option is not specified.
If possible, migrate the data LIFs to another node prior to specifying this option.
allow-version-mismatch - If this value is specified, the takeover operation is
initiated even if the partner is running a version of software that is incompatible
with the version running on the node. In this case, the partner is given the time
to close its storage resources gracefully before the takeover operation proceeds.
Use this value as part of a nondisruptive upgrade procedure.
force - If this value is specified, the takeover operation is initiated even if the node
detects an error that normally prevents a takeover operation from occurring. This
value is available only at the advanced privilege level and higher.
Attention:
If this option is specified, negotiated takeover optimization is bypassed even if the
-bypass-optimization option is set to false.
Caution:
The use of this option can potentially result in data loss. If the HA interconnect is
detached or inactive, or the contents of the failover partner's NVRAM cards are
unsynchronized, takeover is normally disabled. Using the -force option enables
a node to take over its partner's storage despite the unsynchronized NVRAM,
which can contain client data that can be lost upon storage takeover.
[-bypass-optimization {true|false}] - Bypass Takeover Optimization
If this is an operator-initiated planned takeover, this parameter specifies whether the
takeover optimization is bypassed. This parameter defaults to false.
Attention:
This parameter is ignored and negotiated takeover optimization automatically bypassed
if the -immediate option, the -force option, or the -allow-disk-inventorymismatch parameter is specified as part of the same storage failover takeover
command.
[-allow-disk-inventory-mismatch {true|false}] - Disk inventory
If this parameter is specified, the takeover operation is initiated even if the local node
cannot see the partner's filesystem disks.
1137
Attention:
If this parameter is specified, negotiated takeover optimization is bypassed even if the bypass-optimization parameter is set to false.
Caution:
The use of this parameter can potentially result in client outage.
[-skip-lif-migration-before-takeover [true]] - Skip Migrating LIFs Away from Node Prior
to Takeover
This parameter specifies that LIF migration prior to takeover is skipped. However if LIFs
on this node are configured for failover, those LIFs may still failover after the takeover
has occurred. Without this parameter, the command attempts to synchronously migrate
data and cluster management LIFs away from the node prior to its takeover. If the
migration fails or times out, the takeover is aborted.
[-ignore-quorum-warnings [true]] - Ignore Quorum warnings before Takeover.
If this parameter is specified, quorum checks prior to the takeover will be skipped. The
cluster will not be able to warn users of possible data outages related to quorum.
Examples
The following example causes a node named node0 to initiate a negotiated optimized
takeover of its partner's storage:
cluster1::> storage failover takeover -bynode node0
The following example causes a node named node0 to initiate an immediate takeover of
its partner's storage:
cluster1::> storage failover takeover -bynode node0 -option immediate
storage failover hwassist show

Display hwassist status
level.
Description
1138
The storage failover hwassist show command displays information about

hardware assisted takeover configurations. By default, the command displays the
Node name.
Partner node name.
Whether hardware assisted takeover is enabled.
IP address on which the local node receives hardware assist alerts.
Port on which local node receives hardware assist alerts.
Hardware assist monitor status.
If the monitor is inactive, the reason it is inactive.
If the monitor is inactive, the corrective action to make it active.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the hwassist configurations that match this parameter value.
[-partner-name {<nodename>|local}] - Name of the Partner Node
[-enabled {true|false}] - Local Hardware Assist Enabled
[-local-status <text>] - Local Node's Hwassist Status
Selects the hwassist configurations that match this parameter value (active or inactive).
[-local-ip <text>] - IP Address on Which Local Node is Listening
[-local-port <integer>] - Port on Which Local Node is Listening
1139

[-local-inactive <text>] - Local Node's Hwassist Inactive Status Reason
[-local-action <text>] - Corrective Action on Local Node
Examples
The following example displays the hardware assist information for the local node and
its partner:
cluster1::> storage failover hwassist show
Node
----------------ha1
Partner : ha2
Hwassist Enabled : true
Hwassist IP : 10.225.248.19
Hwassist Port : 4444
Monitor Status : active
Inactive Reason : Corrective Action : ha2
Partner : ha1
Hwassist Enabled : true
Hwassist IP : 10.225.248.21
Hwassist Port : 4444
Monitor Status : active
Inactive Reason : Corrective Action : -
1140
storage failover hwassist test

Test the hwassist functionality
level.
Description
The storage failover hwassist test command tests the Hardware Assist h/
w connectivity between the two nodes in a HA pair. The test result can be one of the
following.
Hardware Assist is not initialized.
No Hardware Assist h/w found.
Partner is throttling alerts.
Resource is busy.
Hardware Assist h/w returned an error.
No response from partner.Timed out.
Unexpected abort.
Partner has taken over.
Interconnect is down between nodes.
Partner is not booted up yet.
Parameters
This specifies the node from which a test alert is initiated.
Examples
The following command issues a test alert from the node cluster1-01:
cluster1::> storage failover hwassist test -node cluster1-01
Info: Storage Failover Hwassist: Operation successful.
1141
storage failover hwassist stats clear

Clear the hwassist statistics
level.
Description
The storage failover hwassist stats clear command clears the statistics
information maintained by Hardware Assist functionality.
Parameters
This specifies the node on which the statistics are to be cleared.
Examples
The following example clears the hwassist statistics on the node cluster1-01:
cluster1::> storage failover hwassist stats clear -node cluster1-01
storage failover hwassist stats show

Display hwassist statistics
level.
Description
The storage failover hwassist stats show command displays statistics about
the hardware assist alerts processed by a node. The command displays the following
information for each alert:
Alert type.
Event that triggered the alert.
The number of times the alert has been received.
1142
Whether takeover was possible on receiving the alert.

The last time at which the alert was received.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the hwassist statistics for the specified node.
Examples
The following example displays the hwassist statistics for the node ha1:
cluster1::> storage failover hwassist stats show -node ha1
Node
received
alert type
alert event
count
takeover
last
---------------- ------------ -------------------- ------ ---------------------------ha1

system_down
power_loss
0 Yes
---
system_down
l2_watchdog_reset
0 Yes
---
system_down
power_off_via_rlm
0 Yes
---
system_down
power_cycle_via_rlm
0 Yes
---
system_down
reset_via_rlm
0 Yes
---
system_down
power_off_via_sp
0 Yes
---
system_down
power_cycle_via_sp
0 Yes
---
system_down
reset_via_sp
0 Yes
---
system_down
post_error
0 No
---
system_down
abnormal_reboot
0 No
---
system_down
loss_of_heartbeat
0 No
---
keep_alive
10 13:10:52 EST 2011
periodic_message
121 No
Thu Feb
test
test
0 No
---
ID mismatch
---
0 ---
---
Key mismatch ---
0 ---
---
1143
Unknown
---
0 ---
---
Number of times hw_assist alerts throttled: 0
1144
storage failover interconnect show-link

Display information about the storage failover interconnect link
privilege level.
Description
The storage failover interconnect show-link command displays
information about storage failover interconnect links in the cluster.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display information only about the interconnect links on the
specified node.
[-link-number <integer>] - Link Number
Use this parameter to display information only about nodes that have the number of
interconnect links you specify.
[-link-state <text>] - Link State
Use this parameter to display information only about the interconnect links that are in
the state you specify. Possible values include up and down.
Examples
The following example displays information about all storage-failover interconnect links
in the cluster:
cluster1::*> storage failover interconnect show-link
Node
Port Number
Link State
1145
-----------------------------------------------------------------------------node1
0
down
up
down
up
node2
1146
storage failover interconnect status

Display the state of the storage failover interconnect and active logical links
privilege level.
Description
The storage failover interconnect status command displays status
information about storage failover interconnects in the cluster.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display information only about the interconnect status of the
nodes you specify.
[-state <text>] - Storage Failover Connection State
Use this parameter to display information only about the interconnects that are in the
state you specify. Possible values are connected and disconnected.
[-active-link <integer>] - Active Logical Link
Use this parameter to display information about the interconnects for the nodes on
which the specified logical link is active.
Examples
The following example displays storage-failover interconnect status for all nodes in the
cluster:
cluster1::*> storage failover interconnect status
Node
Connection State
Active Logical Link
1147
-----------------------------------------------------------------------------node1
Disconnected
Disconnected
node2
1148
storage failover interconnect statistics error show

Display error statistics for the storage failover interconnect
privilege level.
Description
The storage failover interconnect statistics error show command
displays node-specific error statistics about the storage-failover interconnect.
Parameters
specify.
| [-instance ] }
about all fields.
Selects error statistics for the specified node.
[-type {rv|nvram5-sw|nvram5-hw-error|nvram5-hw-perf|nvram5-port-1|nvram5-port-2}] Error Statistics Type
Selects the error statistics of the specified type.
[-counter <text>] - Error Counter Name
Selects the error statistics for the specified error counter.
[-value <integer>] - Error Counter Value
Selects the error statistics that match the specified counter value.
Examples
The following example displays the counter named RV connection attempts for
statistic type RV on the node named node0:
cluster1::*> storage failover interconnect statistics error show -node node0 type RV -counter "RV connection attempts"
1149
Node Name : node0

Error Statistics Type : RV
Error Counter Name : RV connection attempts
Counter Value : 2
1150
storage failover interconnect statistics

performance basic
Display basic performance statistics for the storage failover interconnect
privilege level.
Description
The storage failover interconnect statistics performance basic
command displays basic performance statistics for the storage-failover interconnect.
Parameters
specify.
| [-instance ] }
about all fields.
Specify this parameter to display only statistics for the node you specify.
Specify this parameter to display only the statistic counter you specify.
Specify this parameter to display only statistics that have the value you specify.
Examples
The following example displays basic performance statistics for a node named node0:
cluster1::*> storage failover interconnect statistics performance basic -node
node0
Node
Counter Name
Counter Value
-------------------------------------------------------------node0
1151
Avg MB/s
Completion Intr rate(per sec)
Elapsed time(secs)
2913
RDMA reads
2914
avg bytes per xfer
6281
avg ic_waitdone RDMA-READ time(us)
avg ic_waitdone time(us)
49
avg nv vi q lengths
avg rnv transfer size
8408
avg time between rnv msgs(us)
2113
avg time between rnv transfers(us)
1056
ic_16K+_writes
606052
ic_4k_writes
621335
ic_8k_writes
475766
ic_isdones
2489583
ic_isdones done
411252
ic_isdones not-done
2078331
ic_qmax_waits
ic_small_writes:
2388998
ic_waits
1006419
nvlog Avg time to sync(msec)
530
nvlog Max time to sync(msec)
530
rnv msgs dequeued
1378876
rnv msgs not queued
82
rnv msgs queued
1378876
rnv queue total waittime(us)
72775524
rnv transfers
2757936
total xfers
4092323
1152
storage failover interconnect statistics

performance vi-if
Display vi-if performance statistics for the storage failover interconnect
privilege level.
Description
The storage failover interconnect statistics performance vi-if
command displays performance statistics on a per-interface basis for the storagefailover interconnect.
Parameters
specify.
| [-instance ] }
about all fields.
Specify this parameter to display only statistics for the node you specify.
[-interface <integer>] - VI_IF Interface
Specify this parameter to display only statistics for the messaging interface you specify.
Possible values are 0 and 1.
Specify this parameter to display only the statistic counter you specify.
Specify this parameter to display only statistics that have the counter value you specify.
Examples
1153
The following example displays per-interface performance statistics for the storagefailover interconnect on a node named node0a:
cluster1::*> storage failover interconnect statistics performance vi-if node0a
Node
1154
Interface
Counter Name
Counter Value
node0a
Send credit
node0a
Send Queue length
35
0
node0a
Send Queue full
node0a
Sent Queue length
node0a
Sent data
node0a
Receive Queue length
node0a
Received data
node0a
Explicit credit updates received
node0a
Explicit credit updates sent
node0a
Piggyback credit updates received
1143
node0a
Piggyback credit updates sent
1142
node0a
Sent mbufs
1143
node0a
Recv mbufs freed by vi_if
node0a
Recv mbufs freed by client
node0a
Send credit
node0a
Send Queue length
node0a
Send Queue full
node0a
Sent Queue length
node0a
Sent data
node0a
Receive Queue length
node0a
Received data
node0a
Explicit credit updates received
node0a
Explicit credit updates sent
node0a
Piggyback credit updates received
509611
node0a
Piggyback credit updates sent
509616
node0a
Sent mbufs
509613
node0a
Recv mbufs freed by vi_if
509617
node0a
Recv mbufs freed by client
0
86868
36
86868
35
35
1
1143
33
1
12230704
36
12230784
35
35
storage failover internal-options modify

Modify the internal options for storage failover
privilege level.
Description
The storage failover internal-options modify command changes some of
the storage failover internal options for a node.
Parameters
Use this parameter to specify the node whose storage failover internal options are to be
modified.
Examples
The following example enables failover when the cluster ports are down on a node
named node0:
node::*> storage failover internal-options modify -node node0 -failover-whencluster-ports-down true
The following example sets the failover to start if node0's cluster ports are down for
more than 30 seconds:
node::*> storage failover internal-options modify -node node0 -cluster-portsdown-interval 30
storage failover internal-options show

Display the internal options for storage failover
privilege level.
Description
1155
The storage failover internal-options show command displays the

following information about the storage failover configuration:
Node name
Whether automatic giveback is enabled
Whether partner checking is enabled
Takeover detection time, in seconds
Whether takeover on failover is enabled
Whether takeover on panic is enabled
Whether takeover on reboot is enabled
Whether hardware-assisted takeover is enabled
IP address on which the partner node listens to the hardware-assisted takeover
alerts
Port on which the partner node listens to the hardware-assisted takeover alerts
Whether takeover on short uptime is enabled (detailed view only)
Short uptime interval, in seconds (detailed view only)
Number of giveback attempts (detailed view only)
Giveback attempt interval, in minutes (detailed view only)
Whether status is propagated through SFO mailboxes (detailed view only)
Status read interval, in seconds (detailed view only)
Status write interval, in seconds (detailed view only)
Hardware-assisted takeover retry count (detailed view only)
Hardware-assisted takeover heartbeat period (detailed view only)
Whether operator-initiated planned takeover is optimized
Parameters
specify.
| [-more ]
This parameter displays the following additional information: :
1156
Node name
Whether takeover on short uptime is enabled
Short uptime interval, in seconds
Number of giveback attempts
Giveback attempt interval, in minutes
Whether status is propagated through SFO mailboxes
Status read interval, in seconds
Status write interval, in seconds
Hardware-assisted takeover retry count
Hardware-assisted takeover heartbeat period
| [-instance ] }
about all fields.
Selects configuration information for the specified node.
Selects configuration information for nodes that have the specified automatic giveback
setting.
Selects configuration information for nodes that have the specified partner-checking
setting.
Selects configuration information for nodes that have the specified takeover detection
time setting.
[-onfailure {true|false}] - Takeover on Failure Enabled
Selects configuration information for nodes that have the specified takeover-on-failure
setting.
Selects configuration information for nodes that have the specified takeover-on-panic
setting.
1157
[-onshort-uptime {true|false}] - Takeover on Short Uptime Enabled

Selects configuration information for nodes that have the specified takeover-on-shortuptime setting.
[-short-uptime <integer>] - Short Uptime (secs)
Selects configuration information for nodes that have the specified takeover-on-shortuptime time setting.
[-attempts <integer>] - Number of Giveback Attempts
Selects configuration information for nodes that have the specified number of giveback
attempts setting.
[-attempts-time <integer>] - Giveback Attempts Minutes
Selects configuration information for nodes that have the specified giveback attempt
time setting.
[-propagate {true|false}] - Propagate Status via Mailbox
Selects configuration information for nodes that have the specified setting for
propagation of status through Storage Failover mailboxes.
[-read-interval <integer>] - Node Status Read Interval (secs)
Selects configuration information for nodes that have the specified status read interval
setting.
[-write-interval <integer>] - Node Status Write Interval (secs)
Selects configuration information for nodes that have the specified status write interval
setting.
Selects configuration information for nodes that have the specified takeover-on-reboot
setting.
If this parameter is specified, the command displays information only about the node or
nodes that have the specified delay for auto giveback.
[-hwassist {true|false}] - Hwassist Enabled
Selects configuration information for nodes that have the specified hardware-assisted
takeover setting.
[-hwassist-partner-ip <text>] - Partner's Hwassist IP
1158
Selects configuration information for nodes that have the specified partner IP setting for
hardware-assisted takeovers.
Selects configuration information for nodes that have the specified partner port setting
for hardware-assisted takeovers.
Selects configuration information for nodes that have the specified health check interval
setting for hardware-assisted takeovers
Selects configuration information for nodes that have the specified retry count (in
seconds) for hardware-assisted takeovers.
[-mode {ha|non_ha}] - HA Mode
If this parameter is specified, the command displays information only about the node or
nodes that have the specified HA mode.
Selects configuration information for nodes that have the specified setting for bypass
takeover optimization ( true means that optimized operator-initiated planned takeover
is bypassed, false means that it is enabled). Operator-initiated planned takeover is
optimized when SFO aggregates are relocated serially to the partner prior to takeover.
This reduces client outage.
Examples
The following example displays detailed information about the internal options for
storage failover on a node named node2:
cluster1::*> storage failover internal-options show -node node2
Node: node2
Auto Giveback Enabled: false
Check Partner Enabled: true
Takeover Detection Time (secs): 15
Takeover On Failure Enabled: true
Takeover On Panic Enabled: false
Takeover On Short Uptime Enabled: true
Short Uptime (secs): Number of Giveback Attempts: 3
Giveback Attempts Minutes: 10
1159
Propagate Status Via Mailbox: true

Node Status Read Interval (secs): 5
Node Status Write Interval (secs): 5
Failover the Storage when Cluster Ports Are Down: Failover Interval when Cluster Ports Are Down (secs): Takeover on Reboot Enabled: true
Delay Before Auto Giveback (secs): 300
Hardware Assist Enabled: true
Partner's Hw-assist IP:
Partner's Hw-assist Port: 4444
Hw-assist Health Check Interval (secs): 180
Hw-assist Retry count: 2
HA mode: ha
Bypass Takeover Optimization Enabled: true
1160
storage failover mailbox-disk show

Display information about storage failover mailbox disks
privilege level.
Description
The storage failover mailbox-disk show command lists the mailbox disks that
are used by storage failover. The command displays the following information:
Node name
Whether the mailbox disk is owned by the local node or by its partner
Disk name
Disk universal unique identifier (UUID)
This command is available only at the advanced privilege level and higher.
Parameters
If -fields <fieldname>,... is used, the command displays only the specified fields.
| [-instance ] }
If this parameter is used, the command displays detailed information about all entries.
Selects the mailbox disks that are associated with the specified node.
[-location {local|partner}] - Mailbox Location
Selects the mailbox disks that have the specified relationship to the node.
[-diskindex <integer>] - Mailbox Disk Index
Selects the mailbox disk that has the specified index number.
[-diskname <text>] - Mailbox Disk Name
Selects the mailbox disks that match the specified disk name.
[-diskuuid <text>] - Mailbox Disk UUID
1161
Selects the mailbox disks that match the specified UUID.
Examples
The following example displays information about the mailbox disks on a node named
node1:
cluster1::*> storage failover mailbox-disk show -node node1
Node
Location
Index Disk Name
Disk UUID
------- --------- ----- ------------- ----------------------node1
1162
local
0 1.0.4
20000000:8777E9D6:[...]
local
1 1.0.6
20000000:8777E9DE:[...]
partner
0 1.0.1
20000000:877BA634:[...]
partner
1 1.0.2
20000000:8777C1F2:[...]
storage failover progress-table show

Display status information about storage failover operations
privilege level.
Description
The storage failover progress-table show displays status information about
storage-failover operations. This information is organized in a resource table. The
command displays the following information:
Node name
Resource-entry index number
Resource-entry name
Resource-entry state
Resource-entry failure code
Resource-entry time delta
Parameters
If -fields <fieldname>, ... is used, the command will only displays only the specified
fields.
| [-instance ] }
If this parameter is used, the command displays detailed information about all entries.
Selects the status information for the specified node.
[-index <integer>] - Resource Table Index
Selects the status information for the specified index number.
[-entryname <text>] - Resource Table Entry Name
Selects the status information for the specified entry name.
1163
[-state <text>] - Resource Table Entry State

Selects the status information for the specified state. Possible values include
UP, START_RUNNING, START_DONE, START_FAILED, STOP_RUNNING,
STOP_FAILED, TAKEOVER_BARRIER, and ONLY_WHEN_INITD.
[-failurecode <text>] - Entry Failure Code
Selects the status information for the specified failure code. Possible values include OK,
FAIL, FAIL_ALWAYS, HANG, PANIC, and VETO.
[-timedelta <integer>] - Entry Time Delta
Selects the status information for the specified time delta.
Examples
The following example displays the entire storage-failover resource table:
cluster1::*> storage failover progress-table show
Node
Entry Name
------ -----------------------------------
State
Time Delta
-------
-----------
node0
Pre-rsrctbl: fmdisk_resumePartnerDi
start_done
Pre-rsrctbl: coredump_get_busy_spar
start_done
107
Pre-rsrctbl: raid_preread_labels_be
start_done
Pre-rsrctbl: fmdisk_reserve_all
start_done
84
rsrctbl: fmrsrc_giveback_done
start_done
rsrctbl: fmic
start_done
rsrctbl: fmdisk_reserve
start_done
171
rsrctbl: fm_partnerSlowTimeout
start_done
rsrctbl: fmdisk_inventory
start_done
rsrctbl: fmfsm_reserve
start_done
Press <space> to page down, <return> for next line, or 'q' to quit...
Node
Entry Name
State
Time Delta
----------
-----------
rsrctbl: rdb-ha
start_done
36
rsrctbl: giveback_cleanup_wait
start_done
rsrctbl: priority_ha
start_done
rsrctbl: raid
start_done
113
rsrctbl: raid_disaster_early
start_done
rsrctbl: wafl_nvram_replay
start_done
rsrctbl: takeover_test_1
start_done
------ -----------------------------------node0
1164
1165
storage firmware download

Download disk, ACP processor and shelf firmware
privilege level.
Description
The storage firmware download command downloads ACP processor, disk and
shelf firmware to a specified node.
Use the storage disk firmware update command to install downloaded disk
firmware.
Use the system node run local storage download shelf command to install
downloaded disk shelf module firmware.
Use the system node run local storage download acp command to install
downloaded ACP processor firmware.
Parameters
This specifies the node to which the firmware is to be downloaded.
-package-url <text> - Package URL
This specifies the path to the firmware package.
The following URL protocols are supported: ftp, http, and tftp.
Examples
The following example downloads a disk firmware package with the path ftp://
example.com/fw/disk-fw-1.2.LOD.zip to a node named node1:
cluster1::> storage firmware download -node node1 -package-url ftp://example.com/
fw/disk-fw-1.2.LOD.zip
See Also
storage disk firmware update system node run
1166
storage load balance

Balance storage I/O across controller's initiator ports
level.
Description
This command is obsolete. I/O load is balanced automatically every five minutes.
Parameters
-node {<nodename>|local} - Node to balance on
The name of the clustered node for which information is being displayed.
Examples
This command has no effect.
1167
storage load show

Display I/O statistics to array LUNs, grouped by initiator port.
level.
Description
This command is obsolete. The storage load show command displays the load
distribution of I/O on the cluster.
Parameters
specify.
| [-switch ]
The switch parameter adds switch information to the display.
| [-instance ] }
about all fields.
[-node {<nodename>|local}] - Controller name
[-initiator-port <text>] - Initiator Port
The initiator port of the array LUN for which I/O stats are being displayed.
[-wwpn <text>] - Target Port WWPN
The World Wide Port Name of the array LUN for which I/O stats are being displayed.
[-serialnumber <text>] - Serial Number
The serial number of the array LUN for which I/O stats are being displayed.
[-lun <integer>] - LUN
The array LUN for which I/O stats are being displayed.
1168
[-pct-io <text>] - %I/O

Percent of I/O bandwidth consumed by this array LUN.
[-io-blocks <integer>] - I/O (blocks)
Number of I/O blocks transferred.
The initiator side switch port for this array LUN.
The target side switch port for this array LUN.
Examples
cluster1::> storage load show -switch
Initiator port: 0a connected to vnbr3850s4:7.
Target Side
LUN Serial #
I/O (blocks)
Target Port
Switch Port
%I/O
--- -------------------------------- ---------------- -------------------- ----------------1 D600020C00D3

0
50060e80004291c0
vnbr3850s5:12
2 D600020C00D4
21
50060e80004291c0
vnbr3850s5:12
100
5 D600020C00EF
0
50060e80004291c0
vnbr3850s5:12
Initiator port: 0c connected to vnci9124s54:1-11.

Target Side
LUN Serial #
I/O (blocks)
Target Port
Switch Port
%I/O
--- -------------------------------- ---------------- -------------------- ----------------3 D600020C00D9

8
50060e80004291c2
vnci9124s54:1-22
42
4 D600020C00DA
7
50060e80004291c2
vnci9124s54:1-22
36
6 D600020C00F0
3
50060e80004291c2
vnci9124s54:1-22
15

Target Side
LUN Serial #
I/O (blocks)
Target Port
Switch Port
%I/O
--- -------------------------------- ---------------- -------------------- ----------------2 D600020C00D4

0
50060e80004291c0
vnbr3850s5:12
1169

Target Side
LUN Serial #
I/O (blocks)
Target Port
Switch Port
%I/O
--- -------------------------------- ---------------- -------------------- ----------------5 D600020C00EF

0
50060e80004291c0
vnbr3850s5:12
6 D600020C00F0
31
50060e80004291c0
vnbr3850s5:12
100

Target Side
LUN Serial #
I/O (blocks)
Target Port
Switch Port
%I/O
--- -------------------------------- ---------------- -------------------- ----------------1 D600020C00D3

0
50060e80004291c2
vnci9124s54:1-22

Target Side
LUN Serial #
I/O (blocks)
Target Port
Switch Port
%I/O
--- -------------------------------- ---------------- -------------------- ----------------3 D600020C00D9

3
50060e80004291c2
vnci9124s54:1-22
42
4 D600020C00DA
3
50060e80004291c2
vnci9124s54:1-22
42
1170
storage path quiesce

Quiesce I/O to an array LUN on one path.
level.
Description
The storage path quiesce command quiesces I/O on one path to a LUN. After
the I/O has been quiesced, no new I/O is sent on the path to the array LUN unless the
storage path resume command is issued to continue I/O.
Parameters
-node {<nodename>|local} - Node name
-initiator <initiator name> - Initiator Port
Initiator port that the clustered node uses.
-target-wwpn <wwpn name> - Target Port
Target World Wide Port Name. Port on the storage array that is being used.
-lun-number <integer> - LUN Number
Logical Unit number. The range is: [0...65535]
Examples
The following example suspends I/O between node vbv3170f1b, port 0a and the array
port 50001fe1500a8669, LUN 1.
node::> storage path quiesce -node vbv3170f1b -initiator 0a -target-wwpn
50001fe1500a8669 -lun-number 1
See Also
storage path resume
1171
storage path resume

Resume I/O to an array LUN on a path.
level.
Description
The storage path resume command continues I/O flow to an array LUN on a path
that was previously quiesced. Resuming I/O to a quiesced array LUN is not an error.
Parameters
-node {<nodename>|local} - Node name
-initiator <initiator name> - Initiator Port
-target-wwpn <wwpn name> - Target Port
-lun-number <integer> - LUN Number
Logical Unit number. The range is: [0...65535]
Examples
The following example quiesces I/O between node vbv3170f1b, port 0a and the array
port 50001fe1500a8669, LUN 1
node::> storage path resume -node vbv3170f1b -initiator 0a -target-wwpn
50001fe1500a8669 -lun-number 1
storage path show-by-initiator

Display a list of paths to attached arrays from the initiator's perspective
level.
1172
Description
The storage path show-by-initiator command displays path based statistics.
The output is similar to the storage path show command but the output is listed by
initiator.
Parameters
specify.
| [-instance ] }
about all fields.
[-initiator <text>] - Initiator Port
[-target-wwpn <text>] - Target Port
Switch port connected to the clustered node.
Switch port connected to the array.
Name of the storage array that is connected to the cluster.
[-tpgn <integer>] - Target Port Group Number
TPGN refers to the target port group to which the target port belongs. A target port
group is a set of target ports which share the same LUN access characteristics and
failover behaviors.
[-port-speed <text>] - Port Speed
Port Speed of the specified port.
1173
[-path-io-kbps <integer>] - Kbytes of I/O per second on Path (Rolling Average)

Rolling average of I/O per second on the path.
[-path-iops <integer>] - Number of IOPS on Path (Rolling Average)
Rolling average of Kbytes of I/O per second on the path
[-initiator-io-kbps <integer>] - Kbytes of I/O per second on Initiator (Rolling Average)
Rolling average of I/O per second on the initiator port.
[-initiator-iops <integer>] - Number of IOPS on Initiator (Rolling Average)
Rolling average of Kbytes of I/O per second on the initiator port.
[-target-io-kbps <integer>] - Kbytes of I/O per second to Target (Rolling Average)
Rolling average of I/O per second on the target port.
[-target-iops <integer>] - Number of IOPS to Target (Rolling Average)
Rolling average of Kbytes of I/O per second on the target port.
Examples
vnv3070f20b::> storage path show-by-initiator
Node: vnv3070f20b
Initiator I/O
Target I/O
Initiator
(KB/s)
Initiator Side
Path I/O
Target Side
(KB/s)
Switch Port
Target Port Array Name
(KB/s)
Switch Port
--------- ------------- -------------------- ------------ ------------------------------- ---------------- ---------------0a
3 vnbr3850s4:4
3 200600a0b819e16f IBM_1722_1
vnbr3850s5:15
vnbr3850s5:12
35
vnci9124s54:1-24
vnci9124s54:1-22
0 50060e80004291c0 HITACHI_DF600F_1
0c
35 vnci9124s54:1-6
35 200700a0b819e16f IBM_1722_1
0 50060e80004291c2 HITACHI_DF600F_1
See Also
storage path show
1174
storage path show

Display a list of paths to attached arrays.
level.
Description
The storage path show command displays path based statistics. The default
command shows:
Node name
Initiator port
Target port
TPGN
Port speeds
Path I/O in Kbytes/sec
IOPs
Parameters
specify.
| [-array ]
Using this option displays:
Array name
Target port
Target I/O in Kbytes/sec
Target side switch port
Initiator side switch port
1175
Initiator I/O in Kbytes/sec

Initiator port
| [-by-target ]
Using this option displays the same information as the array option, but grouped by
target port.
| [-detail ]
Using this option displays the same information as the array and by-target options, but
adds the following:
Target IOPs
Target LUNs
Path IOPs
Path errors
Path quality
Path LUNs
Initiator IOPs
Initiator LUNs
| [-switch ]
Using this option adds switch port information to the default display.
| [-instance ] }
about all fields.
Name of the storage array that is connected to the cluster.
1176

failover behaviors.
Rolling average of I/O per second on the path.
[-path-iops <integer>] - Number of IOPS on Path (Rolling Average)
Rolling average of Kbytes of I/O per second on the path
Rolling average of I/O per second on the initiator port.
[-initiator-iops <integer>] - Number of IOPS on Initiator (Rolling Average)
[-target-iops <integer>] - Number of IOPS to Target (Rolling Average)
Switch port connected to the array.
[-path-link-errors <integer>] - Link Error count on path
Fibre Channel link error count.
[-path-quality <integer>] - Percentage of weighted error threshold
A number representing the threshold of errors that is allowed on the path. Path quality
is a weighted error value. When the error weight of a path exceeds the threshold, I/O is
routed to a different path.
[-path-lun-in-use-count <integer>] - Number of LUNs in the in-use state on this path
Number of LUNs on this path.
1177
[-initiator-lun-in-use-count <integer>] - Number of LUNs in the in-use state on this

initiator
Number of LUNs on this initiator.
[-target-lun-in-use-count <integer>] - Number of LUNs in the in-use state on this target
Number of LUNs on this target.
[-vmdisk-device-id <integer>] - Virtual disk device ID
Common device identifier, shared by a VM and its hypervisor, of a virtual disk. On ESX
servers, this is the Disk ID component of a virtual device node, with a value of 0 to 15.
Examples
The following example shows the default display.
vbv3170f2a::> storage path show
Path I/O
Node
(KB/s)
Initiator
Array Target Port
TPGN
Speed
------
-------
IOPS
--------------------- -------------------- ------------
-----------------------
vbv3170f2a-01
6
0b
50001fe1500a866c
2 Gb/S
vbv3170f2a-01
0
0b
50001fe1500a866d
2 Gb/S
vbv3170f2a-01
0
0c
50001fe1500a866e
4 Gb/S
vbv3170f2b-03
3
0a
50001fe1500a866d
2 Gb/S
vbv3170f2b-03
3
0c
50001fe1500a866f
4 Gb/S
The following example shows how the information is displayed with the array option.
vnv3070f20b::> storage path show -array
Node: vnv3070f20b
Target I/O
Initiator Side Initiator I/O Initiator
Array Name
Target Port
Switch Port
(KB/s)
(KB/s)
Port
Target Side
Path I/O
Switch Port
(KB/s)
---------------- ---------------- ------------ -------------------- ------------------------------- ------------- --------HITACHI_DF600F_1 50060e80004291c0

vnbr3850s4:4
3
1178
vnbr3850s5:12
0a
50060e80004291c2
vnci9124s54:1-6
26
0c
IBM_1722_1
200600a0b819e16f
vnbr3850s4:4
3
0a
200700a0b819e16f
vnci9124s54:1-6
26
0c
vnci9124s54:1-22
vnbr3850s5:15
26
vnci9124s54:1-24
26
The following example shows how the information is displayed when grouped by target.
vnv3070f20b::> storage path show -by-target
Node: vnv3070f20b
Array Name: HITACHI_DF600F_1
Target I/O
Side Initiator I/O Initiator
Target Port
Port
(KB/s)
(KB/s)
Port
Target Side
Path I/0
Initiator
Switch Port
(KB/s)
Switch
---------------- ------------ -------------------- ------------------------------- ------------- --------50060e80004291c0

vnbr3850s4:4
0
3
vnbr3850s5:12
50060e80004291c2
vnci9124s54:1-6
0a
0
26
vnci9124s54:1-22
0c
Target Side
Path I/0
Initiator
Switch Port
(KB/s)
Switch
Node: vnv3070f20b
Array Name: IBM_1722_1
Target I/O
Side Initiator I/O Initiator
Target Port
Port
(KB/s)
(KB/s)
Port
---------------- ------------ -------------------- ------------------------------- ------------- --------200600a0b819e16f

vnbr3850s4:4
3
3
200700a0b819e16f
vnci9124s54:1-6
vnbr3850s5:15
0a
26
26
vnci9124s54:1-24
0c
26
The following example shows how the information is displayed with the switch option.
vbv3170f2b::> storage path show -switch
Target Side
Initiator Side
Node
Switch Port
Path I/O
Initiator Array Target Port
TPGN
Speed
(KB/s)
Switch Port
IOPS
1179
----------------------------------------
--------- ----------------------- ------------------------- ------- ------------ ------------
vbv3170f2a-01
vbbr300s1:2
0b
vbv3170f2a-01
vbbr300s1:2
0b
vbv3170f2a-01
vbci9124s2:1-3
0c
vbv3170f2b-03
vbbr300s1:3
0a
vbv3170f2b-03
vbci9124s2:1-4
0c
50001fe1500a866c
2 Gb/S
9
vbbr300s1:6
3
50001fe1500a866d
2 Gb/S
0
vbbr300s1:7
0
50001fe1500a866e
4 Gb/S
0
vbci9124s2:1-7
0
50001fe1500a866d
2 Gb/S
4
vbbr300s1:7
1
50001fe1500a866f
4 Gb/S
4
vbci9124s2:1-8
1
1180
storage pool add

Add disks to a storage pool
level.
Description
The storage pool add command increases the total capacity of an existing storage
pool by adding the specified SSDs to the storage pool. The disks are split into four equal
partitions and added to each of the storage pool's allocation units. If any allocation units
from the storage pool have already been allocated to a Flash Pool cache, the amount of
storage provided to that cache is increased.
For example, if an SSD with a usable size of 745 GB is added to a storage pool that
is part of four Flash Pools, each Flash Pool will grow its cache size by 186.2 GB. If a
different allocation is desired, create a new storage pool using the storage pool
create command.
Parameters
-storage-pool <storage pool name> - Storage Pool Name
This parameter specifies the storage pool to which disks are to be added.
[-disk-list <disk path name>, ...] - List of Spare Disks
This parameter specifies a list of disks to be added to the storage pool. In an HA
configuration, SSDs being added to a storage pool can be owned by either node in the
HA pair.
{ [-quiet [true]] - Confirmations off (privilege: advanced)
When set to true, this parameter specifies the operation should be executed without
pausing for confirmation.
| [-simulate [true]] } - Simulate Storage Pool Addition
When set to true, this parameter specifies the operation should be performed as a
simulation. The command reports which aggregates would grow automatically as a
result of adding the disks to the storage pool. The disks are not added to the storage
pool.
Examples
1181
In this example, the user requests a report detailing the changes that would occur if a
new disk is added to the storage pool SP1. In this case, 186.2 GB of cache is added to
the Flash Pool aggregates nodeA_flashpool_1 and nodeB_flashpool_1. There are two
unprovisioned allocation units in the storage pool and therefore the storage pool spare
capacity also grows by 372.5 GB.
cluster1::> storage pool add -storage-pool SP1 -disk-list 1.0.23 -simulate
This operation will result in capacity being allocated in the following way:
Container
Name
Capacity
Current
New
To Be Added
Size
Size
-----------------
------------
---------
---------
nodeA_flashpool_1
186.2GB
558.7GB
744.9GB
nodeB_flashpool_1
186.2GB
558.7GB
744.9GB
(Spare Capacity)
372.5GB
1.09TB
1.45TB
See Also
storage pool create
1182
storage pool create

Create a new storage pool
level.
Description
The storage pool create command creates an SSD storage pool using a given list
of spare SSDs.
When a storage pool is created, Data ONTAP splits the capacity provided by the SSDs
into four equally-sized allocation units. In an HA configuration, two allocation units
(containing 50% of the total capacity) are assigned to each node in the HA pair. This
assignment can be modified using the storage pool reassign command.
After the storage pool is created, its allocation units can be provisioned into Flash
Pool aggregates using the storage aggregate add-disks command using the storage-pool parameter.
Parameters
This parameter specifies the name of the storage pool that is to be created. The SSDs
are partitioned and placed into the new storage pool.
-disk-list <disk path name>, ... - Disk List for Storage Pool Creation
This parameter specifies a list of SSDs to be included in the new storage pool. The
SSDs must be spare disks and can be owned by either node in an HA pair.
[-simulate [true]] - Simulate Storage Pool Creation
This option simulates the storage pool creation and prints the allocation unit size that
would be used for the storage pool.
Examples
The following example creates a storage pool named SP1 from four SSDs.
cluster1::> storage pool create -storage-pool SP1 -disk-list 1.0.13, 1.0.15,
1.0.17, 1.0.19
[Job 122] Job succeeded: storage pool create job for "SP1" completed successfully
1183
See Also
storage pool reassign storage aggregate add-disks
1184
storage pool delete

Delete an existing storage pool
level.
Description
The storage pool delete command deletes an existing SSD storage pool. At the
end of the operation, the SSDs are coverted back to spare disks.
Parameters
This parameter specifies the storage pool that you want to delete. You can delete the
storage pool only if all of the allocation units in the storage pool are spare.
Examples
Verify that storage pool SP3 is ready for deletion by confirming it has four spare
allocation units and then delete it.
cluster1::> storage pool show-available-capacity -storage-pool SP3
Storage SyncMirror Allocation Unit
Node
Storage Pool
Type
Pool
Unit size
Total
Count Usable Size
---------- --------------- ------- ---------- ---------- ----- ----------node-a
SP3
SSD
Pool0
372.5GB
744.9GB
node-b
SP3
SSD
Pool0
372.5GB
744.9GB

cluster1::> storage pool delete -storage-pool SP3
Warning: Are you sure you want to delete storage pool "SP3"? {y|n}: y
[Job 313] Job succeeded: storage pool delete job for "SP3" completed successfully
1185
storage pool reassign

Reassign capacity from one node to another node in storage pool
level.
Description
The storage pool reassign command changes the ownership of unprovisioned
(spare) storage pool allocation units from one HA partner to the other for an existing
storage pool.
Parameters
This parameter specifies the storage pool within which spare capacity is reassigned
from one node to another.
-from-node {<nodename>|local} - Reassign Available Capacity from This Node
This parameter specifies the name of the node that currently owns the allocation units.
-to-node {<nodename>|local} - Reassign Available Capacity to This Node
This parameter specifies the name of the node that will now own the allocation units.
-allocation-units <integer> - Allocation Units
This parameter specifies the number of allocation units to be reassigned.
Examples
Move a spare allocation unit from node-b to node-a in preparation for provisioning the
allocation units on node-a.
cluster1::*> storage pool show-available-capacity -storage-pool SP2
Node
Storage Pool
Type
Pool
Unit size
Total
Count Usable Size
---------- --------------- ------- ---------- ---------- ----- ----------node-a
SP2
SSD
Pool0
744.9GB
1.45TB
node-b
SP2
SSD
Pool0
744.9GB
744.9GB
1186
cluster1::*> storage pool reassign -storage-pool SP2 -from-node node-b -to-node

node-a -allocation-units 1
[Job 310] Job succeeded: storage pool reassign job for "SP2" completed
successfully
cluster1::*> storage pool show-available-capacity -storage-pool SP2
Node
Storage Pool
Type
Pool
Unit size
Total
Count Usable Size
---------- --------------- ------- ---------- ---------- ----- ----------node-a
SP2
SSD
Pool0
744.9GB
2.18TB
node-b
SP2
SSD
Pool0
744.9GB
0B
See Also
storage pool show-available-capacity
1187
storage pool show-aggregate

Display aggregates provisioned from storage pools
level.
Description
The storage pool show-aggregate command displays allocation information for
SSD storage pools in the cluster. The command output depends upon the parameter or
displays information about allocations of all storage pools in the cluster.
Parameters
specify.
| [-instance ] }
about all fields.
[-storage-pool <storage pool name>] - Name of Storage Pool
Selects the storage pools that match this parameter value.
[-capacity {<integer>[KB|MB|GB|TB|PB]}] - Capacity
Capacity includes space provided by data and parity portions of each allocation unit.
When used as Flash Pool cache, only the data portions of each allocation unit contribute
capacity to the cache.
[-allocated-unit-count <integer>] - Number of AU's Assigned to This Aggregate
[-original-owner <text>] - Original Owner Name
1188

Examples
Display information about the aggregate or aggregates using a storage pool called SP2:
cluster1::> storage pool show-aggregate -storage-pool SP2 -instance
Name of Storage Pool: SP2
Aggregate: node2_flashpool_1
Capacity: 744.9GB
Number of AU's Assigned to This Aggregate: 1
Original Owner Name: node2
Node: node2
1189
storage pool show-available-capacity

Display available capacity of storage pools
level.
Description
The storage pool show-available-capacity command displays information
about spare capacity available in SSD storage pools on each node in the cluster.
The command output depends upon the parameter or parameters specified with the
command. If no parameters are specified, the command displays information about
available capacities in all shared pools in the cluster.
Storage pool available capacity is data storage space that has not yet been provisioned
into Flash Pool aggregates. Allocation units may be provisioned into Flash Pool
aggregates using the storage aggregate add-disks command using the storage-pool parameter.
Note:
All storage pool available capacity can be provisioned into Flash Pool aggregates.
Available capacity within a storage pool is not used to protect against a disk failure.
In the case of an SSD failure or predicted failure, Data ONTAP will move a suitable
whole SSD spare disk from outside the storage pool into the storage pool and begin the
recovery process (using either reconstruction or Rapid RAID Recovery, whichever is
appropriate).
Parameters
specify.
| [-instance ] }
about all fields.
1190
Selects the available capacities that match this parameter value.

[-allocation-unit-size {<integer>[KB|MB|GB|TB|PB]}] - Allocation Unit Size
Allocation units are the units of storage capacity that are available to be provisioned into
Flash Pool aggregates.
[-storage-type <SSD>] - Type of Storage Pool
Selects the available capacities that match this parameter value. Only the SSD type is
supported for this version of Data ONTAP.
[-allocation-unit-count <integer>] - Number of Allocation Units Available
Allocation units are the units of storage capacity that are available to be provisioned into
Flash Pool aggregates. Each allocation unit is one minimum unit of allocation (MUA)
and its capacity is given as allocation-unit-size.
[-syncmirror-pool <text>] - Syncmirror Pool
The SyncMirror pool of an allocation unit must match the SyncMirror pool of the
aggregate's hard disks when adding allocation units into a Flash Pool aggregate.
Mirroring of Flash Pool aggregates that are provisioned from SSD storage pools is not
supported.
[-available-size {<integer>[KB|MB|GB|TB|PB]}] - Total Usable Available Size
The available-size is the sum of the capacities of the allocation units that are
assigned but not yet provisioned. The amount of available-size that contributes to
Flash Pool cache depends upon the RAID type used when provisioning the allocation
units.
Examples
In this example, two nodes of an HA pair share available capacity from two storage
pools, SP1 and SP2. There are a total of 5 allocation units that have not yet been
provisioned.
cluster1::> storage pool show-available-capacity
1191

Node
Storage Pool
Type
Pool
Unit size
Total
Count Usable Size
---------- --------------- ------- ---------- ---------- ----- ----------node-a
SP1
SSD
Pool0
558.7GB
558.7GB
node-b
SP1
SSD
Pool0
558.7GB
558.7GB
node-a
SP2
SSD
Pool0
744.9GB
1.45TB
node-b
SP2
SSD
Pool0
744.9GB
744.9GB
See Also
1192
storage pool show-disks

Display disks in storage pools
level.
Description
The storage pool show-disks command displays information about disks in
storage pools in the cluster. The command output depends on the parameter or
displays information about all disks in all storage pools in the cluster.
Parameters
specify.
| [-instance ] }
about all fields.
[-disk <disk path name>] - Name of the disk
Selects the storage pools with the disks that match this parameter value.
[-disk-type {ATA | BSAS | EATA | FCAL | FSAS | LUN | MSATA | SAS | SATA | SCSI |
SSD | XATA | XSAS | VMDISK}] - Disk Type
Selects the storage pools with the disks that match this parameter value. Only the SSD
type is supported for this version of Data ONTAP.
[-usable-size {<integer>[KB|MB|GB|TB|PB]}] - Disk Usable Size
In this command, usable-size refers to the sum of the capacities of all of the
partitions on the disk.
1193
[-total-size {<integer>[KB|MB|GB|TB|PB]}] - Total Size

Examples
Show information about SSDs in a storage pool called SP2.
cluster1::> storage pool show-disks -storage-pool SP2
Storage Pool Name: SP2
Storage
Disk
Type
Usable Size
Total Size
-------- ------- ----------- -----------
1194
1.0.16
SSD
745.0GB
745.2GB
1.0.18
SSD
745.0GB
745.2GB
1.0.20
SSD
745.0GB
745.2GB
1.0.22
SSD
745.0GB
745.2GB
storage pool show

Display details of storage pools
level.
Description
The storage pool show command displays information about SSD storage pools in
the cluster. By default, the command displays information about all storage pools in the
cluster. You can specify parameters to limit the output to a specific set of storage pools.
Parameters
specify.
| [-instance ] }
about all fields.
[-storage-pool <storage pool name>] - Storage Pool Name
[-storage-pool-uuid <UUID>] - UUID of Storage Pool
[-nodes {<nodename>|local}, ...] - Nodes Sharing the Storage Pool
In an HA pair, either node name may be specified.
[-disk-count <integer>] - Number of Disks in Storage Pool
[-allocation-unit-size {<integer>[KB|MB|GB|TB|PB]}] - Allocation Unit Size
1195
Allocation units represent the unit of storage allocated to Flash Pool aggregates from
this storage pool.
[-allocation-unit-data-size-raid4 {<integer>[KB|MB|GB|TB|PB]}] - Allocation Unit Data
Size for RAID4
This parameter shows the amount of additional data capacity provided if an allocation
unit from this storage pool was added to a Flash Pool aggregate with -raidtype as
raid4.
[-allocation-unit-data-size-raid-dp {<integer>[KB|MB|GB|TB|PB]}] - Allocation Unit
Data Size for RAID-DP
This parameter shows the amount of additional data capacity provided if an allocation
unit from this storage pool was added to a Flash Pool aggregate with -raidtype as
raid_dp.
[-storage-type <SSD>] - Storage Type
Only the SSD type is supported for this version of Data ONTAP.
[-pool-usable-size {<integer>[KB|MB|GB|TB|PB]}] - Storage Pool Usable Size
The pool-usable-size is the sum of the capacities of the allocation units that are
assigned to nodes but not yet provisioned. The amount of pool-usable-size that
contributes to Flash Pool cache depends upon the RAID type used when provisioning
the allocation units.
[-pool-total-size {<integer>[KB|MB|GB|TB|PB]}] - Storage Pool Total Size
The pool-total-size is the sum of the capacities of allocation units belonging to this
storage pool.
[-is-healthy {true|false}] - Is Pool Healthy?
For storage pools with is-healthy false, the unhealthy-reason parameter
provides more information.
is-healthy must be true in order to provision allocation units from a storage pool into
a Flash Pool aggregate.
[-pool-state <State of the Storage Pool>] - State of the Storage Pool
Selects the storage pools that match this parameter value. Possible states are:
1196
normal - the storage pool is operating normally.

degraded - the storage pool has one or more failed disks.
creating - the storage pool is being created.
deleting - the storage pool is being deleted.
reassigning - allocation units are being reassigned from one node to another.
growing - allocation units in the storage pool are expanding due to the addition of
new capacity into the storage pool.
[-unhealthy-reason <text>] - Reason for storage pool being unhealthy
The message provided gives additional details about why the storage pool is unhealthy.
[-current-operation-job-id <integer>] - Job ID of the Currently Running Operation
Long-running operations associated with storage pools will be managed via jobs. For
example, if you provision allocation units from a storage pool into an aggregate in order
to create a flash pool aggregate and the disks associated with the storage pool need to
be zeroed, the operation will be completed via a job.
Examples
Display the storage pools in the cluster.
cluster1::> storage pool show
Storage Pool
Type
#Disks Nodes
Total Size
-------------------
----- ------ ----------------
LargeSP
SSD
10 noda-a,node-b
7.27TB
SmallSP
SSD
2 noda-a,node-b
1.45TB
----------
The following example displays the details of a storage pool named SmallSP. Only one
of its four allocation unit has been provisioned, so 75% of its size is available (usable).
cluster1::> storage pool show -storage-pool SmallSP
Storage Pool Name: SmallSP
UUID of Storage Pool: 60f2f1b9-e60f-11e3-a5e7-00a0981899a2
Nodes Sharing the Storage Pool: node-a, node-b
1197
Number of Disks in Storage Pool: 2

Allocation Unit Size: 372.5GB
Storage Type: SSD
Storage Pool Usable Size: 1.09TB
Storage Pool Total Size: 1.45TB
Is Pool Healthy?: true
State of the Storage Pool: normal
Reason for storage pool being unhealthy: Job ID of the Currently Running Operation: -
1198
storage raid-options modify

Modify a RAID option
level.
Description
The storage raid-options modify command is used to modify the available
RAID options for each node in a cluster. The options are described in the storage
raid-options manual page.
Parameters
This parameter specifies the node on which the RAID option is to be modified.
-name <text> - Option Name
This parameter specifies the RAID option to be modified. To see the list of RAID options
that can be modified, use the storage raid-options show command.
[-value <text>] - Option Value
This parameter specifies the value of the selected RAID option.
Examples
The following example sets the raid scrub duration to 12 hours for a node named node1:
cluster1::> storage raid-options modify -node node1 -name raid.scrub.duration value 720
See Also
storage raid-options show storage raid-options
1199
storage raid-options show

Display RAID options
level.
Description
The storage raid-options show command displays information about all the
RAID options in a cluster. The options are described in the storage raid-options
manual page.
Parameters
specify.
| [-instance ] }
about all fields.
Selects information about all the RAID options on the specified node.
[-name <text>] - Option Name
Selects information about the RAID options that have the specified name.
[-value <text>] - Option Value
Selects information about all the RAID options that have the specified value.
[-constraint <text>] - Option Constraint
Selects information about all the RAID options that have the specified constraint. The
'constraint' field indicates the expected setting for a RAID option across both nodes of
an HA pair. The possible values are:
none - no constraint on the value of this RAID option; nodes can have different
values
1200
same_preferred - the same value should be used on both nodes of an HA pair,

otherwise the next takeover may not function correctly
same_required - the same value must be used on both nodes of an HA pair,
otherwise the next takeover will not function correctly
only_one - the same value should be used on both nodes of an HA pair. If the
values are different and a takeover is in progress, the value of the RAID option on
the node that is taking over will be used
unknown - no information about constraints for this RAID option
Examples
The following example shows the raid scrub settings for a node named node1:
cluster1::> storage raid-options show -node node1 -name raid.scrub*
Node
Option
Value
Constraint
-------- ------------------------------------- ------------ ----------node1
raid.scrub.duration
360
none
node1
raid.scrub.perf_impact
low
only_one
node1
raid.scrub.schedule
none
See Also
storage raid-options storage raid-options modify
1201
storage shelf show

Display a list of storage shelves
level.
Description
The storage shelf show command displays information about all the storage
shelves in the storage system. If no parameters are specified, the default command
displays the following information about the storage shelves:
Shelf Name
Shelf ID
Serial Number
Model
Module Type
Status
To display detailed profile information about a single storage shelf, use the -shelf
parameter.
Parameters
Displays the specified fields for all the storage shelves, in column style output.
| [-bay ]
Displays the following details about the disk bays in the storage shelf:
The unique positional identifier of the disk bay
Whether a disk drive is installed in the bay
Bay type
Operational status of the disk bay
| [-connectivity ]
Displays the following details about the connectivity from the node to the storage shelf:
1202
Node name
Initiator side switch port
Target side switch port
World wide port name
Target Port Group Number (TPGN)
Port speed at which the Host Bus Adapter (HBA) is running
I/O throughput in Kbytes/sec
Rate of I/O operations per second
| [-cooling ]
Displays the following details about the cooling elements and temperature sensors of
the storage shelf:
Element ID of the cooling fan
The current speed of the cooling fan in revolutions per minute (rpm)
Location of the fan in the storage shelf
Sensor ID of the temperature sensor element
Temperature at the sensor in degrees Celsius
Whether the current temperature at the sensor is the ambient temperature
Low critical threshold value for the temperature sensor
Low warning threshold value for the temperature sensor
High critical threshold value for the temperature sensor
High warning threshold value for the temperature sensor
| [-errors ]
Displays the following error status information about the storage shelves which have
errors:
Error type
Error severity
Component
Error description
1203
Corrective action
| [-module ]
Displays the following details about the I/O modules attached to the storage shelf:
Module ID
Module Part number
Serial number of the Enclosure Services Controller Electronics element
Whether monitoring is enabled on this module
Whether this module is the SAS expander master module
Whether this module is the element reporting
Status of the firmware update on the module
Version of the firmware installed on the module
Latest firmware revision
Number of times, since last boot, that this module has been swapped
Operational status of the module
Location of the module within the storage shelf
| [-port ]
Displays the following details about the storage shelf ports:
Expander phy element identifier
SAS shelf port type
World Wide Port Name of the SAS port
Negotiated physical link rate of the SAS port in Gb/s
Power status of the SAS port
Fibre Channel shelf port ID
Fibre Channel shelf port type
Fibre Channel shelf port status
| [-power ]
Displays the following details about the power supplies, voltage sensors and current
sensors of the storage shelf:
1204
Power Supply Unit (PSU) number

PSU type
PSU part number
PSU serial number
Whether the PSU can be reset via software control
Whether the auto power reset of the PSU is enabled
PSU firmware revision
Operational status of the PSU
Location of the power supply unit within the storage shelf
Voltage sensor number
Voltage detected by the voltage sensor, in volts (V)
Operational status of the voltage sensor
Location of the voltage sensor within the storage shelf
Current sensor number
Current detected by the current sensor, in milliamps (mA)
Operational status of the current sensor
Location of the current sensor within the storage shelf
| [-instance ] }
Displays expanded information about all the storage shelves in the system. If a storage
shelf is specified, then this parameter displays the same detailed information for the
storage shelf you specify as does the -shelf parameter.
Displays information only about the storage shelves that are attached to the node you
specify.
[-shelf <text>] - Shelf Name
Displays information only about the storage shelves that match the names you specify.
[-shelf-uid <text>] - Shelf UID
Displays information only about the storage shelf that matches the shelf UID you
specify. Example: 50:05:0c:c0:02:10:64:26
1205
[-stack-id {<integer>|-}] - Stack ID

Displays information only about the storage shelves that are attached to the stack that
matches the stack ID you specify
[-shelf-id <text>] - Shelf ID
Displays information only about the storage shelves that match the shelf ID you specify.
[-module-type {unknown|atfcx|esh4|iom3|iom6|iom6e}] - Shelf Module Type
Displays information only about the storage shelves that match the module-type you
specify.
[-connection-type {unknown|fc|sas}] - Shelf Connection Type
Displays information only about the storage shelves that match the connection type you
specify. Example: FC or SAS.
[-is-local-attach {true|false}] - Is the Shelf Local to This Cluster?
Displays information only about the storage shelves that are local (TRUE) or remote
(FALSE) to this cluster.
[-vendor <text>] - Shelf Vendor
Displays information only about the storage shelves that match the vendor you specify.
[-product-id <text>] - Shelf Product Identification
Displays information only about the storage shelves that match the product ID you
specify.
[-serial-number <text>] - Shelf Serial Number
Displays information only about the storage shelf that matches the serial number you
specify.
[-disk-count {<integer>|-}] - Disk Count
Displays information only about the storage shelves that have the disk count you
specify.
[-state {unknown|no-status|init-required|online|offline|missing}] - Shelf State
Displays information only about the storage shelves that are in the state you specify.
[-op-status {unknown|normal|warning|error|critical}] - Shelf Operational Status
Displays information only about the storage shelves that are currently operating under
the status condition you specify.
[-bay-id {<integer>|-}, ...] - Bay ID
1206
Displays information only about the storage shelves that have bays that match the bay
ID you specify.
[-bay-type {unknown|single-disk|multi-lun}, ...] - Bay Type
Displays information only about the storage shelves that have bays that match the type
of bay you specify.
[-bay-has-disk {true|false}, ...] - Bay Has Disk
Displays information only about the storage shelves that have bays with disk drives
inserted in them (true) or empty bays (false).
[-bay-op-status {unknown|normal|error}, ...] - Bay Operational Status
Displays information only about the storage shelves that have bays that match the
operational state you specify.
[-controller {<nodename>|local}, ...] - Controller Name
Displays information only about the storage shelves that are connected to the node you
specify.
[-initiator <text>, ...] - Initiator
Displays information only about the storage shelves that are visible to the initiator you
specify.
[-initiator-side-switch-port <text>, ...] - Initiator Side Switch Port
Displays information only about the storage shelves that are visible to an initiator
connected to the switch port you specify.
[-target-side-switch-port <text>, ...] - Target Side Switch Port
Displays information only about the storage shelves visible on target ports identified by
the switch port to which they are connected.
[-target-port <text>, ...] - Target Port
Displays information only about the storage shelves visible on the specified target ports
identified by their World Wide Port Name (WWPN).
[-tpgn {<integer>|-}, ...] - Target Port Group Number
Displays information only about the storage shelves that belong to the Target Port Group
Name (TPGN) you specify.
[-port-speed {<integer>|-}, ...] - Port Speed
Displays information only about the storage shelves with ports that match the port speed
you specify.
1207
[-io-kbps {<integer>|-}, ...] - Kbytes/sec on storage shelf

Displays information only about the storage shelves visible to an initiator that has
executed I/O at the throughput you specify.
[-iops {<integer>|-}, ...] - Number IOPS per second on storage shelf
Displays information only about the storage shelves visible to an initiator that has
executed the number of IOPs you specify.
[-current-sensor-id {<integer>|-}, ...] - Current Sensor ID
Displays information only about the storage shelves with current sensor that matches
the current sensor ID you specify.
[-current-sensor-location <text>, ...] - Current Sensor Location
Displays information only about the storage shelves with current sensors installed at the
location you specify.
[-current-sensor-reading {<integer>|-}, ...] - Current Sensor Reading
Displays information only about the storage shelves with current sensors that match the
current reading you specify.
[-current-op-status {unknown|normal|over-current-critical|under-current-critical}, ...] Operational Status
Displays information only about the storage shelves with current sensors that match the
[-fan-id {<integer>|-}, ...] - Fan ID
Displays information only about the storage shelves with a cooling fans that match the
fan IDs you specify.
[-fan-location <text>, ...] - Fan Location
Displays information only about the storage shelves with cooling fans installed.
[-fan-rpm {<integer>|-}, ...] - Fan Rotation Per Minute
Displays information only about the storage shelves with cooling fans that match the
rpm you specify.
[-fan-op-status {unknown|normal|off|error}, ...] - Fan Operational Status
Displays information only about the storage shelves with cooling fans that match the
[-module-id <text>, ...] - Module ID
1208
Displays information only about the storage shelves with an I/O module that matches
the module ID you specify.
[-module-location <text>, ...] - Module Location
Displays information only about the storage shelves with I/O modules in the specified
shelf module slots.
[-module-part-number <text>, ...] - Module Part Number
Displays information only about the storage shelves with I/O modules that match the
module part numbers you specify.
[-is-sas-master-module {true|false}, ...] - Is SAS Expander Master Module?
Displays information only about the storage shelves with a SAS master I/O module
(true) or an I/O module that is not a SAS master (false). This parameter applies only to
SAS shelves.
[-is-monitor-active {true|false}, ...] - Is Monitor Active?
Displays information only about the storage shelves whose monitoring is enabled (true)
or disabled (false).
[-enclosure-type <text>, ...] - Module Enclosure Type
Displays information only about the storage shelves that match the enclosure types you
specify.
[-es-serial-number <text>, ...] - ES Electronics Element Serial Number
electronics serial numbers you specify.
[-module-fru-id <text>, ...] - Field Replaceable Unit ID
field replaceable unit (FRU) IDs you specify.
[-module-is-reporting-element {true|false}, ...] - Is Reporting Element?
Displays information only about the storage shelves with element reporting I/O modules
(true) or not (false).
[-module-fw-revision <text>, ...] - Firmware Revision
firmware revision you specify.
[-module-latest-fw-revision <text>, ...] - Latest Firmware Revision
1209
latest firmware revision you specify.
[-module-fw-progress {not-available|ready|in-progress|failed}, ...] - Module Firmware
Progress
specified firmware update progress.
[-module-swap-count {<integer>|-}, ...] - Module Swap Count
Displays information only about the storage shelves whose I/O modules have been
swapped the specified number of times.
[-module-op-status {unknown|normal|warning|error}, ...] - Module Operational Status
[-sas-port-id <text>, ...] - Port ID
Displays information only about the storage shelves with SAS Ports that match the port
IDs you specify.
[-sas-port-type {unknown|circle|square|sil|disk|in|out|unused|aux1|aux2|hi_ho|a_to_b|
b_to_a}, ...] - Port Type
Displays information only about the storage shelves with SAS Ports that match the SAS
port type you specify.
[-sas-port-wwpn <text>, ...] - Port World Wide Port Name
Displays information only about the storage shelves with SAS Ports that match the
World Wide Port Names you specify.
[-sas-port-speed <text>, ...] - Port Speed
Displays information only about the storage shelves with SAS Ports that match the port
speed you specify.
[-sas-negotiated-port-speed <text>, ...] - Negotiated Port Speed
negotiated port speed you specify.
[-sas-port-power-status <text>, ...] - Port Power Status
power status you specify.
[-sas-port-op-status {error|normal|off|unknown|byp-bad-term|bad-zone-recovery|
byp_clk_thr|byp_comma_los|byp_crc_brst_thr|byp_data_timeout|byp_drv_fault|
1210
byp_drv_pcycle|byp_drv_pwr|byp_drv_self|byp_gen|byp_init|byp_lip_brst_thr|
byp_lip_f8|byp_lip_rate_thr|byp_lipf7|byp_ltbi|byp_man|byp_no_drive|byp_osc|
byp_other_thr|byp_rec_los|byp_rport|byp_stall_thr|byp_wrd_brst_thr|byp_wrd_rate_thr|
byp_xmit_fault|diag_transmit|inserted|loopback|status_unknown|warn_high_clk_delta|
warn_high_crc_rate|warn_high_lip|warn_high_wrd_rate|term|phy_dis_clk_fault|
phy_dis_crc_err|phy_dis_crc_err_burst|phy_dis_disparity|phy_dis_disparity_burst|
phy_dis_emulate_reserve|phy_dis_inval_dword|phy_dis_inval_dword_burst|
phy_dis_loss_dword|phy_dis_loss_dword_burst|phy_dis_man_smp|phy_dis_manual|
phy_dis_mirrored|phy_dis_no_drive|phy_dis_phy_change|phy_dis_phy_change_burst|
phy_dis_phy_reset|phy_dis_phy_reset_burst|phy_dis_phy_unused|phy_ena|
phy_ena_not_attach|phy_ena_unknown|phy_unknown}, ...] - Port Operational Status
operational status you specify. Displays information only about the storage shelves with
SAS Ports that match the operational status you specify.
[-fc-port-id <text>, ...] - Fibre Channel Port ID
Displays information only about the storage shelves with FC Ports that match the port
IDs you specify.
[-fc-port-mode {unknown|circle|square|sil|disk|in|out|unused|aux1|aux2|hi_ho|a_to_b|
b_to_a}, ...] - Fibre Channel Port Mode
Displays information only about the storage shelves with FC Ports that match the port
modes you specify.
[-fc-port-op-status {error|normal|off|unknown|byp-bad-term|bad-zone-recovery|
byp_clk_thr|byp_comma_los|byp_crc_brst_thr|byp_data_timeout|byp_drv_fault|
byp_drv_pcycle|byp_drv_pwr|byp_drv_self|byp_gen|byp_init|byp_lip_brst_thr|
byp_lip_f8|byp_lip_rate_thr|byp_lipf7|byp_ltbi|byp_man|byp_no_drive|byp_osc|
byp_other_thr|byp_rec_los|byp_rport|byp_stall_thr|byp_wrd_brst_thr|byp_wrd_rate_thr|
byp_xmit_fault|diag_transmit|inserted|loopback|status_unknown|warn_high_clk_delta|
warn_high_crc_rate|warn_high_lip|warn_high_wrd_rate|term|phy_dis_clk_fault|
phy_dis_crc_err|phy_dis_crc_err_burst|phy_dis_disparity|phy_dis_disparity_burst|
phy_dis_emulate_reserve|phy_dis_inval_dword|phy_dis_inval_dword_burst|
phy_dis_loss_dword|phy_dis_loss_dword_burst|phy_dis_man_smp|phy_dis_manual|
phy_dis_mirrored|phy_dis_no_drive|phy_dis_phy_change|phy_dis_phy_change_burst|
phy_dis_phy_reset|phy_dis_phy_reset_burst|phy_dis_phy_unused|phy_ena|
phy_ena_not_attach|phy_ena_unknown|phy_unknown}, ...] - Fibre Channel Port
Operational Status
Displays information only about the storage shelves with FC Ports that match the
[-psu-id {<integer>|-}, ...] - Power Supply Unit ID
1211
Displays information only about the storage shelves with power supply units (PSU) that
match the unit IDs you specify.
[-psu-location <text>, ...] - Power Supply Unit Location
Displays information only about the storage shelves with PSUs that are located at the
specified location inside the shelf.
[-psu-type <text>, ...] - Power Supply Unit Type
Displays information only about the storage shelves with PSUs that match the PSU
types you specify.
[-psu-part-number <text>, ...] - Power Supply Unit Part Number
Displays information only about the storage shelves with PSUs that match the PSU part
number you specify.
[-psu-serial-number <text>, ...] - Power Supply Unit Serial Number
Displays information only about the storage shelves with PSUs that match the PSU
[-psu-reset-capable {true|false}, ...] - Power Supply Unit Reset Capability
Displays information only about the storage shelves with reset capable PSUs (true) or
reset incapable PSUs (false).
[-psu-is-enabled {true|false}, ...] - Power Supply Unit Enable/Disable Status
Displays information only about the storage shelves with PSUs that are enabled (true) or
disabled (false).
[-psu-fw-version <text>, ...] - Power Supply Unit Firmware Version
Displays information only about the storage shelves with PSUs that have the firmware
[-psu-op-status {unknown|normal|error|dc-over-voltage|dc-under-voltage|dc-overcurrent|over-temperature-error|failed|off}, ...] - Operational Status
Displays information only about the storage shelves with PSUs that match the
[-temp-sensor-id {<integer>|-}, ...] - Sensor Name
Displays information only about the storage shelves with temperature sensors that
match the sensor IDs you specify.
[-temp-sensor-location <text>, ...] - Sensor Location
1212
match the specified sensor locations inside the shelf.
[-temp-sensor-reading {<integer>|-}, ...] - Temperature Reading
match the temperature reading you specify.
[-temp-is-ambient {true|false}, ...] - Temperature Reading at Ambient Value
Displays information only about the storage shelves with temperature sensors whose
current temperature reading is ambient (true) or not (false).
[-temp-high-critical-threshold {<integer>|-}, ...] - High Critical Threshold
match the high critical threshold you specify.
[-temp-high-warning-threshold {<integer>|-}, ...] - High Warning Threshold
match the high warning threshold you specify.
[-temp-low-warning-threshold {<integer>|-}, ...] - Low Warning Threshold
match the low warning threshold you specify.
[-temp-low-critical-threshold {<integer>|-}, ...] - Low Critical Threshold
match the low critical threshold you specify.
[-temp-op-status {unknown|normal|under-temperature|over-temperature}, ...] Operational Status
match the operational status you specify.
[-voltage-sensor-id {<integer>|-}, ...] - Voltage Sensor ID
Displays information only about the storage shelves with voltage sensors that match
the sensor IDs you specify.
[-voltage-sensor-location <text>, ...] - Voltage Sensor Location
the specified sensor locations inside the shelf.
[-voltage-sensor-reading <text>, ...] - Voltage Current Reading
1213
the voltage reading you specify.
[-voltage-op-status {unknown|normal|over-voltage-critical|under-voltage-critical}, ...] Operational Status
the operational status you specify.
[-error-type {unknown|acpp|bay|configuration|current|disk|internal|fan|module|port|
power|temperature|voltage}, ...] - Error Type
Displays information only about the storage shelves with errors that match the error type
you specify.
[-error-severity {unknown|notice|warning|error|critical}, ...] - Error Severity
Displays information only about the storage shelves with errors that match the error
severity you specify.
Examples
The following example displays information about all storage shelves:
cluster1::> storage shelf show
Module
Operational
Shelf Name
Shelf ID
Serial Number
Model
Type
---------------------------
--------
---------------
-----------
------
Status
1.1
6000270148
DS2246
IOM6
Critical
1.3
6000001183
DS2246
IOM6
Normal
1.4
6000003844
DS2246
IOM6
Normal
1.5
SHJ000000013A9E
DS4246
IOM6
Normal
1.6
SHJ000000013A84
DS4246
IOM6
Normal
1.7
6000005555
DS2246
IOM6
Normal
2.1
OPS4417021829F0
DS14-Mk2-AT
AT-FCX
Critical
3.2
OPS65200218EF42
DS14-Mk2-AT
AT-FCX
Normal
4.8
OPS6773421015EF
DS14-Mk4-FC
ESH4
Normal

cluster1::>
1214
The following example displays expanded information about a storage shelf named 3.2:
cluster1::> storage shelf show -shelf 3.2 -instance
Shelf Name: 3.2
Stack ID: 3
Shelf ID: 2
Shelf UID: 50:05:0c:c0:02:18:ef:42
Serial Number: OPS65200218EF42
Module Type: AT-FCX
Model: DS14-Mk2-AT
Shelf Vendor: XYRATEX
Disk Count: 14
Connection Type: FC
Shelf State: Online
Status: Normal
Paths:
Controller
Initiator
Switch Port
Target Port

TPGN
Speed I/O KB/s
------------------ --------- --------------------------------------------------- ------------------ ------ -------------
Target Side
IOPS
stsw-3270-01
N/A
0a
stsw-3270-01
N/A
0b
stsw-3270-02
N/A
0c
stsw-3270-02
N/A
0d
--------
N/A
-
- Gb/s
N/A
-
N/A
-
- Gb/s
N/A
-
N/A
-
- Gb/s
N/A
-
N/A
-
- Gb/s
N/A
-
Errors:
-----cluster1::>
The following example displays information about the power supplies, voltage sensors
and current sensors of the storage shelf 3.2:
1215
cluster1::> storage shelf show -shelf 3.2 -power

Shelf Name: 2.1
Stack ID: 2
Shelf ID: 1
Shelf UID: 50:05:0c:c0:02:18:29:f0
Serial Number: OPS4417021829F0
Module Type: AT-FCX
Model: DS14-Mk2-AT
Disk Count: 14
Connection Type: FC
Shelf State: Online
Status: Critical
Power Supply Units:
Reset
Reset
Capable
Enabled
Firmware
-------
-------
--------
false
true
020F
9C 114-00065+A0 XXT114889562
false
rear of the shelf at the bottom right
true
020F
Operational
PSU #
Status
PSU
Type Part#
Location
Serial#
----- ---- ------------ ------------------------- -----------------------1

9C 114-00065+A0 XXT114889534
rear of the shelf at the bottom left
2
normal
off
Voltage Sensors:
Voltage
Operational
Sensor
Sensor #
Reading
Status
Location
--------
---------
---------------
------------------------
1
power supply
5.70 V
normal
rear of the shelf on the lower left
2
power supply
12.300 V
normal
3
power supply
5.70 V
normal
rear of the shelf on the lower right
4
power supply
12.300 V
normal
Current Sensors:
1216
Current
Operational
Sensor
Sensor #
Reading
Status
Location
--------
--------
---------------
------------------------
1
power supply
0 mA
normal
2
power supply
0 mA
normal
3
power supply
0 mA
normal
4
power supply
0 mA
normal
Errors:
-----Critical condition is detected in storage shelf power supply unit "1". The
unit might fail.
Critical over temperature failure for temperature sensor "1". Current
temperature: "75" C ("167" F).
cluster1::>
The following example displays information about the cooling elements and temperature
sensors inside the storage shelf 3.2:
cluster1::> storage shelf show -shelf 3.2 -cooling
Shelf Name: 3.2
Stack ID: 3
Shelf ID: 2
Shelf UID: 50:05:0c:c0:02:18:ef:42
Module Type: AT-FCX
Model: DS14-Mk2-AT
Disk Count: 14
Connection Type: FC
Shelf State: Online
Status: Normal
Fans:
Operational
Fan
Fan #
Fan Speed
Status
Location
-----
---------
-------------
----------------------
- RPM
normal
N/A
- RPM
normal
N/A
1217
Temperature:
Temp.
Sensor
Low
Low
High
High
Critical
Warning
Critical
Warning
-------- ------- -------- ------------------ ------------------------
-------
--------
-------
Operational
Sensor #
Location
Reading
Ambient
Status
29 C
true
10
50
40
normal
39 C
false
10
63
53
normal
41 C
false
10
63
53
normal
N/A
N/A
N/A
Errors:
-----cluster1::>
The following example displays information about the connectivity from the node to the
storage shelf 3.2:
cluster1::> storage shelf show -shelf 3.2 -connectivity
Shelf Name: 3.2
Stack ID: 3
Shelf ID: 2
Shelf UID: 50:05:0c:c0:02:18:ef:42
Module Type: AT-FCX
Model: DS14-Mk2-AT
Disk Count: 14
Connection Type: FC
Shelf State: Online
Status: Normal
Paths:
Controller
Initiator
Switch Port
Target Port
1218

TPGN
Speed I/O KB/s
Target Side
IOPS
------------------ --------- --------------------------------------------------- ------------------ ------ ------------stsw-3270-01

N/A
0a
stsw-3270-01
N/A
0b
stsw-3270-02
N/A
0c
stsw-3270-02
N/A
0d
--------
N/A
-
- Gb/s
N/A
-
N/A
-
- Gb/s
N/A
-
N/A
-
- Gb/s
N/A
-
N/A
-
- Gb/s
N/A
-
Errors:
-----cluster1::>
The following example displays information about the disk bays of the storage shelf 3.2:
cluster1::> storage shelf show -shelf 3.2 -bay
Shelf Name: 3.2
Stack ID: 3
Shelf ID: 2
Shelf UID: 50:05:0c:c0:02:18:ef:42
Module Type: AT-FCX
Model: DS14-Mk2-AT
Disk Count: 14
Connection Type: FC
Shelf State: Online
Status: Normal
Bays:
---Bay
ID
Has
Operational
Disk
Bay Type
Status
-----
-----------
-----------
true
single-disk
normal
true
single-disk
normal
---
1219
true
single-disk
normal
true
single-disk
normal
true
single-disk
normal
true
single-disk
normal
true
single-disk
normal
true
single-disk
normal
true
single-disk
normal
true
single-disk
normal
10
true
single-disk
normal
11
true
single-disk
normal
12
true
single-disk
normal
13
true
single-disk
normal
Errors:
-----cluster1::>
The following example displays information about the ports of the storage shelf 3.2:
cluster1::> storage shelf show -shelf 3.2 -port
Shelf Name: 3.2
Stack ID: 3
Shelf ID: 2
Shelf UID: 50:05:0c:c0:02:18:ef:42
Module Type: AT-FCX
Model: DS14-Mk2-AT
Disk Count: 14
Connection Type: FC
Shelf State: Online
Status: Normal
SAS Ports:
Negotiated
1220
Power
Phy # Port Type

Port Status
WWPN
Port Speed
Port Speed
Status
------ -------------------
-----------------------
----------
----------
------
FC Ports:
Port
ID #
Port Type
Status
------
---------
-----------
32
Disk
Normal
33
Disk
Normal
34
Disk
Normal
35
Disk
Normal
36
Disk
Normal
37
Disk
Normal
38
Disk
Normal
39
Disk
Normal
40
Disk
Normal
41
Disk
Normal
42
Disk
Normal
43
Disk
Normal
44
Disk
Normal
45
Disk
Normal
Hi-Ho
Error
A-to-B
Error
Errors:
-----cluster1::>
The following example displays error information about the storage shelves that have
errors:
cluster1::> storage shelf show -errors
Shelf Name: 1.1
Shelf UID: 50:0a:09:80:00:91:ce:e9
1221
Serial Number: 6000270148

Error Type
Description
------------------
---------------------------
Power
Critical condition is detected in storage shelf power
supply unit "1". The unit might fail.
Temperature
Critical over temperature failure for temperature sensor
"1". Current temperature: "75" C ("167" F).
Shelf Name: 2.1

Shelf UID: 50:05:0c:c0:02:18:29:f0
Serial Number: OPS4417021829F0
Error Type
Description
------------------
---------------------------
Fan
Error detected in cooling fan "2". Fan is located in "N/
Fan
Error detected in cooling fan "1". Fan is located in "N/
A".
A".
cluster1::>
1222
storage switch add

Add a switch for monitoring
level.
Description
The storage switch add command enables you to add FC switches for SNMP
monitoring in a MetroCluster configuration.
Parameters
-switch-ipaddress <IP Address> - FC Switch Management IP Address
This parameter specifies the IP address of the switch that is being added for monitoring.
This parameter specifies the SNMP community set on the switch that is being added for
monitoring.
[-veto-backend-fabric-check {true|false}] - Veto Backend Fabric Check? (privilege:
advanced)
If specified, the storage switch add command will not check if the switch is present
in the MetroCluster's backend fabric. By default, it does not let you add switches that are
not present.
Examples
The following command adds a switch with IP Address '10.226.197.34' for monitoring:
cluster1::> storage switch add -switch-ipaddress 10.226.197.34 -snmpcommunity public
cluster1::> storage switch show
Symbolic
Switch
Name
Is
Vendor
Model
Switch WWN
Monitor
Monitored Status
----------- -------- ------- ---------- ---------------- --------- ------Cisco_10.226.197.34

mcc-cisco-8Gb-fab-4
Cisco
DS-C9148-16P-K9
2000547fee78f088 true
ok
1223
mcc-cisco-8Gb-fab-1
mcc-cisco-8Gb-fab-1
Cisco
false
false
false
mcc-cisco-8Gb-fab-2
mcc-cisco-8Gb-fab-2
Cisco
mcc-cisco-8Gb-fab-3
mcc-cisco-8Gb-fab-3
Cisco

cluster1::>
1224
storage switch modify

Modify information about a switch's configuration
level.
Description
The storage switch modify enables you to modify certain parameters for
identifying and accessing the FC switches added for monitoring in a MetroCluster
configuration.
Parameters
-switch-name <text> - FC Switch Name
This parameter specifies the name of the switch.
[-switch-ipaddress <IP Address>] - Switch Ip Address
This parameter specifies the IP address of the switch.
This parameter specifies the SNMP community set on the switch.
Examples
The following command modifies 'Cisco_10.226.197.34' switch SNMP community to
'public':
Symbolic
Switch
Name
Is
Vendor
Model
Switch WWN
Monitor
Monitored Status
----------- -------- ------- ---------- ---------------- --------- ------Cisco_10.226.197.34

mcc-cisco-8Gb-fab-4
Cisco
DS-C9148-16P-K9
2000547fee78f088 true
ok
mcc-cisco-8Gb-fab-1
mcc-cisco-8Gb-fab-1
Cisco
false
mcc-cisco-8Gb-fab-2
1225
mcc-cisco-8Gb-fab-2
Cisco
false
false
mcc-cisco-8Gb-fab-3
mcc-cisco-8Gb-fab-3
Cisco

cluster1::> storage switch modify -switch-name Cisco_10.226.197.34 -switchipaddress 10.226.197.34 -snmp-community public
cluster1::>
1226
storage switch refresh

Refresh storage switch info
privilege level.
Description
The storage switch refresh command triggers a refresh of the SNMP data for
the MetroCluster FC switches and FC-to-SAS bridges. It does not do anything if the
refresh is already going on. The FC switches and FC-to-SAS bridges must have been
previously added for monitoring by using the storage switch add and storage
bridge add commands respectectively.
Parameters
None
Examples
The following command triggers a refresh for the SNMP data:
cluster1::*> storage switch refresh
cluster1::*>
See Also
storage switch add storage bridge add
1227
storage switch remove

Remove a switch from monitoring
level.
Description
The storage switch remove enables you to remove FC switches that were
previously added for SNMP monitoring.
Parameters
-switch-name <text> - FC Switch Name
This parameter specifies the name of the switch added for monitoring.
Examples
The following command removes 'Cisco_10.226.197.34' switch from monitoring:
Symbolic
Switch
Name
Is
Vendor
Model
Switch WWN
Monitor
Monitored Status
----------- -------- ------- ---------- ---------------- --------- ------Cisco_10.226.197.34

mcc-cisco-8Gb-fab-4
Cisco
DS-C9148-16P-K9
2000547fee78f088 true
ok
false
false
false
mcc-cisco-8Gb-fab-1
mcc-cisco-8Gb-fab-1
Cisco
mcc-cisco-8Gb-fab-2
mcc-cisco-8Gb-fab-2
Cisco
mcc-cisco-8Gb-fab-3
mcc-cisco-8Gb-fab-3
Cisco

cluster1::> storage switch remove -switch-name Cisco_10.226.197.34
1228

Symbolic
Switch
Name
Is
Vendor
Model
Switch WWN
Monitor
Monitored Status
----------- -------- ------- ---------- ---------------- --------- ------mcc-cisco-8Gb-fab-4

mcc-cisco-8Gb-fab-4
Cisco
-
false
false
false
false
mcc-cisco-8Gb-fab-1
mcc-cisco-8Gb-fab-1
Cisco
mcc-cisco-8Gb-fab-2
mcc-cisco-8Gb-fab-2
Cisco
mcc-cisco-8Gb-fab-3
mcc-cisco-8Gb-fab-3
Cisco
4 entries were displayed

cluster1::>
1229
storage switch show

Display switch information
level.
Description
The storage switch show command displays information about all the storage
switches in the MetroCluster configuration. The switches must have been previously
added for monitoring using the storage switch add command. If no parameters
are specified, the default command displays the following information about the storage
switches:
Switch
Symbolic Name
Vendor
Model
Switch WWN
Is Monitored
Monitor Status
To display detailed profile information about a single storage switch, use the -switchname parameter.
Parameters
Displays the specified fields for all the storage switches, in column style output.
| [-connectivity ]
Displays the following details about the connectivity from the storage switch to
connected entities:
Port name
Port operating mode
Port world wide name
1230
Peer port world wide name

Peer type
Additional information about peer
Displays the following details about the connectivity from the node to the storage switch:
Node name
Adapter name
Switch port name
Switch port speed
Adapter type
| [-cooling ]
Displays the following details about the fans and temperature sensors on the storage
switch:
Fan name
Fan speed in rotations per minute (RPM)
Fan operational status
Temperature sensor name
Temperature sensor reading in Celsius (C)
Temperature sensor status
| [-error ]
Displays the errors related to the storage switch.
| [-port ]
Displays the following details about the storage switch ports:
Port name
Port world wide name
Port operating mode
Whether SFP is present in the port
1231
Port speed in gigabits per second (Gbps)

Port BB credit
Peer port world wide name
| [-power ]
Displays the following details about the storage switch power supplies:
Power supply name
Power supply serial number
Power supply operational status
| [-san-config ]
Displays the following details about the Virutal Storage Area Networks (VSAN) and
Zones of the storage switch:
VSAN identifier
VSAN name
VSAN operational status
Type of load balancing configured for the VSAN
Where in-order-delivery set for the VSAN
Whether the auto power reset of the PSU is enabled
VAN member switch name and port
Zone name
VSAN ID of the zone
Zone member switch name and port
Zone member port id
Zone member port world wide name
| [-sfp ]
Displays the following details about the storage switch ports Small Formfactor Pluggable
(SFP):
Port name
Type of SFP
1232
SFP transmitter type

SFP vendor
SFP part number
SFP serial number
| [-stats ]
Displays the following details about the storage switch ports:
Port name
Frames received through the port (Rx Frames)
Frames transmitted through the port (Tx Frames)
Octets received through the port (Rx Octets)
Octets transmitted through the port (Tx Octets)
Port error frames
| [-instance ] }
Displays expanded information about all the storage switches in the system. If a storage
switch is specified, then this parameter displays the same detailed information for the
storage switch you specify as does the -switch-name parameter.
[-switch-name <text>] - FC Switch Name
Displays information only about the storage switches that match the name you specify.
[-switch-wwn <text>] - Switch World Wide Name
Displays information only about the storage switches that match the switch wwn you
specify.
[-switch-symbolic-name <text>] - Switch Symbolic Name
Displays information only about the storage switches that match the switch symbolic
name you specify.
[-switch-fabric-name <text>] - Fabric Name
Displays information only about the storage switches that match the switch fabric you
specify.
[-domain-id <integer>] - Switch Domain ID
Displays information only about the storage switches that match the switch domain id
you specify.
1233
[-switch-role {unknown|primary|subordinate}] - Switch Role in Fabric

Displays information only about the storage switches that match the switch role you
specify.
[-snmp-version {SNMPv1|SNMPv2c}] - Supported SNMP Version
Displays information only about the storage switches that match the switch SNMP
[-switch-model <text>] - Switch Model
Displays information only about the storage switches that match the switch model you
specify.
[-switch-vendor {unknown|Brocade|Cisco}] - Switch Vendor
Displays information only about the storage switches that match the switch vendor you
specify.
[-fw-version <text>] - Switch Firmware Version
Displays information only about the storage switches that match the switch firmware
[-serial-number <text>] - Switch Serial Number
Displays information only about the storage switches that match the switch serial
number you specify.
[-switch-ipaddress <IP Address>] - Switch Ip Address
Displays information only about the storage switches that match the switch IP address
you specify.
[-switch-status {unknown|ok|error}] - Switch Status
Displays information only about the storage switches that match the switch status you
specify.
Displays information only about the storage switches that match the switch SNMP
community you specify.
[-profile-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Switch Profile Data Last Successful Refresh Timestamp
Displays information only about the storage switches that match the profile data last
[-is-monitoring-enabled {true|false}] - Is Monitoring Enabled for Switch
1234
Displays information only about the storage switches that match the switch monitoring
value you specify.
[-psu-name-list <text>, ...] - Switch Power Supply Name List
Displays information only about the storage switches that have the power supply units
with the names you specify.
[-psu-serial-number-list <text>, ...] - Switch Power Supply Serial Number List
with the serial numbers you specify.
[-psu-status-list {unknown|normal|warning|faulty|not-present}, ...] - Switch Power
Supply Status List
with the statuses you specify.
[-psu-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Switch Power Supply Data Last Successful Refresh Timestamp
Displays information only about the storage switches that match the power supply unit
[-temp-sensor-name-list <text>, ...] - Switch Temperature Sensor Name List
Displays information only about the storage switches that have the temperature sensors
with the names you specify.Displays information only about the storage switches that
have the temperature sensors with the names you specify.Displays information only
about the storage switches that have the temperature sensors with the names you
specify.
[-temp-sensor-reading-list <integer>, ...] - Switch Temperature Sensor Reading (C)
List
with the readings you specify.
[-temp-sensor-status-list {unknown|normal|warning|critical}, ...] - Switch Temperature
Sensor Status List
with the statuses you specify.
[-temp-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Switch Temperature Sensor Data Last Successful Refresh Timestamp
Displays information only about the storage switches that match the temperature sensor
1235
[-fan-name-list <text>, ...] - Switch Fan Name List

Displays information only about the storage switches that match the fans with the names
you specify.
[-fan-rpm-list <integer>, ...] - Switch Fan Speed (RPM) List
Displays information only about the storage switches that match the fans with the RPM
speeds you specify.
[-fan-status-list {unknown|operational|failed|not-operational|not-present}, ...] - Switch
Fan Operational Status List
Displays information only about the storage switches that match the fans with the
statuses you specify.
[-fan-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Switch Fan Data Last Successful Refresh Timestamp
Displays information only about the storage switches that match the fan data last
[-vsan-index-list <integer>, ...] - Switch VSAN Index List
Displays information only about the storage switches that have the VSANs with the
[-vsan-name-list <text>, ...] - Switch VSAN Name List
names you specify.
[-vsan-oper-status-list {up|down}, ...] - Switch VSAN Operational Status List
operational statuses you specify.
[-vsan-load-balancing-type-list {src-id-dest-id|src-id-dest-id-ox-id}, ...] - Switch VSAN
Load balancing Type List
Displays information only about the storage switches that have the VSANs with the load
balancing types you specify.
[-is-vsan-iod-list {true|false}, ...] - Is In-order Delivery Set for VSAN List
Displays information only about the storage switches that have the VSANs with the IOD
setting you specify.
[-vsan-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Switch VSAN Data Last Successful Refresh Timestamp
1236
Displays information only about the storage switches that match the VSAN data last
[-member-switch-name-list <text>, ...] - Member Switch List
member switch names you specify.
[-member-switch-port-name-list <text>, ...] - Member Switch Port Name List
memeber switch port names you specify.
[-vsan-id-list <integer>, ...] - Zone VSAN ID List
Displays information only about the storage switches that have the VSANs with the IDs
you specify.
[-zone-name-list <text>, ...] - Switch Zone Name List
Displays information only about the storage switches that have the zones with the
names you specify.
[-zone-member-sw-domain-id-list <integer>, ...] - Zone Member Switch Port Domain
ID List
member switch domain ids you specify.
[-zone-member-port-name-list <text>, ...] - Zone Member Port List
Displays information only about the storage switches that have the zones with the port
names you specify.
[-zone-member-port-wwn-list <text>, ...] - Zone Member WWPN List
Displays information only about the storage switches that have the zones with the port
WWNs you specify.
[-zone-member-port-switch-name-list <text>, ...] - Zone Member Switch WWN List
member port hosting switch names you specify.
[-zone-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Switch Zone Data Last Successful Refresh Timestamp
Displays information only about the storage switches that match the zone data last
[-zone-member-wwn-list <text>, ...] - Zone Member WWN List
1237
member WWNs you specify.
[-zone-member-port-id-list <text>, ...] - Zone Member Port ID List
member port ids you specify.
[-port-wwn-list <text>, ...] - Switch Port World Wide Name (WWPN) List
Displays information only about the storage switches that have the ports with the WWNs
you specify.
[-port-name-list <text>, ...] - Switch Port Name List
Displays information only about the storage switches that have the ports with the names
you specify.
[-port-admin-status-list {unknown|enabled|disabled}, ...] - Switch Port Admin Status
List
Displays information only about the storage switches that have the ports with
administrative statuses you specify.
[-port-oper-status-list {unknown|online|offline}, ...] - Switch Port Operational Status List
Displays information only about the storage switches that have the ports with
operational statuses you specify.
[-port-mode-list {unknown|auto|F-port|FL-port|E-port|TE-port|U-port|G-port}, ...] Switch Port Mode List
Displays information only about the storage switches that have the ports with the
operating modes you specify.
[-port-oper-speed-list <integer>, ...] - Switch Port Current Speed (in Gbits/sec) List
operational speeds you specify.
[-port-bb-credit-list <integer>, ...] - Switch Port BB Credit List
Displays information only about the storage switches that have the ports with the BB
credits you specify.
[-port-sfp-present-list {true|false}, ...] - Switch Port Is SFP Present List
Displays information only about the storage switches that have the ports with the SFP
present values you specify.
[-port-peer-wwpn-list <text>, ...] - Switch Port Peer WWPN List
1238
Displays information only about the storage switches that have the ports with the peer
port WWPNs you specify.
[-port-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Switch Port Data Last Successful Refresh Timestamp
Displays information only about the storage switches that match the port data last
[-port-stat-name-list <text>, ...] - Switch Port Name List
you specify.
[-port-tx-frames-list <integer>, ...] - Switch Port Transmitted Frame Count List
transmitted frames values you specify.
[-port-rx-frames-list <integer>, ...] - Switch Port Received Frame Count List
received frames values you specify.
[-port-tx-octets-list <integer>, ...] - Switch Port Total Transmitted Octets List
transmitted octets values you specify.
[-port-rx-octets-list <integer>, ...] - Switch Port Total Received Octets List
received octets values you specify.
[-port-frame-error-list <integer>, ...] - Switch Port Frame Error Count List
Displays information only about the storage switches that have the ports with the error
frame values you specify.
[-port-stat-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Switch Port Stat Data Last Update Timestamp
Displays information only about the storage switches that match the port statistics data
[-sfp-port-name-list <text>, ...] - Switch Port Name List
you specify.
[-sfp-type-list {unknown|other|gbic|embedded|glm|gbic-with-serial-id|gbic-withoutserial-id|sfp-with-serial-id|sfp-without-serial-id|xfp|x2-short|x2-medium|x2-tall|xpak-short|
1239
xpak-medium|xpak-tall|xenpak|sfp-dw-dm|qsfp|x2-dw-dm|gbic-not-installed|small-formfactor}, ...] - Switch Port SFP Type List

types you specify.
[-sfp-tx-type-list {unknown|long-wave-laser|short-wave-laser|long-wave-laser-costreduced|electrical|ten-gig-base-sr|ten-gig-base-lr|ten-gig-base-er|ten-gig-base-lx4|tengig-base-sw|ten-gig-base-lw|ten-gig-base-ew}, ...] - Switch Port SFP Transmitter Type
List
transmitter types you specify.
[-sfp-vendor-list <text>, ...] - Switch Port SFP Vendor List
vendors you specify.
[-sfp-part-number-list <text>, ...] - Switch Port SFP Part Number List
part numbers you specify.
[-sfp-serial-number-list <text>, ...] - Switch Port SFP Serial Number List
[-sfp-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Switch Port SFP Data Last Successful Refresh Timestamp
Displays information only about the storage switches that match the port SFP data last
[-switch-error-text-list <text>, ...] - Switch Error Text List
Displays information only about the storage switches that have the errors you specify.
[-conn-switch-port-name-list <text>, ...] - Switch Port Name List
you specify.
[-conn-switch-port-mode-list {unknown|auto|F-port|FL-port|E-port|TE-port|U-port|Gport}, ...] - Switch Port Operating Mode List
operating modes you specify.
[-conn-switch-port-wwn-list <text>, ...] - Switch Port WWN List
1240
Displays information only about the storage switches that have the ports with the WWNs
you specify.
[-conn-switch-port-peer-port-wwn-list <text>, ...] - Switch Port Peer Port WWN List
port WWNs you specify.
[-conn-switch-port-peer-info-list <text>, ...] - Switch Port Peer Host & Port Name List
information values you specify.
[-conn-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Switch Connectivity Data Last Successful Refresh Timestamp
Displays information only about the storage switches that match the switch connectivity
[-conn-switch-port-peer-type-list {unknown|bridge|switch|fcp-adapter|fcvi-adapter}, ...]
- Switch Port Peer Type List
Displays information only about the storage switches that have the ports connected to
the peer types you specify.
[-switch-port-name-list <text>, ...] - Switch Port Name List
you specify.
[-switch-port-speed-list <integer>, ...] - Switch Port Speed (in Gbps) List
Displays information only about the storage switches that have the ports with the speeds
you specify.
[-node-name-list <nodename>, ...] - Node Name List
Displays information only about the storage switches that are connected to the nodes
you specify.
[-adapter-name-list <text>, ...] - Node Adapter Name List
Displays information only about the storage switches that are connected to the adapters
you specify.
[-adapter-port-name-list <text>, ...] - Node Adapter Port Name List
Displays information only about the storage switches that are connected to the adapter
ports you specify.
[-adapter-type-list {unknown|FCP-Initiator|FC-VI|FCP-Target}, ...] - Node Adapter Type
List
1241
Displays information only about the storage switches that are connected to the types of
adapters you specify.
[-path-data-last-successful-refresh-timestamp {MM/DD/YYYY HH:MM:SS
[{+|-}hh:mm]}] - Switch Path Data Last Successful Refresh Timestamp
Displays information only about the storage switches that match the node to switch path
[-name-list <text>, ...] - Switch Name List
Displays information only about the storage switches that match the names you specify.
[-domain-id-list <integer>, ...] - Switch Domain ID List
Displays information only about the storage switches that match the domain ids you
specify.
[-wwn-list <text>, ...] - Switch WWN List
Displays information only about the storage switches that match the switch WWNs you
specify.
[-role-list {unknown|primary|subordinate}, ...] - Switch Role in Fabric List
Displays information only about the storage switches that match the switch roles you
specify.
[-address-list <IP Address>, ...] - Switch IP Address List
Displays information only about the storage switches that match the switch IP addresses
you specify.
Examples
The following example displays information about all storage switches:
cluster::>storage switch show
Symbolic
Switch
Name
Is
Vendor
Model
Switch WWN
Monitor
Monitored Status
----------- -------- ------- ---------- ---------------- --------- ------Cisco_10.226.197.34

mcc-cisco-8Gb-fab-4
Cisco
DS-C9148-16P-K9
2000547fee78f088 true
ok
Cisco_10.226.197.35
mcc-cisco-8Gb-fab-3
Cisco
1242
DS-C9148-16P-K9
2000547fee78f0f0 true
ok
Cisco_10.226.197.36
mcc-cisco-8Gb-fab-2
Cisco
DS-C9148-16P-K9
2000547fee78efb0 true
ok
Cisco_10.226.197.37
mcc-cisco-8Gb-fab-1
Cisco
DS-C9148-16P-K9
2000547fee78f0d8 true
ok

cluster::>
The following example displays connectivity (switch to peer and node to switch)
information about all storage switches:
cluster::> storage switch show -connectivity
Switch Name: Cisco_10.226.197.36
Switch WWN: 2000547fee78efb0
Fabric WWN: 2001547fee78efb1
Vendor: Cisco
Model: DS-C9148-16P-K9
Errors: Last Update Time: 7/31/2014 14:16:42 -04:00
Connectivity:
Port Name Port Mode Port WWN
Peer Port WWN
Peer Type
Peer Info
--------- --------- ---------------- ---------------- ------------ --------fc1/1
F-port
2001547fee78efb0 2100001086607d34 unknown
unknown
fc1/3
F-port
2003547fee78efb0 21000024ff3dd9cb unknown
unknown
fc1/4
F-port
2004547fee78efb0 21000024ff3dda8d unknown
unknown
fc1/5
F-port
2005547fee78efb0 500a0980009af880 unknown
unknown
fc1/6
F-port
2006547fee78efb0 500a0981009af370 unknown
unknown
fc1/11
TE-port
200b547fee78efb0 200b547fee78f088 switch
Cisco_10.226.197.34:fc1/11
fc1/12
TE-port
200c547fee78efb0 200c547fee78f088 switch
Cisco_10.226.197.34:fc1/12
fc1/13
F-port
200d547fee78efb0 2100001086609e22 unknown
unknown
fc1/15
F-port
200f547fee78efb0 21000024ff3dd91b unknown
unknown
fc1/16
F-port
2010547fee78efb0 21000024ff3dbef5 unknown
unknown
1243
fc1/17
F-port
2011547fee78efb0 500a0981009afda0 unknown
unknown
fc1/18
F-port
2012547fee78efb0 500a0981009a9160 unknown
unknown
fc1/25
F-port
ATTO_10.226.197.17:1
2019547fee78efb0 21000010866037e8 bridge
fc1/27
F-port
201b547fee78efb0 21000024ff3dd9d3 fcvi-adapter dpgmcc-3240-15-a1:fcvi_device_1
fc1/28
F-port
201c547fee78efb0 21000024ff3dbe3d fcvi-adapter dpgmcc-3240-15-a2:fcvi_device_1
fc1/29
F-port
mcc-3240-15-a2:0c
201d547fee78efb0 500a0980009ae0a0 fcp-adapter
dpg-
fc1/30
F-port
mcc-3240-15-a1:0d
201e547fee78efb0 500a0981009aef40 fcp-adapter
dpg-
Last Update Time: 7/31/2014 14:26:48 -04:00

Path:
Switch
Port
Node
Adapter
Switch Port
Speed Adapter Type
-------------------- -------------- ----------- ------- -------------dpg-mcc-3240-15-a1
0d
fc1/30
4Gbps FCP-Initiator
dpg-mcc-3240-15-a1
fcvi_device_1
fc1/27
8Gbps FC-VI
dpg-mcc-3240-15-a2
0c
fc1/29
4Gbps FCP-Initiator
dpg-mcc-3240-15-a2
fcvi_device_1
fc1/28
8Gbps FC-VI
The following command displays cooling (temperature sensors and fans) information
about all storage switches:
cluster::>storage switch show -cooling
Switch WWN: 2000547fee78f088
Vendor: Cisco
Fans:
Fan
RPM Status
------------ -------- ---------------
1244
Fan Module-1
- operational
Fan Module-2
operational
Fan Module-3
operational
Fan Module-4
operational
Last Update Time: 7/31/2014 14:27:10 -04:00

Temperature Sensors:
Sensor
Temp (C) Status
--------------- -------- -------module-1 Outlet
27 normal
module-1 Outlet
29 normal
module-1 Intake
26 normal
module-1 Intake
28 normal
The following command displays the error information about all storage switches:
cluster::> storage switch show -error
------------------------------------------------------------------------------Cisco_10.226.197.34(2000547fee78f088): Switch is Unreachable over Management
Network.

Switch WWN: 2000547fee78f0f0
------------------------------------------------------------------------------Cisco_10.226.197.35(2000547fee78f0f0): Switch is Unreachable over Management
Network.

Switch WWN: 2000547fee78efb0
------------------------------------------------------------------------------Cisco_10.226.197.36(2000547fee78efb0): Switch is Unreachable over Management
Network.
1245

Switch WWN: 2000547fee78f0d8
------------------------------------------------------------------------------Cisco_10.226.197.37(2000547fee78f0d8): Switch is Unreachable over Management
Network.
The following command displays the detailed information about all the storage switches:
cluster::> storage switch show -instance
Switch Domain: Switch Role: Switch WWN: 2000547fee78f088
Vendor: Cisco
Firmware Version: 6.2(1)
Errors: Cisco_10.226.197.34(2000547fee78f088): Switch is
Unreachable over Management Network.
Last Update Time: 7/31/2014 14:41:28 -04:00
Fabric:
Switch Name
Domain WWN
Role
IP Address
--------------------------- ------ ---------------- ------------------------Cisco_10.226.197.34
0 2000547fee78f088 unknown
10.226.197.34
Cisco_10.226.197.36
0 2000547fee78efb0 unknown
10.226.197.36
The following command displays port information about all storage switches:
cluster::> storage switch show -port
1246

Vendor: Cisco
Ports:
Admin
Port Name Port WWN Status
PeerPortWWN
Oper
Status
SFP
Speed
BB
Port Mode Present (Gbps) Credit
--------- -------- -------- ------- --------- ------- ------ ---------------fc1/1
2001547fee78f088
enabled
online
F-port
true
offline auto
true
online
F-port
true
online
F-port
true
online
F-port
true
online
F-port
true
offline auto
true
offline auto
true
offline auto
true
offline auto
true
32
offline TE-port
true
32
offline TE-port
true
32
2100001086608b76
fc1/2
2002547fee78f088
fc1/3
2003547fee78f088
enabled
enabled
21000024ff48edd9
fc1/4
2004547fee78f088
enabled
21000024ff3dd981
fc1/5
2005547fee78f088
enabled
500a098001057f98
fc1/6
2006547fee78f088
enabled
500a098101069778
fc1/7
2007547fee78f088
fc1/8
2008547fee78f088
enabled
enabled
fc1/9
2009547fee78f088
fc1/10
200a547fee78f088
fc1/11
200b547fee78f088
enabled
enabled
enabled
200b547fee78efb0
fc1/12
200c547fee78f088
enabled
200c547fee78efb0
fc1/13
200d547fee78f088
1247
enabled
online
F-port
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
offline auto
true
offline auto
true
32
offline auto
true
32
offline auto
true
32
online
true
32
offline auto
true
32
online
F-port
true
32
online
F-port
true
32
online
F-port
true
32
online
F-port
true
32
true
32
2100001086609c2e
fc1/14
200e547fee78f088
fc1/15
200f547fee78f088
enabled
enabled
fc1/16
2010547fee78f088
fc1/17
2011547fee78f088
fc1/18
2012547fee78f088
fc1/19
2013547fee78f088
fc1/20
2014547fee78f088
enabled
enabled
enabled
enabled
enabled
fc1/21
2015547fee78f088
fc1/22
2016547fee78f088
fc1/23
2017547fee78f088
fc1/24
2018547fee78f088
fc1/25
2019547fee78f088
enabled
enabled
enabled
enabled
enabled
F-port
2100001086609c06
fc1/26
201a547fee78f088
enabled
fc1/27
201b547fee78f088
enabled
21000024ff48ea93
fc1/28
201c547fee78f088
enabled
21000024ff48eacf
fc1/29
201d547fee78f088
enabled
500a098101484340
fc1/30
201e547fee78f088
enabled
500a09810147e700
fc1/31
201f547fee78f088
enabled
1248
offline auto
fc1/32
2020547fee78f088
fc1/33
2021547fee78f088
fc1/34
2022547fee78f088
enabled
enabled
enabled
fc1/35
2023547fee78f088
fc1/36
2024547fee78f088
fc1/37
2025547fee78f088
fc1/38
2026547fee78f088
fc1/39
2027547fee78f088
enabled
enabled
enabled
enabled
enabled
fc1/40
2028547fee78f088
fc1/41
2029547fee78f088
fc1/42
202a547fee78f088
fc1/43
202b547fee78f088
fc1/44
202c547fee78f088
enabled
enabled
enabled
enabled
enabled
fc1/45
202d547fee78f088
fc1/46
202e547fee78f088
fc1/47
202f547fee78f088
fc1/48
2030547fee78f088
enabled
enabled
enabled
enabled
offline auto
true
offline auto
true
offline auto
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
32
offline auto
true
offline auto
true
offline auto
true
port-channel 1
2401547fee78f088
enabled
port-channel 2
2402547fee78f088
enabled
port-channel 3
1249
2403547fee78f088
enabled
offline auto
true
offline auto
true
offline auto
true
offline auto
true
offline auto
true
offline auto
true
offline auto
true
offline auto
true
offline auto
true
enabled
offline auto
true
enabled
online
true
port-channel 4
2404547fee78f088
enabled
port-channel 5
2405547fee78f088
enabled
port-channel 6
2406547fee78f088
enabled
port-channel 7
2407547fee78f088
enabled
port-channel 8
2408547fee78f088
enabled
port-channel 9
2409547fee78f088
enabled
port-channel 10
240a547fee78f088
enabled
port-channel 11
240b547fee78f088
enabled
port-channel 12
240c547fee78f088
sup-fc0
unknown
The following command displays power supply unit information about all storage
switches:
cluster::> storage switch show -power
Vendor: Cisco
1250
Power Supplies:
Power Supply
Serial Number Status
--------------- ------------- ----------300.00W 110v AC PAC15494TBZ
normal
300.00W 110v AC PAC15494T4D
normal
The following command displays san configuration (VSANs and Zones) information
about all storage switches:
cluster::> storage switch show -san-config
Vendor: Cisco
VSAN Configuration:
Oper
VSAN ID Vsan Name
Status Load Balancing
isIOD
------- ------------------------ ------ --------------- ----1 VSAN0001
up
src-id-dest-id
true
2 dpg_13_storage
up
src-id-dest-id-ox-id
3 dpg_13_fcvi
down
10 dpg_mcc_13_fab1_fcvi
up
src-id-dest-id
20 dpg_mcc_13_fab1_storage
up
30 dpg_mcc_13_fab2_fcvi
up
src-id-dest-id
true
40 VSAN0040
up
src-id-dest-id
true
70 dpg_mcc_14_fcvi
up
src-id-dest-id
true
true
true
true
true
1251
80 dpg_mcc_14_storage
up
110 dpg_mcc_15_fcvi
up
120 dpg_mcc_15_storage
up
down
true
true
true
4094 isolated_vsan
true
VSAN Membership:
VSAN ID Switch Name
Switch Port Name
------- -------------------- ----------------
1252
1 Cisco_10.226.197.34
fc1/2
1 Cisco_10.226.197.34
fc1/7
1 Cisco_10.226.197.34
fc1/8
1 Cisco_10.226.197.34
fc1/9
1 Cisco_10.226.197.34
fc1/10
1 Cisco_10.226.197.34
fc1/11
1 Cisco_10.226.197.34
fc1/12
1 Cisco_10.226.197.34
fc1/14
1 Cisco_10.226.197.34
fc1/19
1 Cisco_10.226.197.34
fc1/20
1 Cisco_10.226.197.34
fc1/21
1 Cisco_10.226.197.34
fc1/22
1 Cisco_10.226.197.34
fc1/23
1 Cisco_10.226.197.34
fc1/24
1 Cisco_10.226.197.34
fc1/31
1 Cisco_10.226.197.34
fc1/32
1 Cisco_10.226.197.34
fc1/33
1 Cisco_10.226.197.34
fc1/34
1 Cisco_10.226.197.34
fc1/35
1 Cisco_10.226.197.34
fc1/36
1 Cisco_10.226.197.34
fc1/37
1 Cisco_10.226.197.34
fc1/38
1 Cisco_10.226.197.34
fc1/39
1 Cisco_10.226.197.34
fc1/40
1 Cisco_10.226.197.34
fc1/41
1 Cisco_10.226.197.34
fc1/42
1 Cisco_10.226.197.34
fc1/43
1 Cisco_10.226.197.34
fc1/44
1 Cisco_10.226.197.34
fc1/45
1 Cisco_10.226.197.34
fc1/46
1 Cisco_10.226.197.34
fc1/47
1 Cisco_10.226.197.34
fc1/48
1 Cisco_10.226.197.34
port-channel 1
1 Cisco_10.226.197.34
port-channel 2
1 Cisco_10.226.197.34
port-channel 3
1 Cisco_10.226.197.34
port-channel 4
1 Cisco_10.226.197.34
port-channel 5
1 Cisco_10.226.197.34
port-channel 6
1 Cisco_10.226.197.34
port-channel 7
1 Cisco_10.226.197.34
port-channel 8
1 Cisco_10.226.197.34
port-channel 9
1 Cisco_10.226.197.34
port-channel 10
1 Cisco_10.226.197.34
port-channel 11
1 Cisco_10.226.197.34
port-channel 12
1 Cisco_10.226.197.36
fc1/2
1 Cisco_10.226.197.36
fc1/7
1 Cisco_10.226.197.36
fc1/8
1 Cisco_10.226.197.36
fc1/9
1 Cisco_10.226.197.36
fc1/10
1 Cisco_10.226.197.36
fc1/11
1 Cisco_10.226.197.36
fc1/12
1 Cisco_10.226.197.36
fc1/14
1 Cisco_10.226.197.36
fc1/19
1 Cisco_10.226.197.36
fc1/20
1 Cisco_10.226.197.36
fc1/21
1 Cisco_10.226.197.36
fc1/22
1 Cisco_10.226.197.36
fc1/23
1 Cisco_10.226.197.36
fc1/24
1 Cisco_10.226.197.36
fc1/26
1 Cisco_10.226.197.36
fc1/31
1 Cisco_10.226.197.36
fc1/32
1 Cisco_10.226.197.36
fc1/33
1 Cisco_10.226.197.36
fc1/34
1 Cisco_10.226.197.36
fc1/35
1 Cisco_10.226.197.36
fc1/36
1 Cisco_10.226.197.36
fc1/37
1 Cisco_10.226.197.36
fc1/38
1 Cisco_10.226.197.36
fc1/39
1253
1 Cisco_10.226.197.36
fc1/40
1 Cisco_10.226.197.36
fc1/41
1 Cisco_10.226.197.36
fc1/42
1 Cisco_10.226.197.36
fc1/43
1 Cisco_10.226.197.36
fc1/44
1 Cisco_10.226.197.36
fc1/45
1 Cisco_10.226.197.36
fc1/46
1 Cisco_10.226.197.36
fc1/47
1 Cisco_10.226.197.36
fc1/48
30 Cisco_10.226.197.34
fc1/3
30 Cisco_10.226.197.34
fc1/4
30 Cisco_10.226.197.36
fc1/3
30 Cisco_10.226.197.36
fc1/4
40 Cisco_10.226.197.34
fc1/1
40 Cisco_10.226.197.34
fc1/5
40 Cisco_10.226.197.34
fc1/6
40 Cisco_10.226.197.36
fc1/1
40 Cisco_10.226.197.36
fc1/5
40 Cisco_10.226.197.36
fc1/6
70 Cisco_10.226.197.34
fc1/15
70 Cisco_10.226.197.34
fc1/16
70 Cisco_10.226.197.36
fc1/15
70 Cisco_10.226.197.36
fc1/16
80 Cisco_10.226.197.34
fc1/13
80 Cisco_10.226.197.34
fc1/17
80 Cisco_10.226.197.34
fc1/18
80 Cisco_10.226.197.36
fc1/13
80 Cisco_10.226.197.36
fc1/17
80 Cisco_10.226.197.36
fc1/18
110 Cisco_10.226.197.34
fc1/26
110 Cisco_10.226.197.34
fc1/27
110 Cisco_10.226.197.34
fc1/28
120 Cisco_10.226.197.34
fc1/25
120 Cisco_10.226.197.34
fc1/29
120 Cisco_10.226.197.34
fc1/30
120 Cisco_10.226.197.36
fc1/25
120 Cisco_10.226.197.36
fc1/29
120 Cisco_10.226.197.36
fc1/30
Last Update Time: 7/31/2014 14:45:40 -04:00
1254
Zone Configuration:
Member
Member
Member
Zone Name VSAN ID Switch Name Port Name Port ID Member WWN
--------- ------- ----------- --------- ------- ---------dpg_mcc_fcvi
30 Cisco_10.226.197.36
fc1/3
$default_zone$ 30 Cisco_10.226.197.36
fc1/4
dpg_mcc_storage
40 Cisco_10.226.197.36
fc1/1
fc1/5
dpg_mcc_14_fcvi
70 Cisco_10.226.197.36
fc1/15
fc1/16
dpg_mcc_14_storage
80 Cisco_10.226.197.34
fc1/13
fc1/17
dpg_mcc_15_fcvi
110 Cisco_10.226.197.36
fc1/27
$default_zone$
110 Cisco_10.226.197.36
fc1/28
dpg_mcc_15_storage
120 Cisco_10.226.197.34
fc1/25
$default_zone$
120 Cisco_10.226.197.34
fc1/29
The following command displays port SFP information about all storage switches:
1255
cluster::> storage switch show -sfp

Vendor: Cisco
SFP:
Port Name Type
Number
Tx Type
Vendor
Part Number Serial
--------- ------------- ---------------- ----------- ----------------------fc1/1
sfp-with-serial-id
short-wave-laser CISCO-FINISAR
FTLF8528P2BCV-CS
FNS160629J9
fc1/2
unknown
unknown
fc1/3
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS160629H3
fc1/4
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS160629QH
fc1/5
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS160628EA
fc1/6
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS160629QT
1256
fc1/7
unknown
unknown
fc1/8
unknown
unknown
fc1/9
unknown
unknown
fc1/10
unknown
unknown
fc1/11
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS160629GP
fc1/12
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS16061X71
fc1/13
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS160629P8
fc1/14
unknown
unknown
fc1/15
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS160629JP
fc1/16
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS160628D2
fc1/17
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS160629NG
fc1/18
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS160629R1
fc1/19
unknown
unknown
fc1/20
unknown
unknown
fc1/21
unknown
unknown
fc1/22
unknown
unknown
fc1/23
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS160629NC
fc1/24
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS160628CX
1257
fc1/25
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS160629NZ
fc1/26
unknown
unknown
fc1/27
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS16061XB0
fc1/28
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS16061XA6
fc1/29
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS16061XA0
fc1/30
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS16061X9S
fc1/31
unknown
unknown
fc1/32
unknown
unknown
fc1/33
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS16061NL7
fc1/34
unknown
unknown
fc1/35
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS160629M8
fc1/36
sfp-with-serial-id
FTLF8528P2BCV-CS
FNS160629KH
1258
fc1/37
unknown
unknown
fc1/38
unknown
unknown
fc1/39
unknown
unknown
fc1/40
unknown
unknown
fc1/41
unknown
unknown
fc1/42
unknown
unknown
fc1/43
unknown
unknown
fc1/44
unknown
unknown
fc1/45
unknown
unknown
fc1/46
unknown
unknown
fc1/47
unknown
unknown
fc1/48
unknown
unknown
port-channel 1
unknown
unknown
port-channel 2
unknown
unknown
port-channel 3
unknown
unknown
port-channel 4
unknown
unknown
port-channel 5
unknown
unknown
port-channel 6
unknown
unknown
port-channel 7
unknown
unknown
port-channel 8
unknown
unknown
port-channel 9
unknown
unknown
port-channel 10
unknown
unknown
port-channel 11
unknown
unknown
port-channel 12
unknown
unknown
sup-fc0
The following command displays port statistics information about all storage switches:
cluster::> storage switch show -stats
1259

Vendor: Cisco
Port Statistics:
Port Name
Rx
Rx
Tx
Tx
Error
Frames
Octets
Frames
Octets
Frames
------------ ------------ ------------ ------------ ------------ ------------
1260
fc1/1
2116207233
3710682580
3906335374
859905888
fc1/2
208
208
fc1/3
3238899002
903116292
3079548736
4014304952
fc1/4
1888758418
1643379900
2434821325
2997002344
fc1/5
3719731908
1808138824
1878240211
3421335100
fc1/6
2644430347
1042009564
249190625
2003353056
fc1/7
228
228
fc1/8
156
156
fc1/9
148
148
fc1/10
224
224
fc1/11
3617142898
4129927136
39089396
2595464620
fc1/12
473603889
1560909460
2797562521
2833496016
fc1/13
1852255936
1091902804
180309704
1769859928
fc1/14
140
140
fc1/15
4997082
3519688264
4283938
3370856432
fc1/16
4995287
3519577592
4282173
3370732136
fc1/17
55146756
178045212
1733567096
3030415436
fc1/18
63005788
4287094736
1726651844
2640371212
fc1/19
200
200
fc1/20
104
104
fc1/21
108
108
fc1/22
108
108
fc1/23
164
164
fc1/24
216
216
fc1/25
2810698819
1611009260
471527156
1900246656
fc1/26
104
104
fc1/27
4165019838
887421780
3848122102
2581891136
fc1/28
58607737
1015197080
101621078
3482734024
fc1/29
4266270960
222242144
3766674764
2400640552
fc1/30
3984658378
1443835508
152597387
678837848
fc1/31
220
220
fc1/32
120
120
fc1/33
132
132
fc1/34
144
144
fc1/35
160
160
fc1/36
104
104
fc1/37
148
148
fc1/38
184
184
fc1/39
160
160
fc1/40
136
136
fc1/41
196
196
fc1/42
128
128
fc1/43
168
168
fc1/44
212
212
fc1/45
136
136
fc1/46
224
224
fc1/47
104
104
fc1/48
104
104
See Also
storage switch add
1261
storage tape offline

Take a tape drive offline
level.
Description
This command takes the specified tape drive offline.
Parameters
Use this parameter to specify the node to which the tape drive is attached.
{ -name <text> - Tape Drive Device Name
Use this parameter to specify the device name of the tape drive that needs to be taken
offline. The format of the device -name name includes a prefix to specify how the tape
cartridge is handled and a suffix to describe the density of the tape. The prefix suggests
'r', 'nr' or 'ur' for rewind, no rewind, or unload/reload and a suffix shows density of 'l',
'm', 'h' or 'a'. For example, a tape device name for this operation might have the form
"nrst8m" were 'nr' is the 'no rewind' prefix, 'st8' is the alias-name and 'm' is the tape
density. You can use the 'storage tape show -device-names' command to find more
information about device names of tape drives attached to a node.
| -device-id <text> } - Tape Drive Device ID
Use this parameter to specify the device ID of the tape drive that needs to be taken
offline.
Examples
The following example takes the tape drive with device name 'nrst8m' offline. This tape
drive is attached to cluster1-01.
cluster1::> storage tape offline -node cluster1-01 -name nrst8m
storage tape online

1262
Bring a tape drive online

level.
Description
This command brings a specified tape drive online.
Parameters
{ -device-id <text> - Tape Drive Device ID
Use this parameter to specify the device ID of the tape drive that needs to be brought
online.
| -name <text> } - Tape Drive Device Name
Use this parameter to specify the device name of the tape drive that needs to be
brought online. The format of the device -name name includes a prefix to specify how
the tape cartridge is handled and a suffix to describe the density of the tape. The prefix
suggests 'r', 'nr' or 'ur' for rewind, no rewind, or unload/reload and a suffix shows density
of 'l', 'm', 'h' or 'a'. For example, a tape device name for this operation might have the
form "nrst8m" were 'nr' is the 'no rewind' prefix, 'st8' is the alias-name and 'm' is the tape
Examples
The following example brings the tape drive with device id sw4:2.126L4 attached to the
node, cluster1-01, online.
cluster1::> storage tape online -node cluster1-01 -device-id sw4:2.126L4
storage tape position

Modifies the tape drive cartridge position
level.
1263
Description
This command changes the tape drive cartridge position.
Parameters
-name <text> - Tape Drive Device Name
Use this parameter to specify the device name of the tape drive whose cartridge position
needs to be changed. The format of the device -name includes a prefix to specify how
the tape cartridge is handled and a suffix to describe the density of the tape. The prefix
suggests 'r', 'nr' or 'ur' for rewind, no rewind, or unload/reload and a suffix shows density
of 'l', 'm', 'h' or 'a'. For example, a tape device name for this operation might have the
form "nrst8m" were 'nr' is the 'no rewind' prefix, 'st8' is the alias-name and 'm' is the tape
-operation {weof|fsf|bsf|fsr|bsr|rewind|erase|eom} - Tape Position Operation
Use this parameter to specify the tape positioning operation. The possible values for operation are:
weof - Write end-of-file marks
fsf - Forward space end-of-file marks
bsf - Backward space end-of-file marks
fsr - Forward space records
bsr - Backward space records
rewind - Rewind the tape
erase - Erase then entire tape media from current position
eom - Position the tape at end of data (end of media if full)
[-count <integer>] - Count for Positioning
Use this parameter to specify the count for a tape positioning operation. You can specify
this parameter only with the following operations: weof, fsf, bsf, fsr, and bsr. The default
value of this parameter is one. Valid values for weof operations are from 0 to 2097136
(0x1FFFF0).
1264
Examples
The following example specifies a rewind operation on a tape device. Note the -count
parameter does not need to be specified for this type of operation.
cluster1::> storage tape position -node cluster1-01 -name nrst8m -operation
rewind
The following example specifies an fsf (forward space filemark) operation on a tape
device. Note the -count parameter specifies 5 forward space filemarks for this operation.
cluster1::> storage tape position -node cluster1-01 -name nrst1a -operation fsf count 5
The following example specifies an eom (end-of-media) operation on a tape device. The
'eom' positions a tape at end of data (end of media if full). Note the -count parameter
does not need to be specified for this type of operation.
cluster1::> storage tape position -node cluster1-01 -name rst0h -operation eom
storage tape reset

Reset a tape drive
privilege level.
Description
This command resets a specified tape drive.
Parameters
-device-id <text> - Tape Drive Device ID
Use this parameter to specify the device ID of the tape drive is to be reset.
Examples
1265
The following example resets the tape drive with device ID sw4:2.126L3 attached to the
node, cluster1-01.
cluster1::> storage tape reset -node cluster1-01 -device-id sw4:2.126L3
storage tape show-errors

Display tape drive errors
level.
Description
The storage tape show-errors command displays error information about
tape drives attached to the cluster. By default, this command displays the following
information about all tape drives:
Node to which the tape drive is attached
Device ID of the tape drive
Type of device(tape drive)
Description of the tape drive
Alias name of the tape drive
Tape drive errors
Parameters
specify.
| [-instance ] }
about all fields.
Displays detailed information about tape drives on the specified node.
1266
[-device-id <text>] - Device ID

Selects the tape drive with the specified device ID.
[-device-type <text>] - Device Type
Selects the devices with the specified type of tape drive.
Selects the tape drives with the specified description.
[-alias-name <text>] - Alias Name
Selects the tape drive with the specified alias name.
[-wwnn <text>] - World Wide Node Name
Selects the tape drives with the specified World Wide Node Name.
[-wwpn <text>] - World Wide Port Name
Selects the tape drive with the specified World Wide Port Name.
Selects the tape drive with the specified serial number.
[-error <text>] - Tape Drive Error Description
Selects the tape drives with the specified error string.
Selects the tape drives with the specified initiator port.
Examples
The following example shows error information for all tape drives attached to cluster1.
cluster1::> storage tape show-errors
Node: node1
Device ID: 0d.125
Device Type: tape drive
Description: Hewlett-Packard LTO-5
Alias: st0
Errors: hardware error; repair or replace tape drive
Node: node1
Device ID: 2d.0
1267

Description: IBM LTO-6 ULT3580
Alias: st2
Errors: -
The following example shows error information for tape drive sw4:2.126L1 attached to
the node, node1.
cluster1::> storage tape show-errors -device-id sw4:2.126L1 -node node1
Node: node1
Device ID: sw4:2.126L1
Description: Hewlett-Packard LTO-3
Alias: st3
Errors: -
1268
storage tape show-media-changer

Displays information about media changers
level.
Description
This storage tape show-media-changer command displays information about
media changers attached to the cluster. By default, this command displays the following
information about all media changers:
Device ID of media changer
Description of media changer
World Wide Node Name of media changer
World Wide Port Name of media changer
Serial number of media changer
Media changer errors
Node to which the media changer is attached
Initiator port which hosts the media changer
Alias name of media changer
Operational state of media changer
Functional status of media changer
Parameters
specify.
| [-instance ] }
about all fields.
1269
Selects the media changer with the specified device ID.

Displays detailed information about media changers on the specified node.
Selects the media changers with the specified description.
Selects the media changer with the specified alias name.
Selects the media changers with the specified World Wide Node Name.
>Selects the media changer with the specified World Wide Port Name.
Selects the media changer with the specified serial number.
[-device-if-type {unknown|fibre-channel|SAS|pSCSI}] - Device If Type
Selects the media changers with the specified interface type.
[-device-state {unknown|available|ready-write-enabled|ready-write-protected|offline|inuse|error|reserved-by-another-host|normal}] - Operational State of Device
Selects the media changers with the specified operational state.
[-error <text>] - Media Changer Error Description
Selects the media changers with the specified error string.
Selects the media changers with the specified initiator port.
Examples
The following example displays information about all media changers attached to the
cluster:
cluster1::> storage tape show-media-changer
Media Changer: sw4:10.11L1
Description: PX70-TL
WWNN: 2:00a:000e11:10b919
1270
WWPN: 2:00b:000e11:10b919
Serial Number: 00FRU7800000_LL1
Errors: Paths:
Node
Initiator
Alias
Device State
Status
------------------------
---------
-------
------------------------
--------
cluster1-01
2b
mc0
in-use
normal
Media Changer: sw4:12.4L1

Description: NEO-TL
WWNN: 2:001:000e11:10b919
WWPN: 2:002:000e11:10b919
Serial Number: 00FRU7800000_LL0
Errors: Paths:
Node
Initiator
Alias
Device State
Status
------------------------
---------
-------
------------------------
--------
cluster1-01
5a
mc1
available
normal
1271
storage tape show-supported-status

Displays the qualification and supported status of tape drives
level.
Description
This command displays the supported and qualification status of all tape drives
recognized by Data ONTAP attached to a node in the cluster. This includes nonqualified
tape drives. Such tape drives do not have a Tape Configuration File (TCF) on the
storage system. A nonqualified tape drive can be used if the tape drive emulates
a qualified tape drive or if the appropriate TCF for the nonqualified tape drive is
downloaded from the NetApp Support Site to the storage system.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the tape drives that match this parameter value.
[-tape-drive <text>] - Tape Drive Name
[-is-supported {true|false}] - Tape Drive Supported
[-status <text>] - Supported Status
Examples
1272
The following example displays support and qualification status of tape drives
recognized by Data ONTAP. The command also identifies tape drives attached to the
node that are nonqualified (not supported).
cluster1::> storage tape show-supported-status
Node: Node1
Is
Tape Drive
Supported
Support Status
------------------------- ---------
---------------------------------
sw4:2.126L6
false
Nonqualified tape drive
Hewlett-Packard C1533A
true
Qualified
Hewlett-Packard C1553A
true
Qualified
Hewlett-Packard Ultrium 1 true
Qualified
Sony SDX-300C
true
Qualified
Sony SDX-500C
true
Qualified
StorageTek T9840C
true
Dynamically Qualified
StorageTek T9840D
true
Tandberg LTO-2 HH
true
The following example displays support and qualification status of tape

drives selected by #tape-drive. The command identifies the supported
status of the selected tape drive.
cluster1::> storage tape show-supported-status -tape-drive "Sony SDX-300C"
Node: Node1
Is
Tape Drives
-----------------------------------------------------------Sony SDX-300C
Supported
Support Status
--------true
Qualified
1273
storage tape show-tape-drive

Displays information about tape drives
level.
Description
This storage tape show-tape-drive command displays information about
tape drives attached to the cluster. By default, this command displays the following
information about all tape drives:
Device ID of tape drive
Description of tape drive
World Wide Node Name of tape drive
World Wide Port Name of tape drive
Serial Number of tape drive
Tape drive errors
Initiator port which hosts the tape drive
Alias name of tape drive
Operational state of tape drive
Functional status of tape drive
Parameters
specify.
| [-instance ] }
about all fields.
1274
Selects the tape drive with the specified device ID.

Selects the tape drives with the specified description.
Selects the tape drive with the specified alias name.
Selects the tape drives with the specified World Wide Node Name.
Selects the tape drive with the specified World Wide Port Name.
Selects the tape drive with the specified serial number.
[-device-if-type {unknown|fibre-channel|SAS|pSCSI}] - Device If Type
Selects the tape drives with the specified interface type.
Selects the tape drives with the specified operational state.
[-error <text>] - Tape Drive Error Description
Selects the tape drives with the specified error string.
Selects the tape drives with the specified initiator port.
[-resv-type {off|persistent|scsi}] - Reservation type for device
Selects the tape drives with the specified type.
Examples
The following example displays information about all tape drives attached to the cluster:
cluster1::> storage tape show-tape-drive
Tape Drive: sw4:11.126
1275
Description: StorageTek T10000C

WWNN: 5:001:04f000:b39ec8
WWPN: 5:001:04f000:b39ec9
Errors: Paths:
Node
Initiator
Alias
Device State
Status
------------------------
---------
-------
------------------------
--------
cluster1-01
2a
st0
ready-write-enabled
normal
Tape Drive: sw4:12.4

Description: HP LTO-3
WWNN: 2:001:000e11:10b919
WWPN: 2:002:000e11:10b919
Errors: Paths:
1276
Node
Initiator
Alias
Device State
Status
------------------------
---------
-------
------------------------
--------
cluster1-01
0b
st1
ready-write-enabled
normal
storage tape show

Displays information about tape drives and media changers
level.
Description
The storage tape show command displays information about tape drives and media
changers attached to the cluster. Where it appears in the remainder of this document
"device" may refer to either a tape drive or a media changer. By default, this command
displays the following information about all tape drives and media changers:
Node to which the tape drive/media changer is attached
Device ID of the tape drive/media changer
Description of the tape drive/media changer
Type of device: tape drive or media changer
Functional status of the tape drive/media changer
Parameters
specify.
| [-alias ]
Displays the tape drive/media changer alias with the following details:
Node to which tape drive/media changer is attached
Alias name of the tape drive/media changer
Alias mapping for tape drive/media changer
| [-connectivity ]
Displays the connectivity from the node to the tape drive/media changer with the
following details:
1277

Tape drive/media changer description
Type of device: tape drive or media changer
Interface type for the tape drive/media changer
World Wide Node Name of tape drive/media changer
World Wide Port Name of tape drive/media changer
Serial Number of tape drive/media changer
Tape drive/media changer errors
Initiator port which hosts the tape drive/media changer
Operational state of tape drive/media changer
Functional status of tape drive/media changer
| [-device-names ]
Displays the tape drive names for used tape positioning using the following details:
rewind, no rewind, unload/reload and density
Device Names that include Rewind, no Rewind, Unload/Reload
| [-status ]
Displays the status of tape drive/media changer with the following details:
World Wide Node Name of tape drive/media changer
World Wide Port Name of tape drive/media changer
Serial Number of tape drive/media changer
1278
Format used for tape cartridge mounted by tape drive

Tape drive/media changer errors
Operational state of tape drive/media changer
File number following last tape drive I/O operation
Block number following last tape drive I/O operation
Residual count following last tape drive I/O operation
| [-instance ] }
about all fields.
Selects the tape drive/media changer with the specified device ID.
Displays detailed information about tape drives or media changers on the specified
node.
[-device-type <text>] - Device Type
Selects the devices with the specified type of tape drive or media changer.
Selects the tape drives/media changers with the specified description.
Selects the tape drive/media changer with the specified alias name.
[-alias-mapping <text>] - Alias Mapping
Selects the tape drive/media changer with the specified alias mapping.
Selects the tape drives/media changers with the specified World Wide Node Name.
Selects the tape drive/media changer with the specified World Wide Port Name.
Selects the tape drive/media changer with the specified serial number.
1279
[-functional-status {unknown|normal|error}] - Functional Status

Selects the tape drives/media changers with the specified functional status of the
device.
[-device-if-type {unknown|fibre-channel|SAS|pSCSI}] - Device Interface Type
Selects the tape drives/media changers with the specified interface type.
Selects the tape drives/media changers with the specified operational state.
[-format <text>, ...] - Tape Cartridge Format
Selects the tape drives with the specified tape format.
[-error <text>] - Tape Error
Selects the tape drives/media changers with the specified error string.
Selects the tape drives/media changers with the specified initiator port.
[-file-number <integer>] - File Number
Selects the tape drives/media changers with the specified file number. The file number
is the number of file marks between the beginning of media and current logical position.
File number gets modified on write file mark, and forward or backward space file
operations. A value of -1 indicates unknown position on the tape media or tape not
loaded in the tape drive.
[-block-number <integer>] - Block Number
Selects the tape drives/media changers with the specified block number. The block
number is the number of logical blocks between the beginning of tape media or the
prior file mark and the current logical position on the tape media. Block number gets
modified on writes, reads, and forward or backward space over records (blocks). The
block number also gets reset to zero when a file mark is crossed or another file mark
is written that designates a new file. If the tape is back spaced to a prior file mark, the
block number might be zeroed. A value of -1 indicates unknown position on the tape
media or that a tape not loaded in the tape drive.
[-residual-count <integer>] - Residual Count of Last I/O Operation
Selects the tape drives with the specified residual count.
[-device-name-r <text>, ...] - Device Name for Rewind
Selects the tape drives with the specified device name for rewind.
1280
[-device-name-nr <text>, ...] - Device Name for No Rewind

Selects the tape drives with the specified device name for no rewind.
[-device-name-ur <text>, ...] - Device Name for Unload Reload
Selects the tape drives with the specified device name for unload/reload.
[-resv-type {off|persistent|scsi}] - Reservation Type for device
Selects the tape drives with the specified type.
Examples
The following example displays information about all tape drives and media changers
attached to the cluster:
cluster1::> storage tape show
Node: cluster1-01
Device ID
Device Type
Description
Status
----------------------
--------------
------------------------------
--------
sw4:10.11
tape drive
HP LTO-3
error
Device ID
Device Type
Description
Status
----------------------
--------------
------------------------------
--------
sw4:10.11L1
media changer
PX70-TL
normal
Node: cluster1-01
The following example displays detailed information about a tape drive named
sw4:10.11
cluster1::> storage tape show -device-id sw4:10.11
Node: cluster1-01
Device ID
Device Type
Description
Status
----------------------
--------------
------------------------------
--------
sw4:10.11
tape drive
HP LTO-3
error
1281
storage tape trace

Enable/disable tape trace operations
level.
Description
This command enables or disables diagnostic tape trace operations for all tape drives
attached to the node you have specified.
Parameters
Use this parameter to specify the node on which the tape trace feature is enabled or
disbled.
[-is-trace-enabled {true|false}] - Tape Trace Enabled or Disabled
Use this parameter to enable or disable the tape trace feature. By default, the tape trace
feature is enabled.
Examples
The following example enables tape trace operation on the node, cluster1-01.
cluster1::> storage tape trace -node cluster1-01 -is-trace-enabled true
storage tape alias clear

Clear alias names
level.
Description
This command clears alias names for a tape drive or media changer.
1282
Parameters
{ -name <text> - Alias Name That Is to Be Cleared
Use this parameter to specify the alias name that is to be cleared. You can use the
'storage tape show -alias' command to find more information about alias names of
tape drives and media changers attached to a node. The -clear-scope and -name
parameters are mutually exclusive. If you specify the -name parameter, a single alias
name is cleared.
| -clear-scope {tape|media-changer|all} } - Scope of Alias Clear Operation
Use this parameter to specify the scope of the alias clear operation. The -clearscope and -name parameters are mutually exclusive. If you specify the -clearscope parameter, multiple aliases are cleared depending upon the value of the
parameter.
The possible values for -clear-scope are as follows:
tape - Clear all tape drive aliases
media-changer - Clear all media-changer aliases
all - Clear both tape drive and media-changer aliases
Examples
The following example clears an alias name 'st3' attached to the node, cluster1-01.
cluster1::> storage tape alias clear -node cluster1-01 -name st3
The following example clears all tape drive alias names attached to the node,
cluster1-01.
cluster1::> storage tape alias clear -node cluster1-01 -clear-scope tape
The following example clears all media changer alias names attached to the node,
cluster1-01.
cluster1::> storage tape alias clear -node cluster1-01 -clear-scope media-changer
1283
The following example clears both tape and media changer alias names attached to the
node, cluster1-01.
cluster1::> storage tape alias clear -node cluster1-01 -clear-scope all
storage tape alias set

Set an alias name for tape drive or media changer
level.
Description
This command sets an alias name for a tape drive or media changer.
Parameters
-name <text> - Alias Name for Tape Drive or Media Changer
Use this parameter to specify the alias name for tape drive or media changer. For a tape
drive alias name, the format is 'st' followed by one or more digits. For a media changer
alias name, the format is 'mc' followed by one or more digits.
-mapping <text> - Mapping for Alias Name
Use this parameter to specify the mapping for an alias name. Use the format
'SN[<serial-number>]'. Valid mapping for serial numbers are in the format 'SN[<serialnumber>]' where the <serial-number> is from 2 to 90 characters long and includes the
following characters: 0-9, a-z, and A-Z.
Examples
The following example sets an alias name 'st3' for a tape drive with serial number
SN[123456]L4 attached to the node, node1.
cluster1::storage tape alias> set
-node node1 -name st3 -mapping SN[123456]L4.
The following example sets an alias name 'mc1' for a media changer with serial number
SN[65432] attached to the node, node1.
1284
cluster1::storage tape alias> set
-node node1 -name mc1 -mapping SN[65432].
storage tape alias show

Displays aliases of all tape drives and media changers
level.
Description
This command displays aliases of all tape drives and media changers attached to every
node in the cluster.
Parameters
specify.
| [-instance ] }
about all fields.
Examples
The following example shows the aliases of all tape drives and media changers
attached to every node in the cluster:
cluster1::> storage tape alias show
Node: node1
Alias
Mapping
--------------------------------------
----------------------------------------
mc0
SN[00FRU7800000_LL0]L1
mc1
SN[00FRU7800000_LL1]L1
mc2
SN[aa6a64c69360a0980248c8]
mc3
SN[c940abe8b0c3a0980248c8]
1285
mc4
SN[fba082e6b335a0980248c8]L5
st0
SN[HU19487T7N]
st1
SN[1068000230]
st10
SN[fba0c508b335a0980248c8]L7
Node: node2
1286
Alias
Mapping
--------------------------------------
----------------------------------------
mc1
SN[c940982fc48c8]
st3
SN[ST456HT8N]L3
st2
SN[HG68000230]L2
st11
SN[aba673980248c8]L7
storage tape library config show

Display connectivity to back-end storage tape libraries.
level.
Description
This command displays information such as how the storage tape libraries connect to
the cluster, LUN groups, number of LUNs, WWPN, and switch port information. Use
this command to verify the cluster's storage tape library configuration or to assist in
troubleshooting.
Parameters
specify.
| [-switch ]
If you specify this parameter, switch port information is shown.
| [-instance ] }
about all fields.
[-group <integer>] - LUN Group
A LUN group is a set of LUNs that shares the same path set.
[-target-wwpn <text>] - Library Target Ports
The World Wide Port Name of a storage tape library port.
[-initiator <text>] - Initiator
The host bus adapter that the clustered node uses to connect to storage tape libraries.
[-array-name <array name>] - Library Name
1287
Name of the storage tape library that is connected to the clustered node.
This identifies the switch port that connects to the tape library's target port.
This identifies the switch port that connects to the node's initiator port.
[-lun-count <integer>] - Number of LUNS
This is a command-line switch (-lun-count) used to restrict what LUN groups are
displayed in the output.
Examples
The following example displays the storage tape library configuration information.
cluster1::> storage tape library config show
LUN
Node
Initiator
LUN
Group Count
Library Name
Library Target Port
------------ ----- ----- ---------------------------- ------------------------------cluster1-01

0
TAPE_LIB_1
50050763124b4d6f
3d
cluster1::>
1288
storage tape library path show-by-initiator

Display a list of LUNs on the given tape library
level.
Description
This command displays path information for every initiator port connected to a tape
library. The output is similar to the storage library path show command but the output is
listed by initiator.
Parameters
fields used to be used in this display
| [-instance ] }
about all fields.
Target World Wide Port Name. Port on the storage tape library that is being used.
Switch port connected to the tape library.
Name of the storage tape library that is connected to the cluster.
1289
failover behaviors.
Rolling average of Kbytes of I/O per second on the library path.
[-path-iops <integer>] - Number of I/O per second on Path (Rolling Average)
Rolling average of I/O per second on the library path.
[-initiator-iops <integer>] - Number of I/O per second on Initiator (Rolling Average)
>Rolling average of I/O per second on the initiator port.
[-target-iops <integer>] - Number of I/O per second to Target (Rolling Average)
Examples
The following example displays the path information by initiator for a storage tape
library.
cluster1::> storage tape library path show-by-initiator
Node: cluster1-01
Initiator I/O
Target I/O
Initiator
(KB/s)
Initiator Side
Path I/O
Target Side
(KB/s)
Switch Port
Target Port Library Name
(KB/s)
Switch Port
--------- ------------- -------------------- ------------ ------------------------------- ---------------- ---------------0b
0 sw_tape:6
0 510a09800000412d TAPE_LIB_1
sw_tape:0
sw_tape:1
0 510a09820000412d TAPE_LIB_1
3d
0 N/A
0 50050763124b4d6f TAPE_LIB_2
N/A
1290
storage tape library path show

Display a list of Tape Libraries on the given path
level.
Description
This command displays path information for a tape library and has the following
parameters by default:
Node name
Initiator port
Target port
TPGN (Target Port Group Number)
Port speeds
IOPs
Parameters
fields used to be used in this display
| [-detail ]
Using this option displays the following:
Target IOPs
Target LUNs
Path IOPs
Path errors
Path quality
Path LUNs
Initiator IOPs
1291
Initiator LUNs
| [-instance ] }
about all fields.
Name of the storage tape library that is connected to the cluster.
Target World Wide Port Name. Port on the storage tape library that is being used.
failover behaviors.
[-path-io-kbps <integer>] - Kbytes of I/O per second on Path(Rolling Average)
Rolling average of Kbytes of I/O per second on the library path.
[-path-iops <integer>] - Number of I/O per second on Path(Rolling Average)
Rolling average of I/O per second on the library path.
[-initiator-io-kbps <integer>] - Kbytes of I/O per second on Initiator(Rolling Average)
[-initiator-iops <integer>] - Number of I/O per second on Initiator(Rolling Average)
>Rolling average of I/O per second on the initiator port.
[-target-io-kbps <integer>] - Kbytes of I/O per second to Target(Rolling Average)
1292

[-target-iops <integer>] - Number of I/O per second to Target(Rolling Average)
Switch port connected to the tape library.
[-path-link-errors <integer>] - Link Error count on path
Fibre Channel link error count.
[-path-quality <integer>] - Percentage of weighted error threshold
A number representing the threshold of errors that is allowed on the path. Path quality
is a weighted error value. When the error weight of a path exceeds the threshold, I/O is
routed to a different path.
[-path-lun-in-use-count <integer>] - Number of LUNs in the in-use state on this path
Number of LUNs on this path.
[-initiator-lun-in-use-count <integer>] - Number of LUNs in the in-use state on this
initiator
Number of LUNs on this initiator.
[-target-lun-in-use-count <integer>] - Number of LUNs in the in-use state on this target
Number of LUNs on this target.
Examples
The following example displays the path information for a storage tape library
cluster1::> storage tape library path show
Node
(KB/s)
Initiator
Target Port
TPGN
Speed
-----------------------
------
-------
IOPs
--------------------- -------------------- -----------cluster1-01

0
3d
50050763124b4d6f
61
4 Gb/S
0b
510a09800000412d
35
4 Gb/S
0b
510a09820000412d
4 Gb/S
cluster1-01
0
cluster1-01
0
1293
1294
system chassis show

Display all the chassis in the cluster
level.
Description
The system chassis show command displays information about all the chassis in
the cluster. By default, the command displays the following information about all the
chassis in the cluster:
Chassis ID
Status
List of nodes in the chassis
To display more details, use the -instance parameter.
Parameters
Selects the fields that you specify.
| [-instance ] }
Displays detailed information about all the chassis in the cluster.
[-chassis-id <text>] - Chassis ID
Selects information about the specified chassis.
[-member-nodes {<nodename>|local}, ...] - List of Nodes in the Chassis
Selects information about the chassis with the specified member node list.
[-num-nodes <integer>] - Number of Nodes in the Chassis
Selects information about the chassis with the specified number of nodes.
[-status {ok|ok-with-suppressed|degraded|unreachable|unknown}] - Status
Selects information about the chassis with the specified status.
Examples
1295
The following example displays information about all the chassis in the cluster:
cluster1::> system chassis show
Chassis ID
Status
List of Nodes
-------------------------- --------------- ---------------------------------4591227214
ok
node1,node2
4591227000
ok
node1,node2
The following example displays detailed information about a specific chassis:

cluster1::> system chassis show -chassis-id 4591227214 -instance
Chassis ID: 4591227214
List of Nodes in the Chassis: node1,node2
Number of Nodes in the Chassis: 2
Status: ok
1296
system chassis fru show

Display the FRUs in the cluster
level.
Description
The system chassis fru show command displays information about all the major
chassis specific FRUs in the cluster. By default, the command displays the following
information about all the FRUs in the cluster:
Chassis ID
FRU name
FRU type
FRU state
Nodes sharing the FRU
Parameters
| [-instance ] }
Displays detailed information about FRUs.
Specifies the node name which holds the controller.
[-serial-number <text>] - FRU Serial Number
Selects information about the FRU with the specified serial number.
[-fru-name <text>] - FRU Name
Selects information about the FRU with the specified FRU name.
[-type {controller|psu|fan|dimm|bootmedia}] - FRU Type
1297
Selects information about all the FRUs with the specified FRU type.
[-name <text>] - FRU Name
Selects information about the FRU with the specified FRU unique name.
[-state <text>] - FRU State
Selects information about all the FRUs with the specified state.
Selects information about all the FRUs with the specified status.
[-display-name <text>] - Display Name for the FRU
Selects information about all the FRUs with the specified FRU display name.
[-monitor {node-connect|system-connect|system|controller|chassis|cluster-switch|
example}] - Monitor Name
Selects information about all the FRUs with the specified monitor name.
[-model <text>] - Model Type
Selects information about all the FRUs with the specified FRU model.
[-shared {shared|not_shared}] - Shared Resource
Selects information about all the FRUs with the specified sharing type.
Selects information about all the FRUs in the specified chassis.
[-additional-info <text>] - Additional Information About the FRU
Selects information about all the FRUs with the specified additional information.
[-connected-nodes {<nodename>|local}, ...] - List of Nodes Sharing the FRU
Selects information about all the FRUs with the specified node list.
[-num-nodes <integer>] - Number of Nodes Sharing the FRU
Selects information about all the FRUs with the specified number of connected nodes.
Examples
The following example displays information about all major chassis specific FRUs in the
cluster:
cluster1::> system chassis fru show
1298
Chassis ID
FRU
Type
State
Nodes Sharing the FRU
------------------- ---------- -------- ----------- ----------------------4591227214
node1
controller
4591227214
node2
controller
ok
node2
4591227214
PSU1 FRU
psu
GOOD
node1,node2
4591227214
PSU2 FRU
psu
GOOD
node1,node2
ok
node1
The following example displays detailed information about a specific FRU:

cluster1::> system chassis fru show -instance -fru-name "PSU1 FRU"
Node: node1
FRU Serial Number: XXT122737891
FRU Name: PSU1 FRU
FRU Type: psu
FRU Name: XXT122737891
FRU State: GOOD
Status: ok
Display Name for the FRU: PSU1 FRU
Monitor Name: chassis
Model Type: none
Shared Resource: shared
Additional Information About the FRU: Part Number: 114-00065+A0
Revision: 020F
Manufacturer: NetApp
FRU Name: PSU
List of Nodes Sharing the FRU: node1,node2
Number of Nodes Sharing the FRU: 2
1299
system cluster-switch create

Add information about a cluster switch or management switch
level.
Description
The system cluster-switch create command adds information about a cluster
switch or management switch. The cluster switch health monitor uses this information to
monitor the health of the switch.
Use this command if Data ONTAP cannot automatically discover a cluster or
management switch. Data ONTAP relies on discovery protocols to discover the
switches. By default, Data ONTAP automatically attempts to discover and monitor
supported cluster and management switches.
If the Cisco Discovery Protocol v1(CDPv1) Daemon is disabled, Data ONTAP cannot
discover the cluster and management switches. To verify whether the discovery protocol
is enabled or disabled, run the command: system node run -node <node_name> command options cdpd.enable
Use the system cluster-switch show command to identify the switches that the
cluster switch health monitor is monitoring.
Parameters
-device <text> - Device Name
Specifies the device name of the switch that you want to monitor. Data ONTAP uses
the device name of the switch to identify the SNMP agent with which it wants to
communicate.
-address <IP Address> - IP Address
Specifies the IP address of switch's management interface.
-snmp-version {SNMPv1|SNMPv2c} - SNMP Version
Specifies the SNMP version that Data ONTAP uses to communicate with the switch.
The default is SNMP v2c.
-community <text> - Community String
Specifies the community string for SNMPv2 authentication. The default is cshm1!.
1300
-model {NX5010|NX5020|CAT2960|OTHER|NX5596|CN1610|CN1601} - Model Number

Specifies the model number of the switch. You should not set this parameter to OTHER.
Data ONTAP does not monitor switches that match this value. Data ONTAP sets this
parameter to OTHER if a switch that it automatically discovers is not supported for
health monitoring.
-type {cluster-network|management-network} - Switch Network
Specifies the switch type.
[-is-monitoring-enabled-admin {true|false}] - Enable Switch Monitoring
Specifies the switch admin monitoring status.
Examples
cluster1::> system cluster-switch create -device SwitchA -ipaddress 1.2.3.4
-snmpversion SNMPv2c -community public -discovered false -model NX5010 -type
cluster
Creates a new switch configuration for a switch named SwitchA.
See Also
system node run system cluster-switch show
1301
system cluster-switch delete

Delete information about a cluster switch or management switch
level.
Description
The system cluster-switch delete command disables switch health monitoring
for a cluster or management switch.
Parameters
Specifies the name of the switch.
[-force [true]] - Force Delete (privilege: advanced)
Specifies if force delete or not.
Examples
cluster1::> system cluster-switch delete -device SwitchA
Disables monitoring for the switch named SwitchA.
system cluster-switch modify

Modify information about a switch's configuration
level.
Description
The system cluster-switch modify command modifies information about a
cluster switch or management switch. The cluster switch health monitor uses this
information to monitor the switch.
1302
Parameters
Specifies the device name of switch that you want to monitor.
[-address <IP Address>] - IP Address
Specifies the IP address of switch's management interface.
[-snmp-version {SNMPv1|SNMPv2c}] - SNMP Version
Specifies the SNMP version that Data ONTAP uses to communicate with the switch.
The default is SNMPv2c.
[-community <text>] - Community String
Specifies the community string for SNMPv2 authentication.
[-type {cluster-network|management-network}] - Switch Network
Specifies the switch type.
[-is-monitoring-enabled-admin {true|false}] - Enable Switch Monitoring
Specifies the switch admin monitoring status.
Examples
cluster1::> system cluster-switch modify -device SwitchA -ipaddress 2.3.4.5
Modifies the IP address for the switch named SwitchA.
system cluster-switch prepare-to-downgrade

Changes the model number of manually created switches based on the switch support
provided in the Data ONTAP releases earlier to 8.2.1
privilege level.
Description
This command changes switch information so it is compatible with Data ONTAP 8.2.
When executed, it changes the model numbers of the switches that are supported in
Data ONTAP 8.2.1 and not supported in Data ONTAP 8.2 to OTHER. It also deletes
1303
the entries of the switches which were deleted by the user but maintained for record by
the cluster switch health monitor. By doing these operations, it prepares cluster switch
health monitor to work smoothly in Data ONTAP 8.2.
Parameters
None
Examples
cluster1::> system cluster-switch prepare-to-downgrade
1304
system cluster-switch show-all

Displays the list of switches that were added and deleted
privilege level.
Description
The system cluster-switch show-all command displays configuration details
for discovered monitored cluster switches and management switches, including
switches that are user-deleted. From the list of deleted switches, you can delete a
switch permanently from the database to re-enable automatic discovery of that switch.
Parameters
Selects the fields that have the specified name.
| [-instance ] }
Selects detailed information for all the switches.
[-device <text>] - Device Name
Selects the switches that match the specified device name.
Selects the switches that match the specified IP address.
Selects the switches that match the specified SNMP version.
Selects the switches that match the specified community string.
[-discovered {true|false}] - Is Discovered
Selects the switches that match the specified discovery setting.
[-model {NX5010|NX5020|CAT2960|OTHER|NX5596|CN1610|CN1601}] - Model
Number
Selects the switches that match the specified model number.
1305

Selects the switches that match the specified switch type.
[-sw-version <text>] - Software Version
Selects the switches that match the specified software version.
[-is-monitoring-enabled-operational {true|false}] - Switch Monitoring Status
Selects the switches that match the specified operational monitoring status.
[-reason <text>] - Reason For Not Monitoring
Selects the switches that match the specified reason.
[-version-source <text>] - Source Of Switch Version
Selects the switches that match the specified version source (for example, from SNMP
or CDP or ISDP).
Examples
cluster1::> system cluster-switch show-all
Switch
Type
Address
Model
--------------------------- ------------------ -----------------------------SwitchA

1.2.3.4
cluster
Nexus5010
Is Monitored: yes
Reason:
Software Version: Cisco IOS 4.1N1
Version Source: CDP
The example above displays the configuration of all cluster switches and management
switches.
1306
system cluster-switch show

Display the configuration for cluster and management switches
level.
Description
The system cluster-switch show command displays configuration details for the
monitored cluster switches and management switches.
Parameters
Selects the fields that have the specified name.
| [-snmp-config ]
Displays the following information about a switch:
Device Name
Community String
SNMP Version
| [-status ]
Displays the following status information about a switch:
Is Discovered
Community String
Model Number
Switch Network
Software Version
Reason For Not Monitoring
Source Of Switch Version
Is Monitored ?
| [-instance ] }
1307
Selects detailed information for all the switches.

Selects the switches that match the specified device name.
Selects the switches that match the specified IP address.
Selects the switches that match the specified SNMP version.
[-is-discovered {true|false}] - Is Discovered
Selects the switches that match the specified discovery setting.
Selects the switches that match the specified community string.
[-model {NX5010|NX5020|CAT2960|OTHER|NX5596|CN1610|CN1601}] - Model
Number
Selects the switches that match the specified model number.
Selects the switches that match the specified switch type.
[-sw-version <text>] - Software Version
Selects the switches that match the specified software version.
[-reason <text>] - Reason For Not Monitoring
Selects the switches that match the specified reason.
[-version-source <text>] - Source Of Switch Version
Selects the switches that match the specified version source (for example, from SNMP
or CDP os ISDP).
[-is-monitoring-enabled-operational {true|false}] - Is Monitored ?
Selects the switches that match the specifed operational monitoring status.
Examples
cluster1::> system cluster-switch show
Switch
1308
Type
Address
Model
Software Version
----------- -------- ---------------- --------------------------------------SwitchA
cluster
1.2.3.4
Nexus5010
Cisco IOS 4.1N1
The example above displays the configuration of all cluster switches and management
switches.
cluster1::> system cluster-switch show -snmp-config
Name
Community
SNMP Version
------------- ------------ -----------SwitchA
public
SNMPv2c
The example above displays the community string, polling interval and SNMP version
for all cluster switches and management switches.
system cluster-switch polling-interval modify

Modify the polling interval for monitoring cluster and management switch health
privilege level.
Description
The system cluster-switch polling-interval modify command modifies
the interval in which the cluster switch health monitor polls cluster and management
switches.
Parameters
[-polling-interval <integer>] - Polling Interval
Specifies the interval in which the health monitor polls switches. The interval is in
minutes. The default value is 5. The allowed range of values is 2 to 120.
Examples
cluster1::> system cluster-switch polling-interval modify -polling-interval
41
Modifies the polling interval of the switches.
1309
system cluster-switch polling-interval show

Display the polling interval for monitoring cluster and management switch health
level.
Description
The system cluster-switch polling-interval show command displays the
polling interval used by the health monitor.
Parameters
None
Examples
cluster1::> system cluster-switch polling-interval show
Polling Interval (in minutes): 40
The example above displays the polling interval period for the switches.
system configuration backup copy

Copy a configuration backup
privilege level.
Description
The system configuration backup copy command copies a configuration
backup from one node in the cluster to another node in the cluster.
Use the system configuration backup show command to display configuration
backups to copy.
Parameters
-from-node {<nodename>|local} - Source Node
1310
Use this parameter to specify the name of the source node where the configuration
backup currently exists.
-backup <text> - Backup Name
Use this parameter to specify the name of the configuration backup file to copy.
-to-node {<nodename>|local} - Destination Node
Use this parameter to specify the name of the destination node where the configuration
backup copy is created.
Examples
The following example copies the configuration backup file node1.special.7z from
the node node1 to the node node2.
cluster1::*> system configuration backup copy -from-node node1 -backup
node1.special.7z -to-node node2
[Job 295] Job is queued: Copy backup job.
See Also
system configuration backup show
1311
system configuration backup create

Create a configuration backup
privilege level.
Description
The system configuration backup create command creates a new
configuration backup file.
Parameters
Use this parameter to specify the node on which to create the backup file.
[-backup-name <text>] - Backup Name
Use this parameter to specify the name of the backup file to create. The backup name
cannot contain a space or any of the following characters: * ? /
[-backup-type {node|cluster}] - Backup Type
Use this parameter to specify the type of backup file to create.
Examples
The following example creates a a new cluster configuration backup file called
node1.special.7z on the node node1.
cluster1::*> system configuration backup create -node node1 -backup-name
node1.special.7z -backup-type cluster
[Job 194] Job is queued: Cluster Backup OnDemand Job.
1312
system configuration backup delete

Delete a configuration backup
privilege level.
Description
The system configuration backup delete command deletes a saved
configuration backup.
Use the system configuration backup show command to display saved
configuration backups.
Parameters
Use this parameter to specify the name of the configuration backup file to delete.
Examples
The following example shows how to delete the configuration backup file
node1.special.7z from the node node1.
cluster1::*> system configuration backup delete -node node1 -backup
node1.special.7z
See Also
1313
system configuration backup download

Download a configuration backup
privilege level.
Description
The system configuration backup download command copies a configuration
backup from a source URL to a node in the cluster.
Parameters
Use this parameter to specify the name of the node to which the configuration backup is
downloaded.
-source <text> - Source URL
Use this parameter to specify the source URL of the configuration backup to download.
[-backup-name <text>] - Backup Name
Use this parameter to specify a new local file name for the downloaded configuration
backup.
Examples
The following example shows how to download a configuration backup file from a URL
to a file named exampleconfig.download.7z on the node node2.
cluster1::*> system configuration backup download -node node2 -source
http://www.example.com/config/download/nodeconfig.7z -backup-name
exampleconfig.download.7z
1314
system configuration backup rename

Rename a configuration backup
privilege level.
Description
The system configuration backup rename command changes the file name of
a configuration backup file.
Use the system configuration backup show command to display configuration
backups to rename.
Parameters
Use this parameter to specify the name of the configuration backup file to rename.
Use this parameter to specify a new name for the configuration backup file.
Examples
The following example renames the saved configuration file download.config.7z on
the node node1 to test.config.7z.
cluster1::*> system configuration backup rename -node node1 -backup
download.config.7z -new-name test.config.7z
See Also
1315

Show configuration backup information
privilege level.
Description
The system configuration backup show command displays information about
saved configuration backups.
Parameters
specify.
| [-instance ] }
about all fields.
Selects configuration backups that are saved on the node you specify.
[-backup <text>] - Backup Name
Selects configuration backups that have the backup name you specify.
[-backup-type {node|cluster}] - Backup Type
Selects configuration backups of the type you specify.
[-time <MM/DD HH:MM:SS>] - Backup Creation Time
Selects configuration backups that were saved on the date and time you specify.
[-cluster-name <text>] - Cluster Name
Selects configuration backups that were saved in the cluster that has the name you
specify.
1316
Selects configuration backups that were saved in the cluster that has the UUID you
specify.
[-size {<integer>[KB|MB|GB|TB|PB]}] - Size of Backup
Selects configuration backups that have the file size you specify.
[-nodes-in-backup {<nodename>|local}, ...] - Nodes In Backup
Selects configuration backups that include the configuration of the nodes you specify.
[-version <text>] - Software Version
Selects configuration backups that have the software version you specify.
[-is-auto {true|false}] - Backup Created from Schedule (true or false)
A value of true selects configuration backups that were created from a schedule. A
value of false selects configuration backups that were created manually.
[-schedule <text>] - Name of Backup Schedule
Selects configuration backups that were created by the schedule you specify.
Examples
cluster1::*> system configuration backup show
Node
Backup Tarball
Time
Size
---------
----------------------------------------- ------------------ -----
node1
cluster1.8hour.2011-02-22.18_15_00.7z
02/22 18:15:00
7.78MB
node1
cluster1.8hour.2011-02-23.02_15_00.7z
02/23 02:15:00
7.98MB
node1
cluster1.8hour.2011-02-23.10_15_00.7z
02/23 10:15:00
7.72MB
node1
cluster1.daily.2011-02-22.00_10_00.7z
02/22 00:10:00
7.19MB
node1
cluster1.daily.2011-02-23.00_10_00.7z
02/23 00:10:00
7.99MB
Press <space> to page down, <return> for next line, or 'q' to quit... q
1317
system configuration backup upload

Upload a configuration backup
privilege level.
Description
The system configuration backup upload command copies a configuration
backup from a node in the cluster to a remote URL.
Parameters
Use this parameter to specify the name of the node from which the configuration backup
is uploaded.
Use this parameter to specify the file name of the configuration backup to upload.
-destination <text> - Destination URL
Use this parameter to specify the destination URL of the configuration backup. Files
larger than 32MB cannot be transferred when using the TFTP protocol.
Examples
The following example show how to upload the configuration backup file
testconfig.7z from the node node2 to a remote URL.
cluster1::*> system configuration backup upload -node node2 -backup testconfig.7z
-destination ftp://www.example.com/config/uploads/testconfig.7z
system configuration backup settings modify

Modify configuration backup settings
privilege level.
1318
Description
The system configuration backup settings modify command changes
settings for configuration backup.
Parameters
[-destination <text>] - Backup Destination URL
Use this parameter to specify the destination URL for uploads of configuration backups.
Use the value "" to remove the destination URL.
[-username <text>] - Username for Destination
Use this parameter to specify the user name to use to log in to the destination system
and perform the upload. Use the system configuration backup settings
set-password command to change the password used with this user name.
[-numbackups1 <integer>] - Number of Backups to Keep for Schedule 1
Use this parameter to specify the number of backups created by backup schedule 1
to keep on the destination system. If the number of backups exceeds this number, the
oldest backup is removed.
Examples
The following example shows how to set the destination URL and user name used for
uploads of configuration backups.
cluster1::*> system configuration backup settings modify -destination ftp://
www.example.com/config/uploads/ -username admin
See Also
system configuration backup settings set-password
1319
system configuration backup settings setpassword

Modify password for destination URL
privilege level.
Description
The system configuration backup settings set-password command
sets the password used for uploads of configuration backups. This password is used
along with the username you specify using the system configuration backup
settings modify command to log in to the system and perform the upload. Enter the
command without parameters. The command prompts you for a password, and for a
confirmation of that password. Enter the same password at both prompts. The password
is not displayed.
Use the system configuration backup settings show command to display
the destination URL for configuration backups. Use the system configuration
backup settings modify command to change the destination URL and remote
username for configuration backups.
Parameters
None
Examples
The following example shows successful execution of this command.
cluster1::*> system configuration backup settings set-password
Enter the password:
Confirm the password:
See Also
system configuration backup settings show system configuration backup upload
1320
system configuration backup settings show

Show configuration backup settings
privilege level.
Description
The system configuration backup settings show command displays current
settings for configuration backup. These settings apply to backups created automatically
by schedules. By default, the command displays the URL to which configuration
backups are uploaded, and the user name on the remote system used to perform the
upload.
Use the system configuration backup settings set-password command
to change the password used with the user name on the destination. Use the system
configuration backup settings modify command to change the destination
URL and username for uploads of configuration backups, and to change the number of
backups to keep for each schedule.
Parameters
[-instance ]
Use this parameter to display detailed information about configuration backup settings,
including the number of backups to keep for each backup schedule.
Examples
The following example displays basic backup settings information.
cluster1::*> system configuration backup settings show
Backup Destination URL
Username
-------------------------------------------------- ------------ftp://www.example.com/config/uploads/
jdoe
The following example shows detailed output using the -instance parameter.
cluster1::*> system configuration backup settings show -instance
Backup Destination URL: ftp://www.example.com/config/uploads/
Username for Destination: admin
Schedule 1: 8hour
1321
Number of Backups to Keep for Schedule 1: 2

Schedule 2: daily
Schedule 3: weekly
See Also
system configuration backup settings set-password
1322
system configuration recovery cluster modify

Modify cluster recovery status
privilege level.
Description
The system configuration recovery cluster modify command modifies the
cluster recovery status. This command should be used to end the cluster recovery after
all recovery procedures are applied.
Parameters
[-recovery-status {complete|in-progress|not-in-recovery}] - Cluster Recovery Status
Use this parameter with the value complete to set the cluster recovery status after the
cluster has been recreated and all of the nodes have been rejoined to it. This enables
each node to resume normal system operations. The in-progress and not-inrecovery values are not applicable to this command.
Examples
The following example modifies the cluster recovery status.
source::> system configuration recovery cluster modify -recovery-status complete
system configuration recovery cluster recreate

Recreate cluster
privilege level.
Description
The system configuration recovery cluster recreate command re-creates
a cluster, using either the current node or a configuration backup as a configuration
template. After you re-create the cluster, rejoin nodes to the cluster using the system
configuration recovery cluster rejoin command.
1323
Parameters
-from {node|backup} - From Node or Backup
Use this parameter with the value node to re-create the cluster using the current node
as a configuration template. Use this parameter with the value backup to re-create the
cluster using a configuration backup as a configuration template.
[-backup <text>] - Backup Name
Use this parameter to specify the name of a configuration backup file to use
as a configuration template. If you specified the -from parameter with the value
backup, you must use this parameter and specify a backup name. Use the system
configuration backup show command to view available configuration backup
files.
Examples
The following example shows how to re-create a cluster using the node node1 as a
configuration template.
cluster1::*> system configuration recovery cluster recreate -from node
The following example shows how to re-create a cluster using the configuration backup
siteconfig.backup.7z as a configuration template.
cluster1::*> system configuration recovery cluster recreate -from backup -backup
siteconfig.backup.7z
See Also
system configuration backup show system configuration recovery cluster rejoin
1324
system configuration recovery cluster rejoin

Rejoin a cluster
privilege level.
Description
The system configuration recovery cluster rejoin command rejoins a
node to a new cluster created earlier using the system configuration recovery
cluster recreate command. Only use this command to recover a node from a
disaster. Because this synchronization can overwrite critical cluster information, and
will restart the node you specify, you are required to confirm this command before it
executes.
Parameters
-node {<nodename>|local} - Node to Rejoin
Use this parameter to specify the node to rejoin to the cluster.
Examples
This example shows how to rejoin the node node2 to the cluster.
cluster1::*> system configuration recovery cluster rejoin -node node2
Warning: This command will rejoin node "node2" into the local cluster,
potentially overwriting critical cluster configuration files. This
command should only be used to recover from a disaster. Do not perform
any other recovery operations while this operation is in progress.
This command will cause node "node2" to reboot.
See Also
1325
system configuration recovery cluster show

Show cluster recovery status
privilege level.
Description
The system configuration recovery cluster show command displays
the cluster recovery status. Cluster recovery status is "not-in-recovery" under normal
operations, and it becomes "in-progress" if a new cluster is created using the system
configuration recovery cluster recreate command with the -from backup
parameter. When cluster recovery status is "in-progress", wait until the output of the "Is
Recovery Status Persisted" field is true before using the system configuration
recovery cluster rejoin command to recover other nodes in the cluster.
Parameters
None
Examples
The following example displays the cluster recovery status.
source::> system configuration recovery cluster show
Recovery Status: in-progress
Is Recovery Status Persisted: true
See Also
system configuration recovery cluster rejoin
1326
system configuration recovery cluster sync

Sync a node with cluster configuration
privilege level.
Description
The system configuration recovery cluster sync command synchronizes
a node with the cluster configuration. Only use this command to recover a node from
a disaster. Because this synchronization can overwrite critical cluster information, and
will restart the node you specify, you are required to confirm this command before it
executes.
Parameters
-node {<nodename>|local} - Node to Synchronize
Use this parameter to specify the name of the node to synchronize with the cluster.
Examples
The following example shows the synchronization of the node node2 to the cluster
configuration.
cluster1::*> system configuration recovery cluster sync -node node2
Warning: This command will synchronize node "node2" with the cluster
configuration, potentially overwriting critical cluster configuration
files on the node. This feature should only be used to recover from a
disaster. Do not perform any other recovery operations while this
operation is in progress. This command will cause all the cluster
applications on node "node2" to restart, interrupting administrative
CLI and Web interface on that node.
All cluster applications on node "node2" will be restarted. Verify that the
cluster applications go online.
1327
system configuration recovery node restore

Restore node configuration from a backup
privilege level.
Description
The system configuration recovery node restore command restores the
configuration of the local node from a configuration backup file.
Use the system configuration backup show command to view available
configuration backup files.
Parameters
Use this parameter to specify the name of a configuration backup file to use as the
configuration template.
[-nodename-in-backup <text>] - Use Backup Identified by this Nodename
Use this parameter to specify a node within the configuration backup file to use as a
configuration template. Only specify this parameter if you are specifying a name other
than the name of the local node.
[-force [true]] - Force Restore Operation
Use this parameter with the value true to force the restore operation and overwrite the
current configuration of the local node. This overrides all compatibility checks between
the node and the configuration backup. The configuration in the backup is installed even
if it is not compatible with the node's software and hardware.
Use this parameter with the value false to be warned of the specific dangers of
restoring and be prompted for confirmation before executing the command. This value
also assures that the command performs compatibility checks between configuration
stored in the backup and the software and hardware of the node. The default is false.
Examples
The following example shows how to restore the configuration of the local node from
the configuration backup of node3 that is stored in the configuration backup file
example.backup.7z.
1328
cluster1::*> system configuration recovery node restore -backup example.backup.7z

Warning: This command overwrites local configuration files with files contained
in the specified backup file. Use this command only to recover from a
disaster that resulted in the loss of the local configuration files.
The node will reboot after restoring the local configuration.
See Also
1329
system controller show

Display the controller information
level.
Description
The system controller show command displays information about all the
controllers in the cluster. These commands are available for 80xx, 25xx and later
systems. Earlier models are not supported. By default, the command displays the
following information about all the controllers in the cluster:
Controller name
System ID
System serial number
Controller model name
Health monitor status
Parameters
| [-instance ] }
Displays detailed information about all the controllers in the cluster.
Selects information about the specified controller.
[-system-id <text>] - System ID
Selects information about the controller with the specified System ID.
[-model <text>] - Model Name
Selects information about the controllers with the specified model name.
[-part-number <text>] - Part Number
1330
Selects information about the controllers with the specified part number.
[-revision <text>] - Revision
Selects information about the controllers with the specified revision.
Selects information about the controller with the specified system serial number.
[-controller-type <text>] - Controller Type
Selects information about the controllers with the specified controller type.
Selects information about the controllers with the specified health monitor status.
Selects information about the controllers with the specified chassis ID.
Examples
The below example displays information about all controllers in the cluster.
cluster1::> system controller show
Controller Name
Model
System ID
Serial Number
Status
------------------------- ----------------------------- -------- ----------FAS2520
ok
FAS2520
ok
node1
140733730268652
700001456939
node2
140733730268667
700001456941
The example below displays detailed information about specified controller in the
cluster.
cluster1::> system controller show -instance -node node1
Node: node1
System ID: 140733730268652
Model Name: FAS2520
Part Number: 111-01316
Revision: 21
Controller Type: none
Status: ok
1331
1332
system controller bootmedia show

Display the Boot Media Device Health Status
level.
Description
The system controller bootmedia show command displays details of the
bootmedia devices present in all the nodes in a cluster. These commands are available
for 80xx, 25xx and later systems. Earlier models are not supported. By default, the
command displays the following information about the bootmedia:
Node name
Display name
Vendor ID
Device ID
Memory size
Bootmedia state
Parameters
| [-instance ] }
Displays detailed information for all the bootmedia devices.
Selects the bootmedia device that is present on the specified node.
[-vendor-id <Hex Integer>] - Vendor ID
Selects the bootmedia devices with the specified vendor ID.
[-device-id <Hex Integer>] - Device ID
1333
Selects the bootmedia devices with the specified device ID.

[-display-name <text>] - Display Name
Selects the bootmedia devices with the specified display name.
[-unique-name <text>] - Unique Name
Selects the bootmedia device with the specified unique name.
example}] - Health Monitor Name
Selects the bootmedia devices with the specified health monitor.
[-usbmon-status {present|not-present}] - USBMON Health Monitor
Selects the bootmedia devices with the specified USBMON status.
[-device-state {good|warn|bad}] - Bootmedia State
Selects the bootmedia devices with the specified device state.
[-size <integer>] - Max memory size(in MB)
Selects the bootmedia devices with the specified memory size.
[-health {ok|ok-with-suppressed|degraded|unreachable|unknown}] - Status
Selects the bootmedia devices with the specified health monitor status.
Examples
The example below displays the information of the bootmedia devices present in all the
nodes in a cluster.
cluster1::> system controller bootmedia show
Bootmedia
Node
Display Name
Vendor ID Device ID
Size State
Status
------------- -------------------- --------- --------- ------- --------- -----node1
Micron Technology
634
655
1929 good
ok
634
655
1929 good
ok
0x655
node2
Micron Technology
0x655
The example below displays the detailed information about the bootmedia present in a
node.
cluster1::> system controller bootmedia show -instance -node node1
1334
Node: node1
Vendor ID: 634
Device ID: 655
Display Name: Micron Technology 0x655
Unique Name: Micron Technology 0x655 (ad.0)
Health Monitor Name: controller
USBMON Health Monitor: present
Bootmedia State: good
Max memory size(in MB): 1929
Status: ok
1335
system controller config show-errors

Display configuration errors
level.
Description
The system controller config show-errors displays configuration errors.
These commands are available for 80xx, 25xx and later systems. Earlier models are not
supported.
node
description
Parameters
| [-instance ] }
Displays detailed information for all the PCI devices.
Displays configuration errors on the specified node.
[-description <text>] - Error Description
Displays the node with the specified configuration error.
Examples
The example below displays configuration errors on all the nodes in the cluster.
cluster1::> system controller config show-errors
Configuration Errors for Node: cluster1-01
-----------------------------------------------------------------------------Chelsio T320E 2x10G NIC card (PN X1008A) in slot 1 is not supported on model
FAS3210
1336
Configuration Errors for Node: cluster1-02

-----------------------------------------------------------------------------PCI-E Dual 10/100/1000 Ethernet G20 card (PN X1039A) in slot 2 is not supported
on model FAS3210
cluster::>
1337
system controller config pci show-add-on-devices

Display PCI devices in expansion slots
level.
Description
The system controller config pci show-add-on-devices command
displays information about the PCIe devices in I/O expansion slots. These commands
are available for 80xx, 25xx and later systems. Earlier models are not supported. The
command displays the following information about the PCIe devices:
Node
Model
Type
Slot
Device
Vendor
Sub-device ID
Parameters
| [-instance ] }
Displays detailed information about PCI devices.
Selects the PCI devices that are present in the specified node.
[-model <text>] - Model String
Selects the PCI devices that are present on the system with the specified model name.
[-type <integer>] - Device Type
1338
Selects the PCI devices with the specified device type.

[-slot <integer>] - PCI Slot Number
Selects the PCI devices present in the specified slot.
[-device <text>] - Device
Selects the PCI devices with the specified device ID.
[-vendor <text>] - Vendor Number
Selects the PCI devices with the specified vendor ID.
[-sub-device-id <integer>] - Sub Device ID
Selects the PCI devices with the specified sub-device ID.
Examples
The example below displays information about PCI devices found in I/O expansion slots
of all the nodes in the cluster.
cluster1::> system controller config pci show-add-on-devices
Node
Model
Slot Type Device
Vendor Sub-Device ID
------------------ ------------------- ---- ---- ------- ------ ------------cluster1-01
FAS6240
cluster1-02
0x2532 0x1077
10
0x1527 0x8086
0x6732 0x15B3
0x8030 0x1077
0x8001 0x11F8
15
0x10FB 0x8086
13
0x150E 0x8086
0x1528 0x8086
0x2532 0x1077
10
0x1527 0x8086
0x6732 0x15B3
0x8030 0x1077
FAS6240
0x8001 0x11F8
15
0x10FB 0x8086
13
0x150E 0x8086
0x1528 0x8086
1339
cluster1::>
1340
system controller config pci show-hierarchy

Display PCI hierarchy
level.
Description
The system controller config pci show-hierarchycommand displays the
PCI Hierarchy of all PCI devices found in a controller. These commands are available
for 80xx, 25xx and later systems. Earlier models are not supported. The command
displays the following information about the PCI devices:
Node
Level
Device
Link Capability
Link Status
Parameters
| [-instance ] }
Displays detailed information for PCI devices.
Displays the PCI hierarchy of the specified node.
[-level <integer>] - PCI Device Level
Displays the PCI devices that match the specified level within the PCI hierarchy.
[-pci-device <text>] - PCI Device
Displays the PCI devices that match the specified device description.
[-link-cap <text>] - Link Capability
1341
Displays the PCI devices that match the specified link capability.
[-link-status <text>] - Link Status
Displays the PCI devices that match the specified link status.
Examples
The example below displays the PCI hierarchy for all of the nodes in the cluster.
cluster1::> system controller config pci show-hierarchy
PCI Hierarchy
Node: cluster1-01
Level Device
Link
----- --------- ------------------------1
Br[3721](0,3,0): PCI Device 8086:3721 on Controller

LinkCap(MaxLkSp(2),MaxLkWd(4),ASPM(3),L0(3),L1(6),Port(68))
LinkStatus(LkSp(2),LkWd(4),DLAct),
Dv[8001](1,0,0): PMC SAS adapter on Controller

LinkStatus(LkSp(2),LkWd(4),SClk),

Dv[6274](2,0,0): PCI Device 15b3:6274 on Controller

LinkStatus(LkSp(1),LkWd(4)),

Br[3b42](0,28,0): PCI Device 8086:3b42 on Controller

LinkStatus(LkSp(1),LkWd(4),SClk,DLAct),
Dv[150e](4,0,0): Intel 1G NIC on Controller


1342
2

Br[3b4a](0,28,4): PCI Device 8086:3b4a on Controller

Dv[10d3](5,0,0): Intel 1G NIC on Controller

Br[3b4e](0,28,6): PCI Device 8086:3b4e on Controller


Node: cluster1-02
Level Device
Link
----- --------- ------------------------1

Dv[8001](1,0,0): PMC SAS adapter on Controller


Dv[6274](2,0,0): PCI Device 15b3:6274 on Controller


Br[3b42](0,28,0): PCI Device 8086:3b42 on Controller

1343
2



Br[3b4a](0,28,4): PCI Device 8086:3b4a on Controller


Br[3b4e](0,28,6): PCI Device 8086:3b4e on Controller



cluster::>
1344
system controller environment show

Display the FRUs in the controller
level.
Description
The system controller environment show displays information about all
environment FRUs in the cluster. These commands are available for 80xx, 25xx and
later systems. Earlier models are not supported. By default, the command displays the
following information about the environment FRUs in the cluster:
Node
FRU name
FRU state
Parameters
| [-instance ] }
Displays detailed information about the environment FRUs.
Selects information about all the environment FRUs that the specified node owns.
Selects information about all the environment FRUs with the specified serial number.
[-fru-name <text>] - FRU Name
Selects information about the environment FRU with the specified FRU name.
Selects information about all the environment FRUs with the specified FRU type.
1345
Selects information about all the environment FRUs with the specified unique name.
Selects information about all the environment FRUs with the specified FRU state.
Selects information about all the environment FRUs with the specified health monitor
status.
[-display-name <text>] - Display Name for the FRU
Selects information about all the environment FRUs with the specified display name.
Selects information about all the environment FRUs with the specified monitor.
Selects information about all the environment FRUs with the specified FRU model.
[-shared {shared|not_shared}] - Shared Resource
Selects information about all the environment FRUs with the specified sharing type.
Selects information about all the environment FRUs in the specified chassis.
Selects information about all the environment FRU with specified additional information.
Examples
The following example displays information about all major environment FRUs in the
cluster:
cluster1::> system controller environment show
Node
FRU Name
State
------------------ ------------------------------ -----------
1346
node1
PSU1 FRU
GOOD
node1
PSU2 FRU
GOOD
node2
PSU1 FRU
GOOD
node2
PSU2 FRU
GOOD
The following example displays detailed information about a specific environment FRU:
cluster1::> system controller environment show -node node1 -fru-name "PSU1 FRU" instance
Node: node1
FRU Serial Number: XXT122737891
FRU Name: PSU1 FRU
FRU Type: psu
Name: XXT122737891
FRU State: GOOD
Status: ok
Display Name for the FRU: PSU1 FRU
Monitor Name: controller
Model Type: none
Shared Resource: shared
Additional Information About the FRU: Part Number: 114-00065+A0
Revision: 020F
Manufacturer: NetApp
FRU Name: PSU
1347
system controller fru show

Display Information About the FRUs in the Controller
level.
Description
The system controller fru show command displays information about all the
controller specific Field Replaceable Units (FRUs) in the cluster. These commands are
available for 80xx, 25xx and later systems. Earlier models are not supported. By default,
the command displays the following information about all the FRUs in the cluster:
Node
FRU name
Health monitor subsystem
Parameters
| [-instance ] }
Displays detailed information about the controller specific FRUs in the cluster.
Selects information about the FRUs in the specified node.
[-subsystem <Subsystem>] - Subsystem
Selects information about the FRUs of the specified subsystem.
Selects information about the FRU with the specified serial number.
[-fru-name <text>] - Name of the FRU
Selects information about the FRU with the specified FRU name.
1348

Selects information about the FRU with the specified FRU type.
[-name <text>] - FRU Name
Selects information about the FRU with the specified unique name.
Selects information about the FRU with the specified state.
Selects information about the FRU with the specified health monitor status.
[-display-name <text>] - Display Name for the Fru
Selects information about the FRU with the specified display name.
Selects information about the FRU with the specified health monitor type.
Selects information about the FRU with the specified model.
Selects information about the FRU with the specified chassis ID.
[-location <text>] - Location of the FRU
Selects information about the FRU with the specified FRU location.
Selects information about the FRU with the specified additional information.
Examples
The example below displays information about all controller specific FRUs in the cluster.
cluster1::> system controller fru show
Node
Status
Subsystem
FRU Name
------------------ --------------------------------------------- ----------Environment
ok
Environment
ok
node1
PSU1 FRU
node1
PSU2 FRU
1349
node1
DIMM-NV1
Memory
node1
DIMM-1
Memory
node1
Micron Technology 0x655 (ad.0)
node2
PSU1 FRU
node2
PSU2 FRU
node2
DIMM-NV1
Memory
node2
DIMM-1
Memory
node2
Micron Technology 0x655 (ad.0)
ok
ok
Motherboard
ok
Environment
ok
Environment
ok
ok
ok
Motherboard
ok
The example below displays information about the specific FRU.

cluster1::> system controller fru show -instance -serial-number
AD-01-1306-2EA01E9A
Node: node1
Subsystem: Memory
FRU Serial Number: AD-01-1306-2EA01E9A
Name of the FRU: DIMM-1
FRU Type: dimm
FRU Name: DIMM-1
FRU State: ok
Status: ok
Display Name for the Fru: DIMM-1
Monitor Name: controller
Model Type: none
Location of the FRU: Memory Slot: 1
Additional Information About the FRU: Part No: HMT82GV7MMR4A-H9
1350
system controller ioxm show

Displays IOXM Device Health Status
level.
Description
The system controller ioxm show command displays the details of the IO
expansion modules (IOXMs) that are connected to the nodes in a cluster. These
commands are available for 80xx, 25xx and later systems. Earlier models are not
supported. By default, the command displays the following information about the IOXMs:
Node name
Display name
Is IOXM present?
Power status
Parameters
| [-instance ] }
Displays detailed information for all the IOXMs.
Selects the IOXM that is connected to the specified node.
[-chassis-config {c-i|c-c|c-b}] - Controller-IOXM or Controller-Controller or ControllerBlank
Selects the IOXMs with the specified chassis configuration.
[-is-present {present|not-present}] - IOXM Presence
1351
Selects the IOXMs that are connected and detected (present) or connected but not
detected (not-present).
[-power {good|bad}] - Power to IOXM
Selects the IOXMs with the specified power state.
Selects the IOXMs with the specified display name.
Selects the IOXM with the specified unique name.
Selects the IOXMs with the specified health monitor.
[-status {ok|ok-with-suppressed|degraded|unreachable|unknown}] - IOXM Health
Selects the IOXMs with the specified health monitor status.
Examples
The example below displays the information of all the IOXMs that are connected to the
nodes in a cluster.
cluster1::> system controller ioxm show
Node
Display Name Is-Present? Power
Status
------------- ------------ ----------- --------- -----node1
IOXM
present
good
ok
node2
IOXM
present
good
ok
The example below displays detailed information of an IOXM that is connected to a

node.
cluster1::> system controller ioxm show -instance -node node1
Node: node1
Controller-IOXM or Controller-Controller or Controller-Blank: c-i
IOXM Presence: present
Power to IOXM: good
Display Name: node1/IOXM
Unique Name: 8006459930
1352
IOXM Health: ok
1353
system controller memory dimm show

Display the Memory DIMM Table
level.
Description
The system controller memory dimm show command displays information about
the DIMMs in all the nodes in the cluster. These commands are available for 80xx, 25xx
and later systems. Earlier models are not supported. By default, the command displays
the following information about all the DIMMs in the cluster:
Node
DIMM name
Uncorrectable ECC error count
Correctable ECC error count
CPU socket
Channel
Slot number
Parameters
| [-instance ] }
Displays detailed information about the DIMMs in all the controllers in the cluster.
Selects information about the DIMMs in the specified node.
[-pds-id <integer>] - DIMM ID
Selects information about the DIMMs with the specified DIMM ID.
1354
[-slotname <text>] - Slot Name

Selects information about the DIMMs with the specified slot name.
[-socket <integer>] - CPU Socket
Selects information about the DIMMs with the specified socket ID.
[-channel <integer>] - Channel
Selects information about the DIMMs with the specified channel number.
[-slot-no <integer>] - Slot Number on a Channel
Selects information about the DIMMs with the specified slot number.
Selects information about the DIMMs with the specified serial number.
[-part-no <text>] - Part Number
Selects information about the DIMMs with the specified part number.
[-cecc-count <integer>] - Correctable ECC Error Count
Selects information about the DIMMs with the specified correctable ECC error count.
[-uecc-count <integer>] - Uncorrectable ECC Error Count
Selects information about the DIMMs with the specified uncorrectable ECC error count.
Selects information about the DIMMs with the specified health monitor.
Selects information about the DIMMs with the specified health monitor status.
[-name <text>] - Unique Name of DIMM
Selects information about the DIMMs with the specified unique name.
[-display-name <text>] - Display Name for the DIMM
Selects information about the DIMMs with the specified display name.
Examples
The example below displays information about the DIMMs in all the nodes in the cluster.
cluster1::> system controller memory dimm show
1355
DIMM
UECC
CECC
CPU
Name
Count
Count
Socket
--------
---------
Slot
Channel
Number
Node
Status
-------
------
-------------- ------- -------------
ok
ok
ok
ok
node1
DIMM-1
node1
DIMM-NV1
node2
DIMM-1
node3
DIMM-NV1
The example below displays detailed information about a specific DIMM in a specific
controller.
cluster1::> system controller memory dimm show -instance -node node1 -pds-id 1
Node: node1
DIMM ID: 1
Slot Name: DIMM-1
CPU Socket: 0
Channel: 0
Slot Number on a Channel: 0
Serial Number: AD-01-1306-2EA01E9A
Part Number: HMT82GV7MMR4A-H9
Correctable ECC Error Count: 0
Uncorrectable ECC Error Count: 0
Status: ok
Unique Name of DIMM: DIMM-1
Display Name for the DIMM: DIMM-1
1356
system controller pci show

Display the PCI Device Table
level.
Description
The system controller pci show command displays details of the PCI devices
present in all of the nodes in a cluster. These commands are available for 80xx, 25xx
and later systems. Earlier models are not supported. By default, the command displays
the following information about the PCI devices:
Node name
Display name
Correctable error count
Functional link width
Functional link speed
Parameters
| [-instance ] }
Displays detailed information for all of the PCI devices.
Selects the PCI devices that are present in the specified node.
[-bus-number <integer>] - Bus Number
Selects the PCI devices with the specified bus number.
[-device-number <integer>] - Device Number
Selects the PCI devices with the specified device number.
1357
[-function-number <integer>] - Function Number

Selects the PCI devices with the specified function number.
[-slot-number <integer>] - Slot Info
Selects the PCI devices with the specified slot number.
Selects the PCI devices monitored by the specified health monitor.
[-vendor-id <Hex Integer>] - Vendor ID
Selects the PCI devices with the specified vendor ID.
[-device-id <Hex Integer>] - Device ID
Selects the PCI devices with the specified device ID.
[-physical-link-width <integer>] - Physical Link Width
Selects the PCI devices with the specified physical link width.
[-functional-link-width <integer>] - Functional Link Width
Selects the PCI devices with the specified functional link width.
[-physical-link-speed <text>] - Physical Link Speed(GT/s)
Selects the PCI devices with the specified physical link speed.
[-functional-link-speed <text>] - Functional Link Speed(GT/s)
Selects the PCI devices with the specified functional link speed.
Selects the PCI devices with the specified unique name.
[-corr-err-count <integer>] - Correctable Error Count
Selects the PCI devices with the specified correctable error count.
[-health {ok|ok-with-suppressed|degraded|unreachable|unknown}] - Status
Selects the PCI devices with the specified health monitor status.
Selects the PCI devices with the specified display name.
[-cerr-diff <integer>] - Correctable Error Difference
Selects the PCI devices with the specified difference in correctable error count.
1358
Examples
The example below displays the information about the PCIe devices present in all of the
nodes in the cluster.
cluster1::> system controller pci show
Node
Display
Correctable Functional Functional
Name
Error Count Link Width Link Speed Status
------------- ------------------------ ----------- ---------- ---------- -----cluster1-01
Ontap PCI Device 0
5GT/s ok
cluster1-02
Ontap PCI Device 4
5GT/s ok
The example below displays detailed information about a PCIe device in a node.
cluster1::> system controller pcie show -instance -node cluster1-01 -bus-number 1
Node: cluster1-01
Bus Number: 1
Device Number: 0
Function Number: 0
Slot Info: 0
Vendor ID: 11f8
Device ID: 8001
Physical Link Width: 4
Functional Link Width: 4
Physical Link Speed(GT/s): 5GT/s
Functional Link Speed(GT/s): 5GT/s
Unique Name: ontap0@pci0:1:0:0
Correctable Error Count: 0
Status: ok
Display Name: Ontap PCI Device 0
Correctable Error Difference: 0
1359
system controller sp config show

Display the Service Processor Config Table
level.
Description
The system controller sp config show command displays the following
configuration information of the service processor for all nodes in the cluster:
Node name
Service processor status
Service processor firmware version
Booted firmware version
Service processor configuration status
Physical Ethernet link status of service processor
To display more details, use the -instance parameter. These commands are available for
80xx, 25xx and later systems. Earlier models are not supported.
Parameters
Selects the field that you specify.
| [-instance ] }
Displays detailed configuration information of the service processor.
Use this parameter to list the service processor configuration of the specific node.
[-version <text>] - Firmware Version
Selects the service processor configuration with the specified firmware version.
[-boot-version {primary|backup}] - Booted Version
1360
Selects the service processor configuration with the specified version of the currently
booted partition.
Selects the service processor configuration with the specified monitor name.
[-sp-status {online|offline|sp-daemon-offline|node-offline|degraded|rebooting|unknown}]
- SP Status
Selects the service processor configuration with the specified status of service
processor.
[-sp-config {true|false}] - Configured
Selects information about the service processor with the specified configuration status of
the service processor.
Selects the service processor configuration information with the specified service
processor status.
[-link-status {up|down|disabled|unknown}] - Public Link Status
Selects the service processor configuration with the specified physical ethernet link
status.
[-name <text>] - Display Name
Selects the service processor configuration with the specified unique name.
Examples
The example below displays configuration of the service processor in all the nodes in
the cluster:
cluster1::> system controller sp config show
Firmware
Booted
Node
Version
Version
----
--------
--------- ------------ -------- --------- ------
Configured
SP
Link
Status
Status
Status
node1
2.2.2
primary
true
online
up
ok
node2
2.2.2
primary
true
online
up
ok
The example below displays configuration of the service processor of a particular node
in detail:
1361
cluster1::> system controller sp config show -instance -node node1

Node: node1
Firmware Version: 2.2.2
Booted Version: primary
SP Status: online
Configured: true
Status: ok
Public Link Status: up
Display Name: SP Config
1362
system controller sp upgrade show

Display the Service Processor Upgrade Table
level.
Description
The system controller sp upgrade show command displays the following
information about the service processor firmware of all the nodes in the cluster:
Node name
Is new firmware available?
Is autoupdate enabled?
Status of autoupdate
To display more details, use the -instance parameter. These commands are available for
80xx, 25xx and later systems. Earlier models are not supported.
Parameters
| [-instance ] }
Displays detailed upgrade information of the service processor.
Use this parameter to list the upgrade information of the service processor on the
specified node.
[-new-fw-avail {true|false}] - New Firmware Available
Selects the information of the service processors which have new firmware available.
[-new-fw-version <text>] - New Firmware Version
Selects the information about service processors with the specified firmware version.
[-auto-update {true|false}] - Auto Update
1363
Selects the information about service processors with the specified state.
[-auto-update-stat {installed|corrupt|updating|auto-updating|none}] - Auto Update
Status
Selects the information about service processors with the specified auto update status.
[-auto-update-sttime <MM/DD/YYYY HH:MM:SS>] - Auto Update Start Time
Selects the information about service processors with the specified start time.
[-auto-update-entime <MM/DD/YYYY HH:MM:SS>] - Auto Update End Time
Selects the information about service processors with the specified end time.
[-auto-update-per <integer>] - Auto Update Percent Done
Selects the information about service processors with the specified auto update
percentage completed.
[-auto-update-maxret <integer>] - Auto Update Maximum Retries
Selects the information about service processors with the specified maximum number of
retries.
[-auto-update-curret <integer>] - Auto Update Current Retries
Selects the information about service processors with the specified number of current
retries.
[-auto-update-prevstat {failed|passed}] - Previous AutoUpdate Status
Selects the information about service processors with the specified automatic update
status.
Selects the information about service processors with the specified monitor name.
Selects the information about service processors with the specified health monitor
status.
[-name <text>] - Display Name
Selects the information about service processors with the specified display name.
Examples
1364
The example below displays service processor upgrade information for all nodes in the
cluster:
cluster1::> system controller sp upgrade show
New
Firmware
Auto Update
Auto Update
Node
Available
Feature
Status
Status
----
---------------
------------
--------------
---------
node1 false
true
installed
ok
node2 false
true
installed
ok
The example below displays the detailed service processor upgrade information for a
specific node:
cluster1::> system controller sp upgrade show -instance -node node1
Node: node1
New Firmware Available: false
New Firmware Version: Not Applicable
Auto Update: true
Auto Update Status: installed
Auto Update Start Time: Thu Oct 20 20:06:03 2012 Etc/UTC
Auto Update End Time: Thu Oct 20 20:09:19 2012 Etc/UTC
Auto Update Percent Done: 0
Auto Update Maximum Retries: 5
Auto Update Current Retries: 0
Previous AutoUpdate Status: passed
Status: ok
Display Name: SP Upgrade
1365
system feature-usage show-history

Display Feature Usage History
level.
Description
Display feature usage information in the cluster on a per-node and per-week basis.
Parameters
specify.
| [-instance ] }
about all fields.
Displays feature usage information for the specified node name.
[-serial-number <Node Serial Number>] - Node Serial Number
Displays feature usage information for the specified serial number.
[-feature-name <Managed Feature>] - Feature Name
Displays feature usage information for the specified feature name.
[-week-number <Sequence Number>] - Week Number
Displays feature usage information for the specified week number.
[-usage-status {not-used|configured|in-use|not-available}] - Usage Status
Displays feature usage information that matches the specified usage status.
[-date-collected <MM/DD/YYYY HH:MM:SS>] - Collection Date
Displays feature usage information that is collected on the day matching the specified
date.
1366

Displays feature usage information for the specified owner name.
[-feature-message <text>] - Feature Message
Displays feature usage information that contains the specified feature message.
Examples
The following example displays a usage output filtered by the serial number and feature
name:
cluster1::> system feature-usage show-history -serial-number
1-81-0000000000000001122334455 -feature-name NFS
Node Serial Number: 1-81-0000000000000001122334455
Feature Name: NFS
Owner: node1
Week # Usage Status
Date Collected
Feature Message
------ ----------------- -------------------- -------------------------4 in-use
01/22/13 10:00:00
3 in-use
01/15/13 10:00:00
2 not-used
01/08/13 10:00:00
1 configured
01/01/13 10:00:00
1367
system feature-usage show-summary

Display Feature Usage Summary
level.
Description
Display usage summary information about features in the cluster on a per-node basis.
The summary information includes counter information such as the number of weeks
the feature was in use and the last date and time the feature was used. Additional
information can also be displayed by using the -instance parameter.
Parameters
specify.
| [-instance ] }
about all fields.
[-serial-number <Node Serial Number>] - Node Serial Number
Displays usage summary information for the specified serial number.
[-feature-name <Managed Feature>] - Feature Name
Displays usage summary information for the specified feature name.
[-weeks-in-use <integer>] - Weeks In-Use
Displays usage summary information for features matching the number of weeks in use.
[-last-used <MM/DD/YYYY HH:MM:SS>] - Date last used
Displays usage summary information for features last used on the specified date.
Displays usage summary information for the specified owner name.
[-weeks-not-used <integer>] - Weeks Not Used
1368
Displays usage summary information for features matching the number of weeks not in
use.
[-weeks-configured <integer>] - Weeks Configured
Displays usage summary information for features matching the number of weeks that
the feature was in configuration.
[-weeks-not-available <integer>] - Weeks Data Not Available
Displays usage summary information for features matching the number of weeks when
usage data was not available.
Examples
The following example displays a usage summary output for a cluster of two nodes:
cluster1::> system feature-usage show-summary
Owner: node1
Feature Name
Weeks In Use
------------
----------------- --------------------
Date Last Used
CIFS
10 1/1/2013 23:27:49
NFS
15 1/8/2013 23:48:03

Owner: node2
Feature Name
Weeks In Use
------------
----------------- --------------------
Date Last Used
CIFS
10 1/1/2013 23:26:38
NFS
20 1/8/2013 23:46:48
1369
system health alert delete

Delete system health alert
level.
Description
The system health alert delete command deletes all the alerts on the cluster
with the specified input parameters.
Parameters
Use this parameter to delete alerts generated on a cluster only on the node you specify.
-monitor <hm_type> - Monitor
Use this parameter to delete alerts generated on a cluster only on the monitor you
specify.
-alert-id <text> - Alert ID
Use this parameter to delete alerts generated on a cluster only on the alert ID you
specify.
-alerting-resource <text> - Alerting Resource
Use this parameter to delete alerts generated on a cluster on the alerting resource you
specify.
Examples
This example shows how to delete an alert with the specified alert-id:
cluster1::> system health alert delete -alert-id
DualPathToDiskShelf_Alert -alerting-resource *
system health alert modify

Modify system health alert
1370

level.
Description
The system health alert modify command suppresses alerts generated on the
cluster and sets the acknowledgement state for an alert.
Parameters
Use this parameter to specify the node on which you want to change the state.
Use this parameter to specify the monitor name on which you want to change the state.
-alert-id <text> - Alert ID
Use this parameter to specify the alert ID on which you want to change the state.
-alerting-resource <text> - Alerting Resource
Use this parameter to specify the alerting resource name on which you want to change
the state.
[-acknowledge {true|false}] - Acknowledge
Use this parameter to set the acknowledgement state to true or false.
[-suppress {true|false}] - Suppress
Use this parameter to set the suppress state to true or false.
[-acknowledger <text>] - Acknowledger
Use this parameter to set the acknowledger as the filter for setting state.
[-suppressor <text>] - Suppressor
Use this parameter to set the suppressor as the filter for setting state.
Examples
This example modifies the alert field states on the cluster:
cluster1::> system health alert modify -node * -alert-id
DualPathToDiskShelf_Alert -suppress true
1371
system health alert show

View system health alerts
level.
Description
The system health alert show command displays information about all the alerts
generated on the system. Using -instance will add detailed information.
Parameters
| [-instance ] }
Displays the following additional information about each alert:
Node name
Resource name
Severity of the alert
Time of alert generation
Suppress state of the alert
Acknowledge state of the alert
Probable cause for the alert
Possible effect due to the alert
Recommended corrective actions to follow
Selects the alerts generated for the specified node.
[-monitor <hm_type>] - Monitor
Selects the alerts with the specified monitor name.
[-alert-id <text>] - Alert ID
1372
Selects the alerts with the specified alert ID.

[-alerting-resource <text>] - Alerting Resource
Selects the alerts with the specified alerting resource name.
[-subsystem <hm_subsystem>] - Subsystem
Selects the alerts generated on the monitoring subsystem.
[-indication-time <Date>] - Indication Time
Selects the alerts with the specified indicated time.
[-perceived-severity <hm_perceived_sev>] - Perceived Severity
Selects the alerts with the perceived severity level.
[-probable-cause <hm_probable_cause>] - Probable Cause
Selects the alerts that contain the specified probable cause.
[-probable-cause-description <text>] - Description
Selects the alerts containing the specified probable cause description.
[-corrective-actions <text>] - Corrective Actions
Selects the alerts with the specified recommended corrective action.
[-possible-effect <text>] - Possible Effect
Selects the alerts with the specified possible effect.
[-acknowledge {true|false}] - Acknowledge
Selects the alerts with the specified acknowledgement status.
[-suppress {true|false}] - Suppress
Selects the alerts with the specified suppressor field status of true or false.
[-policy <text>] - Policy
Selects the alerts with the specified policy name.
[-acknowledger <text>] - Acknowledger
Selects the alerts with the specified acknowledger field.
[-suppressor <text>] - Suppressor
Selects the alerts with the specified suppressor field.
[-additional-info <text>, ...] - Additional Information
1373
Selects the alerts with the specified additional information.

[-alerting-resource-name <text>] - Alerting Resource Name
Selects the alerts with the specified alerting resource name.
[-tags <hm_alert_type>, ...] - Additional Alert Tags
Selects the alerts with the specified keywords.
Examples
The example below displays information about all the alerts generated in the cluster:
cluster1::> system health alert show
Node: node1
Resource: Shelf ID 2
Severity: Major
Suppress: false
Acknowledge: false
Tags: quality-of-service, nondisruptive-upgrade
Probable Cause: Disk shelf 2 does not have two paths to controller
node1.
Possible Effect: Access to disk shelf 2 via controller node1 will be
lost with a single hardware component failure (e.g.
cable, HBA, or IOM failure).
Corrective Actions: 1. Halt controller node1 and all controllers attached to
disk shelf 2.
2. Connect disk shelf 2 to controller node1 via two paths
following the rules in the Universal SAS and ACP Cabling Guide.
3. Reboot the halted controllers.
4. Contact support personnel if the alert persists.
The example below displays additional information about a specific alert generated in
the cluster:
cluster1::> system health alert show -monitor node-connect -alert-id
DualPathToDiskShelf_Alert -instance
Node: node1
Monitor: node-connect
Alert ID: DualPathToDiskShelf_Alert
Alerting Resource: 50:05:0c:c1:02:00:0f:02
Subsystem: SAS-connect
1374
Indication Time: Mon Mar 21 10:26:38 2011

Perceived Severity: Major
Probable Cause: Connection_establishment_error
Description: Disk shelf 2 does not have two paths to controller node1.
Corrective Actions: 1. Halt controller node1 and all controllers attached to
disk shelf 2.
2. Connect disk shelf 2 to controller node1 via two paths
following the rules in the Universal SAS and ACP Cabling Guide.
Possible Effect: Access to disk shelf 2 via controller node1 will be lost
with a single hardware component failure (e.g. cable, HBA, or IOM failure).
Acknowledge: false
Suppress: false
Policy: DualPathToDiskShelf_Policy
Acknowledger: Suppressor: Additional Information: Shelf uuid: 50:05:0c:c1:02:00:0f:02
Shelf id: 2
Shelf Name: 4d.shelf2
Number of Paths: 1
Number of Disks: 6
Adapter connected to IOMA:
Adapter connected to IOMB: 4d
Alerting Resource Name: Shelf ID 2
Additional Alert Tags: quality-of-service, nondisruptive-upgrade
1375
system health alert definition show

Display system health alert definition
level.
Description
The system health alert definition show command displays information
about the various alerts defined in the system health monitor policy file. Using instance will display additional details.
Parameters
| [-instance ] }
Use this parameter to display additional information on each alert definition.
Node name
Monitor name
Subsystem identifier
Alert ID
Severity of the alert
Probable cause
Probable cause description
Possible effect due the error state
Recommended corrective actions to be followed
Any additional information
Additional alert tags
Selects the alert definitions for the specified node.
1376

Selects the alert definitions with the specified monitor name.
[-alert-id <text>] - Class of Alert
Selects the alert definitions with the specified alert identifier.
[-perceived-severity <hm_perceived_sev>] - Severity of Alert
Selects the alert definitions with the specified perceived severity.
Selects the alert definitions with the specified probable cause of the alert.
[-probable-cause-description <text>] - Probable Cause Description
Selects the alert definitions with the specified probable cause description.
[-possible-effect <text>] - Possible Effect
Selects the alert definitions with the specified possible effect.
Selects the alert definitions with the specified corrective action.
[-subsystem <hm_subsystem>] - Subsystem Name
Selects the alert definitions with the specified subsystem.
[-additional-information <text>] - Additional Relevant Data
Selects the alert definitions with the specified additional information.
[-tags <hm_alert_type>, ...] - Additional Alert Tags
Selects the alert definitions with the specified keywords.
Examples
The example below displays information about all the definitions in the alert definition
file:
cluster1::> system health alert definition show
Node
Monitor
Subsystem
Alert ID
------------- ---------------------- ----------------- ----------------------node-01
system-connect
SAS-connect
DualControllerNonHa_
Alert
Severity: Major
Probable Cause: Configuration_error
1377
Probable Cause Description: Disk shelf $(sschm_shelf_info.id) is connected to

two controllers
($(sschm_shelf_info.connected-nodes)) that are
not an HA pair.
Possible Effect: Access to disk shelf $(sschm_shelf_info.id) may
be lost with a single controller failure.
Corrective Actions: 1. Halt all controllers that are connected to disk
shelf $(sschm_shelf_info.id).
2. Connect disk shelf $(sschm_shelf_info.id) to both
HA controllers following the rules in the Universal SAS and ACP Cabling Guide.
Additional Info: Tags: quality_of_service, nondisruptive-upgrade
The example below displays detailed information about the definitions in the alert
definition file:
cluster1::> system health alert definition show -instance
Node: krivC-01
Monitor: system-connect
Class of Alert: DualControllerNonHa_Alert
Severity of Alert: Major
Probable Cause: Configuration_error
Probable Cause Description: Disk shelf $(sschm_shelf_info.id) is connected to two
controllers ($(sschm_shelf_info.connected-nodes)) that are not an HA pair.
Possible Effect: Access to disk shelf $(sschm_shelf_info.id) may be
lost with a single controller failure.
Corrective Actions: 1. Halt all controllers that are connected to disk
shelf $(sschm_shelf_info.id).
2. Connect disk shelf $(sschm_shelf_info.id) to
both HA controllers following the rules in the Universal SAS and ACP Cabling
Guide.
4. Contact support personnel if the alert
persists.
Subsystem Name: SAS-connect
Additional Relevant Data: Additional Alert Tags: quality_of_service, nondisruptive-upgrade
1378
system health autosupport trigger history show

View system health alert history
level.
Description
The system health autosupport trigger history show command displays
all the alert triggers in the cluster that generated the AutoSupport messages. The
following fields are displayed in the output:
Node name
Monitor name
Subsystem
Alert identifier
Alerting resource
Severity
If an AutoSupport has been sent due to this alert
Parameters
Use this parameter to display only the fields you specify.
| [-instance ] }
Use this parameter to display additional information about all of the alerts that were
generated.
Use this parameter to display AutoSupport trigger history on the specified node.
Use this parameter to display AutoSupport trigger history with the specified monitor
name.
1379
Use this parameter to display the AutoSupport message that was triggered by the
specified alert ID.
[-alerting-resource <text>] - Alerting Resource
specified alerting resource.
specified subsystem.
[-indication-time <Date>] - Indication Time
Use this parameter to display the AutoSupport message that was triggered at the
indicated time.
[-perceived-severity <hm_perceived_sev>] - Perceived Severity
Use this parameter to display the AutoSupport message that was triggered by alerts
with the specified perceived severity.
[-autosupport-triggered {true|false}] - AutoSupport Triggered
Use this parameter to display the alerts that generated AutoSupport messages.
Use this parameter to display the alerts that were generated with the specified probable
cause.
Use this parameter to display the AutoSupport alerts with the specified corrective
actions.
[-asup-enable {true|false}] - Enable Asup for This Alert
Use this parameter to enable or disable an AutoSupport message for this alert.
[-alert-clear-time <Date>] - Alert Clear Time
Use this parameter to display the alerts that were cleared at a given time.
Examples
This example displays information about the AutoSupport trigger history
cluster1::> system health autosupport trigger history show
1380
Node
Monitor
------------
---------------------- ----------------- ----------------------
Subsystem
Alert ID
node1
node-connect
SAS-connect
DualPathToDiskShelf_
Alert
Resource: 50:05:0c:c1:02:00:0f:02
Severity: Major
AutoSupport sent: true
This example displays info about the autosupport trigger history in detail
cluster1::> system health autosupport trigger history show -instance
Node: node1
Alert ID: DualPathToDiskShelf_Alert
Alerting Resource: 50:05:0c:c1:02:00:0f:02
Indication Time: Thu Mar 17 11:59:09 2011
Perceived Severity: Major
AutoSupport Triggered: true
Probable Cause: Connection_establishment_error
Corrective Actions: 1. Halt controller node1 and all controllers attached
to disk shelf 2.
2. Connect disk shelf 2 to controller node1 via two paths following the rules in
the Universal SAS and ACP Cabling Guide.
Enable asup for this alert: true
Alert Clear Time: Wed May 29 16:10:13 2013
1381
system health config show

Display system health configuration
level.
Description
The system health config show command displays the configuration and
status of each health monitor in the cluster. The command shows a health status for
each health monitor. The health status is an aggregation of the subsystem health for
each subsystem that the health monitor monitors. For example, if a health monitor
monitors two subsystems and the health status of one subsystem is "ok" and the other
is "degraded", the health status for the health monitor is "degraded".
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to list the health monitors present on the specified node.
Use this parameter to display the health monitors with the specified monitor name.
[-subsystem <hm_subsystem>, ...] - Subsystem
Selects the health monitors with the specified subsystems.
[-health {ok|ok-with-suppressed|degraded|unreachable|unknown}] - Health
Selects the health monitors with the specified health status.
[-mon-version <text>] - Monitor Version
Selects the health monitors with the specified monitor version.
1382
[-pol-version <text>] - Policy File Version

Selects the health monitors with the specified health monitor policy version.
[-context {Node |Cluster}] - Context
Selects the health monitors with the specified running context.
[-aggregator <hm_type>] - Aggregator
Selects the health monitors with the specified aggregator.
[-resources <text>, ...] - Resource
Selects the health monitors with the specified resource name.
[-init-state {Invalid|Initailizing|Initialized|Starting_Discovery|Starting_Re-Discovery|
Discovery_Done_Partially|Discovery_Done}] - Subsystem Initialization Status
Selects the health monitors with the specified subsystem initialization state.
[-sub-pol-versions <text>] - Subordinate Policy Versions
Selects the health monitors with the specified subordinate policy version.
Examples
The example below displays information about health monitor configuration:
cluster1::> system health config show
Node
Monitor
Subsystem
Health
------------- ---------------------- ----------------- -----------------node1
node-connect
SAS-connect
degraded
node1
system-connect
SAS-connect
degraded
node1
system
SAS-connect
degraded
The example below displays detailed information about health monitor configuration:
cluster1::> system health config show -instance
Node: node1
Health: degraded
Monitor Version: 1.0
Policy File Version: 1.0
Context: node_context
1383
Aggregator: system-connect
Resource: SasAdapter, SasDisk, SasShelf
Subsystem Initialization Status: initialized
Subordinate Policy Versions: 1.0 SAS, 1.0 SAS multiple adapters
1384
system health node-connectivity adapter show

Show adapter resources and connectivity status
level.
Description
The system health node-connectivity adapter show command displays
information about the adapters present on the different nodes in the cluster. By default,
the command displays the following information about all adapters:
Owner node name
Adapter name
Adapter is in use
Adapter is enabled
Number of shelves attached to the adapter
Detailed status information
Parameters
specify.
| [-instance ] }
about all fields.
Selects information about the shelves that the specified node owns.
[-adapter-name <text>] - Adapter Name
Selects information about the specified adapter name.
1385
Selects information about the specified monitor name.
[-wwn <text>] - WWN
Selects information about the adapter with the specified Word Wide Node name.
[-in-use {true|false}] - In Use?
Selects information about the adapters currently in use.
[-is-enabled {true|false}] - Is Enabled?
Selects information about the adapters that are enabled.
[-is-dual-attached {true|false}] - Adapter Dual Attached
Selects information about the adapters that have dual attachments.
Selects information about the adapters with the specified status.
[-slot-num <integer>] - Slot Number
Selects information about the adapters with the specified slot number.
Selects information about the adapters with the specified port name.
[-iom-port {Circle|Square}] - IOM Port to be Connected to
Selects information about the adapters connected to the specified IOM port, either IOMA
or IOMB.
[-num-shelf <integer>] - Number of Shelves
Selects information about the adapters with the specified number of shelves.
[-shelf-list <text>, ...] - List of Shelves
Selects information about the adapters with the specified shelf list.
[-num-ioma <integer>] - Number of Shelves Connected to IOMA
Selects information about the adapters with the specified number of shelves that are
connected to IOMA.
[-ioma-list <text>, ...] - List of Shelves Connected to IOMA
Selects information about the adapters with the specified shelves that are connected to
IOMA.
1386
[-num-iomb <integer>] - Number of Shelves Connected to IOMB

Selects information about the adapters with the specified number of shelves that are
connected to IOMB.
[-iomb-list <text>, ...] - List of Shelves Connected to IOMB
Selects information about the adapters with the specified shelves that are connected to
IOMB.
[-num-circle-port <integer>] - Number of Shelves Connected to Circle port
Selects information about the adapters with the specified number of shelf circle ports.
[-circle-port-list <text>, ...] - List of Shelves Connected to Circle port
Selects information about the adapters with the specified list of shelves with circle ports
connected.
[-num-square-port <integer>] - Number of Shelves Connected to Square port
Selects information about the adapters with the specified number of shelves with square
ports connected.
[-square-port-list <text>, ...] - List of Shelves Connected to Square port
Selects information about all the adapters with the specified list of shelves with square
ports connected.
Examples
The following example displays information about all adapters for each node in the
cluster:
cluster1::> system health node-connectivity adapter show
Node
Adapter
In
Name
Use?
Number of
Enabled
Shelves
Status
------------------ -------- -------
--------
----------
---------
node1
1a
true
true
OK
node1
1b
false
false
OK
node1
1c
false
false
OK
node1
1d
true
true
OK
The following example displays detailed information about a specific adapter :

cluster1::> system health node-connectivity adapter show -adapter-name 1a instance
Node: node1
1387
Adapter Name: 1a
Monitor Name: node-connect
WWN: 5:00e004:0000007:b8
In Use?: true
Is Enabled?: true
Adapter Dual Attached: true
Status: OK
Slot Number: 1
Port Name: a
IOM Port to be connected to: square
Number of Shelves: 2
List of Shelves: 50:05:0c:c1:02:00:0f:02,
50:05:0c:c1:02:00:16:9d
Number of shelves connected to IOMA: 2
List of shelves connected to IOMA: 50:05:0c:c1:02:00:0f:02,
50:05:0c:c1:02:00:16:9d
Number of shelves connected to IOMB: 0
List of shelves connected to IOMB: Number of shelves connected to Circle port: 0
List of shelves connected to Circle port: Number of shelves connected to Square port: 2
List of shelves connected to Square port: 50:05:0c:c1:02:00:0f:02,
50:05:0c:c1:02:00:16:9d
1388
system health node-connectivity disk show

Show disk resources and connectivity status
level.
Description
The system health node-connectivity disk show command displays
information about disks. The command output depends on the parameter or parameters
specified with the command. If no parameters are specified, the command displays the
following information about all disks:
Owner node name
Disk name
Disk bay number
Number of paths to the disk
Status
To display detailed information about disks, run the command with the -instance
parameter
Parameters
specify.
| [-instance ] }
about all fields.
Selects information about all of the disks the node owns.
[-serial-no <text>] - Serial Number
Selects information about only the disk with the specified serial number.
1389
Selects information about the disks with the specified monitor name.
[-disk-name <text>] - Disk Name
Selects information about the disk with the specified disk name.
[-sec-name <text>] - Secondary Disk Name
Selects information about the disk with the specified secondary disk name.
[-uuid <text>] - UUID
Selects information about the disk with the specified Universally Unique Identifier
(UUID).
[-shelf-id <integer>] - Shelf ID
Selects information about the disks associated with the specified shelf ID.
[-bay-no <integer>] - Bay Number
Selects information about the disks with the specified bay number.
[-num-paths <integer>] - Number of Paths
Selects information about the disks with the specified number of paths.
Selects information about the disks with the specified status.
Examples
The example below displays information about all of the disks in the cluster:
cluster1::> system health node-connectivity disk show
Node
Disk Name
Bay
--------------- ------------------------------------- ----
1390
Paths
Status
-----
----------
node1
4d.31.2
OK
node1
4d.31.0
OK
node1
4d.31.1
OK
node1
4a.02.1
OK
node1
4a.02.2
OK
node1
4a.02.3
OK
node2
1d.31.2
OK
node2
1d.31.0
OK
node2
1d.31.1
OK
node2
1a.02.1
OK
node2
1a.02.2
OK
node2
1a.02.3
OK
The example below displays detailed information about a specific disk in the cluster:
cluster1::> system health node-connectivity disk show -disk-name 4d.31.2 instance
Node: node1
Serial Number: 3QP1G8SG000099433A81
Disk Name: 4d.31.2
Secondary disk Name: 4a.31.2
UUID:
5000C500:12BEC6A7:00000000:00000000:00000000:00000000:00000000:00000000:00000000:00000000
Shelf Id: 31
Bay Number: 2
Number of Paths: 2
Status: OK
1391
system health node-connectivity shelf show

Show shelf resources and connectivity status
level.
Description
The system health node-connectivity shelf show command displays
information about shelves in the cluster. By default, the command displays the following
information:
Owner node name
Shelf name
Number of disks
Number of paths to the shelf
Status
To display detailed information about shelves, run the command with the -instance
parameter
Parameters
specify.
| [-instance ] }
about all fields.
Selects information about the shelves that the node owns.
[-uuid <text>] - Shelf UUID
Selects information about the shelf with the specified UUID.
1392
Selects information about the shelves with the specified monitor name.
[-shelf-name <text>] - Shelf Name
Selects information about shelves with the specified shelf name.
Selects information about shelves with the specified number of paths.
[-num-disks <integer>] - Number of Disks
Selects information about shelves with the specified number of disks
[-ioma-adapter <text>] - Adapter Connected to IOMA
Selects information about shelves with IOMA connected to the specified adapter.
[-iomb-adapter <text>] - Adapter Connected to IOMB
Selects information about shelves with IOMB connected to the specified adapter.
[-ioma-adapter-slot <integer>] - Slot number of Adapter Connected to IOMA
Selects information about shelves with IOMA connected to the specified adapter slot.
[-iomb-adapter-slot <integer>] - Slot number of Adapter Connected to IOMB
Selects information about shelves with IOMB connected to the specified adapter slot.
[-ioma-adapter-port <text>] - Port name of Adapter Connected to IOMA
Selects information about shelves with IOMA connected to the specified adapter port.
[-iomb-adapter-port <text>] - Port name of Adapter Connected to IOMB
Selects information about shelves with IOMB connected to the specified adapter port.
Selects information about shelves with the specified status.
[-id <integer>] - Shelf ID
Selects information about the shelf with the specified shelf ID.
Examples
The example below displays information about all shelves in the cluster:
cluster1::> system health node-connectivity shelf show
1393
Node
Shelf Name
Num
Num
Disks
Paths Status
------------------ ----------------------------------- -----
----- ----------
node1
4d.shelf2
OK
node1
4d.shelf31
OK
node2
1d.shelf2
OK
node2
1d.shelf31
OK
The example below displays detailed information about a specific shelf in the cluster:
cluster1::> system health node-connectivity shelf show -shelf-name 4d.shelf2 instance
Node: node1
Shelf UUID: 50:05:0c:c1:02:00:0f:02
Shelf name: 4d.shelf2
Number of Paths: 2
Number of Disks: 4
Adapter connected to IOMA: 4d
Adapter connected to IOMB: 4a
Slot number of Adapter connected to IOMA: 4
Slot number of Adapter connected to IOMB: 4
Port name of Adapter connected to IOMA: d
Port name of Adapter connected to IOMB: a
Status: OK
Shelf Id: 2
1394
system health policy definition modify

Modify system health policy definition
level.
Description
The system health policy definition modify enables or disables health
monitoring policies based on input parameters the user provides.
Parameters
Use this parameter to specify the node on which you want to enable or disable the
policy.
Use this parameter to specify the monitor name for which you want to be enable or
disable the policy.
-policy-id <text> - Policy
Use this parameter to specify the policy identifier that you want to enable or disable.
[-enable {true|false}] - Policy Status
Use this parameter with the value "true" to enable the policy. Set the value to "false" to
disable the policy.
[-asup-enable {true|false}] - Enable AutoSupport for This Alert
Use this parameter to enable or disable an AutoSupport message for this alert.
Examples
This example modifies policy state on the cluster:
cluster1::> system health policy definition modify -node node1
-policy-id ControllerToShelfIomA_Policy -enable false -monitor *
1395
system health policy definition show

Display system health policy definitions
level.
Description
The system health policy definition show command lists the health monitor
policy definitions as described by the health monitor policy file. The command displays
the following fields:
Node name
Monitor name
Policy name
Policy rule expression
Expression for joining two tables
Policy status
Alert identifier
Responsible resource name
Parameters
specify.
| [-instance ] }
about all fields.
Selects policy definitions for the specified node.
Selects policy definitions with the specified monitor name.
1396
[-policy-id <text>] - Policy

Selects policy definitions with the specified policy identifier.
[-rule-expression <ArithExpr>] - Rule Expression
Selects policy definitions with the specified rule of expression.
[-where <ArithExpr>] - Variable Equivalence
Selects rules that match the provided expression. This expression is part of the alert
definition. It is shown for reference only and cannot be changed.
[-enable {true|false}] - Policy Status
Use this parameter with the value set to "true" to select policy definitions that are
enabled. Set the value to "false" to select policy definitions that are disabled.
Selects all policy definitions of the specified alert identifier.
[-responsible-resource-info <text>] - Table and ID of Resource at Fault
Selects all policy definitions with the specified responsible resource.
[-asup-enable {true|false}] - Enable AutoSupport for This Alert
Selects policy definitions for which AutoSupport messages are either enabled or
disabled.
Examples
The example below displays information about all the policy definitions present in the
cluster:
cluster1::> system health policy definition show
Node
Monitor
Policy
------------- ---------------------- ---------------------node1
node-connect
ControllerToShelfIomA_Policy
Policy Rule Expression: nschm_shelf_info.num-paths == 2 &&

nschm_shelf_info.iomb-adapter == NULL
Where: Enable: true
Alert ID: ControllerToShelfIomA_Alert
Number of Alerts: Responsible Resource: nschm_shelf_info.name
1397
The example below displays detailed information about all the policy definitions present
in the cluster:
cluster1::> system health policy definition show -instance
Node: node1
Policy: ControllerToShelfIomA_Policy
Rule Expression: nschm_shelf_info.num-paths == 2 &&
nschm_shelf_info.iomb-adapter == NULL
Variable Equivalence: Policy Status: true
Alert ID: ControllerToShelfIomA_Alert
Table and ID of Resource at Fault: nschm_shelf_info.name
1398
system health status show

Display system health monitoring status
level.
Description
The system health status show command displays the health monitor status. The
possible states are:
ok
ok-with-suppressed
degraded
unreachable
Parameters
None
Examples
This example displays information about health monitoring status:
cluster1::> system health status show
Status
--------------degraded
system health subsystem show

Display the health of subsystems
level.
Description
1399
The system health subsystem show command displays the health status of
each subsystem for which health monitoring is available. This command aggregates
subsystem health status from each node in the cluster. A subsystem's health status
changes to "degraded" when a health monitor raises an alert. You can use the system
health alert show command to display information about generated alerts.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the specified subsystem.
[-health {ok|ok-with-suppressed|degraded|unreachable|unknown}] - Health
Selects subsystems that have the specified health status.
[-init-state {Invalid|Initailizing|Initialized|Starting_Discovery|Starting_Re-Discovery|
Discovery_Done_Partially|Discovery_Done}] - Initialization State
Selects subsystems that have the specified initialization state.
[-outstanding-alert-count <integer>] - Number of Outstanding Alerts
Selects subsystems that have the specified number of outstanding alerts.
[-suppressed-alert-count <integer>] - Number of Suppressed Alerts
Selects subsystems that have the specified number of suppressed alerts.
Examples
The example below displays the health status of each subsystem:
cluster1::> system health subsystem show
Subsystem
Health
----------------- ------------------
1400
SAS-connect
degraded
CIFS-NDO
OK
The example below displays detailed information about the health status of each
subsystem:
cluster1::> system health subsystem show -instance
Health: degraded
Initialization State: initialized
Number of Outstanding Alerts: 51
Number of Suppressed Alerts: 0
Subsystem: CIFS-NDO
Health: OK
Initialization State: initialized
Number of Outstanding Alerts: 0
Number of Suppressed Alerts: 0
See Also
system health alert show
1401
system health system-connectivity shelf show

Show shelf resources and connectivity status
level.
Description
The system health system-connectivity shelf show command displays the
cluster level view of the shelves attached. The default command shows:
Shelf UUID
Shelf ID
Connected nodes
Number of paths to the shelf
Status of the shelf
Parameters
specify.
| [-instance ] }
about all fields.
Selects the shelves that the specified node owns.
[-uuid <text>] - Shelf UUID
Selects the shelf with the specified Universal Unique Identifier.
Selects the shelves with the specified monitor name.
[-id <integer>] - Shelf ID
1402
Use this parameter to display the cluster view information about all the shelves with the
specified shelf identifier.
Selects the shelves with the specified status.
Selects the shelves with the specified number of paths.
[-connected-nodes <text>, ...] - List of Nodes Connected to the Shelf
Selects the shelves with the specified connected nodes.
[-num-nodes <integer>] - Number of Nodes Connected to the Shelf
Selects the shelves with the specified number of nodes.
Examples
The example below displays information about all the shelves in the cluster:
cluster1::> system health system-connectivity shelf show
Shelf UUID
Shelf
Connected
Num
ID
Nodes
Paths
Status
---------------------------------- ------
--------------- ----- ------------
50:05:0c:c1:02:00:0f:02
node1, node2
OK
50:05:0c:c1:02:00:16:9d
31
node1, node2
OK
The example below displays detailed information about all the shelves in the cluster:
cluster1::> system health system-connectivity shelf show -instance
Node: node1
Shelf UUID: 50:05:0c:c1:02:00:0f:02
Monitor Name: system-connect
Shelf Id: 2
Status: OK
Number of Paths: 4
List of Nodes Connected to the shelf: node1, node2
Number of Nodes Connected to the Shelf: 2
Node: node1
Shelf UUID: 50:05:0c:c1:02:00:16:9d
1403
Monitor Name: system-connect

Shelf Id: 31
Status: OK
Number of Paths: 4
List of Nodes Connected to the shelf: node1, node2
Number of Nodes Connected to the Shelf: 2
1404
system license add

Add one or more licenses
level.
Description
This command adds a license to a cluster. To add a license you must specify a valid
license key, which you can obtain from your sales representative.
Parameters
{ -license-code <License Code> - License Code
This specifies the key of the license that is to be added to the cluster. For Data ONTAP
8.1, the parameter accepts a 14 digit upper-case alphanumeric character key. For Data
ONTAP 8.2, the parameter accepts a list of 28 digit upper-case alphanumeric character
keys.
| -license-code <License Code V2>, ... } - License Code V2
This specifies the key of the license that is to be added to the cluster. For Data ONTAP
8.1, the parameter accepts a 14 digit upper-case alphanumeric character key. For Data
ONTAP 8.2, the parameter accepts a list of 28 digit upper-case alphanumeric character
keys.
Examples
The following Data ONTAP 8.2 example adds a list of licenses
with the keys AAAAAAAAAAAAAAAAAAAAAAAAAAAA and
BBBBBBBBBBBBBBBBBBBBBBBBBBBB to the cluster
cluster1::> system license add -license-code AAAAAAAAAAAAAAAAAAAAAAAAAAAA,
BBBBBBBBBBBBBBBBBBBBBBBBBBBB
The following Data ONTAP 8.1 example adds a license with the key
AAAAAAAAAAAAAA to the cluster
cluster1::> system license add -license-code AAAAAAAAAAAAAA
1405
system license clean-up

Remove unnecessary licenses
level.
Description
This command manages licenses in the cluster that have no effect, and so can be
removed. Licenses that have expired or are not affiliated with any controller in the
cluster are deleted by this command.
Parameters
[-unused [true]] - Remove unused licenses
If you use this parameter, the command removes licenses in the cluster that are not
affiliated with any controller in the cluster.
[-expired [true]] - Remove expired licenses
If you use this parameter, the command removes licenses in the cluster that have
expired.
[-simulate | -n [true]] - Simulate Only
If you use this parameter, the command will not remove the licenses. Instead it will
display the licenses that will be removed if this parameter was not provided.
Examples
The following example simulates and displays the licenses that can be cleaned up:
cluster1::> system license clean-up -n -unused -expired
Serial number: 1-80-000011
Owner: cluster1
Package
Reason
------------------------- ----------------------------------------------------SnapLock
Demo License has expired
SnapProtectApps
Demo License has expired
Serial number: 1-81-0000000000000004062522917

Owner: none
1406
Package
Reason
------------------------- ----------------------------------------------------NFS
Serial number is not used by any node in the cluster
CIFS
Serial number is not used by any node in the cluster
The following example deletes the expired licenses:

cluster1::> system license clean-up -expired
2 demo licenses deleted.
The following example deletes the unused licenses:

cluster1::> system license clean-up -unused
2 unused licenses deleted.
system license delete

Delete a license
level.
Description
This command deletes a license from a cluster.
Parameters
{ -feature <Licensable Features> - Feature
Data ONTAP 8.1 only. This specifies the name of the feature license that is to be deleted
from the cluster.
| [-serial-number <Node Serial Number>] - Serial Number
Data ONTAP 8.2 and above. This specifies the serial number of the license that is to be
deleted from the cluster. If this parameter is not provided, the default value is the serial
number of the cluster.
-package <Licensable Package> } - Package
Data ONTAP 8.2 and above. This specifies the name of the package that is to be
deleted from the cluster.
1407
Examples
The following Data ONTAP 8.2 example deletes a license named CIFS and serial
number 1-81-0000000000000000000123456 from the cluster:
cluster1::> system license delete -serial-number 1-81-0000000000000000000123456 package CIFS
The following Data ONTAP 8.1 example deletes a license named CIFS from the cluster:
cluster1::> system license delete -feature CIFS
system license show

Display licenses
level.
Description
This command displays the information about licenses in the system.
Parameters
{ [-fields ]
specify.
| [-instance ] }
about all fields.
[-serial-number <Node Serial Number>] - Serial Number
If you use this parameter, the command displays information only about the licenses that
matches the serial number you specify.
[-package <Licensable Package>] - Package
Data ONTAP 8.2 and above. If you use this parameter, the command displays
information only about the specified package.
1408

information only about the packages that matches the owner name you specified.
[-feature <Licensable Features>] - Feature
Data ONTAP 8.1 only. If you use this parameter, the command displays information only
about the specified feature.
[-serial-number <Cluster Serial Number>] - Cluster serial Number
matches the serial number you specify.
[-limit <integer>] - Limit
about the licenses that have the node count limit you specify.
[-expiration <MM/DD/YYYY HH:MM:SS>] - Expiration Date
information only about the license that have the expiration date you specify.
[-expiration-date <text>] - Expiration Date
about the licenses that have the expiration date you specify.
matches the description you specify.
[-type {license|site|demo}] - Type
information only about the licenses that have the license type you sepcified.
[-legacy {yes|no}] - Legacy
information only about the licenses that matches the legacy field you specified.
[-customer-id <text>] - Customer ID
information only about the licenses that have the customer-id you specified.
Examples
1409
The following Data ONTAP 8.2 example displays default information about all licensed
packages in the cluster:
cluster1::> system license show
Serial Number: 1-80-123456
Owner: cluster1
Package
Type
Description
Expiration
----------------- ------- --------------------- -------------------Base
site
Cluster Base License
NFS
site
NFS License
iSCSI
site
iSCSI License
Serial Number: 1-81-0000000000000001122334455

Owner: node1
Package
Type
Description
Expiration
----------------- ------- --------------------- -------------------NFS
license NFS License
SnapRestore
license SnapRestore License
The following Data ONTAP 8.1 example displays default information about all licensed
features in the cluster:
cluster1::> system license show
Feature
Cluster SN
Limit
Description
---------------
-----------
-------
-----------
Base
1-80-123456
666
Base License w/cluster size limit (nodes)
Mirror
1-80-123456
666
Mirror License
CIFS
1-80-123456
666
CIFS License
SnapRestore
1-80-123456
666
SnapRestore License
NFS
1-80-123456
666
NFS License
SnapMirror_DP
1-80-123456
666
SnapMirror Data Protection License
1410
system license status show

Display license status
level.
Description
This command displays the list of licensable packages in the system and their current
licensing status.
Parameters
specify.
| [-instance ] }
about all fields.
[-package <Licensable Package>] - Package Name
If you use this parameter, the command displays information only about the specified
package.
[-method <Licensed Method>] - Licensed Method
If you use this parameter, the command displays information only about the packages
with the specified licensed method.
[-expiration <MM/DD/YYYY HH:MM:SS>] - Expiration Date
have the expiration date you specify.
match the description you specify.
Examples
1411
The following example displays the license status of the cluster:

cluster1::> system license status show
Package
Licensed Method
Expiration
-----------------
---------------
-------------------------
Base
site
NFS
none
CIFS
none
iSCSI
license
FCP
none
SnapRestore
license
SnapMirror
license
FlexClone
none
SnapVault
none
SnapLock
none
SnapManagerSuite
license
SnapProtectApps
none
1412
system node halt

Shut down a node
level.
Description
The system node halt command stops all activity on a node. You may supply
a reason for the shutdown, which will be stored in the audit log. You may also keep
partner nodes from performing storage takeover during the shutdown.
Parameters
Use this mandatory parameter to specify the node that you want to shut down. The
value local specifies the current node.
[-reason <text>] - Reason for Shutdown
Use this parameter to enter a brief note to indicate the reason for the restart, which
will be stored in the audit log. Providing this information assists support personnel with
troubleshooting efforts.
[-inhibit-takeover | -f [true]] - Disallow Storage Takeover by Partner
This parameter optionally forces the shutdown and prevents storage failover.
Note:
If -inhibit-takeover is set to true, the default behavior as seen with command storage
failover show -fields onreboot is ignored.
If you enter this command without using this parameter, its effective value is false
and storage takeover is allowed. If you enter this parameter without a value, it is
automatically set to true and storage takeover is disabled during reboot.
[-dump | -d [true]] - Create a Core Dump
If this parameter is set to true, it forces a dump of the kernel core when halting the node.
[-skip-lif-migration-before-shutdown [true]] - Skip Migrating LIFs Away from Node
Prior to Shutdown
1413
If this parameter is specified, LIF migration prior to the shutdown will be skipped.
However if LIFs on this node are configured for failover, those LIFs may still failover
after the shutdown has occurred. The default is to migrate LIFs prior to the shutdown.
In the default case, the command attempts to synchronously migrate data and cluster
management LIFs away from the node prior to shutdown. If the migration fails or times
out, the shutdown will be aborted.
[-ignore-quorum-warnings [true]] - Ignore quorum warnings before shutdown.
If this parameter is specified, quorum checks prior to the shutdown will be skipped. The
Examples
The following example shuts down the node named cluster1 for hardware maintenance:
cluster1::> system halt -node cluster1 -reason 'hardware maintenance'
See Also
storage failover show
1414
system node modify

Modify node attributes
level.
Description
The system node modify command sets the attributes of a node.
The owner, location, and asset tag attributes are informational only, and do not affect
the operation of the node or the cluster. The cluster eligibility attribute marks a node as
eligible to participate in a cluster. The epsilon attribute marks a node as the tie-breaker
vote if the cluster has an even number of nodes.
Any field of type <text> may be set to any text value. However, if the value contains
spaces or other special characters, you must enter it using double-quotes as shown in
the example below.
Use the system node show command to display the field values that this command
modifies.
Parameters
This mandatory parameter specifies which node will have its attributes modified. The
value "local" specifies the current node.
This optional text string identifies the node's owner. Fill it in as needed for your
organization.
[-location <text>] - Location
Use this text string to identify the physical location of the node. This text string is
optional; fill it in as needed for your organization.
[-assettag <text>] - Asset Tag
If your organization uses asset tags to track equipment, you can use this text string to
store that tag's value.
[-eligibility {true|false}] - Eligibility (privilege: advanced)
1415
This parameter specifies whether the node is eligible to participate in a cluster. If you
modify another node's eligibility to false, it will no longer be visible from other nodes in
the cluster. If you modify the local node's eligibility to false, the node will no longer be
active in the cluster and you will not be able to see any cluster nodes from it.
If specified as true for a node, this value designates the specified node as epsilon for
this cluster. In a cluster, only one node can be designated as epsilon at any given time.
A node can be designated as Epsilon to add weight to its voting in a cluster with an even
number of nodes.
[-is-diff-svcs {true|false}] - Differentiated Services
If set to true this means that the specified node and its HA partner is part of
differentiated services storage infrastructure. The default value for this setting is false.
Examples
The following example modifies the attributes of a node named node0. The node's
owner is set to "IT" and its location to "Data Center 2."
cluster1::> system node modify -node node0 -owner "IT" -location "Data Center 2"
See Also
system node show
1416
system node reboot

Reboot a node
level.
Description
The system node reboot command restarts a node. You can supply a reason
for the reboot, which is stored in the audit log. You can also keep partner nodes from
performing storage takeover during the reboot and instruct the rebooted node to create
a core dump.
Parameters
Specifies the node that is to be restarted. The value "local" specifies the current node.
[-inhibit-takeover | -f [true]] - Disallow Storage Takeover by Partner
If set to true, this parameter specifies that the node's failover partner is not allowed to
take over for the node when the node is rebooted. If you enter this command without
using this parameter, its effective value is false and storage takeover is allowed. If you
enter this parameter without a value, it is automatically set to true and storage takeover
is disabled during reboot.
[-reason <text>] - Reason for Reboot
Use this parameter to enter a brief note to indicate the reason for the restart, which
will be stored in the audit log. Providing this information assists support personnel with
troubleshooting efforts.
[-dump | -d [true]] - Create a Core Dump
If you would like the node to create a core dump before restarting, specify the true
value with this parameter. If you enter this command without using this parameter,
its effective value is false and the node doesn't create a core dump. If you enter this
parameter without a value, it is automatically set to true and the node creates a core
dump.
[-skip-lif-migration-before-reboot [true]] - Skip Migrating LIFs Away from Node Prior to
Reboot
1417
If this parameter is specified, LIF migration prior to the reboot will be skipped. However if
LIFs on this node are configured for failover, those LIFs may still failover after the reboot
has occurred. The default is to migrate LIFs prior to the reboot. In the default case,
the command attempts to synchronously migrate data and cluster management LIFs
away from the node prior to reboot. If the migration fails or times out, the reboot will be
aborted.
[-ignore-quorum-warnings [true]] - Ignore quorum warnings before reboot
If this parameter is specified, quorum checks prior to the reboot will be skipped. The
Examples
The command in the following example restarts the node named cluster1 for a software
upgrade:
cluster1::> system node reboot -node cluster1 -reason "software upgrade"
system node rename

Rename a node
level.
Description
The system node rename command changes a node's name. Both the node to
be modified and the new name of that node must be specified with the following
parameters. This command is best executed from the node that is being renamed, using
the -node local parameter.
Use the system node show command to display the names of all the nodes in the
current cluster.
Parameters
This parameter specifies which node you are renaming. The value local specifies the
current node.
-newname <text> - New Name
Use this parameter to specify the new name of the node.
1418
Examples
The following example changes the name of the node named node3 to node4.
cluster1::> system node rename -node node3 -newname node4
See Also
system node show
1419
system node restore-backup

Restore the original backup configuration to the HA target node
privilege level.
Description
The system node restore-backup command restores the backup configuration file
that is stored on the partner node to the specified target node in an HA pair. The backup
configuration file is restored after Data ONTAP has been installed on the target node.
The backup configuration file is stored on the HA partner node while the target node
is down. After the target node has been installed, the partner node sends this backup
configuration file to the target node through the management network by using the
system node restore-backup command to restore the original configuration. This
procedure is commonly used when replacing the target node's boot device.
The target IP address should be the address of the target node used for netboot
installation.
Parameters
Specifies the partner node that sends the backup configuration file to the target node.
The value "local" specifies the current node.
-target-address <Remote InetAddress> - HA Partner IP Address
Specifies the IP address for the target node.
Examples
1420
system node revert-to

Revert a node to a previous release of Data ONTAP
privilege level.
Description
The system node revert-to command reverts a node's cluster configuration to
the given version. After the system node revert-to command has finished, the
revert_to command must be run from the nodeshell. The revert_to command reverts
the filesystem on individual nodes to the target release. Before running revert-to in
the cluster shell, the target release must be installed on the node.
Parameters
Specifies the node that is to be reverted. The value local specifies the current node.
-version <revert version> - Data ONTAP Version
Specifies the version of Data ONTAP to which the node is to be reverted.
[-check-only [true]] - Capability Check
If set to true, this parameter specifies that the cluster configuration revert should
perform checks to verify all of the preconditions necessary for revert-to to complete
successfully. Setting the parameter to true does not run through the actual revert
process. By default this option is set to false.
Examples
The command in the following example reverts cluster configuration of a node named
node1 to Data ONTAP version 8.2
cluster1::*> system node revert-to -node node1 -version 8.2
system node run-console

Access the console of a node
1421

level.
Description
This command allows you to access the console of any remote node on the same
cluster. The remote access is helpful in situations where the node cannot be booted
up or has network issues. This command establishes an SSH session with the Service
Processor of a remote node and accesses that node's console over the serial channel.
This command works even if Data ONTAP is not booted up on the remote node. You
can get back to the original node by pressing Ctrl+D. This command works only on SSH
sessions and not on physical console sessions.
Parameters
This parameter specifies the node whose physical console you want to access.
Examples
The following example accesses the console of node2 in the same cluster.
cluster1::> system node run-console -node node2

Pressing Ctrl-D will end this session and any further sessions you might open on
top of this session.
Type Ctrl-D.
SP-login: admin
Password:
*****************************************************
* This is an SP console session. Output from the
* serial console is also mirrored on this session.
*****************************************************
node2::>
node2::> Connection to 192.168.1.202 closed.
cluster1::>
1422
system node run

Run interactive or non-interactive commands in the nodeshell
level.
Description
Use the system node run command to run certain commands from the nodeshell
CLI on a specific node in the cluster. You can run a single nodeshell command from the
clustershell that returns immediately, or you can start an interactive nodeshell session
from which you can run multiple nodeshell commands.
Nodeshell commands are useful for root volume management and system
troubleshooting. Commands that are available through the nodeshell are scoped to
a single node in the cluster. That is, they affect only the node specified by the value
of the -node parameter and do not operate on other nodes in the cluster. To see a
list of available nodeshell commands, type '?' at the interactive nodeshell prompt. For
more information on the meanings and usage of the available commands, use the man
command in the nodeshell.
Only one interactive nodeshell session at a time can be run on a single node. Up to 24
concurrent, non-interactive sessions can be run at a time on a node.
When running the nodeshell interactively, exit the nodeshell and return to the
clustershell by using the exit command. If the nodeshell does not respond to
commands, terminate the nodeshell process and return to the clustershell by pressing
Ctrl-D.
The system node run command is not available from the GUI interface.
Note:
An alternate way to invoke the system node run command is by typing the run as a
single word.
Parameters
Use this parameter to specify the name of the node on which you want to run the
nodeshell command. If you specify only this parameter, the command starts an
1423
interactive nodeshell session that lasts indefinitely. You can exit the nodeshell to the
clustershell by pressing Ctrl-D or by typing the exit command.
{ [-command <text>, ...] - Command to Run
This optionally specifies the name of a single nodeshell command to run on the
specified node. To see a list of available nodeshell commands, type '?' at an interactive
nodeshell prompt.
| [-reset [true]] } - Reset Existing Connection
If this parameter is specified with the true value, it terminates any existing interactive
nodeshell session on the specified node. The default value is false.
Examples
The following example runs the nodeshell command sysconfig -V on a node named
node1:
cluster1::> system node run -node node1 -command sysconfig -V
volume node1_aggr0 (1 RAID group):
group 0: 3 disks
The following example starts a nodeshell session on a node named node2 and then
runs the nodeshell sysconfig -V command. The system remains in the nodeshell
after running the sysconfig -V command.
cluster1::> run -node node2
Type 'exit' or 'Ctrl-D' to return to the CLI
node2> sysconfig -V
volume node2_aggr0 (1 RAID group):
group 0: 3 disks
node2>
The following example starts a nodeshell session on a node named node1 and then
runs two nodeshell commands, aggr status first and vol status second. Use
quotation marks and semicolons when executing multiple nodeshell commands with a
single run command.
cluster1::> run -node node1 -command "aggr status; vol status"
Aggr State
aggr0 online
Status
Options
raid_dp, aggr
root
parity uninit'd!
32-bit
1424
aggr1 online
raid_dp, aggr
parity uninit'd!
32-bit
Volume State
vol0 online
Status
Options
raid_dp, flex
root, nvfail=on
parity uninit'd!
root_vs0 online
raid_dp, flex
create_ucode=on,
cluster
convert_ucode=on,
parity uninit'd!
maxdirsize=102400
1425
system node show-discovered

Display all nodes discovered on the local network
privilege level.
Description
The system node show-discovered command displays information about all the
detectable nodes on the local cluster network. This includes both nodes in a cluster and
nodes that do not belong to a cluster. You can filter the output to show only nodes that
do not belong to a cluster or nodes that are in a cluster.
To see a list of values that are in use for a particular field, use the -fields parameter
of this command with the list of field names you wish to view.
Parameters
If you specify the -fields <fieldname>, ... parameter, the command only displays the
fields that you specify.
| [-instance ] }
If the -instance parameter is specified, the command displays detailed information
about each node.
[-node <text>] - Node Name
This parameter specifies the name of a node for which information is to be displayed. If
this parameter is not specified, the command displays information about all discovered
nodes.
[-is-in-cluster {true|false}] - Is in a Cluster
If this parameter is set to false, the command lists only nodes that do not belong to a
cluster.
Displays information about nodes belonging to the cluster that has the UUID you
specify.
[-cluster-name <text>] - Cluster Name
1426
Displays information about nodes belonging to the cluster that has the name you
specify.
[-serial-number <text>] - Node Serial Number
Displays information about the node that has the serial number you specify.
[-addresses <IP Address>, ...] - Cluster IP Addresses
Displays information about the node that has the cluster IP addresses you specify.
[-netmask <IP Address>] - Cluster Address Mask
Displays information about the nodes that have the netmask address you specify.
[-nvramid <nvramid>] - Node NVRAM ID
Displays information about the node that has the NVRAM ID you specify.
[-partner-nvramid <nvramid>] - Partner NVRAM ID
Displays information about the node that has an HA partner with the NVRAM ID you
specify.
Displays the nodes that have the specified model number.
Displays the nodes that have the specified version of Data ONTAP.
Examples
The following example displays information about all discovered nodes in the cluster
network:
cluster1::*> system node show-discovered
Node
Cluster
Addresses
NVRAM ID
Partner NVRAM
------------- ------------- --------------- ----------- -------------4069114-60-0
169.254.232.178 4069114600
4069114-60-2
169.254.79.38
4069114602
4069114-60-3
169.254.195.76
4069114603
cluster1-01
cluster1
169.254.140.39
4069114628
4069114629
cluster1-02
cluster1
169.254.138.137 4069114629
4069114628
1427
system node show-memory-errors

Display Memory Errors on DIMMs
privilege level.
Description
system node show-memory-errors prints the history of memory (storage
controller's RAM) errors since boot. This command can be useful in diagnosing
memory problems or determining which DIMM, if any, might need replacement. Some
correctable ECC errors are to be expected under normal operation, but many occurring
on a particular DIMM might indicate a problem. All the fields are read only and can be
used to filter the output. The maximum number of physical address and timestamps
reported is 160.
Parameters
specify.
| [-verbose ]
The -verbose parameter enables verbose mode, resulting in the display of more
detailed output.
| [-instance ] }
about all fields.
When provided, the -node parameter specifies the nodes for which the memory error
statistics are to be displayed. When the -node is not provided, the command is applied
to all the nodes in the cluster.
[-id <integer>] - DIMM ID
This parameter refers to the DIMM ID. It can be used to look at the correctable ECC
error count on a specific DIMM.
1428
[-name <text>] - DIMM Name

This parameter specifies the DIMM name for which the memory error statistics are to be
displayed.
[-cecc <integer>] - Correctable ECC Error Count
This parameter can be used to get all the DIMMs with the specified correctable ECC
error count.
[-merr {true|false}] - Multiple Errors on Same Address
Use this parameter with the values true to specify whether the error was seen multiple
times on the same physical address. It can also be used to look at all the DIMMs with
multiple errors on same address.
[-timestamp <text>, ...] - Error Time
This specifies the time at which the error was seen on the DIMM.
[-addr <text>, ...] - Error Address
This specifies the physical address on which the error was seen.
Examples
cluster1::*> system node show-memory-errors
Correctable ECC Memory Errors:
Node: localhost
DIMM
CECC
Multiple Err
Name
Count
Same Address
------- ------
------------
DIMM-1
false
DIMM-2
false
DIMM-3
false
DIMM-4
false
DIMM-5
true
DIMM-6
false
DIMM-7
false
DIMM-8
false

cluster1::*> system node show-memory-errors -verbose
Correctable ECC Memory Errors:
1429
Node: localhost
DIMM
CECC
Multiple Err
Name
Count
Same Address
Timestamp
Physical
------- ------
------------
--------------------
-------------
DIMM-1
false
DIMM-2
false
DIMM-3
false
DIMM-4
false
DIMM-5
true
12/02/2013 08:17:43
0xD640
Address
12/02/2013 08:17:57
0x3F7FF800
12/02/2013 08:18:03
0x11743D000
12/02/2013 08:18:37
0x11743D000
DIMM-6
false
12/02/2013 08:17:53
0x87EC0
DIMM-7
false
12/02/2013 08:17:51
0x13DED8900
DIMM-8
false
1430
system node show

Display the list of nodes in the cluster
level.
Description
The system node show command displays information about the nodes in a cluster.
You can limit output to specific types of information and specific nodes in the cluster, or
filter output by specific field values.
To see a list of values that are in use for a particular field, use the -fields parameter
of this command with the list of field names you wish to view. Use the system node
modify command to change some of the field values that this command displays.
Parameters
specify.
| [-inventory ]
Use this parameter to display inventory information such as serial numbers, asset tags,
system identifiers, and model numbers.
| [-messages ]
Use this parameter to display system messages for each node.
| [-instance ] }
about all fields.
Selects information for node names that match this parameter value.
Selects nodes that have owner values that match this parameter value.
1431
Selects nodes at specific physical locations that match this parameter value.
Selects nodes that have model numbers that match this parameter value.
[-serialnumber <text>] - Serial Number
Selects nodes that have serial numbers that match this parameter value.
[-assettag <text>] - Asset Tag
Selects nodes that have asset tags that match this parameter value.
[-uptime {<seconds>|[<d> days] <hh>:<mm>[:<ss>]}] - Uptime
Selects nodes that have uptimes that match this parameter value. This parameter is
most useful when used with a range indicator such as less than or greater than, as in:
show -uptime >"30 days 00:00"
[-nvramid <nvramid>] - NVRAM System ID

Selects nodes that have NVRAM system IDs that match this parameter value.
[-systemid <text>] - System ID
Selects nodes that have system IDs that match this parameter value.
Selects nodes that have vendor names that match this parameter value.
[-health {true|false}] - Health
Selects nodes that have health values that match this parameter value. Specify true to
display healthy nodes, and false to display unhealthy nodes.
[-eligibility {true|false}] - Eligibility
Selects nodes that have voting eligibility values that match this parameter value.
Selects nodes that have epsilon holding designations that match this parameter value.
This is useful to find out which node, if any, in the current cluster has been designated
as epsilon. Specify true to display the node holding epsilon, and false to display
nodes not holding epsilon.
[-uuid <UUID>] - UUID (privilege: advanced)
1432
Selects nodes that have the specified universal unique identifiers that match this
parameter value.
[-is-diff-svcs {true|false}] - Differentiated Services
If true, the corresponding node is considered to be part of differentiated services storage
infrastructure.
[-is-all-flash-optimized {true|false}] - All-Flash Optimized
Selects nodes that have "All-Flash Optimized" personality values that match this
parameter value. Specify true to display nodes which support only SSD drives, and false
to display nodes which support all kinds of drives.
Examples
cluster1::> system node show
Node
Health Eligibility Uptime
Model
Owner
Location
------ ------ ----------- ------------- -------- ------ ------------node0
true
true
89 days 23:47 MODELXX
node1
true
true
IT
Data Center 2
Data Center 2
node2
true
true
Data Center 2
node3
true
true
Data Center 2
This example displays the locations and model numbers of all nodes that are in physical
locations that have names beginning with "Lab":
cluster1::> system node show -location lab* -fields location, model
node
location model
------------- -------- -----node5
Lab 1
MODELXX
node7
Lab 3
MODELXX
node9
Lab 5
MODELXX
See Also
system node modify
1433
system node autosupport invoke-core-upload

Generate and send an AutoSupport message with an existing core file.
level.
Description
The system node autosupport invoke-core-upload command sends an
AutoSupport message with an existing core file from a node. The core file specified
by the "-core-filename" option is included in the AutoSupport message. The command
requires that the specified file be present while the AutoSupport message is being
transmitted.
Parameters
Use this parameter to specify the node from which the AutoSupport message is sent.
Defaults to localhost.
[-message <text>] - Message Included in the AutoSupport Subject
Use this parameter to specify the text in the subject line of the AutoSupport message.
[-uri <text>] - Alternate Destination for This AutoSupport
Use this parameter to send the AutoSupport message to an alternate destination.
Only "file," "http," and "https" protocols are supported. If this parameter is omitted, the
message is sent to the all of the recipients defined by the system node autosupport
modify command.
[-force [true]] - Generate and Send Even if Disabled
Use this parameter to generate and send the AutoSupport message even if AutoSupport
is disabled on the node.
[-case-number <text>] - Case Number for This Core Upload
Use this parameter to specify the optional case number to be associated with this
AutoSupport message.
-core-filename <text> - The Existing Core Filename to Upload
Use this parameter to specify the core file to be included in the AutoSupport message.
Use the system node coredump show command to list the core files by name.
1434
Examples
Use this command to list the core files from a node:
cluster1::> system node coredump show -node local
Node:Type Core Name
Saved Panic Time
--------- ------------------------------------------- ----- ----------------node:kernel

core.4073000068.2013-09-11.15_05_01.nz
true
9/11/2013 15:05:01
Use this command to invoke an AutoSupport message with the corefile

core.4073000068.2013-09-11.15_05_01.nz:
cluster1::> system node autosupport invoke-core-upload -core-filename
core.4073000068.2013-09-11.15_05_01.nz -node local
See Also
system node coredump show
1435
system node autosupport invoke-performancearchive

Generate and send an AutoSupport message with performance archives.
level.
Description
The system node autosupport invoke-performance-archive command
sends an AutoSupport message with the performance archives from a node. The
command requires that the performance archives in the specified date range be present
while the AutoSupport message is being transmitted.
Parameters
The default setting is localhost.
Use this parameter to specify the text in the subject line of the AutoSupport message.
Only "file," "http," and "https" protocols are supported. If this parameter is omitted, the
message is sent to the all of the recipients defined by the system node autosupport
modify command.
[-case-number <text>] - Case Number for This Performance Archive Upload
Use this parameter to specify the optional case number to be associated with this
-start-date <MM/DD/YYYY HH:MM:SS> - Start Date for Performance Archive Dataset
1436
Use this parameter to specify the start date for the files in the performance archive
dataset to be included in the AutoSupport message.
{ -end-date <MM/DD/YYYY HH:MM:SS> - End Date for Performance Archive Dataset
Use this parameter to specify the end date for the files in the performance archive
dataset to be included in the AutoSupport message. The end date should be within six
hours of the start date.
| -duration <[<integer>h][<integer>m][<integer>s]> } - Duration of Performance
Archive Dataset
Use this parameter with start-date to specify the duration of the performance archive
dataset to be included in the AutoSupport message. The maximum duration limit is six
hours from the start date.
Examples
Use this command to invoke an AutoSupport message to include the performance
archives in the given date range:
cluster1::> system node autosupport invoke-performance-archive -node local start-date 9/12/2013 19:37:24 -end-date 9/12/2013 22:37:24
cluster1::> system node autosupport invoke-performance-archive -node local start-date 11/21/2013 13:42:09 -duration 6h
1437
system node autosupport invoke-splog

Generate and send an AutoSupport message with collected service-processor log files
level.
Description
The system node autosupport invoke-splog command sends an AutoSupport
message with the Service Processor log files from a specified node in the cluster.
Parameters
-remote-node {<nodename>|local} - Node
Use this parameter to specify the node from which Service Processor log files are to be
collected.
[-log-sequence <integer>] - Log File Sequence Number
Use this parameter to specify the sequence number of the Service Processor log files
to be collected. If this parameter is omitted, the latest Service Procesor log files are
collected.
Only "file," "http," and "https" protocols are supported. If this parameter is omitted,
the message is sent to the all of the recipients defined by the system node
autosupport modify command.
Examples
Use this command to invoke an AutoSupport message to include the Service Processor
log files collected from node cluster1-02.
cluster1::> system node autosupport invoke-splog -remote-node cluster1-02
[Job 777] Job succeeded: Log files from the service processor have been
transferred to "/mroot/etc/log/sp/ondemand" on node cluster1-01, and
AutoSupport message has been triggered.
1438
cluster1::>
See Also
1439
system node autosupport invoke

Generate and send an AutoSupport message
level.
Description
The system node autosupport invoke command sends an AutoSupport
message from a node.
Parameters
Use this parameter to specify text sent in the subject line of the AutoSupport message.
This parameter is not available when the -type parameter is set to performance.
-type {test|performance|all} - Type of AutoSupport Collection to Issue
Use this parameter to specify the type of AutoSupport collection to issue. There is no
default; you must specify a -type.
test - The message contains basic information about the node. When the
AutoSupport message is received by technical support, an e-mail confirmation is
sent to the system owner of record. This enables you to confirm that the message
is being received by technical support.
all - The message contains all collected information about the node.
performance - The message contains only performance information about the
node. This parameter has effect only if performance AutoSupport messages
are enabled, which is controlled by the -perf parameter of the system node
autosupport modify command.
Use this parameter to send the AutoSupport message to the destination you specify
instead of the configured destination. Only "file", "mailto", "http", and "https" protocols
are supported. If this parameter is omitted, the message is sent to the all of the
recipients defined by the system node autosupport modify command.
1440

Use this parameter to generate and send the message even if AutoSupport is disabled
on the node.
Examples
The following example sends a test AutoSupport message from a node named node0
with the text "Testing ASUP":
cluster1::> system node autosupport invoke -node node0 -type test -message
"Testing ASUP"
See Also
1441

Modify AutoSupport configuration
level.
Description
The system node autosupport modify command modifies the AutoSupport
configuration of a node.
Parameters
Use this parameter to specify the node being configured.
[-state {enable|disable}] - State
Use this parameter to specify whether AutoSupport is enabled or disabled on the node.
The default setting is enable. When AutoSupport is disabled, messages are not sent to
anyone, including the vendor's technical support, your internal support organization, or
partners.
[-mail-hosts <text>, ...] - SMTP Mail Hosts
Use this parameter to specify up to five SMTP mail hosts through which the node sends
AutoSupport messages. This parameter is required if you specify e-mail addresses in
the -to, -noteto, or -partner-address parameters or if you specify smtp in the -transport
parameter. Separate multiple mail hosts with commas with no spaces in between. The
AutoSupport delivery engine attempts to use these hosts for delivery in the order that
you specify.
You can optionally specify a port value for each mail server. A port value can be
specified on none, all, or some of the mail hosts. The port specification for a mail host
consists of a colon (":") and a decimal value between 1 and 65335, and follows the
mailhost name (for example, mymailhost.example.com:5678 ). The default port value is
25.
Also, you can optionally prepend a user name and password combination for
authentication to each mail server. The format of the username and password pair is
user1:pw1@mymailhost.example.com. The username and password can be specified
on none, all, or some of the mail hosts.
1442
The default value for this parameter is mailhost.

[-from <mail address>] - From Address
Use this parameter to specify the e-mail address from which the node sends
AutoSupport messages. The default is Postmaster@xxx where xxx is the name of the
system.
[-to <mail address>, ...] - List of To Addresses
Use this parameter to specify up to five e-mail addresses to receive AutoSupport
messages that are most relevant for your internal organization. Separate multiple
addresses with commas with no spaces in between. For this parameter to have effect,
the -mail-hosts parameter must be configured correctly. Individual trigger events can
change the default usage of this parameter using the -to parameter of the system
node autosupport trigger modify command. By default, no list is defined.
[-noteto <mail address>, ...] - List of Noteto Addresses
Use this parameter to specify up to five addresses to receive a short-note version of
AutoSupport messages that are most relevant for your internal organization. Shortnote e-mails contain only the subject line of the AutoSupport message, which is easier
to view on a mobile device. For this parameter to have effect, the -mail-hosts
parameter must be configured correctly. Individual trigger events can change the
default usage of this parameter using the -noteto parameter of the system node
autosupport trigger modify command. By default, no list is defined.
[-partner-address <mail address>, ...] - List of Partner Addresses
Use this parameter to specify up to five e-mail addresses to receive all AutoSupport
messages including periodic messages. This parameter is typically used for support
partners. For this parameter to have effect, the -mail-hosts parameter must be
configured correctly. By default, no list is defined.
[-support {enable|disable}] - Send AutoSupport Messages to Vendor Support
Use this parameter to specify whether to send all AutoSupport messages to your
vendor's technical support. (Destination information is pre-defined and does not require
configuration.) When -state is enabled and -support is disabled, messages are sent to
the addresses specified in the -to, -noteto, or -partner-address parameters but are not
sent to your vendor's technical support. The default is enable.
[-transport {smtp|http|https}] - Protocol to Contact Support
Use this parameter to specify the protocol used to deliver AutoSupport messages
to your vendor's technical support. This parameter applies only when the -support
parameter is set to enable. If you specify http or https and your network uses a proxy,
1443
you must also set the -proxy-url parameter. If you specify smtp, you must also configure
-the mail-hosts parameter.
[-proxy-url <text>] - Support Proxy URL
Use this parameter to specify an HTTP or HTTPS proxy if the -transport parameter
is set to HTTP or HTTPS and your organization uses a proxy. Enter the URL without
an http:// or https:// prefix. If authentication is required, use the format "[username]:
[password]@[host][:[port]]". The default is an empty string.
[-hostname-subj {true|false}] - Hostname Subject
Use this parameter to specify whether the hostname of the node is included in the
subject line of the AutoSupport message. The default is false. This parameter applies
only if the -remove-private-data parameter is true.
[-nht {true|false}] - NHT Enable
Use this parameter to specify whether NHT disk drive health data is sent to technical
support and addresses specified in the -partner-address parameter when disk
drives fail. The default is true.
[-perf {true|false}] - Performance Data Enable
Use this parameter to specify whether performance data is sent to technical support and
addresses specified in the -partner-address parameter. The default is true.
[-retry-interval <[<integer>h][<integer>m][<integer>s]>] - Retry Interval
Use this parameter to specify the amount of time to delay before trying to send an
AutoSupport message again after a sending failure. Values may end with "s", "m", or
"h" to indicate seconds, minutes, or hours, respectively. The minimum interval is 30
seconds and the maximum is 1 day. The default is 4 minutes.
[-retry-count <integer>] - Retry Count
Use this parameter to specify the number of times to try resending mail before dropping
it. The minimum number is 5 and the maximum is 4,294,967,294. The default is 15
times.
[-reminder {true|false}] - Reminder Enable
Use this parameter to enable or disable a reminder message that is sent when
AutoSupport is not configured to send messages to technical support. This reminder
is logged as an EMS event called "autosupport.general.reminder" every 24 hours. The
default is true.
[-max-http-size {<integer>[KB|MB|GB|TB|PB]}] - Maximum HTTP Size
Use this parameter to specify the maximum file size (in bytes by default, but can also be
specified in KB, MB, TB or PB) for HTTP and HTTPS transfers. This parameter applies
1444
only to messages sent to technical support and only if the -transport parameter is set to
HTTP or HTTPS. Setting the value to 0 disables the delivery size budget. The default is
10 MB.
If the size of the AutoSupport message exceeds this value, AutoSupport will deliver
as much of the message as possible. You can use the "system node autosupport
manifest show" command to identify the sections of the message that AutoSupport sent.
AutoSupport collects and sends the content in order of priority. The priority is predefined
for each AutoSupport message. To identify the collection order for an AutoSupport
trigger, use the "system node autosupport trigger show" command with the -instance
parameter.
[-max-smtp-size {<integer>[KB|MB|GB|TB|PB]}] - Maximum SMTP Size
Use this parameter to specify the maximum file size (in bytes by default, but can also
be specified in KB, MB, TB or PB) for SMTP (e-mail) transfers. This parameter applies
to messages sent to the addresses specified in the -to, -noteto, and -partner-address
parameters. If the -transport parameter is set to smtp, this parameter also applies to
messages sent to the vendor's technical support. Setting the value to 0 disables the
delivery size budget. The default is 5 MB.
If the size of the AutoSupport message exceeds this value, AutoSupport will deliver
as much of the message as possible. You can use the "system node autosupport
manifest show" command to identify the sections of the message that AutoSupport sent.
AutoSupport collects and sends the content in order of priority. The priority is predefined
for each AutoSupport message. To identify the collection order for an AutoSupport
trigger, use the "system node autosupport trigger show" command with the -instance
parameter.
[-remove-private-data {true|false}] - Remove Sensitive Data
Use this parameter with the value true to remove, encode, or mask sensitive data from
AutoSupport attachments and headers. Use this feature to eliminate private data from
all AutoSupport messages.
Eliminated data might include: IP addresses, MAC addresses, URIs, DNS names, email addresses, port numbers, node names, Vserver names, cluster names, aggregate
names, volume names, junction paths, policy names, user IDs, group IDs, LUNs, and
qtree names.
The default is false.
Note:
Changing this value from false to true deletes the AutoSupport history and all files
associated with it.
1445
[-validate-digital-certificate {true|false}] - Validate Digital Certificate Received

Use this parameter with the value true to force the node to validate digital certificates
that it receives. The default is true
Examples
The following example enables AutoSupport on a node named node3 with the following
settings:
SMTP mail host named smtp.example.com.
E-mail "from" address of alerts@node3.example.com
E-mail "to" address of support@example.com
AutoSupport messages sent to support personnel
HTTPS set as transport protocol
Short-note address of pda@example.com
If sending fails, the system will wait 23 minutes before retrying.
cluster1::> system node autosupport modify -node node3 -state enable -mail-hosts
smtp.example.com -from alerts@node3.example.com -to support@example.com -support
enable -transport https -noteto pda@example.com -retry-interval 23m
The following examples show how to modify AutoSupport URLs when using IPv6
address literals:
cluster1::> system node autosupport modify -node node1 -mail-hosts
[2620:10a:4002:6004::bbbb]:25
cluster1::> system node autosupport modify -node node1 -proxy-url
username:password@[2620:10a:4002:6004::bbbb]:8080
See Also
system node autosupport trigger modify event show-suppression
1446

Display AutoSupport configuration
level.
Description
The system node autosupport show command displays the AutoSupport
configuration of one or more nodes.
Parameters
specify.
| [-config ]
Use this parameter to display the retry interval, retry count, throttle, and reminder
settings of all nodes in the cluster.
| [-nht-performance ]
Use this parameter to display NHT and performance information about all nodes in the
cluster.
| [-recent ]
Use this parameter to display the subject and time of the last AutoSupport message
generated by each node in the cluster.
| [-support-http ]
Use this parameter to display whether HTTP support is enabled for each node in the
cluster, and identify the transport protocol and the support proxy URL used by each
node.
| [-support-smtp ]
Use this parameter to display whether SMTP (e-mail) support is enabled for each node
in the cluster, and identify the transport protocol and the "to" mail address used by each
node.
1447
| [-instance ] }
about all fields.
Use this parameter to display detailed information about the node you specify.
[-state {enable|disable}] - State
Use this parameter to display information only about nodes that have the AutoSupport
state you specify.
[-mail-hosts <text>, ...] - SMTP Mail Hosts
Use this parameter to display information only about nodes that use the mail hosts you
specify.
[-from <mail address>] - From Address
Use this parameter to display information only about nodes that have the "from" e-mail
address you specify.
[-to <mail address>, ...] - List of To Addresses
Use this parameter to display information only about nodes that have the "to" e-mail
addresses you specify.
[-noteto <mail address>, ...] - List of Noteto Addresses
Use this parameter to display information only about nodes that send short-note e-mail
messages to the e-mail addresses you specify. Short-note e-mails contain only the
subject line of the AutoSupport message, which is easier to view on a mobile device.
[-partner-address <mail address>, ...] - List of Partner Addresses
Use this parameter to display information only about nodes that have the "partneraddress" e-mail addresses you specify. These addresses are not subject to the delivery
limitations configured for the "-to" addresses of AutoSupport triggers.
[-support {enable|disable}] - Send AutoSupport Messages to Vendor Support
Use this parameter with the value "enable" to display information only about nodes that
send AutoSupport messages to your vendor's technical support. Use this parameter
with the value "disable" to display information only about nodes that do not send
AutoSupport messages to your vendor's technical support.
[-transport {smtp|http|https}] - Protocol to Contact Support
Use this parameter to display information only about nodes that use the protocol you
specify to send AutoSupport messages.
1448
[-url <text>] - Support URL for HTTP/HTTPS

Use this parameter to display information only about nodes that use the URL you
specify to send messages through HTTP and HTTPS POST operations.
[-put-url <text>] - Support URL for HTTP/S PUT
Use this parameter to display information only about nodes that use the URL you
specify to send messages through HTTP PUT operations.
[-proxy-url <text>] - Support Proxy URL
Use this parameter to display information only about nodes that use the proxy URL you
specify.
[-support-address <mail address>, ...] - Support Address
Use this parameter to display information only about nodes that use the external support
address you specify.
[-hostname-subj {true|false}] - Hostname Subject
Use this parameter to display information only about nodes that include their hostname
in the "Subject:" line of AutoSupport messages. If the parameter "remove-private-data"
is false, this parameter has no effect.
[-nht {true|false}] - NHT Enable
Use this parameter with the value "true" to display information only about nodes
that send NHT disk drive data. Use this parameter with the value "false" to display
information only about nodes that do not send NHT data.
[-perf {true|false}] - Performance Data Enable
Use this parameter with the value "true" to display information only about nodes that
send periodic performance AutoSupport messages. Use this parameter with the value
"false" to display information only about nodes that do not send periodic performance
messages.
[-retry-interval <[<integer>h][<integer>m][<integer>s]>] - Retry Interval
Use this parameter to display information only about nodes that use the retry interval
you specify.
[-retry-count <integer>] - Retry Count
Use this parameter to display information only about nodes that use the retry count you
specify.
[-reminder {true|false}] - Reminder Enable
1449
send messages reminding administrators to enable AutoSupport if AutoSupport is not
enabled. Use this parameter with the value "false" to display information only about
nodes that do not send reminder messages.
[-last-subject <text>] - Last Subject Sent
Use this parameter to display information only about nodes whose last AutoSupport
message had the "Subject:" line you specify.
[-last-time <MM/DD/YYYY HH:MM:SS>] - Last Time Sent
Use this parameter to display information only about nodes whose last AutoSupport
message was sent at the date and time you specify. Specify the date and time in the
format "MM/DD/YYYY HH:MM:SS".
[-max-http-size {<integer>[KB|MB|GB|TB|PB]}] - Maximum HTTP Size
Use this parameter to display information only about nodes that limit the maximum size
of HTTP transfers to the file size you specify.
[-max-smtp-size {<integer>[KB|MB|GB|TB|PB]}] - Maximum SMTP Size
Use this parameter to display information only about nodes that limit the maximum size
of SMTP (e-mail) transfers to the file size you specify.
[-remove-private-data {true|false}] - Remove Sensitive Data
remove sensitive data from AutoSupport messages. Use this parameter with the value
"false" to display information only about nodes that do not remove sensitive data.
[-validate-digital-certificate {true|false}] - Validate Digital Certificate Received
validate digital certificates they receive. Use this parameter with the value "false" to
display information only about nodes that do not validate digital certificates.
[-ondemand-server-url <text>] - AutoSupport OnDemand Server URL
Use this parameter to display information only about nodes that have the AutoSupport
OnDemand Server URL you specify.
Examples
The following example displays the AutoSupport configuration for a node named node3:
cluster1::> system node autosupport show -node node3
Node: node3
State: enable
1450
SMTP Mail Hosts: smtp.example.com

From Address: alerts@node3.example.com
List of To Addresses: support@example.com
List of Noteto Addresses: List of Partner Addresses: partner@node4.example.com
Send AutoSupport Messages to Vendor Support: enable
Protocol to Contact Support: https
Support Proxy URL: support.proxy.example.com
Hostname Subject: true
NHT Enable: true
Performance Data Enable: true
Retry Interval: 4m
Retry Count: 15
Reminder Enable: true
The Transmission Window: 1h
Last Subject Sent: WEEKLY
Last Time Sent: 3/11/2011 06:00:03
Maximum HTTP Size: 10MB
Maximum SMTP Size: 5MB
Remove Sensitive Data: false
Validate Digital Certificate Received: true
Continue Local Collection while Disabled: true
See Also
event show-suppression system node autosupport trigger show
system node autosupport budget show system node autosupport history show
system node autosupport manifest show
1451
system node autosupport destinations show

Display a summary of the current AutoSupport destinations
level.
Description
The system node autosupport destinations show command displays a list of
all message destinations used by AutoSupport. The command provides you with a quick
summary of all addresses and URLs that receive AutoSupport messages from all nodes
in the cluster.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display only destinations that receive AutoSupport messages from
[-destinations <text>, ...] - Destinations
Use this parameter to display only destination lists for nodes that send AutoSupport
messages to the destinations you specify.
Examples
This example displays all of the destinations in use by the current cluster. Each node
uses the same destination for HTTP POST, HTTP PUT, and e-mail notifications.
cluster1::> system node autosupport destinations show
Node
Destinations
------------------------------------------------------------------------------
1452
node1
https://asuppost.example.com/cgi-bin/asup.cgi
https://asupput.example.com/cgi-bin/asup.cgi
support@example.com
node2
https://asuppost.example.com/cgi-bin/asup.cgi
https://asupput.example.com/cgi-bin/asup.cgi
support@example.com
1453
system node autosupport history cancel

Cancel an AutoSupport Transmission.
level.
Description
The system node autosupport history cancel command cancels an active
AutoSupport transmission. This command is used to pause or abandon a long running
delivery of an AutoSupport message. The cancelled AutoSupport message remains
available for retransmission using the system node autosupport history
retransmit command.
Parameters
Use this parameter to specify the node on which to cancel the AutoSupport message.
The default setting is localhost.
-seq-num <Sequence Number> - AutoSupport Sequence Number
Use this parameter to specify the sequence number of the AutoSupport message you
want to cancel.
[-destination {smtp|http|noteto|retransmit}] - Destination for This AutoSupport
Use this parameter to specify the destination type for the AutoSupport message you
want to cancel.
Examples
Use this command to cancel the AutoSupport message delivery with seq-num 10 to all
destinations.
cluster1::> system node autosupport history cancel -node local -seq-num 10
Use this command to cancel the AutoSupport message delivery with seq-num 10 via
HTTP only.
cluster1::> system node autosupport history cancel -node local -seq-num 10 destination http
1454
See Also
system node autosupport history retransmit
1455
system node autosupport history retransmit

Selectively retransmit a previously collected AutoSupport.
level.
Description
The system node autosupport history retransmit command retransmits a
locally stored AutoSupport message.
Support personnel might ask you to run this command to retransmit an AutoSupport
message. You might also retransmit an AutoSupport message if you run the system
node autosupport history show command and notice that a message was not
delivered.
If you retransmit an AutoSupport message, and if support already received that
message, the support system will not create a duplicate case. If, on the other hand,
support did not receive that message, then the AutoSupport system will analyze the
message and create a case, if necessary.
Use the system node autosupport history show command to display the 50
most recent AutoSupport messages, which are available for retransmission.
Parameters
-seq-num <Sequence Number> - AutoSupport Sequence Number
Use this parameter to specify the sequence number of the AutoSupport message to
retransmit.
-uri <text> - Destination to Send this AutoSupport
Use this parameter to specify the HTTP, HTTPS, FILE, or MAILTO uniform resource
indicator (URI) to which the AutoSupport message is sent.
[-size-limit {<integer>[KB|MB|GB|TB|PB]}] - Transmit Size Limit for this AutoSupport.
Use this parameter to specify a size limit for the retransmitted AutoSupport message. If
the message information exceeds this limit, it will be trimmed to fit the limit you specify.
1456
Omit the size limit or set it to 0 to disable it, which is useful to retransmit an AutoSupport
message that was truncated by a mail or Web server due to the default size limits.
Examples
The following example retransmits the AutoSupport message with sequence number 45
on the node "node1" to a support address by e-mail.
cluster1::> system node autosupport history retransmit -node node1 -seq-num 45 uri mailto:support@example.com
See Also
system node autosupport history show
1457
system node autosupport history show-uploaddetails

Display upload details of recent AutoSupport messages
level.
Description
The system node autosupport history show-upload-details command
displays upload details of the 50 most recent AutoSupport messages sent by nodes in
the cluster. By default, it displays the following information:
AutoSupport Sequence Number
Destination
Compressed Size
Percentage Complete
Rate of upload
Time Remaining
Parameters
specify.
| [-instance ] }
Use this parameter to display the following detailed information about all entries:
AutoSupport Sequence Number
Destination
Compressed Size
Percentage Complete
Rate of Upload
1458
Time Remaining
Use this parameter to display details of AutoSupport messages sent from the node you
specify.
[-seq-num <Sequence Number>] - AutoSupport Sequence Number
Use this parameter to display details of AutoSupport messages with the sequence
number you specify. Sequence numbers are unique to a node. Use this parameter with
the -node parameter to display information about an individual message.
[-destination {smtp|http|noteto|retransmit}] - Destination for this AutoSupport
Use this parameter to display details of AutoSupport messages that were sent to the
destination type you specify.
[-size {<integer>[KB|MB|GB|TB|PB]}] - Autosupport Compressed Size
Use this parameter to display details of AutoSupport messages of the compressed size
you specify.
Use this parameter to display the percentage completed for any active (incomplete)
[-upload-rate {<integer>[Bps|KBps|MBps|GBps]|unlimited}] - Rate of Upload
Use this parameter to display the rate in bytes per second that upload is using currently,
otherwise zero when not active.
[-time-remaining <[<integer>h][<integer>m][<integer>s]>] - Time remaining for Upload
Use this parameter to display the estimated time for the transmission of the AutoSupport
message to complete.
Examples
The following example shows the first three results output by the history show-uploaddetails command. Note that "q" was pressed at the prompt.
cluster1::> system node autosupport history show-upload-details -node node1
Seq
Node
Num
Percent
Destination Size
Complete
Time
Rate
Remaining
------------ ----- ----------- --------- ---------- ----------- -------node1

13
1459
smtp
755.9KB
100
142.88KBps
0s
http
755.8KB
80
125.97KBps
10s
noteto
smtp
http
316.4KB
100
158.22KBps
0s
noteto
201B
100
201Bps
0s
smtp
http
626.1MB
100
649.56KBps
0s
noteto
12
11
Press <space> to page down, <return>> for next line, or 'q' to quit... q
1460
system node autosupport history show

Display recent AutoSupport messages
level.
Description
The system node autosupport history show command displays information
about the 50 most recent AutoSupport messages sent by nodes in the cluster. By
default, it displays the following information:
AutoSupport sequence number
Destination type, such as smtp
Status of delivery, such as sent-successful
Attempt count
Time of last update
Parameters
specify.
| [-delivery ]
Use this parameter to display destination information about each AutoSupport message.
| [-detail ]
Use this parameter to display trigger and subject information about each AutoSupport
message.
| [-instance ] }
Use this parameter to display the following detailed information about all entries:
Trigger event
Subject of the message
Delivery URI
1461
Last error
Compressed Size
Decompressed Size
Total Collection Time (in ms)
Use this parameter to display only AutoSupport messages sent from the node you
specify.
Use this parameter to display only AutoSupport messages with the sequence number
you specify. Sequence numbers are unique to a node. Use this parameter with the node parameter to display information about an individual message.
[-destination {smtp|http|noteto|retransmit}] - Destination for This AutoSupport
Use this parameter to display only AutoSupport messages that were sent to the
destination type you specify.
[-trigger <Message Name>] - Trigger Event
Use this parameter to display only AutoSupport messages that match the trigger event
you specify.
[-last-update <MM/DD/YYYY HH:MM:SS>] - Time of Last Update
Use this parameter to display only AutoSupport messages that were updated most
recently at the time you specify. Specify time in "MM/DD/YYYY HH:MM:SS" format.
[-status <AutoSupport general status>] - Status of Delivery
Use this parameter to display only AutoSupport messages with the status you specify.
Possible statuses are:
initializing - The AutoSupport message request is being processed.
collection-failed - The AutoSupport collection failed. View the 'Last Error' field of
this message for more information.
collection-in-progress - The AutoSupport collection is in progress.
queued - The AutoSupport message is queued for delivery.
transmitting - The AutoSupport message transmission is in progress.
sent-successful - The AutoSupport message was sent successfully.
1462
ignore - The AutoSupport message was processed successfully, but the trigger
event is not configured for delivery to the current destination type.
re-queued - The AutoSupport message transmission failed, has been re-queued,
and will be retried.
transmission-failed - The AutoSupport message transmission failed, and the retry
limit was exceeded.
ondemand-ignore - The AutoSupport message was processed successfully, but
the AutoSupport On Demand server chose to ignore it.
[-attempt-count <integer>] - Delivery Attempts
Use this parameter to display only AutoSupport messages that the system has
attempted to send the number of times you specify. This parameter is most useful when
given a range, such as ">5".
[-subject <text>] - AutoSupport Subject
Use this parameter to display only AutoSupport messages of the type you specify.
[-uri <text>] - Delivery URI
Use this parameter to display only AutoSupport messages sent to the destination URI
you specify.
[-error <text>] - Last Error
Use this parameter to display only AutoSupport messages that failed with the "Last
Error" description you specify.
[-generated-on <MM/DD/YYYY HH:MM:SS>] - Time of Generation
Use this parameter to display only AutoSupport messages that were generated
(collected) at a particular time.
[-size {<integer>[KB|MB|GB|TB|PB]}] - AutoSupport Compressed Size
Use this parameter to display only AutoSupport messages of the compressed size you
specify.
Use this parameter to display the percentage completed for any active (incomplete)
[-upload-rate {<integer>[Bps|KBps|MBps|GBps]|unlimited}] - Rate of Upload
Use this parameter to display the rate in bytes per second that upload is using currently,
otherwise zero when not active.
1463
[-time-remaining <[<integer>h][<integer>m][<integer>s]>] - Time Remaining for Upload

Use this parameter to display the estimated time for the transmission of the AutoSupport
message to complete.
[-decompressed-size {<integer>[KB|MB|GB|TB|PB]}] - AutoSupport Decompressed
Size
Use this parameter to display only AutoSupport messages of the decompressed size
you specify.
[-total-time <integer>] - Total Collection Time (ms)
Use this parameter to display only AutoSupport messages of total collection time you
specify. A value is only shown when the collection has completed.
Examples
The following example shows the first three results output by the history command. Note
that "q" was pressed at the prompt.
cluster1::> system node autosupport history show -node node1
Seq
Node
Num
Destination Status
Attempt
Last
Count
Update
------------ ----- ----------- -------------------- -------- ----------------node1
56
smtp
ignore
11/18/2010 01:10:01
http
re-queued
11/18/2010 02:50:07
noteto
transmitting
11/18/2010 01:10:01
smtp
ignore
11/18/2010 00:53:59
http
sent-successful
11/18/2010 01:50:03
noteto
sent-successful
11/18/2010 00:53:59
smtp
ignore
11/17/2010 12:18:58
http
sent-successful
11/17/2010 16:07:22
noteto
sent-successful
11/17/2010 12:18:58
55
54
Press <space> to page down, <return>> for next line, or 'q' to quit... q
1464

Display AutoSupport content manifest
level.
Description
The system node autosupport manifest show command reports what
information is contained in AutoSupport messages. The name and size of each file
collected for the message is reported, along with any errors.
Parameters
specify.
| [-content ]
Use this parameter to display detailed information about the content of the files
contained in the report.
| [-instance ] }
about all fields.
Use this parameter to display information about only AutoSupport messages sent from
Use this parameter to display information about only AutoSupport message content
with the sequence number you specify. Sequence numbers are unique to a node. Use
this parameter with the -node parameter to display information about an individual
message.
[-prio-num <integer>] - Priority Order of Collection
Use this parameter to display information about only AutoSupport message content with
the collection priority you specify. Content is collected in order, by priority number.
1465
[-subsys <AutoSupport collection subsystems>] - Subsystem

collected by the AutoSupport subsystem you specify.
[-cmd-tgt <Execution domain of AutoSupport content>] - Execution Domain for
Command
produced in the execution domain you specify.
[-body-file <text>] - The AutoSupport Content Filename for this Data
stored in the body file with the file name you specify.
[-cmd <text>] - Actual Data Being Collected
produced by the D-Blade command, BSD command, file, or XML table you specify.
[-query <text>] - Table Query for XML Collection
produced by the table query you specify.
[-size-collected {<integer>[KB|MB|GB|TB|PB]}] - Number of Bytes Collected
collected in files with the file size you specify.
[-time-collected <integer>] - Collection Time for this Data Item (ms)
collected in the amount of time you specify, in milliseconds.
[-status <AutoSupport manifest collection status>] - Status of this Data Item
Use this parameter to display information about only AutoSupport message content with
the collection status you specify. Possible statuses are:
requested - The AutoSupport request has been added to the queue and is
waiting processing by the collector.
working - The AutoSupport collector is actively gathering the needed data.
file-not-found - AutoSupport data collection failed because a necessary file
is missing.
no-such-table - The AutoSupport collector was unable to find the requested
SMF table.
1466
collection-truncated-size-limit - AutoSupport data was truncated due

to size limits, but partial data is available.
collection-truncated-file-size-limit - AutoSupport data for a
particular data item or file was truncated due to file size limits, but partial data is
available.
collection-skipped-size-limit - AutoSupport data was skipped due to
size limits, and no data is available.
collection-truncated-time-limit - AutoSupport data was truncated due
to time limits, but partial data is available.
collection-skipped-time-limit - AutoSupport data was skipped due to
time limits, and no data is available.
delivery-skipped-size-limit - AutoSupport data was skipped at delivery
time due to size limits.
general-error - AutoSupport data collection failed. Additional information (if
any) is in the Error String field.
completed - AutoSupport data collection is complete, and the AutoSupport
message is ready for delivery.
content-not-collected-precheck - AutoSupport content was not collected
due to pre-check function violation.
content-not-collected-privacy - AutoSupport content was not collected
because the operation is disabled in privacy mode.
content-empty - AutoSupport content was collected successfully, but the output
was empty.
collection-aborted - AutoSupport data collection was aborted.
[-error <text>] - Textual Description of Error
with the error text you specify. If data collection has failed, the error text contains a
description of the failure. If data collection completes successfully, this field is
empty.
[-content-type <Type of AutoSupport content>] - AutoSupport Content Type for this
Data
Use this parameter to display information about only AutoSupport message content of
the type you specify. Types supported are:
basic - Configuration data about this subsystem
1467
troubleshooting - Detailed diagnostic data about this subsystem
Examples
This example displays the content of AutoSupport message number 372 on the node
"node1".
cluster1::> system node autosupport manifest show -node node1 -seq-num 372
Node
Sequence
AutoSupport
Collected
Body Filename
Size
Status
Error
----------------- --------- -------------- ----------- --------- ----------node1
372
SYSCONFIG-A.txt
OPTIONS.txt
1.73KB completed
29.44KB completed
software_image.xml
7.56KB completed
CLUSTER-INFO.xml
autosupport.xml
3.64KB completed
12.29KB completed
autosupport_budget.xml
7.01KB completed
autosupport_history.xml
46.52KB completed
X-HEADER-DATA.TXT
717.00B completed
SYSTEM-SERIAL-NUMBER.TXT
35.00B completed
cluster_licenses.xml
3.29KB completed
cm_hourly_stats.gz 151.4KB completed
boottimes.xml
56.86KB completed
rdb_txn_latency_stats_hrly.xml
39.31KB completed
rdb_voting_latency_stats_hrly.xml
3.43KB completed
This example shows how you can use parameters to limit output to specific fields of a
specific AutoSupport message. This is helpful when troubleshooting.
cluster1::> system node autosupport manifest show -node node5 -seq-num 842 fields body-file,status,size-collected,time-collected,cmd,cmd-tgt,subsys
node
seq-num prio-num subsys
cmd-tgt body-file
size-collected time-collected status
cmd
---------- ------- -------- --------- ------- --------------- --------------------------- -------------- ---------
1468
node5
16.44KB
842
mandatory dblade
completed
SYSCONFIG-A.txt "sysconfig -a"
256
node5
29.67KB
node5
8.68KB
842
1
3542
mandatory dblade
completed
OPTIONS.txt
842
33
options
mandatory smf_table software_image.xml software_image

completed
node5
842
3
asup_cluster_info 4.75KB
mandatory smf_table CLUSTER-INFO.xml

7
completed
node5
12.32KB
mandatory smf_table autosupport.xml autosupport

completed
842
4
10
node5
842
5
mandatory smf_table autosupport_budget.xml
autosupport_budget 7.03KB 29
completed
node5
842
6
mandatory smf_table autosupport_history.xml
autosupport_history 62.77KB 329
completed
node5
842
7
function" 720.00B 3
node5
842
8
function" 31.00B 2
mandatory custom_fx X-HEADER-DATA.TXT "Custom

completed
mandatory custom_fx SYSTEM-SERIAL-NUMBER.TXT "Custom
completed
node5
842
9
cluster_licenses 5.62KB 9
mandatory smf_table cluster_licenses.xml

completed
node5
13.07KB
842
4
10
log_files custom_fx log_files.xml "Custom function"

completed
node5
25.33KB
842
24
11
log_files custom_fx EMS-LOG-FILE.gz "Custom function"

completed
node5
log/ems -
842
-
12
log_files dblade_file EMS-LOG-FILE-PARTNER.gz /etc/

content-not-collected-precheck
node5
35.40KB
842
42
13
log_files dblade_file MESSAGES.gz /etc/log/messages

completed
14
log_files dblade_file MESSAGES-PARTNER.gz /etc/log/

content-not-collected-precheck
node5
842
messages -
1469
system node autosupport trigger modify

Modify AutoSupport trigger configuration
level.
Description
Use the system node autosupport trigger modify command to enable
and disable AutoSupport messages for individual triggers, and to specify additional
subsystem reports to include if an individual trigger sends an AutoSupport message.
Parameters
Use this parameter to specify the node whose AutoSupport trigger configuration is
modified.
-autosupport-message <Autosupport Message> - EMS Message
Use this parameter to specify the AutoSupport trigger to modify. AutoSupport triggers
are EMS messages whose names begin with "callhome.". However, for the purposes
of this command, "callhome." is implied, does not need to be entered, and will not be
displayed in command output.
[-to {enabled|disabled}] - Deliver to AutoSupport -to Addresses
Use this parameter with the value "enabled" to enable sending AutoSupport messages
to the configured "to" address.
[-noteto {enabled|disabled}] - Deliver to AutoSupport -noteto Addresses
Use this parameter with the value "enabled" to enable sending short notes to the
configured "noteto" address.
[-basic-additional <AutoSupport collection subsystems>, ...] - Additional Subsystems
Reporting Basic Info
Use this parameter to include basic content from the additional subsystems you specify.
Content is collected from these subsystems in addition to the default list of subsystems.
[-troubleshooting-additional <AutoSupport collection subsystems>, ...] - Additional
Subsystems Reporting Troubleshooting Info
1470
Use this parameter to include troubleshooting content from the additional subsystems
you specify. Content is collected from these subsystems in addition to the default list of
subsystems.
Examples
The following example enables messages from the battery.low trigger on the node
node1.
cluster1::> system node autosupport trigger modify -node node1 -autosupportmessage battery.low -to enabled
See Also
1471
system node autosupport trigger show

Display AutoSupport trigger configuration
level.
Description
The system node autosupport trigger show command displays what system
events trigger AutoSupport messages. When a trigger event occurs, the node may
send an AutoSupport message to a predefined destination, and a short note to another
destination. The full AutoSupport message contains detail for troubleshooting. The short
message is meant for short pager or SMS text messages.
Use the system node autosupport destinations show command to view
available destinations.
Parameters
specify.
| [-basic ]
Use this parameter to display which subsystem information is included as basic content
when the AutoSupport message is triggered.
| [-troubleshooting ]
Use this parameter to display which subsystem information is included as
troubleshooting content when the AutoSupport message is triggered.
| [-instance ] }
about all fields.
Use this parameter to display AutoSupport triggers only on the node you specify.
[-autosupport-message <Autosupport Message>] - EMS Message
1472
Use this parameter to display only AutoSupport triggers with the name you specify.
AutoSupport triggers are EMS messages whose names begin with "callhome.".
However, for the purposes of this command, "callhome." is implied, does not need to be
entered, and will not be displayed in command output.
[-to {enabled|disabled}] - Deliver to AutoSupport -to Addresses
Use this parameter with the value "enabled" to display only AutoSupport messages
that send full messages to the "to" address when triggered. Use this parameter with the
value "disabled" to display only AutoSupport messages that do not send full messages.
[-noteto {enabled|disabled}] - Deliver to AutoSupport -noteto Addresses
Use this parameter with the value "enabled" to display only AutoSupport messages that
send short notes to the "noteto" address when triggered. Use this parameter with the
value "disabled" to display only AutoSupport messages that do not send short notes.
[-basic-default <AutoSupport collection subsystems>, ...] - Default Subsystems
Use this parameter to display only AutoSupport triggers that include in their messages,
by default, basic content from the subsystems you specify.
[-troubleshooting-default <AutoSupport collection subsystems>, ...] - Default
Use this parameter to display only AutoSupport triggers that include in their messages,
by default, troubleshooting content from the subsystems you specify.
[-additional-content <Type of AutoSupport content>, ...] - Additional Content Flag
Use this parameter to display only AutoSupport triggers that have been configured to
include additional basic or troubleshooting content.
[-basic-additional <AutoSupport collection subsystems>, ...] - Additional Subsystems
include additional basic content from the subsystems you specify.
[-troubleshooting-additional <AutoSupport collection subsystems>, ...] - Additional
include additional troubleshooting content from the subsystems you specify.
Examples
This example shows the first page of output from the command. Note that "q" was
pressed at the prompt to quit.
1473
cluster1::> system node autosupport trigger show

AutoSupport
Node
Message
Additional
To
Note To
Content
------------ ------------------------- --------- ------------- --------------node1
aggr.offline
enabled
enabled
node1
aggr.restricted
disabled
enabled
node1
aggr.wafliron
disabled
enabled
node1
bad.ram
disabled
disabled
node1
battery.failure
enabled
enabled
node1
battery.low
disabled
disabled
node1
battery.notice
enabled
enabled
node1
battery.overchg
enabled
enabled
node1
battery.overtemp
enabled
enabled
node1
battery.warning
enabled
enabled
node1
bmc.bus
disabled
disabled
node1
bmc.hb.stop
disabled
disabled
node1
bmc.post
disabled
disabled
node1
bootfs.chkdsk
enabled
enabled
node1
c.fan
enabled
enabled
node1
c.fan.fru.degraded
disabled
disabled
node1
c.fan.fru.fault
disabled
enabled
node1
c.fan.fru.rm
disabled
enabled
node1
c.fan.fru.shut
enabled
enabled
node1
ch.ps.degraded
disabled
disabled
Press <space> to page down, <return> for next line, or 'q' to quit... q
See Also
system node autosupport destinations show system node autosupport manifest show
1474
system node coredump delete-all

Delete all coredumps owned by a node
level.
Description
The system node coredump delete-all command deletes either all unsaved
core dumps or all saved core files on a node. You can specify whether saved core
files or unsaved core dumps are deleted by using the optional -saved parameter. If
the command is issued while a core dump is being saved, the command prompts you
before stopping the save operation and deleting the core dump.
Parameters
-node <nodename> - Node That Owns the Coredump
This specifies the node from which core files or core dumps are to be deleted.
[-type {unsaved-kernel|saved-kernel|kernel|application|all}] - Type of Core to delete
This parameter specifies the type of core file to be deleted. If the type is unsaved, all
unsaved core dumps will be deleted. If the type is saved, all saved core files will be
deleted. If the type is kernel, all kernel core files and kernel core dumps will be deleted.
If the type is application, all application core files will be deleted. If the type is all, all core
files will be deleted. The default setting is to delete only unsaved kernel core dumps and
core files.
Examples
The following example deletes all unsaved kernel core dumps on a node named node0:
cluster1::> system node coredump delete-all -node node0
system node coredump delete

Delete a coredump
level.
1475
Description
The system node coredump delete command deletes a specified core dump. If
the command is issued while the specified core dump is being saved, the command
prompts you before stopping the save operation and deleting the core dump.
Parameters
-node {<nodename>|local} - Node That Owns the Coredump
This specifies the node from which core files are to be deleted.
[-type {kernel|application}] - Coredump Type
This specifies the type of core file to be deleted. If the type is kernel, the specified kernel
core file will be deleted. If the type is application, the specified application core file will
be deleted.
-corename <text> - Coredump Name
This specifies the core file that is to be deleted.
Examples
The following example deletes a core dump named
core.101268397.2010-05-30.19_37_31.nz from a node named node0:
cluster1::> system node coredump delete -node node0 -corename
core.101268397.2010-05-30.19_37_31.nz
system node coredump save-all

Save all unsaved kernel coredumps owned by a node
level.
Description
The system node coredump save-all saves all unsaved core dumps on a
specified node. If the node has already attempted to save the core dump by the value
set by the -save-attempts parameter, the command prompts you before continuing. The
save-attempts parameter is set by invoking the command system node coredump config
modify.
1476
Parameters
-node <nodename> - Node That Owns the Coredump
This specifies the node on which unsaved core dumps are to be saved.
Examples
The following example saves all unsaved core dumps on a node named node0:
cluster1::> system node coredump save-all -node node0
See Also
system node coredump save
1477
system node coredump save

Save an unsaved kernel coredump
level.
Description
The system node coredump save command saves a specified core dump. If
the node has already attempted to save the core dump by the value specified by
the -save-attempts parameter, the command prompts you before continuing.
The -save-attempts parameter is set by invoking the command system node
coredump config modify. A saved core dump can be uploaded to a remote site for
support analysis; see the system node coredump upload command man page for
more information.
Parameters
This specifies the node on which the core dump is located.
This specifies the core dump that is to be saved.
Examples
The following example saves a core dump named
core.101268397.2010-05-30.19_37_31.nz on a node named node0:
cluster1::> system node coredump save -node node0 -corename
core.101268397.2010-05-30.19_37_31.nz
See Also
system node coredump config modify system node coredump upload
system node coredump save-all
1478

Display a list of coredumps
level.
Description
The system node coredump show command displays basic information about
core dumps, such as the core dump name, time of panic that triggered the core dump
and whether the core file is saved. You can specify optional parameters to display
information that matches only those parameters. For example, to display the list of
kernel core files, run the command with -type kernel.
Parameters
specify.
| [-system ]
If you specify this parameter, the command displays the following information:
Node name
Core dump name
Core dump ID
Node that panicked and generated the core
System ID of the node that panicked and generated the core
Version of the core
| [-instance ] }
about all fields.
[-node {<nodename>|local}] - Node That Owns the Coredump
1479
If you specify both this parameter and the -corename parameter, the command
displays detailed information about the specified core. If you specify this parameter by
itself, the command displays information about the core files on the specified node.
This parameter specifies the type of core files to be displayed. If the type is kernel, the
command displays kernel core files. If the type is application, the command displays
application core files.
[-corename <text>] - Coredump Name
If you specify both this parameter and the -node parameter, the command displays
detailed information about the specified core. If you specify this parameter by itself, the
command displays information about the core files that match the specified name.
[-panic-node <text>] - Node That Generated Core
If you specify this parameter with a node name, the command displays information only
about the core files that were generated when the specified node panicked.
[-panic-systemid <integer>] - System ID of Node That Generated Core
If you specify this parameter, the command displays information only about the core files
that were generated when the node with the specified system ID panicked.
[-version <text>] - Data ONTAP Version of Core
that match the specified version.
[-panic-time <MM/DD/YYYY HH:MM:SS>] - Time of Panic That Generated Core
that were generated by a panic at the specified time. Specify time in the format of MM/
DD/YYYY HH:MM:SS [+- HH:MM]. You can use [+- HH:MM] to specify the time range
within which all core files triggered by a panic are displayed. [+- HH:MM] is relative to
UTC.
[-panic-string <text>] - Panic String
that match the specified panic string.
[-is-saved {true|false}] - Saved Core
If you specify this parameter, the command displays information only about the core
dumps that are or are not saved yet to a core file.
[-is-partial {true|false}] - Partial Core
1480
dumps that are or are not partially saved.
[-save-attempts <integer>] - Number of Attempts to Save Core
dumps that have the specified number of successful or failed save attempts.
[-space-needed {<integer>[KB|MB|GB|TB|PB]}] - Space Needed To Save Core
dumps that need the specified amount of disk space to save into a core file.
Examples
The following examples display information about the core files:
cluster1::> system node coredump show
Node
Core Name
Saved
Panic Time
-------- ------------------------------------------- ------- ----------------node0

core.101182345.2010-02-01.14_19_08.nz
false
2/1/2010 09:19:08
Partial Core: false

Number of Attempts to Save Core: 2
Space Needed To Save Core: 4.45GB
node1
core.101268397.2010-05-30.19_37_31.nz
true
5/30/2010 15:37:31
true
9/6/2010 14:40:03
core.101271326.2010-09-06.19_06_18.nz
true
9/6/2010 15:06:18
core.101271326.2010-09-06.19_09_49.nz
true
9/6/2010 15:09:49
node2
core.101270930.2010-09-06.18_40_03.nz
node3

cluster1::> system node coredump show -panic-time 9/6/2010 15:00:00+3:00
Node
Core Name
Saved
Panic Time
-------- ------------------------------------------- ------- ----------------node3

core.101271326.2010-09-06.19_06_18.nz
true
9/6/2010 15:06:18
core.101271326.2010-09-06.19_09_49.nz
true
9/6/2010 15:09:49
See Also
1481
system node coredump status
1482
system node coredump status

Display kernel coredump status
level.
Description
The system node coredump status command displays status information about
core dumps. The command output depends on the parameters specified with the
command. If a core dump is in the process of being saved into a core file, the command
also displays its name, the total number of blocks that are to be saved, and the current
number of blocks that are already saved.
parameters. For example, to display coredump status information about the local node,
run the command with the parameter -node local.
Some parameters are available only at the advanced privilege level and higher.
Parameters
specify.
| [-disks ] (privilege: advanced)
Node name
Total number of disks
Number of spare disks
Number of disks used
Number of disks with partial cores
| [-spraycore ] (privilege: advanced)
1483
Node name
Whether spray cores are supported
Number of spray-core disks
Number of spray-core blocks
Number of disks needed for spray core
Number of blocks needed for spray core
| [-instance ] }
about all fields.
Node name
State of the core-dump process
Space available on the internal file system
Name of the core being saved, if applicable
Total number of blocks in the core being saved, if applicable
Number of blocks currently saved, if applicable
Type of core dump
Number of unsaved complete cores on the node
Number of unsaved partial cores on the node
If you specify this parameter at the advanced privilege level or higher, the command
displays the following additional information:
Whether spray cores are supported on the node
Whether any spare disks are available on the node
Number of disks that have cores
Number of unsaved cores
Number of disks that have partial cores
1484
Number of partial cores

Number of unused spray-core disks
Number of spray-core blocks
Number of disks available for core dumps
Number of blocks needed for spray core
Number of disks needed for spray core
[-state <text>] - State
If you specify this parameter, the command displays information only about the nodes
that are in the specified core dump state. Possible values include: nocore, idle, init,
saving, and waitdump.
[-space-available {<integer>[KB|MB|GB|TB|PB]}] - Space Available On Internal
Filesystem
that have the specified amount of available space, in bytes, on their internal file
systems.
[-corename <text>] - Name of Core Being Saved
If you specify this parameter, the command displays information only about the node
that is currently saving the specified core file name.
[-total-blocks <integer>] - Total Number of Blocks in Core Being Saved
that have the specified number of blocks in the core dump being saved.
[-blocks-saved <integer>] - Number of Blocks saved
that have the specified number of blocks saved.
[-type <text>] - Type of Core Dump
that have the specified core dump type. Possible values include zipped, sprayed, and
spare.
[-spraycore-supported {true|false}] - Spray Core Supported on Node (privilege:
advanced)
1485
that do or do not support the spray method of dumping core. This parameter is available
[-spares-available {true|false}] - Spare Disk(s) Available on Node (privilege: advanced)
that do or do not have spare disks available. This parameter is available only at the
[-disks-used <integer>] - Number of Disks with Cores (privilege: advanced)
that have the specified number of disks that contain core dumps. This parameter is
[-unsaved-cores <integer>] - Number of Unsaved Complete Cores
that have the specified number of complete core dumps that are not yet saved into a
core file.
[-partial-disks <integer>] - Number of Disks with Partial Cores (privilege: advanced)
that have the specified number of disks with partial core dumps. This parameter is
[-partial-cores <integer>] - Number of Unsaved Partial Cores
that have the specified number of partial core dumps that are not yet saved into a core
file.
[-spraycore-disks <integer>] - Number of Unused Spray Core Disks (privilege:
advanced)
that have the specified number of unused spray-core disks. This parameter is available
[-spraycore-blocks <integer>] - Number of Spray Core Blocks (privilege: advanced)
that have the specified number of spray-core blocks. This parameter is available only at
[-numdisks <integer>] - Total Number of Disks Available for Core Dump (privilege:
advanced)
1486
that have the specified total number of disks available for core dump. This parameter is
[-blocks-needed <integer>] - Number of Blocks Needed for Spray Core (privilege:
advanced)
that have the specified number of blocks needed for the spray method of dumping core.
[-disks-needed <integer>] - Number of Disks Needed for Spray Core (privilege:
advanced)
that have the specified number of disks needed for the spray method of dumping core.
[-space-needed {<integer>[KB|MB|GB|TB|PB]}] - Space Needed to Save All Unsaved
Cores
that require the specified amount of disk space to save all unsaved core dumps.
[-min-free {<integer>[KB|MB|GB|TB|PB]}] - Minimum Free Bytes on Root Filesystem
that need to have the specified number of bytes available on the root filesystem after a
core dump is saved.
Examples
The following example displays core dump information about the node named node0:
cluster1::> system node coredump status -node node0 -instance
Node: node0
State: idle
Space Available On Internal Filesystem: 132.1GB
Name of Core Being Saved: Total Number of Blocks in Core Being Saved: Number of Blocks saved: Type of core dump: spray
Number of Unsaved Complete Cores: 0
Number of Unsaved Partial Cores: 1
Space Needed To Save All Unsaved Cores: 4.81GB
Minimum Free Bytes On Internal Filesystem: 250MB
1487
See Also
1488
system node coredump trigger

Make the node dump system core and reset
privilege level.
Description
This command triggers a Non-maskable Interrupt (NMI) on the specified node via the
Service Processor of that node, causing a dirty shutdown of the node. This operation
forces a dump of the kernel core when halting the node. LIF migration or storage
takeover occurs as normal in a dirty shutdown. This command is different from the dump parameter of the system node shutdown, system node halt, or system
node reboot command in that this command uses a control flow through the Service
Processor of the remote node, whereas the -dump parameter uses a communication
channel between Data ONTAP running on the nodes. This command is helpful in cases
where Data ONTAP on the remote node is hung or does not respond for some reason.
If the panic node reboots back up, then the generated coredump can be seen by using
the system node coredump show command. This command works for a single node
only and the full name of the node must be entered exactly.
Parameters
This parameter specifies the node for which you want to trigger a coredump.
Examples
The following example triggers a NMI via the Service Processor and causes node2 to
panic and generate a coredump. Once node2 reboots back up, the command system
node coredump show can be used to display the generated coredump.
cluster1::*> system node coredump trigger -node node2
Warning: The Service Processor is about to perform an operation that will cause
1489
a dirty shutdown of node "node2". This operation can

cause data loss. Before using this command, ensure that the cluster
will have enough remaining nodes to stay in quorum. To reboot or halt
a node gracefully, use the "system node reboot" or "system node halt"
command instead. Do you want to continue? {yes|no}: yes
Warning: This operation will reboot the current node. You will lose this login
session. Do you want to continue? {y|n}: y
cluster1::*>
cluster1::> system coredump show
Node:Type Core Name
Saved Panic Time
--------- ------------------------------------------- ----- ----------------node2:kernel

core.1786429481.2013-10-04.11_18_37.nz
false 10/4/2013 11:18:37
Partial Core: false

Number of Attempts to Save Core: 0
Space Needed To Save Core: 3.60GB
cluster1::>
See Also
system node shutdown system node halt system node reboot
1490
system node coredump upload

(DEPRECATED)-Upload a coredump to a remote site
level.
Description
Attention:
This command is deprecated and might be removed in a future release of Data ONTAP.
Use "system node autosupport invoke-core-upload" instead.
The system node coredump upload command uploads a saved core file to a
specified URL. You should use this command only at the direction of technical support.
Parameters
This specifies the node on which the core file is located.
This specifies the type of core files to be uploaded. If the type is kernel, kernel core files
will be uploaded. If the type is application, application core file will be uploaded.
This specifies the name of the core file that is to be uploaded.
[-location <text>] - URL for Coredump Upload Directory
This specifies the URL to which the core file is to be uploaded. If this parameter is not
specified, the command uploads the core file to the location specified by the -uploadlocation parameter of the system node coredump config modify command.
The following protocols are supported: ftp, tftp, and http. (By default, the location is set
to ftp://ftp.netapp.com/to-ntap/, for which you enter 'anonymous' as the username and
any valid email address as the password when the system prompts you for credential.)
[-casenum <integer>] - Case Number
This specifies the support case number that will be prefixed to the core file name at the
destination. The case number is critical information for quick and automated processing
of the received core file.
1491
Examples
The following example uploads a core file named
core.07142005145732.2010-10-05.19_03_41.nz on a node named node0 to the default
location. The support case number is 2001234567.
cluster1::> system node coredump upload -node node0 -corename
core.07142005145732.2010-10-05.19_03_41.nz -casenum 2001234567
See Also
system node coredump config modify system node autosupport invoke-core-upload
1492
system node coredump config modify

Modify coredump configuration
level.
Description
The system node coredump config modify command modifies the cluster's core
dump configuration.
Parameters
This parameter specifies the node whose coredump configuration you want to modify.
[-sparsecore-enabled {true|false}] - Enable Sparse Cores
If you set this parameter to true, the command enables sparse cores. A sparse core
omits all memory buffers that contain only user data.
[-min-free {<integer>[KB|MB|GB|TB|PB]}] - Minimum Free Bytes On Root Filesystem
If you specify this parameter, the command displays the number of bytes that need to
be made available in the root file system after saving the core dump. If the minimum
number of bytes cannot be guaranteed, core dumps are not generated. The default
setting is 250 MB.
[-coredump-attempts <integer>] - Maximum Number Of Attempts to Dump Core
If you specify this parameter, the command displays the maximum number of times the
system will attempt to generate a core dump when encountering repeated disk failures.
The default setting is 2.
[-save-attempts <integer>] - Maximum Number Attempts to Save Core
If you specify this parameter, the command displays the maximum number of times the
system will attempt to save a core dump.The default setting is 2.
[-save-onstartup {true|false}] - Enable Auto Save of Coredumps on Startup
If you set this parameter to true, the system will automatically start saving the core dump
after reboot.
[-upload-location <text>] - URL for Coredump Upload Directory
1493
Attention:
This option is deprecated and might be removed in a future release of Data ONTAP. Use
the -uri parameter of the "system node autosupport invoke-core-upload"
command instead.
If you specify this parameter, the system uploads the core dumps to the specified URL.
The following protocols are supported: ftp, tftp, and http. (The default setting is ftp://
ftp.netapp.com/to-ntap/.)
Examples
The following example sets the maximum number of core dump attempts to 5 and the
maximum number of save attempts to 5:
cluster1::> system node coredump config modify -coredump-attempts 5 -saveattempts 5
See Also
1494
system node coredump config show

Display coredump configuration
level.
Description
The system node coredump config show command displays basic information
about a cluster's core dump configuration, such as whether sparse cores are enabled,
minimum number of free bytes on the root volume file system that need to be available
after saving the core files, maximum number of times the process attempts to generate
a core dump when encountering repeated disk failures, maximum number of times the
process attempts to save a core dump, the URL to which core dumps are uploaded, and
whether core dumps are automatically saved when a node restarts.
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays the coredump configuration
information of the specified node.
[-sparsecore-enabled {true|false}] - Enable Sparse Cores
If you specify this parameter, the command displays only the coredump information that
matches the specified spare core setting. A sparse core omits all memory buffers that
contain only user data.
[-min-free {<integer>[KB|MB|GB|TB|PB]}] - Minimum Free Bytes On Root Filesystem
If you specify this parameter, the command displays only the core dump information that
matches the specified number of bytes that need to be made available in the root file
system after saving the core dump.
1495
[-coredump-attempts <integer>] - Maximum Number Of Attempts to Dump Core

matches the specified maximum number of times the system will attempt to generate a
core dump when encountering repeated disk failures.
[-save-attempts <integer>] - Maximum Number Attempts to Save Core
matches the maximum number of times the system will attempt to save a core dump.
[-save-onstartup {true|false}] - Enable Auto Save of Coredumps on Startup
matches the specified configuration of whether the system will automatically start saving
the core dump after reboot.
[-upload-location <text>] - URL for Coredump Upload Directory
Attention:
This option is deprecated and might be removed in a future release of Data ONTAP. Use
the -uri parameter of the "system node autosupport invoke-core-upload"
command instead.
matches the specified URL where core dumps are uploaded.
Examples
The following example displays information about the cluster's core dump configuration:
cluster1::> system node coredump config show
Sparse
Core
Node
Enabled
Min
Max
Free
Dump
Max On
Save Startup
Bytes Attempts Attempts Enabled Coredump Location
----- ------- -------- -------- -------- ------- ----------------------------node0

true
example/
250MB
2 true
ftp://ftp.example.com/to-
250MB
2 true
250MB
2 true
node1
true
example/
node2
true
example/
node3
1496
true
example/
250MB
2 true
See Also
1497
system node coredump reports delete

Delete an application core report
level.
Description
The system node coredump reports delete command deletes the specified
application core report.
Parameters
This specifies the node from which reports are to be deleted.
-reportname <text> - Report Name
This specifies the report that is to be deleted.
Examples
The following example shows how a report named
notifyd.1894.80335005.2011-03-25.09_59_43.ucore.report is deleted from a node
named node0:
cluster1::> system node coredump reports delete -node node0 -reportname
notifyd.1894.80335005.2011-03-25.09_59_43.ucore.report
system node coredump reports show

Display a list of application core reports
level.
Description
The system node coredump reports show command displays basic information
about application core reports, such as the report name and time of the panic that
triggered the application core dump. You can specify optional parameters to display
1498
information that matches only those parameters. For example, to display the list of
reports in the local node, run the command with -node local.
Parameters
specify.
| [-instance ] }
about all fields.
[-node {<nodename>|local}] - Node That Owns the Coredump
Selects information about all the reports on the specified node. If you specify both this
parameter and the -reportname parameter, the command displays detailed information
about the specified report.
[-reportname <text>] - Report Name
Selects information about the reports that match the specified name. If you specify both
this parameter and the -node parameter, the command displays detailed information
about the specified report.
[-panic-node <text>] - Node That Generated Core
Selects information about the reports that were generated by the specified node.
[-panic-systemid <integer>] - System ID of Node That Generated Core
Selects information about the reports that were generated by thenode with the specified
system ID.
[-version <text>] - Data ONTAP Version of Core
Selects information about the reports that match the specified version.
Selects information about the reports that were generated by a panic at the specified
time. Specify time in the format of MM/DD/YYYY HH:MM:SS [+- HH:MM]. You can use
[+- HH:MM] to specify the time range within which all core files triggered by a panic are
displayed. [+- HH:MM] is relative to UTC.
[-panic-string <text>] - Panic String
Selects information about the reports that match the specified panic string.
1499
Examples
The following example displays information about the reports:
cluster1::> system node coredump reports show
Node
Report Name
Panic Time
-------- -------------------------------------------
-----------------
node0
notifyd.1894.80335005.2011-03-25.09_59_43.ucore.report
09:59:43
1500
3/25/2011
system node coredump reports upload

(DEPRECATED)-Upload an application core report to a remote site
level.
Description
Attention:
This command is deprecated and might be removed in a future release of Data ONTAP.
See core report information in the SmartSoft tool.
The system node coredump reports upload command uploads an application
report to a specified URL. You should use this command only at the direction of
technical support.
Parameters
This specifies the node on which the report is located.
-reportname <text> - Report Name
This specifies the name of the report that is to be uploaded.
[-location <text>] - URL for Coredump Upload Directory
This specifies the URL to which the report is to be uploaded. The following protocols are
supported: ftp, tftp, and http. (By default, the location is set to ftp://ftp.netapp.com/tontap/, for which you enter 'anonymous' as the username and any valid email address as
the password when the system prompts you for credential.)
[-casenum <integer>] - Case Number
This specifies the support case number that is be prefixed to the core file name at the
destination. The case number is critical information for quick and automated processing
of the received core file.
Examples
1501
The following example shows how a report named

notifyd.1894.80335005.2011-03-25.09_59_43.ucore.bz2 is uploaded on a node named
node0 to the default location. The support case number is 2001234567.
cluster1::> system node coredump reports upload -node node0 -corename
notifyd.1894.80335005.2011-03-25.09_59_43.ucore.bz2 -casenum 2001234567
system node coredump segment delete-all

Delete all core segments on a node
level.
Description
This command deletes all the core segments on a node.
Parameters
This specifies the node on which to delete the core segments.
Examples
This deletes all the core segments for node1.
cluster1::> system node coredump segment delete-all -node node1
system node coredump segment delete

Delete a core segment
level.
Description
This command deletes a core segment.
Parameters
1502

This specifies the node on which to delete the core segments.
-segment <text> - Core Segment
This specifies the core segment to delete. The pathname is relative to the coredump
directory. If a directory is specified, all core segment files within it are deleted. If the
directory is empty, it is deleted.
[-owner-node <text>] - Node That Owns the Core Segment File
This specifies the node that owns the core segment. Use this parameter only in takeover
mode to delete a partner's coredump segment.
Examples
This deletes all core segments in the directory, core.151708240.2012-01-11.05_56_52.
cluster1::> system node coredump segment delete -node node1 -segment
core.151708240.2012-01-11.05_56_52
system node coredump segment show

Display a list of core segments
level.
Description
This command displays the following information about core segments:
name of the core segment directory
time of the panic that generated the core segment
total number of core segment files
core segment file name
Parameters
1503
specify.
| [-instance ] }
Displays the following details:
Core segment file name
Node that owns the core segment file
System ID of the node that generated the core
MD5 checksum of the compressed data of the core segment file
Name of the core segment
Total number of core segments for the core file
Timestamp of the panic that triggered the core segment
Selects information about the core segments on the specified node.
[-segment <text>] - Core Segment
Selects information about the specified core segment. If segment is a directory, the
command displays the information for the first core segment file. If segment is a file, the
command displays the file information.
[-owner-node <text>] - Node That Owns the Core Segment File
Selects information about the core segments owned by the specified node. This
parameter should only be used in takeover mode to display information about the
partner's core segments.
[-panic-system-id <integer>] - System ID of Node That Generated Core
Selects information about the core segments that were generated when the node with
the specified system ID panicked.
[-md5-data-chksum <text>] - Md5 Checksum of the Compressed Data of the Core
Segment
Selects information about the core segments whose data segment's MD5 checksum
matches the specified checksum.
[-segment-name <text>] - Name of the Core Segment
Selects information about the core segments with the specified name.
1504
[-total-segment-count <integer>] - Number of Segments Generated

Selects information about the core segments with the specified name.
Selects information about the core segments that were generated by a panic at the
specified time.
Examples
The example below displays the core segments on node1.
cluster1::> system node coredump segment show -node node1
Node: node1
Segment Directory: core.118049106.2012-01-05.17_11_11
Panic Time: 1/5/2012 12:11:11
Number of Segments: 2
Segment File Name:
core.118049106.2012-01-05.17_11_11.nvram.nz
core.118049106.2012-01-05.17_11_11.ontap.nz
The example below displays detailed information a specific core segment file on node1.
cluster1::> system node coredump segment show -node node1 -segment
core.118049106.2012-01-05.17_11_11.ontap.nz -instance
Node: node1
Core Segment:
core.118049106.2012-01-05.17_11_11.ontap.nz
Node That Owns the Core Segment File: node1
System ID of Node That Generated Core: 118049106
Md5 Checksum of the Compressed Data of the Core Segment:
1a936d805dcd4fd5f1180fa6464fdee4
Name of the Core Segment: ontap
Number of Segments Generated: 2
Time of Panic That Generated Core: 1/5/2012 12:11:11
1505
system node coredump segment start

Start a core segmenting job
level.
Description
This command schedules a job to segment a core file.
Parameters
This specifies the node on which you want to segment the core file.
-core-name <text> - Name of the Full Core to Be Segmented
This specifies the core file to segment.
[-delete-core {true|false}] - Deletes Full Core After Successful Segmenting of the Core
This specifies to delete the full core file after the segmenting. The default is false - do
not delete.
Examples
This schedules a job to segment the core file, core.101166076.2012-01-22.18_38_09.nz
on node1.
cluster1::> system node coredump segment start -node node1 -corename
core.101166076.2012-01-22.18_38_09.nz
system node coredump segment status

Display status of a core segmenting job
level.
Description
1506
This command displays the status of a core segmenting job. The following fields are
displayed:
Job Id
Core file name
Status
Percentage complete
Parameters
specify.
| [-instance ] }
about all fields.
This displays detailed information for all core segmenting jobs.
[-core-name <text>] - Name of the Full Core to Be Segmented
If you specify this parameter, the command displays only the status for the core
segmenting job that is segmenting the specified core name.
[-owner-node <text>] - Node Whose Full Core Will Be Segmented
If you specify this parameter, the command displays only the status for core segmenting
jobs whose core file is owned by the specified node. This parameter should only be
used in takeover mode to display information about the partner's core segments.
[-job-id <integer>] - Core Segmenting Job Id
If you specify this parameter, the command displays only the status for the core
segmenting job identified by the job id.
[-status <The status fo the core segmentation job>] - Status of the Core Segmenting
Job
If you specify this parameter, the command displays information only for the core
segmenting jobs that have the specified status.
Statuses :
1507
Queued - The job is in the queue. It might run immediately or it might run after
another job completes.
Running - The job is running.
Stopping - The job has been canceled.
[-percent-completed <percent>] - Percentage of the Core Segmentation Completed
If you specify this parameter, the command displays only the status of core segmenting
jobs that are (at least) a specific percent complete.
Examples
This displays the status of the core segmenting jobs on node1.
cluster1::> system node coredump segment status -node node1
Core
Node
ID
Name
Status
Percent
-----
--
----------------
------
-------
core.118049106.2012-01-05.17_11_11.nz
node1
Running
1508
15%
system node coredump segment stop

Cancel core segmenting job
level.
Description
This command cancels a core segmenting job.
Parameters
This is the node on which the core segmenting job is running.
-job-id <integer> - Core Segmenting Job Id
This is the job identifier of the core segmenting job.
Examples
This cancels core segmenting job 10 on node1.
cluster1::> system node coredump segment stop -node node1 -job-id 10
system node coredump segment config modify

Modify the core segmenting configuration
level.
Description
This command controls automatic core file segmenting.
Parameters
This specifies the node whose core segmenting configuration is updated.
1509
[-auto-delete {true|false}] - Enable Deletion of Full Core After Automatic Core

Segmenting
This specifies whether the core file is deleted after automatic segmentation.
The default setting is false - do not delete the core file.
[-auto-segment {true|false}] - Enable Automatic Core Segmenting After Saving of a Full
Core
This specifies whether the core file is automatically segmented after it is saved.
In some systems, the default setting is false. For all other platforms, the default setting
is true - the system will automatically segment the full core file after the core has been
saved.
Examples
This enables automatic core file segmenting.
cluster1::> system node coredump segment modify -node node1 -auto-segment true
system node coredump segment config show

Display the core segmenting configuration
level.
Description
This command displays basic information about a node's core segmenting configuration,
such as whether automatic segmenting is enabled and whether the full core file is
deleted afterward.
Parameters
specify.
| [-instance ] }
Displays detailed information about all entries.
1510

Selects the nodes for which information is displayed.
[-auto-delete {true|false}] - Enable Deletion of Full Core After Automatic Core
Segmenting
Selects information about nodes that match the specified configuration for auto-delete
(whether the full core file should be automatically segmented after it is saved).
[-auto-segment {true|false}] - Enable Automatic Core Segmenting After Saving of a Full
Core
Selects information about nodes that match the specified configuration for auto-segment
(whether the full core file should be automatically segmented after it is saved).
Examples
The example below displays the core segmenting configuration for all nodes in the
cluster.
cluster1::> system node coredump segment config show -node *
AutoSegment
AutoDelete
Node
Enabled
Enabled
----
-----------
---------
cluster1
true
true
1511
system node environment sensors show

Display the sensor table
level.
Description
The system node environment sensors show command displays the following
information:
Node name
Sensor name
Sensor state
Sensor value
Sensor units
Critically Low threshold for the sensor
Warning Low threshold for sensor
Warning High threshold for sensor
Critically High threshold for the sensor
FRU name (detailed view only)
Parameters
specify.
| [-instance ] }
about all fields.
1512
Selects information about the sensors on the specified node.If this parameter is
specified with the -name parameter, the command displays information only about the
specified sensor.
[-name <text>] - Sensor Name
Selects information about the sensors that have the specified name.If this parameter is
specified with the -node parameter, the command displays information only about the
specified sensor.
[-fru <text>] - FRU
Selects information about the sensors associated with the specified Field Replaceable
Unit (FRU).
[-type {fan|thermal|voltage|current|battery-life|discrete|fru|nvmem|counter|minutes|
percent|agent|unknown}] - Sensor Type
Selects information about the sensors that have the specified sensor type. Possible
values vary among platforms but may include fan, temperature, thermal and voltage.
[-units <text>] - Value Units
Selects information about the sensors that have readings displayed in the specified units
of measure. Possible values vary among platforms but may include RPM, C and mV.
[-state {normal|warn-low|warn-high|crit-low|crit-high|disabled|uninitialized|init-failed|notavailable|invalid|retry|bad|not-present|failed|ignored|fault|unknown}] - Sensor State
Selects information about the sensors that have the specified state. Possible values
vary among platforms but may include normal, warn_lo, warn_hi, crit_lo, crit_hi and
failed.
[-discrete-state {normal|warn-low|warn-high|crit-low|crit-high|disabled|uninitialized|initfailed|not-available|invalid|retry|bad|not-present|failed|ignored|fault|unknown}] - Discrete
Sensor State
Selects information about the discrete-valued sensors that are in the specified state.
A discrete-valued sensor has a set of possible discrete values rather than a range
of possible values. For example, a presence sensor which has the discrete values
PRESENT and NOT_PRESENT is a discrete-valued sensor. Possible values vary
among platforms but may include normal and failed.
[-value <integer>] - Last Sensor Value
Selects information about the sensors that have the specified sensor value.
[-discrete-value <text>] - Discrete Sensor Value
1513
Selects information about the discrete-valued sensors that have the specified
discrete value. Possible values vary among sensors but may include PRESENT,
NOT_PRESENT, ON, OFF, OK and FAULT.
[-crit-low <integer>] - Critical Low Threshold
Selects information about the sensors that have the specified critically low threshold.
[-warn-low <integer>] - Warning Low Threshold
Selects information about the sensors that have the specified warning-low threshold.
[-warn-hi <integer>] - Warning Hi Threshold
Selects information about the sensors that have the specified warning-high threshold.
[-crit-hi <integer>] - Critical Hi Threshold
Selects information about the sensors that have the specified critically high threshold.
[-inactive {true|false}] - Show Inactive Sensors
Selects information about the sensors that are currently inactive.
Examples
The following example displays information about all sensors on a cluster named
cluster1:
cluster1::> system node environment sensors show
Node Sensor
State Value/Units Crit-Low Warn-Low Warn-Hi Crit-Hi
---- --------------------- ------ ----------- -------- -------- ------- ------mynode

Partner IO Pre
NOT_PRESENT
Partner Ctrl Pre
PRESENT
PSU2 Over Curr
OK
PSU2 Over Volt
OK
PSU2 Over Temp
OK
PSU2 Fault
OK
PSU2 DC OK
OK
1514
PSU2 Input OK
OK
PSU2 ON
ON
PSU2 Fan2 Fault
OK
Node Sensor
---- --------------------- ------ ----------- -------- -------- ------- ------mynode

PSU2 Fan2 Speed
normal
15400 RPM
3000
3500
25500
3000
3500
25500
51
61
PSU2 Fan1 Fault

OK
PSU2 Fan1 Speed
normal
15700 RPM
normal
28000 mA
PSU2 Curr
PSU2 Temp
normal
29 C
PSU2 Present
PRESENT
PSU1 Over Curr
OK
PSU1 Over Volt
OK
PSU1 Over Temp
OK
Node Sensor
---- --------------------- ------ ----------- -------- -------- ------- ------mynode

PSU1 Fault
OK
PSU1 DC OK
OK
PSU1 Input OK
OK
PSU1 ON
ON
PSU1 Fan2 Fault
1515
OK
PSU1 Fan2 Speed
normal
15600 RPM
3000
3500
25500
3000
3500
25500
51
61
PSU1 Fan1 Fault

OK
PSU1 Fan1 Speed
normal
16200 RPM
normal
27000 mA
PSU1 Curr
PSU1 Temp
normal
Node Sensor
28 C
---- --------------------- ------ ----------- -------- -------- ------- ------mynode

PSU1 Present
PRESENT
Battery 3.3V
normal
3400 mV
3025
3100
3500
3575
normal
3328 mV
3024
3104
3504
3568
normal
12152 mV
10478
10602
13392
13516
normal
4979 mV
4602
4696
5310
5404
normal
3375 mV
3025
3100
3500
3575
normal
12152 mV
10478
10726
13268
13516
normal
5003 mV
4602
4696
5310
5404
normal
3375 mV
3025
3100
3500
3575
AUX 3.3V
STBY 12V
STBY 5V
STBY 3.3V
12V
5V
3.3V
[...]
1516
system node firmware download

Download motherboard firmware and system diagnostics
privilege level.
Description
The system node firmware download command downloads new system firmware
to the boot device. A reboot followed by the 'update_flash' command at the firmware
prompt is required for the firmware to take effect.
Parameters
This specifies the node or nodes on which the firmware is to be updated.
-package <text> - Package URL
This parameter specifies the URL that provides the location of the package to be
fetched. Standard URL schemes, including HTTP, FTP, TFTP and FILE, are accepted.
Examples
The following example downloads firmware to node-01 from a web server:
cluster1::*> system node firmware download -node node-01 -package
http://example.com/serviceimage.zip
system node hardware tape drive show

Displays information about tape drives
level.
Description
This command displays the following information about tape drives:
1517
Device ID of the tape drive

Description of the tape drive
NDMP path of the tape drive
Parameters
specify.
| [-instance ] }
about all fields.
Selects information about the tape drive that has the specified device ID.
Selects information about the tape drive or drives that have the specified description.
[-wwn <text>] - World Wide Name
Selects information about the tape drive that has the specified worldwide name.
Selects information about the tape drive that has the specified serial number.
[-ndmp-path <text>, ...] - NDMP Path
Selects information about the tape drive or drives that have the specified NDMP path.
Examples
The following example displays information about all tape drives in the cluster:
cluster1::> system node hardware tape drive show
Node
Device Id Drive Description
NDMP Path
------ --------- -------------------- --------------------------------cluster1

brocade-247-198:3.126L1
1518
nrst0l nrst0m nrst0h nrst0a
IBM LTO 4 ULTRIUM
rst0l rst0m rst0h rst0a

urst0l urst0m urst0h urst0a
brocade-247-198:3.126L2
IBM LTO 4 ULTRIUM

brocade-247-198:3.126L3
IBM LTO 4 ULTRIUM

brocade-247-198:3.126L4
IBM LTO 4 ULTRIUM

brocade-247-198:3.126L6
SONY
SDX-400C

1519
system node hardware tape library show

Display information about tape libraries
level.
Description
This command displays the following information about tape libraries:
Node to which the tape library is attached
Device ID of the tape library
Description of the tape library
NDMP path of the tape library
Parameters
specify.
| [-instance ] }
about all fields.
Displays detailed information about tape libraries on the specified node.
Selects information about the tape library that has the specified device ID.
Selects information about the tape library or libraries that have the specified description.
Selects information about the tape library that has the specified worldwide name.
1520
Selects information about the tape library that has the specified serial number.
[-ndmp-path <text>] - NDMP Path
Selects information about the tape library or libraries that have the specified NDMP
path.
Examples
The following example displays information about all tape libraries attached to the
cluster:
cluster1::> system node hardware tape library show
Node
Device Id Drive Description
NDMP Path
------ --------- -------------------- ----------------cluster1-00

0b.125L1
HP
MSL G3
mc1
MSL G3
mc0
Series
0c.125L1
HP
Series
1521
system node hardware unified-connect modify

Modify the Fibre Channel and converged networking adapter configuration
level.
Description
Changes the adapter configuration. Any changes to the adapter mode or type will
require a reboot for the changes to take effect. The adapter must also be offline before
you can make any changes.
The adapter argument is in the form Xy where X is an integer and y is a letter. An
example is 4a.
For a target adapter, use the network fcp adapter modify command to bring the
adapter offline.
For an initiator adapter, use the run local storage disable adapter command
to bring the adapter offline
The mode option refers to the mode of the adapter and can be either fc or cna
The type option refers to the FC-4 type of the adapter and can be initiator or target.
The force option suppresses confirmation prompts.
Parameters
Specifies the node of the adapter.
-adapter <text> - Adapter
Specifies the adapter.
[-mode | -m {fc|cna}] - Configured Mode
Specifies the mode.
[-type | -t {initiator|target}] - Configured Type
Specifies the FC-4 type.
Suppresses warnings and confirmation prompts.
1522
Examples
cluster1::> system node hardware unified-connect modify -node node1 -adapter 0d
-mode cna
Configures the mode of adapter 0d on node1 to CNA.
HA Considerations
During a maintenance head swap procedure in a CFO, if the adapter mode and type
do not match what was originally set, Data ONTAP will attempt to automatically restore
the mode and type settings before allowing the giveback to occur. In the event that the
adapters are not automatically reconfigured and to avoid any service disruptions, you
can boot the new head into Maintenance Mode prior to doing the first giveback and use
the ucadmin command to restore the adapter configuration.
See Also
network fcp adapter modify run local storage disable adapter
1523
system node hardware unified-connect show

Displays information about Fibre Channel and converged networking adapters
level.
Description
This command manages Fibre Channel and converged networking adapters used by
the storage subsystem. Use the command to show the current mode and FC-4 type of
adapters or the capabilities of adapters.
Parameters
specify.
| [-capability ]
If this parameter is specified, the command displays the capabilities of the adapters.
| [-instance ] }
about all fields.
If this parameter is specified, the command displays information about Fibre Channel
and converged networking adapters on the specified node.
adapter.
[-current-mode {fc|cna}] - Current Mode
If this parameter is specified, the command displays adapters configured to the specified
mode.
[-current-type {initiator|target}] - Current Type
1524
FC-4 type.
[-pending-mode {fc|cna}] - Pending Mode
mode on the next reboot.
[-pending-type {initiator|target}] - Pending Type
FC-4 on the next reboot.
[-status-admin <text>] - Administrative Status
If this parameter is specified, the command displays adapters with the specified status.
[-supported-modes {fc|cna}, ...] - Supported Modes
The list of modes that the adapter supports.
[-supported-fc-types {initiator|target}, ...] - Supported FC Types
The list of FC-4 types the adapter supports when configured into fc mode.
[-supported-cna-types {initiator|target}, ...] - Supported CNA Types
The list of FC-4 types the adapter supports when configured into cna mode.
Examples
The following example displays information about all Fibre Channel and converged
networking adapters in the cluster:
cluster1::> system node hardware unified-connect show
Current
Current
Pending
Pending
Admin
Node
Adapter
Mode
Type
Mode
Type
Status
------------
-------
-------
---------
-------
---------
-----------
node1
0c
fc
initiator
online
node1
0d
fc
initiator
online
node1
3a
fc
target
online
node1
3b
fc
target
online
node1
4a
cna
target
online
node1
4b
cna
target
online
node1
6a
fc
target
online
node1
6b
fc
target
online
node2
0c
fc
initiator
online
node2
0d
fc
initiator
online
1525
node2
3a
fc
target
online
node2
3b
fc
target
online
node2
4a
cna
target
online
node2
4b
cna
target
online
node2
6a
cna
target
online
node2
6b
cna
target
online
1526
system node image get

Fetch a file from a URL
level.
Description
This command fetches a file from the specified URL and stores it in the /etc/software
directory.
Parameters
This parameter specifies the node that will fetch and store the package.
This parameter specifies the URL that provides the location of the package to be
fetched. Standard URL schemes, including HTTP, FTP, TFTP and FILE, are accepted.
[-replace-package [true]] - Replace the Local File
Specifies whether an existing package is deleted and replaced with a new package. If
you enter this command without using this parameter, its effective value is false and an
existing package is not replaced with the new one. If you enter this parameter without a
value, it is set to true and an existing package is replaced with the new one.
[-rename-package <text>] - Rename the File
Use this parameter to enter a package name that is different than the file name in the
URL.
[-background [true]] - Run in the background
This parameter will allow the operation to run in the background. The progress of the
operation can be checked with the command system image show-update-progress. If
this command is entered without using this parameter, its effective value is false and the
operation will run in the foreground. If this parameter is used without a value, it is set to
true.
Examples
system image get http://example.com/image.tgz -rename-package image2.tgz replace-package
1527
system node image modify

Modify software image configuration
level.
Description
The system node image modify command sets the default software image on a
specified node. The default software image is the image that is run when the node is
started. A node holds two software images; when you set one as the default image, the
other image is automatically unset as the default. Conversely, if you unset a software
image as the default, the other image is automatically set as the default.
Parameters
This specifies the node on which the software image is located.
-image {image1|image2|remote} - Image Name
This specifies the software image that is to be set or unset as the default.
[-isdefault {true|false}] - Is Default Image
This optionally specifies whether the specified image is the default.
Examples
The following example sets the software image named image2 as the default image on
a node named node0.
node::> system node image modify -node node0 -image image2 -isdefault true
Default Image Changed.
system node image show-update-progress

Show progress information for a currently running update
1528

level.
Description
The system node image show-update-progress command displays the
progress of a software-image update initiated by using the system node image
update command. The command displays progress until the update completes; you
can also interrupt it by pressing Ctrl-C.
Parameters
This optionally specifies the name of a node whose image-update progress is to be
displayed.
[-follow [true]] - Follow the Progress in the Foreground
Do use not use background processing for this command. If you do not use this
parameter, the value is true.
Examples
The following example displays image-update progress:
node::> system node image show-update-progress
ERROR: command failed: There is no update/install in progress
See Also
system node image update
1529
system node image show

Display software image information
level.
Description
The system node image show command displays information about software
images. By default, the command displays the following information:
Node name
Image name
Whether the image is the default image
Whether the image is the current image
Software version
Installation date
To display detailed information about a specific software image, run the command with
the -node and -image parameters. The detailed view adds information about the kernel
image path, and the root file system image path.
You can specify additional parameters to select specific information. For example,
to display information only about software images that are currently running, run the
command with the -iscurrent true parameter.
Parameters
specify.
| [-instance ] }
about all fields.
1530
Selects information about the software images on the specified node. If this parameter
and the -image parameter are both used, the command displays detailed information
about the specified software image.
[-image {image1|image2|remote}] - Image Name
Selects information about the software images that match the specified name. If this
parameter and the -node parameter are specified, the command displays detailed
information about the specified software image.
[-isdefault {true|false}] - Is Default Image
Selects information about the software images with the specified default setting.
[-iscurrent {true|false}] - Is Current Image
Selects information about the software images that have the specified currency value.
[-kernel-path <text>] - Kernel Image Path
Selects information about the software images that have the specified kernel image
path.
[-rootfs-path <text>] - Root Filesystem Image Path
Selects information about the software images that have the specified root file system
image path.
Selects information about the software images that have the specified root file system
image path.
[-installdate <MM/DD/YYYY HH:MM:SS>] - Install Date
Selects information about the software image that have the specified installation date.
Specify the date in the format MM/DD/YYYY HH:MM:SS [+- HH:MM].
Examples
The following example displays information about the software images on a node
named node1:
cluster1::> system node image show -node node1
Node
Image
Is
Is
Install
Default
Current Version
Date
------ ------ -------- ------- --------- -----------------node1

image1 true
true
8.0
8/20/2009 17:42:42
image2 false
false
8.0
6/26/2009 17:44:50
1531
1532
system node image update

Perform software image upgrade/downgrade
level.
Description
The system node image update command downloads the software image from
a specified location and updates the alternate software image (that is, the image that
is not currently running on the node). By default, validation of the software image is
not performed. Use the "-validate-only" parameter to validate the software image first,
before performing the update on the cluster nodes.
At the advanced privilege level, you can specify whether to disable version-compatibility
checking.
Parameters
This specifies the node on which the software image is located.
This specifies the location from which the software image is to be downloaded. The
location can be specified in any of the following ways:
As an HTTP URL in the form http://host_name[:port]/path_to_file. For instance,
http://example.com/downloads/image.tgz. The management utility prompts you for
a user name and password before beginning the download.
Note:
If you use HTTP to transfer software images, be aware that the management
utility does not check whether the Web server is password protected; if it is not,
press Enter at the prompt for user name and password.
As an FTP URL in the form ftp://host_name[:port]/path_to_file. For instance, ftp://
example.com/downloads/image.tgz. If required, the management utility prompts
you for a user name and password before beginning the download.
1533
As a TFTP URL in the form tftp://host_name[:port]/path_to_file. For example,

tftp://example.com/downloads/image.tgz. TFTP does not require a user name or
password.
As a filename of a package left behind by a previous installation, or a package
fetched using system node image get. For example, image.tgz. Available
packages can be displayed using system node image package show.
As a path to a package in a mounted file system in the form file://localhost/
path_to_file. For example, file://localhost/mroot/etc/software/image.tgz.
[-replace {image1|image2}] - Image to Replace
This optionally specifies the image that is to be replaced when the node is booted from
the network.
[-setdefault [true]] - Set Newly Updated Image as Default
This optionally specifies whether to set the newly updated image as the default image
(that is, the image that runs the next time the node is restarted). Note that for this
parameter to work correctly, the cluster must be in quorum when the image is updated.
[-replace-package [true]] - Replace the Local File
Specifies whether an existing package is deleted and replaced with a new package. If
this command is entered without using this parameter, its effective value is false and an
existing package is not replaced with the new one. If this parameter is used without a
value, it is set to true and an existing package is replaced with the new one.
[-rename-package <text>] - Rename the File
Use this parameter to enter a package name that is different than the file name in the
URL.
[-background [true]] - Run in the Background
This parameter will allow the operation to run in the background. The progress of the
operation can be checked with the command system node image show-updateprogress. If this command is entered without using this parameter, its effective value
is false and the operation will run in the foreground. If this parameter is used without a
value, it is set to true.
[-validate-only [true]] - Validate the Package before Installation
Use this parameter to validate the package. Validation consists of verifying whether
there is enough space on the system to install the package, verifying the checksum for
each component within the package and so on. Validation usually takes from 30 to 60
minutes. If you specify this parameter, the package will be validated only, not installed.
1534
Examples
The following example updates the software image on a node named node0 from a
software package located at ftp://ftp.example.com/downloads/image.tgz:
node::> system node image update -node node0 -package ftp://ftp.example.com/
downloads/image.tgz -setdefault true
See Also
system node image get system node image package show system node image showupdate-progress
1535
system node image package delete

Delete a software package
level.
Description
The delete command will delete the specified software package.
Parameters
The package will be deleted from the repository belonging to the node specified with this
parameter. The local node is used as the default if this parameter is omitted.
-package <text> - Package File Name
This parameter specifies the package to be deleted.
Examples
::> system image package delete image.tgz
1 entry was deleted.
system node image package show

Display software package information
level.
Description
The package show command displays details of the software packages residing on the
storage controller.
Parameters
1536

specify.
| [-instance ] }
about all fields.
Selects which node's packages are displayed. The local node is the default if this
parameter is omitted.
[-package <text>] - Package File Name
This parameter specifies which package's information will be displayed.
Examples
cluster1::> system image package show
Package
Node Repository Package File Name
---- ---------- ----------------node-01
mroot
image.tgz
1537
system node internal-switch show

Display onboard switch attributes
level.
Description
The system node internal-switch show command is used to display the internal
switch state information and the link status.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to specify the node the switch resides on.
[-switch-id <integer>] - Switch
Use this parameter to specify the switch id. For example, 1.
[-port-id <integer>] - Port
Use this parameter to specify the port id. For example, 0.
Use this parameter to specify the port name. For example, e0M.
[-auto-admin <Auto-negotiation setting>] - Auto-Negotiation Administrative
Use this parameter to show the auto-negotiation administrative setting. 'enable' or
'disable'.
[-auto-op <Auto-negotiation setting>] - Auto-Negotiation Operational
1538
Use this parameter to show the auto-negotiation operational setting. 'unknown',

'complete', 'incomplete', 'failded' or 'disabled'.
[-duplex-admin <Duplex>] - Duplex Mode Administrative
Use this parameter to show the duplex mode administrative setting. 'half' or 'full'.
[-duplex-op <Duplex>] - Duplex Mode Operational
Use this parameter to show the duplex mode operational setting. 'half' or 'full'.
[-speed-admin <Link speed>] - Speed Administrative
Use this parameter to show the speed administrative setting. '10', '100' or '1000'.
[-speed-op <Link speed>] - Speed Operational
Use this parameter to show the speed operational setting. '10', '100' or '1000'.
[-link <Link Status>] - Link State
Use this parameter to show the link state, 'up' or 'down'.
[-up-admin <Link Status>] - Up Administrative
Use this parameter to show the up administrative setting, 'up' or 'down'.
[-fc-op <Flow control>] - Flow Control Operational
Use this parameter to show the flow control operational setting, 'full', 'send', 'receive' or
'none'.
Examples
The example shows the attributes of the internal switch 0 on the node Node1.
cluster1::> system node internal-switch show -node Node1 -switch-id 0
Auto-Negot
Port Role
Link
Admin/Oper
---
-----
------------------
----------------
Node: Node1
Duplex
Speed(Mbps)
Admin/Oper
Admin/Oper
-----------
-----------
, Switch: 0
sw-wrench
up
enable/complete
full/full
1000/1000
sw-locked-wrench
down
enable/incomplete
full/half
100/10
sw-e0M
up
enable/complete
full/full
1000/1000
sw-e0P
down
enable/incomplete
full/half
100/10
sw-midplane-1
down
enable/incomplete
full/half
100/10
sw-expander-1
up
enable/unknown
full/full
100/100
sw-sp-1
up
enable/unknown
full/full
100/100
1539
1540
system node internal-switch dump eeprom

Display onboard switch eeprom config
level.
Description
The system node internal-switch dump eeprom command is used to show the
internal switch eeprom firmware content.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to specify the node the internal switch resides on.
[-version <text>] - Version
Use this parameter to specify the version of firmware needs to be dumped.
[-eeprom <text>] - Firmware
Use this parameter to specify the firmware content needs to be dumped.
Examples
The following example shows the internal switch eeprom firmware content of the internal
switch 0 on Node1.
cluster1::> system node internal-switch dump eeprom -node Node1 -switch-id 0
EEPROM Configuration
1541
-------------------Node: Node1
, Switch: 0 , Version: Version2 SB_XX Switch0
7fa300007fa900007fa800007fa700007fa610007fa5d0007fa200007fa30000
7fa610107fa802337fa713137fa5b0007fa200007fa300007fa610207fa80233
7fa731317fa5b0007fa200007fa300007fa610407fa802117fa733337fa5b000
8027102080282c808047101080482c808087102080882c808107101081082c80
8207104082082c808407104084082c8088082c808809000a880a80fa8024007c
7fe990007fea00047fe9bf017fea00047fe9b0007fea00197fe9b0017fea0020
7fe9b0027fea4c887fe9b0037fea01197fe9b0047feafff07fe9b0057fea00ff
7fe9b0067fea10007fe9b0078024007fffff56657273696f6e20320000005342
5f585800000053776974636820300000ffffffff0040e0e8100065b4100065b4
100065b42b2adfe00040586000000000000000012b2adfe0100087700040e0e8
000003b6000400087fc5e9a0000000001000877000000000000003b600040008
10008770100014682b2adfe00000000010001050000000017fc5e9a010001468
2ab094700040e0e8100065b4100065b42b2adfe0004059bc000000c0100018e8
7fc5e9d80040c01800000000000000c000000026000000001000877000000000
000003b6000e001c10008770000000010000001e0000001e2ab094700040e0e8
7fc5ea180040491000000000000000060041bc2c7fc5
1542
system node internal-switch dump port-mapping

Display onboard switch port mapping
level.
Description
The system node internal-switch dump port-mapping command is used to
show the internal switch port connections.
Parameters
specify.
| [-instance ] }
about all fields.
[-role <text>] - Port Name
Examples
The following example shows the port connections of the internal switch 0 on Node1.
cluster1::> system node internal-switch dump port-mapping -node Node1 -switch-id
0
Port
Port Name
1543
----
-----------------
Node: Node1
, Switch: 0
sw-wrench
sw-locked-wrench
sw-e0M
sw-e0P
sw-midplane-1
sw-expander-1
sw-sp-1
1544
system node internal-switch dump stat

Display onboard switch port statistics counter
level.
Description
The system node internal-switch dump stat command is used to display the
counter information of the internal switch ports.
Parameters
specify.
| [-instance ] }
about all fields.
[-stat-id <text>] - Counter Name
Use this parameter to specify the counter name.
[-valued <integer>] - Counter Value
Use this parameter to show the value of specified counter.
1545
Examples
The following example shows partial counter information of the internal switch 0 on
Node1
cluster1::> system node internal-switch dump stat -node Node1 -switch-id 0
Port
Port Name
Counter
Value
----
----------------
-------------------
---------
Node: Node1
1546
, Switch: 0
sw-wrench
1024ToMaxOctets
22480201
sw-wrench
128To255Octets
119552
sw-wrench
256To511Octets
345587
sw-wrench
512To1023Octets
1250437
sw-wrench
64Octets
803025
system node platform ifswitch stat

Show Marvell 88E6061 Ethernet switch statistics
privilege level.
Description
The command system node platform ifswitch stat displays the statistics for
the Marvell 88E6061 Ethernet switch.
Parameters
specify.
| [-instance ] }
about all fields.
When provided, the -node parameter specifies the nodes for which the Marvell
88E6061 Ethernet switch statistics are to be displayed. When the -node parameter is
not provided, the command is applied to all the nodes in the cluster.
[-port {sw-RJ45|sw-RLM|sw-PartnerSwitch|sw-e0M}] - Port
This parameter specifies the port for which the statistics are to be displayed.
[-rx-good <integer>] - Rx Good Frames
This parameter specifies the number of good frames received.
[-rx-bad <integer>] - Rx Bad Frames
This parameter specifies the number of bad frames received.
[-rx-discards <integer>] - Rx Discards
This parameter specifies the number of discarded frames.
[-rx-filtered <integer>] - Rx Filtered
1547
This parameter specifies the number of frames that have been filtered.
[-tx-frames <integer>] - Tx Frames
This parameter specifies the number of frames transmitted.
[-tx-collisions <integer>] - Tx Collisions
This parameter specifies the number of collisions that occurred while transmitting.
[-status {down|up}] - Link Status
This parameter specifies the status of the switch link.
[-media <text>] - Media
This parameter specifies the status of the transmission media.
Examples
cluster1::*> system node platform ifswitch stat #node cluster1
Rx Good Frames
Rx Bad Frames
Tx Frames
Tx Collisions
Rx Discards
Node
Rx Filtered
Port
Link Media
-------- --------- ----- ----- ----- ----- ----- ----- ---- ------------cluster1
sw-RJ45
49661
9046
up auto-100tx-fd
sw-RLM
36197 56475
up auto-100tx-fd
1356
up auto-100tx-fd
45837 52131
up auto-100tx-fd
sw-PartnerSwitch
2694
sw-e0M
1548
system node platform ifswitch mode modify

Modify the statistics collection mode
privilege level.
Description
The command system node platform ifswitch mode show allows the user to
set the status of the statistics collection mode of the Marvell 88E6061 Ethernet switch.
Parameters
When provided, the -node parameter specifies the nodes for which the statistics
collection mode status is to be set. When the -node parameter is not provided, the
command is applied to all the nodes in the cluster.
[-mode {normal|error}] - Mode
This parameter specifies the status to be set for the statistics collection mode of Marvell
88E6061 Ethernet switch.
Examples
cluster1::*> system node platform ifswitch mode modify -node cluster1 -mode
normal
cluster1::*>
See Also
system node platform ifswitch mode show
1549
system node platform ifswitch mode show

Show the statistics collection mode
privilege level.
Description
The command system node platform ifswitch mode show describes the
status of the statistics collection mode of the Marvell 88E6061 Ethernet switch.
Parameters
specify.
| [-instance ] }
about all fields.
Selects nodes with the specified node name. When the -node parameter is not
provided, the command is applied to all the nodes in the cluster.
[-mode {normal|error}] - Mode
Selects nodes with the specified status.
Examples
cluster1::*> system node platform ifswitch mode show -node cluster1
Node
Mode
-------------- -----cluster1
1550
normal
system node power on

Power nodes on
privilege level.
Description
This command switches on the power of the main controller of the specified node. This
command works for a single node only and the full name of the node must be entered
exactly.
Parameters
This parameter specifies the node whose power you want to switch on.
Examples
The following example switches on the power of node2.
cluster1::*>
cluster1::*> system node power on -node node2
cluster1::*>
1551
system node power show

Display the current power status of the nodes
level.
Description
This command displays the power status of the main controller in each node across the
cluster.
Parameters
specify.
| [-instance ] }
about all fields.
This optional parameter specifies the name of a node for which information is to be
displayed. If this parameter is not specified, the command displays information about all
nodes in the cluster.
[-status {on|off}] - Current Power Status
If the -status parameter is specified, the command only lists information about the node
with the power status value you enter.
Examples
The following example displays power status of all the nodes in cluster1.
cluster1::> system node power show
Node
Status
---------------- -----------
1552
node1
on
node2
on

cluster1::>
system node root-mount create

Create a mount from one node to another node's root volume.
level.
Description
The system node root-mount create command produces a root-mount from
one node in the cluster to another node's root volume. The root-mount is marked for
immediate creation by a background task. Use the system node root-mount show
command to view the current status of root-mount or verify task completion.
Parameters
-node <nodename> - Owner of the Root-mount
The node name where the root-mount will be created.
-root-node <nodename> - Root-mount Destination Node
The node name that the root-mount will access.
Examples
The following example shows the creation of a root-mount from cluster1::nodeA to
cluster1::nodeB and the verification of the successful completion.
cluster1::> system node root-mount show
This table is currently empty.
cluster1::> system node root-mount create -node nodeA -root-node nodeB
Node
Root Node
State
Last Error
----------------- ----------------- ----------- ------------------------------nodeA
nodeB
ready
1553
See Also
system node root-mount show system node root-mount delete
1554
system node root-mount delete

Delete a mount from one node to another node's root volume.
level.
Description
The system node root-mount delete command removes a root-mount from
one node in the cluster to another node's root volume. The root-mount is marked for
immediate deletion by a background task. Use the system node root-mount show
command to view the current status of root-mount or verify task completion.
Parameters
-node <nodename> - Owner of the Root-mount
The node which has the mount.
-root-node <nodename> - Root-mount Destination Node
The node accessed by the mount.
Examples
This example shows the deletion of a root-mount from cluster1::nodeA to
cluster1::nodeB and the verification of the command's successful completion.
Node
Root Node
State
Last Error
----------------- ----------------- ----------- ------------------------------nodeA
NodeB
ready
cluster1::> system node root-mount delete -node nodeA -root-node nodeB

See Also
system node root-mount show system node root-mount create
1555
system node root-mount show

Show the existing mounts from any node to another node's root volume.
level.
Description
The system node root-mount show command displays the status of current rootmounts from any node to another node's root volume. These root-mounts are used by
cluster services to access data on other nodes in the cluster. These root-mounts are not
pre-created, but are created as they are needed. They can also be manually created or
deleted.
Parameters
specify.
| [-instance ] }
about all fields.
[-node <nodename>] - Owner of the Root-mount
Selects information about root-mounts that exist on the specified node.
[-root-node <nodename>] - Root-mount Destination Node
Selects information about root-mounts that connect to the specified node.
[-create-time <MM/DD/YYYY HH:MM:SS>] - Mount Creation Time
Selects information about root-mounts that were created at the specified time.
[-state <Mount State>] - State of the Root-Mount
Selects information about root-mounts that have the specified state. The states are:
unknown: The state of the root-mount is being determined.
initializing: A root-mount was found and needs testing to determine the correct
state.
1556
mount-requested: The root-mount has been requested, but is not ready.

mounting: The root-mount is being created, but is not ready.
ready: The root-mount is ready to be used.
not-responding: The root-mount exists but is not responding.
does-not-exist: No root-mount is possible to this node's root volume.
ha-busy: The root-mount is busy pending completion of an HA event.
clean-up-requested: The root-mount is being deleted.
cleaning-up: The root-mount is being deleted.
create-error: The root-mount could not be created.
[-last-error <text>] - Last Error
Selects information about root-mounts that have the specified last-error value.
Examples
The following example shows the default state of the root-mounts on a cluster that is not
using root-node services:
The following example displays the root-mounts that exist for a cluster that has nodeA
mounted to nodeB, and nodeB mounted to nodeA:
Node
Root Node
State
Last Error
----------------- ----------------- ----------- ------------------------------nodeA
nodeB
ready
nodeB
nodeA
ready
HA Considerations
When a node in the cluster is taken over by its partner node, all root-mounts to that
node will be automatically deleted. Any active root-mounts will be recreated to access
the root volume now located on the partner node.
1557
See Also
system node root-mount create system node root-mount delete
1558
system node upgrade-revert show

Display upgrade/revert node status.
privilege level.
Description
The system node upgrade-revert show command displays information about the
status of upgrades or reversions. If an upgrade has failed, this command enables you to
determine which phase of the upgrade contains the failed upgrade task and the reason
for the failure.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display status information only about upgrades or reversions that
are slated to occur on the nodes you specify.
[-upgrade-version <integer>] - Cluster Upgrade Version
Selects status information about upgrades or reversions that are to the version number
you specify.
[-startup-phase {pre-root|pre-apps|post-apps}] - Startup Phase
Selects status information about upgrades or reversions that are slated to occur during
the startup phase you specify. Startup phases are:
pre-root - Upgrade is applied before mroot is mounted
pre-apps - Upgrade is applied before other cluster apps are started
post-apps - Upgrade is applied after all RDB apps are online
1559
[-status <Upgrade/Revert Execution Status>] - Execution Status

Selects status information about upgrades or reversions that have the execution status
you specify. Execution statuses are:
prepared - Ready to upgrade
applied - Successful upgrade
reverted - Successful reversion
failed - Unsuccessful upgrade or reversion
aborted - Unsuccessful upgrade or reversion
skipped - Upgrade or reversion was skipped for that phase
locked - Upgrading or reverting
[-status-msg <text>] - Status Message
Selects status information about upgrades or reversions that have the status message
you specify. The status message displays the current status of the phase with which it
appears.
[-direction {upgrade|revert}] - Upgrade/Revert Direction
Use this parameter with the value upgrade to select status information about upgrades.
Use this parameter with the value revert to select status information about reversions.
[-node-status {reverting|complete|not-needed|aborted|failed|waiting|in-progress|
stopped}] - Node Status
Selects status information about upgrades or reversions that have the status you specify
on nodes where they are slated to occur. Node statuses are:
aborted - Upgrade process aborted. Contact support personnel.
failed - Upgrade process failed. Contact support personnel.
stopped - Upgrade process stopped due to node or management application
restart. Use the system node upgrade-revert upgrade command to
complete the upgrade manually.
complete - Upgrade process completed successfully.
waiting - Upgrade process is waiting the replication database to come online or
for applications to be stable. If the RDB is not online, check network connectivity
using cluster show and cluster ping-cluster to ensure that all nodes
are healthy and in communication.
1560
[-node-status-msg <text>] - Node Status Message

Selects status information about upgrades or reversions that have the node status
message you specify. The node status message displays the upgrade or reversion
status of the node with which it appears. If the upgrade or reversion fails, this message
provides information that helps to diagnose the cause of the failure.
Examples
The following example shows typical output for a cluster with two nodes. Status
messages for each phase display information about the tasks in that phase.
cluster1::*> system node upgrade-revert show
Node: node1
Status: complete
Status Message: The upgrade is complete.
Vers Phase
Status
Upgrade Phase Status Message
---- ---------- -------- -----------------------------------------------------200
pre-root
applied
No upgrade is required for this phase.
200
pre-apps
applied
Upgrade successful.
200
post-apps
applied
Upgrade successful.
Node: node2
Status: complete
Status Message: The upgrade is complete.
Vers Phase
Status
Upgrade Phase Status Message
---- ---------- -------- -----------------------------------------------------200
pre-root
applied
No upgrade is required for this phase.
200
pre-apps
applied
Upgrade successful.
200
post-apps
applied
Upgrade successful.
See Also
system node upgrade-revert upgrade cluster show cluster ping-cluster
1561
system node upgrade-revert upgrade

Run the upgrade at a specific phase.
privilege level.
Description
The system node upgrade-revert upgrade command manually executes an
upgrade. Use this command to execute an upgrade after issues that caused an upgrade
failure are resolved. If the upgrade is successful, no messages display.
Before the command executes upgrades, it checks the configuration of the nodes in
the cluster. If no upgrades are needed, the command displays a message and does not
execute any upgrades.
Parameters
Specifies the node that is to be upgraded. The value local specifies the current node.
Examples
This example shows command output of a node named node0 if node configuration is
current.
cluster1::*> system node upgrade-revert upgrade -node node0
The node configuration is up-to-date. No upgrade is needed.
system node virtual-machine hypervisor modifycredentials

Modify hypervisor IP address and its credentials
level.
Description
1562
The system node virtual-machine hypervisor modify-credentials

command is used to set the IP address of the hypervisor on which the node is running
or vSphere credentials (i.e. -new-username or -new-password).
Parameters
Name of the Data ONTAP node running in a virtual machine. It is a required field and
the node must exist in the cluster.
[-new-server <text>] - New Hypervisor IP Address
New vSphere server controlling this virtual machine. It can be either an IP address or (if
name resolution is enabled) a hostname.
[-new-username <text>] - New Hypervisor Username
New vSphere username for the -new-server specified above.
[-new-password <text>] - New Hypervisor Password
New vSphere password for the -new-server specified above.
Examples
The following example sets the IP address and the credentials of the vSphere server on
which the node is running.
cluster1::> system node virtual-machine hypervisor modify-credentials
-node node1 -new-server 192.168.0.1 -new-username admin -new-password pass123
See Also
system node virtual-machine hypervisor show-credentials
1563
system node virtual-machine hypervisor showcredentials

Display hypervisor IP address and its credentials
level.
Description
The system node virtual-machine hypervisor show-credentials
command displays the current vSphere authentication information (except the
password). This consists of the vSphere server and username. The vSphere password
is not displayed for security reasons. vSphere authentication information is required
to use (system node virtual-machine hypervisor show -node <node>,
system node virtual-machine instance show-system-disks -node
<node> and storage disk show -virtual-machine-disk-info -node
<node>) to be able to gather information about the physical host machine. It also
attempts to verify the current vSphere authentication information with the vSphere
host. If the check succeeds and the credentials are correct, the command displays the
following information. If you want to see details about a single node, use the -node
parameter.
Node
Hypervisor name or IP Address
vSphere Username
Credentials Correct?: true
If the check fails or credentials are incorrect, the command displays an additional Error.
Node
Hypervisor name or IP Address
vSphere Username
Credentials Correct?: false
Error:
Parameters
1564

specify.
| [-instance ] }
about all fields.
This optional parameter represents the name of the Data ONTAP node running in
a virtual machine for which information is to be displayed. If this parameter is not
specified, the command displays information about all nodes in the cluster.
[-server <text>] - Hypervisor IP Address or Hostname
Use this parameter to only display the Data ONTAP nodes in the cluster whose vSphere
server matches this value.
[-username <text>] - Hypervisor Username
Use this parameter to only display the Data ONTAP nodes in the cluster whose vSphere
username matches this value.
[-are-credentials-correct {true|false}] - Credentials Correct?
Get a list of Data ONTAP nodes running with either incorrect (false) or correct (true)
vSphere credentials.
[-error <text>] - Error
Get a list of nodes with the specified error. This parameter is most useful when entered
with wildcards.
Examples
The following example shows the vSphere server and vSphere username. It also
displays whether the server address or its credentials are correct and displays an error if
they are not.
cluster1::> system node virtual-machine hypervisor show-credentials
Node: node1
Hypervisor IP Address: 192.168.0.1
vSphere Username: administrator
Credentials Correct?: true
1565
Node: node2
Hypervisor IP Address:
vSphere Username: admin
Credentials Correct?: false
Error: [13166] could not find IP addr for host.
Correct the vSphere credentials with the
"system node virtual-machine hypervisor modify-credentials -node" command.
See Also
system node virtual-machine hypervisor show system node virtualmachine instance show-system-disks storage disk show -virtual-machine-disk-info
system node virtual-machine hypervisor modify-credentials
1566
system node virtual-machine hypervisor show

Display hypervisor information about Data ONTAP-v nodes
level.
Description
The system node virtual-machine hypervisor show command displays
information for each hypervisor that is hosting a Data ONTAP virtual machine. The
output contains the hypervisor-specific information, such as host name and IP address,
as well as network configuration details. The command only scans hypervisors on
which Data ONTAP virtual machines are installed. To filter command output, specify any
number of optional fields listed below.
Parameters
specify.
| [-instance ] }
about all fields.
The name of the Data ONTAP node running in a virtual machine for which information
is to be displayed. If this optional parameter is not specified, the command displays
information about all nodes in the cluster.
[-vm-uuid <UUID>] - UUID of the Virtual Machine
The hypervisor-supplied unique ID for this virtual machine. This optional parameter
selects information about the hypervisor on which the Data ONTAP virtual machine
is running with the specified UUID. Since UUID is unique per host, an alternative and
easier way is to use -node to filter out the same information.
[-vmhost-bios-release-date <text>] - Release Date for the Hypervisor BIOS
The release date for the currently running hypervisor BIOS. This optional parameter
selects information about the hypervisors that have the specified BIOS release date.
1567
[-vmhost-bios-version <text>] - Current BIOS Version of the Hypervisor Physical

Chassis
The current BIOS version of the hypervisor physical chassis. This optional parameter
selects information about the hypervisors that are running with the specified BIOS
version.
[-vmhost-boot-time <text>] - Time When Hypervisor was Last Booted
The time when the hypervisor was last booted. This optional parameter selects
information about the hypervisors which were last booted at the specified boot time.
[-vmhost-cpu-clock-rate <integer>] - Speed of the Hypervisor CPU Cores (MHz)
The speed of the hypervisor CPU cores. This optional parameter selects information
about the hypervisors that are running with the specified CPU clock rate.
[-vmhost-cpu-core-count <integer>] - Number of Physical CPU Cores on the
Hypervisor
The number of physical CPU cores on the hypervisor. Physical CPU cores are the
processors contained by a CPU package. This optional parameter selects information
about the hypervisors that are running with the specified CPU cores.
[-vmhost-cpu-socket-count <integer>] - Number of Physical CPU Packages on the
Hypervisor
The number of physical CPU packages on the hypervisor. Physical CPU packages are
chips that contain one or more processors. Processors contained by a package are
also known as CPU cores. For example, one dual-core package is comprised of one
chip that contains two CPU cores. This optional parameter selects information about the
hypervisors that are running with the specified CPU sockets.
[-vmhost-cpu-thread-count <integer>] - Number of Physical CPU Threads on the
Hypervisor
The number of physical CPU threads on the hypervisor. This optional parameter selects
information about the hypervisors that are running with the specified CPU threads.
[-vmhost-gateway <text>] - Default Gateway for the Hypervisor
The default gateway for the hypervisor. This optional parameter selects information
about the hypervisors with the specified gateway address.
[-vmhost-hardware-vendor <text>] - Hardware Vendor of the Hypervisor
The name of hypervisor hardware manufacturer. This optional parameter selects
information about the hypervisors with the specified hardware vendor.
1568
[-vmhost-hypervisor <text>] - Complete Product Name, including the Version

Information for the Hypervisor
The complete product name, including the version information for the hypervisor. This
optional parameter selects information about the hypervisors that are running with the
specified hypervisor version.
[-vmhost-ip-address <text>] - Primary IP Address Assigned to the Hypervisor
The primary IP address assigned to the hypervisor. This optional parameter selects
information about the hypervisors with the specified IP address.
[-vmhost-memory <integer>] - Physical Memory Size of the Hypervisor (Bytes)
The physical memory size of the hypervisor in bytes. This optional parameter selects
information about the hypervisors that are running with the specified physical memory.
[-vmhost-model <text>] - Hypervisor Manufacturer-Supplied Hardware Model Name
The hypervisor manufacturer-supplied hardware model name. This optional parameter
selects information about the hypervisors with the specified hardware model.
[-vmhost-name <text>] - Hostname of the Hypervisor
The host name assigned to the hypervisor. This optional parameter selects information
about the hypervisor with the specified host name.
[-vmhost-netmask <text>] - Subnet Mask Address for the Hypervisor
The subnet mask address for the hypervisor. This optional parameter selects
information about the hypervisors with the specified netmask address.
[-vmhost-processor-id <text>] - Processor ID of the Hypervisor
The processor ID of the hypervisor. This optional parameter selects information about
the hypervisors with the specified processor ID.
[-vmhost-processor-type <text>] - CPU Model of the Hypervisor
The CPU model of the hypervisor. This optional parameter selects information about the
hypervisors that are running with the specified processor type.
[-vmhost-software-vendor <text>] - Name of the Virtual Machine Software
Manufacturer
The name of the virtual machine software manufacturer. This optional parameter selects
information about the hypervisors with the specified software vendor.
[-vmhost-uuid <UUID>] - UUID of the Hypervisor
A unique ID for the hypervisor. This optional parameter selects information about the
hypervisor with the specified UUID.
1569
[-vmhost-error <text>] - Error in case Hypervisor Info Retrieval Fails

Displays a list of nodes on which the hypervisor has received the specified error. This
parameter is most useful when entered with wildcards.
Examples
The following example shows typical output from the system node virtualmachine hypervisor show command for the Data ONTAP virtual machines running
in the cluster.
cluster1::> system node virtual-machine hypervisor show
Virtual Machine Info
-------------------Node:
VM UUID:
node1
123abcde-4f5g-6h78-i9j0-k12l3m4567np
Hypervisor Info
-------------------Hardware Vendor:
Model:
Software Vendor:
Hypervisor:
Host Name:
Last Boot Time:
Host UUID:
BIOS Version:
BIOS Release Date:
CPU Packages:
VMware Virtual Platform

Unknown
VMware ESX 4.1.0 build-12345
myesx.example.com
2014-01-01T01:23:45.678901-23:45
00000000-0000-0000-0000-0012a3456789
S1234.5.6.7.8.901234567890
2013-01-01T00:00:00Z
2
CPU Cores:
12
CPU Threads:
24
Processor ID:
Processor Type:
CPU MHz:
Memory Size:
IPv4 Configuration:
1570
VMware, Inc.
0000:0000:0000:0010:0010:0100:1100:0010
Intel(R) Xeon(R) CPU X5670 @ 2.93GHz
2925
4227858432
IP Address: 192.168.0.1
Netmask:
255.255.255.0
Gateway:
192.165.0.1
Virtual Machine Info

-------------------Node:
VM UUID:
node2
123abcde-4f5g-6h78-i9j0-k98l7m6543yz
Hypervisor Info
-------------------Hardware Vendor:
Model:
Software Vendor:
Error:
VMware, Inc.
VMware Virtual Platform
Unknown
ServerFaultCode:
InvalidLoginFault type='InvalidLogin'
See Also
system node virtual-machine instance show-system-disks storage disk show -virtualmachine-disk-info
1571
system node virtual-machine instance showsystem-disks

Display information about Data ONTAP-v system disks
level.
Description
The system node virtual-machine instance show-system-disks
command displays the system disks information of the Data ONTAP node running
on the virtual machine. There are three types of Data ONTAP-v system disks - boot,
core and log. The details contain the physical properties of the disk and its backing
information (e.g. backing store name, iSCSI Lun UUID, etc). To filter command output,
specify any number of optional fields listed below.
Parameters
specify.
| [-instance ] }
about all fields.
The name of the Data ONTAP node running in a virtual machine for which information
is to be displayed. If this optional parameter is not specified, the command displays
information about all nodes in the cluster.
[-vmdisk-type <text>] - Type of the System Disk
The type of the system disk, for example "Boot", "Core" or "Log". This optional
parameter selects the information about the system disk with the specified type.
[-vmdisk-name <text>] - Data ONTAP Supplied Name of the System Disk
The Data ONTAP-supplied name of the system disk. This optional parameter selects the
information about the system disk with the specified name.
1572
[-vmdisk-serial-number <text>] - Data ONTAP Supplied Serial Number of the System

Disk
The Data ONTAP-supplied serial number of the system disk. This optional parameter
selects the information about system disk with the specified serial number.
[-vmdisk-capacity {<integer>[KB|MB|GB|TB|PB]}] - Size of the System Disk
The size of the system disk. This optional parameter selects the information about
system disks with the specified size.
[-vmdisk-area-name <text>] - Name of the System Disk Backing Store
The name of the disk backing store. A backing store represents a storage location for
virtual machine files. It can be a VMFS volume, a directory on network-attached storage,
or a local file system path. This optional parameter selects the information about the
system disks that reside on the specified backing store.
[-vmdisk-file-name <text>] - File Name of the System Disk Used By the Hypervisor
The file name of the virtual disk used by the hypervisor. Each Data ONTAP disk is
mapped to a unique VM disk file. This optional parameter selects the information about
the system disk mapped to the specified file name.
[-vmdisk-backing-store-type <text>] - Type of the System Disk Backing Store
The type of the disk backing store. It can be a VMFS volume, a directory on networkattached storage, or a local file system path. This optional parameter selects the
information about the system disks that are backed by the specified type.
[-vmdisk-backing-store-capacity {<integer>[KB|MB|GB|TB|PB]}] - Size of the System
Disk Backing Store
The size of the disk backing store. This optional parameter selects the information about
the system disks that are backed by stores with the specified capacity.
[-vmdisk-backing-store-nas-path <text>] - Full Path to the Backing Store for NAS
The full path to the backing store for network-attached storage. This optional parameter
selects the information about the system disks with the specified NAS path.
[-vmdisk-backing-adapter-pci <text>] - Backing Adapter PCI Device ID
The backing adapter PCI device ID for the virtual disk. This optional parameter selects
the information about the system disks that have the specified ID as their backing
adapter PCI ID.
[-vmdisk-backing-adapter-device <text>] - Name of the Backing Adapter Device
1573
The name of the backing adapter device. This optional parameter selects the
information about the system disks that have the specified name as their backing
adapter device name.
[-vmdisk-backing-adapter-model <text>] - Type of the Backing Adapter Model
The type of the backing adapter model. This optional parameter selects the information
about the system disks that have the specified type as their backing adapter model type.
[-vmdisk-backing-adapter-driver <text>] - Backing Adapter Driver Name of the Initiator
The backing adapter driver name of the initiator. This optional parameter selects the
information about the system disks that have the specified name as their initiator's
backing adapter driver name.
[-vmdisk-backing-target-iscsi-name <text>] - iSCSI Name of the System Disk Backing
Target
The iSCSI name of the disk backing target. This field is valid only for iSCSI connections.
This optional parameter selects the information about the system disks that have the
specified name as their backing device iSCSI target name.
[-vmdisk-backing-target-iscsi-address <text>] - iSCSI IP Address of the System Disk
Backing Target
The iSCSI IP address of the disk backing target. This field is valid only for iSCSI
connections. This optional parameter selects the information about the system disks that
have the specified IP as their backing device iSCSI target IP address.
[-vmdisk-backing-device-address <text>] - SCSI Device Name (target-id:lun-id) for the
Backing Disk
The SCSI device name for the backing disk. It takes the form target-id:lun-id, for
example "2:1". This optional parameter selects the information about the system disks
that have the specified backing device address.
[-vmdisk-backing-device-uuid <text>] - Hypervisor-Assigned Unique ID of the Backing
Device
The hypervisor-assigned unique ID of the backing device (disk or LUN). This optional
parameter selects the information about system disks that are backed by a device with
the specified UUID.
[-vmdisk-backing-device-partition <integer>] - Backing Disk Partition Number for the
VM Disk File
The backing disk partition number where the corresponding VM disk file resides. This
optional parameter selects the information about the system disks that reside on the
specified partition number on any disk.
1574
[-vmdisk-backing-device-capacity {<integer>[KB|MB|GB|TB|PB]}] - Size of the

Backing Device (Disk or LUN)
The size of the backing device (disk or LUN) in bytes. This optional parameter selects
the information about the system disks that have backing devices with the specified
capacity.
Examples
The following example shows typical output from the system node virtualmachine instance show-system-disks command for the Data ONTAP node
running on a virtual machine.
cluster1::> system node virtual-machine instance show-system-disks

Disk Disk
Node Type Name
Disk
Store
Capacity Name
VM Disk File Name
---- ---- ----- -------- ------ ------------------------------node1

Boot ad0
1.032 GB store1 store1/node1/DataONTAP.vmdk
Core ad1
1.505 GB store2 store2/node1/DataONTAP-var.vmdk
Log
5.001 GB store3 store3/node1/DataONTAP-nvram.vmdk
ad2
Warning: Unable to list entries on node node2. Access to the

vSphere server is failing since the server hostname or IP
address is not set. Correct the vSphere credentials with the
"system node virtual-machine hypervisor modify-credentials"
command.
See Also
system node virtual-machine hypervisor show storage disk show -virtual-machine-diskinfo
1575
system node virtual-machine instance show

Display virtual machine instance information per node
level.
Description
The system node virtual-machine instance show command displays virtual
machine information. With this information you can determine the relationship between
a Data ONTAP node and its associated virtual machine instance running within a cloud
provider. Several other details about the virtual machine can be extracted as well, such
as the cloud provider account ID to which it belongs. To filter command output, specify
any number of optional fields listed below.
Parameters
specify.
| [-instance ] }
about all fields.
This optional parameter represents the name of the Data ONTAP node running in
a virtual machine for which information is to be displayed. If this parameter is not
specified, the command displays information about all nodes in the cluster.
[-instance-id <text>] - ID of This Instance
A cloud provider-supplied unique ID for this virtual machine, for example "i-a9d42f89".
[-account-id <text>] - ID of This Account
The cloud provider-associated account ID for this virtual machine. This parameter is
usually associated with a cloud provider login ID and password.
[-image-id <text>] - ID Of the Image in Use on This Instance
1576
The image ID installed on this virtual machine instance. It identifies a pre-defined

template of a computing device's software environment. It contains the operating system
and can also include application software, such as database servers, middleware, and
web servers. In this case, the ID refers to an image that contains everything required to
run Data ONTAP in the cloud.
[-instance-type <text>] - Specifies System Attributes and Use Cost
A specification (as defined by the cloud provider) that defines the memory, CPU, storage
capacity and usage cost for a virtual machine instance. Some instance types are
designed for standard applications, whereas others are designed for CPU-intensive or
memory-intensive applications and so on.
[-region <text>] - Set of Resources in the Same Geographic Area
A named set of resources in the same geographical area. For example "us-east-1"
might be the name for a collection of compute and storage resources on the eastern
coast of the United States. Typically, a region contains multiple availability zones.
[-version <text>] - Version of This VM Instance Information
The version of this virtual machine instance information, as defined by the cloud
provider.
[-availability-zone <text>] - Distinct Location within a Region
A distinct location within a region that is insulated from failures in other availability
zones. It provides low-latency network connectivity to other availability zones in the
same region.
[-primary-ip <text>] - Primary IP Address Assigned to this Instance
The primary IP address assigned to this virtual machine instance.
Examples
The following example illustrates typical output from the system node virtualmachine instance show command for a virtual machine running in a cloud provider
environment.
cluster1::> system node virtual-machine instance show
Node:
Instance ID:
node1
i-b9c42e97
Account ID:
751083215869
Image ID:
ami-7fb4a1c6
Instance Type:
m3.xlarge
Region:
us-east-1
1577
Version:
2010-08-31
Availability Zone:
us-east-1d
Primary IP:
1578
192.168.0.1
system script delete

Delete saved CLI session logs
level.
Description
The system script delete command deletes files that contain CLI session records.
Use the system script show command to display saved CLI sessions.
Parameters
-username <text> - Log Owner Username
Use this parameter to specify the name of the user whose CLI session record files are
deleted. The default is the username is that of the logged in user.
-filename <text> - Log Filename
Use this parameter to specify the names of CLI session record files to delete.
Examples
The following example shows how to delete the files named sessionlog2 and
sessionlog3.
cluster1::> system script delete -filename sessionlog2,sessionlog3
The following example deletes all saved script files.

cluster1::> system script delete *
See Also
system script show
1579
system script show

Display saved CLI session logs
level.
Description
The system script show command displays information about files that contain
records of CLI sessions.
For security reasons, the command normally displays only the script files created by the
logged in user. Administrative users can display all log files using the -user parameter.
Parameters
specify.
| [-user ]
Use this parameter to display all script files created by all users, along with the
username associated with each file.
| [-instance ] }
about all fields.
[-username <text>] - Log Owner Username
Use this parameter to display information only about files saved by the user you specify.
The default username is that of the logged in user.
[-filename <text>] - Log Filename
Use this parameter to display information only about files that have the file name you
specify.
[-size-limit {<integer>[KB|MB|GB|TB|PB]}] - Logfile Size Limit
Use this parameter to display information only about files that have the size limit you
specify.
1580
[-state <State of CLI session log>] - Current State

Use this parameter to display information only about files that have the state you
specify. Valid values for this parameter are open-and-logging, file-full, and
file-closed.
[-size {<integer>[KB|MB|GB|TB|PB]}] - Current Logfile Size
Use this parameter to display information only about files that are the size you specify.
[-mtime <MM/DD/YYYY HH:MM:SS>] - Last Modification Time
Use this parameter to display information only about files that were last modified at the
date and time you specify.
[-this-session {yes|no}] - Session is Logging
Use this parameter with the value yes to display information only about files that are
recording the current CLI session. Use this parameter with the value no to display
information only about files that are not recording the current CLI session.
Examples
The following example displays typical system script information.
cluster1::> system script show
This
FileName
Sess State
Size
Last Mod Date
------------------- ---- ---------------- ------- -----------------sessionlog1
no
file-closed
435B
12/2/2008 10:51:12
sessionlog2
yes
open-and-logging 193B
12/2/2008 10:51:29
1581
system script start

Start logging all CLI I/O to session log
level.
Description
The system script start command starts creating a record of your CLI session.
The record is stored in a file. Use the system script show -this-session yes
command to display files that are recording the current CLI session. Use the system
script stop command to stop recording the current CLI session.
Parameters
-filename <text> - Filename to Log To
Use this parameter to specify the file name to which the CLI session record is saved.
-size-limit {<integer>[KB|MB|GB|TB|PB]} - Logfile Size Limit Max:2GB
Use this parameter to specify the maximum size of the file that contains the CLI session
record. When the file size reaches this limit, recording stops. The default file size limit is
1 MB. The maximum file size limit is 2 GB.
Examples
The following example shows how to start creating a record of the CLI session in a file
named sessionlog3. The size limit of this file is 20 MB.
cluster1::> system script start -filename sessionlog3 -size-limit 20MB
See Also
system script show system script stop
1582
system script stop

Stops logging CLI I/O
level.
Description
The system script stop command stops creating a record of your CLI session,
if you started creating the record by using the system script start command.
Use the system script show -this-session yes command to display files that are
recording the current CLI session.
Parameters
None
Examples
The following example shows how to stop creating a record of your CLI session.
cluster1::> system script stop
See Also
system script start system script show
1583
system script upload

Upload the selected CLI session log
level.
Description
The system script upload command uploads a CLI session record file to a remote
location. Specify the remote location using an FTP or HTTP URI. Use the system
script show command to display saved CLI sessions. Use the system script
start command to record a CLI session and save it to a file.
Parameters
-username <text> - Username If Not Your Own
Use this parameter to specify the name of the user who owns the file to upload. By
default, this is the user who is logged in.
-filename <text> - Filename to Log To
Use this parameter to specify the name of a file to be uploaded.
-destination {(ftp|http)://(hostname|IPv4 Address|'['IPv6 Address']')...} - URI to Send File
To
Use this parameter to specify the FTP or HTTP destination of the file.
Examples
The following example shows how to upload the file named sessionlog3 to the
destination ftp://now.example.com/cli_sessions.
cluster1::> system script upload -filename sessionlog3 -destination ftp://
now.example.com/cli_sessions
See Also
system script show system script start
1584
system service-processor reboot-sp

Reboot the Service Processor on a node
level.
Description
The system service-processor reboot-sp command reboots the Service
Processor of the specified node.
Parameters
This parameter specifies the node whose Service Processor is to be rebooted.
[-image {primary|backup}] - Image to Boot with After Reboot
This parameter specifies the image that the Service Processor uses after the reboot.
By default, the primary image is used. Avoid booting the SP from the backup image.
Booting from the backup image is reserved for troubleshooting and recovery purposes
only. It might require that the SP automatic firmware update be disabled, which is not a
recommended setting. You should contact technical support before attempting to boot
the SP from the backup image.
Examples
The following command reboots the Service Processor of node "node1" into the
primary image.
cluster1::> system service-processor reboot-sp -node node1 -image primary
NOTE : If your console connection is through the SP, it will be disconnected.
Do you want to reboot the SP ? {y|n}: y
cluster1::>
The following command reboots the Service Processors of all nodes. Since -image is
not specified, the Service Processors will boot into the primary image.
cluster1::> system service-processor reboot-sp -node *
1585
NOTE : If your console connection is through the SP, it will be disconnected.

Do you want to reboot the SP ? {y|n}: y
2 entries were acted on.
cluster1::>
1586
system service-processor show

Display the Service Processor information
level.
Description
The system service-processor show command displays information about the
Service Processor of each node in a cluster. You can limit output to specific types of
information and specific nodes in the cluster, or filter output by specific field values.
In case a node is offline or its Service Processor management daemon is down, the
command displays the last known IP address of its Service Processor. Only the IP
address is displayed in such cases.
Parameters
specify.
| [-instance ] }
about all fields.
Selects information for the Service Processor of the specified node.
[-type {SP|NONE}] - Type of Device
Selects information for the Service Processors of the specified type.
[-status {online|offline|sp-daemon-offline|node-offline|degraded|rebooting|unknown}] Status
Selects information for the Service Processors whose status matches the specified
value.
[-ip-configured {true|false}] - Is Network Configured
1587
Selects information for the Service Processors whose network is configured (true) or
not configured (false).
[-address <IP Address>, ...] - Public IP Address
Selects information for the Service Processors that use the specified IP address or
addresses.
Selects information for the Service Processors that use the specified MAC address.
[-fw-version <text>] - Firmware Version
Selects information for the Service Processors that are running the specified firmware
version.
[-part-num <text>] - Part Number
Selects information for the Service Processors that have the specified part number.
[-serial-num <text>] - Serial Number
Selects information for the Service Processors that have the specified serial number.
[-dev-rev <text>] - Device Revision
Selects information for the Service Processors that have the specified device revision.
[-autoupdate-enabled {true|false}] - Is Firmware Autoupdate Enabled
Selects information for the Service Processors that have the specified status for
firmware automatic update.
Examples
The following example displays basic information for the Service Processors of all the
nodes.
cluster1::> system service-processor show
Node
Type Status
IP
Firmware
Configured
Version
IP Address
------------- ---- ----------- ------------ --------- ------------------------node1
SP
online
true
2.2X5
192.168.1.201
node2
SP
online
true
2.2X5
192.168.1.202

cluster1::>
1588
The following example displays all available information for the Service Processors of all
the nodes.
cluster1::> system service-processor show -instance
Node: node1
Type of Device: SP
Status: online
Is Network Configured: true
Public IP Address: 192.168.1.201
MAC Address: ab:cd:ef:fe:ed:01
Firmware Version: 2.2X5
Part Number: Not Applicable
Serial Number: Not Applicable
Device Revision: Not Applicable
Is Firmware Autoupdate Enabled: true
Node: node2
Type of Device: SP
Status: online
Is Network Configured: true
Public IP Address: 192.168.1.202
Part Number: Not Applicable
Serial Number: Not Applicable
Device Revision: Not Applicable
Is Firmware Autoupdate Enabled: true
cluster1::>
The following example displays only the type, status and firmware version for the
Service Processors of all the nodes.
cluster1::> system service-processor show -fields type,status,fw-version,ipmi-ver
node
type status fw-version ipmi-ver
------------- ---- ------ ---------- -------node1
SP
online 2.2X5
2.0
node2
SP
online 2.2X5
2.0
1589
cluster1::>
1590
system service-processor api-service modify

Modify service processor API service configuration
privilege level.
Description
The system service-processor api-service modify command modifies
SP API service configuration. The SP API is a secure network API that enables Data
ONTAP to communicate with the Service Processor over the network.
Parameters
[-is-enabled {true|false}] - Is SP API Service Enabled
This parameter enables or disables the API service of the Service Processor. When
the API service is disabled, features like network-based firmware updates and networkbased down filer log collection will not be available, and the slower serial-interface will
be used for firmware updates and down filer log collections.
[-port <integer>] - SP API Service Port
This parameter specifies the port number on the Service Processor used for the API
service. By default, port 50000 is used.
Examples
The following example modifies the port number used for the SP API service and then
disables the SP API service.
cluster1::*>system service-processor api-service modify -port 50001
cluster1::*>system service-processor api-service show
Service Processor API service configuration
is-enabled: true
port: 50001
cluster1::*>system service-processor api-service modify -is-enabled false

1591

is-enabled: false
port: 50001
1592
system service-processor api-service renewcertificates

Renew SSL and SSH certificates used for secure communication with Service
Processor API service
privilege level.
Description
The system service-processor api-service renew-certificates
command renews the internal SSL and SSH certificates used for secure communication
with the Service Processor API service. If the parameter -renew-all is not specified,
only host certificates are renewed.
Parameters
[-renew-all {true|false}] - Renew CA Certificates Also
This parameter specifies the type of certificates that needs to be renewed. If this
parameter is set to false, only the host certificates (that is, the client and server
certificates) are renewed. If this parameter is set to true, the root-ca certificate is
renewed along with the host certificates.
Examples
The following example renews the host certificates and the root-ca certificates. The
second command renews only the host certificates.
cluster1::*>system service-processor api-service renew-certificates -renew-all
true
cluster1::*>system service-processor api-service renew-certificates
1593
system service-processor api-service show

Display service processor API service configuration
privilege level.
Description
The system service-processor api-service show command displays the
Service Processor API service configuration.
Parameters
None
Examples
The following example displays the SP API service configuration:
is-enabled: true
port: 50000
system service-processor image modify

Enable/Disable automatic firmware update
level.
Description
The system service-processor image modify command enables or disables
automatic firmware update on the Service Processor of specified node or nodes.
Parameters
1594
The parameter specifies the node on which automatic Service Processor firmware
update is to be enabled or disabled.
[-autoupdate {true|false}] - Firmware Autoupdate
Setting this parameter to true enables automatic firmware update. Setting this
parameter to false disables automatic firmware update. This is a mandatory
parameter.
Examples
The following command enables automatic firmware update for the Service Processor
on the local node.
cluster1::> system service-processor image modify -node local -autoupdate true
The following command enables automatic firmware update for the Service Processors
on all the nodes.
cluster1::> system service-processor image modify -node * -autoupdate true
2 entries were modified.
system service-processor image show

Display the details of currently installed Service Processor firmware image
level.
Description
The system service-processor image show command displays information
about the currently installed firmware images on the Service Processor of each node in
a cluster. You can limit output to specific types of information and specific nodes in the
cluster, or filter output by specific field values.
Parameters
1595

specify.
| [-instance ] }
about all fields.
Selects firmware image information for the Service Processor of the specified node.
[-image {primary|backup}] - Image
Selects firmware image information for the Service Processors that are running the
primary or backup image as specified.
[-type {SP|NONE}] - Type
Selects firmware image information for the Service Processors of the specified type.
[-status {installed|corrupt|updating|auto-updating|none}] - Image Status
Selects firmware image information for the Service Processors whose image status
matches the specified value.
[-is-current {true|false}] - Is Image Current
Selects firmware image information for the SP whose current image matches the
specified status. This parameter indicates the partition (primary or backup) that the SP is
currently booted from, not whether the installed firmware version is most current.
[-version <text>] - Firmware Version
Selects firmware image information for the Service Processors running the specified
firmware version.
[-autoupdate {true|false}] - Firmware Autoupdate
Selects firmware image information for the Service Processors whose automatic update
matches the specified configuration.
[-last-update-status {failed|passed}] - Last Update Status
Selects firmware image information for the Service Processors whose last update is of
the specified status.
Examples
1596
The following command displays basic firmware information for the Service Processors
of all the nodes.
cluster1::> system service-processor image show
Is
Node
Type
Image
Status
Current Version
---------------- ----- ------- ----------- ------- -------node1
SP
node2
primary installed
true
2.2X8
backup
false
2.2X5
primary installed
true
2.2X8
backup
false
2.2X5
installed
SP
installed

cluster1::>
The following command displays all available firmware information for the Service
Processors of all the nodes.
cluster1::> system service-processor image show -instance
Node: node1
Image: primary
Type: SP
Image Status: installed
Is Image Current: true
Firmware Autoupdate: true
Last Update Status: passed
Node: node1
Image: backup
Type: SP
Is Image Current: false
Node: node2
1597
Image: primary
Type: SP
Is Image Current: true
Node: node2
Image: backup
Type: SP
Is Image Current: false
cluster1::>
1598
system service-processor image update

Update Service Processor firmware
level.
Description
The system service-processor image update command installs a new
firmware version on the Service Processor of specified node in a cluster. If this
command fails, it will display and log an appropriate error message and abort. No
automatic command retries will be performed. This command also specifies which
firmware image is to be installed on the Service Processor and how.
You can use the command system service-processor image updateprogress show to check the progress of the update.
The following parameter combinations are not supported for this command:
-update-type differential with -clear-logs true
-baseline true with -package <text>
Parameters
This parameter specifies the node whose Service Processor's firmware is to be
updated.
[-package <text>] - Firmware Package
This parameter specifies the package that will be installed. You can find the package
file in the SP Update Repository field of the system node image package show
command. If you do not specify this parameter, the Service Processor is updated to the
most recent version of the firmware that is available in the update repository. You must
specify this parameter if baseline is false or omitted.
[-baseline {true|false}] - Install Baseline
If you set this parameter to true, the command installs the Service Processor firmware
version that is bundled with the currently running release of Data ONTAP. This is a
safety mechanism that allows you to revert the SP firmware to the version that was
qualified and bundled with the currently running version of Data ONTAP on your system.
If not specified, this parameter defaults to false.
1599
-update-type {serial-full|serial-differential|network-full} - Type

This parameter specifies the type of update to be performed.
If you set the value to serial-full, the command transfers contents of the entire SP
firmware image to the SP via the packetized serial interface, and the contents are
written to the SP primary partition.
If you set the value to serial-differential, the command transfers the SP firmware files
that are different between the old SP firmware image and the new SP firmware image
to the SP via the packetized serial interface, and the contents are written to SP primary
partition.
If you set the value to network-full, the command transfers the entire SP firmware image
to the SP via the SP network interface, and the contents are written to the SP primary
partition.
If you do not specify the update-type option, the command checks for dependencies
of network-based SP firmware updates. If the dependencies are satisfied, then the
command uses the SP network interface to update the SP firmware. If the dependencies
are not satisfied, then the serial interface is used.
[-clear-logs {true|false}] - Clear Logs After Update
If you set this parameter to true, the command resets log settings to factory default and
clears contents of all logs maintained by the Service Processor, including:
Event logs
IPMI logs
Forensics logs
Examples
The following command reverts the firmware on the Service Processor of the local node
to the version that was packaged with the currently running release of Data ONTAP. A
complete install will be performed, clearing all logs maintained by the Service Processor.
The second command displays the status of the in-progress firmware install.
cluster1::> system service-processor image update -node local -update-type full baseline true -clear-logs true
cluster1::>
cluster1::> system service-processor image update-progress show
In
1600
Percent
Node
Progress Start Time
Done
End Time
---------------- -------- ------------------- ------- ------------------node1
yes
8/28/2012 20:00:34
99
node2
no

cluster1::>
See Also
system node image package show system service-processor image updateprogress show
1601
system service-processor image update-progress

show
Display status for the latest Service Processor firmware update
level.
Description
The system service-processor image update-progress show command
displays the progress information of firmware updates on the Service Processor of the
specified nodes. The "in-progress" field displays "no" if no update is in progress.
This command does not display the progress of an SP firmware update that is triggered
from the SP CLI.
Parameters
specify.
| [-instance ] }
about all fields.
This parameter displays the status of Service Processor firmware update for the
specified node.
[-start-time <MM/DD/YYYY HH:MM:SS>] - Latest SP Firmware Update Start
Timestamp
This parameter displays the status of the Service Processor whose firmware update
start time matches the specified value.
[-percent-done <integer>] - Latest SP Firmware Update Percentage Done
This parameter displays the status of the Service Processor whose update completion
percentage matches the specified value.
[-end-time <MM/DD/YYYY HH:MM:SS>] - Latest SP Firmware Update End Timestamp
1602
This parameter displays the status of the Service Processor whose firmware update end
time matches the specified value.
[-in-progress {yes|no}] - Is Update in Progress
This parameter displays the update status of the Service Processor that matches the
specified in-progress status.
Examples
The following example starts a firmware update on the local node and then uses the
command system service-processor image update-progress show to
display progress of firmware updates on Service Processors of all nodes in the system.
cluster1::> system service-processor image update -node local -update-type full baseline true -clear-logs true
cluster1::>
cluster1::> system node service-processor image update-progress show
Node
In
Percent
Progress Start Time
Done
End Time
---------------- -------- ------------------- ------- ------------------node1
yes
8/28/2012 20:00:34
99
node2
no

cluster1::>
1603
system service-processor log show-allocations

Display the Service Processor log allocation map
level.
Description
The system service-processor log show-allocations command displays
the allocation map of the Service Processor logs collected in the cluster. The Service
Processor logs of a node are archived in the mroot directory of the collecting node. This
command displays the sequence numbers for the Service Processor log files that reside
in each collecting node.
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays the sequence numbers of Service
Processor log files that the specified node has collected.
[-remote-node <text>] - Remote Node
If you specify this parameter, the command displays the sequence numbers of Service
Processor log files that have been collected from the specified remote node.
[-seqList <integer>, ...] - Log File Sequence Numbers
If you specify this parameter, the command displays information about Service
Processor log files with the specified sequence number.
Examples
The following example displays the allocation map of the Service Processor log files in
the cluster.
1604
cluster1::> system service-processor log show-allocation

Node
From Which Node
Log File Sequence
------------------- ------------------- ---------------------------------cluster1-01

cluster1-01
10, 11, 12, 13, 15
cluster1-02
14, 15, 16, 17
cluster1-01
14
cluster1-02
11, 12, 13
cluster1-02

cluster1::>
1605
system service-processor network modify

Modify the network configuration
level.
Description
The system service-processor network modify command modifies the
network configuration of the Service Processor of specified node or nodes in a cluster.
If the SP automatic network configuration has been enabled, the system serviceprocessor network modify command allows you to only enable or disable the SP
IPv4 or Ipv6 network interface.
Parameters
This parameter specifies the node whose Service Processor's network configuration is
to be modified.
-address-family {IPv4|IPv6} - Address Family
This parameter specifies whether the IPv4 or the IPv6 configuration is to be modified.
[-enable {true|false}] - Interface Enabled
This parameter enables or disables the underlying network interface for the specified
address-family. This is a mandatory parameter.
[-dhcp {v4|none}] - DHCP Status
If this parameter is set to v4, the Service Processor uses network configuration from the
DHCP server. Otherwise, the Service Processor uses the network address you specify.
If this parameter is not set to v4 or is not specified, you must specify the IP address,
netmask, prefix-length, and gateway in the command. DHCP is not supported for IPv6
configuration.
[-ip-address <IP Address>] - IP Address
This parameter specifies the public IP address for the Service Processor. You must
specify this parameter when the dhcp parameter is not set to v4.
1606
This parameter specifies the netmask for a Service Processor that uses an IPv4
address. This parameter has no effect if the IP address family is set to IPv6. You must
specify this parameter when DHCP is not v4 and the address family is IPv4.
[-prefix-length <integer>] - Prefix Length of Subnet Mask
This parameter specifies the network prefix-length of the Service Processor if the
address family is set to IPv6. The parameter has no effect when the address family is
set to IPv4. You must specify this parameter when DHCP is not set to v4 and when the
address family is set to IPv6.
[-gateway <IP Address>] - Gateway IP Address
This parameter specifies network gateway of the Service Processor. You must specify
this parameter when DHCP is not set to v4.
Examples
The following example enables the network interface for IPv4 on the Service Processor
of the local node. It first displays the current network configuration information of the
local node to show the network interface is initially disabled, and then enables it with
IP address 192.168.1.202, netmask as 255.255.255.0 and gateway as 192.168.1.1. It
displays the interim state with SP Network Setup Status field showing "in-progress".
It finally displays the network configuration again to confirm the specified values took
effect.
cluster1::> system service-processor network show -instance -node local
Node: node2
Address Family: IPv4
Interface Enabled: false
Type of Device: SP
Status: online
Link Status: disabled
DHCP Status: IP Address: MAC Address: ab:cd:ef:fe:ed:02
Netmask: Prefix Length of Subnet Mask: Router Assigned IP Address: Link Local IP Address: Gateway IP Address: Time Last Updated: Fri Jun 13 16:29:55 GMT 2014
Subnet Name: -
1607
Enable IPv6 Router Assigned Address: SP Network Setup Status: succeeded

SP Network Setup Failure Reason: Node: node2
Type of Device: SP
Status: online
DHCP Status: none
IP Address: MAC Address: ab:cd:ef:fe:ed:02
Subnet Name: Enable IPv6 Router Assigned Address: SP Network Setup Status: not-setup
SP Network Setup Failure Reason: 2 entries were displayed.
cluster1::>
cluster1::> system service-processor network modify -node local -address-family

IPv4 -enable true -ip-address 192.168.1.202 -netmask 255.255.255.0 -gateway
192.168.1.1
cluster1::>
Node: node2
Type of Device: SP
Status: online
1608
DHCP Status: IP Address: MAC Address: ab:cd:ef:fe:ed:02

Subnet Name: Enable IPv6 Router Assigned Address: SP Network Setup Status: in-progress
Type of Device: SP
Status: online
DHCP Status: none

Node: node2
Interface Enabled: true
Type of Device: SP
Status: online
Link Status: up
DHCP Status: none
IP Address: 192.168.1.202
Netmask: 255.255.255.0
Prefix Length of Subnet Mask: Router Assigned IP Address: Link Local IP Address: -
1609
Gateway IP Address: 192.168.1.1

Time Last Updated: Fri Jun 13 16:29:55 GMT 2014
Subnet Name: Enable IPv6 Router Assigned Address: SP Network Setup Status: succeeded
Type of Device: SP
Status: online
DHCP Status: none
cluster1::>
1610
system service-processor network show

Display the network configuration
level.
Description
The system service-processor network show command displays the network
configuration of the Service Processor of each node in a cluster. You can limit output to
specific types of information and specific nodes in the cluster, or filter output by specific
field values.
In case a node is offline or its Service Processor management daemon is down, the
command displays the last known IP address of its Service Processor. Only the IP
address is displayed in such cases.
Parameters
specify.
| [-instance ] }
about all fields.
Selects network configuration information for the Service Processor of the specified
node.
[-address-family {IPv4|IPv6}] - Address Family
Selects network configuration information for the Service Processors that have the
specified IP address family.
[-enable {true|false}] - Interface Enabled
Selects network configuration information for the Service Processors whose network
interface for the given address-family is enabled or disabled as specified.
[-type {SP|NONE}] - Type of Device
1611
Selects network configuration information for the Service Processors of the specified
type.
[-status {online|offline|sp-daemon-offline|node-offline|degraded|rebooting|unknown}] Status
Selects network configuration information for the Service Processors whose status
[-link-status {up|down|disabled|unknown}] - Link Status
Selects network configuration information for the Service Processors whose link status
[-dhcp {v4|none}] - DHCP Status
Selects network configuration information for the Service Processors whose DHCP
status matches the specified value.
[-ip-address <IP Address>] - IP Address
Selects network configuration information for the Service Processors that use the
specified IP address.
Selects network configuration information for the Service Processors that use the
specified MAC address.
This parameter displays information only for the Service Processors that use the
specified netmask.
[-prefix-length <integer>] - Prefix Length of Subnet Mask
Selects network configuration information for the Service Processors whose prefix
length of subnet mask matches the specified value.
[-router-ip <IP Address>] - Router Assigned IP Address
Selects network configuration information for the Service Processors whose routerassigned IP address matches the specified value.
[-link-local-ip <IP Address>] - Link Local IP Address
Selects network configuration information for the Service Processors whose link local IP
address matches the specified value.
[-gateway <IP Address>] - Gateway IP Address
1612
Selects network configuration information for the Service Processors whose gateway IP
address matches the specified value.
[-time-last-updated <text>] - Time Last Updated
Selects network information for the Service Processors that have the specified time
stamp showing when configuration was last updated.
[-subnet-name <text>] - Subnet Name
Selects network information for the Service Processors that use the specified subnetname for SP automatic configuration.
[-is-ipv6-ra-enabled {true|false}] - Enable IPv6 Router Assigned Address
Selects network information for the Service Processors that have the specified status for
IPv6 router-assigned address.
[-setup-status {not-setup|succeeded|in-progress|failed}] - SP Network Setup Status
Selects network information for the Service Processors that have the specified status for
network interface setup.
[-setup-failure-reason {success|subnet-out-of-address|invalid-subnet|other-error}] - SP
Network Setup Failure Reason
Selects network information for the Service Processors that have the specified reason
for network interface setup failure.
Examples
The following example displays basic network configuration information for the Service
Processors of all the nodes.
cluster1::> system service-processor network show
Address
Node
Status
Type
Link State
IP Address
------------- -------------- --------- ----------- -----------------------node1
online
IPv4
up
192.168.1.201
DHCP: v4
Network Gateway: 192.168.1.1
Network Mask (IPv4 only): 255.255.255.0
Prefix Length (IPv6 only): IPv6 RA Enabled: Subnet Name: -
1613
SP Network Setup Status: succeeded
node1
online
IPv6
disabled
DHCP: none
Network Gateway: Network Mask (IPv4 only): Prefix Length (IPv6 only): IPv6 RA Enabled: Subnet Name: SP Network Setup Status: not-setup
node2
online
IPv4
up
192.168.1.202
DHCP: v4
Prefix Length (IPv6 only): IPv6 RA Enabled: Subnet Name: SP Network Setup Status: succeeded
node2
online
IPv6
disabled
DHCP: none
Network Gateway: Network Mask (IPv4 only): Prefix Length (IPv6 only): IPv6 RA Enabled: Subnet Name: SP Network Setup Status: not-setup
1614
cluster1::>
The following example displays all available network configuration information for the
Service Processors of all the nodes.
cluster1::> system service-processor network show -instance
Node: node1
Type of Device: SP
Status: online
Link Status: up
DHCP Status: v4
IP Address: 192.168.1.201
Netmask: 255.255.255.0
Prefix Length of Subnet Mask: Router Assigned IP Address: Link Local IP Address: Gateway IP Address: 192.168.1.1
Type of Device: SP
Status: online
DHCP Status: none
Netmask: Prefix Length of Subnet Mask: Router Assigned IP Address: Link Local IP Address: Gateway IP Address:
1615

Type of Device: SP
Status: online
Link Status: up
DHCP Status: v4
IP Address: 192.168.1.202
Netmask: 255.255.255.0
Prefix Length of Subnet Mask: Router Assigned IP Address: Link Local IP Address: Gateway IP Address: 192.168.1.1
Type of Device: SP
Status: online
DHCP Status: none
Netmask: Prefix Length of Subnet Mask: Router Assigned IP Address: Link Local IP Address: Gateway IP Address: -
1616

cluster1::>
1617
system service-processor network autoconfiguration disable

Disable Service Processor Auto-Configuration
level.
Description
The system service-processor network auto-configuration disable
command disables the SP's use of subnet resource for the automatic configuration of
its networking port. This command is a cluster-wide configuration. When you disable the
SP automatic network configuration, all SPs in the cluster will be configured to use IPv4
DHCP. Any addresses previously allocated from the subnet to the SP will be released.
If the SP fails to obtain an IPv4 IP address from the DHCP server, an EMS message
warns you about the failure. The IPv6 interface will be disabled.
Parameters
-address-family {IPv4|IPv6} - Subnet Address Family
This parameter specifies whether the IPv4 or the IPv6 automatic configuration is to be
disabled for the SP.
Examples
The following example disables the automatic configuration for IPv4 on the SP. It first
displays the current network configuration and then disables the SP IPv4 automatic
network configuration.
cluster1::>system service-processor network show
Address
Node
Status
Family
Link State
IP Address
------------- -------------- --------- ----------- -----------------------node1

online
IPv4
up
192.168.1.2
DHCP: none
Prefix Length (IPv6 only): -
1618
IPv6 RA Enabled: Subnet Name: ipv4_test

cluster1::>system service-processor network auto-configuration disable -addressfamily Ipv4

cluster1::>system service-processor network auto-configuration show
Cluster Name
SP IPv4 Subnet Name
SP IPv6 Subnet Name
-------------------- ---------------------------- ---------------------------cluster1

Address
Node
Status
Family
Link State
IP Address
------------- -------------- --------- ----------- -----------------------node1

online
IPv4
up
192.168.1.184
DHCP: v4
1619
system service-processor network autoconfiguration enable

Enable Service Processor Auto-Configuration
level.
Description
The system service-processor network auto-configuration enable
command enables the automatic network configuration for the SP. This is a clusterwide configuration. Every node in the cluster will use the specified subnet to allocate
IP address, subnet mask and gateway address for the SP configuration. When the SP
automatic network configuration is enabled, you do not need to manually manage the
SP network of individual nodes. A node that subsequently joins the cluster uses the
specified subnet to configure its SP network automatically.
Prior to running this command, the subnet you want to use for the SP automatic network
configuration must already be defined in the cluster and must have no resource conflicts
with the SP network interface.
Parameters
-address-family {IPv4|IPv6} - Subnet Address Family
This parameter specifies whether the IPv4 or the IPv6 automatic configuration is to be
enabled for the SP.
-subnet-name <text> - Subnet Name
This parameter specifies the network subnet that the SP will use for automatic network
configuration.
Examples
The following example enables the automatic network configuration for IPv4 on the
SP. It first displays the current SP network configuration, displays available network
subnet in the cluster, and then enable the SP to use the subnet for IPv4 automatic
configuration.
Address
Node
1620
Status
Family
Link State
IP Address
------------- -------------- --------- ----------- -----------------------node1

online
IPv4
up
192.168.1.201
DHCP: v4
cluster1::> network subnet show

IPspace: Default
Subnet
Name
Broadcast
Subnet
Domain
Avail/
Gateway
Total
Ranges
--------- ---------------- --------- --------------- --------- --------------ipv4_test 192.168.1.0/24

192.168.1.2-192.168.1.6
Default
192.168.1.1
3/5
cluster1::>system service-processor network auto-configuration enable -addressfamily ipv4 -subnet-name ipv4_test

cluster1::system service-processor network> show
Address
Node
Status
Family
Link State
IP Address
------------- -------------- --------- ----------- -----------------------node1

online
IPv4
up
192.168.1.2
DHCP: none
Prefix Length (IPv6 only): IPv6 RA Enabled: -
1621
Subnet Name: ipv4_test

1622
system service-processor network autoconfiguration show

Display Service Processor Auto-Configuration Setup
level.
Description
The system service-processor network auto-configuration show
command displays the names of the IPv4 and IPv6 network subnet objects configured in
the cluster that the SP uses for automatic configuration.
Parameters
None
Examples
The following example shows that the SP is configured to use the "ipv4_test" IPv4
subnet in the cluster for the SP automatic network configuration.
cluster1::>system service-processor network auto-configuration show
Cluster Name
SP IPv4 Subnet Name
SP IPv6 Subnet Name
-------------------- ---------------------------- ---------------------------cluster1
ipv4_test
1623
system service-processor ssh add-allowedaddresses

Add IP addresses to the list that is allowed to access the Service Processor
level.
Description
The system service-processor ssh add-allowed-addresses command
grants IP addresses access to the Service Processor.
Parameters
-allowed-addresses <IP Address/Mask>, ... - Public IP Addresses
Use this parameter to specify one or more IP addresses with corresponding netmasks.
The value should be specified in the format of address/netmask, for example,
10.98.150.10/24, fd20:8b1e:b255:c09b::/64. Use commas to separate multiple address/
netmask pairs. If "0.0.0.0/0, ::/0" is specified in the parameter, any IP address is allowed
to access the Service Processor.
Examples
The following examples grant the specified IP addresses access to the Service
Processor and display the list of public IP addresses that are allowed to access the
Service Processor.
cluster1::> system service-processor ssh show

Allowed Addresses: 0.0.0.0/0, ::/0
cluster1::> system service-processor ssh add-allowed-addresses -allowedaddresses 192.168.1.202/24, 192.168.10.201/24
Warning: The default "allow all" setting (0.0.0.0/0, ::/0) will be replaced
with your changes. Do you want to continue? {y|n}: y
cluster1::>
system service-processor ssh show
Allowed Addresses: 192.168.1.202/24, 192.168.10.201/24

The following example enables all IP addresses to access the Service Processor.
1624
cluster1::> system service-processor ssh add-allowed-addresses -allowed-addresses

0.0.0.0/0, ::/0
cluster1::>
1625
system service-processor ssh remove-allowedaddresses

Remove IP addresses from the list that is allowed to access the Service Processor
level.
Description
The system service-processor ssh remove-allowed-addresses command
blocks the specified IP address from accessing the Service Processor. If all IP
addresses are removed from the access list, then the Service Processor is not
accessible from any IP address.
Parameters
-allowed-addresses <IP Address/Mask>, ... - Public IP Addresses
Use this parameter to specify one or more IP addresses with corresponding netmasks.
The value should be specified in the format of address/netmask, for example,
10.98.150.10/24, fd20:8b1e:b255:c09b::/64. Use commas to separate multiple address/
netmask pairs.
Examples
The following example prevents the specified IP addresses from accessing the Service
Processor. It also displays the list of public IP addresses that are allowed to access the
Service Processor.

Allowed Addresses: 192.168.1.202/24, 192.168.10.201/24
cluster1::> system service-processor ssh remove-allowed-addresses -allowedaddresses 192.168.1.202/24, 192.168.10.201/24
Warning: If all IP addresses are removed from the allowed address list, all IP
addresses will be denied access. To restore the "allow all" default,
use the "system service-processor ssh add-allowed-addresses
-allowed-addresses 0.0.0.0/0, ::/0" command. Do you want to continue?
{y|n}: y
1626

Allowed Addresses: cluster1::>
1627
system service-processor ssh show

Display SSH security information about the Service Processor
level.
Description
The system service-processor ssh show command displays the IP addresses
that are allowed to access the Service Processor by using SSH.
Parameters
None
Examples
The following example displays SSH security information about the Service Processor.

cluster1::>
system services firewall modify

Modify firewall status
level.
Description
The system services firewall modify command modifies a node's firewall
configuration.
Parameters
1628

Use this parameter to specify the node on which to modify firewall configuration.
[-enabled {true|false}] - Service Enabled
Use this parameter to specify whether firewall protection is enabled ("true") or disabled
("false") for the node's network ports. The default setting is true.
[-logging {true|false}] - Enable Logging
Use this parameter to specify whether logging is enabled ("true") or disabled ("false") for
the firewall service. The default setting is false.
Examples
The following example enables firewall protection and logging for a node named node1:
cluster1::> system services firewall modify -node node1 -enabled true -logging
true
system services firewall show

Show firewall status
level.
Description
The system services firewall show command displays firewall configuration
and logging information. If the command is issued without any parameters, it displays
information about all nodes in the cluster. You can also query specific nodes for their
firewall information by running the command with the -node parameter.
Parameters
specify.
| [-instance ] }
1629
about all fields.
Selects information about the firewall settings on the node you specify.
[-enabled {true|false}] - Service Enabled
Selects firmware image information about the nodes with the firewall enabled ("true") or
disabled ("false").
[-logging {true|false}] - Enable Logging
Selects firmware image information about the nodes with firewall logging enabled
("true") or disabled ("false").
Examples
The following example displays information about firewall configuration for all nodes in
the cluster:
cluster1::> system services firewall show
Node
Enabled Logging
-------------- ------- ------node0
true
false
node1
true
false
node2
true
false
node3
true
false
1630
system services firewall policy clone

Clone an existing firewall policy
level.
Description
The system services firewall policy clone command creates a new firewall
policy that is an exact copy of an existing policy, but has a new name.
Parameters
-vserver <text> - Vserver owning the Policy
Use this parameter to specify the name of the Vserver owning the existing policy to
copy.
-policy <text> - Firewall Policy to be Cloned
Use this parameter to specify the name of the existing policy to copy.
[-destination-vserver <text>] - Vserver owning the New Firewall Policy
Use this parameter to specify the name of the Vserver that will own the new policy to
create.
-destination-policy <text> - Name of New Firewall Policy
Use this parameter to specify the name of the new policy to create.
Examples
This example creates a new firewall policy named "data2" on Vserver "vs0" from an
existing firewall policy named "data" on Vserver "vs1".
cluster1::> system services firewall policy clone -vserver vs0 -policy data destination-vserver vs1 -destination-policy data2
system services firewall policy create

Create a firewall policy entry for a network service
1631

level.
Description
The system services firewall policy create command creates a firewall
policy entry with the specified name and network service. This command is used both
to create the first network service associated with a new firewall policy, or to add to an
existing firewall policy by associating another network service with an existing policy.
You can optionally specify one or more IP addresses with corresponding netmasks that
are allowed to use the firewall policy entry.
You can use the network interface modify command with the -firewallpolicy parameter to put a firewall policy into effect for a given logical interface by
modifying that logical interface to use the specified firewall policy.
Parameters
Use this parameter to specify the name of the Vserver on which the policy is to be
created.
-policy <textpolicy_name> - Policy
Use this parameter to specify the name of the policy that is to be created.
-service <service> - Service
Use this parameter to specify the network service that is associated with the policy.
Possible values include:
default - The default protocol or protocols for the port to which the firewall is
applied
http - The HTTP protocol
https - The HTTPS protocol
ntp - The NTP protocol
rsh - The RSH protocol
snmp - The SNMP protocol
ssh - The SSH protocol
telnet - The Telnet protocol
-allow-list <IP Address/Mask>, ... - Allowed IPs
1632
Use this parameter to specify one or more IP addresses with corresponding netmasks
that are to be allowed by this firewall policy. The correct format for this parameter is
address/netmask, similar to "192.0.2.128/25". Multiple address/netmask pairs should be
separated with commas. Use the value 0.0.0.0/0 for "any".
Examples
The following example creates a firewall policy named data that uses the SSH protocol
and enables access from all IP addresses on the 192.0.2.128/25 subnet:
cluster1::> system services firewall policy create -policy data -service ssh allow-list 192.0.2.128/25
The following example adds an entry to the firewall policy named data, associating
the HTTPS protocol with that policy and enabling access from all IP addresses on the
192.0.2.128/25 subnet:
cluster1::> system services firewall policy create -policy data -service https allow-list 192.0.2.128/25
See Also
1633
system services firewall policy delete

Remove a service from a firewall policy
level.
Description
The system services firewall policy delete command deletes a firewall
policy. You cannot delete a policy that is being used by a logical interface. Use the
network interface modify command with the -firewall-policy parameter to
change a network interface's firewall policy.
Parameters
Use this parameter to specify the Vserver of the policy to delete.
Use this parameter to specify the name of the policy to delete.
Use this parameter to specify the policy's network service to delete.
Examples
The following example deletes a firewall policy that uses the Telnet protocol on the
policy named data:
cluster1::> system services firewall policy delete -policy data -service telnet
Use wildcards to delete entire policies at once, or particular services from every policy.
This example deletes the entire intercluster policy.
cluster1::> system services firewall policy delete -policy intercluster -service
*
This example deletes the telnet service from every policy.

cluster1::> system services firewall policy delete -policy * -service telnet
1634
See Also
1635
system services firewall policy modify

Modify a firewall policy entry for a network service
level.
Description
The system services firewall modify command enables you to modify the list
of IP addresses and netmasks associated with a firewall policy.
Parameters
Use this parameter to specify the Vserver of the policy to modify.
Use this parameter to specify the name of the policy to modify.
Use this parameter to specify the policy's network service to modify.
[-allow-list <IP Address/Mask>, ...] - Allowed IPs
Use this parameter to specify one or more IP addresses with corresponding netmasks
that are allowed by this firewall policy. The correct format for this parameter is address/
netmask, similar to "192.0.2.128/25". Multiple address/netmask pairs should be
separated with commas. Use the value 0.0.0.0/0 for "any".
Examples
The following example modifies the firewall policy named data that uses the SSH
protocol to enable access from all addresses on the 192.0.2.128 subnet:
cluster1::> system services firewall policy modify -policy data -service ssh allow-list 192.0.2.128/25
See Also
system services firewall modify
1636
system services firewall policy show

Show firewall policies
Description
The system services firewall policy show command displays information
about firewall policies.
Parameters
| [-instance ] }
Use this parameter to display all the fields for the specified policies.
Use this parameter to display information only about the Vserver you specify.
[-policy <textpolicy_name>] - Policy
Use this parameter to display information about the policy you specify.
[-service <service>] - Service
Use this parameter to display information about the services you specify.
[-allow-list <IP Address/Mask>, ...] - Allowed IPs
Use this parameter to display information about the firewall policies that match the list of
allowed IP addresses and netmasks you specify. The correct format for this parameter is
address/netmask, similar to "192.0.2.128/25". Multiple address/netmask pairs should be
separated with commas.
[-ipspace <text>] - IPspace
Use this parameter to display information only about the IPspace you specify.
Examples
The following example displays information about all firewall policies:
1637
cluster1::> system services firewall policy show

Vserver Policy
Service
Allowed
------- ------------ ---------- ------------------cluster1

data
dns
0.0.0.0/0, ::/0
ndmp
0.0.0.0/0, ::/0
ndmps
0.0.0.0/0, ::/0
ndmp
0.0.0.0/0, ::/0
ndmps
0.0.0.0/0, ::/0
dns
0.0.0.0/0, ::/0
http
0.0.0.0/0, ::/0
https
0.0.0.0/0, ::/0
ndmp
0.0.0.0/0, ::/0
ndmps
0.0.0.0/0, ::/0
ntp
0.0.0.0/0, ::/0
snmp
0.0.0.0/0, ::/0
ssh
0.0.0.0/0, ::/0
cluster1
intercluster
cluster1
mgmt
1638
system services manager install show

Display a list of installed services
level.
Description
The system services manager install show command displays information
about installed services.
Parameters
specify.
| [-instance ] }
about all fields.
[-service <text>] - Service
Selects information about installed services that have the name you specify.
[-version <service version>] - Version
Selects information about installed services that have the version number you specify.
[-constituent <text>] - Constituent
Selects information about installed services that have the constituent process you
specify.
[-nodes {<nodename>|local}, ...] - Nodes
Selects information about services that are installed on the nodes you specify.
Selects information about installed services that match the description you specify.
Examples
The following example shows typical output from a two-node cluster.
1639
cluster1::> system services manager install show

Service
Version Constituent Nodes
----------------- ------- ----------- --------------------------------------diagnosis

1.0
schmd
node1, node2
1.0
shmd
node1, node2
1640
system services manager policy add

Add a new service policy
level.
Description
The system services manager policy add command adds a new service policy
to the services manager. Policies determine which versions of a service can run on the
nodes of the cluster.
Parameters
-service <text> - Service
Use this parameter to specify the name of the service for which to add a policy.
-version <service version> - Version
Use this parameter to specify the minimum version number of the service to run.
Examples
This example adds a service manager policy for version 1.0 of the diagnosis service.
cluster1::> system services manager policy add -service diagnosis -version 1.0
system services manager policy remove

Remove a service policy
level.
Description
The system services manager policy remove command removes a policy from
the services manager. Policies determine which versions of a service can run on the
nodes of the cluster.
1641
Parameters
Use this parameter to specify the name of the service from which to remove a policy.
Use this parameter to specify the version number that is configured by the policy to
remove.
Examples
The following example shows the removal of the service policy for version 1.0 of the
diagnosis service.
cluster1::> system services manager policy remove -service diagnosis -version 1.0
system services manager policy setstate

Enable/disable a service policy
level.
Description
The system services manager policy setstate command enables or disables
services manager policies. Use the system services manager policy show
command to display information about configured policies.
Parameters
Use this parameter to set the state of the policy you specify.
Use this parameter to set the state of the policy with the version number you specify.
-state {on|off} - State
Use this parameter with the value "on" to enable the policy. Use this parameter with the
value "off" to disable the policy.
1642
Examples
The following example sets the policy for version 1.0 of the diagnosis service to off.
cluster1::> system services manager policy setstate -service diagnosis -version
1.0 -state off
See Also
system services manager policy show
1643

Display service policies
level.
Description
The system services manager policy show command displays information
about policies that determine which versions of a service can run on the nodes of the
cluster.
Use the system services manager status show command to view information
about services that are configured to run in the cluster.
Parameters
specify.
| [-instance ] }
about all fields.
Selects policies that apply to the service you specify.
Selects policies that have the version number you specify.
Selects policies that have the constituent process you specify.
[-state {on|off}] - State
Use this parameter with the value "on" to select information about policies that are
currently active. Use this parameter with the value "off" to select information about
policies that are not currently active.
[-num-active <integer>] - Number Active
1644
Selects policies that have the number of active (running) instances you specify.
[-target-nodes <service affinity>, ...] - Target Nodes
Selects policies that are configured to run on the nodes you specify.
[-tag <UUID>] - Tag (privilege: advanced)
Selects policies that have the UUID you specify. Use this parameter with the -fields
parameter to display a list of the UUIDs of configured services.
Examples
cluster1::> system services manager policy show
Service
Version State Constituent Number Target

Active Nodes
----------------- ------- ----- ----------- ------ -------------------------diagnosis

1.0
on
schmd
any
1.0
on
shmd
any
See Also
system services manager status show
1645
system services manager status show

Display the status of a service
level.
Description
The system services manager status show command displays the status of
system services that are configured to run in the cluster.
System services run on the nodes of the cluster based on policies. Policies determine
which versions of a service can run on the nodes of the cluster. Use the system
services manager policy show command to view existing policies.
Parameters
specify.
| [-instance ] }
about all fields.
Selects information about services that match the service name you specify.
Selects information about services that are configured to run the version number you
specify. The configured version is the minimum version that is allowed to run in the
cluster according to a policy. Use the system services manager policy show
command to view information about service policies.
Selects information about services that have the constituent process you specify.
[-actual-version <service version>] - Actual Version
1646
Selects information about services that are running the version number you specify. This
number can be higher than the configured version if a more recent version is installed
on the node that is running the service.
Selects information about services that the services manager has assigned to run on
the nodes you specify. If the service state is "running", the service is running on these
nodes.
[-state <svc_state>] - State
Selects information about services that are in the state you specify.
[-is-running {true|false}] - Is Running
Use this parameter with the value "true" to select information about services that are
currently running. Use this parameter with the value "false" to select information about
services that are not currently running.
Examples
The example below shows typical output for a simple cluster.
cluster1::> system services manager status show
Service
Version Constituent Actual
Node
State
Version
----------------- ------- ----------- ------- ---------------- -------------diagnosis
1.0
schmd
1.0
cluster1-01
running
1.0
shmd
1.0
cluster1-01
running
See Also
1647
system services ndmp kill-all

(DEPRECATED)-Kill all NDMP sessions
level.
Description
Note:
This node-scoped NDMP command is deprecated. Node-scoped NDMP functionality
may be removed in a future release of Data ONTAP. Use the Vserver-aware "vserver
services ndmp kill-all" command.
The system services ndmp kill-all command is used to terminate all NDMP
sessions on a particular node in the cluster. This command is not supported on Infinite
Volumes.
Parameters
Node on which all NDMP sessions needs to be terminated.
Examples
The following example shows how all NDMP sessions on the node named node1 can be
terminated:
cluster1::> system services ndmp kill-all -node node1
See Also
vserver services ndmp kill-all
1648
system services ndmp kill

(DEPRECATED)-Kill the specified NDMP session
level.
Description
Note:
services ndmp kill" command.
The system services ndmp kill command is used to terminate a specific NDMP
session on a particular node in the cluster. This command is not supported on Infinite
Volumes.
Parameters
Name of the node on which NDMP session needs to be terminated.
<integer> - Session Identifier
Session ID of the NDMP session.
Examples
The following example shows how a specific NDMP session on the node named node1
can be terminated:
cluster1::> system services ndmp kill 4323 -node node1
See Also
system services ndmp killsession vserver services ndmp kill
1649
system services ndmp modify

Modify NDMP service configuration
level.
Description
Note:
Node-scoped NDMP functionality in this command may be removed in a future release
of Data ONTAP (see below). For Vserver-aware functionality, use the "vserver
services ndmp modify" command.
The system services ndmp modify command allows you to modify the NDMP
configurations for a node in the cluster. One or more of the following configurations can
be modified:
Enable/disable NDMP service
Enable/disable sending the NDMP password in clear text. Note that MD5
authentication mode is always enabled.
NDMP user ID
This command is not supported on Infinite Volumes.
Parameters
This specifies the node whose NDMP configuration is to be modified.
[-enable {true|false}] - (DEPRECATED)-NDMP Service Enabled
Note:
This node-scoped NDMP functionality may be removed in a future release of Data
ONTAP.
This optionally specifies whether NDMP is enabled on the node. The default setting is
true.
[-clear-text {true|false}] - (DEPRECATED)-Allow Clear Text Password
1650
Note:
ONTAP.
This optionally specifies whether the NDMP password can be sent in clear text. The
default setting is true.
[-user-id <text>] - (DEPRECATED)-NDMP User ID
Note:
ONTAP.
This optionally specifies the ID of the NDMP user.
[-common-sessions <integer>] - NDMP Common Sessions (privilege: advanced)
This optional parameter specifies the number of extra common NDMP sessions
supported, in addition to the number of backup and restore sessions supported for a
platform. The default value is 4 for all platforms. The number of backup and restore
sessions are platform dependent.
Warning: Increasing this parameter can make the storage system unresponsive.
Examples
The following example modifies the NDMP configuration on a node named node1. The
configuration enables NDMP, disables sending the password in clear text, and specifies
an NDMP user named ndmp:
cluster1::> system services ndmp modify -node node1 -enable true
-clear-text false -user-id ndmp
See Also
vserver services ndmp modify
1651
system services ndmp off

(DEPRECATED)-Disable NDMP service
level.
Description
Note:
services ndmp off" command.
The system services ndmp off command is used to disable the NDMP service on
any node in the cluster. This command is not supported on Infinite Volumes.
Parameters
The specific node on which NDMP service is to be disabled.
true.
This optionally specifies whether the NDMP password can be sent in clear text.
1652
Examples
The following example is used to turn off the NDMP service on node named node1:
cluster1::> system services ndmp off -node node1
See Also
system services ndmp modify vserver services ndmp off
1653
system services ndmp on

(DEPRECATED)-Enable NDMP service
level.
Description
Note:
services ndmp on" command.
The system services ndmp on command is used to enable the NDMP service
across any node in the cluster. This command is not supported on Infinite Volumes.
Parameters
The specific node on which the NDMP service is to be enabled.
true.
This optionally specifies whether the NDMP password can be sent in clear text.
1654
Examples
The following example is used to turn on the NDMP service on node named node1:
cluster1::> system services ndmp on -node node1
See Also
system services ndmp modify vserver services ndmp on
1655
system services ndmp password

(DEPRECATED)-Change the NDMP password for the node
level.
Description
Note:
services ndmp generate-password" command.
The system services ndmp password command is used to change the NDMP
password for a node in the cluster. This command is not supported on Infinite Volumes.
Parameters
The specific node for which the password is to be changed.
Examples
The following example is used to change the NDMP password for the node named
node1:
cluster1::> system services ndmp password -node node1
Please enter password:
Confirm password:
See Also
vserver services ndmp generate-password
1656
system services ndmp probe

(DEPRECATED)-Display list of NDMP sessions
level.
Description
Note:
services ndmp probe" command.
The system services ndmp probe command displays diagnostic information about
all the NDMP sessions in the cluster. The following fields are displayed for each of the
sessions:
Node
Session identifier
NDMP version
Session authorized
Data state
Data operation
Data server halt reason
Data server connect type
Data server connect address
Data server connect port
Data bytes processed
Mover state
Mover mode
Mover pause reason
Mover halt reason
1657
Mover record size

Mover record number
Mover bytes moved
Mover seek position
Mover bytes left to read
Mover window offset
Mover window length
Mover position
Mover SetRecordSize flag
Mover SetWindow flag
Mover connect type
Mover connect address
Mover connect port
Effective host
NDMP client address
NDMP client port
SCSI device ID
SCSI hostadapter
SCSI target ID
SCSI LUN ID
Tape device
Tape mode
Is Secure Control Connection
Data Backup Mode
Data Path
NDMP Source Address
1658
Parameters
If this parameter is specified, the command displays information about the sessions
running on the specified node only. Node should be a valid node name.
-session-id <integer> - Session Identifier
If this parameter is specified, the command displays information only about the specified
session.
Examples
The following example displays diagnostic information about all the sessions in the
cluster:
cluster1::> system services ndmp probe
Node: cluster1-01
Session identifier: 4952
NDMP version: 4
Session authorized: true
Data state: IDLE
Data operation: NOACTION
Data server halt reason: NA
Data server connect type: LOCAL
....
...
Node: cluster1-02
NDMP version: 4
Data state: IDLE
....
...
1659
The following example displays diagnostic information of sessions running on the node
cluster1-01 only:
cluster1::> system services ndmp probe -node cluster1-01
Node: cluster1-01
NDMP version: 4
Data state: IDLE
....
...
See Also
system services ndmp status vserver services ndmp probe
1660
system services ndmp show

Display NDMP service configuration
level.
Description
Note:
Node-scoped NDMP functionality in this command may be removed in a future release
of Data ONTAP (see below). For Vserver-aware functionality, use the "vserver
services ndmp show" command.
The system services ndmp show command displays the following information
about the NDMP configuration across all the nodes in the cluster:
Node name
Whether NDMP is enabled on the node
Whether sending the NDMP password in clear text is enabled on the node
NDMP user ID
A combination of parameters can be optionally supplied to filter the results based on
specific criteria. This command is not supported on Infinite Volumes.
Parameters
If this parameter is specified, the command displays only the fields that you specify.
| [-instance ] }
If this parameter is specified, the command displays detailed information about all
entries.
Selects information about the specified node.
Note:
1661

ONTAP.
Selects information about the nodes where NDMP is enabled/disabled.
Note:
ONTAP.
Selects information about the nodes whose clear-text setting matches the specified
value.
Note:
ONTAP.
Selects information about the nodes that have the specified NDMP user ID.
Selects information about the nodes that have the specified number of NDMP common
sessions.
Examples
The following example displays information about the NDMP configuration of all nodes
in the cluster:
cluster1::> system services ndmp show
Node
Enabled
Clear text
User Id
----------- --------- ----------- ------node0
true
true
ndmp
node1
true
true
ndmp
node2
true
true
ndmp
node3
true
true
ndmp
See Also
1662
vserver services ndmp show
1663
system services ndmp start

Start the NDMP service
privilege level.
Description
The system services ndmp start command starts the NDMP service daemon
for a node. This is different from the system services ndmp on command. The
system services ndmp on command enables the daemon to accept NDMP
requests. The NDMP service daemon starts automatically on a node when it boots up.
Use this command to start the NDMP service daemon that has been stopped by the
system services ndmp stop command. This command is not supported on Infinite
Volumes.
Parameters
The node on which the NDMP service needs to be started.
Examples
cluster1::*> system services ndmp start -node node0
Starts the NDMP service on node0.
See Also
system services ndmp on system services ndmp stop
1664
system services ndmp status

(DEPRECATED)-Display list of NDMP sessions
level.
Description
Note:
services ndmp status" command.
The system services ndmp status command lists all the NDMP sessions in the
cluster. By default it lists the following details about the active sessions:
Node
Session ID
A combination of parameters can be optionally supplied so as to list only those sessions
which match specific conditions. A short description of each of the parameter is provided
in the parameters section. This command is not supported on Infinite Volumes.
Parameters
This optional parameter specifies which all additional fields to display. Any combination
of the following fields are valid:
ndmp-version
session-authorized
data-state
data-operation
data-halt-reason
data-con-addr-type
data-con-addr
1665
data-con-port
data-bytes-processed
mover-state
mover-mode
mover-pause-reason
mover-halt-reason
mover-record-size
mover-record-num
mover-bytes-moved
mover-seek-position
mover-bytes-left-to-read
mover-window-offset
mover-window-length
mover-position
mover-setrecordsize-flag
mover-setwindow-flag
mover-con-addr-type
mover-con-addr
mover-con-port
eff-host
client-addr
client-port
spt-device-id
spt-ha
spt-scsi-id
spt-scsi-lun
tape-device
tape-modes
1666
is-secure-control-connection
data-backup-mode
data-path
source-addr
| [-instance ] }
If this parameter is specified, the command displays detailed information about all the
active sessions.
[-session-id <integer>] - Session Identifier
If this parameter is specified, the command displays information about specific NDMP
session. A session-id is a number used to identify a particular NDMP session.
[-ndmp-version <integer>] - NDMP Version
This parameter refers to the NDMP protocol version being used in the session.
[-session-authorized {true|false}] - Session Authorized
This field indicates whether an NDMP session is authenticated or not.
[-data-state <component state>] - Data State
This field identifies the current state of the data server's state machine.
[-data-operation <data operation>] - Data Operation
This field identifies the data server's current operation.
[-data-halt-reason <halt reason>] - Data Server Halt Reason
This field identifies the event that caused the data server state machine to enter the
HALTED state.
[-data-con-addr-type <address type>] - Data Server Connect Type
This field specifies the type of data connection established by the data server. The
data connection can be established locally within a given system or between remote
networked systems.
[-data-con-addr <text>] - Data Server Connect Address
This specifies the connection endpoint information for the data server's data connection.
1667
[-data-con-port <integer>] - Data Server Connect Port

This specifies the TCP/IP port that the data server will use when establishing a data
connection.
[-data-bytes-processed <integer>] - Data Bytes Processed
This field represents the cumulative number of data stream bytes transferred between
the backup or recovery method and the data connection during the current data
operation.
[-mover-state <component state>] - Mover State
This parameter identifies the current state of the NDMP tape server's mover state
machine.
[-mover-mode <mover mode>] - Mover Mode
This parameter identifies the direction of the mover data transfer.
[-mover-pause-reason <pause reason>] - Mover Pause Reason
This parameter identifies the event that caused the mover state machine to enter the
PAUSED state.
[-mover-halt-reason <halt reason>] - Mover Halt Reason
This integer field identifies the event that caused the mover state machine to enter the
HALTED state.
[-mover-record-size <integer>] - Mover Record Size
This field represents the current mover record size in bytes.
[-mover-record-num <integer>] - Mover Record Number
This field represents the last tape record processed by the mover.
[-mover-bytes-moved <integer>] - Mover Bytes Moved
This field represents the cumulative number of data stream bytes written to the data
connection or the number of data stream bytes read from the data connection and
written to the tape subsystem, depending on the mode of mover operation.
[-mover-seek-position <integer>] - Mover Seek Position
This field represents the data stream offset of the first byte the DMA requested the
mover to transfer to the data connection during a mover read operation.
[-mover-bytes-left-to-read <integer>] - Mover Bytes Left to Read
This field represents the number of data bytes remaining to be transferred to the data
connection to satisfy the current NDMP_MOVER_READ request.
1668
[-mover-window-offset <integer>] - Mover Window Offset

This field represents the absolute offset of the first byte of the mover window within the
overall data stream.
[-mover-window-length <integer>] - Mover Window Length
This field represents the length of the current mover window in bytes.
[-mover-position <integer>] - Mover Position
This parameter can be used to list only those sessions, whose mover position matches
a specific value. Mover-position should be an integer.
[-mover-setrecordsize-flag {true|false}] - Mover SetRecordSize Flag
This field is used by the DMA to establish the record size used for mover-initiated tape
read and write operations.
[-mover-setwindow-flag {true|false}] - Mover SetWindow Flag
This flag represents whether a mover window has been set or not. A mover window
represents the portion of the overall backup stream that is accessible to the mover
without intervening DMA tape manipulation.
[-mover-con-addr-type <address type>] - Mover Connect Type
This field specifies the type of data connection established by the mover. The data
connection can be established locally within a given system or between remote
networked systems.
[-mover-con-addr <text>] - Mover Connect Address
This specifies the endpoint address or addresses that the mover will use when
establishing a data connection.
[-mover-con-port <integer>] - Mover Connect Port
This specifies the TCP/IP port that the mover will use when establishing a data
connection.
[-eff-host <host type>] - Effective Host
This field indicates the host context in which the NDMP session runs. The valid values
are: PRIMARY or PARTNER.
[-client-addr <text>] - NDMP Client Address
This parameter specifies the client's IP address.
[-client-port <integer>] - NDMP Client Port
This parameter specifies the client's port number.
1669
[-spt-device-id <text>] - SCSI Device ID

This parameter specifies the SCSI device ID.
[-spt-ha <integer>] - SCSI Host Adapter
This parameter specifies the SCSI host adapter.
[-spt-scsi-id <integer>] - SCSI Target ID
This parameter specifies the SCSI target.
[-spt-scsi-lun <integer>] - SCSI LUN ID
This parameter specifies the SCSI LUN ID.
[-tape-device <text>] - Tape Device
This parameter specifies the name to identify the tape device.
[-tape-mode <mover mode>] - Tape Mode
This parameter specifies the mode in which tapes are opened.
[-is-secure-control-connection {true|false}] - Is Secure Control Connection
This parameter specifies whether the control connection is secure or not.
[-data-backup-mode <text>] - Data Backup Mode
This parameter specifies whether the mode of data backup is Dump or SMTape.
[-data-path <text>] - Data Path
This parameter specifies the path of data being backed up.
[-source-addr <text>] - NDMP Source Address
This parameter specifies the control connection IP address of the NDMP session.
Examples
The following example displays all the NDMP sessions on the cluster:
cluster1::> system services ndmp status
Session
Node
Id
--------------
--------
node-01
17479
node-01
19769
node-02
21118
1670
The following example shows how to display only the sessions running on node-01:
cluster1::> system services ndmp status -node node-01
Session
Node
Id
--------------
--------
node-01
17479
node-01
19769
See Also
vserver services ndmp status
1671
system services ndmp stop

Stop the NDMP service
privilege level.
Description
The system services ndmp stop command stops the NDMP service daemon
on a node. This is a disruptive command and should not be used in normal scenarios.
Processing of active sessions continues but the ability to view or kill sessions is lost.
This is different from the system services ndmp off command. The system
services ndmp off command disables new NDMP connections on the node but
does not stop the NDMP service daemon. This command is not supported on Infinite
Volumes.
Parameters
The node on which the NDMP service needs to be stopped.
Examples
cluster1::*> system services ndmp stop -node node0
Stops the NDMP service on node0.
See Also
system services ndmp off system services ndmp start
1672
system services ndmp terminate

Terminate all NDMP sessions
privilege level.
Description
The system services ndmp terminate command terminates all active sessions
on the node. This command forcefully terminates all NDMP sessions without an
opportunity for a graceful shutdown. Use system services ndmp kill-all for a
clean termination of all active sessions on a node. This command is not supported on
Infinite Volumes.
Parameters
The node on which the NDMP sessions need to be terminated
Examples
cluster1::*> system services ndmp terminate -node node0
Terminates all active NDMP sessions on node0.
See Also
system services ndmp kill-all
1673
system services ndmp log start

(DEPRECATED)-Start logging for the specified NDMP session
privilege level.
Description
Note:
services ndmp log start" command.
This command is used to start logging on an active NDMP session on a node. You can
start logging two different kinds of sessions. The NDMP server session manages all
NDMP tasks on the node. If you want to log information regarding the NDMP server,
use server with the -session-id parameter to enable logging. If you want to log
information about a particular NDMP session, for example a restore operation, then
determine the session ID for the session using the "system services ndmp status"
command and use that ID with the -session-id parameter to enable logging.
Parameters
This parameter specifies the node.
-session-id {<integer>|server} - Session Identifier
This parameter specifies the NDMP session-id on which logging needs to be started.
The session-id is associated with a unique NDMP session. Specify server to start
logging on the NDMP server session.
-filter <text> - Level Filter
Use this parameter to specify the filter for a particular session ID. This parameter
controls the NDMP modules for which logging is to be enabled. This parameter can take
five values. They are as follow : all, none, normal, backend or "filter-expression". The
default value for this is none.
all turns on logging for all modules.
none disables logging for all modules.
1674
normal is a short cut parameter that enables logging for all modules except
verbose and io_loop. The equivalent filter string is all-verbose-io_loop
backend is a short cut parameter that enables logging for all modules except
verbose, io_loop, ndmps and ndmpd. The equivalent filter string is all-verboseio_loop-ndmps-ndmpp
(filter-expression) is a combination of one or more modules for which logs
needs to be enabled. Multiple module names can be combined using following
operators :
- to remove the given module from the list of specified modules in the filter
string. For example the filter all-ndmpp will enable logging for all modules
but not ndmpp.
^ to add the given module or modules to the list of modules specified in the
filter string. For example the filter ndmpp^mover^data will enable logging for
ndmpp, mover and data.
The possible module names and a brief description is given below:
+---------------------------------------------------+
| Modules
Description
|
+---------------------------------------------------+
| verbose
| verbose message
| io
| I/O process loop
| io_loop
| I/O process loop verbose
| ndmps
| NDMP service
| ndmpp
| NDMP Protocol
| rpc
| General RPC service
| fdc_rpc
| RPC to FC driver service
| auth
| Authentication
| mover
| NDMP MOVER (tape I/O)
| data
| NDMP DATA (backup/
| scsi
| NDMP SCSI (robot/tape
|
|
messages
|
|
|
|
|
|
|
restore)
ops)
1675
client
server
cleaner
| bkup_rpc
| RPC to Backup service
| bkup_rpc_s
| cleaner
| Backup/Mover session
| conf
| Debug configure/
| dblade
| Dblade specific messages
| timer
| NDMP server timeout
| vldb
| VLDB service
| smf
| SMF Gateway messages
| vol
| VOL OPS service
| sv
| SnapVault NDMP extension
| common
| NDMP common state
| ext
| NDMP extensions messages
| sm
| SnapMirror NDMP extension
| ndmprpc
| NDMP Mhost RPC server
reconfigure
|
messages
|
|
|
|
|
|
|
|
|
+---------------------------------------------------+
Examples
The following example shows how to start logging on a specific NDMP session 33522,
running on the node cluster1-01 with filter normal.
cluster1::*> system services ndmp log start -node
cluster1-01 -session-id 33522 -filter normal
The following example shows how to start logging on the NDMP server session, on the
node cluster1-01 with filter all.
cluster1::*> system services ndmp log start -session-id
server -filter all -node cluster1-01
See Also
1676
vserver services ndmp log start
1677
system services ndmp log stop

(DEPRECATED)-Stop logging for the specified NDMP session
privilege level.
Description
Note:
services ndmp log stop" command.
This command is used to stop logging on an active NDMP session on a node. The
NDMP server session manages all NDMP tasks on the node. If you want to stop logging
information regarding the NDMP server, use server with the -session-id parameter
to disable logging. If you want to stop logging information about a particular NDMP
session, for example a restore operation, then determine the session ID for the session
using the "system services ndmp status" command and use that ID with the -sessionid parameter to disable logging.
Parameters
This parameter specifies the node.
-session-id {<integer>|server} - Session Identifier
This parameter specifies the NDMP session-id on which logging needs to be stopped.
The session-id is associated with a unique NDMP session. Specify server to stop
logging on the NDMP server session.
Examples
The following example shows how to stop logging on a specific NDMP session 35512,
running on node cluster1-01.
cluster1::*> system services ndmp log stop -session-id
35512 -node cluster1-01
1678
The following example shows how to stop logging on the NDMP server session, running
on node cluster1-01.
cluster1::*> system services ndmp log stop -session-id server node cluster1-01
See Also
vserver services ndmp log stop
1679
system services ndmp node-scope-mode off

(DEPRECATED)-Disable NDMP node-scope-mode
level.
Description
Note:
services ndmp" command.
This command puts NDMP server in Vserver-aware mode. The Vserver-aware
commands are available under vserver services ndmp.
Parameters
None
Examples
The following example shows how to disable the node-scope-mode of NDMP server.
cluster1::> system services ndmp node-scope-mode off
NDMP node-scope-mode is disabled.
See Also
vserver services ndmp
1680
system services ndmp node-scope-mode on

(DEPRECATED)-Enable NDMP node-scope-mode
level.
Description
Note:
This command puts the NDMP server in the node-scope-mode. In the node-scopemode, NDMP server has the following behavior:
All NDMP operations are restricted to resources on the node
Vserver-aware NDMP commands are disabled
NDMP authentication falls back to DATA ONTAP 8.1 NDMP authentication
scheme
Parameters
None
Examples
The following example enables node-scope-mode of operation :
cluster1::> system services ndmp node-scope-mode on
NDMP node-scope-mode is enabled.
See Also
1681
system services ndmp node-scope-mode status

(DEPRECATED)-Status of NDMP node-scope-mode
level.
Description
Note:
This command displays whether the NDMP server is operating in node-scope-mode or
not.
NDMP node-scope-mode is disabled - NDMP server is Vserver-aware
NDMP node-scope-mode is enabled - NDMP server is node scoped
Parameters
None
Examples
The following example shows how to check the status of NDMP server in a cluster
cluster1::> system services ndmp node-scope-mode status
NDMP node-scope-mode is disabled.
See Also
1682
system services ntp server create

Add a NTP Server
level.
Description
The system services ntp server create command associates a node with an
NTP server.
Parameters
This specifies the node with which the NTP server is to be associated.
-server <text> - NTP Server Name or IP Address
This specifies the name or IP address of the NTP server that is to be associated with the
specified node.
[-preferred {true|false}] - Preferred NTP Server (privilege: advanced)
This optionally specifies whether the specified NTP server is the preferred NTP server
for the node to use. The default setting is false . This parameter is available only at the
[-version {1|2|3|4|max}] - NTP Version for Server
This optionally specifies the version of NTP that is running on the specified NTP server.
Possible values include 1, 2, 3, 4, and max (for the highest-numbered version currently
available). The default setting is max .
Examples
The following example associates a node named node2 with an NTP server named
ntp1.example.com that is running the highest-numbered version of NTP available.
cluster1::> system services ntp server create -node node2 -server
ntp1.example.com -version max
system services ntp server delete
1683
Delete a NTP Server

level.
Description
The system services ntp server delete command deletes an NTP server from
a specified node's NTP configuration.
Parameters
This specifies the node from which the NTP server is to be deleted.
This specifies the name or IP address of the NTP server that is to be removed from the
node's NTP configuration.
Examples
The following example deletes an NTP server named ntp2.example.com from the NTP
configuration of a node named node3:
cluster1::> system services ntp server delete -node node3 -server
ntp2.example.com
system services ntp server modify

Modify NTP Server Options
level.
Description
The system services ntp server modify command modifies whether an NTP
server is the preferred server for a node, the NTP version associated with an NTP
server, or both.
Parameters
1684
This specifies the node on which the NTP server is to be modified.

This specifies the name or IP address of the NTP server whose version is to be
modified.
This optionally specifies whether the specified NTP server is the preferred NTP server
for the node to use. The default setting is false . This parameter is available only at the
This optionally specifies the version of NTP that is running on the specified NTP server.
Possible values include 1, 2, 3, 4, and max (for the highest-numbered version currently
available). The default setting is max .
Examples
The following example modifies the NTP version associated with an NTP server named
ntp2.example.com used by a node named node3. The NTP version is changed to 4.
cluster1::> system services ntp server modify -node node3 -server
ntp2.example.com -version 4
system services ntp server show

Display a list of NTP Servers
level.
Description
The system services ntp server show command displays the following
information about NTP servers associated with nodes in a cluster:
Node name
NTP server name or IP address
NTP version running on the NTP server
Whether the NTP server is the preferred NTP server for the node (advanced
privilege level or higher only)
1685
Parameters
specify.
| [-instance ] }
about all fields.
Selects information about the specified node; if the parameter is specified with the server parameter, the command displays detailed information about the association
between the specified node and NTP server.
[-server <text>] - NTP Server Name or IP Address
Selects information about nodes that use the specified NTP server; if the parameter is
specified with the -node parameter, the command displays detailed information about
the association between the specified node and NTP server.
Selects information about any node or nodes that have a preferred NTP server. This
parameter is available at the advanced privilege.
Selects information only about the node or nodes associated with an NTP server or
servers that are running the specified version of NTP.
Examples
The following example displays information about all associations between nodes and
NTP servers:
cluster1::> system services ntp show
Node
Server
Version
--------------------------- ----------node0
ntp1.example.com
max
ntp2.example.com
max
ntp1.example.com
max
node1
1686
ntp2.example.com
max
ntp1.example.com
max
ntp2.example.com
max
ntp1.example.com
max
ntp2.example.com
max
node2
node3
1687
system services web modify

Modify the cluster-level configuration of web protocols
level.
Description
This command modifies the overall availability of web services in the cluster, including
the core protocol configurations for those services. In a pre-root or unclustered scenario,
its scope applies to the local node.
Note:
You cannot disable Transport Layer Security (TLS).
Parameters
[-external {true|false}] - External Web Services
Defines whether remote clients can access HTTP or HTTPS service content. Along
with the system services firewall configuration, this parameter controls the
visibility for client connections. The default value for this parameter after installation is
'true', which exports web protocols for remote access. If no value is provided during
modification, its behavior does not change.
[-sslv3-enabled {true|false}] - SSLv3 Enabled
Defines whether the SSL-enabled Vservers in the cluster support Secure Socket Layer
version 3. The default value for this parameter after installation is 'true', which enables
SSLv3.
[-ssl-fips-enabled {true|false}] - SSL FIPS 140-2 Enabled
Defines whether the web server will comply with the Federal Information Processing
Standard (FIPS) 140-2. FIPS 140-2 is a U.S. government security standard that restricts
the protocols and ciphers that can be used with transport layer security. Setting this
parameter to true forces sslv3-enabled to be set to false. The default value for this
parameter is false.
Examples
The following command enables SSL version 3 support:
1688
cluster1::> system services web modify -sslv3-enabled true

Warning: Modifying the cluster configuration will cause pending web service
requests to be interrupted as the web servers are restarted.
See Also
system services firewall
1689
system services web show

Display the cluster-level configuration of web protocols
level.
Description
This command displays the overall availability of web services in the cluster, including
the core protocol configurations for those services. In a pre-root or unclustered scenario,
its output applies to the local node. The following information explains the External
Web Services and Status attributes, two features of web services' availability.
The External Web Services field indicates whether remote clients are allowed
to access the HTTP or HTTPS service content. Along with the system services
firewall configuration, the External Web Services field indicates the visibility for
client connections.
The Status field describes the aggregated operational state of cluster-level web
services as retrieved from the system services web node command. The Status
field does not reflect whether the protocols are externally visible, but whether the server
processes are running correctly. For detailed information about individual servers, use
the system services web node show command. The following are the possible
values for the Status in node configuration or availability:
online, all web services are consistently configured and working correctly.
partial, one or more nodes' web services are unavailable due to an error condition.
mixed, the nodes in the cluster do not share the same web services configuration.
This situation might occur if individual nodes were reconfigured with the system
services web node command.
offline, all of the nodes' web services are unavailable due to an error condition.
unclustered, the current node is not part of an active cluster.
The SSL FIPS 140-2 Enabled field indicates whether or not the web server is in
compliance with FIPS 140-2.
Parameters
None
1690
Examples
The following example displays the availability of web services for the cluster.
cluster1::> system services web show
External Web Services: true
Status: online
HTTP Protocol Port: 80
HTTPs Protocol Port: 443
TLSv1 Enabled: true
SSLv3 Enabled: true
SSL FIPS 140-2 Enabled: false
See Also
system services firewall system services web node system services web node show
1691
system services web node show

Display the status of the web servers at the node level
level.
Description
This command displays operational configuration for the web server processes on the
nodes in the cluster. This output is aggregated to produce the content for the system
services web show command.
Parameters
specify.
| [-instance ] }
about all fields.
Identifies the node where the web server process is being executed.
[-external {true|false}] - External Web Services
Defines whether remote clients can access the HTTP or HTTPs service content. Along
with the system services firewall configuration, this parameter controls the
visibility for client connections. The default value for this parameter after installation is
'true', which exports web protocols for remote access.
[-http-port <integer>] - HTTP Port
Defines the HTTP port for the node-level web services.
[-https-port <integer>] - HTTPs Port
Defines the encrypted HTTP (HTTPs) port for the node-level web services.
[-tlsv1-enabled {true|false}] - TLSv1 Enabled
1692
Defines whether the SSL-enabled services supplied by the node support Transport
Layer Security version 1. You cannot set the value of this parameter to 'false' when
using the system services web node modify command.
[-sslv3-enabled {true|false}] - SSLv3 Enabled
Defines whether SSL-enabled services supplied by the node support Secure Socket
Layer version 3. The default value of this parameter after the node installation is 'true',
which enables SSLv3.
[-ssl-fips-enabled {true|false}] - SSL FIPS 140-2 Enabled
Indicates whether or not the web server will comply with the Federal Information
Processing Standard (FIPS) 140-2. FIPS 140-2 is a U.S. government security standard
that restricts the protocols and ciphers that can be used with transport layer security.
[-status {offline|partial|mixed|online|unclustered}] - Protocol Status
Describes the operational state of node-level web services. This parameter does
not reflect whether protocols are externally visible, but whether the server processes
are running correctly. The following are the possible values that describe the service
availability.
online, indicates that web services are working correctly.
offline, indicates that web services are unavailable due to an error condition.
unclustered, indicates that the current node is not part of an active cluster.
[-total-hits <integer>] - Total HTTP Requests
Indicates the total number of requests serviced by the web server.
[-total-bytes <integer>] - Total Bytes Served
Indicates the total number of bytes returned by the web server.
Examples
The following example displays the status of web servers for nodes in the cluster.
cluster1::system services web node> show
Total
Node
External HTTP Port HTTPs Port Status
Total
HTTP Requests Bytes Served
---------- -------- --------- ---------- -------- ------------- -----------n6070-8
true
80
443 online
3421
n6070-9
true
80
443 online
3421
1693
See Also
system services firewall system services web node modify
system services web show
1694
system smtape abort

Abort an active SMTape session
level.
Description
This command aborts the backup or restore operations based on the session identifier.
You can perform SMTape operations using the system smtape backup or system
smtape restore commands. A unique session identifier is assigned for each new
SMTape operation. This command aborts sessions that are in active and waiting states.
Parameters
-session <Sequence Number> - Session Identifier
Use this parameter to specify the session identifier for a backup or restore session.
Examples
Abort the SMTape session with the session identifier 20
cluster1::> system smtape abort -session 20
Abort posted to session 20.
See Also
system smtape backup system smtape restore
1695
system smtape backup

Backup a volume to tape devices
level.
Description
This command performs a baseline backup of a specified volume path to a tape device.
You can use the command system hardware tape drive show to view the list
of tape devices in the cluster. You must specify a Snapshot copy name to perform an
SMTape backup operation. The Snapshot copy name specified is used as the base
Snapshot copy. A new unique session ID is assigned for this SMTape operation and the
status of the session can be monitored using the command system smtape status.
This session ID can be subsequently used to perform other operations such as to find
the SMTape status, abort an SMTape operation, and continue an SMTape operation.
The volume and tape device must reside on the same node in the cluster. You must
retain the base Snapshot copy created during this backup operation in order to use this
Snapshot copy to re-establish a SnapMirror relationship upon a restore.
Parameters
Use this parameter to specify the Vserver name on which the volume is located. You
need not specify this parameter if only one cluster Vserver exists.
Use this parameter to specify the name of the volume that needs to be backed up to
tape.
-backup-snapshot <snapshot name> - Snapshot Name
Use this parameter to specify the name of the Snapshot copy while performing an
SMTape backup operation.
-tape </node_name/tape_device> - Tape Name
Use this parameter to specify the name of the tape device which is used for this SMTape
operation. The format of the tape device name is /node_name/tape_device, where
node_name is the name of the cluster node owning the tape and tape_device is the
name of the tape device.
1696
[-tape-block-size <integer>] - Tape Record Size in KB

Use this parameter to specify the tape record size in KB for backup and restore
operations. The tape record size is in multiples of 4KB, ranging from 4KB to 256KB. The
default tape record size is 240KB unless it is specified.
Examples
The following example will start the backup of a volume datavol in a Vserver vserver0
to a tape rst0a. Both the volume and tape reside on the same node cluster1-01. The
Snapshot copy to be backed up is datavol_snapshot and the tape record size has the
value of 256KB.
cluster1::> system smtape backup -vserver vserver0 -volume datavol
-backup-snapshot datavol_snapshot -tape /cluster1-01/rst0a
-tape-block-size 256
Session 21 created successfully
The following example will start the backup of a volume datavol in a Vserver vserver0
to a tape rst0a. The volume datavol is in a Vserver vserver0. Both the volume and
tape reside on the same node cluster1-01. The Snapshot copy to be backed up is
datavol_snapshot and the tape record size has the default value of 240KB.
cluster1::> system smtape backup -vserver vserver0 -volume datavol
-backup-snapshot datavol_snapshot -tape /cluster1-01/nrst0l
See Also
system hardware tape drive show system smtape status system smtape restore
system smtape status show system smtape continue system smtape abort
1697
system smtape break

Make a restored volume read-write
Description
This command breaks the relationship between the tape backup of a volume and a
restored volume, changing the restored volume from read-only to read/write.
Parameters
Use this parameter to specify the name of the read-only volume that needs to be made
read/writeable after a restore.
Examples
Make the read-only volume datavol on Vserver vserver0 writeable after a restore.
cluster1::> system smtape break -vserver vserver0 -volume datavol
[Job 84] Job succeeded: SnapMirror Break Succeeded
See Also
1698
system smtape continue

Continue SMTape session waiting at the end of tape
level.
Description
This command continues the SMTape backup and restore operations using the specified
tape device. You can use this command when an SMTape operation has reached the
end of current tape and is in the wait state to write to or read from a new tape.
If a tape device is not specified, the original tape device will be used.
User has to make sure that the correct tape media is inserted in the device and
positioned appropriately before issuing this command.
Parameters
[-tape </node_name/tape_device>] - Tape Name
-session <Sequence Number> - Session Identifier
Use this parameter to specify the session identifier for the SMTape backup or restore
operations.
Examples
Continues an SMTape session having session ID 20 on tape device rst0a on the node
node1 in the cluster.
cluster1::> system smtape continue -session 20 -tape /node1/rst0a
continue on session 20 succeeded
The following example continues session 40 on the same tape device that was being
used by the session.
cluster1::> system smtape continue -session 40
1699
continue on session 40 succeeded
system smtape restore

Restore a volume from tape devices
level.
Description
This command performs restore of a backup image created using the command
system smtape backup in the specified tape device to a destination volume path. A
new unique session ID is assigned for this operation; the status of the session can be
monitored using the command system smtape status. It is required that the volume
and tape device reside in the same cluster node. The volume must be of type DP (Data
Protection) and should be placed in the restricted mode prior to a restore.
Any existing data on the volume will get overwritten upon a restore. The volume will
remain as read-only and of type DP after the restore. You can use the command
system smtape break to get read/write permissions on the volume. Restore to an
Infinite Volume is not supported. Restore can be done to a non-root DP volume.
Parameters
Use this parameter to specify the volume name on which the tape content will be
restored.
default tape record size is 240KB unless it is specified. Use the same record size which
1700
was used during the backup. If the tape record size is different from the tape record size
that was used at the time of backup then system smtape restore will fail.
Examples
The following example will start the restore to a volume datavol from a tape rst0a. The
volume datavol is in a Vserver vserver0. Both vserver0 and rst0a reside on the same
node cluster1-01.
cluster1::> system smtape restore -vserver vserver0 -volume datavol
-tape /cluster1-01/rst0a -tape-block-size 256
The following example will start the restore to a volume datavol from a tape rst0a. The
volume datavol is in a Vserver vserver0. Both vserver0 and rst0a reside on the same
node cluster1-01. The default tape record size of 240KB was used during backup.
cluster1::> system smtape restore -vserver vserver0 -volume datavol
-tape /cluster1-01/rst0a
See Also
system smtape backup system smtape status system smtape break
system smtape status show system smtape continue
1701
system smtape showheader

Display SMTape header
level.
Description
This command displays the image header of a tape. The tape must have a valid backup
of data. The following information about the backup is displayed:
Tape Number - the tape number if the backup spans multiple tape devices.
WAFL Version - WAFL version of the storage system when the volume was
backed up on tape.
Backup Set ID - a unique backup set ID for the baseline backup.
Source Storage System - the source storage system where the volume resided
when the backup was performed.
Source Volume - the source volume that was backed up to tape.
Source Volume Capacity - the capacity of the source volume that was backed up
to tape.
Source Volume Used Size - the used size of the source volume that was backed
up to tape.
Source Snapshot - name of the Snapshot copy used for the backup.
Volume Type - type of the volume.
Is SIS Volume - this field is true if the backed up volume was a SIS volume.
Backup Version - the SMTape backup version.
Backup Sequence No - the backup sequence number.
Backup Mode - this field describes the backup mode.
Time of Backup - the time at which the backup was performed.
Time of Previous Backup - the time at which the previous backup was performed;
this information is displayed only if the previous backup was an incremental
backup.
Volume Total Inodes - number of inodes of the backed up volume.
1702
Volume Used Inodes - number of used inodes of the backed up volume.

Number of Snapshots - number of Snapshot copies present in this backup.
Snapshot ID - is the Snapshot ID of the backup Snapshot.
Snapshot Time - time at which the backup Snapshot copy was created.
Snapshot Name - name of the Snapshot copy which was backed up to tape.
Parameters
default tape record size is 240KB unless it is specified.
Examples
The following example reads the image header from the tape nrst0l residing on the node
cluster1-01 and displays relevant tape header information.
cluster1::> system smtape showheader -tape /cluster1-01/nrst0l
-tape-block-size 240
Tape record size in KB: 240
Tape Number: 1
WAFL Version: 23577
Backup Set ID: 7d0c9a15-8e20-11e1-8741-123478563412
Source Storage System: cluster1-01
Source Volume: /vs1/srcvol
Source Volume Capacity: 400.00MB
Source Volume Used Size: 0.00
Source Snapshot: mysnap
Volume Type: Flex
Is SISVolume: no
Backup Version: 1:3
1703
Backup Sequence No: 0

Backup Mode: dw-data
Time of Backup: 4/24/2012 15:16:38
Time of Previous Backup: 0/0/0 00:00:00
Volume Total Inodes: 12789
Volume Used Inodes: 100
Number of Snapshots: 1
Snapshot ID: 1
Snapshot Time: 4/24/2012 15:16:10
Snapshot Name: mysnap
See Also
1704
system smtape status clear

Clear SMTape sessions
level.
Description
This command clears SMTape sessions which are completed, failed or Unknown state.
Parameters
[-session <Sequence Number>] - Session Identifier
Use this parameter to clear the SMTape sessions with the specified session identifier.
Use this parameter to clear the SMtape sessions related to the specified node.
[-type {backup|restore}] - Operation Type
Use this parameter to clear the SMTape sessions of the specified operation type. These
can be either backup or restore sessions.
[-status {COMPLETED|FAILED|UNKNOWN}] - Session Status
Use this parameter to clear the SMTape sessions which have the status as specified in
the parameter.
[-path <text>] - Path Name
Use this parameter to clear the SMTape sessions which have path as specified in the
parameter.
Use this parameter to clear the SMTape sessions on a specific tape device.
[-backup-snapshot <snapshot name>] - Snapshot Name
Use this parameter to clear the SMTape sessions using the Snapshot copy name as
specified in the parameter.
[-tape-block-size <integer>] - Tape Block Size
Use this parameter to clear the SMTape sessions with the tape block size as specified in
the parameter.
1705
Examples
The following example clears all the completed SMTape sessions in the cluster:
cluster1::> system smtape status clear
5 sessions are purged.
The SMTape sessions on the node node1 in the cluster are cleared.
cluster1::> system smtape status clear -node node1
3 sessions are purged.
system smtape status show

Show status of SMTape sessions
level.
Description
This command lists the status of all SMTape sessions in the cluster. By default, this
command lists the following information:
Session
Type
Status
Progress
Path
Device
Node
Parameters
1706
Use this parameter to display additional fields about each session apart from the default
entries. This parameter is optional. Any combination of the following fields is valid:
Session
Node
Type
Status
Path
Device
Progress
Start-time
End-time
Update-time
Backup-snapshot
Tape-block-size
Error
| [-instance ] }
Displays detailed information about the specified sessions.
[-session <Sequence Number>] - Session Identifier
Selects information about a specific SMTape session. A Session Identifier is a number
that is used to identify a particular SMTape session.
Selects information about sessions related to the specified node.
[-type {backup|restore}] - Operation Type
Selectsinformation about SMTape sessions of the specified operation type.
[-status {COMPLETED|FAILED|ACTIVE|WAITING|ABORTING|UNKNOWN}] - Session
Status
Selects information about SMTape sessions having the specified status in the
parameter.
[-path <text>] - Path Name
1707
Selects information about SMTape sessions on a volume which is at the specified path
name. This is the logical path of the volume and you must specify the path name in the
following format: /vserver_name/volume_name.
Selects information about the SMTape sessions on the specified tape device. You must
specify the tape device name in the following format: /node_name/tape_device.
[-progress {<integer>[KB|MB|GB|TB|PB]}] - Bytes Transferred
Selects information about SMTape sessions in which the number of data bytes
transferred in a particular session matches with the number specified in this parameter.
Selects information about SMTape sessions whose starting time matches the specified
starting time.
Selects information about SMTape sessions whose ending time matches the specified
ending time.
[-backup-snapshot <snapshot name>] - Snapshot Name
Selects information about SMTape sessions that use a particular Snapshot copy name
which matches the specified Snapshot copy name in the parameter in backup or restore
operations.
[-tape-block-size <integer>] - Tape Block Size
Selects information about SMTape sessions that use a particular tape block size which
matches the specified tape block size parameter in backup or restore operations.
[-error <text>] - Error Description
Selects information about SMTape sessions that have a particular error description
which matches the specified error description in the parameter.
Examples
Displays default entries about the five SMTape sessions.
cluster1::> system smtape status show
Session Type
1708
Status
Progress
Path
Device
Node
------- ------- --------- --------
------------ --------------- -----------
/vsrvr1/vol1 /cls1-01/nrst0l cluster1-01
Backup
COMPLETED
50MB
Restore FAILED
0B
Backup
Backup
COMPLETED
50MB
COMPLETED
50MB
Backup
/vsrvr1/vol2 /cls1-03/nrst0m cluster1-03
COMPLETED
50KB
/vsrvr1/vol5 /cls1-01/nrst0n cluster1-01
The following example shows the output with the -instance argument.
cluster1::> system smtape status show -instance
Session Identifier: 1
Node Name: node1
Operation Type: Backup
Status: COMPLETED
Path Name: /vs1/vol1
Device Name: /node1/rst0a
Bytes Transferred: 2048
Start Time: 1/4/2012 14:26:24
End Time: 1/4/2012 14:29:45
Last updated: 1/4/2012 14:29:45
Snapshot Name: vol1.snapshot
Tape Block Size: 240
Error Description: None
1709
system snmp authtrap

Enables or disables SNMP authentication traps
level.
Description
Use this command to either enable or disable the standard SNMP authentication failure
traps.
Parameters
[-authtrap <integer>] - Enables SNMP Authentication Trap
Enter the value of 1 to enable SNMP authentication failure traps. By default, SNMP
authentication trap is disabled and the value is 0.
Examples
The following example demonstrates how to set the SNMP authtrap.
cluster1::> system snmp authtrap -authtrap 1

cluster1::> system snmp show
contact:
private
location:
NB
authtrap:
1
init:
0
traphosts:
community:
-
1710
system snmp contact

Displays or modifies contact details
level.
Description
Sets the contact name as the System.sysContact.0 MIB-II variable.
Parameters
[-contact <text>] - Contact
Specifies the contact name. Without any value specified, this command displays current
setting of contact name.
Examples
The following example sets the contact name for SNMP.
cluster1::> system snmp contact -contact private

contact:
private
location:
NB
authtrap:
1
init:
0
traphosts:
community:
-
1711
system snmp init

Enables or disables SNMP traps
level.
Description
Initializes or disables sending of traps by the SNMP daemon from the cluster.
Parameters
[-init <integer>] - Initialize Traps
Use the value of 1 to initialize SNMP daemon to send traps or use a value of 0 to stop
sending traps from the cluster. If no value is specified, this command displays the
current setting of init. Traps are enabled by default.
Examples
The following command initializes SNMP daemon to send traps.
cluster1::> system snmp init -init 1

contact:
private
location:
NB
authtrap:
1
init:
1
traphosts:
community:
-
1712
system snmp location

Displays or modifies location information
level.
Description
Sets the location name as the System.sysLocation.0 MIB-II variable.
Parameters
Specifies the location details. If no value is specified, this command displays the current
setting of location.
Examples
This command sets the location name.
cluster1::> system snmp location -location NB
contact:
private
location:
NB
authtrap:
1
init:
1
traphosts:
community:
-
1713
system snmp prepare-to-downgrade

Change SNMP configuration to the default settings for releases earlier than Data
ONTAP 8.2.1
privilege level.
Description
This command prepares the SNMP sub-system for a downgrade or a revert.
Parameters
None
Examples
The following command prepares the SNMP sub-system for a downgrade or a revert,
within a cluster named cluster1:
cluster1::*> system snmp prepare-to-downgrade
system snmp show

Displays SNMP settings
level.
Description
Lists the current values of all the SNMP parameters.
Parameters
None
Examples
The example below shows a typical command display.
1714

contact:
private
location:
NB
authtrap:
1
init:
1
traphosts:
xxx.example.com(xxx.example.com)(192.168.xxx.xxx)
community:
-
1715
system snmp community add

Adds a new community with the specified access control type
level.
Description
Adds communities with the specified access control type. Only read-only communities
are supported. There is no limit for the number of communities supported.
Parameters
This parameter specifies the Vserver for which to add the community.
-community-name <text> - Community
Specifies the name of the community.
-type <ctype> - access type
Specifies 'ro' for read-only community.
Examples
The following command adds the read-only community name 'private'.
cluster1::> system snmp community add -type ro
-community-name private
cluster1::> system snmp community show
ro
private
system snmp community delete

Deletes community with the specified access control type
level.
1716
Description
Deletes communities with the specified access control type. Only read-only communities
are supported.
Parameters
This parameter specifies the Vserver for which to delete the community.
-community-name <text> - Community
Specify the name of the community.
-type <ctype> - access type
Specify 'ro' for a read-only community.
Examples
This command deletes the read-only community 'private'.
cluster1::> system snmp community delete -type ro

-community-name private
system snmp community show

Displays communities
level.
Description
Displays the current list of SNMP communities.
Parameters
1717

specify.
| [-instance ] }
about all fields.
Selects the Vserver to which the SNMP community belongs
[-community-name <text>] - Community
Selects the SNMP v1/v2c community string
[-access <ctype>] - access
Selects the access type of the SNMP v1/v2c community. Read-only (ro) is the only
access type supported
Examples
cluster1
ro private
system snmp traphost add

Add a new traphost
level.
Description
Adds SNMP managers who receive the SNMP trap PDUs. SNMP manager can be a
hostname or IP address. There is no limit on the number of traphosts supported.
Parameters
1718
-peer-address <Remote InetAddress> - hostname|ipaddress

Specifies the IP address or hostname of the host.
Examples
This command adds a new hostname 'yyy.example.com'.
cluster1::> system snmp traphost add -peer-address yyy.example.com
Or
cluster1::> system snmp traphost add yyy.example.com
cluster1::> system snmp traphost show
yyy.example.com(yyy.example.com)(192.168.xxx.xxx)
xxx.example.com(xxx.example.com)(xxx.xxx.xxx.xxx)
1719
system snmp traphost delete

Delete a traphost
level.
Description
Deletes SNMP managers who receive SNMP trap PDUs. SNMP managers can be
hostname or IP address. There is no limit on the number of traphosts supported.
Parameters
-peer-address <Remote InetAddress> - hostname|ipaddress
Specifies the IP address or hostname of the host.
Examples
This command deletes a traphost 'yyy.example.com'.
cluster1::> system snmp traphost delete -peer-address yyy.example.com
Or
cluster1::> system snmp traphost delete yyy.example.com
1720
system snmp traphost show

Displays traphosts
level.
Description
Displays list of the SNMP managers that receive trap PDUs.
Parameters
None
Examples
The example below displays all host names or IP addresses that have been added until
now.
cluster1::> system snmp traphost show

system timeout modify

Set the CLI inactivity timeout value
level.
Description
The system timeout modify command sets the timeout value for CLI sessions.
If there is no CLI activity during the length of the timeout interval, the logged in user is
logged out. The default value is 30 minutes. To prevent CLI sessions from timing out,
specify a value of 0 (zero).
Parameters
1721
[-timeout <integer>] - Timeout (in minutes)

Use this parameter to specify the timeout value, in minutes.
Examples
The following example shows how to modify the timeout value for CLI sessions to be 10
minutes:
cluster1::> system timeout modify -timeout 10
The following example shows how to prevent CLI sessions from timing out:
cluster1::> system timeout modify -timeout 0
system timeout show

Display the CLI inactivity timeout value
level.
Description
The system timeout show command displays the timeout value for CLI sessions.
If there is no CLI activity during the length of the timeout interval, the logged in user is
logged out. A timeout value of 0 minutes means that the CLI sessions never time out.
Parameters
None
Examples
The following example displays the timeout value for CLI sessions:
cluster1::> system timeout show
CLI session timeout: 15 minute(s)
1722
1723
volume autosize
Set/Display the autosize settings of the flexible volume.
Description
The volume autosize command allows the user to specify the maximum size
and increment that a volume will automatically grow to when it is out of space or the
minimum size that it will shrink to when the amount of used space is below a certain
threshold. If only the volume/Vserver name is specified then the current settings are
displayed. This command is not supported on Infinite Volumes.
Parameters
This parameter can be used to specify the Vserver on which the volume is located.
This parameter specifies the volume for which the user wants to set or display the
autosize configuration.
[-maximum-size {<integer>[KB|MB|GB|TB|PB]}] - Maximum Autosize
This parameter allows the user to specify the maximum size to which a flexible volume
can grow. The default for FlexVol volumes is 120% of the volume size. If the value of
this parameter is invalidated by manually resizing the volume or is invalid when the
autosize feature is enabled, the maximum size is reset to 120% of the volume size.
The value for -maximum-size cannot be set larger than the platform-dependent
maximum FlexVol volume size. If you specify a larger value, the value of -maximumsize is automatically reset to the supported maximum without returning an error. This
parameter is not supported on Infinite Volumes.
[-increment-size {<integer>[KB|MB|GB|TB|PB]}] - (DEPRECATED)-Increment Size
Note:
This parameter is deprecated. In a future release, its value will be computed based on
other autosize settings.
1724
When increasing the size of a volume, Data ONTAP uses the specified increment as a
guide; the actual size increase may be larger or smaller. The default is the lesser value
of either 1GB or 5% of the volume size at the time the volume was created. If the value
of the -maximum-size parameter is invalidated by manually resizing the volume or is
invalid when the autosize feature is enabled, the increment is reset to the lesser value
of either 1GB or 5% of the volume size. This parameter is not supported on Infinite
Volumes.
[-increment-percent <percent>] - (DEPRECATED)-Increment Percentage
Note:
The specified increment percent is converted to a fixed increment size in bytes based
on the volume size when the command is issued. When increasing the size of a volume,
Data ONTAP uses this computed increment as a guide; the actual size increase may
be larger or smaller. The default is the lesser value of either 1GB or 5% of the volume
size at the time the volume was created. If the value of the -maximum-size parameter
is invalidated by manually resizing the volume or is invalid when the autosize feature is
enabled, the increment is reset to the lesser value of either 1GB or 5% of the volume
size. This parameter is not supported on Infinite Volumes.
[-minimum-size {<integer>[KB|MB|GB|TB|PB]}] - Minimum Autosize
This parameter specifies the minimum size to which the volume can automatically
shrink. If the volume was created with the grow_shrink autosize mode enabled, then the
default minimum size is equal to the initial volume size. If the value of the -minimumsize parameter is invalidated by a manual volume resize or is invalid when autosize is
enabled, the minimum size is reset to the volume size. This parameter is not supported
on Infinite Volumes.
[-grow-threshold-percent <percent>] - Grow Threshold Used Space Percentage
This parameter specifies the used space threshold for the automatic growth of the
volume. When the volumes used space becomes greater than this threshold, the
volume will automatically grow unless it has reached the maximum autosize. This
[-shrink-threshold-percent <percent>] - Shrink Threshold Used Space Percentage
This parameter specifies the used space threshold for the automatic shrinking of the
volume. When the amount of used space in the volume drops below this threshold, the
volume will shrink unless it has reached the specified minimum size. This parameter is
not supported on Infinite Volumes.
1725
{ [-mode {off|grow|grow_shrink}] - Autosize Mode

This parameter specifies the autosize mode for the volume. The supported autosize
modes are:
off - The volume will not grow or shrink in size in response to the amount of used
space.
grow - The volume will automatically grow when used space in the volume is
above the grow threshold.
grow_shrink - The volume will grow or shrink in size in response to the amount of
used space.
By default, -mode is off for new FlexVol volumes, except for DP mirrors, for which the
default value is grow_shrink. The grow and grow_shrink modes work together with
Snapshot autodelete to automatically reclaim space when a volume is about to become
full. The volume parameter -space-mgmt-try-first controls the order in which
these two space reclamation policies are attempted. This parameter is not supported in
Infinite Volumes.
| [-is-enabled {on|off}] - Autosize Enabled
Note that this option has been deprecated in Data ONTAP 8.2 and later. Use the mode parameter instead. Volume autosize allows a FlexVol volume to automatically
grow in size within an aggregate. By default -is-enabled is disabled for FlexVol
volumes. This option can be used to enable or disable autosize on a volume. Enabling
this option is equivalent to setting -mode to grow, disabling the autoshrink functionality
if it is currently enabled. This parameter cannot be specified with the -mode parameter.
This parameter is not supported in Infinite Volumes.
[-reset [true]] - Autosize Reset
This option allows the user to reset the values of autosize, autosize-increment, maxautosize, min-autosize, autosize-grow-threshold-percent, autosize-shrink-thresholdpercent and autosize-mode to their default values based on the current size of the
volume. For example, the max-autosize value will be set to 120% of the current size of
the volume.
Examples
The following example sets the autosize settings on a volume named vol1. The
maximum size to grow is 1TB, the increment is 10g and autogrow is enabled.
cluster1::> vol autosize vol1 -maximum-size 1t -increment-size 10g -mode grow
(volume autosize)
vol autosize: Flexible volume 'vs1:vol1' autosize settings UPDATED.
1726
The following example shows the autosize settings on a volume named vol1. The
maximum size to grow is 1TB, the increment is 10g and autogrow is enabled.
cluster1::> vol autosize vol1
(volume autosize)
Volume autosize is currently ON for volume 'vs1:vol1'.
The volume is set to grow to a maximum of 1t, in increments of 10g.
1727
volume create
Create a new volume
Description
The volume create command creates a volume on a specified Vserver and storage
aggregate. You can optionally specify the following attributes for the new volume:
Size
State (online, offline, restricted)
Type (read-write or data-protection)
Export policy
User ID
Group ID
Security style (Infinite Volume: Unified UNIX, NFS and CIFS permissions. All other
volume types: UNIX mode bits, CIFS ACLs, or mixed NFS and CIFS permissions)
Default UNIX permissions for files on the volume
Language
Junction path
Whether the junction path is active (advanced privilege level or higher only)
Whether the volume is the root volume for its Vserver (advanced privilege level or
higher only)
Comment
Whether autosizing is enabled for FlexVols
Maximum size for autosizing FlexVols
(DEPRECATED)-Autosize increment for FlexVols
Minimum size for autosize
Grow used space threshold percentage for autosize
Shrink used space threshold percentage for autosize
1728
Whether autosizing is enabled for FlexVols

Current mode of operation of volume autosize
Maximum directory size (advanced privilege level or higher only)
Space guarantee style (none or volume)
Snapshot policy
Snapshot reserve percentage
Whether the volume create operation runs as a foreground or background
process
Caching policy
Parameters
This specifies the Vserver on which the volume is located. If only one data Vserver
exists, you do not need to specify this parameter.
This specifies the name of the volume that is to be created. A volume's name must start
with an alphabetic character (a to z or A to Z) and be 150 or fewer characters in length
for Infinite Volumes, and 203 or fewer characters in length for all other volume types.
Volume names must be unique within a Vserver.
-aggregate <aggregate name> - Aggregate Name
This specifies the storage aggregate on which the volume is to be created. This
parameter does not apply to Infinite Volumes.
[-size {<integer>[KB|MB|GB|TB|PB]}] - Volume Size
This optionally specifies the size of the volume. The size is specified as a number
followed by a unit designation: k (kilobytes), m (megabytes), g (gigabytes), or t
(terabytes). If the unit designation is not specified, bytes are used as the unit, and the
specified number is rounded up to the nearest 4 KB. The minimum size for a FlexVol
volume is 20 MB. For Infinite Volumes, the minimum size is 1.33 TB per node that will
host a data constituent. For both FlexVol volumes and Infinite Volumes, the default
size is set to the minimum size. The volume's maximum size is limited by the platform
maximum. If the volume's guarantee is set to volume, the volume's maximum size
can also be limited by the available space in the hosting aggregate. Volumes can be
increased and decreased in size with the volume modify command. The maximum
1729
number of files a volume is configured for is listed under "Total Files" when running the
command volume show -instance.
[-state {online|restricted|offline|force-online|force-offline|mixed}] - Volume State
This optionally specifies the volume's state. A restricted volume does not provide client
access to data but is available for administrative operations.
Note:
The mixed state applies to Infinite Volumes only and cannot be specified as a target
state.
[-type {RW|DP|DC}] - Volume Type
This optionally specifies the volume's type, either read-write or data-protection. If you do
not specify a value for this parameter, a read-write volume is created by default.
[-policy <text>] - Export Policy
This optionally specifies the ID number of the export policy associated with the volume.
For information on export policies, see the documentation for the vserver exportpolicy create command.
[-user <user name>] - User ID
This optionally specifies the name or ID of the user that is set as the owner of the
volume's root.
[-group <group name>] - Group ID
This optionally specifies the name or ID of the group that is set as the owner of the
volume's root.
[-security-style <security style>] - Security Style
This optionally specifies the security style for the volume. Possible values include
unix (for UNIX mode bits), ntfs (for CIFS ACLs), mixed (for mixed NFS and CIFS
permissions) and unified (for mixed NFS and CIFS permissions with unified ACLs).
Regardless of the security style, both NFS and CIFS clients can read from and write
to the volume. Infinite Volumes support the unified security style only, and the unified
security style can only be used on Infinite Volumes.
[-unix-permissions <unix perm>] - UNIX Permissions
This optionally specifies the default UNIX permissions for files on the volume. Specify
UNIX permissions either as a four-digit octal value (for example, 0700) or in the style of
the UNIX ls command (for example, -rwxr-x---). For information on UNIX permissions,
see the UNIX or Linux documentation. The default setting is 0755 or ---rwxr-xr-x.
1730
[-junction-path <junction path>] - Junction Path

This optionally specifies the volume's junction path. The junction path name is case
insensitive and must be unique within a Vserver's namespace.
[-junction-active {true|false}] - Junction Active (privilege: advanced)
This optionally specifies whether the volume's junction path is active. The default setting
is true. If the junction path is inactive, the volume does not appear in the Vserver's
namespace. This parameter is available only at the advanced privilege level and higher.
[-vsroot {true|false}] - Vserver Root Volume (privilege: advanced)
This optionally specifies whether the volume is the root volume of its Vserver. The
default setting is false. If this parameter is set to true, the default size of the newly
created volume is 1GB. This parameter is not supported on Infinite Volumes.
This optionally specifies a comment for the volume.
[-max-autosize {<integer>[KB|MB|GB|TB|PB]}] - Maximum Autosize (for flexvols only)
autosize feature is enabled, the maximum size is reset to 120% of the volumesize.
The value for -max-autosize cannot be set larger than the platform-dependent
maximum FlexVol volume size. If you specify a larger value, the value of -maxautosize is automatically reset to the supported maximum without returning an error.
This parameter is not supported on Infinite Volumes.
[-autosize-increment | -i {<integer>[KB|MB|GB|TB|PB]}] - (DEPRECATED)-Autosize
Increment (for flexvols only)
Note:
of the -max-autosize parameter is invalidated by manually resizing the volume or is
Volumes.
1731
[-autosize-increment-percent | -p <percent>] - (DEPRECATED)-Autosize Increment

Percent (for flexvols only)
Note:
size at the time the volume was created. If the value of the -max-autosize parameter
[-min-autosize {<integer>[KB|MB|GB|TB|PB]}] - Minimum Autosize
shrink. If the volume was created with the grow_shrink autosize mode enabled, then
the default minimum size is equal to the initial volume size. If the value of the -minautosize parameter is invalidated by a manual volume resize or is invalid when
autosize is enabled, the minimum size is reset to the volume size. This parameter is not
supported on Infinite Volumes.
[-autosize-grow-threshold-percent <percent>] - Autosize Grow Threshold Percentage
[-autosize-shrink-threshold-percent <percent>] - Autosize Shrink Threshold
Percentage
{ [-autosize-mode {off|grow|grow_shrink}] - Autosize Mode
modes are:
1732
space.
used space.
By default, -autosize-mode is off for new FlexVol volumes, except for data protection
mirrors, for which the default value is grow_shrink. The grow and grow_shrink modes
work together with Snapshot autodelete to automatically reclaim space when a volume
is about to become full. The volume parameter -space-mgmt-try-first controls the
order in which these two space reclamation policies are attempted. This parameter is
not supported in Infinite Volumes.
| [-autosize {true|false}] } - Autosize Enabled (for flexvols only)
Note that this option has been deprecated in Data ONTAP 8.2 and later. Use the autosize-mode parameter instead. Volume autosize allows a FlexVol volume to
automatically grow in size within an aggregate. By default -autosize is disabled for
FlexVol volumes. This option can be used to enable or disable autosize on a volume.
Enabling this option is equivalent to setting -autosize-mode to grow, disabling the
autoshrink functionality if it is currently enabled. This parameter cannot be specified with
the -autosize-mode parameter. This parameter is not supported in Infinite Volumes.
[-maxdir-size {<integer>[KB|MB|GB|TB|PB]}] - Maximum Directory Size (privilege:
advanced)
This optionally specifies the maximum directory size. The default setting is 102,400 KB
(or 100 MB). This parameter is available only at the advanced privilege level and higher.
[-space-guarantee | -s {none|volume}] - Space Guarantee Style
This optionally specifies the space-reservation policy for the volume. A value of volume
reserves space on the aggregate for the entire volume. A value of none reserves no
space on the aggregate, meaning that writes can fail if the aggregate runs out of space;
because CIFS does not handle out-of-space conditions, do not use this value if the
volume is accessible to CIFS clients. The default setting is volume. The file setting is
no longer supported.
This optionally specifies the amount of space that is reserved in the volume for
Snapshots. The default setting is 5 percent, except for data protection mirrors for which
the default is 0 percent.
1733
[-snapshot-policy <snapshot policy>] - Snapshot Policy

This optionally specifies the Snapshot policy for the volume. The default is the Snapshot
policy for all volumes on the Vserver, as specified by the -snapshot-policy
parameter of the vserver create and vserver modify commands. The schedules
associated with the snapshot-policy for an Infinite Volume cannot have an interval
shorter than hourly.
[-language <Language code>] - Language
This optionally specifies the language encoding setting for the volume. By default, the
volume inherits the Vserver language encoding setting. You cannot specify the language
encoding setting for an Infinite Volume.
Note:
You cannot modify the language encoding setting of a volume.
[-foreground {true|false}] - Foreground Process
This specifies whether the operation runs in the foreground. The default setting is true
(the operation runs in the foreground). When set to true, the command will not return
until the operation completes. This parameter applies only to Infinite Volumes. For
FlexVol volumes, the command al ways runs in the foreground.
[-nvfail {on|off}] - NVFAIL Option
Setting this optional parameter to true causes the volume to set the in-nvfailed-state flag
to true, if committed writes to the volume are lost due to a failure. The in-nvfailed-state
flag fences the volume from further data access and prevents possible corruption of the
application data. Without specifying a value, this parameter is automatically set to false.
[-storage-service <storage service name>] - Storage Service Name (privilege:
advanced)
The name of the initial storage service for the Infinite Volume. This is required if the
parameter -is-managed-by-service is set to true. This parameter applies to Infinite
Volumes only.
[-enable-snapdiff {true|false}] - Create Namespace Mirror Constituents For SnapDiff
Use
When set to true for an Infinite Volume that spans three or more nodes, namespace
mirror constituents are created for SnapDiff use. One namespace mirror constituent
is created on every node that contains a data constituent for the Infinite Volume. A
namespace constituent is not created on nodes that contain either the namespace
constituent or a namespace mirror constituent used for data protection of the
namespace constituent. An automatic daily replication schedule is set up for every
1734
namespace mirror constituent created. The default setting is false. This parameter
applies to Infinite Volumes only.
[-unreachable-attr-action {return-generated|wait}] - Action When Attributes Are Not
Reachable (privilege: advanced)
This parameter specifies the information that an Infinite Volume returns when a client
lists a directory that contains one or more files with inaccessible attributes, which can
happen when a data constituent is not online. When this parameter is set to returngenerated, the Infinite Volume returns default values for the attributes, which appear to
the client as a file size of 0 and timestamps that are in the past. When this parameter is
set to wait, the Infinite Volume returns a RETRY error, which may cause some clients
to hang. When the inaccessible file attributes become available, the Infinite Volume
returns them to the client. The default setting is return-generated. This parameter is not
supported for FlexVol volumes.
[-namespace-aggregate <aggregate name>] - Namespace Aggregate (privilege:
advanced)
The name of the aggregate in which to create the Infinite Volume namespace
constituent. If a name is not provided, Data ONTAP picks the aggregate assigned to the
Vserver that has the most usable space. This parameter applies to Infinite Volumes only.
[-max-namespace-constituent-size {<integer>[KB|MB|GB|TB|PB]}] - Maximum Size of
Namespace Constituent (privilege: advanced)
The maximum size of the namespace constituent. The default value is 10TB. This
parameter applies to Infinite Volumes only.
[-ns-mirror-aggr-list <aggregate name>, ...] - List of Aggregates for Namespace
Mirrors (privilege: advanced)
Specifies the aggregates that can be used to create Infinite Volume namespace mirror
constituents. No other aggregate will be chosen for this purpose. Aggregates in this
list will remain available for other uses in the Infinite Volume. This parameter applies to
Infinite Volumes only.
[-data-aggr-list <aggregate name>, ...] - List of Aggregates for Data Constituents
Specifies the aggregates that can be used to create Infinite Volume data constituents.
No other aggregate will be chosen for this purpose. Aggregates in this list will remain
available for other uses in the Infinite Volume. This parameter applies to Infinite Volumes
only.
[-max-data-constituent-size {<integer>[KB|MB|GB|TB|PB]}] - Maximum Size of Each
Data Constituent (privilege: advanced)
1735
This optional parameter specifies the maximum size of an Infinite Volume data
constituent. The default value is determined by checking the maximum FlexVol size
setting on all nodes used by the Infinite Volume. The smallest value found is chosen
as the default for the max-data-constituent-size for the Infinite Volume. This
[-qos-policy-group <text>] - QoS Policy Group Name
This optionally specifies which QoS policy group to apply to the volume. This policy
group defines measurable service level objectives (SLOs) that apply to the storage
objects with which the policy group is associated. If you do not assign a policy group to
a volume, the system will not monitor and control the traffic to it. This parameter is not
[-caching-policy <text>] - Caching Policy Name
This optional parameter specifies the caching policy to apply to the volume. A caching
policy defines how the system caches this volume's data in a Flash Pool aggregate.
If a caching policy is not assigned to this volume, the system uses auto as the default
caching policy. This parameter is not supported on Infinite Volumes.
Only metadata, randomly read, and randomly written user data are eligible for caching.
Metadata consists of directories, indirect blocks and system metafiles. They are eligible
for read caching only. User data that shows random read pattern is eligible for read
caching while randomly written blocks are eligible for both read and write caching. When
a random write pattern is detected on user data, the first such write is eligible for read
caching while all subsequent overwrites are eligible for write caching. The available
caching policies are:
none - Does not cache any user data or metadata blocks.
auto - Read caches all metadata and randomly read user data blocks and write
caches all randomly overwritten user data blocks.
meta - Read caches only metadata blocks.
random_read - Read caches all metadata and randomly read user data blocks.
random_read_write - Read caches all metadata, randomly read and randomly
written user data blocks.
meta-random_write - Read caches all metadata and write caches randomly
overwritten user data blocks.
noread-random_write - Write caches all randomly overwritten user data blocks. It
does not do any read caching.
1736
random_read_write-random-write - Read caches all metadata, randomly read and

randomly written user data blocks. It also write caches randomly overwritten user
data blocks.
advanced)
If the Auto Balance feature is enabled, this parameter specifies whether the volume
might be considered for system workload balancing. When set to true, the Auto Balance
Aggregate feature might recommend moving this volume to another aggregate. The
default value is true.
Examples
The following example creates a new volume named user_jdoe on a Vserver named
vs0 and a storage aggregate named aggr1. Upon its creation, the volume is placed
in the online state. It uses the export policy named default_expolicy. The owner of the
volume's root is a user named jdoe whose primary group is named dev. The volume's
junction path is /user/jdoe. The volume is 250 GB in size, space for the entire volume is
reserved on the aggregate, and the create operation runs in the background.
node::> volume create -vserver vs0 -volume user_jdoe -aggregate aggr1 -state
online
-policy default_expolicy -user jdoe -group dev -junction-path /user/
jdoe -size 250g
-space-guarantee volume -percent-snapshot-space 20 -foreground false
The following example creates a new volume named vol_cached on a Vserver named
vs0 and a Flash Pool storage aggregate named aggr1. The newly created volume is
placed online and uses auto as the caching policy.
cluster1::> volume create -vserver vs0 -volume vol_cached -aggregate aggr1 -state
online -caching-policy auto
See Also
volume modify volume show vserver export-policy create vserver create
vserver modify
1737
volume delete
Delete an existing volume
Description
The volume delete command deletes the specified volumes. Before deleting a
volume, the user is prompted to confirm the operation unless the -force flag is
specified. If this volume was associated with a policy group the underlying qos workload
is deleted.
Note:
If there is a qtree or quota policy associated with a volume, it is deleted when you
delete the volume.
A volume must be offline (see volume offline) to be deleted.
Parameters
This specifies the name of the Vserver from which the volume is to be deleted. If only
one data Vserver exists, you do not need to specify this parameter.
This specifies the name of the volume that is to be deleted.
If this parameter is specified, the user is not prompted to confirm each deletion
operation. In addition, the operation is run only on the local node, and several potential
errors are ignored. By default, this setting is false. This parameter is available only at
FlexVol volumes, the command always runs in the foreground.
1738
Examples
The following example deletes a volume named vol1_old from a Vserver named vs0:
cluster1::> volume delete -vserver vs0 -volume vol1_old
See Also
volume offline
1739
volume make-vsroot
Designate a non-root volume as a root volume of the Vserver
privilege level.
Description
The volume make-vsroot command promotes a non-root volume of the Vserver to
be the Vserver's root volume. The Vserver's root volume must be a FlexVol volume with
a size of atleast 1 GB.
For instance, if you run this command on a volume named user that is located on a
Vserver named vs0, the volume user is made the root volume of the Vserver vs0.
If you run this command on a Vserver with Infinite Volume, you must create a new root
volume. You cannot promote an existing non-root volume to be the root volume of the
Vserver with Infinite Volume. When the command executes, the new root volume is
created on the aggregate specified by the aggregate parameter, and the old root volume
is deleted.
Parameters
This specifies the Vserver on which a non-root volume is to be made the root volume.
This specifies the non-root volume that is to be made the root volume of its Vserver. For
Vservers with FlexVol volume this must be an existing FlexVol volume. For Vservers
with Infinite Volume this must be a non-existent volume that will be created during the
execution of the command.
[-aggregate <aggregate name>] - Aggregate Name
This specifies the aggregate that the new root volume will be created on for Vservers
with Infinite Volume. This parameter is not supported for Vservers with FlexVol volumes.
Examples
The following example makes a volume named root_vs0_backup the root volume of its
Vserver with FlexVol volumes, which is named vs0.
1740
node::> volume make-vsroot -vserver vs0 -volume root_vs0_backup
The following example makes a volume named root_vs1 the root volume of the Vserver
with Infinite Volume vs1.
node::> volume make-vsroot -vserver vs1 -volume root_vs1 -aggregate aggr1
volume modify
Modify volume attributes
Description
The volume modify command can be used to modify the following attributes of a
volume:
Size
State (online, offline, restricted, force-online or force-offline)
Export policy
User ID
Group ID
Security style (Infinite Volume: Unified UNIX, NFS and CIFS permissions. All other
volume types: UNIX mode bits, CIFS ACLs, or mixed NFS and CIFS permissions)
Default UNIX permissions for files on the volume
Whether the junction path is active
Comment
Volume nearly full threshold percent
Volume full threshold percent
Maximum size for autosizing
(DEPRECATED)-Autosize increment
Minimum size for autosize
Grow used space threshold percentage for autosize
1741
Shrink used space threshold percentage for autosize

Whether autosizing is enabled
Current mode of operation of volume autosize
Reset the autosize values to their defaults
Total number of files for user-visible data permitted on the volume
Space guarantee style (none or volume)
Snapshot policy
Convert ucode
Caching policy
You can use the volume move command to change a volume's aggregate or node. You
can use the volume rename command to change a volume's name. You can use the
volume make-vsroot command to make a volume the root volume of its Vserver.
You can change additional volume attributes by using this command at the advanced
Parameters
This specifies the Vserver on which the volume is located. If only one data Vserver
exists, you do not need to specify this parameter. Although node Vservers are not
displayed when using <Tab> completion, this parameter supports node Vservers for
modifying the root volume of the specified node Vserver.
This specifies the volume that is to be modified.
This optionally specifies the new size of the volume. The size is specified as a number
specified number is rounded up to the nearest 4 KB. A relative rather than absolute size
change can be specified by adding + or - before the given size: for example, specifying
+30m adds 30 megabytes to the volume's current size. The minimum size for a volume
is 20 MB (the default setting). The volume's maximum size is limited by the platform
maximum. If the volume's guarantee is set to volume, the volume's maximum size
can also be limited by the available space in the hosting aggregate. If the volume's
1742
guarantee is currently disabled, its size cannot be increased. This parameter is not
supported on Infinite Volumes that are managed by storage services.
This optionally specifies the volume's state. A restricted volume does not provide client
access to data but is available for administrative operations.
Note:
The mixed state applies to Infinite Volumes only and cannot be specified as a target
state.
This optionally specifies the ID number of the export policy associated with the volume.
For information on export policy, see the documentation for the vserver exportpolicy create command.
This optionally specifies the name or ID of the user that is set as the owner of the
volume's root.
This optionally specifies the name or ID of the group that is set as the owner of the
volume's root.
This optionally specifies the security style for the volume. Possible values include
unix (for UNIX mode bits), ntfs (for CIFS ACLs), mixed (for mixed NFS and CIFS
permissions) and unified (for mixed NFS and CIFS permissions with unified ACLs).
Regardless of the security style, both NFS and CIFS clients can read from and write
to the volume. Infinite Volumes support the unified security style only, and the unified
security style can only be used on Infinite Volumes.
This optionally specifies the default UNIX permissions for files on the volume. Specify
see the UNIX or Linux documentation. The default setting is 0755 or -rwxr-xr-x.
[-junction-active {true|false}] - Junction Active (privilege: advanced)
This optionally specifies whether the volume's junction path is active. The default
setting is true. If the junction is inactive, the volume does not appear in the Vserver's
namespace.
1743

This optionally specifies a comment for the volume.
[-space-nearly-full-threshold-percent <percent>] - Volume Nearly Full Threshold
Percent
This optionally specifies the percentage at which the volume is considered nearly full,
and above which an EMS warning will be generated. This parameter is not supported on
Infinite Volumes. The default value is 95%. The maximum value for this option is 99%.
Setting this threshold to 0 disables the volume nearly full space alerts.
[-space-full-threshold-percent <percent>] - Volume Full Threshold Percent
This optionally specifies the percentage at which the volume is considered full, and
above which a critical EMS error will be generated. This parameter is not supported on
Infinite Volumes. The default value is 98%. The maximum value for this option is 100%.
Setting this threshold to 0 disables the volume full space alerts.
autosize feature is enabled, the maximum size is reset to 120% of the volume size.
The value for -max-autosize cannot be set larger than the platform-dependent
maximum FlexVol volume size. If you specify a larger value, the value of -maxautosize is automatically reset to the supported maximum without returning an error.
Note:
of the -max-autosize parameter is invalidated by manually resizing the volume or is
Volumes.
1744
[-autosize-increment-percent | -p <percent>] - (DEPRECATED)-Autosize Increment

Percent (for flexvols only)
Note:
size at the time the volume was created. If the value of the -max-autosize parameter
shrink. If the volume was created with the grow_shrink autosize mode enabled, then
the default minimum size is equal to the initial volume size. If the value of the -minautosize parameter is invalidated by a manual volume resize or is invalid when
autosize is enabled, the minimum size is reset to the volume size. This parameter is not
Percentage
{ [-autosize-mode {off|grow|grow_shrink}] - Autosize Mode
modes are:
1745
space.
used space.
By default, -autosize-mode is off for new flexible volumes, except for DP mirrors, for
which the default value is grow_shrink. The grow and grow_shrink modes work together
with Snapshot autodelete to automatically reclaim space when a volume is about to
become full. The volume parameter -space-mgmt-try-first controls the order
in which these two space reclamation policies are attempted. This parameter is not
supported in Infinite Volumes.
| [-autosize {true|false}] - Autosize Enabled (for flexvols only)
Note that this option has been deprecated in Data ONTAP 8.2 and later. Use the autosize-mode parameter instead. Volume autosize allows a FlexVol volume to
automatically grow in size within an aggregate. By default -autosize is disabled for
FlexVol volumes. This option can be used to enable or disable autosize on a volume.
Enabling this option is equivalent to setting -autosize-mode to grow, disabling the
autoshrink functionality if it is currently enabled. This parameter cannot be specified with
the -autosize-mode parameter. This parameter is not supported in Infinite Volumes.
[-autosize-reset [true]] - Autosize Reset
This allows the user to reset the values of autosize, autosize-increment, max-autosize,
min-autosize, autosize-grow-threshold-percent, autosize-shrink-threshold-percent and
autosize-mode to their default values. For example, the max-autosize value will be set to
120% of the current size of the volume.
[-files <integer>] - Total Files (for user-visible data)
This optionally specifies the total number of files for user-visible data permitted on the
volume. This value can be raised or lowered. Raising the total number of files does not
immediately cause additional disk space to be used to track files. Instead, as more files
are created on the volume, the system dynamically increases the number of disk blocks
that are used to track files. The space assigned to track files is never freed, and the
files value cannot be decreased below the current number of files that can be tracked
within the assigned space for the volume.
advanced)
This optionally specifies the maximum directory size. The default maximum directory
size is model-dependent, and optimized for the size of system memory. You can
1746
increase it for a specific volume by using this option, but doing so could impact system
performance. If you need to increase the maximum directory size, work with customer
support. This parameter is not supported on Infinite Volumes.
This option controls whether the volume is guaranteed some amount of space in the
aggregate. The default is volume; none can be set by the administrator. The file
setting is no longer supported. Volume guaranteed means that the entire size of the
volume is preallocated. The none value means that no space is preallocated, even
if the volume contains space-reserved files or LUNs; if the aggregate is full, space is
not available even for space-reserved files and LUNs within the volume. Setting this
parameter to none enables you to provision more storage than is physically present
in the aggregate (thin provisioning). When you use thin provisioning for a volume, it
can run out of space even if it has not yet consumed its nominal size and you should
carefully monitor space utilization to avoid unexpected errors due to the volume running
out of space. For flexible root volumes, to ensure that system files, log files, and cores
can be saved, the space-guarantee must be volume. This is to ensure support of
the appliance by customer support, if a problem occurs. Disk space is preallocated
when the volume is brought online and, if not used, returned to the aggregate when
the volume is brought offline. It is possible to bring a volume online even when the
aggregate has insufficient free space to preallocate to the volume. In this case, no
space is preallocated, just as if the none option had been selected. In this situation, the
vol options and vol status command display the actual value of the space-guarantee
option, but indicate that it is disabled. This parameter is not supported on Infinite
Volumes that are managed by storage services.
[-min-readahead {true|false}] - Minimum Read Ahead (privilege: advanced)
This optionally specifies whether minimum readahead is used on the volume. The
default setting is false.
[-atime-update {true|false}] - Access Time Update Enabled (privilege: advanced)
This optionally specifies whether the access time on inodes is updated when a file is
read. The default setting is true.
[-snapdir-access {true|false}] - Snapshot Directory Access Enabled
This optionally specifies whether clients have access to .snapshot directories. The
This optionally specifies the amount of space that is reserved on the volume for
Snapshot copies. The default setting is 5 percent.
1747
This optionally specifies the Snapshot policy for the volume. The default is the Snapshot
policy for all volumes on the Vserver, as specified by the -snapshot-policy
parameter of the vserver create and vserver modify commands. The schedules
associated with the snapshot-policy for an Infinite Volume cannot have an interval
shorter than hourly.
Setting this optional parameter to true causes the volume to set the in-nvfailed-state flag
to true, if committed writes to the volume are lost due to a failure. The in-nvfailed-state
flag fences the volume from further data access and prevents possible corruption of the
application data. Without specifying a value, this parameter is automatically set to false.
[-in-nvfailed-state {true|false}] - Volume's NVFAIL State (privilege: advanced)
This field is automatically set to true on a volume when committed writes to the volume
are possibly lost due to a failure, and the volume has the nvfail option enabled. With this
field set, the client access to the volume is fenced to protect against possible corruptions
that result from accessing stale data. The administrator needs to take appropriate
recovery actions to recover the volume from the possible data loss. After the recovery
is completed, the administrator can clear this field and restore the client access to the
volume. This field can be cleared using the CLI but it cannot be set.
[-dr-force-nvfail {on|off}] - Force NVFAIL on MetroCluster Switchover
Setting this optional parameter to true on a volume causes the MetroCluster switchover
operation to set the in-nvfailed-state flag to true on that volume. The in-nvfailed-state
flag prevents further data access to the volume. The default value is false.
[-filesys-size-fixed {true|false}] - Is File System Size Fixed
This option causes the file system to remain the same size and not grow or shrink when
a SnapMirrored volume relationship is broken, or when a volume add is performed on it.
It is automatically set to true when a volume becomes a SnapMirrored volume. It stays
set to true after the snapmirror break command is issued for the volume. This allows
a volume to be SnapMirrored back to the source without needing to add disks to the
source volume. If the volume is a traditional volume and the size is larger than the file
system size, setting this option to false forces the file system to grow to the size of the
volume. If the volume is a flexible volume and the volume size is larger than the file
1748
system size, setting this option to false forces the volume size to equal the file system
size. The default setting is false.
[-extent-enabled {off|on|space-optimized}] - Extent Option
Setting this option to on or space-optimized enables extents in the volume. This
causes application writes to be written in the volume as a write of a larger group of
related data blocks called an extent. Using extents may help workloads that perform
many small random writes followed by large sequential reads. However, using extents
may increase the amount of disk operations performed on the controller, so this option
should only be used where this trade-off is desired. If the option is set to spaceoptimized then the reallocation update will not duplicate blocks from Snapshot
copies into the active file system, and will result in conservative space utilization. Using
space-optimized may be useful when the volume has Snapshot copies or is a
SnapMirror source, when it can reduce the storage used in the volume and the amount
of data that SnapMirror needs to move on the next update. The space-optimized
value can result in degraded read performance of Snapshot copies. The default value is
off; extents are not used.
[-fractional-reserve <percent>] - Fractional Reserve
This option changes the amount of space reserved for overwrites of reserved objects
(LUNs, files) in a volume. This parameter is not supported on Infinite Volumes. The
option is set to 100 by default with guarantee set to volume. A setting of 100 means
that 100% of the required reserved space is actually reserved so the objects are fully
protected for overwrites. The value is set to 0 by default with guarantee set to none.
The value can be either 0 or 100 when guarantee is set to volume or none. Using a
value of 0 indicates that no space will be reserved for overwrites. This returns the extra
space to the available space for the volume, decreasing the total amount of space used.
However, this does leave the protected objects in the volume vulnerable to out of space
errors. If the percentage is set to 0%, the administrator must monitor the space usage
on the volume and take corrective action.
[-space-mgmt-try-first {volume_grow|snap_delete}] - Primary Space Management
Strategy
A flexible volume can be configured to automatically reclaim space in case the volume is
about to run out of space, by either increasing the size of the volume using autogrow or
deleting Snapshot copies in the volume using Snapshot autodelete. If this option is set
to volume_grow the system will try to first increase the size of volume before deleting
Snapshot copies to reclaim space. If the option is set to snap_delete the system will first
automatically delete Snapshot copies and in case of failure to reclaim space will try to
grow the volume. This parameter is not supported on Infinite Volumes.
[-read-realloc {off|on|space-optimized}] - Read Reallocation Option
1749
Setting this option to on or space-optimized enables read reallocation in the volume.

This results in the optimization of file layout by writing some blocks to a new location on
disk. The layout is updated only after the blocks have been read because of a user read
operation, and only when updating their layout will provide better read performance in
the future. Using read reallocation may help workloads that perform a mixture of random
writes and large sequential reads. If the option is set to space-optimized then the
reallocation update will not duplicate blocks from Snapshot copies into the active file
system, and will result in conservative space utilization. Using space-optimized may
be useful when the volume has Snapshot copies or is a SnapMirror source, when it can
reduce the storage used in the volume and the amount of data that snapmirror needs to
move on the next update. The space-optimized value can result in degraded read
performance of Snapshot copies. The default value is off.
advanced)
The name of the storage service for the Infinite Volume. This parameter applies to
Use
When set to true for an Infinite Volume that spans three or more nodes, namespace
mirror constituents are created for SnapDiff use. One namespace mirror constituent
is created on every node that contains a data constituent for the Infinite Volume.
A namespace mirror constituent is not created on nodes that contain either the
namespace constituent or a namespace mirror constituent used for data protection of
the namespace constituent. An automatic daily replication schedule is set up for every
namespace mirror constituent created. If set to false, all existing namespace mirror
constituents used by SnapDiff are deleted. The namespace mirror constituent used for
namespace data protection is not affected. This parameter applies to Infinite Volumes
only.
lists a directory that contains one or more files with inaccessible attributes, which can
happen when a data constituent is not online. When this parameter is set to returngenerated, the Infinite Volume returns default values for the attributes, which appear to
the client as a file size of 0 and timestamps that are in the past. When this parameter is
set to wait, the Infinite Volume returns a RETRY error, which may cause some clients
to hang. When the inaccessible file attributes become available, the Infinite Volume
returns them to the client. The default setting is return-generated. This parameter is not
supported for FlexVol volumes.
1750
[-namespace-aggregate <aggregate name>] - Namespace Aggregate (privilege:

advanced)
The name of the aggregate in which to create the Infinite Volume namespace
constituent. If a name is not provided, Data ONTAP picks the aggregate assigned to the
Vserver that has the most usable space. This parameter can only be specified for DP
Infinite Volumes that do not have an existing namespace constituent. This parameter
applies to Infinite Volumes only.
The maximum size of the namespace constituent. The default value is 10TB. This
[-ns-mirror-aggr-list <aggregate name>, ...] - List of Aggregates for Namespace
Mirrors (privilege: advanced)
Specifies the aggregates that can be used to create Infinite Volume namespace mirror
constituents. No other aggregate will be chosen for this purpose. Aggregates in this
list will remain available for other uses in the Infinite Volume. This parameter applies to
This parameter specifies the maximum size of an Infinite Volume data constituent. The
default value is determined by checking the maximum FlexVol size setting on all nodes
used by the Infinite Volume. The smallest value found is chosen as the default for the
maximum constituent size. This parameter applies to Infinite Volumes only.
This optionally specifies which QoS policy group to apply to the volume. This policy
a volume, the system will not monitor and control the traffic to it. To remove this volume
from a policy group, enter the reserved keyword "none". This parameter is not supported
This parameter specifies the caching policy to apply to the volume. A caching policy
defines how the system caches this volume's data in a Flash Pool aggregate. This
Only metadata, randomly read, and randomly written user data are eligible for caching.
Metadata consists of directories, indirect blocks and system metafiles. They are eligible
for read caching only. User data that shows random read pattern is eligible for read
1751
caching while randomly written blocks are eligible for both read and write caching. When
a random write pattern is detected on user data, the first such write is eligible for read
caching while all subsequent overwrites are eligible for write caching. The available
caching policies are:
none - Does not cache any user data or metadata blocks.
auto - Read caches all metadata and randomly read user data blocks and write
caches all randomly overwritten user data blocks.
meta - Read caches only metadata blocks.
random_read - Read caches all metadata and randomly read user data blocks.
random_read_write - Read caches all metadata, randomly read and randomly
written user data blocks.
meta-random_write - Read caches all metadata and write caches randomly
overwritten user data blocks.
noread-random_write - Write caches all randomly overwritten user data blocks. It
does not do any read caching.
random_read_write-random-write - Read caches all metadata, randomly read and
randomly written user data blocks. It also write caches randomly overwritten user
data blocks.
advanced)
If the Auto Balance feature is enabled, this parameter specifies whether the volume
might be considered for system workload balancing. When set to true, the Auto Balance
Aggregate feature might recommend moving this volume to another aggregate. The
default value is true.
Examples
The following example modifies a volume named vol4 on a Vserver named vs0. The
volume's export policy is changed to default_expolicy and its size is changed to 500 GB.
cluster1::> volume modify -vserver vs0 -volume vol4 -policy default_expolicy size 500g
The following example modifies a volume named vol2. It enables autogrow and sets the
maximum autosize to 500g and autosize increment to 20g
cluster1::> volume modify -volume vol2 -autosize-mode grow -max-autosize 500g autosize-increment 20g
1752
The following example modifies a volume named vol2 to have an autosize increment of
50g
cluster1::> volume modify -volume vol2
-autosize-increment 50g
The following example modifies a volume named vol2 to have a space guarantee of
none.
cluster1::> volume modify -space-guarantee none -volume vol2
The following example modifies all volumes in Vserver vs0 to have a fractional reserve
of 30%.
cluster1::> volume modify -fractional-reserve 30 -vserver vs0 *
The following example modifies a volume named vol2 to grow in size by 5 gigabytes
cluster1::> volume modify -volume vol2 -size +5g
The following example modifies a volume named vol2 to have a different caching policy.
The volume must be on a Flash Pool aggregate.
cluster1::> volume modify -volume vol2 -caching-policy none
See Also
vserver export-policy create vserver create vserver modify volume move
volume rename volume make-vsroot
1753
volume mount
Mount a volume on another volume with a junction-path
Description
The volume mount command mounts a volume at a specified junction path.
Parameters
This specifies the Vserver on which the volume is located.
This specifies the volume that is to be mounted.
-junction-path <junction path> - Junction Path Of The Mounting Volume
This specifies the junction path of the mounted volume. The junction path name is case
insensitive and must be unique within a Vserver's namespace.
[-active {true|false}] - Activate Junction Path
This optionally specifies whether the mounted volume is accessible. The default setting
is false . If the mounted path is not accessible, it does not appear in the Vserver's
namespace.
[-policy-override {true|false}] - Override The Export Policy
This optionally specifies whether the parent volume's export policy overrides the
mounted volume's export policy. The default setting is false .
Examples
The following example mounts a volume named user_tsmith on a Vserver named
vs0. The junction path for the mounted volume is /user/tsmith. The mounted volume
is accessible, and the mounted volume's export policy is not overridden by the parent
volume's export policy.
node::> volume mount -vserver vs0 -volume user_tsmith
-junction-path /user/tsmith -active true -policy-override false
1754
volume offline
Take an existing volume offline
Description
The volume offline command takes the volume offline. If the volume is already in
restricted or iron_restricted state, then it is already unavailable for data access, and
much of the following description does not apply. The current root volume may not be
taken offline. A number of operations being performed on the volume in question can
prevent volume offline from succeeding for various lengths of time. If such operations
are required, the command may take additional time to complete. If they do not, the
command is aborted. The -force flag can be used to forcibly offline a volume.
Parameters
This specifies the name of the Vserver from which the volume is to be taken offline. If
only one data Vserver exists, you do not need to specify this parameter.
This specifies the name of the volume that is to be taken offline.
[-force | -f [true]] - Force Offline
This specifies whether the offline operation is forced. Using this option to force a volume
offline can potentially disrupt access to other volumes. The default setting is false.
Examples
The following example takes the volume named vol1 offline:
cluster1::> volume offline vol1
Volume 'vs1:vol1' is now offline.
1755
volume online
Bring an existing volume online
Description
The volume online command brings the volume online. A volume can only be
brought online if it is offline or restricted. If the volume is inconsistent but has not lost
data, the user will be cautioned and prompted before bringing it online. It is advisable to
run wafl-iron (or do a snapmirror initialize in case of a replica volume) prior to bringing
an inconsistent volume online. Bringing an inconsistent volume online increases the
risk of further file system corruption. If the containing aggregate cannot honor the
space guarantees required by this volume, the volume online operation will fail. It is not
advisable to use volumes with their space guarantees disabled. Lack of free space can
lead to failure of writes which in turn can appear as data loss to some applications.
Parameters
This parameter specifies the name of the Vserver from which the volume is to be
brought online. If only one data Vserver exists, you do not need to specify this
parameter.
This parameter specifies the name of the volume that is to be brought online.
[-force | -f [true]] - Force Online
When this parameter is used, the volume will be brought online even if there is not
enough space available in the aggregate to honor the volume's space guarantee.
This parameter specifies whether the operation runs in the foreground. The default
setting is true (the operation runs in the foreground). When set to true, the command
will not return until the operation completes. This parameter applies only to Infinite
Volumes. For FlexVol volumes, the command always runs in the foreground.
Examples
1756
The following example brings a volume named vol1 online:

cluster1::> volume online vol1
Volume 'vs1:vol1' is now online.
volume rename
Rename an existing volume
Description
The volume rename command renames a volume. The volume name must be unique
among the other volumes on the same Vserver.
Parameters
This specifies the Vserver on which the volume is located. For a node's root volume,
use the name of the node for this parameter.
This specifies the volume that is to be renamed.
-newname <volume name> - Volume New Name
This specifies the volume's new name. A volume's name must start with an alphabetic
character (a to z or A to Z) and be 203 or fewer characters in length.
Examples
The following example renames a volume named vol3_backup as vol3_save on a
Vserver named vs0:
node::> volume rename -vserver vs0 -volume vol3_backup -newname vol3_save
1757
volume restrict
Restrict an existing volume
Description
The volume restrict command puts the volume in restricted state. If the volume
is online, then it will be made unavailable for data access as described under volume
offline.
Parameters
This specifies the name of the Vserver from which the volume is to be restricted. If only
one data Vserver exists, you do not need to specify this parameter.
This specifies the name of the volume that is to be restricted.
Examples
The following example restricts a volume named vol1:
cluster1::> volume restrict vol1
Volume 'vs1:vol1' is now restricted.
See Also
volume offline
1758
volume show-footprint
Display a list of volumes and their data and metadata footprints in their associated
aggregate.
Description
The volume show-footprint command displays information about the space used
in associated aggregates by volumes and features enabled in volumes. The command
output depends on the parameter or parameters specified with the command. If no
parameters are specified, the command displays the following information about all
volumes.
The volume show-footprint command is not supported for Infinite Volumes;
however, the command displays information about Infinite Volume constituents as if the
constituents were FlexVol volumes.
Parameters
specify.
| [-instance ] }
about all fields.
If this parameter and the -volume parameter are specified, the command displays
detailed information about the specified volume. If this parameter is specified by itself,
the command displays information about volumes on the specified Vserver.
If this parameter and the -vserver parameter are specified, the command displays
the command displays information about all volumes matching the specified name.
[-volume-msid <integer>] - Volume MSID
1759
If this parameter is specified, the command displays information only about the volume
that has the specified MSID.
[-volume-dsid <integer>] - Volume DSID
that has the specified DSID.
on the vserver which has the specified UUID.
If this parameter is specified, the command displays information only about the volumes
that are associated with the specified aggregate.
on the aggregate which have the specified UUID.
[-hostname <text>] - Hostname
that belong to the specified host.
[-tape-backup-metafiles-footprint {<integer>[KB|MB|GB|TB|PB]}] - Tape Backup
Metadata Footprint
whose tape backup metafiles use the specified amount of space in the aggregate.
[-tape-backup-metafiles-footprint-percent <percent>] - Tape Backup Metadata
Footprint Percent
whose tape backup metafiles use the specified percentage of space in the aggregate.
[-dedupe-metafiles-footprint {<integer>[KB|MB|GB|TB|PB]}] - Deduplication Footprint
whose deduplication metafiles use the specified amount of space in the aggregate.
[-dedupe-metafiles-footprint-percent <percent>] - Deduplication Footprint Percent
whose deduplication metafiles use the specified percentage of space in the aggregate.
[-dedupe-metafiles-temporary-footprint {<integer>[KB|MB|GB|TB|PB]}] - Temporary
Deduplication Footprint
1760
whose temporary deduplication metafiles use the specified amount of space in the
aggregate.
[-dedupe-metafiles-temporary-footprint-percent <percent>] - Temporary
Deduplication Footprint Percent
whose temporary deduplication metafiles use the specified percentage of space in the
aggregate.
[-volume-blocks-footprint {<integer>[KB|MB|GB|TB|PB]}] - Volume Data Footprint
whose data blocks use the specified amount of space in the aggregate.
This field is the total amount of data written to the volume. It includes data in the active
file system in the volume as well as data that is consumed by volume Snapshot copies.
This row only includes data and not reserved space, so when volumes have reserved
files, the volume's total used in the volume show-space command output can exceed
the value in this row.
[-volume-blocks-footprint-percent <percent>] - Volume Data Footprint Percent
whose data blocks use the specified percentage of space in the aggregate.
[-flexvol-metadata-footprint {<integer>[KB|MB|GB|TB|PB]}] - Flexible Volume
Metadata Footprint
whose file system metadata uses the specified amount of space in the aggregate.
This field includes the space used or reserved in the aggregate for metadata associated
with this volume.
[-flexvol-metadata-footprint-percent <percent>] - Flexible Volume Metadata Footprint
Percent
whose file system metadata uses the specified percentage of space in the aggregate.
[-delayed-free-footprint {<integer>[KB|MB|GB|TB|PB]}] - Delayed Free Blocks
whose delayed free blocks use the specified amount of space in the aggregate.
When Data ONTAP frees space in a volume, this space is not always immediately
shown as free in the aggregate. This is because the operations to free the space in
the aggregate are batched for increased performance. Blocks that are declared free
1761
in the FlexVol volume but which are not yet free in the aggregate are called "delayed
free blocks" until the associated delayed free blocks are processed. For SnapMirror
destinations, this row will have a value of 0 and will not be displayed.
[-delayed-free-footprint-percent <percent>] - Delayed Free Blocks Percent
that have the specified amount of blocks waiting to be freed in the aggregate. This
space is called "delayed free blocks".
[-snapmirror-destination-footprint {<integer>[KB|MB|GB|TB|PB]}] - SnapMirror
Destination Footprint
whose SnapMirror transfer uses the specified amount of space in the aggregate.
During a SnapMirror transfer, this row will include incoming SnapMirror data and
SnapMirror-triggered delayed free blocks from previous SnapMirror transfers.
[-snapmirror-destination-footprint-percent <percent>] - SnapMirror Destination
Footprint Percent
whose SnapMirror transfer uses the specified percentage of space in the aggregate.
[-volume-guarantee-footprint {<integer>[KB|MB|GB|TB|PB]}] - Volume Guarantee
whose guarantees use the specified amount of space in the aggregate.
This field includes the amount of space reserved by this volume in the aggregate for
future writes. The amount of space reserved depends on the guarantee type (the
provisioning mode) of the volume.
For a "volume" guaranteed volume, this is the size of the volume minus the amount in
the Volume Data Footprint row.
For a "file" guaranteed volume, this is the sum of all of the space reserved for hole fills
and overwrites in all of the space reserved files in the volume.
[-volume-guarantee-footprint-percent <percent>] - Volume Guarantee Percent
whose guarantees use the specified percentage of space in the aggregate.
[-file-operation-metadata {<integer>[KB|MB|GB|TB|PB]}] - File Operation Metadata
that have file operation metadata using the specified amount of space in the aggregate.
1762
This metadata is used by file move and copy operations. Although it is not returned as
free space once the operations are complete, it can be reused by future file operations.
[-file-operation-metadata-percent <percent>] - File Operation Metadata Percent
that have file operation metadata using the specified percentage of space in the
aggregate.
[-total-footprint {<integer>[KB|MB|GB|TB|PB]}] - Total Footprint
which use the specified amount of space in the aggregate. This field is the sum of the
other rows in this table.
[-total-footprint-percent <percent>] - Total Footprint Percent
which use the specified percentage of space in the aggregate.
[-aggregate-size {<integer>[KB|MB|GB|TB|PB]}] - Containing Aggregate Size
that are associated with an aggregate of the specified size.
Examples
The following example displays information about all volumes in the system
cluster1::> volume show-footprint

Vserver : nodevs
Volume
: vol0
Feature
Used
Used%
----------
-----
Volume Data Footprint
103.1MB
11%
Volume Guarantee
743.6MB
83%
Flexible Volume Metadata
4.84MB
1%
Delayed Frees
4.82MB
1%
856.3MB
95%
--------------------------------
Total Footprint
Vserver : thevs
1763
Volume
: therootvol
Feature
-------------------------------Volume Data Footprint
Volume Guarantee
Used
Used%
----------
-----
116KB
0%
19.83MB
1%
208KB
0%
60KB
0%
20.20MB
1%
Delayed Frees
Total Footprint
Vserver : thevs
Volume
: thevol
Feature
-------------------------------Volume Data Footprint
Volume Guarantee
Delayed Frees
Total Footprint
Used
Used%
----------
-----
128KB
0%
2.00GB
76%
11.38MB
0%
428KB
0%
2.01GB
76%
See Also
volume show-space
1764
volume show-space
Display space usage for volume(s)
Description
The volume show-space command displays information about space usage within
the volume. The command output depends on the parameter or parameters specified
with the command. If no parameters are specified, the command displays the following
information about all volumes.
The volume show-space command is not supported for Infinite Volumes; however,
the command displays information about Infinite Volume constituents as if the
constituents were FlexVol volumes.
Parameters
specify.
| [-instance ] }
about all fields.
[-volume-msid <integer>] - Volume MSID
1765
that has the specified MSID.
[-volume-dsid <integer>] - Volume DSID
that has the specified DSID.
on the vserver which has the specified UUID.
that are associated with the specified aggregate.
on the aggregate which have the specified UUID.
[-hostname <text>] - Hostname
that belong to the specified host.
[-user-data {<integer>[KB|MB|GB|TB|PB]}] - User Data
or volumes that have the specified amount of space in use by user data in the volume.
This is the amount of data written to the volume via CIFS, NFS or SAN protocols plus
the metadata (for example indirect blocks, directory blocks) directly associated with user
files plus the space reserved in the volume for these files (hole and overwrite reserves).
This is the same information displayed by running the Unix du command on the mount
point.
[-user-data-percent <percent_no_limit>] - User Data Percent
or volumes that have the specified percentage of space in use by user data in the
volume.
[-dedupe-metafiles {<integer>[KB|MB|GB|TB|PB]}] - Deduplication
or volumes that have the specified amount of space in use by deduplication metafiles in
the volume.
1766
[-dedupe-metafiles-percent <percent>] - Deduplication Percent

or volumes that have the specified percentage of space in use by deduplication
metafiles in the volume.
[-dedupe-metafiles-temporary {<integer>[KB|MB|GB|TB|PB]}] - Temporary
Deduplication
or volumes that have the specified amount of space in use by temporary deduplication
metafiles in the volume.
[-dedupe-metafiles-temporary-percent <percent>] - Temporary Deduplication Percent
volume or volumes that have the specified percentage of space in use by temporary
deduplication metafiles in the volume.
[-filesystem-metadata {<integer>[KB|MB|GB|TB|PB]}] - Filesystem Metadata
or volumes that have the specified amount of space in use by file system metadata in
the volume.
[-filesystem-metadata-percent <percent>] - Filesystem Metadata Percent
or volumes that have the specified percentage of space in use by file system metadata
in the volume.
[-snapmirror-metadata {<integer>[KB|MB|GB|TB|PB]}] - SnapMirror Metadata
or volumes that have the specified amount of space in use by SnapMirror metafiles in
the volume.
Between SnapMirror transfers, some metadata is maintained to support storage-efficient
transfers. During transfers, some additional space is used temporarily. This space is
used in all SnapMirror destination volumes.
[-snapmirror-metadata-percent <percent>] - SnapMirror Metadata Percent
or volumes that have the specified percentage of space in use by SnapMirror metafiles
inside the volume.
[-tape-backup-metadata {<integer>[KB|MB|GB|TB|PB]}] - Tape Backup Metadata
1767
or volumes that have the specified amount of space in use by tape backup metafiles in
the volume.
[-tape-backup-metadata-percent <percent>] - Tape Backup Metadata Percent
or volumes that have the specified percentage of space in use by tape backup metafiles
in the volume.
[-quota-metafiles {<integer>[KB|MB|GB|TB|PB]}] - Quota Metadata
or volumes that have the specified amount of space in use by quota metafiles.
[-quota-metafiles-percent <percent>] - Quota Metadata Percent
or volumes that have the specified percentage of space in use by quota metafiles.
[-inodes {<integer>[KB|MB|GB|TB|PB]}] - Inodes
or volumes that have the specified amount of space in use by the inode metafile in the
volume.
This is the amount of space required to store inodes in the file system and is
proportional to the maximum number of files ever created in the volume. The inode file
is not compacted or truncated, so if a large number of files are created and then deleted,
the inode file does not shrink.
[-inodes-percent <percent>] - Inodes Percent
or volumes that have the specified percentage of space in use by the inode metafile in
the volume.
[-snapshot-reserve {<integer>[KB|MB|GB|TB|PB]}] - Snapshot Reserve
or volumes that have the specified amount of space in use by the Snapshot reserve in
the volume.
[-snapshot-reserve-percent <percent>] - Snapshot Reserve Percent
or volumes that have the specified percentage of space in use by the Snapshot reserve
in the volume.
1768
[-snapshot-reserve-unusable {<integer>[KB|MB|GB|TB|PB]}] - Snapshot Reserve

Unusable
or volumes that have the specified amount of space reserved but unusable in the
volume.
Snapshot reserve can be diminished under certain conditions to accomodate volume
metadata. Creating space in the volume will make this space available.
[-snapshot-reserve-unusable-percent <integer>] - Snapshot Reserve Unusable
Percent
or volumes that have the specified percentage of space reserved but unusable.
[-snapshot-spill {<integer>[KB|MB|GB|TB|PB]}] - Snapshot Spill
or volumes that have the specified amount of space in use by their Snapshot spill.
If Snapshot used space exceeds the Snapshot reserve it is considered to spill out of
the reserve. This space cannot be used by the active file system until Snapshots are
deleted.
[-snapshot-spill-percent <percent>] - Snapshot Spill Percent
or volumes that have the specified percentage of space in use by the Snapshot spill.
[-performance-metadata {<integer>[KB|MB|GB|TB|PB]}] - Performance Metadata
or volumes that have the specified amount of space in use for performance optimization
in the volume.
[-performance-metadata-percent <percent>] - Performance Metadata Percent
or volumes that have the specified percentage of space in use for performance
optimization in the volume.
[-total-used {<integer>[KB|MB|GB|TB|PB]}] - Total Used
or volumes that have the specified amount of space in use by the volume, including the
space used by the Snapshot reserve.
This is equivalent to the used field in the output of the volume show command.
[-total-used-percent <percent_no_limit>] - Total Used Percent
1769
or volumes that have the specified percentage of space in use by the volume, including
the space used by the Snapshot reserve.
or volumes that have the specified amount of physical space in use by the volume.
This differs from total-used space by the space that is reserved for future writes. The
value includes blocks in use by Snapshot copies.
or volumes that have the specified percentage of physical space in use in the volume
based on volume size including the space reserved for Snapshot copies.
Examples
The following example shows how to display details for all volumes.
cluster1::> volume show-space

Vserver : nodevs
Volume
: vol0
Feature
Used
Used%
----------
------
163.4MB
3%
172KB
0%
2.93MB
0%
Snapshot Reserve
292.9MB
5%
Total Used
459.4MB
8%
Total Physical Used
166.4MB
3%
Used
Used%
-------------------------------User Data
Filesystem Metadata
Inodes
Vserver : thevs
Volume
Feature
1770
: rootvol
--------------------------------
----------
------
100KB
0%
Filesystem Metadata
76KB
0%
Inodes
24KB
0%
1MB
5%
1.20MB
6%
200KB
1%
User Data
Snapshot Reserve
Total Used
Total Physical Used
Vserver : vs1
Volume
: vol1
Feature
-------------------------------User Data
Filesystem Metadata
Inodes
Used
Used%
----------
------
180.8MB
74%
280KB
0%
12KB
0%
Snapshot Reserve
12.20MB
5%
Total Used
193.3MB
79%
Total Physical Used
192.9MB
79%
The following example shows all Volumes that have a snap reserve greater than 2 MB:
cluster1::> volume show-space -snapshot-reserve >2m
Vserver : thevs
Volume
: rootvol
Feature
Used
Used%
----------
------
User Data
92KB
0%
Filesystem Metadata
84KB
0%
--------------------------------
1771
Inodes
Snapshot Reserve
Total Used
Total Physical Used
24KB
0%
1MB
5%
1.20MB
6%
200KB
1%
See Also
volume show
1772
volume show
Display a list of volumes
Description
The volume show command displays information about volumes. The command
output depends on the parameter or parameters specified with the command. If no
parameters are specified, the command displays the following information about all
volumes:
Vserver name
Volume name
Aggregate name
State (online, offline, restricted, or force-online)
Type (RW for read-write or DP for data-protection)
Size
Available size
Percentage of space used
To display detailed information about a single volume, run the command with the vserver and -volume parameters. The detailed view provides all of the information in
the previous list and the following additional information:
Name ordinal
Volume data set ID
Volume master data set ID
Volume style (trad, flex or infinitevol)
Whether the volume is a Cluster volume or Node volume
Export policy name
User ID
Group ID
1773
Security style (unix, ntfs, mixed or unified)

UNIX permissions
Junction path
Junction path source
Whether the junction path is active
Parent volume name
Vserver root volume
Comment
Filesystem size
Total user-visible size
Used size
Used percentage
Volume nearly full threshold percent
Volume full threshold percent
Autosize enabled
Maximum autosize
(DEPRECATED)-Autosize increment
Minimum autosize
Autosize grow threshold percent
Autosize shrink threshold percent
Autosize mode
Total files
Files used
Maximum directory size
Space guarantee style
Whether a space guarantee is in effect
Whether minimum readahead is enabled
Whether access time update is enabled
1774
Whether Snapshot directory access is enabled

Percentage of space reserved for Snapshot Copies
Percentage of Snapshot copy space used
Snapshot policy name
Creation time
If the filesystem size is fixed
Overwrite reserve
Fractional reserve
Which space management strategy to try first
Language
Whether there's one data volume per member aggregate
Concurrency level
Optimization policy
Whether the volume is a clone
Volume UUID
Whether failover is enabled
Failover state
Extent option
Read reallocation option
Consistency state
Whether volume is quiesced on disk
Whether volume is quiesced in memory
Whether volume contains shared or compressed data
Space saved by storage efficiency
Percentage of space saved by storage efficiency
Space saved by deduplication
Percentage of space saved by deduplication
Space shared by deduplication
1775
Space saved by compression

Percentage of space saved by compression
Volume Size Used by Snapshot Copies
Caching policy
To display detailed information about all volumes, run the command with the instance parameter. Fields not supported by Infinite Volumes will display a value of
"-".
You can specify additional parameters to display information that matches only those
parameters. For example, to display information only about data-protection volumes, run
the command with the -type DP parameter.
Parameters
This specifies the fields that need to be displayed. The fields Vserver and policy are the
default fields (see example).
| [-junction ]
If this parameter is specified, the command displays the following information:
Vserver name
Volume name
Whether the volume's junction is active
Junction path
Junction path source (if the volume is a mirror)
| [-settings ] (privilege: advanced)
Vserver name
Volume name
Whether minimum readahead is enabled on the volume
Whether the access time is updated on inodes when a file on the volume is read
Whether clients have access to .snapshot directories
1776
Whether automatic Snapshot copies are enabled on the volume

| [-instance ] }
or volumes that are located on the specified storage aggregate.
or volumes that have the specified size. Size is the maximum amount of space a volume
can consume from its associated aggregate(s), including user data, metadata, Snapshot
copies, and Snapshot reserve. Note that for volumes without a -space-guarantee
of volume, the ability to fill the volume to this maximum size depends on the space
available in the associated aggregate or aggregates.
[-name-ordinal <text>] - Name Ordinal (privilege: advanced)
If this parameter is specified, it denotes the ordinal assignment used in relation to this
volume's name. Ordinals are used to disambiguate volumes that have the same base
name on the same controller. A value of "0" indicates that the base volume name is
unique on the controller. A value greater than zero indicates that the volume's base
name is used by two or more volumes on the same controller, and that appending "(n)"
to this volume's name uniquely identifies it on this controller.
[-dsid <integer>] - Volume Data Set ID
or volumes that match the specified data set ID.
[-msid <integer>] - Volume Master Data Set ID
or volumes that match the specified master data set ID.
1777

or volumes that have the specified state.
[-type {RW|DP|DC}] - Volume Type
or volumes of the specified volume type (RW for read-write or DP for data-protection).
[-volume-style {flex|infinitevol}] - Volume Style
that have the specified style. Possible values are flex for FlexVol volumes, and infinitevol
[-is-cluster-volume {true|false}] - Is Cluster-Mode Volume
If this parameter is specified, the command displays information only about cluster
volumes (true) or node root volumes and other node scoped volumes (false).
[-is-constituent {true|false}] - Is Constituent Volume
If this parameter is specified, the command displays information only about volumes that
either are or are not constituents of an Infinite Volume, depending on the value provided.
or volumes that use the specified export policy.
or volumes whose root is owned by the specified user.
or volumes whose root is owned by the specified group.
or volumes that have the specified security style (unix for UNIX mode bits, ntfs for CIFS
ACLs, mixed for both styles or unified for Unified UNIX, NFS and CIFS permissions).
or volumes whose default UNIX permissions match the specified permissions. Specify
1778
see the UNIX or Linux documentation.
or volumes that have the specified junction path.
[-junction-path-source {RW volume|LS mirror}] - Junction Path Source
or volumes that have the specified junction path source.
[-junction-active {true|false}] - Junction Active
or volumes whose junction paths have the specified status.
[-junction-parent <volume name>] - Junction Parent Volume
or volumes that have the specified parent volume.
[-vsroot {true|false}] - Vserver Root Volume (privilege: advanced)
or volumes that match the specified setting; that is, whether they are the root volumes
for their Vservers.
or volumes that match the specified comment text.
[-available {<integer>[KB|MB|GB|TB|PB]}] - Available Size
or volumes that have the specified available size. Available is the amount of free space
currently available to be used by this volume. For a volume with a -space-guarantee
of type volume, available is always -total minus -used. For volumes that do not
have a -space-guarantee of type volume, available could be reduced if the volumes
associated aggregate or aggregates are space constrained.
[-filesystem-size {<integer>[KB|MB|GB|TB|PB]}] - Filesystem Size
or volumes that have the specified filesystem size. Filesystem size is the same as the
volumes -size unless the volume is or was a physical replica destination. In this case,
the file system size corresponds to the -size of the source volume, until -filesyssize-fixed is set to false.
1779
[-total {<integer>[KB|MB|GB|TB|PB]}] - Total User-Visible Size

or volumes that have the specified total size. Total is the total space available for user
data and file system metadata. It does not include the Snapshot reserve.
[-used {<integer>[KB|MB|GB|TB|PB]}] - Used Size
or volumes that have the specified used size. Used is the amount of space occupied
by user data and file system metadata. It includes Snapshot spill (the amount of space
by which Snapshot copies exceed Snapshot reserve). It does not include the Snapshot
reserve.
[-percent-used <percent>] - Used Percentage
or volumes that have the specified percentage of used space. This row is based on a
value of used space that includes the space used by Snapshot copies or the Snapshot
reserve (whichever is greater) in relation to the current volume size.
[-space-nearly-full-threshold-percent <percent>] - Volume Nearly Full Threshold
Percent
or volumes that have the specified nearly full threshold percent.
[-space-full-threshold-percent <percent>] - Volume Full Threshold Percent
or volumes that have the specified full threshold percent.
or volumes that have the specified maximum automatic size.
Note:
or volumes that have the specified increment size for automatic sizing.
1780
or volumes that have the specified minimum automatic size.
or volumes that have the specified automatic grow used space threshold percentage.
Percentage
or volumes that have the specified automatic shrink used space threshold percentage.
[-autosize-mode {off|grow|grow_shrink}] - Autosize Mode
or volumes that have the specified automatic sizing mode setting.
[-autosize {true|false}] - Autosize Enabled (for flexvols only)
or volumes that have the specified automatic sizing setting.
[-files <integer>] - Total Files (for user-visible data)
or volumes that have the specified number of files.
[-files-used <integer>] - Files Used (for user-visible data)
or volumes that have the specifies number of files used.
advanced)
or volumes that have the specified maximum directory size.
or volumes that have the specified space-reservation policy. If the value of -spaceguarantee is none, the value of -space-guarantee-enabled is always true. In
other words, because there is no guarantee, the guarantee is always in effect. If the
value of -space-guarantee is volume, the value of -space-guarantee-enabled
can be true or false, depending on whether the guaranteed amount of space was
available when the volume was mounted.
[-space-guarantee-enabled {true|false}] - Space Guarantee in Effect
1781
or volumes that have the specified space-guarantee setting. If the value of -spaceguarantee is none, the value of -space-guarantee-enabled is always true. In
other words, because there is no guarantee, the guarantee is always in effect. If the
value of -space-guarantee is volume, the value of -space-guarantee-enabled
can be true or false, depending on whether the guaranteed amount of space was
available when the volume was mounted.
[-min-readahead {true|false}] - Minimum Read Ahead (privilege: advanced)
or volumes that have the specified minimum-readahead setting.
[-atime-update {true|false}] - Access Time Update Enabled (privilege: advanced)
or volumes that have the specified access-time update setting.
[-snapdir-access {true|false}] - Snapshot Directory Access Enabled
or volumes that have the specified Snapshot-copy access setting.
or volumes that have the specified percentage of space reserved for Snapshot copies.
[-snapshot-space-used <percent_no_limit>] - Snapshot Reserve Used
or volumes that have the specified used percentage of the reserve for Snapshot copies.
or volumes that use the specified Snapshot policy.
[-create-time <Date>] - Creation Time
or volumes that have the specified creation time.
[-language <Language code>] - Language
or volumes that store data in the specified language. To determine the available
languages, enter volume show-language?at the clustershell command prompt.
[-clone-volume {true|false}] - Clone Volume
1782
are clones (true) or not clones (false).
[-node {<nodename>|local}] - Node name
If this parameter is specified, the command displays information only the volume or
volumes that are located on the specified storage system.
[-uuid <UUID>] - UUID of the Volume (privilege: advanced)
or volumes that match the specified UUID.
If this parameter is specified, the command displays information only about volumes for
which failover is enabled (on) or disabled (off).
[-in-nvfailed-state {true|false}] - Volume's NVFAIL State
If this parameter is specified, the command displays information only about volumes
which are in the failed over state (true) or not (false).
[-dr-force-nvfail {on|off}] - Force NVFAIL on MetroCluster Switchover
If this parameter is specified, the command displays information only about volumes for
which dr-force-nvfail is enabled (on) or disabled (off).
[-filesys-size-fixed {true|false}] - Is File System Size Fixed
or volumes that have the specified filesys-size-fixed setting.
[-extent-enabled {off|on|space-optimized}] - Extent Option
have extents enabled (on), not enabled (off) or space optimized (space-optimized).
[-overwrite-reserve {<integer>[KB|MB|GB|TB|PB]}] - Reserved Space for Overwrites
or volumes that have the specified overwrite-reserve setting.
[-fractional-reserve <percent>] - Fractional Reserve
or volumes that have the specified fractional-reserve setting.
[-space-mgmt-try-first {volume_grow|snap_delete}] - Primary Space Management
Strategy
1783
or volumes that have the specified space-mgmt-try-first setting. Possible values
are volume_grow and snap_delete.
[-read-realloc {off|on|space-optimized}] - Read Reallocation Option
that have read reallocation enabled (on), not enabled (off) or space optimized (spaceoptimized).
[-is-inconsistent {true|false}] - Inconsistency in the File System
are inconsistent (true) or consistent (false) in the file system.
[-is-quiesced-on-disk {true|false}] - Is Volume Quiesced (On-Disk)
are quiesced (true) or not quiesced (false) on disk.
[-is-quiesced-in-memory {true|false}] - Is Volume Quiesced (In-Memory)
are quiesced (true) or not quiesced (false) in memory.
[-transition-state <state>] - Transition Operation State (privilege: advanced)
or volumes that match the specified transition state.
[-transition-behavior {data-move|data-protection|none}] - Transition Behavior
or volumes that match the specified transition behavior. Possible values are:
data-move: Volumes that are being moved from a system operating in 7-Mode.
data-protection: Volumes that are being replicated from a system operating in 7Mode for disaster recovery.
none: Volumes that are not part of transition.
[-is-copied-for-transition {true|false}] - Copied for Transition (privilege: advanced)
or volumes that match the specified value based on whether the volume is copied for
transition or not.
[-is-transitioned {true|false}] - Transitioned (privilege: advanced)
1784
or volumes that match the specified value based on whether the volume is transitioned
or not.
[-is-sis-volume {true|false}] - Volume Contains Shared or Compressed Data
If this parameter is specified, the command displays information only about those
volumes that match the specified storage efficiency setting. Infinite Volumes will
report the aggregated setting of their constituent data volumes as true or false if all
constituents have the same setting, otherwise no value will be reported.
[-sis-space-saved {<integer>[KB|MB|GB|TB|PB]}] - Space Saved by Storage Efficiency
volumes that have the specified amount of space saved by the storage efficiency
technology.
[-sis-space-saved-percent <percent>] - Percentage Saved by Storage Efficiency
volumes that have the specified percentage of space saved by the storage efficiency
technology.
[-dedupe-space-saved {<integer>[KB|MB|GB|TB|PB]}] - Space Saved by Deduplication
volumes that have the specified amount of space saved due to deduplication.
[-dedupe-space-saved-percent <percent>] - Percentage Saved by Deduplication
volumes that have the specified percentage of space saved due to deduplication.
[-dedupe-space-shared {<integer>[KB|MB|GB|TB|PB]}] - Space Shared by
Deduplication
volumes that have the specified amount of shared space due to deduplication.
[-compression-space-saved {<integer>[KB|MB|GB|TB|PB]}] - Space Saved by
Compression
volumes that have the specified amount of space saved due to compression.
[-compression-space-saved-percent <percent>] - Percentage Space Saved by
Compression
volumes that have the specified percentage of space saved due to compression.
1785
[-size-used-by-snapshots {<integer>[KB|MB|GB|TB|PB]}] - Volume Size Used by

Snapshot Copies
If this parameter is specified, the command displays information about those volumes
that have the specified volume size used by Snapshot copies.
[-block-type {32-bit|64-bit}] - Block Type
If this parameter is specified, the command displays information about only the volumes
with the specified indirect block format. Possible values are 32-bit to display 32-bit
volumes and 64-bit to display 64-bit volumes.
[-is-moving {true|false}] - Is Volume Moving
are moving (true) or not moving (false).
[-hybrid-cache-eligibility {read|read-write}] - Flash Pool Caching Eligibility
or volumes with the specified Flash Pool caching attributes. Possible caching attributes
are:
'read' ... Indicates that the volume cannot participate in write caching.
'read-write' ... Indicates that the volume can participate in read and write caching.
[-hybrid-cache-write-caching-ineligibility-reason <text>] - Flash Pool Write Caching
Ineligibility Reason
or volumes which are ineligible to participate in write caching due to the specified
reason.
[-is-managed-by-service {true|false}] - Managed By Storage Service
If this parameter is specified as true, only display volumes that are managed by
storage services.
advanced)
match the specified storage service.
Use
1786
Setting this parameter displays information only about Infinite Volumes that either do or
do not have namespace mirror constituents for SnapDiff use, depending on the value
provided. This parameter applies to Infinite Volumes only.
lists a directory that contains one or more files with inaccessible attributes. If this
parameter is specified, the command displays information only about volumes that
match the specified action. This parameter is not supported for FlexVol volumes.
[-constituent-role <Constituent Roles>] - Constituent Volume Role
constituent volume or volumes that are of the specified role. This parameter applies to
match the specified namespace constituent size.
If this parameter is specified, the command displays information only about the Infinite
Volume or Infinite Volumes that have the specified maximum data constituent size. This
match the specified Qos policy group.
If this parameter is specified, the command displays the volumes that match the
specified caching policy.
[-is-volume-in-cutover {true|false}] - Is Volume Move in Cutover Phase
are in the cutover phase (true) or not in the cutover phase (false) of a volume move.
[-snapshot-count <integer>] - Number of Snapshot Copies in the Volume
that have the specified number of Snapshot copies.
1787
[-vbn-bad-present {true|false}] - VBN_BAD may be present in the active filesystem

may have VBN_BAD present in its active filesystem (true) or do not have VBN_BAD
present in its active filesystem (false).
advanced)
or volumes that are eligible for consideration by the Auto Balance Aggregate feature.
[-is-vol-on-hybrid-aggr {true|false}] - Is Volume on a hybrid aggregate
associated with a Flash Pool aggregate (true) or not (false).
or volumes that have the specified physical used size. This differs from total-used space
by the space that is reserved for future writes. The value includes blocks in use by
Snapshot copies.
or volumes that have the specified physical used percent based on volume size
including the space reserved for Snapshot copies.
Examples
The following example displays information about all volumes on the Vserver named
vs1:
cluster1::> volume show -vserver vs1
Vserver
Volume
Aggregate
State
Type
Size
Available Used%
--------- ------------ ------------ ---------- ---- ---------- ---------- -----
1788
vs1
vol1
aggr1
online
RW
2GB
1.9GB
5%
vs1
vol1_dr
aggr0_dp
online
DP
200GB
160.0GB
20%
vs1
vol2
aggr0
online
RW
150GB
110.3GB
26%
vs1
vol2_dr
aggr0_dp
online
DP
150GB
110.3GB
26%
vs1
vol3
aggr1
online
RW
150GB
120.0GB
20%
vs1
vol3_dr
aggr1_dp
online
DP
150GB
120.0GB
20%
vs1
vol4
aggr1
online
RW
200GB
159.8GB
20%
vs1
vol4_dr
aggr1_dp
online
DP
200GB
159.8GB
20%
vs1
vol5
aggr2
online
RW
200GB
102.3GB
48%
vs1
vol5_dr
aggr2_dp
online
DP
200GB
102.3GB
48%
vs1
vol6
aggr2
online
RW
150GB
117.2GB
21%
vs1
vol6_dr
aggr2_dp
online
DP
150GB
117.2GB
21%
vs1
vol7
aggr3
online
RW
150GB
118.5GB
20%
vs1
vol7_dr
aggr3_dp
online
DP
150GB
118.5GB
20%
vs1
vol8
aggr3
online
RW
150GB
90.03GB
39%
vs1
vol8_dr
aggr3_dp
online
DP
150GB
90.03GB
39%
vs1
vol9
aggr4
online
RW
150GB
43.67GB
70%
vs1
vol9_dr
aggr4_dp
online
DP
150GB
43.67GB
70%
vs1
vol10
aggr4
online
RW
150GB
108.7GB
27%
vs1
vol10_dr
aggr4_dp
online
DP
150GB
108.7GB
27%
vs1
vol11
aggr5
online
RW
250GB
45.65GB
81%
vs1
vol11_dr
aggr5_dp
online
DP
250GB
45.65GB
81%
The following example displays detailed information about a volume named vol1 on a
Vserver named vs1:
cluster1::*> volume show -vserver vs1 -volume vol1
Vserver Name: vs1
Volume Name: vol1
Aggregate Name: aggr1
Volume Size: 30MB
Volume Data Set ID: 1026
Volume Master Data Set ID: 2147484674
Volume State: online
Volume Type: RW
Volume Style: flex
Is Cluster Volume: true
Is Constituent Volume: false
Export Policy: default
User ID: root
Group ID: daemon
Security Style: mixed
Unix Permissions: ---rwx-----Junction Path: Junction Path Source: Junction Active: Junction Parent Volume: Comment:
1789
Available Size: 23.20MB

Filesystem Size: 30MB
Total User-Visible Size: 28.50MB
Used Size: 5.30MB
Used Percentage: 22%
Volume Nearly Full Threshold Percent: 95%
Volume Full Threshold Percent: 98%
Maximum Autosize (for flexvols only): 8.40GB
Autosize Increment (for flexvols only): 358.4MB
Minimum Autosize: 30MB
Autosize Grow Threshold Percentage: 85%
Autosize Shrink Threshold Percentage: 50%
Autosize Mode: off
Autosize Enabled (for flexvols only): false
Total Files (for user-visible data): 217894
Files Used (for user-visible data): 98
Space Guarantee Style: volume
Space Guarantee In Effect: true
Snapshot Directory Access Enabled: true
Space Reserved for Snapshot Copies: 5%
Snapshot Reserve Used: 98%
Snapshot Policy: default
Creation Time: Mon Jul 08 10:54:32 2013
Language: C.UTF-8
Clone Volume: false
Node name: cluster-1-01
NVFAIL Option: off
Force NVFAIL on MetroCluster Switchover: off
Is File System Size Fixed: false
Extent Option: off
Reserved Space for Overwrites: 0B
Fractional Reserve: 100%
Primary Space Management Strategy: volume_grow
Read Reallocation Option: space-optimized
Inconsistency in the File System: false
Is Volume Quiesced (On-Disk): false
Is Volume Quiesced (In-Memory): false
Transition Operation State: none
Copied for Transition: false
Transitioned: true
1790
Volume Contains Shared or Compressed Data: false

Efficiency Policy: default
UUID of the Efficiency Policy: b0f36cd7e7bc-11e2-9994-123478563412
Space Saved by Storage Efficiency: 0B
Percentage Saved by Storage Efficiency: 0%
Space Saved by Deduplication: 0B
Percentage Saved by Deduplication: 0%
Space Shared by Deduplication: 0B
Space Saved by Compression: 0B
Percentage Space Saved by Compression: 0%
Volume Size Used by Snapshot Copies: 1.48MB
Block Type: 64-bit
Is Volume Moving: false
Flash Pool Caching Eligibility: read-write
Flash Pool Write Caching Ineligibility Reason: Managed By Storage Service: Enable Object Store: Create Namespace Mirror Constituents For SnapDiff Use: Constituent Volume Role: QoS Policy Group Name: Caching Policy Name: auto
Is Volume Move in Cutover Phase: false
Number of Snapshot Copies in the Volume: 10
VBN_BAD may be present in the active filesystem: false
Is Eligible for Auto Balance Aggregate: -
1791
volume size
Set/Display the size of the volume.
Description
The volume size command allows the user to set or display the volume size. If newsize is not specified then the current volume size is displayed.
Parameters
This parameter can be used to specify the Vserver on which the volume is located.
This parameter specifies the volume for which the user wants to set or display the size.
[-new-size <text>] - [+|-]<New Size>
This optional parameter specifies the size of the volume. It can be used to set the
volume size to a particular number or grow/shrink the size by a particular amount.
The size is specified as a number (preceded with a sign for relative growth/shrinkage)
specified number is rounded up to the nearest 4 KB. The minimum size for a flexible
volume is 20 MB, and the maximum size depends on hardware platform and free space
in the containing aggregate. If the volume's space guarantee is currently disabled, its
size cannot be increased. This parameter is not supported on Infinite Volumes that are
managed by storage services.
Examples
The following example shows the size of a volume called vol1.
cluster1::> vol size vol1
(volume size)
vol size: Flexible volume 'vs1:vol1' has size 2g.
The following example sets the size of a volume called vol1 to 1GB.
cluster1::> vol size vol1 1g
1792
(volume size)
vol size: Flexible volume 'vs1:vol1' size set to 1g.
The following example increases the size of a volume called vol1 by 500MB.
cluster1::> vol size vol1 +500m
(volume size)
vol size: Flexible volume 'vs1:vol1' size set to 1.49g.
The following example decreases the size of a volume called vol1 by 250MB.
cluster1::> vol size vol1 -250m
(volume size)
vol size: Flexible volume 'vs1:vol1' size set to 1.24g.
volume unmount
Unmount a volume
Description
The volume unmount command unmounts a volume from its parent volume. The
volume can be remounted at the same or a different location by using the volume
mount command.
Parameters
This specifies the volume that is to be unmounted.
Examples
The following example unmounts a volume named vol2 on a Vserver named vs0:
node::> volume unmount -vserver vs0 -volume vol2
See Also
1793
volume mount
1794
volume aggregate vacate

Move all Infinite Volume constituents from one aggregate to another.
level.
Description
The volume aggregate vacate command moves all constituents belonging to a
given Infinite Volume from the source aggregate to the destination aggregate.
The volume aggregate vacate command is not supported for FlexVol volumes.
Parameters
The name of the Vserver that owns the volume.
The name of the volume.
-source-aggregate <aggregate name> - Source Aggregate
The source aggregate from which all Infinite Volume constituents are being moved.
-destination-aggregate <aggregate name> - Destination Aggregate
The destination aggregate to which the Infinite Volume constituents are being moved.
[-foreground | -w {true|false}] - Foreground Process
not specified, the default setting is false (the operation runs in the background). When
set to true, the command will not return until the process completes.
Examples
The following example moves all constituents of Infinite Volume repo_vol from aggr1 to
aggr2.
cluster1::> volume aggregate vacate -vserver vs0 -volume repo_vol -sourceaggregate aggr1 -destination-aggregate aggr2
1795
volume clone create

Create a FlexClone volume
Description
The volume clone create command creates a FlexClone volume on the aggregate
containing the specified parent volume. This command is not supported on Infinite
Volumes. The maximum volume clone hierarchy depth is 500 and the default depth is
60. You can optionally specify the following attributes for the new FlexClone volume:
Vserver on which the parent volume resides
Name of the FlexClone parent snapshot
Junction path where FlexClone volume should be mounted
State of the junction path
Space guarantee style (none, volume or file)
Comment
Whether the volume clone create command runs as a foreground or
background process
Parameters
This specifies the Vserver on which the parent volume resides. If only one data Vserver
-flexclone <volume name> - FlexClone Volume
This specifies the name of the FlexClone volume. The name must be unique within the
hosting Vserver.
[-type {RW|DP}] - FlexClone Type
This parameter specifies the type of FlexClone volume. A read-only FlexClone volume
is created if you specify the type as DP; otherwise a read-write FlexClone volume is
created.
-parent-volume | -b <volume name> - FlexClone Parent Volume
1796
This specifies the name of parent volume from which the FlexClone clone volume is
derived.
[-parent-snapshot <snapshot name>] - FlexClone Parent Snapshot
This specifies the name of the parent snapshot from which the FlexClone clone volume
is derived.
This specifies the junction path at which the new FlexClone clone volume should be
mounted.
This optionally specifies whether the volume's junction path is active. The default setting
is true. If the junction path is inactive, the volume does not appear in the Vserver's
namespace. This parameter is available only at the advanced privilege level and higher.
This optionally specifies the space-reservation policy for the FlexClone volume. A value
of file reserves space only for space-reserved files within the FlexClone volume. A
value of volume reserves space on the aggregate for the entire volume. A value of
none reserves no space on the aggregate, meaning that writes can fail if the aggregate
runs out of space. The default setting is inherited from the parent volume.
This optionally specifies a comment for the FlexClone volume.
This optionally specifies whether the FlexClone volume create operation runs as a
foreground process. The default setting is true (that is, the operation runs in the
foreground).
This parameter optionally specifies which QoS policy group to apply to the FlexClone
volume. The policy group defines measurable service level objectives (SLOs) that apply
to the storage objects with which the policy group is associated. If you do not assign
a policy group to the FlexClone volume, the system does not monitor and control the
traffic to the volume.
Examples
The following command creates a FlexClone volume fc_vol_1 from parent volume
fv2 on Vserver vs1 and the job runs as a foreground process.
1797
cluster1::> volume clone create -vserver vs1 -flexclone fc_vol_1 -parentvolume fv2 -junction-active true -foreground true -comment "Testing FlexClone
creation"
cluster1::> volume clone show fc_vol_1 -vserver vs1
Vserver Name: vs1
FlexClone Volume: fc_vol_1
FlexClone Parent Volume: fv2
FlexClone Parent Snapshot: clone_fc_vol_1.0
Junction Path: Junction Active: Space Guarantee Style: volume
FlexClone Aggregate: test_aggr
FlexClone Data Set ID: 1046
FlexClone Master Data Set ID: 2147484694
FlexClone Size: 19MB
Used Size: 108KB
Split Estimate: 0.00B
Inodes processed: Total Inodes: Percentage complete: Blocks Scanned: Blocks Updated: Comment: Testing FlexClone creation
1798
volume clone modify

Description
Parameters
Examples
1799
volume clone show

Display a list of FlexClones
Description
The volume clone show command displays information about FlexClone clone
volumes. This command is not supported on Infinite Volumes. By default, the command
displays the following information about all FlexClone volume clones:
Vserver name
FlexClone volume name
Parent volume name
Parent snapshot name
Whether a FlexClone volume is online or offline
To display detailed information about all FlexClone volumes, run the command with the
-instance parameter.
Parameters
Selects the fields to be displayed.
| [-estimate ]
Displays an estimate of the free disk space required in the aggregate to split the
indicated clone volume from its underlying parent volume. The value reported may differ
from the space actually required to perform the split, especially if the clone volume is
changing when the split is being performed.
| [-instance ] }
Displays detailed information about FlexClone volumes. If -flexclone is also
specified, the command displays detailed information about the FlexClone volume.
1800
Selects summary information for the FlexClone volumes on the specified Vserver. If
-flexclone is also specified, the command displays detailed information about the
specified FlexClone volume.
[-flexclone <volume name>] - FlexClone Volume
Selects summary information for the specified FlexClone volume. If -vserver is also
specified, the command displays detailed information about the specified FlexClone
volume.
Selects information for the specified type of FlexClone volume. The type can be
specified as either read-only (DP) or read-write (RW).
[-parent-volume | -b <volume name>] - FlexClone Parent Volume
Selects summary information for the FlexClone volumes that are clones of the specified
parent volume.
Selects summary information for the FlexClone volumes that are clones of the parent
volume to which the specified snapshot belongs.
[-state {online|restricted|offline|force-online|force-offline|mixed}] - FlexClone Volume
State
Selects summary information for the FlexClone volumes that are in the specified state.
Selects summary information for the FlexClone volumes that have the specified junction
path.
Selects summary information for the FlexClone volumes that have the specified junction
path status.
that have the specified space-reservation policy.
[-space-guarantee-enabled {true|false}] - Space Guarantee In Effect
Selects summary information for the FlexClone volumes that have the specified spaceguarantee setting.
[-aggregate <aggregate name>] - FlexClone Aggregate
1801
Selects summary information for the FlexClone volumes that reside on the specified
storage aggregate.
[-dsid <integer>] - FlexClone Data Set ID
Selects summary information for the FlexClone volumes that have the specified Data
Set ID.
[-msid <integer>] - FlexClone Master Data Set ID
Selects summary information for the FlexClone volumes that have the specified Master
Data Set ID.
[-size {<integer>[KB|MB|GB|TB|PB]}] - FlexClone Size
Selects summary information for the FlexClone volumes that have the specified size.
Selects summary information for the FlexClone volumes that have the specified amount
of used space.
[-split-estimate {<integer>[KB|MB|GB|TB|PB]}] - Split Estimate
Selects summary information for the FlexClone volumes that require the specified
amount of free disk space for splitting from the parent.
[-inodes-processed <integer>] - Inodes Processed
Selects summary information for the FlexClone volumes that have the specified number
of Inodes processed for splitting the FlexClone volume from its parent volume.
[-inodes-total <integer>] - Total Inodes
of total Inodes.
[-inode-percentage-complete <integer>] - Percentage Complete
Selects summary information for the FlexClone volumes that have specified percentage
of Inodes processed for splitting the FlexClone volume from its parent volume.
[-blocks-scanned <integer>] - Blocks Scanned
of blocks scanned for splitting the FlexClone volume from its parent volume.
[-blocks-updated <integer>] - Blocks Updated
of blocks updated for after splitting the FlexClone volume from its parent volume.
1802
Selects summary information for the FlexClone volumes that have the specified
comment.
Selects summary information for the FlexClone volumes that have the specified QoS
policy group.
Examples
The following example displays detailed information about all FlexClone volumes on
Vserver vs0:
cluster1::> volume clone show -vserver vs0
(volume clone show)
Vserver
FlexClone
Parent-Volume
Parent-Snapshot
--------- -------------- --------------- --------------vs0
fc_vol_1
test_vol
clone_fc_vol_1.0
fc_vol_2
test_vol2
clone_fc_vol_2.0
fc_vol_3
tv9
clone_fc_vol_3.0
tv8
tv7
clone_tv8.0
tv9
test_vol2
clone_tv9.0
The following example displays detailed information about FlexClone volume fc_vol_2
on Vserver vs0:
cluster1::> volume clone show -vserver vs0 -flexclone fc_vol_2
Vserver Name: vs0
FlexClone Parent Volume: test_vol2
FlexClone Parent Snapshot: clone_fc_vol_2.0
Junction Path: Junction Active: Space Guarantee Style: volume
FlexClone Aggregate: test_aggr
FlexClone Data Set ID: 1038
FlexClone Master Data Set ID: 2147484686
FlexClone Size: 47.50MB
Used Size: 128KB
1803
Split Estimate: 0.00B

Inodes processed: Total Inodes: Percentage complete: Blocks Scanned: Blocks Updated: Comment:
Qos Policy Group Name: pg1
The following example displays summary information about all FlexClone volumes
residing on Vserver vs0 along with the fields msid, dsid, state and parentvolume.
cluster1::> volume clone show -vserver vs0 -fields msid, dsid, state, parentvolume
vserver flexclone parent-volume state
dsid msid
------- --------- ------------- ------ ---- ---------vs0
fc_vol_1
test_vol
online 1037 2147484685
vs0
fc_vol_3
tv9
online 1039 2147484687
vs0
flex_clone1
fc_vol_1
online 1041 2147484689
vs0
fv_2
fc_vol_1
online 1043 2147484691
vs0
tv9
test_vol2
online 1036 2147484684
The following example displays summary information about all FlexClone volumes
residing on Vserver vs0 along with space-guarantee-enabled and spaceguarantee information about each FlexClone volume.
cluster1::> vol clone show -vserver vs0 -fields space-guarantee-enabled, spaceguarantee
(volume clone show)
vserver flexclone space-guarantee space-guarantee-enabled
------- --------- --------------- ----------------------vs0
fc_vol_1
volume
true
vs0
fc_vol_3
volume
true
vs0
flex_clone1
volume
true
vs0
fv_2
volume
true
vs0
tv9
volume
true
1804
volume clone split estimate

Estimates the space required by the containing-aggregate to split the FlexClone volume
Description
The volume clone split estimate command displays an estimate of the free disk
space required in the aggregate to split the indicated clone volume from its underlying
parent volume. The value reported might differ from the space actually required to
perform the split, especially if the clone volume is changing when the split is being
performed. This command is not supported on Infinite Volumes.
Parameters
This specifies the estimates for free disk space required for splitting FlexClone volumes
residing on this Vserver. If the -flexclone option is also specified, then the command
displays the free disk space estimate only for the specified FlexClone volume residing
on the specified Vserver.
This specifies the free disk space estimate for splitting this FlexClone volume.
This parameter specifies the type of FlexClone volume. A read-only FlexClone volume
is created if you specify the type as DP; otherwise a read-write FlexClone volume is
created.
[-parent-volume | -b <volume name>] - FlexClone Parent Volume
This specifies the free disk space estimates for splitting the FlexClone volumes cloned
off this parent volume.
This specifies the free disk space estimates for splitting the FlexClone volumes cloned
off this parent snapshot.
[-state {online|restricted|offline|force-online|force-offline|mixed}] - FlexClone Volume
State
1805
This specifies the free disk space estimates for splitting the FlexClone volumes with the
specified state.
This specifies the free disk space estimates for splitting the FlexClone volumes mounted
at this junction path.
If this specified, the command displays the free disk space estimate for splitting the
FlexClone volumes with the specified junction path status.
specified type of space guarantee.
[-space-guarantee-enabled {true|false}] - Space Guarantee In Effect
specified state of space guarantee.
[-aggregate <aggregate name>] - FlexClone Aggregate
This specifies the free disk space estimates for splitting the FlexClone volumes residing
on the specified aggregate.
[-dsid <integer>] - FlexClone Data Set ID
This specifies the free disk space estimates for splitting the FlexClone volume with the
specified DSID (data set ID).
[-msid <integer>] - FlexClone Master Data Set ID
specified MSID (master data set ID).
[-size {<integer>[KB|MB|GB|TB|PB]}] - FlexClone Size
This specifies the free disk space estimates for splitting FlexClone volumes with the
specified size.
specified amount of used disk space.
[-split-estimate {<integer>[KB|MB|GB|TB|PB]}] - Split Estimate
This specifies the free disk space estimates for splitting the FlexClone volumes which
match with the specified free disk space estimate for splitting.
1806
[-inodes-processed <integer>] - Inodes Processed

This specifies the free disk space estimates for splitting the FlexClone volumes for
which the specified number of Inodes have been processed already.
which the specified total number of inodes need to be processed.
[-inode-percentage-complete <integer>] - Percentage Complete
which the specified percentage of Inode processing has been completed.
which the specified number of blocks have been scanned.
which the specified number of blocks have been updated.
This specifies the free disk space estimates for splitting the FlexClone volumes that
have the specified value for the comment field.
This parameter optionally specifies which QoS policy group to apply to the FlexClone
volume. The policy group defines measurable service level objectives (SLOs) that apply
to the storage objects with which the policy group is associated. If you do not assign
a policy group to the FlexClone volume, the system does not monitor and control the
traffic to the volume.
Examples
The following example displays the FlexClone split free disk space estimates for the
FlexClone volumes residing on Vserver vs0.
cluster1::> volume clone split estimate -vserver vs0
(volume clone split estimate)
Split
Vserver
FlexClone
Estimate
--------- ------------- ---------vs0
fc_vol_1
851.5MB
1807
fc_vol_3
0.00B
flex_clone1
350.3MB
fv_2
47.00MB
tv9
0.00B
See Also
volume clone show
1808
volume clone split show

Show the status of FlexClone split operations in-progress
Description
The volume clone split show command displays the progress information of all
the active FlexClone volume splitting jobs. This command is not supported on Infinite
Volumes. By default, this command displays the following information:
Vserver name
FlexClone volume name
Number of inodes processed during clone splitting
Total inodes to be processed during clone splitting
Percentage of inodes processed
Total number of blocks scanned for clone splitting
Total number of blocks updated for clone splitting
If the -instance option is also specified, detailed information about all splitting jobs is
displayed.
Parameters
This specifies the fields to be displayed, for all the ongoing FlexClone splitting jobs.
| [-instance ] }
This specifies the command to display detailed information about the ongoing FlexClone
volume splitting jobs.
Selects information about the ongoing FlexClone volume splitting jobs for all FlexClone
volumes on this Vserver.
1809
Selects information about ongoing FlexClone volume splitting jobs for this FlexClone
volume.
[-inodes-processed <integer>] - Inodes processed
Selects information about all the ongoing FlexClone splitting jobs which have the
specified number of Inodes processed.
Selects information about all the ongoing FlexClone splitting jobs that have the specified
number of total Inodes to be processed.
[-inode-percentage-complete <integer>] - Percentage complete
percentage of Inode processing completed.
number of blocks scanned.
number of blocks updated.
Examples
The following example displays information about all the ongoing FlexClone splitting
jobs in the cluster.
cluster1::> volume clone split show
(volume clone split show)
Inodes
Blocks
--------------------- --------------------Vserver
FlexClone
Processed
Total
Scanned
Updated % Complete
--------- ------------- ---------- ---------- ---------- ---------- ---------vs1
fc_vol_1
1260
The following example displays information about FlexClone volume fc_vol_2 residing
on Vserver vs0.
cluster1::> volume clone split show -vserver vs0 -flexclone fc_vol_2 -instance
(volume clone split show)
1810
Vserver Name: vs0

Inodes processed: 0
Total Inodes: 3192
Percentage complete: 0
Blocks Scanned: 0
Blocks Updated: 0
1811
volume clone split start

Split a FlexClone from the parent volume
Description
The volume clone split start command starts a job to separate the FlexClone
volume from the underlying parent volume. Both, the parent and the FlexClone volumes
will be available for the duration of the split operation. After the job starts, you can stop it
using the volume clone split stop command. You can also stop the job using the
job stop command. You can monitor the current progress of the job using the volume
clone split show and job show commands. This command is not supported on
Infinite Volumes.
Parameters
This specifies the Vserver that the FlexClone volume exists on.
This specifies the FlexClone volume that will be split from its parent volume.
[-foreground [true]] - Foreground Process
This specifies whether the clone splitting job will run as a foreground job. The default
value of this option is true.
Examples
The following example starts splitting FlexClone volume fc_vol_1 on Vserver vs1 as a
foreground job.
cluster1::> volume clone split start -vserver vs1 -flexclone fc_vol_1 -foreground
true
See Also
volume clone split stop job stop volume clone split show job show
1812
volume clone split stop

Stop an ongoing FlexClone split job
Description
The volume clone split stop command stops the process of separating the
FlexClone volume from its underlying parent volume, but does not lose any of the
progress achieved while the split process was active. That is, all the clone volume
blocks already separated from the parent volume remain separated. If you restart the
split operation, splitting process begins from the beginning because no information
about previously achieved progress is saved, but previously split blocks are not re-split.
Parameters
This specifies the Vserver that the FlexClone volume exists on.
This specifies the FlexClone volume whose separation from the parent volume will be
stopped.
Examples
The following example stops an ongoing clone splitting job for FlexClone volume
fc_vol_1 on Vserver vs1.
cluster1::> volume clone split stop -vserver vs1 -flexclone fc_vol_1
volume efficiency check

Scrub efficiency metadata of a volume
1813
Description
This command verifies and updates the fingerprint database for the specified volume.
This command is not supported on Infinite Volumes that are managed by storage
services.
Parameters
Specifies the Vserver on which the volume is located.
{ -volume <volume name> - Volume Name
Specifies the volume on which the verify operation needs to be started.
| -path </vol/volume> } - Volume Path
Specifies the volume path on which the verify operation needs to be started.
[-delete-checkpoint | -d {true|false}] - Delete Checkpoint
Deletes existing checkpoint.
Examples
The following example runs volume efficiency check with delete checkpoint
option turned on.
cluster1::> volume efficiency check -vserver vs1 -volume vol1 -delete-checkpoint
true
volume efficiency modify

Modify the efficiency configuration of a volume
Description
This command is used to set or modify the schedule, policy and various other efficiency
configuration options on a volume. This command is not supported on Infinite Volumes
that are managed by storage services.
Parameters
1814

This specifies the volume on which efficiency options need to be modified.
This specifies the volume path on which efficiency options need to be modified.
{ [-schedule <text>] - Schedule
This option is used to set and modify the schedule.
schedule is [day_list][@hour_list] or [hour_list][@day_list] or - or auto or manual
The day_list specifies the days of the week that an efficiency operation should run. It is
a list of the first three letters of the day (sun, mon, tue, wed, thu, fri, sat), separated by a
comma. Day ranges such as mon-fri can also be used. The default day_list is sun-sat.
The names are not case sensitive.
The hour_list specifies the hours of each scheduled day that an efficiency operation
should run. The hour_list is from 0 to 23, separated by a comma. Hour ranges such as
8-17 are allowed. Step values can be used in conjunction with ranges (For example,
0-23/2 means every two hours in a day). The default hour_list is 0, i.e. at midnight of
each scheduled day.
When efficiency is enabled on a volume for the first time, an initial schedule is assigned
to the volume. This initial schedule is sun-sat@0, which means run once every day at
midnight.
If "-" is specified, no schedule is set on the volume. The auto schedule string triggers
an efficiency operation depending on the amount of new data written to the volume.
The manual schedule string prevents SIS from automatically triggering any operations
and disables change-logging. This schedule string can only be used on SnapVault
destination volumes. The use of this schedule is mainly desirable when inline
compression is enabled on a SnapVault destination volume and background processing
is not necessary.
Note that schedule and policy are mutually exclusive options.
| [-policy <text>] } - Efficiency Policy Name
This option is used to set an efficiency policy. The policy cannot be changed to the
predefined inline-only policy when there is an active background operation on the
volume.
Note that schedule and policy are mutually exclusive options.
1815
[-compression {true|false}] - Compression

This option is used to enable and disable compression. The default value is false.
[-inline-compression {true|false}] - Inline Compression
This option is used to enable and disable inline compression. Inline compression can be
enabled only if compression is enabled. The default value is false.
You can use the inline-only predefined efficiency policy to run inline compression without
the need of any background efficiency operations. This policy is available only if all the
nodes in the cluster are running Data ONTAP version 8.3 or later.
[-idd {true|false}] - Incompressible Data Detection
This option is used to enable and disable incompressible data detection. It can be
enabled only if compression is enabled. The default value is false.
[-quick-check-fsize <integer>] - Compression Quick Check File Size
This option is used to modify the minimum file size (in bytes) required to attempt Quick
check on a file. The default value is 500MB.
Examples
The following examples modify efficiency options on a volume.
cluster1::> volume efficiency modify -vserver vs1 -volume vol1 -schedule sunsat@12
cluster1::> volume efficiency modify -vserver vs1 -volume vol1 -policy policy1
cluster1::> volume efficiency modify -vserver vs1 -volume vol1 -compression true
-inline-compression true -idd true
volume efficiency off

Disables efficiency on a volume
Description
The volume efficiency off command disables efficiency on a volume. This
command is not supported on Infinite Volumes that are managed by storage services.
1816
Parameters
Specifies the name of the volume on which efficiency needs to be disabled.
Specifies the volume path on which efficiency needs to be disabled.
Examples
The following examples disable efficiency on a volume:
cluster1::> volume efficiency off -vserver vs1 -volume vol1
cluster1::> volume efficiency off -vserver vs1 -path /vol/vol1
volume efficiency on
Enable efficiency on a volume
Description
The volume efficiency on command enables efficiency on a volume. The
specified volume must be online. Efficiency operations will be started periodically
according to a per volume schedule or policy. The volume efficiency modify
command can be used to modify schedule and the volume efficiency policy
modify command can be used to modify policy. You can also manually start an
efficiency operation with the volume efficiency start command. This command
is not supported on Infinite Volumes that are managed by storage services.
Parameters
1817

This specifies the name of the volume on which efficiency needs to be enabled.
This specifies the volume path on which efficiency needs to be enabled.
Examples
The following examples enable efficiency on a volume.
cluster1::> volume efficiency on -vserver vs1 -volume vol1
cluster1::> volume efficiency on -vserver vs1 -path /vol/vol1
cluster1::> volume efficiency on -vserver vs1 -volume vol1 -needs-upgrade true
cluster1::> volume efficiency on -vserver vs1 -path /vol/vol1 -needs-upgrade true
See Also
volume efficiency modify volume efficiency policy modify volume efficiency start
1818
volume efficiency revert-to

Reverts volume efficiency metadata
Description
The volume efficiency revert-to command reverts the format of volume
efficiency metadata for the volume to the given version of Data ONTAP.
Parameters
This specifies the name of the volume for which volume efficiency metadata needs to be
reverted.
This specifies the volume path for which volume efficiency metadata needs to be
reverted.
[-version <revert version>] - Revert to Version
Specifies the version of Data ONTAP to which the volume efficiency metadata needs to
be formatted.
[-delete | -d {true|false}] - Delete Existing Metafile on Revert
If set to true, this parameter specifies that the volume efficiency metadata be deleted
instead of reverting its format. By default this parameter is set to false.
[-clean-up | -c {true|false}] - Delete Previously Downgraded Metafiles
If set to true, this parameter specifies that the volume efficiency metadata already
reverted using volume efficiency revert-to be deleted. By default this
parameter is set to false.
Examples
The following examples reverts volume efficiency metadata on a volume named vol1
located in vserver vs1 to version 8.2.
1819
cluster1::> volume efficiency revert-to -vserver vs1 -volume vol1 -version 8.2
cluster1::> volume efficiency revert-to -vserver vs1 -path /vol/vol1 -version 8.2
volume efficiency show

Display a list of volumes with efficiency
Description
The volume efficiency show command displays the information about storage
efficiency of volumes. The command output depends on the parameter or parameters
specified. If no parameters are specified, the command displays the following
information for all volumes with efficiency:
Vserver: Vserver the volume belongs to.
Volume: Name of the volume.
State: Current state of efficiency on the volume (Enabled or Disabled).
Status: Status of the efficiency on the volume. Following are the possible values:
Active: An efficiency operation is currently running.
Idle: There are no efficiency operations running.
Initializing: An efficiency operation is being initialized.
Undoing: Efficiency is being undone on the volume.
Pending: An efficiency operation is queued.
Downgrading: An efficiency operation necessary to downgrade the
efficiency metafiles to a previous Data ONTAP release is active.
Disabled: Efficiency is disabled on the volume.
Status is not supported for Infinite Volumes and will display a value of "-"
Progress: The progress of the current efficiency operation with information as to
which stage of the efficiency process is currently in progress and how much data
is processed for that stage. For example: "25 MB Scanned", "20 MB Searched",
1820
"500 KB (2%) Compressed", "40 MB (20%) Done", "30 MB Verified". Progress is

not supported for Infinite Volumes and will display a value of "-"
To display detailed information, run the command with the -l or -instance parameter.
The detailed view provides all information in the previous list and the following additional
information (fields not supported by Infinite Volumes will display a value of "-"):
Path: Volume Path.
Compression: Current state of compression on the volume (Enabled or Disabled).
Inline Compression: Current state of inline compression on the volume (Enabled
or Disabled).
Incompressible Data Detection: Current state of Incompressible Data Detection on
the volume (Enabled or Disabled).
Compression Quick Check File Size: Minimum file size (in bytes) to attempt Quick
Check on a file. The default value is 500MB.
Type: Type of volume (Regular or SnapVault).
Schedule: The schedule of efficiency operation for the volume.
Policy: Efficiency policy for the volume.
Minimum Blocks Shared: The minimum number of adjacent blocks in a file that
can be shared.
Blocks Skipped Sharing: Blocks skipped sharing because of the minimum block
share value. This parameter is not supported on Infinite Volumes.
Last Operation State: Status of the last operation (Success or Failure). Not
Last Successful Operation Begin: The time and date at which the last successful
operation began. This parameter is not supported on Infinite Volumes.
Last Successful Operation End: The time and date at which the last successful
operation ended. This parameter is not supported on Infinite Volumes.
Last Operation Begin: The time and date at which the last operation began. This
Last Operation End: The time and date at which the last operation ended. This
Last Operation Size: The size of the last operation. This parameter is not
1821
Last Operation Error: The error encountered by the last operation. This parameter
is not supported on Infinite Volumes.
Change Log Usage: The percentage of the change log that is used. This
Logical Data: The total logical data in the volume, and how much is reached
compared to the deduplication logical data limit. This parameter is not supported
Queued Job: The job that is queued. Following are the possible values:
-: There are no queued jobs.
scan: A job to process existing data is queued.
start: A job to process newly added data is queued.
check: A job to eliminate stale data from the fingerprint database is queued.
downgrading: An efficiency operation necessary to downgrade the efficiency
metafiles to a previous Data ONTAP release is queued.
Stale Fingerprints: The percentage of stale entries in the fingerprint database.
If this is greater than 20 percent a subsequent volume efficiency start
operation triggers the verify operation, which might take a long time to complete.
You can specify additional parameters to display information that matches only those
parameters. For example, to display information only about volumes with efficiency in
Vserver vs1, run the command with the -vserver vs1 parameter.
No information is displayed for Infinite Volumes that are managed by storage services.
Parameters
This specifies the fields that need to be displayed. The fields Vserver and volume name
are the default fields.
| [-l ]
This option displays detailed information about the volumes with efficiency.
| [-instance ] }
about all fields.
1822

Displays information only for those volumes that match the specified Vserver.
{ [-volume <volume name>] - Volume Name
Displays information only for those volumes that match the specified volume.
| [-path </vol/volume>] } - Volume Path
Displays information only for those volumes that match the specified volume path.
[-state {Disabled|Enabled}] - State
Displays information only for those volumes that match the specified state.
[-op-status <Efficiency status>] - Status
Displays information only for those volumes that match the specified operation status.
[-progress <text>] - Progress
Displays information only for those volumes that match the specified progress. This
[-type {Regular|SnapVault}] - Type
Displays information only for those volumes that match the specified type of volume.
[-schedule <text>] - Schedule
Displays information only for those volumes that match the specified schedule.
[-policy <text>] - Efficiency Policy Name
Displays information only for those volumes that match the specified policy.
[-blks-skipped-sharing <integer>] - Blocks Skipped Sharing
Displays information only for those volumes that match the specified blocks skipped
sharing. This parameter is not supported on Infinite Volumes.
[-last-op-state <text>] - Last Operation State
Displays information only for those volumes that match the specified last operation
state. This parameter is not supported on Infinite Volumes.
[-last-success-op-begin <Date>] - Last Success Operation Begin
Displays information only for those volumes that match the specified last successful
operation begin time. This parameter is not supported on Infinite Volumes.
[-last-success-op-end <Date>] - Last Success Operation End
1823
Displays information only for those volumes that match the specified last successful
operation end time. This parameter is not supported on Infinite Volumes.
[-last-op-begin <Date>] - Last Operation Begin
Displays information only for those volumes that match the specified last operation
begin time. This parameter is not supported on Infinite Volumes.
[-last-op-end <Date>] - Last Operation End
Displays information only for those volumes that match the specified last operation end
time. This parameter is not supported on Infinite Volumes.
[-last-op-size {<integer>[KB|MB|GB|TB|PB]}] - Last Operation Size
Displays information only for those volumes that match the specified last operation size.
[-last-op-error <text>] - Last Operation Error
Displays information only for those volumes that match the specified last operation error.
[-changelog-usage <percent_no_limit>] - Changelog Usage
Displays information only for those volumes that match the specified change log usage.
[-logical-data-size {<integer>[KB|MB|GB|TB|PB]}] - Logical Data Size
Displays information only for those volumes that match the specified logical data size.
[-logical-data-limit {<integer>[KB|MB|GB|TB|PB]}] - Logical Data Limit
Displays information only for those volumes that match the specified logical data limit.
[-logical-data-percent <percent_no_limit>] - Logical Data Percent
Displays information only for those volumes that match the specified logical data
percentage. This parameter is not supported on Infinite Volumes.
[-queued-job <text>] - Queued Job
Displays information only for those volumes that match the specified number of queued
jobs. This parameter is not supported on Infinite Volumes.
[-stale-fingerprint-percentage <integer>] - Stale Fingerprint Percentage
Displays information only for those volumes that match the specified stale fingerprint
percentage. This parameter is not supported on Infinite Volumes.
1824
[-compression {true|false}] - Compression

Displays information only for those volumes that match the specified compression
setting.
[-inline-compression {true|false}] - Inline Compression
Displays information only for those volumes that match the specified inline compression
setting.
[-idd {true|false}] - Incompressible Data Detection
Displays information only for those volumes that match the specified idd setting. This
[-is-constituent {true|false}] - Constituent Volume
Displays information only for those volumes that either are or are not constituents of an
Infinite Volume, depending on the value provided.
[-quick-check-fsize <integer>] - Compression Quick Check File Size
Displays information only for those volumes that match the specified quick-check file
size setting. This parameter is not supported on Infinite Volumes.
Examples
The following example displays information about all volumes with efficiency on the
Vserver named vs1:
cluster1::> volume efficiency show -vserver vs1
Vserver
Volume
State
Status
Progress
----------- ------------------- -------- ------------ ------------------vs1
vol1
Enabled
Idle
Idle for 22:37:53
vs1
vol2
Enabled
Idle
Idle for 22:37:53
vs1
vol3
Enabled
Idle
Idle for 22:37:49
vs1
vol4
Enabled
Idle
Idle for 22:37:53
vs1
vol5
Enabled
Idle
Idle for 22:37:53
vs1
volham
Enabled
Idle
Idle for 22:37:53
vs1
volham1
Enabled
Idle
Idle for 22:37:53
The following example displays detailed information about a volume named vol1 on a
Vserver named vs1:
cluster1::> volume efficiency show -vserver vs1 -volume vol1
1825
Vserver Name: vs1

Volume Name: vol1
Volume Path: /vol/vol1
State: Enabled
Status: Idle
Progress: Idle for 00:00:14
Type: Regular
Schedule: sun-sat@0
Efficiency Policy Name: Min Blocks Shared: 1
Blocks Skipped Sharing: 0
Last Operation State: success
Last Success Operation Begin: Mon Nov 15 20:13:26 UTC 2010
Last Success Operation End: Mon Nov 15 20:13:26 UTC 2010
Last Operation Begin: Mon Nov 15 20:13:26 UTC 2010
Last Operation End: Mon Nov 15 20:13:26 UTC 2010
Last Operation Size: 0.00B
Last Operation Error: Change Log Usage: 0%
Logical Data Size: 156KB
Logical Data Limit: 50.00TB
Logical Data Percent: 0%
Queued Job: Stale Fingerprint Percentage: 0
Compression: false
Inline Compression: false
Incompressible Data Detection: false
Compression Quick Check File Size: 524288000
See Also
volume efficiency start
1826
volume efficiency start

Starts efficiency operation on a volume
Description
Use the volume efficiency start command to start an efficiency operation. The
volume must be online and have efficiency enabled. If there is an efficiency operation
already active on the volume, this command fails.
When the volume efficiency start command is issued, a checkpoint is created
at the end of each stage or sub-stage, or on an hourly basis in the gathering phase. If
at any point the volume efficiency start operation is stopped, the system can
restart the efficiency operation from the execution state saved in the checkpoint. The
delete-checkpoint parameter can be used to delete the existing checkpoint and
restart a fresh efficiency operation. The checkpoint corresponding to gathering has a
validity period of 24 hours. If the user knows that significant changes have not been
made on the volume, then such a gatherer checkpoint whose validity has expired can be
used with the help of the use-checkpoint parameter. There is no time restriction for
checkpoints of other stages.
This command is not supported on Infinite Volumes that are managed by storage
services.
When the volume is configured to use the inline-only efficiency policy, the system will
stop monitoring changes to the data for the purpose of running background efficiency
operations. The background deduplication operations will be disabled. The user can
still execute compression specific efficiency operation with -scan-old-data and compression parameters to compress the existing data on the volume.
Parameters
Specifies the name of the volume.
1827
Specifies the complete path of the volume.

[-scan-old-data | -s [true]] - Scan Old Data
This option scans the file system and processes all existing data. It prompts for user
confirmation before proceeding. Use the force option to suppress this confirmation.
{ [-use-checkpoint | -p [true]] - Use Checkpoint (if scanning old data)
Use the checkpoint when scanning existing data. Valid only if scan-old-data
parameter is true.
| [-delete-checkpoint | -d [true]] } - Delete Checkpoint
Deletes the existing checkpoint and restarts a new volume efficiency start
operation.
[-qos-policy <sis_qos>] - QoS Policy
Specifies the qos-policy, which indicates how the efficiency operations are throttled. This
option can be configured to be background or best-effort. Default value is besteffort. If background is specified, the efficiency operations are run with minimum
or no impact on the data serving client operations. If best-effort is specified, the
efficiency operations might have some impact on the data serving client operations.
[-compression | -C [true]] - Start Compression (if scanning old data) (privilege:
advanced)
Compresses existing data. Deduplication is not run unless the dedupe option is also
specified. Valid only if scan-old-data parameter is true.
[-dedupe | -D [true]] - Start Deduplication (if scanning old data) (privilege: advanced)
Deduplicates existing data on disk. Similarly, compression is not run unless the
compression option is also specified. Valid only if scan-old-data parameter is true.
[-build-metadata | -m [true]] - Build metadata without sharing(if scanning old data)
Builds deduplication metadata by scanning the entire file system. You will not achieve
any space savings with this option. Once the metadata is built, existing data can be
shared with newly written data on subsequent deduplication runs.
[-scan-all | -o [true]] - Scan all the data without shared block optimization(if scanning old
data)
Scans the entire file system and processes the shared blocks also. You may be able to
achieve additional space savings using this option. Where as, by default the option
scan-old-data saves some time by skipping the shared blocks.
[-shared-blocks | -a [true]] - Compress Shared Blocks (if scanning old data) (privilege:
advanced)
1828
Compresses the Compression Groups that have shared blocks created by deduplication
or cloning data. Valid only if scan-old-data parameter is true.
[-snapshot-blocks | -b [true]] - Compress Blocks In Snapshots (if scanning old data)
Compresses data blocks locked in a Snapshot copy. Valid only if scan-old-data
parameter is true.
[-queue | -q [true]] - Operation Should Be Queued
Queues an efficiency operation. It will be queued only if an operation is already in
progress. Valid only if scan-old-data is false.
[-force | -f [true]] - Force Operation
Suppresses all confirmation messages.
Examples
The following examples start efficiency on a volume:
cluster1::> volume efficiency start -volume vol1 -vserver vs1
cluster1::> volume efficiency start -scan-old-data -volume vol1 -vserver vs1
cluster1::> volume efficiency start -volume vol1 -vserver vs1 -queue -deletecheckpoint
volume efficiency stat

Show volume efficiency statistics
Description
The volume efficiency stat command displays efficiency statistics. This
command is not supported on Infinite Volumes. The output depends on the parameters
specified with the command. If no parameters are specified, the command displays the
following efficiency statistics fields for all the volumes:
Vserver: The Vserver that the volume belongs to.
Volume Name: Name of the volume.
1829
Allocated: The total allocated disk space in KB in the dense volume.

Saving: The total amount of savings in KB due to efficiency.
%Saved: The percentage of saved space by all efficiency operations over
allocated space.
To display detailed information, run the command with the -l, -lv or -instance
parameter.
Parameters
This specifies the fields that need to be displayed. The Vserver and volume name are
the default fields.
| [-instance ] }
about all fields.
Displays statistics only for those volume(s) that match the specified Vserver.
Displays statistics only for those volume(s) that match the specified volume name.
| [-path </vol/volume>] } - Volume Path
Displays statistics only for those volume(s) that match the specified volume path.
[-b [true]] - Display In Blocks
Displays usage size in 4k block counts.
[-num-compressed-inline <integer>] - Inline Compression Attempts
Displays statistics only for those volume(s) that match the specified number of
Compression Groups attempted inline.
Examples
The following example displays default efficiency statistics for all the volumes.
cluster1::> volume efficiency stat
Vserver
Volume
Allocated
Saving
%Saved
----------- ------------------- ------------------ ------------------ ------
1830
vs0
vol0
16284324 KB
4680 KB
0%
vs1
vs1
vol1
457600 KB
18684 KB
3%
vol2
3458716 KB
0 KB
0%
vs1
vol3
965296 KB
308 KB
0%
vs1
vol4
796212 KB
60 KB
0%
vs1
vol5
3762452 KB
10236 KB
0%
vs1
volham
3888 KB
0 KB
0%
vs2
vol2
156 KB
0 KB
0%
The following example display the node statistics:

cluster1::> volume efficiency stat -g
Node Name:
Cluster-01
Max Efficiency Ops:
Max Share Blocks:
3060
Pending Efficiency Ops:
Running Efficiency Ops:
Total Configured:
Succeeded Ops:
Started Ops:
Failed Ops:
Deferred Ops:
Stopped Ops:
Dropped Change Logs:
16384
Change Log Generated:
37347544
Change Log Flushed:
37347544
Change Log Pending:
The following example show the detailed statistics for vol1 in Vserver vs1.
cluster1::> volume efficiency stat -l -vserver vs1 -volume vol1
Vserver:
vs1
Path:
/vol/vol1
Allocated:
16776 KB
Shared:
3212 KB
Saving:
812804 KB
%Saved:
97%
Max Refcount:
32767
Total Processed:
2150464 KB
Total Process Time:
00:29:49
Total Verify Time:
1831
1832
Efficiency Files:
Succeeded Op:
Started Op:
Failed Op:
Stopped Op:
Deferred Op:
Succeeded Check Op:
Failed Check Op:
Suspended Check Op:
Total FP Deleted:
Total Sorted Blocks:
Overlapped Blocks:
Same Fingerprint:
Same FBN Location:
Same Data:
Same VBN:
Mismatched Data:
Same Sharing Records:
Max Reference Hits:
Staled Recipient:
Staled Donor:
File Too Small:
Out of Space:
FP False Match:
Mismatch By Overwrites:
Delino Records:
Unaligned Compression Blocks:
Additional Sharing Messages:
Compression Saved:
CGs Decompressed:
Partial CG Modifies:
Avg Decompress Time:
Extra CP Reads:
Inline Compression Attempts:
Background Compression Attempts:
Inline Compressed Blocks:
Background Compressed CGs:
Uncompressed Blocks:
New Partial CG Writes:
Decompress Disk Bad:
Decompress SW Bad:
Avg Compression Time:
Compression Attempts:
Compression Failures:
Poor Compression Ratio:
CGs Skipped Due to VBN_ZERO Policy:
Shared Blocks Skipped:
Snapshot Blocks Skipped:
Un-Flushed Change Logs:
Incompressible CGs Found By Quick Check:
Inline Incompressible CGs:
Avg Incompressible Data Quick Check Time:
Avg Compressible Data Quick Check Time:
BCE Messages Received in Exempt Domain:
BCE Aborts Before Compress Stage:
BCE Aborts Due to Stale Inode Before Compress Stage:
BCE Aborts Due to Invalid FBN:
BCE Policy Stage Entries:
BCE Compress Stage Entries:
BCE CGs Skipped Due to Overwrites in Compress Stage:
BCE Messages Sent to Exempt Domain:
BCE SetFlag Stage Entries:
BCE Aborts Before Post Processing:
BCE Aborts Due to Stale Inode Before Post Processing:
BCE CGs Skipped Due to Overwrites in Post Processing:
BCE CGs Skipped Due to No Space in Post Processing:
Average Number of CGs Batched for Decompression:
1833
volume efficiency stop

Stop efficiency operation on a volume
Description
Use the volume efficiency stop command to stop an efficiency operation. This
Parameters
This specifies the name of the volume on which efficiency operation needs to be
stopped.
This specifies the volume path on which efficiency operation needs to be stopped.
[-all | -a [true]] - Stop All Operations
This specifies both active and queued efficiency operations to be aborted.
Examples
The following examples stop efficiency on a volume.
cluster1::> volume efficiency stop -vserver vs1 -volume vol1
cluster1::> volume efficiency stop -vserver vs1 -volume vol1 -all
volume efficiency undo

Undo efficiency on a volume
1834

Description
Remove volume efficiency on a volume by undoing compression, removing all the block
sharing relationships, and cleaning up any volume efficiency specific data structures.
Any efficiency operations on the volume must be disabled before issuing this command.
The volume efficiency configuration is deleted when the undo process completes. This
Parameters
This specifies the volume name.
This specifies the volume path.
[-compression | -C [true]] - Decompress The Data In The Volume
Undo the effects of compression. This requires efficiency to be disabled (by performing
volume efficiency off).
[-dedupe | -D [true]] - Undo Block Sharing In The Volume
Undo the effects of deduplication. This requires efficiency to be disabled (by performing
volume efficiency off).
[-inode | -i <integer>] - Inode Number To Undo Sharing
Remove the block sharings from a specified inode. This parameter is not supported on
Infinite Volumes.
[-undo-type | -t {all|wrong}] - Selective Undo
This specifies to remove either all or only invalid block sharing. When all is used, all
block sharings are removed. When wrong is used, only invalid sharings present in the
volume are removed. When used along with log option, it logs information about all or
wrong block sharings without sharing removal.
[-log | -d [true]] - Only Log Incorrect Savings
1835
If true, information about invalid block sharing relationships will only be logged. Invalid
sharings will not be removed. This option is only valid when the parameter undo-type is
set to wrong.
Examples
The following are examples of how to use efficiency undo.
cluster1::> volume efficiency undo -vserver vs1 -volume vol1
cluster1::> volume efficiency undo -vserver vs1 -volume vol1 -compression true
cluster1::> volume efficiency undo -vserver vs1 -volume vol1 -dedup true compression true
See Also
volume efficiency off
1836
volume efficiency policy create

Create an efficiency policy
Description
The volume efficiency policy create creates an efficiency policy.
Parameters
-policy <text> - Efficiency Policy Name
This specifies the policy name.
[-type <Efficiency policy type>] - Policy Type
This specifies the policy type. The policy type defines when the volume using this policy
will start processing a changelog. There are two possible values:
threshold means changelog processing occurs when the changelog reaches a
certain percentage.
scheduled means changelog processing will be triggered by time.
The default value is scheduled.
[-schedule <text>] - Job Schedule Name
This specifies the job schedule. Use job schedule commands to manage job
schedules. Only cron job schedules are supported.
[-duration <text>] - Duration
This specifies the duration that an efficiency operation can run (in hours). The possible
values are "-" or a number between 1 and 999 inclusive. Default value is "-", which
means no duration.
[-start-threshold-percent <percent>] - Threshold Percentage
1837
The percentage at which the changelog will be processed. The percentage is checked
on an hourly basis. The default value is 20. Valid only if -type parameter is set as
threshold.
[-qos-policy <Efficiency QoS policy>] - QoS Policy
This specifies how the efficiency operations are throttled. This option can be configured
to be background or best-effort. Default value is best-effort. If background
is specified, the efficiency operations are run with minimum or no impact on the data
serving client operations. If best-effort is specified, the efficiency operations might
have some impact on the data serving client operations.
[-enabled {true|false}] - Enabled
This specifies whether the policy is enabled or not. The policy is enabled by default.
User specified comment.
Examples
The following example creates an efficiency policy.
cluster1::> volume efficiency policy create -vserver vs1 -policy policy1 schedule daily -duration 100
See Also
job schedule
1838
volume efficiency policy delete

Delete an efficiency policy
Description
The volume efficiency policy delete command deletes an efficiency policy.
An efficiency policy can be deleted only when it is not associated with any volume. The
pre-defined policies default and inline-only cannot be deleted.
Parameters
Examples
The following example deletes an efficiency policy:
cluster1::> volume efficiency policy delete -vserver vs1 -policy policy1
volume efficiency policy modify

Modify an efficiency policy
Description
The volume efficiency policy modify command can be used to modify the
policy attributes.
The attributes of the inline-only predefined policy cannot be modified.
1839
Parameters
This specifies the policy type. The policy type defines when the volume using this policy
will start processing a changelog. There are two possible values:
threshold means changelog processing occurs when the changelog reaches a
certain percentage.
scheduled means changelog processing will be triggered by time.
The default value is scheduled.
This specifies the job schedule. Use job schedule show to show all the jobs.
This specifies the duration that an efficiency operation can run in hours. The possible
value is between 1 and 999 inclusive.
The percentage at which the changelog will be processed. The percentage is checked
on an hourly basis. The default value is 20. Valid only if -type parameter is set as
threshold.
This specifies how the efficiency operations are throttled. This option can be configured
to be background or best-effort. Default value is best-effort. If background
is specified, the efficiency operations are run with minimum or no impact on the data
serving client operations. If best-effort is specified, the efficiency operations might
have some impact on the data serving client operations.
This specifies whether the policy is enabled or not. Default value is true.
1840
User specified comment.
Examples
The following example modifies efficiency policy.
cluster1::> volume efficiency policy modify -policy policy1 -schedule hourly
See Also
job schedule show
1841
volume efficiency policy show

Show efficiency policies
Description
The volume efficiency policy show command displays information about
efficiency policies. By default, the command displays the following information about all
policies:
Vserver: Name of the Vserver that the policy belongs to.
Policy Name: Efficiency policy name.
Job Schedule: Job schedule name.
Duration (Hours): The duration in hours that the efficiency operation can run.
Enable: Whether the policy is enabled or not.
Comment: User specified comment.
You can specify additional parameters to select the displayed information. For example,
to display efficiency policies only with duration 5 hours, run the command with the duration 5 parameter.
The pre-defined policies default and inline-only are available when all the nodes in the
cluster are running Data ONTAP version 8.3 or later.
The inline-only pre-defined policy must be used when the user wants to use the inline
compression feature without any regularly scheduled or manually started background
storage efficiency operations. When a volume is configured to use the inline-only
efficiency policy, the system will stop monitoring changes to the data for running the
background efficiency operations on the volume. Volumes cannot be configured with the
inline-only policy if there is a currently active background efficiency operation.
Parameters
Selects the fields to be displayed. Vserver and policy are the default fields (see
example).
1842
| [-instance ] }
Selects information about the policies that match the specified Vserver.
[-policy <text>] - Efficiency Policy Name
Selects information about the policies that match the specified policy name.
Selects information about the policies that match the specified policy type. There are
two possible values - threshold and scheduled.
Selects information about the policies that match the specified schedule.
Selects information about the policies that match the specified duration hours.
Selects information about the policies that match the specified start-threshold-percent.
Valid only if -type parameter is set as threshold.
Selects information about the policies that match the specified throttling method. The
values can be background or best-effort.
Selects information about the policies that have the specified enabled setting.
Selects information about the policies that match the specified comment.
[-policy-owner {cluster-admin|vserver-admin}] - Owner of the Policy
Selects information about the policies that match the specified owner. The values can be
cluster-admin or vserver-admin.
Examples
The following example shows all the efficiency policies with the matching Vserver vs1.
cluster1::> volume efficiency policy show -vserver vs1
1843
Vserver
Policy
Job
Duration
Name
Schedule
(Hours)
QoS Policy
Enabled
Comment
-------- ------------ ---------- -------- ----------- -------- -------------vs1
default
daily
best_effort true
Default policy
vs1
inline-only
Inline-Only
policy
vs1
policy1
daily
best_effort true
user-defined
The following example shows all the policies with the following fields - Vserver (default),
policy (default) and duration.
cluster1::> volume efficiency policy show -fields duration
vserver policy
duration
------- -------
--------
vs1
default
vs1
inline-only -
vs1
policy1
1844
volume file modify

Manage the association of a QoS policy group with a file
level.
Description
This command adds and removes files from QoS policy groups. QoS policy groups
define measurable service level objectives (SLOs) that apply to the storage objects with
which the policy group is associated. A QoS policy group associated with this file can
be created, modified, and deleted. You cannot associate a file to a QoS policy group if a
LUN was created from the file.
Parameters
-vserver <vserver name> - Vserver Managing Volume
This specifies the Vserver on which the volume (containing the file) resides.
This specifies the name of the volume. The name must be unique within the hosting
Vserver.
-file <text> - File Path
This specifies the actual path of the file with respect to the volume.
This option associates the file with a QoS policy group. This policy group manages
storage system resources to deliver your desired level of service. If you do not assign a
policy to a file, the system will not monitor and control the traffic to it. To remove this file
from a QoS policy group, enter the reserved keyword none.
Examples
cluster1::> vol file modify -vserver vs0 -volume vs0_vol56 -file 1.txt -qospolicy-group fast -cache all-read
Associates the file 1.txt with the fast QoS policy group and all-read caching policy.
1845
volume file reservation

Get/Set the space reservation info for the named file.
Description
The volume file reservation command can be used to query the space
reservation settings for the named file, or to modify those settings. This command is not
supported on Infinite Volumes. With no further modifiers, the command will report the
current setting of the space reservation flag for a file. This tells whether or not space is
reserved to fill holes in the file and to overwrite existing portions of the file that are also
stored in a snapshot. For symlinks, the link is followed and the command operates on
the link target.
Parameters
Specifies the Vserver on which the volume is located. If only one data Vserver exists,
you do not need to specify this parameter.
-path </vol/<volume name>/<file path>> - File Name
Specifies the complete file path for which we want to get/set the space reservation
settings.
[-is-enabled <text>] - enable | disable
Specifying enable or disable will turn the reservation setting on or off accordingly for the
file.
Examples
The following example enables the file reservation setting for the file named file1. The
file file1 is stored in volume testvol on Vserver vs0.
node::> file reservation -vserver vs0 /vol/testvol/file1 enable
space reservations for file /vol/testvol/file1: on.
1846
volume file show-disk-usage

Show disk usage of file
Description
This command requires a path to a file in a volume and displays the following
information:
Vserver name
Total bytes used by the file in kilobytes
Full Path to the file
If not logged in as Vserver administrator, the command also requires a Vserver name.
This command is not supported on an Infinite Volume.
Note:
The "-instance" option provides the same result as the default as there are no extra
fields to display.
Parameters
specify.
| [-h ]
If this parameter is specified, the command displays total bytes used by the file in
human readable form.
| [-k ]
kilobytes.
| [-m ]
1847
megabytes.
| [-u ]
If this parameter is specified, the command displays the unique bytes used by the file
(bytes that are not shared with any other file in the volume due to deduplication or
FlexClone files) in kilobytes.
| [-uh ]
If this parameter is specified, the command displays the unique bytes used by the file in
human readable form.
| [-uk ]
kilobytes.
| [-um ]
megabytes.
| [-instance ] }
about all fields.
This parameter is used to specify the Vserver that contains the file for which the
command displays the total bytes used. It is required if not logged in as Vserver
administrator.
-path </vol/<volume name>/<file path>> - Full Path
This required parameter is used to specify the path of the file for which the command
displays the total bytes used.
[-range | -r <<start offset>:<end offset>>] - Block Range
If this parameter is specified, the command displays the total bytes used by the file in
the specified block range.
Examples
The following example displays the disk-usage of the file file1.txt in volume /vol/
root_vs0.
cluster1::> volume file show-disk-usage -vserver vs0 -path /vol/root_vs0/
file1.txt
1848
Vserver
Total
Path
--------
------
-----
vs0
1408KB
/vol/root_vs0/file1.txt
cluster1::> volume file show-disk-usage -m -vserver vs0 -path /vol/root_vs0/

file1.txt
Vserver
Total
Path
--------
------
-----
vs0
1MB
vs0::> volume file show-disk-usage -um -path /vol/root_vs0/file1.txt

Vserver
Total
Unique
Path
--------
-----
------
-------
vs0
1MB
1MB
1849
volume file show-filehandle

Show the file handle of a file
Description
This command requires a path to a file in a volume and displays the file handle
information described below:
Vserver name
Path to the file
File handle flags
Snapshot ID of the file (snapid)
File ID
File handle generation number
File system ID (fsid)
Master data set ID (msid)
Data set ID (dsid)
If not logged in as a Vserver administrator, the command also requires a Vserver name.
Parameters
specify.
| [-instance ] }
about all fields.
[-vserver <vserver name>] - Vserver Managing Volume
This specifies the Vserver where the file resides.
1850
[-path <text>] - Path to File

This specifies the path to the file.
Examples
The following example displays the file handle information of a file named file1.txt in the
volume /vol/vol1.
cluster1::> volume file show-filehandle -vserver vs0 -path /vol/vol1/file1.txt
Vserver
Path
----------------------
---------------------------
vs0
flags
/vol/vol1/file1.txt
snapid
fileid
generation
fsid
msid
---------
----------
----------
------------
0x60
0x206b6
0x402
0x80000402
dsid
------- ----------------0x0
0x402
1851
volume file show-inode

Display file paths for a given inode
Description
This command displays information about all the files having a given inode in a volume
of a Vserver. If the -snapshot-id or -snapshot-name parameter is specified, the
command displays file information from the Snapshot copy; otherwise, it displays the
information from the active file system. The -vserver, -volume and -inode-number
are mandatory parameters.
If no optional parameter is specified, the command displays the following fields for all
the files having the given inode:
Vserver Name
Volume Name
Inode Number
File Path
Parameters
If you specify the -fields parameter, the command output also includes the specified field
or fields.
| [-snapshot ]
Vserver Name
Volume Name
Inode Number
Snapshot Name
Snapshot ID
File Path
1852
| [-instance ] }
If this parameter is specified, the command displays detailed information about the files
matching the specified inode number. The following information is displayed:
Vserver Name
Volume Name
Inode Number
File Path
Snapshot Name
Snapshot ID
File Name
Parent Inode Number
Parent Directory Cookie
This specifies the Vserver in which the volume or Snapshot copy is located.
This specifies the volume in which the inode number is located.
-inode-number <integer> - Inode Number
This specifies the inode number whose information has to be retrieved.
{ [-snapshot-name <snapshot name>] - Snapshot Name
If this parameter or -snapshot-id is specified, information about the files is retrieved
from the Snapshot copy instead of the active file system.
| [-snapshot-id <integer>] } - Physical Snapshot ID
If this parameter or -snapshot-name is specified, information about the files is
retrieved from the Snapshot copy instead of the active file system.
[-file-path <text>] - File Path
If this parameter is specified, the command displays information only about the files that
match the specified file path.
[-file-name <text>] - File Name
If this parameter is specified, the command displays information only about the files that
match the specified file name.
1853
[-parent-inode-number <integer>] - Parent Inode Number

The inode number of the parent directory of the file associated with the inode. If this
parameter is specified, the command displays information only about the files that match
the specified parent inode number.
[-parent-dir-cookie <integer>] - Parent Directory Cookie
The index of the directory entry of the file in its parent directory tree. If this parameter
is specified, the command displays information only about the files that match the
specified parent directory cookie.
Examples
The following example displays information about all the files having the inode number
96 in the active file system of a volume named vol1 on a Vserver named vs1:
cluster1::> volume file show-inode -vserver vs1 -volume vol1 -inode-number 96
Inode
Vserver
Volume
Number
File Path
--------- ------------ -------- ---------------------------------vs1
vol1
96
/vol/vol1/file1
vs1
vol1
96
/vol/vol1/file2
vs1
vol1
96
/vol/vol1/A/file2
The following example displays information about all the files with inode number 96 in a
Snapshot copy named mysnap. The Snapshot copy is present in a volume named vol1
on a Vserver named vs1:
cluster1::> volume file show-inode -vserver vs1 -volume vol1 -inode-number 96 snapshot-name mysnap -snapshot
Vserver
Volume
Inode
Snapshot Snapshot
Number
Name
ID
File Path
--------- ------------ -------- -------- -------------------------------vs1

mysnap/file1
vol1
96
mysnap
131
/vol/vol1/.snapshot/
vs1
mysnap/file2
vol1
96
mysnap
131
/vol/vol1/.snapshot/
1854
The following example displays detailed information about all the files with inode number
96 in a Snapshot copy named mysnap. The Snapshot copy is present in a volume
named vol1 on a Vserver named vs1:
cluster1::> volume file show-inode -vserver vs1 -volume vol1 -inode-number 96 snapshot-name mysnap -instance
Vserver Name: vs1
Volume Name: vol1
Inode number: 96
File Path: /vol/vol1/.snapshot/mysnap/file1
Physical Snapshot ID: 131
File Name: file1
Parent Inode Number: 64
Parent Directory Cookie: 2
Vserver Name: vs1
Volume Name: vol1
Inode number: 96
File Path: /vol/vol1/.snapshot/mysnap/file2
Physical Snapshot ID: 131
File Name: file2
Parent Inode Number: 64
Parent Directory Cookie: 3
1855
volume file clone autodelete

Enable/Disable autodelete
Description
The volume file clone autodelete command enables or disables the automatic
deletion of a file or LUN clone. Newly created file and LUN clones are disabled for
automatic deletion by default. This command is not supported on Infinite volumes.
Parameters
This specifies the Vserver on which the volume resides. If only one data Vserver exists,
you do not need to specify this parameter.
This specifies the name of the volume in which the file or LUN is present.
-clone-path <text> - Clone Path
This specifies the path where clone resides. If you use the volume parameter, then
specify the relative path to the file or LUN clone. Otherwise, specify the absolute path.
-enable {true|false} - Enable Autodelete
This parameter enables or disables the autodelete feature for the file or LUN clones in
a specified volume if the clones are already added for automatic deletion. If you set the
parameter to true, the specified file or LUN clones gets automatically deleted in the 'try'
or 'disrupt' mode. If the value is false, the clones get automatically deleted only in the
'destroy' mode.
[-force {true|false}] - Force Enable Autodelete
This parameter forces automatic deletion of a specified file or LUN, or a file or LUN
clone. The default value is false.
Examples
The following command enables for automatic deletion a LUN Clone named lun_clone
contained in a volume named volume1. This volume is present on a Vserver named vs1.
1856
cluster1::> volume file clone autodelete /vol/volume1/lun_clone -enable true vserver vs1
The following command specifies the relative clone path when the volume parameter is
specified in the command.
cluster1::> volume file clone autodelete lun_clone -enable true
-vserver vs1 -volume volume1
volume file clone create

Create file or LUN full or sub file clone
Description
The volume file clone create command creates a clone of a file or a LUN. This
command is not supported on Infinite Volumes. You can optionally specify the following
parameters for the clone file creation process:
Vserver in which the volume resides
Name of the parent snapshot
The range of blocks to be cloned
The option to avoid space reservations for the new file or LUN clone
The option to assign a QoS policy group to the new file or LUN clone
The option to assign a caching policy to the new file or LUN clone
The option to mark the new file or LUN clone created for auto deletion
The option to overwrite an existing file or LUN clone
File or LUN clones create a duplicate copy of another file or LUN, but don't require
copying the data itself. This allows the clone operation to occur in constant time, taking
the same amount of time to complete no matter the size of the file being cloned. This
also means that clones require only a small amount of additional storage space because
the clone shares the data with the source file or LUN.
Parameters
1857
This specifies the Vserver in which the parent volume resides. If only one data Vserver
This specifies the name of volume in which a file or LUN is going to be cloned.
-source-path <text> - Source Path
This specifies the path to the file or LUN to be cloned relative to the specified volume.
-destination-path <text> - Destination Path
This specifies the path for the newly-created cloned file or LUN relative to the specified
volume. If the file or LUN clone to be created is a whole file or LUN ,the destination file
or LUN must not exist. If the range parameter is being specified the destination file or
LUN must exist.
[-snapshot-name | -s <snapshot name>] - Source Snapshot
The name of the Snapshot copy to use as the source for the clone operation. If this
value is not specified, the active filesystem will be used instead.
{ [-range | -r <<source start block>:<destination start block>:<block length>>, ...] Block Range
This specifies the block range to be cloned. If the range is not specified, the entire file
or LUN is cloned. The block range should be specified in the format s:d:n where s is the
source start block number, d is the destination start block number, and n is the length in
blocks to be cloned. If this parameter is used the path provided by the destinationpath parameter must refer to a file or LUN which already exists. If either the source
or destination are a LUN then the block size is measured in 512-byte LBA blocks. If
neither the source nor destination are a LUN then the block size will be 4KB. If 512-byte
sectors are used the source and destination offsets must have the same offset within
4KB blocks.
This option is most likely to be used by external automated systems in managing virtual
disk configurations and not by human administrators.
| [-no-reserve | -o [true]] } - Do not reserve clone
If this option is used the clone file or LUN will not be guaranteed space in the underlying
aggregate. While this out-of-space condition persists, writes to the clone file or
LUN would fail. This option may be useful if few writes to the clone are expected to
be needed, or to allow a file or LUN clone to be created under space-constrained
conditions for recovery purposes. If this option is not specified the clone will inherit the
space reservation properties from the source.
[-ignore-streams | -i [true]] - Ignore streams
1858
This parameter specifies whether streams should be ignored during cloning of files or
LUNs. If you set this parameter to false, the streams are ignored; otherwise, they are
included in the clones. The default value is false.
[-ignore-locks | -k [true]] - Ignore locks
This parameter specifies whether byte-range locks and shared-mode locks on files
or LUNs should be ignored during cloning. If you set this parameter to true, the locks
are ignored; otherwise, clone operation fails if locks are present on files or LUNs. The
[-overwrite-destination | -d [true]] - Overwrite Destination
Specify this parameter to overwrite the destination file, if it exists. The default is to fail
the command if the destination exists.
This optionally specifies which QoS policy group to apply to the file or LUN. This policy
objects with which the policy group is associated. If you do not assign a policy group
to a file or LUN, the system will not monitor and control the traffic to it. You cannot
associate a file to a QoS policy group if a LUN was created from the file.
[-autodelete {true|false}] - Mark Clone for Autodeletion
This parameter marks the file or LUN clones created for auto deletion. When set to true,
the file or LUN clones get automatically deleted when the volume runs out of space. The
[-bypass-throttle {true|false}] - Bypass Throttle Checks (privilege: advanced)
This parameter specifies whether clone throttle checks should be skipped during clone
creation. When set to true, clones are created without enforcing any clone throttle
checks. The default value is false.
Examples
The following command creates a FlexClone file of the file named myfile contained in
a volume named vol. The file myfile is located in the root directory of that volume. The
cloned file myfile_copy resides in the root directory same volume.
cluster1::> volume file clone create -volume vol -source-path /myfile destination-path /myfile_copy
The following command optionally associates the FlexClone file named myfile_copy with
the fast QoS policy group and the caching policy named random-read.
1859
cluster1::> volume file clone create -volume vol -source-path /myfile destination-path /myfile_copy -qos-policy-group fast -caching-policy random-read
See Also
volume file clone token create
1860
volume file clone show-autodelete

Show the autodelete status for a file or LUN clone
Description
The volume file clone show-autodelete command displays the autodelete
details of a file or LUN clone. The command displays the following information about a
file or LUN clone:
Vserver Name
Clone Path
Whether auto deletion of file or LUN clone is enabled
Parameters
specify.
| [-instance ] }
about all fields.
This specifies the Vserver to which the file or LUN clone belongs.
-clone-path <text> - Clone Path
This specifies the path of the file or LUN clone.
[-autodelete-enabled {true|false}] - Autodelete Enabled
If this parameter is true, the file or LUN clone gets automatically deleted in the 'try' or
'disrupt' mode. If the value is false, the clones get automatically deleted only in the
'destroy' mode.
Examples
1861
The following example displays the autodelete information about a file or LUN clone.
cluster1::> volume file clone show-autodelete -vserver vs1 -clone-path /vol/v1/f1
Vserver Name: vs1
Clone Path: /vol/v1/f1
Autodelete Enabled: true
volume file clone deletion add-extension

Add new supported file extensions to be deleted with clone delete
Description
The volume file clone deletion add-extension command can be used to
add new supported file extensions for clone delete. This command is not supported on
Infinite Volumes.
Parameters
Name of the vserver.
Name of the volume.
-extensions <text> - Supported Extensions for Clone Delete
List of supported file extensions for clone delete.
Examples
The following example adds the new supported vmdk,vhd file extensions to volume vol1
of vserver vs1.
cluster1::> volume file clone deletion add-extension -vserver vs1 -volume vol1 extensions vmdk,vhd
1862
volume file clone deletion modify

Description
The volume file clone deletion modify command can be used to change the
required minimum clone file size of a volume for clone delete. This is not applicable on
Infinite volumes.
Parameters
Name of the volume.
[-minimum-size {<integer>[KB|MB|GB|TB|PB]}] - Minimum Size Required for Clone
delete
Minimum clone file size required for clone delete.
Examples
The following example changes the required minimum file size to 100M for volume vol1
of vserver vs1 .
cluster1::> volume file clone deletion modify -volume vol1 -vserver vs1 -minimumsize 100M
volume file clone deletion remove-extension

Remove unsupported file extensions for clone delete
Description
1863
The volume file clone deletion remove-extension command can be used

to remove the existing file extensions that are no longer supported for clone delete. This
command is not supported on Infinite Volumes.
Parameters
Name of the volume.
[-extensions <text>] - Unsupported Extensions for Clone Delete
List of unsupported file extensions for clone delete.
Examples
The following example removes the existing unsupported vmdk, vhd file extensions to
volume vol1 of vserver vs1.
cluster1::> volume file clone deletion remove-extension -vserver vs1 -volume vol1
-extensions vmdk,vhd
volume file clone deletion show

Show the supported file extensions for clone delete
Description
The volume file clone deletion show command displays the following
information for clone delete:
Vserver Name
Volume Name
Minimum File Size Required for Clone Delete
List of Supported File Extensions for Clone Delete
Parameters
1864

specify.
| [-instance ] }
about all fields.
Name of the volume.
[-extensions <text>, ...] - Supported Extensions for Clone Delete
List of supported file extensions for Clone Delete.
[-minimum-size {<integer>[KB|MB|GB|TB|PB]}] - Minimum Size Required for Clone
delete
Minimum file size required for Clone Delete.
Examples
The following example displays the clone deletion information for all volumes of all
vservers.
cluster1::> volume file clone deletion show
Vserver
Volume
Minimum
Extensions
Size
-------------------------------------vs0
-------------------
-------
testvol
100B
vmdk, vhd, vhdx,
vswp
vs0_root
vs1
testvol
0B
100G
vmdk, vhd, vhdx,
vswp
vs1_root
0B
The following example displays the clone deletion information for volume vol1 of vserver
vs1.
cluster1::> volume file clone deletion show -vserver vs0 -volume testvol
Vserver Name: vs0
1865
Volume Name: testvol

Supported Extensions for Clone Delete: vmdk, vhd, vhdx, vswp
Minimum Size Required for Clone delete: 100B
1866
volume file clone split load modify

Modify maximum split load on a node
Description
The volume file clone split load modify command can be used to change
the maximum split load (file or LUN clones) of a node.
Parameters
Node name on which the new maximum split load is being applied.
[-max-split-load {<integer>[KB|MB|GB|TB|PB]}] - Maximum Clone Split Load
This specifies the new maximum split load of a node. This is the amount of clone create
load, the node can take at any point of time. If it crosses this limit, then the clone create
requests will not be allowed, till the split load is less than maximum split load
Examples
The following example changes the new maximum limit to 10TB on node1.
cluster1::*> volume file clone split load*> modify -node clone-01 -max-split-load
100KB
volume file clone split load show

Show split load on a node
Description
The volume file clone split load show command displays the corresponding
file or LUN clone split loads on nodes.If no parameters are specified, the command
displays the following information:
1867
Node
Max Split Load
Current Split Load
Token Reserved Load
Allowable Split Load
Parameters
specify.
| [-instance ] }
about all fields.
Node on which the file or LUN Clone split load is displayed.
[-max-split-load {<integer>[KB|MB|GB|TB|PB]}] - Maximum Clone Split Load
This specifies the maximum allowable split load on the node.
[-current-split-load {<integer>[KB|MB|GB|TB|PB]}] - Current Clone Split Load
This specifies the current on going split load on the node.
[-token-reserved-load {<integer>[KB|MB|GB|TB|PB]}] - Load Reserved for Clone
Creation
This specifies the reserved split load of the node using the tokens.
[-allowable-split-load {<integer>[KB|MB|GB|TB|PB]}] - Allowable Clone Split Load
This specifies the available split load of the node.
Examples
The following example displays the current and allowable file or LUN clone split load on
a node.
cluster1::> volume file clone split load show
Node
Max
Current
Token
Allowable
Split Load Split Load Reserved Load Split Load
1868
------------------------------- ---------- ---------- ------------- ---------clone-01
15.97TB
0B
100MB
15.97TB
clone-02
15.97TB
0B
100MB
15.97TB
cluster1::> volume file clone split load show -node clone-01 -instance
Node Name: clone-01
Maximum Clone Split Load: 15.97TB
Current Clone Split Load: 0B
Load Reserved for Clone Creation: 100MB
Allowable Clone Split Load: 15.97TB
1869
volume move abort

Stop a running volume move operation
level.
Description
The "volume move abort" command sends an abort message to the volume move
operation and returns immediately. The volume move operation might not abort
immediately depending on the stage it is in. For example, if the volume move operation
is in a cut-over or clean-up phase, the abort is ignored. You invoke the "volume move
show" command to view the list of running volume move operations and monitor the
progress of the abort operation. This command has the same behavior as the job
stop -id <job-id> command where the job-id is the identifier of the volume move job.
Parameters
This specifies the name of the volume being moved.
Examples
The following example aborts running volume move operation on volume vol1
cluster1::> volume move show
Vserver
Volume
State
Move Phase Percent-Complete Time-To-
Complete
--------- ---------- -------- ---------- ------------------------------vs0
vol1
alert
cutover_hard_deferred 0%
vs0
vol2
failed
failed
cluster1::> volume move abort -vserver vs0 -volume vol1
1870
cluster1::> volume move show -vserver vs0 -volume vol1 -fields

completion-status
vserver volume completion-status
------- ------ -------------------------vs0
vol1
"Volume move job stopped."
The following example shows command failed to abort on vol2 as volume move
operation is completed.
Vserver
Volume
State
Move Phase Percent-Complete Time-To-
Complete
--------- ---------- -------- ---------- ------------------------------vs0
vol1
alert
cutover_hard_deferred 0%
vs0
vol2
failed
failed

cluster1::> volume move abort -vserver vs0 -volume vol2
Error: command failed: There is no volume move operation running on the
specified volume.
See Also
job stop
1871
volume move show

Show status of a volume moving from one aggregate to another aggregate
level.
Description
The volume move show command displays information about volume moves in the
cluster. By default, with no parameters, it only shows volume moves that have failed or
are currently running. The command display output depends on the parameters passed.
If no parameters are passed, the following information is displayed:
Vserver Name: The Vserver on which the volume is located.
Volume Name: The volume that is part of a completed or running volume move
operation.
Actual Completion Time: The date and time in the cluster time zone when the
volume move completed.
Bytes Remaining: The number of bytes remaining to be sent during volume move.
This is an approximate number and lags the current status by a few minutes while
the volume move is in operation.
Specified Action For Cutover: The action to be taken for cutover or during cutover
failure. This is the input given during the start of volume move.
Specified Cutover Time Window: The time window in seconds given as an input
for the cutover phase of volume move. This is the input given during the start of
volume move.
Job ID: The Job-ID of move job.
Destination Node: The name of the node where the destination aggregate is
present.
Source Node: The name of the node where the source aggregate is present.
Destination Aggregate: The name of the aggregate to which the volume is moved.
Detailed Status: The detail about any warnings, errors, and state of the move
operation.
Estimated Time of Completion: The approximate date and time in the cluster time
zone when the entire volume move operation is expected to complete. Note that
this time may keep increasing when the move goes into cutover-deferred mode.
1872
In those cases where the input for cutover-action is wait, during the data copy
phase, the estimated time of completion will approximate the time to reach the
cutover point and wait for user intervention.
Managing Node: The node in the cluster on which the move job is or was running.
This is usually on the node hosting the volume to be moved.
Percentage Complete: The amount of work to move the volume completed thus
far in terms of percentage.
Move Phase: The phase of the move operation.
Estimated Remaining Duration: The approximate amount of time in terms of days,
hours, minutes and seconds remaining to complete the volume move.
Replication Throughput: The current replication throughput of the move operation
in terms of Kb/s, Mb/s or Gb/s.
Duration of Move: The duration in days, hours and minutes for which the volume
move was or is in progress.
Source Aggregate: The name of the aggregate where the volume being moved
originally resides or resided.
Start Time of Move: The date and time in the cluster time zone when the volume
move operation started.
Move State: The state of the volume move at the time of issuing the command
and the system gathering up the information about the move.
Parameters
specify.
| [-instance ] }
about all fields.
This specifies the Vserver on which the volume is located. If this parameter and the
-volume parameter are specified, the command displays detailed information about
latest move performed on the specified volume. If this parameter is specified by itself,
the command displays information about latest moves performed on volumes of the
specified Vserver.
1873

This specifies the volume that is part of a completed or running volume move operation.
detailed information about latest move performed on the specified volume. If this
parameter is specified by itself, the command displays information about the latest move
on all volumes matching the specified name.
[-actual-completion-time <Date>] - Actual Completion Time
If this parameter is specified, the command displays move operations that match the
specified date and time in the cluster time zone when the volume move completed.
[-bytes-remaining {<integer>[KB|MB|GB|TB|PB]}] - Bytes Remaining
specified number of bytes remaining to be sent during volume move.
[-cutover-action {abort_on_failure|defer_on_failure|force|wait|retry_on_failure}] Specified Action For Cutover (privilege: advanced)
specified action to be taken for cutover or during cutover failure.
[-cutover-window <integer>] - Specified Cutover Time Window (privilege: advanced)
specified time window in seconds for the cutover phase of volume move.
[-destination-aggregate <aggregate name>] - Destination Aggregate
specified name of the aggregate to which the volume is being moved.
[-destination-node <nodename>] - Destination Node (privilege: advanced)
specified name of the node where the destination aggregate is present.
[-details <text>] - Detailed Status
specified detail about any warnings, errors and state of the move operation.
[-estimated-completion-time <Date>] - Estimated Time of Completion
specified date and time in the cluster time zone when the entire volume move operation
is expected to complete.
[-job-id <integer>] - Job ID (privilege: advanced)
1874
specified Job-ID of the move job.
[-managing-node <nodename>] - Managing Node
specified node in the cluster on which the move job is or was running.
[-percent-complete <percent>] - Percentage Complete
If this parameter is specified, the command displays move operations that match
the specified the amount of work to move the volume completed thus far in terms of
percentage.
[-phase {queued|initializing|replicating|cutover|cutover_hard_deferred|
cutover_soft_deferred|aborting||completed|cleaning_up|failed|restarting}] - Move Phase
specified phase of the move operation.
[-prior-issues <text>] - Prior Issues Encountered (privilege: advanced)
specified issues or transient errors encountered causing the move operation to retry the
data copy phase or the cutover phase.
[-estimated-remaining-duration {<seconds>|[<d> days] <hh>:<mm>[:<ss>]}] Estimated Remaining Duration
specified time.
[-replication-throughput <text>] - Replication Throughput
specified replication throughput of the move operation in terms of Kb/s, Mb/s or Gb/s.
[-actual-duration {<seconds>|[<d> days] <hh>:<mm>[:<ss>]}] - Duration of Move
specified duration for which the volume move was or is in progress.
[-source-aggregate <aggregate name>] - Source Aggregate
specified name of the aggregate where the volume being moved originally resides or
resided.
[-source-node <nodename>] - Source Node (privilege: advanced)
1875
specified name of the node where the source aggregate is present.
[-start-time <Date>] - Start Time of Move
specified date and time in the cluster time zone when the volume move operation
started.
[-state {healthy|warning|alert|failed|done}] - Move State
specified state of the volume move operation.
[-moved-by-autobalance {true|false}] - Move Initiated by Auto Balance Aggregate
If this parameter is specified, the command displays move operations that were
triggered by the Auto Balance Aggregate feature.
Examples
The following example lists status of volume move operation for a volume vol2 on a
Vserver vs0
cluster1::> volume move show -vserver vs0 -volume vol2
Vserver Name: vs0
Volume Name: vol2
Bytes Remaining: 6.37GB
Actual Completion Time: Destination Aggregate: cluster1_aggr2
Detailed Status: Transferring data: 3.67GB sent.
Estimated Time of Completion: Sat Jul 16 20:25:50 2011
Managing Node: node1
Percentage Complete: 36%
Move Phase: replicating
Estimated Remaining Duration: 00:01
Replication Throughput: 61.08MB/s
Duration of Move: 00:02
Source Aggregate: cluster1_aggr1
Start Time of Move: Sat Jul 16 20:22:01 2011
Move State: healthy
Move Initiated by Auto Balance Aggregate: false
1876
The following example lists status of running and failed volume move operations in the
cluster.
Vserver
Volume
State
Move Phase Percent-Complete
Time-To-Complete
--------- ---------- -------- ---------- ------------------------------vs0
s1
alert
cutover_hard_deferred
vs0
vol2
failed
failed
98%
-
The following example lists status of all the volume move operations in the cluster.
cluster1::> vol move show -phase *
(volume move show)
Vserver
Volume
State
Time-To-Complete
--------- ---------- -------- ---------- ------------------------------vs0
s1
alert
cutover_hard_deferred
98%
vs0
s2
done
completed
100%
vs0
vol1
failed
failed
Vserver
Volume
State
Time-To-Complete
--------- ---------- -------- ---------- ------------------------------vs0
vol1
done
completed
100%
vs0
vol2
done
completed
100%
1877
volume move start

Start moving a volume from one aggregate to another aggregate
level.
Description
The volume move start command moves a flexible volume from one storage aggregate
to another. The destination aggregate can be located on the same node as the original
aggregate or on a different node. The move occurs within the context of the same
Vserver.
Parameters
This specifies the volume that will be moved.
-destination-aggregate <aggregate name> - Destination Aggregate
This specifies the aggregate to which the volume will be moved.
[-cutover-window <integer>] - Cutover time window in seconds (privilege: advanced)
This specifies the time interval to completely cutover operations from the original volume
to the moved volume. The default value is 45 seconds. The range for valid input is from
30 to 300 seconds, inclusive.
[-cutover-action {abort_on_failure|defer_on_failure|force|wait|retry_on_failure}] - Action
for Cutover (privilege: advanced)
Specifies the action to be taken for cutover. If the effective cluster version is Data
ONTAP 8.3 and later, the default is "retry_on_failure"; otherwise the default is
"defer_on_failure". 'If the "abort_on_failure" action is specified, the job tries to cutover
until cutover attempts are exhausted. If it fails to cutover, it cleans up and ends the
operation. If the "defer_on_failure" action is specified, the job tries to cutover until the
cutover attempts are exhausted. If itfails to cutover, it moves into the "cutover deferred"
state. The volume move job waits for the user to issue a volume move trigger-cutover
command to restart the cutover process. If the "force" action is specified, the job tries
to cutover until the cutover attempts are exhausted and forces the cutover at the
1878
expense of disrupting the clients. If the "wait" action is specified, when the job hits the
decision point, it does not go into cutover automatically, instead it waits for the user to
issue a volume move trigger-cutover command as the signal to try the cutover. If the
"retry_on_failure" action is specified, the job retries to cutover indefinitely and it never
enters a hard-deferred state. After exhausting cutover attempts, the move job waits one
hour before trying to cutover again. The user can issue a volume move trigger-cutover
command at any time to restart the cutover process.
[-perform-validation-only [true]] - Performs validation checks only
This is a boolean option allowing the user to perform pre-move validation checks for
the intended volume. When set to true, the command only performs the checks without
creating a move job. The default value is false.
This specifies whether the volume move operation runs as a foreground process. The
default setting is false (that is, the operation runs in the background).
Examples
The following example performs a validation-check for a volume named volume_test on
a Vserver named vs0 to determine if it can be moved to a destination-aggregate named
dest_aggr.
node::> volume move start -vserver vs0 -volume volume_test -destination-aggregate
dest_aggr -perform-validation-only true
volume move trigger-cutover

Trigger cutover of a move job
level.
Description
This command causes a replicating or deferred volume move job to attempt cutover.
Unless the force option is set, cutover entry is not guaranteed.
Parameters
The Vserver on which the volume is located.
1879

The volume that will be moved.
[-force [true]] - Force Cutover
The optional parameter, when set to true, forces cutover without any confirmation and
could possibly cause client I/O disruptions. Default is false.
Examples
cluster1::> volume move trigger-cutover -vserver vs0 -volume testvol_1 -force true
1880
volume move recommend show

Display Move Recommendations
privilege level.
Description
The volume move recommend show command displays moves that were
recommended by the Auto Balance Aggregate feature.
Parameters
specify.
| [-instance ] }
about all fields.
If this parameter is specified, the display will be limited to only those recommendations
with a Vserver that matches the specified value.
with a volume that matches the specified value.
[-creation-time <MM/DD/YYYY HH:MM:SS>] - Time Stamp of Recommendation
with a creation-time that matches the specified value.
[-source-aggregate <aggregate name>] - Unbalanced Aggregate Name
with a source-aggregate that matches the specified value.
[-source-space-after <percent>] - Space Free After Move (%)
1881
with a source-space-after that matches the specified value.
[-destination-aggregate <aggregate name>] - Destination Aggregate Name
with a destination-aggregate that matches the specified value.
[-destination-space-after <percent>] - Space Bump After Move (%)
with a destination-space-after that matches the specified value.
Examples
The following example displays information about the recommendations made by the
Auto Balance Aggregate feature.
cluster1::*> volume move recommend show -instance
Vserver Name: vs0.example.com
Volume Name: ro10
Time Stamp of Recommendation: 3/13/2014 16:26:39
Unbalanced Aggregate Name: aggr_1
Space Free After Move (%): 36%
Destination Aggregate Name: aggr_3
Space Bump After Move (%): 36%
1882
volume move target-aggr show

List target aggregates compatible for volume move
level.
Description
The volume move target-aggr show displays information about compatible target
aggregates for the specified volume to be moved to.
Parameters
specify.
| [-instance ] }
about all fields.
[-vserver <vserver name>] - Vserver Name (Required field)
Selects information about compatible target aggregates on volumes of the specified
Vserver.
[-volume <volume name>] - Volume Name (Required field)
Selects information about compatible target aggregates that have the specified volume
name.
Selects information about compatible target aggregates with the specified aggregate
name (to which the volume might be moved).
[-availsize {<integer>[KB|MB|GB|TB|PB]}] - Available size
Selects information about compatible target aggregates that have the specified available
size.
[-storagetype <text>] - Storage Type
1883
Selects information about compatible target aggregates with the specified storage
type. Examples of storage types are ATA, BSAS, FCAL, LUN, SATA, SAS and
SSD.
Examples
The following example lists target aggregates compatible for moving a volume vol1 on a
Vserver vs1
cluster1::> volume move target-aggr show -vserver vs1 -volume v11
Aggregate Name
Available Size
Storage Type
--------------
--------------
------------
aggr1
113.5GB
FCAL
aggr2
113.5GB
FCAL
1884
volume qtree create

Create a new qtree
Description
This command creates a qtree in the Vserver and volume you specify. You can create
up to 4,994 qtrees per volume. This command is not supported on Infinite Volumes.
You can optionally specify the following attributes when creating a new qtree:
Security style
Opportunistic lock mode
UNIX permissions
Export Policy
Parameters
This specifies the name of the Vserver on which the volume containing the qtree
belongs.
This specifies the name of the volume that will contain the qtree you are creating.
-qtree <qtree name> - Qtree Name
This specifies the name of the qtree you are creating.
A qtree name cannot contain a forward slash (/) and must be all ASCII characters. The
qtree name cannot be more than 64 characters long.
| -qtree-path <qtree path> } - Actual (Non-Junction) Qtree Path
The qtree path argument in the format /vol/<volume name>/<qtree name> can be
specified instead of specifying volume and qtree as separate arguments.
This optionally specifies the security style for the qtree, which determines how access to
the qtree is controlled. The supported values are unix (for UNIX uid, gid and mode bits),
1885
ntfs (for CIFS ACLs), and mixed (for NFS and CIFS access). The unified security style,
which applies only to Infinite Volumes, cannot be applied to a qtree. If you do not specify
a security style for the qtree, it inherits the security style of its containing volume.
[-oplock-mode {enable|disable}] - Oplock Mode
This optionally specifies whether oplocks are enabled for the qtree. If you do not specify
a value for this parameter, it inherits the oplock mode of its containing volume.
[-unix-permissions | -m <unix perm>] - Unix Permissions
This optionally specifies the UNIX permissions for the qtree when the -securitystyle is set to unix or mixed. You can specify UNIX permissions either as a fourdigit octal value (for example, 0700) or in the style of the UNIX ls command (for
example, -rwxr-x--- ). For information on UNIX permissions, see the UNIX or Linux
documentation. If you do not specify UNIX permissions for the qtree, it inherits the UNIX
permissions of its containing volume.
[-export-policy <text>] - Export Policy
This optional parameter specifies the name of the export policy associated with the
qtree. For information on export policies, see the documentation for the vserver
export-policy create command. If you do not specify a value for this parameter, it
inherits the export policy of its containing volume.
Examples
The following example creates a qtree named qtree1. The Vserver name is vs0 and
the volume containing the qtree is named vol1. The qtree has a mixed security style. Its
other attributes are inherited from volume vol1.
cluster1::> volume qtree create -vserver vs0 -volume vol1 -qtree qtree1 security-style mixed
The following example uses a 7G-compatible command to create the qtree.

cluster1::> vserver context vs0
vs0::> qtree create /vol/vol1/qtree1
See Also
vserver export-policy create
1886
volume qtree delete

Delete a qtree
Description
This command deletes a qtree. The length of time that it takes to delete a qtree depends
on the number of directories and files it contains. You can monitor the progress of the
delete operation by using the job show and job watch-progress commands,
respectively. This command is not supported on Infinite Volumes.
The automatically created qtree in the volume - qtree0, listed in CLI output as "" - cannot
be deleted.
Note:
Quota rules associated with this qtree in all the quota policies will be deleted when you
delete this qtree.
Parameters
belongs.
This specifies the name of the volume containing the qtree to be deleted.
This specifies the name of the qtree to be deleted.
1887
This optionally forces the qtree delete operation to proceed when the qtree contains
files. The default setting is false (that is, the qtree will not be deleted if it contains files).
This parameter is available only at the advanced privilege and higher.
This optionally specifies whether the qtree delete operation runs as a foreground
process. The default setting is false (that is, the operation runs in the background).
Examples
The following example deletes a qtree named qtree4. The Vserver name is vs0 and the
volume containing the qtree is named vol1.
cluster1::> volume qtree delete -vserver vs0 -volume vol1 -qtree qtree4
WARNING: Are you sure you want to delete qtree qtree4 in volume vol1 vserver vs0?
{y|n}: y
[Job 38] Job is queued: Delete qtree qtree4 in volume vol1 vserver vs0.
See Also
job show job watch-progress
1888
volume qtree modify

Modify qtree attributes
Description
This command allows you to modify the following attributes of an existing qtree in the
given Vserver and volume:
Security style
Opportunistic lock mode
UNIX permissions
Export policy
This command is not supported by Infinite Volumes.
Parameters
belongs.
This specifies the name of the volume containing the qtree to be modified.
This specifies the name of the qtree to be modified. You can modify the attributes
of qtree0 (represented as "" in the CLI) by omitting the -qtree parameter from the
command or by specifying the value """" for the -qtree parameter.
The qtree path argument in the format /vol/<volume name>/<qtree name> can
be specified instead of specifying volume and qtree as separate arguments. The
automatically created qtree0 can be represented as /vol/<volume name>.
1889
This optionally modifies the security style for the qtree. The supported values are unix
(for UNIX uid, gid and mode bits), ntfs (for CIFS ACLs), and mixed (for NFS and CIFS
access). The unified security style, which applies only to Infinite Volumes, cannot be
applied to a qtree. Modifying a qtree's security style will not affect any of the files in the
other qtrees of this volume.
This optionally modifies whether oplocks are enabled for the qtree.
Modifying qtree0's oplock mode will not affect any of the files in the other qtrees of this
volume.
[-unix-permissions <unix perm>] - Unix Permissions
This optionally modifies the UNIX permissions for the qtree. You can specify UNIX
permissions either as a four-digit octal value (for example, 0700) or in the style of the
UNIX ls command (for example, -rwxr-x---). For information on UNIX permissions,
see the UNIX or Linux documentation.
The unix permissions can be modified only for qtrees with unix or mixed security style.
This optional parameter modifies the export policy associated with the qtree. If you do
not specify an export policy name, the qtree inherits the export policy of the containing
volume.For information on export policy, see the documentation for the vserver
export-policy create command.
Examples
The following example modifies a qtree named qtree1. The Vserver name is vs0 and the
volume containing the qtree is named vol1. The qtree now has a UNIX security style and
oplocks are enabled.
cluster1::> volume qtree modify -vserver vs0 -volume vol1 -qtree qtree1 security-style unix -oplocks enabled
See Also
1890
volume qtree oplocks

Modify qtree oplock mode
Description
This command allows you to display or modify the opportunistic lock mode of a qtree.
Parameters
belongs.
This specifies the name of the volume containing the qtree.
This specifies the name of the qtree for which the oplock mode is being displayed or
modified.
This specifies the new oplock mode of the qtree. If this parameter is not specified, then
the current oplock mode of the qtree is displayed.
Modifying qtree0's oplock mode will not affect any of the files in the other qtrees of this
volume.
Examples
The following example displays the oplock mode of a qtree called qtree1. The Vserver
name is vs0 and the volume containing the qtree is named vol1.
cluster1::> volume qtree oplocks -vserver vs0 -volume vol1 -qtree qtree1
1891
/vol/vol1/qtree1 has mixed security style and oplocks are disabled.
The following example modifies the oplock mode of a qtree called qtree2 to enabled.
The Vserver name is vs0 and the volume containing the qtree is named vol1.
cluster1::> volume qtree oplocks -vserver vs0 -volume vol1 -qtree qtree2 -oplockmode enable
The following example uses a 7G-compatible command to display and modify the
oplock mode of a qtree.
vs0::> qtree oplocks /vol/vol1/qtree1
vs0::> qtree oplocks /vol/vol1/qtree2 enable
1892
volume qtree rename

Rename an existing qtree
Description
This command allows you to rename an existing qtree. This command is not supported
The automatically created qtree in the volume - qtree0, listed in CLI output as "" - cannot
be renamed.
Parameters
belongs.
This specifies the name of the volume containing the qtree to be renamed.
This specifies the name of the qtree to be renamed.
-newname <qtree name> - Qtree New Name
This specifies the new name of the qtree. The new qtree name cannot contain a forward
slash (/) and cannot bo more than 64 characters long.
Examples
The following example renames a qtree named qtree3 to qtree4. The Vserver name is
vs0 and the volume containing the qtree is named vol1.
cluster1::> volume qtree rename -vserver vs0 -volume vol1 -qtree qtree3 -newname
qtree4
1893
volume qtree security

Modify qtree security style
Description
This command allows you to display or modify the security style of a qtree. This
Parameters
belongs.
This specifies the name of the volume containing the qtree.
This specifies the name of the qtree for which the security style is being displayed or
modified.
This specifies the new security style of the qtree. If this parameter is not specified,
then the current security style of the qtree is displayed. The supported values are unix
(for UNIX uid, gid and mode bits), ntfs (for CIFS ACLs), and mixed (for NFS and CIFS
access). The unified security style, which applies only to Infinite Volumes, cannot be
applied to a qtree. Modifying a qtree's security style will not affect any of the files in the
other qtrees of this volume.
Examples
The following example displays the security style of a qtree called qtree1. The Vserver
name is vs0 and the volume containing the qtree is named vol1.
1894
cluster1::> volume qtree security -vserver vs0 -volume vol1 -qtree qtree1
The following example modifies the security style of a qtree called qtree2 to unix. The
Vserver name is vs0 and the volume containing the qtree is named vol1.
cluster1::> volume qtree security -vserver vs0 -volume vol1 -qtree qtree2 security-style unix
The following example uses a 7G-compatible command to display and modify the
security style of a qtree.
vs0::> qtree security /vol/vol1/qtree1
vs0::> qtree security /vol/vol1/qtree2 unix
1895
volume qtree show

Display a list of qtrees
Description
This command displays information about qtrees for online volumes. By default, the
command displays the following information about all qtrees in the cluster:
Vserver name
Volume name
Qtree name
Security style (unix, ntfs, mixed or unified)
Whether oplocks is enabled
Status (normal or readonly)
The display will also include information about Qtree 0. When you create a volume,
a special qtree referred to as "qtree0", also called the default qtree is automatically
created for the volume. It represents all of the data stored in a volume that is not
contained in a qtree. In the CLI output, qtree0 is denoted by empty quotation marks ("")
and has the ID zero (0). The qtree called qtree0 cannot be manually created or deleted.
The qtree status indicates readonly for data protection and load sharing volumes.
To display detailed information about a single qtree, run the command with the -instance
and -qtree parameters. The detailed view adds the following information:
UNIX permissions
Qtree ID
Export policy
Is Export Policy Inherited
Parameters
1896
specify.
| [-exports ]
Displays the following information about qtree exports:
Vserver - The name of the Vserver the qtree belongs to
Volume - The name of the volume the qtree resides on
Qtree name - The name of the qtree
Policy Name - The name of the export policy assigned to the qtree
Is Export Policy Inherited - Whether the export policy assigned to the qtree is
inherited
| [-id ]
Displays qtree IDs in addition to the default output.
| [-instance ] }
about all fields.
Selects information about the qtrees in the specified Vserver.
Selects information about the qtrees in the specified volume.
[-qtree <qtree name>] - Qtree Name
Selects information about the qtrees that have the specified name.
| [-qtree-path <qtree path>] } - Actual (Non-Junction) Qtree Path
Selects information about the qtrees that have the specified path.
Selects information about the qtrees that have the specified security style. The unified
security style, which applies only to Infinite Volumes, cannot be applied to a qtree.
Selects information about the qtrees that have the specified oplock mode.
[-unix-permissions | -m <unix perm>] - Unix Permissions
1897
Selects information about the qtrees that have the specified UNIX permissions.
[-qtree-id <integer>] - Qtree Id
Selects information about the qtrees that have the specified ID. A valid qtree ID is an
integer from 0 to 4994. All qtree0 (automatically created) qtrees have an ID of zero (0).
[-status {normal|readonly}] - Qtree Status
Selects information about the qtrees that have the specified status.
Selects information about the qtrees that use the specified export policy.
[-is-export-policy-inherited {true|false}] - Is Export Policy Inherited
Selects information about the qtrees that inherit (true) or not inherit (false) the export
policy of containing volume.
Examples
The following example displays default information about all qtrees along with each
qtree ID. Note that on vs0, no qtrees have been manually created, so only the
automatically created qtrees referred to as qtree 0 are shown. On vs1, the volume
named vs1_vol1 contains qtree 0 and two manually created qtrees, qtree1 and qtree2.
cluster1::> volume qtree show -id
Vserver
Volume
Qtree
Style
Oplocks
Status
Id
---------- ------------- ------------ ------------ ---------- -------- -vs0
vs0_vol1
""
unix
enable
readonly 0
vs0
vs0_vol2
""
unix
enable
normal
vs0
vs0_vol3
""
unix
enable
readonly 0
vs0
vs0_vol4
""
unix
enable
readonly 0
vs0
root_vs_vs0
""
unix
enable
normal
vs1
vs1_vol1
""
unix
enable
normal
vs1
vs1_vol1
qtree1
unix
disable
normal
vs1
vsl_vol1
qtree2
unix
enable
normal
vs1
root_vs_vs1
""
unix
enable
normal
1898
volume qtree statistics-reset

Reset qtree statistics in a volume
Description
This command resets qtree statistics for all qtrees in a volume. This command is not
Parameters
belongs.
This specifies the name of the volume containing the qtrees whose statistics you want to
reset.
Examples
The following example resets statistics for all qtrees on the volume named vol1 on the
Vserver named vs0.
cluster1::> volume qtree statistics-reset -vserver vs0 -volume vol1
volume qtree statistics

Display qtree statistics
Description
1899
This command displays NFS and CIFS operations statistics for qtrees. Note that
qtree statistics are available only when the volume containing the qtree is online. This
Statistics are cumulative values from the time the volume is brought online or when
the statistics have been reset by using the "volume qtree statistics-reset"
command.
parameters are specified, the command displays the following statistics information
about all qtrees:
Vserver name
Volume name
Qtree name
NFS operations
CIFS operations
Note:
Qtree statistics are not persistent. If you restart a node, if a storage takeover and
giveback occurs, or if the containing volume is set to offline and then online, qtree
statistics are set to zero.
Parameters
specify.
| [-internal ] (privilege: advanced)
If this parameter is specified, the output will also include the internal operation statistics.
Internal operation is any operation on the qtree that originated within Data ONTAP
software.
| [-no-reset ] (privilege: advanced)
If this parameter is specified, the output will display the NFS and CIFS op statistics since
the time the volume was online.
| [-no-reset-internal ] (privilege: advanced)
1900
If this parameter is specified, the output will also include the internal op statistics since
the time the volume was online.
| [-instance ] }
about all fields.
If this parameter is specified, the command displays information about the qtrees on the
specified Vserver.
If this parameter is specified, the command displays information about the qtrees on the
specified volume.
qtree.
| [-qtree-path <qtree path>] } - Actual (Non-Junction) Qtree Path
[-nfs-ops <Counter64>] - NFS operations since reset
If this parameter is specified, the command displays information about qtrees that
have the corresponding cumulative number of NFS operations since the statistics was
zeroed.
[-cifs-ops <Counter64>] - CIFS operations since reset
If this parameter is specified, the command displays information about qtrees that
have the corresponding cumulative number of CIFS operations since the statistics was
zeroed.
[-internal-ops <Counter64>] - Internal operations since reset (privilege: advanced)
If this parameter is specified, the command displays information about qtrees that have
the corresponding cumulative number of internal operations since the statistics was
zeroed.
[-no-reset-nfs-ops <Counter64>] - NFS operations since online (privilege: advanced)
the corresponding cumulative number of NFS operations since the volume was online.
1901
[-no-reset-cifs-ops <Counter64>] - CIFS operations since online (privilege: advanced)

the corresponding cumulative number of CIFS operations since the volume was online.
[-no-reset-internal-ops <Counter64>] - Internal operations since online (privilege:
advanced)
the corresponding cumulative number of internal operations since the volume was
online.
Examples
The following example displays statistics information for all qtrees on the Vserver named
vs0.
cluster1::> volume qtree statistics -vserver vs0
Vserver
Volume
Qtree
NFS Ops
CIFS Ops
---------- ------------- ------------ ------------ ---------vs0
vol0
qtree1
10876
2678
vs0
vol1
qtree1a
16543
vs0
vol2
qtree2
vs0
vol2
qtree2a
The following example displays statistics information for qtrees on Vserver vs0 that have
NFS ops more than 15000.
cluster1::> volume qtree statistics -vserver vs0 -nfs-ops >15000
Vserver
Volume
Qtree
NFS Ops
CIFS Ops
---------- ------------- ------------ ------------ ---------vs0
vol1
qtree1a
16543
See Also
volume qtree statistics-reset
1902
volume quota modify

Modify quota state for volumes
Description
This command allows you to modify the following quota attributes for one or more
volumes:
Quota state
Whether quota exceeded messages are logged or not
Frequency with which quota exceeded messages are logged
Modifications to the quota state for a volume creates a job to perform the quota state
changes for that volume. You can monitor the progress of the job by using the job
show and job watch-progress commands. This command is not supported on
Infinite Volumes.
Parameters
This specifies the name of the Vserver on which the volume whose quota attributes you
are modifying is located.
This specifies the name of the volume whose quota attributes you are modifying.
[-state <quota_state>] - Quota State
This parameter optionally modifies the quota state to one of the following:
off - This indicates that quotas be deactivated for the specified volume.
on - This indicates that quotas be activated for the specified volume.
resize - This indicates that the quota limits be resized according to the values
specified in the quota policy assigned to the Vserver. Note that quotas must be
activated first for a volume before a resize operation can be performed.
1903
Both quota activation and quota resize operations apply the quota rules configured for
the volume within the quota policy that is currently assigned to the Vserver. These quota
rules are managed by using the commands in the volume quota policy rule
menu. Quotas, when activated for a volume, go through an initialization process. As
part of the quota initialization all the quota rules are applied to the volume. In addition, a
filesystem scanner is started to scan the entire filesystem within the volume to bring the
quota accounting and reporting up to date. The quota job finishes after the filesystem
scanner is started on the volume. The quota state for the volume is initializing
until the filesystem scanner finishes scanning the entire filesystem. After the scanning is
complete, the quota state will be on.
When quotas are resized, the quota state is resizing until the resizing operation
finishes. As part of this operation, the quota limits for quotas currently in effect are
resized to the limits currently configured for the volume. After the quota resize operation
finishes, the quota state will be on.
Quota state changes can also be performed using the commands volume quota on,
volume quota off and volume quota resize.
[-logging {on|off}] - Logging Messages
This parameter optionally specifies whether quota exceeded syslog/EMS messages are
logged in the system log messages. When it is set to on, quota exceeded messages are
generated when the user exceeds the quota's disk limit or the file limit through a NFS/
CIFS operation or any operation within the Data ONTAP software. When set to off no
quota exceeded messages are generated. This parameter can be changed only after
quotas are activated for a volume.
[-logging-interval <text>] - Logging Interval
This parameter optionally specifies a logging interval, which indicates the frequency with
which quota exceeded messages are generated. You can specify a logging interval in
the <integer><suffix> format, where suffix can be minutes (m), hours (h), or days
(d), but not combinations thereof (in other words, 90m is a valid logging interval, but
1h30m is not a valid logging interval). You can modify the logging interval only when the
logging is on. When quotas are first activated, the logging parameter is automatically set
to on, and the logging interval set to 1h. If continuous logging is required, an interval of
0m should be specified. This parameter can be changed only after quotas are activated
for a volume.
Note:
quota message logging may not occur at exactly the same interval rate as specified by
the user, especially for very small intervals. This is due to the behavior of the logging
system that buffers messages instead of outputting them immediately. Setting the
1904
logging interval to 0m can cause lots of quota exceeded messages to be logged in the
system log messages.
This parameter optionally specifies whether the job created by quota state modify
operation runs as a foreground process. The default setting is false (that is, the quota
state modify operation runs in the background). When set to true, the command will
not return until the job completes.
Examples
The following example activates quotas on the volume named vol1, which exists on
Vserver vs0.
cluster1::> volume quota modify -vserver vs0 -volume vol1 -state on
[Job 24] Job is queued: Quota ON Operation on vserver vs0 volume vol1.
The following example turns on quota message logging and sets the logging interval to
4 hours.
cluster1::> volume quota modify -vserver vs0 -volume vol1 -logging on -logginginterval 4h
The following example resizes quota limits on a volume.

cluster1::> volume quota modify -vserver vs0 -volume vol1 -state resize foreground true
[Job 80] Job succeeded: Successful
See Also
volume quota policy rule volume quota on volume quota off volume quota resize
job show job watch-progress volume quota show
1905
volume quota off

Turn off quotas for volumes
Description
This command creates a job to deactivate quotas for the specified volume. This
command is not supported on Infinite Volumes. You can monitor the progress of the job
by using the job show and job watch-progress commands.
Parameters
This specifies the name of the Vserver on which the volume is located.
This specifies the name of the volume on which you are deactivating quotas.
This optionally specifies whether the job created for deactivating quotas runs as a
foreground process. The default setting is false (that is, the operation runs in the
background). When set to true, the command will not return until the job completes.
Examples
The following example deactivates quotas on the volume named vol1, which exists on
Vserver vs0.
cluster1::> volume quota off -vserver vs0 -volume vol1
[Job 23] Job is queued: Quota OFF Operation on vserver vs0 volume vol1.
The following example uses a 7G-compatible command to deactivate quotas on the

volume named vol1 which exists on Vserver vs0.
vs0::> quota off vol1
[Job 25] Job is queued: Quota OFF Operation on vserver vs0 volume vol1.
1906
See Also
job show job watch-progress volume quota modify
1907
volume quota on
Turn on quotas for volumes
Description
This command creates a job to activate quotas for the specified volume. This command
is not supported on Infinite Volumes. You can monitor the progress of the job by using
the job show and job watch-progress commands.
Parameters
This specifies the name of the volume on which you are activating quotas.
This optionally specifies whether the job created for activating quotas runs as a
The quota job finishes after the filesystem scanner is started. The quota state for the
volume is initializing until the filesystem scanner finishes scanning the entire
filesystem. After the scanning is complete, the quota state will be on.
Examples
The following example activates quotas on the volume named vol1, which exists on
Vserver vs0.
cluster1::> volume quota on -vserver vs0 -volume vol1
The following example uses a 7G-compatible command to activate quotas on the

volume named vol1 which exists on Vserver vs0.
1908
vs0::> quota on -w vol1

[Job 25] Job succeeded: Successful
See Also
1909
volume quota report

Display the quota report for volumes
Description
This command displays the quota report for all volumes in each Vserver that are online
and for which quotas are activated. Quota report includes the quota rules (default,
explicit, and derived) in effect and the associated resource usage (disk space and files).
If quotas are still initializing for a specific volume, that volume is not included. This
This command displays the following information:
Vserver name
Volume name
Index - This is a unique number within a volume assigned to each quota rule
displayed in the quota report.
Tree name - This field gives the name of the qtree if the quota rule is at the qtree
level. It is empty if the quota rule is at the volume level.
Quota type - Type of quota rule (tree or user or group).
Quota target - This field gives the name of the target of the quota rule. For tree
quota rules, it will be the qtree ID of the qtree. For user quota rules, it will be the
UNIX user name or the Windows user name. For group quota rules, it will be the
UNIX group name. For default rules (tree or user or group), this will display "*".
If the UNIX user identifier, UNIX group identifier, or Windows security identifier
no longer exists or if the identifier-to-name conversion fails, the target appears in
numeric form.
Quota target ID - This field gives the target of the quota rule in numeric form. For
tree quota rules, it will be the qtree ID of the qtree. For group quota rules, it will
be the UNIX group identifier. For UNIX user quota rules, it will be the UNIX user
identifier. For Windows user quota rules, it will be the Windows security identifier
in its native format. For default rules (tree or user or group), "*" will be displayed.
Disk space used - For a default quota, the value is 0.
Disk space limit
1910
Soft disk space limit

Threshold for disk space limit
Files used - For a default quota, the value is 0.
File limit
Soft file limit
Quota specifier - For an explicit quota, this field shows how the quota target was
configured by the administrator using the volume quota policy rule command. For
a default quota, the field shows "*". For a derived tree quota, this field shows the
qtree path. For a derived user and group quota, the field is either blank or "*".
The following parameters: -soft, -soft-limit-thresholds, -target-id, thresholds, -fields and -instance display different set of fields listed above. For
example, -soft will display the soft disk space limit and soft file limit apart from other
information. Similarly -target-id will display the target in the numeric form.
A quota report is a resource intensive operation. If you run it on many volumes in the
cluster, it might take a long time to complete. A more efficient way would be to view the
quota report for a particular volume in a Vserver.
Depending upon the quota rules configured for a volume, the quota report for a single
volume can be large. If you want to monitor the quota report entry for a particular tree/
user/group repeatedly, find the index of that quota report entry and use the -index field
to view only that quota report entry. See the examples section for an illustration.
Parameters
specify.
| [-soft ]
If this parameter is specified, the command display will include the soft disk space limit
and the soft file limit.
| [-soft-limit-thresholds ]
If this parameter is specified, the command display will include the soft disk space limit,
threshold for disk space limit and soft file limit.
| [-target-id ]
1911
If this parameter is specified, the command will display the target of a user or group
quota rule in numeric form.
| [-thresholds ]
If this parameter is specified, the command display will include the threshold for disk
space limit.
| [-instance ] }
about all fields.
If this parameter is specified, the command displays the quota report for volumes in the
specified Vserver.
If this parameter is specified, the command displays the quota report for the specified
volume.
If this parameter is specified, the command displays the quota report for the quota rules
that have the specified index.
[-tree <qtree name>] - Qtree Name
that have the specified qtree name.
[-quota-type <text>] - Quota Type
of the given type.
[-quota-target <text>] - Quota Target
that have the specified quota target.
[-quota-target-id <text>] - Quota Target ID
that have the specified quota target identifier.
[-disk-used {<integer>[KB|MB|GB|TB|PB]}] - Disk Space Used
that have the specified disk space used value.
1912
[-disk-limit {<integer>[KB|MB|GB|TB|PB]}] - Disk Space Limit

that have the specified disk space limit.
[-files-used <integer>] - Files Used
that have the specified files used value.
[-file-limit <integer>] - Files Limit
that have the specified file limit.
[-threshold {<integer>[KB|MB|GB|TB|PB]}] - Disk Space Threshold
that have the specified threshold for disk space limit.
[-soft-disk-limit {<integer>[KB|MB|GB|TB|PB]}] - Soft Disk Space Limit
that have the specified soft disk space limit.
[-soft-file-limit <integer>] - Soft Files Limit
that have the specified soft file limit.
[-quota-specifier <text>] - Quota Specifier
that have the specified quota specifier.
[-path <text>] - Path
If this parameter is specified, the command will display the quota report for the quota
rules that are applicable for the file in the specified path. The format of the path to the
file should begin with /vol/<volume name>/. The quota rules that are applicable typically
consists of the tree quota rule corresponding to the qtree in which the file resides within
the volume, user quota rule at the volume and qtree level corresponding to the UNIX
user identifier or the Windows security identifier associated with the file and the group
quota rule at the volume and qtree level corresponding to the UNIX group identifier
associated with the file.
Examples
The following example displays the quota report for all the volumes.
cluster1::> volume quota report
1913
Vserver: vs0
----Disk----
Quota
Volume
Tree
Type
ID
Used
Limit
Used
Limit
Specifier
-------
--------
------
-------
-----
-----
------
------
---------
tree
0.00B
100MB
10000
tree
0.00B
200MB
20000
vxw02
user
0.00B
50MB
user
sam,Engr\Sammy
0.00B
100MB
sam
group
0.00B
500MB
vol2
vol2
vxw02
vol2
vol2
vxw02
vol2
vol2
q1
tree
1MB
100MB
10000
vol2
q1
user
0.00B
50MB
vol2
q1
group
0.00B
500MB
vol2
q1
group
root
1MB
vol2
vxw01
tree
0.00B
100MB
10000
vol2
vxw01
user
0.00B
50MB
vol2
vxw01
group
0.00B
500MB
vol2
vxw01
group
root
0.00B
vol2
vxw02
user
0.00B
50MB
vol2
vxw02
group
0.00B
500MB
vol2
vxw02
group
root
0.00B
vol2
vxw03
tree
0.00B
100MB
10000
vol2
vxw03
user
0.00B
50MB
vol2
vxw03
group
0.00B
500MB
vol2
vxw03
group
root
0.00B
group
root
1MB
50MB
vol2
vol2
q1
user
root,Engr\root
vol2
vxw01
user
root,Engr\root
vol2
vxw02
user
root,Engr\root
0.00B
0.00B
0.00B
vol2
vxw03
user
root,Engr\root
vol2
user
root,Engr\root
vol2
user
john,Engr\John
user
john,Engr\John
0.00B
0.00B
1MB
vol2
1914
----Files-----
q1
q1
vxw01
vxw03
1MB
50MB
The following example displays the quota report for the quota rules that are applicable
for the given path to a file.
cluster1::> volume quota report -path /vol/vol2/q1/file1
Vserver: vs0
----Disk---Volume
Tree
Type
ID
-------
--------
------
-------
vol2
q1
tree
vol2
q1
----Files-----
Limit
Used
Limit
Specifier
-----
-----
------
------
---------
1MB
100MB
10000
group
root
1MB
vol2
group
root
1MB
vol2
user
john,Engr\John
50MB
user
john,Engr\John
50MB
1MB
vol2
q1
Quota
Used
1MB
q1
The following example displays the quota report with the target in the numeric form for
the given path to a file.
cluster1::> volume quota report -path /vol/vol2/q1/file1 -target-id
Vserver: vs0
----Disk---Volume
Tree
Type
ID
-------
--------
------
-------
vol2
q1
tree
vol2
q1
group
vol2
vol2
q1
Quota
Limit
Used
Limit
Specifier
-----
-----
------
------
---------
1MB
100MB
10000
1MB
group
1MB
user
8017,S-1-5-21-3567637-1906459281-1427260136-60871
1MB
vol2
----Files-----
Used
user
50MB
q1
8017,S-1-5-21-3567637-1906459281-1427260136-60871
1MB
50MB
1915
The following example shows how to monitor the quota report for a particular user/tree/
group. First, the quota report command is issued with -instance to see the index field
for the quota report entry we are interested in. Next, the quota report is issued with the
-index field specified to fetch only that particular quota report entry repeatedly to view
the usage over time.
cluster1::> volume quota report -vserver vs0 -volume vol1 -quota-type user quota-target john -tree q1 -instance
Vserver Name: vs0
Volume Name: vol1
Index: 10
Qtree Name: q1
Quota Type: user
Quota Target: john
Quota Target ID: 5433
Disk Space Used: 50.5MB
Disk Space Limit: 100MB
Files Used: 205
Files Limit: Disk Space Threshold: 95MB
Soft Disk Space Limit: 80MB
Soft Files Limit: Quota Specifier: john
cluster1::> volume quota report -vserver vs0 -volume vol1 -index 10
Vserver Name: vs0
Volume Name: vol1
Index: 10
Qtree Name: q1
Quota Type: user
Quota Target: john
Disk Space Used: 55MB
Files Used: 410
Soft Files Limit: -
1916
Quota Specifier: john

cluster1::> volume quota report -vserver vs0 -volume vol1 -index 10
Vserver Name: vs0
Volume Name: vol1
Index: 10
Qtree Name: q1
Quota Type: user
Quota Target: john
Disk Space Used: 60.7B
Files Used: 500
Soft Files Limit: Quota Specifier: john
See Also
volume quota show volume quota modify volume quota policy rule
1917
volume quota resize

Resize quotas for volumes
Description
This command resizes the quota limits for the quotas currently in effect for the specified
volume. It creates a job to resize quotas. This command is not supported on Infinite
Volumes. You can monitor the progress of the job by using the job show and job
watch-progress commands.
Note:
Quotas must be activated before quota limits can be resized.
Parameters
This specifies the name of the volume on which you are resizing the quota limits and
threshold.
This optionally specifies whether the job created for resizing quotas runs as a
Examples
The following example resizes quotas on the volume named vol1, which exists on
Vserver vs0.
cluster1::> volume quota resize -vserver vs0 -volume vol1
[Job 34] Job is queued: Quota RESIZE Operation on vserver vs0 volume vol1.
1918
The following example uses a 7G-compatible command to resize quotas on the volume
named vol1 which exists on Vserver vs0.
vs0::> quota resize vol1
[Job 35] Job is queued: Quota RESIZE Operation on vserver vs0 volume vol1.
See Also
1919
volume quota show

Display quota state for volumes
Description
This command displays information about quotas for online volumes. The command
output depends on the parameters specified with the command. Quotas can only be
administered on FlexVol volumes. This command is not supported on Infinite Volumes.
If no parameters are specified, the command displays the following information for all
volumes:
Vserver name
Volume name
Quota state - quota state for this volume. The possible values are as follows:
off - this state indicates that quotas are deactivated for the volume.
on - this state indicates that quotas are activated for the volume.
initializing - this state indicates that quotas are being initialized for the
volume.
resizing - this state indicates that quota limits are being resized for the
volume.
corrupt - this state indicates that quotas are corrupt for this volume.
Scan status - percentage of the files in the volume scanned by the quota scanner
that runs as part of activating quotas.
Last error - most recently generated error message as part of the last quota
operation (on or resize). Present only if an error has been generated.
To display detailed information about all volumes, run the command with the -instance
parameter. The detailed view provides all of the information in the previous list and the
following additional information:
Logging messages - whether quota exceeded syslog/EMS messages are logged
or not. For volumes where the quota logging parameter is set to on, quota
exceeded messages are generated when a NFS/CIFS operation or any internal
1920
Data ONTAP operation is being prevented because the quota disk usage is
exceeding the disk limit or the quota file usage is exceeding the file limit. For
quotas where the logging parameter is set to off, no quota exceeded messages
are generated.
Logging interval - frequency with which quota exceeded messages are logged.
This parameter only applies to volumes that have the logging parameter set to on.
Sub status - additional status about quotas for this volume. Following are the
possible values reported:
upgrading - this indicates that the quota metadata format is being
upgraded from an older version to a newer version for the volume.
setup - this indicates that the quotas are being setup on the volume.
transferring rules - this indicates that the quota rules are being
transferred to the volume.
scanning - this indicates that the quota filesystem scanner is currently
running on the volume.
finishing - this indicates that the quota on or resize operation is in the
final stage of the operation.
done - this indicates that the quota operation is finished.
none - this indicates that there is no additional status.
All errors - collection of all the error messages generated as part of the last quota
operation (on or resize) since the volume was online.
User quota enforced (advanced privilege only) - indicates whether there are user
quota rules being enforced.
Group quota enforced (advanced privilege only)- indicates whether there are
group quota rules being enforced.
Tree quota enforced (advanced privilege only) - indicates whether there are tree
quota rules being enforced.
Parameters
specify.
1921
| [-logmsg ]
If this parameter is specified, the command displays whether quota exceeded messages
are logged and the logging interval for the quota messages.
| [-instance ] }
about all fields.
If this parameter is specified, the command displays information for the volumes in the
specified Vserver.
If this parameter is specified, the command displays information for the specified
volume.
[-state <quota_state>] - Quota State
If this parameter is specified, the command displays information for the volumes that
have the specified quota state.
[-scan-status <percent>] - Scan Status
If this parameter is specified, the command displays information about the volumes
whose scan-status matches the specified percentage value. The scan status is
displayed in the format [0-100]%.
[-logging {on|off}] - Logging Messages
If this parameter is specified, the command displays information about the volumes that
have the specified logging setting.
[-logging-interval <text>] - Logging Interval
have the specified quota logging interval.
[-sub-status <text>] - Sub Quota Status
have the specified quota sub-status.
[-last-error <text>] - Last Quota Error Message
whose last error matches the specified error message.
[-errors <text>] - Collection of Quota Errors
1922
whose collection of errors match the specified error message.
[-is-user-quota-enforced {true|false}] - User Quota enforced (privilege: advanced)
have the specified value for this field.
[-is-group-quota-enforced {true|false}] - Group Quota enforced (privilege: advanced)
[-is-tree-quota-enforced {true|false}] - Tree Quota enforced (privilege: advanced)
Examples
The following example displays information about all volumes on the Vserver named
vs0.
cluster1::> volume quota show -vserver vs0
Scan
Vserver
Volume
State
Status
---------
------------
---------------
------
vs0
root_vs0
off
vs0
vol1
off
Last Error: Volume vol1 has no valid quota rules

vs0
vol2
on
vs0
vol3
initializing
30%
The following example displays the logging information for all the volumes.
cluster1::> volume quota show -logmsg
Logging
Logging
Vserver
Volume
State
Message
Interval
---------
------------
---------------
-------
--------
vs0
root_vs0
off
vs0
vol1
off
vs0
vol2
on
on
1h
vs0
vol3
on
on
1h
1923
The following example displays detailed information in advanced privilege for a volume
vol1, which exists on Vserver vs0
cluster1::*> volume quota show -instance -vserver vs0 -volume vol1
Vserver Name: vs0
Volume Name: vol1
Quota State: on
Scan Status: Logging Messages: on
Logging Interval: 1h
Sub Quota Status: none
Last Quota Error Message: Collection of Quota Errors: User Quota enforced: true
Group Quota enforced: false
Tree Quota enforced: false
The following example displays the detailed information when quotas are upgrading for
volume vol1, which exists on Vserver vs0.
cluster1::> volume quota show -instance -vserver vs0 -volume vol1
Vserver Name: vs0
Volume Name: vol1
Quota State: initializing
Scan Status: 3%
Logging Messages: Logging Interval: Sub Quota Status: upgrading
Last Quota Error Message: -
1924
Collection of Quota Errors: -
The following example displays the "Last Quota Error Message" and the "Collection of
Quota Errors" for volume vol1, which exists on Vserver vs0
cluster1::> volume quota show -instance -vserver vs0 -volume vol1
Vserver Name: vs0
Volume Name: vol1
Quota State: on
Scan Status: Logging Messages: on
Logging Interval: 1h
Sub Quota Status: none
Last Quota Error Message: second definition for user2 (type:user
target:user2,user4 qtree:"").
Collection of Quota Errors: second definition for user1 (type:user
second definition for user2 (type:user
1925
volume quota policy copy

Copy a quota policy
Description
This command copies a quota policy and the rules it contains. This command is not
supported on Infinite Volumes. You must enter the following information to copy a quota
policy:
Vserver name
Policy name
New policy name
Parameters
This parameter specifies the Vserver from which you are copying the quota policy.
-policy-name <text> - Policy Name
This parameter specifies the name of the quota policy you are copying.
-new-policy-name <text> - New Policy Name
This parameter specifies the name of the new quota policy you are copying to. The new
name cannot have more than 32 characters.
Examples
The following example copies a quota policy named quota_policy_0 on Vserver vs0. It is
copied to quota_policy_1.
cluster1::> volume quota policy copy -vserver vs0 -policy-name quota_policy_0 new-policy-name quota_policy_1
volume quota policy create
1926
Create a quota policy

Description
A quota policy is collection of quota rules for all the volumes in a specific Vserver. This
command creates a quota policy for a specific Vserver. Multiple quota policies can be
created for a Vserver, but only one of them can be assigned to the Vserver. A Vserver
can have a maximum of five quota policies. If five quota policies already exist, the
command fails and a quota policy must be deleted before another quota policy can be
created. This command is not supported on Infinite Volumes.
When you turn on quotas for a volume, the quota rules to be enforced on that volume
will be picked from the quota policy that is assigned to the Vserver containing that
volume. The quota policy for clustered volumes is equivalent to the /etc/quotas file in
7G.
You must enter the following information to create a quota policy:
Vserver name
Policy name
Parameters
This parameter specifies the Vserver for which you are creating the quota policy. You
can create a quota policy only for a data Vserver. Quota policies cannot be created for a
node or admin Vserver.
This parameter specifies the name of the quota policy you are creating. The quota policy
name cannot be more than 32 characters long and must be unique within the Vserver.
Examples
The following example creates a quota policy named quota_policy_0 on Vserver vs0.
cluster1::> volume quota policy create -vserver vs0 -policy-name quota_policy_0
volume quota policy delete
1927
Delete a quota policy

Description
This command deletes a quota policy and all the rules it contains. The policy can be
deleted only when it is not assigned to the Vserver. This command is not supported on
Infinite Volumes. You must enter the following information to delete a quota policy:
Vserver name
Policy name
Parameters
This parameter specifies the Vserver containing the quota policy you want to delete.
This parameter specifies the name of the quota policy you want to delete.
Examples
The following example deletes a quota policy named quota_policy_5 on Vserver vs0.
cluster1::> volume quota policy delete -vserver vs0 -policy-name quota_policy_5
volume quota policy rename

Rename a quota policy
Description
This command renames a quota policy. This command is not supported on Infinite
Volumes. You must enter the following information to rename a quota policy:
Vserver name
Policy name
1928
New policy name
Parameters
This parameter specifies the Vserver containing the quota policy you want to rename.
This parameter specifies the name of the quota policy you are renaming.
-new-policy-name <text> - New Policy Name
This parameter specifies the new name of the quota policy. The new name cannot be
more than 32 characters long.
Examples
The following example renames a quota policy named quota_policy_0 on Vserver vs0.
The policy's new name is quota_policy_1.
cluster1::> volume quota policy rename -vserver vs0 -policy-name quota_policy_0 new-policy-name quota_policy_1
volume quota policy show

Display the quota policies
Description
This command displays information about quota policies. This command is not
supported on Infinite Volumes. The command displays the following information about
all quota policies:
Vserver name
Policy name
When the policy was last modified
Parameters
1929

specify.
| [-instance ] }
about all fields.
If this parameter is specified, the command displays information about the quota policies
for the specified Vserver.
[-policy-name <text>] - Policy Name
If this optional parameter is specified, the command displays information about quota
policies that match the specified name.
[-last-modified <MM/DD/YYYY HH:MM:SS>] - Last Modified
If this optional parameter is specified, the command displays information about quota
policies with the last modified time that match the given time.
Examples
The following example displays information about all quota policies.
cluster1::> volume quota policy show
Vserver
Policy
---------------
--------------------
Name
Last Modified
----------------
vs0
quota_policy_vs0
10/16/2008 17:40:05
vs1
quota_policy_vs1
10/16/2008 17:47:45
vs2
quota_policy_vs2
10/16/2008 17:44:13
vs3
quota_policy_vs3
10/16/2008 17:44:13
1930
volume quota policy rule create

Create a new quota rule
Description
This command creates a quota policy rule. This command is not supported on Infinite
Volumes. You must enter the following information to create a quota policy rule:
Vserver name
Quota policy name
Volume name
Quota target type
Target to which the rule applies
Qtree to which the rule applies
You can optionally specify the following additional attributes for the quota policy rule:
User mapping
Hard disk limit
Hard file limit
Threshold for disk limit
Soft disk limit
Soft file limit
Note:
For a new quota policy rule to get enforced on the volume, you should create the rule
in the quota policy assigned to the Vserver. Additionally, a quota off and on or a quota
resize operation must be done using the "volume quota modify" command.
Parameters
1931
This parameter specifies the Vserver containing the quota policy for which you are
creating a rule.
This parameter specifies the name of the quota policy in which you are creating a rule.
This parameter specifies the name of the volume for which you are creating a rule.
-type {tree|user|group} - Type
This parameter specifies the quota target type of the rule you are creating.
-target <text> - Target
This parameter specifies the target to which the quota policy rule applies. For default
quota rules, this parameter should be specified as "". For explicit tree quotas rules,
this parameter should indicate the qtree name. For explicit user quota rules, this
parameter can contain UNIX user name, UNIX user identifier, Windows user name,
Windows Security Identifier or a path to an existing object within the volume. If a
name contains a space, enclose the entire value in quotes. A UNIX user name cannot
include a backslash (\) or an @ sign; user names with these characters are treated as
Windows names. For multi-user quotas, this parameter can contain multiple user targets
separated by a comma. For explicit group quota rules, this parameter can contain UNIX
group name or UNIX group identifier or a path to an existing object within the volume.
When a path is specified as the target, it should be of the format /vol/<vol-name>/<path
to file from volume root> where the volume matches that of the -volume parameter.
This parameter specifies the name of the qtree to which the quota rule applies. This
parameter is not applicable for tree type rules. For user or group type rules at the
volume level, this parameter should contain "".
[-user-mapping {on|off}] - User Mapping
This parameter optionally specifies if user mapping needs to be performed for a user
quota rule. If this parameter is "on", the UNIX user name specified as the quota target
will be mapped to the corresponding Windows user name or vice-versa and quota
accounting will be performed for the users together. The mapping will be obtained as
configured in "vserver name-mapping".
Note that this parameter can be specified only for quota policy rules of type user. A
value of "on" can be specified for this parameter only if the quota target is a UNIX user
name or a Windows user name and cannot be specified for multi-user quota targets.
[-disk-limit {<size>|-}] - Disk Limit
1932
This parameter optionally specifies a hard limit for the disk space that can be consumed
by the quota target. The default unit for the disk limit is assumed to be Kilobytes if
no units are specified. When the hard disk space limit is reached, no additional disk
space can be consumed by the specified target. The value that you specify for this
parameter should be greater than or equal to the threshold and soft disk limit. A disk
limit of unlimited can be specified with a "-" for this parameter or by not specifying this
parameter and will be indicated by a "-". The maximum value is 1,125,899,906,842,620
KB, which is approximately 1,023 PB. The value should be a multiple of 4 KB. If it is
not, this field can appear incorrect in quota reports. This happens because the field is
always rounded up to the nearest multiple of 4 KB to match disk space limits, which are
translated into 4-KB disk blocks. The value can be larger than the amount of disk space
available in the volume.
[-file-limit {<integer>|-}] - Files Limit
This parameter optionally specifies a hard limit for the number of files permitted on the
quota target. When the hard number of files limit is reached, no additional files can be
created by the specified target. The value that you specify for this parameter should be
greater than or equal to the soft file limit. A file limit of unlimited can be specified with a
"-" for this parameter or by not specifying this parameter and will be indicated by a "-".
The maximum value is 4,294,967,295.
[-threshold {<size>|-}] - Threshold for Disk Limit
This parameter optionally specifies the disk limit threshold for the quota target. The
default unit for the disk limit threshold is assumed to be Kilobytes if no units are
specified. When the disk limit threshold is exceeded, a console message, an EMS
event, and an SNMP trap are generated. The value that you specify for this parameter
should be greater than or equal to the soft disk limit and equal to or less than the
disk limit. A threshold of unlimited can be specified with a "-" for this parameter or by
not specifying this parameter and will be indicated by a "-". The maximum value is
1,125,899,906,842,620 KB, which is approximately 1,023 PB. The value should be a
multiple of 4 KB. If it is not, this field can appear incorrect in quota reports. This happens
because the field is always rounded up to the nearest multiple of 4 KB to match disk
space limits, which are translated into 4-KB disk blocks.
[-soft-disk-limit {<size>|-}] - Soft Disk Limit
This parameter optionally specifies a soft limit for the disk space that can be consumed
by the quota target. The soft disk limit indicates that the hard limit for the disk space will
soon be exceeded. The default unit for the soft disk limit is assumed to be Kilobytes
if no units are specified. When the soft limit for the disk space is exceeded, a console
message, an EMS event and an SNMP trap are generated. The same happens when
the disk space used goes below the specified limit. The value that you specify for this
parameter should be equal to or less than the threshold and the disk limit. A soft disk
limit of unlimited can be specified with a "-" for this parameter or by not specifying this
1933
parameter and will be indicated by a "-". The maximum value is 1,125,899,906,842,620

KB, which is approximately 1,023 PB. The value should be a multiple of 4 KB. If it is
not, this field can appear incorrect in quota reports. This happens because the field is
always rounded up to the nearest multiple of 4 KB to match disk space limits, which are
translated into 4-KB disk blocks.
[-soft-file-limit {<integer>|-}] - Soft Files Limit
This parameter optionally specifies a soft limit for the number of files permitted on
the quota target. The soft file limit indicates that the hard limit for the number of files
will soon be exceeded. When the soft limit for the number of files is exceeded, a
console message, an EMS event and an SNMP trap are generated. The same happens
when the files used goes below the specified limit. The value that you specify for this
parameter should be equal to or less than the file limit. A soft file limit of unlimited can
be specified with a "-" for this parameter or by not specifying this parameter and will be
indicated by a "-". The maximum value is 4,294,967,295.
Examples
The following example creates a default tree quota rule for volume vol0 in Vserver vs0
and in the quota policy named quota_policy_0. This quota policy applies to all qtrees on
volume vol0.
cluster1::> volume quota policy rule create -vserver vs0
-policy-name quota_policy_0 -volume vol0 -type user -target ""
The following example creates a quota policy rule for volume vol0 in Vserver vs0 and
in the quota policy named quota_policy_0. This quota policy applies to the UNIX user
myuser for a qtree named qtree1 on volume vol0 with a disk limit of 20 Gigabytes, soft
disk limit of 15.4 Gigabytes and threshold limit of 15.4 Gigabytes. User mapping is
turned on for this rule.
-policy-name quota_policy_0 -volume vol0 -type user -target myuser
-qtree qtree1 -user-mapping on -disk-limit 20GB -soft-disk-limit 15.4GB
-threshold 15.4GB
The following example creates a quota policy rule for volume vol0 in Vserver vs0 and in
the quota policy named quota_policy_0. This quota policy applies to the Windows user
DOMXYZ\myuser for a qtree named qtree1 on volume vol0 with a file limit of 40000 and
a soft file limit of 26500. User mapping is turned on for this rule.
-policy-name quota_policy_0 -volume vol0 -type user -target DOMXYZ\myuser
1934
-qtree qtree1 -user-mapping on -file-limit 40000 -soft-file-limit 26500
in the quota policy named quota_policy_0. This quota policy applies to the UNIX user
identifier 12345 for a qtree named qtree1 on volume vol0.
-policy-name quota_policy_0 -volume vol0 -type user -target 12345
-qtree qtree1
in the quota policy named quota_policy_0. This quota policy applies to the Windows
Security Identifier S-123-456-789 for a qtree named qtree1 on volume vol0.
-policy-name quota_policy_0 -volume vol0 -type user
-target S-123-456-789 -qtree qtree1
in the quota policy named quota_policy_0. This quota policy applies to the UNIX group
engr for a qtree named qtree1 on volume vol0.
-policy-name quota_policy_0 -volume vol0 -type group -target engr
-qtree qtree1
the quota policy named quota_policy_0. This quota policy applies to the user who is the
owner of the file /vol/vol0/qtree1/file1.txt for qtree qtree1 on volume vol0.
cluster1::> volume quota policy rule create -vserver vs0 -policy-name
quota_policy_0 -volume vol0 -type user -target /vol/vol0/qtree1/file1.txt
-qtree qtree1
the quota policy named quota_policy_0. This quota policy applies to the users specified
in the target for qtree qtree1 on volume vol0.
-policy-name quota_policy_0 -volume vol0 -type user
-target user1,DOMXYZ\user2,23457,S-126-098-567,/vol/vol0/qtree1/file2.txt
-qtree qtree1
1935
See Also
vserver name-mapping volume quota modify
1936
volume quota policy rule delete

Delete an existing quota rule
Description
The volume quota policy rule delete command deletes a quota policy rule.
This command is not supported on Infinite Volumes. You must enter the following
information to delete a quota policy rule:
Vserver name
Quota policy name
Volume name
Quota target type
Target to which the rule applies
Qtree to which the rule applies
Note:
If the rule being deleted belongs to the quota policy that is currently assigned to the
Vserver, enforcement of the rule on the volume must be terminated by performing a
quota off and on or a quota resize operation using the "volume quota modify"
command.
Parameters
deleting a rule.
This parameter specifies the name of the quota policy in which you are deleting a rule.
This parameter specifies the name of the volume for which you are deleting a rule.
1937

This parameter specifies the quota target type for the rule.
This parameter specifies the target to which the quota policy rule applies.
This parameter specifies the name of the qtree for which you are deleting a rule.
Examples
The following example deletes a quota policy rule on Vserver vs1 for the quota policy
named quota_policy_1. This quota policy applies to the group named engr for the qtree
named qtree1 on volume vol1.
cluster1::> volume quota policy rule delete -vserver vs1
-policy-name quota_policy_1 -volume vol1 -type group -target engr
-qtree qtree1
See Also
volume quota modify
1938
volume quota policy rule modify

Modify an existing quota rule
Description
This command can be used to modify the following attributes of a quota policy rule:
User mapping
Hard disk limit
Hard file limit
Soft disk limit
Soft file limit
Note:
If the rule being modified belongs to the quota policy that is currently assigned to the
Vserver, rule enforcement on the volume must be enabled by performing a quota off and
on or a quota resize operation using the "volume quota modify" command.
Parameters
modifying a rule.
This parameter specifies the name of the quota policy in which you are modifying a rule.
This parameter specifies the name of the volume for which you are modifying a rule.
1939
This parameter specifies the quota target type for the rule you are modifying.
This parameter specifies the target to which the quota policy rule applies. If the target
is a user, the user ID or username must be the same one that was used to create the
quota. The same restriction is there for both group ID or groupname and Windows SID
or Windows account name.
This parameter specifies the name of the qtree to which the quota policy rule applies.
This parameter optionally modifies the user mapping for a user quota rule. The value
for this parameter can be modified only for quota policy rules of type user. A value of
"on" can be specified for this parameter only if the quota target is a unix user name
or a Windows user name and cannot be specified for multi-user quota targets. If this
parameter is "on", the unix user name specified as the quota target will be mapped
to the corresponding Windows user name or vice-versa and quota accounting will be
performed for the users together.
This parameter optionally modifies the hard limit for the disk space that can consumed
by the quota target. The default unit for the disk limit is assumed to be Kilobytes if no
units are specified. The value that you specify for this parameter should be greater than
or equal to the threshold and soft disk limit. A disk limit of unlimited can be specified with
a "-" for this parameter.
This parameter optionally modifies the hard limit for the number of files permitted on
the quota target. The value that you specify for this parameter should be greater than
or equal to the soft file limit. A file limit of unlimited can be specified with a "-" for this
parameter
This parameter optionally modifies the disk limit threshold for the quota target. The
default unit for the disk limit threshold is assumed to be Kilobytes if no units are
specified. The value that you specify for this parameter should be greater than or equal
to the soft disk limit and equal to or less than the disk limit. A threshold limit of unlimited
can be specified with a "-" for this parameter.
This parameter optionally modifies the soft limit for the disk space that can be consumed
by the quota target. The default unit for the soft disk limit is assumed to be Kilobytes if
1940
no units are specified. The value that you specify for this parameter should be equal to
or less than the threshold and the disk limit. A soft disk limit of unlimited can be specified
with a "-" for this parameter.
This parameter optionally modifies the soft limit for the number of files permitted on
the quota target. The value that you specify for this parameter should be equal to or
less than the file limit. A soft file limit of unlimited can be specified with a "-" for this
parameter.
Examples
The following example modifies a quota policy rule for the quota policy named
quota_policy_0. This quota policy exists on Vserver vs0 and applies to the user named
myuser for qtree named qtree1 on volume vol0. The user mapping is turned on, the hard
disk limit is set to 20 GB and the hard file limit is set to 100,000 files.
cluster1::> volume quota policy rule modify -vserver vs0
-policy-name quota_policy_0
-volume vol0 -type user -target myuser
-qtree qtree1 -user-mapping on -disk-limit 20GB -file-limit 100000
See Also
volume quota modify
1941
volume quota policy rule show

Display the quota rules
Description
This command displays the following information about quota policy rules by default.
Vserver name
Quota policy name
Volume name
Type of quota policy rule
Target of the quota policy rule
Qtree name
User mapping
Hard disk limit
Soft disk limit
Hard file limit
Soft file limit
Parameters
specify.
| [-instance ] }
about all fields.
1942

If this parameter is specified, the command displays information about quota rules for
the quotas contained on volumes on the specified Vserver.
[-policy-name <text>] - Policy Name
the specified quota policy.
the quota policy associated with the specified volume.
[-type {tree|user|group}] - Type
the specified quota type.
[-target <text>] - Target
the specified target.
the specified qtree.
If this parameter is specified, the command displays information about quota rules
having the specified user-mapping value.
having the specified hard disk limit.
having the specified hard file limit.
having the specified disk limit threshold.
1943
having the specified soft disk limit.
having the specified soft file limit.
Examples
The following example displays information about all the quota policy rules in a
cluster. There is one user rule that exists on Vserver vs0 for the quota policy named
quota_policy_0. This quota policy applies to the user named myuser for qtree named
qtree0 on volume vol0.
cluster1::> volume quota policy rule show
Vserver: vs0
Policy: quota_policy_0
User
1944
Mapping
Disk
Volume: vol0
Disk
Soft
Soft
Files
Files
Type
Target
Qtree
Limit
Limit
Limit
Limit
Threshold
-----
------
------ ------- -------
-------
------
-------
---------
tree
myuser
qtree0 on
18GB
100000
80000
16GB
20GB
volume snapshot compute-reclaimable

Calculate the reclaimable space if specified snapshots are deleted
Description
The volume snapshot compute-reclaimable command calculates the volume
space that can be reclaimed if one or more specified Snapshot copies are deleted.
The command heavily uses systems computational resources so it can reduce the
performance for client requests and other system processes. Therefore, the queries that
use queries that use query operators (*, |, etc.), are disabled for this command. You
should not specify more than three Snapshot copies per query. Snapshot copies must
be specified as a comma-separated list with no spaces after the commas.
Parameters
This specifies the volume for which reclaimable space is to be calculated.
-snapshots <snapshot name>, ... - List of Snapshots
This specifies one or more than one Snapshot copies that are to be considered for
deletion. If you list more than one Snapshot copy, specify a comma-separated list with
no spaces after the commas.
Examples
The following example calculates the space that can be reclaimed if the Snapshot copy
named hourly.2008-01-10_1505 is deleted on a volume named vol3, which is a part of
the Vserver named vs0:
cluster1::> volume snapshot compute-reclaimable -vserver vs0
-volume vol3 -snapshots hourly.2008-01-10_1505
1945
volume snapshot create

Create a snapshot
Description
The volume snapshot create command creates a Snapshot copy of a specified
volume.
Parameters
This specifies the Vserver that contains the volume on which the snapshot is to be
created.
-volume <volume name> - Volume
This specifies the volume where a Snapshot copy is to be created.
-snapshot <snapshot name> - Snapshot
This specifies the name of the Snapshot copy that is to be created.
This optionally specifies a comment for the Snapshot copy.
If you use this option and select false, the Snapshot copy creation process runs in the
background. If you use this option and select true, the Snapshot copy creation process
runs in the foreground. This option applies only to Infinite Volumes, and is ignored for
other volumes. The default is true.
[-snapmirror-label <text>] - Label for SnapMirror Operations
If you specify this option, the Snapshot copy is created with the SnapMirror Label
that you specify. If this option is not specified, the Snapshot copy is created with no
SnapMirror Label. The SnapMirror Label is used by the Vaulting subsystem when you
back up Snapshot copies to the Vault Destination.
Examples
1946
The following example creates a Snapshot copy named vol3_snap on a volume named
vol3 on a Vserver named vs0. The Snapshot copy is given the comment "Single
snapshot" and the operation runs in the background.
cluster1::> volume snapshot create -vserver vs0 -volume vol3 -snapshot
vol3_snapshot -comment "Single snapshot" -foreground false
volume snapshot delete

Delete a snapshot
Description
The volume snapshot delete command deletes a Snapshot copy from a specified
volume.
Parameters
This specifies the Vserver that contains the volume on which the specified Snapshot
copy is saved.
This specifies the volume from which a Snapshot copy is to be deleted.
This specifies the Snapshot copy that is to be deleted.
If you use this option and set it to false, the delete operation runs as a background
process. If you specify this option and set it to true, the operation runs as a foreground
process. This option applies only to Infinite Volumes, and is ignored for other volumes.
The default is true.
If you use this switch, the Snapshot copy is immediately deleted without generating
any confirmation messages. If you do not use this option the operation generates
confirmation messages. Passing in a value of true is supported, but not required. The
1947
force switch is typically used for scripting applications where users cannot directly
confirm the delete operation.
[-ignore-owners [true]] - Ignore Snapshot Owners (privilege: advanced)
If you use this switch, the command ignores other processes that might be accessing
the Snapshot copy. If you do not use this option the operation exhibits default behavior
and checks the owners tags before allowing the deletion to occur. Passing in a value of
true is supported, but not required.
Examples
The following example deletes a Snapshot copy named vol3_daily from a volume
named vol3 on a Vserver named vs0:
cluster1::> volume snapshot delete -vserver vs0 -volume vol3 -snapshot vol3_daily
volume snapshot modify

Modify snapshot attributes
Description
The volume snapshot modify command enables you to change the text comment
associated with a Snapshot copy.
Parameters
copy is saved.
This specifies the volume whose Snapshot copy is to be modified.
This specifies the Snapshot copy whose text comment is to be modified.
1948
This specifies the new comment for the Snapshot copy.

This specifies the SnapMirror Label for the Snapshot copy. The SnapMirror Label
is used by the Vaulting subsystem when you back up Snapshot copies to the Vault
Destination. If an empty label ("") is specified, the existing label will be deleted.
Examples
The following example modifies the comment of a Snapshot copy named vol3_snapshot
of a volume named vol3 on a Vserver named vs0. The comment is changed to "Preupgrade snapshot".
cluster1::> volume snapshot modify -vserver vs0 -volume vol3
-snapshot vol3_snapshot -comment "Pre-upgrade snapshot"
volume snapshot partial-restore-file

Restore part of a file from a snapshot
Description
The volume snapshot partial-restore-file command enables you to restore
a range of bytes in a file from the version of the file saved in the Snapshot copy. This
command is intended to be used to restore particular pieces of LUNs and NFS or CIFS
container files that are used by a host to store multiple sources of data. For example, a
host may be storing multiple user databases in the same LUN. A partial file restore can
be used to restore one of those databases in the LUN without touching other databases
stored in the LUN. This command is not intended for restoring parts of normal user-level
files that are stored in the volume. You should use volume snapshot restorefile command to restore normal user-level files. The volume for the partial-restore
should be online during this operation.
Parameters
This specifies the Vserver which contains the volume.
1949

This specifies the volume in which the Snapshot copy is saved.
-snapshot | -s <snapshot name> - Snapshot Name
This specifies the Snapshot copy which contains the version of file from which a range
of bytes is restored. The source file must be present in the Snapshot copy.
-path <text> - Filepath
This specifies the relative path to the file which is partially restored from the Snapshot
copy. You should specify the -volume option so that the file is searched and restored
from the Snapshot copy of the specified volume. If you do not specify the -volume
then the file is searched and restored from the Snapshot copy of the root volume. The
destination file must be present in the active file system.
-start-byte <integer> - Starting Byte Offset (Multiple of 4096)
This specifies the starting byte offset in the file to partially restore. The first byte of the
file is byte zero. The start byte must be a multiple of 4096. In addition, the start byte
must not exceed the size of the source or destination file.
-byte-count <integer> - Number of Bytes to Restore (Multiple of 4096)
This specifies the total number of bytes to restore, beginning at the -start-byte
value. The -byte-count option must be a multiple of 4096. The maximum number of
bytes that can be restored is 16 MB. The byte count must not exceed the range of the
source or destination file.
Examples
The following example restores first 4096 bytes in the file foo.txt inside the volume vol3
from the Snapshot copy vol3_snap:
cluster1::> volume snapshot partial-restore-file -vserver vs0 -volume vol3
-snapshot vol3_snap -volume vol3 -path /foo.txt -start-byte 0 -byte-count 4096
See Also
volume snapshot restore-file
1950
volume snapshot prepare-for-revert

Deletes multiple Snapshot copies of the current File System version.
privilege level.
Description
This command will delete all Snapshot copies that have the format used by the current
version of Data ONTAP. It will fail if any Snapshot copy polices are enabled, or if any
Snapshot copies have an owner.
Note:
Snapshot policies must be disabled prior to running this command.
Parameters
The name of the node.
Examples
The following example prepares the Snapshot copies for revert.
cluster1::*> volume snapshot prepare-for-revert -node node1
volume snapshot rename

Rename a snapshot
Description
The volume snapshot rename command renames a Snapshot copy.
Note:
1951
You cannot rename a Snapshot copy that is created as a reference copy during the
execution of the volume copy or volume move commands.
Parameters
copy is to be renamed
This specifies the volume that contains the Snapshot copy to be renamed.
This specifies the Snapshot copy that is to be renamed.
-new-name <snapshot name> - Snapshot New Name
This specifies the new name for the Snapshot copy.
Examples
The following example renames a Snapshot copy named vol3_snap on a volume named
vol3 and a Vserver named vs0. The Snapshot copy is renamed to vol3_snap_archive.
cluster1::> volume snapshot rename -vserver vs0 -volume vol3
-snapshot vol3_snap -new-name vol3_snap_archive
See Also
volume copy volume move
1952
volume snapshot restore-file

Restore a file from a snapshot
Description
The volume snapshot restore-file command enables you to restore a single
file to a version saved in the Snapshot copy. You can restore a file over an existing
copy of the file in the parent read-write volume or to a different location within the same
parent read-write volume. If the destination file for the restore operation does not exist,
a new file is created with the same version as the one saved in the Snapshot copy. If
the destination file for the restore operation exists, then it is overwritten by the version
from the Snapshot copy. This operation is used to restore normal user-level files and
LUNs. The command fails if you try to restore directories (and their contents) and files
with NT streams. During the restore operation the parent read-write volume should
remain online. The command fails if the destination path for the restore operation is in a
different volume than the source volume.
Parameters
This specifies the Vserver which contains the volume.
This specifies the volume which contains the specified Snapshot copy.
-snapshot | -s <snapshot name> - Snapshot Name
This specifies the Snapshot copy from which the file is restored.
-path <text> - Filepath
This specifies the relative path to the file which is restored from the Snapshot copy. You
should specify the -volume option so that the file is searched and restored from the
Snapshot copy of the specified volume. If you do not specify the -volume then the file
is searched and restored from the Snapshot copy of the root volume.
[-restore-path | -r <text>] - Restore Filepath
1953
This option specifies the destination location inside the volume where the file is restored.
If you do not specify this option, the file is restored at the same location referred by path option. If you specify -restore-path option, then it should refer to a relative
path location within the same volume which contains the source file. If you do not
specify -volume along with the relative path, the file is restored in the root volume.
[-split-disabled [true]] - Disable Space Efficient LUN Splitting
If you use this option and set it to true, space efficient LUN clone split is not allowed
during the restore operation. If you use this option and set it to false or do not use this
option, then space efficient LUN clone split is allowed during the restore operation.
Examples
The following example restores a file foo.txt from the Snapshot copy vol3_snap inside
the volume vol3 contained in a Vserver vs0:
cluster1::> volume snapshot restore-file -vserver vs0 -volume vol3 -snapshot
vol3_snap -path /foo.txt
volume snapshot restore

Restore the volume to a snapshot.
Description
The volume snapshot restore command restores a Snapshot copy to be the readwrite parent volume for the volume family. This replaces the current working copy of
the volume with the Snapshot copy that results in a loss of all changes made since the
Snapshot copy was created.
Note:
You should manually update all the SnapMirror relationships of a volume immediately
after you restore its Snapshot copy. Not doing so can result in unusable SnapMirror
relationships that must be deleted and re-created.
Before running this command on an Infinite Volume, unmount the volume. Any
namespace mirror constituents present in the system are resyncronized to the restored
Snapshot copy.
1954
After the restore is complete, the size of the flexible volume will be set to either the
current volume size or the snapshot size - whichever is greater.
Parameters
copy to be restored is saved.
This specifies the parent read-write volume whose Snapshot copy is to be restored to
take its place.
This specifies the Snapshot copy that is to be restored to be the read-write parent
volume.
[-force [true]] - Force Restore
If the user specifies this option, the Snapshot copy is restored even if there are newer
Snapshot copies used as reference Snapshot copies for data protection operations.
[-preserve-lun-ids {true|false}] - Preserve LUN Identifiers
This option enables you to select whether the Snapshot copy restore needs to be nondisruptive to clients due to LUN identifiers changing. If you use this option and set
it to true, or choose to not use this option at all, the volume snapshot restore
command fails if the system determines that it cannot be non-disruptive with regards to
LUN identifiers. If you use this option and set it to false the restore operation proceeds
even if this might cause client-visible effects. In this case, administrators should take the
LUNs offline before proceeding.
Examples
The following example restores a Snapshot copy named vol3_snap_archive to be the
parent read-write volume for the volume family. The existing read-write volume is named
vol3 and is located on a Vserver named vs0:
cluster1::> volume snapshot restore -vserver vs0 -volume vol3
-snapshot vol3_snap_archive
volume snapshot show
1955
Display a list of snapshots

Description
The volume snapshot show command displays information about Snapshot copies.
parameters are specified, the command displays a table with the following information
about all the available Snapshot copies:
Vserver name
Volume name
Snapshot copy name
State
Size
Percentage of total blocks in the parent volume
Percentage of used blocks in the parent volume
To display a detailed list view with additional information, run the command and
select the -instance view. In addition to the above mentioned information about the
Snapshot copies, the detailed list view provides the following additional information:
Creation time
Snapshot busy
List of the Snapshot copy's owners
Comment associated with the Snapshot copy
SnapMirror Label associated with the Snapshot copy
7-Mode Snapshot
Constituent Snapshot
At the advanced or higher privilege level the detailed view provides the following
additional information:
Snapshot copy's Dataset ID
Snapshot copy's master Dataset ID
1956
Number of consistency points in the Snapshot copy

Internal status of the Snapshot copy
File system version
File system block format
Physical Snap ID
Logical Snap ID
Database record owner
Snapshot tags
Instance UUID
Version UUID
Node
The list view is automatically enabled if a single Snapshot copy is specified by using the
-vserver, -volume and -snapshot options together.
A preformatted query for displaying the time-related information is available by
specifying the -time format specifier. This displays a table that contains the following
fields for all the available Snapshot copies:
Vserver name
Volume name
Snapshot copy name
Creation time
By using the -fields option you can choose to print only the certain fields in the
output. This presents the selected fields in a table view. This is ideal when you want
additional information to be different from the information that is provided by the default
table view, but would like it in a format which is visually easy to compare.
You can specify additional parameters to display the information that matches only
those parameters. For example, to display information only about Snapshot copies of
the load-sharing volumes, run the command with the -volume-type LS parameter. If
you specify multiple filtering parameters, only those Snapshot copies that match all the
specified parameters are displayed.
Parameters
1957

specify.
| [-time ]
If the -time format is specified, the command displays time related information about
all entries.
| [-instance ] }
about all fields.
If you use this parameter, the Snapshot copies located only on the specified Vserver will
be displayed.
If you use this parameter only Snapshot copies located on the specified volume will be
displayed.
[-snapshot <snapshot name>] - Snapshot
If you use this parameter only Snapshot copies matching the specified name will be
displayed.
[-dsid <integer>] - Snapshot Data Set ID (privilege: advanced)
Snapshot copy that has the specified data set ID.
[-msid <integer>] - Snapshot Master Data Set ID (privilege: advanced)
Snapshot copy that has the specified master data set ID.
[-create-time <Date>] - Creation Time
Snapshot copies that match the specified creation time.
[-busy {true|false}] - Snapshot Busy
Snapshot copies that have the specified busy status.
[-owners <text>, ...] - List of Owners
1958
Snapshot copies that are owned by the specified list of owners.
[-size {<integer>[KB|MB|GB|TB|PB]}] - Snapshot Size
Snapshot copies that have the specified size. The size is specified as a character
specifying the unit of measurement followed by a number specifying the size in the
mentioned unit of measurement: k (kilobytes), m (megabytes), g (gigabytes), or t
(terabytes). If the unit of measurement is not specified, bytes are used as the unit, and
the specified number is rounded up to the nearest 4 KB. You may also use an inequality
such as >10mb as input.
[-blocks <percent>] - Percentage of Total Blocks
Snapshot copies that have the specified percentage of total blocks on their parent
volumes. You may also use an inequality such as >10 as input.
[-usedblocks <percent>] - Percentage of Used Blocks
Snapshot copies that have the specified percentage of used blocks on their parent
volumes. You may also use an inequality such as >10 as input.
[-cpcount <integer>] - Consistency Point Count (privilege: advanced)
Snapshot copies that have the specified number of consistency points. You may also
use an inequality such as <100 as input.
[-internal-status <text>] - Internal Status (privilege: advanced)
Snapshot copies that have the specified internal status. You may also specify an
equality such as !"-" as input.
Snapshot copies that have the specified comment text. You may also specify an
inequality such as !"-" as input.
[-fs-version <text>] - File System Version (privilege: advanced)
If you use this parameter the only Snapshot copies displayed are those that were
created when the file system was of a specific release. This parameter is helpful
especially when you need to upgrade to newer software release and want to know the
Snapshot copies that will be impacted by the upgrade process.
1959
[-is-7-mode {true|false}] - 7-Mode Snapshot

If you use this parameter only those Snapshot copies which have the specified value
are shown. This value is true for the Snapshot copies that exist on the volume that was
in 7-mode configuration and then transitioned to a clustered configuration. In such a
scenario, the volume is in a clustered configuration and the existing Snapshot copies
are still in the 7-mode configuration.
If you use this parameter, only those Snapshot copies that have the specified
SnapMirror Label value are shown.
[-state {valid|invalid|partial}] - Snapshot State
If you use this parameter only those Snapshot copies which have the specified state will
be shown.
[-is-constituent {true|false}] - Constituent Snapshot
If you use this parameter, only those Snapshot copies whose parent volume is a
constituent volume of an Infinite Volume will be shown.
[-node <nodename>] - Node (privilege: advanced)
If you use this parameter only those Snapshot copies that are located on the specified
storage system are shown.
Examples
The following example displays detailed information about all Snapshot copies of a
volume named vol1:
cluster1::> volume snapshot show -volume vol1
---Blocks--Vserver Volume Snapshot
State
Size
Total% Used%
------- ------ -------------------------------- ------ ----- ------ ----vs1
1960
vol1
__mirror_ref_snapshot_2153852611 valid
184KB
20%
0%
daily.2008-10-18_0010
valid
236KB
24%
0%
daily.2008-10-19_0010
valid
188KB
20%
0%
hourly.2008-10-19_0505
valid
184KB
20%
0%
hourly.2008-10-19_0605
valid
184KB
20%
0%
hourly.2008-10-19_0705
valid
184KB
20%
0%
hourly.2008-10-19_0805
valid
184KB
20%
0%
weekly.2008-10-07_0015
valid
220KB
23%
0%
weekly.2008-10-14_0015
valid
232KB
23%
0%
vs1
vol1_dr
72KB
9%
0%
0B
0%
0%
daily.2008-10-18_0010
valid
236KB
24%
0%
daily.2008-10-19_0010
valid
188KB
20%
0%
hourly.2008-10-19_0305
valid
188KB
20%
0%
hourly.2008-10-19_0405
valid
188KB
20%
0%
hourly.2008-10-19_0505
valid
184KB
20%
0%
hourly.2008-10-19_0605
valid
184KB
20%
0%
weekly.2008-10-07_0015
valid
220KB
23%
0%
weekly.2008-10-14_0015
valid
232KB
24%
0%
1961
volume snapshot autodelete modify

Modify autodelete settings
Description
The volume snapshot autodelete modify command enables you to modify
Snapshot autodelete and LUN or file clone autodelete policy settings. Based on
the defined policy, automatic deletion of Snapshot copies and LUN or file clones is
triggered. Automatic deletion of Snapshot copies and LUN or file clones is useful
when you want to automatically reclaim space consumed by the Snapshot copies and
LUN or file clones from the volume when it is low in available space. LUN or file clone
autodelete follows Snapshot copy autodelete. This command works only on a read-write
parent volume. You cannot setup automatic Snapshot copy deletion and automatic LUN
or file clone deletion for Infinite Volumes and read-only volumes.
Parameters
This specifies the volume whose autodelete policy has to be modified.
This option specifies whether automatic deletion of Snapshot copies and LUN or file
clones is enabled or disabled. If set to true, automatic deletion of Snapshot copies and
LUN or file clones is enabled. If set to false, automatic deletion of Snapshot copies and
LUN or file clones is disabled.
[-commitment {try|disrupt|destroy}] - Commitment
This option specifies which Snapshot copies and LUN or file clones can be automatically
deleted to reclaim back space.
When set to try, the Snapshot copies which are not locked by any application and the
LUN or file clones which are not configured as preserved are deleted.
When set to disrupt, the Snapshot copies which are not locked by data backing
functionalities (such as volume clones, LUN clones and file clones) and LUN or file
clones which are not configured as preserved are deleted. In the disrupt mode, the
1962
Snapshot copies locked by data protection utilities such as Snapmirror and Volume
Move can be deleted. If such a locked Snapshot copy is deleted during the data transfer,
the transfer is aborted.
When set to destroy, the Snapshot copies locked by the data backing functionalities are
deleted. In addition, all the LUN or file clones in the volume are deleted.
[-defer-delete {scheduled|user_created|prefix|none}] - Defer Delete
This option determines the order in which Snapshot copies can be deleted.
Possible values are as follows:
When set to scheduled, scheduled Snapshot copies are the last to be deleted.
When set to user_created, user Snapshot copies are the last to be deleted.
When set to prefix, Snapshot copies matching a certain prefix are the last to be
deleted.
When set to none, no defer deletion order is honored.
This option is not applicable for LUN or file clones.
[-delete-order {newest_first|oldest_first}] - Delete Order
This option specifies if the oldest Snapshot copy and the oldest LUN or file clone or the
newest Snapshot copy and the newest LUN or file clone are deleted first.
[-defer-delete-prefix <text>] - Defer Delete Prefix
This option specifies the prefix string for the -defer-delete prefix parameter. The
option is not applicable for LUN or file clones.
[-target-free-space <percent>] - Target Free Space
This option specifies the free space percentage at which the automatic deletion of
Snapshot copies and LUN or file clones must stop. Depending on the -trigger
Snapshot copies and LUN or file clones are deleted until you reach the target free space
percentage.
[-trigger {volume|snap_reserve|space_reserve}] - Trigger
This option specifies the condition which starts the automatic deletion of Snapshot
copies and LUN or file clones.
Setting this option to volume triggers automatic deletion of Snapshot copies and LUN or
file clones when the volume reaches threshold capacity and the volume space reserved
for Snapshot copies is exceeded.
Setting the option to snap_reserve triggers automatic deletion of Snapshot copies and
LUN or file clones when the space reserved for Snapshot copies reaches threshold
capacity.
1963
Setting the option to space_reserve triggers automatic deletion of Snapshot copies

when reserved space in the volume reaches threshold capacity and the volume space
reserved for Snapshot copies is exceeded.
The threshold capacity is determined by the size of the volume as follows:
If the volume size is less than 20 GB, the autodelete threshold is 85%.
If the volume size is equal to or greater than 20 GB and less than 100 GB, the
autodelete threshold is 90%.
If the volume size is equal to or greater than 100 GB and less than 500 GB, the
If the volume size is equal to or greater than 500 GB and less than 1 TB, the
If the volume size is equal to or greater than 1 TB, the autodelete threshold is
98%.
[-destroy-list <text>] - Destroy List
This option specifies a comma separated list of data backing functions which are
affected if the automatic deletion of the Snapshot copy backing that service is triggered.
The possible values for this option are lun_clone,fileclone, lun_clone,sfsr, vol_clone,
cifs_share, or none. Except none, all the other options can be combined as a comma
separated list. Note that "lun_clone", "file_clone" and "sfsr" individually are not valid
values. Only pairs "lun_clone,file_clone" and "lun_clone,sfsr" are supported.
If you specify vol_clone, the cloned volume backed by the Snapshot copy is deleted.
If you specify lun_clone, and the LUN is in the process of being cloned when autodelete
is triggered, the cloning operation is aborted. Any access to this LUN will result in an
error being reported to the client.
If you specify file_clone, and the file cloning operation is in progress when autodelete is
triggered, the cloning operation is aborted. Any access to this file will result in an error
being reported to the client.
If you specify sfsr, and the file restore is in progress when autodelete is triggered, the
restore operation is aborted.
If the Snapshot copy is locked either by a lun_clone or file_clone or both, the destroy-list must be set to lun_clone,file_clone.
If the Snapshot copy is locked either by a lun_clone or sfsr operation or both, the destroy-list must be set to lun_clone,file_clone. The options file_clone and sfsr are
equivalent to each other.
If you set -destroy-list to lun_clone,file_clone and the Snapshot copy is backing a
file clone or sfsr operation, both the operations are aborted. This is also the case when
you set -destroy-list to lun_clone,sfsr.
1964
LUN or file clone autodelete is applicable only if -destroy-list contains lun_clone

and file_clone
Examples
The following example enables Snapshot autodelete and sets the trigger to
snap_reserve for volume vol3 which is part of the Vserver vs0:
cluster1::> volume snapshot autodelete modify -vserver vs0 -volume vol3 -enabled
true -trigger snap_reserve
The following example enables Snapshot autodelete and LUN or file clone autodelete
for volume vol3 which is part of the Vserve vs0:
cluster1::> volume snapshot autodelete modify -vserver vs0 -volume vol3 -enabled
true -trigger volume -commitment try -delete-order oldest_first -destroy-list
lun_clone,file_clone
1965
volume snapshot autodelete show

Display autodelete settings
Description
The volume snapshot autodelete show command displays information about
Snapshot autodelete policies. The command output depends on the parameters
specified with the command. If no parameters are specified, the command displays a
table with the following information about all the available Snapshot autodelete policies:
Vserver name
Volume name
Option name
Option value
To display a detailed list view with additional information, run the command and select
the -instance view. The detailed list view provides the following information:
Vserver name
Volume name
Enabled
Commitment
Defer Delete
Delete Order
Defer Delete Prefix
Target Free Space
Trigger
Destroy List
Is Constituent Volume
By using the -fields option you can choose to print only the certain fields in the
output. This presents the selected fields in a table view. This is ideal when you want
1966
additional information to be different from the information that is provided by the default
table view, but would like it in a format which is visually easy to compare.
You can specify additional parameters to display the information that matches only
those parameters. For example, to display information only about Snapshot autodelete
policies which are enabled, run the command with -enabled true parameter. If you
specify multiple filtering parameters, only those policies that match all the specified
parameters are displayed.
Parameters
This option allows you to print only certain fields in the output.
| [-instance ] }
This option allows you to print a detailed list view.
detailed autodelete policy information about the specified volume. If this parameter is
specified by itself, the command displays autodelete policy information about volumes
on the specified Vserver.
detailed autodelete policy information about the specified volume. If this parameter
is specified by itself, the command displays autodelete policy information about all
volumes matching the specified name.
If this parameter is specified, the command displays information about autodelete
policies that match the specified parameter value.
[-commitment {try|disrupt|destroy}] - Commitment
policies that match the specified commitment value.
[-defer-delete {scheduled|user_created|prefix|none}] - Defer Delete
policies that match the specified defer deletion criterion.
[-delete-order {newest_first|oldest_first}] - Delete Order
1967

policies that match the specified deletion order.
[-defer-delete-prefix <text>] - Defer Delete Prefix
policies that match the prefix used for deferring deletion.
[-target-free-space <percent>] - Target Free Space
policies that match the specified target free space.
[-trigger {volume|snap_reserve|space_reserve}] - Trigger
policies that match the specified trigger condition.
[-destroy-list <text>] - Destroy List
policies that match the specified value.
[-is-constituent {true|false}] - Is Constituent Volume
policies for the constituent volumes of Infinite Volumes.
Examples
The following example displays Snapshot autodelete policy settings for volume vol3
which is inside the Vserver vs0:
cluster1::> volume snapshot autodelete show -vserver vs0 -volume vol3
Vserver
Volume
--------- -------------vs0
Option Name
------------------
vol3
Enabled
Commitment
Trigger
Target Free Space
false
try
volume
20%
Delete Order
oldest_first
Defer Delete
user_created
Defer Delete Prefix

Destroy List
1968
Option Value
---------------------
(not specified)
none
volume snapshot policy add-schedule

Add a schedule to snapshot policy
Description
The volume snapshot policy add-schedule command adds a schedule to
a Snapshot policy. You can create a schedule by using the job schedule cron
create or job schedule interval create commands.
Parameters
This specifies the Vserver on which a Snapshot policy schedule is to be added.
-policy <snapshot policy> - Snapshot Policy Name
This specifies the Snapshot policy to which a schedule is to be added.
-schedule <text> - Schedule Name
This specifies the schedule that is to be added to the Snapshot policy.
-count <integer> - Maximum Snapshot Copies for Schedule
This specifies the maximum number of Snapshot copies that can be taken by the
specified schedule. The total count of all the Snapshot copies to be retained for the
policy cannot be more than 255.
[-prefix <text>] - Snapshot Copy Name Prefix for Schedule
This option specifies the prefix with which Snapshot copies will be created for the added
schedule. Every schedule has only one prefix. Once a prefix gets associated with a
schedule, you cannot update the prefix. If some prefix is already associated with the
schedule and you do not specify this parameter, then the previously defined prefix
is used. The command fails if you try to update an existing prefix for a schedule. If
no prefix is associated with the schedule and you do not specify this parameter, then
schedule name is be used as the prefix.
1969
This specifies the SnapMirror Label identified with a Snapshot copy when it is created
for the added schedule. The SnapMirror Label is used by the Vaulting subsystem when
you back up Snapshot copies to the Vault Destination.
Examples
The following example adds a schedule named midnight to the Snapshot policy named
snappolicy_nightly on Vserver vs0. The schedule can take a maximum of five Snapshot
copies.
cluster1::> volume snapshot policy add-schedule -vserver vs0 -policy
snappolicy_nightly -schedule midnight -count 5
See Also
job schedule cron create job schedule interval create
1970
volume snapshot policy create

Create a new snapshot policy
Description
The volume snapshot policy create command creates a Snapshot policy. A
Snapshot policy includes at least one schedule, up to a maximum of five schedules,
and a maximum number of Snapshot copies per schedule. You can create a schedule
by using the job schedule cron create or job schedule interval create
commands. When applied to a volume, the Snapshot policy specifies the schedule on
which Snapshot copies are taken and the maximum number of Snapshot copies that
each schedule can take. The total count of all the Snapshot copies to be retained for the
Parameters
This specifies the Vserver on which the Snapshot policy is to be created.
This specifies the Snapshot policy that is to be created.
-enabled {true|false} - Snapshot Policy Enabled
This specifies whether the Snapshot policy is enabled.
This option specifies a text comment for the Snapshot policy.
-schedule1 <text> - Schedule1 Name
This specifies the name of the first schedule associated with the Snapshot policy.
-count1 <integer> - Maximum Snapshot Copies for Schedule1
This specifies the maximum number of Snapshot copies that can be taken by the first
schedule.
[-prefix1 <text>] - Snapshot Copy Name Prefix for Schedule1
1971
This option specifies the prefix associated with the first schedule. Every schedule has
only one prefix. The command fails if you try to update an existing prefix. If you do not
specify this parameter and there is no prefix associated with the schedule, the schedule
name is used as the prefix. If you do not specify this parameter and there is already a
prefix associated with the schedule from a previous invocation of the command, then
that prefix is used.
[-snapmirror-label1 <text>] - Label for SnapMirror Operations for Schedule1
This specifies the SnapMirror Label of the first schedule associated with the Snapshot
policy. Once specified, all Snapshot copies created for that schedule have the
SnapMirror Label assigned to them. The SnapMirror Label is used by the Vaulting
subsystem when you back up Snapshot copies to the Vault Destination.
[-schedule2 <text>] - Schedule2 Name
This option specifies the name of the second schedule associated with the Snapshot
policy. If this parameter is specified, the -count2 parameter must also be specified.
[-count2 <integer>] - Maximum Snapshot Copies for Schedule2
This option specifies the maximum number of Snapshot copies that can be taken by the
second schedule. If this parameter is specified, the -schedule2 parameter must also
be specified.
This option specifies the prefix associated with the second schedule. If this parameter
is specified, -schedule2 and -count2 parameters must also be specified. Every
schedule has only one prefix. The command fails if you try to update an existing prefix.
If you do not specify this parameter and there is no prefix associated with the schedule,
the schedule name is used as the prefix. If you do not specify this parameter and
there is already a prefix associated with the schedule from a previous invocation of the
command, then that prefix is used.
This specifies the SnapMirror Label of the second schedule associated with the
Snapshot policy. Once specified, all Snapshot copies created for that schedule have
the SnapMirror Label assigned to them. The SnapMirror Label is used by the Vaulting
This option specifies the name of the third schedule associated with the Snapshot
1972
third schedule. If this parameter is specified, the -schedule3 parameter must also be
specified.
This option specifies the prefix associated with the third schedule. If this parameter
This specifies the SnapMirror Label of the third schedule associated with the Snapshot
This option specifies the name of the fourth schedule associated with the Snapshot
fourth schedule. If this parameter is specified, the -schedule4 parameter must also be
specified.
This option specifies the prefix associated with the fourth schedule. If this parameter
This specifies the SnapMirror Label of the fourth schedule associated with the
Snapshot policy. Once specified, all Snapshot copies created for that schedule have
the SnapMirror Label assigned to them. The SnapMirror Label is used by the Vaulting
1973

This option specifies the name of the fifth schedule associated with the Snapshot policy.
If this parameter is specified, the -count5 parameter must also be specified.
fifth schedule. If this parameter is specified, the -schedule5 parameter must also be
specified.
This option specifies the prefix associated with the fifth schedule. If this parameter
the schedule name is be used as the prefix. If you do not specify this parameter and
This specifies the SnapMirror Label of the fifth schedule associated with the Snapshot
Examples
The following example creates a Snapshot policy named snappolicy_4hrs on a
Vserver named vs0. The policy runs on a single schedule named 4hrs with a prefix
every_4_hour and has a maximum number of five Snapshot copies.
cluster1::> volume snapshot policy create -vserver vs0 -policy snappolicy_4hrs
-schedule1 4hrs -count1 5 -prefix1 every_4_hour
See Also
job schedule cron create job schedule interval create
1974
volume snapshot policy delete

Delete a snapshot policy
Description
The volume snapshot policy delete command deletes a Snapshot policy.
Parameters
This specifies the Vserver on which the Snapshot policy is to be deleted.
This specifies the Snapshot policy that is to be deleted.
Examples
The following example deletes a Snapshot policy named snappolicy_hourly on Vserver
vs0:
cluster1::> volume snapshot policy delete -vserver vs0 -policy snappolicy_hourly
volume snapshot policy modify-schedule

Modify a schedule within snapshot policy
Description
The volume snapshot policy modify-schedule command modifies the
maximum number of Snapshot copies that can be taken by a Snapshot policy's
schedule.
Parameters
1975

This specifies the Vserver on which a Snapshot policy schedule is to be modifed.
This specifies the Snapshot policy whose schedule is to be modified.
This specifies the schedule that is to be modified.
[-newcount <integer>] - Maximum Snapshot Copies for Schedule
This specifies the maximum number of Snapshot copies that can be taken by the
specified schedule. The total count of all the Snapshot copies to be retained for the
[-newsnapmirror-label <text>] - Label for SnapMirror Operations
This specifies the SnapMirror Label identified with a Snapshot copy when it is created
for the specified schedule. The SnapMirror Label is used by the Vaulting subsystem
when you back up Snapshot copies to the Vault Destination. If an empty label ("") is
specified, the existing label will be deleted.
Examples
The following example changes the maximum number of Snapshot copies from five to
four for a schedule named midnight on a Snapshot policy named snappolicy_nightly on
Vserver vs0:
cluster1::> volume snapshot policy modify-schedule -vserver vs0 -policy
snappolicy_nightly -schedule midnight -newcount 4
volume snapshot policy modify

Modify a snapshot policy
Description
The volume snapshot policy modify command enables you to modify the
description associated with a Snapshot policy and whether the policy is enabled or
disabled.
1976
Parameters
This specifies the Vserver on which the Snapshot policy is to be modified.
This specifies the Snapshot policy that is to be modified.
[-enabled {true|false}] - Snapshot Policy Enabled
This optionally specifies whether the Snapshot policy is enabled.
This specifies the comment text for the Snapshot policy.
[-snapmirror-labels <text>, ...] - Label for SnapMirror Operations
This optionally specifies a comma separated list of SnapMirror labels that are applied to
the schedules in the Snapshot policy. Each label in the list applies to only one schedule
in the Snapshot policy (maximum of 5 SnapMirror labels), the first label applying to the
first schedule, the second label applying to the second schedule, and so on. You can
have a maximum of five SnapMirror labels, which corresponds to the maximum number
of schedules a Snapshot policy can have. If an empty string ("") is specified, the existing
labels will be deleted from all the schedules.
Examples
The following example changes the description of a Snapshot policy named
snappolicy_wknd on Vserver vs0 to "Runs only on weekends":
cluster1::> volume snapshot policy modify -vserver vs0 -policy snappolicy_wknd comment "Runs only on weekends"
volume snapshot policy remove-schedule

Remove a schedule from snapshot policy
Description
1977
The volume snapshot policy remove-schedule command removes a schedule

from a Snapshot policy.
Parameters
This specifies the Vserver on which a Snapshot policy schedule is to be removed.
This specifies the Snapshot policy from which a schedule is to be removed.
This specifies the schedule that is to be removed from the Snapshot policy.
Examples
The following example removes a schedule named hourly from a Snapshot policy
named snappolicy_daily on Vserver vs0:
cluster1::> volume snapshot policy remove-schedule -vserver vs0 -policy
snappolicy_daily -schedule hourly
volume snapshot policy show

Show snapshot policies
Description
The volume snapshot policy show command displays the following information
about Snapshot policies:
Vserver name
Snapshot policy name
Number of schedules in the policy
Comment for the policy
Individual schedule names
Maximum number of Snapshot copies associated with each schedule
1978
Snapshot copy name prefixes for the schedules

SnapMirror Labels associated with the schedules
Parameters
specify.
| [-revert-incompatible ] (privilege: advanced)
If this parameter is specified, the command displays Snapshot policies that are not
supported in Data ONTAP 8.2. The total Snapshot copy count in the policy needs to
be reduced to be equal to or less than the supported count for the revert operation to
succeed.
| [-instance ] }
about all fields.
If this parameter is specified, the command displays Snapshot policies on the specified
Vserver.
[-policy <snapshot policy>] - Snapshot Policy Name
specified Snapshot policy.
[-enabled {true|false}] - Snapshot Policy Enabled
If this parameter is specified, the command displays detailed information only about the
Snapshot policy or policies that have the specified enabled value.
Snapshot policy or policies that have the specified comment.
[-total-schedules <integer>] - Total Number of Schedules in This Policy
Snapshot policy or policies that have the specified total number of schedules.
[-schedules <text>, ...] - Schedule Name
1979
Snapshot policy or policies that have the specified list of schedules.
[-counts <integer>, ...] - Maximum Snapshots for the Schedule
Snapshot policy or policies that have the specified list of maximum numbers of
Snapshot copies per schedule.
[-prefixes <text>, ...] - Prefix Name
Snapshot policy or policies that have the specified list of prefixes.
[-snapmirror-labels <text>, ...] - Label for SnapMirror Operations
Snapshot policies that have the specified SnapMirror Label. When you specify a list of
SnapMirror labels, the command displays all the Snapshot policies that contain any of
the SnapMirror Labels specified in the list.
[-policy-owner <text>] - Owner of the policy
Snapshot policies that have the specified policy owner.
[-total-count <integer>] - Total Number of Snapshots in This Policy
Snapshot policies that have the specified total number of Snapshot copies.
Examples
The following example displays information about all Snapshot policies:
cluster1::> volume snapshot policy show
Vserver: cm
Number of Is
Policy Name
Schedules Enabled Comment
------------------------ --------- ------- ---------------------------------default

weekly schedules.
Schedule
1980
3 false
Count
Default policy with hourly, daily &
Prefix
SnapMirror Label
---------------------- -----
---------------------- -------------------
hourly
hourly
daily
daily
weekly
weekly
default-1weekly
& 1 weekly schedule.
3 false
Schedule
Count
Default policy with 6 hourly, 2 daily
Prefix
SnapMirror Label
---------------------- -----
---------------------- -------------------
hourly
hourly
daily
daily
weekly
weekly
none
0 false
Schedule
Count
Policy for no automatic snapshots.
Prefix
SnapMirror Label
---------------------- -----
---------------------- -------------------
Vserver: vs0
Number of Is
Policy Name
Schedules Enabled Comment
------------------------ --------- ------- ---------------------------------p1
1 false
Schedule
Count
Prefix
SnapMirror Label
---------------------- -----
---------------------- -------------------
weekly
weekly
p2
2 true
Schedule
Count
Prefix
SnapMirror Label
---------------------- -----
---------------------- -------------------
hourly
hourly
daily
daily
1981
vserver add-aggregates
Add aggregates to the Vserver
level.
Description
The vserver add-aggregates command adds aggregates to the Vserver.
Parameters
Specifies the Vserver for which aggregates have to be added.
-aggregates <aggregate name>, ... - List of Aggregates to Be Added
Specifies the list of aggregates to add to the Vserver.
Examples
The following example illustrates how to add aggregates aggr1 and aggr2 to a Vserver
named vs.example.com:
cluster1::> vserver add-aggregates -vserver vs.example.com -aggregates
aggr1,aggr2
vserver add-protocols
Add protocols to the Vserver
level.
Description
The vserver add-protocols command adds given protocols to a specified Vserver.
Parameters
1982
This specifies the Vserver that is to be modified.

-protocols {nfs|cifs|fcp|iscsi|ndmp}, ... - Protocols
This parameter specifies the list of protocols to be allowed to run on the Vserver.
Possible values include nfs, cifs, fcp, and iscsi, and ndmp.
Examples
The following example shows adding protocol 'cifs' to a vserver named
vs0.example.com.
cluster1::> vserver add-protocols -vserver vs0.example.com -protocols cifs
vserver context
Set Vserver context
level.
Description
Cluster administrators can use the vserver context command to login to a specified
Vserver with a specified Vserver user name. All subsequent commands will be issued
in the context of that Vserver. The role of the cluster administrator will be the same as
that of the user name with which the Vserver context was set. The context is valid for
the duration of the CLI or Web UI session in which it is specified. The exit command
can be used to return to the original context.
Parameters
Use this parameter to specify the Vserver.
[-username <text>] - Vserver Administrator User Name
Use this parameter to specify a Vserver administrator user name for the context. The
default value vsadmin is used if one is not specified.
Examples
The following example sets the CLI context to Vserver vs0.example.com. All
subsequently issued commands will be executed in the context of that Vserver:
1983
cluster1::> vserver context -vserver vs0.example.com

Info: Use 'exit' command to return.
vs0.example.com::>
See Also
exit
1984
vserver create
Create a Vserver
level.
Description
The vserver create command creates a Vserver.
Parameters
This specifies the name of the Vserver that is to be created. Use a fully qualified domain
name (FQDN) - for example, "data.example.com" - for the Vserver to ensure unique
Vserver names across cluster leagues.
Note:
Maximum number of characters supported is 47, and 41 for a Vserver with subtype
"sync-source". "all" is a reserved name and must not be used as a Vserver name.
[-subtype <vserver subtype>] - Vserver Subtype
This specifies the subtype of the Vserver being created. Possible values are:
default - For default data Vservers
sync-source - For MetroCluster source Vservers
sync-destination - For MetroCluster destination Vservers
-rootvolume <volume name> - Root Volume
This specifies the name of the Vserver's root volume, which is created when the Vserver
is created. The size of the Vserver's root volume is 1GB
This specifies the storage aggregate that holds the Vserver's root volume.
-rootvolume-security-style <security style> - Root Volume Security Style
This specifies the security style for the Vserver's root volume. Possible values include
unix (for UNIX mode bits), ntfs (for CIFS ACLs), and mixed (for mixed NFS and CIFS
1985
access). Regardless of the security style, both NFS and CIFS clients can read from
and write to the root volume. The unified security style, which applies only to Infinite
Volumes, cannot be applied to a Vserver's root volume.
[-language <Language code>] - Default Volume Language Code
This optionally specifies the default language encoding setting for the Vserver
and its volumes. The recommended format is to append .UTF-8 for the language
encoding values. For example, for the en_US language, the recommended format is
en_US.UTF-8. The default setting is C.UTF-8.
This optionally specifies the Snapshot policy for new volumes created on the Vserver. If
no value is specified, the default Snapshot policy is used. You can use the -snapshotpolicy parameter on the volume create or volume modify commands to set
the Snapshot policy on a specific volume, regardless of its Vserver's Snapshot policy
setting.
This optionally specifies a comment for the Vserver.
[-quota-policy <text>] - Quota Policy
This optionally specifies a quota policy for the Vserver. This parameter is not supported
on a Vserver with Infinite Volume.
[-is-repository {true|false}] - Is Vserver with Infinite Volume
This specifies that the Vserver will contain an Infinite Volume.
This optionally specifies the IPspace the Vserver will be assigned to. If left unspecified,
the Vserver will be assigned to the default IPspace.
Examples
The following example creates a Vserver named vs0.example.com in the IPspace
ipspace123. The Vserver's root volume is named root_vs0 and is located on aggregate
aggr0. The Vserver uses NIS for network information, a file for name mapping
information, and the language is U.S. English.
cluster1::> vserver create -vserver vs0.example.com -ipspace ipspace123 rootvolume root_vs0 -aggregate aggr0
-language en_US.UTF-8 -rootvolume-security-style mixed
See Also
1986
volume create volume modify
1987
vserver delete
Delete a Vserver
level.
Description
The vserver delete command deletes a specified Vserver. If the Vserver is
associated with one or more volumes, you must manually delete volumes (including root
and mirror volumes) before you delete the Vserver.
Parameters
This specifies the Vserver that is to be deleted.
Examples
The following example deletes a Vserver named vs2.example.com:
cluster1::> vserver delete -vserver vs2.example.com
vserver modify
Modify a Vserver
level.
Description
The vserver modify command modifies the attributes of a specified Vserver.
Parameters
This specifies the Vserver that is to be modified.
1988
This optional parameter specifies the default language encoding setting for the Vserver
and its volumes. The recommended format is to append .UTF-8 for the language
encoding values. For example, for the en_US language, the recommended format is
en_US.UTF-8. The default setting is C.UTF-8. This field is not modifiable on a Vserver
with Infinite Volume.
This optional parameter specifies the Snapshot policy for a Vserver being modified.
This optional parameter specifies a comment for the Vserver.
This optional parameter specifies a quota policy to be used for all volumes associated
with a Vserver. You can create and configure multiple, different quota policies, but each
Vserver must have one and only one associated quota policy. This parameter is not
supported on a Vserver with Infinite Volume.
[-aggr-list <aggregate name>, ...] - List of Aggregates Assigned
This optional parameter specifies a confined list of aggregates on which volumes can be
created for a Vserver by the Vserver administrator. But these aggregates do not become
exclusive property of the Vserver, i.e. they might be assigned for use to other Vservers.
If the value of this parameter is specified as "-", then the Vserver administrator cannot
create any volumes for that Vserver. Note that the cluster administrator will still be able
to create volumes on any aggregate and assign them to this Vserver.
[-max-volumes <unsigned32_or_unlimited>] - Limit on Maximum Number of Volumes
allowed
This optional parameter specifies the maximum number of volumes that can be created
for the Vserver, including the root volume. This value is not modifiable on a Vserver with
Infinite Volume.
[-admin-state {running|stopped|starting|stopping}] - Vserver Admin State (privilege:
advanced)
Use this parameter to set the admin state of the Vserver if the Vserver start or stop job
fails. Possible values include running and stopped.
[-allowed-protocols {nfs|cifs|fcp|iscsi|ndmp}, ...] - Allowed Protocols
This optional parameter specifies the list of protocols to be allowed to run on the
Vserver. If the values provided here conflict with the ones provided for disallowedprotocols, then those values would become part of the disallowed-protocols.
When part of vserver-modify, this field should include the existing list along with the new
protocol list to be added to prevent data disruptions. Possible values include nfs, cifs,
1989
fcp, iscsi, and ndmp. Possible values for a Vserver with Infinite Volume include nfs and
cifs.
[-disallowed-protocols {nfs|cifs|fcp|iscsi|ndmp}, ...] - Disallowed Protocols
This optional parameter specifies the list of protocols to be disallowed to run on the
Vserver. If the values provided here conflict with the ones provided for allowedprotocols, they would continue to be part of the disallowed-protocols. When
part of vserver-modify, this field should include the existing list along with the new
protocol list to be added to prevent data disruptions. Possible values include nfs, cifs,
fcp, iscsi, and ndmp. Only the protocols configured for Vservers with Infinite Volume can
be disallowed.
This optionally specifies which QoS policy group to apply to the Vserver. This policy
a Vserver, the system will not monitor and control the traffic to it. To remove this Vserver
from a policy group, enter the reserved keyword "none". This parameter is not supported
on a Vserver with Infinite Volume.
Examples
The following example modifies the quota policy for a Vserver named vs0.example.com
to pol1, specifies a Snapshot policy named daily, adds the comment "Sales team
access".
cluster1::> vserver modify -vserver vs0.example.com -snapshot-policy daily
-comment "Sales team access" -quota-policy pol1
vserver prepare-for-revert
Prepares Vservers to be reverted
privilege level.
Description
The vserver prepare-for-revert command prepares Vservers to be reverted
to the previous version of Data ONTAP. It disables any operations that cannot be
scheduled during revert.
1990
Parameters
None
Examples
The following example prepares all Vservers to be reverted.
cluster1::*> vserver prepare-for-revert
vserver remove-aggregates
Remove aggregates from the Vserver
level.
Description
The vserver remove-aggregates command removes aggregates from the Vserver.
Parameters
Specifies the Vserver from which aggregates have to be removed.
-aggregates <aggregate name>, ... - List of Aggregates to Be Removed
Specifies the list of aggregates to remove from the Vserver.
Examples
The following example illustrates how to remove aggregates aggr1 and aggr2 from a
Vserver named vs.example.com:
cluster1::> vserver remove-aggregates -vserver vs.example.com -aggregates
aggr1,aggr2
vserver remove-protocols
Remove protocols from the Vserver
1991

level.
Description
The vserver remove-protocols command removes the specified protocols from
the specified Vserver. When you remove the protocols from a Vserver, the data access
with respect to the removed protocols is disrupted.
Parameters
Specifies the Vserver that is to be modified.
-protocols {nfs|cifs|fcp|iscsi|ndmp}, ... - Protocols
This parameter specifies the list of protocols to be removed. on the Vserver. Possible
values include nfs, cifs, fcp, iscsi, and ndmp.
Examples
The following example shows removing protocol 'cifs' from a Vserver named
vs0.example.com.
cluster1::> vserver remove-protocols -vserver vs0.example.com -protocols cifs
vserver rename
Rename a Vserver
level.
Description
The vserver rename command renames the Vserver.
Parameters
-vserver <text> - Vserver
This specifies the Vserver that is to be renamed.
1992
-newname <vserver> - New Vserver name (Use Fully Qualified Domain Name, For
example: data.example.com)
This specifies the Vserver's new name. The name must be a unique Vserver
name in the cluster. Use a fully qualified domain name (FQDN) - for example,
"data.example.com" - for the Vserver name to reduce name collisions in cluster leagues.
Note:
Maximum number of characters supported is 47, and 41 for a Vserver with subtype
"sync-source". "all" is a reserved name and must not be used as a Vserver name.
Examples
The following example renames a Vserver named vs1.example.com as
vs2.example.com:
cluster1::> vserver rename -vserver vs1.example.com -newname vs2.example.com
vserver show-protocols
Show protocols for Vserver
Description
The vserver show-protocols command displays the running protocols on a given
Vserver.
Parameters
specify.
| [-instance ] }
about all fields.
1993
If this parameter is specified, the command displays the allowed set of protocols for the
specified Vserver.
[-protocol {nfs|cifs|fcp|iscsi|ndmp}, ...] - Protocols
If this optional parameter is specified, the command displays all the Vservers configured
with the specified protocols.
Examples
The following example displays the protocols configured for Vserver vs1.
cluster1::> vserver show-protocols -vserver vs1
Vserver: vs1
Protocols: nfs, cifs
vserver show
Display Vservers
Description
The vserver show command displays the following information:
Vserver name
Vserver type (data, admin, node or system - detailed view only)
Vserver subtype (default, sync-source, and sync-destination - detailed view only)
Vserver universal unique identifier (detailed view only)
Root volume name
Aggregate on which the root volume is located
Associated NIS domain
Root volume security style (unix for UNIX mode bits, ntfs for CIFS ACLs, mixed
for both (detailed view only), or unified (Infinite Volumes only))
LDAP client
Language (detailed view only)
1994
Snapshot policy (detailed view only)

Comment text (detailed view only)
Quota policy (detailed view only)
Aggregate list (detailed view only)
Maximum Volumes (detailed view only)
Qos-policy-group (detailed view only)
Config-lock (detailed view only)
Admin state (running, stopped, starting, stopping, initializing, or deleting)
Operational state (running, or stopped)
Operational state stopped reason (sync-destination-and-switchover-not-done, or
cluster-reboot-done, or admin-state-stopped)
Allowed Protocols (nfs, cifs, fcp, iscsi, ndmp - detailed view only)
Disallowed Protocols (nfs, cifs, fcp, iscsi, ndmp - detailed view only)
Whether the Vserver is a Vserver with Infinite Volume (detailed view only)
IPspace to which the Vserver belongs (detailed view only)
Parameters
specify.
| [-protocols ]
If this optional parameter is specified, the command displays the allowed and disallowed
set of protocols for the Vserver(s).
| [-instance ] }
about all fields.
specified Vserver.
[-type <vserver type>] - Vserver Type
1995
If this parameter is specified, the command displays information only about the Vserver
or Vservers that have the specified Vserver type. Types include admin for the clusterwide management Vserver, system for cluster-level communications in an IPspace, data
for data serving Vserver, and node for node management Vserver.
[-subtype <vserver subtype>] - Vserver Subtype
or Vservers that have the specified Vserver subtype. Types include:
default for default data Vserver
sync-source for MetroCluster source Vserver,
sync-destination for MetroCluster destination Vserver.
[-uuid <UUID>] - Vserver UUID
that match the specified UUID.
[-rootvolume <volume name>] - Root Volume
or Vservers that have the specified root volume.
or Vservers that have their root volumes contained by the specified aggregate.
[-nisdomain <nis domain>] - NIS Domain
or Vservers that use the specified NIS domain.
[-rootvolume-security-style <security style>] - Root Volume Security Style
or Vservers that have the specified root-volume security style. The unified security style,
which applies only to Infinite Volumes, cannot be applied to a Vserver's root volume.
[-ldap-client <text>] - LDAP Client
or Vservers that use the specified LDAP client.
or Vservers that use the specified language. To determine the available languages,
1996
enter "vserver show -language ?" at the clustershell command prompt and at the
Vserver prompt.
or Vservers that have the specified Snapshot policy.
or Vservers that match the specified comment.
or Vservers that use the specified quota policy.
[-aggr-list <aggregate name>, ...] - List of Aggregates Assigned
or Vservers to which the specified aggregate(s) are assigned for use.
[-max-volumes <unsigned32_or_unlimited>] - Limit on Maximum Number of Volumes
allowed
or Vservers on which the specified maximum volume count is configured.
[-admin-state {running|stopped|starting|stopping}] - Vserver Admin State
or Vservers that match the specified admin-state.
[-operational-state {running|stopped}] - Vserver Operational State
or Vservers that match the specified operational-state. This field determines the state
of the Vserver LIFs. New LIFs created on a Vserver, which is in running state, will be
operationally up and the LIFs created on a Vserver, which is in stopped state, will be
operationally down.
[-operational-state-stopped-reason {sync destination and switchover is not done|
cluster reboot is done|admin state stopped| dp destination not started}] - Vserver
Operational State Stopped Reason
or Vservers that are operationally stopped due to the specified reason. This field
indicates the reason for the operational-state of the Vserver being stopped
[-allowed-protocols {nfs|cifs|fcp|iscsi|ndmp}, ...] - Allowed Protocols
1997
or Vservers on which the specified protocols are allowed to run.
[-disallowed-protocols {nfs|cifs|fcp|iscsi|ndmp}, ...] - Disallowed Protocols
or Vservers on which the specified protocols are disallowed to run.
[-is-repository {true|false}] - Is Vserver with Infinite Volume
If this parameter is specified, the command displays information only about the Vservers
which have the specified is-repository value. This will be true for Vservers with Infinite
Volume.
Display the Vservers that match the specified qos-policy-group.
A policy group defines measurable service level objectives (SLOs) that apply to the
storage objects with which the policy group is associated. If you do not assign a policy
group to a Vserver, the system will not monitor and control the traffic to it.
[-config-lock {true|false}] - Config Lock
This parameter specifies if the Vserver is locked or unlocked for modification. If the
config-lock is set to true, then modifying the Vserver's configuration is not allowed.
If this parameter is specified, the command displays information only about the Vservers
that are assigned to the specified IPspace.
Examples
The following example displays information about all Vservers.
cluster1::> vserver show
non mcc setup:
Admin
Operational
Vserver
Volume
Root
Type
Subtype
Aggregate
------------------cluster
state
state
------- --------------- ----------- ----------- ----------admin
node
node1
vs0
root_vs1
1998
data
default
running
running
aggr0

mcc setup:
cluster1::> vserver show
Admin
Operational
Root
Vserver
Aggregate
---------cluster
Type
Subtype
------- ---------------
state
state
Volume
------- ----------- ----------- ---------
admin
node
node1
vs2
data_aggr
vs3-mc
data
data
sync-source
sync-destination
running running
running stopped -
rv
-
1999
vserver start
Start a Vserver
level.
Description
The vserver start command starts data access on a Vserver.
Parameters
This specifies the name of the Vserver on which data access is to be started.
Note:
The name must be 47 characters or less.
This specifies if the vserver start command should be executed in the foreground
or background. If you do not enter this parameter, it is set to true, and the vserver
start command is executed in the foreground.
[-force [true]] - Force Vserver Start
In case of a MetroCluster configuration or Vserver disaster recovery, by using
this parameter you can start the Vserver that is either locked (which prevents any
configuration changes) or its partner Vserver is operationally running. If you do not enter
this parameter, it is set to false.
Examples
The following example starts data access on Vserver vs0.example.com in the
background.
cluster1::> vserver start -vserver vs0.example.com -foreground false
vserver stop
2000
Stop a Vserver
level.
Description
The vserver stop command stops data access on a Vserver.
Parameters
This specifies the name of the Vserver on which data access is to be stopped.
Note:
The name must be 47 characters or less.
This specifies if vserver stop command should be executed in the foreground or
background. If you do not enter this parameter, it is set to true, and the vserver stop
command is executed in the foreground.
Examples
The following example stops data access on Vserver vs0.example.com in the
background.
cluster1::> vserver stop -vserver vs0.example.com -foreground false
vserver unlock
Unlock Vserver configuration
privilege level.
Description
The vserver unlock command revokes the administrative lock on the Vserver
configuration. When a Vserver is unlocked, changes to the configuration are permitted.
The unlock operation fails if the Vserver is not locked by the administrator or if it is
2001
locked by internal applications. If the Vserver fails to unlock due to an error condition,
you can use the -force option.
Parameters
The name of the Vserver that has to be unlocked.
[-force [true]] - Force Unlock
This option is specified to unlock the Vserver when the Vserver fails to unlock due to an
error condition.
Examples
The following example illustrates how to unlock the Vserver named vs123.example.com,
forcefully:
cluster1::> vserver unlock -vserver vs1.example.com -force true
vserver active-directory create

Create an Active Directory account. If joining a domain, this command may take several
minutes to complete.
Description
The vserver active-directory create command creates an Active Directory
account for a Vserver. When you create the Active Directory account, you must add it
to an existing Windows Active Directory domain. When you enter this command, you
are prompted to provide the credentials of a user account that has sufficient privileges
to add computers to the -ou container within the -domain domain. The user account
must have a password that cannot be empty. When joining a domain, this command
may take several minutes to complete.
Note:
Each Vserver can have only one Active Directory account.
Parameters
2002

This parameter specifies the name of the Vserver for which you want to create the
Active Directory account. The Vserver must already exist.
-account-name <NetBIOS> - Active Directory NetBIOS Name
This parameter specifies the name of the Active Directory account (up to 15 characters).
-domain <TextNoCase> - Fully Qualified Domain Name
This parameter specifies the name of the Active Directory domain.
[-ou <text>] - Organizational Unit
This parameter specifies the organizational unit within the Active Directory domain. By
default, this parameter is set to CN=Computers. When specifying this parameter, specify
only the organizational unit portion of the distinguished name. Data ONTAP appends
the value provided for the required -domain parameter onto the value provided for
ou parameter to produce the Active Directory distinguished name, which is used when
creating the Vservers Active Directory account in the domain.
Examples
The following example creates an Active Directory account ADSERVER1 for Vserver
vs1 and domain example.com.
cluster1::> vserver active-directory create -vserver vs1 -account-name ADSERVER1
-domain example.com
In order to create an Active Directory machine account, you must supply the
name and password of a Windows account with sufficient privileges to add
computers to the "CN=Computers" container within the "example.com" domain.
Enter the user name: Administrator
Enter the password:
The following example creates an Active Directory account ADSERVER2 for Vserver
vs2, domain example.com and organizational unit sample_ou.
cluster1::> vserver active-directory create -vserver vs2 -account-name ADSERVER2
-domain example.com -ou OU=sample_ou
2003
computers to the "OU=sample_ou" container within the "example.com" domain.

Enter the password:
2004
vserver active-directory delete

Delete an Active Directory account
Description
The vserver active-directory delete command deletes the Active Directory
account for a specified Vserver.
Parameters
This parameter specifies the Vserver for the Active Directory account you want to
delete.
Examples
The following example deletes the Active Directory account for a Vserver named vs1:
cluster1::> vserver active-directory delete -vserver vs1
In order to delete an Active Directory machine account, you must supply the
name and password of a Windows account with sufficient privileges to remove
computers from the "example.com" domain.
Enter the password:
2005
vserver active-directory modify

Modify the domain of an Active Directory account. If re-joining the current domain or
joining a new one, this command may take several minutes to complete.
Description
The vserver active-directory modify command modifies the domain of an
Active Directory account. You can also re-join the current domain or join a new one.
When joining a domain, this command may take several minutes to complete.
Parameters
This parameter specifies the Vserver for the Active Directory account whose associated
domain you want to modify.
[-domain <TextNoCase>] - Fully Qualified Domain Name
This parameter specifies the fully qualified name of the Active Directory domain to
associate with the Active Directory account.
Examples
The following example modifies the Active Directory domain associated with Vserver
vs1.
cluster1::> vserver active-directory modify -vserver vs1 -domain example.com
computers to the "CN=Computers" container within the "example.com" domain.
Enter the user name: administrator
Enter the password:
2006
vserver active-directory password-change

Change the domain account password for an Active Directory account
Description
The vserver active-directory password-change command changes the
domain account password for the specified Vserver's Active Directory account.
Parameters
This parameter specifies the name of the Vserver associated with the Active Directory
account whose domain account password you want to change.
Examples
The following example changes the password for the Active Directory account for a
Vserver named vs1.
cluster1::> vserver active-directory password-change -vserver vs1
vserver active-directory password-reset

Reset the domain account password for an Active Directory account
Description
The vserver active-directory password-reset command resets the
domain account password for the Active Directory account. This may be required if
the password stored along with the machine account in the Windows Active Directory
domain is changed or reset without the Vserver's knowledge. The operation requires the
2007
credentials for a user with permission to reset the password in the organizational unit
(OU) that contains the machine account.
Parameters
This parameter specifies the name of the Vserver associated with the Active Directory
account whose domain account password you want to reset.
Examples
The following example resets the password for the Active Directory account for a
Vserver named vs1.
cluster1::> vserver active-directory password-reset -vserver vs1
Enter your user ID: Administrator
Enter your password:
vserver active-directory show

Display Active Directory accounts
Description
The vserver active-directory show command displays information about Active
Directory accounts. The command output depends on the parameter or parameters
specified with the command. If you do not specify any parameters, the command
displays the following information about all Active Directory accounts:
Vserver name
Active Directory account NetBIOS name
Domain or workgroup name
You can specify the -fields parameter to specify which fields of information to display
about Active Directory accounts. You can use fields ? to display the valid values for
the fields parameter. In addition to the fields above, you can display the following
fields:
2008
Fully-qualified domain name

Organizational unit
parameters. For instance, to display information only about Active Directory accounts
that are in the Windows Active Directory domain named RUBY, run the command with
the value of the -domain-workgroup parameter set to RUBY.
You can specify the -instance parameter to display all information for all Active
Directory accounts in list form.
Parameters
| [-instance ] }
about all entries.
If you specify this parameter, the command displays information only about the Active
Directory account for the specified Vserver.
[-account-name <NetBIOS>] - Active Directory NetBIOS Name
If you specify this parameter, the command displays information only for the Active
Directory accounts that match the specified NetBIOS account name.
[-domain-workgroup <CIFS domain>] - NetBIOS Domain/Workgroup Name
Directory accounts that are in the specified NetBIOS domain or workgroup.
Note:
Workgroups are not supported in this release.
Directory accounts that are in the specified domain.
2009
Directory accounts that are in the specified organizational unit.
[-auth-style {domain|workgroup}] - Authentication Style
Directory accounts that are in the specified authentication style.
Examples
The following example displays a subset of the information about all Active Directory
accounts.
cluster1::> vserver active-directory show
Vserver
Account
Domain/Workgroup
Name
Name
-------------- ----------- ---------------vs1
ADSERVER1
EXAMPLE
The following example displays all information about all Active Directory Vservers in list
form.
cluster1::> vserver active-directory show -instance
Vserver: vs1
Active Directory account NetBIOS Name: ADSERVER1
NetBIOS Domain/Workgroup Name: EXAMPLE
Fully Qualified Domain Name: EXAMPLE.COM
Organizational Unit: CN=Computers
2010
vserver audit create

Create an audit configuration
Description
The vserver audit create command creates an audit configuration for a Vserver.
When you create an audit configuration, you can also specify the rotation method. By
default, the audit log is rotated based on size.
You can use the time-based rotation parameters in any combination (-rotateschedule-month, -rotate-schedule-dayofweek, -rotate-schedule-day,
-rotate-schedule-hour, and -rotate-schedule-minute). The -rotateschedule-minute parameter is mandatory. All other time-based rotation parameters
are optional.
The rotation schedule is calculated by using all the time-related values. For example,
if you specify only the -rotate-schedule-minute parameter, the audit log files are
rotated based on the minutes specified on all days of the week, during all hours on all
months of the year. If you specify only one or two time-based rotation parameters (say
-rotate-schedule-month and -rotate-schedule-minutes), the log files are
rotated based on the minute values that you specified on all days of the week, during
all hours, but only during the specified months. For example, you can specify that the
audit log is to be rotated during the months January, March, and August on all Mondays,
Wednesdays, and Saturdays at 10:30.
If you specify values for both -rotate-schedule-dayofweek and -rotateschedule-day, they are considered independently. For example if you specify rotate-schedule-dayofweek as Friday and -rotate-schedule-day as 13 then
the audit logs would be rotated on every Friday and on the 13th day of the specified
month, not just on every Friday the 13th.
This command is not supported on a Vserver with Infinite Volume.
Parameters
This parameter specifies the name of the Vserver on which to create the audit
configuration. The Vserver must already exist.
2011
-destination <text> - Log Destination Path

This parameter specifies the audit log destination path, where consolidated audit logs
are stored. If the path is not valid, the command fails.
[-events {file-ops|cifs-logon-logoff|cap-staging}, ...] - Categories of Events to Audit
This parameter specifies the categories of events to be audited. Supported event
categories are: file access events (both CIFS and NFS), CIFS logon and logoff events
and Central Access Policy(CAP) staging events.The corresponding parameter values
are: file-ops,cifs-logon-logoff and cap-staging.By default, file-ops and cifs-logon-logoff
events are enabled.
[-format {xml|evtx}] - Log Format
This parameter specifies the output format of the audit logs. The output format can be
either Data ONTAP-specific XML or Microsoft Windows EVTX log format. By default, the
output format is EVTX.
{ [-rotate-size {<integer>[KB|MB|GB|TB|PB]}] - Log File Size Limit
This parameter specifies the audit log file size limit. By default, the audit log is rotated
based on size. The default audit log size is 100 MB.
| [-rotate-schedule-month <cron_month>, ...] - Log Rotation Schedule: Month
This parameter specifies the monthly schedule for rotating the audit log. For example,
you can specify that the audit log is to be rotated during the months January, March, and
August, or during all the months. Valid values are January, February, March, April, May,
June, July, August, September, October, November, December, and all. Specify "all" to
rotate the audit logs every month.
[-rotate-schedule-dayofweek <cron_dayofweek>, ...] - Log Rotation Schedule: Day
of Week
This parameter specifies the daily (day of the week) schedule for rotating the audit
log. For example, you can specify that the audit log is to be rotated on Tuesdays and
Fridays, or during all the days of a week. Valid values are Sunday, Monday, Tuesday,
Wednesday, Thursday, Friday, Saturday, and all. Specify "all" to rotate the audit logs
every day.
[-rotate-schedule-day <cron_dayofmonth>, ...] - Log Rotation Schedule: Day
This parameter specifies the day of the month schedule for rotating the audit log. For
example, you can specify that the audit log is to be rotated on the 10th and 20th days of
a month, or all days of a month. Valid values range from 1 to 31.
[-rotate-schedule-hour <cron_hour>, ...] - Log Rotation Schedule: Hour
2012
This parameter specifies the hourly schedule for rotating the audit log. For example, you
can specify that the audit log is to be rotated at 6 a.m and 10 a.m. Valid values range
from 0 (midnight) to 23 (11:00 p.m.). Specify "all" to rotate the audit logs every hour.
-rotate-schedule-minute <cron_minute>, ... } - Log Rotation Schedule: Minute
This parameter specifies the minute schedule for rotating the audit log. For example,
you can specify that the audit log is to be rotated at the 30th minute. Valid values range
from 0 to 59.
[-rotate-limit <integer>] - Log Files Rotation Limit
This parameter specifies the audit log files rotation limit. A value of 0 indicates that all
the log files are retained. The default value is 0. For example, if you enter a value of 5,
the last five audit logs are retained.
Examples
The following examples create an audit configuration for Vserver vs1 using size-based
rotation.
cluster1::> vserver audit create -vserver vs1 -destination /audit_log -rotatesize 10MB -rotate-limit 5
The following example creates an audit configuration for Vserver vs1 using time-based
rotation. The audit logs are rotated monthly, all days of the week, at 12:30.
cluster1::> vserver audit create -vserver vs1 -destination /audit_log -rotateschedule-month all -rotate-schedule-dayofweek all -rotate-schedule-hour 12 rotate-schedule-minute 30
The following example creates an audit configuration for Vserver vs1 using time-based
rotation. The audit logs are rotated in January, March, May, July, September, and
November on Monday, Wednesday, and Friday, at 6:15, 6:30, 6:45, 12:15, 12:30, 12:45,
18:15, 18:30, and 18:45. The last 6 audit logs are retained.
cluster1::> vserver audit create -vserver vs1 -destination /audit_log -rotateschedule-month January,March,May,July,September,November -rotate-scheduledayofweek Monday,Wednesday,Friday -rotate-schedule-hour 6,12,18 -rotate-scheduleminute 15,30,45 -rotate-limit 6
The following example creates an audit configuration for Vserver vs1 for auditing CIFS
and NFS file access events in the output log format EVTX.
cluster1::> vserver audit create -vserver vs1 -destination /audit_log -format
evtx -events file-ops
2013
vserver audit delete

Delete audit configuration
Description
The vserver audit delete command deletes the audit configuration for a Vserver.
Parameters
This parameter specifies the name of the Vserver associated with the audit configuration
to be deleted.
This parameter is used to forcibly delete the audit configuration. By default the setting is
false.
Examples
The following example deletes the audit configuration for Vserver vs1.
cluster1::> vserver audit delete -vserver vs1
vserver audit disable

Disable auditing
Description
The vserver audit disable command disables auditing for a Vserver.
Parameters
2014
This parameter specifies the name of the Vserver for which auditing is to be disabled.
The Vserver audit configuration must already exist.
Examples
The following example disables auditing for Vserver vs1.
cluster1::> vserver audit disable -vserver vs1
vserver audit enable

Enable auditing
Description
The vserver audit enable command enables auditing for a Vserver.
Parameters
This parameter specifies the name of the Vserver for which auditing is to be enabled.
The Vserver audit configuration must already exist.
[-force [true]] - Force Enable (privilege: advanced)
This parameter is used to forcibly enable auditing. By default the setting is false.
Examples
The following example enables auditing for Vserver vs1.
cluster1::> vserver audit enable -vserver vs1
vserver audit modify

Modify the audit configuration
2015
Description
The vserver audit modify command modifies an audit configuration for a Vserver.
Parameters
This parameter specifies the name of the Vserver for which the audit configuration is to
be modified. The Vserver audit configuration must already exist.
If you have configured time-based rotation, modifying one parameter of time-based
rotation schedule does not affect the other parameters. For example, if the rotation
schedule is set to run at Monday 12:30 a.m., and you modify the -rotate-scheduledayofweek parameter to Monday,Wednesday,Friday, the new rotation-schedule
rotates the audit logs on Monday, Wednesday, and Friday at 12:30 a.m. To clear timebased rotation parameters, you must explicitly set that portion to "-". Some time-based
parameters can also be set to "all".
[-destination <text>] - Log Destination Path
This parameter specifies the audit log destination path, where consolidated audit logs
are stored. If the path is not valid, the command fails.
This parameter specifies the categories of events to be audited. Supported event
categories are: file access events (both CIFS and NFS), CIFS logon and logoff events
and Central Access Policy(CAP) staging events. The corresponding parameter values
are file-ops,cifs-logon-logoff and cap-staging. By default, file-ops and cifs-logon-logoff
events are enabled
This parameter specifies the output format of the audit logs. The output format can be
either Data ONTAP-specific XML or Microsoft Windows EVTX log format. By default, the
output format is EVTX.
{ [-rotate-size {<integer>[KB|MB|GB|TB|PB]}] - Log File Size Limit
This parameter specifies the audit log file size limit. By default, the audit log is rotated
based on size. The default audit log size is 100 MB.
| [-rotate-schedule-month <cron_month>, ...] - Log Rotation Schedule: Month
This parameter specifies the monthly schedule for rotating the audit log. For example,
you can specify that the audit log is to be rotated during the months January, March, and
August, or during all the months. Valid values are January, February, March, April, May,
2016
June, July, August, September, October, November, December, and all. Specify "all" to
rotate the audit logs every month.
[-rotate-schedule-dayofweek <cron_dayofweek>, ...] - Log Rotation Schedule: Day
of Week
This parameter specifies the daily (day of the week) schedule for rotating the audit
log. For example, you can specify that the audit log is to be rotated on Tuesdays and
Fridays, or during all the days of a week. Valid values are Sunday, Monday, Tuesday,
Wednesday, Thursday, Friday, Saturday, and all. Specify "all" to rotate the audit logs
every day.
This parameter specifies the day of the month schedule for rotating the audit log. For
example, you can specify that the audit log is to be rotated on the 10th and 20th days of
a month, or all days of a month. Valid values range from 1 to 31.
This parameter specifies the hourly schedule for rotating the audit log. For example, you
can specify that the audit log is to be rotated at 6 a.m and 10 a.m. Valid values range
from 0 (midnight) to 23 (11:00 p.m.). Specify "all" to rotate the audit logs every hour.
[-rotate-schedule-minute <cron_minute>, ...] } - Log Rotation Schedule: Minute
This parameter specifies the minute schedule for rotating the audit log. For example,
you can specify that the audit log is to be rotated at the 30th minute. Valid values range
from 0 to 59.
This parameter specifies the audit log files rotation limit. A value of 0 indicates that all
the log files are retained. The default value is 0.
Examples
The following example modifies the rotate-size and rotate-limit field for Vserver vs1.
cluster1::> vserver audit modify -vserver vs1 -rotate-size 10MB -rotate-limit 3
The following example modifies an audit configuration for Vserver vs1 using the timebased rotation method. The audit logs are rotated monthly, all days of the week, at
12:30.
cluster1::> vserver audit modify -vserver vs1 -destination /audit_log -rotateschedule-month all -rotate-schedule-dayofweek all -rotate-schedule-hour 12 rotate-schedule-minute 30
2017
The following example modifies an audit configuration for Vserver vs1 for auditing CIFS
and NFS file access events in the output log format EVTX.
cluster1::> vserver audit modify -vserver vs1 -format evtx -events file-ops
vserver audit rotate-log

Rotate audit log
Description
The vserver audit rotate-log command rotates audit logs for a Vserver.
Parameters
This parameter specifies the name of the Vserver for which audit logs are to be rotated.
The Vserver audit configuration must already exist. Auditing must be enabled for the
Vserver.
Examples
The following example rotates audit logs for Vserver vs1.
cluster1::> vserver audit rotate-log -vserver vs1
vserver audit show

Display the audit configuration
Description
The vserver audit show command displays audit configuration information about
Vservers. The command output depends on the parameter or parameters specified with
2018
the command. If you do not specify any parameters, the command displays the following
information about all the Vservers:
Vserver name
Audit state
Target directory
You can specify the -fields parameter to specify which audit configuration information
to display about Vservers.
parameters. For instance, to display information about the log file rotation size of a
Vserver whose value matches 10 MB, run the command with the -rotate-size 10MB
parameter.
You can specify the -instance parameter to display audit configuration information for
all Vservers in list form.
Parameters
| [-log-save-details ]
You can specify the -log-save-details parameter to display the following
information about all the Vservers:
Vserver name
Rotation file size
Rotation schedules
Rotation limit
| [-instance ] }
all entries.
If you specify this parameter, the command displays information about the specified
Vserver.
[-state {true|false}] - Auditing State
2019
If you specify this parameter, the command displays information about the Vservers that
use the specified audit state value.
[-destination <text>] - Log Destination Path
use the specified destination path.
If you specify this parameter, the command displays information about the Vservers
that use the specified category of events that are audited. Valid values are file-ops, cifslogon-logoff and cap-staging.
use the specified log format.
[-rotate-size {<integer>[KB|MB|GB|TB|PB]}] - Log File Size Limit
use the specified log file rotation size.
[-rotate-schedule-month <cron_month>, ...] - Log Rotation Schedule: Month
If you specify this parameter, the command displays information about the Vservers
that use the specified month of the time-based log rotation scheme. Valid values
are January, February, March, April, May, June, July, August, September, October,
November, and December.
[-rotate-schedule-dayofweek <cron_dayofweek>, ...] - Log Rotation Schedule: Day of
Week
use the specified day of the week of the time-based log rotation scheme. Valid values
are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday.
use the specified day of the month of the time-based log rotation scheme. Valid values
range from 1 to 31.
use the specified hour of the time-based log rotation scheme. Valid values range from 0
(midnight) to 23 (11:00 p.m.).
[-rotate-schedule-minute <cron_minute>, ...] - Log Rotation Schedule: Minute
2020
use the specified minute of the time-based log rotation scheme. Valid values range from
0 to 59.
[-rotate-schedule-description <text>] - Rotation Schedules
use the specified rotation schedules. This field is derived from the rotate-time fields.
use the specified rotation limit value.
Examples
The following example displays the name, audit state, event types, log format, and
target directory for all Vservers.
cluster1::> vserver audit show
Vserver
State
Event Types Log Format Target Directory
----------- ------ ----------- ---------- -------------------vs1
false
file-ops
evtx
/audit_log
The following example displays the Vserver names and details about the audit log for all
Vservers.
cluster1::> vserver audit show -log-save-details
Vserver
Rotation
Rotation
File Size Rotation Schedule
Limit
----------- --------- ------------------------ -------vs1
100MB
The following example displays in list form all audit configuration information about all
Vservers.
cluster1::> vserver audit show -instance
Vserver: vs1
Auditing state: true
Log Destination Path: /audit_log
Categories of Events to Audit: file-ops
2021
Log Format: evtx

Log File Size Limit: 100MB
Log Rotation Schedule: Month: Log Rotation Schedule: Day of Week: Log Rotation Schedule: Day: Log Rotation Schedule: Hour: Log Rotation Schedule: Minute: Rotation Schedules: Log Files Rotation Limit: 0
2022
vserver check lif-multitenancy run

Run check for LIF multitenancy
Description
The run command checks the specified Vserver to verify that it has connectivity to the
configured external servers providing services such as Active Directory, NIS, and DNS.
The output can consist of three types of messages. Failure messages indicate that a
Vserver does not have the connectivity required to a server exporting a service. Warning
messages indicate configuration or operational issues that are possible causes of the
failures. A success message is displayed if the Vserver has network connectivity to each
of the configured servers for each service.
You can use this command to verify configuration changes such as creating a Vserver
or changing the configured servers for one or more services. It is also useful for
diagnosing operational problems that result from failures that could be caused by the
inability to make network connections to configured servers.
The services that are checked are DNS, NIS, CIFS preferred domain controllers, CIFS
discovered domain controllers, KDC, Active Directory, Admin, Password, LDAP, and
LDAP preferred Active Directory.
Only a single run for a Vserver is allowed to run in a cluster. If multiple runs are
attempted for a Vserver, a message will be displayed indicating that a run is already in
progress.
For each service, this command will ping each configured server until a successful ping
is completed. In certain circumstances where a subnet is offline or LIFs are operationally
down, this command may take a long time to run. In order to show that forward progress
is being made, an activity indicator of a '.' is displayed for each ping sent.
The following fields are reported in table format. Some fields may not be relevant to a
type of message and will consist of the text "-".
Vserver name
Service external server is exporting
Address of external server
Connectivity to that external server
2023
More information describing the problem

Suggestions to remediate the problems
Success when there are no problems
Parameters
Use this parameter to specify the Vserver to check.
[-verbose {true|false}] - Show Positive and Negative Result (privilege: advanced)
When this parameter is specified the results of all connectivity tests will be displayed in
the success and failure cases.
Examples
This is an example of a successful run:
cluster1::> vserver check lif-multitenancy run -vserver vs0
..
SUCCESS: All external servers are reachable.
This is an example of a run with warnings and failures that need to be corrected:
cluster1::> vserver check lif-multitenancy run -vserver vs0
Vserver
Connected Details
Severity Service
Address
LIF
--------------- -------- ------------------ --------------- ------------------------ --------------vs0
warning operationally down
vs0_lif1
vs0
warning operationally down
vs0_lif2
...
vs0
no
failure
DNS
10.98.200.20
failure
NIS domain
10.98.13.53
cache
...
vs0
no
cache
Error : command failed:
FAILURES FOUND.
You must correct these failures to avoid service disruptions

in DOT 8.3 and above.
2024
Corrective actions may include:

- removing decommissioned external servers from the vserver
configuration
- restoring network interfaces that are down
- adding network interfaces or routes
- modifying the locations where network interfaces may reside
(through
adjusting failover groups/policies or changing the home-node or
auto-revert settings).
For assistance, please consult the 8.3 Upgrade Document,
or contact support personnel.
At advanced privilege, additional information for messages at all severities is displayed.

cluster1::*> vserver check lif-multitenancy run -vserver vs0 -verbose true
....
Vserver
Connected Details
Severity Service
Address
LIF
--------------- -------- ------------------ --------------- ------------------------ --------------vs0

yes
info
DNS
10.98.200.20
vs0_lif1
info
NIS domain
10.98.13.53
vs0_lif1
ping
....
vs0
yes
ping
SUCCESS: All external servers are reachable.
2025
vserver check lif-multitenancy show-results

Show the results of the latest multitenancy network run
Description
You can view detailed information about the latest completed run, or the run for a
Vserver.
Vserver - name of vserver run was for
Severity - severity of the message which is failure, warning, or info.
Service - name of service that is being checked for connectivity
Address - address of server configured for the above service that is being
LIF - the LIF a successful connectivity check to the above server was made from
Connected - true of there is connectivity, false if there is not
Status - additional information useful for resolving issues
Parameters
specify.
| [-instance ] }
about all fields.
Selects the messages matching the specified Vserver
[-severity <text>] - Severity
Selects the messages matching the specified severity of failure, warning, and info.
[-service <text>] - Service Name
2026
Selects the messages matching the specified service.

[-address <text>] - Address of Server
Selects the messages matching the specified address.
Selects the messages matching the specified LIF.
[-connected {yes|no}] - Vserver Connectivity
Selects the messages matching the specified connectivity.
[-status <text>] - Additional Information
Selects the messages matching the specified search criteria.
Examples
Runs that are successful will not have any content.
cluster1::> vserver check lif-multitenancy show-results -vserver vs0
Successful runs made with -verbose true will show the LIF used to Ping the nework
address from.
Network
Logical
Vserver
Severity
Service
Address
Interface
Connected
----------------
--------
-----------
-----------
---------
----------
info
DNS
10.98.200.20
vs0_lif1
yes
ping
info
NIS domain
10.98.13.53
vs0_lif1
yes
ping
Status
vs0
Runs that fail display each failure that needs to be fixed.

Vserver
Severity
Service
Network
Logical
Address
Interface
Connected
Status
2027
----------------
--------
-----------
-----------
---------
----------
warning
operationally down
vs0_lif1
warning
operationally down
vs0_lif2
failure
DNS
10.98.200.20
-
no
cache
failure
NIS domain
10.98.13.53
no
cache
vs0
2028
vserver check lif-multitenancy show

Show the summary of the latest multitenancy network run
Description
You can view summary information about the latest completed run, or the run in
progress for a Vserver. It will show the following fields:
Vserver - Name of Vserver that was checked for LIF connectivity
Start Time - Date And Time the run was started
Status - Not Started, In Progress, Complete, or Aborted
Success - Yes if the run has a Status of Complete with no failures. No if the run
has a status of Complete with one or more failures.
Updated - The date and time the scan was last updated.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the summary information matching the specified Vserver.
Selects the summary information matching the specified date and time the run was
started
[-status {not started|in progress|complete|aborted}] - Run Status
Selects the summary information matching the specified status of the run.
2029
[-success {yes|no}] - Successful Run

Selects the summary information matching the specified success or failure of the run.
[-updated <MM/DD/YYYY HH:MM:SS>] - Run Updated
Selects the summary information matching the last time the run was still in progress.
Examples
This is what a successful run looks like:
cluster1::> vserver check
lif-multitenancy show
Vserver
Start Time
Status
Success
--------------
-------------------
------------
-------
7/16/2014 14:28:35
complete
yes
vs0
This is what a failed run looks like:

cluster1::> vserver check lif-multitenancy show
Vserver
Start Time
Status
Success
--------------
-------------------
------------
-------
7/16/2014 14:40:55
complete
no
vs0
This is what specifying the Vserver looks like:

cluster1::> vserver check lif-multitenancy show -vserver vs0
Vserver: vs0
Start Time: 7/16/2014 14:40:55
Run Status: complete
Successful Run: no
Advanced privilege adds in the Updated field.

cluster1::*> vserver check lif-multitenancy show
2030
Vserver
Start Time
Status
Success
Updated
--------------
--------------
----------
-------
--------------
vs0
7/16/2014 14:40:55
complete
no
7/16/2014 14:40:56
2031
vserver cifs add-netbios-aliases

Add NetBIOS aliases for the CIFS server name
Description
The vserver cifs add-netbios-aliases command creates or adds a list of
NetBIOS aliases for the CIFS server name.
Parameters
This parameter specifies the name of the Vserver for which NetBIOS alias are to be
created or added.
-netbios-aliases <NetBIOS>, ... - List of NetBIOS Aliases
This parameter specifies one or more NetBIOS aliases to be added to an existing list of
NetBIOS aliases. A new list of NetBIOS aliases is created if the list is currently empty.
Examples
The following example creates a new list of NetBIOS aliases for Vserver vs_a.
cluster1::> cifs show -display-netbios-aliases
Vserver: vs_a
Server Name: CIFS_SERVER
NetBIOS Aliases: cluster1::> cifs add-netbios-aliases -netbios-aliases alias_1,alias_2,alias_3
Vserver: vs_a
NetBIOS Aliases: ALIAS_1, ALIAS_2, ALIAS_3
2032
The following example adds several NetBIOS aliases for the CIFS server
CIFS_SERVER on Vserver vs_a.
cluster1::> cifs add-netbios-aliases -netbios-aliases alias_4,alias_5,alias_6
Vserver: vs_a
NetBIOS Aliases: ALIAS_1, ALIAS_2, ALIAS_3, ALIAS_4,
ALIAS_5, ALIAS_6
cluster1::> vserver cifs add-netbios-aliases -vserver v1 -netbios-aliases alias_7
Vserver: vs_a
ALIAS_5, ALIAS_6, ALIAS_7
2033
vserver cifs create

Create a CIFS server
Description
The vserver cifs create command creates a CIFS server on a Vserver. When you
create the CIFS server, you must add it to an existing CIFS domain. When you enter this
command, the storage system prompts you to provide the credentials of a user account
that has sufficient privileges to add computers to the -ou container within the -domain
domain. The user account must have a password that cannot be empty. If the new CIFS
server is joining a domain, this command might take several minutes to complete.
Note:
Each Vserver can have only one CIFS server.
Parameters
This parameter specifies the name of the Vserver on which to create the CIFS server.
The Vserver must already exist.
-cifs-server <NetBIOS> - CIFS Server NetBIOS Name
This parameter specifies the name of the CIFS server (up to 15 characters).
This parameter specifies the name of the Active Directory domain to associate with the
CIFS server.
This parameter specifies the organizational unit within the Active Directory domain to
associate with the CIFS server. By default, this parameter is set to CN=Computers.
[-default-site <text>] - Default Site Used by LIFs Without Site Membership
This parameter specifies the site within the Active Directory domain to associate with the
CIFS server if Data ONTAP cannot determine an appropriate site.
2034
[-status-admin {down|up}] - CIFS Server Administrative Status

Use this parameter to specify whether the initial administrative status of the cifs server is
up or down. The default setting is up.
[-comment <text>] - CIFS Server Description
This optional parameter specifies a text comment for the server. CIFS clients can see
this CIFS server description when browsing servers on the network. The comment can
be up to 48 characters long. If there is a space in the descriptive remark or the path, you
must enclose the entire string in quotation marks.
[-netbios-aliases <NetBIOS>, ...] - List of NetBIOS Aliases
This parameter specifies a list of NetBIOS aliases, which are alternate names to the
CIFS server name.
Examples
The following example creates a CIFS server CIFSSERVER1 for Vserver vs1 and
domain EXAMPLE.com.
cluster1::> vserver cifs create -vserver vs1 -cifs-server CIFSSERVER1 -domain
EXAMPLE.com
In order to create an Active Directory machine account for the CIFS server, you
must supply the name and password of a Windows account with sufficient
privileges to add computers to the "CN=Computers" container within the
"EXAMPLE.com" domain.
Enter the password:
2035
vserver cifs delete

Delete a CIFS server
Description
The vserver cifs delete command deletes a CIFS server.
Parameters
This parameter specifies the Vserver for the CIFS server you want to delete.
Examples
The following example deletes the CIFS server from a Vserver named vs1:
cluster1::> vserver cifs delete -vserver vs1
vserver cifs modify

Modify a CIFS server
Description
The vserver cifs modify command modifies the site within the Active Directory
domain to associate with the CIFS server if Data ONTAP cannot determine an
appropriate site. You also can rejoin the CIFS server to the current domain or join a new
one. When a CIFS server is joining a domain, this command might take several minutes
to complete.
Parameters
2036
This parameter specifies the Vserver for the CIFS server whose associated site you
want to modify.
This parameter specifies the fully qualified name of the Active Directory domain to
associate with the CIFS server.
This parameter specifies the site within the Active Directory domain to associate with the
CIFS server if Data ONTAP cannot determine an appropriate site.
Use this parameter to modify the administrative status of the cifs server. Modify the
administrator status to down to stop cifs access.
Use this parameter to modify the comment of the server.
Examples
The following example changes the default site and administrative status of the CIFS
server associated with Vserver "vs1":
cluster1::> vserver cifs modify -vserver vs1 -default-site default -status-admin
up
The following example modifies the Active Directory domain for the CIFS server
associated with Vserver "vs1". The administrative status of the CIFS server must be set
to "down" in order to proceed with Active Directory domain modification. If the command
completes successfully, the administrative status is automatically set to "up".
cluster1::> vserver cifs modify -vserver vs1 -domain example.com -status-admin
down
In order to create an Active Directory machine account for the CIFS server, you
must supply the name and password of a Windows account with sufficient
privileges to add computers to the "CN=Computers" container within the
"example.com"
domain.
Enter the user name: administrator
Enter the password:
cluster1::>
2037
2038
vserver cifs nbtstat

Display NetBIOS information over TCP connection
Description
The vserver cifs nbtstat command displays information about NetBIOS over TCP (NBT)
connections for the cluster. It displays the IP address associated with the interfaces,
the IP addresses of the WINS servers in use, and information about the registered
NetBIOS names for the cluster. You can use this command to troubleshoot NetBIOS
name resolution problems.
Note:
NetBIOS name service (NBNS) over IPv6 is not supported.
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this optional parameter, the command displays the NetBIOS name service
information only for the specified node.
information only for the specified Vserver.
[-nbt-name <text>] - NBT Name
information only for the specified NetBIOS name.
2039
[-netbios-suffix <Hex String>] - NetBIOS Suffix

information only for the specified NetBIOS suffix.
[-interface <IP Address>, ...] - Interfaces
information only for the specified IP address.
[-wins-servers <IP Address>, ...] - Servers
information only for the specified WINS servers.
[-server-state <text>, ...] - Server State (active, inactive)
information only for the specified WINS server state. The following are possible values
for this parameter:
active
inactive
[-nbt-scope <text>] - NBT Scope
information only for the specified NetBIOS name scope.
[-nbt-mode <text>] - NBT Mode
information only for the specified NetBIOS name service mode. The following are
possible values for this parameter:
'p' - Point to Point
'h' - Hybrid
'm' - Mixed
'b' - Broadcast
[-state <text>] - State
information only for the specified NetBIOS name registration state. The following are
possible values for this parameter:
must_register
2040
must_unregister
wins
broadcast
name_released
wins_conflict
broadcast_conflict
[-time-left <integer>] - Time Left
information only for the specified registration time left in minutes with the WINS server.
[-type <text>] - Type
information only for the specified name registration type. The following are possible
values for this parameter:
registered
active
permanent
group
Examples
The following example displays the NetBIOS name service information.
cluster1::> nbtstat
(vserver cifs nbtstat)
Vserver: vs1
Node:
cluster1-01
Interfaces:
10.10.10.32
10.10.10.33
Servers:
17.17.1.2
(active
NBT Scope:
[ ]
NBT Mode:
2041
[h]
NBT Name
NetBIOS Suffix
State
Time Left
------------------ ---------------
------------- ---------
CLUSTER_1
00
wins
57
CLUSTER_1
20
wins
57
Type
-----
Vserver: vs1
Node:
cluster1-02
Interfaces:
10.10.10.35
Servers:
17.17.1.2
(active
CLUSTER_1
00
wins
58
CLUSTER_1
20
wins
58
2042
vserver cifs remove-netbios-aliases

Remove NetBIOS aliases
Description
The vserver cifs remove-netbios-aliases command deletes NetBIOS aliases
for the CIFS server.
Parameters
This parameter specifies the name of the Vserver from which the list of NetBIOS aliases
are deleted.
-netbios-aliases <NetBIOS>, ... - List of NetBIOS Aliases
This parameter specifies one or more NetBIOS aliases to be deleted. To delete all the
NetBIOS aliases of a Vserver use '-'.
Examples
The following example deletes NetBIOS aliases for the CIFS server CIFS_SERVER on
Vserver vs_a.
Vserver: vs_a
ALIAS_5, ALIAS_6, ALIAS_7
cluster1::> cifs remove-netbios-aliases -netbios-aliases alias_1,alias_3,alias_5
Vserver: vs_a
2043

NetBIOS Aliases: ALIAS_2, ALIAS_4, ALIAS_6, ALIAS_7
cluster1::> cifs remove-netbios-aliases -netbios-aliases alias_7
Vserver: vs_a
cluster1::> cifs remove-netbios-aliases -netbios-aliases cluster1::> cifs show -display-netbios-aliases
Vserver: vs_a
NetBIOS Aliases: -
2044
vserver cifs show

Display CIFS servers
Description
The vserver cifs show command displays information about CIFS servers. The
command output depends on the parameter or parameters specified with the command.
If you do not specify any parameters, the command displays the following information
about all CIFS servers:
Vserver name
CIFS server NetBIOS name
Domain or workgroup name
Authentication style
about CIFS servers. In addition to the fields above, you can display the following fields:
Default site
Fully-qualified domain name
parameters. For instance, to display information only about CIFS servers that are in the
CIFS domain named RUBY, run the command with the -domain-workgroup RUBY
parameter.
You can specify the -instance parameter to display all information for all CIFS servers
in list form.
Parameters
| [-display-netbios-aliases ]
2045
If you specify this parameter, the command displays information about configured
NetBIOS aliases.
| [-instance ] }
all entries.
If you specify this parameter, the command displays information only about the CIFS
servers for the specified Vserver.
[-cifs-server <NetBIOS>] - CIFS Server NetBIOS Name
If you specify this parameter, the command displays information only for CIFS servers
that match the specified CIFS server NetBIOS name.
[-domain-workgroup <CIFS domain>] - NetBIOS Domain/Workgroup Name
that are in the specified NetBIOS domain or workgroup.
Note:
Workgroups are not supported in this release.
that are in the specified domain.
that have the specified default site.
[-auth-style {domain|workgroup}] - Authentication Style
that match the specified authentication style.
Note:
Workgroups are not supported in this release, so the only possible authentication style
is domain.
2046
that match the specified administrative status.
that match the specified comment field.
[-netbios-aliases <NetBIOS>, ...] - List of NetBIOS Aliases
that have specified NetBIOS alias.
Examples
The following example displays a subset of the information about all CIFS servers.
cluster1::> vserver cifs show
Vserver
Server
Domain/Workgroup
Name
Name
Authentication Style
-------------- ----------- ---------------- -------------------vs1
CIFSSERVER1 EXAMPLE
domain
The following example displays all information about all CIFS-enabled Vservers in list
form.
cluster1::> vserver cifs show -instance
Vserver: vs1
CIFS Server NetBIOS Name: CIFSSERVER1
NetBIOS Domain/Workgroup Name: EXAMPLE
Fully Qualified Domain Name: EXAMPLE.COM
Default Site Used by LIFs Without Site Membership:
Authentication Style: domain
CIFS Server Administrative Status: up
CIFS Server Description:
List of NetBIOS Aliases: ALIAS_2, ALIAS_4, ALIAS_6
The following example displays the NetBIOS aliases for the CIFS server CIFSSERVER1
2047
Vserver: vs1
Server Name: CIFSSERVER1
vserver cifs start

Start a CIFS server
Description
This command starts the CIFS server on the specified Vserver. The CIFS server must
already exist. To create a CIFS server, run vserver cifs create.
Parameters
This parameter specifies a Vserver containing a configured CIFS server that has been
stopped.
Examples
The following example starts the CIFS server on Vserver vs1:
cluster1::> cifs start -vserver vs1
See Also
vserver cifs create
2048
vserver cifs stop

Stop a CIFS server
Description
This command stops the CIFS server on the specified Vserver.
Note:
Established sessions will be terminated and their open files closed. Workstations with
cached data will not be able to save those changes, which could result in data loss.
Parameters
This parameter specifies a Vserver containing a configured CIFS server that is running.
Examples
The following example stops the CIFS server on Vserver vs1:
cluster1::> cifs stop -vserver vs1
vserver cifs branchcache create

Create the CIFS BranchCache service
Description
The vserver cifs branchcache create command creates the configuration
for computing and retrieving BranchCache hash data. Only a single instance of the
BranchCache service can be created on a Vserver.
2049
The vserver cifs branchcache create command is not supported for Vservers
Parameters
This parameter specifies the CIFS-enabled Vserver on which you want to set up the
BranchCache service.
[-versions {v1-enable|v2-enable|enable-all}, ...] - Supported BranchCache Versions
This optional parameter specifies a list of versions of the BranchCache protocol that the
storage system supports. The default is enable-all. This list can include one or more
of the following:
v1-enable - This option enables BranchCache Version 1.
enable-all - This option enables all supported versions of BranchCache.
-hash-store-path <text> - Path to Hash Store
This parameter specifies an existing directory into which the hash data is stored. Readonly paths, such as snapshot directories, are not allowed.
[-hash-store-max-size {<integer>[KB|MB|GB|TB|PB]}] - Maximum Size of the Hash
Store
This optional parameter specifies the maximum size to use for the hash data. If the size
of the hash data exceeds this value, older hashes are deleted to make room for newer
hashes. The default is 1 GB.
[-server-key <text>] - Encryption Key Used to Secure the Hashes
This optional parameter specifies a server key that the BranchCache service uses to
prevent clients from impersonating the BranchCache server.
[-operating-mode <BranchCache Mode>] - CIFS BranchCache Operating Modes
This optional parameter specifies the mode in which the BranchCache service operates.
The default is per-share. Possible values include:
disable - This option disables the BranchCache service for the Vserver.
all-shares - This option enables the BranchCache service for all the shares on this
Vserver.
per-share - This option enables the BranchCache service on a per-share basis.
You can enable the BranchCache service on an existing share by adding the
2050
branchcache flag in the -share-properties parameter of the vserver cifs

share modify command.
Examples
The following example creates the BranchCache service on the Vserver named vs1.
The path to the hash store is /vs1_hash_store.
cluster1::> vserver cifs branchcache create -vserver vs1 -hash-store-path /
vs1_hash_store
The following example creates the BranchCache service on the Vserver vs1. The
path to the hash store is /vs_hash_store. The service is enabled on all the shares
of the Vserver, supports BranchCache version 2, supports a maximum of 1 GB of
BranchCache hashes, and secures the hashes using the key "vs1 secret".
cluster1::> vserver cifs branchcache create -vserver vs1 -hash-store-path /
vs1_hash_store -operating-mode all-shares -versions v2-enable -hash-store-maxsize 1GB -server-key "vs1 secret"
See Also
vserver cifs share modify
2051
vserver cifs branchcache delete

Stop and remove the CIFS BranchCache service
Description
The vserver cifs branchcache delete command stops and removes the
Vserver BranchCache configuration.
The vserver cifs branchcache delete command is not supported for Vservers
Parameters
This parameter specifies the CIFS-enabled Vserver whose BranchCache configuration
you want to remove.
-flush-hashes {true|false} - Delete Existing Hashes
This parameter specifies whether to keep or delete all existing hashes after deleting the
BranchCache service.
Examples
The following example stops and removes the BranchCache service on the Vserver vs1.
It also deletes all existing hashes.
cluster1::> vserver cifs branchcache delete -flush-hashes true -vserver vs1
vserver cifs branchcache hash-create

Force CIFS BranchCache hash generation for the specified path or file
Description
2052
The vserver cifs branchcache hash-create command causes the

BranchCache service to compute hashes for a single file, for a directory, or for all the
files in a directory structure if you specify the -recurse option.
The vserver cifs branchcache hash-create command is not supported for
Vservers with Infinite Volume.
Parameters
This parameter specifies the CIFS-enabled Vserver on which the hash is computed.
-path <text> - Path of File or Directory to Hash
This parameter specifies the path of the directory or file for which hashes are to be
computed. If a file is specified, the hashes are computed on the whole file. If a directory
is specified, hashes are computed on all files within the directory.
-recurse {true|false} - Process All Files in the Directory Recursively
If this option is set to true and the -path parameter specifies a directory, hashes are
computed recursively for all directories in the path.
Examples
The following example creates hashes for the file "report.doc":
cluster1::> vserver cifs branchcache hash-create -vserver vs1 -path /repository/
report.doc -recurse false
The following example creates hashes for all the files in the directory "repository":
cluster1::> vserver cifs branchcache hash-create -vserver vs1 -path /repository recurse false
The following example recursively creates hashes for all the files and directories inside
the directory "documents":
cluster1::> vserver cifs branchcache hash-create -vserver vs1 -path /documents recurse true
vserver cifs branchcache hash-flush

Flush all generated BranchCache hashes
2053

Description
The vserver cifs branchcache hash-flush command deletes all hash data
from the configured hash store.
The vserver cifs branchcache hash-flush command is not supported for
Parameters
This parameter specifies the CIFS-enabled Vserver whose hash data is to be deleted.
Examples
The following example flushes all the hashes for Vserver vs1:
cluster1::> vserver cifs branchcache hash-flush -vserver vs1
vserver cifs branchcache modify

Modify the CIFS BranchCache service settings
Description
The vserver cifs branchcache modify command modifies the configuration for
computing and retrieving BranchCache hash data.
The vserver cifs branchcache modify command is not supported for Vservers
Parameters
This parameter specifies the CIFS-enabled Vserver whose BranchCache service is to
be modified.
2054

This optional parameter specifies a list of versions of the BranchCache protocol that the
storage system supports. The default is enable-all. This list can include one or more
of the following:
enable-all - This option enables all supported versions of BranchCache.
This optional parameter specifies the mode in which the BranchCache service operates.
The default is per-share. Possible values include:
disable - This option disables the BranchCache service for the Vserver.
all-shares - This option enables the BranchCache service for all the shares on this
Vserver.
per-share - This option enables the BranchCache service on a per-share basis.
You can enable the BranchCache service on an existing share by adding the
branchcache flag in the -share-properties parameter of the vserver cifs
share modify command.
Store
This optional parameter specifies the maximum size to use for the hash data. If the size
of the hash data exceeds this value, older hashes are deleted to make room for newer
hashes. The default is 1 GB.
[-flush-hashes {true|false}] - Delete Existing Hashes
This parameter specifies whether to keep or delete all the existing hashes. This must be
set to true when modifying the server key.
[-hash-store-path <text>] - Path to Hash Store
This parameter specifies an existing directory into which the hash data is stored. Readonly paths, such as snapshot directories, are not allowed.
This optional parameter specifies a server key that the BranchCache service uses
to prevent clients from impersonating the BranchCache server. If you specify this
parameter, all existing hashes for the Vserver are deleted.
2055
Examples
The following example modifies the BranchCache service on the Vserver named vs1.
The path to the hash store is /vs1_hash_store_2, the server key used to secure the
hashes is set to "new vserver secret", all existing hashes are removed, the service
supports all BranchCache versions, and is enabled on a per-share basis.
cluster1::> vserver cifs branchcache modify -vserver vs1 -hash-store-path /
vs1_hash_store_2 -server-key "new vserver secret" -flush-hashes true -versions
enable-all -operating-mode per-share
The following example modifies the BranchCache service on the Vserver vs1. The
service is enabled on all the shares of the Vserver, supports BranchCache version 1,
and supports a maximum of 1 TB of BranchCache hashes.
cluster1::> vserver cifs branchcache modify -vserver vs1 -operating-mode allshares -versions v1-enable -hash-store-max-size 1TB
See Also
2056
vserver cifs branchcache show

Display the CIFS BranchCache service status and settings
Description
The vserver cifs branchcache show command displays information about
the BranchCache configuration for the Vserver. The command output depends on
the parameter or parameters specified with the command. If you do not specify any
parameters, the command displays the following information:
Operating Mode
Allowed Versions
Maximum Size
Path
parameters.
Parameters
If you specify the -fields <fieldname>, ... parameter, the command displays only the
| [-instance ] }
all entries.
If you specify this parameter, the command displays information for the specified
Vserver.
If you specify this parameter, the command displays information for the Vservers that
support the specified BranchCache versions.
2057
[-hash-store-path <text>] - Path to Hash Store

If you specify this parameter, the command displays information for Vservers that store
their hashes at the specified location.
Store
If you specify this parameter, the command displays information for Vservers that have a
maximum hash store size that is set to the specified value.
If you specify this parameter, the command displays information for Vservers that have
the specified server key.
If you specify this parameter, the command displays information for Vservers whose
BranchCache configuration operates in the specified mode.
Examples
The following example displays a subset of the information about the BranchCache
service in the cluster.
cluster1::> vserver cifs branchcache show
Vserver
Operating
Allowed
Max
Mode
Versions
Size
Path
-------------- ---------- ----------- ------ -----------------------vs1
per_share
enable_all
1GB /hash_dir/
The following example displays all information about all the Vservers with BranchCache
configurations.
cluster1::> vserver cifs show -instance
Vserver: vs1
Supported Versions of BranchCache: enable_all
Path to Hash Store: /hash_dir/
Maximum Size of the Hash Store: 1GB
Encryption Key Used to Secure the Hashes: asdad
CIFS BranchCache Operating Modes: per_share
The following example displays information about BranchCache configurations that

store the hash data at the location /branchcache_hash_store.
2058
cluster1::> vserver cifs branchcache show -hash-store-path /

branchcache_hash_store
Vserver
Operating
Allowed
Max
Mode
Versions
Size
Path
-------------- ---------- ----------- ------ -----------------------vs1
per_share
enable_all
1GB /branchcache_hash_store
2059
vserver cifs character-mapping create

Create character mapping on a volume
Description
The vserver cifs character-mapping create command creates the CIFS
character mapping for the specified volume on a particular Vserver.
Note:
Choose target characters in the "Private Use Area" of Unicode in the following range: U
+E0000...U+F8FF.
Caution:
The target Unicode characters must not appear in existing file names; otherwise,
unwanted character mappings would occur, resulting in clients being unable to access
mapped files. For example, if ":" is mapped to "-" but "-" appears in files normally, a
Windows client using the mapped share to access a file named "a-b" would have its
request mapped to the NFS name "a:b", which is not the desired file.
The vserver cifs character-mapping create command is not supported for
Parameters
This parameter specifies the Vserver on which a volume is located for which you are
creating the character mapping. If only one data Vserver exists, you do not need to
specify this parameter.
This parameter specifies the name of the volume for which you are creating the
character mapping.
-mapping <text>, ... - Character Mapping
This parameter specifies the mapping of the invalid CIFS filename characters to
valid CIFS filename characters. The mapping consists of a list of source-target
2060
character pairs separated by ":". The characters are Unicode characters entered using
hexadecimal digits. For example: 3C:E03C.
Note:
The permissible Unicode character set for source mapping is: 0x01-0x19, 0x5C, 0x3A,
0x2A, 0x3F, 0x22, 0x3C, 0x3E, 0x7C, 0xB1.
Examples
The following example creates a character mapping for a volume vol1 on Vserver vs1.
cluster1::> vserver cifs character-mapping create -volume vol1 -mapping 3c:e17c,
3e:f17d, 2a:f745
cluster1::> vserver cifs character-mapping show
Vserver
Volume Name
Character Mapping
--------------
-----------
------------------------------------------
vs1
vol1
3c:e17c, 3e:f17d, 2a:f745
2061
vserver cifs character-mapping delete

Delete character mapping on a volume
Description
The vserver cifs character-mapping delete command deletes the CIFS
The vserver cifs character-mapping delete command is not supported for
Parameters
This parameter specifies the Vserver on which a Volume is located for which you are
deleting the character mapping. If only one data Vserver exists, you do not need to
This parameter specifies the name of the volume for which you are deleting the
character mapping.
Examples
The following example deletes all character mappings for a volume vol1 on Vserver vs1.
cluster1::> vserver cifs character-mapping delete -volume vol1
vserver cifs character-mapping modify

Modify character mapping on a volume
Description
2062
The vserver cifs character-mapping modify command modifies the CIFS

You can modify a particular volume's character mapping by specifying the following two
parameters in the modify command:
Vserver associated with the volume
Name of the Volume
Note:
Choose target characters in the "Private Use Area" of Unicode in the following range: U
+E0000...U+F8FF.
Caution:
The target Unicode characters must not appear in existing file names; otherwise,
unwanted character mappings would occur, resulting in clients being unable to access
mapped files. For example, if ":" is mapped to "-" but "-" appears in files normally, a
Windows client using the mapped share to access a file named "a-b" would have its
request mapped to the NFS name "a:b", which is not the desired file.
The vserver cifs character-mapping modify command is not supported for
Parameters
This parameter specifies the Vserver on which a Volume is located for which you are
modifying the character mapping. If only one data Vserver exists, you do not need to
This parameter specifies the name of the volume for which you are modifying the
character mapping.
[-mapping <text>, ...] - Character Mapping
This parameter specifies the mapping of the invalid CIFS filename characters to
valid CIFS filename characters. The mapping consists of a list of source-target
character pairs separated by ":". The characters are Unicode characters entered using
hexadecimal digits. For example: 3C:E03C.
Note:
2063
The permissible Unicode character set for source mapping is: 0x01-0x19, 0x5C, 0x3A,
0x2A, 0x3F, 0x22, 0x3C, 0x3E, 0x7C, 0xB1.
Examples
The following example modifies a character mapping for a volume vol1 on Vserver vs1.
cluster1::> vserver cifs character-mapping modify -volume vol1 -mapping 3c:e17d,
3e:f17e, 2a:f746
2064
Vserver
Volume Name
Character Mapping
--------------
-----------
------------------------------------------
vs1
vol1
3c:e17d, 3e:f17e, 2a:f746
vserver cifs character-mapping show

Display character mapping on volumes
Description
The vserver cifs character-mapping show command displays information
about character mapping configured for volumes. The command output depends on
parameters, the command displays the following information about character mapping
configured for volumes:
Vserver name
Volume name
Character mapping
Parameters
If you specify this parameter, the command displays only the fields that you specify.
| [-instance ] }
all entries.
If you specify this parameter, the command displays information about character
mapping configured for all the volumes that belong to the specified Vserver.
If you specify this parameter, the command displays information about the character
mapping configured for all the volumes that match the specified volume name.
[-mapping <text>, ...] - Character Mapping
If you specify this parameter, the command displays information about the character
mapping configured for all volumes that match the specified mapping.
2065
Examples
The following example displays information about all character mappings configured for
volumes
2066
Vserver
Volume Name
Character Mapping
--------------
-----------
------------------------------------------
vs1
vol1
3c:e17d, 3e:f17e
vserver cifs domain discovered-servers resetservers

Reset and rediscover servers for a Vserver
Description
The vserver cifs domain discovered-servers reset-servers command
discards information the storage system has stored about domain controllers, LDAP,
and NIS servers. After that, it begins the discovery process to reacquire current
information about external servers.
Parameters
This parameter specifies the name of the Vserver.
Examples
The following is an example use of this command. It produces no output.
cluster1::> vserver cifs domain discovered-servers reset-servers
cluster1::>
vserver cifs domain discovered-servers show

Display discovered server information
Description
The vserver cifs domain discovered-servers show command displays
information about the discovered servers for the CIFS domains of one or more Vservers.
Server displays are grouped by node and Vserver, and each group is preceded by the
2067
node and Vserver identification. Within each grouping, the server display is limited to
those associated with the domain specified by the domain parameter, if it is present.
Parameters
specify.
| [-instance ] }
about all fields.
If you use this parameter, the command only displays servers for the specified node.
If you use this parameter, the command only displays servers for the specified Vserver.
If you use this parameter, the command only displays servers in the specified domain.
[-type {Unknown|KERBEROS|MS-LDAP|MS-DC|LDAP|NIS}] - Server Type
If you use this parameter, the command only displays servers of the specified type.
[-name <text>] - Server Name
If you use this parameter, the command only displays servers the with the specified
name. This can result in multiple lines because the same server may provide multiple
services.
[-preference {unknown|preferred|favored|adequate}] - Preference
If you use this parameter, the command only displays servers of the specified
preference level.
[-address <InetAddress>] - Server Address
If you use this parameter, the command only displays servers with the specified IP
address. This can result in multiple lines because the same server may provide multiple
services.
[-status {OK|unavailable|slow|expired|undetermined|unreachable}] - Status
If you use this parameter, the command only displays servers of the specified status.
2068
Examples
The following example display shows the information provided by this command.
cluster1::> vserver cifs domain discovered-servers show
Node: node1
Vserver: vs1
Domain Name
Type
Preference DC-Name
DC-Address
Status
--------------- -------- ---------- --------------- --------------- --------""
NIS
preferred
192.168.10.222
192.168.10.222
OK
example.com
MS-LDAP
adequate
DC-1
192.168.192.24
OK
example.com
MS-LDAP
adequate
DC-2
192.168.192.25
OK
example.com
MS-DC
adequate
DC-1
192.168.192.24
OK
example.com
MS-DC
adequate
DC-2
192.168.192.25
OK
2069
vserver cifs domain name-mapping-search add

Add to the list of trusted domains for name-mapping
Description
The vserver cifs domain name-mapping-search add command adds one or
more trusted domains to the list of trusted domains to be used in preference to all others
by the specified Vserver for looking up Windows user names when performing Windows
user to UNIX user name-mapping. If a list already exists for the specified vserver, the
new list is merged with the existing list.
Parameters
This parameter specifies the name of the Vserver for which you want to add trusted
domains.
-trusted-domains <domain name>, ... - Trusted Domains
This parameter specifies a comma-delimited list of fully-qualified domain names of the
trusted domains for the home domain.
Examples
The following example adds two trusted domains (cifs1.example.com and
cifs2.example.com) to the preferred list used by Vserver vs1:
cluster1::> vserver cifs domain name-mapping-search add -vserver vs1 -trusteddomains cifs1.example.com, cifs2.example.com
vserver cifs domain name-mapping-search modify

Modify the list of trusted domains for name-mapping search
2070
Description
The vserver cifs domain name-mapping-search modify command modifies
the current list of trusted domains to be used in preference to all others by the specified
Vserver to lookup Windows user names when performing Windows user to UNIX user
name-mapping. The new list overwrites the existing list.
Parameters
This parameter specifies the name of the Vserver for which you want to modify the
trusted domain list.
-trusted-domains <domain name>, ... - Trusted Domains
This parameter specifies a comma-delimited list of fully qualified domain names of the
trusted domains of the home domain.
Examples
The following example modifies the trusted domain list used by Vserver vs1:
cluster1::> vserver cifs domain name-mapping-search modify -vserver vs1 -trusteddomains cifs3.example.com
vserver cifs domain name-mapping-search remove

Remove from the list of trusted domains for name-mapping search
Description
The vserver cifs domain name-mapping-search remove command removes
one or more trusted domains from the list used by the specified Vserver to lookup
Windows user names when performing Windows user to UNIX user name-mapping. If
a list of trusted domains is not provided, the entire trusted domain list for the specified
Vserver is removed.
Parameters
2071
This parameter specifies the name of the Vserver from which you want to remove
trusted domains.
[-trusted-domains <domain name>, ...] - Trusted Domains
This parameter specifies a comma-delimited list of trusted domains of the home domain.
Examples
The following example removes two trusted domains from the list used by Vserver vs1:
cluster1::> vserver cifs domain name-mapping-search remove -trusted-domains
cifs1.example.com, cifs2.example.com
vserver cifs domain name-mapping-search show

Display the list of trusted domains for name-mapping searches
Description
The vserver cifs domain name-mapping-search show command displays
information about trusted domains of the home domain by Vserver.
Parameters
specify.
| [-instance ] }
about all fields.
This parameter specifies the name of the Vserver for which you want to display
information about the trusted domains.
[-trusted-domains <domain name>, ...] - Trusted domains
2072
This parameter specifies a comma-delimited list of fully qualified domain names of

trusted domains for which you want to display information.
Examples
The following example displays information about all preferred trusted domains:
cluster1::> vserver cifs domain name-mapping-search show
Vserver
Trusted Domains
--------------
----------------------------------
vserver_1
CIFS1.EXAMPLE.COM
2073
vserver cifs domain password change

Generate a new password for the CIFS server's machine account and change it in the
Windows Active Directory domain.
Description
The vserver cifs domain password change changes the domain account
password for a CIFS server.
Parameters
This parameter specifies the name of the Vserver for whose CIFS server you want to
change the domain account password.
Examples
The following example changes the password for the CIFS server on a Vserver named
vs1.
cluster1::> vserver cifs domain password change -vserver vs1
cluster1::>
vserver cifs domain password reset

Reset the CIFS server's machine account password in the Windows Active Directory
domain.
Description
The vserver cifs domain password reset command resets the domain
account password for a CIFS server. This may be required if the password stored along
with the machine account in the Windows Active Directory domain is changed or reset
2074
without the Vserver's knowledge. The operation requires the credentials for a user
with permission to reset the password in the organizational unit (OU) that the machine
account is a member of.
Parameters
This parameter specifies the name of the Vserver for whose CIFS server you want to
reset the domain account password.
Examples
The following example resets the password for the CIFS server on a Vserver named
vs1.
cluster1::> vserver cifs domain password reset -vserver vs1
Enter your user ID: Administrator
Enter your password:
cluster1::>
vserver cifs domain password schedule modify

Modify the domain account password change schedule
Description
The vserver cifs domain password schedule modify command enables you
to modify a domain account password change schedule for a CIFS server.
Parameters
This specifies the name of the Vserver containing the CIFS server for which you want to
change the domain account password.
[-is-schedule-enabled {true|false}] - Is Password Change Schedule Enabled
2075
This specifies whether the domain account password change schedule is enabled.
[-schedule-weekly-interval <integer>] - Interval in Weeks for Password Change
Schedule
This specifies the number of weeks after which the scheduled domain account
password change must occur.
[-schedule-randomized-minute <integer>] - Minutes Within Which Schedule Start Can
be Randomized
This specifies the minutes within which the scheduled domain account password
change must begin.
[-schedule-day-of-week <cron_dayofweek>] - Day of Week for Password Change
Schedule
This sets the day of week when the scheduled domain account password change
occurs.
[-schedule-time-of-day <HH:MM:SS>] - Start Time for Password Change Schedule
This sets the time in HH:MM:SS at which the scheduled domain account password
change starts.
Examples
The following example enables the domain account password change schedule and
configures it to run at any time between 23:00:00 to 00:59:00 (one hour before midnight
to one hour after midnight) on every 4th Sunday.
cluster1::> vserver cifs domain password schedule modify -is-schedule-enabled
true -schedule-randomized-minute 120 -schedule-weekly-interval 4 -schedule-timeof-day 23:00:00 -schedule-day-of-week sunday
2076
vserver cifs domain password schedule show

Display the domain account password change schedule
Description
The vserver cifs domain password schedule show command displays the
domain account password change schedule configuration. It displays the following
fields:
Vserver: Vserver for which the schedule is configured
Schedule Enabled: Whether the schedule is enabled or disabled for this Vserver
Schedule Interval: Weeks after which the password change schedule occurs
again for this Vserver
Schedule Randomized Within: Minutes within which the schedule must begin for
this Vserver
Schedule: Password change schedule currently set on this Vserver
Last Successful Password Change/Reset Time: Time at which the last password
change or reset happened successfully on this Vserver
Warning: Warning message, applicable only when the change password job is
deleted with the feature still enabled on this Vserver
Parameters
specify.
| [-instance ] }
about all fields.
2077
If you specify this parameter, the command displays information for the specified
Vserver.
[-is-schedule-enabled {true|false}] - Is Password Change Schedule Enabled
If you specify this parameter, the command displays information for all the Vservers on
which the is-schedule-enabled value applies.
[-schedule-weekly-interval <integer>] - Interval in Weeks for Password Change
Schedule
which the schedule-weekly-interval value applies.
[-schedule-randomized-minute <integer>] - Minutes Within Which Schedule Start Can
be Randomized
which the schedule-randomized-minute value applies.
[-schedule-last-changed <text>] - Last Successful Password Change/Reset Time
which the schedule-last-changed value applies.
[-schedule-description <text>] - Schedule Description
which the schedule-description value applies.
[-schedule-warn-msg <text>] - Warning Message in Case Job Is Deleted
which the schedule-warn-msg value applies.
Examples
The following example shows the domain account password change schedule
configuration when the password change feature is enabled for Vserver vs1.
cluster1::> vserver cifs domain password schedule show
Vserver: vs1
Schedule Enabled: true
Schedule Interval: 4
week
Schedule Randomized Within: 120 min

Schedule: Fri@23:00
Last Changed At: Thu Apr
2078
4 02:35:23 2013
The following example shows the domain account password change schedule
configuration when the password change job has been accidently deleted.
cluster1::> vserver cifs domain password schedule show
Vserver: vs1
Schedule Enabled: true
Schedule Interval: 4
week
Schedule Randomized Within: 120 min

Schedule: Fri@23:00
Last Changed At: Thu Apr
4 02:35:23 2013
Warning: Password change job was deleted. Re-enable the

password change schedule.
2079
vserver cifs domain preferred-dc add

Add to a list of preferred domain controllers
Description
The vserver cifs domain preferred-dc add command adds one or more
domain controllers to be used in preference to all others by the specified Vserver for
interactions with the specified domain. If a list already exists for the specified domain,
the new list is merged with the existing list.
Note:
Each Vserver discovers domain controllers and attempts to sort them internally based
on real-world performance. Therefore it should not be necessary to create a preferred
list of domain controllers under most circumstances.
Parameters
This parameter specifies the name of the Vserver for which you want to add preferred
domain controllers.
This parameter specifies the fully-qualified name of the domain that the domain
controllers belong to.
-preferred-dc <InetAddress>, ... - Preferred Domain Controllers
This parameter specifies a comma-delimited list of IP addresses for domain controllers
that belong to the domain specified in the -domain parameter.
Examples
The following example adds two domain controllers (192.168.0.100 and 192.168.0.101)
to the preferred list used by Vserver vs1 when connecting to the example.com domain:
cluster1::> vserver cifs domain preferred-dc add -vserver vs1 -domain example.com
-preferred-dc 192.168.0.100,192.168.0.101
2080
vserver cifs domain preferred-dc remove

Remove from a list of preferred domain controllers
Description
The vserver cifs domain preferred-dc remove command removes one or
more domain controllers from the list used by the specified Vserver for interactions with
the specified domain. If a list of preferred domain controllers is not provided, the entire
list for the specified domain is removed.
Parameters
This parameter specifies the name of the Vserver from which you want to remove
preferred domain controllers.
This parameter specifies the fully-qualified name of the domain that the domain
controllers belong to.
[-preferred-dc <InetAddress>, ...] - Preferred Domain Controllers
that belong to the domain specified in the -domain parameter.
Examples
The following example removes one domain controller (192.168.0.101) from the
preferred list used by Vserver vs1 when connecting to the example.com domain:
cluster1::> vserver cifs domain preferred-dc remove -vserver vs1 -domain
example.com -preferred-dc 192.168.0.101
vserver cifs domain preferred-dc show

Display a list of preferred domain controllers
2081

Description
The vserver cifs domain preferred-dc show command displays lists of
preferred domain controllers by Vserver and domain.
Parameters
specify.
| [-instance ] }
about all fields.
This parameter specifies the name of the Vserver for which you want to display
preferred domain controllers.
This parameter specifies the fully-qualified name of the domain of the domain controllers
to display.
[-preferred-dc <InetAddress>, ...] - Preferred Domain Controllers
to display.
Examples
The following example displays all preferred domain controllers for all Vservers:
cluster1::> vserver cifs domain preferred-dc show
Vserver
Domain Name
Preferred Domain Controllers
-------------- ----------------------------- ---------------------------------vs1
2082
example.com
192.168.0.100, 192.168.0.101
vserver cifs domain trusts rediscover

Reset and rediscover trusted domains for a Vserver
Description
The vserver cifs domain trusts rediscover command discards information
the Vserver has stored about trusted domains. After that, it begins the discovery process
to reacquire current information about trusted domains.
Parameters
Examples
The following example rediscovers trusted domains. It produces no output.
cluster1::> vserver cifs domain trusts rediscover
vserver cifs domain trusts show

Display discovered trusted domain information
Description
The vserver cifs domain trusts show command displays information about
the trusted domains for the CIFS home domain of one or more Vservers. The displayed
trusted domain information is grouped by node and Vserver, and each group is
preceded by the node and Vserver identification.
Parameters
2083

specify.
| [-instance ] }
about all fields.
If you use this parameter, the command displays information only about trusted domains
of the home domains for the specified node.
of the home domain for the specified Vserver.
[-home-domain <domain name>] - Home Domain Name
of the home domain with the specified name.
[-trusted-domain <domain name>, ...] - Trusted Domain Name
with the specified name.
Examples
The following example displays information about all the bidirectional trusted domains
for node-01 and vserver_1.
cluster1::> vserver cifs domain trusts show -node node-01 -vserver vserver_1
Node: node-01
Vserver: vserver_1
Home Domain
Trusted Domain
---------------------
-----------------------------------
EXAMPLE.COM
CIFS1.EXAMPLE.COM,
CIFS2.EXAMPLE.COM
2084
vserver cifs group-policy modify

Change group policy configuration
Description
The vserver cifs group-policy modify command modifies a CIFS server's
group policy configuration.
Parameters
This parameter specifies the Vserver whose group policy configuration you want to
modify.
[-status {enabled|disabled}] - Group Policy Status
This parameter specifies whether the CIFS-enabled Vserver's group policy is enabled or
disabled.
Examples
The following example enables the group policy for CIFS-enabled Vserver vs1.
cluster1::> vserver cifs group-policy modify -vserver vs1 -status enabled
vserver cifs group-policy show-applied

Show currently applied group policy setting
Description
The vserver cifs group-policy show-applied command displays information
about group policies assigned to a Vserver. It displays all or a subset of the group policy
information matching the criteria that you specify.
2085
about all group policies applied to Vservers in the cluster:
GPO Name: Specifies the name of the Group Policy object.
Level: Specifies the level in which the Group Policy is configured. It could be
either site level, domain level, or OU level.
Status: Specifies whether or not this Group Policy object is enabled.
Advanced Audit Settings:
Object Access:
Central Access Policy Staging: Specifies the type of events to be audited for
central access policy staging. Possible values are:
none - Do not audit.
success - Audit only success events.
failure - Audit only failure events.
both - Audit both success and failure events.
Registry Settings:
Refresh Time Interval: Specifies how often the Group Policy is updated.
Refresh Random Offset: Specifies a random time that is added to the
refresh interval to prevent all clients from requesting Group Policy updates
at the same time.
Hash Publication Mode for BranchCache: Specifies the hash generation
mode used to generate hashes for data stored in shared folders on which
BranchCache is enabled, which is then provided to clients. Possible values
are:
per-share - Allow hash publication only for shared folders on which
BranchCache is enabled.
disabled - Disallow hash publication on all shared folders.
all-shares - Allow hash publication for all shared folders.
Hash Version Support for BranchCache: Specifies the version supported by
the BranchCache hash generation service. Possible values are:
2086
all-versions - Both versions 1 and 2 (V1 and V2).

version1 - Version 1 (V1).
Security Settings:
Event Audit and Event Log:
Audit Logon Events: Specifies the type of logon events to be audited.

Audit Object Access: Specifies the type of object access to be audited.
Log Retention Method: Specifies the audit log retention method. Possible
values are:
overwrite-as-needed - Overwrite the event log when size of the log file
exceeds the maximum log size.
overwrite-by-days - Not supported.
do-not-overwrite - Do not overwrite the event log.
Max Log Size: Specifies the maximum size of the audit log. This size is
displayed in kbytes.
File Security: Specifies a list of files or directories on which file security is applied.
2087
Kerberos:
Max Clock Skew: Specifies maximum tolerance in hours for computer clock
synchronization.
Max Ticket Age: Specifies maximum lifetime in minutes for user ticket.
Max Renew Age: Specifies maximum lifetime in days for user ticket
renewal.
Privilege Rights:
Take Ownership: List of users and groups that have the right to take
ownership of any securable object in the system.
Security Privilege: List of users and groups that can specify auditing options
for object access of individual resources, such as files, folders, and Active
Directory objects.
Change Notify: List of users and groups that can traverse directory trees
even though the users and groups might not have permissions on the
traversed directory.
Registry Values:
Signing Required: Specifies whether SMB signing is on or off.
Restrict Anonymous:
No enumeration of Security Account Manager (SAM) accounts: This

security setting determines what additional permissions are granted for
anonymous connections to the computer. This option displays as 'noenumeration' in Data ONTAP if enabled.
No enumeration of SAM accounts and shares: This security setting
determines whether anonymous enumeration of SAM accounts and shares
is allowed. This option displays as 'no-enumeration' in Data ONTAP if
enabled.
Restrict anonymous access to shares and named pipes: This security
setting restricts anonymous access to shares and pipes. This option
displays as 'no-access' in Data ONTAP if enabled.
2088
Combined restriction for anonymous user: The combined restriction for the
anonymous user is derived from the above three settings:
If 'no-access' is enabled, 'Combined restriction for anonymous user'
is set to 'no-access'. The anonymous user is denied access to the
specified shares and named pipes, and cannot use enumeration of
SAM accounts and shares.
If 'no-enumeration' is enabled and 'no-access' is disabled, 'Combined
restriction for anonymous user' is set to 'no-enumeration'. The
anonymous user has access to the specified shares and named
pipes, but cannot use enumeration of SAM accounts and shares.
If 'no-enumeration' is disabled and 'no-access' is disabled, 'Combined
restriction for anonymous user' is set to 'no-restriction'. The
anonymous user has full access and can use enumeration.
Restricted Groups:
List of restricted groups. For more information on each group, refer to the
man page for the "vserver cifs group-policy restricted-group show-applied"
command. Each group specifies two properties for restricted groups.
The "Members" list defines who belongs and who does not belong to the
restricted group. The "MemberOf" list ensures that the restricted group is
added to the groups listed in "MemberOf" field. A group can be a member of
groups other than those listed in "MembersOf" section.
Central Access Policy Settings:
Policies:
Specifies a list of central access policies. Central access policies and
rules determine access permissions for multiple files on the Vserver.
Parameters
| [-instance ] }
2089
all entries.
If you specify this parameter, the command displays only group policy information that
has been applied to the Vserver you specify.
[-gpo-index <integer>] - GPO Index
If you specify this parameter, the command displays only group policy information at
gpo-index.
Examples
The following example displays all group policy information about all group policies that
have been applied to a Vserver:
cluster1::> vserver cifs group-policy show-applied
Vserver: vs1
----------------------------GPO Name: Default Domain Policy
Level: Domain
Status: enabled
Object Access:
Central Access Policy Staging: failure
Registry Settings:
Refresh Time Interval: 22
Refresh Random Offset: 8
Hash Publication Mode for BranchCache: per-share
Hash Version Support for BranchCache: all-versions
Security Settings:
Audit Logon Events: none
Audit Object Access: success
Log Retention Method: overwrite-as-needed
Max Log Size: 16384
File Security:
/vol1/home
/vol1/dir1
Kerberos:
2090
Max Clock Skew: 5

Max Ticket Age: 10
Max Renew Age:
Privilege Rights:
Take Ownership: usr1, usr2
Security Privilege: usr1, usr2
Change Notify: usr1, usr2
Registry Values:
Signing Required: false
Restrict Anonymous:
No enumeration of SAM accounts: true
No enumeration of SAM accounts and shares: false
Restrict anonymous access to shares and named pipes: true
Combined restriction for anonymous user: no-access
Restricted Groups:
gpr1
gpr2
Policies: cap1
cap2
GPO Name: Resultant Set of Policy
Level: RSOP
Object Access:
Registry Settings:
Hash Version Support for BranchCache: all-versions
Security Settings:
Max Log Size: 16384
File Security:
/vol1/home
/vol1/dir1
Kerberos:
2091
Max Clock Skew: 5

Max Ticket Age: 10
Max Renew Age:
Privilege Rights:
Registry Values:
Restrict Anonymous:
Restricted Groups:
gpr1
gpr2
Policies: cap1
cap2
2092
vserver cifs group-policy show-defined

Show applicable group policy settings defined in Active Directory
Description
The vserver cifs group-policy show-defined command displays information
about group policies that have been defined in Active Directory. It displays all or a
subset of the group policy configuration matching the criteria that you specify.
about all group policies defined in Active Directory:
GPO Name: Specifies the name of the Group Policy object.
Level: Specifies the level in which the Group Policy is configured. It could be
either site level, domain level, or OU level.
Status: Specifies whether or not this Group Policy object is enabled.
Object Access:
Central Access Policy Staging: Specifies the type of events to be audited for
central access policy staging. Possible values are:
Registry Settings:
Refresh Time Interval: Specifies how often the Group Policy is updated.
Refresh Random Offset: Specifies a random time that is added to the
refresh interval to prevent all clients from requesting Group Policy updates
at the same time.
2093
Hash Publication Mode for BranchCache: Specifies the hash generation

mode used to generate hashes for data stored in shared folders on which
BranchCache is enabled, which is then provided to clients. Possible values
are:
per-share - Allow hash publication only for shared folders on which
BranchCache is enabled.
disabled - Disallow hash publication on all shared folders.
all-shares - Allow hash publication for all shared folders.
Hash Version Support for BranchCache: Specifies the version supported by
the BranchCache hash generation service. Possible values are:
all-versions - Both versions 1 and 2 (V1 and V2).
Security Settings:
Audit Logon Events: Specifies the type of logon events to be audited.

Audit Object Access: Specifies the type of object access to be audited.
2094
Log Retention Method: Specifies the audit log retention method. Possible
values are:
overwrite-as-needed - Overwrite the event log when size of the log file
exceeds the maximum log size.
overwrite-by-days - Not supported.
do-not-overwrite - Do not overwrite the event log.
Max Log Size: Specifies the maximum size of the audit log. This size is
displayed in kbytes.
File Security: Specifies a list of files or directories on which file security is to be
applied.
Kerberos:
Max Clock Skew: Specifies maximum tolerance in hours for computer clock
synchronization.
Max Ticket Age: Specifies maximum lifetime in minutes for user ticket.
Max Renew Age: Specifies maximum lifetime in days for user ticket
renewal.
Privilege Rights:
Take Ownership: List of users and groups that have the right to take
ownership of any securable object in the system.
Security Privilege: List of users and groups that can specify auditing options
for object access of individual resources, such as files, folders, and Active
Directory objects.
Change Notify: List of users and groups that can traverse directory trees
even though the users and groups might not have permissions on the
traversed directory.
Registry Values:
Signing Required: Specifies whether SMB signing is on or off.
Restrict Anonymous:
2095
No enumeration of Security Account Manager (SAM) accounts: This

security setting determines what additional permissions are granted for
anonymous connections to the computer. This option displays as 'noenumeration' in Data ONTAP if enabled.
No enumeration of SAM accounts and shares: This security setting
determines whether anonymous enumeration of SAM accounts and shares
is allowed. This option displays as 'no-enumeration' in Data ONTAP if
enabled.
Restrict anonymous access to shares and named pipes: This security
setting restricts anonymous access to shares and pipes. This option
displays as 'no-access' in Data ONTAP if enabled.
Combined restriction for anonymous user: The combined restriction for the
anonymous user is derived from the above three settings:
If 'no-access' is enabled, 'Combined restriction for anonymous user'
is set to 'no-access'. The anonymous user is denied access to the
specificd shares and named pipes, and cannot use enumeration of
SAM accounts and shares.
If 'no-enumeration' is enabled and 'no-access' is disabled, 'Combined
restriction for anonymous user' is set to 'no-enumeration'. The
anonymous user has access to the specified shares and named
pipes, but cannot use enumeration of SAM accounts and shares.
If 'no-enumeration' is disabled and 'no-access' is disabled, 'Combined
restriction for anonymous user' is set to 'no-restriction'. The
anonymous user has full access and can use enumeration.
Restricted Groups:
List of restricted groups. For more information on each group, refer to the
man page for the "vserver cifs group-policy restricted-group show-defined"
command. Each group specifies two properties for restricted groups.
The "Members" list defines who belongs and who does not belong to the
restricted group. The "MemberOf" list ensures that the restricted group is
added to the groups listed in "MemberOf" field. A group can be a member of
groups other than those listed in "MembersOf" section.
2096
Policies:
Specifies a list of central access policies. Central access policies and
rules determine access permissions for multiple files on the Vserver.
Parameters
| [-instance ] }
all entries.
If you specify this parameter, the command displays only group policy information that
has been defined in Active Directory for the Vserver that you specify.
[-gpo-index <integer>] - GPO Index
If you specify this parameter, the command displays only group policy information at
gpo-index.
Examples
The following example displays all group policy information for all group policies that
have been defined in Active Directory:
cluster1::> vserver cifs group-policy show-defined
Vserver: vs1
----------------------------GPO Name: Default Domain Policy
Level: Domain
Status: enabled
Object Access:
Registry Settings:
2097

Hash Version Support for BranchCache : version1
Security Settings:
Max Log Size: 16384
File Security:
/vol1/home
/vol1/dir1
Kerberos:
Max Clock Skew: 5
Max Ticket Age: 10
Max Renew Age:
Privilege Rights:
Registry Values:
Restrict Anonymous:
Restricted Groups:
gpr1
gpr2
Policies: cap1
cap2
GPO Name: Resultant Set of Policy
Status: enabled
Object Access:
Registry Settings:
2098
Hash Publication for Mode BranchCache: per-share

Hash Version Support for BranchCache: version1
Security Settings:
Max Log Size: 16384
File Security:
/vol1/home
/vol1/dir1
Kerberos:
Max Clock Skew: 5
Max Ticket Age: 10
Max Renew Age:
Privilege Rights:
Registry Values:
Restrict Anonymous:
Restricted Groups:
gpr1
gpr2
Policies: cap1
cap2
2099
vserver cifs group-policy show

Show group policy configuration
Description
The vserver cifs group-policy show command displays information about
group policy configuration for CIFS-enabled Vserver. It displays all or a subset of the
group policy configuration matching the criteria that you specify.
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays group policy configuration only for
the Vserver that you specify.
[-status {enabled|disabled}] - Group Policy Status
If you specify this parameter, the command displays group policy configuration only for
the Vservers that match the status you specify.
Examples
The following example displays group policy configuration for all Vservers:
cluster1::> vserver cifs group-policy show
Vserver
2100
GPO Status
--------------
----------
vs1
disabled
vserver cifs group-policy update

Apply group policy settings defined in Active Directory
Description
The vserver cifs group-policy update command applies the group-policy
settings defined in Active Directory for the given Vserver.
Parameters
This parameter specifies the CIFS-enabled Vserver to which the group-policy settings
be applied.
[-force-reapply-all-settings {true|false}] - Force Re-apply All Settings
This parameter specifies whether to ignore all processing optimizations and re-apply all
settings. The default is false.
Examples
The following example applies the group-policy settings defined in Active Directory for
Vserver vs1.
cluster1::> vserver cifs group-policy update -vserver vs1 -force-reapply-allsettings true
vserver cifs group-policy central-access-policy

show-applied
Show currently applied central access policies
Description
2101
The vserver cifs group-policy central-access-policy show-applied

command displays information about the central access policies assigned to Vservers.
command. If you do not specify any parameters, the command displays the following
information about all CIFS servers:
Vserver name
Name of the central access policy
SID
Description
Creation time
Modification time
Member rules
Parameters
| [-instance ] }
all entries.
If you specify this parameter, the command displays information only for central access
policies for the specified Vserver.
[-name <TextNoCase>] - Name
[-sid <windows sid>] - Identifier
policies that match the specified SID.
policies that match the specified description.
2102
[-ctime <Date>] - Creation Time

policies that match the specified creation time.
[-mtime <Date>] - Modification Time
policies that match the specified modification time.
[-rules <TextNoCase>, ...] - Central Access Rules
policies that match the specified member rules.
Examples
The following example displays information for all central access policies:
cluster1::> vserver cifs group-policy central-access-policy show-applied
Vserver
Name
SID
---------- -------------------- ----------------------------------------------vs1

p1
S-1-17-3386172923-1132988875-3044489393-3993546205
Description: policy #1
Creation Time: Tue Oct 22 09:34:13 2013
Modification Time: Wed Oct 23 08:59:15 2013
Member Rules: r1
vs1
p2
S-1-17-1885229282-1100162114-134354072-822349040
Modification Time: Thu Oct 31 10:25:32 2013
Member Rules: r1
r2
2103
vserver cifs group-policy central-access-policy

show-defined
Show applicable central access policies defined in the Active Directory
Description
The vserver cifs group-policy central-access-policy show-defined
command displays information about the central access policies that are defined in
the Active Directory. The command output depends on the parameter or parameters
displays the following information about all CIFS servers:
Vserver name
Name of the central access policy
SID
Description
Creation time
Modification time
Member rules
Parameters
| [-instance ] }
all entries.
2104

[-sid <windows sid>] - Identifier
policies that match the specified SID.
policies that match the specified description.
policies that match the specified creation time.
policies that match the specified modification time.
[-rules <TextNoCase>, ...] - Central Access Rules
policies that match the specified member rules.
Examples
The following example displays information for all central access policies:
cluster1::> vserver cifs group-policy central-access-policy show-defined
Vserver
Name
SID
---------- -------------------- ----------------------------------------------vs1

p1
S-1-17-3386172923-1132988875-3044489393-3993546205
Modification Time: Wed Oct 23 08:59:15 2013
Member Rules: r1
vs1
p2
S-1-17-1885229282-1100162114-134354072-822349040
2105
Modification Time: Thu Oct 31 10:25:32 2013

Member Rules: r1
r2
2106
vserver cifs group-policy central-access-rule

show-applied
Show currently applied central access rules
Description
The vserver cifs group-policy central-access-rule show-applied
command displays information about the central access rules assigned to Vservers. The
about all CIFS servers:
Vserver name
Name of the central access rule
Description
Creation time
Modification time
Current permissions
Proposed permissions
Target resources
Parameters
| [-instance ] }
all entries.
2107
rules for the specified Vserver.
rules that match the specified name.
rules that match the specified description.
rules that match the specified creation time.
rules that match the specified modification time.
[-effective <text>] - Effective Security Policy
rules that match the specified effective security policy.
[-proposed <text>] - Proposed Security Policy
rules that match the specified proposed security policy.
[-resource <text>] - Resource Condition
rules that match the specified resource condition.
Examples
The following example displays information for all central access rules:
cluster1::> vserver cifs group-policy central-access-rule show-applied
Vserver
Name
---------- -------------------vs1
r1
Description: rule #1
2108
Modification Time: Tue Oct 22 09:33:48 2013

Current Permissions: O:SYG:SYD:AR(A;;FA;;;WD)
Proposed Permissions: O:SYG:SYD:(A;;FA;;;OW)(A;;FA;;;BA)(A;;FA;;;SY)
vs1
r2

2109
vserver cifs group-policy central-access-rule

show-defined
Show applicable central access rules defined in the Active Directory
Description
The vserver cifs group-policy central-access-rule show-defined
command displays information about the central access rules that are defined in the
Active Directory. The command output depends on the parameter or parameters
displays the following information about all CIFS servers:
Vserver name
Name of the central access rule
Description
Creation time
Modification time
Current permissions
Proposed permissions
Target resources
Parameters
| [-instance ] }
all entries.
2110
rules for the specified Vserver.
rules that match the specified name.
rules that match the specified description.
rules that match the specified creation time.
rules that match the specified modification time.
[-effective <text>] - Effective Security Policy
rules that match the specified effective security policy.
[-proposed <text>] - Proposed Security Policy
rules that match the specified proposed security policy.
[-resource <text>] - Resource Condition
rules that match the specified resource condition.
Examples
The following example displays information for all central access rules:
cluster1::> vserver cifs group-policy central-access-rule show-defined
Vserver
Name
---------- -------------------vs1
r1
2111

vs1
r2

2112
vserver cifs group-policy restricted-group showapplied

Show the applied restricted-group settings.
Description
The vserver cifs group-policy restricted-group show-applied
command displays settings of all the restricted groups applied to a Vserver.
about all the restricted groups applied to all the Vservers in the cluster.
Group Policy Name: Specifies the name of the group policy.
Version: Specifies the version of the group policy.
Link: Specifies the level in which the group policy is configured. Possible values
are:
Local: Group policy is configured in Data ONTAP.
Site: Group policy is configured at the site level in the Domain Controller.
Domain: Group policy is configured at the domain level in the Domain
Controller.
OrganizationalUnit: Group policy is configured at the OU level in the Domain
controller.
RSOP: Resultant set of policies derived from all the group policies defined
at various levels.
Group Name: Specifies the name of a restricted group.
Members: Specifies users and groups who belong to and who do not belong to
the restricted group.
MemberOf: Specifies list of groups to which the restricted group is added. A group
can be a member of groups other than the groups listed here.
Parameters
2113

specify.
| [-instance ] }
about all fields.
If this parameter is specified, the command displays the restricted-group information that
has been applied to the specified Vserver.
If this parameter is specified, the command displays the specified index for the group
policy in the restricted group. The restricted-group information for the group policy at the
specified index.
[-group-name <text>] - Group Name
If this parameter is specified, the command displays the restricted-group information for
the specified group name.
[-group-policy-name <text>] - Group Policy Name
the specified group policy name.
the specified UUID of the group policy.
[-version <integer>] - Version
the specified version of the group policy.
[-link {Local|Site|Domain|OrganizationalUnit|RSOP}] - Link Type
the specified link for the group policy.
[-members <gpoUserGroup>, ...] - Members, List of Users/groups
the specified members of users and groups.
2114
[-member-of <gpoUserGroup>, ...] - MemberOf, List of Groups

the specified member of the group.
Examples
The following example displays information about all restricted groups that have been
applied to a Vserver.
cluster1::> vserver cifs group-policy restricted-group show-applied
Vserver: vs_1
------------Group Policy Name: gpo1
Version: 16
Link: OrganizationalUnit
Group Name: grp1
Members: usr1
MemberOf: GPO\g9
Group Policy Name: Resultant Set of Policy
Version: 0
Link: RSOP
Group Name: grp1
Members: usr1
MemberOf: GPO\g9
2115
vserver cifs group-policy restricted-group showdefined

Show the defined restricted-group settings.
Description
The vserver cifs group-policy restricted-group show-defined
command displays settings of all the restricted groups defined in Domain Controller for a
Vserver.
about all the restricted groups defined in Domain Controller for all the Vservers in the
cluster.
Group Policy Name: Specifies the name of the group policy.
Version: Specifies the version of the group policy.
Link: Specifies the level in which the group policy is configured. Possible values
are:
Local: Group policy is configured in Data ONTAP.
Site: Group policy is configured at the site level in the Domain Controller.
Domain: Group policy is configured at the domain level in the Domain
Controller.
OrganizationalUnit: Group policy is configured at the OU level in the Domain
Controller.
RSOP: Resultant set of policies derived from all the group policies defined
at various levels.
Group Name: Specifies the name of a restricted group.
Members: Specifies users and groups who belong to and who do not belong to
the restricted group.
MemberOf: Specifies list of groups to which the restricted group is added. A group
can be a member of groups other than the groups listed here.
2116
Parameters
specify.
| [-instance ] }
about all fields.
If this parameter is specified, the command displays the restricted-group information that
is defeined in Domain Controller for the specified Vserver.
If this parameter is specified, the command displays the specified index for the group
policy in the restricted group. The restricted-group information for the group policy at the
specified index.
[-group-name <text>] - Group Name
the specified group name.
[-group-policy-name <text>] - Group Policy Name
the specified group policy name.
the specified UUID of the group policy.
[-version <integer>] - Version
the specified version of the group policy.
[-link {Local|Site|Domain|OrganizationalUnit|RSOP}] - Link Type
the specified link for the group policy.
[-members <gpoUserGroup>, ...] - Members, List of Users/groups
2117
the specified members of users and groups.
[-member-of <gpoUserGroup>, ...] - MemberOf, List of Groups
the specified member of the group.
Examples
The following example displays information about all restricted groups that are defined
in Domain Controller for a Vserver.
cluster1::> vserver cifs group-policy restricted-group show-defined
Vserver: vs_1
------------Group Policy Name: gpo1
Version: 16
Link: OrganizationalUnit
Group Name: grp1
Members: usr1
MemberOf: GPO\g9
Group Policy Name: Resultant Set of Policy
Version: 0
Link: RSOP
Group Name: grp1
Members: usr1
MemberOf: GPO\g9
2118
vserver cifs home-directory modify

Modify attributes of CIFS home directories
Description
The vserver cifs home-directory modify command modifies the CIFS home
directory configuration for a CIFS server.
Parameters
This parameter specifies the name of the CIFS server for which you want to modify the
CIFS home directory configuration.
[-is-home-dirs-access-for-admin-enabled {true|false}] - Is Home Directory Access for
Admin Enabled
This optional parameter specifies whether a user with Windows administrative privileges
can connect to another user's home directory. The default value for this parameter is
true.
[-is-home-dirs-access-for-public-enabled {true|false}] - Is Home Directory Access for
Public Enabled (privilege: advanced)
This optional parameter specifies whether any user can connect to another user's home
directory. The default value for this parameter is false.
Examples
The following example modifies the CIFS home directory configuration for the Vserver
"vs1". It enables users with Windows administrative privileges to connect to another
user's home directory, and enables any user to connect to another user's home
directory.
cluster1::> vserver cifs home-directory modify -vserver vs1 -is-home-dirs-accessfor-admin-enabled true
-is-home-dirs-access-for-public-enabled true
2119
vserver cifs home-directory show-user

Display the Home Directory Path for a User
Description
The vserver cifs home-directory show-user command prints the path of a
user's CIFS home directory. Use this command if multiple CIFS home directory paths
exist and you want to see which path holds the user's CIFS home directory.
Parameters
If you specify this parameter, the command displays only the fields that you specify.
| [-instance ] }
all entries.
Use this required parameter to specify the Vserver that contains the home directory of
the user specified with the required -username parameter.
-username <text> - User Name
Use this required parameter to locate the home directory of the specified user. You must
enter this parameter in the following format: user or domain/user.
If you specify this parameter, the command displays information about the user's home
directory with the specified path.
Examples
The following command displays information about the home directory of a user
belonging to a particular Vserver.
cluster1::> vserver cifs home-directory show-user -vserver vs1 -username user1
2120
Vserver
User
Home Dir Path
-----------
-------------------
---------------------------------
vs1
user1
/home/user1
2121
vserver cifs home-directory show

Display home directory configurations
Description
The vserver cifs home-directory show command displays the CIFS home
directory configuration for one or more Vservers.
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays CIFS home directory configuration
for the specified Vserver.
[-is-home-dirs-access-for-admin-enabled {true|false}] - Is Home Directory Access for
Admin Enabled
If you specify this parameter, the command displays home directory configuration for
CIFS servers that have the specified setting.
[-is-home-dirs-access-for-public-enabled {true|false}] - Is Home Directory Access for
Public Enabled (privilege: advanced)
If you specify this parameter, the command displays home directory configuration for
CIFS servers that have the specified setting.
Examples
The following example lists the CIFS home directory configuration for a Vserver on the
cluster.
2122
cluster1::> vserver cifs home-directory show -vserver vs1

Vserver: vs1
Is Home Directory Access for Admin Enabled: true
At the advanced privilege level or above, the output displays the information below:
cluster1::*> vserver cifs options show
Vserver: vs1
Is Home Directory Access for Admin Enabled: true
Is Home Directory Access for Public Enabled: false
2123
vserver cifs home-directory search-path add

Add a home directory search path
Description
The vserver cifs home-directory search-path add command adds a search
path to a CIFS home directory configuration.
Parameters
This parameter specifies the CIFS-enabled Vserver containing the CIFS home directory
configuration to which you want to add the search path.
-path <text> - Path
This parameter specifies the search path you want to add.
Examples
The following example adds the path /home1 to the CIFS home directory configuration
on Vserver vs1.
cluster1::> vserver cifs home-directory search-path add -vserver vs1 -path /home1
vserver cifs home-directory search-path remove

Remove a home directory search path
Description
The vserver cifs home-directory search-path remove command removes
a search path from a CIFS home directory configuration.
2124
Parameters
This parameter specifies the CIFS-enabled Vserver containing the CIFS home directory
configuration from which you want to remove the search path.
-path <text> - Path
This parameter specifies the search path you want to remove.
Examples
The following example removes the path /home1 from the CIFS home directory
configuration on Vserver vs1.
cluster1::> vserver cifs home-directory search-path remove -vserver vs1 -path /
home1
vserver cifs home-directory search-path reorder

Change the search path order used to find a match
Description
The vserver cifs home-directory search-path reorder command moves
a search path to a new position in the search path order in the CIFS home directory
configuration for the CIFS-enabled Vserver.
Parameters
This parameter specifies the CIFS enabled Vserver for which you want to reorder
searches.
-path <text> - Path
This parameter specifies the search path you want to move.
-to-position <integer> - Target Position
This parameter specifies the new position of the search path in the search path order.
2125
Examples
The following example moves the search path /home1 to position 1 in the search path
order for the CIFS home directory configuration on Vserver vs1.
cluster1::> vserver cifs home-directory search-path reorder -vserver vs1 -path /
home1 -to-position 1
vserver cifs home-directory search-path show

Display home directory search paths
Description
The vserver cifs home-directory search-path show command displays
information about the search paths that are in the home directory configuration for the
CIFS-enabled Vservers.
Parameters
If you specify this parameter, the command only displays the fields that you specify.
| [-instance ] }
all entries.
If you specify this parameter, the command displays home directory configuration for the
CIFS-enabled Vserver that you specify.
If you specify this parameter, the command displays information only for the search path
that you specify.
Examples
The following example displays information about search paths for all CIFS home
directories on all CIFS-enabled Vservers:
2126
cluster1::> vserver cifs home-directory search-path show

Vserver
Position Path
----------- -------- ----------------vs1
/home1
vs2
/home2
vserver cifs netbios-alias prepare-to-downgrade

Remove NetBIOS aliases from Data ONTAP 8.3 before reverting to Data ONTAP 8.2.2
and earlier versions
privilege level.
Description
The vserver cifs netbios-alias prepare-to-downgrade removes the
NetBIOS aliases for all the CIFS servers from Data ONTAP 8.3 before reverting to Data
ONTAP 8.2.2 and earlier versions
Parameters
None
Examples
cluster1::*> vserver cifs netbios-alias prepare-to-downgrade
vserver cifs options modify

Modify CIFS options
Description
The vserver cifs options modify command modifies CIFS options for a CIFS
server.
2127
Parameters
This parameter specifies the name of the CIFS server for which you want to modify
CIFS options.
[-default-unix-user <text>] - Default UNIX User
This optional parameter specifies the name of the default UNIX user for the CIFS server.
[-read-grants-exec {enabled|disabled}] - Read Grants Exec for Mode Bits
This optional parameter specifies whether the CIFS server does read grant execution for
mode bits.
[-wins-servers <InetAddress>, ...] - Windows Internet Name Service (WINS) Addresses
This optional parameter specifies a list of Windows Internet Name Server (WINS)
addresses for the CIFS server. You must specify the WINS servers using an IP address.
You can enter multiple WINS addresses as a comma-delimited list.
Note:
Use an IPv4 address because WINS over IPv6 is not supported.
[-smb2-enabled {true|false}] - Enable all SMB2 Protocols (privilege: advanced)
This optional parameter specifies whether the CIFS server negotiates the SMB 2
version of the CIFS protocol. The default value for this parameter is true. This parameter
is not supported for Vservers with Infinite Volume.
[-smb3-enabled {true|false}] - Enable SMB3 Protocol (privilege: advanced)
This optional parameter specifies whether the CIFS server negotiates the SMB 3
version of the CIFS protocol. The default value for this parameter is true. This parameter
is not supported for Vservers with Infinite Volume.
[-max-mpx <integer>] - Maximum Simultaneous Operations per TCP Connection
This optional parameter specifies the maximum number of simultaneous operations the
CIFS server reports it can process per TCP connection.
[-shadowcopy-dir-depth <integer>] - Maximum Depth of Directories to Shadow Copy
This optional parameter specifies the maximum depth of directories on which to create
shadow copies in the CIFS server. The default for this parameter is 5. The value 0
2128
indicates that all sub-directories should be shadow copied. This parameter is not
supported for Vservers with Infinite Volume.
[-copy-offload-enabled {true|false}] - Enable Copy Offload Feature (privilege:
advanced)
This optional parameter enables the Copy Offload feature in the CIFS server. If set to
false, the Copy Offload feature is disabled. The default for this parameter is true. This
parameter is not supported for Vservers with Infinite Volume.
[-is-copy-offload-direct-copy-enabled {true|false}] - Is Direct-copy Copy Offload
Mechanism Enabled (privilege: advanced)
This optional parameter enables the direct-copy mechanism for ODX copy offload in the
CIFS server. If set to false, the direct-copy mechanism is disabled. The default for this
parameter is true. This parameter is not supported for Vservers with Infinite Volume.
The direct-copy mechanism increases the performance of the copy offload operation
when Windows clients try to open the source file of a copy in a mode that prevents the
file being changed while the copy is in progress. If turned off, regular copy offloading
takes place.
[-default-unix-group <text>] - Default UNIX Group
This optional parameter specifies the name of the default UNIX group for the CIFS
server. If you do not specify a default UNIX group, the CIFS ACL to NFSv4 ACL
translation may result in incomplete NFSv4 ACL information. This parameter is not
supported by Vservers with FlexVol volumes.
[-shadowcopy-enabled {true|false}] - Enable Shadow Copy Feature (VSS) (privilege:
advanced)
When set to true, this optional parameter enables the Shadow Copy (VSS) feature in the
CIFS server. If set to false, the Shadow Copy (VSS) feature is disabled. The default for
this parameter is true. This parameter is not supported for Vservers with Infinite Volume.
[-is-referral-enabled {true|false}] - Refer Clients to More Optimal LIFs (privilege:
advanced)
This optional parameter specifies whether the CIFS server automatically refers clients
to a data LIF local to the node which hosts the root of the requested share. The default
value for this parameter is false. This parameter is not supported for Vservers with
Infinite Volume.
[-is-local-auth-enabled {true|false}] - Is Local User Authentication Enabled (privilege:
advanced)
This optional parameter specifies whether local user authentication is enabled for the
CIFS server.
2129
[-is-local-users-and-groups-enabled {true|false}] - Is Local Users and Groups Enabled

This optional parameter specifies whether the local users and groups feature is enabled
for the CIFS server.
[-is-use-junctions-as-reparse-points-enabled {true|false}] - Is Reparse Point Support
Enabled (privilege: advanced)
This optional parameter specifies whether the CIFS server exposes junction points to
Windows clients as reparse points. The default value for this parameter is true. This
parameter is only active if the client has negotiated use of the SMB 2 or SMB 3 protocol.
This parameter is not supported for Vservers with Infinite Volume.
[-is-exportpolicy-enabled {true|false}] - Is Export Policies for CIFS Enabled (privilege:
advanced)
This optional parameter specifies whether the CIFS server uses export policies to
control client access. The default value for this parameter is false.
[-is-unix-nt-acl-enabled {true|false}] - Is NT ACLs on UNIX Security-style Volumes
This optional parameter specifies whether the CIFS server has the NT ACLs enabled on
UNIX security-style volumes. The default value for this parameter is true.
[-is-trusted-domain-enum-search-enabled {true|false}] - Is Enumeration of Trusted
Domain and Search Capability Enabled (privilege: advanced)
This optional parameter specifies whether the CIFS server supports enumeration of
bidirectional trusted domains and supports searching in all the bidirectional trusted
domains when performing Windows user lookups for UNIX user to Windows user name
mapping. The default value is true.
[-client-session-timeout <integer>] - Idle Timeout Before CIFS Session Disconnect
(secs)
This optional parameter specifies the amount of idle time (in seconds) before a CIFS
session is disconnected. The default value for this parameter is 900 seconds.
[-is-dac-enabled {true|false}] - Is Dynamic Access Control (DAC) Enabled (privilege:
advanced)
When set to true, this optional parameter enables the Dynamic Access Control (DAC)
feature in the CIFS server. If set to false, the Dynamic Access Control (DAC) feature
is disabled. The default for this parameter is false. This parameter is not supported for
2130
[-restrict-anonymous {no-restriction|no-enumeration|no-access}] - Restrictions for

Anonymous User (privilege: advanced)
This optional parameter controls the access restrictions of non-authenticated sessions
and applies the restrictions for the anonymous user based on the permitted values. The
default value for this parameter is no-restriction. Permitted values for this option are:
no-restriction - This option specifies no access restriction for anonymous users
(default).
no-enumeration - This option specifies that only enumeration is restricted.
no-access - This option specifies that access is restricted for anonymous users.
[-is-read-only-delete-enabled {enabled|disabled}] - Is Deletion of Read-Only Files
Enabled
This optional parameter controls deletion of read-only files and directories. NTFS delete
semantics forbid deletion of a file or directory when the read-only attribute is set. UNIX
delete semantics ignore it, focusing instead on parent directory permissions, which
some applications require. This option is used to select the desired behavior. By default
this option is disabled, yielding NTFS behavior.
[-file-system-sector-size {512|4096 (in bytes)}] - Size of File System Sector Reported
to SMB Clients (bytes) (privilege: advanced)
This optional parameter specifies the size of file system sector reported to SMB clients
(in bytes). The default value for this parameter is 4096. Valid values are 512 and 4096.
[-is-fake-open-enabled {true|false}] - Is Fake Open Support Enabled (privilege:
advanced)
This optional parameter specifies whether the CIFS server supports fake open requests.
This parameter allows you to optimize the open and close requests coming from SMB 2
clients. The default value for this parameter is true.
[-is-unix-extensions-enabled {true|false}] - Is UNIX Extensions Enabled (privilege:
advanced)
When set to true, this optional parameter enables the UNIX Extensions feature in the
CIFS server. If set to false, the UNIX Extensions feature is disabled. The default for this
parameter is false. UNIX Extensions allows POSIX/UNIX style security to be displayed
through the CIFS protocol.
[-is-search-short-names-enabled {true|false}] - Is Search Short Names Support
2131
This optional parameter specifies whether the CIFS server supports searching short
names. A search query with this option enabled will try to match 8.3 file names along
with long file names. The default value for this parameter is false.
[-is-advertise-dfs-enabled {true|false}] - Enable DFS Referral Advertisement (privilege:
advanced)
This optional parameter specifies whether to advertise DFS referral of the CIFS
protocol. The default value for this parameter is true. This option is not applicable to
SMB 1.
Examples
The following example modifies CIFS options for the Vserver "vs1". It changes the
default UNIX user, disables read grants exec, disables SMB2.x, changes maximum
multiplex count to 1124, changes the file system sector size reported to SMB clients
to 512, disables the direct-copy offload mechanism for ODX copy offload, enables
the UNIX Extensions feature, disables fake open requests changes WINS servers to
192.168.11.112 and changes the client session timeout to 6000.
cluster1::> vserver cifs options modify -vserver vs1 -default-unix-user
pcuser -read-grants-exec disabled
-smb2-enabled false -max-mpx 1124
-file-system-sector-size 512 -is-copy-offload-direct-copy-enabled false

-is-unix-extensions-enabled true -is-fake-open-enabled false, -wins-servers
192.168.11.112 -client-session-timeout 6000
2132
vserver cifs options prepare-to-downgrade

Restore the CIFS restrict_anonymous settings for releases earlier than Data ONTAP
8.2.2
privilege level.
Description
The vserver cifs options prepare-to-downgrade disables the CIFS
restrict_anonymous values for releases earlier than Data ONTAP 8.2.2. Run this
command before downgrading to a release earlier than 8.2.2.
Parameters
None
Examples
cluster1::*> vserver cifs options prepare-to-downgrade
vserver cifs options show

Display CIFS options
Description
The vserver cifs options show command displays the CIFS configuration
options for one or more Vservers.
Parameters
2133
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command only displays CIFS options for the specified
Vserver.
[-default-unix-user <text>] - Default UNIX User
If you specify this parameter, the command only displays CIFS options for the specified
default UNIX user.
[-read-grants-exec {enabled|disabled}] - Read Grants Exec for Mode Bits
If this parameter is set to enabled, the command displays options for CIFS servers that
grant execution access when granting read access using mode bits. If set to disabled,
the command displays options for CIFS servers that do not grant execution access
when granting read access using mode bits.
[-wins-servers <InetAddress>, ...] - Windows Internet Name Service (WINS) Addresses
If you specify this parameter, the command displays CIFS options only for CIFS servers
that use the specified Windows Internet Name Server (WINS) addresses.
[-smb2-enabled {true|false}] - Enable all SMB2 Protocols (privilege: advanced)
If this parameter is set to true, the command displays options for CIFS servers where
SMB 2 version of the CIFS protocol is negotiated. If set to false, the command displays
options for CIFS servers where SMB 2 version of the CIFS protocol is not negotiated.
[-smb3-enabled {true|false}] - Enable SMB3 Protocol (privilege: advanced)
If this parameter is set to true, the command displays options for CIFS servers where
SMB 3 version of the CIFS protocol is negotiated. If set to false, the command displays
options for CIFS servers where SMB 3 version of the CIFS protocol is not negotiated.
[-max-mpx <integer>] - Maximum Simultaneous Operations per TCP Connection
If you specify this parameter, the command displays the maximum number of
simultaneous operations the CIFS server reports it can process per TCP connection.
[-shadowcopy-dir-depth <integer>] - Maximum Depth of Directories to Shadow Copy
2134
If you specify this parameter, the command displays options only for CIFS servers that
are configured with the specified depth of directories on which to create shadow copies.
[-copy-offload-enabled {true|false}] - Enable Copy Offload Feature (privilege:
advanced)
If set to true, this command displays options only for CIFS servers where the Copy
Offload feature is enabled. If set to false, options are displayed for CIFS servers where
the Copy Offload feature is disabled.
[-is-copy-offload-direct-copy-enabled {true|false}] - Is Direct-copy Copy Offload
Mechanism Enabled (privilege: advanced)
If set to true, this command displays options only for CIFS servers where the direct-copy
mechanism for ODX Copy Offload is enabled. If set to false, options are displayed for
CIFS servers where the direct- copy offload mechanism is disabled.
The direct-copy mechanism increases the performance of the copy offload operation
when Windows clients try to open the source file of a copy in a mode that prevents the
file being changed while the copy is in progress. If turned off, regular copy offloading
takes place.
[-default-unix-group <text>] - Default UNIX Group
If you specify this parameter, the command displays CIFS options only for the specified
default UNIX group.
[-shadowcopy-enabled {true|false}] - Enable Shadow Copy Feature (VSS) (privilege:
advanced)
If set to true, this command displays options only for CIFS servers where the Shadow
Copy (VSS) feature is enabled. If set to false, options are displayed for CIFS servers
where the Shadow Copy (VSS) feature is disabled.
[-is-referral-enabled {true|false}] - Refer Clients to More Optimal LIFs (privilege:
advanced)
If you specify this parameter, the command displays whether the CIFS server
automatically refers clients to a data LIF local to the node which hosts the root of the
requested share.
[-is-local-auth-enabled {true|false}] - Is Local User Authentication Enabled (privilege:
advanced)
If this parameter is set to true, the command displays CIFS options only for CIFS
servers where local user authentication is enabled. If set to false, the command displays
options for CIFS servers where local user authentication is disabled.
2135
[-is-local-users-and-groups-enabled {true|false}] - Is Local Users and Groups Enabled

servers where the local users and groups feature is enabled. If set to false, the
command displays options for CIFS servers where the local users and groups feature is
disabled.
[-is-use-junctions-as-reparse-points-enabled {true|false}] - Is Reparse Point Support
If you specify this parameter, the command only displays CIFS options for Vservers
which have the specified reparse point setting.
[-is-exportpolicy-enabled {true|false}] - Is Export Policies for CIFS Enabled (privilege:
advanced)
If you specify this parameter, the command only displays CIFS options for Vservers
which have the specified export policy setting.
[-is-unix-nt-acl-enabled {true|false}] - Is NT ACLs on UNIX Security-style Volumes
If this parameter is set to true, the command only displays CIFS options for Vservers
that have the NT ACLs on UNIX security-style volumes enabled. If set to false, the
command displays CIFS options for Vservers that have the NT ACLS on UNIX securitystyle volumes disabled.
[-is-trusted-domain-enum-search-enabled {true|false}] - Is Enumeration of Trusted
Domain and Search Capability Enabled (privilege: advanced)
servers that support enumeration of bidirectional trusted domains and that support
searching in all bidirectional trusted domains when performing Windows user lookups
for UNIX user to Windows user name mapping. If set to false, the command displays
options for CIFS servers that do not support enumeration of bidirectional trusted
domains.
[-client-session-timeout <integer>] - Idle Timeout Before CIFS Session Disconnect
(secs)
are configured with the specified client session timeout value (in seconds).
[-is-dac-enabled {true|false}] - Is Dynamic Access Control (DAC) Enabled (privilege:
advanced)
2136
If set to true, this command displays options only for CIFS servers where the Dynamic
Access Control (DAC) feature is enabled. If set to false, options are displayed for CIFS
servers where the Dynamic Access Control (DAC) feature is disabled.
[-restrict-anonymous {no-restriction|no-enumeration|no-access}] - Restrictions for
Anonymous User (privilege: advanced)
If you specify this parameter, the command displays CIFS options only for CIFS servers
that have the specified permitted value for the anonymous user. Permitted values for
this option are:
no-restriction - There is no access restriction for anonymous users.
no-enumeration - Only enumeration is restricted.
no-access - Access is restricted for anonymous users.
[-is-read-only-delete-enabled {enabled|disabled}] - Is Deletion of Read-Only Files
Enabled
have the specified is-read-only-delete-enabled setting.
[-file-system-sector-size {512|4096 (in bytes)}] - Size of File System Sector Reported
to SMB Clients (bytes) (privilege: advanced)
are configured with the specified file system sector size (in bytes).
[-is-fake-open-enabled {true|false}] - Is Fake Open Support Enabled (privilege:
advanced)
If you set this parameter to true, the command displays options for CIFS servers where
fake open is enabled. If set to false, the command displays options for CIFS servers
where fake open is disabled.
[-is-unix-extensions-enabled {true|false}] - Is UNIX Extensions Enabled (privilege:
advanced)
If set to true, this command displays options only for CIFS servers where the UNIX
Extensions feature is enabled. If set to false, options are displayed for CIFS servers
where the UNIX Extensions feature is disabled. UNIX Extensions allows POSIX/UNIX
style security to be displayed through the CIFS protocol.
[-is-search-short-names-enabled {true|false}] - Is Search Short Names Support
2137
If you set this parameter to true, the command displays options for CIFS servers where
search short names is enabled. If set to false, the command displays options for CIFS
servers where search short names is disabled.
[-is-advertise-dfs-enabled {true|false}] - Enable DFS Referral Advertisement (privilege:
advanced)
servers where DFS referral advertisement is enabled. If set to false, the command
displays options for CIFS servers where DFS referral advertisement is disabled. This
option is not applicable to SMB 1.0.
Examples
The following example lists CIFS options for a Vserver on the cluster.
cluster1::> vserver cifs options show
Vserver: vs1
Client Session Timeout: 900
Default Unix Group: Default Unix User: pcuser
Read Grants Exec: disabled
WINS Servers: -
At the advanced level, the output displays the information below.

cluster1::*> vserver cifs options show
Vserver: vs1
Client Session Timeout: 900
Copy Offload Enabled: true
Default Unix Group: Default Unix User: pcuser
Direct-Copy Copy Offload Enabled : true
Export Policies Enabled: false
Is Advertise DFS Enabled: true
Is DAC Enabled: false
Is Fake Open Support Enabled: true
Is Local Auth Enabled: true
Is Local Users and Groups Enabled: true
Is Referral Enabled: false
Is Search Short Names Support Enabled: false
2138
Is Trusted Domain Enumeration And Search Enabled: true

Is UNIX Extensions Enabled: false
Is Use Junction as Reparse Point Enabled: true
Max Multiplex Count: 255
NT ACLs on UNIX Security Style Volumes Enabled: true
Read Grants Exec: disabled
Read Only Delete: enabled
Reported File System Sector Size : 4096
Shadowcopy Dir Depth: 5
Shadowcopy Enabled: true
SMB2 Enabled: true
SMB3 Enabled: true
WINS Servers: -
2139
vserver cifs security modify

Modify CIFS security settings
Description
The vserver cifs security modify command modifies CIFS server security
settings.
Parameters
This parameter specifies the name of the Vserver whose CIFS security settings you
want to modify.
[-kerberos-clock-skew <integer>] - Maximum Allowed Kerberos Clock Skew
This parameter specifies the maximum allowed Kerberos ticket clock skew in minutes.
The default is 5 minutes.
[-kerberos-ticket-age <integer>] - Kerberos Ticket Lifetime
This parameter specifies the Kerberos ticket lifetime in hours. The default is 10 hours.
[-kerberos-renew-age <integer>] - Maximum Kerberos Ticket Renewal Days
This parameter specifies the maximum Kerberos ticket renewal lifetime in days. The
default is 7 days.
[-is-signing-required {true|false}] - Require Signing for Incoming CIFS Traffic
This parameter specifies whether signing is required for incoming CIFS traffic. The
default is false.
[-is-password-complexity-required {true|false}] - Require Password Complexity for
Local User Accounts
This parameter specifies whether password complexity is required for CIFS local users.
If this parameter is set to true, password complexity is required. If the value is set to
false, password complexity is not required. The default is true.
[-use-start-tls-for-ad-ldap {true|false}] - Use start_tls For AD LDAP Connections
2140
This parameter specifies whether or not to use Start TLS over AD LDAP connections.
When enabled, the communication between the Data ONTAP LDAP Client and the
LDAP Server will be encrypted using Start TLS. Start TLS is a mechanism to provide
secure communication by using the TLS/SSL protocols. If you do not specify this
parameter, the default is false.
[-is-aes-encryption-enabled {true|false}] - Is AES-128 and AES-256 Encryption
Enabled
This parameter specifies whether or not to use Kerberos AES-128 and AES-256
encryption types for authentication. When enabled and depending on negotiation with
the KDC service, it is possible for authentication operations to utilize these encryption
types. If you do not specify this parameter, the default is false.
[-lm-compatibility-level {lm-ntlm-ntlmv2-krb|ntlm-ntlmv2-krb|ntlmv2-krb|krb}] - LM
Compatibility Level
This parameter specifies the LM compatibility level. The default is "lm-ntlm-ntlmv2krb" (LM, NTLM, NTLMv2 and Kerberos).
Examples
The following example makes the following changes: the Kerberos clock skew is set to 3
minutes, the Kerberos ticket lifetime to 8 hours and it makes signing required for Vserver
"vs1".
cluster1::> vserver cifs security modify -vserver vs1 -kerberos-clock-skew 3 kerberos-ticket-age 8 -is-signing-required true
cluster1::> vserver cifs security show
Vserver: vs1
Kerberos Clock Skew:
3 minutes
Kerberos Ticket Age:
8 hours
Kerberos Renewal Age:
7 days
Is Signing Required:
true
Is Password Complexity Required:
true
Use start_tls For AD LDAP connection:
false
Is AES Encryption Enabled:
false
LM Compatibility Level:
krb
2141
See Also
vserver cifs security show vserver cifs users-and-groups local-user create
vserver cifs users-and-groups local-user set-password
2142
vserver cifs security show

Display CIFS security settings
Description
The vserver cifs security show command displays information about CIFS
server security settings.
Parameters
If you specify the -fields parameter, the command only displays the fields that you
specify.
| [-instance ] }
about all fields.
This parameter specifies the name of the Vserver whose CIFS security settings you
want to display.
[-kerberos-clock-skew <integer>] - Maximum Allowed Kerberos Clock Skew
If this parameter is specified, the command displays information only about the security
settings that match the specified Kerberos ticket clock skew.
[-kerberos-ticket-age <integer>] - Kerberos Ticket Lifetime
settings that match the specified Kerberos ticket age.
[-kerberos-renew-age <integer>] - Maximum Kerberos Ticket Renewal Days
settings that match the specified Kerberos renewal age.
[-realm <text>] - Kerberos Realm
settings that match the specified Kerberos realm.
2143
[-kdc-ip <text>, ...] - KDC IP Address

settings that match the specified KDC IP address.
[-kdc-name <text>, ...] - KDC Name
settings that match the specified KDC name.
[-site <text>, ...] - KDC Site
settings that match the specified Windows site.
[-is-signing-required {true|false}] - Require Signing for Incoming CIFS Traffic
This parameter specifies whether signing is required for incoming CIFS traffic. If this
parameter is specified, the command displays information only about the security
settings that match the specified value for is-signing-required.
[-is-password-complexity-required {true|false}] - Require Password Complexity for
Local User Accounts
If this parameter is set to true, the command displays CIFS security configuration
information only for CIFS servers where password complexity for local user accounts
is required. If set to false, the command displays security configuration information for
CIFS servers where password complexity for local user accounts is not required.
[-use-start-tls-for-ad-ldap {true|false}] - Use start_tls For AD LDAP Connections
This parameter specifies whether or not to use Start TLS over AD LDAP connections.
When enabled, the communication between the Data ONTAP LDAP Client and the
LDAP Server will be encrypted using Start TLS. Start TLS is a mechanism to provide
secure communication by using the TLS/SSL protocols. If you do not specify this
parameter, the default is false.
[-is-aes-encryption-enabled {true|false}] - Is AES-128 and AES-256 Encryption
Enabled
If this parameter is set to true, the command displays CIFS security configuration
information only for CIFS servers where AES-128 and AES-256 encryption types are
enabled. If set to false, the command displays security configuration information for
CIFS servers where AES-128 and AES-256 encryption types are disabled.
[-lm-compatibility-level {lm-ntlm-ntlmv2-krb|ntlm-ntlmv2-krb|ntlmv2-krb|krb}] - LM
Compatibility Level
settings that match the specified LM compatibility level.
2144
Examples
The following example displays CIFS server security settings.
cluster1::> vserver cifs security show
Vserver: vs1
Kerberos Clock Skew:
3 minutes
Kerberos Ticket Age:
8 hours
Kerberos Renewal Age:
7 days
Is Signing Required:
true
Is Password Complexity Required:
true
Use start_tls For AD LDAP connection:
false
Is AES Encryption Enabled:
false
LM Compatibility Level:
krb
The following example displays the Kerberos clock skew for all Vservers.
cluster1::> vserver cifs security show -fields kerberos-clock-skew
vserver kerberos-clock-skew
------- ------------------vs1
See Also
vserver cifs security modify
2145
vserver cifs session close

Close an open CIFS session
Description
The vserver cifs session close command closes the specified CIFS sessions.
Parameters
If you specify this parameter, the command will close all the opened CIFS sessions on
the specified node.
If you specify this parameter, the command will close all the opened CIFS sessions on
the specified CIFS-enabled Vserver.
[-session-id <integer>] - Session ID
If you specify this parameter, the command will close the open CIFS session that
matches the specified session ID.
[-connection-id <integer>] - Connection ID
If you specify this parameter, the command will close all the opened CIFS sessions that
match the specified connection ID.
[-lif-address <IP Address>] - Incoming Data LIF IP Address
are established through the specified data LIF IP address.
[-address <IP Address>] - Workstation IP address
are opened from the specified IP address.
[-auth-mechanism <Authentication Mechanism>] - Authentication Mechanism
If you specify this parameter, the command will close all the opened CIFS sessions
that used the specified authentication mechanism. The authentication mechanism can
include one of the following:
2146
NTLMv1 - NTLMv1 authentication mechanism

Kerberos - Kerberos authentication mechanism
Anonymous - Anonymous authentication mechanism
[-windows-user <TextNoCase>] - Windows User
If you specify this parameter, the command will close all the opened CIFS sessions
that are established for the specified CIFS user. The acceptable format for CIFS user is
[domain]\user.
[-unix-user <text>] - UNIX User
are established for the specified UNIX user.
[-protocol-version <CIFS Dialects>] - Protocol Version
are established over the specified version of CIFS protocol. The protocol version can
SMB1 - SMB 1.0
SMB2 - SMB 2.0
SMB2_1 - SMB 2.1
SMB3 - SMB 3.0
[-continuously-available <CIFS Open File Protection>] - Continuously Available
If you specify this parameter, the command will close all the opened CIFS sessions with
open files that have the specified level of continuously available protection. The open
files are "continuously available" if they are opened from an SMB 3 client through a
share with the "continuously_available" property set. These open files are capable of
non-disruptively recovering from takeover and giveback as well as general aggregate
relocation between partners in a high-availability relationship. This is in addition to the
traditional SMB 2 capability allowing clients to recover from LIF migration and other brief
network interruptions.
Note:
The CA protection levels depict the continuous availability at the connection level so it
might not be accurate for a session if the connection has multiple sessions. Streams
opened through a continuously available share are permitted, but are not currently made
continuously available. Directories may be opened through a continuously available
2147
share, but, by design, will not appear continuously available as clients do not open them
that way. These protection levels are applicable to the sessions on read/write volumes
residing on storage failover aggregates.
The continuously available status can be one of the following:
No - The session contains one or more open file but none of them are
continuously available.
Yes - The session contains one or more open files and all of them are
Partial - The session contains at least one continuously available open file but
other open files that are not.
[-is-session-signed {true|false}] - Is Session Signed
are established with the specified SMB signing option.
Examples
The following example closes all open CIFS sessions on all the nodes with protocolversion SMB2:
cluster1::> cifs session close -node * -protocol-version SMB2
The following example closes all open CIFS sessions for all Vservers on node node1:
cluster1::> cifs session close -node node1 -vserver *
vserver cifs session show

Display established CIFS sessions
Description
The vserver cifs session show command displays information about established
CIFS sessions. The command output depends on the parameter or parameters
2148
displays the following information about all CIFS sessions:
Node name
Vserver name
CIFS connection ID
CIFS session ID
Workstation IP address
CIFS user name
CIFS open files
Session idle time
parameters. For example, to display information only about CIFS sessions established
on connection ID 2012, run the command with the -connection-id parameter
set to 2012.
Parameters
| [-instance ] }
If you specify this parameter, the command displays detailed information about matching
CIFS sessions.
If you specify this parameter, the command displays information about the CIFS
sessions on the specified node.
If you specify this parameter, the command displays information about CIFS sessions on
the specified CIFS-enabled Vserver.
If you specify this parameter, the command displays information about the CIFS session
that match the specified session ID.
2149
If you specify this parameter, the command displays information about CIFS sessions
that match the specified connection ID.
[-lif-address <IP Address>] - Incoming Data LIF IP Address
that are established through the specified data LIF IP address.
[-address <IP Address>] - Workstation IP address
that are opened from the specified IP address.
[-auth-mechanism <Authentication Mechanism>] - Authentication Mechanism
that used the specified authentication mechanism. The authentication mechanism can
Kerberos - Kerberos authentication mechanism
Anonymous - Anonymous authentication mechanism
[-windows-user <TextNoCase>] - Windows User
that are established for the specified CIFS user. The acceptable format for CIFS user is
[domain]\user.
[-unix-user <text>] - UNIX User
that are established for the specified UNIX user.
[-shares <integer>] - Open Shares
that have the specified number of CIFS shares opened.
[-files <integer>] - Open Files
that have the specified number of regular CIFS files opened.
[-other <integer>] - Open Other
2150
that have the specified number of special CIFS files opened such as streams or
directories.
[-connected-time <elapsed>] - Connected Time
that are established for the specified time duration.
[-idle-time <elapsed>] - Idle Time
If you specify this parameter, the command displays information about CIFS sessions on
which there is no activity for the specified time duration.
[-protocol-version <CIFS Dialects>] - Protocol Version
that are established over the specified version of CIFS protocol. The protocol version
can include one of the following:
SMB1 - SMB 1.0
SMB2 - SMB 2.0
SMB2_1 - SMB 2.1
SMB3 - SMB 3.0
with open files that have the specified level of continuously available protection. The
open files are "continuously available" if they are opened from an SMB 3 client through
a share with the "continuously_available" property set. These open files are capable of
non-disruptively recovering from takeover and giveback as well as general aggregate
relocation between partners in a high-availability relationship. This is in addition to the
traditional SMB 2 capability allowing clients to recover from LIF migration and other brief
network interruptions.
Note:
The CA protection levels depict the continuous availability at the connection level so it
might not be accurate for a session if the connection has multiple sessions. Streams
opened through a continuously available share are permitted, but are not currently made
continuously available. Directories may be opened through a continuously available
share, but, by design, will not appear continuously available as clients do not open them
that way. These protection levels are applicable to the sessions on read/write volumes
residing on storage failover aggregates.
2151

No - The session contains one or more open file but none of them are
Yes - The session contains one or more open files and all of them are
Partial - The session contains at least one continuously available open file but
other open files that are not.
[-is-session-signed {true|false}] - Is Session Signed
that are established with the specified SMB signing option.
Examples
The following example displays information about all CIFS sessions:
cluster1::> vserver cifs session show
Node:
node1
Vserver: vs1
Connection Session
ID
ID
Workstation
Windows User
Open
Idle
Files
Time
---------- ------- ---------------- ---------------- --------- --------------127834
172.17.193.172
CIFSQA\
22s
Administrator
The following example displays information about a CIFS session with session-id 1.
cluster1::> vserver cifs session show -session-id 1 -instance
Node: node1
Vserver: vs1
Session ID: 1
Connection ID: 127834
Incoming Data LIF IP Address: 10.53.13.224
Workstation: 172.17.193.172
Authentication Mechanism: NTLMv2
Windows User: CIFSQA\Administrator
UNIX User: root
Open Shares: 2
2152
Open Files: 2
Open Other: 0
Connected Time: 2d 17h 58m 5s
Idle Time: 22s
Protocol Version: SMB3
Continuously Available: No
Is Session Signed: true
2153
vserver cifs session file close

Close an open CIFS file
Description
The vserver cifs session file close command closes the specified open
CIFS file.
Parameters
If you specify this parameter, the command will close all the opened CIFS files on the
specified node.
If you specify this parameter, the command will close all the opened CIFS files on the
specified CIFS-enabled Vserver.
[-file-id <integer>] - File ID
If you specify this parameter, the command will close the opened CIFS file that matches
the specified file ID.
If you specify this parameter, the command will close all the opened CIFS files
connected on the specified connection ID.
If you specify this parameter, the command will close all the opened CIFS files
connected on the specified session ID.
Examples
The following example closes all the opened CIFS files that are connected to the data
LIFs of Vserver vs1 on the node node1:
cluster1::> vserver cifs session file close -node node1 -vserver vs1
2154
The following example closes all the opened CIFS files on all the nodes with the file-id 1:
cluster1::> vserver cifs session file close -node * -file-id 1
vserver cifs session file show

Display opened CIFS files
Description
The vserver cifs session file show command displays information about
all open CIFS files. The command output depends on the parameter or parameters
displays the following information about all open CIFS files:
Node name
Vserver name
CIFS connection ID
CIFS session ID
CIFS file ID
CIFS file type
CIFS file open mode
CIFS file hosting volume
CIFS share name
CIFS file path
Continuously available protection level
parameters. For example, to display information only about CIFS files opened on
connection ID 2012, run the command with the -connection-id parameter set
to 2012.
2155
Parameters
| [-instance ] }
If you specify this parameter, the command displays detailed information about matching
open CIFS files.
If you specify this parameter, the command displays information about the open CIFS
files on the specified node.
If you specify this parameter, the command displays information about open CIFS files
on the specified CIFS-enabled Vserver.
[-file-id <integer>] - File ID
If you specify this parameter, the command displays information about the open CIFS
file that match the specified file ID.
that are opened on the specified connection ID.
If you specify this parameter, the command displays information about the CIFS file that
are opened on the specified session ID.
[-file-type <CIFS File Type>] - File Type
If you specify this parameter, the command displays information about opened CIFS
files that are of the specified file type. The file type can be any of these: Regular,
Symlink, Stream, or Directory.
[-open-mode <CIFS Open Mode>] - Open Mode
If you specify this parameter, the command displays information about CIFS files that
are opened with the specified mode. The open mode can include one or more of the
following:
R - This property specifies that the file is opened for read.
W - This property specifies that the file is opened for write.
2156
D - This property specifies that the file is opened for delete.

The open mode can have multiple values specified as a list with no commas.
[-hosting-aggregate <aggregate name>] - Aggregate Hosting File
that reside on the specified aggregate.
[-hosting-volume <volume name>] - Volume Hosting File
that reside on the specified volume.
[-share <Share>] - CIFS Share
If you specify this parameter, the command displays information about CIFS files that
are opened over the specified CIFS share.
[-path <text>] - Path from CIFS Share
that match the specified CIFS file path.
[-share-mode <CIFS Open Mode>] - Share Mode
that are opened with the specified share mode. The share mode can include one or
more of the following:
R - This property specifies that the file is shared for read.
W - This property specifies that the file is shared for write.
D - This property specifies that the file is shared for delete.
The share mode can have multiple values specified as a list with no commas.
[-range-locks <integer>] - Range Locks
that have the specified number of range locks.
If you specify this parameter, the command displays information about open
CIFS files with or without continuously available protection. The open files are
"continuously available" if they are opened from an SMB 3 client through a share
with the "continuously_available" property set. These open files are capable of nondisruptively recovering from takeover and giveback as well as general aggregate
relocation between partners in a high-availability relationship. Streams opened through
2157
a continuously available share are permitted, but are not currently made continuously
available. Directories may be opened through a continuously available share, but, by
design, will not appear continuously available as clients do not open them that way.
These protection levels are applicable to the files on read/write volumes residing on
storage failover aggregates.
No - The open file is not continuously available.
Yes - The open file is continuously available.
[-reconnected <text>] - Reconnected
that have the specified reconnected state. The reconnected state can be one of the
following:
No - The open file is not reconnected.
Yes - The open file is reconnected.
Examples
The following example displays information about all open CIFS files:
cluster1::> vserver cifs session file show
Node:
node1
Vserver:
vs1
Connection: 2192
Session:
File
File
Open Hosting
ID
Type
Mode Volume
Continuously
Share
Available
------- --------- ---- --------------- --------------------- -----------7
Regular
rw
rootvs1
rootca
Yes
Path: \win8b8.txt
The following example displays information about a CIFS file with file-id 7.
cluster1::> vserver cifs session file show -file-id 7 -instance
Node: node1
Vserver: vs1
File ID: 7
2158
Connection ID: 2192

Session ID: 1
File Type: Regular
Open Mode: rw
Aggregate Hosting File: aggr1
Volume Hosting File: rootvs1
CIFS Share: rootca
Path from CIFS Share: \win8b8.txt
Share Mode: rd
Range Locks: 0
Continuously Available: Yes
Reconnected: No
2159
vserver cifs share create

Create a CIFS share
Description
The vserver cifs share create command creates a CIFS share.
Parameters
This parameter specifies the CIFS-enabled Vserver on which you want to create a CIFS
share.
-share-name <Share> - Share
This parameter specifies the name of the CIFS share that you want to create. A share
name can be up to 256 characters long. If this is a home directory share (designated
as such by specifying the homedirectory on the -share-properties parameter),
you can include %w (Windows user name), %u (UNIX user name) and %d (Windows
domain name) variables in any combination with this parameter to generate shares
dynamically,with the resultant share names based on the authenticating user's Windows
user name, UNIX user name, and/or Windows domain name.
-path <text> - Path
This parameter specifies the path to the CIFS share. This path must exist in a volume.
A directory path name can be up to 256 characters long. If there is a space in the
path name, you must enclose the entire string in quotation marks (for example, "/
new volume/mount here"). If this is a home directory share as specified by value of
home directory on the -share-properties parameter, you can make the path
name dynamic by specifying the %w (Windows user name), %u (UNIX user name), or
%d (domain name) variables or any of their combination as a part of the value of this
parameter.
[-share-properties <share properties>, ...] - Share Properties
This optional parameter specifies a list of properties for the share. The list can include
one or more of the following:
homedirectory - This property specifies that the share and path names are
dynamic. Specify this value for a home directory share. In a home directory share,
2160
Data ONTAP can dynamically generate the share's name and path by substituting
%w, %u, and %d variables with the corresponding Windows user name, UNIX
user name, and domain, respectively, specified as the value of the -share-name
and -path parameters. For instance, if a dynamic share is defined with a name of
%d_%w, a user logged on as barbara from a domain named FIN sees the share
as FIN_barbara. Using the homedirectory value specifies that the share and path
names are dynamically expanded. This property cannot be added or removed
after share creation.
oplocks - This property specifies that the share uses opportunistic locks, also
known as client-side caching. Oplocks are enabled on shares by default; however,
some applications do not work well when oplocks are enabled. In particular,
database applications such as Microsoft Access are vulnerable to corruption when
oplocks are enabled. An advantage of shares is that a single path can be shared
multiple times, with each share having different properties. For instance, if a path
named /dept/finance contains both a database and other types of files, you can
create two shares to it, one with oplocks disabled for safe database access and
one with oplocks enabled for client-side caching.
browsable - This property allows Windows clients to browse the share. This is the
default initial property for all shares.
showsnapshot - This property specifies that Snapshot copies can be viewed and
traversed by clients.
changenotify - This property specifies that the share supports ChangeNotify
requests. For shares on a Vserver with FlexVol volumes, this is a default initial
property. For shares on a Vserver with Infinite Volume, the changenotify property
is not set by default, and setting it requires the advanced privilege level. When the
changenotify property is set for a share on a Vserver with Infinite Volume, change
notifications are not sent for changes to file attributes and timestamps.
attributecache - This property enables the file attribute caching on the CIFS share
in order to provide faster access of attributes over SMB 1.0.
Note:
For certain workloads, stale file attribute data could be delivered to a client.
continuously-available - This property permits SMB clients that support it to open
files in a persistent manner. Files opened this way are protected from disruptive
events, such as failover and giveback. This option is not supported for Vservers
branchcache - This property specifies that the share allows clients to request
BranchCache hashes on the files within this share. This option is useful only if you
2161
specify per-share as the operating mode in the CIFS BranchCache configuration,

and also specify the "oplocks" share property. This option is not supported for
access-based-enumeration - This property specifies that Access Based
Enumeration is enabled on this share. ABE-filtered shared folders are visible to
a user based on that individual user's access rights, preventing the display of
folders or other shared resources that the user does not have rights to access.
namespace-caching - This property specifies that the SMB clients connecting
to this share can cache the directory enumeration results returned by the CIFS
servers.
[-symlink-properties {enable|hide|read_only}, ...] - Symlink Properties
This optional parameter specifies how the storage system presents UNIX symbolic links
(symlinks) to CIFS clients. The list can include one or more of the following:
enable - This property enables symlinks for read-write access.
hide - This property hides symlinks.
read_only - This property enables symlinks for read-only access.
Note:
The read_only setting does not apply to widelinks.
Note:
To disable symlinks use "" or "-".
[-file-umask <Octal Integer>] - File Mode Creation Mask
This optional parameter specifies the default UNIX umask for new files created on the
share.
[-dir-umask <Octal Integer>] - Directory Mode Creation Mask
This optional parameter specifies the default UNIX umask for new directories created on
the share.
[-comment <text>] - Share Comment
This optional parameter specifies a text comment for the share that is made available to
Windows clients. The comment can be up to 256 characters long. If there is a space in
the descriptive remark or the path, you must enclose the entire string in quotation marks
(for example, "This is engineering's share.").
2162
[-attribute-cache-ttl <[<integer>h][<integer>m][<integer>s]>] - File Attribute Cache

Lifetime
This optional parameter specifies the lifetime for the attribute cache share property,
which you specify as the value of the -share-properties parameter.
Note:
This value is useful only if you specify attributecache as a share property.
[-offline-files {none|manual|documents|programs}] - Offline Files
This optional parameter allows Windows clients to cache data on this share.The actual
caching behavior depends upon the Windows client. The value can be one of the
following:
none - Disallows Windows clients from caching any files on this share.
manual - Allows users on Windows clients to manually select files to be cached.
documents - Allows Windows clients to cache user documents that are used by
the user for offline access.
programs - Allows Windows clients to cache programs that are used by the user
for offline access and may use those files in an offline mode even if the share is
available.
[-vscan-fileop-profile {no-scan|standard|strict|writes-only}] - Vscan File-Operations
Profile
This optional parameter controls which operations trigger virus scans. The value can be
no-scan: Virus scans are never triggered for this share.
standard: Virus scans can be triggered by open, close, and rename operations.
This is the default profile.
strict: Virus scans can be triggered by open, read, close, and rename operations.
writes-only: Virus scans can be triggered only when a file that has been modified
is closed.
[-max-connections-per-share <integer>] - Maximum Tree Connections on Share
This optional parameter specifies the maximum number of simultaneous connections
on the new share. This limit is at the node level, not the Vserver or cluster level. The
default for this parameter is 0. The value 0 indicates no limit. The allowed range for this
parameter is (0..4294967295).
2163
[-force-group-for-create <text>] - UNIX Group for File Create

This optional parameter specifies that all files that CIFS users create in a specific share
belong to the same group (also called the "force-group"). The "force-group" must be
a predefined group in the UNIX group database. This setting has no effect unless the
security style of the volume is UNIX or mixed security style. If "force-group" has been
specified for a share, the following becomes true for the share:
Primary GID of the CIFS users who access this share is temporarily changed to
the GID of the "force-group".
All files in this share that CIFS users create belong to the same "force-group",
regardless of the primary GID of the file owner.
Examples
The following example creates a CIFS share named SALES_SHARE on a Vserver
named vs1. The path to the share is /sales.
cluster1::> vserver cifs share create -vserver vs1 -share-name SALES_SHARE path /sales -symlink-properties enable
The following example creates a CIFS share named SALES_SHARE on a Vserver

named vs1. The path to the share is /sales and the share uses opportunistic locks
(client-side caching), the share can be browsed by Windows clients, and a notification is
generated when a change occurs.
cluster1::> vserver cifs share create -vserver vs1 -share-name SALE -shareproperties browsable,changenotify,oplocks
The following example creates a CIFS share named DOCUMENTS on a Vserver named
vs1. The path to the share is /documents and the share uses opportunistic locks (clientside caching), a notification is generated when a change occurs, and the share allows
clients to ask for BranchCache hashes for files in the share.
cluster1::> vserver cifs share create -vserver vs1 -share-name DOCUMENTS path /
documents -share-properties branchcache,changenotify,oplocks
The following example creates a CIFS share named DOCUMENTS on a Vserver named
vs1. The path to the share is /documents and the share uses opportunistic locks (clientside caching), a notification is generated when a change occurs, and the share allows
clients to cache (client-side caching) user documents on this share.
cluster1::> vserver cifs share create -vserver vs1 -share-name DOCUMENTS -path /
documents -share-properties changenotify,oplocks -offline-files documents
2164
vserver cifs share delete

Delete a CIFS share
Description
The vserver cifs share delete command deletes a CIFS share.
Parameters
This parameter specifies the Vserver from which you want to delete a CIFS share.
This parameter specifies the name of the CIFS share you want to delete.
Examples
The following example deletes a CIFS share named share1 from a Vserver named vs1.
cluster1::> vserver cifs share delete -vserver vs1
-share-name share1

Modify a CIFS share
Description
The vserver cifs share modify command modifies a CIFS share.
Parameters
2165
This parameter specifies the CIFS-enabled Vserver containing the CIFS share you want
to modify.
This parameter specifies the name of the CIFS share that you want to create. A share
name can be up to 256 characters long. If this is a home directory share (designated
as such by specifying the homedirectory on the -share-properties parameter),
you can include %w (Windows user name), %u (UNIX user name) and %d (Windows
domain name) variables in any combination with this parameter to generate shares
dynamically, with the resultant share names based on the authenticating user.s
Windows user name, UNIX user name, and/or Windows domain name.
This parameter specifies the path to the CIFS share. This path must exist in a volume.
A directory path name can be up to 256 characters long. If there is a space in the
path name, you must enclose the entire string in quotation marks (for example, "/new
volume/mount here"). If this is a homedirectory share as specified by value of home
directory on the -share-properties parameter, a dynamic path name must be
specified using %w (Windows user name), %u (UNIX user name), or %d (domain name)
variables or any of their combination as a part of the value of this parameter.
This optional parameter specifies how the storage system presents UNIX symbolic links
(symlinks) to CIFS clients. The list can include one or more of the following:
enable - This property enables symlinks for read-write access.
hide - This property hides symlinks.
read_only - This property enables symlinks for read-only access.
Note:
The read_only setting does not apply to widelinks.
Note:
To disable symlinks use "" or "-".
This optional parameter specifies the default UNIX umask for new files created on the
share.
2166
This optional parameter specifies the default UNIX umask for new directories created on
the share.
This optional parameter specifies a text comment for the share that is made available to
Windows clients. The comment can be up to 256 characters long. If there is a space in
the descriptive remark or the path, you must enclose the entire string in quotation marks
(for example, "This is engineering's share.").
Lifetime
This optional parameter specifies the lifetime for the attribute cache share property,
which you specify as the value of the -share-properties parameter.
Note:
This value is useful only if you specify attributecache as a share property.
This optional parameter allows Windows clients to cache data on this share.The actual
caching behavior depends upon the Windows client. The value can be one of the
following:
none - Disallows Windows clients from caching any files on this share.
manual - Allows users on Windows clients to manually select files to be cached.
documents - Allows Windows clients to cache user documents that are used by
the user for offline access.
programs - Allows Windows clients to cache programs that are used by the user
for offline access and may use those files in an offline mode even if the share is
available.
Profile
This optional parameter controls which operations trigger virus scans. The value can be
no-scan: Virus scans are never triggered for this share.
standard: Virus scans can be triggered by open, close, and rename operations.
This is the default profile.
strict: Virus scans can be triggered by open, read, close, and rename operations.
2167
writes-only: Virus scans can be triggered only when a file that has been modified
is closed.
This optional parameter specifies a maximum number of simultaneous connections to
the share. This limit is at the node level, not the Vserver or cluster level. The default for
this parameter is 0. The value 0 indicates no limit. The allowed range for this parameter
is (0..4294967295).
This optional parameter specifies that all files that CIFS users create in a specific share
belong to the same group (also called the "force-group"). The "force-group" must be
a predefined group in the UNIX group database. This setting has no effect unless the
security style of the volume is UNIX or mixed security style. You can disable this option
by passing a null string "".
Examples
The following example modifies a CIFS share named SALES_SHARE on a Vserver
named vs1. The share uses opportunistic locks. The file mask is set to 644 and the
directory mask to 777.
cluster1::> vserver cifs share modify -vserver vs1 -share-name SALES_SHARE symlink-properties hide -file-umask 644 -dir-umask 777
The following example modifies a CIFS share named SALES_SHARE on a Vserver

named vs1. The path to the share is /sales and the share uses opportunistic locks
(client-side caching), the share can be browsed by Windows clients, and a notification is
not generated when a change occurs.
cluster1::> vserver cifs share modify -vserver vs1 -share-name SALES_SHARE path /sales -share-properties oplocks,browsable
The following example modifies a CIFS share named DOCUMENTS on a Vserver

named vs1. The share uses opportunistic locks (client-side caching), a notification is
generated when a change occurs, and the share allows clients to ask for BranchCache
hashes for files in the share.
cluster1::> vserver cifs share modify -vserver vs1 -share-name DOCUMENTS -shareproperties branchcache,changenotify,oplocks

named vs1. The share uses opportunistic locks (client-side caching), a notification is
generated when a change occurs, and the share allows clients to cache (client-side
caching) user documents on this share.
2168
cluster1::> vserver cifs share modify -vserver vs1 -share-name DOCUMENTS -shareproperties changenotify,oplocks -offline-files documents

named vs1. The optional parameter "force-group-for-create" can be disabled by passing
the null string as parameter to "force-group-for-create" option.
cluster1::> cifs share modify -vserver vs1 -share-name DOCUMENTS -force-groupfor-create ""
A CIFS client that connects to a share whose symlink properties setting is "enable"
might fail to re-connect after the setting changes to "hide" under the following
circumstances:
1) A CIFS share on the storage system has symlink properties enabled and
2) a client successfully connects to the share and
3) you disable symlink properties on the share by setting it to "hide" and
4) the client disconnects from the share and
5) the client tries to reconnect to the same share.
vserver cifs share show

Display CIFS shares
Description
The vserver cifs share show command displays information about CIFS shares.
command. If you do not specify any parameters, the command displays the following
information about all CIFS shares:
Vserver name
CIFS share name
2169
Path
Share properties
Comment
parameters. For example, to display information only about CIFS shares that use
dynamic shares, run the command with the -share-properties dynamicshare
parameter.
Parameters
| [-shadowcopy ]
If you specify this parameter, the command displays information only about CIFS
shadow copy shares.
| [-umask ]
If you specify this parameter, the command displays file and directory masks for CIFS
shares.
| [-instance ] }
If you specify this parameter, the command displays detailed information about all CIFS
shares.
If you specify this parameter, the command displays information only about CIFS shares
on the specified CIFS-enabled Vserver.
[-share-name <Share>] - Share
share or shares that match the specified name.
share or shares that use the CIFS-enabled Vserver with the specified CIFS server
name.
2170
share or shares that have the specified path.
share or shares that have the specified share properties.
share or shares that have the specified symbolic link properties.
share or shares that use the specified file mask.
share or shares that use the specified directory mask.
share or shares that have the specified comment.
[-acl <text>, ...] - Share ACL
share or shares that have the specified ACL.
Lifetime
share or shares that have the specified attribute-cache-ttl for attribute cache.
shares that are present in this volume.
shares that have the specified Offline Files properties.
Profile
2171
shares that have the specified Vscan fileop profile.
shares that have the specified maximum connections per share configured.
This optional parameter displays information about the CIFS shares that have the
specified "force-group" parameter configured.
Examples
The following example displays information about all CIFS shares:
cluster1::> vserver cifs share show
Vserver
Share
Path
Properties Comment
ACL
-------------- ------------- ----------------- ---------- -------- ----------vs1
ROOTSHARE
oplocks
Share
CNC \
browsable
mapped
Everyone /
changenoti to top
Full
fy
Control
of
Vserver
global
namespac
e
vs1
admin$
browsable
vs1
c$
oplocks
BUILTIN\Admi
browsable
nistrators /
changenoti
Full
fy
vs1
ipc$
Control
browsable
The following example displays information about a CIFS share named SALES_SHARE
on a Vserver named vs1.
cluster1::> vserver cifs share show -vserver vs1 -share-name SALES_SHARE
Vserver: vs1
Share: SALES_SHARE
CIFS Server NetBIOS Name: WINDATA
2172
Path: /sales
Share Properties: oplocks
browsable
Symlink Properties: enable
File Mode Creation Mask: Directory Mode Creation Mask: Share Comment: Share ACL: Everyone / Full Control
File Attribute Cache Lifetime: Offline Files: manual
Vscan File-Operations Profile: standard
2173
vserver cifs share access-control create

Create an access control list
Description
The vserver cifs share access-control create command adds a user or
group to a CIFS share's ACL.
Parameters
This parameter specifies the name of the Vserver containing the CIFS share.
-share <Share> - Share Name
This parameter specifies the name of the CIFS share.
-user-or-group <TextNoCase> - User/Group Name
This parameter specifies the user or group to add to the CIFS share's access control
list. If you specify the user name, you must include the user's domain using the format
"domain\username". The user-or-group parameter is case-insensitive text.
[-user-group-type {windows|unix-user|unix-group}] - User or Group Type
This parameter specifies the type of the user or group to add to the CIFS share's
access control list. The default type is windows. The user-group-type can be one of the
following:
windows
unix-user
unix-group
-permission <access rights> - Access Type
This parameter specifies the permissions for the user or group. The permissions can be
No_access
Read
2174
Change
Full_Control
Examples
The following example adds the windows group "Everyone" with "Full_Control"
permission to the access control list of the share "vol3".
vs1::> vserver cifs share access-control create -share vol3 -user-orgroup Everyone -user-group-type windows -permission Full_Control
The following example adds the unix-user "pcuser" and unix-group "daemon" with "read"
permission to the access control list of the share "vol3".
vs1::> vserver cifs share access-control create -share vol3 -user-orgroup pcuser -user-group-type unix-user -permission read
vs1::> vserver cifs share access-control create -share vol3 -user-orgroup daemon -user-group-type unix-group -permission read
2175
vserver cifs share access-control delete

Delete an access control list
Description
The vserver cifs share access-control delete command deletes a user or
group from a CIFS share's ACL.
Parameters
This parameter specifies the name of the Vserver containing the CIFS share.
This parameter specifies the user or group to delete from the CIFS share's access
control list. If you specify a user name, you must include the user's domain using the
format "domain\username". The user-or-group parameter is case-insensitive text.
This parameter specifies the type of the user or group to delete from the CIFS share's
access control list. The default type is windows. The user-group-type can be one of the
following:
windows
unix-user
unix-group
Examples
The following example deletes the group "Everyone" for the access control list of share
"vol3".
vs1::> vserver cifs share access-control delete -share vol3 -user-orgroup Everyone
2176
vserver cifs share access-control modify

Modify an access control list
Description
The vserver cifs share access-control modify command modifies the
permissions of a user or group in a CIFS share's ACL.
Parameters
This parameter specifies the name of the Vserver containing the CIFS share whose ACL
you want to modify.
This parameter specifies the name of the CIFS share whose ACL you want to modify.
This parameter specifies the user or group to modify. If you specify the user name, you
must include the user's domain using the format "domain\username". The user-or-group
parameter is case-insensitive text.
This parameter specifies the type of the user or group to modify. The default type is
windows. The user-group-type can be one of the following:
windows
unix-user
unix-group
[-permission <access rights>] - Access Type
This parameter specifies the permissions for the user or group. The permissions can be
No_access
2177
Read
Change
Full_Control
Examples
The following example modifies the access control list for a share named "vol3". It
changes the permission for the windows group "Everyone" to "Full_Control".
vs1::*> vserver cifs share access-control modify -share vol3 -user-orgroup Everyone -user-group-type windows -permission Full_Control
The following example modifies the access control list for a share named "vol3".
It changes the permission for the unix-user "pcuser" and unix-group "daemon" to
"change".
vs1::> vserver cifs share access-control modify -share vol3 -user-orgroup pcuser -user-group-type unix-user -permission change
vs1::> vserver cifs share access-control modify -share vol3 -user-orgroup daemon -user-group-type unix-group -permission change
2178
vserver cifs share access-control show

Display access control lists on CIFS shares
Description
The vserver cifs share access-control show command displays the ACLs of
CIFS shares.
Parameters
specify.
| [-instance ] }
about all fields.
This optional parameter specifies the name of the Vserver containing the share for
which you want to display the access control list.
[-share <Share>] - Share Name
This optional parameter specifies the name of the CIFS share for which you want to
display the access control list.
[-user-or-group <TextNoCase>] - User/Group Name
If you specify this optional parameter, the command displays only access control lists for
the CIFS shares that have ACLs matching the specified user or group.
If you specify this optional parameter, the command displays only access control lists
for the CIFS shares that have ACLs matching the specified user-group-type. The usergroup-type can be one of the following:
windows
2179
unix-user
unix-group
[-permission <access rights>] - Access Type
the CIFS shares that have ACLs matching the specified permission. The permissions
can be one of the following:
No_access
Read
Change
Full_Control
[-winsid <windows sid>] - Windows SID
the CIFS shares that have ACLs matching the specified Windows SID.
Examples
The following example displays all the ACLs for shares in Vserver vs1.
vs1::> vserver cifs share access-control show
Vserver
Share
User/Group
User/Group
Access
Name
Name
Type
Permission
-------------- ----------- --------------------------- ----------- -----------
2180
vs1
vol3
CIFSQA\administrator
windows
Read
vs1
vol3
Everyone
windows
Full_Control
vs1
vol3
pcuser
unix-user
Read
vs1
vol3
daemon
unix-group
Read
vserver cifs share properties add

Add to the list of share properties
Description
The vserver cifs share properties add command adds share properties
to the list of share properties of an existing CIFS share. You can add one or more
share properties. You can add additional share properties at any time by rerunning this
command. Any share properties that you have previously specified will remain in effect
and newly added properties are appended to the existing list of share properties.
Parameters
This parameter specifies the name of the Vserver containing the CIFS share whose
share properties you want to add.
-share-properties <share properties>, ... - Share Properties
This parameter specifies the list of share properties you want to add to the CIFS share.
The share properties can be one or more of the following:
known as client-side caching. This is a default initial property for all shares;
however, some applications do not work well when oplocks are enabled. In
particular, database applications such as Microsoft Access are vulnerable to
corruption when oplocks are enabled. An advantage of shares is that a single
path can be shared multiple times, with each share having different properties.
For instance, if a path named /dept/finance contains both a database and other
types of files, you can create two shares to it, one with oplocks disabled for safe
database access and one with oplocks enabled for client-side caching.
browsable - This property allows Windows clients to browse the share. This is a
default initial property for all shares.
2181
changenotify - This property specifies that the share supports Change Notify
Note:
BranchCache hashes on the files within this share. This option is useful only
if you specify "per-share" as the operating mode in the CIFS BranchCache
configuration, and also specify the "oplocks" share property. This option is not
Enumeration(ABE) is enabled on this share. ABE-filtered shared folders are
visible to a user based on that individual user's access rights, preventing the
display of folders or other shared resources that the user does not have rights to
access.
servers.
Note:
The oplock, browsable, and changenotify share properties are assigned to a share by
default. If you have removed them from a share, you can use the vserver cifs share
properties add command to add these properties to the share.
2182
Examples
The following example adds the "showsnapshot" and "changenotify" properties to a
share named "sh1".
cluster1::> vserver cifs share properties add -vserver vs1 -share-name
sh1 -share-properties showsnapshot,changenotify
vserver cifs share properties remove

Remove from the list of share properties
Description
The vserver cifs share properties remove command removes share
properties from the list of share properties of an existing CIFS share. You can remove
one or more share properties. You can remove additional share properties at any time
by rerunning this command. Any existing share properties that you do not remove
remain in effect.
Parameters
This parameter specifies the name of the Vserver containing the CIFS share whose
share properties you want to remove.
-share-properties <share properties>, ... - Share Properties
This parameter specifies the list of share properties you want to remove from the CIFS
share. The share properties can be one or more of the following:
known as client-side caching. Oplocks are enabled on shares by default; however,
some applications do not work well when oplocks are enabled. In particular,
database applications such as Microsoft Access are vulnerable to corruption when
oplocks are enabled. An advantage of shares is that a single path can be shared
2183
multiple times, with each share having different properties. For instance, if a path
named /dept/finance contains both a database and other types of files, you can
create two shares to it, one with oplocks disabled for safe database access and
one with oplocks enabled for client-side caching.
browsable - This property allows Windows clients to browse the share.
Note:
configuration, and also specify the "oplocks" share property. This option is not
Enumeration(ABE) is enabled on this share. ABE-filtered shared folders are
visible to a user based on that individual user's access rights, preventing the
display of folders or other shared resources that the user does not have rights to
access.
servers.
Examples
2184
The following example removes "showsnapshot" and "changenotify" properties to a

share named "sh1".
cluster1::> vserver cifs share properties remove -vserver vs1 -share-name
sh1 -share-properties showsnapshot,changenotify
vserver cifs share properties show

Display share properties
Description
The vserver cifs share properties show command displays the CIFS share
properties.
Parameters
specify.
| [-instance ] }
about all fields.
This optional parameter specifies the name of the Vserver containing the CIFS share for
which you want to display share properties.
[-share-name <Share>] - Share
If you specify this parameter, the command displays share properties only for the CIFS
share that you specify.
If you specify this parameter, the command displays share properties only for CIFS
shares using the properties you specify. The share properties can be one or more of the
following:
2185
homedirectory - This property specifies that the share and path names are
dynamic. Specify this value for a home directory share. In a home directory share,
the share's name and path can be generated by substituting %w and %d variables
with the corresponding user's name and domain, respectively, specified as the
value of the -share-name and -path parameters. For instance, if a dynamic
share is defined with a name of %d_%w, a user logged on as barbara from a
domain named FIN sees the share as FIN_barbara. Using the homedirectory
value specifies that the share and path names are dynamically expanded.
known as client-side caching.
browsable - This property allows Windows clients to browse the share.
requests.
Note:
events, such as failover and giveback.
configuration, and also specify the "oplocks" share property.
shadowcopy - This property specifies that the share is pointing to a shadow copy.
This attribute cannot be added nor removed from a share.
Enumeration is enabled on this share. ABE-filtered shared folders are visible to
a user based on that individual user's access rights, preventing the display of
folders or other shared resources that the user does not have rights to access.
2186

servers.
Examples
The following example displays share properties for shares in Vserver vs1.
cluster1::> vserver cifs share properties show
Vserver
Share
Properties
---------------- ---------------- ----------------vs1
abc
oplocks
browsable
changenotify
vs1
admin$
browsable
vs1
ipc$
browsable
vs1
sh1
oplocks
browsable
changenotify
2187
vserver cifs superuser create

Adds superuser permissions to a CIFS account
Description
The vserver cifs superuser create command elevates the privileges of the
specified domain account in this Vserver to superuser. With superuser privileges, Data
ONTAP bypasses some of the security checks.
Parameters
Vserver name.
-domain <CIFS domain> - Domain
The domain name of accountname.
-accountname <CIFS account> - User
The domain account to which you want to give superuser privileges.
Examples
The following example shows how to elevate ExampleUser in EXAMPLE domain to
superuser for a Vserver vs1.
vs1::> vserver cifs superuser create -domain EXAMPLE -accountname
vserver vs1
ExampleUser -
vserver cifs superuser delete

Deletes superuser permissions from a CIFS account
Description
2188
The vserver cifs superuser delete command removes the superuser

privileges for the specified domain account in this Vserver. With superuser privileges,
Data ONTAP bypasses some of the security checks.
Parameters
Vserver name.
-domain <CIFS domain> - Domain
The domain name of accountname.
-accountname <CIFS account> - User
The domain account name you want to remove superuser privileges.
Examples
The following example shows how to remove superuser privileges for ExampleUser in
EXAMPLE domain for a Vserver vs1.
vs1::> vserver cifs superuser delete -domain EXAMPLE -accountname ExampleUser vserver vs1
vserver cifs superuser show

Display superuser permissions for CIFS accounts
Description
The vserver cifs superuser show command displays all account names with
superuser privileges. The command output depends on the parameter or parameters
displays the following superuser information for all CIFS servers:
Vserver name
CIFS server NetBIOS name
Domain
2189
Account Name
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays superuser information of only the
specified Vservers.
[-domain <CIFS domain>] - Domain
If you specify this parameter, the command displays superuser information of only for
accounts that are in the specified domain.
[-accountname <CIFS account>] - User
CIFS servers with the specified superuser account.
Vservers with specified CIFS server name.
Examples
The following example displays superuser information of all Vservers.
vs1::> vserver cifs superuser show
Vserver
CIFS Server
Domain
Account Name
-------------- --------------- --------------- ------------
2190
vs1
SMB_SERVER1
CIFSDOMAIN
ADMINISTRATOR
vs2
SMB_SERVER2
CIFSDOMAIN
ADMINISTRATOR
vserver cifs symlink create

Create a symlink path mapping
Description
The vserver cifs symlink create command creates a symbolic link mapping
for CIFS. A mapping consists of a Vserver name, a UNIX (NFS) path, a CIFS share
name, and a CIFS path. You can also specify a CIFS server name and whether the
CIFS symbolic link is a local link or wide link. A local symbolic link maps to the local
CIFS share, while a wide symbolic link maps to any CIFS share on the network. If the
target share is a Home Directory, then the -home-directory field must be set to true
for correct processing.
Parameters
This parameter specifies the Vserver on which you want to create the mapping.
-unix-path <text> - UNIX Path
This parameter specifies the UNIX (NFS) path for the mapping.
Note:
It must begin and end with a forward slash (/).
-share-name <Share> - CIFS Share
This parameter specifies the CIFS share for the mapping.
-cifs-path <TextNoCase> - CIFS Path
This parameter specifies the CIFS path for the mapping. Note that this value is specified
by using a UNIX-style path.
Note:
[-cifs-server <TextNoCase>] - Remote NetBIOS Server Name
2191
This parameter specifies a new CIFS server DNS name, IP address, or NetBIOS name
for the mapping.
[-locality {local|widelink}] - Local or Wide Symlink
This parameter specifies whether the CIFS symbolic link is a local link or wide link. A
local symbolic link maps to the local CIFS share, while a wide symbolic link maps to any
CIFS share on the network. The default setting is local.
[-home-directory {true|false}] - Home Directory
This parameter specifies whether the target share is a home directory. The default value
is false.
Note:
This field must be set to true when the target share is a Home Directory for correct
processing.
Examples
The following example creates a symbolic link mapping on a Vserver named vs1. It
has the UNIX path /sales/, the CIFS share name SALES_SHARE, and the CIFS path /
mycompany/sales/.
cluster1::> vserver cifs symlink create -vserver vs1
-unix-path /sales/ -share-name SALES_SHARE -cifs-path "/mycompany/sales/"
The following example creates a symbolic link mapping on a Vserver named vs1. It has
the UNIX path /example/, the CIFS share name EXAMPLE_SHARE, the CIFS path /
mycompany/example/, the CIFS server IP address, and is a widelink.
cluster1::> vserver cifs symlink create -vserver vs1 -unix-path /example/ -sharename EXAMPLE_SHARE
-cifs-path "/mycompany/example/" -cifs-server CIFSSERVER1 -locality widelink
2192
vserver cifs symlink delete

Delete a symlink path mapping
Description
The vserver cifs symlink delete command deletes a symbolic link mapping for
CIFS.
Parameters
This specifies the Vserver on which the symbolic link mapping is located.
This specifies the UNIX (NFS) path of the mapping that you want to delete.
Examples
The following example deletes a symbolic link mapping to a UNIX path /example/ from a
Vserver named vs1:
cluster1::> vserver cifs symlink delete -vserver vs1 -unix-path /example/
vserver cifs symlink modify

Modify a symlink path mapping
Description
The vserver cifs symlink modify command modifies the CIFS share name,
CIFS path, CIFS server name, or locality of a symbolic link mapping. It can also be used
to modify the value of -home-directory field.
2193
Parameters
This parameter specifies the Vserver on which the symbolic link mapping is located.
This parameter specifies the UNIX (NFS) path of the mapping that you want to modify.
Note:
[-share-name <Share>] - CIFS Share
This parameter specifies a new CIFS share name for the mapping.
[-cifs-path <TextNoCase>] - CIFS Path
This parameter specifies a new CIFS path for the mapping. Note that this value is
specified by using a UNIX-style path.
Note:
This parameter specifies a new CIFS server DNS name, IP address, or NetBIOS name
for the mapping.
This parameter specifies a new locality for the mapping. A local symbolic link maps
to the local CIFS share, while a wide symbolic link maps to any CIFS share on the
network. The default setting is local.
This parameter specifies whether the new target share is a home directory.
Note:
This field must be set to true when the target share is a Home Directory for correct
processing.
Examples
2194
The following example modifies the symbolic link mapping to a UNIX path /example/
on a Vserver named vs1. The mapping is modified to use the CIFS path /mycompany/
example/.
cluster1::> vserver cifs symlink modify -vserver vs1 -unix-path /example/ -cifspath "/mycompany/example/"
The following example modifies the symbolic link mapping to a UNIX path /example/
on a Vserver named vs1. The mapping is modified to use the CIFS share name
EXAMPLE_SHARE, the CIFS path /mycompany/example/, on the CIFS server
cifs.example.com, and to be a widelink.
cluster1::> vserver cifs symlink modify -vserver vs1 -unix-path /example/ -sharename EXAMPLE_SHARE -cifs-path "/mycompany/example/" -cifs-server cifs.example.com
-locality widelink
2195
vserver cifs symlink show

Show symlink path mappings
Description
The vserver cifs symlink show command displays the following information
about symbolic link mappings for CIFS:
Vserver
UNIX (NFS) path
The DNS name, IP address, or NetBIOS name of the CIFS server
CIFS share name
CIFS path
Whether the locality of the CIFS server is a local or widelink (A local symbolic link
maps to the local CIFS share, while a wide symbolic link maps to any CIFS share
on the network.)
Parameters
| [-instance ] }
all entries.
If you specify this parameter, the command displays information about symbolic link
mappings on the specified Vserver.
[-unix-path <text>] - UNIX Path
If you specify this parameter, the command displays information only about the symbolic
link mapping that uses the specified UNIX (NFS) path.
2196
[-share-name <Share>] - CIFS Share

link mapping or mappings that use the specified CIFS share.
[-cifs-path <TextNoCase>] - CIFS Path
link mapping that uses the specified CIFS path.
link mapping that uses the specified CIFS server.
link mappings that have the specified locality.
link mappings that have the target share as a home directory (if true) or as a static CIFS
share (if false).
Examples
The following example displays information about all symbolic link mappings for CIFS:
cluster1::> vserver cifs symlink show
Vserver
Unix Path
CIFS Server
CIFS Share
CIFS Path
Locality
---------- ---------- ------------------- ----------- ------------------ -------vs1
/hr/
192.0.2.160
HR_SHARE
vs1
/sales/
WINDATA
SALES_SHARE /mycompany/sales/
/mycompany/hr/
local
vs1
/web/
cifs.example.com
WEB_SHARE
widelink
/mycompany/web/
widelink
The following example displays information about all symbolic link mappings that are
widelinks:
cluster1::> vserver cifs symlink show -locality widelink
Vserver
Unix Path
CIFS Server
CIFS Share
CIFS Path
Locality
---------- ---------- ------------------- ----------- --------------- -------vs1
/hr/
192.0.2.160
HR_SHARE
/mycompany/hr/
vs1
/web/
cifs.example.com
WEB_SHARE
/mycompany/web/ widelink
widelink
2197
2198
vserver cifs users-and-groups update-names

Update the names of Active Directory users and groups
Description
The vserver cifs users-and-groups update-names command updates the
names of Active Directory users and groups that are registered in local databases on
the cluster and reports the status of the update operations. This is done so that objects
that were renamed in the Active Directory can be properly displayed and configured in
the local databases.
Parameters
If you specify this parameter, the command will only be performed within the scope of
the Vserver that matches the specified Vserver name.
{ [-display-failed-only {true|false}] - Display Only Failures
If you set this parameter to true, the command displays only the Active Directory users
and groups that failed to update. If set to false, the command displays only the Active
Directory users and groups that successfully updated.
| [-suppress-all-output {true|false}] } - Suppress All Output
If you set this parameter to true, the command does not display information about the
status of the updates of Active Directory users and groups. To display information about
the status of the updates, set this parameter to false or do not specify this parameter in
the command.
Examples
The following example updates the names of Active Directory users and groups
associated with Vserver "vs1". In the last case, there is a dependent chain of names that
needs to be updated.
cluster1::*> vserver cifs users-and-groups update-names -vserver vs1
Vserver:
vs1
SID:
S-1-5-21-123456789-234565432-987654321-12345
2199
Domain:
EXAMPLE1
Out-of-date Name:
dom_user1
Updated Name:
dom_user2
Status:
Successfully updated
Vserver:
vs1
SID:
S-1-5-21-123456789-234565432-987654322-23456
Domain:
EXAMPLE2
Out-of-date Name:
dom_user1
Updated Name:
dom_user2
Status:
Successfully updated
Vserver:
vs1
SID:
S-1-5-21-123456789-234565432-987654321-123456
Domain:
EXAMPLE1
Out-of-date Name:
dom_user3
Updated Name:
dom_user4
Status:
Successfully updated; also updated SID
"S-1-5-21-123456789-234565432-987654321-123457"
to name "dom_user5"; also updated SID
"S-1-5-21-123456789-234565432-987654321-123458"
"S-1-5-21-123456789-234565432-987654321-123459"
"S-1-5-21-123456789-234565432-987654321-123460"
to name "dom_user8"
The command completed successfully. 7 Active Directory objects have been updated.
2200
vserver cifs users-and-groups local-group addmembers

Add members to a local group
Description
The vserver cifs users-and-groups local-group add-members command
adds members to a local group.
Parameters
This specifies the name of the Vserver.
-group-name <CIFS name> - Group Name
This specifies the name of the local group.
-member-names <CIFS name>, ... - Names of Users or Active Directory Groups to be
Added
This specifies the list of local users, Active Directory users, or Active Directory groups to
be added to a particular local group.
Examples
The following example adds a local user "CIFS_SERVER\loc_usr1" and an Active
Directory group "CIFS_SERVER\dom_grp2" to the local group "CIFS_SERVER\g1".
cluster1::> vserver cifs users-and-groups local-group add-members -vserver vs1 group-name CIFS_SERVER\g1 -member-names CIFS_SERVER\loc_usr1,AD_DOMAIN\dom_grp2
2201
vserver cifs users-and-groups local-group create

Create a local group
Description
The vserver cifs users-and-groups local-group create command creates
a local group and optionally sets the description of that local group. The group name
must meet the following criteria:
The group name length must not exceed 256 characters.
The group name cannot be terminated by a period.
The group name cannot include commas.
The group name cannot include any of the following printable characters: ", /, \,
[, ], :, |, <, >, +, =, ;, ?, *, @
The group name cannot include characters in the ASCII range 1-31, which are
non-printable.
Parameters
[-description <TextNoCase>] - Description
This specifies a description for this local group. If the description contains a space,
enclose the parameter in quotation marks.
Examples
The following example creates a local group "CIFS_SERVER\g1" associated with
Vserver "vs1".
cluster1::> vserver cifs users-and-groups local-group create -vserver vs1 -groupname CIFS_SERVER\g1
2202
vserver cifs users-and-groups local-group delete

Delete a local group
Description
The vserver cifs users-and-groups local-group delete command deletes
a local group. Removing a local group removes its membership records.
Parameters
This specifies the name of the local group to delete.
Examples
The following example deletes the local group "CIFS_SERVER\g1" associated with
Vserver "vs1".
cluster1::> vserver cifs users-and-groups local-group delete -vserver vs1 -groupname CIFS_SERVER\g1
vserver cifs users-and-groups local-group modify

Modify a local group
Description
The vserver cifs users-and-groups local-group modify command
modifies the description of a local group.
Parameters
2203

This specifies a description for this local group. If the description contains a space,
Examples
The following example modifies the description of the local group "CIFS_SERVER\g1"
associated with Vserver "vs1".
cluster1::> vserver cifs users-and-groups local-group modify -vserver vs1 -groupname CIFS_SERVER\g1 -description "Example Description"
vserver cifs users-and-groups local-group removemembers

Remove members from a local group
Description
The vserver cifs users-and-groups local-group remove-members
command removes members from a local group.
Parameters
-member-names <CIFS name>, ... - Names of Users or Active Directory Groups to be
Removed
2204
This specifies the list of local users, Active Directory users, or Active Directory groups to
be removed from a particular local group.
Examples
The following example removes the local users "CIFS_SERVER\u1" and
"CIFS_SERVER\u2" from the local group "CIFS_SERVER\g1".
cluster1::> vserver cifs users-and-groups local-group remove-members -vserver vs1
-group-name CIFS_SERVER\g1 -member-names CIFS_SERVER\u1,CIFS_SERVER\u2
2205
vserver cifs users-and-groups local-group rename

Rename a local group
Description
The vserver cifs users-and-groups local-group rename command
renames a local group. The new group name must remain in the same domain as the
old group name. The new group name must meet the following criteria:
The group name length must not exceed 256 characters.
The group name cannot be terminated by a period.
The group name cannot include commas.
The group name cannot include any of the following printable characters: ", /, \,
[, ], :, |, <, >, +, =, ;, ?, *, @
The group name cannot include characters in the ASCII range 1-31, which are
non-printable.
Parameters
This specifies the local group's name.
-new-group-name <CIFS name> - New Group Name
This specifies the local group's new name.
Examples
The following example renames the local group "CIFS_SERVER\g_old" to
"CIFS_SERVER\g_new" on Vserver "vs1".
cluster1::> vserver cifs users-and-groups local-group rename -group-name
CIFS_SERVER\g_old -new-group-name CIFS_SERVER\g_new -vserver vs1
2206
vserver cifs users-and-groups local-group showmembers

Display local groups' members
Description
The vserver cifs users-and-groups local-group show-members
command displays members of a local group. The members can be local or Active
Directory users or groups.
Parameters
specify.
| [-instance ] }
about all fields.
If this parameter is specified, the command displays group members of local groups that
match the specified Vserver name.
[-group-name <CIFS name>] - Group Name
If this parameter is specified, the command displays group members of local groups that
match the specified group name.
[-member <CIFS name>] - Member Name
If this parameter is specified, the command displays group members that match the
specified member name. The name can be that of a local user, Active Directory user, or
Active Directory group.
Examples
The following example displays members of local groups associated with Vserver "vs1".
2207
cluster1::> vserver cifs users-and-groups local-group show-members -vserver vs1

Vserver
Group Name
Members
-------------- ---------------------------- -----------------------vs1
BUILTIN\Administrators
CIFS_SERVER\Administrator
AD_DOMAIN\Domain Admins
AD_DOMAIN\dom_grp1
BUILTIN\Users
AD_DOMAIN\Domain Users
AD_DOMAIN\dom_usr1
CIFS_SERVER\g1
CIFS_SERVER\u1
2208
vserver cifs users-and-groups local-group show

Display local groups
Description
The vserver cifs users-and-groups local-group show command displays
local groups.
Parameters
specify.
| [-instance ] }
about all fields.
If this parameter is specified, the command displays information only about local groups
that match the specified Vserver name.
[-group-name <CIFS name>] - Group Name
that match the specified group name.
that match the specified description.
Examples
The following example displays all local groups associated with Vserver "vs1".
cluster1::> vserver cifs users-and-groups local-group show -vserver vs1
Vserver
Group Name
Description
-------------- -------------------------------- ----------------------------
2209
vs1
Built-in Administrators group
vs1
BUILTIN\Backup Operators
Backup Operators group
vs1
privileges
BUILTIN\Power Users
Restricted administrative
vs1
BUILTIN\Users
All users
vs1
CIFS_SERVER\g1
vs1
CIFS_SERVER\g2
2210
vserver cifs users-and-groups local-user create

Create a local user
Description
The vserver cifs users-and-groups local-user create command creates
a local user and optionally sets the attributes for that local user. The command prompts
for the local user's password.
The user name must meet the following criteria:
The user name length must not exceed 20 characters.
The user name cannot be terminated by a period.
The user name cannot include commas.
The user name cannot include any of the following printable characters: ", /, \,
[, ], :, |, <, >, +, =, ;, ?, *, @
The user name cannot include characters in the ASCII range 1-31, which are nonprintable.
The password must meet the following criteria:
The password must be at least six characters in length.
The password must not contain user account name.
The password must contain characters from three of the following four categories:
English uppercase characters (A through Z)
English lowercase characters (a through z)
Base 10 digits (0 through 9)
Special characters: ~, !, @, #, 0, ^, &, *, _, -, +, =, `, \, |, (, ), [, ], :, ;, ", ', <,
>, ,, ., ?, /
Parameters
2211

-user-name <CIFS name> - User Name
This specifies the user name.
[-full-name <TextNoCase>] - Full Name
This specifies the user's full name. If the full name contains a space, enclose the full
name within double quotation marks.
This specifies a description for this local user. If the description contains a space,
[-is-account-disabled {true|false}] - Is Account Disabled
This specifies whether the user account is enabled or disabled. Set this parameter to
true to disable the account. Set this parameter to false to enable the account. If this
parameter is not specified, the default is to enable the user account.
Examples
The following example creates a local user "CIFS_SERVER\u1" associated with Vserver
"vs1".
cluster1::> vserver cifs users-and-groups local-user create -vserver vs1 -username CIFS_SERVER\u1
Enter the password:
Confirm the password:
vserver cifs users-and-groups local-user delete

Delete a local user
Description
The vserver cifs users-and-groups local-user delete command deletes
a local user. Upon deletion, all membership entries for this local user are deleted.
2212
Parameters
Examples
The following example deletes the local user "CIFS_SERVER\u1" associated with
Vserver "vs1".
cluster1::> vserver cifs users-and-groups local-user show-membership
(vserver cifs users-and-groups local-user show-membership)
Vserver
User Name
Membership
-------------- ------------------------------- -----------------------vs1
CIFS_SERVER\u1
CIFS_SERVER\g1

cluster1::> vserver cifs users-and-groups local-user delete -vserver vs1 -username CIFS_SERVER\u1
Vserver
User Name
Membership
-------------- ------------------------------- -----------------------vs1
2213
vserver cifs users-and-groups local-user modify

Modify a local user
Description
The vserver cifs users-and-groups local-user modify command modifies
attributes of a local user.
Parameters
This specifies the user's full name. If the full name contains a space in the name,
enclose it within double quotation marks
This specifies a description for this local user. If the description contains a space,
This specifies if the user account is enabled or disabled. Set this parameter to true to
disable the account. Set this parameter to false to enable the account.
Examples
The following example modifies the full name of the local user "CIFS_SERVER\u1".
cluster1::> vserver cifs users-and-groups local-user modify -user-name
CIFS_SERVER\u1 -full-name "John Smith" -vserver vs1
vserver cifs users-and-groups local-user rename

2214
Rename a local user

Description
The vserver cifs users-and-groups local-user rename command renames
a local user. The new user name must remain in the same domain as the old user
name.
The new user name must meet the following criteria:
The user name length must not exceed 20 characters.
The user name cannot be terminated by a period.
The user name cannot include commas.
The user name cannot include any of the following printable characters: ", /, \,
[, ], :, |, <, >, +, =, ;, ?, *, @
The user name cannot include characters in the ASCII range 1-31, which are nonprintable.
Parameters
-new-user-name <CIFS name> - New User Name
This specifies the new user name.
Examples
The following example renames the local user "CIFS_SERVER\u_old" to
"CIFS_SERVER\u_new" on Vserver "vs1".
cluster1::> vserver cifs users-and-groups local-user rename -user-name
CIFS_SERVER\u_old -new-user-name CIFS_SERVER\u_new -vserver vs1
2215
vserver cifs users-and-groups local-user setpassword

Set a password for a local user
Description
The vserver cifs users-and-groups local-user set-password command
sets the password for the specified local user. The password must meet the following
criteria:
The password must be at least six characters in length.
The password must not contain user account name.
The password must contain characters from three of the following four categories:
English uppercase characters (A through Z)
English lowercase characters (a through z)
Base 10 digits (0 through 9)
Special characters: ~, !, @, #, 0, ^, &, *, _, -, +, =, `, \, |, (, ), [, ], :, ;, ", ', <,
>, ,, ., ?, /
Parameters
Examples
The following example sets the password for the local user "CIFS_SERVER\u1"
associated with Vserver "vs1".
cluster1::> vserver cifs users-and-groups local-user set-password -user-name
CIFS_SERVER\u1 -vserver vs1
2216
Enter the new password:

Confirm the new password:
The following example attempts to set the password but fails because the password did
not meet password complexity requirements.
cluster1::> vserver cifs users-and-groups local-user set-password -user-name
CIFS_SERVER\u1 -vserver vs1
Enter the new password:
Confirm the new password:
Error: command failed: The password does not meet the password complexity
requirements. Refer to the man page for details.
2217
vserver cifs users-and-groups local-user showmembership

Display local users' membership information
Description
The vserver cifs users-and-groups local-user show-membership
command displays the membership of local users.
Parameters
specify.
| [-instance ] }
about all fields.
If this parameter is specified, the command displays local user membership information
for local users that are associated with the specified Vserver.
[-user-name <CIFS name>] - User Name
for a local user that matches the specified user name.
[-membership <CIFS name>] - Local Group That This User is a Member of
for the local group of which this local user is a member.
Examples
The following example displays the membership information of all local users; user
"CIFS_SERVER\Administrator" is a member of "BUILTIN\Administrators" group, and
"CIFS_SERVER\u1" is a member of "CIFS_SERVER\g1" group.
2218

Vserver
User Name
Membership
-------------- ------------------------------- -----------------------vs1
CIFS_SERVER\u1
CIFS_SERVER\g1
2219
vserver cifs users-and-groups local-user show

Display local users
Description
The vserver cifs users-and-groups local-user show command displays
local users and their attributes.
Parameters
specify.
| [-instance ] }
about all fields.
If this parameter is specified, the command displays information only about local users
that match the specified Vserver name.
[-user-name <CIFS name>] - User Name
that match the specified user name.
that match the specified full name.
that match the specified description.
2220
that match the status specified.
Examples
The following example displays information about all local users.
cluster1::> vserver cifs users-and-groups local-user show
Vserver
User Name
Full Name
Description
------------ --------------------------- -------------------- ------------vs1

administrator account
James Raynor
vs1
Sarah Kerrigan
CIFS_SERVER\u1
Built-in
2221
vserver cifs users-and-groups privilege addprivilege

Add local privileges to a user or group
Description
The vserver cifs users-and-groups privilege add-privilege command
adds privileges to a local or Active Directory user or group.
Parameters
-user-or-group-name <CIFS name> - User or Group Name
This specifies the name of the local or Active Directory user or group.
-privileges <Privilege>, ... - Privileges
This specifies the list of privileges to be associated with this user or group.
Examples
The following example adds the privileges "SeTcbPrivilege" and
"SeTakeOwnershipPrivilege" to the user "CIFS_SERVER\u1".
cluster1::> vserver cifs users-and-groups privilege add-privilege
-vserver vs1 -user-or-group-name CIFS_SERVER\u1 -privileges
SeTcbPrivilege,SeTakeOwnershipPrivilege
2222
vserver cifs users-and-groups privilege removeprivilege

Remove privileges from a user or group
Description
The vserver cifs users-and-groups privilege remove-privilege
command removes privileges from a local or Active Directory user or group. This
command creates a new or modifies an existing privilege entry.
Parameters
-privileges <Privilege>, ... - Privileges
This specifies the list of privileges to be removed from this user or group.
Examples
The following example removes the previously added "SeTcbPrivilege" and
"SeTakeOwnershipPrivilege" privileges from the user "CIFS_SERVER\u1".
cluster1::> vserver cifs users-and-groups privilege show
Vserver
User or Group Name
Privileges
-------------- ---------------------------- ------------------vs1
CIFS_SERVER\u1
SeTcbPrivilege
SeTakeOwnershipPrivilege
cluster1::> vserver cifs users-and-groups privilege remove-privilege

-vserver vs1 -user-or-group-name CIFS_SERVER\u1 -privileges
SeTcbPrivilege,SeTakeOwnershipPrivilege
Vserver
User or Group Name
Privileges
2223
-------------- ---------------------------- ------------------vs1
CIFS_SERVER\u1
The following example removes "SeBackupPrivilege" from the group "BUILTIN

\Administrators".
cluster1::> vserver cifs users-and-groups privilege remove-privilege -vserver vs1
-user-or-group-name BUILTIN\Administrators -privileges SeBackupPrivilege
Vserver
User or Group Name
Privileges
-------------- ---------------------------- ------------------vs1
SeRestorePrivilege
SeSecurityPrivilege
2224
vserver cifs users-and-groups privilege resetprivilege

Reset local privileges for a user or group
Description
The vserver cifs users-and-groups privilege reset-privilege
command resets privileges of a local or Active Directory user or group.
Parameters
Examples
The following example resets the privileges for the local user "CIFS_SERVER\u1".
This operation removes the privilege entry, if any, associated with the local user
"CIFS_SERVER\u1".
Vserver
User or Group Name
Privileges
-------------- ---------------------------- ------------------vs1
CIFS_SERVER\u1
SeRestorePrivilege
cluster1::> vserver cifs users-and-groups privilege reset-privilege -vserver vs1

-user-or-group-name CIFS_SERVER\u1
The following example resets the privileges for the group "BUILTIN\Administrators",
effectively removing the privilege entry.
2225

Vserver
User or Group Name
Privileges
-------------- ---------------------------- ------------------vs1
SeRestorePrivilege
SeSecurityPrivilege
cluster1::> vserver cifs users-and-groups privilege reset-privilege -vserver vs1

-user-or-group-name BUILTIN\Administrators
2226
vserver cifs users-and-groups privilege show

Display privileges
Description
The vserver cifs users-and-groups privilege show command displays
privilege overrides assigned to local or Active Directory users or groups.
Parameters
specify.
| [-instance ] }
about all fields.
If this parameter is specified, the command displays information only about privilege
overrides assigned to local or Active Directory users or groups that match the specified
Vserver name.
[-user-or-group-name <CIFS name>] - User or Group Name
user name or group name.
[-privileges <Privilege>, ...] - Privileges
privileges.
Examples
The following example displays all privileges explicitly associated with local or Active
Directory users or groups for Vserver "vs1".
2227
cluster1::> vserver cifs users-and-groups privilege show -vserver vs1

Vserver
User or Group Name
Privileges
-------------- ---------------------------- ------------------vs1
SeRestorePrivilege
2228
vserver config-replication pause

Temporarily pause Vserver configuration replication
privilege level.
Description
Vserver domain locking functionality locks the Vserver while Vserver DM is recording
configuration baseline. This command aborts the ongoing baseline generation activity,
unlocks the Vserver and temporarily pauses configuration replication for the Vserver.
Command confirmations has to be enabled to execute this command. The time at
which replication resumes is displayed after successful completion of the command.
Configuration changes made after executing this command is not replicated to the
partner cluster. If a disaster occurs during this time, the configuration changes made
are lost. Replication can be manually resumed by executing the vserver config
replication resume command.
Parameters
-vserver <vserver name> - Vserver name
Examples
cluster::> vserver config replication pause -vserver vs1
Vserver configuration replication will be paused, then automatically
resumed after five minutes.
Manually resume configuration replication by running the "vserver config
replication resume -vserver vs1" command.
Do you want to continue ? {y|n}: y
Vserver configuration replication is paused and will be resumed at:
5/24/2014 06:11:23
See Also
vserver config replication resume vserver config-replication resume
2229
vserver config-replication resume

Resume Vserver configuration replication
privilege level.
Description
This command resumes configuration replication of the Vserver which was temporarily
paused by using vserver config replication pause command. Successful
completion of the command ensures that configuration replication has been resumed for
the Vserver.
Parameters
-vserver <vserver name> - Vserver name
Examples
cluster::> vserver config replication resume -vserver vs1
See Also
vserver config replication pause vserver config-replication pause
2230
vserver config-replication show

Display Vserver configuration replication resume time
privilege level.
Description
The vserver config-replication show command displays the time at which the
configuration replication resumes for the Vserver.
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays resume time for the specified
Vserver.
Examples
cluster::> vserver config-replication show
Replication
Vserver
Resume Time
-----------
------------------
vs1
12/9/2014 03:18:48
See Also
vserver config-replication pause vserver config-replication resume
2231
vserver data-policy export

Display a data policy
Description
The vserver-data policy export command displays the current data policy for a Vserver
Parameters
This specifies the Vserver with Infinite Volume for which the data policy will be
displayed.
Examples
The following example shows the current data policy.
cluster1::> vserver data-policy export -vserver vs1
{ "ruleset_format_version" : "1.0",
"rules" : [
{ "rule_label" : "default",
"rule_id" : "ec17a05f-7785-11e1-baf4-123478563412",
"rule_scope" : [],
"rule_epoch" : { "epoch_reference" : "ctime" },
"rule_epochs" : {
"0" : {
"local" : {
"metadata" : {
"storageservice" : "-"
}
}
}
}
}
]
2232
2233
vserver data-policy import

Import a data policy
Description
The vserver data-policy import command sets a new data policy for a Vserver with
Infinite Volume. After entering the command, you are prompted to type or paste the
content of the new data policy. When you are done, press ENTER on a blank line.
Parameters
This specifies the Vserver with Infinite Volume for which the data policy will be changed.
Examples
The following examples attempt to change the Vserver data policy, first with bad
content, and then with an acceptable data policy.
cluster1::> vserver data-policy import -vserver vs1
Enter the contents of the file data policy for Vserver "vs1":
Press <Enter> when done
{ "foo" : "bar" }
Error: command failed: Data Policy validation failed: 'ruleset_format_version'

is a required field.
cluster1::> vserver data-policy import -vserver vs1
"rules" : [
2234
"rule_id" : "ec17a05f-7785-11e1-baf4-123478563412",
"rule_scope" : [],
"rule_epochs" : {
"0" : {
"local" : {
"metadata" : {
}
}
}
}
}
]
}
2235
vserver data-policy validate

Validate a data policy without import
Description
The vserver data-policy validate command checks a data policy for errors, without
modifying the data policy for the Vserver with Infinite Volume.
Parameters
This specifies the Vserver with Infinite Volume for which the data policy will be validated.
Examples
The following examples show first a problem with a given data policy, and then an
example of a valid data policy.
cluster1::> vserver data-policy validate -vserver vs1
{ "foo" : "bar" }
Error: command failed: Data Policy validation failed: 'ruleset_format_version'

is a required field.
cluster1::> vserver data-policy validate -vserver vs1
"rules" : [
2236
"rule_id" : "ec17a05f-7785-11e1-baf4-123478563412",
"rule_scope" : [],
"rule_epochs" : {
"0" : {
"local" : {
"metadata" : {
}
}
}
}
}
]
}
Data Policy validation succeeded: No errors found.
2237
vserver export-policy check-access

Given a Volume And/or a Qtree, Check to See If the Client Is Allowed Access
Description
The vserver export-policy check-access command checks whether a specific
client is allowed access to a specific export path. This enables you to test export policies
to ensure they work as intended and to troubleshoot client access issues.
The command takes the volume name (and optionally the qtree name) as input and
computes the export path for the volume/qtree. It evaluates the export policy rules that
apply for each path component and displays the policy name, policy owner, policy rule
index and access rights for that path component. If no export policy rule matches the
specified client IP address access is denied and the policy rule index will be set to 0.
The output gives a clear view on how the export policy rules are evaluated and helps
narrow down the policy and (where applicable) the specific rule in the policy that grants
or denies access. This command is not supported on Infinite Volumes.
Parameters
specify.
| [-instance ] }
about all fields.
This parameter specifies the name of the Vserver in which the export policy resides.
This parameter specifies the name of the volume that you want to check export access
for. To check export access for a qtree use the -qtree parameter. The -qtree parameter
is optional. If you specify the -qtree parameter, you must provide the name of the
2238
volume containing the qtree. If you do not specify the -qtree parameter, export access
will be checked only for the volume.
-client-ip <IP Address> - Client Address
This parameter specifies the IP address of the client that you want to check export
access for.
-authentication-method <authentication method> - Authentication Method
This parameter specifies the authentication method of the client that is attempting
access. Possible values include the following:
sys - The authentication method used by the client is AUTH_SYS.
krb5 - The authentication method used by the client is Kerberos v5.
krb5i - The authentication method used by the client is Kerberos v5i.
ntlm - The authentication method used by the client is CIFS NTLM.
none - The authentication method used by the client is not explicitly listed in the
list of values in the rorule.
-protocol <client access protocol> - Protocol
This parameter specifies the protocol that the client is using when attempting to access
the exported path. Possible values include the following:
nfs3 - The NFSv3 protocol
cifs - The CIFS protocol
flexcache - The FlexCache protocol
-access-type {read|read-write} - Access Rights to Check for
This parameter specifies the type of access you want to check for. Possible values are
read for read-only access and read-write for read-write access.
[-qtree <qtree name>] - Name of the Qtree
This optional parameter specifies the qtree in the volume that is part of the exported
path. If you specify this parameter, you must also provide the name of the volume the
qtree belongs to.
Examples
The following examples of the vserver export-policy check-access command
display various possible results for client export access checks.
2239
cluster1::*> vserver export-policy check-access -vserver vs1 -client-ip 1.2.3.4 volume flex_vol -authentication-method sys -protocol nfs3 -access-type read
Path
Policy
Policy
Policy
Owner
Owner Type
Rule
Index Access
----------------------------- ---------- --------- ---------- ------ ---------/
default
vs1_root
volume
1 read
/dir1
default
vs1_root
volume
1 read
/dir1/dir2
default
vs1_root
volume
1 read
/dir1/dir2/flex1
data
flex_vol
volume
10 read

cluster1::*> vserver export-policy check-access -vserver vs1 -client-ip 1.2.3.4 volume flex_vol -authentication-method sys -protocol nfs3 -access-type read-write
Path
Policy
Policy
Policy
Owner
Owner Type
Rule
Index Access
----------------------------- ---------- --------- ---------- ------ ---------/
default
vs1_root
volume
1 read
/dir1
default
vs1_root
volume
1 read
/dir1/dir2
default
vs1_root
volume
/dir1/dir2/flex1
data
flex_vol
volume
1 read
10 read-write

cluster1::*> vserver export-policy check-access -vserver vs1 -client-ip 1.2.3.4 volume flex_vol -authentication-method sys -protocol nfs3 -access-type read-write
-qtree qt1
Path
Policy
Policy
Policy
Owner
Owner Type
Rule
Index Access
----------------------------- ---------- --------- ---------- ------ ---------/
default
vs1_root
volume
1 read
/dir1
default
vs1_root
volume
1 read
/dir1/dir2
default
vs1_root
volume
1 read
/dir1/dir2/flex1
data
flex_vol
volume
10 read
/dir1/dir2/flex1/qt1
primarynames
qt1
qtree
0 denied
2240
vserver export-policy copy

Copy an export policy
Description
The vserver export-policy copy command creates a copy of an export policy on
the same or a different Vserver. The command fails if an export policy with the specified
new name already exists on the target Vserver.
Parameters
This parameter specifies the Vserver on which the export policy that you want to copy is
located.
-policyname <export policy name> - Policy Name
This parameter specifies the export policy that you want to copy.
-newvserver <vserver name> - New Vserver
This parameter specifies the Vserver to which you want to copy the export policy.
-newpolicyname <export policy name> - New Export Policy Name
This parameter specifies the name of the new policy.
Examples
The following example copies an existing policy named read_only_expolicy located on a
Vserver named vs0 to a new policy named default_expolicy located on a Vserver named
vs1.
vs1::> vserver export-policy copy -vserver vs0 -policyname read_only_expolicy newvserver vs1 -newpolicyname default_expolicy

Create a rule set
2241

Description
The vserver export-policy create command creates an export policy. You can
use the vserver export-policy rule create command to add rules to a policy.
Each cluster has an empty default export policy with the ID 0. This default export policy
does not contain any rules. You cannot delete the default export policy, but you can
rename or modify it.
Parameters
This parameter specifies the Vserver on which you want to create the export policy.
This parameter specifies the export policy that you want to create.
Examples
The following example creates an export policy named read_only_expolicy on a Vserver
named vs0:
vs1::> vserver export-policy create -vserver vs0 -policyname read_only_expolicy
See Also
vserver export-policy rule create
2242
vserver export-policy delete

Delete a rule set
Description
The vserver export-policy delete command deletes an export policy. You
cannot delete the default policy (named default) for a Vserver unless you delete the
Vserver.
Parameters
This parameter specifies the Vserver on which the export policy that you want to delete
is located.
This parameter specifies the export policy that you want to delete.
Examples
The following example deletes an export policy named test_expolicy from a Vserver
named vs0:
vs1::> vserver export-policy delete -vserver vs0 -policyname test_expolicy
vserver export-policy rename

Rename an export policy
Description
The vserver export-policy rename command renames an export policy.
2243
Parameters
This parameter specifies the Vserver on which the export policy is located.
This parameter specifies the export policy that you want to rename.
-newpolicyname <export policy name> - New Export Policy Name
This parameter specifies the new name of the export policy.
Examples
The following example renames an export policy named user_expolicy with the name
read_only_expolicy on a Vserver named vs0:
vs1::> vserver export-policy rename -vserver vs0 -policyname user_expolicy newpolicyname read_only_expolicy
vserver export-policy show

Display a list of rule sets
Description
The vserver export-policy show command displays the following information:
Vserver name
Export policy name
Policy ID (diagnostic privilege level only)
Parameters
specify.
| [-instance ] }
2244
about all entries.
If you specify this parameter, the command displays a list of export policies that are
located on the Vserver that you specify.
[-policyname <export policy name>] - Policy Name
If you specify this parameter, the command displays only the export policy or sets that
match the specified name.
Examples
The following example displays a list of all export policies:
vs1::> vserver export-policy show
VServer
Policy Name
---------------
-------------------
vs0
default_expolicy
vs0
read_only_expolicy
vs1
default_expolicy
vs1
test_expolicy
2245
vserver export-policy cache flush

Flush the export caches
level.
Description
The vserver export-policy cache flush command clears out the contents of
the export policy caches for a Vserver. You might need to flush the caches to allow the
changes to immediately take effect for your NFS clients because of:
A change to your export policy rules.
Modifying a host name record in a name server (i.e., local hosts or DNS).
Modifying the entries in a netgroup in a name server (i.e., local netgroup, LDAP, or
NIS).
Recovering from a network outage that resulted in a netgroup being partially
expanded.
To flush the caches, you must specify the following items:
Vserver: either a specific Vserver or use "*" to flush all of them.
You can optionally specify the following items:
Node: if flushing the access cache, you can also specify which node to flush it on.
Cache to flush: by default all but showmount will be flushed.
Note that the showmount cache is not used to determine NFS client access and as such
is only flushable explicitly.
Parameters
This parameter specifies the name of the Vserver on which you want to flush the
caches.
This parameter specifies the node on which you want to flush the access cache.
2246
[-cache {all|access|host|id|name|netgroup|showmount}] - Cache Name

This parameter specifies the name of the cache which you want to flush. Possible
values include the following:
all - All caches but showmount. This is the default.
access - The export-policy rules access cache.
host - The host name to IP cache.
id - The ID to credential cache.
name - The name to ID cache.
netgroup - The netgroup cache.
showmount - The showmount caches.
Examples
The following example flushes the access cache on a Vserver named vs0:
cluster1::> vserver export-policy cache flush -vserver vs0 -cache access
vserver export-policy netgroup check-membership

Check to see if the client is a member of the netgroup
Description
The vserver export-policy netgroup check-membership command
determines if the client IP address is a member of the netgroup. Data ONTAP can
determine the membership information only after it has fully loaded the netgroup into the
cache. Until then, while the reverse lookup scan algorithm might find a match, both DNS
round robin and DNS aliases prevent ruling out non-matches. You can use the vserver
export-policy netgroup queue show command to monitor the loading of the
netgroup.
Parameters
2247
This parameter specifies the name of the Vserver whose netgroup you want to check for
client membership.
-netgroup <text> - Name of the Netgroup
This parameter specifies the name of the netgroup that you want to check for client
membership.
-client-ip <IP Address> - Client Address
This parameter specifies the IP address of the client whose netgroup membership you
want to check.
Examples
The following examples of the vserver export-policy netgroup checkmembership command display various possible results for client membership checks.
cluster1::*> vserver export-policy netgroup check-membership -vserver vs1 netgroup mercury -client-ip 172.17.16.72
Client 172.17.16.72 is a member of netgroup "mercury" for Vserver "vs1" with
state "reverse lookup scan".
Client 172.17.16.72 is a member of netgroup "mercury" for Vserver "vs1" with
state "cache".
Client 172.17.16.14 is not a member of netgroup "mercury" for Vserver "vs1".
cluster1::*> vserver export-policy netgroup check-membership -vserver vs1 netgroup big -client-ip 172.17.16.69
Cannot yet determine the membership of client 172.17.16.69 in netgroup "big" for
Vserver "vs1". Try again when the netgroup is loaded in the cache.
cluster1::*> vserver export-policy netgroup check-membership -vserver vs1 netgroup big -client-ip 172.17.16.69
Client 172.17.16.72 is a member of netgroup "big" for Vserver "vs1" with state
"cache".
cluster1::*> vserver export-policy netgroup check-membership -vserver vs1 netgroup big -client-ip 2002:c65f:e228:0:0:0:0:0
Cannot yet determine the membership of client 2002:c65f:e228:: in netgroup "big"
for Vserver "vs1". Try again when the netgroup is loaded in the cache.
2248
See Also
vserver export-policy netgroup queue show
2249
vserver export-policy netgroup cache show

Show the Netgroup Cache
Description
The vserver export-policy netgroup cache show command displays
the contents of the export policy netgroup cache for a Vserver. Entries shown here
correspond to the caches used to evaluate client membership in a netgroup. To show
the netgroup cache, you must specify the following item:
Vserver: The name of the Vserver whose netgroup cache you want to display.
The following information is displayed per cache entry:
Vserver name: The name of the Vserver.
Netgroup name: The name of the netgroup.
State of the cache entry: The state of the cache entry. There are four possible
values:
initializing: The cache entry is being populated for the first time.
ready: Processing of the cache entry is complete and it is ready to be used.
not-found: The netgroup could not be found.
abandoned: The cache entry has been abandoned.
Total number of hosts in the netgroup cache: The number of host names retrieved
from the name service in mapping the netgroup to a list of hosts.
Number of IP addresses resolved: The number of IP addresses found when
translating hosts to IP addresses.
Number of hosts not found: The number of host names that failed to resolve to IP
addresses.
How long it took to expand the netgroup: How long it took to expand the netgroup
the last time in the queue.
Entry is refreshing: If the entry is a complete miss or refresh.
2250
Next refresh time: When the next refresh is scheduled to take place.
Note that each host might translate to more than one IP address so a one-to-one
mapping is not guaranteed. Additionally, a cache entry may still be ready to use while it
is refreshing.
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays the netgroup cache information
only if the Vserver name matches the specified value.
[-netgroup <text>] - Name of the Netgroup
only if the netgroup name matches the specified value.
[-cache-state {initializing|ready|not-found|abandoned}] - State of the Cache Entry
only if the netgroup cache state matches the specified value.
[-total-hosts <integer>] - Total Number of Hosts in the Netgroup
only if the netgroup record's count of host names matches the specified value.
[-num-ip-addrs <integer>] - Number of IP Addresses Resolved
only if the netgroup record's count of IP addresses matches the specified value.
[-num-hosts-not-found <integer>] - Number of Hosts Not Found
only if the netgroup record's count of failed host name lookups matches the specified
value.
2251
[-expansion-duration <[[<hours>:]<minutes>:]<seconds>>] - Expansion Duration

only if the netgroup record expansion time matches the specified value.
[-is-refreshing {true|false}] - Is Entry Refreshing?
only if the netgroup record refreshing state matches the specified value.
[-time-next-refresh <Date>] - Next Refresh Time
only if the time of the next scheduled refresh matches the specified value.
Examples
The following example displays the netgroup cache for the Vserver vs1 and the
netgroup netgroup1:
cluster1::> vserver export-policy netgroup cache show -vserver vs1 -netgroup
netgroup1
Vserver
Netgroup
State
-------- ---------- -----------vs1
2252
netgroup1
Ready
vserver export-policy netgroup queue show

Show the Netgroup Processing Queue
level.
Description
The vserver export-policy netgroup queue show command displays the
ongoing processing of the netgroup cache for a node. Entries shown here are not used
to evaluate client membership in a netgroup. The following information is displayed per
queue entry:
Vserver name: The name of the Vserver.
Netgroup name: The name of the netgroup.
Age of entry in the queue: How long the entry has been in the queue.
Queue state: The state of the entry in the queue. There are three possible values:
running: The entry is currently being processed.
waiting: The entry is waiting to be processed.
retrying: The entry is waiting to be reprocessed.
Note that as the vserver export-policy netgroup queue show
command is not atomic. Several queue entries might show up in the 'running'
state.
Number of times retried in the queue: The number of times was the entry was
taken off of the netgroup processing queue and added back on it.
Total number of hosts in the netgroup: The number of host names retrieved from
the name service in mapping the netgroup to a list of hosts.
Number of hosts processed: The number of hosts that have been processed.
Number of IP addresses resolved: The number of IP addresses found when
translating hosts to IP addresses.
Number of hosts not found: The number of host names that failed to resolve to IP
addresses.
2253
Note that each host name might translate to more than one IP address so a one-to-one
mapping is not guaranteed.
Parameters
specify.
| [-instance ] }
about all fields.
only if the Vserver name matches the specified value.
[-netgroup <text>] - Name of the Netgroup
only if the netgroup name matches the specified value.
[-queue-state {waiting|running|retrying}] - State of Entry in the Queue
only if the netgroup queue state matches the specified value.
[-age <[[<hours>:]<minutes>:]<seconds>>] - Age of Entry in the Queue
only if the age of when the netgroup record was put on the netgroup processing queue
[-retries-on-queue <integer>] - Number of Retries on the Queue
only if, during a refresh, the number of times the netgroup record has been put back on
the netgroup processing queue matches the specified value.
[-total-hosts <integer>] - Total Number of Hosts in the Netgroup
only if the netgroup record's count of hosts matches the specified value.
[-num-hosts-processed <integer>] - Number of Hosts Processed
2254
only if, during a refresh, the number of host name lookups matches the specified value.
[-num-ip-addrs <integer>] - Number of IP Addresses Resolved
only if, during a refresh, the number of host names converted to IP addresses matches
the specified value.
[-num-hosts-not-found <integer>] - Number of Hosts Not Found
only if, during a refresh, the number of host name lookup failures matches the specified
value.
Examples
The following example displays the netgroup queue:
cluster1::> vserver export-policy netgroup queue show
Age on
Vserver
Netgroup
State
Queue
Total
Hosts
Hosts Processed
---------- ---------- --------- --------- --------- --------testvs1
test-netgr retrying
test
waiting
0:0:47
12441
110
0:01:35
2255

Create a rule
Description
The vserver export-policy rule create command creates an export rule and
adds it to a policy. To create an export rule, you must specify the following items:
Vserver
Export policy
Clients that match the rule
Read-only access rule
Read-write access rule
You can optionally specify the following items:
Index number; that is, the location of the export rule in the policy
Access protocol
Anonymous ID
Superuser security type
Whether suid access is enabled
Whether creation of devices is enabled
Whether UNIX-type permissions changes on NTFS (Windows) volumes are
prohibited or allowed when the request originates from an NFS client (advanced
privilege and higher only)
Whether ownership changes are restricted or not (advanced privilege and higher
only)
Parameters
2256
-policyname <text> - Policy Name

This parameter specifies the name of the export policy to which you want to add the
new export rule. The export policy must already exist. To create an export policy, see the
vserver export-policy create command.
[-ruleindex <integer>] - Rule Index
This optional parameter specifies the index number of the export rule that you want to
create. If you specify an index number that already matches a rule, the index number
of the existing rule is incremented, as are the index numbers of all subsequent rules,
either to the end of the list or to an open space in the list. If you do not specify an index
number, the new rule is placed at the end of the policy's list.
[-protocol <client access protocol>, ...] - Access Protocol
This optional parameter specifies the list of access protocols for which you want to apply
the export rule. Possible values include the following:
any - Any current or future access protocol
nfs - Any current or future version of NFS
You can specify a comma-separated list of multiple access protocols for an export rule.
If you specify the protocol as any, you cannot specify any other protocols in the list. If
you do not specify this parameter, the value defaults to any.
-clientmatch <text> - Client Match Hostname, IP Address, Netgroup, or Domain
This parameter specifies the client or clients to which the export rule applies. You can
specify the match in any of the following formats:
As a hostname; for instance, host1
As an IPv4 address; for instance, 10.1.12.24
As an IPv6 address; for instance, fd20:8b1e:b255:4071::100:1
As an IPv4 address with a subnet mask expressed as a number of bits; for
instance, 10.1.12.10/4
instance, fd20:8b1e:b255:4071::/64
2257
As an IPv4 address with a network mask; for instance, 10.1.16.0/255.255.255.0

As a netgroup, with the netgroup name preceded by the @ character; for
instance, @eng
As a domain name preceded by the . character; for instance, .example.com
Note: Entering an IP address range, such as 10.1.12.10-10.1.12.70, is not allowed.
Entries in this format are interpreted as a text string and treated as a hostname.
-rorule <authentication method>, ... - RO Access Rule
This parameter specifies the security type for read-only access to volumes that use the
export rule. Possible values include the following:
sys - For an incoming request from a client matching the clientmatch criteria,
allow read access to the volume if the security type of that incoming request
is AUTH_SYS. The effective security type of the incoming request (to be used
subsequently in evaluation of rwrule/superuser) becomes sys.
krb5 - For an incoming request from a client matching the clientmatch criteria,
is Kerberos v5. The effective security type of the incoming request (to be used
subsequently in evaluation of rwrule/superuser) becomes krb5.
krb5i - For an incoming request from a client matching the clientmatch criteria,
allow read access to the volume if the security type of that incoming request is
Kerberos v5 with integrity service. The effective security type of the incoming
request (to be used subsequently in evaluation of rwrule/superuser) becomes
krb5i.
ntlm - For an incoming request from a client matching the clientmatch criteria,
is CIFS NTLM. The effective security type of the incoming request (to be used
subsequently in evaluation of rwrule/superuser) becomes ntlm.
any - For an incoming request from a client matching the clientmatch criteria,
allow read access to the volume regardless of the security type of that incoming
request. The effective security type of the incoming request (to be used
subsequently in evaluation of rwrule/superuser) remains the same as the security
type of the incoming request.
Note:
If the security type of the incoming request is AUTH_NONE, read access will be
granted to that incoming request as an anonymous user.
2258
none - For an incoming request from a client matching the clientmatch criteria,
allow read access to the volume as an anonymous user if the security type of
that incoming request is not explicitly listed in the list of values in the rorule.
The effective security type of the incoming request (to be used subsequently in
evaluation of rwrule/superuser) becomes none.
never - For an incoming request from a client matching the clientmatch criteria,
do not allow any access to the volume regardless of the security type of that
incoming request.
You can specify a comma-separated list of multiple security types for an export rule.
If you specify the security type as any or never, you cannot specify any other security
types.
Note:
For an incoming request from a client matching the clientmatch criteria, if the security
type doesn't match any of the values listed in rorule (as explained above), access will be
denied to that incoming request.
-rwrule <authentication method>, ... - RW Access Rule
This parameter specifies the security type for read-write access to volumes that use the
sys - For an incoming request from a client matching the clientmatch criteria, allow
write access to the volume if the effective security type (determined from rorule) of
that incoming request is AUTH_SYS.
allow write access to the volume if the effective security type (determined from
rorule) of that incoming request is Kerberos v5.
rorule) of that incoming request is Kerberos v5 with integrity service.
rorule) of that incoming request is CIFS NTLM.
allow write access to the volume regardless of the effective security type
(determined from rorule) of that incoming request.
Note:
2259
If the effective security type (determined from rorule) of the incoming request is
none, write access will be granted to that incoming request as an anonymous
user.
allow write access to the volume as an anonymous user if the effective security
type (determined from rorule) of that incoming request is none.
do not allow write access to the volume regardless of the effective security type
types.
Note:
For an incoming request from a client matching the clientmatch criteria, if the effective
security type (determined by rorule) doesn't match any of the values listed in rwrule (as
explained above), write access will be denied to that incoming request.
[-anon <text>] - User ID To Which Anonymous Users Are Mapped
This parameter specifies a UNIX user ID or user name that the user credentials are
mapped to when evaluation of rorule or superuser parameters result in user being
mapped to the anonymous user. The default setting of this parameter is 65534, which is
normally associated with the user name nobody. The following notes apply to the use of
this parameter:
To disable access by any client with a user ID of 0, specify a value of 65535.
[-superuser <authentication method>, ...] - Superuser Security Types
This parameter specifies a security type for superuser access to files. The default
setting of this parameter is none. Possible values include the following:
sys - For an incoming request from a client matching the clientmatch criteria and
with the user ID 0, allow superuser access to the volume if the effective security
type (determined from rorule) of that incoming request is AUTH_SYS.
krb5 - For an incoming request from a client matching the clientmatch criteria and
type (determined from rorule) of that incoming request is Kerberos v5.
krb5i - For an incoming request from a client matching the clientmatch criteria
and with the user ID 0, allow superuser access to the volume if the effective
2260
security type (determined from rorule) of that incoming request is Kerberos v5 with
integrity service.
ntlm - For an incoming request from a client matching the clientmatch criteria and
type (determined from rorule) of that incoming request is CIFS NTLM.
any - For an incoming request from a client matching the clientmatch criteria
and with the user ID 0, allow superuser access to the volume regardless of the
effective security type (determined by rorule) of that incoming request.
Note:
none, access will be granted to that incoming request as an anonymous user.
none - For an incoming request from a client matching the clientmatch criteria
and with the user ID 0, allow access to the volume as an anonymous user if the
effective security type (determined from rorule) of that incoming request is none.
You can specify a comma-separated list of multiple security types for superuser access.
If you specify the security type as any, you cannot specify any other security types.
Note:
For an incoming request from a client matching the clientmatch criteria and with the user
ID 0, if the effective security type doesn't match any of the values listed in superuser (as
explained above), the user ID is mapped to anonymous user.
[-allow-suid {true|false}] - Honor SetUID Bits in SETATTR
This parameter specifies whether set user ID (suid) and set group ID (sgid) access is
enabled by the export rule. The default setting is true.
[-allow-dev {true|false}] - Allow Creation of Devices
This parameter specifies whether the creation of devices is enabled by the export rule.
The default setting is true.
[-ntfs-unix-security-ops {ignore|fail}] - NTFS Unix Security Options (privilege:
advanced)
This parameter specifies whether UNIX-type permissions changes on NTFS (Windows)
volumes are prohibited (fail) or allowed (ignore) when the request originates from an
NFS client. The default setting is fail.
2261
[-chown-mode {restricted|unrestricted}] - Change Ownership Mode (privilege:

advanced)
This parameter specifies who is allowed to change the ownership mode of a file. The
default setting is restricted. The allowed values are:
restricted - Only root may change the ownership of the file.
unrestricted - Non-root users may change ownership of files that they own.
Examples
The following example creates an export rule with index number 1 in an export policy
named read_only_expolicy on a Vserver named vs0. The rule matches all clients in the
domain named example.com. The rule enables all access protocols. It enables readonly access by any matching client and requires authentication by AUTH_SYS, NTLM,
or Kerberos 5 for read-write access. Clients with the UNIX user ID zero are mapped to
user ID 65534 (which normally maps to the user name nobody). It does not enable suid
and sgid access or the creation of devices.
vs1::> vserver export-policy rule create -vserver vs0 -policyname
read_only_expolicy -ruleindex 1
-protocol any -clientmatch .example.com -rorule any -rwrule "ntlm,krb5,sys" -anon
65534 -allow-suid false
-allow-dev false
See Also
2262
vserver export-policy rule delete

Delete a rule
Description
The vserver export-policy rule delete command deletes an export rule from
a policy. You can specify the export rule by specifying its index number in the policy.
When you delete a rule, the other rules in the policy are not automatically renumbered
or reordered. You can use the vserver export-policy rule setindex
command to reorder the rules in a rule set.
Parameters
This parameter specifies the Vserver which contains the export policy.
This parameter specifies the export policy from which you want to delete a rule.
-ruleindex <integer> - Rule Index
This parameter specifies the index number of the rule that you want to delete. You can
use the vserver export-policy rule show command to view a list of rules with
their index numbers.
Examples
The following example deletes an export rule with the index number 5 from an export
policy named rs1 on a Vserver named vs0:
vs1::> vserver export-policy rule delete -vserver vs0
-policyname read_only_expolicy -ruleindex 5
See Also
vserver export-policy rule show vserver export-policy rule setindex
2263
vserver export-policy rule modify

Modify a rule
Description
The vserver export-policy rule modify command modifies a specified
export rule in a policy. This command cannot change the position of a rule in a policy;
to reorder rules in a policy, use the vserver export-policy rule setindex
command. You can use this command to change the following attributes of an export
rule:
Access protocol
Client match specification
Anonymous ID
Whether suid access is enabled
Whether UNIX-type permissions changes on NTFS (Windows) volumes are
prohibited or allowed when the request originates from an NFS client (advanced
privilege and higher only)
Whether ownership changes are restricted or not (advanced privilege and higher
only)
Parameters
This parameter specifies the name of the export policy containing the export rule that
you want to modify.
2264

This parameter specifies the index number of the export rule that you want to modify. To
view a list of rules with their index numbers, use the vserver export-policy rule
show command.
This optional parameter specifies the list of access protocols for which you want to apply
the export rule. Possible values include the following:
If you specify the protocol as any, you cannot specify any other protocols in the list. If
you do not specify this parameter, the value defaults to any.
[-clientmatch <text>] - Client Match Hostname, IP Address, Netgroup, or Domain
This parameter specifies the client or clients to which the export rule applies. You can
specify the match in any of the following formats:
instance, 10.1.12.10/4
instance, fd20:8b1e:b255:4071::/64
instance, @eng
2265
Note: Entering an IP address range, such as 10.1.12.10-10.1.12.70, is not allowed.

Entries in this format are interpreted as a text string and treated as a hostname.
[-rorule <authentication method>, ...] - RO Access Rule
This parameter modifies the security type for read-only access to volumes that use the
krb5i.
Note:
2266
incoming request.
types.
Note:
[-rwrule <authentication method>, ...] - RW Access Rule
This parameter modifies the security type for read-write access to volumes that use the
rorule) of that incoming request is Kerberos v5.
rorule) of that incoming request is Kerberos v5 with integrity service.
Note:
user.
2267
types.
Note:
This parameter specifies a UNIX user ID or user name that the user credentials are
mapped to when evaluation of rorule or superuser parameters result in user being
mapped to the anonymous user. The default setting of this parameter is 65534, which is
normally associated with the user name nobody. The following notes apply to the use of
this parameter:
To disable access by any client with a user ID of 0, specify a value of 65535.
This parameter specifies a security type for superuser access to files. The default
setting of this parameter is none. Possible values include the following:
krb5i - For an incoming request from a client matching the clientmatch criteria
and with the user ID 0, allow superuser access to the volume if the effective
security type (determined from rorule) of that incoming request is Kerberos v5 with
integrity service.
2268
Note:
Note:
This parameter specifies whether set user ID (suid) and set group ID (sgid) access is
enabled by the export rule. The default setting is true.
This parameter specifies whether the creation of devices is enabled by the export rule.
advanced)
This parameter specifies whether UNIX-type permissions changes on NTFS (Windows)
volumes are prohibited (fail) or allowed (ignore) when the request originates from an
NFS client. The default setting is fail.
advanced)
2269
This parameter specifies who is allowed to change the ownership mode of a file. The
default setting is restricted. The allowed values are:
restricted - Only root may change the ownership of the file.
unrestricted - Non-root users may change ownership of files that they own.
Examples
The following example modifies the export rule with index number 3 in an export policy
named default_expolicy on a Vserver named vs0. The rule is modified to match any
clients in the netgroup named group1 to enable NFSv2 and CIFS support, to enable
read-only access by any matching client, to require authentication by NTLM or Kerberos
5 for read-write access, and to enable suid and sgid access.
vs1::> vserver export-policy rule modify -vserver vs0 -policyname
default_expolicy -ruleindex 3 -protocol "nfs2,cifs"
-clientmatch @group1 -rorule any -rwrule "ntlm,krb5" -allow-suid true
See Also
vserver export-policy rule show vserver export-policy rule setindex
2270
vserver export-policy rule setindex

Move a rule to a specified index
Description
The vserver export-policy rule setindex command modifies the index
number of the specified export rule. If the new index number is already in use, the
command reorders the list to accommodate it. If the existing index is given a higher
index number (that is, later in the list), the command decrements the index numbers of
rules between the moved rule and moved-to rule; otherwise, the command increments
the index numbers between the moved-to rule and the existing rule.
You can use the vserver export-policy rule show command to view a list of
rules with their index numbers.
Parameters
This parameter specifies the export policy that contains the rule whose index number
you want to modify.
This parameter specifies the index number of the rule that you want to move.
-newruleindex <integer> - Index
This parameter specifies the new index number for the rule.
Examples
The following example changes the index number of a rule at index number 5 to index
number 3 in an export policy named rs1 on a Vserver named vs0:
vs1::> vserver export-policy rule setindex -vserver vs0
-policyname read_only_policy -ruleindex 5 -newruleindex 3
2271
See Also
vserver export-policy rule show
2272
vserver export-policy rule show

Display a list of rules
Description
The vserver export-policy rule show command displays information about
export rules. The command output depends on the parameter or parameters specified
with the command. If you do not specify any parameters, the command displays the
Vserver name
Export policy name
Export rule index number
Access protocol
Client match
To display detailed information about a specific export rule, run the command with the vserver, -policyname, and -ruleindex parameters. The detailed view provides all
of the information in the previous list and the following additional information:
Anonymous ID
Whether set user ID (suid) and set group ID (sgid) access is enabled
NTFS security settings
Change ownership mode
those parameters. For example, to display information only about export rules that have
a read-write rule value of never, run the command with the -rwrule never parameter.
2273
Parameters
specify.
| [-instance ] }
about all entries.
If you specify this parameter, the -policyname parameter, and the -ruleindex
parameter, the command displays detailed information about the specified export rule.
If you specify this parameter by itself, the command displays information only about the
export rules on the specified Vserver.
[-policyname <text>] - Policy Name
If you specify this parameter, the -vserver parameter, and the -ruleindex
export rules on the specified policy.
[-ruleindex <integer>] - Rule Index
If you specify this parameter, the -vserver parameter, and the -policyname
export rules that have the specified index number.
If you specify this parameter, the command displays information only about the export
rules that have the specified access protocol or protocols. Possible values include the
following:
2274
If you specify the protocol as any, you cannot specify any other protocols in the list.
[-clientmatch <text>] - Client Match Hostname, IP Address, Netgroup, or Domain
rules that have the specified client match. You can specify the match in any of the
following formats:
instance, 10.1.12.10/4
instance, fd20:8b1e:b255:4071::/64
instance, @eng
[-rorule <authentication method>, ...] - RO Access Rule
rule or rules that have the specified read-only rule. Possible values include the following:
krb5i.
2275
Note:
incoming request.
types.
Note:
[-rwrule <authentication method>, ...] - RW Access Rule
rule or rules that have the specified read-write rule. Possible values include the
following:
2276
rorule) of that incoming request is Kerberos 5.
allow write access to the volume if the security type of that incoming request is
krb5i.
Note:
user.
types.
Note:
2277
rule or rules that have the specified anonymous ID.
rule or rules that have the specified superuser security type. Possible values include the
following:
krb5i.
Note:
never - For an incoming request from a client matching the clientmatch criteria
and with the user ID 0, allow access to the volume as an anonymous user
regardless of the effective security type (determined from rorule) of that incoming
request.
Note:
2278
Only export rules that were created in an earlier release can have the superuser
parameter set to the security type never
Note:
rule or rules that have the specified setting for set user ID (suid) and set group ID (sgid)
access.
rule or rules that have the specified setting for the creation of devices.
advanced)
rule or rules that have the specified setting for the Vserver. The setting can either
prohibit (fail) or allow (ignore) UNIX-type permissions changes on NTFS (Windows)
volumes when the request originates from an NFS client.
[-ntfs-unix-security-ops-vs <NfsNtfsUnixSecOps>] - Vserver NTFS Unix Security
Options (privilege: advanced)
rule or rules that have the specified setting for the Vserver. The setting can either
prohibit (fail) or allow (ignore) UNIX-type permissions changes on NTFS (Windows)
volumes when the request originates from an NFS client.
advanced)
rule or rules that have the specified change ownership mode.
[-chown-mode-vs {restricted|unrestricted|use-export-policy}] - Vserver Change
Ownership Mode (privilege: advanced)
2279
If you specify this parameter, the command displays information only about the Vservers
that have the specified change ownership mode setting.
Examples
The following example displays information about all export rules:
vs1::> vserver export-policy rule show
Vserver
Policy
Rule
Access
Client
Name
Index
Protocol Match
RO
Rule
------------ ------------------ ------
-------- ------------ ------
vs0
default_expolicy
any
0.0.0.0/0
any
vs0
read_only_expolicy 2
any
0.0.0.0/0
any
vs1
default_expolicy
any
0.0.0.0/0
any
vs1
test_expolicy
any
0.0.0.0/0
any
2280
vserver fcp create

Create FCP service configuration
Description
This command creates an FCP service for a Vserver. An FCP service must be licensed
before you can manage FCP services. If the FCP service is not licensed, the FCP
command returns an error.
When you create an FCP service on a Vserver, the Vserver has the following
configuration defaults:
The administrative status of the FCP service is up.
The FCP command automatically generates a unique World Wide Node Name
(WWNN) unless you specify one.
The format for a WWNN is XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.
When selecting a new WWNN, use the following format to fit with the registered names:
2X:XX:00:0a:98:XX:XX:XX where XX is some integral value. If your unique WWNN
does not match this format, use the -f parameter. To modify a target-name, use the
vserver fcp modify command. The default value is up.
Parameters
Specifies the Vserver for the FCP service.
[-target-name <text>] - Target Name (privilege: advanced)
Specifies the World Wide Node Name (WWNN). The format for a WWNN is
XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.
[-status-admin {down|up}] - Administrative Status
Specifies the administrative status of the FCP service of a Vserver. If you set this
parameter to up, the FCP service will accept login requests from FCP initiators. If you
set this parameter to down, FCP initiators will not be allowed to log in.
[-force | -f [true]] - Force (privilege: advanced)
2281
Allows you to use a World Wide Node Name outside the Vendor's registered
namespace. If you use this parameter without a value, it is set to true, and the command
does not prompt you when the WWNN is outside the Vendor's registered namespace.
Examples
cluster1::> vserver fcp create -vserver vs_1
Creates an FCP service on Vserver vs_1.
See Also
vserver fcp modify
2282
vserver fcp delete

Delete FCP service configuration
Description
Deletes an FCP service of a Vserver. Before you can delete an FCP service, the
administration status must be down. Use the vserver fcp modify command to
change the administration status.
Parameters
Examples
cluster1::> vserver fcp delete -vserver vs_1
Deletes the FCP service on Vserver vs_1.
See Also
vserver fcp modify
2283
vserver fcp modify

Modify FCP service configuration
Description
This command modifies an FCP service configuration on a Vserver.
If the target name provided is outside the vendor's namespace, the user must verify that
the target name is unique outside the cluster. The vendor cannot verify that the target
name is unique outside the cluster if the vendor did not generate the target name.
Parameters
Specifies the World Wide Node Name (WWNN). The format for a WWNN is
XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.
Specifies the administrative status of the FCP service of a Vserver. If you set this
parameter to up, the FCP service begins to accept login requests from FCP initiators. If
you set this parameter to down, FCP initiators cannot log in.
[-force | -f [true]] - Force (privilege: advanced)
Allows you to use a World Wide Node Name outside the Vendor's registered
namespace. If you use this parameter without a value, it is set to true, and the command
does not prompt you when the WWNN is outside the Vendor's registered namespace.
Examples
cluster1::> vserver fcp modify -vserver vs_1 -status-admin down
Changes the administration status of the FCP service on Vserver vs_1 to down.
2284
vserver fcp show

Display FCP service configuration
Description
Displays the current status of the FCP service in a cluster.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display the FCP services that match the Vserver that you specify.
[-target-name <text>] - Target Name
Use this parameter to display the FCP service that matches the target name that you
specify.
Use this parameter to display the FCP services that match the administrative status that
you specify.
Examples
cluster1::> vserver fcp show
Status
Vserver
Target Name
Admin
---------- ---------------------------- -----vs0
20:00:00:a0:98:0c:b0:eb
up
vs2
20:01:00:a0:98:0c:b0:eb
up
2285
Displays the FCP configuration for all the Vservers in the cluster.
2286
vserver fcp start

Starts the FCP service
Description
This command starts the FCP service of a Vserver. When you start the FCP service, the
logical interfaces are brought online.
You must have a license before you can start the FCP service. Use system license
add to enable the FCP license.
Parameters
Examples
cluster1::> vserver fcp start -vserver vs_1
(vserver fcp start)
Starts FCP service for Vserver vs_1.
See Also
system license add
2287
vserver fcp stop

Stops the FCP service
Description
This command stops the FCP service of a Vserver. When you stop the FCP service, the
operation status of all FCP logical interfaces in the Vserver will be down.
Parameters
Examples
cluster1::> vserver fcp stop -vserver vs_1
(vserver fcp stop)
Stops FCP service on Vserver vs_1.
2288
vserver fcp initiator show

Display FCP initiators currently connected
Description
This command displays information about FCP initiators that are currently logged in.
If you do not specify a Vserver, the command displays all initiators logged into all
FCP Vservers within a cluster. If you specify a Vserver but not a logical interface, the
command displays information about all initiators connected to all logical interfaces
within the specified Vserver.
If an initiator belongs to an initiator group or has a World Wide Port Name (WWPN)
alias, the command displays this information.
Parameters
specify.
| [-instance ] }
about all fields.
[-vserver <Vserver Name>] - Vserver
Use this parameter to display the FCP initiators logged into the Vserver that you specify.
Use this parameter to display the FCP initiators that match the logical interfaces that you
specify.
[-wwpn <text>] - Initiator WWPN
Use this parameter to display the FCP initiators that matches the World Wide Port Name
(WWPN) that you specify.
[-port-address <Hex Integer>] - Port Address
2289
Use this parameter to display FCP initiators that match the port address that you
specify.
[-wwnn <text>] - Initiator WWNN
Use this parameter to display the FCP initiator that matches the World Wide Node
Name (WWNN) that you specify.
[-alias <text>, ...] - Initiator WWPN Alias
Use this parameter to display the FCP initiator that matches the alias name that you
specify.
[-igroup <text>, ...] - Igroup Name
Use this parameter to display the FCP initiator that matches the initiator group that you
specify.
Examples
cluster1::> vserver fcp initiator show
Vserver
Logical
Initiator
Initiator
Interface
WWNN
WWPN
Igroup
--------- ---------- -------------- ------------- ------------------------vs1
vs1.fcp
2f:a2:00:a0:98:0b:56:13
2f:a2:00:a0:98:0b:56:15
igroup1
Displays information regarding all logged in FCP initiators.
2290
vserver fcp interface show

Display configuration information for an FCP interface
Description
This command displays FCP logical interface information. If you do not specify a
Vserver, the command displays all of the FCP data interfaces of a cluster.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter with other options to display information about FCP logical interfaces
scoped to the specified Vserver.
Use this parameter to display FCP logical interfaces that match the names of logical
interfaces that you specify. You can provide a partial logical interface name, and press
tab to complete the name or the closest match.
Use this parameter to display FCP logical interfaces that match the World Wide Port
Name (WWPN) that you specify.
[-wwnn <text>] - WWNN
Use this parameter to display FCP logical interfaces that match the World Wide Node
Name (WWNN) that you specify.
2291
Specifies the configured status of the FCP logical interface. If you set this parameter to
up the command displays all FCP logical interfaces with the administrative status of up If
you set this parameter to down the command displays all the FCP logical interfaces with
the administrative status of down.
Specifies the current status of the FCP logical interface. If you set this parameter to up
the command displays all the FCP logical interfaces with the operational status of up If
you set this parameter to down the command displays all the FCP logical interfaces with
the operational status of down.
[-status-extended <text>] - Extended Status
Use this parameter to display more detailed information on the status of the FCP logical
interface that you specify.
[-port-address <Hex Integer>] - Host Port Address
Use this parameter to display FCP logical interfaces that match the host port address
that you specify.
Use this parameter to display FCP logical interfaces that are on the node that you
specify.
Use this parameter to display FCP logical interfaces that are on the port that you
specify.
Specifies whether the node hosting the FCP interface is the initially configured node. If
you use this command without using this parameter, it is set to true, and the command
displays all FCP interfaces that are on the initially configured node.
[-relative-port-id <integer>] - Relative Port ID
Use this parameter to display FCP logical interfaces that match the relative target port
ID that you specify. The system assigns each LIF and target portal group a relative
target port ID that is Vserver unique. You cannot change this ID.
Examples
cluster1::> vserver fcp interface show
Vserver
2292
Logical
Status
Current
Current Is
Interface
Admin/Oper WWPN
Node
Port
Home
---------- ---------- ---------- ---------------- ------------- ------- -----vs1
vs1.fcp
up/down
2f:a2:00:a0:98:0b:56:13
node1
0c
true
Displays all FCP interface information.
2293
vserver fcp portname set

Assigns a new WWPN to a FCP adapter
Description
This command assigns a new World Wide Port Name (WWPN) to a logical interface.
The administration status of logical interface must be down before you can change the
WWPN.
Use the network interface modify to change the administration status of the
logical interface.
Parameters
-vserver <Vserver Name> - Vserver
-lif <lif-name> - Logical Interface
Specifies the logical interface to which you want to assign a new WWPN.
-wwpn <text> - FCP Adapter WWPN
Specifies the WWPN that you want to change.
Allows you to use a WWPN that is not in the format 2X:XX:0a:09:80:XX:XX:XX when
set to true. If you use this parameter without a value, it is set to true, and the command
does not prompt you when the WWNN does not follow this format.
Examples
cluster1::*> vserver fcp portname set -vserver vs_1 -lif vs_1.fcp -wwpn
2f:a2:00:a0:98:0b:56:13
Sets a new WWPN for LIF vs_1.fcp on Vserver vs_1.
See Also
2294
2295
vserver fcp portname show

Display WWPN for FCP logical interfaces
Description
This command displays a list of World Wide Port Names (WWPN) that are used by the
FCP logical interfaces.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display a list of FCP logical interfaces and their WWPNs that
match the Vserver name you specify.
match the logical interface that you specify. You can use wildcards in the logical
interface to display a specific group of logical interfaces.
match the WWPN that you specify. You can use wildcards in the WWPN to display a
specific group of WWPNs.
Examples
cluster1::> vserver fcp portname show
Logical
2296
Vserver
Interface
---------
-------------- -------------------------
WWPN
vs_a
vs_a.fcp
2f:a2:00:a0:98:0b:56:13
vs_io1
vs_io1.fcp
2f:9e:00:a0:98:0b:56:13
vs_2
lif2
2f:a3:00:a0:98:0b:56:13
vs_2
lif3
2f:a4:00:a0:98:0b:56:13
vs_2
lif4
2f:a5:00:a0:98:0b:56:13
vs_2
lif5
2f:a6:00:a0:98:0b:56:13
vs_2
vs_2.fcp
2f:9a:00:a0:98:0b:56:13
vs1
vs1.fcp
2f:9d:00:a0:98:0b:56:13
vs1
vs1.fcp2
2f:97:00:a0:98:0b:56:13
Displays the WWPNs for each FCP logical interface for all the Vservers in a cluster.
2297
vserver fcp wwn blacklist show

Displays the blacklisted WWNs
privilege level.
Description
This command displays WWNs that have been blacklisted from re-use.
A blacklisted WWN is a WWN that is prohibited for use as either a fiber channel protocol
service WWNN or a fiber channel data LIF WWPN.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the blacklisted WWNs that match the parameter value.
Selects the blacklisted WWNs that were previously assigned to the Vserver(s) that
match the parameter value.
Examples
cluster1::> vserver fcp wwn blacklist show
WWN
Vserver
----------------------- ---------01:02:03:04:05:06:07:08 vs1

01:02:03:04:05:06:07:09 vs1
2298
Displays the blacklisted WWNs.
2299
vserver fcp wwpn-alias remove

Removes an alias for a World Wide Port Name of an initiator.
Description
This command removes an alias from a World Wide Port Name (WWPN).
Parameters
{ -alias | -a <text>, ... - Initiator WWPN Alias
Specifies the alias of the WWPN that you want to remove.
| -wwpn | -w <target_eui> } - Initiator WWPN
Specifies the WWPN.
Examples
cluster1::> vserver fcp wwpn-alias remove -vserver vs_1 -wwpn
2f:a0:00:a0:98:0b:56:13
On Vserver vs_1, removes all the aliases on WWPN 2f:a0:00:a0:98:0b:56:13.

cluster1::> vserver fcp wwpn-alias remove -vserver vs_1 -alias my_alias
On Vserver vs_1, removes the alias my_alias.
2300
vserver fcp wwpn-alias set

Set an alias for a World Wide Port Name of an initiator that might login to the target.
Description
This command creates a new alias for a World Wide Port Name (WWPN). You can
create multiple aliases for a WWPN, but you cannot use the same alias for multiple
WWPNs.
An alias name is a case-sensitive name that must contain one to 32 characters. Spaces
are not allowed.
Parameters
-alias | -a <text> - Initiator WWPN Alias
Specifies the alias of the WWPN.
-wwpn | -w <target_eui> - Initiator WWPN
Specifies the WWPN.
Allows you to override a WWPN associated with an existing alias with a newly specified
WWPN. If you use this parameter without a value, it is set to true, and the command
does not prompt you when you override an existing alias.
Examples
cluster1::> vserver fcp wwpn-alias set -vserver vs_1 -alias my_alias -wwpn
2f:a0:00:a0:98:0b:56:13
Sets the alias my_alias for the WWPN 2f:a0:00:a0:98:0b:56:13.
2301
vserver fcp wwpn-alias show

Displays a list of the WWPN aliases configured for initiators
Description
This command displays aliases associated with World Wide Port Names (WWPN).
Note:
You can also use these commands to display WWPN aliases:
lun igroup show
lun igroup create
lun igroup add
lun igroup remove
vserver fcp show
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display a list of WWPNs and the associated aliases that match
the Vserver name that you specify.
[-alias | -a <text>] - Initiator WWPN Alias
Use this parameter to display the WWPN that matches the alias that you specify.
2302
[-wwpn | -w <target_eui>] - Initiator WWPN

Use this parameter to display a list of aliases that match the WWPN that you specify.
Examples
cluster1::> vserver fcp wwpn-alias show
Vserver
Initiator
Initiator
WWPN
Alias
--------- ----------------------- -----------------vs1
2f:a0:00:a0:98:0b:56:13 my_alias
Displays the alias my_alias for the WWPN 2f:a0:00:a0:98:0b:56:13 on Vserver vs1.
See Also
lun igroup show lun igroup create lun igroup add lun igroup remove
vserver fcp show
2303
vserver fpolicy disable

Disable a policy
Description
The vserver fpolicy disable command disables an FPolicy policy for the
specified Vserver.
Note:
Parameters
This parameter specifies the name of the Vserver on which you want to disable an
FPolicy policy.
-policy-name <Policy name> - Policy
This parameter specifies the name of the FPolicy policy you want to disable.
Examples
The following command disables an FPolicy policy.
cluster1::> vserver fpolicy show
Vserver
Policy Name
Sequence
Status Engine
----------------------- ------------------------------ --------
------ --------
vs1.example.com
vs1_pol
off
native
vs2.example.com
vs2_pol
on
external

cluster1::> vserver fpolicy disable -vserver vs2.example.com -policy-name vs2_pol
Vserver
Policy Name
Sequence
----------------------- ------------------------------ --------
2304
Status
Engine
-------
-------
vs1.example.com
vs1_pol
off
vs2.example.com
external
vs2_pol
off
native
2305
vserver fpolicy enable

Enable a policy
Description
The vserver fpolicy enable command enables FPolicy policies for the specified
Vserver and sets their sequence (priority). The sequence is used when multiple policies
have subscribed to the same file access event. To modify the sequence number of
a policy, the administrator must disable the policy (if it is enabled) and then use this
command to enable it with the new sequence number. Policies that use the native
engine configuration will have a higher priority than policies for any other engine,
regardless of the sequence number assigned to them.
Note:
Parameters
This parameter specifies the name of the Vserver on which you want to enable an
FPolicy policy. The Vserver administrator can enable FPolicy policies created within
the scope of the Vserver and can also enable an FPolicy policy created by the cluster
administrator. The cluster administrator can enable FPolicy policies for any Vserver but
cannot enable them with a scope of cluster. The scope is determined at a Vserver level.
This parameter specifies the name of the FPolicy policy you want to enable.
-sequence-number <integer> - Policy Sequence Number
This parameter specifies the sequence number which will be assigned to the policy.
Examples
The following command enables an FPolicy policy.
2306
Vserver
Policy Name
Sequence
Status Engine
----------------------- ------------------------------ --------
------ --------
vs1.example.com
vs1_pol
off
native
vs2.example.com
vs2_pol
off
external
cluster1::> vserver fpolicy enable -vserver vs2.example.com -policy-name vs2_pol

-sequence-number 5
Vserver
Status
Engine
----------------------- ------------------------------ --------
Policy Name
Sequence
-------
-------
vs1.example.com
vs1_pol
off
native
vs2.example.com
external
vs2_pol
on
2307
vserver fpolicy engine-connect

Establish a connection to FPolicy server
Description
The vserver fpolicy engine-connect command connects an FPolicy server to
a specified node. Connecting the FPolicy server to a node enables FPolicy processing,
providing the FPolicy configuration is complete. Before connecting an FPolicy server to
a node, you must configure FPolicy by completing the following tasks:
Create an FPolicy event
Create an FPolicy external engine
Create an FPolicy policy
Create a scope for the FPolicy policy
Note:
The FPolicy event and external engine must be attached to the FPolicy policy.
Note:
The FPolicy policy should be enabled.
Note:
Parameters
This parameter specifies the node that you want to connect to the FPolicy server. The
value local specifies the current node.
2308
This parameter specifies the Vserver that you want to connect to the specified FPolicy
server using the specified FPolicy policy.
This parameter specifies the name of the FPolicy policy that is attached to an external
engine.
-server <IP Address> - Server
This parameter specifies the FPolicy server to which you want to connect the node.
The specified server must be present in the external engine configuration of the above
specified policy.
Examples
The following example connects an FPolicy server.
cluster1::> vserver fpolicy engine-connect -node FPolicy-01 -vserver
vs1.example.com -policy-name p -server 1.1.1.1

FPolicy
Server-
Server-
Vserver
type
Policy
Node
Server
status
--------------- ------------- ------------ ----------------- -----------------------vs1.example.com p

primary
FPolicy-01
1.1.1.1
connected
2309
vserver fpolicy engine-disconnect

Terminate connection to FPolicy server
Description
The vserver fpolicy engine-disconnect command disconnects an FPolicy
server from a specified node.
Note:
Parameters
This parameter specifies the node that you want to disconnect from the FPolicy server.
The value local specifies the current node.
This parameter specifies the Vserver that you want to disconnect from the specified
FPolicy server with the specified attached FPolicy policy.
This parameter specifies the name of the FPolicy policy that is attached with an external
engine.
-server <IP Address> - Server
This parameter specifies the FPolicy server you want to disconnect. The specified
server must be present in the external engine configuration of the above specified
FPolicy policy.
Examples
The following example disconnects an FPolicy server.
cluster1::> vserver fpolicy engine-disconnect -node FPolicy-01 -vserver
vs1.example.com -policy-name p -server 1.1.1.1
2310

FPolicy
Server-
Server-
Vserver
Policy
Node
Server
status
type
--------------- ------------- ------------ ----------------- -----------------------vs1.example.com p

primary
FPolicy-01
1.1.1.1
disconnected
2311
vserver fpolicy show-enabled

Display all enabled policies
level.
Description
The vserver fpolicy show-enabled command displays information about all
enabled policies in the Vserver. The command output depends on the parameter or
parameters specified with the command. If you do not specify any parameters, the
command displays the following information about all FPolicy policies:
Vserver name
Policy name
Priority
about FPolicy policies.
You can specify the -instance parameter to display information for all FPolicy policies
in a list format.
Note:
Parameters
| [-instance ] }
all entries.
If you specify this parameter, the command displays information only about the FPolicy
2312
[-policy-name <Policy name>] - Policy Name

policy that you specify.
[-priority <text>] - Policy Priority
policies with the policy priority that you specify.
Examples
The following example displays the information about enabled FPolicy policies on the
cluster.
cluster1::> vserver fpolicy show-enabled
Vserver
Policy Name
Priority
----------------------- ------------------------------ ---------vs1.example.com
pol_native
native
vs1.example.com
pol_native2
native
vs1.example.com
pol1
vs1.example.com
pol2
2313
vserver fpolicy show-engine

Display FPolicy server status
Description
The vserver fpolicy show-engine command displays status information for
all FPolicy external engines or displays status information only for FPolicy servers for
a specified Vserver. The command output depends on the parameter or parameters
displays the following information for all FPolicy servers:
Vserver name
Node name
FPolicy policy name
FPolicy server IP Address
FPolicy server status
FPolicy server type
about FPolicy servers. You can specify specific parameters to display only information
that matches those parameters. For instance, to display information only about all
FPolicy servers (external engines) that are connected, run the command with the fields parameter set to server and -server-status parameter set to connected.
You can specify the -instance parameter to display all information for all policies in
the list form.
Note:
Parameters
2314
| [-instance ] }
all entries.
external engine attached to the specified node.
server for the specified Vserver.
[-policy-name <Policy name>] - Policy
servers that are attached with the specified policy.
[-server <IP Address>] - Server
servers that you specify.
[-server-status <Status>] - Server Status
servers that have the specified status.
[-server-type <Server Type>] - Server Type
servers that have the specified server type.
[-connected-since <MM/DD/YYYY HH:MM:SS>] - Time FPolicy Server was Connected
servers that have been connected since the specified time.
[-disconnected-since <MM/DD/YYYY HH:MM:SS>] - Time FPolicy Server was
Disconnected
servers that have been disconnected since the specified time.
[-disconnect-reason <text>] - Reason for FPolicy Server Disconnection
2315
servers that are disconnected because of the specified reason.
[-disconnect-reason-id <integer>] - ID for FPolicy Server Disconnection
If you specify this parameter, the command displays information about the FPolicy
servers that are disconnected because of the specified disconnect reason ID. There is
a unique ID associated with each disconnect reason, which can be used to identify the
reason for FPolicy server disconnection.
[-session-id <text>] - Session ID
If you specify this parameter, the command displays information about the FPolicy
server that is connected with the specified session ID. There is a unique session ID
associated with each connection to FPolicy server, which can be used to identify the
established connection.
Examples
This example displays information about all FPolicy servers (external engines).
cluster1::> vserver fpolicy show-engine
FPolicy
ServerVserver
ServerPolicy
Node
Server
status
type
--------------- ------------- ------------ ----------------- -----------------------vs2.example.com vs2_pol

primary
FPolicy-01
9.9.9.9
connected
vs1.example.com vs1_pol
primary
FPolicy-01
1.1.1.1
connected
This example displays information only about all connected FPolicy servers (external
engines).
cluster1::> vserver fpolicy show-engine -fields server -server-status connected
node
vserver
policy-name server
---------- --------------- ----------- ------FPolicy-01 vs1.example.com vs1_pol
1.1.1.1
This example displays information about an FPolicy server.

cluster1::> vserver fpolicy show-engine -server 10.72.204.118 -instance
2316
Node: fpol-01
Vserver: vserver_1.example.com
Policy: pol_cifs
Server: 10.72.204.118
Server Status: disconnected
Server Type: primary
Time FPolicy Server was Connected: Time FPolicy Server was Disconnected: 2/5/2013 05:06:22
Reason for FPolicy Server Disconnection: TCP Connection to FPolicy server failed.
ID for FPolicy Server Disconnection: 9307
Session ID:
2317
vserver fpolicy show-passthrough-read-connection

Display connection status for FPolicy passthrough-read
Description
The vserver fpolicy show-passthrough-read-connection command
displays the status of the passthrough-read connection from all FPolicy servers.
Passthrough-read is a way to read data for offline files without restoring the files to
primary storage. If you do not specify any parameters, the command displays following
information about the passthrough-read connection from FPolicy servers:
Vserver name
FPolicy policy name
Node name
FPolicy server IP address
Passthrough-read connection status
You can specify the -fields parameter to specify which fields of information to display.
In addition to the fields above, you can display the following fields.
Session ID of the control channel
Time passthrough-read channel was connected
Time passthrough-read channel was disconnected
Reason for passthrough-read channel disconnection
You can specify the -instance parameter to display information for all passthroughread connections in the list form.
Parameters
| [-instance ] }
2318
all entries.
If you specify this parameter, the command displays information only about the
passthrough-read connections on the specified node.
passthrough-read connections for the specified Vserver.
passthrough-read connections that are attached with the specified FPolicy policy.
passthrough-read connections from the specified FPolicy server.
[-control-session-id <text>] - Session ID of the Control Channel
passthrough-read connections that are connected with the specified control session ID.
The passthrough-read connection is attached to a control connection that has a unique
control session ID.
[-server-status <Status of fpolicy passthrough-read connection>] - Server Status
passthrough-read connections that have the specified status.
[-connected-since <MM/DD/YYYY HH:MM:SS>] - Time Channel Was Connected
passthrough-read connections that have the specified connection time.
[-disconnected-since <MM/DD/YYYY HH:MM:SS>] - Time Channel Was Disconnected
passthrough-read connections that have the specified disconnection time.
[-disconnect-reason <Reason for fpolicy passthrough-read disconnection>] - Reason
for Disconnection
passthrough-read connections that are disconnected because of the specified
disconnect reason.
2319
Examples
This example displays information about passthrough-read connections from all FPolicy
servers.
cluster1::> vserver fpolicy show-passthrough-read-connection
Node
FPolicy
Server
Server
Status
Vserver
Policy Name
---------------
------------- ------------ ----------------- --------------
vs2.example.com
pol_cifs_2
FPolicy-01
2.2.2.2
disconnected
vs1.example.com
pol_cifs_1
FPolicy-01
1.1.1.1
connected
This example displays information about passthrough-read connections from all

connected FPolicy servers.
cluster1::> vserver fpolicy show-passthrough-read-connection -server-status
connected
Node
FPolicy
Server
Server
Status
Vserver
Policy Name
---------------
------------- ------------ ----------------- --------------
vs1.example.com
pol_cifs_1
FPolicy-01
1.1.1.1
connected
This example displays information about passthrough-read connections from FPolicy

servers configured in an FPolicy policy.
cluster1::> vserver fpolicy show-passthrough-read-connection -policy-name
pol_cifs_1 -instance
Node: FPolicy-01
Vserver: vserver_1.example.com
Policy: pol_cifs_1
Server: 2.2.2.2
Session ID of the Control Channel:
8cef052e-2502-11e3-88d4-123478563412
Server Status: connected
Time Passthrough Read Channel was Connected: 9/24/2013 10:17:45
Time Passthrough Read Channel was Disconnected: Reason for Passthrough Read Channel Disconnection: none
2320
2321
vserver fpolicy show

Display all policies with status
Description
The vserver fpolicy show command displays status information about all FPolicy
policies in the Vserver. The command output depends on the parameter or parameters
displays the following information about all FPolicy policies:
Vserver name
Policy name
Sequence number
Status
about FPolicy policies.
You can specify the -instance parameter to display information for all FPolicy policies
in a list format.
Note:
Parameters
| [-instance ] }
all entries.
2322
[-sequence-number <integer>] - Sequence Number
policy or policies that use the specified sequence-number.
[-status {on|off}] - Status
policy or policies that use the specified status.
[-engine <Engine name>] - FPolicy Engine
policy or policies that use the specified engine.
Examples
The following example displays the information about FPolicy policies on the cluster
using the vserver fpolicy show command.
Sequence
Vserver
Policy Name
Number
Status
Engine
---------
----------------------- -------------------------- ---------------FPolicy
cserver_policy
off
vs1.example.com
v1p1
off
vs1.example.com
v1p2
off
vs1.example.com
v1p3
off
vs1.example.com
cserver_policy
off
vs2.example.com
v1p1
on
vs2.example.com
v1p2
on
vs2.example.com
cserver_policy
on
eng1
eng2
native
native
eng1
native
eng3
eng1
2323
2324
vserver fpolicy policy create

Create a policy
Description
The vserver fpolicy policy create command creates an FPolicy policy. You
must create an FPolicy event name before creating an FPolicy policy. If you are using
an external FPolicy server, you must also create an FPolicy engine before creating a
policy.
Note:
Parameters
This parameter specifies the name of the Vserver on which you want to create an
FPolicy policy.
This parameter specifies the name of the FPolicy policy that you want to create. An
FPolicy policy name can be up to 256 characters long and is a string that can only
contain any combination of ASCII-range alphanumeric characters (a-z, A-Z, 0-9), "_"
and "." .
-events <Event name>, ... - Events to Monitor
This parameter specifies a list of events to monitor for the FPolicy policy. All the events
in the event list should be created by the administrator of the specified Vserver or the
cluster administrator. The events must already exist. Create events using the fpolicy
policy event create command.
-engine <Engine name> - FPolicy Engine
This parameter specifies an external engine for this FPolicy policy. An external engine
contains information required by the node to send notifications to an FPolicy server. The
Vserver administrator of the specified Vserver or the cluster administrator creates the
external engine prior to creating the FPolicy policy. If this parameter is not specified,
2325
the default native external engine is used. The native external engine is internal to Data
ONTAP and is used if you want to configure native file blocking and you do not want to
use an external FPolicy server.
[-is-mandatory {true|false}] - Is Mandatory Screening Required
This parameter specifies what action to take on a file access event in a case when all
primary and secondary servers are down or no response is received from the FPolicy
servers within a given timeout period. When this parameter is set to true, file access
events will be denied under these circumstances. To allow file access events under
these circumstances, set this parameter to false. By default, it is true.
[-allow-privileged-access {yes|no}] - Allow Privileged Access
This parameter specifies privileged access for FPolicy servers. It is used to specify
whether privileged access is required for FPolicy servers. Privileged access is used
when the FPolicy server requires direct access to the cluster nodes. With this option set
to yes, FPolicy servers can access files on the cluster using a separate data channel
with privileged access. By default, it is no.
[-privileged-user-name <text>] - User Name for Privileged Access
This parameter specifies the privileged user name. It is used to specify the privileged
user name for accessing files on the cluster using a separate data channel with
privileged access. The input for this field should be in "domain\user name" format. If allow-privileged-access is set to no, any value set for this field is ignored.
[-is-passthrough-read-enabled {true|false}] - Is Passthrough Read Enabled
This parameter specifies whether passthrough-read should be allowed for FPolicy
servers registered for the policy. Passthrough-read is a way to read data for offline
files without restoring the files to primary storage. Offline files are the files which have
been moved to secondary storage. If passthrough-read is enabled, the FPolicy server
provides the data for the file over a separate channel instead of restoring the file to
primary storage. By default, this parameter is false.
Examples
The following example creates an FPolicy policy.
cluster1::> vserver fpolicy policy create -vserver vs1.example.com -policy-name
vs1_pol -events cserver_evt,v1e1
-engine native -is-mandatory true -allow-privileged-access no -ispassthrough-read-enabled false
cluster1::> vserver fpolicy policy show -vserver vs1.example.com -policy-name
vs1_pol
2326
Policy Name: vs1_pol
Events to Monitor: cserver_evt, v1e1
FPolicy Engine: native
Is Mandatory Screening Required: true
Allow Privileged Access: no
User Name for Privileged Access: Is Passthrough Read Enabled: false
See Also
fpolicy policy event create
2327
vserver fpolicy policy delete

Delete a policy
Description
The vserver fpolicy policy delete command deletes an FPolicy policy.
Note:
Parameters
This parameter specifies the name of the Vserver from which you want to delete the
FPolicy policy.
This parameter specifies the name of the FPolicy policy that you want to delete.
Examples
The following example deletes an FPolicy policy.
cluster1::> vserver fpolicy policy delete -vserver vs1.example.com policy-name vs1_pol
vserver fpolicy policy modify

Modify a policy
Description
2328
The vserver fpolicy policy modify command modifies an FPolicy policy.

Note:
Parameters
This parameter specifies the name of the Vserver on which you want to modify an
FPolicy policy.
This parameter specifies the name of the FPolicy policy that you want to modify. An
FPolicy policy name can be up to 256 characters long and is a string that can only
contain any combination of ASCII-range alphanumeric characters (a-z, A-Z, 0-9), "_"
and ".".
[-events <Event name>, ...] - Events to Monitor
This parameter specifies a list of events to monitor for the FPolicy policy. All the events
in the event list should be created by the administrator of the specified Vserver or the
cluster administrator. The events must already exist. Create events using the fpolicy
policy event create command.
This parameter specifies an external engine for this FPolicy policy. An external engine
contains information required by the node to send notifications to an FPolicy server. The
Vserver administrator of the specified Vserver or the cluster administrator creates the
external engine prior to modifying the FPolicy policy. If this parameter is not specified,
the default native external engine is used. The native external engine is internal to Data
ONTAP and is used if you want to configure native file blocking and you do not want to
use an external FPolicy server.
This parameter specifies what action to take on a file access event in a case when all
primary and secondary servers are down or no response is received from the FPolicy
servers within a given timeout period. When this parameter is set to true, file access
events will be denied under these circumstances. To allow file access events under
these circumstances, set this parameter to false. By default, it is true.
This parameter specifies privileged access for FPolicy servers. It is used to specify
whether privileged access is required for FPolicy servers. Privileged access is used
2329
when the FPolicy server requires direct access to the cluster nodes. With this option set
to yes, FPolicy servers can access files on the cluster using a separate data channel
with privileged access. By default, it is no.
This parameter specifies the privileged user name. It is used to specify the privileged
user name for accessing files on the cluster using a separate data channel with
privileged access. The input for this field should be in "domain\user name" format. If allow-privileged-access is set to no, any value set for this field is ignored.
This parameter specifies whether passthrough-read should be allowed for FPolicy
servers registered for the policy. Passthrough-read is a way to read data for offline
files without restoring the files to primary storage. Offline files are the files which have
been moved to secondary storage. If passthrough-read is enabled, the FPolicy server
provides the data for the file over a separate channel instead of restoring the file to
primary storage. By default, this parameter is false.
Examples
The following example modifies an FPolicy policy.
cluster1::> vserver fpolicy policy modify -vserver vs1.example.com -policy-name
vs1_pol -events cserver_evt,v1e1
-engine native -is-mandatory true -allow-privileged-access no -ispassthrough-read-enabled false
cluster1::> vserver fpolicy policy show -vserver vs1.example.com -policy-name
vs1_pol
Policy Name: vs1_pol
Events to Monitor: cserver_evt, v1e1
FPolicy Engine: native
Is Mandatory Screening Required: true
Allow Privileged Access: no
User Name for Privileged Access: Is Passthrough Read Enabled: false
2330
See Also
fpolicy policy event create
2331
vserver fpolicy policy show

Display policy configuration
Description
The vserver fpolicy policy show command displays information about all
FPolicy policies belonging to the Vserver. Any Vserver administrator can see FPolicy
policies associated with their Vserver as well as policies created by the cluster
administrator. The command output depends on the parameter or parameters specified
following information about all FPolicy policies:
Vserver name
Policy name
Events to monitor
FPolicy engine
Is mandatory screening required
Allow privileged access
User name for privileged access
about FPolicy policies. You can specify additional parameters to display only information
that matches those parameters. For example, to display information only about FPolicy
policies where the FPolicy server requires privileged access, run the command with the
-fields parameter set to policy-name (no "-") and -allow-privileged-access
parameter set to yes.
You can specify the -instance parameter to display all information for all policies in
the list form.
Note:
Parameters
2332

| [-instance ] }
all entries.
policies for the specified Vserver. FPolicy policies created by the cluster administrator
are visible for all Vservers.
[-events <Event name>, ...] - Events to Monitor
policy or policies that use the specified event or events.
policy or policies that use the specified engine.
policy or policies that use the specified mandatory attribute.
policy or policies that use the specified privileged access.
policy or policies that use the specified privileged user name.
policies that use the specified passthrough-read setting.
2333
Examples
The following example displays the information about FPolicy policies on the cluster
using the vserver fpolicy policy show command.
cluster1::> vserver fpolicy policy show

Vserver
Is Mandatory
PrivAccess
--------------- -----------
Policy
---------- -------------
------------
----------
Cluster
cserver_
cserver_eng
true
yes
cserver_pol
Events
Engine
evt
vs1.example.com p
true
no
vs1.example.com cserver_pol
cserver_
cserver_eng
true
yes
cserver_eng
true
yes
evt
cserver_
evt
The following example displays FPolicy policy name information about all Vserver
FPolicy policies with the -allow-privileged-access parameter set to "yes".
cluster1::> vserver fpolicy policy show -fields policy-name -allow-privilegedaccess yes

vserver
policy-name
--------------- ----------Cluster
cserver_pol
2334
vserver fpolicy policy event create

Create an event
Description
The vserver fpolicy policy event create command creates an FPolicy
event. An event describes what to monitor. An event can contain protocol, file
operations, filters, and volume operation event types. In the FPolicy configuration, an
event is attached to an FPolicy policy. You can attach the same event to one or more
policies.
Note:
Note:
There is dependency in three fields (-protocol, -files-operations, -filters )
and the following are the valid combination of the three fields:
-protocol cifs -file-operations open,close
-protocol cifs -file-operations open,close -filters monitor-ads,offlinebit
Specify none of the three (-protocol , -files-operations , -filters )
fields
Parameters
FPolicy event.
-event-name <Event name> - Event
This parameter specifies the name of the FPolicy event that you want to create. An
event name can be up to 256 characters long. An event name value is a string that can
2335
only contain any combination of ASCII-range alphanumeric characters (a-z, A-Z, 0-9),
"_" and ".".
[-protocol <Protocol>] - Protocol
This parameter specifies the protocol name for which the event will be created.
By default, no protocol is selected. The value of this parameter must be one of the
following:
cifs - This specifies that the event is for the CIFS protocol.
nfsv3 - This specifies that the event is for the NFSv3 protocol.
Note:
If you specify -protocol, then you must also specify a valid value for the -fileoperations parameter.
[-file-operations <File Operation>, ...] - File Operations
This parameter specifies a list of file operations for the FPolicy event. The event will
check the operations specified in this list from all client requests using the protocol
specified in the -protocol parameter. The list can include one or more of the following
operations:
close - File close operations.
create - File create operations.
create_dir - Directory create operations.
delete - File delete operations.
delete_dir - Directory delete operations.
getattr - Get attribute operations.
link - Link operations.
lookup - Lookup operations.
open - File open operations.
read - File read operations.
write - File write operations.
rename - File rename operations.
rename_dir - Directory rename operations.
2336
setattr - Set attribute operations.

symlink - Symbolic link operations.
Note:
If you specify -file-operations then you must specify a valid protocol in the protocol parameter.
[-filters <Filter>, ...] - Filters
This parameter specifies a list of filters of given file operation or operations for the
protocol specified in the -protocol parameter. The values in the -filters parameter
are used to filter client requests. The list can include one or more of the following:
monitor-ads - Filter the client request for alternate data stream.
close-with-modification - Filter the client request for close with modification.
close-without-modification - Filter the client request for close without modification.
first-read - Filter the client request for first read.
first-write - Filter the client request for first write.
offline-bit - Filter the client request for offline bit set. Setting this filter, FPolicy
server receives notification only when offline files are accessed.
open-with-delete-intent - Filter the client request for open with delete intent.
Setting this filter, FPolicy server receives notification only when an attempt is
made to open a file with the intent to delete it. This is used by file systems when
the FILE_DELETE_ON_CLOSE flag is specified.
open-with-write-intent - Filter the client request for open with write intent. Setting
this filter, FPolicy server receives notification only when an attempt is made to
open a file with the intent to write something in it.
write-with-size-change - Filter the client request for write with size change.
Note:
If you specify a value for the -filters parameter, then you must also specify valid
values for the -file-operations and -protocol parameters.
[-volume-operation {true|false}] - Is Volume Operation Required
This parameter specifies volume operation for which event will be created. By default, it
is false.
2337
Examples
The following example creates an FPolicy event.
cluster1::> vserver fpolicy policy event create -vserver
vs1.example.com -event-name cifs_event -protocol cifs
-file-operations
open,close,read,write -filters first-read,offline-bit
-volume-operation
true
cluster1::> vserver fpolicy policy event show -vserver
vs1.example.com -event-name cifs_event
Event Name: cifs_event
Protocol: cifs
File Operations: open, close, read, write
Filters: first-read, offline-bit
Volume Operation: true
The following is a list of supported -file-operations and -filters for the CIFS
protocol.
Supported
file
| Supported
|
filters
operations |
============================================================================================
close
: monitor-ads, close-with-modification, close-withoutmodification, offline-bit
create
: monitor-ads, offline-bit
create_dir : currently no filter is supported for this file operation

delete
delete_dir : currently no filter is supported for this file operation

getattr
open
write-intent
read
2338
: offline-bit
: monitor-ads, offline-bit, open-with-delete-intent, open-with: monitor-ads, first-read, offline-bit
write
: monitor-ads, first-write, offline-bit, write-with-size-change
rename
: offline-bit, monitor-ads
rename_dir : currently no filter is supported for this file operation

setattr
The following is a list of supported -file-operations and -filters for the nfsv3
protocol.
Supported
file
| Supported
|
filters
operations |
=======================================================================
create
: offline-bit

delete
: offline-bit

link
: offline-bit
lookup
: offline-bit
read
: offline-bit
write
: offline-bit, write-with-size-change
rename
: offline-bit

setattr
: offline-bit
symlink
: offline-bit
protocol.
Supported
file
| Supported
|
filters
operations |
=======================================================================
close
: offline-bit
create
: offline-bit

delete
: offline-bit

getattr
: offline-bit
link
: offline-bit
2339
lookup
: offline-bit
open
: offline-bit
read
: offline-bit
write
rename
: offline-bit
2340
setattr
: offline-bit
symlink
: offline-bit
vserver fpolicy policy event delete

Delete an event
Description
The vserver fpolicy policy event delete command deletes an FPolicy
event.
Note:
Parameters
This parameter specifies the Vserver from which you want to delete an FPolicy event.
This parameter specifies the name of the FPolicy event you want to delete.
Examples
The following example deletes an FPolicy event.
cluster1::> vserver fpolicy policy event delete
event-name cifs_event
-vserver vs1.example.com -
vserver fpolicy policy event modify

Modify an event
Description
2341
The vserver fpolicy policy event modify command modifies an FPolicy

event. An event describes what to monitor. An event can contain protocol, file
operations, filters, and volume operation event types. In the FPolicy configuration, an
event is attached to an FPolicy policy. You can attach the same event to one or more
policies. You can modify an event while it is attached to an FPolicy policy. Any changes
to the event take effect immediately.
Note:
Note:
There is dependency in three fields (-protocol, -files-operations, -filters )
and the following are the valid combination of the three fields:
-protocol cifs -file-operations open,close
-protocol cifs -file-operations open,close -filters monitor-ads,offlinebit
Specify none of the three (-protocol , -files-operations , -filters )
fields
Parameters
FPolicy event.
This parameter specifies the name of the FPolicy event that you want to modify. An
event name can be up to 256 characters long. An event name value is a string that can
only contain any combination of ASCII-range alphanumeric characters (a-z, A-Z, 0-9),
"_" and "." .
This parameter specifies the protocol name for which the event will be modified.
By default, no protocol is selected. The value of this parameter must be one of the
following:
cifs - This specifies that the event is for the CIFS protocol.
2342
Note:
If you specify -protocol, then you must also specify a valid value for the -fileoperations parameter.
This parameter specifies a list of file operations for the FPolicy event. The event will
check the operations specified in this list from all client requests using the protocol
specified in the -protocol parameter. The list can include one or more of the following
operations:
close - File close operations.
create - File create operations.
create_dir - Directory create operations.
delete - File delete operations.
delete_dir - Directory delete operations.
getattr - Get attribute operations.
link - Link operations.
lookup - Lookup operations.
open - File open operations.
read - File read operations.
write - File write operations.
rename - File rename operations.
rename_dir - Directory rename operations.
setattr - Set attribute operations.
symlink - Symbolic link operations.
Note:
If you specify -file-operations then you must specify a valid protocol in the protocol parameter.
2343
This parameter specifies a list of filters of given file operation or operations for the
protocol specified in the -protocol parameter. The values in the -filters parameter
are used to filter client requests. The list can include one or more of the following:
monitor-ads - Filter the client request for alternate data stream.
close-with-modification - Filter the client request for close with modification.
close-without-modification - Filter the client request for close without modification.
first-read - Filter the client request for first read.
first-write - Filter the client request for first write.
offline-bit - Filter the client request for offline bit set. Setting this filter, FPolicy
server receives notification only when offline files are accessed.
open-with-delete-intent - Filter the client request for open with delete intent.
Setting this filter, FPolicy server receives notification only when an attempt is
made to open a file with the intent to delete it. This is used by file systems when
the FILE_DELETE_ON_CLOSE flag is specified.
open-with-write-intent - Filter the client request for open with write intent. Setting
this filter, FPolicy server receives notification only when an attempt is made to
open a file with the intent to write something in it.
write-with-size-change - Filter the client request for write with size change.
Note:
If you specify a value for the -filters parameter, then you must also specify valid
values for the -file-operations and -protocol parameters.
This parameter specifies volume operation for which event will be modified. By default, it
is false.
Examples
The following example modifies an FPolicy event.
cluster1::> vserver fpolicy policy event modify -vserver
vs1.example.com -event-name cifs_event -protocol cifs
-file-operations
open,close,read,write -filters first-read,offline-bit
-volume-operation
true
2344
cluster1::> vserver fpolicy policy event show -vserver

vs1.example.com -event-name cifs_event
Event Name: cifs_event
Protocol: cifs
File Operations: open, close, read, write
Filters: first-read, offline-bit
Volume Operation: true
The following is a list of supported -file-operations and -filters for the CIFS
protocol.
Supported
file
| Supported
|
filters
operations |
============================================================================================
close
: monitor-ads, close-with-modification, close-withoutmodification, offline-bit
create

delete

getattr
: offline-bit
open
write-intent
: monitor-ads, offline-bit, open-with-delete-intent, open-with-
read
: monitor-ads, first-read, offline-bit
write
: monitor-ads, first-write, offline-bit, write-with-size-change
rename

setattr
protocol.
Supported
| Supported
2345
file
filters
operations |
=======================================================================
create
: offline-bit

delete
: offline-bit

link
: offline-bit
lookup
: offline-bit
read
: offline-bit
write
rename
: offline-bit

setattr
: offline-bit
symlink
: offline-bit
protocol.
Supported
file
| Supported
|
filters
operations |
=======================================================================
close
: offline-bit
create
: offline-bit

delete
: offline-bit

getattr
: offline-bit
link
: offline-bit
lookup
: offline-bit
open
: offline-bit
read
: offline-bit
write
rename
: offline-bit
2346
setattr
: offline-bit
symlink
: offline-bit
vserver fpolicy policy event show

Display events
Description
The vserver fpolicy policy event show command displays information about
all FPolicy events belonging to the Vserver. Any Vserver administrator can see FPolicy
events associated with their Vserver as well as FPolicy events created by the cluster
administrator. The command output depends on the parameter or parameters specified
following information about all FPolicy events:
Vserver name
FPolicy event name
Protocol name
List of file operations
List of filters
Volume operation
about FPolicy events. You can specify additional parameters to display only information
that matches those parameters. For example, to display information only about all CIFS
events configured with the -volume-operation field set, run the command with the
-fields parameter set to -event-name event-name -protocol cifs -volumeoperation yes.
You can specify the -instance parameter to display all information for all policies in a
list format.
Note:
Parameters
2347
| [-instance ] }
all entries.
events for the specified Vserver. Events created on the admin Vserver by the cluster
administrator are visible in all Vservers.
[-event-name <Event name>] - Event
event that matches the specified event name.
event or events that use the specified protocol.
event or events that use the specified file operation or operations.
event or events that use the specified filter or filters.
If you set this parameter to true, the commands displays information about events where
the -volume-operation parameter is set true . If you set this parameter to false,
the command displays information about events where the -volume-operation
parameter is set false.
Examples
The following example displays the information about all Vserver FPolicy policy events.
cluster1::> vserver fpolicy policy event show
Event
File
Volume
Filters
2348
Vserver
Operation
Name
Protocols Operations
--------------- ------------------ --------- ------------------------ -----------Cluster
cserver_evt
cifs
open, close,
first-
read, write
first-
open, close,
first-
read, write
first-
write, true
read
vs1.example.com cserver_evt
cifs
write, true
read
read
vs1.example.com v1e1
cifs
open, read
first-
cifs
open
nfsv4
open
vs2.example.com cserver_evt
cifs
open, close,
first-
read, write
first-
false
true
write, true
read
The following example displays event name information about all Vserver FPolicy policy
events with CIFS as a protocol and with false as volume operation.
cluster1::> vserver fpolicy policy event show -fields event-name protocol cifs -volume-operation false
vserver
event-name
--------------- ---------vs1.example.com v1e2
2349
vserver fpolicy policy external-engine create

Create an external engine
Description
The vserver fpolicy policy external-engine create command creates
an FPolicy external engine. The cluster uses the external engine to hold configuration
information that it needs in order to send notification information to the FPolicy servers.
It specifies the primary servers and secondary servers to which the cluster will send
notifications. It also specifies FPolicy server related configuration information.
Note:
Parameters
FPolicy external engine.
-engine-name <Engine name> - Engine
This parameter specifies the name of the FPolicy external engine that you want to
create. An external engine name can be up to 256 characters long. An external engine
name is a string that can only contain any combination of ASCII-range alphanumeric
characters (a-z, A-Z, 0-9), "_", and "." .
-primary-servers <IP Address>, ... - Primary FPolicy Servers
This parameter specifies a list of IP addresses for the primary FPolicy servers to which
you want the external engine you create to apply. The -primary-servers parameter
is used to specify a list of servers to which to send file access events for a given
FPolicy policy. When an administrator configures multiple servers as primary servers,
notifications are sent to the FPolicy servers in a round-robin fashion.
-port <integer> - Port Number of FPolicy Service
This parameter specifies the port number for the FPolicy service.
2350
[-secondary-servers <IP Address>, ...] - Secondary FPolicy Servers

This parameter specifies a list of IP addresses for the secondary FPolicy servers to
which you want the external engine you create to apply. Secondary servers will be used
only when all the primary servers are not reachable. When an administrator configures
multiple servers as secondary servers, notifications are sent to FPolicy server in a
round-robin fashion. By default, no secondary server is selected.
[-extern-engine-type <External Engine Type>] - External Engine Type
This parameter specifies the type of the external engine. This specifies how the FPolicy
server should behave, synchronously or asynchronously. By default, it is synchronous
in nature. When set to synchronous, after sending a notification to the external FPolicy
server, request processing does not continue until after receiving a response from the
FPolicy server. At that point request flow either continues or processing results in denial,
depending on whether the response from the FPolicy server permits the requested
action. When set to asynchronous, after sending a notification to the external FPolicy
server, file request processing continues.
-ssl-option {no-auth|server-auth|mutual-auth} - SSL Option for External Communication
This parameter specifies the SSL option for external communication with the FPolicy
server. Possible values include the following:
no-auth : When set to no-auth, no authentication takes place. The communication
link is established over the TCP protocol.
server-auth : When set to server-auth, only the FPolicy server is authenticated
by the Vserver. With this option, before creating the FPolicy external engine, the
administrator must install the public certificate of the certificate authority (CA) that
signed the FPolicy server certificate.
mutual-auth : When set to mutual-auth, mutual authentication takes place
between the Vserver and the FPolicy server, i.e. authentication of the FPolicy
server by the Vserver along with authentication of the Vserver by the FPolicy
server. With this option, before creating the FPolicy external engine, the
signed the FPolicy server certificate along with the public certificate and key file
for authentication of the Vserver.
The public certificate of certificate authority (CA) that is used to sign the FPolicy server
certificate is installed using the security certificate install command with type set to client_ca. The private key and public certificate required for authentication
of the Vserver is installed using the security certificate install command
with -type set to server.
2351
[-reqs-cancel-timeout <[<integer>h][<integer>m][<integer>s]>] - Timeout for Canceling

a Request (privilege: advanced)
This parameter specifies the timeout for canceling a request. It is used to specify the
time interval in which the node waits for a response from the FPolicy server. Beyond this
timeout, a cancel request is sent to the FPolicy server to cancel the pending request.
The request is then sent to an alternate FPolicy server that is registered for the policy.
This timeout helps in handling a FPolicy server that is not responding, which can
improve CIFS/NFS client response. Also, this feature can help in releasing of system
resources since the request is moved from a down/bad FPolicy server to an alternate
FPolicy server. The value for this field must be between 0s and 100s. By default, it is
20s.
[-reqs-abort-timeout <[<integer>h][<integer>m][<integer>s]>] - Timeout for Aborting a
Request (privilege: advanced)
This parameter specifies the timeout for aborting a request. The value for this field must
be between 0s and 200s. By default, it is 40s.
[-status-req-interval <[<integer>h][<integer>m][<integer>s]>] - Interval for Sending
Status Requests (privilege: advanced)
This parameter specifies the interval for sending status requests. It is used to specify the
interval after which a status request will be send to the FPolicy server. The value for this
field must be between 0s and 50s. By default, it is 10s.
[-max-connection-retries <integer>] - Max Reconnect Attempt (privilege: advanced)
This parameter specifies the maximum number of attempts to reconnect to the FPolicy
server from a Vserver. It is used to specify the number of times a broken connection will
be retried. The value for this field must be between 0 and 20. By default, it is 5.
[-max-server-reqs <integer>] - Maximum Outstanding Requests for FPolicy Server
This parameter specifies the maximum number of outstanding requests for the FPolicy
server. It is used to specify maximum outstanding requests that will be queued up for the
FPolicy server. The value for this field must be between 1 and 10000. By default, it is 50.
[-server-progress-timeout <[<integer>h][<integer>m][<integer>s]>] - Timeout for
Disconnecting Non-responsive Server (privilege: advanced)
This parameter specifies the timeout for disconnecting non-responsive FPolicy servers.
It is used to specify the time interval after which the connection to the FPolicy server is
terminated. This happens only when the FPolicy server's queue contains the maximum
allowed number of requests that it can hold in its queue and no response is received
within this timeout. The maximum allowed number of requests is either 50 (the default)
2352
or the number specified by the -max-server-reqs parameter. The value for this field
must be between 1s and 100s. By default, it is 60s.
[-keep-alive-interval <[<integer>h][<integer>m][<integer>s]>] - Interval for Sending
Keep-Alive Messages (privilege: advanced)
This parameter specifies the interval in hours (h), minutes (m), or seconds (s) at which
keep-alive messages are sent to the FPolicy server. Keep-alive messages are used to
detect half-open connections. The range of supported values for this field is 10 through
600 (h, m, or s). Alternatively, the value can be set to 0, which disables keep-alive
messages and prevents them from being sent to the FPolicy servers. The default value
for this field is 120s.
[-certificate-common-name <FQDN or Custom Common Name>] - FQDN or Custom
Common Name
This parameter specifies the certificate name as a fully qualified domain name (FQDN)
or custom common name. The certificate is used if SSL authentication between the
Vserver and the FPolicy server is configured.
[-certificate-serial <text>] - Serial Number of Certificate
This parameter specifies the serial number of the certificate used for authentication if
SSL authentication between the Vserver and the FPolicy server is configured.
[-certificate-ca <text>] - Certificate Authority
This parameter specifies the certificate authority (CA) name of the certificate used for
authentication if SSL authentication between the Vserver and the FPolicy server is
configured.
[-recv-buffer-size <integer>] - Receive Buffer Size (privilege: advanced)
This parameter specifies the receive buffer size of the connected socket for the FPolicy
server. The default value is set to 256 kilobytes (Kb). When the value is set to 0, the size
of the receive buffer is set to a value defined by the system. For example, if the default
receive buffer size of the socket is 65536 bytes, by setting the tunable value to 0, the
socket buffer size is set to 65536 bytes. You can use any non-default value to set the
size (in bytes) of the receive buffer.
[-send-buffer-size <integer>] - Send Buffer Size (privilege: advanced)
This parameter specifies the send buffer size of the connected socket for the FPolicy
of the send buffer is set to a value defined by the system. For example, if the default
send buffer size of the socket is set to 65536 bytes, by setting the tunable value to 0, the
socket buffer size is set to 65536 bytes. You can use any non-defualt value to set the
size (in bytes) of the send buffer.
2353
[-session-timeout <[<integer>h][<integer>m][<integer>s]>] - Session ID Purge Timeout

During Reconnection (privilege: advanced)
This parameter specifies the interval after which a new session ID is sent to the FPolicy
server during reconnection attempts. The default value is set to 10 seconds. If the
connection between the storage controller and the FPolicy server is terminated and
reconnection is made within the -session-timeout interval, the old session ID is sent
to FPolicy server so that it can send responses for old notifications.
Examples
The following example creates an FPolicy external engine.
cluster1::> vserver fpolicy policy external-engine create -vserver
vs1.example.com -engine-name new_engine -primary-servers 1.1.1.1 -port 10 secondary-servers 2.2.2.2 -ssl-option mutual-auth -extern-engine-type synchronous
-certificate-serial 8DDE112A114D1FBC -certificate-common-name Sample1-FPolicyClient -certificate-ca TASample1
cluster1::> vserver fpolicy policy external-engine show -vserver vs1.example.com
-engine-name new_engine
Engine: new_engine
Primary FPolicy Servers: 1.1.1.1
Port Number of FPolicy Service: 10
Secondary FPolicy Servers: 2.2.2.2
External Engine Type: synchronous
SSL Option for External Communication: mutual-auth
FQDN or Custom Common Name: Sample1-FPolicy-Client
Serial Number: 8DDE112A114D1FBC
Certificate Authority: TASample1
See Also
2354
vserver fpolicy policy external-engine delete

Delete an external engine
Description
The vserver fpolicy policy external-engine delete command deletes an
Note:
Parameters
This parameter specifies the Vserver from which you want to delete an FPolicy external
engine.
This parameter specifies the name of the FPolicy external engine you want to delete.
Examples
The following example deletes an FPolicy external engine.
Engine: new_engine
2355
cluster1::> vserver fpolicy policy external-engine delete -vserver

vs1.example.com -engine-name new_engine
2356
vserver fpolicy policy external-engine modify

Modify an external engine
Description
The vserver fpolicy policy external-engine modify command modifies
an FPolicy external engine. The cluster uses the external engine to hold configuration
information that it needs in order to send notification information to the FPolicy servers.
It specifies the primary servers and secondary servers to which the cluster will send
notifications. It also specifies FPolicy server related configuration information.
Note:
Parameters
This parameter specifies the name of the FPolicy external engine that you want to
modify. An external engine name can be up to 256 characters long. An external engine
name is a string that can only contain any combination of ASCII-range alphanumeric
characters (a-z, A-Z, 0-9), "_", and "." .
[-primary-servers <IP Address>, ...] - Primary FPolicy Servers
This parameter specifies a list of IP addresses for the primary FPolicy servers to which
you want the external engine you modify to apply. The -primary-servers parameter
is used to specify a list of servers to which to send file access events for a given
FPolicy policy. When an administrator configures multiple servers as primary servers,
notifications are sent to the FPolicy servers in a round-robin fashion.
[-port <integer>] - Port Number of FPolicy Service
This parameter specifies the port number for the FPolicy service.
2357

This parameter specifies a list of IP addresses for the secondary FPolicy servers to
which you want the external engine you modify to apply. Secondary servers will be used
only when all the primary servers are not reachable. When an administrator configures
multiple servers as secondary servers, notifications are sent to FPolicy server in a
round-robin fashion. By default, no secondary server is selected.
This parameter specifies the type of the external engine. This specifies how the FPolicy
server should behave, synchronously or asynchronously. By default, it is synchronous
in nature. When set to synchronous, after sending a notification to the external FPolicy
server, request processing does not continue until after receiving a response from the
FPolicy server. At that point request flow either continues or processing results in denial,
depending on whether the response from the FPolicy server permits the requested
action. When set to asynchronous, after sending a notification to the external FPolicy
server, file request processing continues.
[-ssl-option {no-auth|server-auth|mutual-auth}] - SSL Option for External
Communication
This parameter specifies the SSL option for external communication with the FPolicy
server. Possible values include the following:
no-auth : When set to no-auth, no authentication takes place. The communication
link is established over the TCP protocol.
server-auth : When set to server-auth, only the FPolicy server is authenticated
by the Vserver. With this option, before creating the FPolicy external engine, the
signed the FPolicy server certificate.
mutual-auth : When set to mutual-auth, mutual authentication takes place
between the Vserver and the FPolicy server, i.e. authentication of the FPolicy
server by the Vserver along with authentication of the Vserver by the FPolicy
server. With this option, before creating the FPolicy external engine, the
signed the FPolicy server certificate along with the public certificate and key file
for authentication of the Vserver.
The public certificate of certificate authority (CA) that is used to sign the FPolicy server
certificate is installed using the security certificate install command with type set to client_ca. The private key and public certificate required for authentication
of the Vserver is installed using the security certificate install command
with -type set to server.
2358

This parameter specifies the timeout for canceling a request. It is used to specify the
time interval in which the node waits for a response from the FPolicy server. Beyond this
timeout, a cancel request is sent to the FPolicy server to cancel the pending request.
The request is then sent to an alternate FPolicy server that is registered for the policy.
This timeout helps in handling a FPolicy server that is not responding, which can
improve CIFS/NFS client response. Also, this feature can help in releasing of system
resources since the request is moved from a down/bad FPolicy server to an alternate
FPolicy server. The value for this field must be between 0s and 100s. By default, it is
20s.
This parameter specifies the timeout for aborting a request. The value for this field must
be between 0s and 200s. By default, it is 40s.
This parameter specifies the interval for sending status requests. It is used to specify the
interval after which a status request will be send to the FPolicy server. The value for this
This parameter specifies the maximum number of attempts to reconnect to the FPolicy
server from a Vserver. It is used to specify the number of times a broken connection will
be retried. The value for this field must be between 0 and 20. By default, it is 5.
This parameter specifies the maximum number of outstanding requests for the FPolicy
server. It is used to specify the maximum outstanding requests that will be queued up for
the FPolicy server. The value for this field must be between 1 and 10000. By default, it is
50.
This parameter specifies the timeout for disconnecting non-responsive FPolicy servers.
It is used to specify the time interval after which the connection to the FPolicy server is
terminated. This happens only when the FPolicy server's queue contains the maximum
allowed number of requests that it can hold in its queue and no response is received
within this timeout. The maximum allowed number of requests is either 50 (the default)
2359
or the number specified by the -max-server-reqs parameter. The value for this field
must be between 1s and 100s. By default, it is 60s.
This parameter specifies the interval in hours (h), minutes (m), or seconds (s) at which
keep-alive messages are sent to the FPolicy server. Keep-alive messages are used to
detect half-open connections. The range of supported values for this field is 10 through
600 (h, m, or s). Alternatively, the value can be set to 0, which disables keep-alive
messages and prevents them from being sent to the FPolicy servers. The default value
for this field is 120s.
Common Name
This parameter specifies the certificate name as a fully qualified domain name (FQDN)
or custom common name. The certificate is used if SSL authentication between the
Vserver and the FPolicy server is configured.
This parameter specifies the serial number of the certificate used for authentication if
SSL authentication between the Vserver and the FPolicy server is configured.
This parameter specifies the certificate authority (CA) name of the certificate used for
authentication if SSL authentication between the Vserver and the FPolicy server is
configured.
This parameter specifies the receive buffer size of the connected socket for the FPolicy
of the receive buffer is set to a value defined by the system. For example, if the default
receive buffer size of the socket is 65536 bytes, by setting the tunable value to 0, the
socket buffer size is set to 65536 bytes. You can use any non-default value to set the
size (in bytes) of the receive buffer.
This parameter specifies the send buffer size of the connected socket for the FPolicy
of the send buffer is set to a value defined by the system. For example, if the default
send buffer size of the socket is set to 65536 bytes, by setting the tunable value to 0, the
socket buffer size is set to 65536 bytes. You can use any non-defualt value to set the
size (in bytes) of the send buffer.
2360

This parameter specifies the interval after which a new session ID is sent to the FPolicy
server during reconnection attempts. The default value is set to 10 seconds. If the
connection between the storage controller and the FPolicy server is terminated and
reconnection is made within the -session-timeout interval, the old session ID is sent
to FPolicy server so that it can send responses for old notifications.
Examples
The following example modifies an FPolicy external engine.
cluster1::> vserver fpolicy policy external-engine modify -vserver
vs1.example.com -engine-name new_engine -primary-servers 1.1.1.1 -port 10 secondary-servers 2.2.2.2
Engine: new_engine
The following example shows how to modify -recv-buffer-size and -sendbuffer-size to a non-default value of 0.
cluster1::*> vserver fpolicy policy external-engine modify -vserver
vs1.example.com -engine-name new_engine -recv-buffer-size 0 -send-buffer-size 0
See Also
2361
vserver fpolicy policy external-engine show

Display external engines
Description
The vserver fpolicy policy external-engine show command displays
information about all FPolicy external engines belonging to the Vserver. Any Vserver
administrator can see FPolicy external engines associated to their Vserver as well as
external engines created by cluster administrator. The command output depends on
parameters, the command displays the following information about all FPolicy external
engines:
Vserver name
FPolicy external engine name
List of primary FPolicy servers
List of secondary FPolicy servers
Port number for FPolicy service
FPolicy external engine type
about FPolicy external engines. You can specify additional parameters to display only
information that matches those parameters. For instance, to display information only
about all external engines where the -port parameter is set to 9, run the command
with the -field parameter set to engine-name and -port parameter set to 9.
You can specify the -instance parameter to display all information for all policies in a
list format.
Note:
Parameters
2362
| [-instance ] }
all entries.
external engines for the specified Vserver. FPolicy external engines that the cluster
administrator creates are visible in all Vservers.
[-engine-name <Engine name>] - Engine
external engine that you specify.
[-primary-servers <IP Address>, ...] - Primary FPolicy Servers
external engine or engines that use the specified IP addresses as primary FPolicy
servers.
[-port <integer>] - Port Number of FPolicy Service
external engine or engines that use the specified port for the FPolicy service.
external engine or engines that use the specified IP addresses as secondary FPolicy
servers.
external engine or engines that use the specified external engine type.
[-ssl-option {no-auth|server-auth|mutual-auth}] - SSL Option for External
Communication
external engine or engines that use the specified SSL option.
2363
external engine or engines that use the specified timeout for canceling a request.
external engine or engines that use the specified timeout for aborting a request.
external engine or engines that use the specified interval for sending status requests.
external engine or engines that use the specified maximum reconnect attempts.
external engine or engines that use the specified FPolicy server maximum outstanding
requests.
external engine or engines that use the specified timeout for disconnecting nonresponsive server.
external engine or engines that use the specified keep-alive interval.
Common Name
external engine or engines that use the specified certificate common name.
external engine or engines that use the specified certificate serial number.
2364

external engine or engines that use the specified certificate authority name.
external engine or engines that use the specified receive buffer size.
external engine or engines that use the specified send buffer size.
external engine or engines that use the specified session timeout.
Examples
The following example displays the information about the configured external engines
using the vserver fpolicy policy external-engine show command.
cluster1::> vserver fpolicy policy external-engine show
Vserver
Type
Engine
Primary
Secondary
Servers
Servers
External
Port Engine
--------------- ---------------------
----------------- ----------------- ------
Cluster
synchronous
cserver_eng
9.9.9.9
vs1.example.com cserver_eng
synchronous
9.9.9.9
vs1.example.com v1n1
synchronous
1.1.1.1
2.2.2.2
synchronous
9.9.9.9
vs2.example.com v2n1
synchronous
3.3.3.3
5.5.5.5
2365
The following example displays the information about all Vserver FPolicy external
engines with the -port parameter set to 9.
cluster1::> vserver fpolicy policy external-engine show -fields engine-name port 9
vserver
engine-name
--------------- ----------Cluster
cserver_eng
The following example displays the values of all the advanced-level parameters for the
external engine v1n1 in Vserver vs1.example.com.
cluster1::*> vserver fpolicy policy external-engine show -vserver
vs1.example.com -engine-name v1n1 -instance
(vserver fpolicy policy external-engine show)
Engine: v1n1
SSL Option for External Communication: no-auth
Timeout for Canceling a Request: 20s
Timeout for Aborting a Request: 40s
Interval for Sending Status Requests: 10s
Max Reconnect Attempt: 5
Maximum Outstanding Requests for FPolicy Server: 50
Timeout for Disconnecting Non-responsive Server: 1m
Interval for Sending Keep-Alive Messages: 2m
FQDN or Custom Common Name: Serial Number of Certificate: Certificate Authority: Receive Buffer Size: 0
Send Buffer Size: 0
Session ID Purge Timeout During Reconnection: 10s
2366
2367
vserver fpolicy policy scope create

Create scope
Description
The vserver fpolicy policy scope create command creates an FPolicy
scope for an FPolicy policy. A scope defines the boundaries on which the FPolicy
policy will apply. The Vserver is the basic scope boundary. When you create a scope
for an FPolicy policy, you must define the FPolicy policy to which it will apply and you
must designate to which Vserver you want to apply the scope. There are a number of
parameters that further restrict the scope within the specified Vserver. You can restrict
the scope by specifying what to include in the scope. Or you can restrict the scope by
specifying what to exclude from the scope. For example, you can restrict the scope by
specifying which volumes to include using the -volumes-to-include parameter or
which volumes to exclude using the -volumes-to-exclude parameter. Once you
apply a scope to an enabled policy, policy event checks get applied to the scope defined
by this command.
Note:
There are special considerations for the scope for a cluster FPolicy policy. The cluster
FPolicy policy is a policy that the cluster administrator creates for the admin Vserver.
If the cluster administrator also creates the scope for that cluster FPolicy policy, a
Vserver administrator cannot create a scope for that same policy. However, if the cluster
administrator does not create a scope for the cluster FPolicy policy, then any Vserver
administrator can create the scope for that cluster policy. In the event that the Vserver
administrator creates a scope for that cluster FPolicy policy, the cluster administrator
cannot subsequently create a cluster scope for that same cluster policy. This is because
the cluster administrator cannot override the scope for the same cluster policy.
Note:
Parameters
2368
FPolicy policy scope.
This parameter specifies the name of the FPolicy policy for which you want to create the
scope.
[-shares-to-include <Share name>, ...] - Shares to Include
This parameter specifies a list of shares for file access monitoring. With this option, the
administrator provides a list of shares, separated by commas. For file access events
relative to the specified shares and file operations monitored by the FPolicy policy, a
notification is generated. The -shares-to-include parameter can contain regular
expressions and can include metacharacters such as "?" and "*".
Note:
When a share is included in the -shares-to-include parameter and the parent
volume of the share is included in the -volumes-to-exclude parameter, -volumesto-exclude has precedence over -shares-to-include.
[-shares-to-exclude <Share name>, ...] - Shares to Exclude
This parameter specifies a list of shares to exclude from file access monitoring. With this
option, the administrator provides a list of shares, separated by commas. When a share
is specified in the -shares-to-exclude parameter, no notification is sent for files
accessed relative to that share. The -shares-to-exclude parameter can contain
regular expressions and can include metacharacters such as "?" and "*".
[-volumes-to-include <volume name>, ...] - Volumes to Include
This parameter specifies a list of volumes for file access monitoring. With this option, the
administrator provides a list of volumes, separated by commas. For file access events
within the volume and file operations monitored by the FPolicy policy, a notification is
generated. The -volumes-to-include parameter can contain regular expressions
and can include metacharacters such as "?" and "*".
[-volumes-to-exclude <volume name>, ...] - Volumes to Exclude
This parameter specifies a list of volumes to exclude from file access monitoring. With
this option, the administrator provides a list of volumes, separated by commas, for which
no file access notifications are generated. The -volumes-to-exclude parameter can
contain regular expressions and can include metacharacters such as "?" and "*".
Note:
2369

volume of the share is included in the -volumes-to-exclude parameter, -volumesto-exclude has precedence over -shares-to-include. Similarly, when an export
policy is included in the -export-policies-to-include parameter and the parent
volume of the export-policy is included in the -volumes-to-exclude parameter, volumes-to-exclude has precedence over -export-policies-to-include.
[-export-policies-to-include <FPolicy export policy>, ...] - Export Policies to Include
This parameter specifies a list of export policies for file access monitoring. With this
option, the administrator provides a list of export policies, separated by commas. For
file access events within an export policy and file operations monitored by the FPolicy
policy, a notification is generated. The -export-policies-to-include parameter
can contain regular expressions and can include metacharacters such as "?" and "*".
Note:
When an export policy is included in the -export-policies-to-include parameter
and the parent volume of the export policy is included in the -volumes-to-exclude
parameter, -volumes-to-exclude has precedence over -export-policies-toinclude.
[-export-policies-to-exclude <FPolicy export policy>, ...] - Export Policies to Exclude
This parameter specifies a list of export policies to exclude from file access monitoring.
With this option, the administrator provides a list of export policies, separated by
commas, for which no file access notification is sent. The -export-policiesexclude parameter can contain regular expressions and can include metacharacters
such as "?" and *.
[-file-extensions-to-include <File extension>, ...] - File Extensions to Include
This parameter specifies a list of file extensions, separated by commas, for a given
FPolicy policy for which FPolicy processing is required. Any file access to files with
the same extensions included in the -file-extensions-to-include parameter
generates a notification. The -file-extensions-to-include parameter can
contain regular expressions and can include metacharacters such as "?".
[-file-extensions-to-exclude <File extension>, ...] - File Extensions to Exclude
FPolicy policy for which FPolicy processing will be excluded. Using the exclude
list, the administrator can request notification for all extensions except those in the
excluded list. Any file access to files with the same extensions included in the -fileextensions-to-exclude parameter does not generate a notification. The -file-
2370
extensions-to-exclude parameter can contain regular expressions and can

include metacharacters such as "?".
Note:
An administrator can specify both -file-extensions-to-include and -fileextensions-to-exclude lists. The -file-extensions-to-exclude parameter
is checked first before the -file-extensions-to-include parameter is checked.
[-is-file-extension-check-on-directories-enabled {true|false}] - Is File Extension
Check on Directories Enabled (privilege: advanced)
This parameter specifies whether the file name extension checks apply to directory
objects as well. If this parameter is set to true, the directory objects are subjected to
same extension checks as regular files. If this parameter is set to false, the directory
names are not matched for extensions and notifications would be sent for directories
even if their name extensions do not match.
Examples
The following example creates an FPolicy policy scope.
cluster1::> vserver fpolicy policy scope create
vs1.example.com
-vserver
-policy-name vs1_pol
-file-extensions-to-
include flv,wmv,mp3,mp4
-file-extensions-toexclude cpp,c,h,txt
cluster1::> vserver fpolicy policy scope show
Vserver
Policy
Extensions
Extensions
Name
Name
Included
Excluded
----------------- ------------------- -------------------------------------Cluster
cserver_pol
txt
mp3, wmv
vs1.example.com
vs1_pol
flv, wmv, mp3, mp4
cpp, c, h,
txt
2371
vserver fpolicy policy scope delete

Delete scope
Description
The vserver fpolicy policy scope delete command deletes an FPolicy policy
scope.
Note:
Parameters
This parameter specifies the name of the Vserver from which you want to delete the
This parameter specifies the name of the FPolicy policy for which you want to delete the
scope.
Examples
The following example deletes a scope of an FPolicy policy.
cluster1::> vserver fpolicy policy scope delete -vserver vs1.example.com
vserver fpolicy policy scope modify

Modify scope
2372
Description
The vserver fpolicy policy scope modify command modifies an FPolicy
scope for an FPolicy policy. A scope defines the boundaries on which the FPolicy
policy will apply. The Vserver is the basic scope boundary. When you modify a scope
for an FPolicy policy, you must define the FPolicy policy to which it will apply and you
must designate to which Vserver you want to apply the scope. There are a number of
parameters that further restrict the scope within the specified Vserver. You can restrict
the scope by specifying what to include in the scope. Or you can restrict the scope by
specifying what to exclude from the scope. For example, you can restrict the scope by
specifying which volumes to include using the -volumes-to-include parameter or
which volumes to exclude using the -volumes-to-exclude parameter. Once you
apply a scope to an enabled policy, policy event checks get applied to the scope defined
by this command.
Note:
Parameters
This parameter specifies the name of the FPolicy policy for which you want to modify the
scope.
This parameter specifies a list of shares for file access monitoring. With this option, the
administrator provides a list of shares, separated by commas. For file access events
relative to the specified shares and file operations monitored by the FPolicy policy, a
notification is generated. The -shares-to-include parameter can contain regular
expressions and can include metacharacters such as "?" and "*".
Note:
volume of the share is included in the -volumes-to-exclude parameter, -volumesto-exclude has precedence over -shares-to-include.
2373

This parameter specifies a list of shares to exclude from file access monitoring. With this
option, the administrator provides a list of shares, separated by commas. When a share
is specified in the -shares-to-exclude parameter, no notification is sent for files
accessed relative to that share. The -shares-to-exclude parameter can contain
regular expressions and can include metacharacters such as "?" and "*".
This parameter specifies a list of volumes for file access monitoring. With this option, the
administrator provides a list of volumes, separated by commas. For file access events
within the volume and file operations monitored by the FPolicy policy, a notification is
generated. The -volumes-to-include parameter can contain regular expressions
and can include metacharacters such as "?" and "*".
This parameter specifies a list of volumes to exclude from file access monitoring. With
this option, the administrator provides a list of volumes, separated by commas, for which
no file access notifications are generated. The -volumes-to-exclude parameter can
contain regular expressions and can include metacharacters such as "?" and "*".
Note:
volume of the share is included in the -volumes-to-exclude parameter, -volumesto-exclude has precedence over -shares-to-include. Similarly, when an export
policy is included in the -export-policies-to-include parameter and the parent
volume of the export-policy is included in the -volumes-to-exclude parameter, volumes-to-exclude has precedence over -export-policies-to-include.
This parameter specifies a list of export policies for file access monitoring. With this
option, the administrator provides a list of export policies, separated by commas. For
file access events within an export policy and file operations monitored by the FPolicy
policy, a notification is generated. The -export-policies-to-include parameter
can contain regular expressions and can include metacharacters such as "?" and "*".
Note:
When an export policy is included in the -export-policies-to-include parameter
and the parent volume of the export policy is included in the -volumes-to-exclude
parameter, -volumes-to-exclude has precedence over -export-policies-toinclude.
2374

This parameter specifies a list of export policies to exclude from file access monitoring.
With this option, the administrator provides a list of export policies, separated by
commas, for which no file access notification is sent. The -export-policiesexclude parameter can contain regular expressions and can include metacharacters
such as "?" and *.
FPolicy policy for which FPolicy processing is required. Any file access to files with
the same extensions included in the -file-extensions-to-include parameter
generates a notification. The -file-extensions-to-include parameter can
contain regular expressions and can include metacharacters such as "?".
FPolicy policy for which FPolicy processing will be excluded. Using the exclude
list, the administrator can request notification for all extensions except those in the
excluded list. Any file access to files with the same extensions included in the -fileextensions-to-exclude parameter does not generate a notification. The -fileextensions-to-exclude parameter can contain regular expressions and can
include metacharacters such as "?".
Note:
An administrator can specify both -file-extensions-to-include and -fileextensions-to-exclude lists. The -file-extensions-to-exclude parameter
is checked first before the -file-extensions-to-include parameter is checked.
This parameter specifies whether the file name extension checks apply to directory
objects as well. If this parameter is set to true, the directory objects are subjected to
same extension checks as regular files. If this parameter is set to false, the directory
names are not matched for extensions and notifications would be sent for directories
even if their name extensions do not match.
Examples
The following example modifies an FPolicy policy scope.
cluster1::> vserver fpolicy policy scope modify
vs1.example.com
-vserver
2375
-file-extensions-toinclude flv,wmv,mp3,mp4
-file-extensions-toexclude cpp,c,h,txt
Vserver
Policy
Extensions
Extensions
Name
Name
Included
Excluded
----------------- ------------------- -------------------------------------Cluster
cserver_pol
txt
mp3, wmv
vs1.example.com
vs1_pol
flv, wmv, mp3, mp4
cpp, c, h,
txt
2376
vserver fpolicy policy scope show

Display scope
Description
The vserver fpolicy policy scope show command displays scope information
about all FPolicy policies belonging to the Vserver. The command output depends on
parameters, the command displays the following information about all FPolicy scopes:
Vserver name
Policy name
The file extensions to include
The file extensions to exclude
about FPolicy scopes. In addition to the fields above, you can display the following
fields:
The shares to include
The shares to exclude
The volumes to include
The volumes to exclude
The export policies to include
The export policies to exclude
Whether file extention check on directories is enabled
You can specify specific parameters to display only information that matches those
parameters. For example, to display scope information only about all FPolicy policies
where the -file-extensions-to-include parameter is set to txt, run the
command with the -fields parameter set to policy-name and -file-extensionsto-include parameter set to txt.
2377
You can specify the -instance parameter to display scope information for all FPolicy
policies in a list format.
Note:
Parameters
| [-instance ] }
all entries.
If you specify this parameter, the command displays scope information only about the
FPolicy policies for the specified Vserver.
If you specify this parameter, the command displays information only about the specified
FPolicy policy.
FPolicy policy or policies that use the specified share or shares in the include list.
FPolicy policy or policies that use the specified share or shares in the exclude list.
FPolicy policy or policies that use the specified volume or volumes in the include list.
FPolicy policy or policies that use the specified volume or volumes in the exclude list.
2378
FPolicy policy or policies that use the specified export policy or policies in the include
list.
FPolicy policy or policies that use the specified export policy or policies in the exclude
list.
If you specify this parameter, the command displays scope information only about
the FPolicy policy or policies that use the specified file extension or extensions in the
include list.
FPolicy policy or policies that use the specified file extension or extensions in exclude
list.
FPolicy policy or policies that use the specified file extension check on directories. If set
to true, the command displays information about scopes where file extension checks on
directories is enabled. If set to false, the command displays information about scopes
where file extension checks on directories is disabled.
Examples
The following example displays scope information about FPolicy policies.
Vserver
Policy
Extensions
Extensions
Name
Name
Included
Excluded
----------------- ------------------- -------------------------------------Cluster
cserver_pol
vs1.example.com
vs1.example.com
vs1_pol
mp3
2379
vserver group-mapping create

Create a group mapping
Description
The vserver group-mapping create command creates a group mapping.
Group mappings are applied in the order in which they occur in the priority list; for
example, a group mapping that occurs at position 2 in the priority list is applied before
a group mapping that occurs at position 3. Each mapping direction (Kerberos-toUNIX, Windows-to-UNIX, and UNIX-to-Windows) has its own priority list. Data ONTAP
prevents you from creating two group mappings with the same pattern.
Patterns can be expressed as POSIX regular expressions. For information about regular
expressions, see the UNIX reference page for regex(7).
Each Vserver can have up to 1024 group mappings in each direction.
The vserver group-mapping create command is not supported on Vservers with
FlexVol volumes.
Note:
If you are using the CLI, you must delimit all regular expressions with double quotation
marks ("). For instance, to enter the regular expression (.+) in the CLI, type "(.+)" at the
command prompt. To add a "?" to the expression, press ESC followed by the "?".
Parameters
This parameter specifies the Vserver on which you want to create the group mapping.
-direction <Direction of the name mapping> - Name Mapping Direction
This parameter specifies the direction of the group mapping. Possible values are krbunix for a Kerberos-to-UNIX group mapping, win-unix for a Windows-to-UNIX group
mapping, and unix-win for a UNIX-to-Windows group mapping.
-position <integer> - Position
This parameter specifies the group mapping's position in the priority list. Specify the
position as a positive integer.
2380
Note:
If you want to create a new group mapping at a position that is already occupied in
the priority list, use the vserver group-mapping insert command instead of the
vserver group-mapping create command.
-pattern <text> - Pattern
This parameter specifies the pattern you want to match. Refer to the command
description section for details. The pattern can be up to 256 characters in length.
-replacement <text> - Replacement
This parameter specifies the replacement pattern. The replacement pattern can be up to
256 characters in length.
Examples
The following example creates a group mapping on a Vserver named vs1. The mapping
is from UNIX to Windows at position 5 in the priority list. The mapping maps the pattern
cifs to the replacement EXAMPLE\Domain Groups.
cluster1::> vserver group-mapping create -vserver vs1 -direction unix-win position 5 -pattern cifs -replacement "EXAMPLE\\Domain Groups"
See Also
vserver group-mapping insert
2381
vserver group-mapping delete

Delete a group mapping
Description
The vserver group-mapping delete command deletes a group mapping.
The vserver group-mapping delete command is not supported on Vservers with
FlexVol volumes.
Parameters
This parameter specifies the Vserver from which you want to delete the group mapping.
This parameter specifies the direction of the group mapping that you want to delete.
This parameter specifies the position of the group mapping that you want to delete.
Specify the position as a positive integer.
Examples
The following example deletes a group mapping on a Vserver named vs1. The group
mapping is from UNIX to Windows and is at position 5.
cluster1::> vserver group-mapping delete -vserver vs1 -direction unix-win position 5
vserver group-mapping insert

Create a group mapping at a specified position
2382
Description
The vserver group-mapping insert command creates a group mapping at a
specified position in the priority list. The command rearranges the list as needed to
accommodate the new entry. For instance, if you have a priority list of five mappings
and insert a new mapping at position 3, the mapping previously at position 3 is moved to
position 4, the mapping previously at position 4 is moved to position 5, and the mapping
previously at position 5 is moved to position 6. Each mapping direction (Kerberos-toUNIX, Windows-to-UNIX, and UNIX-to-Windows) has its own priority list.
You can specify patterns as POSIX regular expressions. For information about regular
The vserver group-mapping insert command is not supported on Vservers with
FlexVol volumes.
Note:
Parameters
This parameter specifies the Vserver on which you want to create the group mapping.
This parameter specifies the position in the priority list at which you want to insert the
new group mapping. Specify a position as a positive integer.
2383
Examples
The following example creates a group mapping on a Vserver named vs1. It is a group
mapping from Kerberos to UNIX. It is inserted into the priority list at position 2. The
group mapping maps any principal in the Kerberos realm SEC.EXAMPLE.COM to the
UNIX group name corresponding to the principal's base name with any instance names
removed; for example, artists/admin@SEC.EXAMPLE.COM is mapped to artists.
cluster1::> vserver group-mapping insert -vserver vs1 -direction krb-unix position 2 -pattern "([^@/]+)(/[^@]+)?@SEC.EXAMPLE.COM" -replacement "\1"
vserver group-mapping modify

Modify a group mapping's pattern, replacement pattern, or both
Description
The vserver group-mapping modify command modifies the pattern, the
replacement pattern, or both of a specified group mapping.
The vserver group-mapping modify command is not supported on Vservers with
FlexVol volumes.
Note:
Parameters
2384
This parameter specifies the Vserver on which you want to modify the group mapping.
This parameter specifies the group mapping's position in the priority list. A position is
specified as a positive integer. Each mapping direction (Kerberos-to-UNIX, Windows-toUNIX, and UNIX-to-Windows) has its own priority list.
[-pattern <text>] - Pattern
[-replacement <text>] - Replacement
Examples
The following example modifies the group mapping on the Vserver named vs1 and
direction win-unix, at position 3. The pattern to be matched is changed to "EXAMPLE\(.
+)".
cluster1::> vserver group-mapping modify -vserver vs1 -direction win-unix position 3 -pattern "EXAMPLE\\(.+)"
vserver group-mapping show

Display group mappings
Description
The vserver group-mapping show command displays information about group
mappings. The command output depends on the parameter or parameters specified
following information about all group mappings:
2385
Vserver name
Direction of the mapping (krb-unix for Kerberos-to-UNIX, win-unix for Windows-toUNIX, or unix-win for UNIX-to-Windows)
Position of the mapping in the priority list
Pattern to be matched
Replacement pattern
parameters. For instance, to display information only about Kerberos-to-UNIX group
mappings, run the command with the -direction krb-unix parameter.
The vserver group-mapping show command is not supported on Vservers with
FlexVol volumes.
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays information only about the group
mapping or mappings that match the specified Vserver.
[-direction <Direction of the name mapping>] - Name Mapping Direction
mapping or mappings that have the specified mapping direction.
[-position <integer>] - Position
mapping that has the specified position in the priority list.
2386
mapping or mappings that use the specified matching pattern. The pattern can be up to
256 characters in length. Refer to the command description section for details.
mapping or mappings that use the specified replacement pattern.
Examples
The following example displays information about all group mappings:
cluster1::> vserver group-mapping show
Vserver
Direction Position
-------------- --------- -------vs1
win-unix
Pattern: EXAMPLE\\artists
Replacement: nobody
vs1
unix-win
Pattern: EXAMPLE\\(.+)
Replacement: \_1
vs2
win-unix
Pattern: (.+)
Replacement: EXAMPLE\\artists
2387
vserver group-mapping swap

Exchange the positions of two group mappings
Description
The vserver group-mapping swap command exchanges the positions of two group
mappings in the priority list.
The vserver group-mapping swap command is not supported on Vservers with
FlexVol volumes.
Parameters
This parameter specifies the Vserver on which the group mappings are located.
This parameter specifies the direction of the group mappings that you want to exchange.
Each mapping direction (Kerberos-to-UNIX, Windows-to-UNIX, and UNIX-to-Windows)
has its own priority list.
This parameter specifies the position in the priority list of the first group mapping that
you want to exchange. Specify a position as a positive integer.
-with-position <integer> - Position of an existing group mapping entry in the list of
group mappings for this Vserver. This entry will be swapped with the entry at 'position'.
This parameter specifies the position in the priority list of the second group mapping that
Examples
The following example exchanges the positions of two group mappings on a Vserver
named vs1. The group mappings have the direction Windows-to-UNIX. The group
mappings are exchanged between positions 2 and 4.
cluster1::> vserver group-mapping swap -vserver vs1 -direction win-unix -position
2 -with-position 4
2388
vserver iscsi create

Create a Vserver's iSCSI service
Description
This command creates an iSCSI target for a specified Vserver. By default the system
creates a default iSCSI target name with the status-admin set to enabled. Until you
create an iSCSI service, iSCSI initiators cannot log into the Vserver.
Parameters
Specifies the Vserver for the iSCSI service.
Specifies a iSCSI target name of a Vserver. This name is unique and is not case
sensitive. The target name must conform to this format iqn.1995-08.com.example:string
and follow these rules:
Contains up to 223 bytes.
Contains alphanumeric characters. The period ".", hyphen "-", and colon ":" are
acceptable.
Does not contain the underscore character "_".
[-target-alias <text>] - Target Alias
Specifies an iSCSI target alias name of a Vserver. The maximum number of characters
for an alias name is 128. The alias default name is the Vserver name.
Specifies the administrative status of the iSCSI service of a Vserver. If you set this
parameter to up, the command creates an iSCSI service with the administrative status
of up. If you set this parameter to down, the command creates an iSCSI service with the
administrative status of down.
[-max-error-recovery-level <integer>] - Max Error Recovery Level (privilege:
advanced)
2389
Specifies the maximum error recovery level allowed by the iSCSI service. You can
specify 0, 1, or 2, or you can accept the default. The default is zero. The actual error
recovery level depends on the negotiated error recovery level between the initiator and
the iSCSI target when the session is created.
0 - Session failure recovery
1 - Digest failure recovery
2 - Connection failure recovery
[-retain-timeout <integer>] - RFC3720 DefaultTime2Retain Value (in sec) (privilege:
advanced)
Specifies the wait time before an active task reassignment is possible after an
unexpected connection termination. For example, a value of 0 means that the
connection or task state is immediately discarded by the target. The default is 20
seconds.
[-login-timeout <integer>] - Login Phase Duration (in sec) (privilege: advanced)
Specifies the login phase duration. The default is 15 seconds.
[-max-conn-per-session <integer>] - Max Connections per Session (privilege:
advanced)
Specifies the maximum number of connections per session that a target can accept.
The default is 4 connections.
[-max-ios-per-session <integer>] - Max Commands per Session (privilege: advanced)
Specifies the maximum number of commands per session that a target can accept. The
default is 128 commands per session.
[-tcp-window-size <integer>] - TCP Receive Window Size (in bytes) (privilege:
advanced)
Specifies the TCP receive window size (in bytes). The default is 131,400 bytes.
[-force | -f [true]] - Allow Non-Vendor Target Name (privilege: advanced)
Force the command to accept a target name that would normally be rejected as invalid.
Examples
cluster1::> vserver iscsi create -vserver vs_1
Creates the iSCSI service for Vserver vs_1.
2390
vserver iscsi delete

Delete a Vserver's iSCSI service
Description
This command deletes the iSCSI service from a Vserver.
Note:
You must first disable the service with the command vserver iscsi modify with "status-admin down" before you can delete the service.
Parameters
Examples
cluster1::> vserver iscsi delete -vserver vs_1
Deletes the iSCSI service for Vserver vs_1.
See Also
vserver iscsi modify
2391

Modify a Vserver's iSCSI service
Description
This command modifies the configuration for an iSCSI service.
Modifications take effect immediately after you execute the command. Making
modifications to your service can result in traffic loss on a live system. Call technical
support if you are unsure of the possible consequences.
Parameters
Specifies an iSCSI target name of a Vserver. This name is unique and is not case
sensitive. The target name must conform to this format iqn.1995-08.com.example:string
and follow these rules:
Contains up to 223 bytes.
Contains alphanumeric characters. The period ".", hyphen "-", and colon ":" are
acceptable.
Does not contain the underscore character "_".
Note:
The iSCSI service must be down in order to change the target name.
{ [-target-alias <text>] - Target Alias
Specifies the new target alias of the iSCSI service.
| [-clear | -c [true]] } - Clear the Target Alias
Clears the current target alias from the iSCSI service configuration.
2392
Specifies the configured administrative status of a service. If you set this parameter to
up, the iSCSI service begins to accept login requests from iSCSI initiators. If you set this
parameter to down, iSCSI initiators cannot log in.
advanced)
Specifies the maximum error recovery level the iSCSI service negotiates with iSCSI
initiators during login phase.
0 - Session failure recovery
1 - Digest failure recovery
2 - Connection failure recovery
advanced)
Specifies the wait time before active task reassignment is possible after an unexpected
connection termination. For example, a value of 0 means that the connection or task
state is immediately discarded by the target.
Specifies maximum time the login phase remains active until the iSCSI target terminates
the connection.
advanced)
Specifies the maximum number of connections per session that the iSCSI target can
accept.
Specifies the maximum number of commands per session that the iSCSI target can
accept.
advanced)
Specifies the TCP receive window size (in bytes).
A change to the TCP receive window size value takes effect for all network interfaces
when you restart the iSCSI service for the Vserver as follows:
vserver iscsi stop -vserver <vserver name>
vserver iscsi start -vserver <vserver name>
2393
If you change an individual network interface from up to down back to up, as follows, the
new value for TCP receive window size takes effect for that network interface:
network interface modify -vserver <vserver name> -lif <LIF name> -status-admin
down
network interface modify -vserver <vserver name> -lif <LIF name> -status-admin up
[-force | -f [true]] - Allow Non-Vendor Target Name (privilege: advanced)

Force the command to accept a target name that would normally be rejected as invalid.
Examples
cluster1::> vserver iscsi modify -vserver vs_1 -status-admin down
Modifies the status-admin of the iSCSI service for Vserver vs_1 to down.
See Also
vserver iscsi stop vserver iscsi start network interface modify
2394
vserver iscsi show

Display a Vserver's iSCSI configuration
Description
This command displays the current configuration of the iSCSI service.
Parameters
specify.
| [-instance ] }
about all fields.
Selects the iSCSI services for the Vserver that matches the parameter value.
[-target-name <text>] - Target Name
Selects the iSCSI services with a target name that matches the parameter value.
[-target-alias <text>] - Target Alias
Selects the iSCSI services with a target alias that matches the parameter value.
Selects the iSCSI services with a configured status that matches the parameter value.
advanced)
Selects the iSCSI services with a maximum error recovery level that matches the
parameter value.
advanced)
2395
Selects the iSCSI services with a wait time that matches the parameter value. The
wait time is the amount of time before active task reassignment is possible after an
unexpected connection termination.
Selects the iSCSI services with a login phase duration that matches the parameter
value.
advanced)
Selects the iSCSI services with a maximum connection per session that matches the
parameter value.
Selects the iSCSI services with a maximum number of commands per session that
matches the parameter value.
advanced)
Selects the iSCSI services with a TCP receive window size (in bytes) that matches the
parameter value.
Examples
cluster1::> vserver iscsi show
Vserver
Target
Target
Status
Name
Alias
Admin
---------- -------------------------------- ---------------------------- -----vs_1
iqn.1992-08.com.example:sn.c7c82a22bf9f11df83e5123478563412:vs.2
vs_1_alias
up

cluster1::> vserver iscsi show -instance
Vserver: vs_1
Target Name:
iqn.1992-08.com.example:sn.c7c82a22bf9f11df83e5123478563412:vs.2 The following
is the output of the show command at the advanced privilege level:
Target Alias: vs_1_alias
Administrative Status: up
2396
Displays the output of the show command at the admin privilege level.
cluster1::*> vserver iscsi show
Vserver
Target
Target
Status
Name
Alias
Admin
---------- -------------------------------- ---------------------------- -----vs_1
vs_1_alias
up
Displays the output of the show command at the advanced privilege level.
cluster1::*> vserver iscsi show -instance
Vserver: vs_1
Target Name:
Target Alias: vs_1_alias
Max Error Recovery Level: 0
DefaultTime2Retain Value (in sec): 20
Login Phase Duration (in sec): 20
Max Connections per Session: 4
Max I/O per Session: 128
TCP Window Size all Sessions (in bytes): 131400
Displays the detailed entries for all entries.
2397
vserver iscsi start

Starts the iSCSI service
Description
This command starts the iSCSI service of a Vserver. You can also use vserver iscsi
modify with "-status-admin up".
Parameters
Examples
cluster1::> vserver iscsi start -vserver vs_1
Starts the iSCSI service for Vserver vs_1.
See Also
2398
vserver iscsi stop

Stops the iSCSI service
Description
Stops the iSCSI service of a Vserver. This command shuts down all active iSCSI
sessions and stops any new iSCSI sessions. You can also use vserver iscsi
modify with "-status-admin down".
Parameters
Examples
cluster1::> vserver iscsi stop -vserver vs_1
Stops the iSCSI service for Vserver vs_1.
See Also
2399
vserver iscsi command show

Display active iSCSI commands
Description
This command displays the status of active iSCSI commands in an iSCSI session. If
you specify an iSCSI command ID, the command shows what commands are active in a
session and is useful for initiator debugging.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display a list of active iSCSI commands that match the Vserver
name that you specify.
[-tpgroup <text>] - Target Portal Group
Use this parameter to display a list of active iSCSI commands that are within the target
portal group.
[-tsih <integer>] - Target Session ID
Use this parameter to display a list of active iSCSI commands that match the target
session ID handle that you specify.
[-command-id <integer>] - Command ID
Use this parameter to display a list of active iSCSI commands that match the command
ID that you specify.
2400
Use this parameter to display a list of active iSCSI commands that match the initiator
[-initiator-alias <text>] - Initiator Alias
alias that you specify.
session ID that you specify.
[-command-sub-id <integer>] - Command Sub ID
sub ID that you specify.
[-command-state <iSCSI Command States>] - Command State
state that you specify.
[-command-type {Sequenced|Imm_Taskmgmt|Imm_Other}] - Command Type
If you use this parameter, the command displays a list of active iSCSI commands that
contains the specified command type. The command types indicate:
"Sequenced" -- the system processes the commands in sequence
"Imm_Taskmgmt" -- the system processes the commands immediately
"Imm_Other" -- the system processes the commands as queued
Examples
cluster1::> vserver iscsi command show -instance -vserver vs_1
Vserver: vs_1
Target Portal Group Name: tpgroup_1
Target Session ID: 2
Command ID: 20797
Initiator Name: iqn.1993-08.org.debian:01:fa752b8a5a3a
Initiator Alias: alias_1
Initiator Session ID: 00:02:3d:01:00:00
Command Sub ID: 20797
Command State: Scsicdb_Waiting_STLayer
Command Type: Sequenced
2401
Displays detailed information for active iSCSI commands in Vserver vs_1.
2402
vserver iscsi connection show

Display active iSCSI connections
Description
This command displays iSCSI connection information within a session. If you do not
specify a connection, the command displays all information for all connections.
An active iSCSI session can contain one or multiple iSCSI connections. If an iSCSI
connection has not completed the iSCSI login sequence, the iSCSI session might not
contain iSCSI connections.
This command gives real-time status of connection activity. You can use the parameters
header-digest-enabled and data-digest-enabled to troubleshoot performance problems.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display iSCSI connections that match the Vserver that you
specify.
Use this parameter to display iSCSI connections that match the target portal group that
you specify.
Use this parameter to display iSCSI connections that match the target session ID that
you specify.
2403

Use this parameter to display iSCSI connections that match the connection ID that you
specify.
[-connection-state <iSCSI Connection State>] - Connection State
Use this parameter to display iSCSI connections that match the connection state you
specify.
[-has-session {true|false}] - Connection Has session
Specifies if a session is established for a connection. If you enter this command
using the parameter without a value, it is set to true, and the command displays all
connections that have an established session. If you set this parameter to false, the
command displays all connections that do not have established sessions.
[-lif <text>] - Logical interface
Use this parameter to display iSCSI connections that match the logical interface that you
specify.
[-tpgroup-tag <integer>] - Target Portal Group Tag
Use this parameter to display iSCSI connections that use the target portal group tag that
you specify.
[-local-address <text>] - Local IP Address
Use this parameter to display iSCSI connections that use the local IP address that you
specify.
[-local-ip-port <integer>] - Local TCP Port
Use this parameter to display iSCSI connections that use the local TCP port that you
specify.
[-authentication-method {CHAP|deny|none}] - Authentication Type
Use this parameter to display iSCSI connections that match the authentication type
that you specify. CHAP requires password validation. Deny does not allow connections.
None allows all connections.
[-data-digest-enabled {true|false}] - Data Digest Enabled
Specifies if data digest is enabled for a connection. If you enter this command using the
parameter without a value, it is set to true, and the command displays all connections
that support data digest. If you set this parameter to false, the command displays all
connections that do not support data digest.
[-header-digest-enabled {true|false}] - Header Digest Enabled
2404
Specifies if header digest is supported. If you enter this command using the parameter
without a value, it is set to true, and the command shows all connections that support
header digest. If you set this parameter to false, the command displays all connections
that do not support header digest.
[-rcv-window-size <integer>] - TCP/IP Recv Size
Use this parameter to display iSCSI connections that match the specified negotiated
size of the TCP/IP receive window in bytes.
[-initiator-mrdsl <integer>] - Initiator Max Recv Data Length
Use this parameter to display iSCSI connections that match the maximum length of
message that the initiator can receive.
[-remote-address <text>] - Remote IP address
Use the parameter to display iSCSI connections that match the IP address of the
initiator that you specify.
[-remote-ip-port <integer>] - Remote TCP Port
Use this parameter to display iSCSI connections that match the specified TCP port of
initiator that you specify.
[-target-mrdsl <integer>] - Target Max Recv Data Length
Use this parameter to display iSCSI connections that match the maximum message size
that a target can receive.
Examples
cluster1::> vserver iscsi connection show -vserver vs1
Tpgroup
Vserver
Name
TSIH
Conn
Local
Remote
TCP Recv
ID
Address
Address
Size
------------ ------------- ----- ----- --------------- --------------- -------vs1
vs1.iscsi
0 10.63.8.163
10.60.141.65
131400
vs1
vs1.iscsi
0 10.63.8.163
10.62.8.75
131400
Displays connection information on Vserver vs1.
2405
vserver iscsi connection shutdown

Shut down a connection on a node
Description
This command shuts down a specified iSCSI connection within a session. If you want
to shut down all iSCSI connections in a session, use the vserver iscsi session
shutdown command.
Parameters
-tpgroup <text> - Target Portal Group
Specifies the target portal group that contains the connection you want to shut down.
-tsih <integer> - Target Session ID
Specifies the target session ID that you want to shut down.
-connection-id <integer> - Connection ID
Specifies the connection ID that you want to shut down.
Examples
cluster1::*> vserver iscsi connection shutdown -vserver vs_1 -tpgroup tpgroup_1 tsih 4 -connection-id 0
Forces the shutdown of an iSCSI connection with the connection ID of 0 on Vserver

vs_1 in tpgroup tpgroup_1, target session ID 4.
See Also
vserver iscsi session shutdown
2406
vserver iscsi initiator show

Display iSCSI initiators currently connected
Description
This command displays a list of active initiators currently connected to a specified
Vserver.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display the active initiators that match the Vserver that you
specify.
Use this parameter to display the active initiators that match the name of the target
portal group that you specify.
Use this parameter to display the active initiators that match the target session ID you
that specify.
Use this parameter to display the active initiators that match the initiator name that you
specify.
2407
Use this parameter to display the active initiators that match the alias name that you
specify.
[-tpgroup-tag <integer>] - TPGroup Tag
Use this parameter to display the active initiators that match the target portal group tag
that you specify.
Use this parameter to display the active initiators that match the initiator session ID that
you specify.
[-igroup <text>, ...] - Igroup Name
Use this parameter to display the active initiators that match the initiator group that you
specify.
Examples
cluster1::> vserver iscsi initiator show -vserver vs_1
Tpgroup
Vserver Name
Initiator
TSIH Name
ISID
IGroup
------- -------- ---- --------------------- ----------------- ----------------vs_1
vs_1.iscsi
6 iqn.1994-05.com.redhat:6ed6dfb0489e
vs_1
vs_1.iscsi
7 iqn.1993-08.org.debian:01:fa752b8a5a3a
00:02:3d:03:00:00 00:02:3d:01:00:00 igroup_1

Displays the active initiator information on Vserver vs_1.
2408
vserver iscsi interface disable

Disable the specified interfaces for iSCSI service
Description
This command disables the specified logical interfaces for an iSCSI service. Once
disabled, all subsequent attempts to establish new iSCSI connections over the logical
interface will fail.
Parameters
{ -lif <lif-name>, ... - Logical Interface
Specifies the logical interfaces on a Vserver you want to disable.
| -all | -a [true] } - All
Specifies that all logical interfaces on the Vserver are disabled.
When set to true, forces the termination of any active iSCSI sessions without prompting
you for a confirmation.
Examples
cluster1::> vserver iscsi interface disable -vserver vs_1 -lif vs_1.iscsi
Disables the iscsi logical interface vs_1.iscsi on Vserver vs_1.
2409
vserver iscsi interface enable

Enable the specified interfaces for iSCSI service
Description
This command enables specified logical interfaces for iSCSI Vserver service. Once
enabled, your system accepts new iSCSI connections and services iSCSI requests over
the newly enabled logical interfaces.
Parameters
Specifies the logical interfaces on a Vserver that you want to enable.
When set to true, all logical interfaces are enabled. If you use this parameter without a
value, it is set to true, and the command enables all logical interfaces.
Examples
cluster1::> vserver iscsi interface enable -vserver vs_1 -lif vs_1.iscsi
Enables the iscsi logical interface vs_1.iscsi on Vserver vs_1.
2410
vserver iscsi interface show

Show network interfaces used for iSCSI connectivity
Description
This command shows the iSCSI logical interfaces for a specified Vserver. If you do not
specify any of the parameters, the command displays all of the interfaces on a Vserver.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display iSCSI logical interfaces that match the Vserver that you
specify.
Use this parameter to display iSCSI logical interfaces that that you specify.
Specifies the configured status of the logical interface. If you set this parameter to up,
the command displays all iSCSI logical interfaces with the administrative status of up. If
you set this parameter to down, the command displays all the iSCSI logical interfaces
with the administrative status of down.
Specifies the current status of the logical interface. If you set this parameter to up, the
command displays all the iSCSI logical interfaces with the operational status of up. If
you set this parameter to down, the command displays all the iSCSI logical interfaces
with the operational status of down.
2411

Specifies if this logical unit is enabled for iSCSI service. If you enter this command
without a parameter, its effective value is true, and the command displays all the
enabled iSCSI logical interfaces.
Use this parameter to display iSCSI logical interfaces that match the IP address that you
specify.
[-ip-port <integer>] - IP Port Number
Use this parameter to display iSCSI logical interfaces that match IP port number for the
logical interface that you specify.
Use this parameter to display iSCSI logical interfaces that match current node that you
specify.
Use this parameter to display iSCSI logical interfaces that match specified current
physical port that you specify.
Specifies if the node hosting the logical interface is the initially configured node. If you
use this command without using this parameter, it is set to true, and the command
displays all iSCSI interfaces that are on the initially configured node.
[-tpgroup <text>] - TPGroup Name
Use this parameter to display iSCSI logical interfaces that match the target portal group
[-tpgroup-tag | -t <integer>] - TPGroup Tag
Use this parameter to display iSCSI logical interfaces that match the target portal group
tag that you specify.
[-relative-port-id <integer>] - Relative Port ID
Use this parameter to display iSCSI logical interface that matches the relative target port
ID that you specify. The system assigns each logical interfaces and target portal group a
relative target port ID that is Vserver unique. You cannot change this ID.
Examples
cluster1::> vserver iscsi interface show -vserver vs_1
2412
Logical
Vserver
Status
Interface
IP
TPGT Admin/Oper Address
Curr
Curr
Node
Port Enabled
---------- ---------- ---- ---------- --------------- ----------- ---- ------vs_1
vs_1.iscsi 1027
vs_1
vs_1.iscsi2
1028
up/up
10.63.8.165
node1
e0c
true
up/up
10.63.8.166
node1
e0c
true
Displays information for logical interfaces on Vserver vs_1.

cluster1::> vserver iscsi interface show -vserver vs_1 -relative-port-id 1
Logical
Vserver
Interface
Status
IP
TPGT Admin/Oper Address
Curr
Curr
Node
Port Enabled
---------- ---------- ---- ---------- --------------- ----------- ---- ------vs_1
vs_1.iscsi 1027
up/up
10.63.8.165
node1
e0c
true
Displays the logical interface vs_1.iscsi with the relative target port ID of 1.
2413
vserver iscsi interface accesslist add

Add the iSCSI LIFs to the accesslist of the specified initiator
Description
This command adds network interfaces to an access list for a specified initiator. An
access list ensures that an initiator only logs in with IP addresses associated with the
interfaces defined in the access list.
You can restrict an initiator to certain network interfaces to improve performance and
security. Access lists are useful where a particular initiator cannot access all of the
network interfaces on a node.
Access list policies are based on the interface name. The accesslist rules are:
If you disable the network interface for iSCSI through the vserver iscsi
interface disable command, for example, the network interface is not
accessible to any initiator regardless of any access lists in effect.
If an initiator does not have an access list, that initiator can access any iSCSIenabled network interface.
If an initiator has an access list, that initiator can only login to network interfaces in
its access list. Additionally, the initiator cannot discover any IP addresses that are
not on this access list. If an initiator sends an iSCSI sendtargets request, the node
responds with a list of IP addresses for iSCSI data logical interfaces that are in its
access list.
If an initiator does not have an access list, you automatically create an access
list when you issue the vserver iscsi interface accesslist add
command.
If you remove all the interfaces from the access list of an initiator with the
vserver iscsi interface accesslist remove command, the accesslist
is also deleted.
Creating or modifying access list requires that initiator log out and log back in
before changes take effect.
When you use the add or remove commands, the system warns you if an iSCSI session
could be affected.
2414
Note:
You will not affect any iSCSI sessions if you use the -a parameter when adding or
removing all interfaces.
Parameters
Specifies the Vserver name.
-initiator-name <text> - Initiator Name
Specifies the initiator you want to add to the access list.
Specifies the lif you want to add to an access list.
If you use this parameter without a value, it is set to true, and the command adds all
iSCSI data logical interfaces for a vserver to an initiator's accesslist. If the initiator does
not have an accesslist, the system creates a new accesslist.
If you use this parameter without a value, it is set to true, and the command does not
prompt you when an active iSCSI service or any active iSCSI data logical interfaces
could be affected. If you do not use this parameter, the command prompts for
confirmation if the iSCSI service is active or if any active data logical interfaces would be
affected.
Examples
cluster1::> vserver iscsi interface accesslist add -vserver vs_1 -initiator-name
iqn.1992-08.com.example:abcdefg -a
Adds the initiator iqn.1992-08.com.example:abcdefg on Vserver vs_1 for all iSCSI data
logical interfaces in vs_1.
See Also
vserver iscsi interface disable vserver iscsi interface accesslist remove
2415
vserver iscsi interface accesslist remove

Remove the iSCSI LIFs from the accesslist of the specified initiator
Description
This command removes network interfaces from an access list for a specified initiator.
The system removes the access list when the list is empty. When you remove a network
interface from an initiator, this action could result in the shutdown of active sessions.
Parameters
Specifies the Vserver name.
-initiator-name <text> - Initiator Name
Specifies the initiator that you want to remove logical interfaces from.
Specifies the logical interface you want to remove.
If you use this parameter without a value, it is set to true, and the command removes
all of the iSCSI data logical interfaces from an initiator's accesslist. If you remove all the
network interfaces from an access list, the system removes the access list.
If you use this parameter without a value, it is set to true, and the command does not
prompt you when an active iSCSI service or any active iSCSI data logical interfaces
could be affected. If you do not use this parameter, the command prompts for
confirmation if the iSCSI service is active or if any active data logical interfaces would be
affected.
Examples
cluster1::> vserver iscsi interface accesslist remove -vserver vs_1 -initiatorname iqn.1992-08.com.example:abcdefg -a
2416
Removes all the network interfaces from the access list for initiator
iqn.1992-08.com.example:abcdefg on Vserver vs_1.
2417
vserver iscsi interface accesslist show

Show accesslist of the initiators for iSCSI connectivity
Description
This command displays an access list for an initiator. An access list is a list of logical
interfaces that an initiator can use for iSCSI logins. The system records the access lists
as part of the node configuration and preserves the access lists during reboots.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display the access lists that match the Vserver name that you
specify.
Use this parameter to display the access lists that match the initiator that you specify.
Use this parameter to display the access lists that match the logical interface that you
specify.
Examples
cluster1::> vserver iscsi interface accesslist show -vserver vs1
Vserver
Initiator Name
Logical Interface
------------------ ----------------------------- ----------------------------vs1
2418
iqn.2010-01.com.example:aaaaa isw1
isw2
iqn.2010-01.com.example:aaabb isw1
isw2
Displays the access lists for vserver vs1.
2419
vserver iscsi isns create

Configure the iSNS service for the Vserver
Description
This command creates and starts an iSNS service with the IP address of the iSNS
server.
Note:
A Vserver management LIF must exist before you can create an iSNS service. This
LIF is used to communicate with the iSNS server. To create a Vserver management
LIF, use the network interface create command, with -role data and -dataprotocol none.
Parameters
Specifies the Vserver for the iSNS service that you want to create.
-address <IP Address> - iSNS Server IP Address
Specifies the IP address of the iSNS server. Both IPv4 and IPv6 address families are
supported. The address family must be the same as that of the vserver management
LIF.
Note:
A default route must exist for the specified vserver. To create a route, use the network
routing-groups route create command. To view existing routes, use the
network routing-groups route show command.
Specifies the administrative status of the iSNS service of a Vserver. If you set this
parameter to up, the iSNS service starts for the Vserver and registers with the
configured iSNS server. If you set this parameter to down, the Vserver loses its ability to
register with the iSNS server and to be discovered by iSNS clients.
2420
[-force [true]] - Force

vserver iscsi isns create fails if vserver management LIF is not configured.
When you set this option to "true," you create an iSNS service on a Vserver even if the
vserver does not have a vserver management LIF.
Examples
cluster1::> vserver iscsi isns create -vserver vs_1 -address 10.60.1.1 -statusadmin up
Creates the iSNS service for Vserver vs_1 using the IPv4 address.
cluster1::> vserver iscsi isns create -vserver vs_1 -address
fd20:8b1e:b255:840b:a0df:565b:19b5:4d06 -status-admin up
Creates the iSNS service for Vserver vs_1 using the IPv6 address.
See Also
network routing-groups route create network routing-groups route show
network interface create
2421
vserver iscsi isns delete

Remove the iSNS service for the Vserver
Description
This command deletes the iSNS service for the Vserver.
Parameters
Specifies the Vserver for the iSNS service that you want to delete.
Examples
cluster1::> vserver iscsi isns delete -vserver vs_1
Deletes the iSNS service for Vserver vs_1.
2422
vserver iscsi isns modify

Modify the iSNS service for the Vserver
Description
This command modifies the configuration of an iSNS service.
Modifications take effect immediately after you execute the command.
Parameters
Specifies the Vserver for the iSNS service that you want to modify.
[-address <IP Address>] - iSNS Server IP Address
Specifies the IP address of the iSNS server. Both IPv4 and IPv6 address families are
supported. The address family must be the same as that of the vserver management
LIF.
Note:
A default route must exist for the specified vserver. To create a route, use the network
routing-groups route create command. To view existing routes, use the
network routing-groups route show command.
Specifies the administrative status of the iSNS service of a Vserver. If you set this
parameter to up, the iSNS service starts for the Vserver, and registers with the
configured iSNS server. If you set this parameter to down, the Vserver loses its ability to
[-force [true]] - Force
vserver iscsi isns modify fails to modify the iSNS server address if vserver
management LIF is not configured. When you set this option to "true," you can modify
the iSNS service on a Vserver even if the vserver does not have a vserver management
LIF.
2423
Examples
cluster1::> iscsi isns modify -vserver vs_1 -status-admin up
Modifies the status-admin of the iSNS service for Vserver vs_1 to up.
See Also
network routing-groups route create network routing-groups route show
2424
vserver iscsi isns show

Show iSNS service configuration
Description
Shows the iSNS service configuration.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display the iSNS services that match the Vserver name that you
specify.
[-address <IP Address>] - iSNS Server IP Address
Use this parameter to display the iSNS services that match the IP address of the iSNS
server that you specify.
Use this parameter to display the iSNS services that match the configured status of the
service that you specify.
[-entity-id <text>] - iSNS Server Entity Id
Use this parameter to display the iSNS services that match the configured iSNS server
entity-id that you specify.
[-last-successful-update <MM/DD/YYYY HH:MM:SS>] - Last Successful Update
Use this parameter to display the iSNS services that match the time of the last
successful attempt.
2425
[-last-update-attempt <MM/DD/YYYY HH:MM:SS>] - Last Update Attempt

Use this parameter to display the iSNS services that match the time of the last update
attempt.
[-last-update-result <isnsErrors>] - Last Update Result
Use this parameter to display the iSNS services that match the result of the last update
attempt.
Examples
cluster1::> vserver iscsi isns show
Vserver
iSNS Server Entity Identifier
iSNS Server IP Address iSNS Status
---------- ------------------------------- ---------------------- ----------iscsi_vs
isns:00000044
10.229.136.188
up
Displays the output of the show command for all Vservers in a cluster.
cluster1::> vserver iscsi isns show -instance
Vserver Name: vs1
iSNS Server IP Address: 10.72.19.11
iSNS Server Entity Id: isns.0000001c
Last Successful Update: 11/12/2011 10:18:45
Last Update Attempt: 11/12/2011 10:18:45
Last Update Result: iSNS_Ok
Vserver Name: vs2

iSNS Server IP Address: 10.72.16.13
iSNS Server Entity Id: isns.0000001b
Last Successful Update: 11/12/2011 13:38:05
Last Update Attempt: 11/12/2011 13:38:05
Last Update Result: iSNS_Ok
Displays the details for all Vservers in a cluster.
2426
vserver iscsi isns start

Starts the iSNS service
Description
Starts the iSNS service. Once you start the iSNS service, the Vserver automatically
register with the iSNS server.
Parameters
Specifies the Vserver for the iSNS service that you want to start.
Examples
cluster1::> vserver iscsi isns start -vserver vs_1
Starts the iSNS service for Vserver vs_1.
2427
vserver iscsi isns stop

Stops the iSNS service
Description
Stops the iSNS service. Once you stop the iSNS service, the Vserver loses the ability to
Parameters
Specifies the Vserver for the iSNS service that you want to stop.
Examples
cluster1::> vserver iscsi isns stop -vserver vs_1
Stops the iSNS service for Vserver vs_1.
2428
vserver iscsi isns update

Force update of registered iSNS information
Description
Forces an update of the registration information with the iSNS server. Normally, the
system checks for iSNS configuration changes on the Vserver every few minutes and
automatically sends updates to the iSNS server.
Parameters
Specifies the Vserver for the iSNS service that you want to update.
Examples
cluster1::> vserver iscsi isns update -vserver vs_1
Updates the iSNS server registration for Vserver vs_1.
2429
vserver iscsi security create

Create an iSCSI authentication configuration for an initiator
Description
This command configures the security method for an iSCSI initiator on a Vserver.
The outbound CHAP password and user name are optional. If you want mutual
authentication, you need to configure both inbound and outbound CHAP passwords and
user names.
You cannot use the same password for inbound and outbound settings.
Parameters
-initiator-name | -i <text> - Initiator Name
Specifies the initiator that you want to create a security method for. You can use either
an iqn such as iqn.1995-08.com.example:string or eui such as eui.0123456789abcdef
for the initiator.
-auth-type | -s {CHAP|deny|none} - Authentication Type
Specifies the authentication type:
CHAP - Authenticates using a CHAP user name and password.
none - The initiator can access the Vserver without authentication.
deny - The initiator cannot access the Vserver.
[-user-name | -n <text>] - Inbound CHAP User Name
Specifies the inbound CHAP user name. CHAP user names can be one to 128 bytes.
A null user name is not allowed. If provided, you will be prompted to provide the
corresponding inbound CHAP password.
[-outbound-user-name | -m <text>] - Outbound CHAP User Name
2430
Specifies the outbound CHAP user name. CHAP user names can be one to 128 bytes.
If provided, you will be prompted to enter the corresponding outbound CHAP password.
Examples
cluster1::> iscsi security create -initiator eui.0123456789abcdef -auth-type CHAP
-user-name bob -outbound-user-name bob2
Password:
Outbound Password:
Creates authentication method chap for initiator eui.0123456789abcdef with inbound

and outbound usernames and passwords.
2431
vserver iscsi security default

Configure the default authentication settings
Description
This command defines a default iSCSI authentication method for your Vserver. If
you do not configure the initiator to use a user-defined authentication method, the
system assigns the default authentication method automatically to the initiator. Use
the vserver iscsi security create command if you want to configure a userdefined authentication method.
The outbound CHAP user name and password are optional. If you want a bi-directional
handshake, provide the outbound user name and you will be prompted for the
corresponding password.
You cannot use the same password for inbound and outbound settings.
Parameters
-auth-type | -s {CHAP|deny|none} - Authentication Method
{ [-outbound-user-name | -m <text>] - Outbound CHAP User Name
2432
| [-clear-outbound [true]] } - Clear Outbound CHAP Parameters

Removes the outbound user name and the outbound password information from the
default authentication method. After you clear the outbound information, you no longer
have a bi-directional handshake.
Examples
cluster1::> iscsi security default -vserver vs_1 -security chap -user-name bob outbound-user-name bob_out
Password:
Outbound Password:
Sets the default authentication method to CHAP with inbound and outbound user names
and passwords.
See Also
vserver iscsi security create
2433
vserver iscsi security delete

Delete the iSCSI authentication configuration for an initiator
Description
This command removes the security settings for this initiator. The default authentication
setting now applies to this initiator.
Parameters
Specifies the initiator that you want to remove the authentication setting from.
Examples
cluster1::> iscsi security delete -vserver vs_1 -initiator
iqn.1992-08.com.example:abcdefg
Deletes initiator iqn.1992-08.com.example:abcdefg on Vserver vs_1 from the

authentication setting. The default authentication now applies to this initiator.
2434
vserver iscsi security generate

Generate a 128-bit random CHAP secret
Description
This command generates a 128-bit value that you can use as a CHAP secret.
Parameters
None
Examples
cluster1::> vserver iscsi security generate
Generated Random Secret: 0x1c755035c7a64c302d4fa2459223f205
Generates a random secret password.
2435
vserver iscsi security modify

Modify the iSCSI authentication configuration for an initiator
Description
The command modifies an existing authentication method for an initiator. To delete the
authentication setting for an initiator, use the vserver iscsi security delete
command.
The outbound CHAP password and user name are optional. If you want a bi-directional
handshake, you need to configure both inbound and outbound CHAP passwords and
user names.
You do not need to know the inbound or outbound passwords to change them.
Parameters
Specifies the initiator name that you want to modify the existing authentication method.
[-auth-type | -s {CHAP|deny|none}] - Authentication Type
{ [-outbound-user-name | -m <text>] - Outbound CHAP User Name
2436
| [-clear-outbound [true]] } - Clear Outbound CHAP Parameters
Removes the outbound user name and the outbound password information from the
authentication method. After you clear the outbound information, you no longer have a
bi-directional handshake.
Examples
cluster1::> vserver iscsi security modify -vserver vs_1 -initiator
iqn.1992-08.com.example:abcdefg -auth-type chap -user-name bob -outbound-username bob_out
Password:
Outbound Password:
Changes user names and passwords for initiator iqn.1992-08.com.example:abcdefg on

Vserver vs_1.
See Also
vserver iscsi security delete
2437
vserver iscsi security show

Show the current iSCSI authentication configuration
Description
This command displays the default authentication and all initiator-specific authentication
information. Data ONTAP authentication overrides all other service authentication
methods.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display authentication information that matches the Vserver name
that you specify.
[-initiator-name | -i <text>] - Initiator Name
Use this parameter to display authentication information that matches the initiator that
you specify.
[-auth-type | -s {CHAP|deny|none}] - Authentication Type
Use this parameter to display authentication information that matches the authentication
type that you specify.
Use this parameter to display authentication information that matches the inbound
CHAP user name that you specify.
[-outbound-user-name | -m <text>] - Outbound CHAP User Name
2438
Use this parameter to display authentication information that matches the outbound
CHAP user name that you specify.
[-auth-chap-policy <local>] - Authentication CHAP Policy
Use this parameter to display authentication information that matches the authentication
CHAP policy that you specify.
Examples
cluster1::> iscsi security show -vserver vs_1
Vserver
Initiator Name
Auth
Auth CHAP Inbound CHAP
Outbound CHAP
Type
Policy
User Name
User Name
---------- ---------------------- ------ --------- ------------- ------------vs_1
default
vs_1
iqn.2010-12.com.example:abcdefg
none
CHAP
local
bob
bob2
Displays the authentication information for Vserver vs_1.
2439
vserver iscsi session show

Display iSCSI sessions
Description
This command displays iSCSI session information. If you do not specify the target
session ID (TSIH), the command displays all session information for the specified
Vserver. If a Vserver is not specified, the command displays all session information
in the cluster. Use the vserver iscsi connection show command to display
connection information. Use the vserver iscsi session parameter show
command to show the parameters used when creating the session.
You can use session information for troubleshooting performance problems.
An iSCSI session can have one or multiple connections. Typically a session has at least
one connection.
Most of the parameters are read-only. However, some parameters can be modified with
the vserver iscsi modify command.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display iSCSI session information that matches the Vserver name
that you specify.
Use this parameter to display iSCSI session information that matches the target portal
group name that you specify.
2440

Use this parameter to display iSCSI session information that matches the target session
ID that you specify.
[-max-ios-per-session <integer>] - Max Commands per Session
Use this parameter to display iSCSI session information that matches the maximum
commands per session count you specify.
[-data-pdu-in-order {true|false}] - Data PDU in Order
Specifies if the data PDUs are in sequence order. If you enter this command without
using this parameter, it is set to true, and the command displays all session information
that supports PDUs in order. If you provide a false value, the command displays all
session information that does not support PDUs in order.
[-data-sequence-in-order {true|false}] - Data Sequence in Order
Specifies if the data is in sequence order. If you enter this command without using this
parameter, it is set to true, and the command displays all session information where
data sequence is supported. If you provide a false value, the command displays all
session information that does not support data sequence.
[-default-time-to-retain <integer>] - Default Time to Retain
Use this parameter to display session information that matches the retain time that you
specify. This value specifies the amount of time before active reassignment is possible
after an unexpected connection termination or a connection reset. A value of 0 means
the connection task state is immediately discarded by the target.
[-default-time-to-wait <integer>] - Default Time to Wait
Use this parameter to display session information that matches the logout or active task
assignment wait time that you specify. Wait time refers to the amount of time before
attempting an explicit or implicit logout or active task assignment after an unexpected
connection termination or connection reset.
[-error-recovery-level <integer>] - Error Recovery Level
Use this command to display session information that matches the error recovery level
that you specify.
[-first-burst-length <integer>] - First Burst Length
Use this parameter to display session information that matches the first burst length that
you specify. First burst length is the maximum amount of unsolicited data in bytes that
can be sent during the execution of a single iSCSI packet. First burst length covers the
total amount of immediate data and the unsolicited data-out PDU. The first burst length
must not exceed the maximum burst length.
2441
[-immediate-data-enabled {true|false}] - Immediate Data

Specifies if immediate data is supported. When immediate data is supported, the
initiator can send immediate data. If you enter this command using the parameter
without a value, it is set to true, and the command displays all session information that
supports immediate data. If you provide a false value, the command displays all session
information that does not support immediate data.
Use this parameter to display iSCSI session information that matches the alias name of
the initiator that you specify.
[-initial-r2t-enabled {true|false}] - Initial R2T Enabled
Specifies if the initiator supports Initial Ready to Transfer (R2T). R2T is the mechanism
that allows the target to request the initiator for output data. If you enter this command
using the parameter without a value, it is set to true, and the command displays all
session information that supports initial R2T data. If you provide a false value, the
command displays all session information that does not support initial R2T data.
Use this parameter to display the iSCSI session information that matches the initiator
Use this parameter to display iSCSI session information that matches the initiator
session ID that you specify.
[-max-burst-length <integer>] - Max Burst Length for Session
burst length that you specify. Maximum burst length is the maximum iSCSI data payload
in bytes for a data-in or solicited data-out sequence.
[-max-connections <integer>] - Max Connections for Session
number of connections that you specify.
[-max-outstanding-r2t <integer>] - Max Outstanding R2T for Session
number of outstanding R2T per task that you specify.
[-session-type <iSCSI Session Type>] - Session Type
Use this parameter to display iSCSI session information that matches the session type
that you specify.
2442

group tag that you specify.
[-connection-ids <integer>, ...] - Active Connection IDs
Use this parameter to display iSCSI session information that matches the active
connection IDs that you specify.
Examples
cluster1::> vserver iscsi session show -vserver vs_1
Tpgroup
Vserver
Name
Initiator
TSIH
Name
Initiator
ISID
Alias
--------- ------- ------ ---------------------- --------- ----------------------vs_1
tpgroup_1
2
00:02:3d:01:00:00
initiator-alias
Displays session information for all sessions on Vserver vs_1.
See Also
vserver iscsi connection show vserver iscsi session parameter show
2443
vserver iscsi session shutdown

Shut down a session on a node
Description
This command forces a shutdown of all connections in a session. If you want to shut
down a single connection in a session, use the vserver iscsi connection
shutdown command.
Parameters
-tpgroup <text> - Target Portal Group
Specifies the target portal group that contains the session you want to shutdown.
-tsih <integer> - Target Session ID
Specifies the target session ID that you want to shut down.
Examples
cluster1::*> vserver iscsi session shutdown -vserver vs_1 -tpgroup tpgroup_1 tsih 2
Forces a session shutdown for target session ID 2 in tpgroup_1 in Vserver vs_1 .
See Also
vserver iscsi connection shutdown
2444
vserver iscsi session parameter show

Display the parameters used to establish an iSCSI session
Description
This command displays session parameter information. This command is intended for
troubleshooting performance problems.
Most of the parameters are read-only. However, some parameters can be modified with
the vserver iscsi modify command.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display session information that matches the Vserver name that
you specify.
Use this parameter to display session information that matches the target portal group
Use this parameter to display session information that matches the target session ID
that you specify.
[-cmd-window-size <integer>] - Max Commands per Session
Use this parameter to display session information that matches the command window
size that you specify.
2445
[-data-pdu-in-order {true|false}] - Data PDU in Order

Use this parameter to display session information with the value of the Protocol Data
Units (PDU) in order flag you specify. This parameter indicates if the data within a
sequence can be in any order or must be in sequence. If you enter this command
without using this parameter, it is set to true, and the command displays all session
information that supports PDUs in order. If you provide a false value, the command
displays all session information that does not support PDUs in order.
[-data-sequence-in-order {true|false}] - Data Sequence in Order
Use this parameter to display session information with the value of the data sequence
in order flag that you specify. If you enter this command without using this parameter,
it is set to true, and the command displays all session information that supports data
sequence. If you set the values to false, the command displays all session information
that does not support data sequence.
[-default-time-to-retain <integer>] - Default Time to Retain
Use this parameter to display session information that matches the retain time that you
specify. This value specifies the amount of time before active reassignment is possible
after an unexpected connection termination or a connection reset. A value of 0 means
the connection task state is immediately discarded by the target.
[-default-time-to-wait <integer>] - Default Time to Wait
Use this parameter to display session information that matches the logout or active task
assignment wait time that you specify. Wait time refers to the amount of time before
attempting an explicit or implicit logout or active task assignment after an unexpected
connection termination or connection reset.
[-error-recovery-level <integer>] - Error Recovery Level
Use this command to display session information that matches the error recovery level
that you specify.
[-first-burst-length <integer>] - First Burst Length
Use this parameter to display session information that matches the first burst length that
you specify. First burst length is the maximum amount of unsolicited data in bytes that
can be sent during the execution of a single iSCSI packet. First burst length covers the
total amount of immediate data and the unsolicited data-out PDU. The first burst length
must not exceed the maximum burst length.
[-immediate-data-enabled {true|false}] - Immediate Data
Use this parameter to display session information with the value of the immediate dataenabled flag that you specify. If you enter this command without using this parameter, it
is set to true, and the command displays all session information that supports immediate
2446
data. If you set the value to false, the command displays all session information that
does not support immediate data.
[-initial-r2t-enabled {true|false}] - Initial R2T Enabled
Use this parameter to display session information with the value of the R2T dataenabled flag that you specify. If you enter this command without using this parameter, it
is set to true, and the command displays all session information that supports R2T data.
If you set the value to false, the command displays all session information that does not
support R2T data.
Use this parameter to display iSCSI session information that matches the initiator alias
name you specify.
Use this parameter to display iSCSI session information that matches the initiator name
you specify.
session identifier you specify.
[-max-burst-length <integer>] - Max Burst Length for Session
burst length that you specify. Maximum burst length is the maximum iSCSI data payload
in bytes for a data-in or solicited data-out sequence.
[-max-connections <integer>] - Max Connections for Session
number of connections that you specify.
[-max-outstanding-r2t <integer>] - Max Outstanding R2T for Session
number of outstanding R2T per task that you specify.
[-session-type <iSCSI Session Type>] - Session Type
Use this parameter to display iSCSI session information that matches the session type
you specify.
group tag you specify.
2447
[-initiator-mrdsl <integer>, ...] - Initiator Max Recv Data Len

maximum receivable data segment length you specify. An iSCSI initiator declares the
maximum data segment length in bytes it can receive in an iSCSI PDU during the iSCSI
login phase.
[-target-mrdsl <integer>, ...] - Target Max Recv Data Len
Use this parameter to display iSCSI session information that matches the target
maximum receivable data segment length you specify. An iSCSI target declares the
maximum data segment length in bytes it can receive in an iSCSI PDU during the iSCSI
login phase.
Examples
cluster1::> iscsi session parameter show -vserver vs_1
Tpgroup
Vserver Name
Max
Data PDU Data Seq Time 2 Time 2 Error
TSIH Conn In Order In Order Retain Wait
Imm
Rec Lvl Data
Initial
R2T
------- ------- ---- ---- -------- -------- ------ ------ ------- ----- ------vs_1
vs_1.iscsi 6
1 true
true
0 true
false
vs_1
vs_1.iscsi 7
1 true
true
0 true
false
Lists iSCSI session parameters for Vserver vs_1.
See Also
2448
vserver locks break

Break file locks based on a set of criteria
Description
The vserver locks break command breaks one or more locks.
Parameters
{ -vserver <vserver name> - Vserver
This parameter specifies the Vserver containing the lock.
This parameter specifies the name of the volume containing the lock.
This parameter specifies the logical interface through which the lock was established.
-path <text> - Object Path
This parameter specifies a path to the lock.
| -lockid <UUID> } - Lock UUID
This parameter specifies the universally unique identifier (UUID) for the lock.
Examples
The following example breaks the locks on all objects on the Vserver named vs0 in
the volume named vol0, regardless of the paths to the locked objects and the logical
interface through which the locks were established.
cluster1::*> vserver locks break -vserver vs0 -volume vol0 -path * -lif *
WARNING: Breaking file locks can cause applications to become unsynchronized
and may lead to data corruption.
1 entry was acted on.
2449
vserver locks show

Display current list of locks
Description
The vserver locks show command displays information about locks. A lock is a
synchronization mechanism for enforcing limits on concurrent access to files where
many clients can be accessing the same file at the same time. The command output
depends on the parameter or parameters specified with the command. If you do not
specify any parameters, the command displays the following information about locks:
Vserver name
Volume name
Object path
Logical interface name
Lock protocol
Lock type
Client
Parameters
specify.
| [-smb-attrs ]
If you specify the -smb-attrs parameter, the command displays information related to
SMB2 and higher.
| [-instance ] }
about all fields.
{ [-vserver <vserver name>] - Vserver
2450
If you specify this parameter, the command displays information about locks on the
specified Vserver.
If you specify this parameter, the command displays information about locks on the
specified volume.
If you specify this parameter, the command displays information about locks established
through the specified logical interface.
[-path <text>] - Object Path
If you specify this parameter, the command displays information about locks at the
specified path name.
| [-lockid <UUID>] } - Lock UUID
If you specify this parameter, the command displays information about the lock with the
specified universally unique identifier (UUID).
[-protocol <lock protocol>] - Lock Protocol
If you specify this parameter, the command displays information about locks established
through the specified protocol. Some of the valid protocols are:
cifs: SMB locks
nlm: NFS3 locks
nfsv4: NFS4.0 locks
nfsv4.1: NFS4.1 locks
crposix: CrPosix locks for CREATE and LINK
fcache: Delegations for 7-mode destination FlexCache volumes
[-type {byte-range|share-level|op-lock|delegation}] - Lock Type
If you specify this parameter, the command displays information about locks of the
specified lock type. The four types of locks are:
Byte-range locks: Lock only a portion of a file.
Share locks: Represent opened files.
Opportunistic locks: Control client-side caching over SMB.
Delegations: Control client-side caching over NFSv4.
2451
[-node <nodename>] - Node Holding Lock State

If you specify this parameter, the command displays information about all locks on the
specified node.
[-lock-state <lock_state>] - Lock State
If you specify this parameter, the command displays information about the state of the
lock. Some of the valid states are:
granted: The lock is established.
revoking: The server is currently coordinating with the client to change the state of
this lock.
revoked: The lock is undergoing revocation to be downgraded or released.
adjusted: The lock is undergoing revocation to be replaced by a lock equal to or
weaker than the current lock.
subsumed: The lock is one of a set of locks that will replace a lock that is being
revoked.
waiting: The lock is waiting to be granted, because it conflicts with another lock.
denied: The lock has been denied.
timeout: The lock was waiting and has now timed out.
gone: The lock is about to be released.
unused: The lock is allocated but has not been processed into any state.
[-bytelock-offset <integer>] - Bytelock Starting Offset
If you specify this parameter, the command displays information about bytelocks with
the specified offset value. This is the index in the file (in bytes) where the lock begins.
[-bytelock-length <integer>] - Number of Bytes Locked
If you specify this parameter, the command displays information about bytelocks with
the specified length. This is the number of bytes that are locked by this particular lock.
[-bytelock-mandatory {true|false}] - Bytelock is Mandatory
If you specify this parameter, the command displays information only about mandatory
bytelocks. A mandatory bytelock enforces the requirement of byte range locking on
clients before accessing the associated range.
[-bytelock-exclusive {true|false}] - Bytelock is Exclusive
2452
If you specify this parameter, the command displays information only about exclusive
bytelocks. When an exclusive bytelock is granted, no other bytelock may be granted
whose range overlaps it.
[-bytelock-super {true|false}] - Bytelock is Superlock
If you specify this parameter, the command displays information only about superbytelocks. When a super-bytelock is granted, all other locks on that file are released,
and no other operations will be allowed on that file.
[-bytelock-soft {true|false}] - Bytelock is Soft
If you specify this parameter, the command displays information only about softened
bytelocks. An NFSv4 bytelock might become softened if the connection to the client is
interrupted. Soft locks might be reclaimed if the client reconnects. However if another
client requests a lock that conflicts with a soft lock, then the soft lock will be released.
[-oplock-level {exclusive|level2|batch|null|read-batch}] - Oplock Level
If you specify this parameter, the command displays information about locks with the
specified oplock level. The oplock level determines which operations the client may
cache locally. Those operations include opening, reading, writing, closing, and creating
and destroying bytelocks on a file. The five valid oplock levels are:
batch: The client may cache all operations on the file.
exclusive: The client may cache reads and writes on the file.
read-batch: The client may cache reads and opens on the file.
level2: The client may cache reads on the file.
null: The client may not cache any operations on the file.
[-sharelock-mode <share lock mode>] - Shared Lock Access Mode
If you specify this parameter, the command displays information about locks with the
specified sharelock mode. The parameter has two components separated by a hyphen:
the access mode followed by the share mode. The access mode specifies which
operations the client is allowed to perform on the file. The share mode specifies which
operations other clients are disallowed to perform. The two modes are a combination of
one or more of these permissions:
read
write
delete
all
2453
none
For example, the sharelock mode read_write-deny_delete allows the client to read and
write the file, and disallows other clients to delete the file. A special mode is delete-onclose, which specifies that the server will delete the file as soon as it is closed.
[-sharelock-soft {true|false}] - Shared Lock is Soft
If you specify this parameter, the command displays information only about softened
sharelocks. A NFSv4 sharelock can become softened when the connection to the client
is interrupted. If the client reconnects, it might reclaim the sharelock. However, if another
client creates a sharelock that conflicts with the softened sharelock, the softened
sharelock will be released.
[-delegation-type {read|write}] - Delegation Type
If you specify this parameter, the command displays information only about locks with
the specified delegation-type setting. The delegation type determines which operations
the client may cache locally. The two valid delegation types are:
read: The client may cache reads on the file.
write: The client may cache reads and writes on the file.
[-client-address <IP Address>] - Client Address
If you specify this parameter, the command displays information only about locks from
the specified client IP address.
[-smb-open-type {none|durable|persistent}] - SMB Open Type
the specified SMB open type. Valid open types are
durable: Durability is a feature of SMB2. A durable lock might become
"disconnected" if the connection between the client and server is disrupted.
A disconnected durable lock might be reconnected if the connection is
reestablished.
persistent: Persistence is a feature of SMB3. Persistent locks can become
disconnected and later reconnected, like durable locks. Persistent locks are used
to facilitate continuously available shares.
none: The lock is neither durable nor persistent.
[-smb-connect-state <Lock Connect State>] - SMB Connect State
the specified SMB connection state. Some of the valid states are:
2454
connected: This is the normal state of a SMB lock when the server and client are
connected.
disconnected: If a lock is durable or persistent, it might become disconnected if
the connection between the server and its client is interrupted. Disconnected locks
may later be reconnected if the connection is reestablished.
[-smb-expiration-time <integer>] - SMB Expiration Time (Secs)
If you specify this parameter, the command displays information only about locks
with the specified SMB lock expiration time. When a lock is disconnected, -smbexpiration-time shows the time remaining until the lock expires. The server
releases the lock after it expires.
[-smb-open-group-id <text>] - SMB Open Group ID
the specified SMB open group identifier. This is an opaque byte string provided by the
client as the SMB lease key when the lock is first established.
Examples
The following example displays default information about all locks:
cluster1::> vserver locks show
Vserver: vs0
Volume
Object Path
LIF
Protocol
Lock Type
Client
-------- ------------------------- ----------- --------- ----------- ---------vol1
/vol1/notes.txt
node1_data1
cifs
share-level 192.168.1.5
Sharelock Mode: read_write-deny_delete

op-lock
192.168.1.5
Oplock Level: read-batch

/vol1/notes1.txt
node1_data1
cifs

op-lock
192.168.1.5
Oplock Level: batch

/vol1
node1_data2
cifs
Sharelock Mode: read-deny_delete

/vol1/notes.txt
node1_data2
cifs
2455

op-lock
192.168.1.5

The following example displays the SMB related information about all locks:
cluster1::> vserver locks show -smb-attrs
Vserver: vs0
Volume
Object Path
LIF
Protocol
Lock Type
Client
-------- ------------------------- ----------- --------- ----------- ---------vol1
/vol1/notes.txt
node1_data1
cifs

Open Type: durable
Connect State: connected
Expiration Time (Secs): -
Open Group ID: 625e2ff46ee5df1194ba0050569d37047058909c00000000873d210700000000

op-lock
192.168.1.5

Open Type: -
Open Group ID: 625e2ff46ee5df1194ba0050569d37047058909c00000000873d210700000000

/vol1/notes1.txt
node1_data1
cifs

Open Type: durable
Open Group ID: 625e2ff46ee5df1194ba0050569d370440fc8891000000005a3f210700000000

op-lock
192.168.1.5
Oplock Level: batch

Open Type: -
Open Group ID: 625e2ff46ee5df1194ba0050569d370440fc8891000000005a3f210700000000

/vol1
node1_data2
cifs
Sharelock Mode: read-deny_delete

Open Type: none
Open Group ID: -
2456
/vol1/notes.txt
node1_data2
cifs

Open Type: durable
Open Group ID: 625e2ff46ee5df1194ba0050569d370408e08d9c00000000da40210700000000

op-lock
192.168.1.5

Open Type: -
Open Group ID: 625e2ff46ee5df1194ba0050569d370408e08d9c00000000da40210700000000

The following example displays default information about all locks in list form:
cluster1::> vserver locks show -instance
Vserver: vs0
Volume: vol1
Logical Interface: node1_data1
Object Path: /vol1/notes.txt
Lock UUID: 447db184-f801-11df-8bb5-00a098000e34
Lock Protocol: cifs
Lock Type: share-level
Node Holding Lock State: node1
Lock State: granted
Bytelock Starting Offset: Number of Bytes Locked: Bytelock is Mandatory: Bytelock is Exclusive: Bytelock is Superlock: Bytelock is Soft: Oplock Level: Shared Lock Access Mode: read_write-deny_delete
Shared Lock is Soft: false
Delegation Type: Client Address: 192.168.1.5
SMB Open Type: durable
SMB Connect State: connected
SMB Expiration Time (Secs):
2457
SMB Open Group ID:

625e2ff46ee5df1194ba0050569d37047058909c00000000873d210700000000
Vserver: vs0
Volume: vol1
Object Path: /vol1/notes.txt
Lock UUID: 447db185-f801-11df-8bb5-00a098000e34
Lock Protocol: cifs
Lock Type: op-lock
Lock State: granted
Bytelock Starting Offset: Number of Bytes Locked: Bytelock is Mandatory: Bytelock is Exclusive: Bytelock is Superlock: Bytelock is Soft: Oplock Level: read-batch
Shared Lock Access Mode: Shared Lock is Soft: Delegation Type: Client Address: 192.168.1.5
SMB Open Type: SMB Connect State: connected
SMB Expiration Time (Secs): SMB Open Group ID:
625e2ff46ee5df1194ba0050569d37047058909c00000000873d210700000000
Vserver: vs0
Volume: vol1
Object Path: /vol1/notes1.txt
Lock UUID: 48cee334-f801-11df-8bb5-00a098000e34
Lock Protocol: cifs
Lock Type: share-level
Lock State: granted
Bytelock Starting Offset: Number of Bytes Locked: Bytelock is Mandatory: -
2458
Bytelock is Exclusive: Bytelock is Superlock: Bytelock is Soft: Oplock Level: Shared Lock Access Mode: read_write-deny_delete
Shared Lock is Soft: false
Delegation Type: Client Address: 192.168.1.5
SMB Open Type: durable
SMB Connect State: connected
SMB Expiration Time (Secs): SMB Open Group ID:
625e2ff46ee5df1194ba0050569d370440fc8891000000005a3f210700000000
2459
vserver name-mapping create

Create a name mapping
Description
The vserver name-mapping create command creates a name mapping. Name
mappings are applied in the order in which they occur in the priority list; for example,
a name mapping that occurs at position 2 in the priority list is applied before a name
mapping that occurs at position 3. Each mapping direction (Kerberos-to-UNIX,
Windows-to-UNIX, and UNIX-to-Windows) has its own priority list. Data ONTAP
prevents you from creating two name mappings with the same pattern.
Patterns can be expressed as POSIX regular expressions. For information about regular
Each Vserver can have up to 1024 name mappings in each direction.
Note:
Parameters
This parameter specifies the Vserver on which you want to create the name mapping.
-direction <Direction of the name mapping> - Direction
This parameter specifies the direction of the name mapping. Possible values are krbunix for a Kerberos-to-UNIX name mapping, win-unix for a Windows-to-UNIX name
mapping, and unix-win for a UNIX-to-Windows name mapping.
This parameter specifies the name mapping's position in the priority list. Specify the
position as a positive integer.
Note:
2460
If you want to create a new name mapping at a position that is already occupied in
the priority list, use the vserver name-mapping insert command instead of the
vserver name-mapping create command.
Examples
The following example creates a name mapping on a Vserver named vs1. The mapping
is from UNIX to Windows at position 5 in the priority list. The mapping maps the pattern
cifs to the replacement EXAMPLE\Domain Users.
cluster1::> vserver name-mapping create -vserver vs1 -direction unix-win position 5 -pattern cifs -replacement "EXAMPLE\\Domain Users"
See Also
vserver name-mapping insert
2461
vserver name-mapping delete

Delete a name mapping
Description
The vserver name-mapping delete command deletes a name mapping.
Parameters
This parameter specifies the Vserver from which you want to delete the name mapping.
This parameter specifies the direction of the name mapping that you want to delete.
This parameter specifies the position of the name mapping that you want to delete.
Specify the position as a positive integer.
Examples
The following example deletes a name mapping on a Vserver named vs1. The name
mapping is from UNIX to Windows and is at position 5.
cluster1::> vserver name-mapping delete -vserver vs1 -direction unix-win position 5
vserver name-mapping insert

Create a name mapping at a specified position
Description
2462
The vserver name-mapping insert command creates a name mapping at a

specified position in the priority list. The command rearranges the list as needed to
accommodate the new entry. For instance, if you have a priority list of five mappings
and insert a new mapping at position 3, the mapping previously at position 3 is moved to
position 4, the mapping previously at position 4 is moved to position 5, and the mapping
previously at position 5 is moved to position 6. Each mapping direction (Kerberos-toUNIX, Windows-to-UNIX, and UNIX-to-Windows) has its own priority list.
Note:
Parameters
This parameter specifies the Vserver on which you want to create the name mapping.
This parameter specifies the position in the priority list at which you want to insert the
new name mapping. Specify a position as a positive integer.
Examples
2463
The following example creates a name mapping on a Vserver named vs1. It is a user
mapping from Kerberos to UNIX. It is inserted into the priority list at position 2. The
name mapping maps any principal in the Kerberos realm SEC.EXAMPLE.COM to the
UNIX user name corresponding to the principal's base name with any instance names
removed; for example, tom/admin@SEC.EXAMPLE.COM is mapped to tom.
cluster1::> vserver name-mapping insert -vserver vs1 -direction krb-unix position 2 -pattern "([^@/]+)(/[^@]+)?@SEC.EXAMPLE.COM" -replacement "\1"
vserver name-mapping modify

Modify a name mapping's pattern, replacement pattern, or both
Description
The vserver name-mapping modify command modifies the pattern, the
replacement pattern, or both of a specified name mapping.
Note:
Parameters
This parameter specifies the Vserver on which you want to modify the name mapping.
2464
This parameter specifies the name mapping's position in the priority list. A position is
specified as a positive integer. Each mapping direction (Kerberos-to-UNIX, Windows-toUNIX, and UNIX-to-Windows) has its own priority list.
Examples
The following example modifies the name mapping on the Vserver named vs1 and
direction win-unix, at position 3. The pattern to be matched is changed to "EXAMPLE\(.
+)".
cluster1::> vserver name-mapping modify -vserver vs1 -direction win-unix position 3 -pattern "EXAMPLE\\(.+)"
vserver name-mapping show

Display name mappings
Description
The vserver name-mapping show command displays information about name
mappings. The command output depends on the parameter or parameters specified
following information about all name mappings:
Vserver name
Direction of the mapping (krb-unix for Kerberos-to-UNIX, win-unix for Windows-toUNIX, or unix-win for UNIX-to-Windows)
Position of the mapping in the priority list
Pattern to be matched
2465
Replacement pattern
parameters. For instance, to display information only about Kerberos-to-UNIX name
mappings, run the command with the -direction krb-unix parameter.
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays information only about the name
mapping or mappings that match the specified Vserver.
[-direction <Direction of the name mapping>] - Direction
mapping or mappings that have the specified mapping direction.
[-position <integer>] - Position
mapping that has the specified position in the priority list.
mapping or mappings that use the specified matching pattern. The pattern can be up to
256 characters in length. Refer to the command description section for details.
mapping or mappings that use the specified replacement pattern.
Examples
The following example displays information about all name mappings:
cluster1::> vserver name-mapping show
2466
Vserver
Direction Position
-------------- --------- -------vs1
win-unix
Pattern: EXAMPLE\\administrator
Replacement: nobody
vs1
unix-win
Pattern: EXAMPLE\\(.+)
Replacement: \_1
vs2
win-unix
Pattern: (.+)
Replacement: EXAMPLE\\administrator
2467
vserver name-mapping swap

Exchange the positions of two name mappings
Description
The vserver name-mapping swap command exchanges the positions of two name
mappings in the priority list.
Parameters
This parameter specifies the Vserver on which the name mappings are located.
This parameter specifies the direction of the name mappings that you want to exchange.
Each mapping direction (Kerberos-to-UNIX, Windows-to-UNIX, and UNIX-to-Windows)
has its own priority list.
This parameter specifies the position in the priority list of the first name mapping that
-with-position <integer> - Position of an existing name mapping entry in the list of
name mappings for this Vserver. This entry will be swapped with the entry at 'position'.
This parameter specifies the position in the priority list of the second name mapping that
Examples
The following example exchanges the positions of two name mappings on a Vserver
named vs1. The name mappings have the direction Windows-to-UNIX. The name
mappings are exchanged between positions 2 and 4.
cluster1::> vserver name-mapping swap -vserver vs1 -direction win-unix -position
2 -with-position 4
2468
vserver nfs create

Create an NFS configuration for a Vserver
Description
The vserver nfs create command enables and configures a Vserver to serve NFS
clients. The Vserver must already exist. An NFS-enabled Vserver is associated with an
NIS domain.
Parameters
This optional parameter specifies the Vserver on which you want to enable and
configure NFS. The default setting is vs0.
[-access {true|false}] - General NFS Access
This optional parameter specifies whether to enable NFS access on the Vserver. The
[-rpcsec-ctx-high <integer>] - RPC GSS Context Cache High Water Mark (privilege:
advanced)
This optional parameter specifies the maximum number of RPCSEC_GSS
authentication contexts, which are used by Kerberos. The default setting is zero. See
RFC 2203 for information about RPCSEC_GSS contexts.
[-rpcsec-ctx-idle <integer>] - RPC GSS Context Idle (privilege: advanced)
This optional parameter specifies, in seconds, the amount of time a RPCSEC_GSS
context is permitted to remain unused before it is deleted. The default setting is zero
seconds. See RFC 2203 for information about RPCSEC_GSS contexts.
[-v3 {enabled|disabled}] - NFS v3
This optional parameter specifies whether to enable access for NFSv3 clients. The
default setting is enabled.
[-v4.0 {enabled|disabled}] - NFS v4.0
2469
This optional parameter specifies whether to enable access for NFSv4.0 clients. The
default setting is disabled. This parameter is not supported for Vservers with Infinite
Volume.
[-udp {enabled|disabled}] - UDP Protocol
This optional parameter specifies whether to enable NFS access over UDP. The default
setting is enabled. This parameter is not supported for Vservers with Infinite Volume.
Note:
Even if UDP is disabled, if TCP is enabled, the Vserver does not block the NFSv3 traffic
over UDP. By allowing this traffic, the storage system can process NFS_NULL ops
that the Solaris automounter sends to determine if the storage system is alive. (Solaris
sends these ops over UDP even if configured to use TCP.) To block this traffic, you can
use export-policy rules to completely disable UDP access. For more information, see the
vserver export-policy rule create command.
[-tcp {enabled|disabled}] - TCP Protocol
This optional parameter specifies whether to enable NFS access over TCP. The default
setting is enabled.
[-default-win-user <text>] - Default Windows User
This optional parameter specifies a list of default Windows users for the NFS server.
[-enable-ejukebox {true|false}] - Enable NFSv3 EJUKEBOX error (privilege: advanced)
This optional parameter specifies whether EJUKEBOX errors are enabled for NFSv3.
[-v3-require-read-attributes {true|false}] - Require All NFSv3 Reads to Return Read
Attributes (privilege: advanced)
This optional parameter specifies whether NFSv3 read operations are required to return
read attributes. The default setting is false.
[-v3-fsid-change {enabled|disabled}] - Show Change in FSID as NFSv3 Clients
Traverse Filesystems (privilege: advanced)
This optional parameter specifies whether Data ONTAP shows changes in file system
identifiers (FSIDs) as NFSv3 clients traverse file systems. The default setting is
enabled.
[-v3-connection-drop {enabled|disabled}] - Enable the Dropping of a Connection When
an NFSv3 Request is Dropped (privilege: advanced)
2470
This optional parameter specifies whether Data ONTAP allows to drop the connection
when a NFSv3 request is dropped. The default setting is enabled.
[-ntfs-unix-security-ops <NfsNtfsUnixSecOps>] - Vserver NTFS Unix Security Options
This optional parameter specifies how NFSv3 security changes affect NTFS volumes.
If you set this parameter to ignore, Data ONTAP ignores NFSv3 security changes. If
you set this parameter to fail, NFSv3 security changes fail. If you set this parameter to
use_export_policy, Data ONTAP processes NFSv3 security changes in accordance
with the relevant export rules. The default setting is use_export_policy.
[-chown-mode {restricted|unrestricted|use-export-policy}] - Vserver Change Ownership
Mode (privilege: advanced)
This optional parameter specifies the change ownership mode. The default setting is
use_export_policy.
[-trace-enabled {true|false}] - NFS Response Trace Enabled (privilege: advanced)
This optional parameter specifies whether Data ONTAP logs NFS requests when they
exceed the NFS response trigger time (see the trigger parameter). The default
setting is false.
[-trigger <integer>] - NFS Response Trigger (in secs) (privilege: advanced)
This optional parameter specifies the amount of time, in seconds, after which Data
ONTAP must log an NFS request if it has not completed (assuming the -traceenabled option is true). The default setting is 60.
[-udp-max-xfer-size <integer>] - UDP Maximum Transfer Size (privilege: advanced)
This optional parameter specifies the maximum transfer size (in bytes) that the NFS
mount protocol will negotiate with the client for UDP transport. The range is 8192 to
57344. The default setting is 32768.
[-tcp-max-xfer-size <integer>] - TCP Maximum Transfer Size (privilege: advanced)
This optional parameter specifies the maximum transfer size (in bytes) that the storage
system negotiates with the client for TCP transport of data for NFSv2 and NFSv4
protocols. The range is 8192 to 65536. The default setting is 65536.
[-v3-tcp-max-read-size <integer>] - NFSv3 TCP Maximum Read Size (privilege:
advanced)
system negotiates with the client for TCP transport of data for NFSv3 read requests.
The range is 8192 to 1048576. The default setting is 65536 when created.
Note:
2471
This field is supported only if all the nodes in the cluster are running Data ONTAP
version 8.1.0 or later.
[-v3-tcp-max-write-size <integer>] - NFSv3 TCP Maximum Write Size (privilege:
advanced)
system negotiates with the client for TCP transport of data for NFSv3 write requests.
Note:
[-v4.0-acl {enabled|disabled}] - NFSv4.0 ACL Support
This optional parameter specifies whether Data ONTAP supports NFSv4.0 access
control lists (ACLs). The default setting is disabled. This parameter is not supported
for Vservers with Infinite Volume.
[-v4.0-read-delegation {enabled|disabled}] - NFSv4.0 Read Delegation Support
This optional parameter specifies whether Data ONTAP supports NFSv4.0 read
delegations. The default setting is disabled. This parameter is not supported for
[-v4.0-write-delegation {enabled|disabled}] - NFSv4.0 Write Delegation Support
This optional parameter specifies whether Data ONTAP supports NFSv4.0 write
enabled.
Note:
If users access the storage system using NFSv4 from Solaris 10 clients, you must set
this option to disabled.
[-v4.0-referrals {enabled|disabled}] - NFSv4.0 Referral Support (privilege: advanced)
2472
This optional parameter specifies whether Data ONTAP supports NFSv4.0 referrals.
The default setting is disabled. You can set this parameter to enabled only if you also
set the -v4-fsid-change to enabled. If clients accessing the node do not support
NFSv4.0 referrals, set this option to disabled; otherwise, those clients will not be able
to access the file system. This parameter is not supported for Vservers with Infinite
Volume.
[-v4-id-domain <nfs domain>] - NFSv4 ID Mapping Domain
This optional parameter specifies the domain portion of the string form of user and
group names as defined by the NFSv4 protocol. By default, the domain name is
normally taken from the NIS domain or the DNS domain in use. However, the value of
this parameter overrides the default behavior.
[-v4-validate-symlinkdata {enabled|disabled}] - NFSv4 Validate UTF-8 Encoding of
Symbolic Link Data (privilege: advanced)
This optional parameter specifies whether Data ONTAP validates the UTF-8 encoding of
symbolic link data. The default setting is disabled.
[-v4-lease-seconds <integer>] - NFSv4 Lease Timeout Value (in secs) (privilege:
advanced)
This optional parameter specifies the time period in which Data ONTAP irrevocably
grants a lock to a client. By default, the lease period is 30 seconds. The minimum value
is 10. The maximum value is one less than the value of the -v4-grace-seconds
parameter.
[-v4-grace-seconds <integer>] - NFSv4 Grace Timeout Value (in secs)
This optional parameter specifies the time period in which clients attempt to reclaim their
locking state from Data ONTAP during server recovery. By default, the grace period is
45 seconds. The minimum value is 1 more than the value of the -v4-lease-seconds
parameter. The maximum value is 90.
[-v4-acl-preserve {enabled|disabled}] - Preserves and Modifies NFSv4 ACL (and NTFS
File Permissions in Unified Security Style)
This optional parameter specifies if the NFSv4 ACL is preserved or dropped when
chmod is performed. In unified security style, this parameter also specifies if NTFS file
permissions are preserved or dropped when chmod, chgrp, or chown are performed.
The default is enabled.
[-v4.1 {enabled|disabled}] - NFSv4.1 Minor Version Support
default setting is disabled.
-rquota {enabled|disabled} - Rquota Enable
2473
This optional parameter specifies whether to enable rquota over NFS. The default
setting is disabled. This parameter is not supported for Vservers with Infinite Volume.
[-v4.1-implementation-domain <nfs domain>] - NFSv4.1 Implementation ID Domain
This optional parameter specifies the NFSv4.1 implementation domain.
[-v4.1-implementation-name <text>] - NFSv4.1 Implementation ID Name (privilege:
advanced)
This optional parameter specifies the NFSv4.1 implementation name.
[-v4.1-implementation-date <Date>] - NFSv4.1 Implementation ID Date (privilege:
advanced)
This optional parameter specifies the NFSv4.1 implementation date.
[-v4.1-pnfs {enabled|disabled}] - NFSv4.1 Parallel NFS Support
This optional parameter specifies whether Data ONTAP supports parallel NFS over
NFSv4.1. The default setting is enabled.
This optional parameter specifies whether Data ONTAP supports NFSv4.1 referrals.
The default setting is disabled. You can set this parameter to enabled only if you also
set the -v4-fsid-change to enabled. If clients accessing the node do not support
NFSv4.1 referrals, set this option to disabled; otherwise, those clients will not be able
to access the file system. This parameter is not supported for Vservers with Infinite
Volume.
control lists (ACLs). The default setting is disabled.
[-vstorage {enabled|disabled}] - NFS vStorage Support
This optional parameter specifies whether to enable vstorage over NFS. The default
setting is disabled. This parameter is not supported for Vservers with Infinite Volume.
[-v4-numeric-ids {enabled|disabled}] - NFSv4 Support for Numeric Owner IDs
This optional parameter specifies whether the support for numeric string identifiers in
NFSv4 owner attributes is enabled. The default setting is enabled.
[-default-win-group <text>] - Default Windows Group
This optional parameter specifies a list of default Windows groups for the NFS server.
2474
[-v4.x-session-num-slots <integer>] - Number of Slots in the NFSv4.x Session slot
tables (privilege: advanced)
This optional parameter specifies the number of entries in the NFSv4.x session slot
table. By default, the number of slots is 180. The maximum value is 2000.
[-v4.x-session-slot-reply-cache-size <integer>] - Size of the Reply that will be Cached
in Each NFSv4.x Session Slot (in bytes) (privilege: advanced)
This optional parameter specifies the number of bytes of the reply that will be cached
in each NFSv4.x session slot. By default, the size of the cached reply is 640 bytes. The
maximum value is 4096.
[-v4-acl-max-aces <integer>] - Maximum Number of ACEs per ACL (privilege:
advanced)
This optional parameter specifies the maximum number of ACEs in an NFSv4 ACL. The
range is 192 to 1024. The default value is 400. Setting it to a value more than the default
could cause performance problems for clients accessing files with NFSv4 ACLs.
[-mount-rootonly {enabled|disabled}] - NFS Mount Root Only
This optional parameter specifies whether the Vserver allows MOUNT protocol
calls only from privileged ports (port numbers less than 1024). The default setting is
enabled.
[-nfs-rootonly {enabled|disabled}] - NFS Root Only
This optional parameter specifies whether the Vserver allows NFS protocol calls only
from privileged ports (port numbers less than 1024). The default setting is disabled.
[-auth-sys-extended-groups {enabled|disabled}] - AUTH_SYS Extended Groups
This optional parameter specifies whether Data ONTAP supports fetching auxillary
groups from a name service rather than from the RPC header. The default setting is
disabled.
[-extended-groups-limit <integer>] - AUTH_SYS and RPCSEC_GSS Auxillary Groups
Limit (privilege: advanced)
2475
This optional parameter specifies the maximum number of auxillary groups supported
over RPC security flavors AUTH_SYS and RPCSEC_GSS in Data ONTAP. The range is
32 to 1024. The default value is 32.
[-validate-qtree-export {enabled|disabled}] - Validation of Qtree IDs for Qtree File
Operations (privilege: advanced)
This optional parameter specifies whether clustered Data ONTAP performs an additional
validation on qtree IDs. The default setting is enabled. This parameter is only effective
when a qtree is assigned an export policy.
[-mountd-port <integer>] - NFS Mount Daemon Port (privilege: advanced)
This optional parameter specifies which port the NFS mount daemon (mountd) uses.
The port numbers allowed are 635 (the default) and 1024 through 65535.
[-nlm-port <integer>] - Network Lock Manager Port (privilege: advanced)
This optional parameter specifies which port the network lock manager (NLM) uses. The
port numbers allowed are 1024 through 65535. The default setting is 4045.
[-nsm-port <integer>] - Network Status Monitor Port (privilege: advanced)
This optional parameter specifies which port the network status monitor (NSM) uses.
The port numbers allowed are 1024 through 65535. The default setting is 4046.
[-rquotad-port <integer>] - NFS Quota Daemon Port (privilege: advanced)
This optional parameter specifies which port the NFS quota daemon (rquotad) uses.
[-permitted-enc-types <NFS Kerberos Encryption Type>, ...] - Permitted Kerberos
Encryption Types
This optional parameter specifies the permitted encryption types for Kerberos over NFS.
The default setting is des,des3,aes-128,aes-256.
[-showmount {enabled|disabled}] - Showmount Enabled
This optional parameter specifies whether to allow or disallow clients to see all the
Vserver's NFS exports list using "showmount -e" command. The default setting is
disabled.
[-name-service-lookup-protocol {TCP|UDP}] - Set the Protocol Used for Name
Services Lookups for Exports
This optional parameter specifies the protocol to use for doing name service lookups.
The allowed values are TCP and UDP. The default setting is UDP.
[-map-unknown-uid-to-default-windows-user {enable|disable}] - Map Unknown UID
to Default Windows User (privilege: advanced)
2476
If you enable this optional parameter, unknown UNIX users that do not have a name
mapping to a Windows user are mapped to the configured default Windows user. This
allows all unknown UNIX users access with the credentials of the default Windows user.
If you disable it, all unknown UNIX users without name mapping are always denied
access. By default, this parameter is enabled.
[-netgroup-dns-domain-search {enabled|disabled}] - DNS Domain Search Enabled
During Netgroup Lookup (privilege: advanced)
If you enable this optional parameter, during client access check evaluation in a
netgroup, Data ONTAP performs an additional verification to ensure that the domain
returned from DNS for that client is listed in the DNS configuration of the Vserver. This
enables you to validate the domain when clients have the same short name in multiple
domains. The default setting is enabled.
Examples
The following example enables and configures NFS access on a Vserver named
vs0. NFS access is enabled. The maximum number of RPCSEC_GSS authentication
contexts is set to 5. The RPCSEC_GSS idle time is set to 360 seconds. Access is
enabled for NFS v3 clients over both UDP and TCP.
cluster1::> vserver nfs create -vserver vs0 -access true -rpcsec-ctx-high 5 rpcsec-ctx-idle 360 -v3 enabled -udp enabled -tcp enabled
See Also
2477
vserver nfs delete

Delete the NFS configuration of a Vserver
Description
The vserver nfs delete command deletes the NFS configuration of a specified
Vserver. This command does not delete the Vserver itself, just its ability to serve NFS
clients.
Note:
If you delete a Vserver, the Vserver's NFS configuration is automatically deleted. Any
Windows-to-UNIX or UNIX-to-Windows name mappings defined for the Vserver are also
deleted because they require both the CIFS and NFS servers.
Parameters
This specifies the Vserver whose NFS configuration you want to delete.
Examples
The following example deletes the NFS configuration of a Vserver named vs2:
cluster1::> vserver nfs delete -vserver vs2
vserver nfs modify

Modify the NFS configuration of a Vserver
Description
2478
The vserver nfs modify command modifies the configuration of an NFS-enabled

Vserver.
Parameters
This specifies the Vserver whose NFS configuration you want to modify.
This optional parameter specifies whether NFS access is enabled on the Vserver.
advanced)
This optional parameter specifies the maximum number of RPCSEC_GSS
authentication contexts, which are used by Kerberos. The default setting is zero at the
time of creation. See RFC 2203 for information about RPCSEC_GSS contexts.
This optional parameter specifies, in seconds, the amount of time a RPCSEC_GSS
context is permitted to remain unused before it is deleted. The default setting is zero
seconds at the time of creation. See RFC 2203 for information about RPCSEC_GSS
contexts.
This optional parameter specifies whether to enable access for NFS v3 clients.
default setting is enabled at the time of creation. This parameter is not supported for
This optional parameter specifies whether to enable NFS access over UDP. This value
is not modifiable on a Vserver with Infinite Volume.
Note:
Even if UDP is disabled, if TCP is enabled, the Vserver does not block the NFSv3 traffic
over UDP. By allowing this traffic, the storage system can process NFS_NULL ops
that the Solaris automounter sends to determine if the storage system is alive. (Solaris
sends these ops over UDP even if configured to use TCP.) To block this traffic, you can
use export-policy rules to completely disable UDP access. For more information, see the
vserver export-policy rule create command.
2479

This optional parameter specifies whether to enable NFS access over TCP.
This optional parameter specifies a list of default Windows users for the NFS server.
This optional parameter specifies whether EJUKEBOX errors are enabled for NFSv3.
The default setting is true at the time of creation.
This optional parameter specifies whether NFSv3 read operations are required to return
read attributes. The default setting is false at the time of creation.
identifiers (FSIDs) as NFSv3 clients traverse file systems. If you change the value of this
parameter, clients must remount any paths over which they are using NFSv3.
This optional parameter specifies whether NFS v3 connection drop is enabled. The
default setting is enabled at the time of creation.
This optional parameter specifies how NFSv3 security changes affect NTFS volumes.
If you set this parameter to ignore, Data ONTAP ignores NFSv3 security changes. If
you set this parameter to fail, NFSv3 security changes fail. If you set this parameter to
use_export_policy, Data ONTAP processes NFSv3 security changes in accordance
with the relevant export rules. The default setting is ignore at the time of creation.
This optional parameter specifies whether ownership of a file can be changed by
superusers or by non-root users who currently own the file. If you set this parameter to
restricted, the ownership of a file can be changed by superusers only. If you set this
parameter to unrestricted, the ownership of a file can be changed by superusers
2480
and the current owner of the file. If you set this parameter to use-export-policy, the
ownership of a file can be changed in accordance with the relevant export rules.
This optional parameter specifies whether Data ONTAP logs NFS requests when they
exceed the NFS response trigger time (see the trigger parameter). The default
setting is false at the time of creation.
This optional parameter specifies the amount of time, in seconds, after which Data
ONTAP must log an NFS request if it has not completed (assuming the -traceenabled option is set to true). The default setting is 60 at the time of creation.
This optional parameter specifies the maximum transfer size (in bytes) that the NFS
mount protocol negotiates with the client for UDP transport. The range is 8192 to 57344.
The default setting is 32768 at the time of creation.
system negotiates with the client for TCP transport of data for NFSv2 and NFSv4
protocols. The range is 8192 to 65536. The default setting is 65536 when created.
advanced)
system negotiates with the client for TCP transport of data for NFSv3 read requests.
Note:
advanced)
system negotiates with the client for TCP transport of data for NFSv3 write requests.
Note:
2481
control lists (ACLs). The default setting is disabled when created. This parameter is
not supported for Vservers with Infinite Volume.
This optional parameter specifies whether Data ONTAP supports NFSv4 read
delegations. The default setting is disabled when created. This parameter is not
This optional parameter specifies whether Data ONTAP supports NFSv4 write
enabled when created. If you change the value of this parameter, clients must remount
any paths over which they are using NFSv4.
Note:
If users access the storage system using NFSv4 from Solaris 10 clients, you must set
this option to disabled.
This optional parameter specifies whether Data ONTAP supports NFSv4.0 referrals. The
default setting is disabled when created. You can set this parameter to enabled only if
the -v4-fsid-change option is also set to enabled. If clients accessing the node do
not support NFSv4.0 referrals, set this option to disabled; otherwise, those clients will
not be able to access the file system. This parameter is not supported for Vservers with
Infinite Volume.
This optional parameter specifies the domain portion of the string form of user and
group names as defined by the NFSv4 protocol. By default, the domain name is
2482
normally taken from the NIS domain or the DNS domain in use. However, the value of
this parameter overrides the default behavior.
This optional parameter specifies whether Data ONTAP validates the UTF-8 encoding of
symbolic link data. The default setting is disabled when created.
advanced)
This optional parameters specifies the time period in which Data ONTAP irrevocably
grants a lock to a client. By default, the lease period is 30 seconds. The minimum value
is 10. The maximum value is one less than the value of the -v4-grace-seconds
parameter.
This optional parameter specifies the time period in which clients attempt to reclaim their
locking state from Data ONTAP during server recovery. By default, the grace period is
45 seconds. The minimum value is 1 more than the value of the -v4-lease-seconds
parameter. The maximum value is 90.
This optional parameter specifies if the NFSv4 ACL is preserved or dropped when
chmod is performed. In unified security style, this parameter also specifies if NTFS file
permissions are preserved or dropped when chmod, chgrp, or chown are performed.
The default is enabled.
[-rquota {enabled|disabled}] - Rquota Enable
This optional parameter specifies whether to enable rquota over NFS. The default
setting is disabled at the time of creation. This parameter is not supported for
This optional parameter specifies the NFSv4.1 implementation domain.
advanced)
2483
This optional parameter specifies the NFSv4.1 implementation name.

advanced)
This optional parameter specifies the NFSv4.1 implementation date.
This optional parameter specifies whether to enable access for pNFS for NFSv4.1. The
This optional parameter specifies whether Data ONTAP supports NFSv4.1 referrals. The
default setting is disabled when created. You can set this parameter to enabled only if
the -v4-fsid-change option is also set to enabled. If clients accessing the node do
not support NFSv4.1 referrals, set this option to disabled; otherwise, those clients will
not be able to access the file system. This parameter is not supported for Vservers with
Infinite Volume.
control lists (ACLs). The default setting is disabled when created.
This optional parameter specifies whether to enable vstorage over NFS. The default
setting is disabled at the time of creation. This parameter is not supported for
This optional parameter specifies whether to enable the support for numeric string
identifiers in NFSv4 owner attributes. The default setting is enabled at the time of
creation.
This optional parameter specifies a list of default Windows groups for the NFS server.
2484
This optional parameter specifies the number of entries in the NFSv4.x session slot
table. By default, the number of slots is 180. The maximum value is 2000.
This optional parameter specifies the number of bytes of the reply that will be cached
in each NFSv4.x session slot. By default, the size of the cached reply is 640 bytes. The
maximum value is 4096.
advanced)
This optional parameter specifies the maximum number of ACEs in a NFSv4 ACL. The
range is 192 to 1024. The default value is 400. Setting it to a value more than the default
could cause performance problems for clients accessing files with NFSv4 ACLs.
This optional parameter specifies whether the Vserver allows MOUNT protocol
calls only from privileged ports (port numbers less than 1024). The default setting is
enabled.
This optional parameter specifies whether the Vserver allows NFS protocol calls only
from privileged ports (port numbers less than 1024). The default setting is disabled.
This optional parameter specifies whether Data ONTAP supports fetching auxillary
groups from a name service rather than from the RPC header. The default setting is
disabled.
This optional parameter specifies the maximum number of auxillary groups supported
over RPC security flavors AUTH_SYS and RPCSEC_GSS in Data ONTAP. The range is
32 to 1024. The default value is 32.
2485

This optional parameter specifies whether clustered Data ONTAP performs an additional
validation on qtree IDs. The default setting is enabled. This parameter is only effective
when a qtree is assigned an export policy.
This optional parameter specifies which port the NFS mount daemon (mountd) uses.
The port numbers allowed are 635 (the default) and 1024 through 65535.
This optional parameter specifies which port the network lock manager (NLM) uses. The
port numbers allowed are 1024 through 65535. The default setting is 4045.
This optional parameter specifies which port the network status monitor (NSM) uses.
This optional parameter specifies which port the NFS quota daemon (rquotad) uses.
Encryption Types
This optional parameter specifies the permitted encryption types for Kerberos over NFS.
The default setting is des,des3,aes-128,aes-256.
This optional parameter specifies whether to allow or disallow clients to see all the
Vserver's NFS exports list using "showmount -e" command. The default setting is
disabled.
This optional parameter specifies the protocol to use for doing name service lookups.
The allowed values are TCP and UDP. The default setting is UDP.
If you enable this optional parameter, unknown UNIX users that do not have a name
mapping to a Windows user are mapped to the configured default Windows user. This
allows all unknown UNIX users access with the credentials of the default Windows user.
2486
If you disable it, all unknown UNIX users without name mapping are always denied
access. By default, this parameter is enabled.
If you enable this optional parameter, during client access check evaluation in a
netgroup, Data ONTAP performs an additional verification to ensure that the domain
returned from DNS for that client is listed in the DNS configuration of the Vserver. This
enables you to validate the domain when clients have the same short name in multiple
domains. The default setting is enabled.
Examples
The following example enables NFS access on a Vserver named vs0 for NFS clients
that use NFS v3 over TCP:
cluster1::> vserver nfs modify -vserver vs0 -access true -v3 enabled -udp
disabled -tcp enabled
See Also
2487
vserver nfs off

Disable the NFS service of a Vserver
Description
The vserver nfs off command disables NFS access on a Vserver. The Vserver
must already exist.
Parameters
This parameter specifies the Vserver on which you want to disable NFS access.
Examples
The following example disables NFS access on a Vserver named vs0.
cluster1::> vserver nfs off -vserver vs0
vserver nfs on
Enable the NFS service of a Vserver
Description
The vserver nfs on command enables NFS access on a Vserver. The Vserver must
already exist.
Parameters
This parameter specifies the Vserver on which you want to enable NFS access.
2488
Examples
The following example enables NFS access on a Vserver named vs0.
cluster1::> vserver nfs on -vserver vs0
vserver nfs show

Display the NFS configurations of Vservers
Description
The vserver nfs show command displays information about NFS-enabled Vservers.
command. If no parameters are specified, the command displays the following
information about all NFS-enabled Vservers:
Vserver name
Whether general NFS access is enabled
Whether access to NFSv3 clients is enabled
Whether access to NFSv4 clients is enabled
Whether NFS access over UDP is enabled
Whether NFS access over TCP is enabled
List of default Windows users (detailed view only)
parameters. For instance, to display information only about Vservers that enable access
over TCP, enter the command with the -tcp-enable true parameter.
Parameters
specify.
| [-krb-opts ] (privilege: advanced)
2489
If you specify the parameter for -instance , the command shows detailed information
about all NFS-enabled Vservers. Otherwise, if the -krb-opts parameter is specified,
the command shows the following Kerberos-related information:
Vserver name
Maximum number of RPCSEC_GSS authentication contexts
Time, in seconds, an RPCSEC_GSS context can remain idle before being deleted
Otherwise, if the -fields parameter is specified, the command shows information
about all of the NFS-enabled Vservers that you specify as a comma-delimited list.
| [-instance ] }
about all entries.
NFS-enabled Vserver.
If you specify this parameter, the command displays information only about the NFSenabled Vservers that have the specified general-access setting.
advanced)
If you specify this parameter, the command displays information only about NFSenabled Vservers that have the specified maximum number of RPCSEC_GSS
authentication contexts.
If you specify this parameter, the command displays information only about the NFSenabled Vservers that have the specified timeout value for idle RPCSEC_GSS contexts.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v3 option matches the specified input.
If you specify this parameter, the command displays information only about NFSenabled Vservers for which the v4.0 option matches the specified input.
2490
If you specify this parameter, the command displays information only about the NFSenabled Vservers that have the specified NFS-over-UDP access setting.
If you specify this parameter, the command displays information only about the NFSenabled Vservers that have the specified NFS-over-TCP setting.
If you specify this parameter, the command displays information only about the NFSenabled Vservers that have the specified list of default Windows users.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the enable-ejukebox option matches the specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which NFSv3 read operations are required or not required to return
read attributes.
If you specify this parameter, the command displays information about changes in file
system identifiers (FSIDs) as NFSv3 clients traverse file systems.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v3-connection-drop option matches the specified
input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the NTFS-UNIX security setting is ignore, fail, or
use_export_policy.
2491
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which chown-mode setting is restricted, unrestricted, or
use_export_policy.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the trace-enabled option matches the specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers with the specified NFS response trigger time.
If you specify this parameter, the command displays information only about the NFSenabled Vservers with the specified UDP maximum transfer size. The range is 8192 to
57344.
If you specify this parameter, the command displays information only about the NFSenabled Vservers with the specified TCP maximum transfer size. The range is 8192 to
65536.
advanced)
If you specify this parameter, the command displays information only about the NFSenabled Vservers with the specified TCP maximum transfer size for NFSv3 read
requests. The range is 8192 to 1048576.
Note:
advanced)
If you specify this parameter, the command displays information only about the NFSenabled Vservers with the specified TCP maximum transfer size for NFSv3 write
requests. The range is 8192 to 65536.
Note:
2492

If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v4.0-acl option matches the specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v4.0-read-delegation option matches the specified
input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v4.0-write-delegation option matches the
specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the showing of NFSv4 file system identifier (FSID) changes
has been enabled or disabled.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v4.0-referrals option matches the specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers having the specified NIS domain.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which validation of UTF-8 encoding of symbolic link data has been
enabled or disabled.
advanced)
If you specify this parameter, it displays the locking lease period. It is expressed in
seconds. Clients that have been inactive for a period equal or longer to the lease period
may lose all their locking state on a node.
2493
If you specify this parameter, it displays the grace period for clients to reclaim file locks
after a server failure. The grace period is expressed in seconds.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v4-acl-preserve option matches the specified input.
If you specify this parameter, the command displays information only about NFSenabled Vservers for which the v4.1 option matches the specified input.
[-rquota {enabled|disabled}] - Rquota Enable
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the rquota option matches the specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v4.1-implementation-domain option matches the
specified input.
advanced)
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v4.1-implementation-name option matches the
specified input.
advanced)
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v4.1-implementation-date option matches the
specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v4.1-pnfs option matches the specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v4.1-referrals option matches the specified input.
2494
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v4.1-acl option matches the specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the vstorage option matches the specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v4-numeric-ids option matches the specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers that have the specified list of default Windows groups.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v4.1-read-delegation option matches the specified
input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v4.1-write-delegation option matches the
specified input.
If you specify this parameter, this command displays information only about the NFSenabled Vservers for which the v4.x-session-num-slots option matches the
specified input. The range is 1 to 2000.
If you specify this parameter, this command displays information only about the NFSenabled Vservers for which the v4.x-session-slot-reply-cache-size option
matches the specified input. The cache size is expressed in bytes. The range is 512 to
4096.
advanced)
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the v4-acl-max-aces option matches the specified input.
2495

If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the mount-rootonly option matches the specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the nfs-rootonly option matches the specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the auth-sys-extended-groups option matches the
specified input.
If you specify this parameter, the command displays information about the NFS-enabled
Vservers for which the extended-groups-limit option matches the specified input.
The range is 32 to 1024.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which validate-qtree-export option matches the specified
input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the mountd-port option matches the specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the nlm-port option matches the specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the nsm-port option matches the specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which the rquotad-port option matches the specified input.
2496

Encryption Types
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which permitted-enc-types option matches any of the
following : des, des3, aes-128, aes-256.
If you specify this parameter, the command displays information only about the NFSenabled Vserver's for which the showmount option matches the specified input.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which -name-service-lookup-protocol matches the
parameter.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which -map-unknown-uid-to-default-windows-user is
enabled or disabled.
If you specify this parameter, the command displays information only about the NFSenabled Vservers for which -netgroup-dns-domain-search is enabled or disabled.
Examples
The following example displays information about all NFS-enabled Vservers:
cluster1::> vserver nfs show
General
Vserver
Access
Default
v3
v4
v4.1
UDP
TCP
Windows User
------------ ------- -------- -------- -------- -------- -------- -----------vs0
true
enabled
disabled disabled enabled
enabled
vs1
true
enabled
disabled disabled enabled
enabled
The following example displays Kerberos-related information about all NFS-enabled

Vservers:
2497
cluster1::*> vserver nfs show -krb-opts

Vserver Context High Context Idle
-------------- ------------ -----------vs0
30
30
vs1
30
30
2498
vserver nfs start

Start the NFS service of a Vserver
Description
The vserver nfs start command starts the NFS service on a Vserver to serve NFS
clients. The Vserver must already exist.
Parameters
This parameter specifies the Vserver on which you want to start the NFS service.
Examples
The following example starts the NFS service on a Vserver named vs0.
cluster1::> vserver nfs start -vserver vs0
vserver nfs status

Display the status of the NFS service of a Vserver
Description
The vserver nfs status command shows the status of NFS on a Vserver. The
Vserver must already exist.
Parameters
This parameter specifies the Vserver for which you want to see the NFS status.
[-is-enabled {true|false}] - NFS Service Enabled
2499
If you specify this optional parameter, the command displays whether NFS is enabled or
not. This parameter is true if the NFS server is running.
Examples
The following example shows the status of NFS on a Vserver named vs0 for which NFS
is enabled.
cluster1::> vserver nfs status -vserver vs0.
The NFS server is running.
vserver nfs stop

Stop the NFS service of a Vserver
Description
The vserver nfs stop command stops the NFS service on a Vserver to serve NFS
clients. The Vserver must already exist.
Parameters
This parameter specifies the Vserver on which you want to stop the NFS service.
Examples
The following example stops the NFS service on a Vserver named vs0.
cluster1::> vserver nfs stop -vserver vs0
vserver nfs kerberos interface disable

Disable NFS Kerberos on a LIF
2500
Description
The vserver nfs kerberos interface disable command disables NFS
Kerberos on a logical interface.
Parameters
This parameter specifies the Vserver in which the logical interface exists.
This parameter specifies the name of the logical interface on which you want to disable
NFS Kerberos.
[-admin-username <text>] - Account Creation Username
This optional parameter specifies the administrator user name.
[-admin-password <text>] - Account Creation Password
This optional parameter specifies the administrator password.
Examples
The following example disables NFS Kerberos on a Vserver named vs0 and a logical
interface named datalif1.
vs1::> vserver nfs kerberos interface disable -vserver vs0 -lif datalif1
vserver nfs kerberos interface enable

Enable NFS Kerberos on a LIF
Description
The vserver nfs kerberos interface enable command enables NFS
Kerberos on a logical interface.
Parameters
2501
This parameter specifies the Vserver in which the logical interface exists.
This parameter specifies the name of the logical interface on which you want to enable
NFS Kerberos.
[-spn <text>] - Service Principal Name
This optional parameter specifies the service principal name (SPN) for the logical
interface you want to enable. This value must be in the form nfs/host_name@REALM,
where host_name is the fully qualified host name of the Kerberos server, nfs is the
service, and REALM is the name of the Kerberos realm (for instance, EXAMPLE.COM).
Specify Kerberos realm name in uppercase.
[-admin-password <text>] - Account Creation Password
This optional parameter specifies the administrator password.
[-keytab-uri {(ftp|http)://(hostname|IPv4 Address|'['IPv6 Address']')...}] - Load Keytab
from URI
This optional parameter specifies loading a keytab file from the specified URI.
This optional parameter specifies the organizational unit (OU) under which the Microsoft
Active Directory server account will be created when you enable Kerberos using a realm
for Microsoft KDC. If this parameter is not specified, the default OU is "CN=Computers".
Examples
The following example enables NFS Kerberos on a Vserver
named vs0 and a logical interface named datalif1. The SPN is nfs/
sec.example.com@AUTH.SEC.EXAMPLE.COM and the keytab file is loaded from ftp://
ftp.example.com/keytab.
vs1::> vserver nfs kerberos interface enable -vserver vs0 -lif datalif1 -spn nfs/
sec.example.com@AUTH.SEC.EXAMPLE.COM -keytab-uri
ftp://ftp.example.com/keytab
2502
vserver nfs kerberos interface modify

Modify the Kerberos configuration of an NFS server
Description
The vserver nfs kerberos interface modify command modifies a Kerberos
configuration for NFS. An NFS Kerberos configuration is associated with both a Vserver
and a logical interface.
Parameters
This parameter specifies the Vserver associated with the NFS Kerberos configuration
you want to modify.
This parameter specifies the name of the logical interface associated with the NFS
Kerberos configuration you want to modify.
[-kerberos {enabled|disabled}] - Kerberos Enabled
This optional parameter specifies whether to enable or disable Kerberos for NFS on
the specified Vserver and logical interface. If you specify a value of enable, you must
also specify the -spn parameter. The command prompts you for a user name and
password for a Kerberos principal in the same realm as the principal specified by the
-spn parameter; this principal must have permission to create or modify the principal
specified by the -spn parameter.
This optional parameter specifies the service principal name (SPN) of the Kerberos
configuration you want to modify. If you specify a value of enable for the -kerberos
parameter, you must also specify this parameter. This value must be in the form nfs/
host_name@REALM, where host_name is the fully qualified host name of the Kerberos
server, nfs is the service, and REALM is the name of the Kerberos realm (for instance,
EXAMPLE.COM). Specify Kerberos realm names in uppercase.
2503
[-keytab-uri {(ftp|http)://(hostname|IPv4 Address|'['IPv6 Address']')...}] - Load Keytab

from URI
This optional parameter specifies loading a keytab file from the specified URI.
This optional parameter specifies the organizational unit (OU) under which the Microsoft
Active Directory server account will be created when you enable Kerberos using a realm
for Microsoft KDC. If this parameter is not specified, the default OU is "CN=Computers".
Examples
The following example enables an NFS Kerberos configuration on a
Vserver named vs0 and a logical interface named datalif1. The SPN is nfs/
sec.example.com@AUTH.SEC.EXAMPLE.COM and the keytab file is loaded from ftp://
ftp.example.com/keytab.
vs1::> vserver nfs kerberos interface modify -vserver vs0 -lif datalif1
-kerberos enabled -spn nfs/sec.example.com@AUTH.SEC.EXAMPLE.COM -keytab-uri
ftp://ftp.example.com/keytab
2504
vserver nfs kerberos interface show

Display the Kerberos configurations of NFS servers
Description
The vserver nfs kerberos interface show command displays information
about Kerberos configurations for NFS. The command output depends on the
command displays the following information about all Kerberos configurations for NFS:
Vserver name
Logical interface name
Logical interface IP address
Whether Kerberos is enabled or disabled
The Kerberos service principal name (SPN)
The permitted encryption types
parameters. For instance, to display information only about Kerberos configurations for
NFS that are enabled, run the command with the -kerberos enabled parameter.
Parameters
specify.
| [-instance ] }
about all fields.
2505
If you specify this parameter and the -lif parameter, the command displays
information only about the Kerberos configuration or configurations for NFS that are
associated with the specified Vserver and logical interface.
If you specify this parameter and the -vserver parameter, the command displays
information only about the Kerberos configuration or configurations for NFS that are
associated with the specified logical interface and Vserver.
If you specify this parameter, the command displays information only about the Kerberos
configurations for NFS that are associated with the specified logical-interface IP
address.
[-kerberos {enabled|disabled}] - Kerberos Enabled
configurations for NFS that match the specified value.
configuration or configurations for NFS that match the specified SPN.
[-permitted-enc-types <NFS Kerberos Encryption Type>, ...] - Permitted Encryption
Types
configuration for NFS that matches the specified encryption types.
Examples
The following example displays information about the Kerberos configuration for NFS
associated with the Vserver vs0 and the logical interface datalif1:
vs1::> vserver nfs kerberos interface show -vserver vs0 -lif datalif1
Vserver: vs1
Logical Interface: datalif1
IP Address: 192.0.2.130
Kerberos Enabled: enabled
Service Principal Name: nfs/sec.example.com@AUTH.SEC.EXAMPLE.COM
Permitted Encryption Types: des,des3,aes-128,aes-256
2506
vserver nfs kerberos realm create

Create a Kerberos realm configuration
Description
The vserver nfs kerberos realm create command creates a Kerberos realm
configuration.
Parameters
This parameter specifies the Vserver associated with the Kerberos realm configuration
that you want to create.
-realm <text> - Kerberos Realm
This parameter specifies the name of the Kerberos realm for the configuration.
-kdc-vendor <Kerberos Key Distribution Center (KDC) Vendor> - KDC Vendor
This optional parameter specifies the KDC vendor. Specify Microsoft if you are using a
Microsoft Active Directory server; specify Other if you are using a UNIX server.
-kdc-ip <IP Address> - KDC IP Address
This optional parameter specifies the IP address of the Kerberos Distribution Center
(KDC) server.
[-kdc-port <integer>] - KDC Port
This optional parameter specifies the port number of the KDC server. The default setting
is 88.
[-clock-skew <integer>] - Clock Skew
This optional parameter specifies how many seconds of clock skew between the clients
and the server are permitted. The default setting is 300 seconds.
[-adserver-name <text>] - Active Directory Server Name
This optional parameter specifies the name of an Active Directory server for the
configuration. Use this parameter only if you specified the value of -kdc-vendor
parameter as Microsoft.
2507
[-adserver-ip <IP Address>] - Active Directory Server IP Address

This optional parameter specifies the IP address of an Active Directory server for the
configuration. Use this parameter only if you specified the value of the -kdc-vendor
This optional parameter specifies a comment for the Kerberos realm configuration.
[-adminserver-ip <IP Address>] - Admin Server IP Address
This optional parameter specifies the IP address of the administrative server. Use this
parameter only if you specified the value of -kdc-vendor parameter as Other. The
default setting for this parameter is the KDC server's IP address as specified by the kdc-ip parameter.
[-adminserver-port <integer>] - Admin Server Port
This optional parameter specifies the port number of the administrative server. The
default setting is 749. Use this parameter only if you specified the value of -kdcvendor parameter as Other.
[-passwordserver-ip <IP Address>] - Password Server IP Address
This optional parameter specifies the IP address of the password server. Use this
parameter only if you specified the value of -kdc-vendor parameter as Other. The
default setting for this parameter is the KDC server's IP address as specified by the kdc-ip parameter.
[-passwordserver-port <integer>] - Password Server Port
This optional parameter specifies the port number of the password server. The default
setting is 464. Use this parameter only if you specified the value of -kdc-vendor
parameter as Other.
Examples
The following example creates a Kerberos realm named SEC.EXAMPLE.COM for
the Vserver named AUTH. The permitted clock skew is 15 seconds. The KDC's IP
address is 192.0.2.170 and its port is 88. The KDC vendor is Other (for a UNIX KDC).
The administrative server's IP address is 192.0.2.170 and its port is 749. The password
server's IP address is 192.0.2.170 and its port is 464.
cluster1::> vserver nfs kerberos realm create -vserver AUTH -realm
SEC.EXAMPLE.COM -clock-skew 15 -kdc-ip 192.0.2.170 -kdc-port 88 -kdc-vendor
Other -adminserver-ip 192.0.2.170 -adminserver-port 749 -passwordserver-ip
192.0.2.170 -passwordserver-port 464
2508
vserver nfs kerberos realm delete

Delete a Kerberos realm configuration
Description
The vserver nfs kerberos realm delete command deletes a Kerberos realm
configuration from the system.
Parameters
This parameter specifies the name of the Vserver for the Kerberos realm configuration
that you want to delete.
This parameter specifies the name of the Kerberos realm for the configuration.
Examples
The following example deletes the Kerberos realm SEC.EXAMPLE.COM from the
Vserver named AUTH:
cluster1::> vserver nfs kerberos realm delete -vserver AUTH -realm
SEC.EXAMPLE.COM
vserver nfs kerberos realm modify

Modify a Kerberos realm configuration
Description
The vserver nfs kerberos realm modify command modifies one or more
attributes of a Kerberos realm configuration.
2509
Parameters
This parameter specifies the name of the Vserver for the Kerberos realm configuration
that you want to modify.
This optional parameter specifies the name of a Kerberos realm for the configuration.
[-kdc-vendor <Kerberos Key Distribution Center (KDC) Vendor>] - KDC Vendor
This optional parameter specifies the KDC vendor. Specify Microsoft if you are using a
Microsoft Active Directory server; specify Other if you are using a UNIX server.
[-kdc-ip <IP Address>] - KDC IP Address
This optional parameter specifies the IP address of the Kerberos Distribution Center
(KDC) server.
This optional parameter specifies the port number of the KDC server. The default setting
at the time of creation is 88.
This optional parameter specifies how many seconds of clock-skew between server and
the clients are permitted. The default setting at the time of creation is 300 seconds.
This optional parameter specifies the name of an Active Directory server for the
configuration. Use this parameter if you specified the value of -kdc-vendor parameter
as Microsoft.
This optional parameter specifies the IP address of an Active Directory server for
the configuration. Use this parameter if you specified the value of the -kdc-vendor
This optional parameter specifies a comment for the Kerberos realm configuration.
This optional parameter specifies the IP address of the administrative server. Use this
parameter if you specified the value of -kdc-vendor parameter as Other.
2510

This optional parameter specifies the port number of the administrative server. The
default setting at the time of creation is 749. Use this parameter if you specified the
value of the -kdc-vendor parameter as Other.
This optional parameter specifies the IP address of the password server. Use this
parameter if you specified the value of -kdc-vendor parameter as Other.
This optional parameter specifies the port number of the password server. The default
setting at the time of creation is 464. Use this parameter only if you specified the value
of -kdc-vendor parameter as Other.
Examples
The following example modifies the Kerberos realm SEC.EXAMPLE.COM for the
Vserver named AUTH to use a Microsoft KDC server with the IP address 192.0.2.170
and an Active Directory server named AUTH.SEC.EXAMPLE.COM with the IP address
192.0.2.170:
cluster1::> vserver nfs kerberos realm modify -vserver AUTH -realm
SEC.EXAMPLE.COM -adserver-name AUTH.SEC.EXAMPLE.COM -adserver-ip 192.0.2.170 kdc-ip 192.0.2.170 -kdc-vendor Microsoft
2511
vserver nfs kerberos realm show

Display Kerberos realm configurations
Description
The vserver nfs kerberos realm show command displays information about
Kerberos realm configurations. The command output depends on the parameters
displays the following information about all Kerberos realm configurations:
Vserver
Kerberos realm name
Active Directory server name
Kerberos Distribution Center (KDC) vendor
KDC IP address
The permitted encryption types
Parameters
specify.
| [-instance ] }
about all fields.
realm configurations for the specified Vserver.
[-realm <text>] - Kerberos Realm
realm configurations that use the specified Kerberos realm.
2512
[-kdc-vendor <Kerberos Key Distribution Center (KDC) Vendor>] - KDC Vendor

realm configurations that use the specified KDC vendor.
[-kdc-ip <IP Address>] - KDC IP Address
realm configurations that use the specified KDC IP address.
realm configurations that use the specified KDC port number.
realm configurations that use the specified clock skew.
realm configurations that use the Active Directory server that has the specified name.
realm configurations that use the Active Directory server that has the specified IP
address.
realm configurations that match the specified comment text.
realm configurations that use the specified administrative-server IP address.
realm configurations that use the specified administrative-server port number.
realm configurations that use the specified password-server IP address.
2513
realm configurations that use the specified password-server port number.
[-permitted-enc-types <NFS Kerberos Encryption Type>, ...] - Permitted Encryption
Types
realm configuration that match the specified encryption types.
Examples
The following example displays information about all Kerberos realm configurations:
cluster1::> vserver nfs kerberos realm show
Vserver
Kerberos
Active Directory KDC
KDC
Realm
Server
IP Address
Vendor
-------- ------------------------ ---------------- ---------- ----------------AUTH
SEC.EXAMPLE.COM
AUTH.SEC.EXAMPLE.COM
Microsoft
2514
192.0.2.170
vserver nfs pnfs devices create

Create a new pNFS device and its mapping
Description
The vserver nfs pnfs devices create command creates a pNFS device for a
given instance of a volume. The actual creation of pNFS devices is automatically done
by the pNFS implementation in Data ONTAP kernel. The usage of this command might
interfere with the functionality of the pNFS server. Thus, it is advised that this command
not be used without supervision by technical support.
Parameters
[-global-device-table-id <integer>] - Global Device Mapping Table ID
This optional parameter specifies the unique identifier that the pNFS devices subsystem
assigns to the device that corresponds to the MSID described below. The pNFS devices
implementations keeps track of the global unique identifier that needs to be assigned to
this device. It is expected that users need not specifically input the device identifier while
creation.
This parameter specifies the Vserver to which the volumes belong.
-msid <integer> - Volume MSID
This parameter uniquely identifies the volume for which you are creating a pNFS device.
-striping-epoch <integer> - Striping Epoch
This optional parameter specifies the striping epoch identifier for a volume for which you
are creating a pNFS device. For flexible volumes, the value is always 1.
-device-access <integer> - Device Access Flags
This optional parameter specifies the type of access that is given to the pNFS device
that you are creating. If the value is 1, it means write access. If the value if 0, it means
read access. By default, the device is created with write access.
-version <integer> - Device Version
2515
This optional parameter specifies the version associated with the pNFS device identifier.
By default, the version is set to 1.
[-generation-count <integer>] - Device Generation
This optional parameter specifies the generation count associated with the pNFS device
identifier. If a device already exists, the existing device is invalidated and the generation
number for the device is bumped. If a device does not already exist, a new device is
created with generation number 1.
[-create-time <MM/DD/YYYY HH:MM:SS>] - Device Creation Time
This optional parameter specifies the time at which the device is created. If the
parameter is not specified, the time at which the device is created is stored along with
the device.
[-mapping-status {available|notavailable}] - Device Mapping Status
This optional parameter specifies if the mapping exists for a device. If the value is set to
"available", the mappings will be created in the device mappings table. If the value is set
to "notavailable", the mappings will not be created in the device mappings table.
Examples
(No example available)
2516
vserver nfs pnfs devices delete

Delete a pNFS device
Description
The vserver nfs pnfs devices delete command deletes a unique pNFS
device. The pNFS device to be deleted is identified by the unique device mapping
identifier (mid) parameter passed to this operation. When this operation is successful,
the device mappings corresponding to the device and the information corresponding to
the device itself are removed. You can obtain the global mapping identifier from the list
of devices using the command vserver nfs pnfs devices show.
Parameters
-global-device-table-id <integer> - Global Device Mapping Table ID
This parameter specifies the pNFS global device mapping identifier that uniquely
identifies a pNFS device
Examples
The following example deletes the device information of a device with global mapping
identifier value 2.
cluster1::> vserver nfs pnfs delete -mid 2
See Also
vserver nfs pnfs devices show vserver nfs pnfs devices mappings show
vserver nfs pnfs devices invalidate
2517
vserver nfs pnfs devices show

Display pNFS device information
Description
The vserver nfs pnfs devices show command displays a pNFS device for
a given instance of a volume. The command output depends on the parameter or
command displays the following information about all pNFS devices:
Vserver name
The global device mapping identifier of the device
The master data set ID (MSID) of the volume that leads to this device
The mapping status of the device
The generation number of the device
parameters. For instance, to display information only about devices that are exported as
write-only devices, enter the command with the -access-flags 1 parameter.
Parameters
specify.
| [-instance ] }
about all entries.
If you specify this parameter, the command displays information only about the unique
identifier that the pNFS devices subsystem assigns to the device that is being output.
2518
If you specify this parameter, the command displays information only about the Vserver
that owns the volume represented by MSID.
[-msid <integer>] - Volume MSID
If you specify this parameter, the command displays information only about the volume
or volumes that match the specified MSID.
[-striping-epoch <integer>] - Striping Epoch
If you specify this parameter, the command displays information only about the striping
epoch identifier for a volume that serves as the basis for the pNFS device.
[-device-access <integer>] - Device Access Flags
If you specify this parameter, the command displays information only about access flags
which specify the type of access that is given to the pNFS device. If the value is 1, it
means write access. If the value is 0, it means read access.
[-version <integer>] - Device Version
If you specify this parameter, the command displays information only about pNFS
devices that match the specified version number.
[-generation-count <integer>] - Device Generation
If you specify this parameter, the command displays information only about generation
count associated with the pNFS device identifier.
[-create-time <MM/DD/YYYY HH:MM:SS>] - Device Creation Time
If you specify this parameter, the command displays information only about pNFS
devices that were created at the specified time.
[-mapping-status {available|notavailable}] - Device Mapping Status
If you specify this parameter, the command displays information only about if the
mapping exists for a device. If the value is set to "available", the mappings can be seen
in the device mappings table. If the value is set to "notavailable", the mappings will not
be seen in the device mappings table.
Examples
The following example displays the information of a device with global mapping identifier
6. The device corresponds to a volume with MSID 2147484673 on Vserver vs1. The
device mappings corresponding to this device follow in the mappings table.
cluster1::*> vserver nfs pnfs devices show
Vserver Name
Mapping ID
---------------
--------------- --------------- --------------- -------------
Msid
Mapping Status
Generation
2519
vs1
2147484673
available
cluster1::*> vserver nfs pnfs devices mappings show

Vserver Name
Mapping ID
--------------
--------------- --------------- --------------------
Dsid
vs1
1025
LIF IP
10.53.4.14
See Also
vserver nfs pnfs devices mappings show
2520
vserver nfs pnfs devices cache show

Display the device cache
privilege level.
Description
The vserver nfs pnfs devices cache show command displays the device
cache.
Parameters
specify.
| [-instance ] }
about all entries.
If you specify this parameter, the command displays information only about the pNFS
devices cache present on the node.
If you specify this parameter, the command displays information only about the Vserver
that has the pNFS devices cache.
Examples
See Also
2521

Display the list of pNFS device mappings
Description
The vserver nfs pnfs devices show command displays a pNFS device for
a given instance of a volume. The command output depends on the parameter or
parameters specified with the command. If you do not specify parameters, the command
displays the following information about all pNFS devices:
Vserver name
The global device mapping identifier of the device
The Data Set ID (DSID) of the constituent volume
The LIF IP address that serves the constituent on the same controller.
parameters. For instance, to display information only about devices that are exported as
write-only devices, enter the command with the -access-flags 1 parameter.
Parameters
specify.
| [-instance ] }
about all entries.
If your specify this parameter, the command displays information only about the Vserver
that the mapping identifier and DSID belong to.
This specifies the unique identifier that the pNFS devices subsystem assigns to the
device whose mappings are being output.
2522
[-dsid <integer>] - Constituent Volume DSID

If you specify this parameter, the command displays information only about the volume
or volumes that match the specified DSID.
[-lifip <IP Address>] - LIF IP Address
If you specify this parameter, the command displays information only about the pNFS
devices that match the specified LIF IP address.
Examples
The following example displays the device information of a device with global mapping
identifier 6. The device corresponds to a volume with MSID 2147484673 on Vserver
vs1. The device has one constituent with DSID 1025 and is served by the LIF with the IP
address 10.53.4.14.
cluster1::*> vserver nfs pnfs devices* show
Vserver Name
Mapping ID
---------------
--------------- --------------- --------------- -------------
Msid
vs1
2147484673
Mapping Status
available
Generation
6
cluster1::*> vserver nfs pnfs devices mappings show

Vserver Name
Mapping ID
--------------
--------------- --------------- --------------------
Dsid
vs1
1025
Lif IP
10.53.4.14
See Also
vserver nfs pnfs devices show
2523
vserver peer accept

Accept a pending Vserver peer relationship
level.
Description
The vserver peer accept command is used to accept the Vserver peer relationship
between two Vservers. This command is used only for intercluster Vserver peer
relationships.
Parameters
Specifies name of the local Vserver for which you want to accept the Vserver peer
relationship.
-peer-vserver <vserver> - Peer Vserver Name
Specifies name of the peer Vserver with which the Vserver peer relationship was
initiated.
Examples
The following example illustrates how to accept the Vserver peer relationship between
Vservers pvs1.example.com residing on cluster2, and lvs1.example.com residing on
cluster1.
cluster2::> vserver peer accept -vserver pvs1.example.com -peer-vserver
lvs1.example.com
See Also
vserver peer create vserver peer reject
2524
vserver peer create

Create a new Vserver peer relationship
level.
Description
The vserver peer create command creates a Vserver peer relationship between
two Vservers residing on the same cluster or across two clusters. For intercluster
Vserver peer relationships, the cluster administrator must accept or reject the
relationship on peer cluster.
Parameters
Specifies the name of the local Vserver.
Specifies the name of the peer Vserver with which you want to create the Vserver peer
relationship.
[-peer-cluster <text>] - Peer Cluster Name
Specifies the name of the peer cluster. If this is not specified, it is assumed that the peer
Vserver resides on the same cluster.
-applications {snapmirror|file-copy}, ... - Peering Applications
Specifies the applications for which the Vserver peer relationship is created.
Examples
The following example illustrates how to create an intercluster Vserver peer relationship
between Vserver lvs1.example.com, residing on cluster1, and pvs1.example.com,
residing on cluster2. The relationship is created for SnapMirror.
cluster1::> vserver peer create -vserver lvs1.example.com -peer-vserver
pvs1.example.com -peer-cluster cluster2 -applications snapmirror
Here is an another example which creates an intracluster Vserver peer relationship.

cluster1::> vserver peer create -vserver lvs1.example.com -peer-vserver
lvs2.example.com -applications snapmirror
2525
See Also
vserver peer accept vserver peer reject
2526
vserver peer delete

Delete a Vserver peer relationship
level.
Description
The vserver peer delete command deletes the Vserver peer relationship between
two Vservers.
Parameters
Specifies the local Vserver name for which you want to delete the Vserver peer
relationship.
Specifies the peer Vserver name with which the Vserver peer relationship was
established.
[-force [true]] - Force Delete
Deletes the Vserver peer relationship even if the remote cluster is not accessible due to,
for example, network connectivity issues.
Examples
The following example illustrates how to delete the Vserver peer relationship between
two Vservers lvs1.example.com residing on cluster1, and pvs1.example.com residing on
cluster2.
cluster1::> vserver peer delete -vserver lvs1.example.com -peer-vserver
pvs1.example.com
See Also
vserver peer create
2527
vserver peer modify

Modify a Vserver peer relationship
level.
Description
The vserver peer modify command modifies applications of the Vserver peer
relationship.
Parameters
Specifies name of the local Vserver for which you want to modify applications of the
Vserver peer relationship.
Specifies name of the peer Vserver for which you want to modify applications of the
Vserver peer relationship.
-applications {snapmirror|file-copy}, ... - Peering Applications
Specifies the Vserver peer applications.
Examples
The following example illustrates how to modify applications that are part of the
peer relationship between the Vservers lvs1.example.com residing on cluster1, and
pvs1.example.com residing on cluster2.
cluster1::> vserver peer modify -vserver lvs1.example.com -peer-vserver
pvs1.example.com -applications snapmirror
See Also
vserver peer create vserver peer delete
2528
vserver peer reject

Reject a Vserver peer relationship
level.
Description
The vserver peer reject command is used to reject the Vserver peer relationship
between the two Vservers. This command is used only for an intercluster Vserver peer
relationship.
Parameters
Specifies the name of the local Vserver for which you want to reject the Vserver peer
relationship.
Specifies the name of the peer Vserver with which the Vserver peer relationship was
initiated.
Examples
The following example illustrates how to reject the Vserver peer relationship between
cluster2.
cluster1::> vserver peer reject -vserver lvs1.example.com -peer-vserver
pvs1.example.com
See Also
vserver peer create vserver peer accept
2529
vserver peer resume

Resume a Vserver peer relationship
level.
Description
The vserver peer resume command resumes the Vserver peer relationship
between two Vservers.
Parameters
Specifies name of the local Vserver for which you want to resume the Vserver peer
relationship.
Specifies name of the peer Vserver with which you want to resume the Vserver peer
relationship.
[-force [true]] - Force Resume
Resumes the Vserver peer relationship even if the remote cluster is not accessible due
to, for example, network connectivity issues.
Examples
The following example illustrates resuming a Vserver peer relationship between two
Vservers lvs1.example.com residing on cluster1, and pvs1.example.com residing on
cluster2.
cluster1::> vserver peer resume -vserver lvs1.example.com -peer-vserver
pvs1.example.com
See Also
vserver peer suspend
2530
vserver peer show-all

Display Vserver peer relationships in detail
level.
Description
The vserver peer show-all command displays the following information about
Vserver peer relationships:
Local Vserver name
Peer Vserver name
Local Vserver UUID
Peer Vserver UUID
Peer cluster name
Applications
State of the peering relationship
Parameters
specify.
| [-instance ] }
about all fields.
[-vserver <vserver>] - Local Vserver Name
If this parameter is specified, the command displays relationships that match the
specified local Vserver.
[-peer-vserver <text>] - Peer Vserver Name
specified peer Vserver.
2531
[-vserver-uuid <UUID>] - Local Vserver UUID (privilege: advanced)

specified local Vserver UUID.
[-peer-vserver-uuid <UUID>] - Peer Vserver UUID (privilege: advanced)
specified peer Vserver UUID.
[-peer-state {peered|pending|initializing|initiated|rejected|suspended|deleted}] - Peering
State
specified peer state.
[-applications {snapmirror|file-copy}, ...] - Peering Applications
If this parameter is specified, the command displays relationships that have the
specified applications.
[-peer-cluster <text>] - Peer Cluster Name
If this parameter is specified, the command displays relationships that have the
specified peer cluster name.
Examples
The following example illustrates how to display Vserver peer relationships.
cluster1::> vserver peer show-all
Vserver
Peer
Peer
Vserver
State
Peering
Peer Cluster
Applications
----------- ----------- ------------ -------------------------- --------------lvs1.example.com

lvs2.example.com
peered
cluster1
snapmirror
sreev-vsim6
snapmirror
cluster1
snapmirror
lvs1.example.com
pvs1.example.com
peered
lvs2.example.com
lvs1.example.com
peered
See Also
2532
vserver peer show
2533
vserver peer show

Display Vserver peer relationships
Description
The vserver peer show command displays the following information about Vserver
peer relationships:
Local Vserver name
Peer Vserver name
State of the peering relationship
Parameters
specify.
| [-instance ] }
about all fields.
[-vserver <vserver>] - Local Vserver Name
local Vserver.
[-peer-vserver <text>] - Peer Vserver Name
peer Vserver.
[-peer-state {peered|pending|initializing|initiated|rejected|suspended|deleted}] - Peering
State
specified peer state.
2534
Examples
The following examples illustrates how to display Vserver peer relationships. Cluster
administrator:
cluster1::> vserver peer show
Vserver
Peer
Peer
Vserver
State
----------- ----------- -----------lvs1.example.com

lvs2.example.com
peered
lvs1.example.com
pvs1.example.com
peered
lvs2.example.com
lvs1.example.com
peered
Vserver administrator:
lvs1.example.com::> vserver peer show
Vserver
Peer
Peer
Vserver
State
----------- ----------- -----------lvs1.example.com

lvs2.example.com
peered
lvs1.example.com
pvs1.example.com
peered
See Also
vserver peer show-all
2535
vserver peer suspend

Suspend a Vserver peer relationship
level.
Description
The vserver peer suspend command suspends the Vserver peer relationship
between two Vservers.
Parameters
Specifies name of the local Vserver for which you want to suspend the Vserver peer
relationship.
Specifies name of the peer Vserver for which you want to suspend the Vserver peer
relationship.
[-force [true]] - Force Suspend
Suspends the Vserver peer relationship even if the remote cluster is not accessible due
to, for example, network connectivity issues.
Examples
The following example illustrates how to suspend the Vserver peer relationship between
cluster2.
cluster1::> vserver peer suspend -vserver lvs1.example.com -peer-vserver
pvs1.example.com
See Also
vserver peer delete vserver peer resume
2536
vserver peer transition create

Create a new transition peer relationship between a 7-Mode system and a Vserver.
level.
Description
The vserver peer transition create command creates a transition peer
relationship between a 7-Mode system and a Vserver.
Parameters
-local-vserver <vserver name> - Local Vserver name
-src-filer-name <text> - Source 7-Mode system
Specifies the name of the source 7-Mode system (hostname or IP address).
[-multi-path-address <text>] - Additional address for source 7-Mode system
Additional address (hostname or IP address) for the source 7-Mode system.
[-local-lifs <lif-name>, ...] - List of Local LIFs
List of LIFs to be used for this peering relationship. The LIF role can be data or nodemgmt or intercluster or cluster-mgmt.
Examples
The following example illustrates how to create a transition peer relationship
between Vserver vs1.example.com, residing on Cluster1, and a 7-Mode system
src1.example.com. We can also specify an additional multipath address src1e0d.example.com, for load balancing and list of local LIFs lif1, lif2 to be used.
Cluster1::> vserver peer transition create -vserver vs1.example.com -src-filername src1.example.com -multi-path-address src1-e0d.example.com
-local-lifs lif1,lif2
See Also
vserver peer transition modify vserver peer transition delete
vserver peer transition show
2537
vserver peer transition delete

Delete a transition peer relationship.
level.
Description
The vserver peer transition delete command deletes the transition peer
relationship.
Parameters
Specifies the name of the source 7-Mode system(hostname or IP address).
Examples
The following example illustrates how to delete the transition peer relationship
between a Vserver lvs1.example.com residing on cluster1, and source 7-Mode
systemsrc1.example.com.
cluster1::> vserver peer transition delete -vserver lvs1.example.com -src-filername src1.example.com
See Also
vserver peer transition create vserver peer transition modify
2538
vserver peer transition modify

Modify a transition peer relationship.
level.
Description
The vserver peer transition modify command is used to modify the multipath
address or local LIFs of the transition peer relationship.
Parameters
Specifies the name of the source 7-Mode system (hostname or IP address).
Additional address (hostname or IP address) for the source 7-Mode system.
List of LIFs to be used for this peering relationship. The LIF role can be data or nodemgmt or intercluster or cluster-mgmt.
Examples
The following example illustrates how to modify a transition peer relationship`s multipath
address.
cluster1::> vserver peer transition modify -vserver vs1.example.com -src-filername src1.example.com -multi-path-address src1-e0b.example.com
The following example illustrates how to modify the local LIFs of a transition peer
relationship.
Cluster1::> vserver peer transition modify -vserver vs1.example.com -src-filername src1.example.com
-local-lifs lif1,lif2
See Also
2539
vserver peer transition create vserver peer transition delete

2540

Display transition peer relationships.
Description
The vserver peer transition show command displays the following information
about transition peer transition relationships:
Local Vserver name
Source 7-Mode system
Multi-path address
Local LIFs
Parameters
specify.
| [-instance ] }
about all fields.
[-local-vserver <vserver name>] - Local Vserver name
If this parameter is specified, the command displays transition peer information about
the specified local Vserver.
[-src-filer-name <text>] - Source 7-Mode system
If this parameter is specified, the command displays transition peer information about
the specified source 7-Mode system.
multipath-address.
2541

local LIFs.
Examples
cluster1::> vserver peer transition show
Vserver
Source Filer
Multi Path Address
Local LIFs
-------
------------
-----------------
----------------
vs1.example.com
lif1, lif2
src1.example.com
src1-e0b.example.com
See Also
vserver peer transition create vserver peer transition modify
vserver peer transition delete
2542
vserver security file-directory apply

Apply security descriptors on files and directories defined in a policy to a Vserver
Description
The vserver security file-directory apply command applies security
settings to files and directories defined in a security policy of a Vserver.
Applying a security policy to a Vserver is the last step to creating and applying
NTFS ACLs to files or folders. A security policy contains definitions for the security
configuration of a file (or folder) or set of files (or, folders). The policy is a container for
tasks. A task associates a file/folder path name to the security descriptor that needs
to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder
path. A policy cannot have duplicate task entries. There can be only one task per path.
The steps to creating and applying NTFS ACLs are the following:
Create an NTFS security descriptor.
Add DACLs and SACLs to the NTFS security descriptor.
Note:
If you want to audit file and directory events, you must configure auditing on the
Vserver in addition to adding the SACL to the security descriptor.
Create a file/directory security policy.
This step associates the policy with a Vserver.
Create policy tasks.
A policy task refers to a single operation to apply to a file (or folder) or to a set of
files (or folders). Amongst other things, the task defines which security descriptor
to apply to a path.
Apply a policy to the associated Vserver.
The vserver security file-directory apply command is not supported for
2543
Parameters
Specifies the Vserver that contains the path to which the security policy is applied.
-policy-name <Security policy name> - Policy Name
Specifies the security policy to apply.
Examples
The following example applies a security policy named p1 to Vserver vs0.
cluster1::> vserver security file-directory apply -vserver vs0 policy-name p1
vserver security file-directory remove-slag

Removes Storage-Level Access Guard
Description
The vserver security file-directory remove-slag command removes
Storage-Level Access Guard (SLAG) security from the specified volume path.
The vserver security file-directory remove-slag command is not
Parameters
Specifies the name of the Vserver that is associated with the volume path from where
you want to remove SLAG.
-path <text> - Path
Specifies the volume mounted junction path from which you want to remove SLAG
security.
2544
Examples
The following example removes SLAG security from the volume path "/vol1" on Vserver
vs1.
cluster1::>vserver security file-directory show -vserver vs1 -path /vol1
Vserver: vs1
File Path: /vol1
Effective Style: unix
DOS Attributes: 10
DOS Attributes in Text: ----D--Expanded Dos Attributes: Unix User Id: 0
Unix Group Id: 0
Unix Mode Bits: 755
Unix Mode Bits in Text: rwxr-xr-x
ACLs: Storage-Level Access Guard security
DACL
(Applies to Directories):
ALLOW-CIFS1\Administrator-0x1200a9
DACL (Applies to Files):
ALLOW-CIFS1\Administrator-0x1200a9
cluster1::>vserver security file-directory remove-slag -path /vol1 vserver vs1
cluster1::>vserver security file-directory show -vserver vs1 -path /vol1
Vserver: vs1
File Path: /vol1
Effective Style: unix
DOS Attributes: 10
Unix Group Id: 0
Unix Mode Bits: 755
Unix Mode Bits in Text: rwxr-xr-x
ACLs: -
2545
2546
vserver security file-directory show

Display file/folder security information
Description
The vserver file-directory show command displays file/folder security
information. The command output depends on the parameter or parameters specified
with the command.
The -vserver and -path parameters are required for this command. If you do not
specify any of the optional parameters, the command displays all security information in
list format for the specified path.
about files and folders security.
You can specify the -instance parameter to display all the security information in list
format.
Parameters
| [-instance ] }
all entries.
Use this required parameter to specify the Vserver that contains the path to the file or
folder specified with the required -path parameter.
-path <text> - File Path
Use this required field to specify the path of the file or folder for which you want to
display security information. If the volume name is not specified in the path, the path is
relative to the Vserver root volume.
{ [-volume-name <volume name>] - Volume Name
2547
If you specify this parameter, the command displays information about file and directory
security only for files and directories where the specified path is relative to the specified
volume. If this parameter is not specified, the Vserver root volume is taken as default.
| [-share-name <Share>] } - Share Name
security only for files and directories contained where the specified path is relative to the
root of the specified share. If this parameter is not specified, the Vserver root volume is
taken as default.
[-lookup-names {true|false}] - SID to Name Lookups
security for files and directories where the information about owner and group are stored
as names. If set to false, the command displays information about file and directory
security for files and directories where the information for owner and group are stored as
SIDs.
[-expand-mask {true|false}] - Expand Bit Masks
security for files and directories where the hexadecimal bit mask entries are in expanded
bit form. If set to false, the command displays information about file and directly security
for files and directories where the hexadecimal bit mask entries are in collapsed form.
security only for files and directories with paths in volumes of the specified security style.
[-effective-style <security style>] - Effective Style
security only for files and directories with the specified effective security style on the
path.
[-dos-attributes <Hex Integer>] - DOS Attributes
security only for files and directories with the specified DOS attributes.
[-text-dos-attr <TextNoCase>] - DOS Attributes in Text
security only for files and directories with the specified text DOS attributes.
[-expanded-dos-attr <TextNoCase>] - Expanded Dos Attributes
2548
security only for files and directories with the specified extended DOS attributes. This
parameter is useful only for files or directories where the expand-mask is set to true.
[-user-id <user name>] - Unix User Id
security only for files and directories with the specified UNIX user ID.
[-group-id <group name>] - Unix Group Id
security only for files and directories with the specified UNIX group ID.
[-mode-bits <Octal Permission>] - Unix Mode Bits
security only for files and directories with the specified UNIX mode bits in Octal form.
[-text-mode-bits <text>] - Unix Mode Bits in Text
security only for files and directories with the specified UNIX mode bits in text form.
[-acls <Security acl>, ...] - ACLs
security only for files and directories with the specified ACLs. If the specified path is
volume path and Storage-Level Access Guard (SLAG) is configured on the volume, this
parameter displays the SLAG information. It also displays the Dynamic Access Control
(DAC) policies if DAC is configured for the given file or directory path. The following ACL
information can be entered:
Type of ACL - NTFS or NFSV4
Control bits in the security descriptors
Owner - only in case of NTFS security descriptors
Group - only in case of NTFS security descriptors
Access Control Entries - discretionary access control list (DACL) and system
access control list (SACL) access control entries (ACEs) in the ACL
Examples
The following example displays the security information about the path "/vol4" in Vserver
vs1.
cluster1::> vserver security file-directory show -vserver vs1 -path /
vol4
2549
(vserver security file-directory show)

Vserver: vs1
File Path: /vol4
Security Style: ntfs
Effective Style: ntfs
DOS Attributes: 10
Unix Group Id: 0
Unix Mode Bits: 777
Unix Mode Bits in Text: rwxrwxrwx
ACLs: NTFS Security Descriptor
Control:0x8004
Owner:BUILTIN\Administrators
Group:BUILTIN\Administrators
DACL - ACEs
ALLOW-Everyone-0x1f01ff
ALLOW-Everyone-0x10000000-OI|CI|IO
The following example displays the security information about the path "/a/b/file.txt" in
Vserver vs1.
cluster1::> vserver security file-directory show -vserver vs1 path /a/b/file.txt -volume-name vol1
(vserver security file-directory show)
Vserver: vs1
File Path: /vol1/a/b/file.txt
Security Style: ntfs
DOS Attributes: 10
Unix Group Id: 0
Unix Mode Bits: 777
2550
Control:0x8004
Owner:BUILTIN\Administrators
Group:BUILTIN\Administrators
DACL - ACEs
ALLOW-Everyone-0x1f01ff
ALLOW-Everyone-0x10000000-OI|CI|IO
The following example displays the security information of the volume path "/vol1"
containing SLAG.
cluster1::> vserver security file-directory show -vserver vs1 path /vol1
Vserver: vs1
File Path: /vol1
DOS Attributes: 10
DOS Attributes in Text: ----D--Expanded Dos Attribute: Unix User Id: 0
Unix Group Id: 1
Unix Mode Bits: 777
Control:0xbf14
Owner:CIFS1\Administrator
Group:CIFS1\Domain Admins
SACL - ACEs
ALL-Everyone-0xf01ff-OI|CI|SA|FA
RESOURCE ATTRIBUTE-Everyone-0x0
("Department_MS",TS,0x10020,"Finance")
POLICY ID-All resources - No Write-0x0-OI|
CI
DACL - ACEs
ALLOW-CIFS1\Administrator-0x1f01ff-OI|CI
ALLOW-Everyone-0x1f01ff-OI|CI
ALLOW CALLBACK-DAC\skanyal-0x1200a9-OI|CI
((@User.department==@Resource.Department_MS&&@Resource.Impact_MS>1000)&&@Device.department==@
Storage-Level Access Guard security
SACL (Applies to Directories):
2551
AUDIT-R1\user1-0x001f01ff-FA
DACL (Applies to Directories):
ALLOW-R1\user1-0x001f01ff
ALLOW-R1\user2-0x001200a9
SACL (Applies to Files):
AUDIT-R1\user1-0x001f01ff-FA
DACL (Applies to Files):
ALLOW-R1\user1-0x001f01ff
ALLOW-R1\user2-0x001200a9
See Also
vserver file-directory show
2552
vserver security file-directory job show

Display a list of file security jobs
Description
The vserver security file-directory job show command displays
information about security file-directory jobs.
parameter.
You can specify additional parameters to select information that matches the values
you specify for those parameters. For example, to display information only about
security file-directory jobs running on a specific node, run the command with the -node
parameter.
Parameters
specify.
| [-inprogress ]
Displays the job ID, the job name, the owning Vserver, and the progress of the security
file-directory job.
| [-jobstate ]
Displays information about each job's state, including the queue state, whether the job
was restarted and when the job has completely timed out.
| [-sched ]
Displays the job ID, the job name, the owning Vserver, and the schedule on which the
security file-directory job runs.
| [-times ]
2553
Displays the job ID, the job name, the owning Vserver, the time when the job was last
queued, the time when the job was last started, and the time when the job most recently
ended.
| [-type ]
Displays the job ID, the job name, the job type, and the job category.
| [-jobuuid ] (privilege: advanced)
Displays the job ID, the job name, the owning Vserver, and the job UUID.
| [-instance ] }
about all fields.
Selects the jobs that match the ID or range of IDs that you specify.
Selects jobs that are owned by the specified Vserver.
2554

[-process <text>] - Process
Selects jobs with the specified process number.
Examples
The following example displays information abthe file-directory security job.
2555
cluster1::> vserver security file-directory apply -policy-name pol vserver vs1

cluster1::> vserver security file-directory job show
Owning
Job ID Name
Vserver
Node
State
------ -------------------- ---------- -------------- ---------25
Fsecurity Apply
vsim2.3
vsim2.3-01
Success
Description: File Directory Security Apply Job
2556
vserver security file-directory ntfs create

Create an NTFS security descriptor
Description
The vserver security file-directory ntfs create command creates an
NTFS security descriptor to which you can add access control entries (ACEs) to the
discretionary access control list (DACL) and the system access control list (SACL).
Creating an NTFS security descriptor is the first step in configuring and applying NTFS
access control lists (ACLs) to files and folders residing within a namespace. Later, you
will associate the security descriptor to a policy task.
You can create NTFS security descriptors for files and folders residing within FlexVol
volumes with NTFS security-style or on NTFS security descriptors on mixed securitystyle volumes.
Note:
Vserver in addition to adding a SACL to the security descriptor.
Create a policy task.
to apply to a path.
2557
The vserver security file-directory ntfs create command is not

Parameters
Specifies the name of the Vserver on which to create the security descriptor.
-ntfs-sd <ntfs sd name> - NTFS Security Descriptor Name
Specifies the name of the security descriptor you want to create. After you create a
security descriptor, you can add SACL and DACL access control entries (ACEs) to it.
Note:
Every newly created security descriptor contains the 4 default DACL ACEs as
mentioned below:
Vserver: vserver1
NTFS Security Descriptor Name: sd1
Account Name
--------------
Access
Access
Type
Rights
-------
-------
Apply To
----------BUILTIN\Administrators
allow
full-control
this-
BUILTIN\Users
allow
full-control
this-
CREATOR OWNER
allow
full-control
this-
full-control
this-
folder, sub-folders, files

NT AUTHORITY\SYSTEM
allow
[-owner <name or sid>] - Owner of the Security Descriptor

Specifies the owner of the security descriptor. You can specify the owner using either a
user name or SID.
The owner of the security descriptor can modify the permissions on the file (or folder)
or files (or folders) to which the security descriptor is applied and can give other users
the right to take ownership of the object or objects to which the security descriptor is
2558
applied. You can use any of the following formats when specifying the value for this
parameter:
SID
Domain\user-name
user-name@Domain
user-name@FQDN
Note:
If you specify any of the three user name formats for the value of -owner, keep in mind
that the value for the user name is case insensitive. The value for the user name is
ignored for Storage-Level Access Guard (SLAG).
[-group <name or sid>] - Primary Group of the Owner (privilege: advanced)
Specifies the owner group of the security descriptor. You can specify the owner group
using either a group name or SID. You can use any of the following formats when
specifying the value for this parameter:
SID
Domain\user-name
user-name@Domain
user-name@FQDN
Note:
If you specify any of the three user name formats for the value of -group, keep in mind
ignored for SLAG.
[-control-flags-raw <Hex Integer>] - Raw Control Flags (privilege: advanced)
Specifies the control flags in the security descriptor.
Note:
The value for the control flag is ignored for SLAG.
Examples
2559
The following example creates an NTFS security descriptor named sd1 on Vserver
"vs1" and assigns DOMAIN\Administrator as the security descriptor owner.
cluster1::> vserver security file-directory ntfs create -ntfs-sd
sd1 -vserver vs1 -owner DOMAIN\Administrator
cluster1::> vserver security file-directory ntfs show -vserver vs1
-ntfs-sd sd1
Vserver: vs1
Security Descriptor Name: sd2
Owner of the Security Descriptor: DOMAIN\Administrator
2560
vserver security file-directory ntfs delete

Delete an NTFS security descriptor
Description
The vserver security file-directory ntfs delete command deletes an
NTFS security descriptor. Deleting a security descriptor also deletes all the contained
DACL and SACL access control entries (ACEs).
The vserver security file-directory ntfs delete command is not
Parameters
Specifies the name of the Vserver that is associated with the security descriptor that you
want to delete.
Specifies the name of the security descriptor to delete.
Examples
The following example deletes an NTFS security descriptor named "sd1" on Vserver
vs1.
cluster1::> vserver security file-directory ntfs delete -ntfs-sd sd1
-vserver vs1
vserver security file-directory ntfs modify

Modify an NTFS security descriptor
2561
Description
The vserver security file-directory ntfs modify command modifies
an NTFS security descriptor. You can change the -owner , -group and -controlflags-raw of the security descriptor with this command.
The vserver security file-directory ntfs modify command is not
Parameters
Specifies the name of the Vserver associated with the security descriptor that you want
to modify.
Specifies the name of the security descriptor that you want to modify.
Specifies the owner of the security descriptor. You can specify the owner using either
the user name or SID.
The owner of the security descriptor can modify the permissions on the file (or folder)
or files (or folders) to which the security descriptor is applied and can give other users
the right to take ownership of the object or objects to which the security descriptor is
applied. You can use any of the following formats when specifying the value for this
parameter:
SID
Domain\user-name
user-name@Domain
user-name@FQDN
Note:
If you specify any of the three user name formats for the value of -owner, keep in mind
ignored for Storage-Level Access Guard (SLAG).
2562
Specifies the owner group of the security descriptor. You can specify the owner group
using either a group name or SID. You can use any of the following formats when
specifying the value for this parameter:
SID
Domain\user-name
user-name@Domain
user-name@FQDN
Note:
If you specify any of the three user name formats for the value of -group, keep in mind
ignored for SLAG.
Specifies the control flags in the security descriptor to be modified.
Note:
The value for the control flag is ignored for SLAG.
Examples
The following example modifies the owner of an NTFS security descriptor named "sd2"
on Vserver vs1.
cluster1::> vserver security file-directory ntfs modify -ntfs-sd
sd2 -vserver vs1 -owner domain\administrator
cluster1::> vserver security file-directory ntfs show -vserver
vs1 -ntfs-sd sd2
Vserver: vs1
2563
vserver security file-directory ntfs show

Display an NTFS security descriptors
Description
The vserver file-directory ntfs show command displays information about
the security descriptor. The command output depends on the parameter or parameters
displays all information about all security descriptors defined on the cluster.
about security descriptors.
You can specify the -instance parameter to display all the information about security
descriptors in list format.
The vserver security file-directory ntfs show command is not supported
Parameters
| [-instance ] }
all entries.
If you specify this parameter, the command displays information only about the security
descriptors associated with the Vserver that you specify.
[-ntfs-sd <ntfs sd name>] - NTFS Security Descriptor Name
descriptors that you specify.
2564
descriptors owned by the specified user name or SID.
descriptors associated with the owner group.
descriptors associated with the control flags.
Examples
The following example displays information about an NTFS security descriptor named
sd2 on Vserver vs1.
cluster1::> vserver security file-directory ntfs show -vserver vs1
-ntfs-sd sd2
Vserver: vs1
See Also
vserver file-directory ntfs show
2565
vserver security file-directory ntfs dacl add

Add a DACL entry to NTFS security descriptor
Description
The vserver security file-directory ntfs dacl add command adds
access control entries (ACEs) into a security descriptors discretionary access control
list (DACL).
If the security descriptor contains a DACL that has existing ACEs, the command adds
the new ACE to the DACL. If the security descriptor does not contain a DACL, the
command creates the DACL and adds the new ACE to it.
Adding a DACL entry to the security descriptor is the second step in configuring
and applying ACLs to a file or folder. Before you can add a DACL entry to a security
descriptor, you must first create the security descriptor.
Note:
to apply to a path.
2566
The vserver security file-directory ntfs dacl add command is not

Parameters
Specifies the name of the Vserver associated with the security descriptor to which you
want to add a discretionary access control entry (discretionary ACE).
Specifies the name of the security descriptor to which you want to add a discretionary
access control entry.
-access-type {deny|allow} - Allow or Deny
Specifies whether the discretionary access control entry is an allow or deny type of
access control.
-account <name or sid> - Account Name or SID
Specifies the account on which to apply the discretionary access control entry. You
can specify the account by using a user name or SID. You can use any of the following
formats when specifying the value for this parameter:
SID
Domain\user-name
user-name@Domain
user-name@FQDN
Note:
If you specify any of the three user name formats for the value of -account, keep in mind
that the value for the user name is case insensitive.
{ [-rights {no-access|full-control|modify|read-and-execute|read|write}] - DACL ACE's
Access Rights
Specifies the right that you want to add for the account specified in the -account
parameter. The -rights parameter is mutually exclusive with the -advancedrights and -rights-raw parameter. If you specify the -rights parameter, you can
only specify one value.
You can specify one of the following rights values:
2567
no-access
full-control
modify
read-and-execute
read
write
| [-advanced-rights <Advanced access right>, ...] - DACL ACE's Advanced Access
Rights
Specifies the advanced rights that you want to add for the account specified in the account parameter. The -advanced-rights parameter is mutually exclusive with
the -rights and -rights-raw parameter. You can specify more than one advancedrights value by using a comma-delimited list.
You can specify one or more of the following advanced rights:
read-data
write-data
append-data
read-ea
write-ea
execute-file
delete-child
read-attr
write-attr
delete
read-perm
write-perm
write-owner
full-control
| [-rights-raw <Hex Integer>] } - DACL ACE's Raw Access Rights (privilege: advanced)
Specifies the raw rights that you want to add for the account specified in the -account
parameter. The rights-raw parameter is mutually exclusive with the -advanced2568
rights and -rights parameter. Specify the value as a hexadecimal integer, for
example: 0xA10F or 0xb3ff etc.
[-apply-to {this-folder|sub-folders|files}, ...] - Apply DACL Entry
Specifies where to apply the discretionary access control entry. You can specify more
than one value by using a comma-delimited list.
You can specify one or more of the following values:
this-folder
sub-folder
files
Note:
Select one of the following combinations of values for the -apply-to parameter for
Storage-Level Access Guard (SLAG):
this-folder, sub-folder, files
this-folder, sub-folder
files
If you specify an invalid -apply-to value, this security descriptor is removed from
the associated Storage-Level Access Guard (SLAG) security file-directory
policy task.
Examples
The following example adds a DACL entry to the security descriptor named sd1 on
Vserver "vs1" for the "DOMAIN\Administrator" account.
cluster1::> vserver security file-directory ntfs dacl add ntfs-sd sd1 -access-type deny -account DOMAIN\Administrator -rights full-control
-apply-to this-folder -vserver vs1
cluster1::> vserver security file-directory ntfs dacl show vserver vs1 -ntfs-sd sd1 -access-type deny -account domain\administrator
Vserver: vs1
Allow or Deny: deny
Account Name or SID: DOMAIN\Administrator
2569
Access Rights: full-control

Advanced Access Rights: Apply To: this-folder
See Also
security file-directory policy task
2570
vserver security file-directory ntfs dacl modify

Modify an NTFS security descriptor DACL entry
Description
The vserver security file-directory ntfs dacl modify command
modifies parameters in an existing discretionary access control (DACL) entry.
You can unambiguously define which DACL entry to modify by specifying the following
four parameters in the modify command:
Vserver associated with the security descriptor that contains the DACL entry
Name of the security descriptor that contains the DACL entry
Whether the DACL is an allow or deny type of DACL entry
The account name or SID to which the DACL is applied
You can modify the following parameters:
-right,-advanced-rights ,-rights-raw
-apply-to
The vserver security file-directory ntfs dacl modify command is not
Parameters
Specifies the name of the Vserver associated with the security descriptor containing the
discretionary access control entry whose parameters you want to modify.
Specifies the name of the security descriptor that contains the discretionary access
control entry that you want to modify.
2571
Specifies whether the discretionary access control entry that you want to modify is an
allow or deny type of access control.
Specifies the account associated with the discretionary access control entry you want to
modify. You can specify the account by using a user name or SID. You can use any of
the following formats when specifying the value for this parameter:
SID
Domain\user-name
user-name@Domain
user-name@FQDN
Note:
{ [-rights {no-access|full-control|modify|read-and-execute|read|write}] - Access Rights
no-access
full-control
modify
read-and-execute
read
write
| [-advanced-rights <Advanced access right>, ...] - Advanced Access Rights
2572

read-data
write-data
append-data
read-ea
write-ea
execute-file
delete-child
read-attr
write-attr
delete
read-perm
write-perm
write-owner
full-control
| [-rights-raw <Hex Integer>] } - Raw Access Rights (privilege: advanced)
parameter. The -rights-raw parameter is mutually exclusive with the -advancedrights and -rights parameter. Specify the value as a hexadecimal integer, for
Specifies where to apply the discretionary access control entry. You can specify more
than one value by using a comma-delimited list.
this-folder
sub-folder
files
Note:
2573
files
policy task.
Examples
The following example modifies the -right and -apply-to parameters in the DACL
entry associated to the security descriptor named sd2 on Vserver vs1 for the "BUILTIN
\Administrators" account.
cluster1::> vserver security file-directory ntfs dacl modify -ntfssd sd2 -access-type allow -account BUILTIN\Administrators -vserver vs1 -rights
modify -apply-to this-folder,sub-folders
cluster1::> vserver security file-directory ntfs dacl show -vserver
vs1 -ntfs-sd sd2 -account BUILTIN\Administrators -instance
Vserver: vs1
Allow or Deny: allow
Account Name or SID: BUILTIN\Administrators
Access Rights: modify
Advanced Access Rights: Apply To: this-folder, sub-folders
See Also
2574
vserver security file-directory ntfs dacl remove

Remove a DACL entry from NTFS security descriptor.
Description
The vserver security file-directory ntfs dacl remove command
removes a discretionary access control entry from a security descriptor.
You can unambiguously define which DACL entry to remove by specifying the following
four parameters in the command:
Vserver associated with the security descriptor that contains the DACL entry
Name of the security descriptor that contains the DACL entry
Whether the DACL is an allow or deny type of DACL entry
The account name or SID to which the DACL is applied
The vserver security file-directory ntfs dacl remove command is not
Parameters
Specifies the name of the Vserver associated with the security descriptor from which
you want to remove a discretionary access control entry.
Specifies the name of the security descriptor that contains the discretionary access
control entry that you want to remove.
Specifies whether the discretionary access control entry you want to remove is an allow
or deny of access control.
Specifies the account name or SID associated with the discretionary access control
entry that you want to remove.
2575
Examples
The following example removes a DACL entry from the security descriptor named sd2
with allow access type for the "BUILTIN\Administrators" account on Vserver vs1.
cluster1::> vserver security file-directory ntfs dacl remove -ntfs-sd
sd2 -access-type allow -account BUILTIN\Administrators -vserver vs1
vserver security file-directory ntfs dacl show

Display NTFS security descriptor DACL entries
Description
The vserver security file-directory ntfs dacl show command displays
information about all the discretionary access control entries in the Vserver. The
about all DACL entries:
Vserver name
Security descriptor
List of DACL entries
about DACL entries.
You can specify the -instance parameter to display all information about DACL
entries in a list format.
The vserver security file-directory ntfs dacl show command is not
Parameters
2576
| [-instance ] }
all entries.
If you specify this parameter, the command displays information only about discretionary
access control entries associated with the specified Vserver.
discretionary access control entries for the security descriptor that you specify.
[-access-type {deny|allow}] - Allow or Deny
discretionary access control entries with the access type that you specify.
[-account <name or sid>] - Account Name or SID
discretionary access control entries associated with the account name or SID that you
specify. You can use any of the following formats when specifying the value for this
parameter:
SID
Domain\user-name
user-name@Domain
user-name@FQDN
Note:
[-rights {no-access|full-control|modify|read-and-execute|read|write}] - Access Rights
discretionary access control entries with the user right that you specify. Only one value
can be specified.
2577
no-access
full-control
modify
read-and-execute
read
write
[-advanced-rights <Advanced access right>, ...] - Advanced Access Rights
discretionary access control entries with the advanced user rights that you specify. You
can specify more than one value by using a comma-delimited list.
read-data
write-data
append-data
read-ea
write-ea
execute-file
delete-child
read-attr
write-attr
delete
read-perm
write-perm
write-owner
full-control
[-rights-raw <Hex Integer>] - Raw Access Rights (privilege: advanced)
discretionary access control entries with the advanced user rights that you specify. This
2578
value for this parameter is mutually exclusive with any other rights values. Specify the
value as a hexadecimal integer, for example: 0xA10F or 0xb3ff etc.
discretionary access control entries with the -applied-to value or values that you specify.
You can specify more than one value by using a comma-delimited list.
this-folder
sub-folder
files
[-readable-access-rights <TextNoCase>] - Access Rights
If you specify this parameter, the command displays information only the discretionary
access control entries with the readable access rights that you specify.
Examples
The following example shows information about a DACL entry.
cluster1::> vserver security file-directory ntfs dacl show
Vserver: vs1
Account Name
Access
Access
Type
Rights
Apply To
--------------
-------
-------
BUILTIN\Users
allow
full-control
this-folder, sub-
CREATOR OWNER
allow
full-control
this-folder, sub-
full-control
this-folder, sub-
-----------
folders, files
folders, files
NT AUTHORITY\SYSTEM
allow
folders, files
2579
vserver security file-directory ntfs sacl add

Add a SACL entry to NTFS security descriptor
Description
The vserver security file-directory ntfs sacl add command adds
system access control list entries (ACEs) into a security descriptors system access
control list (SACL).
If the security descriptor contains a SACL that has existing security ACEs, the command
adds the new security ACE to the SACL. If the security descriptor does not contain a
SACL, the command creates the SACL and adds the new security ACE to it.
Adding a SACL entry to the security descriptor is the second step in configuring and
applying security ACLs to a file or folder. Before you can add a SACL entry to a security
descriptor, you must first create the security descriptor.
Add DACL and SACL entries to the NTFS security descriptor.
Note:
to apply to a path.
2580
The vserver security file-directory ntfs sacl add command is not

Parameters
Specifies the name of the Vserver associated with the security descriptor to which you
want to add a system access control list entry.
Specifies the name of the security descriptor to which you want to add a system access
control list entry.
-access-type {failure|success} - Failure or Success
Specifies whether the system access control list entry that you want to add is a failure or
success access audit type.
Specifies the account on which to apply the system access control list entry. You can
specify the account by using a user name or SID. You can use any of the following
SID
Domain\user-name
user-name@Domain
user-name@FQDN
Note:
If you specify any of the three user name formats for the value of -account, keep in
mind that the value for the user name is case insensitive.
no-access
2581
full-control
modify
read-and-execute
read
write
read-data
write-data
append-data
read-ea
write-ea
execute-file
delete-child
read-attr
write-attr
delete
read-perm
write-perm
write-owner
full-control
2582
[-apply-to {this-folder|sub-folders|files}, ...] - Apply SACL To

Specifies where to apply the system access control list entry. You can specify more than
one value by using a comma-delimited list.
this-folder
sub-folder
files
Note:
files
policy task.
Examples
The following example adds a SACL entry to the security descriptor named sd1 on
Vserver vs1.
cluster1::> vserver security file-directory ntfs sacl add -ntfssd sd1 -access-type failure -account DOMAIN\Administrator -rights full-control apply-to this-folder -vserver vs1
cluster1::> vserver security file-directory ntfs sacl show vserver vs1 -ntfs-sd sd1 -access-type deny -account DOMAIN\Administrator
Vserver: vs1
Access type for Specified Access Rights: failure
Account Name or SID: DOMAIN\Administrator
Advanced Access Rights: -
2583
Apply To: this-folder

See Also
2584
vserver security file-directory ntfs sacl modify

Modify an NTFS security descriptor SACL entry
Description
The vserver security file-directory ntfs sacl modify command
modifies parameters in an existing system access control list entry.
You can unambiguously define which SACL entry to modify by specifying the following
four parameters in the modify command:
Vserver associated with the security descriptor that contains the SACL entry
Name of the security descriptor that contains the SACL entry
Whether the SACL is a success or failure type of SACL entry
The account name or SID to which the SACL is applied
-rights,-advanced-rights,-rights-raw
-apply-to
The vserver security file-directory ntfs sacl modify command is not
Parameters
Specifies the name of the Vserver associated with the security descriptor containing the
system access control list entry whose fields you want to modify.
Specifies the name of the security descriptor that contains the system access control list
entry that you want to modify.
2585
Specifies whether the system access control list entry that you want to modify is a failure
or success access audit type.
Specifies the account on which to apply the system access control list entry. You can
specify the account by using a user name or SID. You can use any of the following
SID
Domain\user-name
user-name@Domain
user-name@FQDN
Note:
If you specify any of the three user name formats for the value of -account, keep in
mind that the value for the user name is case insensitive.
no-access
full-control
modify
read-and-execute
read
write
2586

read-data
write-data
append-data
read-ea
write-ea
execute-file
delete-child
read-attr
write-attr
delete
read-perm
write-perm
write-owner
full-control
Specifies where to apply the system access control list entry. You can specify more than
one value by using a comma-delimited list.
this-folder
sub-folder
files
Note:
2587
files
policy task.
Examples
The following example modifies the rights and -apply-to fields in the SACL entry.
cluster1::> vserver security file-directory ntfs sacl modify -ntfssd sd2 -access-type success -account BUILTIN\Administrators -vserver vs1 -rights
modify -apply-to this-folder,sub-folders
cluster1::> vserver security file-directory ntfs sacl show -vserver
vs1 -ntfs-sd sd2 -account BUILTIN\Administrators -instance
Vserver: vs1
Access type for Specified Access Rights: success
Account Name or SID: BUILTIN\Administrators
Advanced Access Rights: Apply To: this-folder, sub-folders
See Also
2588
vserver security file-directory ntfs sacl remove

Remove a SACL entry from NTFS security descriptor
Description
The vserver security file-directory ntfs sacl remove command
removes a system access control list entry from a security descriptor.
You can unambiguously define which SACL entry to remove by specifying the following
four parameters in the command:
Vserver associated with the security descriptor that contains the SACL entry
Name of the security descriptor that contains the SACL entry
Whether the SACL is a success or failure type of SACL entry
The account name or SID to which the SACL is applied
The vserver security file-directory ntfs sacl remove command is not
Parameters
Specifies the name of the Vserver associated with the security descriptor from which
you want to remove the system access control list entry.
Specifies the name of the security descriptor that contains the system access control list
entry that you want to remove.
Specifies whether the system access control list entry that you want to remove is a
failure or success access audit type.
Specifies the account name or SID associated with the system access control list entry
that you want to remove.
2589
Examples
The following example removes a SACL entry named sd2 on Vserver vs1 with an
access type of success associated with the "BUILTIN\Administrators" account.
cluster1::> vserver security file-directory ntfs sacl remove -ntfs-sd
sd2 -access-type success -account BUILTIN\Administrators -vserver vs1
vserver security file-directory ntfs sacl show

Display NTFS security descriptor SACL entries
Description
The vserver security file-directory ntfs sacl show command displays
information about all the system access control list entries in the Vserver. The command
output depends on the parameter or parameters specified with the command. If you do
not specify any parameters, the command displays the following information about all
SACL entries:
Vserver name
Security descriptor
List of SACL entries
about SACL entries.
You can specify the -instance parameter to display all information about SACL
entries in a list format.
The vserver security file-directory ntfs sacl show command is not
Parameters
2590
| [-instance ] }
all entries.
If you specify this parameter, the command displays information only about system
access control list entries associated with the specified Vserver.
If you specify this parameter, the command displays information only about the system
access control list entries for the security descriptor that you specify.
[-access-type {failure|success}] - Failure or Success
access control list entries with the access type that you specify.
[-account <name or sid>] - Account Name or SID
access control list entries associated with the account name or SID that you specify. You
can use any of the following formats when specifying the value for this parameter:
SID
Domain\user-name
user-name@Domain
user-name@FQDN
Note:
[-rights {no-access|full-control|modify|read-and-execute|read|write}] - Access Rights
system access control list entries with the user right that you specify. The value for this
parameter is mutually exclusive with any other rights values. Only one value can be
specified.
2591
no-access
full-control
modify
read-and-execute
read
write
[-advanced-rights <Advanced access right>, ...] - Advanced Access Rights
access control list entries with the advanced user rights that you specify. You can
specify more than one value by using a comma-delimited list.
You can specify one or more of the following advanced rights values:
read-data
write-data
append-data
read-ea
write-ea
execute-file
delete-child
read-attr
write-attr
delete
read-perm
write-perm
write-owner
full-control
[-rights-raw <Hex Integer>] - Raw Access Rights (privilege: advanced)
access control list entries with the advanced user rights that you specify. This value for
2592
this parameter is mutually exclusive with any other rights values. Specify the value as a
hexadecimal integer, for example: 0xA10F or 0xb3ff etc.
access control list entries with the -applied-to value or values that you specify. You can
specify more than one value by using a comma-delimited list.
this-folder
sub-folder
files
[-readable-access-rights <TextNoCase>] - Access Rights
access control list entries with the readable access rights that you specify.
Examples
The following example shows a SACL entry.
cluster1::> vserver security file-directory sacl show
(vserver security file-directory ntfs sacl show)
Vserver: vs1
Account Name
Access
Access
Type
Rights
--------------
-------
-------
domain\user
success
full-control
Apply To
----------this-folder, sub-
folders, files
2593
vserver security file-directory policy create

Create a file security policy
Description
The vserver security file-directory policy create command creates a
security policy for a Vserver. A policy acts as a container for various tasks where each
task is a single entry that can be applied to a file/folder.
Creating a security policy is the third step in configuring and applying security ACLs to a
file or folder. You will later add tasks to the security policy.
Note:
You cannot modify a security policy. If you want to apply a policy with the same settings
to a different Vserver, you must create a new policy with the same configuration and
apply it to the desired Vserver.
Add DACLS and SACLS to the NTFS security descriptor.
Note:
Vserver in addition to adding SACLs to the security descriptor.
to apply to a path.
2594
The vserver security file-directory policy create command is not

Parameters
Specifies the name of the Vserver on which to create the security policy.
Specifies the name of the security policy.
Examples
The following example creates a security policy named policy1 on Vserver vs1.
cluster1::> vserver security file-directory policy create -policyname policy1 -vserver vs1
cluster1::> vserver security file-directory policy show
Vserver
Policy Name
------------
--------------
vs1
policy1
2595
vserver security file-directory policy delete

Delete a file security policy
Description
The vserver security file-directory policy delete command deletes a
security policy from a Vserver.
The vserver security file-directory policy delete command is not
Note:
Deleting a policy fails if a job is currently running for the specified policy.
Parameters
Specifies the name of the Vserver associated with the security policy that you want to
delete.
Specifies the name of the security policy you want to delete.
Examples
The following example deletes a security policy named policy1 from Vserver vs1.
cluster1::> vserver security file-directory policy delete -policyname policy1 -vserver vs1
vserver security file-directory policy show

Display file security policies
2596

Description
The vserver security file-directory policy show command displays
information about all security policies in the Vserver. The command output depends on
the parameter or parameters specified with the command.
about security policies.
You can specify the -instance parameter to display information for all security policies
in a list format.
The vserver security file-directory policy show command is not
Parameters
| [-instance ] }
all entries.
If you specify this parameter, the command displays information only about security
policies associated with the specified Vserver.
[-policy-name <Security policy name>] - Policy Name
policy you specify.
Examples
The following example displays information about the security policies on the cluster.
cluster1::> vserver security file-directory policy show
Vserver
Policy Name
------------
--------------
vs1
policy1
2597
vs1
policy2
2598
vserver security file-directory policy task add

Add a policy task
Description
The vserver security file-directory policy task add command adds a
single task entry to a security policy. A task refers to a single operation that can be done
by a security policy to a file/folder.
Before you create a security policy task, you must first create a security policy and a
security descriptor. You should also add DACL entries and SACL entries (if desired) to
the security descriptor before you create the security policy task.
Note:
You can add DACL and SACL entries to the security descriptor after you have
associated it to a security policy task.
Creating a policy task is the fourth step in configuring and applying ACLs to a file or
folder. When you create the policy task, you associate a security descriptor to it. You
also associate the task to a security policy.
Add DACLS and SACLS to the NTFS security descriptor.
Note:
Vserver in addition to adding SACLs to the Security Descriptor.
2599
to apply to a path.
Note:
Adding a policy task fails if a job is currently running for the specified policy to
which a task is being added.
The vserver security file-directory policy task add command is not
Parameters
Specifies the Vserver associated with the security policy to which you want to add a
task.
Specifies the name of the security policy into which you want to add the task.
-path <text> - Path
Specifies the path of the file/folder on which to apply the security descriptor associated
with this task.
[-security-type {ntfs|nfsv4}] - Security Type of the File
Specifies whether the security descriptor associated with this task is an NTFS or a
NFSv4 security descriptor type. If you do not specify a value for this optional parameter,
the default is ntfs.
Note:
The nfsv4 security descriptor type is not supported in this release. If you specify this
optional parameter, you must enter ntfs for the -security-type value.
[-ntfs-mode {propagate|ignore|replace}] - Propagation Mode
Specifies how to propagate security settings to child subfolders and files. This setting
determines how child files and/or folders contained within a parent folder inherit access
control and audit information from the parent folder.
2600
You can specify one of the three parameter values that correspond to three types of
propagation modes:
propagate - propagate inheritable permissions to all subfolders and files
replace - replace existing permissions on all subfolders and files with inheritable
permissions
ignore - do not allow permissions on this file or folder to be replaced
Note:
The ntfs-mode value is ignored for Storage-Level Access Guard (SLAG).
[-ntfs-sd <ntfs sd name>, ...] - NTFS Security Descriptor Name
Specifies the list of security descriptor names to apply to the path specified in the -path
parameter.
[-index-num <integer>] - Position
Specifies the index number of a task. Tasks are applied in order. A task with a larger
index value is applied after a task with a lower index number. If you do not specify this
optional parameter, new tasks are applied to the end of the index list.
The range of supported values is 1 through 9999. If there is a gap between the highest
existing index number and the value entered for this parameter, the task with this
number is considered to be the last task in the policy and is treated as having an index
number of the previous highest index plus one.
Note:
If you specify an index number that is already assigned to an existing task, index
number will be auto arranged to highest index number in the table.
[-access-control {file-directory|slag}] - Access Control Level
Specifies the access control of the task to be applied. Its value can be file-directory or
slag, respectively. When its value is slag, the specified security descriptors with the task
are applied for the volume. Otherwise, the security descriptors are applied on files and
directories as the specified path. The default value is file-directory.
Examples
The following example adds a security policy task entry to the policy named policy1 on
Vserver vs1.
2601
cluster1::> vserver security file-directory policy task add vserver vs1 -policy-name policy1 -path / -access-control slag -security-type ntfs
-ntfs-mode propagate -ntfs-sd sd -index-num 1
cluster1::> vserver security file-directory policy task add
-vserver vs1 -policy-name policy2 -path /1 -security-type ntfs -ntfs-mode
propagate -ntfs-sd sd1,sd2
cluster1::> vserver security file-directory policy task show
Vserver: vs1
Policy: policy1
Index
File/Folder
Access
Security
NTFS
NTFS
Path
Control
Type
Mode
-----
-----------
---------------
--------
----------
slag
ntfs
propagate
sd
File/Folder
Access
Security
NTFS
NTFS
Path
Control
Type
Mode
-----
-----------
---------------
--------
----------
/1
file-directory
ntfs
propagate
Security
Descriptor Name
---------------
Vserver: vs1
Policy: policy2
Index
Security
Descriptor Name
--------------sd1,
sd2
2602
vserver security file-directory policy task modify

Modify a policy task
Description
The vserver security file-directory policy task modify command
modifies a task entry in a security policy.
Note:
Modifying a policy task fails if a job is currently running for the specified policy in which a
task is being modified.
You can unambiguously define which task to modify by specifying the following three
parameters in the modify command:
Vserver associated with the task
Name of the security policy that contains the task
Name of the path to which the task is applied
-ntfs-mode
-ntfs-sd
-index-num
Note:
The only security type supported in this Data ONTAP release is ntfs; therefore, you
cannot modify the -security-type parameter.
The vserver security file-directory policy task modify command is
Parameters
2603
Specifies the Vserver associated with the security policy that contains the task you want
to modify.
Specifies the name of the security policy that contains the task you want to modify.
-path <text> - Path
Specifies the path of the file/folder associated with the task that you want to modify.
[-security-type {ntfs|nfsv4}] - Security Type
Specifies whether the security descriptor in the task that you want to modify should be
an NTFS security descriptor type or an NFSv4 security descriptor type. Default value is
ntfs.
Note:
The nfsv4 security descriptor type is not supported in this release. If you specify this
optional parameter, you must enter ntfs for the -security-type value.
[-ntfs-mode {propagate|ignore|replace}] - NTFS Propagation Mode
Specifies how to propagate security settings to child subfolders and files. This setting
determines how child files and/or folders contained within a parent folder inherit access
control and audit information from the parent folder.
You can specify one of the three parameter values that correspond to three types of
propagation modes:
propagate - propagate inheritable permissions to all subfolders and files
replace - replace existing permissions on all subfolders and files with inheritable
permissions
ignore - do not allow permissions on this file or folder to be replaced
Specifies the list of security descriptor names to apply to the path specified in the -path
parameter.
Specifies the index number of a task. Tasks are applied in order. A task with a larger
index value is applied after a task with a lower index number. If you do not specify this
optional parameter, new tasks are applied to the end of the index list.
The range of supported values is 1 through 9999. If there is a gap between the highest
existing index number and the value entered for this parameter, the task with this
2604
number is considered to be the last task in the policy and is treated as having an index
number of the previous highest index plus one.
Note:
If you specify an index number that is already assigned to an existing task, the
command fails when you attempt to create a duplicate entry.
Examples
The following example modifies the ntfs mode, index, and ntfs-sd parameters in the
security policy task entry.
cluster1::> vserver security file-directory policy task modify vserver vs1 -policy-name policy1 -path / -security-type ntfs -ntfs-mode propagate
-ntfs-sd sd -index-num 1
cluster1::> vserver security file-directory policy task modify
-vserver vs1 -policy-name policy1 -path /1 -security-type ntfs -ntfs-mode
propagate -ntfs-sd sd1, sd2 -index-num 2
cluster1::> vserver security file-directory policy task show vserver vs1 -policy-name policy1
Vserver: vs1
Policy: policy1
Index
File/Folder
Access
Security
NTFS
NTFS
Path
Control
Type
Mode
--------
--------------
------
-----
file-directory
ntfs
propagate
sd
/1
file-directory
ntfs
propagate
sd1,
Security
Descriptor Name
---------------------
sd2
2605
vserver security file-directory policy task remove

Remove a policy task
Description
The vserver security file-directory policy task remove command
removes a task entry from a security policy.
The vserver security file-directory policy task remove command is
Note:
Removing a policy task fails if a job is currently running for the specified policy from
which a task is being removed.
Parameters
Specifies the Vserver associated with the security policy that contains the task you want
to remove.
Specifies the name of the security policy that contains the task you want to remove.
-path <text> - Path
Specifies the path of the file/folder associated with the task that you want to remove.
Examples
The following example removes a security policy task entry.
cluster1::> vserver security file-directory policy task remove vserver vs1 -policy-name policy1 -path /
2606
vserver security file-directory policy task show

Display policy tasks
Description
The vserver security file-directory policy task show command
displays information about all the task entries in the Vserver. The command output
depends on the parameter or parameters specified with the command. If you do not
specify any parameters, the command displays the following information about all task
entries:
Vserver name
Policy name
Task entries
The vserver security file-directory policy task show command is not
Parameters
| [-instance ] }
all entries.
If you specify this parameter, the command displays information only tasks associated
with the specified Vserver.
[-policy-name <Security policy name>] - Policy Name
If you specify this parameter, the command displays information only about tasks
associated with the specified security policy.
2607
applied to the specified path.
[-security-type {ntfs|nfsv4}] - Security Type
associated with the specified security type.
Note:
The nfsv4 security descriptor type is not supported in this release.
[-ntfs-mode {propagate|ignore|replace}] - NTFS Propagation Mode
configured with the NTFS propagation mode that you specify.
If you specify this parameter, the command displays information only about the policy
tasks associated with the NTFS security descriptor that you specify.
assigned the index number that you specify.
[-access-control {file-directory|slag}] - Access Control Level
associated to the access control.
Examples
The following example displays policy task entries for a policy named policy1 on
Vserver vs1.
cluster1::> vserver security file-directory policy task show vserver vs1 -policy-name policy1
Vserver: vs1
Policy: policy1
Index
File/Folder
Access
Security
NTFS
Path
Control
Type
Mode
-----------
---------------
--------
----------
NTFS
Security
Descriptor Name
-------------------
2608
/1
file-directory
ntfs
propagate
sd1,
/2
file-directory
ntfs
ignore
sd2
2609
vserver security trace filter create

Create a security trace entry
Description
The vserver security trace filter create command creates a security trace
filter entry. This feature is currently supported for CIFS only and not supported for NFS.
The vserver security trace filter create command is not supported for
Parameters
This specifies the name of the Vserver on which the permission trace is applied.
-index <integer> - Filter Index
This specifies the index number you want to assign to the trace filter. A maximum of 10
entries can be created. The allowed values for this parameter are 1 through 10.
[-client-ip <IP Address>] - Client IP Address to Match
This specifies the IP Address from which the user is accessing the Vserver.
[-path <TextNoCase>] - Path
This specifies the path to which permission tracing is applied. The value can be the
complete path, starting from the root of the share for CIFS or the root of the volume for
NFS that the client is accessing, or the value can be a part of the path that the client is
accessing. Use NFS style directory separators in the path value.
{ [-windows-name <TextNoCase>] - Windows User Name
This specifies the Windows user name to trace. You can use any of the following
user_name
domain\user_name
| [-unix-name <TextNoCase>] } - UNIX User Name
2610
This specifies the Unix user name to trace.

[-trace-allow {yes|no}] - Trace Allow Events
Security tracing can trace deny events and allow events. Deny event tracing is always
ON by default. Allow events can optionally be traced. If set to yes, this option allows
tracing of allow events. If set to no, allow events are not traced.
[-enabled {enabled|disabled}] - Filter Enabled
This specifies whether to enable or disable the filter. Filters are enabled by default.
[-time-enabled <integer>] - Minutes Filter is Enabled
This specifies a timeout for this filter, after which it is disabled.
Examples
The following example creates a security trace filter.
cluster1::> vserver security trace filter create -vserver vs0 -index 1 -timeenabled 120 -client-ip 10.72.205.207
The following examples create filters that include the -path option. If the client is
accessing a file with the path \\server\sharename\dir1\dir2\dir3\file.txt, a complete path
starting from the root of the share or a partial path can be given as shown:
cluster1::> vserver security trace filter create -vserver vs0 -index 1 -path /
dir1/dir2/dir3/file.txt
cluster1::> vserver security trace filter create -vserver vs0 -index 1 -path
dir3/file.txt
vserver security trace filter delete

Delete a security trace entry
Description
The vserver security trace filter delete command deletes a security trace
filter entry. This feature is currently supported for CIFS only and not supported for NFS.
2611
The vserver security trace filter delete command is not supported for
Parameters
This specifies the name of the Vserver on which the tracing filter entry that you want to
delete is applied.
This specifies the index number for the filter that you want to delete. You can display
a list of the filter index numbers by using the vserver security trace filter
show command.
Examples
The following example deletes a security trace filter.
cluster1::> vserver security trace filter delete -vserver vs0 -index 1
See Also
vserver security trace filter show
2612
vserver security trace filter modify

Modify a security trace entry
Description
The vserver security trace filter modify command modifies a security
trace filter entry. This feature is currently supported for CIFS only and not supported for
NFS.
The vserver security trace filter modify command is not supported for
Parameters
This specifies the name of the Vserver on which the permission trace is applied.
This specifies the index number for the filter. A maximum of 10 entries can be created.
The allowed values for this parameter are 1 through 10.
This specifies the IP Address from which the user is accessing the Vserver.
This specifies the path to which permission tracing is applied. The value can be the
complete path, starting from the root of the share for CIFS or the root of the volume for
NFS that the client is accessing, or the value can be a part of the path that the client is
accessing. Use NFS style directory separators in the path value.
{ [-windows-name <TextNoCase>] - Windows User Name
This specifies the Windows user name to trace. You can use any of the following
user_name
domain\user_name
2613
| [-unix-name <TextNoCase>] } - UNIX User Name

This specifies the Unix user name to trace.
Security tracing can trace deny events and allow events. Deny event tracing is always
ON by default. Allow events can optionally be traced. If set to yes, this option allows
tracing of allow events. If set to no, allow events are not traced.
This specifies whether to enable or disable the filter. Filters are enabled by default.
This specifies a timeout for this filter, after which it is disabled.
Examples
The following example modifies a security trace filter.
cluster1::> vserver security trace filter modify -vserver vs0 -index 1 -timeenabled 120 -client-ip 10.72.205.207
The following examples modify filters that include the -path option. If the client is
accessing a file with the path \\server\sharename\dir1\dir2\dir3\file.txt, a complete path
starting from the root of the share or a partial path can be given as shown:
cluster1::> vserver security trace filter modify -vserver vs0 -index 1 -path /
dir1/dir2/dir3/file.txt
cluster1::> vserver security trace filter modify -vserver vs0 -index 1 -path
dir3/file.txt
vserver security trace filter show

Display a security trace entry
Description
2614
The vserver security trace filter show command displays information about
security trace filter entries. This feature is currently supported for CIFS only and not
supported for NFS.
The vserver security trace filter show command is not supported for
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays permission tracing information only
for filters applied to the specified Vserver.
[-index <integer>] - Filter Index
for filters with the specified filter index number.
for filters applied to the specified client IP address.
for filters applied to the specified path.
[-windows-name <TextNoCase>] - Windows User Name
for filters applied to the specified Windows user name.
[-unix-name <TextNoCase>] - UNIX User Name
for filters applied to the specified UNIX user name.
2615
If you specify this parameter, the command displays information only about events that
either trace or do not trace allow events, depending on the value provided.
If you specify this parameter, the command displays information only about filters that
either are enabled or disabled, depending on the value provided.
If you specify this parameter, the command displays information only about filters that
are disabled after the specified minutes.
Examples
The following example displays security trace filters for Vserver vserver1.
cluster1::> vserver security trace filter show
Vserver
Index
Client-IP
Path
Trace-Allow Windows-Name
-------- ----- --------------- --------------------- ----------- ------------vserver1
no
domain\user
vserver1
192.168.2.3
yes
vserver1
/dir1/dir2/file
no
domain\
administrator
2616
vserver security trace trace-result delete

Delete security trace results
Description
Delete the specified security tracing event record.
The vserver security trace trace-result delete command is not
Parameters
This specifies the cluster node on which the permission tracing event that you want to
delete occurred.
This specifies the Vserver on which the permission tracing event that you want to delete
occurred.
-seqnum <integer> - Sequence Number
This specifies the sequence number of the log entry to be deleted.
Examples
The following example deletes the security trace result record for the Vserver vserver_1
on node Node_1 whose sequence number is 999.
cluster1::> vserver security trace trace-result delete -vserver vserver_1 -node
Node_1 -seqnum 999
vserver security trace trace-result show

Display security trace results
2617
Description
The vserver security trace trace-result show command displays the
list of security trace event records stored on the cluster. These records are generated
in response to security trace filters that are created using the vserver security
trace filter create command. The command output depends on the parameter
or parameters specified with the command. If you do not specify any parameters,
the command displays the following information about all the security trace events
generated since the filter was enabled:
Vserver name
Cluster node name
Security trace filter index number
User name
Security style
Path
Reason
You can specify additional parameters to display only information that match those
parameters. For example, to display information about events that occurred for the user
"guest", run the command with -user-name parameter set to guest.
The vserver security trace trace-result show command is not supported
Parameters
| [-instance ] }
If you specify this parameter, the command displays detailed information about all
security trace events.
trace events on the specified node.
2618
trace events on the specified Vserver.
[-seqnum <integer>] - Sequence Number
trace events with this sequence number.
[-keytime <Date>] - Time
trace events that occurred at the specified time.
[-index <integer>] - Index of the Filter
trace events that occurred as a result of the filter corresponding to the specified filter
index number.
[-client-ip <IP Address>] - Client IP Address
trace events that occurred as a result of file access from the specified client IP address.
[-path <TextNoCase>] - Path of the File Being Accessed
trace events that occurred as a result of file accesses to the specified path.
[-user-name <TextNoCase>] - Windows or Unix User Name
trace events that occurred as a result of file accesses by the specified user.
[-security-style <security style>] - Effective Security Style On File
trace events that occurred on file systems with the specified security style. The allowed
values for security style are the following:
SECURITY_NONE - Security not Set
SECURITY_UNIX_MODEBITS - UNIX and UNIX permissions
SECURITY_UNIX_ACL - UNIX and NFSv4 ACL
SECURITY_UNIX_SD - UNIX and NT ACL
SECURITY_MIXED_MODEBITS - MIXED and UNIX permissions
SECURITY_MIXED_ACL - MIXED and NFSv4 ACL
SECURITY_MIXED_SD - MIXED and NT ACL
2619
SECURITY_NTFS_MODEBITS - NTFS and UNIX permissions

SECURITY_NTFS_ACL - NTFS and NT ACL
SECURITY_NTFS_SD - NTFS and NT ACL
SECURITY_UNIX - UNIX
SECURITY_MIXED - MIXED
SECURITY_NTFS - NTFS
SECURITY_MODEBITS - UNIX permissions
SECURITY_ACL - ACL
SECURITY_SD - SD
[-result <TextNoCase>] - Result of Security Checks
If you specify this parameter, the command displays information about the security trace
events that have the specified result. Access to a file or a directory can be 'allowed' or
'denied'. Output from this command displays the result as a combination of the reason
for allowing or denying access, the location where access is either allowed or denied,
and the access right for which the file operation is allowed or denied.
The following are the reasons why an access can be allowed:
Access is allowed because the operation is trusted and no security is configured
Access is allowed because the user has UNIX root privileges
Access is allowed because the user has UNIX owner privileges
Access is allowed because UNIX implicit permission grants requested access
Access is allowed because the CIFS user is owner
Access is allowed because the user has take ownership privilege
Access is allowed because there is no CIFS ACL
Access is allowed because CIFS implicit permission grants requested access
Access is allowed because the security descriptor is corrupted and the user is a
member of the Administrators group
Access is allowed because the ACL is corrupted and the user is a member of the
Administrators group
Access is allowed because the user has UNIX permissions
Access is allowed because explicit ACE grants requested access
2620
Access is allowed because the user has audit privileges

Access is allowed because the user has superuser credentials
Access is allowed because inherited ACE grants requested access
Access is allowed because storage-level access guard (SLAG) grants requested
access
Access is allowed because no central access policies applied
Access is allowed because no central access policies could be applied from the
corrupt SACL
Access is allowed because matching central access policy could not be located
Access is allowed because no central access rules apply to the object
Access is allowed because skipped one or more corrupt central access rules
Access is allowed because all evaluated central access rules grant access
The following are the reasons why an access can be denied:
Access is denied by UNIX permissions
Access is denied by an explicit ACE
Access is denied. The requested permissions are not granted by the ACE
Access is denied. The security descriptor is corrupted
Access is denied. The ACL is corrupted
Access is denied. The sticky bit is set on the parent directory and the user is not
the owner of file or parent directory
Access is denied. The owner can be changed only by root
Access is denied. The UNIX permissions/uid/gid/NFSv4 ACL can be changed only
by owner or root
Access is denied. The GID can be set by owner to a member of its legal group list
only if 'Owner can chown' is not set
Access is denied. The file or the directory has readonly bit set
Access is denied. There is no audit privilege
Access is denied. Enforce DOS bits blocks the access
Access is denied. Hidden attribute is set
Access is denied by an inherited ACE
2621
Access is denied as the volume is readonly or directory is a snapshot

Access is denied. System attribute is not set in the request
Access is denied by the storage-level access guard (SLAG)
Access is denied, file is infected
Access is denied. Central access policy DB not ready
Access is denied. Central access rule is corrupt
Access is denied. Central access rule explicitly denied access
Access is denied. Matching central access policy not found
The command or the location at which access was denied or allowed are as follows:
while traversing the directory.
while truncating the file.
while creating the directory.
while creating the file.
while checking parent's mode bits during delete.
while deleting the child.
while checking for child-delete access on the parent.
while reading security descriptor.
while accessing the link.
while creating the directory.
while creating or writing the file.
while opening existing file or directory.
while setting the attributes.
while traversing the directory.
while reading the file.
while reading the directory.
while deleting the target during rename.
while deleting the child during rename.
while writing data in the parent during rename.
2622
while adding a directory during rename.

while adding a file during rename.
while updating the target directory during rename.
while setting attributes.
while writing to the file.
while extending the coral file.
while creating the vdisk file.
while checking for stale locks before open.
while deleting a file or a directory.
while truncating a hidden file.
while truncating a file.
while truncating a system file.
while appending to a file or setting a file attribute.
while opening a file or directory for delete.
while checking for permission on parent directory during create.
The access rights for which the file operation is allowed or denied are as follows:
Append.
Delete.
Delete Child.
Execute.
Generic All.
Generic Execute.
Generic Read.
Generic Write.
Maximum Allowed.
Read.
Read Attributes.
Read Control.
2623
Read EA.
System Security.
Synchronize.
Write.
Write Attributes.
Write DAC.
Write EA.
Write Owner.
None.
Examples
The following example displays information about security trace records:
cluster1::> vserver security trace trace-result show
Vserver: vserver_1
Node
Index
Filter Details
Reason
----------------------- -------- --------------------- ------------------------cluster1-01
User: cifs1\
Access is allowed because
administrator
CIFS implicit permission

grants requested access
while opening existing
file or directory.
Access is granted for:
"Read Attributes"
Security Style: MIXED

and NT ACL
Path: /stk/bit
cluster1-01
User: cifs1\
administrator
explicit ACE grants

requested access while
opening existing file
or directory.
"Read Control", "Read
Attributes",
"Read EA", "Read"
2624

and NT ACL
Path: /stk/bit
The following example displays information about security trace records for path /stk/bit/
set:
cluster1::> vserver security trace trace-result show -path /stk/bit/set
Vserver: vserver_1
Node
Index
Filter Details
Reason
----------------------- -------- --------------------- ------------------------cluster1-01
User: cifs1\
administrator
the user has UNIX root

privileges while opening
existing file or
directory.
"Read"
and UNIX permissions
Path: /stk/bit/set
cluster1-01
User: cifs1\
Access is denied. The
administrator
requested permissions
are not granted by the
ACE while checking for
child-delete access on
the parent. Access is not
granted for: "Delete
Child"
and NT ACL
Path: /stk/bit/set
cluster1-01
User: cifs1\
administrator
the CIFS user is owner.

Access is denied by an
explicit ACE while
setting the attributes.
Access is not granted for:
2625
"Read Attributes"
and NT ACL
Path: /stk/bit/set
cluster1-01
User: cifs1\
administrator
inherited ACE grants

requested access. Access
is
denied. Central access
rule
explicitly denied access
while opening existing
file
or directory. Access is
not
granted for:
"Synchronize",
"Read"
Security Style: NTFS
and NT ACL
Path: /stk/bit/set
cluster1-01
User: cifs1\
administrator
explicit ACE grants
requested
access, storage-level
access
guard (SLAG) grants
requested
access . Access is denied.
Central access policy DB
not
ready while opening
existing
file or directory. Access
is
not granted for:
"Synchronize", "Read
Attributes", "Execute"
Security Style: NTFS
and NT ACL
Path: /stk/bit/set
2626
See Also
vserver security trace filter create
2627
vserver services name-service dns clear-statistics

Clear DNS statistics information
Description
The vserver services name-service dns clear-statistics command
clears all previously gathered DNS statistics on a specified node for the specified
Vserver and name server.
Parameters
This parameter specifies the node for which you want to clear DNS statistics.
This parameter specifies the Vserver for which you want to clear DNS statistics.
-name-server <IP Address> - Name Server
This parameter specifies the name server for which you want to clear DNS statistics.
Examples
The following example clears DNS statistics for Vserver vs1 and name server
192.0.2.2 on node node1.
cluster1::*> vserver services name-service dns show-statistics -node
node1
Note: The statistics below apply only to DNS queries made during data
access.
Node: node1
Average Round-Trip
2628
Vserver
Name Server
Time (ms)
Queries
Errors
---------
------------
------------------
-------
-------
vs1
192.0.2.2
65
11
vs2
192.0.2.3
39

cluster1::*> vserver services name-service dns clear-statistics -node
node1 -vserver vs1 -name-server 192.0.2.2
cluster1::*>
node1
access.
Node: node1
Average Round-Trip
Vserver
Name Server
Time (ms)
Queries
Errors
---------
------------
------------------
-------
-------
vs1
192.0.2.2
vs2
192.0.2.3
39
2629
vserver services name-service dns create

Create a new DNS table entry
Description
The vserver services name-service dns create command creates new
DNS server mappings. DNS servers provide remote connection information, such as IP
addresses, based on domain and system names.
Parameters
Use this parameter to specify the Vserver on which to create the new DNS server
mapping.
-domains <text>, ... - Domains
Use this parameter to specify the domains of the Vserver. Separate multiple domains
with commas.
[-name-servers <IP Address>, ...] - Name Servers
Use this parameter to specify the IP addresses of the DNS servers that provide name
service for the domains in this DNS server mapping. Separate multiple addresses with
commas.
[-state {enabled|disabled}] - Enable/Disable DNS
Use this parameter with the value enabled to specify that the DNS server mapping is
active when it is created. Use this parameter with the value disabled to specify that
the DNS server mapping is not active.
[-timeout <integer>] - Timeout (secs)
Use this parameter to specify a timeout value (in seconds) for queries to the name
servers. The default value is 2 seconds.
[-attempts <integer>] - Maximum Attempts
Use this parameter to specify the number of attempts the Vserver should make when
querying the DNS name servers. The default value is 1 attempt.
2630
Examples
This example creates a new DNS server mapping for the Vserver vs0 in the domain
example.com, specifying that 192.168.0.16 and 192.168.0.24 are the name servers for
this domain.
cluster1::> vserver services name-service dns create -vserver vs0 -domains
example.com -name-servers 192.168.0.16,192.168.0.24
vserver services name-service dns delete

Remove a DNS table entry
Description
The vserver services name-service dns delete command removes the DNS
server mapping from a Vserver.
Deleting a DNS server mapping removes it permanently. If you delete a DNS server
mapping, commands or jobs that do not use IP addresses do not succeed. To disable a
DNS server mapping without deleting it, use the vserver services name-service
dns modify command with the -state disabled parameter.
Parameters
Use this parameter to specify the Vserver whose DNS server mapping is deleted.
Examples
This example removes the DNS server mapping from the Vserver node1.
cluster1::> vserver services name-service dns delete -vserver vs0
See Also
vserver services name-service dns modify
2631
vserver services name-service dns modify

Change a DNS table entry
Description
Use the vserver services name-service dns modify command to modify an
existing DNS server mapping.
Use the -state disabled parameter to disable a DNS server mapping without
deleting it. To permanently remove a mapping, use the vserver services nameservice dns delete command.
Parameters
Use this parameter to specify the Vserver whose DNS mapping is modified.
[-domains <text>, ...] - Domains
Use this parameter to specify a domain for the Vserver.
Use this parameter to specify the IP addresses of the DNS name servers for this
Vserver.
Use this parameter with the value enabled to specify that the DNS server mapping
is active. Use this parameter with the value disabled to specify that the DNS server
mapping is not active.
Use this parameter to specify a timeout value (in seconds) for queries to the DNS
servers.
Use this parameter to specify the number of times to attempt queries to the DNS
servers.
2632
Examples
This example modifies the DNS server mapping for the domain example.com on the
Vserver vs0, specifying that 10.0.0.1 and 10.0.0.2 are the name servers for this domain.
cluster1::> vserver services name-service dns modify -vserver vs0 -domains
example.com -name-servers 10.0.0.1,10.0.0.2
The following example disables the DNS mapping for example.com on a Vserver named
vs1:
cluster1::> vserver services name-service dns modify -vserver vs1 -domains
example.com -state disabled
See Also
vserver services name-service dns delete
2633
vserver services name-service dns show-statistics

Display DNS statistics information
Description
The vserver services name-service dns show-statistics command
displays information about DNS statistics on the nodes in a cluster. Currently, these
statistics apply only to DNS queries made during data access. You can view the
following information using this command:
Minimum, maximum, total, and average time taken for a DNS query during data
access
Number of DNS queries made during data access
Number of DNS host not found in the server
Number of DNS queries timed out waiting for reply for server
Number of DNS queries made during data access which resulted in errors
Use this command only as directed by support personnel to help analyze performance
and diagnose problems.
Parameters
specify.
| [-instance ] }
about all fields.
node.
2634
Vserver.
[-name-server <IP Address>] - Name Server
If you specify this parameter, the command displays information only about the node or
nodes that are configured to use the specified name server.
[-avg-rtt <Counter64>] - Average Round Trip Time in DNS Lookups During Data Access
nodes that have the specified average round-trip time (in microseconds) for a successful
DNS query during data access.
[-min-rtt <Counter64>] - Minimum Time Spent in DNS Lookups During Data Access
or nodes that have the specified minimum round-trip time (in microseconds) for a
successful DNS query during data access.
[-max-rtt <Counter64>] - Maximum Time Spent in DNS Lookups During Data Access
or nodes that have the specified maximum round-trip time (in microseconds) for a
successful DNS query during data access.
[-total-rtt <Counter64>] - Total Time Spent in DNS Lookups During Data Access
or nodes that have the specified total round-trip time (in seconds) for a successful DNS
query during data access.
[-queries <Counter64>] - Number of Queries Made During Data Access
nodes that have the specified number of DNS queries made during data access.
[-host-not-found <Counter64>] - Number of Hosts Not Found While Making DNS
queries
nodes that have the specified number of DNS hosts not found in the DNS server made
during data access.
[-timed-out <Counter64>] - Number of DNS Queries Timed Out
nodes that have the specified number of DNS queries that timed out while waiting for
response from DNS server during data access.
[-errors <Counter64>] - Number of Errors Returned During Data Access
2635
nodes that have the specified number of DNS queries made during data access which
resulted in errors.
Examples
The following example displays DNS statistics for a node node1 where the average
round trip time for a successful DNS query is between 300 and 400 microseconds:
node1 -avg-rtt 300..400
access.
Node: node1
Name
Host
Average
Minimum
Maximum
Total
Num
Vserver Server
Out Errors
RTT (us)
RTT (us)
RTT (us)
RTT(s)
Queries
------- ---------- ------
--------
--------
--------
------
-------
300
400
Timed
Found
---------
Num
vs1
192.0.2.2
350
Not
The following example displays DNS statistics for a node node1 where the result
contains at least 1 DNS query resulting in error:
cluster1::*> dns info -node node1 -errors >=1
access.
Node: node1
Name
Host
Average
Minimum
Maximum
Total
Vserver Server
Out Errors
RTT (us)
RTT (us)
RTT (us)
RTT(s)
Queries
------- ---------- ------
--------
--------
--------
------
-------
460
581
Timed
Found
---------
vs1
2636
Not
192.0.2.2
511
Num
Num
2637
vserver services name-service dns show

Display DNS configuration
Description
The vserver services name-service dns show command displays information
about DNS server mappings. DNS servers provide remote connection information, such
as IP addresses, based on domain and system names.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display information only about the DNS server mapping of the
Vservers you specify.
[-domains <text>, ...] - Domains
Use this parameter to display information only about the DNS server mappings for
Vservers in the domains you specify.
Use this parameter to display information only about DNS server mappings that use the
DNS name servers you specify.
Use this parameter with the value enabled to display information only about the DNS
server mappings that are active. Use this parameter with the value disabled to display
information only about the DNS server mappings that are not active.
2638

Use this parameter to display information only about DNS server mappings that have
the timeout value you specify.
Use this parameter to display information only about DNS server mappings that make
the maximum number of attempts you specify.
Examples
The following example shows typical output from the command. Note that cluster1 uses
different name servers for example.com.
cluster1::> vserver services name-service dns show
Name
Vserver
State
Domains
Servers
--------------- --------- ----------------------------------- ---------------node1
enabled
example.com
node2
enabled
example.com, example2.com
cluster1
enabled
example.com, example2.com
10.0.0.1,
10.0.0.2
10.0.0.1,
10.0.0.2
192.168.0.1,
192.168.0.2
2639
vserver services name-service dns hosts create

Create a new host table entry
Description
Use the vserver services name-service dns hosts create command to
create new DNS host table entries. These entries map hostnames to IP addresses.
Parameters
Use this parameter to specify the Vserver on which the host table entry will be created.
Use this parameter to specify the IP address of the new host table entry.
-hostname <text> - Canonical Hostname
Use this parameter to specify the full hostname for the new host table entry.
[-aliases <text>, ...] - Aliases
Use this parameter to specify any aliases to include in the new host table entry.
Separate multiple aliases with commas.
Examples
This example creates a new DNS host table entry for 10.0.0.17 on the vserver vs1, with
the hostname test.example.com and the alias test.
cluster1::> vserver services name-service dns hosts create -vserver vs1 -address
10.0.0.17 -hostname test.example.com -aliases test
vserver services name-service dns hosts delete

Remove a host table entry
2640
Description
Use the vserver services name-service dns hosts delete command to
delete DNS host table entries.
Parameters
Use this parameter to specify the Vserver whose host table entry will be deleted.
Use this parameter to specify the IP address of the host table entry to delete.
Examples
This example removes the DNS host table entry of 10.0.0.15 from the host table of the
vserver vs1.
cluster1::> vserver services name-service dns hosts delete -vserver vs1 -address
10.0.0.16
1 entry was deleted.
vserver services name-service dns hosts modify

Modify hostname or aliases
Description
Use the vserver services name-service dns hosts modify command to
modify existing DNS host table entries.
Parameters
Use this parameter to specify the Vserver whose host table will be modified.
2641
Use this parameter to specify the IP address of the host table entry to modify.
[-hostname <text>] - Canonical Hostname
Use this parameter to specify a full hostname for the host table entry.
Use this parameter to specify alternate hostnames for the host table entry.
Examples
This example changes the host table of vserver vs1 so that the hostname stored in the
host table entry for 10.0.0.57 is pgh.example.com.
cluster1::> vserver services name-service dns hosts modify -vserver -vs1 -address
10.0.0.57 -hostname pgh.example.com
1 entry was modified.
This example changes the host table of vserver vs1 to store the name loghost as an
alternate hostname for IP address 10.0.0.5.
cluster1::> vserver services name-service dns hosts modify -vserver vs1 -address
10.0.0.5 -aliases loghost
1 entry was modified.
vserver services name-service dns hosts show

Display IP address to hostname mappings
Description
Use the vserver services name-service dns hosts show command to
display Domain Name System (DNS) host table entries. These entries map hostnames
to IP addresses. Entries may also include alternate hostnames, known as aliases. Host
table entries enable you to refer to other Internet hosts by a memorable name instead
of by a numeric IP address. This host table is similar to the /etc/hosts file found on most
UNIX style systems.
Parameters
2642
specify.
| [-instance ] }
about all fields.
Use this parameter to display information only about host table entries on the Vservers
you specify.
Use this parameter to display information only about host table entries that match the IP
addresses you specify.
[-hostname <text>] - Canonical Hostname
Use this parameter to display information only about host table entries that match the
hostnames you specify.
Use this parameter to display information only about host table entries that include the
alternate hostnames you specify.
Examples
The following example shows a typical host table.
cluster1::> vserver services name-service dns hosts show
Vserver
Address
Hostname
Aliases
---------- -------------- --------------- ---------------------vs1
10.0.0.10
mail.example.com
vs1
10.0.0.15
ftp.example.com ftp
vs1
10.0.0.16
www.example.com www
vs2
10.0.0.10
mail.example.com
vs2
10.0.0.15
ftp.example.com ftp
vs2
10.0.0.16
www.example.com www
vs2
10.0.0.17
test.example.com
mail, mailhost, snmp
mail, mailhost, snmp
2643
vserver services name-service getxxbyyy

getaddrinfo
Gets the IP address information by using the host name.
privilege level.
Description
The vserver services name-service getxxbyyy getaddrinfo gets the IP
address information by using the host name for a given Vserver. The underlying service
for doing the lookup is selected based on the configured name service switch order.
Parameters
Use this parameter to specify the node where the lookup will be performed
Use this parameter to specify the Vserver where the lookup will be performed
-hostname <text> - Host Name
Use this parameter to specify the Host Name for which the IP address information is
needed
[-address-family {ipv4|ipv6|all}] - Return Addresses for Family
Use this parameter to specify the Address Family for which the IP address information is
needed
[-show-source {true|false}] - Show Source used for Lookup
Use this parameter to specify if source used for lookup needs to be displayed
Examples
The following example requests address information for localhost
cluster1::*> vserver services name-service getxxbyyy getaddrinfo -node
cluster1-01 -vserver vs1 -hostname localhost -address-family all -show-source
true
Source used for Lookup: Files
Host name: localhost
2644
Canonical name: localhost

IPv4 : 127.0.0.1
IPv6 : ::1
2645

getgrbygid
Gets the group members by using the group identifier or GID.
privilege level.
Description
The vserver services name-service getxxbyyy getgrbygid gets the
group members by using the group identifier or GID for a given Vserver. The underlying
service for doing the lookup is selected based on the configured name service switch
order.
Parameters
-groupID <integer> - Group ID
Use this parameter to specify the GroupID for which the members are requested
[-show-source {true|false}] - Source used for Lookup
Examples
The following example requests group information for the given groupid
cluster1::*> vserver services name-service getxxbyyy getgrbygid -node
cluster1-01 -vserver vs1 -groupID 1
name: daemon
gid: 1
2646

getgrbyname
Gets the group members by using the group name.
privilege level.
Description
The vserver services name-service getxxbyyy getgrbyname gets the
group members by using the group name.
Parameters
-groupname <text> - Group Name
Use this parameter to specify the Group Name for which the members are requested
Examples
The following example requests group information for the given group name
cluster1::*> vserver services name-service getxxbyyy getgrbyname node cluster1-01 -vserver vs1 -groupname daemon -show-source false
name: daemon
gid: 1
2647
vserver services name-service getxxbyyy getgrlist

Gets the group list by using the user name.
privilege level.
Description
The vserver services name-service getxxbyyy getgrlist gets the list of
groups to which user belongs. This command will go through all the sources configured
for the group database in the name servers ns-switch configuration.
Parameters
Use this parameter to retrieve the list of groups where the given user is a member
Using this parameter as true, source is always displayed as Unknown.
Examples
The following example requests the grouplist for the given username
cluster1::*> vserver services name-service getxxbyyy getgrlist -node
cluster1-01 -vserver vs1 -username root -show-source false
pw_name: root
Groups: 5
2648

gethostbyaddr
Gets the host information from the IP address.
privilege level.
Description
The vserver services name-service getxxbyyy gethostbyaddr gets the
host name by using the IP address. The underlying service for doing the lookup is
selected based on the configured name service switch order.
Parameters
-ipaddress <IP Address> - IP Address
Use this parameter to specify the IPv4/IPv6 address for which the host information is
needed
Examples
The following example requests host information for the given IP address
cluster1::*> vserver services name-service getxxbyyy gethostbyaddr -node
cluster1-01 -vserver vs1 -ipaddress 127.0.0.1 -show-source false
IP address: 127.0.0.1
2649

gethostbyname
Gets the IP address information from host name.
privilege level.
Description
The vserver services name-service getxxbyyy gethostbyname gets the IP
address by using the host name. The underlying service for doing the lookup is selected
based on the configured name service switch order. When the look up happens from
the hosts file, only the first IP address is returned for a host configured with multiple IP
addresses.
Parameters
Node Use this parameter to specify the node where the lookup will be performed
Vserver Name Use this parameter to specify the Vserver where the lookup will be
performed
-hostname <text> - Host Name
Use this parameter to specify the Hostname for which the IP address information is
requested
Examples
The following example requests IP Address information from the given hostname
cluster1::*> vserver services name-service getxxbyyy gethostbyname -node
cluster1-01 -vserver vs1 -hostname localhost -show-source false
Canonical name: localhost
IPv4: 127.0.0.1
2650
2651

getnameinfo
Gets the name information by using the IP address.
privilege level.
Description
The vserver services name-service getxxbyyy getnameinfo gets the host
and service by using the socket address. The underlying service for doing the lookup is
Parameters
-ipaddress <IP Address> - IP Address
Use this parameter to specify IPv4/IPv6 address for which the name information is
requested
Examples
The following example gets the name information for the given IP Address
cluster1::*> vserver services name-service getxxbyyy getnameinfo node cluster1-01 -vserver vs1 -ipaddress 127.0.0.1 -show-source false
IP address: 127.0.0.1
2652

getpwbyname
Gets the password entry by using the user name.
privilege level.
Description
The vserver services name-service getxxbyyy getpwbyname gets the
password entry by using the user name. The underlying service for doing the lookup is
Parameters
Use this parameter to specify the Username for which the password entry is requested
Examples
The following example requests password entry from the given username
cluster1::*> vserver services name-service getxxbyyy getpwbyname -node
cluster1-01 -vserver vs1 -username vsadmin -show-source true -use-rbac false
Source used for lookup: Files
pw_name: daemon
pw_passwd: *
pw_uid: 1, pw_gid: 1
pw_gecos: Owner of many system processes
pw_dir: /root
pw_shell: /usr/sbin/nologin
2653
2654

getpwbyuid
Gets the password entry by using the user identifier or UID.
privilege level.
Description
The vserver services name-service getxxbyyy getpwbyuid gets the
password entry by using the user identifier or UID. The underlying service for doing the
lookup is selected based on the configured name service switch order.
Parameters
-userID <integer> - User ID
Use this parameter to specify the UserID for whom the password entry is requested
Examples
The following example requests password entry by using the user id
cluster1::*> vserver services name-service getxxbyyy getpwbyuid
node cluster1-01 -vserver vs1 -userID 1001 -show-source true -use-rbac true
Source used for Lookup: Files

pw_name: vsadmin
pw_passwd: $1$f7b22f68$KihT1ptYqpEjcM4jfE60f0
pw_uid: 1001
pw_gid: 65533
pw_gecos: User
pw_dir: /var/home/vsadmin
2655
pw_shell: /sbin/ngsh
2656
vserver services name-service getxxbyyy netgrp

Checks if a client is part of a netgroup.
privilege level.
Description
The vserver services name-service getxxbyyy netgrp checks if a client is
part of a netgroup. The underlying service for doing the lookup is selected based on the
configured name service switch order.
Parameters
-netgroup <text> - Netgroup Name
Use this parameter to specify the Netgroup name
-client <text> - Client Name
Use this parameter to specify the Client name for which the membership in a given
netgroup needs to be checked
Examples
The following example checks if the given client is part of the given netgroup:
cluster1::*> vserver services name-service getxxbyyy netgrp -node
cluster1-01 -vserver vs1 -netgroup net1 -client h1 -show-source false
h1 is a member of net1
2657

netgrpbyhost
Check if a client is part of a netgroup using netgroup-by-host query
privilege level.
Description
The vserver services name-service getxxbyyy netgrpbyhost command
checks whether a client is part of a netgroup using the netgroup.byhost map. The
underlying service for doing the lookup is selected based on the configured name
service switch order.
Parameters
Use this parameter to specify the node where the lookup will be performed.
Use this parameter to specify the Vserver where the lookup will be performed.
-netgroup <text> - Netgroup Name
Use this parameter to specify the netgroup name.
-clientIP <IP Address> - Client IP Address
Use this parameter to specify the client IPv4/IPv6 address for which you want to check
the membership in a given netgroup.
[-enable-domain-search-flag {true|false}] - Use DNS domain
Use this parameter to specify whether you want to perform shortname host lookups in
case the configured DNS search domains match the domain returned by the reverse
lookup.
[-show-source {true|false}] - Source Used for Lookup
Use this parameter to specify whether you want to display the source used for the
lookup.
Examples
2658
The following example checks whether the given client IP address is a member of the
given netgroup:
cluster1::*> vserver services name-service getxxbyyy netgrpbyhost
-node node1 -vserver vs1 -netgroup ng1 -clientIP 10.10.10.90
Hostname resolved to: dnshost.example.com
Success
2659
vserver services name-service ldap create

Create an LDAP configuration
Description
The vserver services name-service ldap create command associates an
LDAP client configuration with a Vserver.
Parameters
This parameter specifies the Vserver with which you want to associate the LDAP client
configuration.
-client-config <text> - LDAP Client Configuration
This parameter specifies the name of the LDAP client configuration, defined under
vserver services name-service ldap client, that you want to associate with
the Vserver.
-client-enabled {true|false} - LDAP Client Enabled
This parameter specifies whether the Vserver can use the LDAP configuration.
Note:
You must also include the 'ldap' method in the Vserver's -ns-switch and/or -nmswitch parameters before a Vserver uses an enabled LDAP configuration.
Examples
The following example associates the LDAP client configuration "corp" with the Vserver
"vs1":
cluster1::> vserver services name-service ldap create -vserver vs1 -client-config
corp
See Also
vserver services name-service ldap client
2660
vserver services name-service ldap delete

Delete an LDAP configuration
Description
The vserver services name-service ldap delete command removes the
LDAP configuration, which is an LDAP client configuration's association with a Vserver.
Note:
Make sure that you remove 'ldap' from the Vserver's -ns-switch and -nm-switch
parameters and test connectivity before deleting a working LDAP configuration.
Parameters
This parameter specifies the Vserver from which you want to disassociate the LDAP
client configuration.
Examples
The following example disassociates the current LDAP client configuration from Vserver
"vs1".
cluster1::> vserver services name-service ldap delete -vserver vs1
vserver services name-service ldap modify

Modify an LDAP configuration
Description
The vserver services name-service ldap modify command modifies an
LDAP client configuration's association with a Vserver.
2661
Note:
Make sure that you remove 'ldap' from the Vserver's -ns-switch and -nm-switch
configurations and test connectivity before disabling a working LDAP configuration.
Parameters
This parameter specifies the Vserver with which you want to associate the LDAP client
configuration.
[-client-config <text>] - LDAP Client Configuration
This parameter specifies the name of the LDAP client configuration, defined under
vserver services name-service ldap client, that you want to associate with
the Vserver.
[-client-enabled {true|false}] - LDAP Client Enabled
This parameter specifies whether the Vserver can use the LDAP configuration.
Note:
You must also include the 'ldap' method in the Vserver's -ns-switch and/or -nmswitch parameters before a Vserver uses an enabled LDAP configuration.
Examples
The following example modifies the LDAP client configuration used by Vserver "vs1" to
"corpnew":
cluster1::> vserver services name-service ldap modify -vserver vs1 -client-config
corpnew
See Also
vserver services name-service ldap client
2662
vserver services name-service ldap show

Display LDAP configurations
Description
The vserver services name-service ldap show command displays
information about LDAP configurations.
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays information about the LDAP
configuration on the specified Vserver.
[-client-config <text>] - LDAP Client Configuration
If you specify this parameter, the command displays information about LDAP
configurations using the specified client.
[-client-enabled {true|false}] - LDAP Client Enabled
If you specify this parameter, the command displays information about LDAP
configurations with the matching client state.
Examples
The following example shows the LDAP configuration for Vserver "vs1":
cluster1::> vserver services name-service ldap show -vserver vs1
Client
Vserver
Client
Configuration Enabled
2663
-------------- ------------- ------vs1
2664
corp
true
vserver services name-service ldap client create

Create an LDAP client configuration
Description
The vserver services name-service ldap client create command creates
an LDAP client configuration. A client configuration is associated with a Vserver using
the vserver services name-service ldap commands.
Parameters
This parameter specifies the Vserver for which configuration is created.
-client-config <text> - Client Configuration Name
This parameter specifies the name that you would like to use to refer to the new LDAP
client configuration.
{ -servers <IP Address>, ... - LDAP Server List
This parameter specifies the list of LDAP servers used when making LDAP connections
using this client configuration. If you specify this parameter, you cannot specify the -addomain, -preferred-ad-servers or -bind-as-cifs-server parameters.
| -ad-domain <TextNoCase> - Active Directory Domain
This parameter specifies the name of the Active Directory domain used to discover
LDAP servers for use by this client. This assumes that the Active Directory schema
has been extended to act as a NIS replacement. If you use this parameter, you cannot
specify the -servers parameter. However, you can specify a list of preferred servers
using the -preferred-ad-servers parameter.
[-preferred-ad-servers <IP Address>, ...] - Preferred Active Directory Servers
This parameter specifies a list of LDAP servers that are preferred over those that are
discovered in the domain specified in the -ad-domain parameter.
[-bind-as-cifs-server {true|false}] } - Bind Using the Vserver's CIFS Credentials
2665
This parameter specifies whether or not LDAP binds made using this client configuration
use the Vserver's CIFS server credentials. If you do not specify this parameter, the
default is false.
-schema <text> - Schema Template
This parameter specifies the name of the schema template the Vserver uses when
making LDAP queries. You can view and modify the templates using the vserver
services name-service ldap client schema commands.
[-port <integer>] - LDAP Server Port
This parameter specifies the port that the LDAP client uses to connect to LDAP servers.
If you do not specify this parameter, the default is port 389.
[-query-timeout <integer>] - Query Timeout (sec)
This parameter specifies the amount of time (in seconds) that the LDAP client waits for
a query to complete. If you do not specify this parameter, the default is 3 seconds.
[-min-bind-level {anonymous|simple|sasl}] - Minimum Bind Authentication Level
This parameter specifies the lowest acceptable level of security the LDAP client
uses to bind to an LDAP server. If you do not specify this parameter, the default is an
anonymous bind.
[-bind-dn <ldap_dn>] - Bind DN (User)
This parameter specifies the user that binds to the LDAP servers. For Active
Directory servers, specify the user in the account (DOMAIN\user) or principal
(user@domain.com) form. Otherwise, specify the user in distinguished name
(CN=user,DC=domain,DC=com) form. This parameter is ignored if -bind-as-cifsserver is set.
[-base-dn <ldap_dn>] - Base DN
This parameter specifies the default base DN for all searches, including user, group,
and netgroup searches. For example, "DC=example,DC=com". If you do not specify this
parameter, the default is the root, specified by an empty ("") set.
[-base-scope {base|onelevel|subtree}] - Base Search Scope
This parameter specifies the default search scope for LDAP queries. Specify base to
search just the named entry, onelevel to search entries immediately below the DN, or
subtree to search the named DN entry and the entire subtree below the DN. If you do
not specify this parameter, the scope is set to subtree by default.
[-user-dn <ldap_dn>] - User DN (privilege: advanced)
This parameter specifies the user DN, which overrides the base DN for user lookups.
2666
Note:
To specify multiple DNs, separate multiple DN entries with semicolons (;). If you
configure multiple user or group DNs and a DN contains a semicolon, add an escape
character (\) immediately before the semicolon or enclose the entire DN with quotation
marks (").
[-user-scope {base|onelevel|subtree}] - User Search Scope (privilege: advanced)
This parameter specifies the user search scope. If you do not specify this parameter, the
scope is set to subtree by default.
[-group-dn <ldap_dn>] - Group DN (privilege: advanced)
This parameter specifies the group DN, which overrides the base DN for group lookups.
Note:
marks (").
[-group-scope {base|onelevel|subtree}] - Group Search Scope (privilege: advanced)
This parameter specifies the group search scope. If you do not specify this parameter,
the scope is set to subtree by default.
[-netgroup-dn <ldap_dn>] - Netgroup DN (privilege: advanced)
This parameter specifies the netgroup DN, which overrides the base DN netgroup
lookups.
Note:
configure multiple netgroup DNs and a DN contains a semicolon, add an escape
marks (").
[-netgroup-scope {base|onelevel|subtree}] - Netgroup Search Scope (privilege:
advanced)
This parameter specifies the netgroup search scope. If you do not specify this
parameter, the scope is set to subtree by default.
[-use-start-tls {true|false}] - Use start-tls Over LDAP Connections
2667
This parameter specifies whether or not to use Start TLS over LDAP connections. When
enabled, the communication between the Data ONTAP LDAP Client and the LDAP
Server will be encrypted using Start TLS. Start TLS is a mechanism to provide secure
communication by using the TLS/SSL protocols. If you do not specify this parameter, the
default is false.
[-allow-ssl {true|false}] - Allow SSL for the TLS Handshake Protocol
This parameter specifies whether or not to use SSL in the TLS handshake protocol. The
default value is false. Note: SSL is an older and less secure protocol; use with caution.
[-is-netgroup-byhost-enabled {true|false}] - Enable Netgroup-By-Host Lookup
Use this parameter to enable or disable netgroup-by-host lookup. If your LDAP directory
contains map structures equivalent to the netgroup.byhost map in NIS, enabling this
feature greatly speeds up netgroup resolution queries over LDAP. By default this
parameter is set to false.
[-netgroup-byhost-dn <ldap_dn>] - Netgroup-By-Host DN (privilege: advanced)
This parameter specifies the netgroup-by-host DN, which overrides the base DN for
netgroup-by-host lookups.
Note:
marks (").
[-netgroup-byhost-scope {base|onelevel|subtree}] - Netgroup-By-Host Scope
This parameter specifies the netgroup-by-host search scope for LDAP queries. If you do
Examples
The following example creates an LDAP client configuration named corp that makes
anonymous binds to 172.160.0.100 and 172.16.0.101 for Vserver vs1:
cluster1::> vserver services name-service ldap client create -vserver vs1 client-config corp -servers 172.16.0.100,172.16.0.101
The following example creates an LDAP client configuration named corp that makes
binds to 172.160.0.100 and 172.16.0.101 for Vserver vs1 for bind-dn diag:
2668
cluster1::> vserver services name-service ldap client create -vserver vs1 client-config corp -servers 172.16.0.100,172.16.0.101 -bind-dn diag
Confirm password:
The following example creates an LDAP client configuration with multiple user DNs.
cluster1::> vserver services ldap client create -vserver vs1 -client-config
corp -servers 172.16.0.100,172.16.0.101
-user-dn "ou=People,dc=mypc,dc=example,dc=com;
ou=People1,dc=mypc1,dc=example2,dc=com"
The following example creates an LDAP client configuration with multiple user DNs, one
of them containing a semicolon
corp -servers 172.16.0.100,172.16.0.101
-user-dn "ou=People,dc=mypc,dc=example,dc=com;
The following example creates an LDAP client configuration with multiple user DNs, one
of them containing a semicolon and a backslash.
corp -servers 172.16.0.100,172.16.0.101
-user-dn "ou=People\;,dc=mypc,dc=example,dc=com\\;
The following example creates an LDAP client configuration with netgroup by host DN.
cluster1::*>vserver services ldap client create -vserver vs1 -client-config
corp -servers 172.16.0.100,172.16.0.101
-netgroup-byhost-dn nisMapName="netgroup.byhost",dc=rfcbis,dc=com
See Also
vserver services name-service ldap client schema vserver services nameservice ldap
2669
vserver services name-service ldap client delete

Delete an LDAP client configuration
Description
The vserver services name-service ldap client delete command deletes
an LDAP client configuration. A Vserver administrator can only delete configurations
owned by the Vserver.
Parameters
This parameter specifies the name of the Vserver which owns the LDAP client you want
to delete.
This parameter specifies the name of the LDAP client configuration you want to delete.
Examples
The following example deletes an LDAP client configuration named corp owned by
Vserver vs1:
cluster1::> vserver services name-service ldap client delete -vserver vs1 client-config corp
vserver services name-service ldap client modifybind-password

Modify Bind Password of an LDAP client configuration
Description
2670
The vserver services name-service ldap client modify-bindpassword command modifies bind-password of a given LDAP client configuration.
Parameters
to modify.
This parameter specifies the name of the LDAP client configuration.
Examples
The following example modifies the password for a given LDAP client configuration
cluster1::> vserver services name-service ldap client modify-bindpassword -client-config corp
Confirm password:
vserver services name-service ldap client modify

Modify an LDAP client configuration
Description
The vserver services name-service ldap client modify command
modifies an LDAP client configuration. A Vserver administrator can modify only
configurations owned by the Vserver.
Parameters
to modify.
2671
This parameter specifies the name of the LDAP client configuration.

{ [-servers <IP Address>, ...] - LDAP Server List
This parameter specifies the list of LDAP servers used when making LDAP connections
using this client configuration. If you specify this parameter, you cannot specify the -addomain, -preferred-ad-servers or -bind-as-cifs-server parameters.
| [-ad-domain <TextNoCase>] - Active Directory Domain
This parameter specifies the name of the Active Directory domain used to discover
LDAP servers for use by this client. This assumes that the Active Directory schema
has been extended to act as a NIS replacement. If you use this parameter, you cannot
specify the -servers parameter. However, you can specify a list of preferred servers
using the -preferred-ad-servers parameter.
This parameter specifies a list of LDAP servers that are preferred over those that are
discovered in the domain specified in the -ad-domain parameter.
[-bind-as-cifs-server {true|false}] } - Bind Using the Vserver's CIFS Credentials
This parameter specifies whether or not LDAP binds made using this client configuration
use the Vserver's CIFS server credentials. If you do not specify this parameter, the
default is false.
[-schema <text>] - Schema Template
This parameter specifies the name of the schema template the Vserver uses when
making LDAP queries. You can view and modify the templates using the vserver
services name-service ldap client schema commands.
This parameter specifies the port that the LDAP client uses to connect to LDAP servers.
If you do not specify this parameter, the default is port 389.
This parameter specifies the amount of time (in seconds) that the LDAP client waits for
a query to complete. If you do not specify this parameter, the default is 3 seconds.
This parameter specifies the lowest acceptable level of security the LDAP client
uses to bind to an LDAP server. If you do not specify this parameter, the default is an
anonymous bind.
2672
This parameter specifies the user that binds to the LDAP servers. For Active
Directory servers, specify the user in the account (DOMAIN\user) or principal
(user@domain.com) form. Otherwise, specify the user in distinguished name
(CN=user,DC=domain,DC=com) form. This parameter is ignored if -bind-as-cifsserver is set.
This parameter specifies the default base DN for all searches, including user, group,
and netgroup searches. For example, "DC=example,DC=com". If you do not specify this
parameter, the default is the root, specified by an empty ("") set.
This parameter specifies the default search scope for LDAP queries. Specify base to
search just the named entry, onelevel to search entries immediately below the DN, or
subtree to search the named DN entry and the entire subtree below the DN. If you do
This parameter specifies the user DN, which overrides the base DN for user lookups.
Note:
marks (").
This parameter specifies the user search scope. If you do not specify this parameter, the
scope is set to subtree by default.
This parameter specifies the group DN, which overrides the base DN for group lookups.
Note:
marks (").
2673
This parameter specifies the group search scope. If you do not specify this parameter,
the scope is set to subtree by default.
This parameter specifies the netgroup DN, which overrides the base DN netgroup
lookups.
Note:
marks (").
advanced)
This parameter specifies the netgroup search scope. If you do not specify this
parameter, the scope is set to subtree by default.
default is false.
This parameter specifies whether or not to use SSL in the TLS handshake protocol. The
default value is false. Note: SSL is an older and less secure protocol; use with caution.
Use this parameter to enable or disable netgroup-by-host lookup. If your LDAP directory
contains map structures equivalent to the netgroup.byhost map in NIS, enabling this
feature greatly speeds up netgroup resolution over LDAP. By default this parameter is
set to false.
This parameter specifies the netgroup-by-host DN, which overrides the base DN for
netgroup-by-host lookups.
Note:
2674
marks (").
This parameter specifies the netgroup-by-host search scope for LDAP queries. If you do
Examples
The following example modifies an existing LDAP client configuration named corp
owned by Vserver vs1 to require simple binds using the administrator@example.com
account:
cluster1::> vserver services name-service ldap client modify -client-config corp
-vserver vs1 -bind-dn administrator@example.com
-min-bind-level simple
The following example modifies the user DN of an existing LDAP client configuration to
contain multiple DNs separated by a semicolon.
cluster1::> vserver services ldap client modify -client-config corp vserver vs1 -bind-dn administrator@example.com
-user-dn "ou=People,dc=mypc,dc=example,dc=in;
ou=People1,dc=mypc,dc=example2,dc=com" -min-bind-level simple
The following example demonstrates how you can use a semicolon as a valid character
in a DN instead of a separator.
-user-dn "ou=People\;,dc=mypc,dc=example,dc=com;
ou=People1,dc=mypc,dc=example2,dc=com"
The following example modifies an existing LDAP client configuration with multiple user
DNs, one of them containing a semicolon and a backslash.
-user-dn "ou=People\;,dc=mypc,dc=example,dc=com\\;
ou=People1,dc=mypc,dc=example2,dc=com"
2675
The following example modifies an existing LDAP client configuration with netgroup by
host DN.
cluster1::*>vserver services ldap client modify -vserver vs1 -clientconfig corp
-netgroup-byhost-dn nisMapName="netgroup.byhost",dc=rfcbis,dc=com
See Also
vserver services name-service ldap client schema
2676
vserver services name-service ldap client show

Display LDAP client configurations
Description
The vserver services name-service ldap client show command displays
information about LDAP client configurations which a Vserver can be associated
with. An LDAP client configuration created by a Vserver's administrator or by the
cluster administrator for the Vserver is owned by the Vserver. A cluster-wide LDAP
client configuration is created by a cluster administrator by specifying the admin
Vserver's name as a value to the -vserver parameter. In addition to its owned LDAP
client configurations, a Vserver can be associated with such cluster-wide LDAP client
configurations.
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays all LDAP client configurations that
can be associated with the specified Vserver.
[-client-config <text>] - Client Configuration Name
If you specify this parameter, the command displays information about the LDAP client
configuration you specify.
[-servers <IP Address>, ...] - LDAP Server List
If you specify this parameter, the command displays LDAP client configurations using
the specified list of servers.
2677
[-ad-domain <TextNoCase>] - Active Directory Domain

the specified domain to discover their list of LDAP servers.
the specified list of preferred servers.
[-bind-as-cifs-server {true|false}] - Bind Using the Vserver's CIFS Credentials
If you specify this parameter, the command displays LDAP client configurations that bind
using CIFS server credentials.
the specified schema.
the specified server port.
the specified query timeout (in seconds).
the specified minimum bind level.
the specified bind DN.
the specified base DN.
the specified base search scope.
2678
the specified user DN.
the specified user search scope.
the specified group DN.
the specified group search scope.
the specified netgroup DN.
advanced)
the specified netgroup search scope.
[-is-owner {true|false}] - Vserver Owns Configuration
If you set this parameter to true, the command displays LDAP client configurations with
the Vservers which own them.
default is false.
If you set this parameter to true, the command displays LDAP client configurations
where SSL is allowed in the TLS handshake protocol. If set to false, the command
displays LDAP client configurations where SSL is not allowed in the TLS handshake
protocol.
2679
If you set this parameter to true, the command displays LDAP client configurations for
which netgroup-by-host lookup is enabled.
the specified netgroup-by-host DN.
the specified netgroup-by-host search scope.
Examples
The following example shows a summary of all of the LDAP client configurations
available for Vserver vs1:
cluster1::> vserver services name-service ldap show -vserver vs1
Vserver
Client
Active Directory
Configuration LDAP Servers
Domain
Schema
Min Bind
Level
---------- ------------- ---------------- ---------------- -------------------------
2680
vs1
corp
172.16.0.100
RFC-2307
anonymous
vs1
corpnew
172.16.0.200
RFC-2307
simple

copy
Copy an existing LDAP schema template
Description
The vserver services name-service ldap client schema copy command
creates a new LDAP schema template from an existing one. In addition to an owned
LDAP schema template, a Vserver administrator can also copy a cluster-wide LDAP
schema template that is owned by the admin Vserver.
Parameters
This parameter specifies the Vserver for which you want to copy an existing LDAP
schema template.
This parameter specifies the name of the existing schema template you want to copy.
-new-schema-name <text> - New Schema Template Name
This parameter specifies the name of the schema template copy.
Examples
The following example creates a copy of the RFC-2307 schema template and names it
corp-schema for Vserver "vs1":
cluster1::> vserver services name-service ldap client schema copy -vserver vs1 schema RFC-2307 -new-schema-name corp-schema

delete
Delete an LDAP schema template
2681

Description
The vserver services name-service ldap client schema delete
command deletes an LDAP schema template. A Vserver administrator can only delete
templates owned by the Vserver.
Note:
You cannot delete the default schema templates.
Parameters
This parameter specifies the name of Vserver owning the LDAP schema template you
want to delete.
This parameter specifies the name of the schema template you want to delete.
Examples
The following example deletes a schema template named corp-schema owned by
Vserver vs1:
cluster1::> vserver services name-service ldap client schema delete -vserver vs1
-schema corp-schema

modify
Modify an LDAP schema template
Description
The vserver services name-service ldap client schema modify
command modifies an existing LDAP schema template. You cannot modify the default
2682
schema templates. Create a copy of a default schema template using the vserver
services name-service ldap client schema copy command, and then
modify the copy. A Vserver administrator can only modify templates owned by the
Vserver.
Parameters
This parameter specifies the name of the Vserver owning the LDAP schema template
you want to modify.
This parameter specifies the name of the schema template you want to modify.
This parameter specifies a comment that describes the schema template.
[-posix-account-object-class <text>] - RFC 2307 posixAccount Object Class
This parameter specifies the RFC 2307 posixAccount object class name defined by the
schema.
[-posix-group-object-class <text>] - RFC 2307 posixGroup Object Class
This parameter specifies the RFC 2307 posixGroup object class name defined by the
schema.
[-nis-netgroup-object-class <text>] - RFC 2307 nisNetgroup Object Class
This parameter specifies the RFC 2307 nisNetgroup object class name defined by the
schema.
[-uid-attribute <text>] - RFC 2307 uid Attribute
This parameter specifies the RFC 2307 uid attribute name defined by the schema.
[-uid-number-attribute <text>] - RFC 2307 uidNumber Attribute
This parameter specifies the RFC 2307 uidNumber attribute name defined by the
schema.
[-gid-number-attribute <text>] - RFC 2307 gidNumber Attribute
This parameter specifies the RFC 2307 gidNumber attribute name defined by the
schema.
[-cn-group-attribute <text>] - RFC 2307 cn (for Groups) Attribute
2683
This parameter specifies the RFC 2307 cn (for Groups) attribute name defined by the
schema.
[-cn-netgroup-attribute <text>] - RFC 2307 cn (for Netgroups) Attribute
This parameter specifies the RFC 2307 cn (for Netgroups) attribute name defined by the
schema.
[-user-password-attribute <text>] - RFC 2307 userPassword Attribute
This parameter specifies the RFC 2307 userPassword attribute name defined by the
schema.
[-gecos-attribute <text>] - RFC 2307 gecos Attribute
This parameter specifies the RFC 2307 gecos attribute name defined by the schema.
[-home-directory-attribute <text>] - RFC 2307 homeDirectory Attribute
This parameter specifies the RFC 2307 homeDirectory attribute name defined by the
schema.
[-login-shell-attribute <text>] - RFC 2307 loginShell Attribute
This parameter specifies the RFC 2307 loginShell attribute name defined by the
schema.
[-member-uid-attribute <text>] - RFC 2307 memberUid Attribute
This parameter specifies the RFC 2307 memberUid attribute name defined by the
schema.
[-member-nis-netgroup-attribute <text>] - RFC 2307 memberNisNetgroup Attribute
This parameter specifies the RFC 2307 memberNisNetgroup attribute name defined by
the schema.
[-nis-netgroup-triple-attribute <text>] - RFC 2307 nisNetgroupTriple Attribute
This parameter specifies the RFC 2307 nisNetgroupTriple attribute name defined by the
schema.
[-enable-rfc2307bis {true|false}] - Enable Support for Draft RFC 2307bis
This parameter specifies whether RFC 2307bis is enabled for the schema.
[-group-of-unique-names-object-class <text>] - RFC 2307bis groupOfUniqueNames
Object Class
This parameter specifies the RFC 2307bis groupOfUniqueNames object class name
defined by the schema. This parameter takes effect only when RFC 2307bis is enabled
for the schema.
2684
[-unique-member-attribute <text>] - RFC 2307bis uniqueMember Attribute

This parameter specifies the RFC 2307bis uniqueMember attribute name defined by the
schema. This parameter takes effect only when RFC 2307bis is enabled for the schema.
[-windows-account-attribute <text>] - ONTAP Name Mapping windowsAccount
Attribute
This parameter specifies the name mapping windowsAccount attribute name defined by
the schema.
Examples
The following example modifies the schema template called corp-schema owned by
Vserver vs1 to use User as the uid attribute name:
cluster1::> vserver services name-service ldap client schema modify -vserver vs1
-schema corp-schema -uid-attribute User
See Also
vserver services name-service ldap client schema copy
2685

show
Display LDAP schema templates
Description
The vserver services name-service ldap client schema show command
shows information about LDAP schema templates which a Vserver can access.
An LDAP schema template created by a Vserver's administrator or by the cluster
administrator for the Vserver is owned by the Vserver. A cluster-wide LDAP schema
template is created by a cluster administrator by specifying the admin Vserver's name
as a value to the -vserver parameter. In addition to its owned LDAP schema templates,
a Vserver can access such cluster-wide LDAP schema templates.
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays all LDAP schema templates that
can be accessed by the specified Vserver.
If you specify this parameter, the command displays the schema template with the
specified name.
If you specify this parameter, the command displays schema templates with the
specified comment.
2686
[-posix-account-object-class <text>] - RFC 2307 posixAccount Object Class

specified posixAccount object class.
[-posix-group-object-class <text>] - RFC 2307 posixGroup Object Class
specified posixGroup object class.
[-nis-netgroup-object-class <text>] - RFC 2307 nisNetgroup Object Class
specified nisNetgroup object class.
[-uid-attribute <text>] - RFC 2307 uid Attribute
specified uid attribute.
[-uid-number-attribute <text>] - RFC 2307 uidNumber Attribute
specified uidNumber attribute.
[-gid-number-attribute <text>] - RFC 2307 gidNumber Attribute
specified gidNumber attribute.
[-cn-group-attribute <text>] - RFC 2307 cn (for Groups) Attribute
specified cn (for Groups) attribute.
[-cn-netgroup-attribute <text>] - RFC 2307 cn (for Netgroups) Attribute
specified cn (for Netgroups) attribute.
[-user-password-attribute <text>] - RFC 2307 userPassword Attribute
specified userPassword attribute.
[-gecos-attribute <text>] - RFC 2307 gecos Attribute
specified gecos attribute.
[-home-directory-attribute <text>] - RFC 2307 homeDirectory Attribute
2687
specified homeDirectory attribute.
[-login-shell-attribute <text>] - RFC 2307 loginShell Attribute
specified loginShell attribute.
[-member-uid-attribute <text>] - RFC 2307 memberUid Attribute
specified memberUid attribute.
[-member-nis-netgroup-attribute <text>] - RFC 2307 memberNisNetgroup Attribute
specified memberNisNetgroup attribute.
[-nis-netgroup-triple-attribute <text>] - RFC 2307 nisNetgroupTriple Attribute
specified nisNetgroupTriple attribute.
[-enable-rfc2307bis {true|false}] - Enable Support for Draft RFC 2307bis
If you set this parameter to true, the command displays RFC 2307bis enabled LDAP
schema templates.
[-group-of-unique-names-object-class <text>] - RFC 2307bis groupOfUniqueNames
Object Class
specified groupOfUniqueNames object class.
[-unique-member-attribute <text>] - RFC 2307bis uniqueMember Attribute
specified uniqueMember attribute.
[-windows-account-attribute <text>] - ONTAP Name Mapping windowsAccount
Attribute
specified windowsAccount attribute.
[-is-owner {true|false}] - Vserver Owns Schema
If you set this parameter to true, the command displays LDAP schema templates with
the Vservers which own them.
Examples
2688
The following example shows a summary of all of the LDAP schema templates defined
in the cluster that can be accessed by Vserver vs1:
cluster1::> vserver services name-service ldap client schema show -vserver vs1
Vserver Schema Template Comment
------- --------------- ------------------------------------------------------vs1
only)
AD-SFU
Schema based on Active Directory Services for UNIX (read-
vs1
RFC-2307
Schema based on RFC 2307 (read-only)
vs1
corp-schema
RFC 2307 schema based on the corporate schema
2689
vserver services name-service netgroup load

Load netgroup definitions from a URI
Description
The vserver services name-service netgroup load command loads
netgroup definitions from a uniform resource identifier (URI) to a specified Vserver.
You can load from a netgroup file at an FTP or a HTTP location (source URI) using the
respective protocol.
Before Data ONTAP saves the new netgroup definitions, it checks that the netgroup
file does not have any file structure issues, does not contain any syntax errors, and all
entries comply with the following rules:
A domain name consists of one or more labels separated by periods (.).
A hostname is a valid domain name, IPv4 address, or IPv6 address.
Valid characters for a label are all alphanumeric characters, underscore (_), and
dash (-). A label may not begin or end with a dash.
Valid characters for a username are all ASCII printable characters with the
exception of whitespace, parentheses, and comma (,).
Valid characters for a netgroup name are all alphanumeric characters, underscore
(_), and dash (-). A netgroup name may not begin with a dash.
A single line in the netgroup file may not exceed 4096 characters.
If the file is found to contain errors, Data ONTAP will issue a warning to that effect, but
netgroup definitions will nevertheless be loaded into the specified Vserver.
Parameters
This parameter specifies the Vserver for which you want to load netgroup definitions.
-source {(ftp|http)://(hostname|IPv4 Address|'['IPv6 Address']')...} - URI to load from
This parameter specifies the source URI from which you want to load netgroup
definitions. You can load from a URI either using the FTP or the HTTP protocol.
2690
Examples
The following example loads netgroup definitions into a Vserver named vs1 from the file
netgroup1 at FTP location ftp://ftp.example.com.
cluster1::> vserver services name-service netgroup load -vserver vs1 -source
ftp://ftp.example.com/netgroup1
vserver services name-service netgroup status

Display local netgroup definitions status
Description
The vserver services name-service netgroup status command displays
the status of local netgroup definitions across a cluster. This enables you to verify that
netgroup definitions are consistent across all nodes that back a Vserver into which
netgroup definitions have been loaded.
The command displays the following information:
Vserver name
Node name
Load time for netgroup definitions
Hash value of the netgroup definitions
Parameters
specify.
| [-instance ] }
about all fields.
2691
If you specify this parameter, the command displays netgroup status only for the
specified Vserver.
If you specify this parameter, the command displays netgroup status only for the
specified node.
[-timestamp <MM/DD/YYYY HH:MM:SS>] - Load Time
If you specify this parameter, the command displays status only for the netgroup
definitions that were loaded at the specified time. Specify time in the format MM/
DD/YYYY HH:MM:SS. Note that the load time stamps for identical definitions are
different on different nodes, because each node downloads the definitions from the URI
individually.
[-hashvalue <text>] - Hash Value
If you specify this parameter, the command displays status only for the netgroup
definitions that have the specified hash value. Note that the primary purpose of the
command is to verify that the definitions on all nodes have the same hash value, so
querying on a specific hash value is not useful in most cases.
Examples
The following example displays netgroup definition status for all Vservers:
cluster1::*> vserver services name-service netgroup status
Vserver
Node
--------- -------
Load Time
Hash Value
------------------- --------------------------------
vs1
node1
9/20/2008 16:04:55
e6cb38ec1396a280c0d2b77e3a84eda2
node2
9/20/2008 16:04:53
e6cb38ec1396a280c0d2b77e3a84eda2
node3
9/20/2008 16:06:26
c0d2b77e3a84eda2e6cb38ec1396a280
node4
9/20/2008 16:06:27
c0d2b77e3a84eda2e6cb38ec1396a280
vs2
2692
vserver services name-service netgroup file delete

Remove a local netgroup file
Description
The vserver services name-service netgroup file delete command
deletes the local netgroup files for given Vservers.
Parameters
Use this parameter to specify the Vservers whose local netgroup file you want to delete.
Separate multiple Vserver names with commas.
Examples
The following example deletes the local netgroup file for a Vserver named vs1.
cluster1::> vserver services netgroup file delete -vserver vs1
vserver services name-service netgroup file show

Display a local netgroup file
Description
The vserver services netgroup file show command displays the contents of
the local netgroup file for the specified Vservers. All the entries under a given netgroup,
specified in the Netgroup column of the command output, list the members of that
netgroup. Each netgroup file specifies netgroups, which are sets of tuples. Each
member of a netgroup is either the name of another netgroup, specified in the Member
Netgroup column, or a specification of a tuple as follows: (Host, User, Domain) where
Host, User, and Domain are character string names for the corresponding component.
2693
Any of the components of a tuple can be either an asterisk (*) to specify a wildcard value
or a dash (-) to specify no valid value.
Parameters
If you specify the -fields fieldname, ... parameter, the command output also includes the
specified field or fields. You can use '-fields ?' to display the fields to specify.
| [-instance ] }
all fields.
Use this parameter to display the local netgroup file contents for the Vservers you
specify.
[-netgroup <text>] - Netgroup Name
If you specify this parameter, the command displays information about the netgroup you
specify.
[-netgrpmemb <text>] - Member Netgroup
If you specify this parameter, the command displays information about the member
netgroup you specify.
[-host <text>] - Member Host
If you specify this parameter, the command displays information about the host you
specify.
[-user <text>] - Member User
If you specify this parameter, the command displays information about the user you
specify.
[-domain <text>] - Member Domain
If you specify this parameter, the command displays information about the domain you
specify.
Examples
The following example displays the netgroup file contents for the Vserver named vs1.
cluster1::> vserver services netgroup file show -vserver vs1
Member
2694
Vserver
Netgroup Netgroup
Host
User
Domain
---------- -------- ----------- ------------- ------------ ------------------vs1

netgrp1
netgrp9
h1
d1
h22
d22
netgrp11
netgrp18
h119
u4343
d34
u88
netgrp8
See Also
vserver services netgroup file show
2695
vserver services name-service nis-domain clearstatistics

Clear NIS statistics information
Description
The vserver services name-service nis-domain clear-statistics
command clears all previously gathered NIS statistics on a specified node for the
specified Vserver and NIS server.
Parameters
This parameter specifies the node for which you want to clear NIS statistics.
This parameter specifies the Vserver for which you want to clear NIS statistics.
-server <IP Address> - NIS Server
This parameter specifies the NIS server for which you want to clear NIS statistics.
Examples
The following example clears NIS statistics for Vserver vs1 and NIS server
192.0.2.66 on node node1.
cluster1::*> vserver services name-service nis-domain show-statistics
-node node1
Note: The statistics below apply only to NIS or YP lookups made
during data access.
Node: node1
NIS
Number of
Total
Minimum
Maximum
Average
RTT (ms)
RTT (ms)
RTT (ms)
RTT (ms)
Number of
Vserver Server YP Lookups
Retransmits
2696
------
------ ----------
--------
--------
--------
--------
vs1
192.0.2.66
500
22500
250
45
43
2365
150
55
-----------
2
vs2
192.0.2.67
0
cluster1::*> vserver services name-service nis-domain clear-statistics
-node node1 -vserver vs1 -server 192.0.2.66
cluster1::*>
-node node1
during data access.
Node: node1
NIS
Number of
Total
Minimum
Maximum
Average
Vserver Server YP Lookups
RTT (ms)
RTT (ms)
RTT (ms)
RTT (ms)
------
------ ----------
--------
--------
--------
--------
vs1
192.0.2.66
0
43
2365
150
55
Number of
Retransmits
-----------
0
vs2
192.0.2.67
0
2697
vserver services name-service nis-domain create

Create a NIS domain configuration
Description
The vserver services name-service nis-domain create command creates
a configuration for an NIS domain. You can configure multiple NIS domains for a given
Vserver, but only one NIS domain can be active on a Vserver at any given time. You can
also configure more than one Vserver with the same NIS domain.
Parameters
Use this parameter to specify the Vserver on which the NIS domain configuration is
created.
-domain <nis domain> - NIS Domain
Use this parameter to specify the NIS domain for which a configuration is created.
Maximum Supported NIS Domain length: 64 characters.
-active {true|false} - Active Domain
Use this parameter with the value true to specify that the NIS domain configuration is
active when it is created. Use this parameter with the value false to specify that the
NIS domain configuration is not active.
-servers <IP Address>, ... - NIS Server
Use this parameter to specify the IP addresses of NIS servers used by the NIS domain
configuration. Separate multiple IP addresses with commas.
Examples
The following example creates an NIS domain configuration on the Vserver named vs0.
The NIS domain is named nisdomain, is active upon creation, and uses an NIS server
with the IP address 192.0.2.180.
cluster1::> vserver services name-service nis-domain create -vserver vs0 -domain
nisdomain -active true -servers 192.0.2.180
2698
vserver services name-service nis-domain delete

Delete a NIS domain configuration
Description
The vserver services name-service nis-domain delete command deletes
an NIS domain configuration.
Deleting an NIS domain configuration removes it permanently. To disable a configuration
without deleting it, use the vserver services name-service nis-domain
modify command with the -active false parameter.
Parameters
Use this parameter to specify the Vserver from which the NIS domain configuration is
deleted.
Use this parameter to specify the NIS domain whose configuration is deleted.
Examples
The following example deletes the configuration of an NIS domain named testnisdomain
from a Vserver named vs2:
cluster1::> vserver services name-service nis-domain delete -vserver vs2 -domain
testnisdomain
See Also
vserver services name-service nis-domain modify
2699
vserver services name-service nis-domain modify

Modify a NIS domain configuration
Description
Use the vserver services name-service nis-domain modify command to
modify the activity status and NIS server of an NIS domain configuration.
Use the -active false parameter to disable an NIS domain configuration without
deleting it. To permanently remove a configuration, use the vserver services
name-service nis-domain delete command.
Parameters
Use this parameter to specify the Vserver whose NIS domain configuration is modified.
Use this parameter to specify the NIS domain whose configuration is modified.
[-active {true|false}] - Active Domain
Use this parameter with the value true to specify that the NIS domain configuration
is active. Use this parameter with the value false to specify that the NIS domain
configuration is not active.
[-servers <IP Address>, ...] - NIS Server
Use this parameter to specify the IP addresses of NIS servers used by the the NIS
domain configuration. Separate multiple IP addresses with commas.
Examples
The following example disables the configuration of an NIS domain named nisdomain
on a Vserver named vs0:
cluster1::> vserver services name-service nis-domain modify -vserver vs0 -domain
nisdomain -active false
See Also
2700
vserver services name-service nis-domain delete
2701
vserver services name-service nis-domain showbound

Display binding status of a NIS domain configuration
Description
The vserver services name-service nis-domain show-bound command
displays binding information about NIS domain configurations.
Parameters
specify.
| [-instance ] }
about all fields.
If you use this parameter, the command displays binding information only about the
NIS domain configurations of the specified Vservers. Use this parameter with the domain parameter to display binding information only about a particular NIS domain
configuration on the specified Vserver.
[-domain <nis domain>] - NIS Domain
If you use this parameter, the command displays binding information only about the NIS
domain configurations that match the specified NIS domain name. Use this parameter
with the -vserver parameter to display binding information only about a particular
Vserver on the specified NIS domain name.
[-bound-servers <IP Address>, ...] - Bound NIS Servers
If you use this parameter, the command displays NIS binding information only about the
specified NIS servers.
2702
Examples
The following example displays binding information about all NIS domain configurations:
cluster1::> vserver services name-service nis-domain show-bound
Bound
Vserver
Domain
NIS Server
------------- ------------------- ----------------vs1
testnisdomain1
vs1
testnisdomain2
192.0.2.180,
10.0.2.15
10.0.2.17
2703
vserver services name-service nis-domain showstatistics

Display NIS statistics information
Description
The vserver services name-service nis-domain show-statistics
command displays information about NIS statistics on the nodes in a cluster. Currently,
these statistics apply only to NIS or YP lookups made during data access. You can view
the following information through this command:
Number of NIS or YP lookups made during data access
Total time in seconds spent on NIS or YP lookups made during data access
Minimum time in microseconds spent on a NIS or YP lookup made during data
access
Maximum time in microseconds spent on a NIS or YP lookup made during data
access
Average time in microseconds spent on NIS or YP lookups made during data
access
Number of network re-transmissions involved in NIS or YP lookups made during
data access
Parameters
specify.
| [-instance ] }
about all fields.
2704
node.
Vserver.
[-server <IP Address>] - NIS Server
nodes that are configured to use the specified NIS server.
[-lookups <Counter64>] - Number of YP Lookups During Data Access
nodes that have the specified number of NIS or YP lookups made during data access.
[-total-rtt <Counter64>] - Total Time Spent in YP Lookups During Data Access
or nodes that have the specified total time (in seconds) spent for all NIS or YP lookups
during data access.
[-min-rtt <Counter64>] - Minimum Time Spent in a YP Lookup During Data Access
nodes that have the specified minimum round-trip time (in microseconds) for a NIS or
YP lookup during data access.
[-max-rtt <Counter64>] - Maximum Time Spent in a YP Lookup During Data Access
nodes that have the specified maximum round-trip time (in microseconds) for a NIS or
YP lookup during data access.
[-avg-rtt <Counter64>] - Average Time Spent in YP Lookups During Data Access
nodes that have the specified average round-trip time (in microseconds) spent for all
NIS or YP lookups during data access.
[-num-rtx <Counter64>] - Number of Network Retransmissions in YP Lookups During
Data Access
nodes that have the specified number of network re-transmissions involved in NIS or YP
lookups made during data access.
[-not-found <Counter64>] - Number of Entries Not Found During YP Lookup
2705
nodes that have the specified number of entry not found involved in NIS or YP lookups
made during data access.
Examples
The following example displays NIS or YP statistics for a node named node1:
-node node1
during data access.
Node: node1
Number of
NIS
Entry Not
Number of
Total
Minimum
Maximum
Average
Retransmits
Vserver Server
Found
YP Lookups
RTT (s)
RTT (us)
RTT (us)
RTT (us)
-----------
------ --------------
----------
-------
--------
--------
--------
500
250
45
43
150
55
vs1
2
192.0.2.66
4
vs2
0
192.0.2.6
2
cluster1::*> nis info -node node1

during data access.
Node: node1
Number of
NIS
Entry Not
Number of
Total
Minimum
Maximum
Average
Retransmits
Vserver Server
Found
YP Lookups
RTT (s)
RTT (us)
RTT (us)
RTT (us)
-----------
------ --------------
----------
-------
--------
--------
--------
500
250
45
43
150
55
vs1
2
4
vs2
2706
192.0.2.66
192.0.2.6
2
2707
vserver services name-service nis-domain show

Display NIS domain configurations
Description
The vserver services name-service nis-domain show command displays
information about NIS domain configurations.
Parameters
specify.
| [-instance ] }
about all fields.
Use this parameter to display information only about the NIS domain configurations of
the Vservers you specify. Use this parameter with the -domain parameter to display
information only about a particular NIS domain configuration on the Vserver you specify.
[-domain <nis domain>] - NIS Domain
Use this parameter to display information only about the NIS domain configurations
that match the NIS domain name you specify. Use this parameter with the -vserver
parameter to display information only about a particular NIS domain configuration on the
Vserver you specify.
[-active {true|false}] - Active Domain
Use this parameter with the value true to display information only about the NIS
domain configurations that are active. Use this parameter with the value false to
display information only about the NIS domain configurations that are not active.
[-servers <IP Address>, ...] - NIS Server
2708
Use this parameter to display information only about the NIS domain configurations that
use the NIS servers at the IP addresses you specify.
Examples
The following example displays information about all NIS domain configurations:
cluster1::> vserver services name-service nis-domain show
Vserver
Domain
Active NIS Server
------------- ------------- ------ -----------node1
nisdomain
true
192.0.2.180
node2
nisdomain
true
10.0.2.15
node2
nisdomain
false
192.0.2.180
node3
testnisdomain true
192.0.2.128, 192.0.2.180
2709
vserver services name-service ns-switch create

Create a new Name Service Switch table entry
Description
The vserver services name-service ns-switch create command specifies
the order in which to lookup the name service sources, for a given Vserver and name
service database. Each name service database contains some information regarding
hosts, group, password, netgroup or namemap. Such a database comes from one or
more name service sources such as files, DNS, LDAP or NIS.
Note: The vserver services name-service ns-switch command provides the
functionality of the /etc/nsswitch.conf file on UNIX systems. For more information, see
the UNIX man page for nsswitch.conf(5).
Parameters
Use this parameter to specify the Vserver on which to create the new name service
switch entry
-database {hosts|group|passwd|netgroup|namemap} - Name Service Switch Database
Name Service Switch Database Use this parameter to specify the name service
database for which the order of the source lookup is being specified. This parameter can
have the following values:
hosts
group
passwd
netgroup
namemap
-sources {files|dns|ldap|nis}, ... - Name Service Source Order
Name Service Source Order Use this parameter to specify the name service sources
and the order in which to look them up for the specified Vserver and name service
2710
database. Each name service source in the list for this parameter must be one of the
following:
files
dns
ldap
nis
Separate multiple name service sources with commas.
For each database specified with the -database parameter, one or more sources must
be specified. The valid sources for each database type are shown in the following table:
+----------+-------------------+
| Database |
Valid Sources
|----------+-------------------|
| hosts
files, dns
| group
files, nis, ldap |
| passwd
files, nis, ldap |
| netgroup |
files, nis, ldap |
| namemap
files, ldap
+----------+-------------------+
Note:
If "files" is not specified as the default source for the "passwd" or "group" database,
ensure that default user and group entries for the 'passwd' and 'group' respectively are
present in the source configured. Default entries for "passwd" database: nobody, pcuser,
root, sshd, toor, daemon, operator, bin, tty, kmem, games, news, man, smmsp, mailnull,
bind, proxy, uucp, pop, www, admin, diag, autosupport. Default entries for "group"
database: wheel, daemon, kmem, sys, tty, operator, mail, bin, news, man, games, ftp,
staff, sshd, smmsp, mailnull, guest, bind, proxy, authpf, _pflogd, _dhcp, uucp, dialer,
network, audit, www, antivirus, nogroup, nobody.
Examples
The following example creates name service source ordering for the hosts database on
a Vserver named vs0. The order of looking up the sources is specified as files followed
by DNS.
cluster1::> vserver services name-service ns-switch create -vserver vs0 -database
hosts -sources files,dns
2711
The following example creates the name service source ordering for the passwd
database on a Vserver named vs1. The order of looking up the sources is specified as
files, NIS and LDAP.
cluster1::> vserver services nameservice ns-switch create -vserver vs1 -database
passwd -sources files,nis,ldap
See Also
vserver services name-service ns-switch
2712
vserver services name-service ns-switch delete

Remove a Name Service Switch table entry
Description
Use the vserver services name-service ns-switch delete command to
permanently remove an existing name service switch entry.
Parameters
Vserver Use this parameter to specify the Vserver for which to delete the name service
switch entry.
database, of the Vserver, for which the name service switch entry is to be deleted.
Following are the possible values for this parameter:
hosts
group
passwd
netgroup
name_map
Examples
The following example deletes the name service switch entry for the hosts database on
a Vserver named vs0.
cluster1::> vserver services name-service ns-switch delete -vserver vs0 database hosts.
The following example deletes the name service switch entry for the group database on
a Vserver named vs1.
cluster1::> vserver services name-service ns-switch delete -vserver vs1 database group.
2713
vserver services name-service ns-switch modify

Change a Name Service Switch table entry
Description
Use the vserver services name-service ns-switch modify command to
modify the order of looking up the name service sources, for an existing name service
switch entry.
Parameters
Vserver Use this parameter to specify the Vserver on which to modify the name service
switch entry.
database, of the given Vserver,for which to modify the name service switch entry.
Following are the possible values for this parameter:
hosts
group
passwd
netgroup
namemap
[-sources {files|dns|ldap|nis}, ...] - Name Service Source Order
Name Service Source Order Use this parameter to specify the name service sources
and the order in whichlook up for the specified Vserver and name service database.
Each name service source in the list for this parameter must be one of the following:
files
dns
ldap
2714
nis
Separate multiple sources with commas.
For each database specified with the -database parameter, one or more sources must
be specified. The valid sources for each database type are shown in the following table:
+----------+-------------------+
| Database |
Valid Sources
|----------+-------------------|
| hosts
files, dns
| group
files, nis, ldap |
| passwd
files, nis, ldap |
| netgroup |
files, nis, ldap |
| namemap
files, ldap
+----------+-------------------+
Note:
If "files" is not specified as the default source for the "passwd" or "group" database,
ensure that default user and group entries for the 'passwd' and 'group' respectively are
present in the source configured. Default entries for "passwd" database: nobody, pcuser,
root, sshd, toor, daemon, operator, bin, tty, kmem, games, news, man, smmsp, mailnull,
bind, proxy, uucp, pop, www, admin, diag, autosupport. Default entries for "group"
database: wheel, daemon, kmem, sys, tty, operator, mail, bin, news, man, games, ftp,
staff, sshd, smmsp, mailnull, guest, bind, proxy, authpf, _pflogd, _dhcp, uucp, dialer,
network, audit, www, antivirus, nogroup, nobody.
Examples
The following example modifies the name service source ordering for the hosts
database on a Vserver named vs0. The order of looking up the sources is changed to
only DNS.
cluster1::> vserver services name-service ns-switch modify -vserver vs0 database hosts -sources dns
The following example modifies the name service source ordering for the passwd
database on a Vserver named vs1. The order of looking up the sources is changed to
LDAP followed by NIS.
cluster1::> vserver services name-service ns-switch modify -vserver vs1 database passwd -sources ldap,nis
2715
vserver services name-service ns-switch show

Display Name Service Switch configuration
Description
Use the vserver services name-service ns-switch show command to
display information about one or more name service switch entries. A name service
switch entry provides information about the order of looking up the name service
sources, for a Vserver and name service database.
Parameters
If you specify the -fields [fieldname], ... parameter, the command only displays the fields
that you specify.
| [-instance ] }
all entries.
Vserver Use this parameter to display only the name service switch entries for the
Vserver you specify.
[-database {hosts|group|passwd|netgroup|namemap}] - Name Service Switch Database
Name Service Switch Database Use this parameter to display only the name service
switch entries of the name service database type you specify. Following are the possible
values for this parameter:
hosts
group
passwd
netgroup
name_map
2716
[-sources {files|dns|ldap|nis}, ...] - Name Service Source Order

Name Service Source Order Use this parameter to display only name service switch
entries with the specified name service source order. Each name service source in the
list for this parameter must be one of the following:
files
dns
ldap
nis
Separate multiple sources with commas.
Examples
The following example shows the output of the vserver services name-service
ns-switch show command.
cluster1::>
vserver services name-service ns-switch show

Source
Vserver
Database
Order
--------------- ------------
---------
vs0
hosts
files,
vs1
passwd
dns
files,
ldap, nis
2717
vserver services name-service unix-group adduser

Add a user to a local UNIX group
Description
The vserver services name-service unix-group adduser command adds a
user to a local UNIX group.
Parameters
Use this parameter to specify the Vserver location of the local UNIX group to which the
user is added.
-name <text> - Group Name
Use this parameter to specify the local UNIX group to which to add the user.
-username <text> - Name of User
Use this parameter to specify the user name to add to the local UNIX group.
Examples
The following example adds a user named tsmith to a local UNIX group named sales on
a Vserver named vs0:
cluster1::> vserver services name-service unix-group adduser -vserver vs0 -name
sales -username tsmith
vserver services name-service unix-group create

Create a local UNIX group
Description
2718
The vserver services name-service unix-group create command creates

a local UNIX group on a Vserver. Use a local UNIX group for Windows-to-UNIX and
UNIX-to-Windows group mappings.
Parameters
Use this parameter to specify the Vserver on which to create the local UNIX group.
Use this parameter to specify the name of the group to create.
-id <integer> - Group ID
Use this parameter to specify an ID number for the group.
Examples
The following example creates a group named sales on a Vserver named vs0. The
group has the ID 94.
cluster1::> vserver services name-service unix-group create -vserver vs0 -name
sales -id 94
vserver services name-service unix-group delete

Delete a local UNIX group
Description
The vserver services name-service unix-group delete command deletes
a local UNIX group from a Vserver.
Parameters
Use this parameter to specify the Vserver location of the local UNIX group to delete.
Use this parameter to specify the local UNIX group to delete.
2719
Examples
The following example deletes a local UNIX group named testgroup from a Vserver
named vs0:
cluster1::> vserver services name-service unix-group delete -vserver vs0 -name
testgroup
vserver services name-service unix-group deluser

Delete a user from a local UNIX group
Description
The vserver services name-service unix-group deluser command
removes a user from a local UNIX group.
Parameters
Use this parameter to specify the Vserver location of the local UNIX group from which
the user is removed.
Use this parameter to specify the local UNIX group from which to remove the user.
-username <text> - Name of User
Use this parameter to specify the user name to remove from the local UNIX group.
Examples
The following example removes a user named testuser from a local UNIX group named
sales on a Vserver named vs0:
cluster1::> vserver services name-service unix-group deluser -vserver vs0 -name
eng -username testuser
2720
vserver services name-service unix-group loadfrom-uri

Load one or more local UNIX groups from a URI
Description
The vserver services name-service unix-group load-from-uri
command loads UNIX groups from a universal resource identifier (URI). The URI must
contain group information in the UNIX /etc/group format:
group_name:password:group_ID:comma_separated_list_of_users
The command discards the value of the password field.
Parameters
Use this parameter to specify the Vserver on which to locate the local UNIX groups.
-uri {(ftp|http)://(hostname|IPv4 Address|'['IPv6 Address']')...} - URI to Load From
Use this parameter to specify the URI from which the command loads group information.
[-overwrite {true|false}] - Overwrite Entries
Use this parameter with the value true to specify that group information loaded from
the URI should overwrite existing group information. The default value is false,
specifying that group information loaded from the URI should not overwrite existing
group information.
Examples
The following example loads group information from the URI ftp://ftp.example.com/
groups onto a Vserver named vs0:
cluster1::> vserver services name-service unix-group load-from-uri -vserver vs0 uri ftp://ftp.example.com/groups
2721
vserver services name-service unix-group modify

Modify a local UNIX group
Description
Use the vserver services name-service unix-group modify command to
modify a local UNIX group's group ID.
Parameters
Use this parameter to specify the Vserver location of the local UNIX group to modify.
Use this parameter to specify the name of the group to modify.
[-id <integer>] - Group ID
Use this parameter to specify an ID number for the group.
Examples
The following example changes a local UNIX group named sales on a Vserver named
vs0 to have the group ID 100:
cluster1::> vserver services name-service unix-group modify -vserver vs0 -group
sales -id 100
vserver services name-service unix-group show

Display local UNIX groups
Description
2722
The vserver services name-service unix-group show command displays

information about local UNIX groups.
Parameters
specify.
| [-members ]
Use this parameter to display the list of users in each local UNIX group.
| [-instance ] }
about all fields.
Use this parameter with the -name parameter to display information only about the local
UNIX group you specify. Use this parameter without -name to display information only
about the local UNIX groups that are located on the specified Vserver.
[-name <text>] - Group Name
Use this parameter with the -vserver parameter to display information only about
the local UNIX group you specify. Use this parameter without -vserver to display
information only about the local UNIX groups that match the name you specify.
[-id <integer>] - Group ID
Use this parameter to display information only about the local UNIX group that has the
ID you specify.
[-users <text>, ...] - Users
Use this parameter to display information only about the local UNIX groups that include
the user names you specify.
Examples
The following example displays information about all local UNIX groups, including lists of
their users:
cluster1::> vserver services name-service unix-group show -members
Vserver
Name
ID
2723
vs0
dev
44
Users: admin, jdoe, tsmith

vs0
sales
12
Users: admin, guest, pjones

vs1
testgroup
13
Users: admin, root, testuser

vs1
users
100
Users: admin, jdoe, pjones, tsmith
2724
vserver services name-service unix-group maxlimit modify

Change Configuration Limits for UNIX-Group
privilege level.
Description
The vserver services name-service unix-group max-limit modify
command enables you to modify maximum UNIX groups and group-members that
can be configured on the system. This allows you to set certain limits to prevent
performance issues due to service configurations using excessive resources.
Parameters
[-limit <integer>] - System Limit
This parameter specifies the maximum limit that you want to set for unix-group. The
default setting for the limit is 32768. The supported range of values for this parameter is
0 to 65536.
Examples
The following example modifies the system-wide limit of the total number of UNIX
groups and members that can be configured on the cluster.
vserver services name-service unix-group max-limit modify -limit 33792
vserver services name-service unix-group maxlimit show

Display Configuration Limits for UNIX-Group
privilege level.
Description
2725
The vserver services name-service unix-group max-limit show

command displays information on UNIX group limits that are configurable with vserver
services name-service unix-group max-limit modify command. The
output will show the following:
Limit: The configured limit on the total number of UNIX groups configurable.
Current Count: Total number of current entries for UNIX groups configuration.
Parameters
None
Examples
The following example shows the limits and total number of current entries for UNIX
group configuration:
cluster1::> vserver services name-service unix-group max-limit show
(vserver services name-service unix-group max-limit show)
Limit
Current Count
-------------- -------------400
See Also
vserver services name-service unix-group max-limit modify
2726
vserver services name-service unix-user create

Create a local UNIX user
Description
The vserver services name-service unix-user create command creates a
local UNIX user on a Vserver. You can use local UNIX users for Windows-to-UNIX and
UNIX-to-Windows name mappings.
Parameters
This parameter specifies the Vserver on which you want to create the local unix user.
-user <text> - User Name
This parameter specifies the user account that you want to create.
-id <integer> - User ID
This parameter specifies an ID number for the user.
-primary-gid <integer> - Primary Group ID
This parameter specifies the ID number of the user's primary group.
[-full-name <text>] - User's Full Name
This parameter specifies the user's full name.
Examples
The following example creates a local UNIX user named tsmith on a Vserver named
vs0. The user has the ID 4219 and the primary group ID 100. The user's full name is
Tom Smith.
vs1::> vserver services name-service unix-user create -vserver vs0 -user tsmith id 4219 -primary-gid 100 -full-name "Tom Smith"
vserver services name-service unix-user delete
2727
Delete a local UNIX user

Description
The vserver services name-service unix-user delete command deletes a
local UNIX user from a Vserver.
Parameters
This parameter specifies the Vserver on which the local UNIX user is located.
This parameter specifies the user that you want to delete.
Examples
The following example deletes a local UNIX user named testuser from a Vserver named
vs0:
vs1::> vserver services name-service unix-user delete -vserver vs0 -user testuser
vserver services name-service unix-user loadfrom-uri

Load one or more local UNIX users from a URI
Description
The vserver services name-service unix-user load-from-uri
command loads one or more UNIX users from a universal resource identifier
(URI). The URI must contain user information in the UNIX /etc/passwd format:
user_name:password:user_ID:group_ID:full_name:home_directory:shell. The command
discards the value of the password field and of the fields after the full_name field
( home_directory and shell).
2728
Parameters
This specifies the Vserver on which the local UNIX user or users are to be located.
-uri {(ftp|http)://(hostname|IPv4 Address|'['IPv6 Address']')...} - URI to Load From
This specifies the URI from which user information is to be loaded.
-overwrite {true|false} - Overwrite Entries
This optionally specifies whether user information from the URI overwrites existing user
information. The default setting is false.
Examples
The following example loads user information from the URI ftp://ftp.example.com/users
onto a Vserver named vs0:
node::> vserver services name-service unix-user load-from-uri -vserver vs0 -uri
ftp://ftp.example.com/users
vserver services name-service unix-user modify

Modify a local UNIX user
Description
The vserver services name-service unix-user modify command modifies
a local UNIX user's ID, primary group ID, or full name.
Parameters
This parameter specifies the Vserver on which the local UNIX user is located.
This parameter specifies the user account that you want to modify.
[-id <integer>] - User ID
2729
This optional parameter specifies an ID number for the user.

[-primary-gid <integer>] - Primary Group ID
This optional parameter specifies the ID number of the user's primary group.
This optional parameter specifies the user's full name.
Examples
The following example modifies the local UNIX user named pjones on a Vserver named
vs0. The user's primary group ID is changed to 100 and the user's full name is Peter
Jones.
vs1::> vserver services name-service unix-user modify -vserver vs0 -user pjones primary-gid 100 -full-name "Peter Jones"
vserver services name-service unix-user show

Display local UNIX users
Description
The vserver services name-service unix-user show command displays
information about local UNIX users. The command output depends on the parameter
or parameters specified with the command. If you do not specify any parameters, the
command displays the following information about all local UNIX users:
Vserver name
User name
User ID
Primary group ID
Full name
Parameters
2730
specify.
| [-instance ] }
about all entries.
If you specify this parameter and the -user parameter, the command displays
information only about the specified local UNIX user. If you specify this parameter by
itself, the command displays information only about the local UNIX user or users that
are located on the specified Vserver.
[-user <text>] - User Name
If you specify this parameter and the -vserver parameter, the command displays
information only about the specified local UNIX user. If you specify this parameter by
itself, the command displays information only about the local UNIX user or users that
have the specified name.
[-id <integer>] - User ID
If you specify this parameter, the command displays information only about the local
UNIX user that has the specified ID.
[-primary-gid <integer>] - Primary Group ID
UNIX user or users that have the specified primary group ID.
UNIX user or users that match the specified name.
Examples
The following example displays information about all local UNIX users:
vs1::> vserver services name-service unix-user show
Vserver
User
User
Group
Full
Name
ID
ID
Name
---------- ---------- ------ ------ ---------------vs0
admin
100
100
administrator
vs0
guest
1000
100
guest
vs0
jdoe
4673
100
Jane Doe
vs0
monitor
2000
100
monitor
2731
2732
vs0
pjones
4236
100
Peter Jones
vs0
root
10
100
root
vs0
tsmith
3289
100
Tom Smith
vserver services name-service unix-user max-limit

modify
Change Configuration Limits for UNIX-User
privilege level.
Description
The vserver services name-service unix-user max-limit modify
command enables you to modify maximum UNIX users that can be configured on
the system. This allows you to set certain limits to prevent performance issues due to
service configurations using excessive resources.
Parameters
[-limit <integer>] - System Limit
This parameter specifies the maximum limit that you want to set for unix-user. The
default setting for the limit is 32768. The supported range of values for this parameter is
0 to 65536.
Examples
The following example modifies the system-wide limit of the total number of UNIX users
that can be configured on the cluster.
vserver services name-service unix-user max-limit modify -limit 33792
vserver services name-service unix-user max-limit

show
Display Configuration Limits for UNIX-User
privilege level.
Description
2733
The vserver services name-service unix-user max-limit show

command displays information on UNIX user limits that are configurable with vserver
services name-service unix-user max-limit modify command. The output
will show the following:
Limit: The configured limit on the total number of UNIX users configurable.
Current Count: Total number of current entries for UNIX users configuration.
Parameters
None
Examples
The following example shows the limits and total number of current entries for UNIX
user configuration:
cluster1::> vserver services name-service unix-user max-limit show
(vserver services name-service unix-user max-limit show)
Limit
Current Count
-------------- -------------400
See Also
vserver services name-service unix-user max-limit modify
2734
vserver services ndmp generate-password

Generates NDMP password for a user
Description
This command is used to generate NDMP password for a given user in the specified
Vserver context. The generated NDMP password is based on the user's login password.
For this reason regenerate it whenever the user's login password changes. This
command fails if a user does not exist for the Vserver.
Parameters
specify.
| [-instance ] }
about all fields.
Specify the Vserver context for which password is to be generated.
[-user <text>] - User
Specify the user name for which the NDMP password needs to be generated.
[-password <text>] - Password
The generated NDMP password string that is used for authentication.
Examples
The following example shows the usage this command to generate NDMP password for
a user belonging to a specific Vserver:
cluster1::> vserver services ndmp generate-password -vserver vserver1 -user user1
2735
Vserver: vserver1
User: user1
Password: a9cCCUp32yjGmBiD
vserver services ndmp kill-all

Kill all NDMP sessions
Description
This command terminates all NDMP sessions on a particular Vserver in the cluster.
Parameters
Specifies the Vserver name in which all NDMP sessions that are to be terminated are
running.
Examples
The following example shows how all NDMP sessions on the Vserver named vserver1
can be terminated:
cluster1::> vserver services ndmp kill-all -vserver vserver1
vserver services ndmp kill

Kill the specified NDMP session
Description
2736
This command terminates a specific NDMP session on a particular Vserver in the

cluster.
Parameters
Specifies the Vserver in which the NDMP session that needs to be terminated is
running.
<text> - Session Identifier
Session ID of the NDMP session. A session-id is a string used to identify a particular
NDMP session.
Examples
The following example shows how a specific NDMP session on the Vserver named
vserver1 can be terminated:
cluster1::> vserver services ndmp kill 1000:8002 -vserver vserver1
See Also
vserver services ndmp killsession
2737

Modify NDMP Properties
Description
This command is used to change NDMP options on Vservers.
One or more of the options specified in the parameters section can be modified for a
specific Vserver, by this command. A short description of each of the options is provided
in the parameters section.
Parameters
[-maxversion <integer>] - NDMP Version
This option can be used to set the highest NDMP protocol version supported by the
NDMP server . The only supported value is 4.
[-ignore-ctime-enabled {true|false}] - Ignore Ctime
This option, when true, allows user to exclude files with ctime changed from storage
system' incremental dumps since other processes like virus scanning often alter the
ctime of files. When this option is false, backup on the Vserver will include all files with a
change or modified time later then the last dump in the previous level dump. The default
value is false. This option is persistent across reboots.
Most WIN32 APIs are often unaware of the "last changed time", ctime, they often
incorrectly set a later time for files, causing these files to be included in the Vserver's
incremental dumps, making the incremental dump very large. This is partially defying
the purpose of having incremental dumps, since one uses incremental dumps to speed
up the backup by only dumping files that were truly changed since the last backup.
The -option-value for this parameter should be true/false.
[-offset-map-enable {true|false}] - Enable Offset Map
This option is used to enable or disable generation of the inode offset map during NDMP
based dump backups. The offset map is required to perform Enhanced Direct Access
Restore (DAR) on the backup data. Enhanced DAR provides support for directory DAR
2738
and DAR of files with NT streams. The default value for this option is true. This option is
persistent across reboots.
[-tcpnodelay {true|false}] - Enable TCP Nodelay
Enables/Disables the TCPNODELAY configuration parameter for the socket between
the Vserver and the DMA. When set to true, the Nagle algorithm is disabled and small
packets are sent immediately rather than held and bundled with other small packets.
This optimizes the system for response time rather than throughput.
This option becomes active when the next NDMP session starts. Existing sessions are
unaffected. The default value for this option is false. This option is persistent across
reboots.
[-tcpwinsize <integer>] - TCP Window Size
This option can be used to change the TCP buffer size of the NDMP data
connection.The minimum and maximum values are 8192(8K) and 262,144(256K),
respectively. The default value for this option is 32768(32K).
This option is persistent across reboots.
The -option-value for this parameter should be a number between 8192(8K) and
262,144(256K).
[-data-port-range <text>] - Data Port Range
This option allows administrators to specify a port range on which the NDMP server can
listen for data connections.
The format of this option is start_port - end_port start_port, end_port can have values
between [1024-65535]; start_port must be lesser than or equal to end_port. If a valid
range is specified, NDMP uses a port within that range to listen for data connections. A
listen request fails if no ports in the specified range are free.
This option is modifiable only from the admin Vserver context and the said option is
applicable for all the data Vservers and the admin Vserver. For example, if the value of
the above option is set with 2000-3000, the same value will be applicable throughout
the cluster. The value all implies that any available port can be used to listen for data
connections. The default value for this option is all. This option is persistent across
reboots.
The -option-value for this option should be in the format {<start_port>-<end port> |
all }- where start_port, end_port can have values between [1024-65535]; start_port must
be lesser than or equal to end_port.
2739
[-backup-log-enable {true|false}] - Enable Backup Log

Backup logging captures important events during dump/restore and records them in /
mroot/etc/log/backup on the root volume. The option allows users to enable or disable
this feature. The default value for this option is true. This option is persistent across
reboots.
[-per-qtree-exclude-enable {true|false}] - Enable per Qtree Exclusion
If this option is true, users can specify exclude list on a per qtree basis to be excluded
from backup. This exclude list will override any values already present due to
'EXCLUDE' environment variable . The user can specify the exclusion list through
a .exclude_list file which resides at the root of the qtree. The exclusion list can be a list
of files or files that match a specified pattern. The default value for this option is false.
[-authtype <NDMP Authentication types>, ...] - Authentication Type
Allows the administrator to choose the authentication method. NDMP supports two
authentication types: challenge and plaintext. The default of this option is challenge.
The -option-value for this parameter can be {challenge | plaintext | challenge,
plaintext | plaintext, challenge}.
[-debug-enable {true|false}] - Enable Debug (privilege: advanced)
This option enables debug logging for NDMP. Debug messages will be logged to the
ndmpd log file /mroot/etc/log/mlog/ndmpd.log . The default value for this option is
false .This option is persistent across reboots.
[-debug-filter <text>] - Debug Filter (privilege: advanced)
This option controls the NDMP modules for which debug logging is to be enabled.
option-value can take five values for this option : all, none, normal, backend or "filterexpression".
all enables debug logging for all modules.
none disables debug logging for all modules. It is equivalent to modify -vserver
vserver_name -debug-enable false.
normal is a shortcut option that enables debug logging for all modules except verbose
and io_loop. The equivalent filter string is all-verbose-io_loop.
2740
backend is a short cut option that enables debug logging for all modules except
verbose, io_loop, ndmps and ndmpd. The equivalent filter string is all-verbose-io_loopndmps-ndmpp.
(filter-expression) is a combination of one or more modules for which debug logs needs
to be enabled. Multiple module names can be combined using following operators :
- to remove the given module from the list of specified modules in the filter string.
For example the filter all-ndmpp will enable debug logging for all modules but not
ndmpp.
^ to add the given module or modules to the list of modules specified in the filter
string. For example the filter ndmpp^mover^data will enable debug logging for
The possible module names and a brief description is given below:+--------------+-------------------------------------+
| Modules
| Description
+--------------+-------------------------------------+
| verbose
| verbose message
| io
| I/O process loop
| io_loop
| I/O process loop verbose messages
| ndmps
| NDMP service
| ndmpp
| NDMP Protocol
| rpc
| fdc_rpc
| auth
| Authentication
| mover
| data
| NDMP DATA (backup/restore)
| scsi
| NDMP SCSI (robot/tape ops)
| bkup_rpc
| RPC to Backup service client
| bkup_rpc_s
| RPC to Backup service server
| conf
| Debug configure/reconfigure
| dblade
| timer
| NDMP server timeout messages
| vldb
| VLDB service
| smf
| common
| NDMP common state
| ext
| ndmprpc
+--------------+-------------------------------------+
2741
The default value for this option is none. This option is persistent across reboots.
The -option-value for this parameter can be {all | none | normal | backend |'filterexpression'}.
[-dump-logical-find <text>] - Enable Logical Find for Dump (privilege: advanced)
This option specifies whether to follow inode-file walk or tree walk for phase I of the
dump. Choosing inode-file walk or tree walk affects the performance of the dump. This
option can take following values:
If default is specified, then level 0 and incremental volume as well as qtree dumps will
use inode walk. All the subtree dumps will use tree walk.
If always is specified, all dumps will follow treewalk.
A comma-separated list of values in any combination from the following list:
vol_baseline: Level 0 full volume backup will follow treewalk.
vol_incr: Incremental full volume backup will follow treewalk.
qtree_baseline: Level 0 qtree backup will follow treewalk.
qtree_incr: Incremental qtree backup will follow treewalk.
The default value for this option is default. This option is persistent across reboots.
The -option-value for this parameter could be {default | always | 'vol_baseline' |
'vol_baseline,qtree_baseline' | ...}.
[-abort-on-disk-error {true|false}] - Enable Abort on Disk Error (privilege: advanced)
If this option is true, dump will abort the backup operation on detection of irrecoverable
data blocks in user files. If this option is false, dump will proceed with backup operation even if irrecoverable data blocks in user files are detected. On detection of irrecoverable
data blocks, dump will send a log message to DMA and also log an entry in /mroot/etc/
log/backup file. The default value for this option is false. This option is persistent across
reboots.
[-fh-dir-retry-interval <integer>] - FH Throttle Value for Dir (privilege: advanced)
NDMP protocol sends back file history information for all directories in phase 3 of dump
to DMA. In the presence of slow DMA or high latency networks, the amount of file
history being generated exceeds the amount being consumed by the DMA. To handle a
slow reader, a flow control mechanism is now introduced where file history generation
is throttled when a DMA is slow in consuming them. The value for this option indicates
2742
how frequently should the file history be resent if it was throttled. The default value is
250 milliseconds. This option is persistent across reboots.
The -option-value for this parameter should be a number.
[-fh-node-retry-interval <integer>] - FH Throttle Value for Node (privilege: advanced)
NDMP protocol sends back file history information for all files in phase 4 of dump
history being generated exceeds the amount being consumed by the DMA. To handle
slow reader conditions, a flow control mechanism is now introduced where file history
generation is throttled when a DMA is slow in consuming them. The value for this option
indicates how frequently should the file history be resent if it was throttled. The default
value is 250 milliseconds. This option is persistent across reboots.
[-restore-vm-cache-size <integer>] - Restore VM File Cache Size (privilege: advanced)
This option mandates the number of WAFL buffers pinned in memory by various metafiles used by logical restore. The minimum and maximum values are 4 and 1024,
respectively. The default value for this option is 64. This option is persistent across
reboots.
Depending on the value of this option, various meta-files are assigned a number of
WAFL buffers that need to be pinned in memory.
+-----------------+---------------------------------+
| Meta-filename
Number of WAFL buffers to

be pinned in memory
|
|
+-----------------+---------------------------------+
| dumpmap
| ndmpd.restore.vm_cache_size
| filemap
| aclfile_map
| inomap
| ndmpd.restore.vm_cache_size / 2 |
| basemap
| flipmap
| revmap
| clrimap
| mfp_for_inotab
| map
| offsetfile_map
+-----------------+---------------------------------+
2743
The -option-value for this parameter should be a number between 4 and 1024.
[-enable {true|false}] - Enable NDMP on Vserver
When the option is set to true, the NDMP daemon handles requests, and when set to
false, the NDMP daemon does not handle requests. Enabling and disabling the option is
equivalent to executing the following commands: vserver services ndmp on and vserver
services ndmp off respectively. This option is persistent across reboots. The default
value of this option is false.
The -option-value for this parameter is either true or false.
[-preferred-interface-role {cluster|data|node-mgmt|intercluster|cluster-mgmt}, ...] Preferred Interface Role
This option allows the user to specify the preferred Logical Interface (LIF) role while
establishing an NDMP data connection channel. The NDMP data server or the NDMP
mover establishes a data channel from the node that owns the volume or the tape
device respectively. This option is used on the node that owns the volume or the tape
device. The order of IP addresses that are used to establish the data connection
depends on the order of LIF roles specified in this option.
The default value for this option for the admin Vserver is intercluster, cluster-mgmt,
node-mgmt
The default value for this option for a data Vserver is intercluster, data.
[-secondary-debug-filter <text>] - Secondary Debug Filter (privilege: advanced)
This option allows control on NDMP debug logging. This option takes a comma
separated tag=value pairs. The supported tag is IPADDR which can be used to specify
Vserver IP addresses for which NDMP debugging is required. If this option is set and
the option debug-enable is set to true, then the debug-filter option is applicable to
sessions whose control connection IP addresses match the IP addresses that are
listed in the option. If this option is not set, the debug filter is applicable to all Vserver
sessions. By default, this option does not have a value set.
[-is-secure-control-connection-enabled {true|false}] - Is Secure Control Connection
Enabled
This option enables NDMP service to accept control connections over secure sockets
on TCP port 30000. This option is persistent across reboots. The default value of this
option is false.
Examples
The following example show how to enable NDMP on a Vserver and set authorization
type to plaintext :
2744
cluster1::> vserver services ndmp modify -vserver vs1 -enable true -authtype
plaintext
cluster1::>
vserver services ndmp off

Disable NDMP service
Description
This command is used to disable NDMP service on a specific Vserver.
Parameters
2745
reboots.
262,144(256K).
reboots.
2746

reboots.
2747
ndmpp.
| Modules
| Description
+--------------+-------------------------------------+
| verbose
| verbose message
| io
| I/O process loop
| io_loop
| ndmps
| NDMP service
| ndmpp
| NDMP Protocol
| rpc
| fdc_rpc
| auth
| Authentication
| mover
| data
| scsi
| bkup_rpc
| bkup_rpc_s
| conf
| dblade
| timer
| vldb
| VLDB service
| smf
| common
| NDMP common state
| ext
| ndmprpc
+--------------+-------------------------------------+
2748
reboots.
2749
reboots.
+-----------------+---------------------------------+
| Meta-filename

be pinned in memory
|
|
+-----------------+---------------------------------+
| dumpmap
| filemap
| aclfile_map
| inomap
| basemap
| flipmap
| revmap
| clrimap
| mfp_for_inotab
| map
| offsetfile_map
+-----------------+---------------------------------+
2750
node-mgmt
Enabled
option is false.
Examples
The following example disables NDMP on a specific Vserver:
2751
cluster1::> vserver services ndmp off -vserver vs1
See Also
2752
vserver services ndmp on

Enable NDMP service
Description
This command is used to enable NDMP service on a specific Vserver.
Parameters
2753

reboots.
262,144(256K).
reboots.
2754
reboots.
2755
ndmpp.
| Modules
| Description
+--------------+-------------------------------------+
| verbose
| verbose message
| io
| I/O process loop
| io_loop
| ndmps
| NDMP service
| ndmpp
| NDMP Protocol
| rpc
| fdc_rpc
| auth
| Authentication
| mover
| data
| scsi
| bkup_rpc
| bkup_rpc_s
| conf
| dblade
| timer
| vldb
| VLDB service
| smf
| common
| NDMP common state
| ext
| ndmprpc
+--------------+-------------------------------------+
2756
reboots.
2757
reboots.
+-----------------+---------------------------------+
| Meta-filename

be pinned in memory
|
|
+-----------------+---------------------------------+
| dumpmap
| filemap
| aclfile_map
| inomap
| basemap
| flipmap
| revmap
| clrimap
| mfp_for_inotab
| map
| offsetfile_map
+-----------------+---------------------------------+
2758
node-mgmt
Enabled
option is false.
Examples
The following example enables NDMP service on a specific Vserver:
2759
cluster1::> vserver services ndmp on -vserver vs1
See Also
2760
vserver services ndmp probe

Display list of NDMP sessions
Description
The system services ndmp probe command displays diagnostic information about
NDMP sessions belonging to a specific Vserver in the cluster. The following fields are
displayed for each of the sessions:
Vserver
Session identifier
NDMP version
Session authorized
Data state
Data operation
Data server halt reason
Data server connect type
Data server connect address
Data server connect port
Data bytes processed
Mover state
Mover mode
Mover pause reason
Mover halt reason
Mover record size
Mover record number
Mover bytes moved
Mover seek position
2761
Mover bytes left to read

Mover window offset
Mover window length
Mover position
Mover SetRecordSize flag
Mover SetWindow flag
Mover connect type
Mover connect address
Mover connect port
Effective host
NDMP client address
NDMP client port
SCSI device ID
SCSI hostadapter
SCSI target ID
SCSI LUN ID
Tape device
Tape mode
Node
Is Secure Control Connection
Data Backup Mode
Data Path
NDMP Source Address
Parameters
Specifies the Vserver context in which NDMP sessions are running.
-session-id <text> - Session Identifier
2762
If this parameter is specified, the command displays information about a specific NDMP
session. A session-id is a string used to identify a particular NDMP session.
Examples
The following example displays diagnostic information about all the sessions in the
cluster:
cluster1::> vserver services ndmp probe
Vserver Name: vserver1
Session Identifier: 1000:7445
NDMP Version: 4
Session Authorized: true
Data State: IDLE
Data Operation: NOACTION
Data Server Halt Reason: NA
....
...
NDMP Version: 4
Data State: IDLE
....
...
The following example displays diagnostic information of sessions associated with

Vserver vserver1 only:
cluster1::> vserver services ndmp probe -vserver vserver1
NDMP Version: 4
2763
Data State: IDLE

....
...
....
...
See Also
vserver services ndmp status system services ndmp probe
2764
vserver services ndmp show

Display NDMP Properties
Description
This command is used to display NDMP options on Vservers.
A combination of parameters can be optionally specified so as to list only a subset of
Vservers where specific values of NDMP options are met. A short description of each of
the options is provided in the parameters section.
Parameters
specify.
| [-instance ] }
about all fields.
If this parameter is specified, the command displays NDMP options for that Vserver
alone.
If this parameter is specified, the command displays NDMP options for Vservers where
the highest NDMP protocol version supported matches the specified input value. The
only supported value is 4.
If this parameter is specified, the command displays NDMP options for Vservers, where
the value for ignore-ctime-enabled matches the specified input value.
2765
The possible value for this parameter is either true or false.
the value for offset-map-enable matches the specified input value.
the value for tcpnodelay matches the specified input value.
This parameter Enables/Disables the TCPNODELAY configuration parameter for
the socket between the Vserver and the DMA. When set to true, the Nagle algorithm
is disabled and small packets are sent immediately rather than held and bundled
with other small packets. This optimizes the system for response time rather than
throughput.
reboots.
the value for tcpwinsize matches the specified input value.
This option shows the TCP buffer size of the NDMP data connection.The minimum and
maximum values are 8192(8K) and 262,144(256K), respectively. The default value for
this option is 32768(32K).
2766

The possible value for this parameter is a number between 8192(8K) and
262,144(256K).
the value for data-port-range matches the specified input value.
This option shows the port range on which the NDMP server can listen for data
connections.
reboots.
The value for this option is displayed in the format {<start_port>-<end port> | all }- where
start_port, end_port can have values between [1024-65535]; start_port must be lesser
than or equal to end_port.
the value for >backup-log-enable matches the specified input value.
mroot/etc/log/backup on the root volume. The default value for this option is true. This
option is persistent across reboots.
The possible value for this parameter is true/false.
the value for per-qtree-exclude-enable matches the specified input value.
2767
the value for authtype matches the specified input value.
The possible value for this parameter can be {challenge | plaintext | challenge, plaintext |
plaintext, challenge}.
the value for debug-enable matches the specified input value.
the value for debug-filter matches the specified input value.
2768
ndmpp.
| Modules
| Description
+--------------+-------------------------------------+
| verbose
| verbose message
| io
| I/O process loop
| io_loop
| ndmps
| NDMP service
| ndmpp
| NDMP Protocol
| rpc
| fdc_rpc
| auth
| Authentication
| mover
| data
| scsi
| bkup_rpc
| bkup_rpc_s
| conf
| dblade
| timer
| vldb
| VLDB service
| smf
| common
| NDMP common state
| ext
| ndmprpc
+--------------+-------------------------------------+
The possible value for this parameter can be {all | none | normal | backend |'filterexpression'}.
2769

the value for dump-logical-find matches the specified input value.
The possible value for this parameter could be {default | always | 'vol_baseline' |
the value for abort-on-disk-error matches the specified input value.
reboots.
The value for this parameter is either true or false.
the value for fh-dir-retry-interval matches the specified input value.
2770
The value for this parameter is a number.
the value for fh-node-retry-interval matches the specified input value.
The value for this parameter is a number.
the value for restore-vm-cache-size matches the specified input value.
reboots.
+-----------------+---------------------------------+
| Meta-filename

be pinned in memory
|
|
+-----------------+---------------------------------+
| dumpmap
| filemap
| aclfile_map
| inomap
| basemap
| flipmap
| revmap
| clrimap
2771
| mfp_for_inotab
| map
| offsetfile_map
+-----------------+---------------------------------+
The possible value for this parameter is a number between 4 and 1024.
the value for enable matches the specified input value.
The value for this parameter is either true or false.
the value for preferred-interface-role matches the specified input value.
node-mgmt
the value for secondary-debug-filter matches the specified input value.
2772
Enabled
the value for is-secure-control-connection-enabled matches the specified
input value.
option is false.
Examples
The following example displays NDMP options for the Vserver(s).
cluster1::> vserver services ndmp show
VServer
Enabled
Authentication type
------------- --------- ------------------cluster
true
plaintext
vs1
true
plaintext
vs2
true
plaintext

cluster1::>
The following example displays detailed NDMP options for a Vserver.

cluster1::*> vserver services ndmp show -vserver vs1 -instance
Vserver: vs1
NDMP Version: 4
Ignore Ctime: false
Enable Offset Map: true
Enable TCP Nodelay: false
TCP Window Size: 32768
Data Port Range: all
Enable Backup Log: true
Enable per Qtree Exclusion: false
Authentication Type: plaintext
Enable Debug: false
Debug Filter: none
2773
Enable Logical Find for Dump: default

Enable Abort on Disk Error: false
FH Throttle Value for Dir: 250
FH Throttle Value for Node: 250
Restore VM File Cache Size: 64
Enable Logging of VM Stats for Dump: false
Enable NDMP on Vserver: true
Preferred Interface Role: intercluster, data
Secondary Debug Filter: Is Secure Control Connection Enabled: false
cluster1::*>
2774
vserver services ndmp status

Display list of NDMP sessions
Description
The vserver services ndmp status command lists NDMP sessions belonging to
a specific Vserver in the cluster. By default it lists the following details about the active
sessions:
Vserver Name
Session ID
A combination of parameters can be optionally supplied so as to list only those sessions
which match specific conditions. A short description of each of the parameter is provided
in the parameters section.
Parameters
This optional parameter specifies which all additional fields to display. Any combination
of the following fields are valid:
ndmp-version
session-authorized
data-state
data-operation
data-halt-reason
data-con-addr-type
data-con-addr
data-con-port
data-bytes-processed
mover-state
2775
mover-mode
mover-pause-reason
mover-halt-reason
mover-record-size
mover-record-num
mover-bytes-moved
mover-seek-position
mover-bytes-left-to-read
mover-window-offset
mover-window-length
mover-position
mover-setrecordsize-flag
mover-setwindow-flag
mover-con-addr-type
mover-con-addr
mover-con-port
eff-host
client-addr
client-port
spt-device-id
spt-ha
spt-scsi-id
spt-scsi-lun
tape-device
tape-modes
node
is-secure-control-connection
data-backup-mode
2776
data-path
source-addr
| [-instance ] }
If this parameter is specified, the command displays detailed information about all the
active sessions.
Specifies the Vserver context in which NDMP sessions are running.
[-session-id <text>] - Session Identifier
If this parameter is specified, the command displays information about specific NDMP
session. A session-id is a string used to identify a particular NDMP session.
[-ndmp-version <integer>] - NDMP Version
This parameter refers to the NDMP protocol version being used in the session.
[-session-authorized {true|false}] - Session Authorized
This field indicates whether an NDMP session is authenticated or not.
[-data-state <component state>] - Data State
This field identifies the current state of the data server's state machine.
[-data-operation <data operation>] - Data Operation
This field identifies the data server's current operation.
[-data-halt-reason <halt reason>] - Data Server Halt Reason
This field identifies the event that caused the data server state machine to enter the
HALTED state.
[-data-con-addr-type <address type>] - Data Server Connect Type
This field specifies the type of data connection established by the data server. The
data connection can be established locally within a given system or between remote
networked systems.
[-data-con-addr <text>] - Data Server Connect Address
This specifies the connection endpoint information for the data server's data connection.
[-data-con-port <integer>] - Data Server Connect Port
This specifies the TCP/IP port that the data server will use when establishing a data
connection.
2777
[-data-bytes-processed <integer>] - Data Bytes Processed

This field represents the cumulative number of data stream bytes transferred between
the backup or recovery method and the data connection during the current data
operation.
[-mover-state <component state>] - Mover State
This parameter identifies the current state of the NDMP tape server's mover state
machine.
[-mover-mode <mover mode>] - Mover Mode
This parameter identifies the direction of the mover data transfer.
[-mover-pause-reason <pause reason>] - Mover Pause Reason
This parameter identifies the event that caused the mover state machine to enter the
PAUSED state.
[-mover-halt-reason <halt reason>] - Mover Halt Reason
This integer field identifies the event that caused the mover state machine to enter the
HALTED state.
[-mover-record-size <integer>] - Mover Record Size
This field represents the current mover record size in bytes.
[-mover-record-num <integer>] - Mover Record Number
This field represents the last tape record processed by the mover.
[-mover-bytes-moved <integer>] - Mover Bytes Moved
This field represents the cumulative number of data stream bytes written to the data
connection or the number of data stream bytes read from the data connection and
written to the tape subsystem, depending on the mode of mover operation.
[-mover-seek-position <integer>] - Mover Seek Position
This field represents the data stream offset of the first byte the DMA requested the
mover to transfer to the data connection during a mover read operation.
[-mover-bytes-left-to-read <integer>] - Mover Bytes Left to Read
This field represents the number of data bytes remaining to be transferred to the data
connection to satisfy the current NDMP_MOVER_READ request.
[-mover-window-offset <integer>] - Mover Window Offset
This field represents the absolute offset of the first byte of the mover window within the
overall data stream.
2778
[-mover-window-length <integer>] - Mover Window Length

This field represents the length of the current mover window in bytes.
[-mover-position <integer>] - Mover Position
This parameter can be used to list only those sessions, whose mover position matches
a specific value. Mover-position should be an integer.
[-mover-setrecordsize-flag {true|false}] - Mover SetRecordSize Flag
This field is used by the DMA to establish the record size used for mover-initiated tape
read and write operations.
[-mover-setwindow-flag {true|false}] - Mover SetWindow Flag
This flag represents whether a mover window has been set or not. A mover window
represents the portion of the overall backup stream that is accessible to the mover
without intervening DMA tape manipulation.
[-mover-con-addr-type <address type>] - Mover Connect Type
This field specifies the type of data connection established by the mover. The data
connection can be established locally within a given system or between remote
networked systems.
[-mover-con-addr <text>] - Mover Connect Address
This specifies the endpoint address or addresses that the mover will use when
establishing a data connection.
[-mover-con-port <integer>] - Mover Connect Port
This specifies the TCP/IP port that the mover will use when establishing a data
connection.
[-eff-host <host type>] - Effective Host
This field indicates the host context in which the NDMP session runs. The valid values
are: PRIMARY or PARTNER.
[-client-addr <text>] - NDMP Client Address
This parameter specifies the client's IP address.
[-client-port <integer>] - NDMP Client Port
This parameter specifies the client's port number.
[-spt-device-id <text>] - SCSI Device ID
This parameter specifies the SCSI device ID.
2779
[-spt-ha <integer>] - SCSI Host Adapter

This parameter specifies the SCSI host adapter.
[-spt-scsi-id <integer>] - SCSI Target ID
This parameter specifies the SCSI target.
[-spt-scsi-lun <integer>] - SCSI LUN ID
This parameter specifies the SCSI LUN ID.
[-tape-device <text>] - Tape Device
This parameter specifies the name to identify the tape device.
[-tape-mode <mover mode>] - Tape Mode
This parameter specifies the mode in which tapes are opened.
[-is-secure-control-connection {true|false}] - Is Secure Control Connection
This parameter specifies whether the control connection is secure or not.
[-data-backup-mode <text>] - Data Backup Mode
This parameter specifies whether the mode of data backup is Dump or SMTape.
[-data-path <text>] - Data Path
This parameter specifies the path of data being backed up.
[-source-addr <text>] - NDMP Source Address
This parameter specifies the control connection IP address of the NDMP session.
Examples
The following example displays all the NDMP sessions on the cluster:
cluster1::> vserver services ndmp status
Session
Vserver
------------------
2780
Id
------------
vserver1
1000:7445
vserver2
1000:7446
vserver2
1000:7447
The following example shows how to display only the sessions running belonging to
Vserver vserver2:
cluster1::> vserver services ndmp status -vserver vserver2
Session
Vserver
Id
------------------
------------
vserver2
1000:7446
vserver2
1000:7447
2781
vserver services ndmp extensions modify

Modify NDMP extension status
privilege level.
Description
This command is used to enable/disable an NDMP extension in the Vserver-aware
NDMP mode.
Parameters
[-is-extension-0x2050-enabled {true|false}] - Is Extension 0x2050 Enabled
If this parameter is specified, the command can be used to modify the status of the
extension in the Vserver-aware mode.
Examples
The following example shows how to enable NDMP extenion 0x2050 in the Vserveraware NDMP mode of operation:
cluster1::> vserver services ndmp extension modify -is-extension-0x2050enabled true
cluster1::>
vserver services ndmp extensions show

Display NDMP extension status
privilege level.
Description
This command displays whether an NDMP extension is enabled in the Vserver-aware
NDMP mode or not.
2782
Parameters
None
Examples
The following example shows how to check the status of NDMP extension 0x2050 in a
cluster :
cluster1::> vserver services ndmp extension show
Is Extension 0x2050 Enabled: true
cluster1::>
vserver services ndmp log start

Start logging for the specified NDMP session
Description
This command is used to start logging on an active NDMP session on a vserver.
Parameters
This parameter specifies the NDMP session-id on which logging needs to be started.
-filter <text> - Level Filter
Use this parameter to specify the filter for a particular session ID. This parameter
controls the NDMP modules for which logging is to be enabled. This parameter can take
five values. They are as follow : all, none, normal, backend or "filter-expression". The
default value for this is none.
2783
all turns on logging for all modules.

none disables logging for all modules.
normal is a short cut parameter that enables logging for all modules except
verbose and io_loop. The equivalent filter string is all-verbose-io_loop
backend is a short cut parameter that enables logging for all modules except
verbose, io_loop, ndmps and ndmpd. The equivalent filter string is all-verboseio_loop-ndmps-ndmpp
(filter-expression) is a combination of one or more modules for which logs
needs to be enabled. Multiple module names can be combined using following
operators :
- to remove the given module from the list of specified modules in the filter
string. For example the filter all-ndmpp will enable logging for all modules
but not ndmpp.
^ to add the given module or modules to the list of modules specified in the
filter string. For example the filter ndmpp^mover^data will enable logging for
The possible module names and a brief description is given below:
+-------------+-------------------------------------+
| Modules
| Description
|
+-------------+-------------------------------------+
| verbose
| verbose message
| io
| I/O process loop
| io_loop
| I/O process loop verbose
| ndmps
| NDMP service
| ndmpp
| NDMP Protocol
| rpc
| fdc_rpc
| auth
| Authentication
| mover
|
|
messages
|
|
|
|
|
|
|
2784
restore)
| data
| NDMP DATA (backup/
| scsi
| NDMP SCSI (robot/tape
| bkup_rpc
| bkup_rpc_s
| cleaner
| Backup/Mover session
| conf
| Debug configure/
| dblade
| timer
| NDMP server timeout
| vldb
| VLDB service
| smf
| vol
| VOL OPS service
| sv
| SnapVault NDMP extension
| common
| NDMP common state
| ext
| sm
| SnapMirror NDMP
| ndmprpc
ops)
client
server
cleaner
reconfigure
|
|
messages
|
|
|
|
|
|
|
extension
|
|
+--------------
+-------------------------------------+
Examples
The following example shows how to start logging on a specific NDMP session
1000:35512, running on vserver cluster1-01 with filter all.
cluster1::*> vserver services ndmp log start -vserver
cluster1-01 -session-id 1000:35512 -filter all
vserver services ndmp log stop

Stop logging for the specified NDMP session
2785

Description
This command is used to stop logging on an active NDMP session on a vserver.
Parameters
This parameter specifies the NDMP session-id on which logging needs to be stopped.
Examples
The following example shows how to stop logging on a specific NDMP session
1000:35512 , running on vserver cluster1-01.
cluster1::*> vserver services ndmp log stop -vserver
cluster1-01 -session-id 1000:35512
vserver services web modify

Modify the configuration of web services
level.
Description
This command modifies the availability of the web services on Vservers. Only the
services that are installed on every node in the cluster can be configured on Vservers
whose type is not 'node'. Enabled services must include authorization configuration
in the vserver services web access command for the services to be externally
available.
Parameters
2786
Identifies a Vserver for hosting a specific web service.

-name <text> - Service Name
Identifies the name of the web service.
Defines the availability of a service on the Vserver. Disabled services are not accessible
through the Vserver's network interfaces. This parameter's default value is dependent
on the service. In general, services that provide commonly used features are enabled by
default.
[-ssl-only {true|false}] - SSL Only
Defines the encryption enforcement policy for a service on the Vserver. Services
for which this parameter is set to true support SSL only and cannot be used over
unencrypted HTTP. The default for this value is 'false'.
Examples
The following command sets access to the web port to SSL only:
cluster1::> vserver services web modify -vserver vs1 -name portal -ssl-only true
See Also
system services web packages vserver services web access
2787
vserver services web show

Display the current configuration of web services
level.
Description
This command displays the availability of the web services on Vservers. Only the
services that are installed on every node in the cluster can be configured on Vservers
whose type is not 'node'. Enabled services must include authorization configuration
in the vserver services web access command for the services to be externally
available.
Parameters
specify.
| [-instance ] }
about all fields.
[-name <text>] - Service Name
[-type <vserver type>] - Type of Vserver
Identifies the type of Vserver on which the service is hosted.
[-version <text>] - Version of Web Service
Defines the version number of the service in the format of major.minor.patch.
[-description <text>] - Description of Web Service
Provides a short description of the web service.
2788
[-long-description <text>] - Long Description of Web Service

Provides a long description of the web service.
[-requires <requirement>, ...] - Service Requirements
Defines the list of requirements that must be met for the service to be successfully
executed. Requirements are defined as a service name, a comparison operator (<=>),
and a version number.
[-default-roles <text>, ...] - Default Authorized Roles
Defines the roles that are automatically granted access to the service in the vserver
services web access show configuration.
Defines the availability of a service on the Vserver. Disabled services are not accessible
through the Vserver's network interfaces. This parameter's default value is dependent
on the service. In general, services that provide commonly used features are enabled by
default.
[-ssl-only {true|false}] - SSL Only
Defines the encryption enforcement policy for a service on the Vserver. Services
for which this parameter is set to true support SSL only and cannot be used over
unencrypted HTTP. The default for this value is 'false'.
Examples
This example displays the availability of the web services on the Vservers.
cluster1::vserver services web> show
Vserver
Type
Service Name
Description
Enabled
-------------- -------- ---------------- ----------------------------- ------cluster1
admin
cem
OBSOLETE
true
cluster1
admin
ontapi
Remote Administrative API
true
cluster1
admin
portal
Data ONTAP Web Services
true
Portal
n6070-8
node
cem
OBSOLETE
true
n6070-8
node
ontapi
true
n6070-8
node
portal
true
n6070-8
node
spi
Portal
Service Processor
false
Infrastructure
n6070-8
node
supdiag
Support Diagnostics
true
Support
2789
n6070-9
node
cem
OBSOLETE
true
n6070-9
node
ontapi
true
n6070-9
node
portal
true
n6070-9
node
spi
Portal
Service Processor
false
Infrastructure
n6070-9
node
supdiag
Support Diagnostics
false
Support
See Also
vserver services web access show system services web packages
vserver services web access
2790
vserver services web access create

Authorize a new role for web service access
level.
Description
This command authorizes roles to access the Vserver's web services. For the user to
access services that require authentication, the user's roles, as defined by security
login show, must be included in this configuration.
Note:
Node Vserver services are authorized with the data Vserver's roles.
Parameters
Identifies the new role to be authorized for this service.
Examples
The following example authorizes the role auditor - created previously - for the web
service:
cluster1::> vserver services web access create -name ontapi -role auditor
See Also
security login show
2791
vserver services web access delete

Remove role authorization for web service access
level.
Description
This command removes the authorization of a role from the Vserver's web services. A
service for which no roles are defined has a single role of 'none' automatically displayed
in this configuration.
Note:
Parameters
Identifies the role whose authorization is to be removed. You cannot remove the
authorization of the role 'none'. Use vserver services web access create to
authorize access for the role.
Examples
The following example removes authorization for the role auditor for the web service:
cluster1::> vserver services web access delete -name ontapi -role auditor
See Also
vserver services web access create
2792
vserver services web access show

Display web service authorization for user roles
level.
Description
This command displays the roles that are authorized to access the Vserver's web
services. For the user to access services that require authentication, the user's roles, as
defined by security login show, must be included in this configuration.
Note:
Parameters
specify.
| [-instance ] }
about all fields.
[-name <text>] - Service Name
Identifies a role assigned for accessing the service. A service without any authorizations
has a role of 'none' assigned to it automatically.
[-type <vserver type>] - Type of Vserver
Identifies the type of Vserver on which the service is hosted.
2793
Examples
The following example displays the roles that are authorized to access the web services.
cluster1::vserver services web access> show
Vserver
Type
Service Name
Role
-------------- -------- ---------------- ---------------cluster1
admin
cem
none
cluster1
admin
ontapi
readonly
cluster1
admin
portal
none
cluster1
admin
spi
none
cluster1
admin
supdiag
none
vs0
cluster
ontapi
admin

cluster1::vserver services web access>
See Also
security login show
2794
vserver smtape break

Make a restored volume read-write
Description
This command breaks the relationship between the tape backup of a volume and a
restored volume, changing the restored volume from read-only to read/write.
Parameters
Use this parameter to specify the Vserver name on which the volume is located.
Use this parameter to specify the name of the read-only volume that needs to be
changed into a read/writeable volume after an smtape restore.
Examples
Make the read-only volume datavol on Vserver vserver0 writeable after a restore.
cluster1::> vserver smtape break -vserver vserver0 -volume datavol
[Job 84] Job succeeded: SnapMirror Break Succeeded
See Also
2795
vserver vscan disable

Disable Vscan on a Vserver
Description
The vserver vscan disable command disables Vscan on a Vserver.
Note:
Parameters
This parameter specifies the name of the Vserver on which you want to disable Vscan.
Examples
The following example disables Vscan on Vserver vs1.
cluster1::> vserver vscan disable -vserver vs1
cluster1::> vserver vscan show -vserver vs1
Vserver: vs1
Vscan Status: off
vserver vscan enable

Enable Vscan on a Vserver
2796
Description
The vserver vscan enable command enables Vscan on a Vserver.
Note:
Parameters
This parameter specifies the name of the Vserver on which you want to enable Vscan.
The Vscan configuration must already exist.
Examples
The following example enables Vscan on Vserver vs1.
cluster1::> vserver vscan enable -vserver vs1
cluster1::> vserver vscan show -vserver vs1
Vserver: vs1
Vscan Status: on
vserver vscan reset

Discard cached scan information
Description
The vserver vscan reset command discards the cached information of the files
that have been successfully scanned. After running this command, the files are scanned
again when they are accessed.
Note:
2797
Parameters
This parameter specifies the name of the Vserver for which you want to discard the
cached information.
Examples
The following example discards the cached information of the successfully scanned
files.
cluster1::> vserver vscan reset -vserver vs1
Warning: Running this command can cause performance degradation because files are
scanned again when they are accessed.
cluster1::>
2798
vserver vscan show

Display Vscan status
Description
The vserver vscan show command displays Vscan status information of the
Vservers. If you do not specify any parameters, the command displays the following
information about all Vservers:
Vserver name
Vscan status
Note:
Parameters
specify.
| [-instance ] }
about all fields.
Vserver.
[-vscan-status {on|off}] - Vscan Status
that have the specified status.
Examples
2799
The following example displays the Vscan status information.

cluster1::> vserver vscan show
Vserver
Vscan Status
--------------
------------
vs1
on
vs2
off
vserver vscan connection-status show-all

Display Vscan servers connection status
Description
The vserver vscan connection-status show-all command displays
connection status information of the external virus-scanning servers, or "Vscan servers".
for all Vscan servers:
Vserver name
Node name
Vscan server
Connection status
Disconnect reason
In addition to the fields above, you can display the following fields:
Server type
Vscan server vendor
Vscan server version
Privileged user
2800
Vscan server connected since

Vscan server disconnected since
Vserver LIF used for connection
Note:
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays information only about the Vscan
servers attached to the specified node.
[-server-type <Server type>] - Server Type
[-vendor <text>] - Vscanner Vendor
2801
servers that are running scan-engine of the specified vendor.
[-version <text>] - Vscanner Version
servers that are running scan-engine of the specified version.
[-disconnect-reason <reason>] - Server Disconnect Reason
[-disconnected-since <MM/DD/YYYY HH:MM:SS>] - Time When Vscanner Was
Disconnected
[-privileged-user <text>] - Privileged User Used for Connection
servers that are connected to clustered Data ONTAP using the specified privileged user.
[-connected-since <MM/DD/YYYY HH:MM:SS>] - Time When Vscanner Was
Connected
[-lif <IP Address>] - Vserver LIF Used for Connection
servers that have used the specified IP address for connecting to clustered Data
ONTAP.
Examples
The following example displays connection-status information about all Vscan servers.
cluster1::> vserver vscan connection-status show-all
Connection
Vserver
Node
Server
Status
Disconnect Reason
----------- ----------------- --------------- -------------- -----------------
2802
vs1
Cluster-01
1.1.1.1
disconnected
remote-closed
vs1
Cluster-01
2.2.2.2
connected
vs2
Cluster-01
3.3.3.3
disconnected
no-data-lif
vs2
Cluster-01
4.4.4.4
disconnected
no-data-lif
The following example displays detailed connection-status information about all Vscan
servers which are connected.
cluster1::> vserver vscan connection-status show-all -instance
-server-status connected
Node: Cluster-01
Vserver: vs1
Server: 2.2.2.2
Server Status: connected
Vscanner Vendor: XYZ
Vscanner Version: 1.12.2
Server Disconnect Reason: Time When Server Was Disconnected: Privileged User Used for Connection: cifs\u2
Time When Server Was Connected: 6/3/2013 08:44:21
Vserver LIF Used for Connection: 10.238.41.223
2803
vserver vscan connection-status show-connected

Display connection status of connected Vscan servers
Description
The vserver vscan connection-status show-connected command displays
connection status information of the connected external virus-scanning servers, or
"Vscan servers". If you do not specify any parameters, the command displays the
following information for all Vscan servers:
Vserver name
Node name
Vscan server
Vscan server vendor
Privileged user
Server type
Vscan server version
Vscan server connected since
Vserver LIF used for connection
Note:
Parameters
specify.
2804
| [-instance ] }
about all fields.
[-vendor <text>] - Vscan Server Vendor
servers that are running scan-engine of the specified vendor.
[-version <text>] - Vscan Server Version
servers that are running scan-engine of the specified version.
[-privileged-user <text>] - Privileged User Used for Connection
servers that are connected to clustered Data ONTAP using the specified privileged user.
[-connected-since <MM/DD/YYYY HH:MM:SS>] - Time When Vscan Server Was
Connected
[-lif <IP Address>] - Vserver LIF Used for Connection
servers that have used the specified IP address for connecting to clustered Data
ONTAP.
2805
Examples
The following example displays connection-status information about all connected
Vscan servers.
cluster1::> vserver vscan connection-status show-connected
Privileged
Vserver
Node
Server
Vendor
User
------------- ----------------- ---------------- ------------- --------------vs1
Cluster-01
1.1.1.1
ABC
cifs\u2
vs1
Cluster-01
2.2.2.2
XYZ
cifs\u2
The following example displays detailed connection-status information about connected

Vscan servers which are running XYZ scan-engine.
cluster1::> vserver vscan connection-status show-connected -instance -vendor XYZ
Node: Cluster-01
Vserver: vs1
Server: 2.2.2.2
Vscanner Vendor: XYZ
Vscanner Version: 1.12
Privileged User Used for Connection: cifs\u2
Time When Vscanner Was Connected: 6/3/2013 08:44:21
Vserver LIF Used for Connection: 10.238.41.223
2806
vserver vscan connection-status show-notconnected

Display connection status of Vscan servers which are allowed to connect but not yet
connected
Description
The vserver vscan connection-status show-not-connected command
displays connection status information of the external virus-scanning servers, or "Vscan
servers" that are ready to accept connection but are not yet connected. This command
could be useful for troubleshooting. If you do not specify any parameters, the command
displays the following information for all Vscan servers:
Vserver name
Node name
Vscan server
Connection status
Disconnect reason
Server type
Vscan server disconnected since
Note:
Parameters
2807
specify.
| [-instance ] }
about all fields.
[-disconnect-reason <reason>] - Server Disconnect Reason
[-disconnected-since <MM/DD/YYYY HH:MM:SS>] - Time When Vscan Server Was
Disconnected
Examples
The following example displays connection-status information about all Vscan servers
which are ready to accept connection but not yet connected.
cluster1::> vserver vscan connection-status show-not-connected
2808
Vserver
Node
Connection
Disconnect
Status
Reason
Server
------------- ----------------- ---------------- ------------- --------------vs2
Cluster-01
3.3.3.3
disconnected
vs2
Cluster-01
4.4.4.4
disconnected
invalidsession-id
remote-closed
The following example displays detailed connection-status information about Vscan

servers which are disconnected because the connection is remotely closed.
cluster1::> vserver vscan connection-status show-not-connected -instance
-disconnect-reason remote-closed
Node: Cluster-01
Vserver: vs2
Server: 4.4.4.4
Server Status: disconnected
Server Disconnect Reason: remote-closed
Time When Vscanner Was Disconnected: 6/4/2013 06:51:32
2809
vserver vscan connection-status show

Display Vscan servers connection status summary
Description
The vserver vscan connection-status show command displays connection
status summary of the external virus-scanning servers, or "Vscan servers" for a Vserver.
for all Vservers:
Vserver name
Node name
List of connected Vscan servers
Connected count
Note:
Parameters
specify.
| [-instance ] }
about all fields.
2810
[-servers <IP Address>, ...] - List of Connected Vscan Servers
that have the specified server or servers.
[-connection-count <integer>] - Number of Connected Vscan Servers Serving the
Vserver
that have the specified connection count.
Examples
The following example displays connection-status summary for all Vservers.
cluster1::> vserver vscan connection-status show
Connected Connected
Vserver
Node
Server-Count Servers
--------------- ------------------- ------------ ----------------------------vs1
Cluster-01
2 1.1.1.1, 2.2.2.2
vs2
Cluster-01
0 -
2811
vserver vscan on-access-policy create

Create an On-Access policy
Description
The vserver vscan on-access-policy create command creates an On-Access
policy.
Note:
Parameters
This parameter specifies the name of the Vserver on which you want to create an OnAccess policy.
This parameter specifies the name of the On-Access policy that you want to create. An
On-Access policy name can be up to 256 characters long and is a string that can only
contain any combination of ASCII-range alphanumeric characters (a-z, A-Z, 0-9), "_", "-"
and ".".
-protocol <CIFS> - File-Access Protocol
This parameter specifies the protocol name for which the On-Access policy will be
created. Currently only CIFS is supported.
[-filters {scan-mandatory|scan-ro-volume|scan-execute-access}, ...] - Filters
This parameter specifies a list of filters which can be used to define the scope of the OnAccess policy more precisely. The list can include one or more of the following:
scan-mandatory - Enable mandatory scan. File access will be denied if there are
no external virus-scanning servers available for virus scanning.
scan-ro-volume - Enable scans for read-only volume.
scan-execute-access - Scan only files opened with execute-access (CIFS only).
2812
By default, it is scan-mandatory.
[-max-file-size {<integer>[KB|MB|GB|TB|PB]}] - Max File Size Allowed for Scanning
This parameter specifies the maximum size of the file which will be considered for virus
scanning. By default, it is 2GB.
[-paths-to-exclude <File path>, ...] - File-Paths Not to Scan
This parameter specifies a list of paths, separated by commas, to exclude from virus
scanning. The path given is from the root of Vserver and can be up to 255 characters
long. CIFS protocol based On-Access policies must use "\" as the path separator. The
path can be one of the following forms:
\dir1\dir2\name - This would match "\dir1\dir2\name" as well as "\dir1\dir2\name
\...".
\dir1\dir2\name\ - This would only match "\dir1\dir2\name\...".
Note:
If you are using the CLI, you must delimit all paths with double quotation marks ("). For
instance, to add the paths "\vol\a b\" and "\vol\a,b\" to the -paths-to-exclude in the
CLI, type "\vol\a b\","\vol\a,b\" at the command prompt. To add a "?" to the expression,
press ESC followed by the "?".
[-file-ext-to-exclude <File extension>, ...] - File-Extensions Not to Scan
This parameter specifies a list of file extensions, separated by commas, to exclude from
virus scanning. These file extensions can be up to 16 characters long. The -fileext-to-exclude supports wildcard patterns containing "*" and "?". Pattern matching
is defined as:
* - Matches any string, including the empty string. For example, mp* would match
mp, mp3, mp4, mpeg etc.
? - Matches any single character. For example, mp? would match mp3, mp4 but
not mp and mpeg.
Note:
If you are using the CLI, you must delimit all patterns with double quotation marks (").
For instance, to enter the pattern mp* in the CLI, type "mp*" at the command prompt. To
add a "?" to the expression, press ESC followed by the "?".
Examples
2813
The following example creates an On-Access policy.

cluster1::> vserver vscan on-access-policy create -vserver vs1 -policy-name test
-protocol CIFS -filters scan-ro-volume -max-file-size 3GB
-file-ext-to-exclude "mp3","txt" -paths-to-exclude "\vol\a b
\","\vol\a,b\"
cluster1::> vserver vscan on-access-policy show -vserver vs1 -policy-name test
Vserver: vs1
Policy: test
Policy Status: off
Policy Config Owner: vserver
File-Access Protocol: CIFS
Filters: scan-ro-volume
Max File Size Allowed for Scanning: 3GB
File-Paths Not to Scan: \vol\a b\, \vol\a,b\
File-Extensions Not to Scan: mp3, txt
2814
vserver vscan on-access-policy delete

Delete an On-Access policy
Description
The vserver vscan on-access-policy delete command deletes an On-Access
policy.
Note:
Parameters
This parameter specifies the name of the Vserver from which you want to delete an OnAccess policy.
This parameter specifies the name of the On-Access policy that you want to delete.
Examples
The following example deletes an On-Access policy.
cluster1::> vserver vscan on-access-policy delete -vserver vs1 -policy-name test
There are no entries matching your query.
2815
vserver vscan on-access-policy disable

Disable an On-Access policy
Description
The vserver vscan on-access-policy disable command disable an OnAccess policy for the specified Vserver.
Note:
Parameters
This parameter specifies the name of the Vserver on which you want to disable an
On-Access policy. The Vserver administrator can disable On-Access policies created
within the scope of the Vserver and can also disable an On-Access policy created by the
cluster administrator. The cluster administrator can disable On-Access policies for any
Vserver.
This parameter specifies the name of the On-Access policy you want to disable.
Examples
The following command disable an On-Access policy on specified Vserver.
cluster1::> vserver vscan on-access-policy disable -vserver vs1 -policy-name new
cluster1::> vserver vscan on-access-policy show -vserver vs1 -policy-name new
Vserver: vs1
Policy: new
Policy Status: off
2816
File-Paths Not to Scan: \vol\temp
File-Extensions Not to Scan: txt
2817
vserver vscan on-access-policy enable

Enable an On-Access policy
Description
The vserver vscan on-access-policy enable command enables an OnAccess policy for the specified Vserver. Only one On-Access policy of a specific protocol
can be enabled at one time.
Note:
Parameters
This parameter specifies the name of the Vserver on which you want to enable an OnAccess policy. The Vserver administrator can enable On-Access policy created within
the scope of the Vserver or the cluster. The cluster administrator can enable On-Access
policy for any Vserver but cannot enable them with a scope of cluster. The scope is
determined at a Vserver level.
This parameter specifies the name of the On-Access policy you want to enable.
Examples
The following command enables an On-Access policy on specified Vserver.
cluster1::> vserver vscan on-access-policy enable -vserver vs1 -policy-name new
cluster1::> vserver vscan on-access-policy show -vserver vs1 -policy-name new
Vserver: vs1
Policy: new
Policy Status: on
2818

2819
vserver vscan on-access-policy modify

Modify an On-Access policy
Description
The vserver vscan on-access-policy modify command modifies an OnAccess policy.
Note:
Parameters
This parameter specifies the name of the Vserver on which you want to modify an OnAccess policy.
This parameter specifies the name of the On-Access policy that you want to modify.
This parameter specifies a list of filters which can be used to define the scope of the OnAccess policy more precisely. The list can include one or more of the following:
scan-mandatory - Enable mandatory scan. File access will be denied if there are
no external virus-scanning servers available for virus scanning.
scan-ro-volume - Enable scans for read-only volume.
scan-execute-access - Scan only files opened with execute-access (CIFS only).
This parameter specifies the maximum size of the file which will be considered for virus
scanning.
2820
This parameter specifies a list of paths, separated by commas, to exclude from virus
scanning. The path given is from the root of Vserver and can be up to 255 characters
long. CIFS protocol based On-Access policies must use "\" as the path separator. The
path can be one of the following forms:
\dir1\dir2\name - This would match "\dir1\dir2\name" as well as "\dir1\dir2\name
\...".
\dir1\dir2\name\ - This would only match "\dir1\dir2\name\...".
Note:
If you are using the CLI, you must delimit all paths with double quotation marks ("). For
instance, to add the paths "\vol\a b\" and "\vol\a,b\" to the -paths-to-exclude in the
CLI, type "\vol\a b\","\vol\a,b\" at the command prompt. To add a "?" to the expression,
press ESC followed by the "?".
This parameter specifies a list of file extensions, separated by commas, to exclude from
virus scanning. These file extensions can be up to 16 characters long. The -fileext-to-exclude supports wildcard patterns containing "*" and "?". Pattern matching
is defined as:
* - Matches any string, including the empty string. For example, mp* would match
mp, mp3, mp4, mpeg etc.
? - Matches any single character. For example, mp? would match mp3, mp4 but
not mp and mpeg.
Note:
If you are using the CLI, you must delimit all patterns with double quotation marks (").
For instance, to enter the pattern mp* in the CLI, type "mp*" at the command prompt. To
add a "?" to the expression, press ESC followed by the "?".
Examples
The following example modifies an On-Access policy.
cluster1::> vserver vscan on-access-policy modify -vserver vs1 -policy-name test
-protocol CIFS -filters scan-ro-volume -max-file-size 10GB
-file-ext-to-exclude "mp3" -paths-to-exclude
"\vol1\temp","\vol2\a"
2821

Vserver: vs1
Policy: test
Policy Status: off
File-Paths Not to Scan: \vol1\temp, \vol2\a
File-Extensions Not to Scan: mp3
2822
vserver vscan on-access-policy show

Display On-Access policies
Description
The vserver vscan on-access-policy show command displays information
about the On-Access policies belonging to the Vserver. It also displays the current
status in Vserver scope. If you do not specify any parameters, the command displays
the following information about all On-Access policies:
Vserver name
Policy name
Policy status
Policy owner
Protocol
File paths to exclude
File extensions to exclude
about On-Access policies. In addition to the fields above, you can display the following
fields:
List of filters
Max file size
Note:
Parameters
2823
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays information only about the OnAccess policies for the specified Vserver.
On-Access policy.
[-policy-status {on|off}] - Policy Status
If you specify this parameter, the command displays information only about the OnAccess policies that have the specified status.
[-owner <Configuration owner>] - Policy Config Owner
If you specify this parameter, the command displays information only about the OnAccess policies that have the specified owner.
[-protocol <CIFS>] - File-Access Protocol
If you specify this parameter, the command displays information only about the OnAccess policies that have the specified protocol.
If you specify this parameter, the command displays information only about the OnAccess policies that have the specified filter or filters in the filter list.
If you specify this parameter, the command displays information only about the OnAccess policies that have the specified max-file-size.
If you specify this parameter, the command displays information only about the OnAccess policies that have the specified path or paths in the exclude list.
2824
If you specify this parameter, the command displays information only about the OnAccess policies that have the specified file extension or extensions in the exclude list.
Examples
The following example displays information about all On-Access policies.
cluster1::> vserver vscan on-access-policy show
Vserver
Policy
Policy
Name
Owner
Protocol Paths Excluded
File-Ext
Policy
Excluded
Status
----------- ---------
-------- -------- ----------------- ----------- ------
Cluster
cluster
CIFS
off
cluster
CIFS
on
default_
CIFS
vs1
default_
CIFS
vs1
new
vserver
CIFS
\vol\temp
txt
off
vs2
default_
cluster
CIFS
on
CIFS
The following example displays detailed information about an On-Access policy.

cluster1::> vserver vscan on-access-policy show -instance -vserver vs1 -policyname new
Vserver: vs1
Policy: new
Policy Status: off
2825
vserver vscan scanner-pool apply-policy

Apply scanner-policy to a scanner pool
Description
The vserver vscan scanner-pool apply-policy command applies a scanner
policy to the specified scanner pool on a specified Vserver.
Note:
Parameters
This parameter specifies the name of the Vserver on which you want to apply the
scanner policy. The Vserver administrator can apply the scanner policy to a scanner
pool created within the scope of the Vserver or the cluster. The cluster administrator can
apply the scanner policy to a scanner pool for any Vserver but cannot apply it within the
scope of cluster. The scope is determined at a Vserver level.
-scanner-pool <Scanner pool> - Scanner Pool
This parameter specifies the name of the scanner pool.
-scanner-policy <Scanner policy> - Scanner Policy
This parameter specifies the scanner policy that you want to apply to the specified
scanner pool on a Vserver. Currently only system policies are available. Available
system policies are:
primary - Makes it active always.
secondary - Makes it active only when none of the primary external virus-scanning
servers are connected.
idle - Makes it inactive always.
[-cluster <Cluster name>] - Cluster on Which Policy Is Applied
2826
This parameter specifies the name of the cluster on which you want to apply the
scanner policy of a scanner pool. By default, it is applied on the local cluster. This
parameter does not have any significance if the cluster is not in a DR relationship.
Examples
The following command applies a scanner policy to the specified scanner pool on a
specified Vserver.
cluster1::> vserver vscan scanner-pool apply-policy -vserver vs1
-scanner-pool p1 -scanner-policy primary -cluster cluster2
cluster1::> vserver vscan scanner-pool show -vserver vs1 -scanner-pool p1
Vserver: vs1
Scanner Pool: p1
Applied Policy: primary
Current Status: on
Cluster on Which Policy Is Applied: cluster2
Scanner Pool Config Owner: vserver
List of IPs of Allowed Vscan Servers: 1.1.1.1, 2.2.2.2
List of Privileged Users: cifs\u1, cifs\u2
2827
vserver vscan scanner-pool create

Create a scanner pool
Description
The vserver vscan scanner-pool create command creates a Vscan scanner
pool. Scanner pool is a set of attributes which are used to validate and manage
connection between clustered Data ONTAP and external virus-scanning server, or
"Vscan server". It also specifies other parameters which are used for connection
management. After creating a scanner pool, a scanner-policy must be applied to it using
the command vserver vscan scanner-pool apply-policy. The default applied
policy is idle, which means the scanner pool is inactive.
Note:
Parameters
This parameter specifies the name of the Vserver on which you want to create a
scanner pool.
This parameter specifies the name of the scanner pool. Scanner pool name can be up
to 256 characters long and is a string that can only contain any combination of ASCIIrange alphanumeric characters (a-z, A-Z, 0-9), "_", "-" and ".".
-servers <IP Address>, ... - List of IPs of Allowed Vscan Servers
This parameter specifies a list of IP addresses of the Vscan servers which are allowed
to connect to clustered Data ONTAP.
-privileged-users <Privileged user>, ... - List of Privileged Users
This parameter specifies a list of privileged users. A valid form of privileged username is "domain-name\user-name" and can be up to 256 characters long. Privileged
user-names are stored and treated as case-insensitive strings. Virus scanners must
use one of the registered privileged users for connecting to clustered Data ONTAP
2828
for exchanging virus-scanning protocol messages and to access file for scanning,
remedying and quarantining operations.
[-request-timeout <[<integer>h][<integer>m][<integer>s]>] - Request Service Timeout
This parameter specifies the timeout value for a scan request. It is used to specify the
time interval in which the node waits for a response from the Vscan server. Beyond this
timeout period, the file operation fails if the applicable On-Access policy has the value
scan-mandatory as one of the values for the On-Access policy filter. The value for this
[-scan-queue-timeout <[<integer>h][<integer>m][<integer>s]>] - Scan Queue Timeout
This parameter specifies the timeout value for a scan request in scan-engine's queue.
The value for this field must be between 10s and 30s. By default, it is 20s.
[-session-setup-timeout <[<integer>h][<integer>m][<integer>s]>] - Session Setup
Timeout (privilege: advanced)
This parameter specifies the timeout value for a response for session-setup-message.
The value for this field must be between 5s and 10s. By default, it is 10s.
[-session-teardown-timeout <[<integer>h][<integer>m][<integer>s]>] - Session
Teardown Timeout (privilege: advanced)
This parameter specifies the timeout value for a response for session-teardownmessage, or for any message to be received for a session-id, after the underlying
connection has been disconnected. The value for this field must be between 5s and 10s.
By default, it is 10s.
[-max-session-setup-retries <integer>] - Max Number of Consecutive Session Setup
Attempts (privilege: advanced)
This parameter specifies the maximum number of consecutive session-setup attempts.
The value for this field must be between 1 and 5. By default, it is 5.
Examples
The following example creates a scanner pool.
cluster1::> vserver vscan scanner-pool create -vserver vs1 -scanner-pool p1
-servers 1.1.1.1,2.2.2.2 -privileged-users cifs\u1,cifs\u2
Vserver: vs1
2829
Scanner Pool: p1
Applied Policy: idle
Current Status: off
List of Privileged Users: cifs\u1, cifs\u2
See Also
vserver vscan scanner-pool apply-policy
2830
vserver vscan scanner-pool delete

Delete a scanner pool
Description
The vserver vscan scanner-pool delete command deletes a scanner pool.
Note:
Parameters
This parameter specifies the name of the Vserver from which you want to delete a
scanner pool.
This parameter specifies the name of the scanner-pool that you want to delete.
Examples
The following example deletes a scanner pool.
cluster1::> vserver vscan scanner-pool delete -vserver vs1 -scanner-pool test
cluster1::> vserver vscan scanner-pool show -vserver vs1 -scanner-pool test
There are no entries matching your query.
2831
vserver vscan scanner-pool modify

Modify a scanner pool
Description
The vserver vscan scanner-pool modify command modifies a Vscan scanner
pool. Scanner pool is a set of attributes which are used to validate and manage
connection between clustered Data ONTAP and external virus-scanning server, or
"Vscan server". It also specifies other parameters which are used for connection
management.
Note:
Parameters
This parameter specifies the name of the Vserver on which you want to modify a
scanner pool.
This parameter specifies the name of the scanner pool. Scanner pool name can be up
to 256 characters long and is a string that can only contain any combination of ASCIIrange alphanumeric characters (a-z, A-Z, 0-9), "_", "-" and ".".
[-servers <IP Address>, ...] - List of IPs of Allowed Vscan Servers
This parameter specifies a list of IP addresses of the Vscan servers which are allowed
to connect to clustered Data ONTAP.
[-privileged-users <Privileged user>, ...] - List of Privileged Users
This parameter specifies a list of privileged users. A valid form of privileged username is "domain-name\user-name" and can be up to 256 characters long. Privileged
user-names are stored and treated as case-insensitive strings. Virus scanners must
use one of the registered privileged users for connecting to clustered Data ONTAP
for exchanging virus-scanning protocol messages and to access file for scanning,
remedying and quarantining operations.
2832

This parameter specifies the timeout value for a scan request. It is used to specify the
time interval in which the node waits for a response from the Vscan server. Beyond this
timeout period, the file operation fails if the applicable On-Access policy has the value
scan-mandatory as one of the values for the On-Access policy filter. The value for this
field must be between 10s and 40s.
This parameter specifies the timeout value for a scan request in scan-engine's queue.
The value for this field must be between 10s and 30s.
This parameter specifies the timeout value for a response for session-setup-message.
The value for this field must be between 5s and 10s.
This parameter specifies the timeout value for a response for session-teardownmessage, or for any message to be received for a session-id, after the underlying
connection has been disconnected. The value for this field must be between 5s and 10s.
This parameter specifies the maximum number of consecutive session-setup attempts.
The value for this field must be between 1 and 5.
Examples
The following example modifies a scanner pool.
cluster1::> vserver vscan scanner-pool modify -vserver vs1 -scanner-pool p1
-servers 3.3.3.3 -privileged-users cifs\u3
Vserver: vs1
Scanner Pool: p1
Applied Policy: idle
Current Status: off
2833

List of IPs of Allowed Vscan Servers: 3.3.3.3
List of Privileged Users: cifs\u3
2834
vserver vscan scanner-pool show-active

Display active scanner pools
Description
The vserver vscan scanner-pool show-active command displays active
scanner pool information available to the Vserver. The active scanner pool configuration
is derived by merging the information of the scanner pools which are currently active
on a Vserver. If you do not specify any parameters, the command displays the following
information about all Vservers:
Vserver name
List of scanner pools
List of servers
List of privileged user
Note:
Parameters
specify.
| [-instance ] }
about all fields.
Vserver.
[-scanner-pools <Scanner pool>, ...] - List of Enabled Scanner Pools
2835
that have the specified scanner pool or pools. A scanner pool becomes part of this list if
it is active at this time.
[-servers <IP Address>, ...] - Merged List of IPs of Allowed Vscan Servers
that have the specified server or servers. Servers of all active scanner pools on a
Vserver are merged to derive this effective server list.
[-privileged-users <Privileged user>, ...] - Merged List of Privileged Users
that have the specified privileged user or users. Privileged users of all active scanner
pools on a Vserver are merged to derive this effective privileged user list.
that have the specified request-timeout. This is set to the maximum value of the requesttimeout of all active scanner pools on a Vserver.
that have the specified scan-queue-timeout. This is set to the maximum value of the
scan-queue-timeout of all active scanner pools on a Vserver.
that have the specified session-setup-timeout. This is set to the maximum value of the
session-setup-timeout of all active scanner pools on a Vserver.
that have the specified session-teardown-timeout. This is set to the maximum value of
the session-teardown-timeout of all active scanner pools on a Vserver.
2836
that have the specified max-session-setup-retries. This is set to the maximum number of
the max-session-setup-retry of all active scanner pools on a Vserver.
Examples
The following example displays information about active scanner pool on all Vservers.
cluster1::> vserver vscan scanner-pool show
Vserver
Scanner
Pool
Pool
Owner
Servers
Privileged
Scanner
Users
Policy
----------- ---------- ------- -------------------- --------------- ---------Cluster
clus
cluster 5.5.5.5
cifs\u5
idle
vs1
new
vserver 1.1.1.1, 2.2.2.2
cifs\u1
primary
vs1
clus
cluster 5.5.5.5
cifs\u5
idle
vs1
p1
vserver 3.3.3.3
cifs\u4
primary
vs2
clus
cluster 5.5.5.5
cifs\u5
primary
vs2
p2
vserver 3.3.3.3, 4.4.4.4
cifs\u2
primary

cluster1::> vserver vscan scanner-pool show-active
Privileged
Vserver
Scanner Pools
Servers
Users
----------- ------------- --------------------------- -----------------------vs1
new, p1
1.1.1.1, 2.2.2.2, 3.3.3.3
cifs\u1, cifs\u4
vs2
clus, p2
3.3.3.3, 4.4.4.4, 5.5.5.5
cifs\u2, cifs\u5
2837
vserver vscan scanner-pool show

Display scanner pools
Description
The vserver vscan scanner-pool show command displays information about
the Vscan scanner pools belonging to the Vserver. It also displays the scanner policy
applied to the scanner pool and its current status in Vserver scope. If you do not specify
any parameters, the command displays the following information about all scanner
pools:
Vserver name
Scanner pool
Scanner pool owner
Scanner policy
Current status
Cluster on which policy is applied
List of servers
List of privileged user
Note:
Parameters
specify.
| [-instance ] }
2838
about all fields.
If you specify this parameter, the command displays information only about the scanner
pools for the specified Vserver.
[-scanner-pool <Scanner pool>] - Scanner Pool
scanner pool.
[-scanner-policy <Scanner policy>] - Applied Policy
pools for the specified scanner policy.
[-current-status {on|off}] - Current Status
pools that have the specified status.
[-cluster <Cluster name>] - Cluster on Which Policy Is Applied
pools that are applied to the specified cluster.
[-owner <Configuration owner>] - Scanner Pool Config Owner
pools that have the specified owner.
pools that have the specified server or servers.
pools that have the specified privileged user or users.
pools that have the specified request-timeout.
2839
pools that have the specified scan-queue-timeout.
pools that have the specified session-setup-timeout.
pools that have the specified session-teardown-timeout.
pools that have the specified max-session-setup-retries.
Examples
The following example displays information about all scanner pools.
cluster1::> vserver vscan scanner-pool show
Vserver
Scanner
Pool
Pool
Owner
Servers
Privileged
Scanner
Users
Policy
----------- ---------- ------- -------------------- --------------- ---------vs1
new
vserver 1.1.1.1, 2.2.2.2
cifs\u5
secondary
vs1
p1
vserver 3.3.3.3
cifs\u1
primary
cifs\u2
The following example displays detailed information about one scanner pool.
cluster1::> vserver vscan scanner-pool show -vserver vs1 -scanner-pool new
Vserver: vs1
Scanner Pool: new
Applied Policy: secondary
Current Status: off
Cluster on Which Policy Is Applied: cluster2
2840

2841
vserver vscan scanner-pool privileged-users add

Add to the list of privileged users
Description
The vserver vscan scanner-pool privileged-users add command adds
one privileged users or list of privileged users to the specified scanner pool.
Note:
Parameters
This parameter specifies the name of the Vserver containing the specified scanner pool
on which you want to add a privileged user or users.
This parameter specifies the name of the scanner pool to which you want to add a
privileged user or users.
This parameter specifies the privileged user or users that you want to add to the
specified scanner pool.
Examples
The following example adds a list of privileged users to the specified scanner pool.
cluster1::> vserver vscan scanner-pool privileged-users add -vserver vs1
-scanner-pool p1 -privileged-users cifs\u2,cifs\u3
cluster1::> vserver vscan scanner-pool privileged-users show -vserver vs1
-scanner-pool p1
Vserver: vs1
2842
Scanner Pool: p1
List of Privileged Users: cifs\u1, cifs\u2, cifs\u3
2843
vserver vscan scanner-pool privileged-users

remove
Remove from the list of privileged users
Description
The vserver vscan scanner-pool privileged-users remove command
removes one privileged users or list of privileged users from the specified scanner pool.
All the existing privileged users of a scanner pool cannot be removed.
Note:
Parameters
on which you want to remove a privileged user or users.
This parameter specifies the name of the scanner pool from which you want to remove a
privileged user or users.
This parameter specifies the privileged user or users that you want to remove from the
Examples
The following example removes a list of privileged users from the specified scanner
pool.
cluster1::> vserver vscan scanner-pool privileged-users remove -vserver vs1
-scanner-pool p1 -privileged-users cifs\u2,cifs\u3
cluster1::> vserver vscan scanner-pool privileged-users show -vserver vs1
2844
-scanner-pool p1
Vserver: vs1
Scanner Pool: p1
2845
vserver vscan scanner-pool privileged-users show

Display list of privileged users
Description
The vserver vscan scanner-pool privileged-users show command
displays the list of privileged users of the Vscan scanner pools belonging to the Vserver.
about the scanner pools:
Vserver name
Scanner pool
List of privileged users
Note:
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays information only for the specified
scanner pool.
2846

pools that have the specified privileged user or users.
Examples
The following example displays the list of privileged users of all scanner pools.
cluster1::> vserver vscan scanner-pool privileged-users show
Vserver
Scanner Pool
Privileged Users
--------------- ----------------- -------------------------------------------Cluster
clus
cifs\u5
vs1
new
cifs\u7
vs1
clus
cifs\u5
vs1
p1
cifs\u1, cifs\u2
vs2
clus
cifs\u5
vs2
p2
cifs\u2
2847
vserver vscan scanner-pool servers add

Add to the list of servers
Description
The vserver vscan scanner-pool servers add command adds one server or
list of servers to the specified scanner pool.
Note:
Parameters
on which you want to add a server or servers.
This parameter specifies the name of the scanner pool to which you want to add a
server or servers.
-servers <IP Address>, ... - List of IPs for Vscan Servers
This parameter specifies the server or servers that you want to add to the specified
scanner pool.
Examples
The following example adds a list of servers to the specified scanner pool.
cluster1::> vserver vscan scanner-pool servers add -vserver vs1
-scanner-pool p1 -servers 10.10.10.10,11.11.11.11
cluster1::> vserver vscan scanner-pool servers show -vserver vs1 -scanner-pool p1
Vserver: vs1
Scanner Pool: p1
2848
List of IPs of Allowed Vscan Servers: 3.3.3.3, 10.10.10.10, 11.11.11.11
2849
vserver vscan scanner-pool servers remove

Remove from the list of servers
Description
The vserver vscan scanner-pool servers remove command removes one
server or list of servers from the specified scanner pool. All the existing servers of a
scanner pool cannot be removed.
Note:
Parameters
on which you want to remove a server or servers.
This parameter specifies the name of the scanner pool from which you want to remove a
server or servers.
-servers <IP Address>, ... - List of IPs for Vscan Servers
This parameter specifies the server or servers that you want to remove from the
Examples
The following example removes a list of servers from the specified scanner pool.
cluster1::> vserver vscan scanner-pool servers remove -vserver vs1
-scanner-pool p1 -servers 10.10.10.10,11.11.11.11
cluster1::> vserver vscan scanner-pool servers show -vserver vs1 -scanner-pool p1
Vserver: vs1
2850
Scanner Pool: p1
List of IPs of Allowed Vscan Servers: 3.3.3.3
2851
vserver vscan scanner-pool servers show

Display list of servers
Description
The vserver vscan scanner-pool servers show command displays the list of
servers of the Vscan scanner pools belonging to the Vserver. If you do not specify any
parameters, the command displays the following information about all scanner pools:
Vserver name
Scanner pool
List of servers
Note:
Parameters
specify.
| [-instance ] }
about all fields.
If you specify this parameter, the command displays information only for the specified
scanner pool.
2852

pools that have the specified server or servers.
Examples
The following example displays the list of servers of all scanner pools.
cluster1::> vserver vscan scanner-pool servers show
Vserver
Scanner Pool
Servers
--------------- ----------------- -------------------------------------------Cluster
clus
5.5.5.5
vs1
new
1.1.1.1, 2.2.2.2
vs1
clus
5.5.5.5
vs1
p1
3.3.3.3, 10.10.10.10, 11.11.11.11
vs2
clus
5.5.5.5
vs2
p2
3.3.3.3, 4.4.4.4
2853

Clustered Data ONTAP 83 Commands Manual Page PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Clustered Data ONTAP 83 Commands Manual Page PDF

Uploaded by

Copyright:

Available Formats

Clustered Data ONTAP 8.

Telephone: +1(408) 822-6000

Part number: 215-09144_D0

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

cluster image show-update-history ............................................................................ 91

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

dashboard performance show .................................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

schedule cron show ...........................................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

lun mapping remove-reporting-nodes ......................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

metrocluster operation show ....................................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

ipspace create ............................................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

network route create ................................................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

security login create .................................................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

snapmirror restore ....................................................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

statistics system show ............................................................................................. 930

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

disk modify ................................................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

storage path show .................................................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

configuration backup copy .........................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

health system-connectivity shelf show ......................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

node coredump reports upload .................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

script start ..................................................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

system services ndmp status ................................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

file clone split load modify .........................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

volume snapshot autodelete show ........................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

cifs nbtstat .................................................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

cifs home-directory show ..........................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

cifs users-and-groups local-user delete ....................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

fcp wwpn-alias set ....................................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

iscsi interface enable ................................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

nfs kerberos realm delete .........................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

security file-directory policy task show ......................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

services name-service netgroup file delete ...............................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

services web show ....................................................................................

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

Clustered Data ONTAP 8.3 Commands: Manual Page Reference

Clustered Data ONTAP 8.3 Commands: Manual Page Reference