Command Line Interface Reference For Block 370 SC Docu47580

User Manual: 370 SC

Open the PDF directly: View PDF PDF.
Page Count: 646

DownloadCommand Line Interface Reference For Block 370 SC Docu47580
Open PDF In BrowserView PDF
EMC® VNX® Series
Version 5.33

Command Line Interface Reference for
Block
P/N 300-015-135 REV. 06

Copyright © 2013-2016 EMC Corporation. All rights reserved. Published in the USA.
Published September 2016
EMC believes the information in this publication is accurate as of its publication date. The information is subject to change
without notice.
The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kind with
respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a
particular purpose. Use, copying, and distribution of any EMC software described in this publication requires an applicable
software license.
EMC², EMC, and the EMC logo are registered trademarks or trademarks of EMC Corporation in the United States and other
countries. All other trademarks used herein are the property of their respective owners.
For the most up-to-date regulatory document for your product line, go to EMC Online Support (https://support.emc.com).
EMC Corporation
Hopkinton, Massachusetts 01748-9103
1-508-435-1000 In North America 1-866-464-7381
www.EMC.com

2

EMC VNX Series 5.33 Command Line Interface Reference for Block

CONTENTS

Preface
Chapter 1

15
About CLI Commands

19

naviseccli......................................................................................................20

Chapter 2

VNX CLI for Block

23

Basic commands...........................................................................................24
Storage setup and management overview........................................ 24
Shared storage setup and management overview.............................25
alpa -get...........................................................................................26
alpa -set...........................................................................................27
arraycommpath................................................................................28
arrayconfig -capture......................................................................... 29
arrayconfig -duplicate...................................................................... 30
arrayname........................................................................................32
backendbus -analyze....................................................................... 32
backendbus -get -connstate............................................................. 35
backendbus -get -physical............................................................... 36
backendbus -get -prominfo.............................................................. 36
backendbus -get -sfpstate................................................................37
backendbus -get -speeds................................................................. 38
backendbus -get -all........................................................................ 38
backendbus -resetspeed..................................................................41
baseuuid......................................................................................... 42
bind................................................................................................. 43
cachecard -list................................................................................. 47
cachecard -initialize......................................................................... 48
cache -sp -info................................................................................. 49
cache -sp -modify.............................................................................50
chglun..............................................................................................50
chgrg............................................................................................... 52
clearlog............................................................................................53
clearstats......................................................................................... 54
cmdtime.......................................................................................... 54
copytodisk....................................................................................... 55
createrg........................................................................................... 56
emconfiguration...............................................................................58
environment.................................................................................... 58
failovermode....................................................................................61
faults -list.........................................................................................62
flash -ioport..................................................................................... 63
flash -iomodule................................................................................64
flashleds..........................................................................................65
getagent.......................................................................................... 66
getall............................................................................................... 68
getarrayuid...................................................................................... 71
getconfig..........................................................................................72
getcontrol........................................................................................ 73
EMC VNX Series 5.33 Command Line Interface Reference for Block

3

CONTENTS

getcrus.............................................................................................74
getdisk.............................................................................................78
getlog.............................................................................................. 84
getloop............................................................................................ 85
getlun.............................................................................................. 85
getresume........................................................................................92
getrg................................................................................................ 95
getsniffer......................................................................................... 97
getsp............................................................................................. 100
getsptime.......................................................................................101
getspuptime.................................................................................. 101
getunusedluns............................................................................... 102
hotsparepolicy -list........................................................................ 103
hotsparepolicy -set........................................................................ 103
inserttestevent...............................................................................104
ioportconfig -config -maxvlans....................................................... 104
ioportconfig -list.............................................................................105
ioportconfig -list -maxvlans............................................................ 112
ioportconfig -persist.......................................................................112
luncache -clear.............................................................................. 113
luncache -list................................................................................. 114
managedby....................................................................................114
managefiles -delete....................................................................... 115
managefiles -list............................................................................ 116
managefiles -retrieve..................................................................... 116
ndu -list......................................................................................... 117
ndu -install.................................................................................... 119
ndu -runrules................................................................................. 122
ndu -commit.................................................................................. 123
ndu -status.................................................................................... 124
ndu -revert..................................................................................... 124
networkadmin -get......................................................................... 125
networkadmin -mib........................................................................ 129
networkadmin -route......................................................................130
networkadmin -set......................................................................... 131
port................................................................................................134
powersaving.................................................................................. 145
rebootSP........................................................................................146
rebootpeerSP................................................................................. 147
remoteconfig -getconfig................................................................. 147
remoteconfig -setconfig................................................................. 148
removerg........................................................................................150
resetandhold................................................................................. 150
responsetest..................................................................................151
sc_off.............................................................................................153
setfeature...................................................................................... 154
setsniffer....................................................................................... 154
setsniffverify.................................................................................. 155
setspstime..................................................................................... 156
setsptime.......................................................................................156
setstats..........................................................................................157
shutdown.......................................................................................158
shutdownsp...................................................................................159
shutdownpeersp............................................................................ 159
spcollect -info................................................................................ 160
spcollect -set................................................................................. 160
4

EMC VNX Series 5.33 Command Line Interface Reference for Block

CONTENTS

spcollect........................................................................................ 161
spportspeed.................................................................................. 162
storagegroup................................................................................. 168
systemtype.................................................................................... 179
trespass.........................................................................................180
unbind........................................................................................... 181
unitserialnumber........................................................................... 181
LUN Expansion (metaLUN) commands.........................................................182
MetaLUNs overview........................................................................182
CLI metaLUN command functions...................................................183
metalun -destroy............................................................................184
metalun -expand............................................................................184
metalun -info................................................................................. 190
metalun -list...................................................................................191
metalun -modify.............................................................................196
Using the added capacity of an expanded SnapView, MirrorView or
SAN Copy LUN................................................................................197
Reserved LUN Pool commands.................................................................... 198
reserved -lunpool -addlun.............................................................. 199
reserved -lunpool -list.................................................................... 200
reserved -lunpool -rmlun................................................................ 201
iSCSI and FCoE commands.......................................................................... 202
iSCSI commands overview............................................................. 202
connection -adduser...................................................................... 203
connection -deleteuser.................................................................. 204
connection -getuser....................................................................... 205
connection -getport........................................................................206
connection -setport........................................................................217
connection -delport........................................................................219
connection -route...........................................................................220
connection -pingnode.................................................................... 221
connection -traceroute................................................................... 222
connection -setsharedauth............................................................ 223
connection -delsharedauth............................................................ 224
connection -getsharedauth............................................................ 224
connection -addset........................................................................ 225
connection -delset......................................................................... 226
connection -modifyset....................................................................226
connection -getset......................................................................... 228
connection -addpath......................................................................228
connection -delpath....................................................................... 229
connection -modifypath................................................................. 230
connection -verifypath................................................................... 231
isns -addserver.............................................................................. 232
isns -deleteserver...........................................................................232
isns -listserver................................................................................233
isns -setprimary............................................................................. 234
LUN Migration commands........................................................................... 235
migrate -start................................................................................. 235
migrate -cancel.............................................................................. 236
migrate -modify..............................................................................237
migrate -list....................................................................................238
Domain and Security commands................................................................. 239
About domains and user accounts................................................. 239
Domain and security commands overview......................................242
domain -add.................................................................................. 243
EMC VNX Series 5.33 Command Line Interface Reference for Block

5

CONTENTS

domain -list....................................................................................245
domain -remove.............................................................................246
domain -uninitialize....................................................................... 247
domain -setmaster......................................................................... 248
ntp -list.......................................................................................... 248
ntp -set.......................................................................................... 250
security -adduser........................................................................... 251
security -changeuserinfo................................................................ 253
security -list................................................................................... 254
security -listrole............................................................................. 254
security -rmuser............................................................................. 255
security -ldap -addserver................................................................255
security -ldap -modifyserver........................................................... 257
security -ldap -removeserver.......................................................... 259
security -ldap -listserver................................................................. 260
security -ldap -addrolemapping......................................................261
security -ldap -modifyrolemapping................................................. 261
security -ldap -removerolemapping................................................ 262
security -ldap -listrolemapping.......................................................263
security -ldap -synchronize............................................................ 263
security -certificate -add.................................................................264
security -certificate -remove........................................................... 264
security -certificate -list.................................................................. 265
security -certificate -alertBeforeExpiration...................................... 266
security -pkcs12upload..................................................................266
security -SPcertificate -generate..................................................... 267
security -fipsmode -set...................................................................267
security -fipsmode -get...................................................................268
security -setport............................................................................. 268
security -trustedclient -enable........................................................268
security -trustedclient -add............................................................ 269
security -trustedclient -list..............................................................270
security -trustedclient -remove....................................................... 270
Event Monitor commands............................................................................271
Event Monitoring overview............................................................. 271
-portal -create................................................................................ 272
-portal -list..................................................................................... 272
-portal -migrate.............................................................................. 273
-portal -destroy.............................................................................. 273
-template -list................................................................................ 274
-template -import........................................................................... 274
-template -export........................................................................... 275
-template -destroy..........................................................................275
-template -findconflict....................................................................276
-template -swap............................................................................. 276
-monitor -addsystem...................................................................... 277
-monitor -removesystem................................................................ 277
-monitor -listmapping.................................................................... 278
-monitor -applytemplate.................................................................278
-monitor -stoptemplate.................................................................. 279
-monitor -getlog............................................................................. 280
-monitor -enableresponse.............................................................. 280
-monitor -disableresponse............................................................. 281
-monitor -getlogsize....................................................................... 282
-monitor -setlogsize....................................................................... 282
-monitor -inserttestevent................................................................283
6

EMC VNX Series 5.33 Command Line Interface Reference for Block

CONTENTS

-monitor -responsetest...................................................................283
-monitor -reloadconfig....................................................................285
Virtual server commands.............................................................................285
Virtual server overview................................................................... 285
server -volmap............................................................................... 286
server -update................................................................................288
server -getagent............................................................................. 288
server -remoteconfig...................................................................... 289
server -register............................................................................... 290
hypervisor -addvirtualcenter.......................................................... 290
hypervisor -modifyvirtualcenter......................................................291
hypervisor -removevirtualcenter..................................................... 292
hypervisor -addesx.........................................................................292
hypervisor -modifyesx.................................................................... 293
hypervisor -removeesx................................................................... 293
hypervisor -listesx.......................................................................... 294
hypervisor -bypassCert -set............................................................ 294
hypervisor -bypassCert -get............................................................ 294
Host Agent commands................................................................................ 295
server -volmap............................................................................... 295
server -update................................................................................297
server -getagent............................................................................. 297
server -remoteconfig...................................................................... 298
server -register............................................................................... 299
Unisphere Server Utility...............................................................................299
Using the server utility command line to generate a high-availability
report.............................................................................................299
Unisphere Initialization Utility..................................................................... 302
Using the command line initialization utility...................................302

Chapter 3

Virtual Pools Commands

305

Virtual Pools overview................................................................................. 306
storagepool -create..................................................................................... 307
storagepool -list.......................................................................................... 310
storagepool -destroy................................................................................... 316
storagepool -modify.................................................................................... 316
storagepool -expand................................................................................... 318
storagepool -cancelexpand......................................................................... 319
storagepool -feature -info............................................................................ 319
storagepool -resumeharvesting................................................................... 321
lun -create...................................................................................................321
lun -modify..................................................................................................323
lun -expand.................................................................................................325
lun -destroy.................................................................................................326
lun -list........................................................................................................326
deduplication -feature -pause..................................................................... 330
deduplication -feature -resume................................................................... 330
deduplication -feature -info.........................................................................330

Chapter 4

Auto-tiering Commands

333

About tiered storage....................................................................................334
autotiering -schedule -modify......................................................................335
autotiering -schedule -enable|-disable........................................................ 336
autotiering -relocation -start........................................................................ 336
EMC VNX Series 5.33 Command Line Interface Reference for Block

7

CONTENTS

autotiering -relocation -setrate.................................................................... 337
autotiering -relocation -pause|-resume........................................................ 338
autotiering -relocation -stop........................................................................ 338
autotiering -info.......................................................................................... 339

Chapter 5

Compression Commands

341

About LUN Compression..............................................................................342
compression -on......................................................................................... 342
compression -pause....................................................................................343
compression -feature -pause.......................................................................344
compression -resume..................................................................................344
compression -feature -resume.....................................................................345
compression -feature -info.......................................................................... 345
compression -modify...................................................................................345
compression -off......................................................................................... 346
compression -list........................................................................................ 346

Chapter 6

FAST Cache Commands

349

Introduction to caching............................................................................... 350
cache -fast -create.......................................................................................351
cache -fast -destroy.....................................................................................352
cache -fast -info.......................................................................................... 352

Chapter 7

EMC Unisphere QoS Manager

355

About Unisphere Quality of Service Manager............................................... 356
QoS Manager prerequisites............................................................356
QoS Manager CLI commands.......................................................................356
nqm -getlatestperf......................................................................... 357
nqm -info....................................................................................... 357
nqm -ioclass -create.......................................................................358
nqm -ioclass -destroy.....................................................................359
nqm -ioclass -list............................................................................360
nqm -ioclass -modify......................................................................362
nqm -measure................................................................................364
nqm -off......................................................................................... 364
nqm -policy -create........................................................................ 365
nqm -policy -destroy...................................................................... 366
nqm -policy -list............................................................................. 366
nqm -policy -modify....................................................................... 367
nqm -run........................................................................................ 368
nqm -schedule -create................................................................... 369
nqm -schedule -destroy..................................................................370
nqm -schedule -list........................................................................ 370
nqm -schedule -modify.................................................................. 372
nqm -schedule -resume..................................................................373
nqm -schedule -suspend................................................................373
nqm -setfallback............................................................................ 374
nqm -setoptions.............................................................................374
nqm -stop...................................................................................... 375
Client tools..................................................................................................375
nqm -archive -dump....................................................................... 375
nqm -archive -retrieve.................................................................... 382
8

EMC VNX Series 5.33 Command Line Interface Reference for Block

CONTENTS

Chapter 8

EMC Unisphere Analyzer

385

About Unisphere Analyzer........................................................................... 386
Prerequisites..................................................................................386
Analyzer CLI commands.............................................................................. 386
analyzer -set.................................................................................. 387
analyzer -get.................................................................................. 388
analyzer -logging............................................................................388
analyzer -start................................................................................ 389
analyzer -stop................................................................................ 389
analyzer -status............................................................................. 390
analyzer -archive............................................................................390
Client tools..................................................................................................392
analyzer -archivedump...................................................................392
analyzer -archiveretrieve................................................................ 405
analyzer -archivemerge.................................................................. 406

Chapter 9

EMC VNX MirrorView/A CLI

409

MirrorView/A remote mirroring commands.................................................. 410
MirrorView/A operations overview..................................................410
MirrorView/A CLI functions.............................................................412
mirror -async -addimage................................................................ 413
mirror -async -change.....................................................................415
mirror -async -changeimage........................................................... 416
mirror -async -create...................................................................... 418
mirror -async -destroy.................................................................... 419
mirror -disablepath........................................................................ 420
mirror -enablepath......................................................................... 421
mirror -async -fractureimage...........................................................422
mirror -async -info.......................................................................... 423
mirror -async -list........................................................................... 425
mirror -async -promoteimage......................................................... 427
mirror -async -removeimage........................................................... 428
mirror -async -setfeature................................................................ 429
mirror -async -syncimage............................................................... 430
MirrorView/A consistency group commands................................................431
mirror -async -creategroup............................................................. 431
mirror -async -destroygroup........................................................... 433
mirror -async -addtogroup.............................................................. 434
mirror -async -removefromgroup.................................................... 434
mirror -async -changegroup............................................................435
mirror -async -syncgroup................................................................ 437
mirror -async -fracturegroup........................................................... 437
mirror -async -promotegroup.......................................................... 438
mirror -async -listgroups.................................................................439

Chapter 10

EMC VNX MirrorView/S CLI

443

MirrorView/S Remote Mirroring commands................................................. 444
MirrorView/S operations overview..................................................444
MirrorView/S CLI functions.............................................................446
mirror -sync -addimage.................................................................. 447
mirror -sync -allocatelog.................................................................450
mirror -sync -change.......................................................................450
mirror -sync -changeimage............................................................. 452
EMC VNX Series 5.33 Command Line Interface Reference for Block

9

CONTENTS

mirror -sync -create........................................................................ 453
mirror -sync -deallocatelog............................................................. 455
mirror -sync -destroy...................................................................... 455
mirror -disablepath........................................................................ 457
mirror -enablepath......................................................................... 458
mirror -sync -fractureimage............................................................ 459
mirror -sync -info............................................................................ 460
mirror -sync -list............................................................................. 462
mirror -sync -listsyncprogress.........................................................464
mirror -sync -listlog........................................................................ 465
mirror -sync -promoteimage........................................................... 465
mirror -sync -removeimage............................................................. 467
mirror -sync -setfeature.................................................................. 469
mirror -sync -syncimage................................................................. 470
MirrorView/S consistency group commands................................................471
mirror -sync -creategroup............................................................... 471
mirror -sync -destroygroup............................................................. 472
mirror -sync -addtogroup................................................................473
mirror -sync -removefromgroup...................................................... 474
mirror -sync -changegroup..............................................................475
mirror -sync -syncgroup..................................................................476
mirror -sync -fracturegroup............................................................. 477
mirror -sync -promotegroup............................................................478
mirror -sync -listgroups.................................................................. 479

Chapter 11

SAN Copy and its command line utilities

481

Introducing SAN Copy software................................................................... 482
Preparing a Block system for a copy session................................................482
Connecting SAN Copy ports to storage groups................................ 483
Preparing a Symmetrix system for a copy session........................................485
Preparing a Symmetrix system using EMC ControlCenter SAN Manager
...................................................................................................... 486
Preparing a Symmetrix system using ESN Manager.........................487
About admhost for SAN Copy...................................................................... 488
admhost SAN Copy command functions...................................................... 488
Preparing logical units for a SAN Copy session............................................ 490
Preparing source and destination logical units for full and incremental
sessions........................................................................................ 491
SAN Copy CLI commands.............................................................................492
SAN Copy command functions.................................................................... 492
sancopy -create...........................................................................................494
sancopy -destinfo........................................................................................498
sancopy -duplicate......................................................................................501
sancopy -info.............................................................................................. 502
sancopy -mark............................................................................................ 506
sancopy -modify..........................................................................................507
sancopy -pause...........................................................................................512
sancopy -remove.........................................................................................513
sancopy -resume.........................................................................................514
sancopy -settings........................................................................................ 515
sancopy -start............................................................................................. 516
sancopy -stop............................................................................................. 518
sancopy -throttle......................................................................................... 519
sancopy -transfer........................................................................................ 520
sancopy -unmark........................................................................................ 521
10

EMC VNX Series 5.33 Command Line Interface Reference for Block

CONTENTS

sancopy -updateconnections...................................................................... 521
sancopy -verify............................................................................................ 522

Chapter 12

EMC SnapView Software

525

SnapView clone CLI commands................................................................... 526
Setting up SnapView to use clones.................................................526
CLI clone command functions........................................................ 527
clone | snapview -addclone............................................................ 528
clone | snapview -allocatecpl......................................................... 531
clone | snapview -changeclone.......................................................532
clone | snapview -changeclonefeature............................................534
clone | snapview -changeclonegroup..............................................535
clone | snapview -consistentfractureclones.................................... 536
clone | snapview -createclonegroup............................................... 537
clone | snapview -deallocatecpl......................................................538
clone | snapview -destroyclonegroup............................................. 539
clone | snapview -fractureclone...................................................... 540
clone | snapview -listclone............................................................. 542
clone | snapview -listclonefeature.................................................. 544
clone | snapview -listclonegroup.................................................... 546
clone | snapview -removeclone...................................................... 548
clone | snapview -resetfracturelog.................................................. 549
clone | snapview -reversesyncclone................................................550
clone | snapview -syncclone........................................................... 552
Admsnap commands for clones.................................................................. 554
About admsnap software and clones............................................. 554
Requirements for admsnap and clones.......................................... 554
admsnap clone_activate................................................................ 555
admsnap clone_deactivate............................................................ 556
admsnap flush...............................................................................558
admsnap list.................................................................................. 559
SnapView Snapshot CLI commands.............................................................560
Setting up SnapView to use snapshots.......................................... 560
SnapView command functions....................................................... 562
snapview -activatesnapshot...........................................................563
snapview -chgrollback................................................................... 565
snapview -chgsnapshot................................................................. 566
snapview -createsnapshot............................................................. 566
snapview -deactivatesnapshot.......................................................568
snapview -listrollback.................................................................... 569
snapview -listsessions................................................................... 571
snapview -listsnapshots................................................................ 573
snapview -listsnapableluns............................................................574
snapview -lunpool..........................................................................575
snapview -rmsnapshot...................................................................576
snapview -startrollback.................................................................. 577
snapview -startsession.................................................................. 579
snapview -stopsession...................................................................582
Admsnap commands for snapshots............................................................ 583
About admsnap software and snapshots....................................... 583
Requirements for snapshots.......................................................... 584
admsnap activate.......................................................................... 584
admsnap deactivate...................................................................... 588
admsnap flush...............................................................................591
admsnap list.................................................................................. 593
EMC VNX Series 5.33 Command Line Interface Reference for Block

11

CONTENTS

admsnap start................................................................................594
admsnap stop................................................................................598

Chapter 13

EMC VNX Snapshots Software

601

VNX Snapshots CLI commands.................................................................... 602
snap -feature................................................................................. 602
snap -create...................................................................................602
snap -destroy................................................................................. 604
snap -list........................................................................................604
snap -modify ................................................................................. 606
snap -copy..................................................................................... 607
snap -restore..................................................................................608
snap -attach...................................................................................609
snap -detach..................................................................................609
snap -group -create........................................................................ 609
snap -group -destroy ..................................................................... 610
snap -group -modify....................................................................... 610
snap -group -list.............................................................................611
snap -group -addmember...............................................................612
snap -group -rmmember.................................................................612
snap -group -replmember...............................................................613
lun -create......................................................................................613
lun -create......................................................................................614
lun -destroy....................................................................................614
lun -modify.....................................................................................615
lun -expand....................................................................................616
lun -attach..................................................................................... 616
lun -detach.................................................................................... 617
storagepool -create........................................................................ 617
storagepool -modify....................................................................... 618
storagepool -list.............................................................................619
storagepool -resumeAutoDelete..................................................... 621
getlun............................................................................................ 621
SnapCLI commands for VNX Snapshots.......................................................623
snapcli create ............................................................................... 623
snapcli destroy.............................................................................. 624
snapcli copy...................................................................................625
snapcli attach................................................................................ 626
snapcli detach............................................................................... 627

Chapter 14

EMC Secure Remote Support on the Storage Processor

629

ESRS Device Client on Storage Processor.....................................................630
esrsconfig -agentprovision.......................................................................... 630
esrsconfig -agentstatus............................................................................... 631
esrsconfig -configproxy -addproxy............................................................... 632
esrsconfig -configproxy -list.........................................................................632
esrsconfig -configproxy -removeproxy......................................................... 633
esrsconfig -configpolicymanager -addpm.................................................... 633
esrsconfig -configpolicymanager -list.......................................................... 634
esrsconfig -configpolicymanager -addpolicyproxy....................................... 634
esrsconfig -configpolicymanager -removepolicyproxy.................................. 635
esrsconfig -configpolicymanager -removePM...............................................635

12

EMC VNX Series 5.33 Command Line Interface Reference for Block

CONTENTS

Chapter 15

Data at Rest Encryption

637

Data at Rest Encryption overview.................................................................638
securedata -feature -activate....................................................................... 639
securedata -feature -info............................................................................. 640
securedata -backupkeys -status.................................................................. 641
securedata -backupkeys -retrieve................................................................642
securedata -auditlog -retrieve......................................................................643
securedata -auditlog -cksum....................................................................... 644

EMC VNX Series 5.33 Command Line Interface Reference for Block

13

CONTENTS

14

EMC VNX Series 5.33 Command Line Interface Reference for Block

Preface

As part of an effort to improve and enhance the performance and capabilities of its
product lines, EMC periodically releases revisions of its hardware and software.
Therefore, some functions described in this document may not be supported by all
versions of the software or hardware currently in use. For the most up-to-date information
on product features, refer to your product release notes.
If a product does not function properly or does not function as described in this
document, please contact your EMC representative.
Audience
This guide is part of the EMC VNX documentation set, and is intended for use by those
who will use CLI commands to configure, manage, or obtain the status of EMC systems.
This version of the manual covers up to VNX systems running release 1.3 of Unisphere.
Readers of this guide are expected to be familiar with the following topics:
l

The operating system running on the servers you will manage.

l

System components and configurations.

For introductory information, refer to the appropriate configuration planning guide for
your system.
Special notice conventions used in this document
EMC uses the following conventions for special notices:
DANGER

Indicates a hazardous situation which, if not avoided, will result in death or serious
injury.
WARNING

Indicates a hazardous situation which, if not avoided, could result in death or serious
injury.
CAUTION

Indicates a hazardous situation which, if not avoided, could result in minor or moderate
injury.
NOTICE

Addresses practices not related to personal injury.
Note

Presents information that is important, but not hazard-related.
Systems no longer covered in this document
The table below lists the systems that are no longer covered in this document and the
last revision of this document that included the systems.

EMC VNX Series 5.33 Command Line Interface Reference for Block

15

Preface

System removed

Last revision including the system

CX200, CX400, and CX600 300-003-628 Rev. A07
069001184 Rev. A11
300-001-335 Rev. A11
300-004-210 Rev. A02
069001181 Rev. A14
FC series; C series

069001038 Rev. A14
300-001-335 Rev. A11
069001184 Rev. A11

FC4700

069001184 Rev. A08

Related documentation
Related documentation for EMC Navisphere CLI reference includes:
We recommend that you download the latest information before you run the CLI
commands. Platform-specific limitations and requirements are provided in the
appropriate release note documents.
l

EMC Unisphere Release Notes

l

EMC MirrorView/Asynchronous and MirrorView/Synchronous for VNX OE for Block Release
Notes

l

The version of this manual that is applicable to your software revision

The most up-to-date information about the EMC SAN Copy software is posted on EMC
Online Support. We recommend that you download the latest information before you start
the SAN Copy software. If you purchased this product from an EMC reseller and you
cannot access EMC Online Support, the latest product information should be available
from your reseller.
To access EMC Online Support, use the following link:
http://Support.EMC.com
Where to get help
EMC support, product, and licensing information can be obtained as follows:
Product information—For documentation, release notes, software updates, or for
information about EMC products, licensing, and service, go to EMC Online Support
(registration required) at http://Support.EMC.com.
Troubleshooting—Go to EMC Online Support at http://Support.EMC.com. After logging
in, locate the applicable Support by Product page.
Technical support—For technical support and service requests, go to EMC Customer
Service on EMC Online Support at http://Support.EMC.com. After logging in, locate
the applicable Support by Product page, and choose either Live Chat or Create a
service request. To open a service request through EMC Online Support, you must
have a valid support agreement. Contact your EMC sales representative for details
about obtaining a valid support agreement or with questions about your account.
Note

Do not request a specific support representative unless one has already been assigned to
your particular system problem.

16

EMC VNX Series 5.33 Command Line Interface Reference for Block

Preface

Your comments
Your suggestions will help us continue to improve the accuracy, organization, and overall
quality of the user publications.
Please send your opinion of this document to:
techpubcomments@EMC.com

EMC VNX Series 5.33 Command Line Interface Reference for Block

17

Preface

18

EMC VNX Series 5.33 Command Line Interface Reference for Block

CHAPTER 1
About CLI Commands

This chapter explains the EMC VNX CLI for Block commands.
Major topic include:
l

naviseccli..............................................................................................................20

About CLI Commands

19

About CLI Commands

naviseccli
Sends status or configuration requests to a system through the command line.
PREREQUISITES
Anyone that can log in to the server running VNX CLI for Block 4.30 or later.
DESCRIPTION
The naviseccli command sends system management and configuration requests to a
system through the Internet.
SYNTAX
naviseccli -help
naviseccli [-addressIPAddress | NetworkName | -h IPAddress |
NetworkName]
[-AddUserSecurity]
[-f filename]
[-nopoll | -np]
[-parse | -p]
[-password password]
[-port port]
[-q]
[-RemoveUserSecurity]
[-scope 0 | 1 | 2]
[-secfilepath]
[security -certificate]
[-timeout | -t timeout]
[-user username]
[-v]
[-xml]
CMD 
OPTIONS
-help
Displays the help screen and does not start the naviseccli process. To start the
naviseccli process, use one or more of the switches that follows instead.
-address IPAddress | NetworkName | -h IPAddress | NetworkName
Specifies the IP address or network name of the targeted SP on the desired system.
The default, if you omit this switch, is localhost.
-AddUserSecurity
Directs the CLI to add user security information to the security file on this server. You
must use the -scope switch to add scope information to the security file. You can
use the -password switch or enter your password into the password prompt, to
supply the required password information to the security file. The -user and secfilepath switches are optional with this command.

20

EMC VNX Series 5.33 Command Line Interface Reference for Block

About CLI Commands

Note

If you specify the -user switch, you can create an alternative username to your
server login name in the security file you create on this server. If you use the secfilepath switch, you can specify an alternative location to your default home
directory, for the security file on this server. You must then use the -secfilepath
switch in each subsequent command that you issue.
-f filename
Stores the data in a file.
-nopoll | -np
Directs the feature provider not to issue a poll request. This switch significantly
increases performance when dealing with large or multiple systems. The feature
provider automatically issues a poll request unless this switch is specified.
Note

When the -nopoll switch is set, get commands may return stale data and set
commands may erase previously changed settings. Use caution when the -nopoll
switch is set.
-parse | -p
Directs the CLI to validate the command. The CLI verifies the command syntax and
displays a message stating whether the command was valid. The CLI takes no other
action.
-password password
Specifies the password on the system you want to log in to. The password is visible
in the command line. Passwords are case-sensitive. If you want to mask the
password, and you are not using a security file, you can omit this switch from the
command line. The CLI then prompts you to enter a password. The information you
enter into the password prompt is concealed.
Note

You can omit this switch if you are using a security file. See -AddUserSecurity.
-port portnumber
Sets the port number (type) of the system. The default is 443. If you choose to
change the default port number, management port 2163 will be supported; however,
you will need to specify the -port switch and number 2163 in every subsequent
command you issue.
-q
Suppresses error messages. This switch is useful when included as part of a script.
-RemoveUserSecurity
Directs the CLI to remove user security information about the current user from the
security file on this server.
-scope 0 | 1 | 2
Specifies whether the user account on the system you want to log in to is local,
global, or lightweight directory access protocol (LDAP). A 0 (default) indicates global,
1 indicates local, and 2 indicates LDAP. A global account is effective throughout the
domain. When the administrator creates a global account, the software copies the
definition of this account to the domain directory, which makes it accessible on all
systems in the domain. A local account is effective only on the systems for which the
administrator creates the account. You can log in only to those systems on which
you have a local account. LDAP maps the username or password entries to an
naviseccli

21

About CLI Commands

external LDAP or active directory server for authentication. Username or password
pairs whose roles are not mapped to the external directory will be denied access.
-secfilepath filename
Stores the security file in a file path location you specify. When you create a security
file on a server using the -addusersecurity command, the security file is saved
to your default home directory. If you want to store the security file in an alternative
location, you can use the optional -secfilepath switch with the addusersecurity command.
Note

If you use the -secfilepath switch to set up an alternative path for your security
file, you must use this switch in every subsequent CLI command you issue, to ensure
the CLI locates the security file.
security -certificate
Saves the certificates to the certificate store. It also provides options like -list, remove, -add to manage the certificate store.
-timeout | -t timeout
Sets the timeout value in seconds. The default is 600 seconds.
-user username
Specifies the username on the system you want to log in to. Username is casesensitive. You can omit this if you have added the username to the security file.
Note

You can use this switch when establishing a security file, to specify an alternative
username. See -AddUserSecurity.
-v
Enables verbose error descriptions. This is the default unless -q is specified.
-xml
Specifies command output in XML format. Use the -o (override switch) when
specifying -xml with commands that require confirmation. Otherwise, the XML
output will contain your confirmation string.
CMD
One of the set of commands used with the naviseccli command.

22

EMC VNX Series 5.33 Command Line Interface Reference for Block

CHAPTER 2
VNX CLI for Block

This chapter includes content for VNX series systems.
Major topics include:
l
l
l
l
l
l
l
l
l
l
l

Basic commands...................................................................................................24
LUN Expansion (metaLUN) commands.................................................................182
Reserved LUN Pool commands............................................................................ 198
iSCSI and FCoE commands.................................................................................. 202
LUN Migration commands................................................................................... 235
Domain and Security commands......................................................................... 239
Event Monitor commands....................................................................................271
Virtual server commands.....................................................................................285
Host Agent commands........................................................................................ 295
Unisphere Server Utility.......................................................................................299
Unisphere Initialization Utility............................................................................. 302

VNX CLI for Block

23

VNX CLI for Block

Basic commands
This section explains each of the basic variations, that is, the CLI commands that are
common to all systems. Command variations for Storage Groups (Access Logix) are
explained in the following chapter.

Storage setup and management overview
This section shows how to configure and monitor a system using the naviseccli
command. It shows commands with UNIX device names. The Windows device names
would be drive letters. In this system, in which each SP is a host. For an overview showing
systems with storage groups, see the section Shared storage setup and management
overview on page 25. For systems without storage groups:
Procedure
1. Create three RAID groups.
naviseccli -h ss1_spa createrg 0 0_0_4 0_0_5 0_0_6 0_0_7 0_0_8 raidtype r5

Creates RAID group 0 from disks 4 through 8 in the DPE enclosure.
naviseccli -h ss1_spa createrg 1 0_0_9 0_0_10 -raidtype r1

Creates RAID group 1 from disks 9 and 10 in the DPE enclosure.
naviseccli -h ss1_spa createrg 2 0_0_11 0_0_12 -raidtype r1

Creates RAID group 2 from disks 11 and 12 in the DPE enclosure.
2. Bind a LUN on each RAID group.
naviseccli -h ss1_spa bind 0 -rg 0

This command binds a LUN of type RAID 5 with LUN ID 0 on RAID group 0. The LUN
occupies all space on RAID group 0, since the bind command did not include the cap switch. By default, read and write caching are enabled on the new LUN.
naviseccli -h ss1_spa bind 1 -rg 1

This command binds a LUN of type RAID 1 (mirrored pair) with LUN ID 1 on RAID group
1. The LUN occupies all space on RAID group 1 and caching is enabled by default.
naviseccli -h ss1_spa bind 2 -rg 2

This command binds a LUN of type RAID 1 (mirrored pair) with LUN ID 2 on RAID group
2. The LUN occupies all space on RAID group 2, and caching is enabled by default.
3. Get SP memory information to prepare to set up the system cache.
naviseccli -h ss1_spa getsp -mem
SP A
Memory Size For The SP: 12288
SP B
Memory Size For The SP: 12288

24

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

4. For easy identification in the future, name the system.
naviseccli -h ss1_spa arrayname users11
Change the arrayname from xxx to users11? (y/n) y

This command changes the name of the system to users11.
Results
At this point, you can create file systems on the LUNs from the operating system and
store data on them.
You can learn LUN device names using the getagent command and check status
periodically using the getsp, getdisk, and getlun commands.

Shared storage setup and management overview
Storage groups provide a simple means of managing which hosts can access defined
groups of LUNs. Specify host-storage group access using the unique ID (also called the
world wide name, WWN) of each HBA and LUN.
Generally, you may find it easier to use Unisphere than the CLI to create and manipulate
storage groups. However, the following is a sequence of tasks you can perform using only
the CLI:
Procedure
1. Plan the LUNs that each host will use: RAID group type, capacity, SP owner, storage
group, and so on.
2. Create the RAID groups, bind the LUNs, and assign the LUNs to RAID groups using
manager or the CLI. See the unshared storage overview in Storage setup and
management overview on page 24 for example use of the CLI.
Note

If you are running VMware ESX Server, you can bind LUNs from ESX Server or a virtual
machine (VM).
3. Create the storage groups you want using Unisphere or the CLI command
storagegroup -create.
4. Connect the hosts to storage groups using Unisphere or the CLI. Use the CLI command
storagegroup -connecthost to assign a storage group to all HBAs in a host, or
the command storagegroup -setpath to assign a storage group to a specific
HBA in a host.
Note

If you are running VMware ESX Server, assign ESX Server to the storage group.
5. Assign LUNs to the storage groups using Unisphere or the CLI storagegroup addhlu command. You can assign more than one LUN to a storage group and let
more than one host access a storage group.

Shared storage setup and management overview

25

VNX CLI for Block

Note

If you are running VMware ESX Server, rescan the bus at the ESX Server level. If you
are running ESX Server 2.5.x, you must then power down any virtual machine to which
you will assign LUNs. If you are running ESX Server 3.x, you do not need to power
down the virtual machine. At the ESX Server level, assign the LUNs to the virtual
machines. When you have finished, if you are running ESX Server 2.5.x, power up the
VM. If you are running ESX Server 3.x, you do not need to power up the VM.
6. As needed, reconfigure host-storage group connections using Unisphere or the CLI
command storagegroup -sethost. If you need to disconnect a host from a
storage group, use storagegroup -disconnecthost.

alpa -get
Displays the SCSI ID associated with an SP port.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The CLI alpa commands (Arbitrated Loop Physical Address) get and set the port ID SCSI
IDs on an SP. These IDs are required for I/O to the SP.
We suggest you use a unique SCSI ID for each SP port in your installation. For example,
on the first system, for ports 0 and 1, you can specify SCSI IDs 0 and 1, respectively. On
the second system, for the ports you can specify IDs 2 and 3 respectively, and so on.
The naviseccli command -get function lists ALPA information. The information
includes the port ID, the SP ID (A or B), and the SCSI ID associated with the port. Issue the
command to the SP for which this information is needed.
If you really need to change an SP port ID, you can do so with the alpa -set function.
SYNTAX
alpa -get
EXAMPLE
For SP A (SP hostname payroll_storage_spa), this command lists the SCSI ID
associated with port 0.
naviseccli -h payroll_storage_spa alpa -get
Storage Processor: SP A
Port ID:
0
ALPA Value:
0

OUTPUT
See above. If the version of VNX Operating Environment (OE) for Block software running
on the SP does not support this command, a Not supported error message is printed
to stderr. Other errors:
VALID_VALUES_0_3

26

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

alpa -set
Updates the SCSI ID associated with an SP port.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli alpa command with the -set switch updates the SCSI ID value for
the given port on an SP.
CAUTION

The SP port ID SCSI IDs are initially set by EMC service personnel to work at your site. Do
not change any value unless you are installing a new SP and need to change its SCSI IDs
from the SP ship values of 0 and 1.
If you change any value, after you confirm, the SP will restart and use the new values.
The software will not let you select a SCSI ID out of range (0-126) or a duplicate ID on a
system. If you omit the -o (override) switch, then the CLI prompts for confirmation:
Changing the ALPA value of port port-id from old-SCSI-ID to new-SCSIID (y/n)

To confirm, answer y; to take no action, answer n.
SYNTAX
alpa -set
-sp a|b -portid portid SCSI-ID [-o]
OPTIONS
-sp a | b
Specifies the SP: A or B.
-portid portid SCSI-ID
Specifies the new SCSI ID to associate with the port. Valid port SCSI IDs range from 0
through 126.
-o
Executes the command without prompting for confirmation.
EXAMPLE
For SP A, this command changes the SCSI ID associated with port 1 to 1.
naviseccli -h ss1_SPA alpa -set -sp a -portid 1 1
Changing the ALPA value of port 1, SP A to 1
WARNING: This operation will reboot the target SP.
Verify that the SPS on the surviving SP is operating correctly.
Otherwise write cache must be disabled:
naviseccli -h IPAddress cache -sp -modify -wc off.
Failure to disable write cache may result in the loss of data.
DO YOU WISH TO CONTINUE? (y/n)

alpa -set

27

VNX CLI for Block

OUTPUT
See above. If the version of VNX OE for Block software running on the SP does not support
this command, a Not supported error message is printed to stderr. Other errors:
VALID_VALUES_0_126
VALID_VALUES_0_3

arraycommpath
Sets a communication path to a system that has no LUNs bound, or removes such a path
(non-storage group only).
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli arraycommpath command creates or removes a communication
path between the server and system. Generally this command is needed when you want
to configure a system that has no LUNs bound.
This command works only for systems without storage groups. For systems with storage
groups, use the command storagegroup sethost -arraycommpath (refer
storagegroup on page 168.)
The CLI will not issue a confirmation request first if you include the -o switch.
CAUTION

Do not issue this command unless you know the appropriate value for the type of
failover software running on the attached servers. The command is designed for
transition from one type of failover software to another. Changing the arraycommpath
mode to the wrong value will make the system inaccessible.
To discover the current setting of arraycommpath, use the command without an
argument.
SYNTAX
arraycommpath [0 | 1] [-o]
OPTIONS
0
Disables a communication path.
1
-o

Enables a communication path.
Executes the command without prompting for confirmation.

EXAMPLE
This command disables the communication path between server and system. In this
example, the confirmation message shows that the change, if confirmed, will cause the
previous setting to be lost.
naviseccli -h ss1_spa arraycommpath 0
WARNING: Previous arraycommpath setting will be lost!
DO YOU WISH TO CONTINUE? (y/n) y

28

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

OUTPUT
If the version of VNX OE for Block software running on the SP does not support this
command, a Not supported error message is printed to stderr. Other errors:
Valid values are 0 or 1

arrayconfig -capture
Queries the system for configuration information.
PREREQUISITES
A user role of administrator is required to execute this command.
DESCRIPTION
The arrayconfig -capture command queries the system for its configuration along
with I/O port configuration information. When issued, the command will capture a
system’s essential configuration data. The information is formatted and stored on the
client workstation.
This generated file can be used as a template to configure other systems or rebuild the
same system if the previous configuration is destroyed. The information captured may
include:
l

Software installed in the system (name of the software, revision, and so on).

l

Physical configuration of the system (storage processors, disks, enclosures, and so
on.)

l

Logical configuration of the system (RAID groups, LUNs, storage groups, clones,
SnapView, and mirrors).

l

I/O port configuration information (hardware and logical configuration information) of
a VNX series system.

SYNTAX
arrayconfig -capture [-format XML|CSV] [output path to local
file name] [-logprogress] [-o]
OPTIONS
-format XML|CSV
Defaults to XML if -format is not specified.
-logfile
Retrieves and outputs the log file stored on the targeted system.
-o
Executes the command without prompting for confirmation.
-output path to local file name
An XML file in the specified path and name will be created. If the indicated output
file already exists, you will be asked if you wish to overwrite it.
-logprogress
Displays the detailed information. If this option is not specified, displays only error
information.
EXAMPLE
naviseccli -h ss1_spa arrayconfig -capture -output c:\Capture158.xml
-format xml

arrayconfig -capture

29

VNX CLI for Block

OUTPUT
If the command succeeds, the XML file will be generated. There will be no message
displayed in the command line.

arrayconfig -duplicate
Creates the components in the indicated configuration file on the targeted system.
PREREQUISITES
Manager privileges are required to execute the arrayconfig -duplicate command.
DESCRIPTION
Issuing the arrayconfig -duplicate command creates the logical components
listed in the configuration file (generated from issuing the arrayconfig -capture
command) for the indicated system. You can view both the status of the duplication
operation and the log file.
Before starting the duplication process, the following will be checked to ensure the
targeted system qualifies for duplication.
Physical components:
l

The model number on the targeted system must be exactly the same as the source.

l

The targeted system must have at least the same number of disks as the source
(includes all RAID groups).

l

The disk enclosure numbers and slot numbers should exactly match the source
(includes all RAID groups).

l

Drive types must match.

l

The size of the targeted disks must be equal to or greater than the size of the source
disks.

Software availability:
l

The targeted system must have all the system and Unisphere software packages
available in the source system.

Logical components:
The target system must be in a logically clean state. If any of the following components
are available, the target is not considered clean and the command will fail:
l

RAID groups

l

LUNs

l

User-created storage groups

Note

Duplication will not create the following logical components on the target system(s):
SnapView sessions, SAN Copy information, synchronous/asynchronous mirror secondary
information. If the XML captured from a mirror secondary system is used for duplication,
then no mirror information will be created in the target system.
Note

While the -capture command supports both XML and CSV file formats, the duplicate command processes information only in the XML format.

30

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

CAUTION

This command creates a new configuration in the system; use it only after completely
understanding the command’s behavior.
SYNTAX
arrayconfig -duplicate [-input path to local file name]
[-recover] [-stop] [-rollback] [-status] [-logfile] [-o]
OPTIONS
-input path to local file name
This is the filename of the captured information (captured from issuing the
configuration -capture command).
-logfile
Retrieves and outputs the duplication log file stored on the targeted system.
-o
Executes the command without prompting for confirmation.
-recover
Used in a disaster recovery situation (if the system in trouble needs to be
reconfigured from scratch using a configuration captured from the same system
when it was healthy).
This assumes that the host connectivity and everything pertaining to the system will
be the same. The initiators, the host objects and their associations with storage
groups will be duplicated.
-rollback
Attempts to back out of the changes that are added to the configuration during the
last duplication operation.
Changes made to the configuration after the duplication operation will not be
accounted for, and may affect the rollback operation. For example, after a successful
duplication, if you destroy a RAID group and create another RAID group with the
same ID, the rollback will destroy the newly created RAID group as well. The rollback
operates based on the object IDs stored in an internal context file. If the IDs are the
same, it will not differentiate between the objects created by the previous
duplication and the user-created objects.
-status
Provides a brief description of the current status of the duplication operation.
-stop
Terminates the currently running duplication operation, leaving the configuration
intact at the point that the duplication ended.
Note

The -logfile and -status commands can be run with monitor privileges. All
other -duplicate commands require manager privileges.
EXAMPLE
naviseccli -h ss1_spa arrayconfig -duplicate -input c:\Capture158.xml

arrayconfig -duplicate

31

VNX CLI for Block

arrayname
Renames a system.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli arrayname command changes the name of a system. If you omit a
system name, the command returns the current system name (in the format host-device
or system name).
The CLI prompts for confirmation as follows.
SYNTAX
arrayname NewArrayName
OPTIONS
arrayname NewArrayName
Specifies the new name for the system.
EXAMPLE
This command changes the name of the system to users11.
naviseccli -h ss1_spa

arrayname users11

Change the arrayname from ss1 to users11? (y/n) y

OUTPUT
If the version of VNX OE for Block software running on the SP does not support this
command, a Not Supported error message is printed to stderr.

backendbus -analyze
Displays speed and state information for each back-end bus and the devices on the backend bus.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli backendbus command with the -analyze function, displays the
current and maximum back-end bus speeds for each back-end bus on the system, and
each device (enclosures, disks, and link control cards (LCCs)) on the back-end bus. It also
lists state information that includes whether a device on the bus is limiting and whether
the system meets conditions required for a reset (see the list of conditions later in this
section).
The current speed indicates the speed at which a bus or device is currently running; the
maximum speed indicates the highest speed at which a bus or device is capable of
running. If a device is limiting, it has a maximum speed lower than the maximum speed
of the back-end bus. If you have a limiting device, a reset will not occur when you issue
backendbus-resetspeed.
When you run backendbus -analyze, a summary analysis appears for each back-end
bus to indicate whether a reset operation will be successful for the back-end bus. One of
the following summary results will appear for each back-end bus.
32

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Table 1 backendbus -analyze summary analysis

Summary analysisa

Description

Speed may change on rescan

A speed-related fault exists on the back-end bus (see
Description section). The CLI cannot determine whether a reset
will occur.

Speed will change on rescan

A reset will occur.

Speed will not change on rescan There are limiting devices on the back-end bus. A reset will not
occur.
a.

If a limiting device or speed-related fault exists on the back-end bus, a listing of the limiting
devices and speed-related faults appears before the summary analysis. Devices with speedrelated faults appear as Devices Requesting Bypass.

A speed-related fault can occur when you add a device to a back-end bus that has a
maximum speed lower than the current speed of the bus. A device with a speed-related
fault appears with unknown speed values; therefore, the CLI cannot determine if a reset
will occur.
Note

If you issue the backendbus -resetspeed command, and a device with a speedrelated fault exists on the bus, the reset could decrease the back-end bus speed
(downgrade).
Your system must meet required conditions before you can issue a reset. The following
table shows the list of conditions.
Table 2 Conditions

Condition

Description (pass criteria)

Analyze Speed Rule

The summary analysis for the back-end bus, displayed in backendbus analyze, indicates that a reset will or may occur.

System Faults Rule

No system faults can exist.

Active Sessions Rule No active SnapView, MirrorView, or SAN Copy sessions.
Transitions Rule

No active transitions such as, LUN binds, LUN expansions, RAID group
expansions, disk equalization.

I/O Rate Rule

No active I/O.

Note

Run backendbus -analyze before you issue backendbus -resetspeed.
SYNTAX
backendbus -analyze
EXAMPLE
The following example displays current and maximum back-end bus speeds for each
back-end bus on the specified system and the devices on the back-end bus:
naviseccli -h ss1_spa -user user11 –password pswd11 -scope 0
backendbus -analyze
backendbus -analyze

33

VNX CLI for Block

OUTPUT
Bus 0 - Current Speed: 6Gbps. Maximum speed: 6Gbps.
Device
Current
Max
Limiting
Type
Speed
Speed
-------------------------------------------------------------Bus 0 Enclosure 0
6
6
No
DAE6S
-------------------------------------------------------------LCC A
6
6
No
LCC B
6
6
No
-------------------------------------------------------------Disk 0
6
6
No
SAS
Disk 1
6
6
No
SAS
Disk 2
6
6
No
SAS
Disk 3
6
6
No
SAS
Disk 4
6
6
No
SAS
Disk 5
6
6
No
SAS
Disk 6
6
6
No
SAS
Disk 7
6
6
No
SAS
Disk 8
6
6
No
SAS
Disk 9
6
6
No
SAS
Disk 10
6
6
No
SAS
Disk 11
6
6
No
SAS
Disk 12
6
6
No
SAS
Disk 13
6
6
No
SAS
Disk 14
6
6
No
SAS
-------------------------------------------------------------Bus 0 Enclosure 1
6
6
Maybe
DAE7S
-------------------------------------------------------------ICM A
6
6
Maybe
ICM B
6
6
Maybe
LCC C
6
6
Maybe
LCC D
6
6
Maybe
-------------------------------------------------------------Disk A0
6
6
No
SAS
Disk A1
6
3
No
SATA
Disk A2
6
6
No
SAS
Disk A3
6
3
No
SATA
Disk A4
6
3
No
SATA
Disk A5
6
3
No
SATA
Disk A6
Unknown
Unknown
No
Unknown
Disk A7
Unknown
Unknown
No
Unknown
Disk A8
Unknown
Unknown
No
Unknown
Disk A9
Unknown
Unknown
No
Unknown
Disk A10
Unknown
Unknown
No
Unknown
Disk A11
Unknown
Unknown
No
Unknown
Disk B0
6
3
No
SATA
Disk B1
6
6
No
SAS
Disk B2
6
3
No
SATA
Disk B3
6
3
No
SATA
Disk B4
6
3
No
SATA
Disk B5
6
3
No
SATA
Disk B6
Unknown
Unknown
No
Unknown
Disk B7
Unknown
Unknown
No
Unknown
Disk B8
Unknown
Unknown
No
Unknown
Disk B9
Unknown
Unknown
No
Unknown
Disk B10
Unknown
Unknown
No
Unknown
Disk B11
Unknown
Unknown
No
Unknown
Disk C0
6
3
No
SATA
Disk C1
6
3
No
SATA
Disk C2
6
3
No
SATA
Disk C3
6
3
No
SATA
Disk C4
6
3
No
SATA
Disk C5
6
3
No
SATA
Disk C6
Unknown
Unknown
No
Unknown

34

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Disk C7
Unknown
Unknown
No
Unknown
Disk C8
Unknown
Unknown
No
Unknown
Disk C9
Unknown
Unknown
No
Unknown
Disk C10
Unknown
Unknown
No
Unknown
Disk C11
Unknown
Unknown
No
Unknown
Disk D0
6
6
No
SAS
Disk D1
6
6
No
SAS
Disk D2
6
3
No
SATA
Disk D3
6
3
No
SATA
Disk D4
6
3
No
SATA
Disk D5
6
3
No
SATA
Disk D6
Unknown
Unknown
No
Unknown
Disk D7
Unknown
Unknown
No
Unknown
Disk D8
Unknown
Unknown
No
Unknown
Disk D9
Unknown
Unknown
No
Unknown
Disk D10
Unknown
Unknown
No
Unknown
Disk D11
Unknown
Unknown
No
Unknown
Disk E0
6
3
No
SATA
Disk E1
6
3
No
SATA
Disk E2
6
3
No
SATA
Disk E3
6
3
No
SATA
Disk E4
6
3
No
SATA
Disk E5
6
3
No
SATA
Disk E6
Unknown
Unknown
No
Unknown
Disk E7
Unknown
Unknown
No
Unknown
Disk E8
Unknown
Unknown
No
Unknown
Disk E9
Unknown
Unknown
No
Unknown
Disk E10
Unknown
Unknown
No
Unknown
Disk E11
Unknown
Unknown
No
Unknown
-------------------------------------------------------------Bus 0 is currently running at 6Gbps.
Speed will not change on rescan
Analyze Speed Rule...Failed No loop will change speed on rescan.
System Faults Rule... Failed: Bus 0 Enclosure 1 Power A is Faulted
Active Sessions Rule... Passed
Transitions Rule... Passed
I/O Rate Rule... Passed

backendbus -get -connstate
Displays the connector state information.
PREREQUISITES
You must have a user account on the storage system on which you want to execute the
command.
DESCRIPTION
The naviseccli backendbus command with the -get -connstate
switches displays the connector state for the mini-SAS HD
connector(s) inserted into the BE SAS ports on the Mezzanine
card.
SYNTAX
backendbus -get -connstate
EXAMPLE
The following output shows the output for the backendbus -get -connstate
command when the mini SAS HD cable is connected on the Hypernova SLIC:
Bus 0
SPA Connector State: Online
SPB Connector State: Online

backendbus -get -connstate

35

VNX CLI for Block

backendbus -get -physical
Displays physical slot and physical port ID information.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli backendbus command with the -get -physical switches
displays the physical location of the back-end bus on the VNX series system. The
physical location information includes I/O module and the physical port ID.
The backendbus -get -all command also displays the physical location
information.
SYNTAX
backendbus -get -physical [backend bus number]
OPTIONS
backend bus number
Specifies the back-end bus for which you want to display bus information.

EXAMPLE
naviseccli -h ss1_spa backendbus -get -physical

OUTPUT
Bus 0
I/O Module Slot: 0
Physical Port ID: 0
Port Combination in Use: YES
Bus 0
I/O Module Slot: 0
Physical Port ID: 1
Port Combination in Use: YES
Bus 2
I/O Module Slot: 0
Physical Port ID: 2
Port Combination in Use: NO

backendbus -get -prominfo
Displays information returned from the resume prom in the connectors.
PREREQUISITES
You must have a user account on the storage system on which you want to execute the
command.
DESCRIPTION
The naviseccli backendbus command with the -get -prominfo switch displays
the new information returned from the resume prom in the SFP+ and mini-SAS HD
connectors.
SYNTAX
backendbus -get -prominfo

36

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

EXAMPLE
The following output shows the output for the backendbus –get –prominfo
command when the mini-SAS HD cable is connected on the Hypernova SLIC:
Bus 0
SPA SFP/Connector EMC Part Number: TBD
SPB SFP/Connector EMC Part Number: TBD
SPA SFP/Connector EMC Serial Number: TBD
SPB SFP/Connector EMC Serial Number: TBD
SPA SFP/Connector Vendor Part Number: TBD
SPB SFP/Connector Vendor Part Number: TBD
SPA SFP/Connector Vendor Serial Number: TBD
SPB SFP/Connector Vendor Serial Number: TBD
SPA SFP/Connector Supported Speeds:
3Gbps.
6Gbps.
SPB SFP/Connector Supported Speeds:
3Gbps.
6Gbps.

backendbus -get -sfpstate
Displays the current condition of each back-end SFP.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli backendbus command with the -get -sfpstate function
displays the current condition of each back-end SFP, which is a small form-factor
pluggable (SFP) optical modular transceiver. You can target a specific back-end bus and
display information for only that bus, or you can display back-end bus information for all
buses on the system.
The SFP states are Online, Faulted, and Removed. Online indicates that the back-end SFP
is functioning normally; Faulted indicates an unsupported or faulted SFP; and Removed
indicates that it does not exist.
Use backendbus -analyze to display speed information for each device on a backend bus.
SYNTAX
backendbus -get -sfpstate [backend bus number]
OPTIONS
backend bus number
Specifies the back-end bus for which you want to display bus information.

EXAMPLE
The following example displays the current condition for each back-end SFP:
naviseccli -h ss1_spa backendbus -get -sfpstate

OUTPUT
Bus 0:

backendbus -get -sfpstate

37

VNX CLI for Block

SPA SFP State: Faulted
SPB SFP State: Online

backendbus -get -speeds
Displays back-end bus speed information for the back-end buses on a system.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli backendbus command with the -get -speeds function displays
the current and available back-end bus speeds, for the back-end buses on a system. You
can target a specific back-end bus and display only information for that bus, or you can
display back-end bus speed information for all buses on the system.
The current speed indicates the speed the bus is currently running at; the available
speed(s) indicates the speed(s) available to the back-end bus. If the current speed is less
than the maximum available speed, you can run the backendbus -analyze
command to verify if there are limiting devices on the back-end bus. If a device is limiting,
it has a maximum speed lower than the maximum speed of the back-end bus. If you have
a limiting device, a reset will not occur when you issue backendbus -resetspeed.
Use backendbus -analyze to display speed information for each device on a backend bus.
SYNTAX
backendbus -get -speeds [backend bus number]
OPTIONS
backend bus number
Specifies the back-end bus for which you want to display bus speed information.

EXAMPLE
The following example displays current and available bus speed information for back-end
bus number 2:
naviseccli -h ss1_spa backendbus -get -speeds 2

OUTPUT
Bus 2:
Current Speed: 6Gbps.
Available Speeds:
3Gbps.
6Gbps.

backendbus -get -all
Displays the bus speeds, SFP state, and physical location of the bus.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli backendbus command with the -get -all function displays the
bus speeds and the current condition of each back-end SFP, which is a small form-factor
pluggable (SFP) optical modular transceiver for the back-end buses on a system. It
displays the physical location of the back-end bus (I/O module and the physical port ID)
38

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

only for the VNX series system. You can target a specific back-end bus and display
information for only that bus, or you can display back-end bus information for all buses
on the system.
The current speed indicates the speed the bus is currently running at; the available
speed(s) indicates the speed(s) available to the back-end bus. If the current speed is less
than the maximum available speed, you can run the backendbus -analyze
command to verify if limiting devices exist on the back-end bus. If a device is limiting, it
has a maximum speed lower than the maximum speed of the back-end bus. If you have a
limiting device, a reset will not occur when you issue backendbus -resetspeed.
The SFP states are Online, Faulted, and Removed. Online indicates that the back-end SFP
is functioning normally; Faulted indicates an unsupported or faulted SFP; and Removed
indicates that it does not exist.
Use backendbus -analyze to display speed information for each device on a backend bus.
SYNTAX
backendbus -get -all [backend bus number]
OPTIONS
backend bus number
Specifies the back-end bus for which you want to display bus information.
EXAMPLE
The following example displays the bus speed, current condition, and physical location
for each back-end SFP:
naviseccli -h ss1_spa backendbus -get -all

OUTPUT
Bus 0
Current Speed: 6Gbps.
Available Speeds:
0Gbps.
3Gbps.
6Gbps.
SPA SFP State: N/A
SPB SFP State: N/A
I/O Module Slot: Base Module
Physical Port ID: 0
Port Combination In Use: No
SPA Connector State: None
SPB Connector State: None
SPA SFP/Connector EMC Part Number: N/A
SPB SFP/Connector EMC Part Number: N/A
SPA SFP/Connector EMC Serial Number: N/A
SPB SFP/Connector EMC Serial Number: N/A
SPA SFP/Connector Vendor Part Number: N/A
SPB SFP/Connector Vendor Part Number: N/A
SPA SFP/Connector Vendor Serial Number: N/A
SPB SFP/Connector Vendor Serial Number: N/A
SPA SFP/Connector Supported Speeds:
N/A

backendbus -get -all

39

VNX CLI for Block

SPB SFP/Connector Supported Speeds:
N/A
Bus 1
Current Speed: 0Gbps.
Available Speeds:
0Gbps.
3Gbps.
6Gbps.
SPA SFP State: N/A
SPB SFP State: N/A
I/O Module Slot: Base Module
Physical Port ID: 1
Port Combination In Use: No
SPA Connector State: None
SPB Connector State: None
SPA SFP/Connector EMC Part Number: N/A
SPB SFP/Connector EMC Part Number: N/A
SPA SFP/Connector EMC Serial Number: N/A
SPB SFP/Connector EMC Serial Number: N/A
SPA SFP/Connector Vendor Part Number: N/A
SPB SFP/Connector Vendor Part Number: N/A
SPA SFP/Connector Vendor Serial Number: N/A
SPB SFP/Connector Vendor Serial Number: N/A
SPA SFP/Connector Supported Speeds:
N/A
SPB SFP/Connector Supported Speeds:
N/A

The following output shows the output for the backendbus –get –all command
when the mini-SAS HD cable is connected on the Hypernova SLIC:
Bus 0
Current Speed: 6Gbps.
Available Speeds:
3Gbps.
6Gbps.
SPA SFP State: N/A
SPB SFP State: N/A
I/O Module Slot: 1
Physical Port ID: 0
SPA Connector State: Online
SPB Connector State: Online
SPA SFP/Connector EMC Part Number:
SPB SFP/Connector EMC Part Number:
SPA SFP/Connector EMC Serial Number:
SPB SFP/Connector EMC Serial Number:
SPA SFP/Connector Vendor Part Number:
SPB SFP/Connector Vendor Part Number:

40

EMC VNX Series 5.33 Command Line Interface Reference for Block

TBD
TBD
TBD
TBD
TBD
TBD

VNX CLI for Block

SPA SFP/Connector Vendor Serial Number:
SPB SFP/Connector Vendor Serial Number:

TBD
TBD

SPA SFP/Connector Supported Speeds:
3Gbps.
6Gbps.
SPB SFP/Connector Supported Speeds:
3Gbps.
6Gbps.

The following example shows the output for the backendbus –get –all command
when the mini-SAS HD cable is connected:
Bus 0
Current Speed: 6Gbps.
Available Speeds:
3Gbps.
6Gbps.
SPA SFP State: N/A
SPB SFP State: N/A
I/O Module Slot: Onboard
Physical Port ID: 0
SPA Connector State: Online
SPB Connector State: Online
SPA SFP/Connector EMC Part Number: N/A
SPB SFP/Connector EMC Part Number: N/A
SPA SFP/Connector EMC Serial Number: N/A
SPB SFP/Connector EMC Serial Number: N/A
SPA SFP/Connector Vendor Part Number: N/A
SPB SFP/Connector Vendor Part Number: N/A
SPA SFP/Connector Vendor Serial Number: N/A
SPB SFP/Connector Vendor Serial Number: N/A
SPA SFP/Connector Supported Speeds:
N/A
SPB SFP/Connector Supported Speeds:
N/A

backendbus -resetspeed
Resets the back-end bus speeds for a system.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli backendbus command with the -resetspeed function, resets the
back-end bus speed for the buses on the system. When you execute backendbus resetspeed, if the back-end bus is eligible for a reset and the system meets the
conditions required for a back-end bus speed reset, the reset occurs. See the table below
for the steps you should take before issuing backendbus -resetspeed.

backendbus -resetspeed

41

VNX CLI for Block

Note

This is a disruptive operation and can take several minutes to complete. During this time
the system will be offline and no I/O will be performed.
Before you execute a reset, run backendbus -analyze to verify the current and
maximum speeds of each back-end bus and device to determine if limiting devices exist,
which will prevent a reset, and to verify that your system meets the conditions required
for a reset.
To verify whether the back-end bus speed reset occurs, capture the output from
backendbus -analyze or backendbus -get -speeds before you execute the
reset, to compare to the reset back-end bus speed values after you issue the reset.
Steps to take before issuing a reset:
1. Run backendbus -analyze to verify the following:
l

back-end bus and device speed information

l

no limiting devices exist on the back-end bus

l

system meets required conditions

2. Save the output from backendbus -analyze or backendbus -get -speeds,
to compare the bus speed in the saved output to the bus speed after you initiate
backendbus -resetspeed.
SYNTAX
backendbus -resetspeed
EXAMPLE
The following example resets the the back-end bus speeds for the specified system:
naviseccli -h ss1_spa backendbus -resetspeed
WARNING: the command you are about to execute requires
that the system be completely shutdown. During this period
of time all IO to attached application hosts will be
suspended. All affected applications must be quiesced
before proceeding to avoid data unavailability and
possible data loss. This operation will take several
minutes to complete.
Are you sure you want to proceed? (y/n)?

OUTPUT
None if the command succeeds; status or error information if it fails.

baseuuid
Gets or sets the system unique unit identifier (UUID) base for use by a server running
Tru64.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli baseuuid command gets or sets the base of the unique unit ID as
required for servers in a Tru64 cluster. The Tru64 operating system uses the UUID (which
it creates by combining the base and an offset, which is the system LUN ID) to manage
the LUNs in a cluster. You can also use the UUID to manage the LUN.
42

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

To discover the UUID base, use the command without an argument.
SYNTAX
baseuuid [uuid-base-value]
OPTIONS
uuid-base-value
Specifies the UUID base.

EXAMPLE
These commands get, then set the UUID base of the system containing the SP ss1_spa.
naviseccli

-h ss1_spa baseuuid

Base UUID of the system: 12345
naviseccli

-h ss1_spa baseuuid 34

Base UUID of the system is set to 34.

OUTPUT
If the version of VNX OE for Block software running on the SP does not support this
command, a Not Supported error message is printed to stderr.

bind
Creates a LUN within an existing RAID group.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli bind command binds a LUN within an existing RAID group. You can
create a RAID group with the createrg command (see createrg on page 56).
Ensure that you address the bind command to the SP that you want to own the LUN.
The following table identifies the parameters you must configure for each RAID type you
bind.
Table 3 LUN parameters for different RAID types

RAID type

Bind parameters

RAID 6, RAID 5, RAID 1/0

LUN number
Write caching

RAID 3

LUN number

RAID 1

LUN number
Write caching

RAID 0

LUN number
Write caching

Disk (individual disk unit)

LUN number
Write caching
bind

43

VNX CLI for Block

Table 3 LUN parameters for different RAID types (continued)

To allow for good choices of available disk modules, bind LUNs in this order:
1. First - RAID 1/0
2. Second - RAID 6, RAID 5, RAID 3, and RAID 0
3. Third - RAID 1
4. Fourth - Individual units
Before you start binding disk modules, read the restrictions and recommendations in the
following table.
Table 4 Restrictions and recommendations for binding disks into LUNs

LUN to bind

Restrictions and recommendations

Any LUN

You can bind only unbound disk modules. All disk modules in a LUN
must have the same capacity to fully use the modules’ storage space.

RAID 6

A RAID 6 group has an even number of disks. You must bind a
minimum of 4 disk modules and no more than 16 disk modules. We
recommend that you bind 6 or 12 modules for more efficient use of
disk space. Write caching is highly recommended for RAID 6.

RAID 5

You must bind a minimum of 3 disk modules and no more than 16 disk
modules. We recommend you bind 5 modules for more efficient use of
disk space.

RAID 3

You must bind exactly 5 or 9 disk modules. Select 5 drives for quicker
rebuild times or 9 drives for more efficient use of space.

RAID 1

You must bind exactly 2 disk modules.

RAID 0

You must bind a minimum of 3 disk modules, and no more than 16 disk
modules.

RAID 1/0

You must bind a minimum of 2 disk modules, and an even number of
modules, but no more than 16 modules. Unisphere pairs modules into
mirrored images in the order in which you select them. The first and
second modules you select are a pair of mirrored images; the third and
fourth modules you select are another pair of mirrored images; and so
on. The first module you select in each pair is the primary image, and
the second module is the secondary image.

Individual disk unit

None

Whether you should use caching for a specific LUN depends on the RAID type.
Recommendations for caching with different RAID types follow.
Table 5 Caching recommendations for different RAID types

RAID type Write caching

44

RAID 0

Acceptable

RAID 1

Acceptable

RAID 1/0

Acceptable

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Table 5 Caching recommendations for different RAID types (continued)

RAID type Write caching
RAID 3

Recommended

RAID 5

Highly recommended

RAID 6

Highly recommended

Disk

Acceptable

Note

When binding RAID 1/0 LUNs, the order in which you select modules is important. The
first module you select is the first part of the mirror’s primary image and the second
module is the first part of the mirror’s secondary image; the third module is the second
part of the primary image, the fourth module is the second part of the secondary image;
and so on for any other modules in the LUN. In other words, the first and second modules
selected are a pair of peer image parts, the third and fourth modules are another pair of
peer image parts, and so on.
If you need to change the description (RAID type), you must unbind the LUN (unbind on
page 181), and then rebind it with the correct parameters. If you need to change the
write cache state, use the chglun command ( chglun on page 50).
SYNTAX
bind [raidtype] [lun] -rg rgID [-cnt count_luns_to_create]
[-aa auto_assignment] [-cap capacity] [-fastcache 0|1]
[-noinitialverify][-pl placement]
[-sp a|b] [-sq size-qualifier]
[-wc writecache]
OPTIONS
raid-type
Specifies the RAID type for the LUN.

r0
= RAID 0
r1
= RAID 1
r3
= RAID 3
r5
= RAID 5
r6
= RAID 6
r1_0
= RAID 1/0

bind

45

VNX CLI for Block

id
= individual disk
Note

All RAID types are not supported on all systems.
lun

Specifies a decimal number to assign to the LUN valid range as shown in VNX for
Block Concepts guide, in section LUN IDs, unique IDs and disk IDs. If a valid range is
not specified, the lowest available number (the default value) is assigned to the
LUN.
-rg rgID
The RAID group identification number. The RAID group must already exist. You can
create a RAID group with the createrg command (createrg on page 56).
rgID specifies a number between 0 and the maximum number of RAID groups
supported by the RAID group system.

-cnt
Specifies the number of LUNs to create.
-aa auto_assignment (CX series only)
Enables or disables autoassignment functionality for the LUN. auto_assignment
specifies functionality as follows:
0
Disables auto-assignment
1
Enables auto-assignment (the default)
-cap capacity
Sets the capacity of usable space in the LUN. (The default is full space available.)
-fastcache 0|1
Enables or disables FAST Cache on the LUN.
-noinitialverify
Does not perform an initial background verification. When this switch is not present,
the bind performs an initial background verification on the newly bound LUN and
eliminates any latent soft media errors.
-pl placement
Places a LUN in a RAID group; placement specifies which algorithm to use as follows:
bf
best fit algorithm (the default)
ff
first fit algorithm
-sp a|b
Sets the default owner of the LUN: SP A or SP B. The default is the current SP.
-sq size-qualifier
Sets the default size qualifier. size-qualifier specifies the qualifier as follows:
mb
megabytes
gb
gigabytes (the default)
46

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

tb
terabytes
bc
block count
-wc write-cache
Enables or disables the system write cache for this specific LUN. writecache values:
0
Disables write cache
1
Enables write cache (the default).
EXAMPLE
naviseccli bind 10 -rg 0 -sq gb -cap 1

OUTPUT
There is no output. Errors are printed to stderr.

cachecard -list
Lists the state information of the cache memory card.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli cachecard command with the -list function lists the state
information of the cache memory card. The memory size and hardware state of the cache
memory card is displayed.
You can choose to display only the memory size by specifying the -size switch or
display only the hardware state by specifying the -hwstate switch. Without these
switches, the memory size and hardware state are displayed.
The possible hardware states are listed in the following table:
Table 6 Hardware states

Hardware state

Meaning

OK

The power on the main SP is on and the cache memory card battery is
fully charged. The cache memory card is in normal operation.

Not present

The cache memory card is not present.

Faulted

The cache memory card has hardware faults.

Battery charging

The power on the main SP is on and the battery is charging on the
cache memory card.

In wrong array

The cache memory card is from the wrong system.

SYNTAX
cachecard -list [-size] [-hwstate]
cachecard -list

47

VNX CLI for Block

OPTIONS
-size
Specifies that only the total memory size of the cache memory card (MB) be
displayed.
-hwstate
Specifies that only the hardware state of the cache memory card be displayed.
EXAMPLE
This command displays all state information (memory size and hardware state) of the
cache memory card.
naviseccli -h ss1_spa cachecard -list

OUTPUT
Total Memory:
Hardware State:

512MB
Ok

cachecard -initialize
Initializes the cache memory card.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli cachecard command with the -initialize function lets you
initialize the cache memory card.
The cachecard -initialize command can be issued under any of the following
circumstances:
l

a different cache memory card is installed on the system

l

live data is on the cache memory card

l

a LUN with an offline (cache dirty) condition exists on the system

SYNTAX
cachecard -initialize [-o]
OPTIONS
-o
Executes the command without prompting for confirmation.
EXAMPLE
For this example, a different cache memory card is installed on the system.
naviseccli -h ss1_spa cachecard -initialize
The cache memory card currently installed in this system is not the
same as the one previously installed in
this system. In order for this system to
function properly, the current cache memory card must be
initialized on this system.
Do you want to initialize Cache Memory Card now? (y/n)?

OUTPUT
None if the command succeeds; status or error information if it fails.

48

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

cache -sp -info
Lists the SP Cache properties.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli cache –sp -infocommand lists all SP cache properties, state
information, and performance statistics.
SYNTAX
cache -sp -info [-state][-perfdata]
OPTIONS
-state
Displays SP Cache state, which may be one of the following:
l

Enabled

l

Disabled

l

Disabling

l

Enabled with dirty data for unwritable LUNs

l

Disabling with dirty data for unwritable LUNs

-perfdata
Displays SP Cache performance statistics.
EXAMPLE #1
This example displays SP Cache state.
naviseccli -h ss1_spa cache -sp -info -state
SP Read Cache State: Enabled
SP Write Cache State: Enabled

EXAMPLE #2
This example displays SP Cache performance statistics.
naviseccli –h ss1_spa cache -sp -info -perfdata
Cache Page size (KB) :
Read Hit Ratio
:
Write Hit Ratio
:
Dirty Cache Pages (MB):

8
100
100
0

EXAMPLE #3
This example displays SP Cache properties and statistics.
naviseccli –h ss1_spa cache -sp –info
Cache Information
-----------------------SP Read Cache State: Enabled
SP Write Cache State: Enabled
Cache Page size (KB): 8
Read Hit Ratio: 100
Write Hit Ratio: 100
Dirty Cache Pages (MB): 0

cache -sp -info

49

VNX CLI for Block

SPA
SPB
SPA
SPB
SPS
SPS
SPA
SPB

Read Cache State: Enabled
Read Cache State: Enabled
Write Cache State: Enabled
Write Cache State: Enabled
Test Day: Saturday
Test Time: 20:00
Physical Memory Size (MB): 65536
Physical Memory Size (MB): 65536

cache -sp -modify
Modifies the SP Cache properties.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli cache –sp -modify command modifies the SP cache properties.
SYNTAX
cache –sp –modify-wc [on|off] [-o]
OPTIONS
-wc [on | off]
Enables or disables write cache.
on Enable write cache
off Disable write cache
-o
Executes the command without prompting for confirmation.
EXAMPLE
This example disables write cache.
naviseccli –h ss1_spa cache -sp –modify -wc off
Warning! Disabling write cache at the system level may seriously
degrade system performance and is not recommended.
Continue disabling system write cache? (y/n)?

OUTPUT
There is no output. Errors are printed to stderr.

chglun
Changes parameters on a currently bound LUN.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli chglun command changes parameters on a currently bound LUN.
You must use at least two switches with chglun and one of the switches must be the
LUN number -l lun.

50

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Note

The chglun command does not support thin LUNs.
To change a metaLUN, use the naviseccli command with the-modify switch, as
described in metalun -modify on page 196.
Table 7 Caching recommendations for different RAID types

RAID type Write caching
RAID 0

Acceptable

RAID 1

Acceptable

RAID 1/0

Acceptable

RAID 3

Recommended

RAID 5

Highly recommended

RAID 6

Highly recommended

Disk

Acceptable

Note

When binding RAID 1/0 LUNs, the order in which you select modules is important. The
first module you select is the first part of the mirror’s primary image and the second
module is the first part of the mirror’s secondary image; the third module is the second
part of the primary image, the fourth module is the second part of the secondary image;
and so on for any other modules in the LUN. In other words, the first and second modules
selected are a pair of peer image parts, the third and fourth modules are another pair of
peer image parts, and so on. Any change to the rebuild time takes effect as soon as the
operation completes.
SYNTAX
chglun -l lun [-a autoassign] [-c cachetype] [-d defaultowner]
[-fastcache 0|1] [-namenewname] [-w writeaside]
OPTIONS
-l lun
Specifies which LUN to change. lun specifies the LUN number. This switch is
required.
-a auto-assign
Enables or disables automatic reassignment of LUN ownership to an active SP if an
SP failure occurs.
auto_assign specifies functionality as follows:

0
Disables autoassignment for specified LUN
1
Enables autoassignment for specified LUN
-c cache-type
chglun

51

VNX CLI for Block

Enables read caching, or both read and write caching. For caching to occur, system
caching must also be enabled. Whether or not you should use caching for a specific
LUN depends on the RAID type. See the caching recommendations for different RAID
types on page 51.
cache-type specifies the type of caching used as follows:

read
read caching
rw
read and write caching
-d default-owner
Changes the default owner of the LUN. default-owner specifies ownership as follows:
0
Changes ownership of the LUN to SP A
1
Changes ownership of the LUN to SP B
-fastcache 0|1
Modifies the FAST Cache configuration of the LUN.
-name newname
Sets the LUN name. newname specifies the new name for the LUN. This switch
applies only to systems running a version of VNX OE for Block software that supports
storage group commands. The LUN name is displayed in the UI and has no other
purpose. You cannot use the LUN name as a CLI command argument. You can assign
the same name to multiple LUNs.
Note

The -name switch applies only to shared systems.
-w write-aside (Dual-SP AX4-5 series running Unisphere and CX series only)
write-aside specifies, in blocks, the largest write request size that will be written to
cache. Write requests greater than the write-aside value are written directly to disk,
bypassing write cache. Valid values are 0 through 65536. The default value '0'
indicates that all writes will be cached.
EXAMPLE
Change LUN 3 to enable read and write caching.
naviseccli -h ss1_spa chglun -l 3 -c rw

OUTPUT
There is no output. Errors are printed to stderr.

chgrg
Changes properties of a RAID group.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.

52

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

DESCRIPTION
The naviseccli chgrg command changes the properties of a specified RAID group.
You must use only one of the optional switches with chgrg and must specify the RAID
group identification number, rgID.
Note

The chgrg command does not support private RAID groups used in thin pools.
SYNTAX
chgrg rgID
[-powersavings on|off]
OPTIONS
rgID

Is the RAID group identification number. rgID specifies a number between 0 and the
maximum number of RAID groups supported by the RAID group system.
-powersavings on|off
Configures the power savings settings. If the selected disks are not eligible for power
savings settings, the system displays an error message.
EXAMPLE
This command turns the power savings settings ON in RAID group 2.
naviseccli -h ss1_spa chgrg 2 -powersavings on

OUTPUT
There is no output. Errors are printed to stderr.

clearlog
Clears the SP’s error log.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli clearlog command deletes the contents of the SP’s unsolicited
error log.
The command clears only the log of the SP you specify with the -h switch in the
command.
SYNTAX
clearlog
EXAMPLE
This command deletes the SP logs of the system.
naviseccli -h ss1_spa clearlog
unsolicited error log cleared

OUTPUT
Confirmation message.

clearlog

53

VNX CLI for Block

clearstats
Resets the SP’s statistics logging.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli clearstats command resets statistics logging on the SP. If
statistics logging is on, it is turned off, and then back on. If statistics logging is off, it is
turned on, and then off.
The command affects only the log of the SP you specify with the -h switch in the
command.
SYNTAX
clearstats
EXAMPLE
naviseccli -h ss1_spa clearstats
Statistics successfully cleared, statistics logging disabled.

OUTPUT
Confirmation message.

cmdtime
Displays the date and endtime of command execution.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
This is a global command switch used to display the date and time at the end of each
command execution. The time is displayed at the end of command output. This is an
optional switch supported on all CLI commands. This switch cannot work independently.
cmdtime switch is used with the CLI commands. You must add the -cmdtime switch for
each command to get the time information.
SYNTAX
cmdtime
OPTIONS
-cmdtime
Displays the date and end time of command execution.
EXAMPLE
naviseccli -h ss1_spa -cmdtime getagent
Agent Rev:
Name:
Desc:
Node:
Physical Node:

54

6.28.0 (1.83)
K10
A-CF2VH072500004
K10

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Signature:
1962014
Peer Signature:
0
Revision:
4.28.40.1.093
SCSI Id:
0
Model:
CX4-40
Model Type:
Rackmount
Prom Rev:
0.47.00
SP Memory:
5120
Serial No:
CF2VH072500004
SP Identifier:
A
Cabinet:
SPE
CmdTime: 10/11/07 07:46:44

copytodisk
Copies data from a configured drive (part of a RAID Group) to an unbound drive.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli copytodisk command initiates the copying of data from a
configured drive (part of a RAID Group) to an unbound drive. The user can use this
command to copy data from any bound disk to any unbound disk, not just from a
permanent spare to a replacement drive.
SYNTAX
copytodisk sourcedisk [destdisk] [-o]
OPTIONS
sourcedisk
Specifies the source disk.
destdisk
Specifies the destination disk.
Note

The destination disk must be the same type as the source disk, and the same size or
larger than the source disk. If the destination disk is not specified, the system will
choose an appropriate disk to copy to.
-o
Executes the command without prompting for confirmation.
EXAMPLE #1
This example initiates the copying of data from a bound disk 0_1_5 to an unbound disk
0_1_6.
naviseccli copytodisk 0_1_5 0_1_6
WARNING: The data from disk 0_1_5 will be copied to disk 0_1_6. This
process cannot be aborted and may take a long time to complete.
Also current selection of disks will break the hot spare policy;
would you like to continue the copy? (y/n) y

EXAMPLE #2
This example initiates the copying of data from disk 0_1_5 to disk 0_1_6 which is part of
an active copytodisk operation or is a bound drive.

copytodisk

55

VNX CLI for Block

naviseccli copytodisk 0_1_5 0_1_6
WARNING: The data from disk 0_1_5 will be copied to disk 0_1_6. This
process cannot be aborted and may take a long time to complete.
Do you wish to continue? (y/n) y
Error: copytodisk command failed
Error returned from Agent
SP A: The destination drive is busy processing a copy or is being
used by another RAID group. Please wait for the drive operation to
complete or copy to another drive. (0x717f8007)

EXAMPLE #3
This example initiates a proactive copy. A user may proactively initiate a copy and allow
the system to pick the drive that it will use to copy the data to. This might be done if the
user saw errors on the disk and wanted to copy the data before the drive actually failed.
For VNX, the source disk is not taken off-line after the copy. A user could also initiate a
proactive copy and supply the destination drive.
naviseccli copytodisk 0_0_7
WARNING: The disk 0_0_7 is selected for hot sparing. Its serial
number is 6SE4LHZE.
The proactive sparing process cannot be aborted and may take a long
time to complete. This disk will still be available after the
proactive copy is complete, and its state will change to Unbound.
Do you wish to continue? (y/n) y

createrg
Creates a RAID group.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli createrg command creates a RAID group on the specified disks.
To create RAID groups on a systems running Navisphere Express, you must define the –
raidtype switch.
Note

You cannot create private RAID groups using the createrg command.
SYNTAX
createrg rgID disks
-raidtype type [-powersavings on|off]
[-elementsize elementsize] [-o]
OPTIONS
rgID

Is the RAID group identification number. rgID specifies a number between 0 and the
maximum number of RAID groups supported by the RAID group system.
disks
Specifies the physical disks included in this RAID group. In a RAID 1/0 or RAID 1
configuration, you can manually select the disks for the RAID group in an order that
determines the primary and secondary image. For example, for a 1/0 RAID group, the
56

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

first two disks you list in the command form a pair of mirrored images, and the next
two disks form another pair of mirrored images, and so on.
Refer to the VNX for Block Concepts guide for more information about disk IDs to
verify the format for specifying disks.
Note

The disks in a RAID group must be SAS, NL-SAS, or different types of Flash drives. In
general, you must use the same type of drive in the RAID Group for all the disks.
-raidtype type
Sets the RAID type of the RAID group during the time of creation. The supported RAID
types are r6, r5, r3, r1_0, r0 and disk.
NOTICE

The -raidtype is a mandatory switch for VNX series systems.
-powersavings on|off
Turns the power savings settings ON or OFF on a RAID group. If -powersavings
option is not specified, then RAID group is created with power savings off by default.
If you specify disks that are not eligible for power savings settings, the system
displays an error message.
-elementsize elementsize
Enables the createrg command to accept an element size for RAID groups.
However, only the 4+1 RAID5 unit type, on non-Flash drives, accepts an element size
as large as 1024 sectors or blocks. If a size of 1024 is requested for RAID groups
other than 4+1 RAID5, the system displays the following error message:
Invalid RAID type for element size requested
Valid RAID types: r5 (with five disks)

If Flash drives are chosen for the RAID Group, with an element size of 1024, the
system displays the following error message:
Invalid drive type for element size requested
Valid drive types: non-Flash drive types
Note

If no element size if specified, an element size of 128 sectors or blocks will be
considered as the default value.
-o
Executes the command without prompting for confirmation. Skips hotspare policy
checking.
EXAMPLE
This command creates RAID group 0 from the five specified disks and sets raidtype r5 as
the RAID group.
naviseccli -h ss1_spa createrg 0 0_1 0_2 0_3 0_4 0_5 –raidtype r5

createrg

57

VNX CLI for Block

emconfiguration
Configures event monitor.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli emconfiguration command can be used to disable event
monitoring of an SP, for a specified amount of time. It will then re-enable the response
after the specified time is up.
SYNTAX
emconfiguration [-reloadconfig] [-disableresponse time]
[-enableresponse]
OPTIONS
-disableresponse time
This switch disables event monitoring of the SP for the amount of time specified.
Time is indicated in minutes, with a maximum of four hours.
-enableresponse
This switch re-enables the response.
-reloadconfig
This switch will reload a template file.
EXAMPLE
naviseccli -h ss1_spa emconfiguration -reloadconfig -disableresponse
time -enableresponse

environment
Reports inlet air temperature and input power.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The environment command displays the inlet air temperature and input power of the
system, disk-array enclosures, and standby power supply through the CLI and Unisphere
GUI.
SYNTAX
environment -list -array [-power] [-present]|[-average]
-enclosure [bus_enc|spe] [-power|-intemp [f|c]]
[-present]|[-average]
-sps [-sp a|b] [-power] [-present]|[-average]
-all
OPTIONS
-array
Displays the present or average input power information on the system.
-power
Displays the input power information.
58

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

-present
Displays the current value, which is a sum of the present input power of all
supported systems. The current value is computed as the 30-second average of the
power consumption sampled every 3 seconds.
-average
Displays the average value. The average value is computed as the 60-minute rolling
average of the present power consumption values.It requires an hour to calculate the
correct value. N/A is displayed if duration of data is less than an hour.
-enclosure
Displays the present or average inlet air temperature or input power information on a
specified disk-array enclosure.
bus_enc|spe
Specifies either the bus enclosure or SPE enclosure.
-intemp f|c
Displays the inlet air temperature information. The f flag indicates Fahrenheit and
the c flag indicates Celsius. The default value is c.
-sps
Displays the present or average input power information on a specified standby
power supply.
-sp a|b
Specifies the standby power supply ID on which to display the information.
-all
Displays the following:
l

System input power information

l

Data Mover enclosure inlet air temperatures and input power information

l

Array input power information

l

Disk-array enclosure inlet air temperatures and input power information

l

Storage processor enclosure inlet air temperatures and input power information

l

Standby power supply input power information

EXAMPLE #1
The following example shows the output for the environment -list -all
command for the DPE9
environment –list –all
Array
Input Power
Status: Valid
Present(watts): 180
Rolling Average(watts): 180
DPE9 Bus 0 Enclosure 0
Input Power
Status: Valid
Present(watts): 180
Rolling Average(watts): 180
Air Inlet Temperature
Status: Valid
Present(degree C): 28
Rolling Average(degree C): 28
Bus 0 Enclosure 0 BBU A
Input Power
Status: Invalid
Present(watts): Not Available
Rolling Average(watts): Not Available
Bus 0 Enclosure 0 BBU B
Input Power

environment

59

VNX CLI for Block

Status: Invalid
Present(watts): Not Available
Rolling Average(watts): Not Available

EXAMPLE #2
The following example shows the output for the environment -list -all
command for the SPE9.
environment -list -all
Array
Input Power
Status: Valid
Present(watts): 114
Rolling Average(watts): 114
SPE9 Enclosure SPE
Input Power
Status: Valid
Present(watts): 114
Rolling Average(watts): 114
Air Inlet Temperature
Status: Valid
Present(degree C): 24
Rolling Average(degree C): 24
DAE5S Bus 0 Enclosure 0
Input Power
Status: Valid
Present(watts): 163
Rolling Average(watts): 163
Air Inlet Temperature
Status: Valid
Present(degree C): 36
Rolling Average(degree C): 36
Enclosure SPE SPS Module A
Input Power
Status: Valid
Present(watts): 0
Rolling Average(watts): 0
Enclosure SPE SPS Battery A
Input Power
Status: Valid
Present(watts): 0
Rolling Average(watts): 0
Enclosure SPE SPS Module B
Input Power
Status: Valid
Present(watts): 0
Rolling Average(watts): 0
Enclosure SPE SPS Battery B
Input Power
Status: Valid
Present(watts): 0
Rolling Average(watts): 0
Bus 0 Enclosure 0 SPS Module A
Input Power
Status: Valid
Present(watts): 0
Rolling Average(watts): 0
Bus 0 Enclosure 0 SPS Battery A
Input Power
Status: Valid
Present(watts): 0
Rolling Average(watts): 0
Bus 0 Enclosure 0 SPS Module B
Input Power
Status: Valid

60

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Present(watts): 0
Rolling Average(watts): 0
Bus 0 Enclosure 0 SPS Battery B
Input Power
Status: Valid
Present(watts): 0
Rolling Average(watts): 0

failovermode
Changes the type of trespass needed for failover software (non-storage group only).
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli failovermode command enables or disables the type of trespass
needed for failover software. Use this command with certain types of failover software as
suggested in What are the Initiator, Arraycommpath, and Failovermode settings for
PowerPath, DMP, PVLinks, and native failover software, which is on EMC Online Support.
The CLI may prompt for confirmation of some changes you specify unless you use the -o
(override). To change the setting, enter y.
This command works for systems without storage groups only. For systems with storage
groups, use the command storagegroup sethost -failovermode (see
storagegroup on page 168 ).
Changing the failover mode setting will ask for confirmation unless you include the -o
switch.
CAUTION

Do not issue this command unless you know the appropriate value for the type of
failover software running on the attached servers. The command is designed for
transition from one type of failover software to another. Changing the failover mode to
the wrong value will make the system inaccessible.
To discover the current setting of failovermode, use the command without an
argument.
SYNTAX
failovermode [0|1|2|3|4] [-o]
OPTIONS
-o
Executes the command without prompting for confirmation.
EXAMPLE
For ss1_spa, this command enables failover mode 0.
naviseccli -h ss1_spa failovermode 0
WARNING: Previous Failovermode setting will be lost!
DO YOU WISH TO CONTINUE? (y/n) y

failovermode

61

VNX CLI for Block

OUTPUT
If the version of VNX OE for Block software running on the SP does not support this
command, a Not supported error message is printed to stderr. Other errors:
Command not supported Valid values are 0 to 3

faults -list
Lists status information for faulted components on the system.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli faults command with the -list function, provides status
information for faulted hardware components, such as enclosures, disks, power supplies,
storage processors, standby power supplies, as well as MirrorView/Asynchronous
replication software sessions.
SYNTAX
faults -list
EXAMPLE
The following example lists the faulted hardware components and MirrorView software
sessions on the system:
naviseccli -h ss1_spa faults -list

OUTPUT
Faulted Subsystem: APM00043806491
Enclosure SPE : Faulted
Enclosure SPE Power B : Faulted
Bus 0 Enclosure 0 : Faulted
Bus 0 Enclosure 0 Disk 7 : Removed
Bus 0 Enclosure 0 Disk 8 : Removed
Bus 0 Enclosure 0 Disk 9 : Removed
Bus 0 Enclosure 0 Power B : Faulted
FAR Mirror Faults Status Report
50:06:01:60:90:60:00:14:09:00:00:00:00:00:00:00:
Asynchronous mirror is faulted
50:06:01:60:90:60:00:14:06:00:00:00:00:00:00:0050:06:01:
60:90:60:03:99:Asynchronous mirror image is fractured
50:06:01:60:90:60:00:14:0B:00:00:00:00:00:00:00:
Asynchronous mirror is faulted
50:06:01:60:90:60:00:14:07:00:00:00:00:00:00:00:
Asynchronous mirror is faulted
50:06:01:60:90:60:00:14:08:00:00:00:00:00:00:0050:06:01:
60:90:60:03:99:Asynchronous mirror image is fractured
50:06:01:60:90:60:00:14:01:00:00:00:00:00:00:00:
Asynchronous mirror is faulted
50:06:01:60:90:60:00:14:11:00:00:00:00:00:00:00:
Asynchronous mirror is faulted
50:06:01:60:90:60:00:14:12:00:00:00:00:00:00:0050:06:01:

62

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

60:90:60:03:99:Asynchronous mirror image is fractured

flash -ioport
Flashes the LEDs on I/O ports.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli flash -ioport command flashes the I/O ports on VNX systems.
Flashes only the targeted SP owned I/O ports.
SYNTAX
flash -ioport [-fe logicalportID | -be logicalportID | [pslotid
"onboard"|"basemodule"|physicalslotID -pport physicalportID] |byusage [mirrorview]] on|off
OPTIONS
-ioport
Controls flashing of I/O ports on the target SP I/O modules.
-fe logicalportID
Turns flashing on/off for the front-end port with the logical ID specified on the target
SP.
-be logicalportID
Turns flashing on/off for the back-end port with the logical ID specified on the target
SP.
-pslotid "onboard"|physicalslotID -pport physicalportID
Turns flashing on/off for an physical slot/port located on the targeted SP’s I/O
module. The physical slot ID refers to the I/O module slot.
Note

"basemodule" is not supported on VNX8000 Block systems.
-byusage mirrorview
Turns flashing on/off for an I/O port depending on how the I/O port is being used.
The only option is mirrorview.
on|off
Indicates whether flashing is turned on or off.
EXAMPLE #1
This example turns flashing on for a specified physical port on the onboard I/O module:
naviseccli -h 10.244.211.36 flash -ioport -pslotid onboard -pportid 3
on
Slot Onboard, Physical Port 3 (Uninitialized): ON

EXAMPLE #2
This example turns flashing on by specifying a logical port ID on the onboard I/O module:

flash -ioport

63

VNX CLI for Block

naviseccli -h 10.244.211.36 flash -ioport -be 3 on
Slot Onboard, Physical Port 1 (BE 3): ON

EXAMPLE #3
This example turns flashing on by specifying the use of an I/O port on the onboard I/O
module:
naviseccli -h 10.244.211.36 flash -ioport -fe 1 on
Slot Onboard, Physical Port 3 (FE 1): ON

EXAMPLE #4
This example turns flashing on by specifying the use of an I/O port on the removable I/O
modules:
naviseccli -h 10.244.211.36 flash -ioport -fe 4 off
Slot 0, Physical Port 0 (FE 4): OFF

EXAMPLE #5
This example turns flashing on for a specified physical port on the removable I/O
modules:
naviseccli -h 10.244.211.36 flash -ioport -pslotid 1 -pportid 0 on
Slot 1, Physical Port 0 (FE 8): ON

EXAMPLE #6
This example turns flashing on for a specified physical port on the base module:
naviseccli -h 10.244.211.36 flash -ioport -pslotid basemodule -pportid
0 on
Slot basemodule, Physical Port 0 (BE 0):ON

flash -iomodule
Turns the LEDs for the I/O ports on an I/O module on or off.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli flash -iomodule command turns the flashing LEDs on/off for all
the I/O ports on a specified module on the VNX system.
SYNTAX
flash -iomodule ["onboard"|"basemodule"|slotid] [on|off]
OPTIONS
"onboard"|"basemodule"|slotid
If the slotID is not specified, an error message is displayed.
Note

"basemodule" is not supported on VNX8000 Block systems.

on|off
64

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Indicates whether flashing is turned on or off.
EXAMPLE #1
naviseccli -h 10.244.211.36 flash -iomodule onboard on
I/O Module Onboard: ON

EXAMPLE #2
naviseccli -h 10.244.211.36 flash -iomodule onboard off
I/O Module Onboard: OFF

EXAMPLE #3
naviseccli -h 10.244.211.36 flash -iomodule basemodule 0 on
I/O Module Basemodule: ON

flashleds
Turns the LEDs for disks in a specific enclosure or bus on or off.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli flashleds command turns on the LEDs in a specific disk-array
enclosure (DPE, iDAE, or DPE) or Fibre Channel bus. The command can help you identify
disks in an enclosure or bus.
SYNTAX
flashleds -e enclosure-number [-b bus-number] [on|off]
OPTIONS
-e enclosure-number
Specifies the disk-array enclosure. In each system, if there is a DPE or iDAE, it is
enclosure 0. DAEs are numbered sequentially on each bus ascending from 1 (for
DPE/iDAE systems) or ascending from 0 (for other system types).
-b bus-number
Specifies the bus-number.
on|off
Turns the LEDs on or off. If you omit this switch, the command turns the LEDs on.
EXAMPLE
These commands turn on the LEDs for the system that holds SP ss1_spa and then turns
them off. For that system, it specifies enclosure 1, bus 0.
naviseccli -h ss1_sp1 flashleds -e 1 -b 0 on
naviseccli -h ss1_sp1 flashleds -e 1 -b 0 off

OUTPUT
There is no output. Errors are printed to stderr.

flashleds

65

VNX CLI for Block

getagent
Gets device names and configurations.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli getagent command returns the names of devices that the
destination Unisphere agent controls. The command also displays descriptions of each
device with which the Unisphere agent is configured to communicate. If you type the
getagent command without switches, the CLI displays all values. With switches, the CLI
displays only the values.
Each SP is a host (-h switch) to which you address the command. The command displays
information for the agent running in the SP (the SP agent). Values for irrelevant display
fields appear as NA.
Note

If you are running VMware ESX Server and issuing this command to a virtual machine
(VM), it cannot target the host agent because the Unisphere Host Agent is supported only
on ESX Server.
SYNTAX
getagent [-cabinet] [-desc] [-mem] [-model] [-name] [-node]
[-peersig] [-prom] [-rev] [-scsiid] [-serial] [-sig]
[-type] [-ver] [-os] [-spid]
OPTIONS
-cabinet
Returns a description of the cabinet type.
-desc
Returns an ASCII description of the device (taken from the Unisphere agent
configuration file).
-mem
Returns, in MB, the size of the SP’s memory. Each SP in the system must have the
same amount of memory to make full use of the memory. Total memory can be 8, 16,
32, or 64 MB.
-model
Returns the model number of the SP.
-name
Returns the name of the device (taken from the Unisphere agent configuration file).
-node
Returns the device’s location in the file system.
Note

Use the returned device name when you specify the device in a command line.
-os
Displays the operating system.
-peersig
Returns the signature of the peer SP.
-prom
66

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Returns the revision of the SP’s PROM code. Each SP in the system should be
running the same revision of PROM code. PROM code is updated automatically when
you update an SP’s VNX OE for Block software and choose the reboot option.
-rev
Returns the microcode revision number of the VNX OE for Block software that the SP
is running. Each SP in the system will be running the same revision of VNX OE for
Block software. You can update an SP’s VNX OE for Block software.
-scsiid
Returns the SCSI ID of SP host connection. The SCSI ID number for the SP is
determined by switch settings on the SP. For information on these switch settings,
see the system installation and maintenance manual.
-serial
Returns the serial number of the system.
-sig
Returns the unique SP signature.
-spid
Returns the SP identifier (A or B).
-type
Returns the model type (deskside or rackmount).
-ver
Returns the version of the agent that is running.
EXAMPLE
This example issues the getagent command to system ss1_spa.
naviseccli -h ss1_spa getagent

OUTPUT
The following is a sample output that shows the devices controlled by one agent. Actual
output varies depending on the switches you use with the getagent command.
Note

For a host that is managing a legacy system, the output may vary depending upon
whether or not the host is in a storage group.
Output from an SP agent
Agent Rev: 7.33.0 (4.67)
Name: K10
Desc:
Node: A-FNM00121900314
Physical Node: K10
Signature: 3178501
Peer Signature: 3194985
Revision: 05.33.000.1.467
SCSI Id: 0
Model: VNX8000
Model Type: Rackmount
Prom Rev: 12.50.00
SP Memory: 131072
Serial No: FNM00121900314
SP Identifier: A
Cabinet: SPE9

getagent

67

VNX CLI for Block

The following output shows the enclosure type for Model VNX5400/VNX5600/VNX5800/
VNX7600 Block systems:
Cabinet: DPE9

The following output shows the enclosure type for a Model VNX8000 Block system:
Cabinet: SPE9

getall
Gets comprehensive system information.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli getall command returns an extensive list of system information,
including:
l

Agent and host information

l

System information

l

HBA or switch information

l

SP information

l

Cache information

l

Disk information

l

LUN information

l

RAID group information

l

Storage group information

l

SnapView information

l

SAN Copy information

l

Drive type for enclosures, disks, RAID groups, and LUNs

The getall command is a superset of the getagent command. If you type the getall
command without switches, the CLI displays all values. With switches, the CLI displays
only the values specified.
Note that the getall command and any of its arguments return all information pertinent
to the current Unisphere release. The amount of this information may change (usually it
increases) with each new Unisphere release. This may affect your custom command
scripts that use getall.
The command displays information for the agent running in the SP (the SP agent). Values
for irrelevant display fields appear as NA.
Some information is not displayed if the feature is not activated or not supported. For
example, SAN Copy items are displayed only if SAN Copy software is installed and
activated.
SYNTAX
getall [-host] [-array] [-hba] [-sp] [-cache] [-disk]
[-drivetype] [-fastcache] [-lun] [-reserved] [-rg] [-sg]
[-snapviews] [-sancopy]
68

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

OPTIONS
-host
Displays only information about the host and the agent that manage the system.
This is a composite of information displayed by the getagent, remoteconfig,
and ndu commands.
-array
Displays only information about the system and its hardware components such as
fan and link control card (LCC). This is a composite of information displayed by the
getarrayuid, arrayname, getcrus, and initialiazearray commands.
-hba
Displays information about each switch, HBA and port. It also displays the physical
location of the port for a VNX series system. This combines the information that the
alpa, port, register, and getloop commands display.
-sp
Displays information about this SP only. This is a composite of information displayed
by the getsp, getcontrol, networkadmin, and getsptime commands.
-cache
Displays information about the cache. This is the same information displayed by the
cache -sp -info command.
-disk
Displays information about disks and enclosures in the system and new disk spindown statistics. This is the same information that the getdisk command displays.
-drivetype
Displays the drive type of the LUN.
-fastcache
Displays the FAST Cache information.
-lun
Displays only information about each logical unit (host and system) in the system.
This is a composite of information displayed by getsniffer, storagegroup,
and getlun commands.
-reserved
Displays the reserved LUN pool information.
-rg
Displays only information about RAID groups. This is the same information displayed
by getrg command.
Note

The -rg switch does not display the private RAID group used in thin pools.
-sg
Displays only information about storage groups. This is the same information
displayed by the storagegroup command.
-snapviews
Displays only information about snapview. This is the same information displayed
by the snapview command.
-sancopy
Displays only information about sancopy. This is the same information displayed
by the sancopy command.
EXAMPLE
This example displays the information about the host and the agent that manage the
system.
naviseccli getall -host
getall

69

VNX CLI for Block

OUTPUT
Server IP Address: 10.244.211.40
Agent Rev: 7.33.85 (2.60)
Agent/Host Information
----------------------Agent Rev: 7.33.85 (2.60)
Name: K10
Desc:
Node: A-FNM00125200242
Physical Node: K10
Signature: 3309592
Peer Signature: 3313827
Revision: 05.33.000.1.489
SCSI Id: 0
Model: VNX7600
Model Type: Rackmount
Prom Rev: 4.50.00
SP Memory: 65536
Serial No: FNM00125200242
SP Identifier: A
Cabinet: DPE9
Name of the software package: -FASTCache
Revision of the software package: Commit Required: NO
Revert Possible: NO
Active State: YES
Is installation completed: YES
Is this System Software: NO
Name of the software package: -ThinProvisioning
Revision of the software package: Commit Required: NO
Revert Possible: NO
Active State: YES
Is installation completed: YES
Is this System Software: NO
Name of the software package: -Unisphere
Revision of the software package: Commit Required: NO
Revert Possible: NO
Active State: YES
Is installation completed: YES
Is this System Software: NO
Name of the software package: -UnisphereBlock
Revision of the software package: Commit Required: NO
Revert Possible: NO
Active State: YES
Is installation completed: YES
Is this System Software: NO
Name of the software package: INTERNAL_USE_ONLY-AutoPilot
Revision of the software package: 05.33.000.1.486
Commit Required: NO
Revert Possible: NO
Active State: YES
Is installation completed: YES
Is this System Software: NO
Name of the software package: INTERNAL_USE_ONLY-FBEAPIX
Revision of the software package: 05.33.000.1.489
Commit Required: NO
Revert Possible: NO

70

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Active State: YES
Is installation completed: YES
Is this System Software: NO
Name of the software package: INTERNAL_USE_ONLY-RALabHosts
Revision of the software package: 05.33.000.1.489
Commit Required: NO
Revert Possible: NO
Active State: YES
Is installation completed: YES
Is this System Software: NO
Name of the software package: VNX-Block-Operating-Environment
Revision of the software package: 05.33.000.1.489
Commit Required: NO
Revert Possible: NO
Active State: YES
Is installation completed: YES
Is this System Software: NO

getarrayuid
Gets the system unique ID.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli getarrayuid command displays the unique ID (UID) of the system
that contains the current SP. For a Fibre Channel system this is the system WWN. For an
iSCSI system this is also the WWN, but iSCSI also has a target name, the iqn identifier,
which is a unique identifier. A system with an iSCSI and Fibre Channel combination
controller shows both types of IDs.
The SP, HBA, and switch ports also have unique IDs. If you specify one or more SPs, then
the CLI displays the unique ID of the systems containing those SPs. Knowing the UID of
an SP’s system is useful with MirrorView mirroring commands and for other operations.
SYNTAX
getarrayuid [-iscsi|-all] [sphostnames]
OPTIONS
sphostnames
Are the hostnames of one or more SPs, separated by spaces or commas. If you omit
sphostnames, then the CLI displays the UID of the SP specified with the -h switch.
-iscsi
Returns the iSCSI target name (iqn) for the system on a combo system.
-all
Returns both the system WWN and the iSCSI target name (iqn).
Note

If you do not specify any switches, getarrayuid returns the system WWN on a
system with an iSCSI and Fibre Channel combination controller, as well as on an
iSCSI-only system.

getarrayuid

71

VNX CLI for Block

EXAMPLE
naviseccli -h ss1_spa getarrayuid -all
Host name
Cps42199
1.2.3.4

Array UID
50:06:01:60:77:02:C7:A7
iqn. 1992-04.com.emc:cx.hk192200422

OUTPUT
The UID of the system that holds the SP (see above).

getconfig
Returns system type configuration information.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli getconfigcommand displays system type configuration
information. If you omit switches, it displays all configuration type information. You can
set configuration information with setconfig.
Use the getsp command to display SP revision and signature information.
SYNTAX
getconfig [-ptype] [-que] [-rer] [-tn] [-pg8] [-rep]
OPTIONS
-ptype
Displays the system package type.
-que
Displays the setting on how queue full status is handled. Yes means that the VNX
OE for Block software will return device status to the operating system as busy,
instead of queue full, when the device queue is full.
-rer
Displays the number of recovered errors.
-tn
Displays the state of the Target Negotiate bit.
-pg8
Displays SCSI mode page 8 information.
-rep
Displays periodic error report information: the number of reported errors or N/A.
EXAMPLE
naviseccli -h ss1_spa getconfig
Sub-System Package Type:
Queue Full Status:
Recovered Errors:
Target Negotiate:
Mode Page 8:
Periodic Error Report:

72

20
DISABLED
DISABLED
Unknown
DISABLED
N/A

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

getcontrol
Gets SP performance information.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli getcontrol command returns information about the SP
performance.
SYNTAX
getcontrol [-allib] [-arv] [-busy] [-cbt] [-date] [-day]
[-flush] [-idle] [-read] [-rw] [-sc] [-sf] [-sl] [-time]
[-write] [-all]
OPTIONS
-allib
Returns the idle and busy ticks for all buses.
-arv
Returns the number of times a user request arrived while at least one other request
was being processed.
-busy
Returns the percentage of time the SP is busy.
-cbt
Returns the controller idle and busy ticks.
-date
Returns the SP’s system date.
-day
Returns the SP’s system day.
-flush
Returns the number of requests to flush the write cache, and the number of write
cache blocks flushed.
-idle
Returns the percentage of time the SP is idle.
-read
Returns the number of reads received by the SP.
-rw
Returns the following:
Host read requests
The number of read requests made by the host to the LUN
Host write requests
The number of write requests made by the host to the LUN
Host blocks read
The number of blocks the host read from the LUN
Host blocks written
The number of blocks written from the host to the LUN
-sc
-sf

Returns the status of the system cache (on/off).
getcontrol

73

VNX CLI for Block

-sl

Returns the status of the system fault LED (on/off).

Returns the status of statistics logging (on/off).
-time
Returns the SP’s system time.
-write
Returns the number of writes received by the SP.
-all
In addition to the getcontrol command information, it displays the serial number
for SP.
EXAMPLE
naviseccli -h ss1_spa getcontrol

OUTPUT
The following is a sample output. Actual output varies depending upon which switches
you use with the getcontrol command.
System Fault LED: ON
Statistics Logging: ON
SP Read Cache State Enabled
SP Write Cache State Disabled
Max Requests: N/A
Average Requests: N/A
Hard errors: N/A
Total Reads: 0
Total Writes: 0
Prct Busy: 0.72
Prct Idle: 99.2
System Date: 02/06/2013
Day of the week: Wednesday
System Time: 10:02:29
Read_requests: 0
Write_requests: 0
Blocks_read: 0
Blocks_written: 0
Sum_queue_lengths_by_arrivals: 0
Arrivals_to_non_zero_queue: 0
Hw_flush_on: N/A
Idle_flush_on: N/A
Lw_flush_off: N/A
Write_cache_flushes: 70
Write_cache_blocks_flushed: 882
Internal bus 1 busy ticks: N/A
Internal bus 1 idle ticks: N/A
Internal bus 2 busy ticks: N/A
Internal bus 2 idle ticks: N/A
Internal bus 3 busy ticks: N/A
Internal bus 3 idle ticks: N/A
Internal bus 4 busy ticks: N/A
Internal bus 4 idle ticks: N/A
Internal bus 5 busy ticks: N/A
Internal bus 5 idle ticks: N/A
Controller busy ticks: 3651
Controller idle ticks: 505075

getcrus
Gets CRU state information.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.

74

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

DESCRIPTION
The naviseccli getcrus command returns state information on all or selected CRUs
(customer replaceable units) in the system except for disks (see the getdisk command)
and selected FRUs/sub FRUs in the system. The getcrus command displays the state of
the following CRUs: fans, link controller cards (LCCs), storage processors (SPs), battery
backup units (referred to as standby power supplies or SPSs), and power supplies (PSs or
VSCs). You can use getcrus without any switches to get the state information for every
CRU (except disks). The getcrus command displays the state of management module of
FRUs and state of I/O module, CPU module, and DIMM of sub FRUs.
Note

If one of the LCCs is pulled from Bus x, Enclosure x, all data along that bus (after the LCC
was pulled) appears as faulted since the agent cannot gather any information along that
path. If this occurs, issue the getcrus command to the peer SP. The CLI lists the faulted
components.
Note

Command switches -cpua, -cpub, -dimma, -dimmb, -ioa, -iob, -mgmta, and mgmtb are supported only on Secure CLI.
SYNTAX
getcrus [-fana] [-fanb] [-fanc] [-lcca]
[-lccb] [-spa] [-spb]
[-lccrevb] [-lccsnb] [-spsa] [-spsb]
[-lccreva] [-lccsna] [-cablingspsa] [-cablingspsb]
[-encdrivetype] [-speeds] [-cpua] [-cpub] [-ioa] [-iob] [dimma]
[-dimmb] [-mgmta] [-mgmtb] [-bma] [-bmb]
[bbua] [bbub] [-all]
OPTIONS
-bbua
Returns the status of Battery Backup Unit on SP A.
-bbub
Returns status of Battery Backup Unit on SP B.
-bma
Returns status of Base Module on SP A.
-bmb
Returns status of Base Module on SP B.
-cablingspsa
Returns the cabling status for SPS A (standby power supply A).
-cablingspsb
Returns the cabling status for SPS B (standby power supply B).
-cpua
Returns the state of the CPU module on SP A.
-cpub
Returns the state of the CPU module on SP B.
-dimma
Returns the state of the DIMM module on SP A.
-dimmb
Returns the state of the DIMM module on SP B.
-encdrivetype
Displays the type(s) of drives that are currently allowed to run in the enclosure.
getcrus

75

VNX CLI for Block

-fana
Returns the state information for fan A.
-fanb
Returns the state information for fan B.
-fanc
Returns the state information for fan C.
-ioa
Returns the state of the I/O modules on SP A.
-iob
Returns the state of the I/O modules on SP B.
-lcca
Returns the state information of the LCC for SP A.
-lccb
Returns the state information of the LCC for SP B.
-lccreva|-lccrevb
Returns the revision of the DPE LCC A, LCC B, or both if you specify both switches.
-lccsna|-lccsnb
Returns the serial number of the DPE LCC A, LCC B, or both if you specify both
switches.
-mgmta
Returns the state of management module A.
-mgmtb
Returns the state of management module B.
-spa
Returns the current operational state of SP A. It can be in any of the following states:
Present
The SP is the communication channel you are using to communicate with the
chassis.
Empty
Agent cannot talk to the SP because a communication channel specifying the
SP is not in the agent’s configuration file for the selected host. For example, the
SP is connected to a different host than the SP in the communications channel
for the chassis.
Not Present
SP that is in the communication channel to the selected chassis has failed or
been removed.
Removed
SP was not present when the agent was started.
-spb
Returns the state information for SP B. See -spa description (above).
-spsa
Returns the state information for SPS (standby power supply, backup battery) A.
-spsb
Returns the state information for standby power supply B.
-speeds
Displays the current and maximum speed of enclosures and LCCs within the
enclosures. The current speed indicates the speed an enclosure or LCC is currently
running at; the maximum speed indicates the highest speed an enclosure or LCC is
capable of running at.
-all
Displays the state of all devices.
76

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

EXAMPLE
This command gets the information about CRU state.
naviseccli -h ss1_spa getcrus

OUTPUT
The following example shows the output from the getcrus -all command for the
VNX5400/VNX5600/VNX5800/VNX7600 Block systems.
DPE9 Bus 0 Enclosure 0
Enclosure Drive Type: SAS, NL SAS
Current Speed: 6Gbps
Maximum Speed: 6Gbps
SP A State: Present
SP B State: Present
Bus 0 Enclosure 0 Fan A0 State: Present
Bus 0 Enclosure 0 Fan A1 State: Present
Bus 0 Enclosure 0 Fan B0 State: Present
Bus 0 Enclosure 0 Fan B1 State: Present
Bus 0 Enclosure 0 Power A State: Present
Bus 0 Enclosure 0 Power B State: Present
Bus 0 Enclosure 0 BBU A State: Present
Bus 0 Enclosure 0 BBU B State: Present
Bus 0 Enclosure 0 CPU Module A State: Present
Bus 0 Enclosure 0 CPU Module B State: Present
Bus 0 Enclosure 0 SP A I/O Module 0 State: Present
Bus 0 Enclosure 0 SP A I/O Module 1 State: Empty
Bus 0 Enclosure 0 SP A I/O Module 2 State: Empty
Bus 0 Enclosure 0 SP A I/O Module 3 State: Empty
Bus 0 Enclosure 0 SP A I/O Module 4 State: Empty
Bus 0 Enclosure 0 SP B I/O Module 0 State: Present
Bus 0 Enclosure 0 SP B I/O Module 1 State: Empty
Bus 0 Enclosure 0 SP B I/O Module 2 State: Empty
Bus 0 Enclosure 0 SP B I/O Module 3 State: Empty
Bus 0 Enclosure 0 SP B I/O Module 4 State: Empty
Bus 0 Enclosure 0 DIMM Module A State: Present
Bus 0 Enclosure 0 DIMM Module B State: Present
Bus 0 Enclosure 0 Management Module A State: Present
Bus 0 Enclosure 0 Management Module B State: Present
Bus 0 Enclosure 0 Base Module A State: Present
Bus 0 Enclosure 0 Base Module B State: Present

The following example shows the output from the getcrus -all command for a
VNX8000 Block system.
SPE9 Enclosure SPE
Enclosure Drive Type: N/A
Current Speed: N/A
Maximum Speed: N/A
SP A State: Present
SP B State: Present
Enclosure SPE Fan A0 State: Present
Enclosure SPE Fan A1 State: Present
Enclosure SPE Fan A2 State: Present
Enclosure SPE Fan A3 State: Present
Enclosure SPE Fan A4 State: Present
Enclosure SPE Fan B0 State: Present
Enclosure SPE Fan B1 State: Present
Enclosure SPE Fan B2 State: Present
Enclosure SPE Fan B3 State: Present
Enclosure SPE Fan B4 State: Present
Enclosure SPE Power A0 State: Present
Enclosure SPE Power A1 State: Present
Enclosure SPE Power B0 State: Present
Enclosure SPE Power B1 State: Present
Enclosure SPE SPS Module A State: Present

getcrus

77

VNX CLI for Block

Enclosure SPE SPS Battery A State: Present
Enclosure SPE SPS Module B State: Present
Enclosure SPE SPS Battery B State: Present
Enclosure SPE SPS Module A Cabling State: Valid
Enclosure SPE SPS Module B Cabling State: Valid
Enclosure SPE CPU Module A State: Present
Enclosure SPE CPU Module B State: Present
Enclosure SPE SP A I/O Module 0 State: Present
Enclosure SPE SP A I/O Module 1 State: Missing
Enclosure SPE SP A I/O Module 2 State: Empty
Enclosure SPE SP A I/O Module 3 State: Empty
Enclosure SPE SP A I/O Module 4 State: Empty
Enclosure SPE SP A I/O Module 5 State: Present
Enclosure SPE SP A I/O Module 6 State: Empty
Enclosure SPE SP A I/O Module 7 State: Empty
Enclosure SPE SP A I/O Module 8 State: Empty
Enclosure SPE SP A I/O Module 9 State: Empty
Enclosure SPE SP A I/O Module 10 State: Empty
Enclosure SPE SP B I/O Module 0 State: Present
Enclosure SPE SP B I/O Module 1 State: Missing
Enclosure SPE SP B I/O Module 2 State: Empty
Enclosure SPE SP B I/O Module 3 State: Empty
Enclosure SPE SP B I/O Module 4 State: Empty
Enclosure SPE SP B I/O Module 5 State: Present
Enclosure SPE SP B I/O Module 6 State: Empty
Enclosure SPE SP B I/O Module 7 State: Empty
Enclosure SPE SP B I/O Module 8 State: Empty
Enclosure SPE SP B I/O Module 9 State: Empty
Enclosure SPE SP B I/O Module 10 State: Empty
Enclosure SPE DIMM Module A State: Present
Enclosure SPE DIMM Module B State: Present
Enclosure SPE Management Module A State: Present
Enclosure SPE Management Module B State: Present
DAE5S Bus 0 Enclosure 0
Enclosure Drive Type: SAS
Current Speed: 6Gbps
Maximum Speed: 6Gbps
Bus 0 Enclosure 0 Power A State: Present
Bus 0 Enclosure 0 Power B State: Present
Bus 0 Enclosure 0 SPS Module A State: Present
Bus 0 Enclosure 0 SPS Battery A State: Present
Bus 0 Enclosure 0 SPS Module B State: Present
Bus 0 Enclosure 0 SPS Battery B State: Present
Bus 0 Enclosure 0 SPS Module A Cabling State: Valid
Bus 0 Enclosure 0 SPS Module B Cabling State: Valid
Bus 0 Enclosure 0 LCC A State: Present
Bus 0 Enclosure 0 LCC B State: Present
Bus 0 Enclosure 0 LCC A Revision: 1.42
Bus 0 Enclosure 0 LCC B Revision: 1.42
Bus 0 Enclosure 0 LCC A Serial #: N/A
Bus 0 Enclosure 0 LCC B Serial #: N/A
Bus 0 Enclosure 0 LCC A Current Speed: 6Gbps
Bus 0 Enclosure 0 LCC B Current Speed: 6Gbps
Bus 0 Enclosure 0 LCC A Maximum Speed: 6Gbps
Bus 0 Enclosure 0 LCC B Maximum Speed: 6Gbps

getdisk
Gets disk status.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.

78

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

DESCRIPTION
The naviseccli getdisk command returns detailed status information about all or
selected disks in the system.
A disk module can be in any of the following operational states:
Table 8 Operational states

State

Meaning

Binding

Being bound into a LUN.

Empty

Failed or removed before the agent started running, or the
disk wasn’t part of a RAID group.

Enabled

Part of a bound LUN.

Expanding

Disk is being added to a RAID group.

Formatting

Being hardware formatted. Generally, modules do not need
formatting.

Rebuilding

The data is being rebuilt on a replacement disk module.

Removed

Disk module is removed from the chassis; applies only to a
disk module that is part of a LUN.

Low Power

Drive is in low -power state (less than full power); a possible
delay can occur with media access.

Reduced Power, Transitioning

Drive is transitioning from a low power/no power to a full
power state or vice versa.

Unbound

Ready to be bound into a LUN.

SYNTAX
getdisk [-bind] [-capacity] [-actualcapacity] [-userlba]
[-cppct] [-hr][-hs] [-hw]
[-lun] [-private] [-product] [-rb] [-read] [-rev]
[-serial] [-sectors] [-sig] [-sr] [ -state] [-sw]
[-type] [-vendor] [-write] [-rg] [-numluns] [-cpn]
[-rds] [-wrts] [-bytrd] [-bytwrt] [-bndcrs] [-drivetype]
[-tla] [ -usercapacity] [-idleticks] [-busyticks] [-speeds]
[-powersavingsdiskcapable] [-powersavingsdiskeligible]
[-powersavingsstate][-spinstats][-arrivalswithnonzeroqueue]
[-highsumofseeks] [-idleticks_SPA] [-idleticks_SPB]
[-busyticks_SPA] [-busyticks_SPB] [-que] [-all]
OPTIONS
disk-position
Returns status for a specific disk. Refer the VNX for Block Concepts guide, section on
LUN IDs, unique IDs, and disk IDs to verify the format for specifying disks.

When the disk-position is not entered, getdisk reports on all disks, regardless of
which switches are set. To obtain only the information specified by the optional
switches, you must include disk-position in the getdisk command.
-actualcapacity
Returns the actual capacity of the disk.
-arrivalswithnonzeroqueue
getdisk

79

VNX CLI for Block

Returns the cumulative number of requests sent to a disk, while one or more
requests were already outstanding.
-bind
Returns the percentage of the disk that is bound.
-bndcrs
Returns the number of Stripe Boundary Crossings (string value or Unknown).
-busyticks
Returns the amount of time that this disk is busy.
-busyticks_SPA
Returns the amount of time in 100 ms ticks where the disk was serving requests
from SPA, respectively.
-busyticks_SPB
Returns the amount of time in 100 ms ticks where the disk was serving requests
from SPB, respectively.
-bytrd
Returns the number of KB read.
-bytwrt
Returns the number of KB written.
-capacity
Returns the disk capacity in MB.
-cpn
Returns the system part number (string value) or N/A.
-cppct
Displays the progress of the following three operations:
l

Automatic hot spare replacement

l

Explicit copytodisk command

-drivetype
Returns the drive type of the disk.
-highsumofseeks
Returns the cumulative seek distance in 512 Byte sectors of all requests to this disk.
The seek distance between two consecutive requests is the delta of their
corresponding LBAs.
-hr
Returns the total number of hard read errors for all the disk modules in the LUN that
persisted through all the retries. A growing number of hard errors may mean that one
or more of the LUN’s disk modules is nearing the end of its useful life.
-hs
Returns hot spare status: NO if not a hot spare, the disk position otherwise; see disk
module operational states on page 79. The Hot Spare value will be shown as N/A on
VNX.
-hw
Returns the total number of hard write errors for all the disk modules in the LUN that
persisted through all the retries. A growing number of hard errors may mean that one
or more of the LUN’s disk modules is nearing the end of its useful life.
-idleticks
Returns the amount of time that this disk is idle.
-idleticks_SPA
Returns the amount of time in 100 ms ticks where the disk had no outstanding
requests from SPA, respectively.
-idleticks_SPB
Returns the amount of time in 100 ms ticks where the disk had no outstanding
requests from SPB, respectively.
-lun
Returns the LUN number(s) to which this disk belongs.
-numluns
80

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Returns the number of LUNs bound to this disk. LUNs may span multiple disks.
-powersavingsdiskcapable
Displays whether the vendor has approved the drives for spin down. It states YES or
NO.
-powersavingsdiskeligible
Determines if the drive has met the system requirements (slot location) for
transitioning to low-power standby state.
-powersavingsstate
Displays the power savings state of the drive.
-private
Returns the offset of every partition on the disk.
-que
Returns the sum of outstanding requests to the disk. For each newly arriving request,
this value gets incremented by the number of currently still outstanding requests to
the disk, plus the arriving request itself.
-product
Returns the product ID of the disk.
-rb
Returns the percentage of the disk that is rebuilt.
-read
Returns the total number of read requests made to the disk module. You might find
the LUN read information in getlun more useful because it is for the entire LUN,
and not just for one of the disk modules in the LUN.
-rds
Returns the number of read requests.
-rev
Returns the product revision number of the disk.
-rg
Returns the RAID group (if any) associated with this disk.
-sectors
Returns the number of user sectors.
-serial
Returns the serial number of the disk.
-sig
Returns the bind signature, which was automatically assigned during the bind
process. The Bind Signature value will be shown as N/A, enclosure number,
slot number (for example, N/A, 0, 1).
-spinstats
Returns the new disk power savings statistics.
-sr
Returns the total number of soft read errors for all the disk modules in the LUN that
disappeared before all the retries. A growing number of soft errors may indicate that
one of the LUN’s disk modules is nearing the end of its useful life.
-state
Returns the state of the disk.
-sw
Returns the total number of soft write errors for all the disk modules in the LUN that
disappeared before all the retries. A growing number of soft errors may indicate that
one of the LUN’s disk modules is nearing the end of its useful life.
-tla
Returns the TLA part number.
-type
Returns the RAID type of the disk.
-usercapacity
Returns the amount of space on the disk that is assigned to bound LUNs.
getdisk

81

VNX CLI for Block

-userlba
Returns user LBA information.
-vendor
Returns the vendor ID of the disk.
-write
Returns the total number of write requests to the disk module. You might find the
LUN write information in getlun more useful because it shows the entire LUN, and
not just one disk.
-wrts
Returns the number of write requests.
-all
In addition to the getdisk command information, it displays maximum queued
requests, average queued requests, percent idle, percent busy information, power
saving attributes, the percent copied, actual capacity, and LBA of user space.
EXAMPLE
Returns information for disk 1 in disk array enclosure 1 (DAE or DAE2 number 1) on bus 1.
naviseccli -h 10.244.211.212 getdisk 0_1_B1

OUTPUT
The following is sample output. Actual output varies depending on the switches you use
with the getdisk command:
Bus 0 Enclosure 1 Disk B1
Vendor Id: HITACHI
Product Id: HUC10606 CLAR600
Product Revision: C202
Lun: 16377
Type: N/A
State: Unbound
Hot Spare: N/A
Prct Rebuilt: 16377: 100
Prct Enabled: 16377: 100
Serial Number: PPG9RTPB
Sectors: 1125185536 (549407)
Capacity: 549691
Private: 16377: 65536
Bind Signature: N/A, 0, 1
Hard Read Errors: 0
Hard Write Errors: 0
Soft Read Errors: 0
Soft Write Errors: 0
Read Retries: N/A
Write Retries: N/A
Remapped Sectors: N/A
Number of Reads: 0
Number of Writes: 0
Number of Luns: 1
Raid Group ID: 3
Clariion Part Number: DG118xxxxx3
Request Service Time: N/A
Read Requests: 0
Write Requests: 0
Kbytes Read: 0
Kbytes Written: 0
Stripe Enabledary Crossing: 0
Drive Type: SAS
Clariion TLA Part Number:005000000
User Capacity: 536.530273
Idle Ticks: 0
Busy Ticks: 0
Current Speed: 6Gbps
Maximum Speed: 6Gbps

82

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

The following is sample output with drive type and state information of disk 0_0_0:
naviseccli -h ss1_spa getdisk 0_0_0 -drivetype -state
Bus 0 Enclosure 0
Drive Type:
State:

Disk 0

SAS
Unbound

The following is sample output with the power savings, percent copied, actual capacity,
and LBA of user space information:
naviseccli -h ss1_spa getdisk 0_4_0 -all
Bus 0 Enclosure 4 Disk 0
Vendor Id: HITACHI
Product Id: HUC10606 CLAR600
Product Revision: C3B2
Lun: Unbound
Type: N/A
State: Unbound
Hot Spare: N/A
Prct Rebuilt: Unbound
Prct Bound: Unbound
Serial Number: PZG9XKVD
Sectors: 0 (0)
Capacity: 549691
Private: Unbound
Bind Signature: N/A, 4, 0
Hard Read Errors: 0
Hard Write Errors: 0
Soft Read Errors: 0
Soft Write Errors: 0
Read Retries: N/A
Write Retries: N/A
Remapped Sectors: N/A
Number of Reads: 0
Number of Writes: 0
Number of Luns: 0
Raid Group ID: 0
Clariion Part Number: DG118032767
Request Service Time: N/A
Read Requests: 0
Write Requests: 0
Kbytes Read: 0
Kbytes Written: 0
Stripe Boundary Crossing: None
Drive Type: SAS
Clariion TLA Part Number:005049250PWR
User Capacity: 0
Idle Ticks: 0
Busy Ticks: 0
Current Speed: 6Gbps
Maximum Speed: 6Gbps
Queue Max: N/A
Queue Avg: N/A
Prct Idle: Not Available
Prct Busy: Not Available
Hardware Power Savings Qualified: YES
Hardware Power Savings Eligible: YES
Power Savings State: Full Power
Current Power Savings Log Timestamp: N/A
Spinning Ticks: N/A
Standby Ticks: N/A
Number of Spin Ups: N/A
Arrivals with Nonzero Queue: 0
High Sum of Seeks: 0
Idle Ticks SPA: 0
Idle Ticks SPB: 0

getdisk

83

VNX CLI for Block

Busy Ticks SPA: 0
Busy Ticks SPB: 0
Queue Length: 0
Prct Copied: N/A
Actual Capacity: 549659
LBA of User Space: 65536

getlog
Gets an SP or Event Monitor log.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli getlog command returns the entire SP or Event Monitor log
(default), the newest entries to the log, or the oldest entries to the log.
Note

Depending on the size of the log, the getlog command may take several minutes to
execute.
The command affects only the log of the SP you specify with the -h switch in the
command.
The getlog command requires an active agent.
Note

For a host not attached (through a switch or HBA) to a system, use getlog -em.
SYNTAX
getlog [-em] [-h] [+n] [-n]
OPTIONS
-em
Displays the Event Monitor log. If you omit this switch, the CLI displays the Event
Monitor log.
-h
Displays the getlog header.
+n
Displays the oldest n entries in the log, with the oldest entry first. If there are fewer
than n entries, the entire log is displayed. N must be greater than 0.
-n
Displays the newest n entries in the log, with the oldest entry first. If there are fewer
than n entries, the entire log is displayed. N must be greater than 0.
If a range of entries is not specified, the entire log is displayed with the oldest entry
first.
EXAMPLE
naviseccli -h ss1_spa getlog -3
04/10/1999 12:43:01 SP B(6e5) (FE Fibre loop
operational)[0x00] 0 0
04/10/1999 12:43:19 SP B(6e4) (FE Fibre loop down)
[0x03] 0 0

84

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

04/10/1999 12:43:19 SP B(6e5) (FE Fibre loop
operational)[0x00] 0 0

getloop
Gets fibre loop information.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli getloop command returns information about the fibre loop.
This command is not valid for IRIX hosts.
Note

This command applies only to Fibre Channel systems.
SYNTAX
getloop [-clfo] [-conn] [-dlf] [-icl] [-ple] [-spf]
OPTIONS
-clfo
Displays whether the command loop has failed over.
-conn
Displays the connection number.
-dlf
Displays the data loop failover status as follows:
Does system have data loop fail-over: Yes/No
Does system have illegal Cross-Loop: Yes/No
-icl
Displays whether there is an illegal cross loop.
-ple
Displays whether private loop is enabled.
-spf
Displays whether this SP can fail over.
EXAMPLE
naviseccli -h ss1_spa getloop
Has Data Loop Failed Over:
Can This SP Failover:
Private Loop Enabled:
Illegal Cross Loop:
Connection #0: Enclosure 0
Connection #1: Enclosure 1
Connection #2: Enclosure 2

NO
NO
YES
NO

getlun
Gets LUN information.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
getloop

85

VNX CLI for Block

DESCRIPTION
The naviseccli getlun command returns information about a LUN and the customer
replaceable units (CRUs) that make up that LUN.
Note

If statistics logging is disabled, some fields are not printed (switches marked with *
below). Other switches must be used with the -disk switch (switches marked with **
below).
If the target LUN is a metaLUN, We recommend that you use the metalun -list
command (see metalun -list on page 191) instead of the getlun command to return
information about the metaLUN. If you use the getlun command, only the following
fields report data that apply to metaLUNs — Name, Current owner, Default owner, LUN
Capacity (Megabytes), LUN Capacity (Blocks), UID, Is Private, Snapshot List, MirrorView
Name if any.
If you target the LUNs that make up a metaLUN, all fields apply.
If the target LUN is a pool LUN, we recommend that you use the storagepool -list
command (see storagepool -list on page 310) instead of the getlun command to return
information about the pool LUN.
SYNTAX
getlun [lun-number] [-aa] [-at] [-bp] [-bread] [-brw]
[-busy] [-bwrite] [-capacity] [-crus] [-default] [-disk]
[-drivetype] [-dsa] [-element] [-ena] [-ff] [-hrdscsi]
[-idle] [-name] [-owner] [-prb]
[-qavg] [-qmax] [-que] [-rc] [-rd3]
[-rchm] [-reads] [-remap] [-rh] [-rhist] [-rr]
[-rwr] [-service] [-sftscsi] [-srcp]
[-stripe][-totque][-type] [-upb] [-was]
[-wc] [-wch] [-uid] [-wh] [-whist] [-wr] [-writes]
[-rg] [-state] [-private] [-usage] [-sc] [-addroffset]
[-ismetalun] [-isthinlun] [ -ispoollun] [-idleticks] [busyticks]
[-lunidleticks] [ -luncache] [-lunbusyticks] [-trespass]
[-brwsp] [-rwrsp] [-lunbusytickssp] [-lunidletickssp]
[-nanzq] [-sqlah] [-slst] [-slct] [-etp] [-itp] [-nzrca][-sor]
[-wcrh] [-fwc] [-fastcache] [issnapmountpoint]
[-idleticks_SPA] [-idleticks_SPB] [-busyticks_SPA] [busyticks_SPB]
[-highsumofseeks] [-arrivalswithnonzeroqueue] [-all]
OPTIONS
lun-number
Specifies the logical unit number (LUN) on which to report. If no LUN number is
specified, the CLI reports on all LUNs in the system. Refer to LUN IDs, unique IDs, and
disk IDs in the VNX for Block Concepts guide for information about identifying LUN
numbers.
-aa
Returns the auto-assignment status (enabled/disabled).
-addroffset
Displays the starting LBA (logical block address) of the LUN. This address tells you
where a LUN begins within a RAID group.
-at
86

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Returns auto-trespass status (enabled or disabled). Shows FAST cache
properties.
-bp*
Returns the number of blocks prefetched by read cache.
-bread**
Returns the number of blocks read for each CRU.
-brwsp *
Returns the number of host blocks read and written in SP A and SP B.
-busy**
Returns the percentage of time that the disk is busy.
-busyticks
Returns the amount of time that the disks on this LUN are busy.
-bwrite**
Returns the number of blocks written for each CRU.
-capacity
Returns, in MB, the LUN capacity.
-crus
Returns the names and states of disks in this LUN.
-default
Returns the name of the default owner (SP) of the LUN.
-disk
Returns the disk statistics for the disks in the specified lun-number. Valid only when
statistics logging is enabled.
-drivetype
Returns the drive type of the disks in the LUN.
-dsa
Displays the status of Dual Simultaneous Access (dsa).
-element
Returns, in blocks, the stripe size. The stripe size is the number of sectors that the
system can read or write to a single disk module in the LUN. The default size is 128
sectors. This size was specified when the LUN was bound. Stripe element size does
not apply to a RAID 1 LUN, individual unit, or hot spare.
-ena**
Returns the disk status (enabled/disabled). Valid only when the -disk switch
is included in the command.
-etp*
Returns the explicit trespasses in SP A and SP B.
-fastcache
Displays the FAST Cache properties of the LUN. Enables or disables fast cache usage
for each LUN.
-ff*
Returns the number of times that a write had to flush a page to make room in the
cache.
-fwc
Returns the number of write requests that do not have to wait for the allocation of
cache pages.
-hrdscsi
Returns the total number of hard errors.
-idle**
Returns the percentage of time that the disks within the LUN are idle.
-idleticks
Returns the amount of time that the disks on this LUN are idle.
-ismetalun
Returns information about whether the LUN is a metaLUN or not.
-isthinlun
Returns information about whether the LUN is a thin LUN or not.
getlun

87

VNX CLI for Block

-itp*
Returns the implicit trespasses in SP A and SP B.
-lunbusytickssp*
Returns the amount of time in 10 microsecond increments where any requests to
this LUN were outstanding through SPA and SPB, respectively.
-lunidletickssp*
Returns the amount of time in 10 microsecond increments where no requests to this
LUN were outstanding through SPA and SPB, respectively.
-luncache
Returns LUN offline (cache dirty) condition information for the specified LUN. See
also the luncache command.
-mirrorname
Returns the MirrorView mirror name.
-name
Returns the LUN name. This switch applies only to systems running a version of VNX
OE for Block software that supports storage group commands. LUN names are
displayed in the UI. You cannot use the LUN name as a CLI command argument.
Note

The -name switch applies only to shared systems.
-nanzq*
Returns the number on arrivals with nonzero queue.
-nzrca*
Returns the nonzero request count arrivals in SP A and SP B.
-owner
Returns the name of the SP that currently owns the LUN. If neither SP owns the LUN a
value of Unknown is returned.
-prb
Returns the percentage of the LUN that is rebuilt.
-private
Returns information on all private LUNs in the system.
-que
Returns the queue length, a number.
-rc
Returns the LUN’s read cache state (alwaysenabled).
Note

The read SP cache is enabled by default while binding LUNs on flash drives. It is
enabled for all RAID types.
-reads**
Returns the number of reads received for each CRU.
-readtime
Returns the cumulative read time in microseconds.
-rg
Returns the RAID group ID.
-rhist*
Returns Read Histogram information. Read Histogram is an system of 10 locations
that contain the number of reads. Element n of the system contains the number of
reads that were larger than or equal to 2n-1 and less than 2n blocks in size. For
example, the first bucket contains the number of 1 block reads, the second contains
the number of 2-3 block reads, the third contains the number of 4-7 block reads, and

88

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

so on. -rhist also displays read histogram overflows, which are the number of I/O
operations that were larger than 512 blocks.
-rwrsp*
Returns the number of host read and write requests in SP A and SP B.
-sc
Returns the LUN capacity as stripe count.
-sftscsi
Returns the total number of soft (correctable) errors.
-slct*
Returns the statistics logging current time.
-slst*
Returns the statistics logging start time.
-snapshot
Returns the number of SnapView snapshots (copy images on which a SnapView
session is active).
-sor*
Returns the sum of outstanding requests in SP A and SP B.
-sqlah*
Returns the sum of queue lengths on arrivals high.
-srcp
Returns the read cache configuration.
-state
Returns the state of the LUN. Valid states are: Expanding, Defragmenting, Faulted,
Transitional, or bound.
-stripe
Returns the number of times an I/O crossed a stripe boundary on a RAID 6, RAID 5,
RAID 0, or RAID 1/0 LUN.
-totque
Returns the total queue length, a number.
-type
Returns the RAID type of the LUN as follows:
RAID 0 - nonredundant individual access array
RAID 1 - mirrored pair
RAID 3 - single-disk parity
RAID 5 - distributed parity
RAID 6 - double distributed parity
RAID 1/0 - mirrored RAID 0 group
Disk - individual unit
Hot Spare - hot spare

-uid
Returns the LUN unique ID.
-upb*
Returns the number of prefetched blocks not used by the read cache.
-usage
Returns the usage for a private LUN. For standard LUNs the usage displays as
Unknown.
-was
Returns the minimum block size request that bypasses cache.
-wc
Returns the LUN’s write cache state (enabled or disabled).

getlun

89

VNX CLI for Block

Note

The write SP cache is enabled by default while binding LUNs on flash drives. It is
enabled for all RAID types.
-wch*
Returns the number of write requests that do not have to wait for the allocation of
cache pages.
-wcrh
Returns the number of write requests to a previously written address location whose
data is still resident in cache. Write rehits form a subset of write cache hits since
they overwrite already existing data in the write cache.
-wh*
Returns the write hit information, if statistics logging is enabled.
-whist*
Returns write histogram information. Write Histogram is an system of 10 locations
that contain the number of writes. Element n of the system contains the number of
writes that were larger than or equal to 2n-1 and less than 2n blocks in size. For
example, the first bucket contains the number of 1 block writes, the second contains
the number of 2-3 block writes, the third contains the number of 4-7 block writes,
and so on. whist also displays the write histogram overflows, which are the
number of writes that were larger than 512 blocks.
-writes**
Returns the number of writes received for each CRU.
-writetime
Returns the cumulative write time in microseconds.
-all
Lists the getlun command information along with the FAST Cache information.
EXAMPLE #1
This example retrieves the LBA (logical block address), LUN capacity, and alignment
offset information.
naviseccli -h ss1_spa getlun -addroffset -offset -capacity
LOGICAL UNIT NUMBER 0
Offset:
LUN Capacity(Megabytes):
LUN Capacity(Blocks):
Address Offset:

N/A
1024
2097152
0

LOGICAL UNIT NUMBER 1
Offset:
LUN Capacity(Megabytes):
LUN Capacity(Blocks):
Address Offset:

N/A
5120
10485760
2097152

LOGICAL UNIT NUMBER 2
Offset:
LUN Capacity(Megabytes):
LUN Capacity(Blocks):
Address Offset:

N/A
10240
20971520
12582912

EXAMPLE #2
This example retrieves the cumulative read time and write time.

90

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

naviseccli –h ss1_spa getlun 0 –readtime –writetime
Cumulative Read Time (microseconds): 87937
Cumulative Write Time (microseconds): 0

EXAMPLE #3
This example retrieves information about LUN number 0: (See sample listing following)
naviseccli -h ss1_spa getlun 0

OUTPUT
The following is a sample output. Actual output varies depending on the switches you use
with the getlun command.
LOGICAL UNIT NUMBER 0
Prefetch size (blocks) = N/A
Prefetch multiplier = N/A
Segment size (blocks) = N/A
Segment multiplier = N/A
Maximum prefetch (blocks) = N/A
Prefetch Disable Size (blocks) = N/A
Prefetch idle count = N/A
Prefetching: N/A Prefetched data retained N/A
Read cache configured according to specified parameters.
Total Hard Errors: 0
Total Soft Errors: 0
Total Queue Length: 0
Name LUN 0
Minimum latency reads N/A
RAID Type: RAID5
RAIDGroup ID: 0
State: Bound
Stripe Crossing: 0
Element Size: 128
Current owner: SP B
Offset: N/A
Auto-trespass: DISABLED
Auto-assign: DISABLED
Write cache: ENABLED
Read cache: ENABLED
Idle Threshold: N/A
Idle Delay Time: N/A
Write Aside Size: 0
Default Owner: SP B
Rebuild Priority: N/A
Verify Priority: N/A
Prct Reads Forced Flushed: N/A
Prct Writes Forced Flushed: N/A
Prct Rebuilt: 100
Prct Bound: N/A
LUN Capacity(Megabytes): 51200
LUN Capacity(Blocks): 104857600
UID: 60:06:01:60:E8:90:32:00:EF:14:8D:66:13:4E:E2:11
Bus 0 Enclosure 4 Disk 19 Queue Length: 0
Bus 0 Enclosure 4 Disk 0 Queue Length: 0
Bus 0 Enclosure 4 Disk 2 Queue Length: 0
Bus 0 Enclosure 4 Disk 4 Queue Length: 0
Bus 0 Enclosure 4 Disk 6 Queue Length: 0
Bus 0 Enclosure 4 Disk 7 Queue Length: 0
Bus 0 Enclosure 4 Disk 19 Hard Read Errors: 0
Bus 0 Enclosure 4 Disk 0 Hard Read Errors: 0
Bus 0 Enclosure 4 Disk 2 Hard Read Errors: 0

getlun

91

VNX CLI for Block

Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Bus 0 Enclosure
Is Private: NO
Snapshots List:
MirrorView Name

4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4

Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk

4 Hard Read Errors: 0
6 Hard Read Errors: 0
7 Hard Read Errors: 0
19 Hard Write Errors: 0
0 Hard Write Errors: 0
2 Hard Write Errors: 0
4 Hard Write Errors: 0
6 Hard Write Errors: 0
7 Hard Write Errors: 0
19 Soft Read Errors: 0
0 Soft Read Errors: 0
2 Soft Read Errors: 0
4 Soft Read Errors: 0
6 Soft Read Errors: 0
7 Soft Read Errors: 0
19 Soft Write Errors: 0
0 Soft Write Errors: 0
2 Soft Write Errors: 0
4 Soft Write Errors: 0
6 Soft Write Errors: 0
7 Soft Write Errors: 0
19 Enabled Bus 0 Enclosure 4 Disk 0 Enabled
2 Enabled Bus 0 Enclosure 4 Disk 4 Enabled
6 Enabled Bus 0 Enclosure 4 Disk 7 Enabled

Not Available
if any: Not Available

getresume
Displays resume information for system devices.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli getresume command displays the properties (resume information)
for system devices, such as the enclosure display board, link control card (LCC), power
supply (PS), storage processor (SP), SAN personality card, central processing unit module
(CPU), I/O module, management module, and the standby power supply (SPS). You can
display resume information for a specific device or for all devices.
The product serial number, product part number, and product revision are displayed only
for the SPE enclosure on VNX systems. This information is displayed only when you use
the -all switch. Only Secure CLI supports use of this switch.
SYNTAX
getresume [-sp] [-lcc busNumber enclosureNumber [lcca|lccb]]
[-ps busNumber enclosureNumber|xpe [psa|psb]]
[-pc] [-mp] [-sps] [-vendorinfo] [-all]
OPTIONS
-all
Displays resume information for all devices.
-lcc busNumber enclosureNumber [lcca|lccb]
Displays resume information for the link control card. If you omit lcca or lccb,
information is returned for link control cards A and B.
-mp
Displays resume information for the enclosures.
-pc
92

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Displays resume information for the SAN personality card.
-ps busNumber enclosureNumber | xpe [psa|psb]
Displays resume information for the power supply. If you omit psa or psb,
information is returned for power supplies A and B.
-sp
Displays resume information for SPs.
-sps
Displays resume information for the standby power supply (SPS) that is associated
with the SP you specify in the command line.
EXAMPLE
This example displays information stored in the resume PROM for power supplies A and B
(bus 0, enclosure 0).
naviseccli -h ss1_spa getresume -ps 0 0
Bus 0 Enclosure 0
Power A
EMC Part Number: N/A
EMC Artwork Revision: N/A
EMC Assembly Revision: N/A
EMC Serial Number: N/A
Vendor Part Number: SG9006-710G
Vendor Artwork Number: 010
Vendor Assembly Number: A10
Vendor Serial Number: AC7111210221
Vendor Name: ACBEL POLYTECH INC.
Location of Manufacture: TANG XIA TOWN, DONG GUAN, CHINA
Year of Manufacture: 2011
Month of Manufacture: 03
Day of Manufacture: 30
Assembly Name: Dual +12V P/S & Cooling Module.
Programmable Name: 1sa :2sa :3sa :4sa
Programmable Revision: 5.21:3.31:3.21:2.04
Bus 0 Enclosure 0
Power B
EMC Part Number: N/A
EMC Artwork Revision: N/A
EMC Assembly Revision: N/A
EMC Serial Number: N/A
Vendor Part Number: SG9006-710G
Vendor Artwork Number: 010
Vendor Assembly Number: A10
Vendor Serial Number: AC7111210334
Vendor Name: ACBEL POLYTECH INC.
Location of Manufacture: TANG XIA TOWN, DONG GUAN, CHINA
Year of Manufacture: 2011
Month of Manufacture: 03
Day of Manufacture: 30
Assembly Name: Dual +12V P/S & Cooling Module.
Programmable Name: 1sa :2sa :3sa :4sa
Programmable Revision: 5.33:3.31:3.21:2.04

getresume

93

VNX CLI for Block

OUTPUT
The following example shows sample output of resume information for I/O carrier device
0 on both SPs.
Storage Processor A
I/O Carrier 0
EMC Part Number
EMC Artwork Revision
EMC Assembly Revision
EMC Serial Number
Vendor Part Number
Vendor Artwork Number
Vendor Assembly Number
Vendor Serial Number
Vendor Name
Location of Manufacture
Year of Manufacture
Month of Manufacture
Day of Manufacture
Assembly Name
Programmable Name
Programmable Revision
Storage Processor B
I/O Carrier
EMC Part Number
EMC Artwork Revision
EMC Assembly Revision
EMC Serial Number
Vendor Part Number
Vendor Artwork Number
Vendor Assembly Number
Vendor Serial Number
Vendor Name
Location of Manufacture
Year of Manufacture
Month of Manufacture
Day of Manufacture
Assembly Name
Programmable Name
Programmable Revision
Enclosure SPE

204-012-901D
N/A
D04
CF2JY063400197
N/A
N/A
N/A
N/A
CELESTICA
THAILAND
2006
9
15
IO Carrier Device
NVRAM0:FLASH0:NVRAM1
0.01:2.07:0.01
0
204-012-901D
N/A
D04
CF2JY063400174
N/A
N/A
N/A
N/A
CELESTICA
THAILAND
2006
9
14
IO Carrier Device
NVRAM0:FLASH0:NVRAM1
0.01:2.07:0.01

Chassis/Midplane
EMC Part Number: 100-562-266
EMC Artwork Revision: N/A
EMC Assembly Revision: A01
EMC Serial Number: HK100072600036
Vendor Part Number: N/A
Vendor Artwork Number: N/A
Vendor Assembly Number: N/A
Vendor Serial Number: N/A
Vendor Name: N/A
Location of Manufacture: Hopk,MA USA
Year of Manufacture: 2007
Month of Manufacture: 07
Day of Manufacture: 11
Assembly Name: DREADNOUGHT DVT CHASSIS
Programmable Name: Micro 11.33
Programmable Revision: Micro 11.33
EMC Product Serial Number: XXXXXXXXXXXXXX
EMC Product Part Number: 900-XXX-XXX
EMC Product Revision: XX.XX.XX
Bus 0 Enclosure 0
Chassis/Midplane
EMC Part Number: 100-561-622
EMC Artwork Revision: D05

94

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

EMC Assembly Revision: A08
EMC Serial Number: FCNST064401287
Vendor Part Number: N/A
Vendor Artwork Number: N/A
Vendor Assembly Number: N/A
Vendor Serial Number: N/A
Vendor Name: FOXCONN, SHENZHEN, CHINA
Location of Manufacture: LONGHUA TOWN, SHENZHEN,CHINA
Year of Manufacture: 2006
Month of Manufacture: 10
Day of Manufacture: 30
Assembly Name: 4GB FC DAE STILETTO W/FLANGES
Programmable Name: Micro 11.33
Programmable Revision: Micro 11.33
Bus 1 Enclosure 0
Chassis/Midplane
EMC Part Number: 100-561-622
EMC Artwork Revision: D05
EMC Assembly Revision: A08
EMC Serial Number: FCJST064500188
Vendor Part Number: N/A
Vendor Artwork Number: N/A
Vendor Assembly Number: N/A
Vendor Serial Number: N/A
Vendor Name: FOXCONN, SHENZHEN, CHINA
Location of Manufacture: LONGHUA TOWN, SHENZHEN, CHINA
Year of Manufacture: 2006
Month of Manufacture: 11
Day of Manufacture: 09
Assembly Name: 4GB FC DAE STILETTO W/FLANGES
Programmable Name: Micro 11.33
Programmable Revision: Micro 11.33

getrg
Gets RAID group information.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli getrg command returns information about the specified RAID group.
If no RAID group is specified, the command returns information about all RAID groups.
SYNTAX
getrg rg [-type] [-state] [-disks] [-drivetype] [-lunlist]
[-maxd] [-maxl] [-tcap] [-ucap] [-lusc] [ -pod] [-prcntdf]
[-prcntex] [-exdisks] [-lunex] [-legal] [-powersavingssetting]
[-powersavingseligible] [-isrginstandbystate] [-elementsize]
[-all]
OPTIONS
rg

Is the RAID group identification number. rg specifies a number between 0 and the
maximum number of RAID groups supported by the system.
-disks
Returns the state of disks in the RAID group.
-drivetype
Returns information about what drive type the RAID group consists of.
getrg

95

VNX CLI for Block

-exdisks
Returns information about which disks are expanding. Displays N/A for not
expanding.
-legal
Returns information about specific RAID type LUNs that you can bind for a specific
RAID group. How you can bind the new LUNs depends on the number of LUNs that
already exist and upon the number of disks in the RAID group.
-lunex
Returns information about which LUNs are expanding. Displays NO for not
expanding.
-lunlist
Returns a list of LUNs that are currently in the RAID group.
-lusc
Returns a free contiguous group of unbound segments in blocks.
-maxd
Returns the maximum number of disks that are allowed in the RAID group.
-maxl
Returns the maximum number of LUNs that are allowed in the RAID group.
-pod
Returns the priority of defragmention/expansion operations. The Defrag/Expand
priority value is always shown as N/A on VNX.
-powersavingssetting
Sets the power savings setting ON or OFF. The default value for a nonconfigured RAID
group is OFF.
-powersavingseligible
Determines the eligibility of a RAID group for the power savings option. A RAID group
is eligible for power savings when all the disks in the RAID group are eligible for
power savings.
-isrginstandbystate
Returns the power savings state of the RAID group when all the disks participating in
RAID group are in power savings mode.
-prcntdf
Returns the percent of defragmention that is complete. The Percent defragmented
value is always shown as N/A on VNX.
-prcntex
Returns the percent of expansion that is complete. The Percent expanded value is
always shown as N/A on VNX.
-state
Returns the RAID group state, which may be one of the following: Invalid, Valid_luns,
Halted, and Busy.
-tcap
Returns the raw and logical capacity of the RAID group in blocks.
-type
Returns the RAID group type.
-ucap
Returns the free (unbounded) capacity of the RAID group in blocks.
-all
Lists the RAID group information.
-elementsize
Displays the element size of a RAID group. The element size of a LUN is always equal
to the element size of the RAID Group that holds the LUN.
EXAMPLE
Retrieves information about RAID group 1.
naviseccli -h ss1_spa getrg 1 -all
96

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

OUTPUT
The following is a sample output. The actual output varies depending on the switches you
use with the getrg command.
RaidGroup ID: 1
RaidGroup Type: r5
RaidGroup State: Valid_luns
List of disks: Bus 0 Enclosure 1 Disk 24
Bus 0 Enclosure 1 Disk 23
Bus 0 Enclosure 1 Disk 22
Bus 0 Enclosure 1 Disk 21
Bus 0 Enclosure 1 Disk 20
List of luns: 0 1 2 3
Max Number of disks: 16
Max Number of luns: 256
Raw Capacity (Blocks): 2799769600
Logical Capacity (Blocks): 2239815680
Free Capacity (Blocks,non-contiguous): 2223038464
Free contiguous group of unbound segments: 2223038464
Defrag/Expand priority: N/A
Percent defragmented: N/A
Percent expanded: N/A
Disk expanding onto: N/A
Lun Expansion enabled: NO
Legal RAID types: r5
Power Savings Setting: OFF
RAID GROUP Power Savings Eligible: NO
Is RAID GROUP in Power Savings Mode: NO
Drive Type: SAS
Element Size: 1024

If you request the -elementsize option explicitly, the following output is generated:
RaidGroup ID: 1
Element Size: 128

The following is a sample output of the getrg -drivetype command.
RaidGroup ID: 1
Drive Type: SATA Flash
RaidGroup ID: 5
Drive Type: NL SAS

getsniffer
Gets background verify reports.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli getsniffer command retrieves background verify reports. You can
retrieve reports for a specific LUN, all LUNs in a RAID group, or all LUNs in a system.
Note

The getsniffer command does not support thin LUNs.

getsniffer

97

VNX CLI for Block

SYNTAX
getsniffer lun-number|-rg rg-number]| [-all] [-curr]
[-rec] [-alltot]
OPTIONS
-all
Retrieves reports on all LUNs in the system.
Note

When you specify the -all switch, it may generate a sizeable amount of data and
take a considerable amount of time to generate the data.
lun-number
Specifies the logical unit on which to report. lun-number specifies the logical unit
number.
-rg rg-number
Retrieves reports on all LUNs in the RAID group.
-alltot
Retrieves and displays the report of historical totals of all full unit verifies.
-curr
Retrieves and displays the report of the currently running full unit verify.
-rec
Retrieves and displays the report of the most recently completed full unit verify.

EXAMPLE
Retrieves the report of the active full unit verify operation for LUN 0.
naviseccli -h ss1_spa getsniffer 0

OUTPUT
The following is a sample output. Actual output varies depending on the switches you use
with the getsniffer command.
VERIFY RESULTS FOR UNIT 0
Currently Running Full Unit Verify
----------------------------------------------------------------Corrected
Checksum errors
0
0
Write Stamp errors
0
0
Time Stamp errors
0
0
Shed Stamp errors
0
0
Coherency errors
0
0
Multi Bit CRC errors
0
0
LBA Stamp errors
0
0
Media errors

98

EMC VNX Series 5.33 Command Line Interface Reference for Block

Uncorrectable

VNX CLI for Block

0

0
Soft Media errors

0

Most Recently Completed Full Unit Verify
----------------------------------------------------------------Corrected
Checksum errors
0
0
Write Stamp errors
0
0
Time Stamp errors
0
0
Shed Stamp errors
0
0
Coherency errors
0
0
Multi Bit CRC errors
0
0
LBA Stamp errors
0
0
Media errors
0
0
Soft Media errors

Uncorrectable

0

Historical Total of All Full Unit Verifies (3 passes)
----------------------------------------------------------------Corrected
Checksum errors
0
0
Write Stamp errors
0
0
Time Stamp errors
0
0
Shed Stamp errors
0
0
Coherency errors
0
0
Multi Bit CRC errors
0
0
LBA Stamp errors
0
0
Media errors
0
0
Soft Media errors

Uncorrectable

0

getsniffer

99

VNX CLI for Block

getsp
Gets the SP revision and serial number information.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
Displays SP identification information. If you omit switches, it displays all SP
configuration information.
Note

Use the getsp command to display SP revision and signature information.
SYNTAX
getsp [-type] [-sig] [-psig] [-rev] [-ser] [-mem] [-id]
OPTIONS
-type
Displays the SP type.
-sig
Displays the SP unique signature.
-psig
Displays the SP peer unique signature.
-rev
Displays the SP revision number.
-ser
Displays the SP serial number.
-mem
Displays the SP memory size.
-id
Displays the SP SCSI ID if available, otherwise displays N/A.
EXAMPLE #1
naviseccli -h ss1_spa getsp
SP A
Cabinet: SPE9
Signature For The SP: 3178501
Signature For The Peer SP: 3194985
Revision Number For The SP: 05.33.000.1.467
Serial Number For The SP: FCNMS120700013
Memory Size For The SP: 131072
SP SCSI ID if Available: 0
SP B
Cabinet: SPE9
Signature For The SP: 3194985
Signature For The Peer SP: 3178501
Revision Number For The SP: 05.33.000.1.467
Serial Number For The SP: FCNMS121200069
Memory Size For The SP: 131072
SP SCSI ID if Available: 0

100

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

EXAMPLE #2
The following command displays the enclosure type for VNX5400/VNX5600/VNX5800/
VNX7600 Block systems.
naviseccli -h ss1_spa getsp -type
SP A
Cabinet: DPE9
SP B
Cabinet: DPE9

EXAMPLE #3
The following command displays the enclosure type for VNX8000 Block systems.
naviseccli -h ss1_spa getsp -type
SP A
Cabinet:

SPE9

SP B
Cabinet:

SPE9

getsptime
Gets the date and time setting on each SP system clock.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli command displays the time on the system clocks in one or both
storage processors. The VNX OE for Block software ensures that the system clocks in both
SPs are close but necessarily identical.
SYNTAX
getsptime [-spa|-spb]
OPTIONS
-spa or -spb
Specifies from which SP to display the date and time.
EXAMPLE
naviseccli -h 10.35.50.11 -user xxxxxx -password xxxxxx -scope 0
getsptime
Time on SP A: 08/25/10 10:09:28
Time on SP B: 08/25/10 10:09:40

OUTPUT
The SP date and time.

getspuptime
Gets the length of time since the SPs were last rebooted.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
getsptime

101

VNX CLI for Block

DESCRIPTION
This naviseccli command determines the length of time since the Storage Processor
(SPA or SPB) on the VNX system was last rebooted.
SYNTAX
getspuptime [-spa|-spb]
OPTIONS
-spa or -spb
Specifies the SP for which to display the time since the last reboot. Not specifying an
option displays the uptime for both SPs.
EXAMPLE
naviseccli -h a.b.c.d -user xxxxxx -password xxxxxx -scope 0
getspuptime

OUTPUT
SP A Uptime: 51 days 10 hours 15 minutes
SP B Uptime: 51 days 9 hours 45 minutes

“N/A” is shown if the peer information could not be retrieved.

getunusedluns
Returns the number of LUNs not used by any storage group or by any replication
applications.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli getunusedluns command displays all the unused LUNs, which are
those the storage group and replication applications are not using.
SYNTAX
getunusedluns
EXAMPLE
naviseccli -h ss1_spa getunusedluns

OUTPUT

102

RaidGroup ID:
List of luns:

0
20

RaidGroup ID:
List of luns:

1
4094 4095 4092 4093 4090 21

RaidGroup ID:
List of luns:

2
10 11 12 13 14

RaidGroup ID:
List of luns:

3
4091 16 17 18 19

RaidGroup ID:
List of luns:

4
0 1 2 3 4

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

hotsparepolicy -list
Lists the hot spare policies for all classes of disks on the array.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli hotsparepolicy -list command lists the hot spare policies for
all classes of disks on the array. Disk class is defined by disk type-capacity combination.
SYNTAX
hotsparepolicy -list [-allentries]
OPTIONS
-allentries
Displays all entries, including those for any disk classes that ever appeared on the
array.
EXAMPLE
This example lists all the hot spare policies for the classes of disks currently residing on
the array.
naviseccli hotsparepolicy -list

OUTPUT
The following is a sample output. Actual output varies depending upon which switch you
use with the command.
Policy ID:
1
Disk Type:
Raw Capacity (MBs):
Number of Disks:
Unused disks for hot spares:
Recommended Ratio of Keep Unused
Ratio of Keep Unused
Number to Keep Unused:
Recommended:

SAS
274845
30
15
1/30
1/30
1
Yes

Policy ID:
2
Disk Type:
Raw Capacity (MBs):
Number of Disks:
Unused disks for hot spares:
Recommended Ratio of Keep Unused
Ratio of Keep Unused
Number to Keep Unused:
Recommended:

NL SAS
2748450
5
0
1/30
1/30
1
Yes

hotsparepolicy -set
Sets the hot spare policy.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli hotsparepolicy -set command sets the hot spare policy.
hotsparepolicy -list

103

VNX CLI for Block

SYNTAX
hotsparepolicy -set id -keep1unusedper ratio [-o]
OPTIONS
id

Specifies the ID of the hot spare policy.
-keep1unusedper ratio
Specifies hot spare policy ratio. The allowable value for ratio is an integer equal to or
larger than 0. For example, 0 means no hot spare, 1 means all disks are kept as hot
spare, 15 means to keep one disk per 15 disks are kept as hot spares.
-o
Executes the command without prompting for confirmation.
EXAMPLE
This example changes the hot spare policy ratio to 1/15.
naviseccli hotsparepolicy -set 1 -keep1unusedper 15
You are about to change the hotspare policy, do you want to change
the ratio to 1/15 for SAS drives with 274845 MBs capacity for hot
spare use? [Y/N] ? (Y)

OUTPUT
None if the command succeeds; status or error information if it fails.

inserttestevent
Inserts an event into the event monitor log to let you verify the accuracy of an event
monitor template.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli inserttestevent command inserts a dummy event of code in the
event log. The event is code 0x2003 and its description is Test Event - internal
use only. The event is in the local event queue for processing.
To verify that the monitoring agent will respond as specified (for example, issue email,
send a page) use the responsetest command.
SYNTAX
inserttestevent
EXAMPLE
For ss1_spa, this command writes a test event into the log file.
naviseccli -h ss1_spa inserttestevent

ioportconfig -config -maxvlans
Sets the maximum number of VLANs per port.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.

104

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

DESCRIPTION
The naviseccli ioportconfig -config -maxvlans command sets the
maximum number of VLANs per port.
SYNTAX
ioportconfig -config [-maxvlans 8|16] [-delay delay] [-o]
OPTIONS
-maxvlans 8 | 16
Sets the maximum number of VLANs per port to either 8 or 16.
-delay delay
Delays the coordinated reboot between SPs for the specified value. The value ranges
from 0 to 1140 seconds. The default value is 360 seconds.
-o
Executes the command without prompting for confirmation.
EXAMPLE
This example shows how to set the maximum number of VLANs per port to 16.
naviseccli –h ss1_spa -user user11 –password pswd11 –scope 0
ioportconfig –config –maxvlans 16

OUTPUT
WARNING: This operation will change the maximum VLAN ports. The
operation will reboot the SPs.
DO YOU WISH TO CONTINUE (Y/N)?

ioportconfig -list
Displays information about all I/O modules and corresponding I/O ports.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli ioportconfig -list command displays the information about
all I/O modules and I/O ports on VNX series systems.
SYNTAX
ioportconfig -list -iomodule "onboard"|"basemodule"|slot_num
[-sp a|b] [label] [-pportid] [-portrole] [-portusage]
[-porttype] [-portstate] [-portsubstate] [-isportpersisted]
[-lportid] [-all]
OPTIONS
-list
Displays information about all I/O modules and I/O ports (for both SPs).
-iomodule "onboard" | "basemodule" | slot_num
Displays information about the module and all I/O ports that exist on the given
module. If the slot_num is not provided, the system returns an error.
Note

"basemodule" is not supported on VNX8000 Block systems.

-sp a | b
ioportconfig -list

105

VNX CLI for Block

Specifies the SP, either A or B. If an -sp switch is not specified, then information
about the I/O module with the given slot_num for both SPs will be shown.
-label
Displays the IO Module Label information.
-pportid
Displays the physical port number.
-portrole
Displays whether the port is operating as a front-end or back-end port. If not
persisted, this field displays an error Uninitialized.
-portusage
Indicates how the port is being used. If the port is a MirrorView port, it displays
Special. If the port is initialized, and is not the MirrorView port, it displays
Normal. If the port is not initialized, the state is Uninitialized. Refer to EMC
MirrorView/Asynchronous Command Line Interface (CLI) Reference for information
about the MirrorView ports for the various systems.
-porttype
Displays the port transport type (Fibre Channel or iSCSI).
-portstate
Displays the state of the port. If not persisted, this field displays Uninitialized.
-portsubstate
Provides a detailed description of why the port is in a particular state.
-isportpersisted
Indicates whether the port is currently persisted.
-lportid
Shows the logical port ID.
EXAMPLE
This example shows information about all I/O modules and corresponding I/O ports.
naviseccli -h ss1_spa -user user11 –password pswd11 -scope 0
ioportconfig -list -all

OUTPUT
Information about each I/O module(s) on SPA:
SP ID:
I/O Module Slot:
I/O Module Type:
I/O Module State:
I/O Module Substate:
I/O Module Power state:
I/O Carrier:
I/O Module Label:

A
0
Unknown
Empty
Not Present
Not Available
No
Unknown

SP ID:
I/O Module Slot:
I/O Module Type:
I/O Module State:
I/O Module Substate:
I/O Module Power state:
I/O Carrier:
I/O Module Label:

A
1
Fibre Channel
Present
Good
On
No
8 Gb Fibre

Information about each port on this I/O module:
Physical Port ID:
0
Port Role:
FE
Logical Port ID:
0
Port Usage:
Special
Port Type:
Fibre Channel
Port State:
Enabled

106

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Port Substate:
Is Persisted:

Good
Yes

Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

1
FE
1
Normal
Fibre Channel
Enabled
Good
Yes

Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

2
FE
2
Normal
Fibre Channel
Enabled
Good
Yes

Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

3
FE
3
Normal
Fibre Channel
Enabled
Good
Yes

SP ID:
I/O Module Slot:
I/O Module Type:
I/O Module State:
I/O Module Substate:
I/O Module Power state:
I/O Carrier:
I/O Module Label:

A
2
iSCSI
Present
Good
On
No
10 GbE v3

Information about each port on this I/O module:
Physical Port ID:
0
Port Role:
FE
Logical Port ID:
4
Port Usage:
Special
Port Type:
iSCSI
Port State:
Enabled
Port Substate:
Good
Is Persisted:
Yes
Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

1
FE
5
Normal
iSCSI
Enabled
Good
Yes

SP ID:
I/O Module Slot:
I/O Module Type:
I/O Module State:
I/O Module Substate:
I/O Module Power state:
I/O Carrier:
I/O Module Label:

A
3
iSCSI
Present
Good
On
No
10 GbE BaseT

Information about each port on this I/O module:

ioportconfig -list

107

VNX CLI for Block

Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

0
FE
6
Normal
iSCSI
Enabled
Good
Yes

Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

1
FE
7
Normal
iSCSI
Enabled
Good
Yes

SP ID:
I/O Module Slot:
I/O Module Type:
I/O Module State:
I/O Module Substate:
I/O Module Power state:
I/O Carrier:
I/O Module Label:

A
4
iSCSI
Present
Good
On
No
1 GbE iSCSI/TOE

Information about each port on this I/O module:
Physical Port ID:
0
Port Role:
FE
Logical Port ID:
8
Port Usage:
Normal
Port Type:
iSCSI
Port State:
Enabled
Port Substate:
Good
Is Persisted:
Yes

108

Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

1
FE
9
Normal
iSCSI
Enabled
Good
Yes

Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

2
FE
10
Normal
iSCSI
Enabled
Good
Yes

Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

3
FE
11
Normal
iSCSI
Enabled
Good
Yes

SP ID:
I/O Module Slot:
I/O Module Type:
I/O Module State:

A
Base Module
SAS
Present

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

I/O
I/O
I/O
I/O

Module Substate:
Module Power state:
Carrier:
Module Label:

Good
On
No
N/A

Information about each port on this I/O module:
Physical Port ID:
0
Port Role:
BE
Logical Port ID:
0
Port Usage:
Normal
Port Type:
SAS
Port State:
Enabled
Port Substate:
Good
Is Persisted:
Yes
Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

1
BE
1
Normal
SAS
Missing
SFP is missing
Yes

Information about each I/O module(s) on SPB:
SP ID:
I/O Module Slot:
I/O Module Type:
I/O Module State:
I/O Module Substate:
I/O Module Power state:
I/O Carrier:
I/O Module Label:

B
0
Unknown
Empty
Not Present
Not Available
No
Unknown

SP ID:
I/O Module Slot:
I/O Module Type:
I/O Module State:
I/O Module Substate:
I/O Module Power state:
I/O Carrier:
I/O Module Label:

B
1
Fibre Channel
Present
Good
On
No
8 Gb Fibre

Information about each port on this I/O module:
Physical Port ID:
0
Port Role:
FE
Logical Port ID:
0
Port Usage:
Special
Port Type:
Fibre Channel
Port State:
Enabled
Port Substate:
Good
Is Persisted:
Yes
Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

1
FE
1
Normal
Fibre Channel
Enabled
Good
Yes

Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:

2
FE
2
Normal
Fibre Channel

ioportconfig -list

109

VNX CLI for Block

Port State:
Port Substate:
Is Persisted:

Enabled
Good
Yes

Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

3
FE
3
Normal
Fibre Channel
Enabled
Good
Yes

SP ID:
I/O Module Slot:
I/O Module Type:
I/O Module State:
I/O Module Substate:
I/O Module Power state:
I/O Carrier:
I/O Module Label:

B
2
iSCSI
Present
Good
On
No
10 GbE v3

Information about each port on this I/O module:
Physical Port ID:
0
Port Role:
FE
Logical Port ID:
4
Port Usage:
Special
Port Type:
iSCSI
Port State:
Enabled
Port Substate:
Good
Is Persisted:
Yes
Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

1
FE
5
Normal
iSCSI
Enabled
Good
Yes

SP ID:
I/O Module Slot:
I/O Module Type:
I/O Module State:
I/O Module Substate:
I/O Module Power state:
I/O Carrier:
I/O Module Label:

B
3
iSCSI
Present
Good
On
No
10 GbE BaseT

Information about each port on this I/O module:
Physical Port ID:
0
Port Role:
FE
Logical Port ID:
6
Port Usage:
Normal
Port Type:
iSCSI
Port State:
Enabled
Port Substate:
Good
Is Persisted:
Yes
Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

110

EMC VNX Series 5.33 Command Line Interface Reference for Block

1
FE
7
Normal
iSCSI
Enabled
Good
Yes

VNX CLI for Block

SP ID:
I/O Module Slot:
I/O Module Type:
I/O Module State:
I/O Module Substate:
I/O Module Power state:
I/O Carrier:
I/O Module Label:

B
4
iSCSI
Present
Good
On
No
1 GbE iSCSI/TOE

Information about each port on this I/O module:
Physical Port ID:
0
Port Role:
FE
Logical Port ID:
8
Port Usage:
Normal
Port Type:
iSCSI
Port State:
Enabled
Port Substate:
Good
Is Persisted:
Yes
Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

1
FE
9
Normal
iSCSI
Enabled
Good
Yes

Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

2
FE
10
Normal
iSCSI
Enabled
Good
Yes

Physical Port ID:
Port Role:
Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

3
FE
11
Normal
iSCSI
Enabled
Good
Yes

SP ID:
I/O Module Slot:
I/O Module Type:
I/O Module State:
I/O Module Substate:
I/O Module Power state:
I/O Carrier:
I/O Module Label:

B
Base Module
SAS
Present
Good
On
No
N/A

Information about each port on this I/O module:
Physical Port ID:
0
Port Role:
BE
Logical Port ID:
0
Port Usage:
Normal
Port Type:
SAS
Port State:
Enabled
Port Substate:
Good
Is Persisted:
Yes
Physical Port ID:
Port Role:

1
BE

ioportconfig -list

111

VNX CLI for Block

Logical Port ID:
Port Usage:
Port Type:
Port State:
Port Substate:
Is Persisted:

1
Normal
SAS
Missing
SFP is missing
Yes

Information about maximum VLANs per port:
Max VLANs per port:
8

ioportconfig -list -maxvlans
Displays information about the maximum number of VLANs per I/O port.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The ioportconfig -list -maxvlans command displays the information about
VLANs per I/O port on VNX series systems.
SYNTAX
ioportconfig -list [-maxvlans]
OPTIONS
-maxvlans
Shows the maximum number of VLANs per port.
EXAMPLE
This example shows information for VLANs.
naviseccli -h ss1_spa -user user11 –password pswd11 -scope 0
ioportconfig -list -maxvlans

OUTPUT
Information about maximum VLANs per port:
Max VLANs per port: 8

ioportconfig -persist
Writes the port configuration information to persistent memory.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli ioportconfig -persist command writes all port configuration
information on the subsystem to persistent memory and reboots both SPs. You can
specify the delay value for writing the port configuration information. If you do not specify
the delay, then the system takes the default value of 360 seconds.
SYNTAX
ioportconfig -persist [-delay delay] [-o]
OPTIONS
-delay delay
112

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

-o

Delays the coordinated reboot between SPs for the specified value. The value ranges
from 0 to 1140 seconds. The default value is 360 seconds.
Executes the command without prompting for confirmation.

EXAMPLE
naviseccli -h ioportconfig -persist -delay 20

OUTPUT
This operation will cause both SPs to reboot in a coordinated
fashion. DO YOU WISH TO CONTINUE (Y/N)?

luncache -clear
Clears the LUN offline (cache dirty) condition.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
You can verify the offline condition of a LUN, using the luncache -list command.
DESCRIPTION
The naviseccli luncache command with the -clear function clears the LUN
offline (cache dirty) condition. You can clear the LUN offline condition for a specific LUN,
or for all LUNS on the system.
When a storage processor (SP) fails, writes destined for a LUN that have not yet been
flushed to disk place the LUN in an offline (cache dirty) condition. LUNs in an offline
condition are inaccessible until pending writes for the LUN are cleared.
Note

When you execute luncache -clear, all pending writes on the LUN are lost. You must
issue the command to the SP that owns the LUN. The luncache -clear command
does not support thin LUNs.
SYNTAX
luncache lun-number -clear [-o]
OPTIONS
lun-number
Specifies the LUN for which to clear the LUN offline condition. If you do not specify a
LUN number, clears the LUN offline condition for all LUNS on the system.
-o
Executes the command without prompting for confirmation.

EXAMPLE
This command clears the LUN offline condition for the specified LUN.
naviseccli -h ss1_spa luncache 9 -clear
Bringing the LUN online will cause all pending writes
on the LUN to be lost.
Do you want to bring the LUN online now? (y/n)

OUTPUT
None if the command succeeds; status or error information if it fails.
luncache -clear

113

VNX CLI for Block

luncache -list
Returns LUN offline (cache dirty) condition information.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli luncache command with the -list function returns the LUN
offline (cache dirty) condition information. You can return information for a specific LUN
or for all LUNS on the system.
When a storage processor (SP) fails, writes destined for a LUN that have not yet been
flushed to disk place the LUN in an offline (cache dirty) condition. LUNs in an offline
condition are inaccessible until pending writes for the LUN are cleared.
Note

You must issue the command to the SP that is the default owner of the LUN which is not
necessarily the current owner. You can clear the LUN offline condition using luncache
-clear. The luncache -list command does not support thin LUNs.
SYNTAX
luncache lun-number -list
OPTIONS
lun-number
Indicates the LUN for which to display LUN offline condition information. If you do
not specify a LUN number, LUN offline condition information is returned for all LUNS
on the system.

EXAMPLE
This command displays LUN offline condition information for the specified LUN.
naviseccli -h ss1_spa luncache 9 -list

OUTPUT
LUN Offline (Cache Dirty Condition):

YES

managedby
Displays the application that manages the system.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
You use the managedby command for purposes of the VSS Provider. The VSS Provider is
used in conjunction with the SnapView functionality, to provide backup capabilities.
Note

The command returns an output value of Navi Manager (Unisphere) or None. A value
of None is synonymous to Unisphere.

114

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

SYNTAX
managedby
EXAMPLE
The system is managed by Unisphere.
naviseccli -h ss1_spa managedby

OUTPUT
Managed By: Navi Manager

managefiles -delete
Deletes SP logging files on the specified system.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli managefiles command with the -delete function lets you delete
SP logging files from supported directories.
Note

The dumps and logs directories are supported for managefiles.
You can specify the files you want to delete by using the -all or -file switches, or you
can omit switches and display a list of files, and then choose a file from the list.
SYNTAX
managefiles -delete [-all] [-file filenames] [-o]
OPTIONS
-all
Deletes all the files from the supported directory.
-file filenames
Deletes the specified files from the supported directory.
-o
Executes the command without prompting for confirmation.
EXAMPLE
This command shows you all file index numbers and names. The files appear in the
format shown below. You then enter the file you want to delete, by either its index
number or name.
naviseccli -h ss1_spa managefiles -delete
Index
0
1
2
3
4
5

Size
0
138
0
0
0
0

Last modified
10/26/2000 17:39:53
10/27/2000 12:37:19
10/27/2000 13:20:53
10/27/2000 13:29:57
10/27/2000 18:31:42
10/27/2000 18:41:37

Filename
naviagent_Oct-26-00_13-36-17.log
naviagent_Oct-26-00_13-48-40.log
naviagent_Oct-27-00_08-48-38.log
naviagent_Oct-27-00_09-29-57.log
naviagent_Oct-27-00_11-06-09.log
naviagent_Oct-27-00_14-41-37.log

Enter files to be deleted with index separated by comma
(1,2,3,4-5) OR a range (1-3) OR enter 'all' to delete all
file OR 'quit' to quit> 2

managefiles -delete

115

VNX CLI for Block

Files selected to be deleted are
naviagent_Oct-27-00_08-48-38.log
Do you want to continue(y/n)[n]? (y/n)? y
File naviagent_Oct-27-00_08-48-38.log is deleted.

OUTPUT
None if the command succeeds; status or error information if it fails.

managefiles -list
Lists SP logging files in supported directories.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli managefiles command with the -list function lets you display a
list of SP logging files in supported directories.
Note

The dumps and logs directories are supported for managefiles.
SYNTAX
managefiles -list
EXAMPLE
This command shows you a list of files in the supported directories, for the system you
specify.
naviseccli -h ss1_spa managefiles -list

OUTPUT
Index
0
1
2
3
4
5

Size
0
138
0
0
0
0

Last modified
10/26/2000 17:39:53
10/27/2000 12:37:19
10/27/2000 13:20:53
10/27/2000 13:29:57
10/27/2000 18:31:42
10/27/2000 18:41:37

Filename
naviagent_Oct-26-00_13-36-17.log
naviagent_Oct-26-00_13-48-40.log
naviagent_Oct-27-00_08-48-38.log
naviagent_Oct-27-00_09-29-57.log
naviagent_Oct-27-00_11-06-09.log
naviagent_Oct-27-00_14-41-37.log

managefiles -retrieve
Retrieves SP logging files from a remote system to the local system.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli managefiles command with the -retrieve function lets you
retrieve SP logging files from supported directories on a remote system to the local
system.

116

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Note

The dumps and logs directories are supported for managefiles.
You can specify the files you want to retrieve by using the -all or -file switches, or
you can omit switches and display a list of files, and then choose a file from the list.
SYNTAX
managefiles -retrieve [-path path] [-all] [-file filenames]
[-o]
OPTIONS
-path path
Specifies the path on the local system where you want to copy the file. If you do not
use this switch, the file is copied to the current directory.
-all
Retrieves all files from the supported directory.
-file filenames
Retrieves the specified files from the supported directory.
-o
Executes the command without prompting for confirmation.
EXAMPLE
This command shows you all file index numbers and names. The files appear in the
format shown below. You then enter the file you want to retrieve, by either its index
number or name.
naviseccli -h ss1_spa managefiles -retrieve
Index
0
1
2
3
4
5

Size
0
138
0
0
0
0

Last modified
10/26/2000 17:39:53
10/27/2000 12:37:19
10/27/2000 13:20:53
10/27/2000 13:29:57
10/27/2000 18:31:42
10/27/2000 18:41:37

Filename
naviagent_Oct-26-00_13-36-17.log
naviagent_Oct-26-00_13-48-40.log
naviagent_Oct-27-00_08-48-38.log
naviagent_Oct-27-00_09-29-57.log
naviagent_Oct-27-00_11-06-09.log
naviagent_Oct-27-00_14-41-37.log

Enter files to be retrieved with index seperated by comma
(1,2,3,4-5) OR a range (1-3) OR enter 'all' to retrieve
all file OR 'quit' to quit> 2
Files selected to be retrieved are
naviagent_Oct-27-00_08-48-38.log
Do you want to continue(y/n)[n]? (y/n)? y
File naviagent_Oct-27-00_08-48-38.log is retrieved to the current
directory.

OUTPUT
None if the command succeeds; status or error information if it fails.

ndu -list
Describes installed SP driver software packages.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
You must be able to log in to the host running VNX CLI for Block.
ndu -list

117

VNX CLI for Block

DESCRIPTION
The ndu command provides nondisruptive upgrades on VNX series systems. This
command lets you install and upgrade system software without disrupting any I/O from
attached servers. Third-party software installation is not supported. This means you can
use ndu to install VNX OE for Block software bundles or enablers.
Use the -list function with no switches to display all the information about all software
packages.
The naviseccli ndu command with the -list function and no switches displays
information about all installed software packages. The format looks like this:
Name of the software package:
name
Revision of the software package: n.nn
Commit Required:
yes or no or
already committed
Revert Possible:
yes or no
Active State:
yes or no
Is installation complete
yes or no or not
applicable.
Is this System Software:
yes or no

For information on one package, use the -name switch. For a subset of package
information, use one or more additional switches.
After listing installed driver packages, you can perform other ndu (non-disruptive
upgrade) steps, such as ndu -commit or ndu -revert.
SYNTAX
ndu -list [-name [name]] [-rev] [-iscommitable] [-isrevertable]
[-isactive] [-iscomplete] [-issystem] [-gen]
OPTIONS
-name [name]
Without the name argument, displays only the names of packages; with name,
displays information on the package name.
-gen
Displays the generation of the package.
-rev
Displays the package revision.
-iscommitable
Displays yes if the package can be committed, no if it cannot.
-isrevertable
Displays yes if the package can be reverted (it is not committed), no if it cannot be.
-isactive
Displays yes if the package is active, no if it is not.
-iscomplete
Displays yes if the package file contains a complete set of files, no or not applicable
if it does not.
-issystem
Displays yes if the package is a factory-supplied system driver, no if it is not.
EXAMPLE
For the SP with hostname payroll_storage_SPA, this command lists all installed
driver packages. For sample output, see previous page.
naviseccli -h payroll_storage_SPA ndu -list

118

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

OUTPUT
See previous page. If the version of VNX OE for Block software running on the SP does not
support this command, a Not supported error message is printed to stderr.

ndu -install
Transfers SP software driver packages to the system private LUN (PSM LUN).
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
You must have a user entry in the Unisphere agent configuration file.
Preinstallation validation checks
Preinstallation validation checks identify unsupported or unsafe installation conditions.
You initiate the validation checks functionality when you issue the ndu -install
command. The validation checks run in the background, prior to installing the software. If
a validation check fails, the CLI displays the error and terminates the installation. You can
choose to display all validation checks as the functionality executes by specifying the verbose switch, otherwise the CLI only displays failures that prevent installation. The
following responses exist for each validation check:
Table 9 Validation check responses

Response

Definition

Successful

Validation check is successful. Installation proceeds.

Warning

Conditions exist that may need correction. Installation proceeds.

Failure

Conditions exist that require correction before installation can
proceed. Installation terminates.

Note

The preinstallation validation checks identify a series of unsupported or unsafe
installation conditions, but cannot guarantee a successful install.
In addition to the user access requirements for the ndu command, the validation check
has associated configuration requirements that you must follow:
l

Create the required user accounts on the system (refer to the VNX for Block Concepts
guide, section Getting Started with Secure CLI) . You can create the user accounts
using the Secure CLI syntax.

l

Create a security file on the host. If you do not create a security file, the CLI prompts
you for a valid username, password and scope:
Security File does not exist
Please enter security information to proceed:
Enter User (Existing user on system)
Enter Password
Enter Scope (0 – global [default]; 1 – local

ndu -install

119

VNX CLI for Block

Note

If the system is uninitialized, user credential information is not required. Therefore, a
security file is not required and the CLI does not prompt you for a username, password
and scope.
You can also issue validation checks without installing or upgrading software (see ndu runrules).
Note

Use the naviseccli ndu -list command to display installed package information. If the
ndu -install command succeeds, the SPs restart.
DESCRIPTION
The ndu command with the -install function transfers files from media to the system,
queries and displays information about the packages, and then installs or upgrades
selected software packages.
The naviseccli ndu command -install function transfers one or more SP driver
packages from a user-accessible file system to the system private storage LUN (PSM).
Media should be present before you issue this command.
You should use a Windows-based management software (either Unisphere or VNX CLI for
Block) to install software.
Before starting a non-disruptive software installation, record the read and write cache
sizes because they will be set to zero.
Before the SP starts a nondisruptive software installation, it disables the caches and sets
their sizes to zero. If the write cache is full and I/O is heavy, disabling the cache may take
over an hour because the cached data must be written to disk. After the data is written,
the installation starts.
When you install new SP software using the CLI, the only way to determine when the
installation is finished is to issue periodic ndu -status commands until the CLI shows
the operation is completed.
When the installation is complete, restore the cache sizes to their original sizes if
possible. You may not be able to use the original sizes because the new software
requires more memory than the version that it replaced.
The software prompts for information as needed; then it installs or upgrades the
specified software packages and restarts the SPs. The SPs then load and run the new
packages. After successful installation, it deletes the files from the system.
You can install more than one package with one ndu command.
Note

When you install an upgrade (that is, a newer version of an installed package), you must
install all the software packages you want to use in the same command. For example, if
you are upgrading SnapView in a system that has SnapView, Access Logix, and VNX OE
for Block software installed, then you must upgrade all three using one ndu -install
command. When you install a new package of the same revision as other existing
packages, you may install only that package and not the others.
The CLI takes the following actions in order:
l

120

If it can find the packages, it transfers them without interaction.

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

l

Unless you used -force (which prevents the prompt and is equivalent to the all
response), the software examines each package and displays the following
information for confirmation:
Item number:
Name of the software package:
Revision of the software package:
Already Installed Revision:
Installable

n
driver-name
n.nn
NO or YES
YES or NO

Enter Item number of the packages to be installed separated
by blanks. Enter 'all' for all packages and
'quit' to quit without installing:

Specify the package(s) you want installed. If you make an invalid choice, the CLI does
not install any package.
Note

Do not change the configuration; for example, binding new LUNs or expanding metaLUNs
while a software install is in progress. Such operations will be rejected; delay them until
after the software upgrade is complete and committed.
SYNTAX
ndu -install pathlist [-delay seconds] [-force] [-gen]
[-verbose]
OPTIONS
pathlist
Specifies filenames, with full pathnames, of the software packages to be installed.
You can use a Windows or UNIX pathname (for example, C:\temp or/usr/bin).
Enclose the pathname list in quotes and separate multiple names by a space. If you
are installing a newer version of an existing package, you must install all other
packages (as explained above).
-delay delay
Specifies the delay time that allows attached hosts enough time after SP B has
finished rebooting to rescan and mark paths available to SP B, before SP A reboots.
The minimum allowed delay is zero seconds and the maximum allowed is 1140
seconds. In most cases, the EMC recommended NDU delay of 360 seconds should
be used. However, some host configurations (such as those using Veritas DMP) may
require a longer delay.
-force
Installs without user interaction. If any package is not installed for any reason, the
software displays an error message and continues installing other packages
specified in the command.
-gen
Displays the generation of the package.
-verbose
Displays all results of the preinstallation validation checks. Without this switch, only
errors that prevent installation (failures) are displayed.

ndu -install

121

VNX CLI for Block

EXAMPLE
naviseccli -h ss1_spa ndu -install
VNX-Block-Operating-Environment-05.33.000.1.539.pbu
Item number: 0
Name of the software package: VNX-Block-Operating-Environment
Revision of the software package: 05.33.000.3.539
Already Installed Revision 05.33.000.3.486
Installable YES
Disruptive upgrade: NO
The requested package(s) will be installed. Do you wish to proceed?
: (y/n)?y

OUTPUT
If the version of VNX OE for Block software running on the SP does not support this
command, a Not supported error message is printed to stderr. Other error
message(s):
NDU_NOT_SUPPORTED
NDU_CANNOT_FIND_FILE
NDU_CANNOT_XFER_FILE
INVALID_PACKAGE

ndu -runrules
Executes the preinstallation validation checks.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
You must have a user entry in the Unisphere agent configuration file.
DESCRIPTION
The naviseccli ndu command with the -runrules function executes the
preinstallation validation checks, without performing software installation (see ndu install).
Note

The ndu -runrules command has associated configuration requirements for the
preinstallation validation checks functionality. See Preinstallation validation checks
under ndu -install on page 119.
Note

Use the naviseccli ndu -install command to both run the preinstallation
validation checks and install software.
SYNTAX
ndu -runrules [pathlist] [-listrules] [-verbose]
OPTIONS
pathlist
Specifies filenames, with full pathnames, of the software packages to be committed.
-listrules
122

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Displays a list of preinstallation validation checks that would run for the specified
host. The validation checks do not execute. To run the validation checks, do not
include this switch.
-verbose
Displays all results of the preinstallation validation checks. Without this switch, only
errors that prevent installation (failures) are displayed.
EXAMPLE
For the SP with hostname payroll_storage_SPA, this command executes the
preinstallation validation checks.
naviseccli -h ss1_spa ndu -runrules

OUTPUT
If the preinstallation validation checks detect failures, the failures are displayed.

ndu -commit
Commits (makes permanent) an installed system driver package.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
You must have a user entry in the Unisphere agent configuration file.
DESCRIPTION
The naviseccli ndu command with the -commit function commits an installed
software package. Every package does not require commit.
If a package needs to be committed and it is not committed, all new features of the newly
installed package may not be available. A committed package cannot be reverted. It can
be uninstalled.
Note

You cannot create any new RAID groups or bind any new LUNs until you commit VNX OE
for Block and Access Logix software.
Use the naviseccli ndu -listcommand to display installed package information.
SYNTAX
ndu -commit namelist
OPTIONS
namelist
Lists package names of the software packages to be committed.

EXAMPLE
For the SP with hostname payroll_storage_SPA, this command commits the
installed package mypackage.
naviseccli -h ss1_spa ndu -commit mypackage

OUTPUT
If the version of VNX OE for Block software running on the SP does not support this
command, a Not supported error message is printed to stderr.

ndu -commit

123

VNX CLI for Block

ndu -status
Returns the status of the ndu install, commit, or revert operations.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
You must have a user entry in the Unisphere agent configuration file.
DESCRIPTION
The naviseccli ndu command with the -status function reports the progress of the
last ndu -install, -commit, or -revert function executed.
Note

Use the naviseccli ndu -list command to display installed package information.
SYNTAX
ndu -status [-clear]
OPTIONS
-clear
Clears the status of the last executed ndu command.
EXAMPLE
For the SP with hostname payroll_storage_SPA, this command reports the status of
the ndu -install, -commit, or -revert function.
naviseccli -h ss1_spa ndu -status

OUTPUT
If the version of VNX OE for Block software running on the SP does not support this
command, a Not supported error message is printed to stderr.

ndu -revert
Returns to (restores functionality of) the previous revision of an installed system driver.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
You must have a user entry in the Unisphere agent configuration file.
DESCRIPTION
The naviseccli ndu command with the -revert function restores the functionality
of the previous revision of an installed driver package. A committed package cannot be
reverted, nor can a package that had no previous revision installed. After the command
succeeds, the SPs will restart.
If you omit the -o (override) switch, the CLI prompts for confirmation:
Revert operation will revert package-name from both SPs. Do you
still want to revert. (y/n)?
Answer y to revert; answer n to cancel the command.

124

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Note

Use the naviseccli ndu -list command to display installed package information.
SYNTAX
ndu -revert [-delay seconds] namelist [-o]
OPTIONS
-delay seconds
Specifies the delay time that allows attached hosts enough time after SP B has
finished rebooting to rescan and mark paths available to SP B, before SP A reboots.
The minimum allowed delay is zero seconds and the maximum allowed is 1140
seconds. In most cases, the EMC recommended NDU delay of 360 seconds should
be used. However, some host configurations (such as those using Veritas DMP) may
require a longer delay.
namelist
Lists package names of the software packages to be reverted.
-o
Executes the command without prompting for confirmation.
EXAMPLE
For the SP with hostname payroll_storage_SPA, this command reverts to the
previous revision of mypackage for both SPs.
naviseccli -h ss1_spa ndu -revert mypackage

OUTPUT
If the version of VNX OE for Block software running on the SP does not support this
command, a Not supported error message is printed to stderr. Other errors:
NDU_CANNOT_FIND_FILE
NDU_CANNOT_XFER_FILE
INVALID_PACKAGE

networkadmin -get
Lists network name and address information.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli networkadmin command with -get function without switches lists
all the network information for an SP. This command supports IPv6 network
communication to the management ports of systems with VNX OE for Block version 04.28
or later. If you do not specify the IP address (either IPv4 or IPv6), then by default IPv4
information is displayed. The default IP address is IPv4. If the -ipv4 and the -ipv6
switches are specified, the information is displayed for both IP addresses with the IPv4
information listed first.
Issue the command to the SP for which this information is needed.

networkadmin -get

125

VNX CLI for Block

Issuing this command with one or more switches displays the information based on the
specified switch. The line Storage Processor: is always displayed. This command
displays information in the following format:
Storage
Storage
Storage
Storage
Storage

Processor:
Processor Network Name:
Processor IP Address:
Processor Subnet Mask:
Processor Gateway Address:

SP-id (A or B)
SP-network-name
SP-IP-address
SP-subnet-mask
SP’s-gateway-system address

Note

If you need to change an SP network name or address, then use the networkadmin
command with the -set function described in networkadmin -set on page 131.
SYNTAX
networkadmin -get [-sp a|b] [-name] [-portid portid [-vportid
vportid]] [-vlanid]
[-ipv4 [-mode] [-address] [-subnetmask] [-gateway]]
[-ipv6 [-mode] [-address] [-globalprefix] [-gateway]]
[-speed][-auto] [-capablespeeds] [-requestedspeed]
[-linkstatus] [-all]
OPTIONS
-sp [a|b]
Displays the properties of the specified SP. The default is the properties of the
connected SP.
-portid portid
Displays the management port ID. If you do not specify the port ID, the system
displays the information of all management ports.
-vportid vportid
Displays the virtual port ID associated with the management port. If you do not
specify the virtual port ID, the system displays the information of all virtual ports.
-vlanid
Displays the virtual LAN (VLAN) ID of the management port/virtual port. If the VLANs
are disabled, the system displays Disabled.
-name
Displays the SP's network name.
-ipv4
Displays all the IPv4 information. This is the default IP address.
-ipv6
Displays all the IPv6 information.
-address
Displays the SP's network IP address (IPv4/IPv6 address).
-gateway
Displays the IP address (IPv4/IPv6 address) of the SP's gateway system.
-subnetmask
Displays the SP's IPv4 subnet mask.
-globalprefix
Displays the SP's IPv6 global prefix.
-mode
Displays the IPv4/IPv6 status. The statuses are automatic, manual, and disabled.
-speed
Displays the current port speed for a specified SP.
126

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

-auto (CX4 series only)
Indicates whether the auto-negotiate feature is turned on or off. The CLI returns a
yes value if the feature is turned on, a no value if the feature is turned off, and a
not supported value if the feature is not supported.
Note

If you have the auto-negotiate feature turned on, the speed value that is generated in
the output will not be auto. The value reflects the speed at which the port is currently
operating. If you have the Auto-Negotiate feature turned on and you specify the requestedspeed switch, the Requested Value displays a value of auto.
-capablespeeds (CX4 series only)
Returns a list of valid speed values for each port.
-requestedspeed (CX4 series only)
Displays the requested speed value.
-linkstaus (CX4 series only)
Displays the link status of the management port.
-all (CX4 series only)
Displays all information for the network admin command.
Note

The command switches -speed, -auto, -capablespeeds, requestedspeed, -linkstatus, -portid, -vportid, -vlanid, -ipv4, ipv6, and -all are supported only with Secure CLI.
EXAMPLE #1
naviseccli –h ss1_spa networkadmin -get -speed
Storage Processor SP A
Management Port Settings
Link Status: Link-up
Current Speed: 100 Mbps/half duplex

EXAMPLE #2
naviseccli –h ss1_spa networkadmin -get -capablespeeds -auto
Storage Processor : SP A
Management Port Settings:
Link Status:
Link-up
Current Speed: 100 Mbps/half duplex
Auto-Negotiate: No
Capable Speeds: 10 Mbps half/full duplex
100 Mbps half/full duplex
1000 Mbps half/full duplex Auto

EXAMPLE #3
Note

The IPv6 information contains IPv6 in the header to distinguish the output from the IPv4
information.

networkadmin -get

127

VNX CLI for Block

naviseccli -address 10.5.2.12 -user a -password a –scope 0
networkadmin –get -ipv4 –ipv6
Storage Processor: SP A
Storage Processor Network Name: lumpy-spa
Storage Processor IP Address: 10.5.2.12
Storage Processor Subnet Mask: 255.255.255.0
Storage Processor Gateway Address: 10.5.2.1
Storage Processor IPv6 Mode: Automatic
Storage Processor IPv6 Address:
3ffe:80c0:22c:4d:20d:56ff:fec5:bff4
Storage Processor IPv6 Global Prefix: 3ffe:80c0:22c:4d::
Storage Processor IPv6 Local Address:
fe80::20d:56ff:fec5:bff4
Storage Processor IPv6 Gateway Address:
fe80::20a:8bff:fe5a:967c

EXAMPLE #4
naviseccli –h ss1_spa networkadmin -get -all
Storage Processor: SP A
Storage Processor Network Name: kirk-spa
Port ID: 0
Management Port Settings:
Link Status: Link-Up
Current Speed: 100Mbps/full duplex
Requested Speed: Auto
Auto-Negotiate: YES
Capable Speeds: 10Mbps half/full duplex
100Mbps half/full duplex
1000Mbps half/full duplex
Auto
Virtual Port ID: 0
VLAN ID: 102
Storage Processor IP Mode: Manual
Storage Processor IP Address: 10.5.2.178
Storage Processor Subnet Mask: 255.255.255.0
Storage Processor Gateway Address: 10.5.2.1
Storage Processor IPv6 Mode: Automatic
Storage Processor IPv6 Address:
3ffe:80c0:22c:47:260:1600:3ce0:151c
Storage Processor IPv6 Global Prefix:
3ffe:80c0:22c:47::
Storage Processor IPv6 Link-local Address:
fe80::260:1600:3ce0:151c
Storage Processor IPv6 Gateway Address:
fe80::20a:8bff:fe5a:967c

OUTPUT
See the previous page. If the version of VNX OE for Block software running on the SP does
not support this command, a Not supported error message is printed to stderr.
If the command switches -speed, -auto, -capablespeeds, -requestedspeed, linkstatus, and -all are not supported on the system then an Invalid command
line parameters error message is printed to stderr.
If IPv6 does not support the system an error is displayed: IPv6 is not supported
for this platform.
IPv6 is enabled but a value for one of the IPv6 values has not been set so, the value will
be displayed as an empty string.

128

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

networkadmin -mib
Configures the SNMP services on the system SP.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli networkadmin command with the -mib function enables or
disables the processing of SNMP MIB read requests on an SP and sets the SNMP
community string. This command with no option lists the current status of the SNMP
service.
Note

To discover current settings, use the networkadmin command with the -mib function.
SYNTAX
networkadmin -mib [-enable] [-disable] [-community string] [-o]
OPTIONS
-enable
Enables the SNMP services.
-disable
Disables the SNMP services.
-community newstring
Sets the SNMP community string to newstring.
Note

The -community switch is supported only with ManagementServer release 28 or
later.
-o
Executes the command without prompting for confirmation.
EXAMPLE
This command disables the SNMP services on SP A.
naviseccli -h ss1_spa networkadmin -mib -disable
Disable processing of SNMP read requests on SP A (y/n)[n]

OUTPUT
Storage Processor: SP A
SNMP MIB Status: Disabled
Community: public

If the version of VNX OE for Block software running on the SP does not support this
command, a Not supported error message is printed to stderr.

networkadmin -mib

129

VNX CLI for Block

networkadmin -route
Sets up the static routes.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli networkadmin command with the -route function is used to set
up the static routes to the specific hosts or networks.
SYNTAX
networkadmin -route [-sp a|b] [-portid portid -vportid vportid]
[-add -destination destination [-subnetmask subnetmask |
-prefixlength length] [-metric metric] [-persistent]]
[-delete -destination destination [-subnetmask subnetmask |
-prefixlength length]] [-list] [-o]
OPTIONS
-sp a|b
Specifies the destination SP. The default is the connected SP.
-portid portid
The -portid and the -vportid together specify the interface associated with the
route. If you do not specify the interface, the system determines it.
-vportid vportid
The -portid and the -vportid together specify the interface associated with the
route. If you do not specify the interface, the system determines it.
-add
Adds a network route.
-destination destination
Specifies the IPv4/IPv6 address or the hostname of the destination.
-subnetmask netmask
Specifies the IPv4 subnet mask value for the route entry. The default value is
255.255.255.255. It is valid only for an IPv4 destination address.
-prefixlength length
Specifies the prefix length and the part of the address to compare while determining
the route. The default value is 128. It is valid only for an IPv6 destination address.
-metric metric
Determines the best route using the routing algorithm. The route with the lowest
metric is preferred over another route.
-persistent
Specifies whether the route should persist across restarts.
-delete
Deletes an existing route.
-list
Displays the routes for the SP. By default, it displays the routes of the connected SP.
It also displays the routes for a specific port/virtual port.
-o
Executes the command without prompting for confirmation.
EXAMPLE
naviseccli -h kirk-spa networkadmin -route -list

130

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

OUTPUT
SP A, Port 0, Virtual Port 0:
Protocol:
IPv4
Subnet Mask:
255.255.255.0
Gateway:
10.5.2.1
Originator:
OS
Metric:
10
Destination Address:
10.5.2.0
Persistent:
YES
Static:
NO
Protocol:
Subnet Mask:
Gateway:
Originator:
Metric:
Destination Address:
Persistent:
Static:

IPv4
255.255.255.255
10.5.2.1
OS
10
10.255.255.255
YES
NO

Protocol:
Subnet Mask:
Gateway:
Originator:
Metric:
Destination Address:
Persistent:
Static:

IPv4
240.0.0.0
10.5.2.1
OS
10
224.0.0.0
YES
NO

Protocol:
Subnet Mask:
Gateway:
Originator:
Metric:
Destination Address:
Persistent:
Static:

IPv4
255.255.255.255
10.5.2.1
OS
1
255.255.255.255
YES
NO

Protocol:
Destination Prefix Length:
Originator:
Metric:
Destination Address:
Persistent:
Static:

IPv6
64
OS
8
3ffe:80c0:22c:47::
YES
NO

networkadmin -set
Updates network information for an SP.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli networkadmin command with the -set function changes one or
more network settings for an SP. This command supports IPv6 network communication to
the management ports of systems with VNX OE for Block version 04.28 or later. If you do
not specify the IP address (either IPv4 or IPv6), then by default IPv4 information is
displayed. The default IP address is IPv4. If both the -ipv4 and -ipv6 switches are
specified, the information is displayed for both IP addresses, with the IPv4 information
listed first.
Issue the command to the SP whose information you want to update.
networkadmin -set

131

VNX CLI for Block

If you omit the -o (override) option, the CLI displays a message in the following form to
confirm the update.
Changing the name of SP  from oldname to newname (y/n)[n]?
Changing the IP address of SP  from old-address to newaddress (y/n)[n]?
Changing the sub-net mask of SP  from old-mask to new-mask
(y/n)[n]?
Changing the gateway address of SP  from old-gatewayaddress to new-gateway-address (y/n)[n]?
To make the change, enter y; otherwise, enter n.
Note

To discover current settings, use the networkadmin command with the -get function.
EMC service personnel set the network properties initially to work at your site. Do not
change any value unless you are moving the SP to another LAN or subnet.
If you change any value, after you confirm, the SP restarts and uses the new value.
SYNTAX
networkadmin -set [-o] [-sp a|b] [-name name] [-portid portid
-vportid vportid] [-vlanid vlanid | -vlandisable]
[-ipv4 [-address address] [-subnetmask subnetmask] [-gateway
gateway-IP-address]]
[-ipv6 [-automatic | -disable | -manual
[[-globalprefix prefix | -address IPv6-address]
[-gateway gateway-IP-address]]]
[-speed [-duplex]]
OPTIONS
-o
Executes the command without prompting for confirmation.
-sp [a|b]
Modifies the properties of the specified SP. The default is the connected SP.
-name name
Changes the SP's network name to name. The maximum length of the name is 64
characters.
-portid portid
Specifies the management port ID. The default management port is 0.
-vportid vportid
Specifies the virtual port ID associated with the management port. The default virtual
port is 0.
-vlanid vlanid
Specifies the VLAN ID to be used for the management port/virtual port. If you specify
an invalid VLAN ID or if the ID is already in use, an error message appears displaying
the valid range.
-vlandisable
Disables VLAN tagging on the virtual port.
-ipv4
Specifies the settings for IPv4.
132

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

-address IP-address
Changes the SP's IPv4 network address to IP-address.
-subnetmask mask
Changes the SP's IPv4 subnet mask to mask.
-gateway gateway-IP-address
Changes the SP's IPv4 or IPv6 gateway IP address to gateway-IP-address.
-ipv6
Specifies the settings for IPv6.
[-automatic | -disable | -manual]
Specifies whether you want to enable IPv6 on the SP automatically, disable IPv6 on
the SP, or enable IPv6 on the SP manually. If you choose manual, also choose
whether to set either a global prefix or a specific IPv6 address, and a gateway.
-globalprefix prefix
Changes the SP's IPv6 global prefix to prefix. If you are using this option, you cannot
also use the -address IPv6-address option.
-address IPv6-address
Sets an IPv6 address on the SP, overriding any previous IPv6 configuration. If you are
using this option, you cannot also use the -globalprefix prefix option.
-speed [-duplex] (CX4 series only)
Changes the speed on the management port for the target SP.
EXAMPLE #1
For SP A, this command changes the gateway address.
naviseccli -h ss1_spa networkadmin -set -gatewayaddress
Changing the gateway address of SP A from 123.456.789.011 to
123.456.789.011
This operation will cause a management server restart!
Do you wish to continue? (y/n)[n] y

EXAMPLE #2
This command enables IPv6 (if not enabled) and maintains the current settings.
naviseccli -address 10.5.2.12 -user a -password a –scope 0
networkadmin –set –ipv6 -manual

EXAMPLE #3
This command enables IPv6 (if not enabled) and sets the IPv6 global prefix.
naviseccli -address 10.5.2.12 -user a -password a –scope 0
networkadmin –set –ipv6 -manual -globalprefix 3ffe:80c0:22c:4c:

EXAMPLE #4
For SP A, this command changes the management port speed to 1000 Mbps/half duplex.
naviseccli -h ss1_spa networkadmin -set -speed 1000
-duplex half
Change the management port speed for SP A to 1000 Mbps/half duplex
DO YOU WISH TO CONTINUE? (y/n)?

EXAMPLE #5
For SP A, this command manually sets an IPv6 address.

networkadmin -set

133

VNX CLI for Block

naviseccli -h ss2_spa -user b -password b -scope 0
networkadmin -set -ipv6 -manual -address 3ffe:80c0:22c:4c:1319:8a2e:
370:7348
Setting the IPv6 Mode to Manual on SP A, Port 0, Virtual Port 0
This operation will cause a management server restart!
Do you wish to continue? (y/n)

OUTPUT
See the description section of this command. If the version of VNX OE for Block software
running on the SP does not support this command, a Not supported error message is
printed to stderr. Other errors:
NETADMIN_NOT_FOUND
NETADMIN_INVALID_NAME
Invalid command line parameters
Invalid speed request

port
Lists SP port information, removes an HBA entry from an SP’s initiator list, and provides
diagnostic capabilities.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli port command lists SP port information, removes an HBA entry from
an SP’s permitted initiator list (initiator record), and provides diagnostic capabilities for
SAN Copy initiator records and duplicate host initiator records. See also the
storagegroup -setpath command in storagegroup on page 168 and the alpa
command in alpa -set on page 27.
Note

To register an individual HBA with a system, you need to use Unisphere.
The optional port -diagnose switches are:
[-sancopy [-clean]] [-host]
SYNTAX
port -list [-hba|-arrayhba|-sp|-gname groupname |-uid UID]
[-all] [-arraycommpath] [-failovermode] [-unitserialnumber]
[-mac] [-initiatorcount] [-sfpstate] [-reads] [-writes]
[-bread] [-bwrite] [-qfull] [-physical] [-usage] [-prominfo]
-removeHBA [-o] [-hbauid HBAUID |–host host|-hostip ip|-all]
-diagnose [-o] -sancopy [-clean] |-host

OPTIONS
-sancopy [-clean]
Lists the SAN Copy initiator records where the initiator is the same as that of the
targeted SP. If you include the optional -clean switch, the CLI prompts you to
remove the initiator records that are displayed.
134

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

-host
Scans the host initiator records and displays duplicate hosts with the same host ID.
Without arguments, -list displays information about all ports in the system but
does not list information given by -all, -arraycommpath, and failovermode. This allows -list without an argument to produce output
compatible with scripts written for old revisions of Secure CLI. Example 1 shows
output without switches. Example 2 shows output with the -all switch. You can
use one of the following optional switches with -list:
-all
Lists all port information, including any information that is new with this Unisphere
release.
-arraycommpath
Displays the status of the arraycommpath setting: 0 if arraycommpath is
disabled; 1 if arraycommpath is enabled.
-arrayhba
Displays information about all systems attached to this HBA, or about systems that
were logged in at some point for which initiator records still exist. See Example 2 for
a display.
-bread
Displays the number of blocks read for each port.
-failovermode
Displays the failover mode: 0, 1, 2, 3, or 4. The storagegroup -failovermode
description provides more information.
-gname groupname
Specifies a storage group. goupname specifies the user-defined storage group name.
If you omit the -gname and the -uid switches, the CLI describes all HBA ports
connected to this storage group.
-hba
Returns information on HBA ports. The initiator and target -hba field returns
different information depending on whether you are targeting a Fibre Channel or
FCoE or an iSCSI HBA. When you target a Fibre Channel or FCoE HBA, the -hba
returns the World Wide Name such as: 10:00:00:00:C9:20:DE:0C:
10:00:00:00:C9:20:DE:0C. When you target an iSCSI HBA, -hba returns the initiator
name.
-initiatorcount
Displays the initiator information for each port on a given SP. Lists the number of
initiators that are defined, logged in and not logged in.
-mac
Displays the MAC address for the front-end ports of an iSCSI system and also FCoE
ports. Running the port ... -mac command returns a MAC Address field for each
port. When you run the port ... -mac command, if any ports are Fibre Channel
ports, the MAC Address field for those ports will display Not Applicable.
-physical (CX4 series only)
Displays the physical location of the port including I/O module and physical port
information.
-reads
Displays the number of reads for each port.
-sfpstate
Displays the small form factor pluggable (SFP) state for each port. This lets you
determine if an incompatible or faulty SFP is detected, in which the status is set to
faulted.
-sp
Specifies SP ports only.
port

135

VNX CLI for Block

-uid UID
Specifies the storage group unique ID (also known as the World Wide Name, WWN).
If you omit the -gname and the -uid switches, the CLI describes all HBA ports
connected to this storage group.
-usage (CX4 series only)
Indicates how the port is used. For example, when either of the MirrorView enablers
is installed, it displays MirrorView.
-prominfo
Displays the new EEPROM information for SFP+ SFPs inserted into the front-end
ports.
-unitserialnumber
Specifies the unitserialnumber mode.
-writes
Displays the number of writes for each port.
The optional port -removeHBA switches are:
-hbauid HBAUID
Removes a specific initiator record specified with -hbauid. HBAUID specifies a
unique host bus adapter identification number (must use uppercase).
-host host
Removes all initiator records that are logged out and registered, for the specified
hostname.
-hostip ip
Removes all initiator records that are logged out and registered, for the specified
host IP address. You can specify the IP address either as IPv4 or IPv6 address. If an
incorrect IP address is specified, an error message appears as follows:
The IP address must be specified as an IPv4 address in
dotted-decimal format or as an IPv6 address in colonhexadecimal notation.
Note

If an IPv6 address is specified, EMC recommends that you use a global unicast
address.
-all
Removes all initiator records that are logged out and registered, for the specified
system.
-o
Executes the command without prompting for confirmation.
EXAMPLE #1
The following example shows sample output of the port -list command targeted to
Fibre Channel HBAs and SPs:
Note

The StorageGroup Name field displays None if the HBA is not explicitly mapped to a userdefined, a non-user defined, a null, a management, or a physical storage group.
naviseccli -h ss1_spa port -list
Information about each HBA:
HBA UID:
10:10:10:10:10:10:10:10:10:10:10:10:10:10:10:10

136

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Server Name:
matt
Server IP Address:
1.2.3.4
HBA Model Description: ModelABC
HBA Vendor Description:VendorABC
HBA Device Driver Name:N/A
Information about each port of this HBA:
SP Name:
SP A
SP Port ID:
0
HBA Devicename:
N/A
Trusted:
NO
Logged In:
NO
Defined:
YES
Initiator Type:
3
StorageGroup Name: Private
Information about each HBA:
HBA UID:
20:00:00:00:C9:21:FE:D5:10:00:00:00:C9:21:FE:D5
Server Name:
20:00:00:00:C9:21:FE:D5:10:00:00:00:C9:21:FE:D5
Server IP Address:
UNKNOWN
HBA Model Description:
HBA Vendor Description:
HBA Device Driver Name:
Information about each port of this HBA:
SP Name:
SP B
SP Port ID:
0
HBA Devicename:
Trusted:
NO
Logged In:
YES
Source ID:
7280384
Defined:
NO
Initiator Type:
128
StorageGroup Name: None
Information about each HBA:
HBA UID:
AA:01:34:11:22:33:44:44:72:68:01:38:01:21:42:53
Server Name:
dochost.example.com
Server IP Address: 10.10.10.1
HBA Model Description:
HBA Vendor Description:
HBA Device Driver Name:
Information about each port of this HBA:
SP Name:
SP A
SP Port ID:
0
HBA Devicename:
Trusted:
NO
Logged In:
NO
Defined:
YES
Initiator Type:
3
StorageGroup Name: Documentation
SP Name:
SP A
SP Port ID:
1
HBA Devicename:
Trusted:
NO
Logged In:
NO
Defined:
YES
Initiator Type:
3
StorageGroup Name: Documentation
Information about each HBA:
HBA UID:
20:00:00:00:C9:2B:53:D3:10:00:00:00:C9:2B:53:D3
Server Name:

port

137

VNX CLI for Block

20:00:00:00:C9:2B:53:D3:10:00:00:00:C9:2B:53:D3
Server IP Address: UNKNOWN
HBA Model Description:
HBA Vendor Description:
HBA Device Driver Name:
Information about each port of this HBA:
SP Name:
SP A
SP Port ID:
0
HBA Devicename:
Trusted:
NO
Logged In:
YES
Source ID:
1315328
Defined:
NO
Initiator Type: 128
Information about each HBA:
HBA UID:
00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF
Server Name: abc.example.com
Server IP Address: 10.10.10.2
HBA Model Description:
HBA Vendor Description:
HBA Device Driver Name:
Information about each port of this HBA:
SP Name:
SP A
SP Port ID:
0
HBA Devicename:
Trusted:
NO
Logged In:
NO
Defined:
YES
Initiator Type:
3
StorageGroup Name: PublicStorageGroup
Information about each SPPORT:
SP Name:
SP A
SP Port ID:
0
SP UID:
50:06:01:60:BC:E0:0C:12:50:06:01:63:3C:E0:0C:12
Link Status:
Up
Port Status:
Online
Switch Present:
YES
Switch UID:
10:00:00:05:1E:0E:E8:7B:20:1D:00:05:1E:0E:E8:7B
SP Source ID:
859648
I/O Module Slot:
Onboard
Physical Port ID:
2
SP Name:
SP A
SP Port ID:
1
SP UID:
50:06:01:60:BC:E0:0C:12:50:06:01:63:3C:E0:0C:12
Link Status:
Up
Port Status:
Online
Switch Present:
YES
Switch UID:
10:00:00:05:1E:0E:E8:7B:20:1D:00:05:1E:0E:E8:7B
SP Source ID:
859648
I/O Module Slot:
Onboard
Physical Port ID:
3
SP Name:
SP A
SP Port ID:
2
SP UID:
50:06:01:60:BC:E0:0C:12:50:06:01:63:3C:E0:0C:12
Link Status:
Up
Port Status:
Online
Switch Present:
YES
Switch UID:
10:00:00:05:1E:0E:E8:7B:20:1D:00:05:1E:0E:E8:7B
SP Source ID:
859648
I/O Module Slot:
Onboard
Physical Port ID:
4

138

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

SP Name:
SP A
SP Port ID:
3
SP UID:
50:06:01:60:BC:E0:0C:12:50:06:01:68:3C:E0:0C:12
Link Status:
Up
Port Status:
Online
Switch Present:
YES
Switch UID:
10:00:00:05:1E:0E:E8:7B:20:1D:00:05:1E:0E:E8:7B
SP Source ID:
859648
I/O Module Slot:
Onboard
Physical Port ID:
5

EXAMPLE #2
The following example shows sample output of the port -list -all command
targeted to Fibre Channel HBAs and SPs.
naviseccli -h ss1_spa port -list -all
Total number of initiators: 1
SP Name:
SP Port ID:
Registered Initiators:
Logged-In Initiators:
Not Logged-In Initiators:

SP A
1
0
0
0

SP Name:
SP Port ID:
Registered Initiators:
Logged-In Initiators:
Not Logged-In Initiators:

SP A
0
0
0
0

SP Name:
SP Port ID:
Registered Initiators:
Logged-In Initiators:
Not Logged-In Initiators:

SP B
1
0
0
0

SP Name:
SP Port ID:
Registered Initiators:
Logged-In Initiators:
Not Logged-In Initiators:

SP B
0
1
1
0

SP Name:
SP Port ID:
Registered Initiators:
Logged-In Initiators:
Not Logged-In Initiators:

SP A
2
0
0
0

SP Name:
SP Port ID:
Registered Initiators:
Logged-In Initiators:
Not Logged-In Initiators:

SP A
3
0
0
0

SP Name:
SP Port ID:
Registered Initiators:
Logged-In Initiators:
Not Logged-In Initiators:

SP B
2
0
0
0

SP Name:
SP Port ID:
Registered Initiators:
Logged-In Initiators:

SP B
3
0
0

port

139

VNX CLI for Block

Not Logged-In Initiators: 0
Information about each HBA:
HBA UID:
20:00:00:00:C9:5E:B8:FF:10:00:00:00:C9:5E:B8:FF
Server Name:
nlpc46123.us.dg.com
Server IP Address:
10.14.46.123
HBA Model Description: Emulex LightPulse HBA - Storport
Miniport Driver
HBA Vendor Description: Emulex
HBA Device Driver Name: elxstor
Information about each port of this HBA:
SP Name:
SP Port ID:
HBA Devicename:
Trusted:
Logged In:
Source ID:
Defined:
Initiator Type:
StorageGroup Name:
ArrayCommPath:
Failover mode:
Unit serial number:

SP B
0
\\.\SCSI3:0:0:0
NO
YES
8327680
YES
3
None
1
1
Array

EXAMPLE #3
The following example shows sample output of the port -list -hba command
targeted to an iSCSI HBA.
naviseccli -h IPAddress_SP port -list -hba
Information about each HBA:
HBA UID: iqn.1991-05.com.microsoft:nlpc20234
Server Name:
nlpc20234
Server IP Address: 25.24.23.235
HBA Model Description:
HBA Vendor Description:
HBA Device Driver Name:
Information about each port of this HBA:
SP Name:
SP Port ID:
HBA Devicename:
Trusted:
Logged In:
Source ID:
Defined:
Initiator Type:
StorageGroup Name:

SP A
0
\\.\SCSI2:0:0:1
NO
YES
4294967295
YES
3
StorageGrpnlpc20234

Information about each SPPORT:

140

SP Name:
SP Port ID:
SP UID:
Link Status:
Port Status:
Switch Present:

SP A
0
iqn.1992-04.com.emc:cx.apm00034901526.a0
Up
Online
Not Applicable

SP Name:
SP Port ID:
SP UID:
Link Status:
Port Status:
Switch Present:

SP A
1
iqn.1992-04.com.emc:cx.apm00034901526.a1
Down
Online
Not Applicable

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

SP Name:
SP Port ID:
SP UID:
Link Status:
Port Status:
Switch Present:

SP B
0
iqn.1992-04.com.emc:cx.apm00034901526.b0
Down
Online
Not Applicable

SP Name:
SP Port ID:
SP UID:
Link Status:
Port Status:
Switch Present:

SP B
1
iqn.1992-04.com.emc:cx.apm00034901526.b1
Down
Online
Not Applicable

EXAMPLE #4
The following example shows sample output of the port -list -mac command
targeted to an iSCSI system.
naviseccli -h 10.14.80.107 port -list -sp -mac
Information about each SPPORT:
SP Name:
SP Port ID:
SP UID:
Link Status:
Port Status:
Switch Present:
MAC Address:

SP B
0
iqn.1992-04.com.emc:cx.apm00034901792.b0
Down
Online
Not Applicable
00:60:16:01:83:AF

SP Name:
SP Port ID:
SP UID:
Link Status:
Port Status:
Switch Present:
MAC Address:

SP B
1
iqn.1992-04.com.emc:cx.apm00034901792.b1
Up
Online
Not Applicable
00:60:16:01:83:B1

SP Name:
SP Port ID:
SP UID:
Link Status:
Port Status:
Switch Present:
MAC Address:

SP A
0
iqn.1992-04.com.emc:cx.apm00034901792.a0
Down
Online
Not Applicable
00:60:16:01:82:89

SP Name:
SP Port ID:
SP UID:
Link Status:
Port Status:
Switch Present:
MAC Address:

SP A
1
iqn.1992-04.com.emc:cx.apm00034901792.a1
Up
Online
Not Applicable
00:60:16:01:82:8B

EXAMPLE #5
The following example shows sample output of the port -list -mac command
targeted to a Fibre Channel system.
naviseccli -h 10.14.5.202 port -list -sp -mac
Information about each SPPORT:
SP Name:
SP Port ID:

SP A
1

port

141

VNX CLI for Block

SP UID: 50:06:01:60:90:21:26:3D:50:06:01:61:10:21:26:3D
Link Status:
Up
Port Status:
Online
Switch Present: NO
MAC Address:
Not Applicable
SP Name:
SP A
SP Port ID:
0
SP UID: 50:06:01:60:90:21:26:3D:50:06:01:60:10:21:26:3D
Link Status:
Up
Port Status:
Online
Switch Present: YES
Switch UID:
10:00:08:00:88:60:8E:77:20:0D:08:00:88:60:8E:77
SP Source ID:
7998739
MAC Address:
Not Applicable
SP Name:
SP B
SP Port ID:
1
SP UID: 50:06:01:60:90:21:26:3D:50:06:01:69:10:21:26:3D
Link Status:
Up
Port Status:
Online
Switch Present: NO
MAC Address:
Not Applicable
SP Name:
SP B
SP Port ID:
0
SP UID: 50:06:01:60:90:21:26:3D:50:06:01:68:10:21:26:3D
Link Status:
Up
Port Status:
Online
Switch Present: YES
Switch UID:
10:00:08:00:88:60:8E:77:20:0C:08:00:88:60:8E:77
SP Source ID:
7998483
MAC Address:
Not Applicable

EXAMPLE #6
The following example shows sample output of the port -list -mac command
targeted to a Fibre Channel over Ethernet (FCoE) system that has FC(0,1,2,3), 1G
iSCSI(4,5), 10G iSCSI(6,7) and 10G FCoE(8,9) ports.
naviseccli -h peregrine-spa port -list -mac
Information about each SPPORT:
SP Name:
SP B
SP Port ID:
3
MAC Address:
Not Applicable

142

SP Name:
SP Port ID:
MAC Address:

SP B
2
Not Applicable

SP Name:
SP Port ID:
MAC Address:

SP B
0
Not Applicable

SP Name:
SP Port ID:
MAC Address:

SP B
1
Not Applicable

SP Name:
SP Port ID:
MAC Address:

SP A
3
Not Applicable

SP Name:
SP Port ID:

SP A
2

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

MAC Address:

Not Applicable

SP Name:
SP Port ID:
MAC Address:

SP A
0
Not Applicable

SP Name:
SP Port ID:
MAC Address:

SP A
1
Not Applicable

SP Name:
SP Port ID:
MAC Address:

SP B
4
00:60:16:1A:3B:C2

SP Name:
SP Port ID:
MAC Address:

SP B
5
00:00:00:00:00:00

SP Name:
SP Port ID:
MAC Address:

SP B
6
00:60:16:32:12:1C

SP Name:
SP Port ID:
MAC Address:

SP B
7
00:00:00:00:00:00

SP Name:
SP Port ID:
MAC Address:

SP A
4
00:60:16:1A:36:52

SP Name:
SP Port ID:
MAC Address:

SP A
5
00:00:00:00:00:00

SP Name:
SP Port ID:
MAC Address:

SP A
6
00:60:16:32:0E:8E

SP Name:
SP Port ID:
MAC Address:

SP A
7
00:00:00:00:00:00

SP Name:
SP Port ID:
MAC Address:

SP B
8
00:60:16:3B:47:B2

SP Name:
SP Port ID:
MAC Address:

SP B
9
00:60:16:3B:47:B3

SP Name:
SP Port ID:
MAC Address:

SP A
8
00:60:16:3B:55:42

SP Name:
SP Port ID:
MAC Address:

SP A
9
00:60:16:3B:55:43

EXAMPLE #7
The following example shows sample output of the port -list -sp -all command.
SP Name:
SP Port ID:
0
SP UID:
50:06:01:60:B6:60:02:DC:50:06:01:68:36:60:02:DC

SP B

port

143

VNX CLI for Block

Link Status:
Up
Port Status:
Online
Switch Present:
YES
Switch UID:
10:00:00:05:1E:E0:0B:E0:20:03:00:05:1E:E0:0B:E0
SP Source ID:
932096
ALPA Value:
0
Speed Value :
8Gbps
Auto Negotiable :
NO
Available Speeds:
2Gbps
4Gbps
8Gbps
Auto
Requested Value:
Auto
MAC Address:
Not Applicable
SFP State:
Online
Reads:
Writes:
0
Blocks Read:
0
Blocks Written:
0
Queue Full/Busy:
0
I/O Module Slot:
0
Physical Port ID:
0
Usage:
SFP/Connector EMC Part Number: 019-078-042
SFP/Connector EMC Serial Number: 000000000000000
SFP/Connector Vendor Part Number: N/A
SFP/Connector Vendor Serial Number: AGL1211D3004397
SFP/Connector Supported Speeds:
2Gbps
4Gbps
8Gbps

0

General

EXAMPLE #8
The following example shows sample output of the port -list -sfpstate
command targeted to FCoE ports, 10G iSCSI, and FC ports.
SPF Normal:
SP Name:
SP Port ID:
SP UID:
Link Status:
Port Status:
Switch Present:
SFP State:

SP A
11
50:06:01:60:16:21:02:B6:50:06:01:60:16:25:02:B6
Down
DISABLED
NO
Online

SFP Faulted:
SP Name:
SP Port ID:
SP UID:
Link Status:
Port Status:
Switch Present:
SFP State:

SP A
8
50:06:01:60:BB:20:13:0D:50:06:01:68:3B:24:13:0D
Down
DISABLED
NO
Faulted

EXAMPLE #9
The following example shows the output for the port –list –prominfo command.
Information about each SPPORT:
SP Name:
SP Port ID:

144

SP A
2

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

SFP/Connector
SFP/Connector
SFP/Connector
SFP/Connector
SFP/Connector
2Gbps
4Gbps
8Gbps
SP Name: SP A
SP Port ID: 3
SFP/Connector
SFP/Connector
SFP/Connector
SFP/Connector
SFP/Connector
2Gbps
4Gbps
8Gbps
…

EMC Part Number:
EMC Serial Number:
Vendor Part Number:
Vendor Serial Number:
Supported Speeds:

TBD
TBD
TBD
TBD

EMC Part Number:
EMC Serial Number:
Vendor Part Number:
Vendor Serial Number:
Supported Speeds:

TBD
TBD
TBD
TBD

powersaving
Enables or disables the power saving settings.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli powersaving command allows you to enable or disable power
saving settings on a system. It displays the system's idle time and the status of the power
saving settings.
SYNTAX
powersaving -globalsettings [-o] [on|off]
-info [-systemidletime] [-globalpowersavingsettings]
OPTIONS
-globalsettings
Enables or disables power saving settings on a system. The system sends a
confirmation message only when you specify the -o switch.
The following message is displayed, if the settings are turned on:
Turning global power saving settings on will spin down all
eligible unused disks and all power saving settings on
Storage Pools will take effect. Do you want to proceed?
The following message is displayed, if the settings are turned off:
Turning global power saving settings off will allow all
drives spinning up to normal. Do you want to proceed?
-info [-systemidletime] [-globalpowersavingsettings]
Displays the system idle time and the status of the global power saving settings.
EXAMPLE
naviseccli -h IP address powersaving -info
System Idle Time: 15 min
Global Power Saving Settings: On

powersaving

145

VNX CLI for Block

rebootSP
Reboots an SP.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
This command reboots one or both SPs. If you omit switches, the current SP is rebooted.
Note

If rebootSP is executed while I/O processes are active, I/O errors may occur and/or the
Unisphere agent process may hang. If the agent process hangs, you must reboot the host
on which the Unisphere agent is running. If you are binding LUNs assigned to one SP, you
should not reboot the peer SP until the binding process has completed. Otherwise, until
the binding process is completed, you will see error messages each time the SP is polled.
Note

See the rebootpeerSP command, to reboot the peer SP of the target SP.
SYNTAX
rebootSP [-both] [-o]
OPTIONS
-both
Reboot both SPs.
Note

If write cache is enabled, it is not allowed to reboot both SPs unless you disable
write cache first or use -o option to override the warning and reboot directly.
-o
Executes the command without prompting for confirmation.
EXAMPLE #1
naviseccli -h ss1_spa rebootSP
WARNING: This operation will reboot the target SP.
Verify that the SPS on the surviving SP is operating correctly.
Otherwise write cache must be disabled:
naviseccli -h IPAddress cache -sp -modify -wc off.
Failure to disable write cache may result in the loss of data.
DO YOU WISH TO CONTINUE? (y/n)

EXAMPLE #2
naviseccli -h ss1_spa rebootSP -both
Error: rebootSP command failed
Before you can execute the rebootSP command, you need to either
disable write cache or override the warning.
To disable write cache, run the “naviseccli -h IPAddress cache -sp
-modify -wc off” command.
To override the warning and reboot both SPs directly, run the
“rebootSP -both -o” command.

146

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

OUTPUT
There is no output. Errors are printed to stderr.

rebootpeerSP
Reboots a peer SP.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
Lets you reboot the peer SP of the target SP in a dual-SP system. For the rebootpeerSP
command, the peer SP is the SP on the system to which the command is not targeted.
Note

See the rebootSP command, to reboot the target SP or both SPs on the system.
SYNTAX
rebootpeerSP [-o]
OPTIONS
-o
Executes the command without prompting for confirmation.
EXAMPLE
The following example reboots the peer SP of the target SP. The target SP is ss1_spa;
the peer SP is ss1_spb.
naviseccli -h ss1_spa rebootpeerSP
WARNING: This operation will reboot the target SP.
Verify that the SPS on the surviving SP is operating correctly.
Otherwise write cache must be disabled:
naviseccli -h IPAddress cache -sp -modify -wc off.
Failure to disable write cache may result in the loss of data.
DO YOU WISH TO CONTINUE? (y/n)

remoteconfig -getconfig
Displays information about a host or SP agent.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The remoteconfig command displays and sets agent configuration information. An
agent can be any host agent or SP agent. These commands let you get and set the
configuration of the agent running on a remote host, scan all the devices in the system on
a remote host, and stop the agent running on a host.
Note

If you are running VMware ESX Server and issuing this command to a virtual machine
(VM), it cannot target the host agent because the Unisphere Host Agent is supported only
on ESX Server.

rebootpeerSP

147

VNX CLI for Block

The naviseccli remoteconfig command with -getconfig displays information
on the agent running on an SP. To display information on the agent for the specified host,
see server -remoteconfig on page 289. If you omit switches, the command displays all
agent information. You can request specific information with switches.
To write the agent information to a file, use the -write filename switch. If you use write, the CLI writes all information to the file; you cannot select specific information
with switches. If a file with the same name exists, the CLI will verify to overwrite.
Note

After listing agent information, you can change the agent settings with the
remoteconfig -setconfig command.
SYNTAX
remoteconfig -getconfig [-description] [-contact] [-users]
[-interval] [-write filename]
OPTIONS
-description
Displays contents of the description field.
-contact
Displays contents of the contact field.
-users
Displays contents of the users field.
-interval
Displays contents of the polling interval field.
-write filename
Writes an image of the configuration file as it exists on the host or SP to file filename.
The file is written in the same format as the agent.config file, which differs from
the output of the getconfig function without the -write switch. You can use this
file to set the configuration for other agents using the remoteconfig setconfig
-f filename function. No other switch is allowed with -write.
EXAMPLE
This command lists all agent information.
naviseccli -h ss1_spa remoteconfig -getconfig

OUTPUT
See remoteconfig -getconfig on page 147. If the version of VNX OE for Block software
running on the SP does not support this command, a Not supported error message is
printed to stderr. Other errors:
RAC_AGENT_NOT_RUNNING

remoteconfig -setconfig
Changes configuration information for a host or SP agent.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli remoteconfig command with -setconfig changes the
configuration information for the agent running on an SP. To change configuration
148

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

information for the agent running on the specified host, see server -remoteconfig on page
289.
Note

The comments in the host agent configuration file are removed. When your changes to
the configuration file take effect, comments that previously resided in the file are
permanently lost.
The CLI prompts for confirmation of every change you specify unless you use the -o
(override) or -f switch. To change the setting for the agent, enter y. The confirmation
queries for all settings are as follows.
Change host description from old to new  [y]?
Change contact information from old to new  [y]?
Add user in the authorized user list [y] ?
Remove user from the authorized user list [y] ?
Change polling interval to new-interval [y] ?

To have the CLI obtain the agent information from a file (perhaps a file written with the
getconfig -write function), use the -ffilename switch. Only the -o (override) switch
is allowed with the -f switch.
You can use the -getconfig function to see how settings are formatted. Make sure that
your entries are valid for the agent you are configuring. A wrong setting can make an
agent inaccessible.
SYNTAX
remoteconfig -setconfig [-o] [-adduser userlist] [-contact
contactinfo] [-description description] [-f filename][-interval
interval] [-rmuser userlist]
OPTIONS
-o
Executes the command without prompting for confirmation.
-adduser userlist
Adds the users specified in userlist to the authorized user list. The user name form is
username@hostname. Separate the user entries with a space.
-contact contactinfo
Specifies new contact information for the agent description field.
-description description
Specifies new contents for the agent description field.
-f filename
Reads the configuration information from file filename. This file must be in the
correct format (same as the agent configuration file used in earlier Unisphere
revisions). The -getconfig -write command automatically creates files in the
correct format. When you use -f, the CLI does not prompt for confirmation; the -o
switch is not needed.
-interval interval
Changes the polling interval in seconds to interval. The valid range is 1 to 120. This
switch may not apply to all system types.
-rmuser userlist
Removes the specified users from the authorized user list.
remoteconfig -setconfig

149

VNX CLI for Block

EXAMPLE
This command adds the user tsjones on host viking to the agent privileged users
list.
naviseccli -h ss1_spa remoteconfig -setconfig -adduser tsjones@viking
Add tsjones@viking in the authorized user list [y]?

OUTPUT
See remoteconfig -getconfig on page 147. If the version of VNX OE for Block software
running on the SP does not support this command, a Not supported error message is
printed to stderr. Other errors:
RAC_AGENT_NOT_RUNNING
RAC_REMOTECONFIG_NOT_SUPPORTED
INVALID_MEGAPOLL
INVALID_USEEXPLICITDEVNAME
RAC_FILE_NOT_FOUND

removerg
Removes a RAID group.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli removerg command removes a specified RAID group.
Note

This command cannot remove thin pools.
SYNTAX
removerg rgID
OPTIONS
rgID

RAID group identification number. rgID specifies a number between 0 and the
maximum number of RAID groups supported by the RAID group system.
EXAMPLE
This command removes RAID group 1.
naviseccli -h ss1_spa removerg 1

resetandhold
Resets an SP and holds the reboot following the power on self tests (POST).
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli resetandhold command, resets an SP and holds the reboot
following the power on self tests (POST), to allow an SP to be reset in a safe manner for
systems where pulling and reseating the SP is not permitted during operation. Because

150

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

the boot process is held, a subsequent rebootpeerSP command must be issued to
clear the hold and reboot the SP, to return the SP to service.
Note

Issue rebootpeerSP after you issue resetandhold, when you are ready to return the
SP to service.
SYNTAX
resetandhold
EXAMPLE
The following example resets and holds the reboot for the targeted SP on the system.
naviseccli -h ss1_spa resetandhold
This operation will cause the system to reset and
then hold the reboot process following the Power On Self
Tests (POST). To clear the hold state and complete the SP reboot,
a rebootpeersp command must be issued to the peer SP.
DO YOU WISH TO CONTINUE?

(y/n)?

responsetest
Tests Event Monitor response.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli responstest command creates an artificial event to test event
monitor response.
The responsetest command is designed for use without the event monitor User
Interface (UI). That is, you can use responsetest in conjunction with the event monitor
template file, navimon.cfg, which you can edit to specify the event monitor responses
you want. If you have used the event monitor UI to set up an event monitor template, do
not use this command.
Event monitor functions accessed via responsetest are decentralized, providing email
and pager support from local systems only. The EMC phone home feature is not available
via this command.
SYNTAX
responsetest -email response-parameters| -emailpage responseparameters | -modempage response-parameters |
-snmp response-parameters
OPTIONS
response-parameters
Allows different parameters for each type of response you specify, as follows:
-email
-smtpmailserver smtpmailserver_hostname
Specifies the SMTP mail server; required.
-destaddress destination_email_address
Specifies the destination email address; required.
[-subject "text"]
The text, within quotation marks, specifies the subject of the email; optional.
responsetest

151

VNX CLI for Block

[-cc destination_email_address]
The email address to send a cc (copy) to; optional.
[-message "text" | -file filename]
The text, in quotation marks, describes the event; optional. Or you specify a file with
descriptive text using -file.
[-sender sender_email_address]
Specifies the sender address; optional. If omitted, CLI inserts the agent hostname as
the sender_email_address.
-emailpage
-smtpmailserver smtpmailserver_hostname
Specifies the SMTP mail server; required.
-destaddress destination_email_address
Specifies the destination email address; required.
[-subject "text" ]
The text, within quotation marks, specifies the subject of the email; optional.
[-cc destination_email_address]
The email address to send a cc (copy) to;
[-message "text" | -file filename]
The text, in quotation marks, describes the event; optional. Or you specify a file with
descriptive text using -file.
[-sender sender_email_address]
Specifies the sender address; optional. If omitted, CLI inserts the agent hostname as
the sender_email_address.
-modempage
(Not supported on AX4-5 series and AX series)
-destnumber phone-number
Specifies the pager phone number (with area code) and is required.
-msgnumber phone-number
Specifies the number that will appear on the pager display (with area code).
[ -comport number ]
Specifies the number of the PC COM. If omitted, the CLI assumes COM l; optional.
[ -messagedelay seconds ]
Specifies the delay between sending the destination phone number to the modem
and sending the message to the modem. This allows enough time for the receiving
modem to answer the call. Optional.
[ -dialcommand command]
Specifies the modem dial command to be used by the agent. Optional.
[ -initcommand command-to-modem ]
Specifies the modem dial command to be used by the agent. The initcommand
allows for some custom modem configuration before the data is sent to it. Optional.
-community community
Specifies a community on the snmp managment host; optional.
-desthost destination-hostname
Specifies an snmp management hostname; required.
-device device
Specifies the device represented by the snmp management host. Required.
EXAMPLE
This command sends a modem page test event.
naviseccli -h ss1_spa responsetest modempage -destnumber -msgnumber

OUTPUT
Result of the test.
152

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

sc_off
Disables data access control.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli sc_off command disables data access control and turns off shared
storage features. You can use this command to reset the system to its factory unshared
storage settings.
CAUTION

Be aware that executing sc_off resets the system to its factory unshared storage
settings, permanently destroying all previously implemented shared storage features.
SYNTAX
sc_off [-o]
OPTIONS
-o
Executes the command without prompting for confirmation.
EXAMPLE
naviseccli -h ss1_spa sc_off

OUTPUT
The first time you run the sc_off command, you will see an output similar to the
following:
You have asked to remove all shared storage components
from the indicated system.
The following functions will be performed, if necessary:
Clear the system's password
Turn fairness off
Set the default storage group to ~physical
Remove all initiator records
Remove all user defined storage groups
Do you wish to proceed? (y/n)? y
Clearing the system's password
Old Password: ***
Turning fairness off
Setting the default storage group to ~physical
Removing all initiator records
Removing all user defined storage groups

If you run the command a second time, and the first time through completed
successfully, the output will be as follows:
You have asked to remove all shared storage components
from the indicated system.
The following functions will be performed, if necessary:
Clear the system's password
Turn fairness off
Set the default storage group to ~physical

sc_off

153

VNX CLI for Block

Remove all initiator records
Remove all user defined storage groups
Do you wish to proceed? (y/n)? y

setfeature
Adds a software feature to a LUN controlled by an SP.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli setfeature command adds and removes a software driver feature
to a LUN owned by an SP.
SYNTAX
setfeature -on|-off -feature feature -lun lun| -lunuid uid
OPTIONS
-on or -off
Adds or removes the feature.
-feature feature
Identifies the feature; for example, RM for remote mirroring and sancopy for SAN
Copy.
-lun lun or -lunuid uid
Specifies the LUN. You can use the LUN number or the LUN unique ID, UID (which is
the World Wide Name, WWN).
OUTPUT
If the version of VNX OE for Block software running on the SP does not support this
command, a Not supported error message is printed to stderr. Other errors:
COMMAND_NOT_SUPPORTED
FEATURE_REQUIRED
LUN_AND_LUNUID_SPECIFIED

setsniffer
Starts a background verify process or changes verify process parameters.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli setsniffer command starts a background verify process or
changes the parameters for the verify process. You can indicate a specific LUN, all LUNs
in a RAID group, or all LUNs in a system.
Note

The setsniffer command does not support thin LUNs.
SYNTAX
setsniffer lun-number| [-rg rg-number] [-all] [-bv] [-cr]

154

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

OPTIONS
-all
Applies sniffer parameters to all LUNs in the system. The target SP must own one
LUN at minimum.
lun-number
Applies sniffer parameters to the specified LUN. lun specifies the logical unit
number. You must target the SP that owns the specified LUN.
-rg rg-number
Applies sniffer parameters to all LUNs in the specified RAID group.
-bv
Starts a full unit background verify.
-cr
Clears background verify reports.
EXAMPLE
Starts a background verify on LUN 0.
naviseccli setsniffer 0 -bv

OUTPUT
There is no output. Errors are printed to stderr.

setsniffverify
Enables or disables sniff verify on all the disks on the array.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli setsniffverify command can enable or disable sniff verify on all
the disks on the array, including bound and unbound region. This command with no
option displays the current sniff verify state.
SYNTAX
setsniffverify [-on | -off]
OPTIONS
–on | off
Enables or disables sniff verify on all dissk.
-on
Enables sniff verify on all disks.
-off
Disables sniff verify on all disks.
EXAMPLE #1
This example enables the disk based sniff verify. There is no output. Errors are printed to
stderr.
naviseccli setsniffverify -on

setsniffverify

155

VNX CLI for Block

EXAMPLE #2
If no option is provided, the command will display the current sniff verify state.
naviseccli setsniffverify
sniffverify is ENABLED

setspstime
Sets SPS or BBU battery test time.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli setspstime command sets the SPS battery test time. If no switches
are specified, the command returns the current SPS battery test time. The SPS test time is
displayed for the client's time zone.
SYNTAX
setspstime [-d day-num] [-h hour-num] [-m minute-num]
[-nolocal]
OPTIONS
-d day-num
Sets the day of the week (0-6, 0=Sunday).
-h hour-num
Sets the hour of the day (0-23, 0=12:00 AM).
-m minute-num
Sets the minute of the hour (0-59).
Note

To set the SPS or BBU test time, all switches must be specified.
-nolocal
The SPS test time is displayed for the client's time zone.
Note

-nolocal is required if your system is communicating with a host agent version
less than 6.5. You cannot use this switch with version 6.5 or higher.
EXAMPLE
This example sets the SPS battery test time to Sunday at 1:00 AM.
naviseccli -h ss1_spa setspstime -d 0 -h 1 -m 0

OUTPUT
There is no output. Errors are printed to stderr.

setsptime
Sets the SP system clocks.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
156

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

DESCRIPTION
The naviseccli setsptime command sets the system time for both SPs.
SYNTAX
setsptime [-M month-num] [-D day-num] [-Y year-num]
[-h hour-num ] [-m minute-num]
OPTIONS
-M month-num
Specifies the month (1-12).
-D day-num
Specifies the day (1-31).
-Y year-num
Specifies the year; use four digits.
-h hour-num
Specifies the hour (0-23).
-m minute-num
Specifies the minute (0-59).
EXAMPLE
This example sets the SP system clock to March 13, 2002, 9:00 am.
naviseccli -h data1_spa setsptime -M 3 -D 13 -Y 2002 -h 9

OUTPUT
There is no output. Errors are printed to stderr.

setstats
Sets statistics logging.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli setstats command sets statistics logging. If no optional switches
are present, the command returns the current state of statistics logging. The SP maintains
a log of statistics for the LUNs, disk modules, and system caching that you can turn on
and off. When enabled, logging affects system performance, so you may want to leave it
disabled unless you have a reason to monitor performance.
The log uses a 32-bit counter to maintain the statistics numbers. When the counter is full,
the statistics numbers restart at zero. As a result, you will see a sudden decrease in a
statistics number if you view it shortly before the counter is full and shortly after the
counter restarts at zero. If you want to keep the log turned on for more than two weeks,
we recommend that you reset the log about every two weeks, so you know when the
numbers start at zero.
The command affects only the SP you specify.
SYNTAX
setstats -on|-off [-powersavings] [-on|-off]
OPTIONS
setstats -on|-off
Enables/disables the performance statistics logging.
setstats

157

VNX CLI for Block

Note

If statistics logging is off, certain options in other commands are disabled. The
options for the other commands specify whether statistics logging must be on for
their options to be valid.
-powersavings
Enables/disables the disk spin-down statistics logging. It affects only the disk spindown statistics.
-on|-off
Returns the current state of power saving statistics logging.
EXAMPLE
The sample output is as follows:
naviseccli -h ss1_spa setstats -on
naviseccli -h ss1_spa setstats -powersavings
Disk Spin Down statistics logging is DISABLED
OR
Disk Spin Down statistics logging is ENABLED
Start Power Savings Log Timestamp: xx/xx/xxxx xx:xx:xx

OUTPUT
There is no output. Errors are printed to stderr.

shutdown
Shuts down and powers off the system.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli shutdown command shuts down and powers off the system you
specify.
SYNTAX
shutdown [-o]
OPTIONS
-o
Executes the command without prompting for confirmation.
EXAMPLE
This command shuts down and powers off the specified system.
naviseccli -h ss1_spa shutdown
Before you shutdown the system, stop all I/O from
any servers connected to the system and save all
unsaved data to disk. During the shutdown process you
will lose access to all data on the LUNs but you will not
lose any data. When you power up the system you
will regain access to the LUNs.

158

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Do you want to shutdown and power off the subsystem now
(y/n)?

OUTPUT
None if the command succeeds; status or error information if it fails.

shutdownsp
Shuts down and powers off the current SP.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli shutdownsp command shuts down the current storage processor
(SP) of the system.
SYNTAX
shutdownsp [-o]
OPTIONS
-o
Executes the command without prompting for confirmation. The confirmation
message varies depending on the system.
EXAMPLE
The confirmation message for a VNX system is as follows:
WARNING: This operation will shutdown the SP and hold it in reset.
Verify that SPS on the surviving SP is operating correctly.
Otherwise write cache must be disabled: naviseccli -h IPAddress
cache -sp -modify -wc off.
To reconnect please reboot the SP - this can be accomplished by
using the
rebootpeerSP command.
Do you want to shutdown and hold the SP now? (y/n) ?

OUTPUT
None if the command succeeds; error information if used with any other system.

shutdownpeersp
Shuts down and powers off the peer SP.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli shutdownpeersp command shuts down the peer storage processor
(SP).
SYNTAX
shutdownpeersp [-o]
OPTIONS
-o
Executes the command without prompting for confirmation.
shutdownsp

159

VNX CLI for Block

The confirmation message varies depending on the system.
EXAMPLE
The confirmation message for a VNX system is as follows:
WARNING: This operation will shutdown the SP and hold it in reset.
Verify that SPS on the surviving SP is operating correctly.
Otherwise write cache must be disabled: naviseccli -h IPAddress
cache -sp -modify -wc off.
To reconnect please reboot the SP - this can be accomplished by
using the
rebootpeerSP command.
Do you want to shutdown and hold the SP now? (y/n) ?

OUTPUT
None if the command succeeds; error information if used with any other system.

spcollect -info
Displays the setting of the automated SPCollect service.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli spcollect command with the -info function lets you display the
setting of the automated SPCollect functionality. The setting appears as Enabled when
the SPCollect automated functionality is turned on; Disabled when it is turned off.
The automated SPCollect service is part of the Peerwatch service included with VNX OE
for Block version 02.19.xxx.5.yyy or higher.
SYNTAX
spcollect -info
EXAMPLE
This command shows you the setting of the automated SPCollect functionality for the
specified system. The Enabled setting, indicating that the SPCollect process is turned on,
appears in the output above.
naviseccli -address ss\1_spa spcollect -info

OUTPUT
AutoExecution: Enabled

spcollect -set
Sets the automated SPCollect service on or off.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli spcollect command with the -set function lets you set the
automated SPCollect process on or off.
The automated SPCollect service is part of the Peerwatch service included with VNX OE
for Block version 02.19.xxx.5.yyy or higher.

160

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Note

Use spcollect -info to verify whether the service is enabled or disabled.
SYNTAX
spcollect -set

-auto on|off

[-o]

OPTIONS
-auto on|off
Sets the automated SPCollect process on or off. If you indicate on, it turns the
automation service on; if you indicate off, it turns the automation service off.
-o
Executes the command without prompting for confirmation.
EXAMPLE
This command turns the automated SPCollect process on.
naviseccli -address ss1_spa spcollect -set -auto on

OUTPUT
None if the command succeeds; status or error information if it fails.

spcollect
Selects and places a collection of system log files into a single .zip file.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli spcollect command selects a collection of system log files and
places them in a single .zip file on the system. You can retrieve the file from the system
using the managefiles command.
Note

This command is not related to the automated SPCollect service that is part of the
Peerwatch service included with VNX OE for Block version 02.19.xxx.5.yyy or higher. This
command lets you run the SPCollect functionality separate from the scheduled service.
See the spcollect -set command to enable or disable the automated SPCollect
service.
NOTICE

The SPCollect functionality can affect system performance (may degrade system
performance).
SYNTAX
spcollect
EXAMPLE
This example creates a .zip file on the system, which contains system log files.
The .zip file has the following format:
arrayserialnumber_SPx_date_time_spsignature_data.zip
naviseccli -h ss1_spa spcollect

arrayserialnumber Is the system serial number.
spcollect

161

VNX CLI for Block

x Is SP A or B.
date Is the date of collection.
time Is the time of collection.
spsignature Is the SP signature

OUTPUT
There is no output. Errors are printed to stderr.

spportspeed
Set or get the SP port speed.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli spportspeed command gets or sets the SP port speed. You can set
the port speed on either SP directly or through the other SP. The port speed you can set
and the options available depend upon your system type.
For a port speed to work, the HBA, switch, and SP must all support it. You can set the
ports of an SP to different speeds if the ports connect to switches or HBAs with different
speeds.
CAUTION

Incompatible port speeds will prevent the two devices from communicating. The CLI
prompts for confirmation as follows before executing the -set command.
Changing the port speed is a disruptive function. Verify that
the other device connected to the system, supports the new
speed. If the speed settings are incompatible, the system will
be unable to communicate with the other connected device. Are
you sure you want to change speed of SP x Port n from n Gigabit
to n Gigabit ?
SYNTAX
spportspeed -get [-isauto] [-avail] [-requested] [-type]
[-physical] [-sfp] [-all] -set -sp a|b
-portid portid speed [-o]
OPTIONS
-isauto
Indicates whether the Auto-Negotiate feature is turned on or off. The CLI returns a yes
value if the feature is turned on, a no value if the feature is turned off, and a not
supported value if the feature is not supported.
Note

If you have the Auto-Negotiate feature turned on, the Speed Value that is generated
in the output does not have a value of auto. The value reflects the speed at which
the port is currently operating. If you have the Auto-Negotiate feature turned on and
you specify the -requested switch, the Requested Value displays a value of auto.
-avail
162

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Indicates the available speeds for a specified port.
-requested
Displays the speed requested through spportspeed -set. The speed that is
requested may not equal the actual speed of the port. For example when the AutoNegotiate feature is turned on, the Requested Value displays auto and the Speed
Value displays the speed at which the port is currently operating.
-type
Displays the connection type (Fibre Channel or iSCSI) for each port along with the
speeds.
-physical (CX series only)
Displays the physical location of the port.
or
-sp a|b
Specifies the SP on which to set the port speed ( a|b).
-portid portid speed
portid specifies the port on the SP (0, 1, 2, or 3).
speed specifies the port speed: See the note above. For Fibre Channel systems, port
speed is 1 for 1 Gb mode, 2 for 2 Gb mode, 4 for 4 Gb mode, auto to initiate the
Auto-Negotiate feature. For iSCSI systems, port speed is 10 for 10 Mb mode, 100 for
100 Mb mode, 1000 for 1000 Mb mode, auto to initiate the Auto-Negotiate feature.

-o
Executes the command without prompting for confirmation.
EXAMPLE #1
naviseccli -h ss1__spa spportspeed -get -physical
Storage Processor :
SP A
Port ID :
0
Speed Value :
8Gbps
Auto Negotiable :
Yes
Available Speeds:
2Gbps
4Gbps
8Gbps
Auto
Requested Value:
Auto
Connection Type:
Fibre Channel
I/O Module Slot:
Onboard
Physical Port ID:
2
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps
Storage Processor :
SP A
Port ID :
1
Speed Value :
8Gbps
Auto Negotiable :
Yes
Available Speeds:
2Gbps
4Gbps
8Gbps
Auto
Requested Value:
Auto
Connection Type:
Fibre Channel
I/O Module Slot:
Onboard
Physical Port ID:
3
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps

spportspeed

163

VNX CLI for Block

Storage Processor :
SP A
Port ID :
2
Speed Value :
8Gbps
Auto Negotiable :
Yes
Available Speeds:
2Gbps
4Gbps
8Gbps
Auto
Requested Value:
Auto
Connection Type:
Fibre Channel
I/O Module Slot:
Onboard
Physical Port ID:
4
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps
Storage Processor :
SP A
Port ID :
3
Speed Value :
8Gbps
Auto Negotiable :
Yes
Available Speeds:
2Gbps
4Gbps
8Gbps
Auto
Requested Value:
Auto
Connection Type:
Fibre Channel
I/O Module Slot:
Onboard
Physical Port ID:
5
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps

EXAMPLE #2
naviseccli spportspeed -get –sfp
Storage Processor : SP A
Port ID : 0
Speed Value : 8Gbps
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps
Storage Processor : SP A
Port ID : 1
Speed Value : 8Gbps
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps
Storage Processor : SP A
Port ID : 2
Speed Value : N/A
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps
Storage Processor : SP A
Port ID : 3

164

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Speed Value : N/A
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps
Storage Processor : SP B
Port ID : 0
Speed Value : N/A
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps
Storage Processor : SP B
Port ID : 1
Speed Value : 8Gbps
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps
Storage Processor : SP B
Port ID : 2
Speed Value : N/A
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps
Storage Processor : SP B
Port ID : 3
Speed Value : N/A
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps

EXAMPLE #3
naviseccli spportspeed -get –all
Storage Processor : SP A
Port ID : 0
Speed Value : 8Gbps
Auto Negotiable : No
Available Speeds:
2Gbps
4Gbps
8Gbps
Auto
Requested Value: Auto
Connection Type: Fibre Channel
I/O Module Slot: 0
Physical Port ID: 0
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps
Storage Processor : SP A
Port ID : 1
Speed Value : 8Gbps
Auto Negotiable : No
Available Speeds:
2Gbps
4Gbps

spportspeed

165

VNX CLI for Block

8Gbps
Auto
Requested Value: Auto
Connection Type: Fibre Channel
I/O Module Slot: 0
Physical Port ID: 1
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps
Storage Processor : SP A
Port ID : 2
Speed Value : N/A
Auto Negotiable : No
Available Speeds:
2Gbps
4Gbps
8Gbps
Auto
Requested Value: 4Gbps
Connection Type: Fibre Channel
I/O Module Slot: 0
Physical Port ID: 2
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps
Storage Processor : SP A
Port ID : 3
Speed Value : N/A
Auto Negotiable : No
Available Speeds:
2Gbps
4Gbps
8Gbps
Auto
Requested Value: 4Gbps
Connection Type: Fibre Channel
I/O Module Slot: 0
Physical Port ID: 3
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps
Storage Processor : SP B
Port ID : 0
Speed Value : N/A
Auto Negotiable : No
Available Speeds:
2Gbps
4Gbps
8Gbps
Auto
Requested Value: 4Gbps
Connection Type: Fibre Channel
I/O Module Slot: 0
Physical Port ID: 0
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps
Storage Processor : SP B
Port ID : 1
Speed Value : 8Gbps

166

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Auto Negotiable : No
Available Speeds:
2Gbps
4Gbps
8Gbps
Auto
Requested Value: Auto
Connection Type: Fibre Channel
I/O Module Slot: 0
Physical Port ID: 1
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps
Storage Processor : SP B
Port ID : 2
Speed Value : N/A
Auto Negotiable : No
Available Speeds:
2Gbps
4Gbps
8Gbps
Auto
Requested Value: 4Gbps
Connection Type: Fibre Channel
I/O Module Slot: 0
Physical Port ID: 2
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps
Storage Processor : SP B
Port ID : 3
Speed Value : N/A
Auto Negotiable : No
Available Speeds:
2Gbps
4Gbps
8Gbps
Auto
Requested Value: 4Gbps
Connection Type: Fibre Channel
I/O Module Slot: 0
Physical Port ID: 3
SFP Supported Speeds:
2Gbps
4Gbps
8Gbps

EXAMPLE #4
naviseccli -h ss1_spa spportspeed -set -sp a -portid 0 2
Changing the port speed is a disruptive function. Verify
that the other device connected to the system,
supports the new speed. If the speed settings are
incompatible, the system will be unable to
communicate with the other connected device.
Are you sure you want to change speed of SP A Port n from
1 Gigabit to 2 Gigabit ? y

OUTPUT
If the version of VNX OE for Block software running on the SP does not support this
command, a Not supported error message is printed to stderr.
spportspeed

167

VNX CLI for Block

storagegroup
Creates and configures storage groups.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli storagegroup command lets you create and manage shared
systems, that is, systems that use storage groups and have the storage group option. For
most command operations, the CLI prompts for confirmation unless you use the -o
switch.
You can use the CLI command storagegroup -connecthost to assign a storage
group to all HBAs in a host, or the command storagegroup -setpath to assign a
storage group to a specific HBA in a host. To change the settings of a storage group that
is already assigned, use the command storagegroup -sethost. To disconnect a
host from all its storage groups, use storagegroup -disconnecthost.
The storagegroup command has many switches, some of which have functions that
you also indicate with switches.
SYNTAX
storagegroup [-addhlu switches] |
[-addsnapshot switches] |
[-chgname switches] |
[-connecthost switches] |
[-create switch] |
[-destroy switch]|
[-disconnecthost switch] |
[-enable] |
[-list switches] |
[-removehlu switches] |
[-removesnapshot switches] |
[-sethost switches] |
[-setpath switches] |
[-shareable switch] |
OPTIONS
storagegroup command, -addhlu switch -addhlu -gname
StorageGroupName| -uid StorageGroupUID -hlu hlunumber -alu alunumber
Adds a host LUN to a storage group. This command requires a bound LUN. If
required, use the bind command to create a LUN. You must use -gname or -uid
and two other switches with -addhlu as follows. Also, see the example in
unbind on page 181.
-gname StorageGroupName
Specifies the name of the storage group.
-uid StorageGroupUID
Specifies the storage group unique identification number.
l
For Fibre Channel systems, the UID uses the World Wide Name (WWN)
format such as: 10:00:00:00:C9:20:DE:0C:10:00:00:00:C9:20:DE:0C.
l
For iSCSI systems, the UID uses the initiator name which uses the IQN
format such as: iqn.1992-04.com.emc:cx.apm00034901792.b0.
168

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

-hlu hlunumber
Specifies the host LUN number, which is the number that the system server will
see. hlunumber is the virtual LUN number. (Virtual LUN numbers let a host
whose operating system has LUN limit or LUN booting restrictions use a number
other than the actual system LUN ID (-alu below), which might be out of the
operating system’s range, to access a LUN.) This switch is required along with alu and either the-gname or -uid switch.
If you have not assigned a host LUN number of 0 and if the arraycommpath
setting is 1, then after the bus is rescanned, the system will display an entry for
LUN 0 even though you have not assigned a host LUN 0. This occurs because
the arraycommpath setting of 1 creates a virtual LUN 0 for communication
with the system.
-alu alunumber
Specifies the system LUN number, the actual LUN number internal to the
system. This is the number assigned when the LUN was bound. alunumber
specifies the logical unit number. This switch is required along with -hlu and
either the -gname or -uid switch.
storagegroup command, -addsnapshot switch -addsnapshot -gname
StorageGroupName| -uid StorageGroupUID -hlu hlunumber -snapshotname
snapshotname| -snapshotuid snapshotuid
Adds a snapshot to a storage group. The storage group you choose should be
different from the source LUN storage group. You must use three of the following
switches with -addsnapshot:
-gname StorageGroupName
Sets the name of the storage group. StorageGroupName specifies a user-defined
storage group name; or
-uid StorageGroupUID
Specifies the storage group unique identification number.
l

l

For Fibre Channel systems, the UID uses the World Wide Name (WWN)
format such as: 10:00:00:00:C9:20:DE:0C:10:00:00:00:C9:20:DE:0C.
For iSCSI systems, the UID uses the initiator name which uses the IQN
format such as: iqn.1992-04.com.emc:cx.apm00034901792.b0.

-hlu hlunumber
Specifies the host LUN number for the snapshot, which is the unique number
that the system server will see. hlunumber is the virtual LUN number.
-snapshotname snapshotname | -snapshotuid snapshotuid
Specifies the snapshot name or unique ID number (World Wide Name, WWN).
One of these switches is required along with the -gname or -uid switch.
storagegroup command, -chgname switch -chgname -gname
StorageGroupName | -uid StorageGroupUID -newgname NewName [-o]
Renames the storage group. You must use two of the following switches with chgname:
-gname StorageGroupName
Specifies the name of the storage group. StorageGroupName specifies a userdefined storage group name.
storagegroup

169

VNX CLI for Block

-uid StorageGroupUID
Specifies the storage group unique identification number.
l

l

For Fibre Channel systems, the UID uses the World Wide Name (WWN)
format such as: 10:00:00:00:C9:20:DE:0C:10:00:00:00:C9:20:DE:0C.
For iSCSI systems, the UID uses the initiator name which uses the IQN
format such as: iqn.1992-04.com.emc:cx.apm00034901792.b0.

-newgname NewName
Sets the new storage group name for the storage group (specified by the gname or -uid switch). NewNamespecifies the new name for the specified
storage group.
-o
Executes the command without prompting for confirmation.
storagegroup command, -connecthost switch -connecthost -host
HostName -gname StorageGroupName| -uid StorageGroupUID [-o]
Connects the specified host to the specified storage group. It connects all of the
host’s HBA/SP combinations to the storage group by assigning the host’s initiator
records to the storage group. To assign a storage group to a specific HBA, use
storagegroup -setpath.
You may use the port -list command to get a list of registered HBAs. If nothing
is registered, use the navicli register command to register an HBA.
You must specify the host using the -host switch, and the storage group using the
-gname switch or the -uid switch. If you include the -o switch, the command will
be executed without asking for user confirmation. Also, see the example in
unbind on page 181.
-host HostName
Specifies the user-defined hostname.
-gname StorageGroupName
StorageGroupName specifies the storage group name.

-uid StorageGroupUID
StorageGroupUID specifies the unique ID.

storagegroup command, -create switch -create -gname
StorageGroupName
Creates a storage group. You must use the -gname switch with -create. Also see
the example in unbind on page 181.
-gname StorageGroupName
StorageGroupName specifies a user-defined storage group name.

storagegroup command, -destroy switch -destroy -gname
StorageGroupName | -uid StorageGroupUID [-o]
Destroys the specified storage group. If you include the -o switch, the command will
be executed without asking for user confirmation. You must use one of the following
switches with -destroy:
-gname StorageGroupName
StorageGroupName specifies a user-defined storage group name.
170

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

-uid StorageGroupUID
Specifies the storage group UID.
storagegroup command, -disconnecthost switch -disconnecthost host HostName [-o]
Disconnects all of the specified host’s HBA/SP combinations from the currently
connected storage group, and reconnects them to ~management. You must specify
the host using the -host switch. If the -o switch is present, the command will be
executed without asking for user confirmation.
-host HostName
HostName specifies the user-defined hostname.

storagegroup command, -enable switch [-o]
Enables data access control. Sets the default storage group to ~management. If the
-o switch is present, the command will be executed without asking for user
confirmation.
storagegroup command, -list switch -list [-gname StorageGroupName| uid StorageGroupUID] -host
Displays information about the specified storage group. When no storage group is
specified, -list displays information about each user-defined storage group in the
system. You can use one of the following optional switches with -list.
-gname StorageGroupName
StorageGroupName specifies a user-defined storage group name.

-host
Displays the hostname of the attached host.
-uid StorageGroupUID
Specifies the storage group unique ID.
storagegroup command, -removehlu switch -removehlu -gname
StorageGroupName | -uid StorageGroupUID -hlu hlunumber
Removes the specified host LUN number from the specified storage group. You must
use one of the following switches:
-gname StorageGroupName
StorageGroupName specifies a user-defined storage group name.

-uid StorageGroupUID
Specifies the storage group UID.
-hlu hlunumber
hlunumber specifies the logical unit number, which is the number that the
system server will see. This switch is required along with either the -gname or uid switch.

storagegroup command, -removesnapshot switch -removesnapshot gname StorageGroupName | -uid StorageGroupUID -snapshotname
snapshotname| -snapshotwwn snapshotUID
Removes a snapshot from a storage group. You must use one of the four following
switches with -removesnapshot:
-gname StorageGroupName
StorageGroupName specifies the user-defined storage group name.
storagegroup

171

VNX CLI for Block

-uid StorageGroupUID
Specifies the storage group unique ID.
-snapshotname snapshotname | -snapshotwwn snapshotUID
Specifies the snapshot name or UID number (World Wide Name, WWN). One of
these switches is required.
storagegroup command, -sethost switch -sethost [-host hostname | ip host-ip-address [-arraycommpath 0|1] [-failovermode 0|1|2 |3|4] [-type
initiator-type] [-unitserialnumber array|lun] [-o]
Creates or changes certain settings for all initiators (HBAs) in the specified host that
are connected to a specific system. You must specify the host (-host switch),
unless you are issuing the command in the current host. To obtain -sethost
status, use the port list command. The -sethost function has subfunction
switches as follows.
Note

For AX4-5 series systems, the storagegroup command with the -sethost
switch will accept nondefault values for the following switches: -failovermode, arraycommpath, -type, and -unitserialnumber.
-arraycommpath 0|1
storagegroup -sethost with -arraycommpath modifies one or more
communication paths between the server and system. A communication path is
a logical path between the host and the system. It may be needed when there is
no LUN owned by an SP through which the host recognizes the system and in
the storage group through which the host recognizes the system.
Changing the arraycommpath setting may force the system to reboot. The CLI will
issue a confirmation request that indicates whether a system reboot is required.
However, the CLI will not issue a confirmation request if you include the -o switch.
CAUTION

Do not issue this command option unless you know the appropriate value for the
type of failover software running on the servers connected to the specified storage
group. The command is designed for transition from one type of failover software to
another. Changing the arraycommpath to the wrong value will make the storage
group inaccessible to any connected servers.
This form of -arraycommpath works for a host. For an entire system, or unshared
storage, use the command arraycommpath.
To discover the current setting of arraycommpath, use the port -list -all or
port -list -arraycommpath command.
0
Disables the communication path previously enabled.
1
Enables a communication path.
Example with arraycommpath:

172

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

naviseccli -h ss1_spa storagegroup -sethost -hostname server101
-arraycommpath 1

-failovermode 0|1|2|3}4
storagegroup -sethost with -failovermode sets the type of trespass
needed for failover software. Use this command with certain types of failover
software as suggested in the failover software release notice or manual.
Changing the failovermode setting may force the system to reboot. The CLI will
issue a confirmation request that indicates whether a system reboot is required.
However, the CLI will not issue a confirmation request if you include the -o switch.
CAUTION

Do not issue the failovermode command option unless you know the
appropriate value for the type of failover software running on the servers connected
to the specified storage group. The command is designed for transition from one
type of failover software to another. Changing the failovermode to the wrong value
will make the storage group inaccessible to any connected servers.
This method of setting -failovermode works for systems with storage group only.
For systems without storage group, use the command failovermode (see
failovermode on page 61).
To discover the current setting of failovermode, use the port -list failovermode or port -list -all command.
Note

For information about when to use these failover modes, refer to the Installation
Roadmap for CLARiiON Storage Systems, which is on EMC Online Support.
0
Failover mode 0.
1
Failover mode 1.
2
Failover mode 2.
3
Failover mode 3.
4
Failover mode 4.
Example with failovermode:
naviseccli -h ss1_spa storagegroup -sethost -failovermode 1
-hostname server102

-hostname [host]
Specifies the HBA owner's hostname. You must specify the host’s hostname or
its IP address (-ip host-ip-address switch).

storagegroup

173

VNX CLI for Block

-ip host-ip-address
Specifies the IP address of the host, in the form xx.xx.xx.xx. You must specify
either the IP address or the hostname. The IP address can be specified as an
IPv4 or IPv6 address. If an incorrect IP address is specified, the error message is
displayed as follows:
The IP address must be specified as an IPv4 address
in dotted-decimal format or as an IPv6 address in
colon-hexadecimal notation.

-type initiatortype
Specifies an initiator type to override the system default. The CLI uses the
default, 3, for the target if omitted. Type values (specify 0x to indicate hex) are
as follows:
0x2
HP (auto trespass)
0x3
Open (default).
0x9
SGI
0xa
HP (no auto trespass)
0x13
Dell
0x16
Fujitsu
0x1c
Compaq Tru64
-unitserialnumber [array|lun]
The unitserialnumber command displays or sets the VDPP80 behavior
mode, which defines how subsequent VPDP80 requests will be populated with
the system serial number. You might need to do this for software such as
SunCluster 3. You can discover the mode with the port -list unitserialnumber or port -list -all command. To set this mode for
a host, see storagegroup -sethost above.
array
Sets the behavior mode to system.
lun
Sets the behavior mode to LUN.
Example with unitserialnumber:
naviseccli -h ss1_spa storagegroup -sethost -unitserialnumber
lun

storagegroup command, -setpath switch -setpath [-gname
StorageGroupName| -uid StorageGroupUID] [-arraycommpath 0|1] [174

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

failovermode 0|1|2 |3|4] [-hbauid hbauid] [-host hostname] [-ip ip-address]
[-sp a|b] [-spport 0|1] [-unitserialnumber array|lun] [-o]
Creates or changes settings for a specific initiator (HBA). You must specify the HBA
(-hba switch), SP (-sp), and SP port (-spport). You can identify the storage group
by name (-gname switch) or unique ID (-uid switch). If you omit both switches, the
CLI uses the default path. To obtain -setpath status, use the port list
command. The -setpath function has many function switches as follows.
-arraycommpath 0|1
storagegroup -setpath with -arraycommpath modifies one or more
communication paths between the server and system. It may be needed when
there is no LUN owned by an SP through which the host recognizes the system
and in the storage group through which the host recognizes the system.
Changing the arraypath setting forces the system to reboot.
This form of -arraycommpath works for systems with storage group only. For
systems without storage group, use the command arraycommpath (see
arraycommpath on page 28).
To discover the current setting of arraycommpath, use the port -list arraycommpath or port -list -all command.
0
Disables the communication path previously enabled.
1
Enables a communication path.
Example with arraycommpath:
naviseccli -h ss1_spa storagegroup -setpath -gname Group1
-hbauid 10:00:00:00:C9:20:DE:0C:10:00:00:00:C9:20:DE:0C
-sp a -spport 0 -arraycommpath 1

-failovermode 0|1|2 |3|4
storagegroup -setpath with -failovermode sets the type of trespass
needed for failover software. Use this command with certain types of failover
software as suggested in the Installation Roadmap for CLARiiON Storage Systems,
which is on EMC Online Support.
Changing the failovermode setting may force the system to reboot. The CLI
will issue a confirmation request that indicates whether a system reboot is
required. However, the CLI will not issue a confirmation request if you specified
the -o switch.
This form of -failovermode works for one storage group. To set the entire
system mode, use the command failovermode.
To discover the current setting of failovermode, use the port -list failovermode or port -list -all command.
0
Failover mode 0.
1
Failover mode 1.

storagegroup

175

VNX CLI for Block

2
Failover mode 2.
3
Failover mode 3.
4
Failover mode 4.
-o
Executes the command without prompting for confirmation.
Example with failovermode:
naviseccli -h ss1_spa storagegroup -setpath -gname
Group1 -hbauid
10:00:00:00:C9:20:DE:0C:10:00:00:00:C9:20:DE:0C
-sp a -spport 0 -failovermode 1

-gname StorageGroupName
StorageGroupName specifies a user-defined storage group name. Use this or the
storage group unique ID (below).

-hbauid hbauid
Specifies the HBA unique ID (WWN). Required.
-host [hostname]
Specifies the HBA owner's hostname. The system uses the hostname (or -ip
address switch) for any subsequent storagegroup -connecthost and disconnecthost commands you issue. If you omit this, the system uses the
HBA UID. Not required.
-ip address
Specifies the HBA owner’s IP address (server’s IP address). You can specify the
IP address as the IPv4 or IPv6 address. Not required. See -hostname switch.
-sp a|b
Specifies the SP that owns the storage group. Required.
-spport 0|1
Specifies the SP port. Required.
-uid StorageGroupUID
Specifies the storage group unique ID.
-unitserialnumber array|lun
Sets the unit serial number operation mode. Use this switch if the software
instructs you to.
-o
Executes the command without prompting for confirmation.
storagegroup command, -shareable switch -shareable [-gname
StorageGroupName [yes|no] | -uid StorageGroupUID [yes|no]]
176

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Specifies whether more than one host can share the storage group. You must use
one of the following switches with -shareable, followed by a yes or a no. A yes or
no indicates whether the storage group can be shared. Only Unisphere can enforce
sharing.
-gname StorageGroupName yes|no
Sets the storage group named StorageGroupName to be shareable (yes) or not
shareable (no).
-uid StorageGroupUID yes|no
Sets the storage group with unique ID StorageGroupUID to be shareable (yes) or
not shareable (no).
EXAMPLE #1
In the following example, Unisphere connects all of ss1_spa’s HBA-SP combinations to
the storage group mail.
naviseccli -h ss1_spa storagegroup -gname mail -connecthost -o

EXAMPLE #2
In the following example, the -list command displays storage group information.
naviseccli -h ss1_spa storagegroup -list
Storage Group Name: Blade 150
Storage Group UID:
34:C7:72:A9:2D:DB:D8:11:AF:5E:08:00:1B:43:73:EE
HBA/SP Pairs:
HBA UID
SP Name
SPPort
-----------------20:00:00:00:C9:39:40:C7:10:00:00:00:C9:39:40:C7 SP B
0
20:00:00:00:C9:39:40:C8:10:00:00:00:C9:39:40:C8 SP A
0
HLU/ALU Pairs:
HLU Number ALU Number
---------- ---------0
15
1
14
2
13
3
11
4
10
5
9
6
7
7
6
8
5
9
3
10
2
11
1
Shareable: YES

EXAMPLE #3
The following examples creates two storage groups, connects them to separate hosts,
and adds a LUN to each one.
naviseccli -h ss_spa storagegroup -create -gname Production
naviseccli -h ss_spa storagegroup -create -gname Backup
storagegroup

177

VNX CLI for Block

naviseccli -h ss_spa storagegroup -connecthost -o -host ServerABC
-gname Production
naviseccli -h ss_spa storagegroup -connecthost -o -host ServerXYZ
-gname Backup
naviseccli -h ss_spa storagegroup -addhlu -gname Production -hlu
20 -alu 20
naviseccli -h ss_spa storagegroup -addhlu -gname Backup -hlu 21
-alu 21

EXAMPLE #4
The following example of storagegroup setpath and storagegroup sethost
with failovermode sets the type of trespass needed for failover software. Also, the
failover mode option is set to 4 in sethost and setpath switches.
naviseccli -h 10. 4. 78. 184 -user a -password a -scope 0 storagegroup
-sethost -ip 10.4.78.184 -failovermode 4
naviseccli -h 10. 4. 78. 184 -user a -password a -scope 0 storagegroup
-setpath -hbauid xxxxx-sp a -spport xxxxx -failovermode 4

EXAMPLE #5
The following example specifies the form of failovermode for one storage group. For the
options -failovermode and -all, the command displays the new failover mode as 4
under the HBA information section when the failover mode is active/active.
naviseccli -h 10. 4. 78. 184 -user a -password a -scope 0 port -list
-failovermode
Information about each port of this HBA
SP Name : SP A
SP Port ID : 0
Failover Mode : 4
naviseccli -h 10. 4. 78. 186 -user a -password a -scope 0 port -list
-all
HBA UID: 20 : 20 : 20 : 20 : 20 : 20 : 20 : 20 : 20 : 20
: 20 : 20 : 20 : 20 : 20 : 20
Server Name : TCS_Dell
Server IP Address : 10 . 4 . 78 . 159
HBA Model Description: 2
HBA Vendor Description : DELL
HBA Device Driver Name : N/A
Information about each port of this HBA :
SP Name : SP A
SP Port ID : 0
HBA Devicename : N/A
Trusted : NO
Logged In : NO
Defined : YES
Initiator Type : 3
StorageGroup Name : None
Array Commpath : 1

178

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Failover mode : 4
Unit serial number : Array

systemtype
Sets the system type.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli systemtype command changes the configured system type. Write
caching must be disabled for this command to work. Changing the system type causes an
SP to restart.
If you issue the command without arguments, the CLI will display both the current and
configured system types.
Note

Do not change the system type of any system running storage group. Do not change the
system type of a system unless it has been quiesced. The agent must be running and
managing the system.
Depending on the type of HP-UX operating system, you may want auto-trespass to be on
or off.
SYNTAX
systemtype -config [type] [-o]
OPTIONS
-config [type]
Sets the system type to one of the following:
A
HP-UX type with auto-trespass off; use this if your HP-UX system does not have
the PVLINKS feature.
2
HP-UX type with auto-trespass on; use this if your HP-UX system has the
PVLINKS feature.
3
Open system (default)
9
SGI (CX600)
13
Dell
16
Fujitsu
1C
HP type
-o
systemtype

179

VNX CLI for Block

Executes the command without prompting for confirmation.
EXAMPLE #1
naviseccli -h ss1_spa systemtype
The configured system type is: 0x3
The current system type is: 0x3

EXAMPLE #2
naviseccli -h ss1_spa systemtype -config 2
In order for this command to execute, write cache
must be disabled and memory size set to zero:

trespass
Trespasses one or more LUNs to the control of an SP.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
This command trespasses one or more LUNs to the control of an SP.
Note

Not applicable to single-SP systems.
The command attempts to trespass all specified LUNs to the SP you specify with the -h
switch.
Note

If trespass is executed while I/O processes are active, I/O errors may occur.
SYNTAX
trespass [all | lun lun-number | mine]
OPTIONS
all
Trespasses all LUNs in the system.
lun lun-number
Trespasses one LUN (specified by lun-number).
mine
Performs whatever trespassing is necessary to take all of the LUNs that have this SP
as a default owner.
EXAMPLE
naviseccli -h ss1_spa trespass all

OUTPUT
There is no output. Errors are printed to stderr.

180

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

unbind
Deconfigures a LUN.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli unbind command deconfigures LUNs from their current logical
configuration. The unbind command destroys all data on the LUN; therefore, when you
execute an unbind command, you are prompted to verify that you really want to unbind
the LUN(s). If you do not want the prompt to appear, you can override prompting using
the -o switch.
The command can unbind only LUNs owned by the SP you specify with -h.
You can unbind multiple LUNs at the same time.
Note

You cannot use this command to unbind thin LUNs.
SYNTAX
unbind lun [-o]
OPTIONS
lun

-o

Specifies the LUN to be deconfigured.
Executes the command without prompting for confirmation.

EXAMPLE #1
This command destroys (deconfigures) LUN 3 without prompting you for permission, and
frees its disks to be reconfigured.
naviseccli -h ss1_spa unbind 3 -o

EXAMPLE #2
This command destroys (deconfigures) LUNs 0, 1, 2, 3, and 4 without prompting you for
permission, and frees its disks to be reconfigured.
naviseccli -h ss1_spa unbind 0 1 2 3 4 -o

unitserialnumber
Displays or changes the VDPP80 (port 80) behavior mode.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli unitserialnumber command displays or sets the VDPP80
behavior mode, which defines how subsequent VPDP80 requests will be populated with
the system serial number. You might need to do this for software such as SunCluster 3.
To set this mode for a specific storage group, see the storagegroup command in
storagegroup.
unbind

181

VNX CLI for Block

SYNTAX
unitserialnumber [array|lun] [-o]
OPTIONS
array
Sets the behavior mode to system.
lun
Sets the behavior mode to LUN.
-o
Executes the command without prompting for confirmation.
EXAMPLE
These two commands display the current behavior mode and then set the mode to
system mode.
naviseccli -h ss1_spa unitserialnumber
Current unit serial number mode is: LUN
naviseccli -h ss1_spa unitserialnumber array

LUN Expansion (metaLUN) commands
This section explains the VNX CLI for Block commands that manage Unisphere metaLUNs.

MetaLUNs overview
A metaLUN is a type of LUN whose maximum capacity is the combined capacities of all
the LUNs that compose it. The metaLUN feature lets you dynamically expand the capacity
of a single LUN (primary LUN) into a larger unit called a metaLUN. You do this by adding
LUNs to the primary LUN. You can also add LUNs to a metaLUN to further increase its
capacity. Like a LUN, a metaLUN can belong to a storage group, and can participate in
SnapView, MirrorView and SAN Copy sessions.
During the expansion process, the host has access to any existing data on the LUN or
metaLUN, but it does not have access to any added capacity until the expansion is
complete. Whether you can actually use the increased user capacity of the metaLUN
depends on the operating system running on the servers connected to the system.
A metaLUN can include multiple sets of LUNs that are striped together and are
independent of other LUNs in the metaLUN. Each set of striped LUNs is called a
component. All metaLUNs contain at least one component that includes the primary LUN
and one or more LUNs. Any data that gets written to a metaLUN component is striped
across all the LUNs in the component.
You can expand a LUN or metaLUN in two ways — stripe expansion or concatenate
expansion. A stripe expansion takes the existing data on the LUN or metaLUN, and
restripes (redistributes) it across the existing LUNs and the new LUNs you are adding. The
stripe expansion may take a long time to complete. A concatenate expansion creates a
new metaLUN component that includes the new LUNs and appends this component to
the end of the existing LUN or metaLUN. There is no restriping of data between the
original storage and the new LUNs. The concatenate operation completes immediately.
Sample stripe expansion on page 183 depicts a LUN using stripe expansion to add two
LUNs. The result is a metaLUN with a single component consisting of all three LUNs with
the data on the primary LUN re-striped across all three LUNs.

182

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Figure 1 Sample stripe expansion

EMC2705

Sample concatenate expansion on page 183 depicts a LUN using concatenate expansion
to add two LUNs. The result is a metaLUN with two components. The first component is
the primary LUN. The second component consists of two new LUNs striped together, but
not striped to the first component.
Figure 2 Sample concatenate expansion

EMC2706

Note

EMC does not recommend that you expand LUN capacity by concatenating LUNs of
different RAID types. Do this only in an emergency situation when you need to add
capacity to a LUN and you do not have LUNs of the same RAID type or the disk capacity to
bind new ones. Concatenating metaLUN components with a variety of RAID types could
impact the performance of the resulting metaLUN. Once you expand a LUN, you cannot
change the RAID type of any of its components without destroying the metaLUN.
Destroying a metaLUN unbinds all LUNs in the metaLUN, and therefore causes data to be
lost.

CLI metaLUN command functions
The naviseccli metaLUN command functions, listed alphabetically, are:
l

metalun -destroy

l

metalun -expand

l

metalun -info

l

metalun -list

l

metalun -modify

The CLI metaLUN functions are listed functionally, in the order you would perform them,
in naviseccli metaLUN command functions, listed in order of use on page 183.
Table 10 naviseccli metaLUN command functions, listed in order of use
Essential functions (in order performed)
metalun -expand

Creates a metaLUN or expands one

metalun -destroy Destroys a metaLUN and then unbinds all LUNs that were part of the
metaLUN

CLI metaLUN command functions

183

VNX CLI for Block

Table 10 naviseccli metaLUN command functions, listed in order of use (continued)
Optional and status functions (alphabetically)
metalun -info

Provides metaLUN information with respect to a specific system

metalun -list

Lists the properties of existing metaLUNs
Optional reconfiguration functions (alphabetically)

metalun -modify

Modifies certain metaLUN properties

metalun -destroy
Destroys a metaLUN and unbinds all LUNs that were part of the metaLUN.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli metalun command with the -destroy switch destroys an existing
metaLUN and then unbinds all LUNs that were part of the metaLUN. You will lose all data
on the LUNs.
Note

You cannot destroy a metaLUN that belongs to a storage group. You must remove the
metaLUN from the storage group in order to destroy it. You cannot destroy any metaLUNs
that are currently participating in a snapshot, clone, mirror or SAN Copy session.
SYNTAX
metalun -destroy -metalun number|WWN| [-o]
OPTIONS
-metalun number| WWN
Specifies the unique number or World Wide Name of the metaLUN you want to
destroy. Use only one of the identifiers with the -metalun command. Use the
metalun -list command to determine the number or WWN of the metaLUN (see
metalun -list on page 191).
-o
Executes the command without prompting for confirmation.
EXAMPLE
This command destroys the metaLUN with the number 20.
naviseccli metalun -destroy 20

metalun -expand
Creates a new metaLUN or expands the capacity of an existing one
PREREQUISITES
This section describes the general requirements and recommendations for both a stripe
and concatenate expansion, as well as those specific to one or the other.
General expansion requirements and recommendations
l

184

Each LUN within a metaLUN must be either a redundant (RAID 6, RAID 5, RAID 3,
RAID 1, RAID 1/0) or non-redundant (RAID 0, disk) RAID type.

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

l

All disks within a metaLUN must be the same type.

l

You can expand only the last component of a metaLUN.

l

Expansion LUNs cannot be participating in a SnapView, MirrorView or SAN Copy
session.

l

The metalun -expand command will prohibit metaLUN creation and expansion if
the element size of the selected LUN(s) differ from the primary LUN. The system
will display the following error message:
The selected LUN(s) element size must be the same as the LUN
being expanded. Please select LUN(s) that match the primary
LUN’s element size.

Stripe expansion requirements and recommendations
All LUNs within a striped metaLUN or metaLUN component must be the same size
and RAID type, and we recommend that each LUN:
l

be from a different RAID group.

l

includes the same number of disks.

l

has the same stripe element size.

Concatenate expansion requirements and recommendations
All LUNs within a concatenated metaLUN component must be the same size and
RAID type, but can differ from the size and RAID type of LUNs within other
components.
Note

EMC does not recommend that you expand LUN capacity by concatenating LUNs of
different RAID types. Do this only in an emergency situation when you need to add
capacity to a LUN and you do not have LUNs of the same RAID type or the disk
capacity to bind new ones. Concatenating metaLUN components with a variety of
RAID types could impact the performance of the resulting metaLUN. Once you
expand a LUN, you cannot change the RAID type of any of its components without
destroying the metaLUN. Destroying a metaLUN unbinds all LUNs in the metaLUN,
and therefore causes data to be lost.
DESCRIPTION
The metalun -expand command is used with naviseccli (see naviseccli on page
20). The naviseccli metalun command with the -expand function creates a new
metaLUN or expands the capacity of an existing one. There are two distinct versions of
this command, one for Unisphere and one for Navisphere Express. When using this
command with Navisphere Express, the syntax is simpler and does not require binding
the destination LUN first. The process is different with Unisphere and requires you to bind
the destination LUN before running the command. See the Prerequisite section above for
requirements and recommendations.

metalun -expand

185

VNX CLI for Block

Note

Thin LUNs do not support metaLUNs, so you cannot create metaLUNs using thin LUNs.
For raw device mapping volumes (RDMs), if you are running VMware ESX Server, after you
create or expand the metaLUN, you must rescan the bus at the ESX Server level. You can
also rescan at the virtual machine level (optional). You then must expand the file system
at the virtual machine level. ESX Server and the virtual machine will now recognize the
new or expanded metaLUN.
For configuration specifications, go to the E-Lab™ Interoperability Navigator on EMC
Online Support.
SYNTAX
metalun -expand -base number|WWN -lus number|WWN [-autoassign
0|1] [-bindoffset sector-number] [-cap capacity]
[-defaultowner A|B] [-elszm elementSizeMultiplier]
[-expansionrate low|medium|high|ASAP|value]
[-name metaLUNname] [-preservedata 1|0] [-nogrow] [-o]
[-sq tb|gb|mb|bc] [-type C|S]
metalun -expand -base number|WWN -lus number|WWN [-type C|S]
[-sq tb|gb|mb|bc] [-cap number] [-nogrow] [-o]
metalun -expand -base number|WWN [-sq tb|gb|mb -cap number]
[-percent number] [-o]
OPTIONS
-base number|WWN
Specifies the unique number or World Wide Name of the LUN or metaLUN you want
to expand. Use only one of the identifiers with the -base switch. Use the metalun
-list command to determine the number or WWN of the LUN or metaLUN (see
metalun -list on page 191).
When you specify a LUN with the -base command, the CLI creates a new metaLUN
with the number and WWN of the primary LUN. Once the CLI creates the new
metaLUN, it assigns a new WWN to the original primary LUN and makes it a private
LUN. When expanding a single LUN, you can use any or all of the -expand switches.
Note

The primary LUN can belong to a storage group. Expansion LUNs cannot belong to a
storage group.
When you specify an existing metaLUN with the -base command, the CLI expands
the capacity of the existing metaLUN. The following switches are not valid during the
expansion of an existing metaLUN: -name, -preservedata, -expansionrate, defaultowner, -autoassign, -elsz, and -bindoffset. The expanded
metaLUN retains the values of the original metaLUN. After the metaLUN is expanded,
use the metalun -modify command to change the metaLUN using -name, expansionrate, -defaultowner, or -autoassign. The -preservedata, elsz and -bindoffset values cannot be changed.
-lus lunnumber|WWN
Specifies the LUN number or World Wide Name of the LUNs you want to add to the
LUN or metaLUN (expansion LUNs). Use only one of the identifiers per LUN with the 186

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

lus command. Use the metalun -list command to determine the number or WWN
of the LUNs (see metalun -list on page 191).
Note

Expansion LUNs cannot be participating in a SnapView (snapshot or clones),
MirrorView, or SAN Copy session.
-autoassign 0|1)
Enables or disables autoassign for a metaLUN. Specify 1 to enable autoassign and 0
to disable it. If you do not specify an autoassign value, it defaults to the value of the
primary LUN.
Autoassign controls the ownership of the LUN when an SP fails in a system with two
SPs. With autoassign enabled, if the SP that owns the LUN fails and the server tries
to access that LUN through the second SP, the second SP assumes ownership of the
LUN to enable access. The second SP continues to own the LUN until the failed SP is
replaced and the system is powered up. Then, ownership of the LUN returns to its
default owner. If autoassign is disabled in the previous situation, the second SP
does not assume ownership of the LUN, and access to the LUN does not occur.
If you are running failover software on a Windows or UNIX server connected to the
system, you must disable autoassign for all LUNs that you want to fail over to the
working SP when an SP fails.
-bindoffset sector-number
Note

Available only if the preservedata switch is set to 0.
EMC does not recommend using a metaLUN bindoffset value if the primary LUN
already has one.
Automatically aligns the logical sector number of the metaLUN to a stripe boundary
on the primary LUN. The value to enter is the number of sectors by which user data is
offset due to file system or partition metadata. Correct application of the bind offset
should result in improved performance. Use a decimal, not hexadecimal, number for
sector-number. If you do not specify a bind offset value, it defaults to 0.
-cap capacity
Specifies the capacity of usable space in the metaLUN. The capacity must be smaller
than the maximum capacity of the metaLUN components, and greater than or equal
to the current capacity (user capacity of the LUN or metaLUN before adding LUNs).
The default value is the maximum capacity of the metaLUN (total capacity of the
existing LUNs and any new LUNs).
Note

If you want to expand a LUN or metaLUN that is participating in a SnapView
(snapshot or clone), MirrorView, or SAN Copy session, you must use the -nogrow
switch with the -expand -cap command. This command expands the capacity of
the LUN or metaLUN to the specified value, but keeps the available user capacity of
the base (LUN or metaLUN) the same as it was before adding LUNs. In order for the
host to have access to the added capacity, you must wait for the session to complete
and then follow the instructions in Using the added capacity of an expanded
SnapView, MirrorView or SAN Copy LUN on page 197.
-defaultowner A|B
metalun -expand

187

VNX CLI for Block

Specifies the SP that will assume ownership of the metaLUN when the system is
powered up. If you do not specify a default owner, it defaults to the owner of the
primary LUN.
-elszm elementSizeMultiplier (Not supported on AX4-5 series systems running
Unisphere)
Sets the stripe element size for a metaLUN component. You determine this by
multiplying the stripe size of the first LUN in each component by the element size
multiplier. The stripe size of the first LUN = stripe element size of the LUN multiplied
by the number of disks in the LUN. Valid multiplier values are 1 through 255. The
default element size multiplier is 4.
-expansionrate low|medium|high|ASAP|value
Specifies the relative importance of making additional LUN capacity available to the
host. It determines the amount of resources the SP devotes to re-striping the existing
data on the original LUNs across the original LUNs and the new LUNs instead of to
normal I/O activity. This rate is available only when you first create a metaLUN and is
important only for a stripe expansion. Valid rebuild priorities are ASAP (default) or 3,
High or 2, Medium or 1, and Low, or 0.
An expansion rate of ASAP or High re-stripes the data across the metaLUN faster
than one with Medium or Low priority, but may degrade system performance.
-name metaLUN-name
Specifies the name of the metaLUN. If you do not specify a name, it defaults to the
name of the primary LUN.
-nogrow
Keeps the available user capacity of the metaLUN the same as it was before adding
LUNs. You cannot use the added capacity until you change the capacity using the modify switch.
Note

For a stripe expansion, any existing data is restriped across the original storage and
any new LUNs, but you cannot access the added capacity at this time.
-o
Executes the command without prompting for confirmation.
-preservedata 1|0
Use with the -type S command (see below). Allows you to preserve or overwrite
any existing data on the primary LUN, only if the primary LUN is outside a storage
group.
Note

You cannot use this command with the -type C switch.
If the primary LUN is outside of a storage group, do one of the following:
l

Specify 1 to enable stripe expansion and preserve the data on the primary LUN.
Note that this operation could take a while. The default value is 1.
Note

You must always specify 1 when the primary LUN is in a storage group. The CLI
returns an error message if you specify 0 in this case.
l

Specify 0 to enable stripe expansion and overwrite the existing data on the
primary LUN. Note that you will lose the original data on the LUN.

-sq tb|gb|mb|bc
Specifies the size qualifier for the capacity of the metaLUN component.
188

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

where:
tb equals terabytes, gb equals gigabytes, mb equals megabytes and bc equals block
count.
Note

The default qualifier is block count.
-type C|S
Sets the expansion type for the metaLUN to concatenate or stripe. The default
expansion type is stripe.
C sets the expansion type to concatenate. A concatenate expansion appends the
new LUNs to the end of the primary LUN component or metaLUN as a single,
separate striped component. There is no striping between the original storage and
the new LUNs.
S sets the expansion type to stripe. For a list of requirements for stripe expansion,
see the Prerequisite section above.
If you are expanding a LUN (the primary LUN), the -type S switch creates a
metaLUN with one component that includes the primary LUN and any LUNs that you
add. Any data on the primary LUN is re-striped across the primary LUN and the new
LUNs.
Note

If the primary LUN has existing data, and it is outside of a storage group, refer to the preservedata switch (see above) for additional options.
You can expand only the last component of an existing metaLUN. In this case, the type S switch re-stripes any existing data across the original LUNs in the
component and any new LUNs that you add. The new LUNs become part of that
metaLUN component.
-base number|WWN
Mandatory switch, supported with Navisphere Express, that specifies the source LUN
or metaLUN you want to expand. You can specify the base number or World Wide
Name of the LUN.
-cap number
Mandatory switch, supported with Navisphere Express, that specifies the additional
storage capacity you can add to the LUN or metaLUN. The size qualifier for the -cap
number is the -sq switch.
-sq tb|gb|mb
Mandatory switch, supported with Navisphere Express, that specifies the size
qualifier for the capacity of the metaLUN component.
where:
tb equals terabytes, gb equals gigabytes, and mb equals megabytes.
For example, if you are expanding a 20 GB LUN, and specify -sq gb -cap 20 in the
command, the resulting metaLUN is 40 GB.
-percent number
Optional switch for Navisphere Express that specifies the amount of additional
storage you want to expand by, as a percentage of the current size of the LUN. The
number should always be greater than 0. This switch can be used instead of -sq and
-cap number switches.

metalun -expand

189

VNX CLI for Block

For example, if you are expanding a 20 GB LUN, and specify -percent 50 in the
command, the resulting metaLUN is 30 GB.
EXAMPLE
For Unisphere Manager, this command creates a metaLUN with the name newMetaLUN,
which includes primary LUN 20 and LUN 42. Since the default expansion type is stripe,
this metaLUN is striped.
naviseccli metalun -expand -base 20 -lus 42 -name newMetaLUN

metalun -info
Provides general information about a system’s metaLUN environment.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli metalun command with the -info function and no other options
displays all general information about the metaLUN environment for a system. Issuing
this command with one or more options displays the information based on the options
issued.
SYNTAX
metalun -info [-canexpand] [-nummetaluns] [-maxmetaluns]
[-maxcomponents] [-maxluns] [-availableluns]
[-lunsinmeta]
OPTIONS
-canexpand
Specifies whether you can or cannot expand any LUNs or metaLUNs on the system.
Valid values are Yes or No.
-nummetaluns
Displays the number of metaLUNs in the system.
-maxmetaluns
Displays the maximum number of metaLUNs that the system will support (based on
system type). See the EMC Unisphere Release Notes for currently supported values.
-maxcomponents
Displays the maximum number of components allowed per metaLUN for this system
(based on system type). See the EMC Unisphere Release Notes for currently supported
values.
-maxluns
Displays the maximum number of LUNs per component that this system supports
(based on system type). See the EMC Unisphere Release Notes for currently supported
values.
-availableluns
Lists all LUNs (by LUN number) in the system that are available for expansion.
-lunsinmeta
Lists any LUNs (by LUN number) in the system that are part of a metaLUN.
EXAMPLE
This command requests information about the metaLUN environment for the system with
SP 10.14.20.57.
naviseccli -address 10.14.20.57 metalun -info

190

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

OUTPUT
Can a LUN or a Meta-LUN be expanded on this system: Yes
Number of Meta-LUNs in the system: 7
Maximum Number of Meta-LUNs per system: 1024
Luns that are participating in Meta-LUNs: 513 512 515 514 517 516
519 518 521 52
0 523 522 525 524
Luns that are available for expansion: 32 43 44 47 48 49 50 51 52 53
54 55 56 5
7 58 59 0
Maximum Number of Components per Meta-LUN: 16
Maximum Number of LUNs per Component: 32

The CLI returns status or error information if the command fails.

metalun -list
Lists the properties of existing metaLUNs.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli metalun command with the -list function and no other options
lists all property information for all metaLUNs on a system. Issuing this command with
one or more options displays the information based on the options issued.
Note

In order to return values for performance data, you must enable statistics logging for each
SP in the system. Use VNX CLI for Block or Unisphere. Performance data switches are
marked with an asterisk (*).
If you request performance data for a specific metaLUN, make sure that you enter the IP
address for the SP that is the current owner of the metaLUN.
SYNTAX
metalun -list [-name [metaLUN-name]] [-metalunwwn metaLUN-WWN]
[-metalunnumber metaLUN-number]
[-all] [-aac*] [-actualusercap] [-autoassign] [-bindoffset]
[-brw*]
[-components*] [-currentowner] [-canexpand] [-defaultowner]
[-drivetype] [-expansionrate] [-elszm] [-isredundant] [-nzrca]
[-percentexp] [-rhist*] [-rwr*] [-sor] [-state] [-totalusercap]
[-whist*]
OPTIONS
-name [metaLUN-name]
Lists all information for that specific metaLUN.
Issuing the -name command without a metaLUN-name displays the names of all
metaLUNs on the system.
-metalunwwn metaLUN-WWN
Lists all information for that specific metaLUN.
Issuing the -metalunwwn command without a metaLUN-WWN displays the WWNs
for all metaLUNs on the system.
-metalunnumber metaLUN-number
metalun -list

191

VNX CLI for Block

Lists all information for that specific metaLUN.
Issuing the -metalunnumber command without a metaLUN-number displays the
numbers for all metaLUNs on the system.
-aac*
Displays the active/active counters associated with the metaLUN.
-actualusercap
Displays the current user capacity of all metaLUNs on the system.
Issuing the -actualusercap command with a metaLUN name, number or WWN
displays the user capacity for that specific metaLUN.
-autoassign
Displays the current state of the autoassign feature for all metaLUNs on the system
(Yes or No).
Issuing the -autoassign command with a metaLUN name, number or WWN
displays the current state of the autoassign feature for that specific metaLUN.
-all
Displays all information for the metalun -list command.
-bindoffset
Aligns the logical sector number of all metaLUNs on the system to a stripe boundary
on the primary LUN.
Issuing the -bindoffset command with a metaLUN name, number or WWN
returns the value of the bindoffset used for that metaLUN.
-brw*
Displays the number of host block read and write requests to all metaLUNs on the
system.
Issuing the -brw command with a metaLUN name, number or WWN displays the
number of host block read and write requests to that specific metaLUN.
-components*
Displays the contents of all components in all metaLUN on the system.
Issuing the -components command with a metaLUN name, number or WWN
displays the contents of all components for that specific metaLUN.
-currentowner
Lists the current SP owner of all metaLUNs in the system. If neither SP owns the
metaLUN a value of Unknown is returned.
Issuing the -components command with a metaLUN name, number or WWN lists
the current SP owner of the specified metaLUN.
-canexpand Yes | No
Yes
The specified metaLUN can be expanded.
No
The specified metaLUN cannot be expanded.
-defaultowner
Lists the default SP owner of all metaLUNs on the system.
Issuing the -defaultowner command with a metaLUN name, number or WWN
lists the default SP owner of the specified metaLUN.
-drivetype
Displays the drive type for all metaLUNs on the system.
192

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Issuing the -drivetype command with a metaLUN name, number or WWN
displays the drive type for the specified metaLUN.
-expansionrate
Displays the expansion rate for all metaLUNs on the system (see the expansionrate low|medium|high|ASAP|value option in metalun -expand on page
184). Valid values are 0 (Low), 1 (Medium), 2 (High), 3 (ASAP), or N/A if the metaLUN
is not currently expanding.
Issuing the -expansionrate command with a metaLUN name, number or WWN
displays the expansion rate for the specified metaLUN (see the -expansionrate
low|medium|high|ASAP|value option in metalun -expand on page 184).
-elszm
Displays the element size multiplier for all metaLUNs on the system (see -elszm
elementSizeMultiplier in metalun -expand on page 184).
Issuing the -elszm command with a metaLUN name, number or WWN displays the
element size multiplier for the specified metaLUN (see -elszm elementSizeMultiplier
in metalun -expand on page 184).
-isredundant
Displays the redundancy of all metaLUNs on the system:
Yes
if it is redundant
No
if it is not redundant
Issuing the -isredundant command with a metaLUN name, number or WWN
displays the redundancy of the specified metaLUN.
-nzrca
Returns the nonzero request count arrivals in SP A and SP B.
-percentexp
Displays the percentage complete of the stripe expansion process of all primary
LUNs or metaLUNs on the system.
Issuing the -percentexp command with a metaLUN name, number or WWN
displays the percentage complete of the stripe expansion process of the specified
primary LUN or metaLUN.
-rhist*
Returns read histogram information for all metaLUNs on the system.
Note

A read histogram is an system of 10 locations that contain the number of reads.
Element n of the system contains the number of reads that were larger than or equal
to 2n-1 and less than 2n blocks in size. For example, the first bucket contains the
number of 1 block reads, the second contains the number of 2-3 block reads, the
third contains the number of 4-7 block reads, and so on. The -rhist switch also
displays the number of read histogram overflows, which are the number of reads
that were larger than 512 blocks.
Issuing the -rhist command with a metaLUN name, number or WWN returns the
read histogram for the specified metaLUN.
-rwr*
Displays the number of host read and write requests to all metaLUNs on the system.
metalun -list

193

VNX CLI for Block

Issuing the -rwr command with a metaLUN name, number or WWN displays the
number of host read and write requests to the specified metaLUN.
-sor
Returns the sum of outstanding requests in SP A and SP B.
-state
Displays the current state of all metaLUNs on the system.
When issuing the -state command with a metaLUN name, number or WWN
displays the state of the specified metaLUN. The following are valid metaLUN states:
Normal
The metaLUN is operating normally.
Degraded
Some part of the metaLUN is faulted, but the metaLUN is still able to process
I/O.
Shut down
The metaLUN is faulted and unusable.
Expanding
The metaLUN is in the process of expanding (re-striping data across all
component LUNs).
-totalusercap
Displays the total user capacity of all metaLUNs on the system.
Issuing the -totalusercap command with a metaLUN name, number or WWN
displays the total user capacity of the specified metaLUN.
-whist*
Returns write histogram information for all metaLUNs on the system.
Note

A write histogram is an system of 10 locations that contain the number of writes.
Element n of the system contains the number of writes that were larger than or equal
to 2n-1 and less than 2n blocks in size. For example, the first bucket contains the
number of 1 block writes, the second contains the number of 2-3 block writes, the
third contains the number of 4-7 block writes, and so on. The -whist switch also
displays the number of write histogram overflows, which are the number of writes
that were larger than 512 blocks.
Issuing the -whist command with a metaLUN name, number or WWN returns the
write histogram for the specified metaLUN.
EXAMPLE
This command requests information on all metaLUNs that are currently owned by the SP
with IP address 10.14.20.57.
naviseccli -address 10.14.20.57 metalun -list

OUTPUT
Meta-LUN Name: LUN30
Meta-LUN WWN: 60:06:01:6D:35:0A:00:00:FC:35:5B:8C:66:60:D7:11
Meta-LUN Number: 30
Default Owner: SP A
Current Owner: SP B

194

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Meta-LUN State: ENABLED
Can MetaLUN Be Expanded: Yes
Expansion Rate: MEDIUM
Percent Expanded: 0
Total Capacity (Blocks/Megabytes): 819200/400
Actual User Capacity (Blocks/Megabytes): 819200/400
Autoassign: No
Is Redundant: Yes
Drive Type: Fibre Channel
Element Size Multiplier: 40
Bind Offset: 0
Read Histogram [0] :
22
Read Histogram [1] :
14
Read Histogram [2] :
19
Read Histogram [3] :
37
Read Histogram [4] :
6
Read Histogram [5]:
0
Read Histogram [6]:
0
Read Histogram [7]:
0
Read Histogram [8]:
0
Read Histogram [9]:
0
Read Histogram Overflows:
45
Write Histogram [0] :
22
Write Histogram [1] :
22
Write Histogram [2] :
22
Write Histogram [3] :
22
Write Histogram [4] :
22
Write Histogram [5] :
22
Write Histogram [6] :
22
Write Histogram [7] :
22
Write Histogram [8] :
22
Write Histogram [9] :
22
Write Histogram Overflows:
45
Read Requests: 0
Write Requests: 0
Blocks Read: 0
Blocks Written: 0
Components:
Number of LUNs: 2
LUNs:
LUN Number: 513
LUN Name: LUN 30
LUN WWN: 60:06:01:72:35:0A:00:00:B0:44:01:4B:61:60:D7:11
RAID Type: RAID5
LUN Number: 512
LUN Name: LUN 31
LUN WWN: 60:06:01:72:35:0A:00:00:15:FB:3B:4C:61:60:D7:11
RAID Type: RAID5
Number of LUNs: 1 (Lists LUN information for second component)

The CLI returns the status or the error information if the command fails.
This command displays the active/active counters for this metaLUN along with other
metaLUN output.
naviseccli -h 10.14.85.50 -user a -password a -scope 0 metalun -list
-metalunnumber 4 -aac
Host
Host
Host
Host
Host
Host
Host

Blocks Read SPA: 6 (optimal)
Blocks Read SPB: 0
Blocks Written SPA: 0 (optimal)
Blocks Written SPB: 0
Read Requests SPA: 6 (optimal)
Read Requests SPB: 0
Write Requests SPA: 0 (optimal)

metalun -list

195

VNX CLI for Block

Host Write Requests SPB: 0
Busy Ticks SPA: 0 (optimal)
Busy Ticks SPB: 0
Idle Ticks SPA: 33224 (optimal)
Idle Ticks SPB: 0
Explicit Trespasses SPA: 0
Explicit Trespasses SPB: 0
Implicit Trespasses SPA: 0
Implicit Trespasses SPB: 0

metalun -modify
Modifies certain properties of an existing metaLUN.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli metalun command with the -modify function lets you edit certain
properties of a specified metaLUN. You must specify either the number or WWN for the
metaLUN, and you must specify at least one other switch.
SYNTAX
metalun -modify -metalun number|WWN [-autoassign 0|1]
[-cap capacity] [-defaultowner A|B]
[-expansionrate low|medium|high|ASAP|value]
[-newname newName] [-o] [-sq tb|gb|mb|bc] [-tomaxcap]
OPTIONS
-metalun number|WWN
Specifies the number or WWN of the metaLUN whose properties you want to change.
-autoassign 1|0 (Not supported on AX4-5 series systems)
Enables or disables auto assign for a metaLUN. Specify 1 to enable auto assign and
0 to disable it. If you do not specify an auto assign value, it defaults to the value of
the primary LUN. For more information about auto assign, see the -autoassign 0|
1 option in metalun -expand on page 184.
-cap capacity
Specifies the capacity of usable space in the metaLUN. The capacity must be smaller
than the maximum capacity of the metaLUN, and greater than or equal to the current
capacity (user capacity of the LUN or metaLUN before adding LUNs).
Note

If you want to modify the user capacity of a LUN or metaLUN that is participating in a
SnapView (snapshot or clone), MirrorView or SAN Copy session, see Using the added
capacity of an expanded SnapView, MirrorView or SAN Copy LUN on page 197.
-defaultowner A|B
Specifies the new default SP owner for the metaLUN — A or B.
-expansionrate low|medium|high|ASAP|value
Specifies the relative importance of making additional LUN capacity available to the
host. It determines the amount of resources the SP devotes to re-striping the existing
data on the original LUNs across the original LUNs and the new LUNs instead of to
normal I/O activity. This rate is available only when you first create a metaLUN and is
important only for a stripe expansion. Valid rebuild priorities are ASAP (default) or 3,
High or 2, Medium or 1, and Low, or 0.
196

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

An expansion rate of ASAP or High re-stripes the data across the metaLUN faster
than one with Medium or Low priority, but may degrade storage-system
performance.
-newname newName
Specifies the new name for the metaLUN. A valid name must not exceed 64
characters and must include at least one non-whitespace character. This name must
be unique on the system.
-o
Executes the command without prompting for confirmation.
-sq tb|gb|mb|bc
Specifies the size qualifier for the capacity of the metaLUN component.
where:
tb equals terabytes, gb equals gigabytes, mb equals megabytes and bc equals block
count. The default qualifier is block count.
-tomaxcap
Lets you expand the metaLUN to its maximum capacity.

Using the added capacity of an expanded SnapView, MirrorView or SAN Copy LUN
You must perform the operations detailed in the following sections to expand the
capacity of a LUN or metaLUN that is currently participating in a SnapView, MirrorView or
SAN Copy session (see metalun -destroy on page 184), and to allow the host to access
the added capacity.
Note

For a stripe expansion, any existing data is re-striped across the original LUN or metaLUN
and the added LUNs during the SnapView, MirrorView or SAN Copy session. This restriping is invisible to the host.

For LUNs in a SnapView session
To access the added capacity of an expanded snapshot source LUN:
Procedure
1. Stop all SnapView sessions and destroy all snapshots associated with the expanded
source LUN (see the SnapView Command Line Interface (CLI) Reference and the online
help).
2. Use the metalun -modify on page 196 command to change the capacity of the
expanded LUNs.
3. Make sure the host operating system can utilize the added capacity.
Results
You can now start new sessions and create new snapshots with the expanded LUNs (see
the SnapView Command Line Interface (CLI) Reference and the online help).

For LUNs in a clone group
Note

You must expand the clone and the clone source LUN to the same size.
To access the added capacity of an expanded clone, or clone source LUN, do the
following:
Using the added capacity of an expanded SnapView, MirrorView or SAN Copy LUN

197

VNX CLI for Block

Procedure
1. For the clone, remove the clone from the clone group; for a clone source LUN, destroy
the clone group.
2. Use the metalun -modify on page 196 command to change the capacity of the
expanded LUNs.
3. Make sure the host operating system can utilize the added capacity.
4. Reconstruct the clone group with the expanded LUNs and then perform a full
synchronization of the LUNs in the clone group.

For LUNs in mirrors
Note

You must expand both the primary and secondary images of a mirror to the same size.
To access the added capacity of an expanded primary and secondary MirrorView LUN, do
the following:
Procedure
1. For the expanded primary image, destroy the mirror; for the expanded secondary
image, remove it from the mirror (see the MirrorView CLI Reference or the online help).
2. Use the metalun -modify on page 196 command to change the capacity of the
expanded LUNs.
3. Make sure the host operating system can utilize the added capacity.
4. Reconstruct the mirror with the expanded LUNs and then perform a full
synchronization of the mirror.

For LUNs in SAN Copy sessions
Note

If you expand the SAN Copy source logical unit, make sure that the destination LUNs are
of equal or greater capacity.
To access the added capacity of an expanded SAN Copy source LUN or destination LUN,
do the following:
Procedure
1. For any sessions that the expanded LUNs are participating in, wait until the SAN copy
sessions complete, or stop the sessions, and then remove these sessions. (See the
online help).
2. Use the metalun -modify on page 196 command to change the capacity of the
expanded LUNs.
3. Make sure the host operating system can utilize the added capacity.
4. Reconstruct the SAN Copy sessions that you removed and then, when you are ready,
start the sessions. (See the online help.)

Reserved LUN Pool commands
This section explains how to configure the reserved LUN pool, which is required for
running replication software such as SnapView, incremental SAN Copy, or MirrorView/
198

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Asynchronous. It also describes the CLI commands that you can use if SnapView is
installed on your system.

reserved -lunpool -addlun
Adds a LUN to the reserved LUN pool.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli reserved command with the -lunpool and -addlun functions
adds one or more LUNs to the reserved LUN pool.
Note

The reserved –addlun command restricts the Reserved LUN Pool LUNs to 128 element
size. If you select LUN(s) with element size not equal to 128, the system will display the
following error message: Invalid element size for chosen LUN(s).
Please choose LUN(s) with element size of 128.
Each system has its own reserved LUN pool, and before starting a replication session, the
reserved LUN pool must contain at least one LUN for each source LUN that will be
participating in a session.
Note

This command does not support the thin LUNs.
Replication sessions include SnapView sessions and any reserved sessions for use in
another application, such as incremental SAN Copy and MirrorView/A.
The software allocates reserved LUNs on a per source LUN basis. Each system manages
its own reserved LUN pool space and allocates reserved LUNs on a per-source LUN basis,
not a per-session basis.
Note

You must bind the LUN before you can add it to the reserved LUN pool. While a LUN is
part of the reserved LUN pool, you cannot use it for any other purpose.
SYNTAX
reserved -lunpool -addlun lun_numbers
OPTIONS
lun_numbers
Specifies the logical unit number(s) to add to the reserved LUN pool.

EXAMPLE
For ss1_spa, this command adds the LUN with ID 11 to the system’s reserved LUN pool.
naviseccli -h ss1_spa reserved -lunpool -addlun 11

OUTPUT
If the version of software running on the SP does not support this command, the
following error message is printed to stderr: Command is not supported

reserved -lunpool -addlun

199

VNX CLI for Block

reserved -lunpool -list
Displays reserved LUN pool information.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli reserved command with the -lunpool and -list functions and
no other switches lists all information about the reserved LUN pool. You can obtain more
specific information with function switches.
Note

This command does not support the thin LUNs.
SYNTAX
reserved -lunpool -list [-allocatedluns] [-chunksize]
[-freeluncount] [-freeluns] [-freesize] [-luncount]
[-percentused] [-size] [-used]
OPTIONS
-allocatedluns
Displays the LUN IDs of all allocated LUNs in the reserved LUN pool.
-chunksize
Displays the number of disk blocks in the reserved LUN pool, in KB. The chunk size
applies to the entire system.
-freeluncount
Displays the total number of unallocated LUNs in the reserved LUN pool.
-freeluns
Displays the LUN IDs of all unallocated LUNs in the reserved LUN pool.
-freesize
Displays the total size of unallocated LUNs in GBs.
-luncount
Displays the total number of LUNs in the reserved LUN pool. You can add LUNs with
the reserved -lunpool -addlun functions.
-percentused
Displays the percentage of the reserved LUN pool that is used.
-size
Displays the size of the reserved LUN pool in GBs.
-used
Displays the space used in the reserved LUN pool, in GBs.
EXAMPLE
This command displays the system’s reserved LUN pool information. A sample output
follows.
naviseccli -h ss1_spa reserved -lunpool -list

OUTPUT
The following output samples show devices controlled by one agent. Actual output varies
depending on the command switches you use with the -lunpool -list command.

200

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Note

If your system is running VNX CLI for Block version 6.24 or later, reserved LUN pool
information will be displayed for the enitre system, regardless of the SP you direct the
command to. If your system is running VNX CLI for Block version 6.22 or earlier, reserved
LUN pool information will be displayed for the SP you direct the command to.
naviseccli ouput:
Name of the SP:
Total Number of LUNs in Pool:
Number of Unallocated LUNs in Pool:
Unallocated LUNs:
Total size in GB:
Unallocated size in GB:
Used LUN Pool in GB:
% Used of LUN Pool:
Chunk size in disk blocks:
Allocated LUN Pool:
Target LUN:
Allocated LUNs:
Lun Pool LUN % Used:
Allocated LUNs:
Lun Pool LUN % Used:

GLOBAL
6
4
14, 24, 23, 22
4.488281
1.292969
0.017639
0.393005
128
2
249
91.852825
250
0

If the version of software running on the SP does not support this command, a Command
is not supported error message is printed to stderr.

reserved -lunpool -rmlun
Removes one or more LUNs from the reserved LUN pool.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli reserved command with the -lunpool and -rmlun functions
removes one or more LUNs from the reserved LUN pool. If you omit the override option,
the CLI prompts for confirmation before removing the LUN from reserved LUN pool.
Note

This command does not support the thin LUNs.
SYNTAX
reserved -lunpool -rmlunluns [-o]
OPTIONS
-o
Executes the command without prompting for confirmation.
-rmlun luns
Specifies the LUN ID of each LUN, with the IDs separated by blanks, you want to
remove from the reserved LUN pool.
EXAMPLE
For ss1_spa, this command starts removing LUN 42 from the system’s reserved LUN pool.
The software asks for confirmation:

reserved -lunpool -rmlun

201

VNX CLI for Block

naviseccli -h ss1_spa reserved-lunpool -rmlun 42
Do you really want to remove the luns from LUN pool.
(y/n)[N]? y

OUTPUT
If the version of software running on the SP does not support this command, a Command
is not supported error message is printed to stderr.

iSCSI and FCoE commands
This section explains each of the naviseccli Internet SCSI (iSCSI) and Fibre Channel over
Ethernet (FCoE) commands, that is, the CLI commands that are common to all iSCSI
systems and FCoE ports.

iSCSI commands overview
The naviseccli iSCSI commands in this section include the connection and iSNS
commands. naviseccli iSCSI commands on page 202 identifies the iSCSI commands that
can be used.
Table 11 naviseccli iSCSI commands

Command

Description
CHAP User Commands

connection -adduser

Creates a CHAP user account.

connection -deleteuser

Deletes a CHAP user account.

connection -getuser

Displays CHAP user accounts.
Port administration commands

connection -getport

Retrieves a specific iSCSI or FCOE port or the list of all the
iSCSI or FCoE ports.

connection -setport

Modifies the properties of a connection port.

connection -delport

Deletes a virtual port.

connection -route

Sets up the static routes.

connection -pingnode

Verifies that packets reach a destination node without
errors.

connection -traceroute

Displays the route that a packet takes to a destination node.

Connection set database commands
connection -setsharedauth Sets a username and secret for the system’s shared
credentials record.
connection -delsharedauth Removes the shared authentication information from the
system.
connection -getsharedauth Displays the username and the switch enabled for the
shared authentication record.
connection -addset

202

Adds a connection set.

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Table 11 naviseccli iSCSI commands (continued)

Command

Description

connection -delset

Deletes a connection set and associated connection paths.

connection -modifyset

Modifies parameters of the connection set.

connection -getset

Lists a specific connection set or all the connection sets.

connection -addpath

Adds a connection path to a specific connection set.

connection -delpath

Deletes a connection path from a connection set.

connection -modifypath

Modifies a connection path from a connection set.

connection -verifypath

Tests a connection path from a connection set.
iSNS commands

isns -addserver

Adds an iSNS server to a system’s iSNS service
configuration.

isns -deleteserver

Deletes an iSNS server from a system’s iSNS service
configuration.

isns -listserver

Displays all iSNS servers that are configured in the system’s
iSNS service.

isns -setprimary

Sets a configured iSNS server as the primary server for a
system’s iSNS service configuration.

connection -adduser
Adds a CHAP authentication user.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -adduser function adds either an
initiator CHAP authentication user or a target (system) CHAP authentication user to the
system CHAP user database.
Note

If you try to create a CHAP user for an initiator and the user is already defined, an error
message is returned that the user is already defined for the initiator.
If you try to add a user for a target and the user is already defined, an error is returned
that only one user can be defined for target access.
SYNTAX
connection -adduser -definedFor initiator|target |
-initiatorName initiatorName | ANY [-userName userName]
-secret secret [-hexsecret] [-o]
OPTIONS
-definedFor initiator | target
connection -adduser

203

VNX CLI for Block

initiator adds an initiator CHAP user account to the system user database. If you
specify initiator, you must specify an initiator using the -initiatorName
parameter. Target specifies that a target (system) CHAP user account will be created.
If you specify target, do not use the -initiatorName parameter.
-initiatorName initiatorName
If initiator user account data is being added, initiatorName is a unique identifier for
the initiator and uses the iSCSI Qualified Name (IQN) of the iSCSI initiator. This
parameter is required if you are defining an initiator user.
-userName username
If initiator user account data is being added, username specifies the CHAP username
that the initiator uses when connecting to an iSCSI target. For CHAP, a username and
secret must be defined for each initiator. If the -userName parameter is omitted, it
defaults to the -initiatorName value. If a target is being configured for mutual CHAP,
the target name becomes the username.
-secret secret
If initiator user account data is being added, secret specifies the CHAP secret
(password) that the system will use to authenticate the initiator. You can specify the
secret in ASCII or hexadecimal characters (see the -hexsecret switch that follows). By
default, -secret is an ASCII string. ASCII secrets must consist of at least 12 and no
more than 16 characters. Hexadecimal secrets must consist of at least 12 and no
more than 16 pairs of data (24 to 32 characters).
-hexsecret
If initiator user account data is being added, including the -hexsecret parameter
specifies that -secret is a hexadecimal value.
-o
Executes the command without prompting for confirmation. If you include the -o
switch, you will not be prompted to confirm that you want to add the user account
data. If you do not use the -o switch, you will be prompted to confirm that you want
to add the user.
EXAMPLE
The following example adds a user account to the system database.
naviseccli connection -adduser -definedfor initiator -initiatorName
5.com.microsoft:cpc7745 -username Guest -secret 1234567890123456
Adding an iSCSI user account with the following
attributes:
Initiator Name: iqn.1991-05.com.microsoft:cpc7745
User name: Guest
Secret: 1234567890123456
Defined For: initiator
Do you really want to perform this action (y/n)? y

connection -deleteuser
Deletes a CHAP authentication user.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -deleteuser function deletes a
specified initiator or target CHAP authentication user from the system CHAP user
database.

204

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

SYNTAX
connection -deleteuser -definedFor initiator | target
-initiatorName initiatorName -userName username [-o]
OPTIONS
-definedFor initiator | target
initiator specifies that an initiator user account will be deleted from the system user
database. If you specify initiator, you must specify an initiator using the initiatorName parameter. target specifies that the target (system) user data will
be deleted.
-initiatorName initiatorName
If initiator user account data is being deleted, initiatorName is the name that was
assigned for the initiator when the user account was created. The default initiator
name is the IQN of the initiator.
-userName username
Specifies the iSCSI CHAP username for the initiator or target user being deleted.
-o
Executes the command without prompting for confirmation. If you include the -o
switch, you will not be prompted to confirm the user account deletion. If you do not
use the -o switch, you will be prompted to confirm that you want to delete the user
account data.
EXAMPLE
The following example deletes a user account from the system:
naviseccli connection -deleteuser -definedfor initiator -initiatorName
iqn.1991-05.com.microsoft:cpc7745 -username Guest
Deleting an iSCSI user account with the following
attributes:
Initiator Name: iqn.1991-05.com.microsoft:cpc7745
User name: Guest
Defined For: initiator
Do you really want to perform this action (y/n)? y

OUTPUT
None if the command succeeds; status or error information if it fails.

connection -getuser
Display CHAP authentication user data.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -getuser function displays CHAP
authentication user account data that is configured on the system. If no arguments are
specified, all CHAP users defined on the system are displayed. Use -definedFor, initiatorName, and -userName to display information for a specified user. If you
specify a particular user and that user is not found, the error message, The specified
user account does not exist, is returned.
SYNTAX
connection -getuser [-definedFor initiator | target]
[-userName userName] [-initiatorName initiatorName]
connection -getuser

205

VNX CLI for Block

OPTIONS
-definedFor initiator | target
initiator specifies that information for a CHAP initiator user is displayed. If you
specify initiator, you must include the -userName and -initiatorName.
target specifies that information for a CHAP target user (the system user account) is
displayed. If you specify target, you must include the -userName.
-initiatorName initiatorName
The initiator is the host or HBA that initiates the connection with the target system.
The initiator is identified by the IQN of the iSCSI initiator.
-userName username
Specifies the iSCSI CHAP username for the initiator or target user being specified by
initiatorName.
EXAMPLE
The following example gets information on the current user:
naviseccli connection -getuser

OUTPUT
Initiator Name: iqn.1991-05.com.microsoft:cpc7745
User Name: Guest
Defined For: initiator

connection -getport
Retrieve a specific iSCSI or FCoE port or the list of all the iSCSI or FCoE ports.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -getport function displays
information about either a specified iSCSI port or a list of all iSCSI ports. If no arguments
are specified, all of the iSCSI ports defined on the targeted system are displayed.
If a change in settings is requested, a confirmation is displayed.
The -sp and the -portid parameters select which iSCSI ports are displayed. If both
options are specified, a particular iSCSI port is specified. If either or both of the options
are omitted, all iSCSI ports that meet the search criteria are displayed.
SYNTAX
connection -getport [-sp a|b] [-portid portid [-vportid
vportid]] [-vlanid] [-address IPAddress] [-subnetmask]
[-gateway]
[-initiatorAuthentication] [-mac] [-mtu] [-flowctl]
[-hostWindow] [-replicationWindow] [-all]
OPTIONS
-sp a|b
Specifies SP A or B. Displays the information for iSCSI or FCoE ports configured on
the specified SP.
-portid portid
Specifies an iSCSI or FCoE port ID. Displays information only for the specified iSCSI
port.The following parameters, -address, -subnetmask, -gateway, and initiatorAuthentication, define additional information that is displayed for
206

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

iSCSI ports. If none of these options is specified, all fields are displayed. The SP and
port ID fields are always displayed.
-address
Displays the IP address of the specified iSCSI ports. The address is a 32-bit numeric
address written as four 8-bit numbers (0-255) separated by periods (called the quaddotted notation). For example, 165.152.36.35.
-subnetmask
Displays the network mask for the specified iSCSI ports. The subnet mask uses the
quad-dotted notation. For example, 255.255.255.0.
-gateway
Displays the network gateway address that the specified iSCSI ports use. The
gateway address uses the quad-dotted notation. For example, 165.152.35.22.
-initiatorAuthentication
Displays the state of the initiator authentication flag for the specified iSCSI ports.
True indicates that initiator authentication is turned on for the port and that all
initiators logging into that port will be required to authenticate against the target
system. False indicates that initiator authentication has been disabled for the port.
-mac
Displays the MAC address for the front-end ports of an iSCSI system and also FCoE
ports. Running the port ... -mac command returns a MAC Address field for each
port. When you run the port ... -mac command, if any ports are Fibre Channel
ports, the MAC Address field for those ports will be displayed as Not Applicable
-mtu
Displays the port’s MTU settings and lists the valid MTU settings for the portal.
-vlanid
Displays the virtual LAN (VLAN) ID of the specified virtual port.
-vportid vportid
Displays information for the specified virtual port ID.
-flowctl
Determines the flow control settings. Valid values are Auto, Transmit flow control
(Tx), Receive flow control (Rx).
-hostWindow
Sets the receive window size for host-to-system traffic. The available window sizes
are 64K, 128K, 256K, 512K, 1MB. The default value is 256K.
replicationWindow
Sets the receive window size for system-to-system traffic. The available window
sizes are 64K, 128K, 256K, 512K, 1MB. The default value is 256K.
-all
Displays all the physical and virtual port information for each iSCSI port.
EXAMPLE #1
naviseccli connection -getport
SP: A
Port ID: 4
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.a4
iSCSI Alias: 0877.a4
IP Address: 172.20.1.140
Subnet Mask: 255.255.255.0
Gateway Address: 172.20.1.1
Initiator Authentication: Not Available
SP: A
Port ID: 5
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.a5
iSCSI Alias: 0877.a5
SP:

A

connection -getport

207

VNX CLI for Block

Port ID: 6
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.a6
iSCSI Alias: 0877.a6
IP Address: 172.20.2.140
Subnet Mask: 255.255.255.0
Gateway Address: 172.20.2.1
Initiator Authentication: Not Available
SP: A
Port ID: 7
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.a7
iSCSI Alias: 0877.a7
SP: B
Port ID: 4
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.b4
iSCSI Alias: 0877.b4
IP Address: 172.20.1.141
Subnet Mask: 255.255.255.0
Gateway Address: 172.20.1.1
Initiator Authentication: Not Available
SP: B
Port ID: 5
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.b5
iSCSI Alias: 0877.b5
SP: B
Port ID: 6
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.b6
iSCSI Alias: 0877.b6
IP Address: 172.20.2.141
Subnet Mask: 255.255.255.0
Gateway Address: 172.20.2.1
Initiator Authentication: Not Available
SP: B
Port ID: 7
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.b7
iSCSI Alias: 0877.b7
SP: B
Port ID: 9
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:69:3B:24:13:0D
iSCSI Alias: N/A
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication: N/A
SP: A
Port ID: 8
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:60:3B:24:13:0D
iSCSI Alias: N/A
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication: N/A
SP: A
Port ID: 9
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:61:3B:24:13:0D
iSCSI Alias: N/A
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication: N/A

208

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

SP: B
Port ID: 8
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:68:3B:24:13:0D
iSCSI Alias: N/A
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication: N/A

EXAMPLE #2
naviseccli connection -getport -sp a -portid 8
SP: A
Port ID: 8
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:68:3B:24:13:0D
iSCSI Alias: N/A
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication: N/A

EXAMPLE #3
naviseccli connection -getport -sp a -portid 8 –vlanid
SP: A
Port ID: 8
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:60:3B:24:13:0D
iSCSI Alias: N/A
Virtual Port ID: 0
VLAN ID: 101

EXAMPLE #4
naviseccli connection -getport -sp a -portid 8 –mtu
SP: A
Port ID: 8
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:60:3B:24:13:0D
iSCSI Alias: N/A
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication: N/A
Current MTU: 2240
Available MTU Sizes: "2240"?

EXAMPLE #5
naviseccli connection -getport -portid 8 -speed
SP: A
Port ID: 8
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:60:3B:24:13:0D
iSCSI Alias: N/A
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication: N/A
Port Speed: 10000 Mb
Auto-Negotiate: No
Available Speeds: 10000 Mb

connection -getport

209

VNX CLI for Block

EXAMPLE #6
naviseccli connection -getport -sp a -portid 8 -vportid 0 -all
SP: A
Port ID: 8
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:60:3B:24:13:0D
iSCSI Alias: N/A
Port Speed: 10000 Mb
Auto-Negotiate: No
Available Speeds: 10000 Mb
Current MTU: 2240
Available MTU Sizes: "2240"
Virtual Port ID: 0
VLAN ID: 101
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication:

N/A

EXAMPLE #7
naviseccli connection -getport –mac
SP: A
Port ID: 4
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.a4
iSCSI Alias: 0877.a4
Port Speed: 1000 Mb
Auto-Negotiate: Yes
Available Speeds: 10 Mb
: 100 Mb
: 1000 Mb
: Auto
Current MTU: 1500
Available MTU Sizes:
"1260","1448","1500","1548","2000","2450","3000","4000","4080","4470",
"5000","6000","7000","8000","9000"
Virtual Port ID: 0
VLAN ID: Disabled
IP Address: 172.20.1.140
Subnet Mask: 255.255.255.0
Gateway Address: 172.20.1.1
Initiator Authentication: Not Available
SP: A
Port ID: 5
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.a5
iSCSI Alias: 0877.a5
Port Speed: 0 Mb
Auto-Negotiate: Yes
Available Speeds: 10 Mb
: 100 Mb
: 1000 Mb
: Auto
Current MTU: 0
Available MTU Sizes:
"1260","1448","1500","1548","2000","2450","3000","4000","4080","4470",
"5000","6000","7000","8000","9000"
SP: A
Port ID: 6
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.a6
iSCSI Alias: 0877.a6
Port Speed: 10000 Mb
Auto-Negotiate: No
Available Speeds: 10000 Mb

210

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Current MTU: 1500
Available MTU Sizes:
"1260","1448","1500","1548","2000","2450","3000","4000","4080","4470",
"5000","6000","7000","8000","9000"
Virtual Port ID: 0
VLAN ID: Disabled
IP Address: 172.20.2.140
Subnet Mask: 255.255.255.0
Gateway Address: 172.20.2.1
Initiator Authentication: Not Available
SP: A
Port ID: 7
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.a7
iSCSI Alias: 0877.a7
Port Speed: 0 Mb
Auto-Negotiate: No
Available Speeds: 10000 Mb
Current MTU: 1500
Available MTU Sizes:
"1260","1448","1500","1548","2000","2450","3000","4000","4080","4470",
"5000","6000","7000","8000","9000"
SP: B
Port ID: 4
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.b4
iSCSI Alias: 0877.b4
Port Speed: 1000 Mb
Auto-Negotiate: Yes
Available Speeds: 10 Mb
: 100 Mb
: 1000 Mb
: Auto
Current MTU: 1500
Available MTU Sizes:
"1260","1448","1500","1548","2000","2450","3000","4000","4080","4470",
"5000","6000","7000","8000","9000"
Virtual Port ID: 0
VLAN ID: Disabled
IP Address: 172.20.1.141
Subnet Mask: 255.255.255.0
Gateway Address: 172.20.1.1
Initiator Authentication: Not Available
SP: B
Port ID: 5
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.b5
iSCSI Alias: 0877.b5
Port Speed: 0 Mb
Auto-Negotiate: Yes
Available Speeds: 10 Mb
: 100 Mb
: 1000 Mb
: Auto
Current MTU: 0
Available MTU Sizes:
"1260","1448","1500","1548","2000","2450","3000","4000","4080","4470",
"5000","6000","7000","8000","9000"
SP: B
Port ID: 6
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.b6
iSCSI Alias: 0877.b6
Port Speed: 10000 Mb
Auto-Negotiate: No
Available Speeds: 10000 Mb

connection -getport

211

VNX CLI for Block

Current MTU: 1500
Available MTU Sizes:
"1260","1448","1500","1548","2000","2450","3000","4000","4080","4470",
"5000","6000","7000","8000","9000"
Virtual Port ID: 0
VLAN ID: Disabled
IP Address: 172.20.2.141
Subnet Mask: 255.255.255.0
Gateway Address: 172.20.2.1
Initiator Authentication: Not Available
SP: B
Port ID: 7
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.b7
iSCSI Alias: 0877.b7
Port Speed: 0 Mb
Auto-Negotiate: No
Available Speeds: 10000 Mb
Current MTU: 1500
Available MTU Sizes:
"1260","1448","1500","1548","2000","2450","3000","4000","4080","4470",
"5000","6000","7000","8000","9000"
SP: B
Port ID: 9
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:69:3B:24:13:0D
iSCSI Alias: N/A
Enode MAC Address: 00-60-16-3B-47-B3
Port Speed: 10 Gb
Auto-Negotiate: No
Available Speeds: 10 Gb
Current MTU: 2240
Available MTU Sizes: "2240"
Virtual Port ID: 0
VLAN ID: 666
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication: N/A
VN_Port MAC Address: 0E-FC-00-68-00-03
SP: A
Port ID: 8
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:60:3B:24:13:0D
iSCSI Alias: N/A
Enode MAC Address: 00-60-16-3B-55-42
Port Speed: 0 Gb
Auto-Negotiate: No
Available Speeds: 10 Gb
Current MTU: 2240
Available MTU Sizes: "2240"
Virtual Port ID: 0
VLAN ID: N/A
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication: N/A
VN_Port MAC Address: 00-00-00-00-00-00
SP: A
Port ID: 9
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:61:3B:24:13:0D
iSCSI Alias: N/A
Enode MAC Address: 00-60-16-3B-55-43
Port Speed: 10 Gb

212

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Auto-Negotiate: No
Available Speeds: 10 Gb
Current MTU: 2240
Available MTU Sizes: "2240"
Virtual Port ID: 0
VLAN ID: 666
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication: N/A
VN_Port MAC Address: 0E-FC-00-68-00-04
SP: B
Port ID: 8
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:68:3B:24:13:0D
iSCSI Alias: N/A
Enode MAC Address: 00-60-16-3B-47-B2
Port Speed: 0 Gb
Auto-Negotiate: No
Available Speeds: 10 Gb
Current MTU: 2240
Available MTU Sizes: "2240"
Virtual Port ID: 0
VLAN ID: N/A
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication: N/A
VN_Port MAC Address: 00-00-00-00-00-00

EXAMPLE #8
naviseccli connection -getport -sp a -portid 8 -vportid 0 -mac
SP: A
Port ID: 8
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:60:3B:24:13:0D
iSCSI Alias: N/A
Port Speed: 10000 Mb
Auto-Negotiate: No
Available Speeds: 10000 Mb
Enode MAC Address: 00:60:16:32:12:5B
Virtual Port ID: 0
VLAN ID: 101
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication: N/A
VN_Port MAC Address: 0E:FC:00:2B:0B:04

EXAMPLE #9
naviseccli -h peregrine-spa connection -getport -sp a -mac -all
SP: A
Port ID: 9
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:61:3B:24:13:0D
iSCSI Alias: N/A
Enode MAC Address: 00-60-16-3B-55-43
Port Speed: 10 Gb
Auto-Negotiate: No
Available Speeds: 10 Gb
Current MTU: 2240
Available MTU Sizes: "2240"

connection -getport

213

VNX CLI for Block

Virtual Port ID: 0
VLAN ID: 666
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication: N/A
VN_Port MAC Address: 0E-FC-00-68-00-04

EXAMPLE #10
naviseccli -h peregrine-spa connection –getport –flowctl –hostWindow
–replicationWindow
Flow Control: Auto
Host Window: 256K
Replication Window: 256K
Available Window Sizes: 64K,128K,256K,512K,1MB

OUTPUT
The following sample output shows several virtual ports assigned with the VLAN tags:
naviseccli -h peregrine_spa connection -getport -sp a -portid 0 -all
SP: A
Port ID: 4
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.a4
iSCSI Alias: 0877.a4
Port Speed: 1000 Mb
Auto-Negotiate: Yes
Available Speeds: 10 Mb
: 100 Mb
: 1000 Mb
: Auto
Current MTU: 1500
Available MTU Sizes:
"1260","1448","1500","1548","2000","2450","3000","4000","4080","4470",
"5000","6000","7000","8000","9000"
Flow Control: Auto
Host Window: 256K
Replication Window: 256K
Available Window Sizes: 64K,128K,256K,512K,1MB
Virtual Port ID: 0
VLAN ID: Disabled
IP Address: 172.20.1.140
Subnet Mask: 255.255.255.0
Gateway Address: 172.20.1.1
Initiator Authentication: Not Available
SP: A
Port ID: 5
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.a5
iSCSI Alias: 0877.a5
Port Speed: 0 Mb
Auto-Negotiate: Yes
Available Speeds: 10 Mb
: 100 Mb
: 1000 Mb
: Auto
Current MTU: 0
Available MTU Sizes:
"1260","1448","1500","1548","2000","2450","3000","4000","4080","4470",
"5000","6000","7000","8000","9000"

214

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

SP: A
Port ID: 6
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.a6
iSCSI Alias: 0877.a6
Port Speed: 10000 Mb
Auto-Negotiate: No
Available Speeds: 10000 Mb
Current MTU: 1500
Available MTU Sizes:
"1260","1448","1500","1548","2000","2450","3000","4000","4080","4470",
"5000","6000","7000","8000","9000"
Flow Control: Auto
Host Window: 256K
Replication Window: 256K
Available Window Sizes: 64K,128K,256K,512K,1MB
Virtual Port ID: 0
VLAN ID: Disabled
IP Address: 172.20.2.140
Subnet Mask: 255.255.255.0
Gateway Address: 172.20.2.1
Initiator Authentication: Not Available
SP: A
Port ID: 7
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.a7
iSCSI Alias: 0877.a7
Port Speed: 0 Mb
Auto-Negotiate: No
Available Speeds: 10000 Mb
Current MTU: 1500
Available MTU Sizes:
"1260","1448","1500","1548","2000","2450","3000","4000","4080","4470",
"5000","6000","7000","8000","9000"
SP: B
Port ID: 4
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.b4
iSCSI Alias: 0877.b4
Port Speed: 1000 Mb
Auto-Negotiate: Yes
Available Speeds: 10 Mb
: 100 Mb
: 1000 Mb
: Auto
Current MTU: 1500
Available MTU Sizes:
"1260","1448","1500","1548","2000","2450","3000","4000","4080","4470",
"5000","6000","7000","8000","9000"
Flow Control: Auto
Host Window: 256K
Replication Window: 256K
Available Window Sizes: 64K,128K,256K,512K,1MB
Virtual Port ID: 0
VLAN ID: Disabled
IP Address: 172.20.1.141
Subnet Mask: 255.255.255.0
Gateway Address: 172.20.1.1
Initiator Authentication: Not Available
SP: B
Port ID: 5
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.b5
iSCSI Alias: 0877.b5
Port Speed: 0 Mb
Auto-Negotiate: Yes
Available Speeds: 10 Mb

connection -getport

215

VNX CLI for Block

: 100 Mb
: 1000 Mb
: Auto
Current MTU: 0
Available MTU Sizes:
"1260","1448","1500","1548","2000","2450","3000","4000","4080","4470",
"5000","6000","7000","8000","9000"
SP: B
Port ID: 6
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.b6
iSCSI Alias: 0877.b6
Port Speed: 10000 Mb
Auto-Negotiate: No
Available Speeds: 10000 Mb
Current MTU: 1500
Available MTU Sizes:
"1260","1448","1500","1548","2000","2450","3000","4000","4080","4470",
"5000","6000","7000","8000","9000"
Flow Control: Auto
Host Window: 256K
Replication Window: 256K
Available Window Sizes: 64K,128K,256K,512K,1MB
Virtual Port ID: 0
VLAN ID: Disabled
IP Address: 172.20.2.141
Subnet Mask: 255.255.255.0
Gateway Address: 172.20.2.1
Initiator Authentication: Not Available
SP: B
Port ID: 7
Port WWN: iqn.1992-04.com.emc:cx.apm00093300877.b7
iSCSI Alias: 0877.b7
Port Speed: 0 Mb
Auto-Negotiate: No
Available Speeds: 10000 Mb
Current MTU: 1500
Available MTU Sizes:
"1260","1448","1500","1548","2000","2450","3000","4000","4080","4470",
"5000","6000","7000","8000","9000"
SP: B
Port ID: 9
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:69:3B:24:13:0D
iSCSI Alias: N/A
Port Speed: 10 Gb
Auto-Negotiate: No
Available Speeds: 10 Gb
Current MTU: 2240
Available MTU Sizes: "2240"
Flow Control: Auto
Host Window: 256K
Replication Window: 256K
Available Window Sizes: 64K,128K,256K,512K,1MB
Virtual Port ID: 0
VLAN ID: 666
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication:

N/A

SP: A
Port ID: 8
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:60:3B:24:13:0D
iSCSI Alias: N/A

216

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Port Speed: 0 Gb
Auto-Negotiate: No
Available Speeds: 10 Gb
Current MTU: 2240
Available MTU Sizes: "2240"
Flow Control: Auto
Host Window: 256K
Replication Window: 256K
Available Window Sizes: 64K,128K,256K,512K,1MB
Virtual Port ID: 0
VLAN ID: N/A
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication:

N/A

SP: A
Port ID: 9
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:61:3B:24:13:0D
iSCSI Alias: N/A
Port Speed: 10 Gb
Auto-Negotiate: No
Available Speeds: 10 Gb
Current MTU: 2240
Available MTU Sizes: "2240"
Flow Control: Auto
Host Window: 256K
Replication Window: 256K
Available Window Sizes: 64K,128K,256K,512K,1MB
Virtual Port ID: 0
VLAN ID: 666
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication:

N/A

SP: B
Port ID: 8
Port WWN: 50:06:01:60:BB:20:13:0D:50:06:01:68:3B:24:13:0D
iSCSI Alias: N/A
Port Speed: 0 Gb
Auto-Negotiate: No
Available Speeds: 10 Gb
Current MTU: 2240
Available MTU Sizes: "2240"
Virtual Port ID: 0
VLAN ID: N/A
IP Address: N/A
Subnet Mask: N/A
Gateway Address: N/A
Initiator Authentication:

N/A

connection -setport
Modify the properties of a port.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -setport function modifies the
properties of a specified SP port.

connection -setport

217

VNX CLI for Block

SYNTAX
connection -setport [-iscsi (Default)]
-sp a|b -portid portid [-vportid vportid (default=0)]
[-vlanid vlanid|-vlandisable]
[-address address] [-subnetmask subnetmask] [-gateway gateway]
[-initiatorAuthentication 0|1] [-alias iscsialias]
[-speed speed] [-mtu mtu] [-o]
connection -setport [-fcoe]
-sp a|b -portid portid [-vportid vportid (default=0)]
[-vlanid vlanid|-vlanautodiscovery] [-o]
OPTIONS
-sp a|b
Specifies that the iSCSI or FCOE port is on either SP A or SP B.
-portid portid
Specifies the port on the SP. For example, an SP with one port has port 1 and an SP
with two ports has port 0 and port 1.
-vportid vportid
Specifies the virtual port ID. If you do not specify the -vportid, the system defaults to
virtual port 0.
-vlanautodiscovery
Sets the port (FCoE only) specified by -portid to be in VLAN auto discovery mode.
-vlanid vlanid
Specifies the VLAN ID.
-vlandisable
Disables VLAN tagging on the virtual port.
-address address
Specifies the IP address of the iSCSI port. The address uses the dotted-quad format.
For example: 165.152.36.35.
-subnetmask subnetmask
Specifies the subnetwork mask for the iSCSI port. The subnet mask uses the dottedquad format. For example: 255.255.255.0.
-gateway gateway
Specifies the network gateway address that the iSCSI port uses. The gateway
address uses the dotted-quad format. For example: 165.152.35.22.
-initiatorAuthentication 0|1
If initiator authentication is turned on, all initiators logging in to the port must be
authenticated by the system.
0 = Not required - default
1 = Required
-aliasiscsialias
Specifies the iSCSI alias.
-speed speed
Specifies the port speed.
-mtu
Configures the MTU size for the specified iSCSI port. If not specified during the initial
creation of a portal, the default is 1500. If -mtu is not specified during the update of
a portal’s setting, the MTU setting will not change. If a change in settings has been
requested, a confirmation will be displayed.
-o

218

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Executes the command without prompting for confirmation. If you include the -o
switch, the port will be set (configured) without a confirmation prompt. Without the o switch, the software displays confirmation messages that you must respond to.
EXAMPLE #1
The following example configures the network settings for the port with IP address
10.14.80.110:
naviseccli connection -setport -sp b -portid 0 -address -subnetmask
255.255.255.0 -gateway 10.14.80.1
It is recommended that you consult with your Network Manager to
determine the correct settings before applying these changes.
Changing the port properties may disrupt traffic on one or more
ports of this I/O Module. Initiator configuration changes may be
necessary to regain connections.
Do you really want to perform this action (y/n)?y

EXAMPLE #2
naviseccli connection –setport –hostWindow 32K –o
Request failed. Invalid window size: 32K.
Available Window Sizes: 64K, 128K, 256K, 512K, 1MB

OUTPUT
None if the command succeeds; status or error information if it fails.

connection -delport
Deletes a virtual port.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to execute
the command.
DESCRIPTION
The naviseccli connection command with the -delport function lets you delete
a virtual port from a physical port. To execute this command, more than one virtual port
should be associated with the management port.
If there is only one management port with only one virtual port, the command cannot be
executed. Use of this command depends on the network provider capabilities.
SYNTAX
connection -delport -sp a|b -portid portid -vportid vportid
[-o]
OPTIONS
-sp a|b
Deletes the virtual port of the specified SP. The default is the connected SP.
-portid portid
Specifies the iSCSI port ID. If you specify an invalid port ID, the system displays the
following error: Request failed. Specified iSCSI port not found.
-vportid vportid
Specifies the virtual port ID. If you specify an invalid virtual port ID, the system
displays the following error message: Request failed. Specified iSCSI
virtual port not found.
-o
connection -delport

219

VNX CLI for Block

Executes the command without prompting for confirmation.
OUTPUT
Provides output depending on the options used.

connection -route
Sets up the static routes to specific hosts or networks.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to execute
the command.
DESCRIPTION
The naviseccli connection command with the -route function is used to set up
the static routes to specific hosts or networks.
SYNTAX
connection -route [-sp a|b] [-portid portid|-vportid vportid]
[-add -destination destination [-subnetmask subnetmask|
-prefixlength length] [-metric metric] [-persistent]]
[-delete -destination destination [-subnetmask subnetmask|
-prefixlength length]]
[-list] [-o]
OPTIONS
-sp a|b
Specifies the destination SP. The default is the connected SP.
-portid portid
The -portid and the -vportid together specify the interface associated with the
route. If you do not specify the interface, the system determines it.
-vportid vportid
The -portid and the -vportid together specify the interface associated with the
route. If you do not specify the interface, the system determines it.
-add
Adds a network route.
-destination destination
Specifies the IPv4/IPv6 address or hostname of the destination.
-subnetmask netmask
Specifies the IPv4 subnet mask value for the route entry. The default is
255.255.255.255. It is valid only for an IPv4 destination address.
-prefixlength length
Specifies the prefix length, that is the part of the address to compare while
determining the route. The default is 128. It is valid only for an IPv6 destination
address.
-metric metric
Determines the best route using the routing algorithm. The route with the lowest
metric is preferred over another route.
-persistent
Specifies whether the route should persist across reboots.
-delete
Deletes an existing route.
-list

220

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

-o

Displays the routes for the SP. By default, it displays the routes for the connected SP.
It also displays the routes for a specific port/virtual port.
Executes the command without prompting for confirmation.

OUTPUT
Provides output depending on the options used.

connection -pingnode
Verifies that packets reach a destination node without errors.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -pingnode function transmits
packets to a target node and returns a notification that the packets have reached the
node without errors. The connection -pingnode command pings a target node from
the iSCSI port. Use the connection -pingnode and the connection traceroute commands to verify and diagnose network connectivity.
SYNTAX
connection -pingnode [-sp a|b] [ [-portid portid -vportid
vportid] |-source sourceaddress] -address address
[-packetSize packetSize] [-count count] [-timeouts timeouts]
[-delays delays]
OPTIONS
-sp a|b
Specifies either storage processor A or storage processor B.
-portid portid
Specifies the port on the SP, either 0 or 1. For example, an SP with one port has port
0 and an SP with two ports has port 0 and port 1.
-vportid vportid
Specifies the virtual port ID.
-address address
Specifies the IP address of the target node that the iSCSI port will ping. The address
is a 32-bit numeric address written as four numbers separated by periods, for
example, 128.221.56.52. Network names are not supported.
-packetSize packetSize
Specifies the size of the packets in bytes. The default is 32 bytes, the minimum is 0
bytes, and the maximum is 2048 bytes.
-count count
Specifies the number of pings to send. The default is 4; the minimum is 1.
-timeouts timeouts
Specifies the response wait timeout period in seconds. The default is 3 seconds, the
minimum is 1 second, and the maximum is 15 seconds.
-delays delays
Specifies a delay in seconds between pings. The default is 1 second, the minimum is
1 second, and the maximum is 10 seconds.
EXAMPLE
naviseccli -h peregrine_spa connection -pingnode -sp a -portid 0
-vportid 0 -address 128.222.132.100
connection -pingnode

221

VNX CLI for Block

OUTPUT
Reply
Reply
Reply
Reply

from
from
from
from

128.222.132.100:
128.222.132.100:
128.222.132.100:
128.222.132.100:

bytes=32
bytes=32
bytes=32
bytes=32

time=1ms
time=1ms
time=1ms
time=1ms

TTL=30
TTL=30
TTL=30
TTL=30

connection -traceroute
Display the route that a packet takes to a destination node.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -traceroute function displays
the route that packets take to a target node that you specify in the command. The
connection -traceroute command traces and displays the route from the system
iSCSI port to the target node. Use the connection -traceroute and connection
-pingnode commands to verify and diagnose network connectivity.
SYNTAX
connection -traceroute[-sp a|b] -address IPAddress
[ [-portid portid -vportid vportid] |-source sourceaddress
[-mtu| -packetSize packetSize] ]
[-timeouts timeouts] [-delays delays]
OPTIONS
-address IPAddress
Specifies the IP address of the target node that the iSCSI port will attempt to contact.
The address uses the dotted-quad format, for example, 128.221.56.52. Network
names are not supported.
-portid portid
Specifies the port on the SP, either 0 or 1. For example, an SP with one port has port
0; an SP with two ports has port 0 and port 1.
-vportid vportid
Specifies the virtual port ID.
-sp a|b
Specifies either SP A or SP B.
-delays delays
Specifies a delay in seconds between datagrams. The default is 1 second, the
minimum is 1 second, and the maximum is 10 seconds.
-packetSize packetSize
Specifies the size of the echo packets in bytes. The default is 32 bytes, the minimum
is 0 bytes, and the maximum is 2048 bytes.
-mtu
Performs networking diagnostics, focusing on the maximum transmission unit
between the two systems. If specified, -source is required.
-source sourceaddress
Specifies the source address and is required when -mtu is used.
-timeouts timeouts
Specifies the response wait timeout period in seconds. The default is 3 seconds, the
minimum is 1 second, and the maximum is 15 seconds.
EXAMPLE
The following example displays the route taken by a packet:
222

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

naviseccli -user a -password a -scope 0 -h ss1_spa connection
-traceroute -sp a -address -mtu -source

OUTPUT
1:
2:

172.20.1.1
10.5.1.250

1 ms
1 ms

1500 mtu
1500 mtu

connection -setsharedauth
Sets username and secret for the system’s shared credentials record.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -setsharedauth function sets a
username and secret for the iSCSI intiator system’s shared credentials record of the
connection set database. The command lets you enable or disable the use of the
system’s shared authentication credentials.
SYNTAX
connection -setsharedauth[-userNameuserName][-secret secret
[-hexsecret]] [-enable|-disable] [-o]
OPTIONS
-userName userName
Specifies the CHAP username used by the initiator when challenged by the target
system. For CHAP, a username and secret must be defined.
-secret secret
Specifies the CHAP secret to be used with the username when challenged by the
target system. You can specify the secret in ASCII or hexadecimal characters (see the
-hexsecret switch that follows). By default, -secret is an ASCII string. ASCII
secrets must consist of at least 12 and no more than 16 characters. Hexadecimal
secrets must consist of at least 12 and no more than 16 pairs of data (24 to 32
characters).
-hexsecret
If initiator user account data is being added, including the -hexsecret parameter,
it specifies that -secret is a hexadecimal value.
-enable| -disable
Enables or disables the use of the system’s shared credentials.
-o
Executes the command without prompting for confirmation.
EXAMPLE
The following example sets a username and secret for the system’s shared credentials
record:
naviseccli connection -setsharedauth -username user1
-secret abcdefghi123 -enable -o

OUTPUT
None if the command succeeds; status or error information if it fails.

connection -setsharedauth

223

VNX CLI for Block

connection -delsharedauth
Removes the system shared authentication credentials.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -delsharedauth function
removes the username and secret from the iSCSI initiator system.
SYNTAX
connection -delsharedauth[-o]
OPTIONS
-o
Executes the command without prompting for confirmation. If you include the -o
switch, you will not be prompted to confirm the user account deletion. If you do not
use the -o switch, you will be prompted to confirm that you want to delete the user
account data.
EXAMPLE
The following example removes the shared authentication credentials from the iSCSI
initiator system:
connection -delsharedauth -o

OUTPUT
None if the command succeeds; status or error information if it fails.

connection -getsharedauth
Displays the username and status of the shared authentication for the iSCSI initiator
system
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -getsharedauth function
displays the username and status of the shared authentication for the iSCSI initiator
system.
SYNTAX
connection -getsharedauth
EXAMPLE
The following example displays the username and status of the shared authentication for
the iSCSI initiator system:
connection -getsharedauth

OUTPUT
User Name: user1
Enabled: True

224

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

If no shared credentials are defined for the system, then the output is:
No system shared credentials are defined.

connection -addset
Adds a connection set.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -addset function adds a
connection set to the connection set database.
SYNTAX
connection -addset -name name
[-digest none|Header|Data|Both]
[-authpolicy none|shared|setspecific -userName userName
-secret secret [-hexsecret] ] [-o]
OPTIONS
-name name
Specifies a unique identifier for the connection set. It is an arbitrary name supplied
by the administrator that indicates the specific connection set using the CLI or UI.
-digest none | Header | Data | Both
Indicates the type of digest, a data protection mechanism, which is turned on for
connections established through this connection set.
Header indicates that the iSCSI packet headers have a checksum applied and
verified.
Data indicates that the data portion of the iSCSI packet have a checksum applied
and verified.Both indicates that both the headers and the data portion of the iSCSI
packet have a checksum applied and verified.
-authpolicy none | shared | setspecific
Defines the type of authentication this connection set uses.
none specifies that no credentials are needed to connect to the target system.
shared specifies that the system shared authentication credentials are used to
authenticate.
setspecific indicates that the username and secret stored as part of this connection
set are used for authentication.
-userName userName
Specifies the CHAP username used by the initiator when challenged by the target
system. For CHAP, a username and secret must be defined.
-secret secret
Specifies the CHAP secret to be used with the username when challenged by the
target system. You can specify the secret in ASCII or hexadecimal characters (see the
-hexsecret switch that follows). By default, -secret is an ASCII string. ASCII
secrets must consist of at least 12 and no more than 16 characters. Hexadecimal
secrets must consist of at least 12 and no more than 16 pairs of data (24 to 32
characters).
-hexsecret
If initiator user account data is being added, including the -hexsecret parameter
specifies that -secret is a hexadecimal value.
connection -addset

225

VNX CLI for Block

-o
Executes the command without prompting for confirmation.
EXAMPLE
The following example adds a connection set to the connection set database:
connection -addset -name MirrorSet -authpolicy none -digest none -o

OUTPUT
None if the command succeeds; status or error information if it fails.

connection -delset
Deletes a connection set and associated connection paths.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -delset function deletes a
connection set and its associated connection paths by the name of the connection set.
SYNTAX
connection -delset -name name [-o]
OPTIONS
-name name
Specifies a unique identifier for the connection set. It is an arbitrary name supplied
by the administrator that indicates the specific connection set using the CLI or UI.
-o
Executes the command without prompting for confirmation. If you include the -o
switch, you will not be prompted to confirm the user account deletion. If you do not
use the -o switch, you will be prompted to confirm that you want to delete the user
account data.
EXAMPLE
The following example deletes a connection set and associated connection paths using
the name of the connection:
connection -delset -name MirrorSet -o

OUTPUT
None if the command succeeds; status or error information if it fails.

connection -modifyset
Modifies parameters of a connection set.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -modifyset function modifies parameters of
a connection set.
Note

You cannot change the name of the connection with this command.

226

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

SYNTAX
connection -modifyset -name name [-digest None|Header|Data|
Both] [-authpolicy none|shared|setspecific -userName
userName -secret secret [-hexsecret] ] [-o]
OPTIONS
-name name
Specifies a unique identifier for the connection set.
-digest None | Header | Data | Both
Indicates the type of digest, which is turned on for connections established through
this connection set.
Header indicates that the iSCSI packet headers have a checksum applied and
verified.
Data indicates that the data portion of the iSCSI packet have a checksum applied
and verified.
Both indicates that both the headers and the data portion of the iSCSI packet have a
checksum applied and verified.
-authpolicy none | shared | setspecific
Defines the type of authentication this connection set uses.
none specifies that no credentials are needed to connect to the target system.
shared specifies that the system shared authentication credentials are used for
authentication.
setspecific indicates that the username and secret stored as part of this connection
set are used for authentication.
-userName userName
Specifies the CHAP username used by the initiator when challenged by the target
system. For CHAP, a username and secret must be defined.
-secret secret
Specifies the CHAP secret to be used with the username when challenged by the
target system. You can specify the secret in ASCII or hexadecimal characters (see the
-hexsecret switch that follows). By default, -secret is an ASCII string. ASCII
secrets must consist of at least 12 and no more than 16 characters. Hexadecimal
secrets must consist of at least 12 and no more than 16 pairs of data (24 to 32
characters).
-hexsecret
If initiator user account data is being added, including the -hexsecret parameter
specifies that -secret is a hexadecimal value.
-o
Executes the command without prompting for confirmation.
EXAMPLE
The following example modifies the parameters of a connection:
connection -modifyset -name MirrorSet -authpolicy -setspecific
-username user2 -secret Twelve2Sixteen -o

OUTPUT
None if the command succeeds; status or error information if it fails.

connection -modifyset

227

VNX CLI for Block

connection -getset
Lists a specific connection set or all the connection sets
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -getset function lists a specific
connection set or all the connection sets and displays the contents of each set.
SYNTAX
connection -getset [-name name]
OPTIONS
-name name
Specifies a unique identifier for the connection set.
EXAMPLE
The following example lists a specific connection set:
connection -getset -name MirrorSet

OUTPUT
Connection Set Name: MirrorSet
User Name: username
Authentication Usage: SetSpecific
Header Digest: Disabled
Data Digest: Disabled
IP Address of Target: 192.168.0.1
Listening IP Port of Target: 3260
SP Ports: A-0 A-1 B-0 B-1
Description: any comments that were entered.

Sample output if the system (CX4 series) has virtual ports:
Connection Set Name: tryzub_generated
User Name: TRISHULA_MirrorViewGenerated
Authentication usage: Setspecific
Header Digest: Enabled
Data Digest: Enabled
IP Address of Target: 172.20.4.146
Listening IP port of Target: 3260
SP Ports: A-3v0 B-2v4
Description: Path to tryzub A-1, generated for MirrorView
Listening IP port of Target: 3260
SP Ports: B-3v1
Description: Path to tryzub B-1, generated for MirrorView

connection -addpath
Adds a connection path to a specific connection set.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -addpath function adds a
connection path to a specific connection set. A connection path consists of the IP
address of the target system, front-end ports used, and a comment field.
228

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

SYNTAX
connection -addpath -name name -target address[:port] [-sp a|b
-portid portid [-vportid vportid]] [comment text] [-o]
OPTIONS
-name name
Specifies the name of the connection set to which you will add the connection path.
-target address:port
Specifies the IP address and listening port (default 3260) of the target system.
-sp a|b
Specifies the storage processor on the initiating system used for the session.
-portid portid
Specifies the front-end port number on the storage processor of the initiating system
to be used for the session.
-vportid vportid
Specifies the virtual port number for the session. If you do not specify the virtual port
number, then the system defaults to virtual port 0.
-comment text
Specifies a comment or description of the connection path.
-o
Executes the command without prompting for confirmation.
EXAMPLE
The following example adds a connection path to the specific connection set:
connection -addpath -name MirrorSet -target 123.231.1.1 -sp a
-portid 3 -comment mirrorview connection path -o

OUTPUT
None if the command succeeds; status or error information if it fails.

connection -delpath
Deletes a connection path from a connection set.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -delpath function deletes a
connection path from a connection set.
Note

You must have an IP address and optional port number to complete this command.
SYNTAX
connection -delpath -name name -target address[:port] [-o]
OPTIONS
-name name
Specifies the name of the connection set, which includes the path you want to
delete.
-target address:port
Specifies the IP address and listening port (default 3260) of the target system.
-o
connection -delpath

229

VNX CLI for Block

Standard override option. Without this option, the user is prompted to confirm
intent.
EXAMPLE
The following example deletes a connection path from a connection set:
connection -delpath -name MirrorSet -target 123.231.1.1 -o

OUTPUT
None if the command succeeds; status or error information if it fails.

connection -modifypath
Modifies the parameters of a connection path.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -modifypath function modifies
the parameters of a connection path.
Note

You must have an IP address and optional port number to complete this command.
SYNTAX
connection -modifypath -name name -target address[:port] -add
-sp a|b -portid portid [-vportid vportid] [-comment text]
[-o] |
-add -comment text [-o] | -del -sp a|b -portid
portid [-vportid vportid] [-o]
OPTIONS
-name name
Specifies the name of the connection set, which includes the path you want to
modify.
-target address:port
Specifies the IP address and listening port (default 3260) of the target system.
-sp a|b
Specifies the storage processor on the initiating system used for the session.
-portid portid
Specifies the front-end port number on the storage processor of the initiating system
to be used for the session.
-vportid vportid
Specifies the virtual port number to be used for the session. If the virtual port
number is not specified, the system defaults to virtual port 0.
-comment text
Specifies a new comment added to the connection path.
-o
Standard override option. Without this option, the user is prompted to confirm
intent.
EXAMPLE
The following example modifies a connection path from a connection set:

230

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

connection -modifypath -name MirrorSet -target 23.231.1.1 -add -sp
b -portid 3 -o

OUTPUT
None if the command succeeds; status or error information if it fails.

connection -verifypath
Tests the parameters of a connection path.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli connection command with the -verifypath function tests the
parameter of a connection path.
Note

A connection set name, an IP address, and an optional port number are needed to
complete this command.
SYNTAX
connection -verifypath -name name -target address[:port]
[-sp a|b -portid portid [-vportid vportid] ]
OPTIONS
-name name
Specifies the name of the connection set, which contains the path to verify.
-target address:port
Specifies the IP address and listening port (default 3260) of the target system.
-sp a|b
Specifies the storage processor on the initiating system used for the session.
-portid portid
Specifies the front-end port number on the storage processor of the initiating system
to be used for the session.
-vportid vportid
Specifies the virtual port number to be used for the session. If the virtual port
number is not specified, the system defaults to virtual port 0.
-o
Standard override option. Without this option, the user is prompted to confirm
intent.
EXAMPLE
The following example tests a connection path from a connection set:
Connection -verifypath -name MirrorSet -target 23.231.1.1 -o

OUTPUT
Test/verify command for target {ipaddr[:portnum]} from
{fe port} completed successfully.

connection -verifypath

231

VNX CLI for Block

isns -addserver
Adds an iSNS server to a system’s iSNS service configuration.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli isns command with the -addserver function adds an iSNS server
to a system’s iSNS service configuration.
When you add a server, if it is the first server you add to a system’s iSNS service
configuration, it is designated as the primary server. If a server exists in the system’s
iSNS service configuration, any subsequent server you add is designated as a backup.
Note

The primary server is the server the iSNS service actively communicates with.
SYNTAX
isns -addserver IPAddr [-o]
OPTIONS
IPAddr
The IP address of the iSNS server you want to add.
Note

You must identify the iSNS server by the server’s IP address. Specify the IP address
in the form b.c.d.e where b, c, d and e range from 0 through 255, for example,
111.222.33.44.
-o
Executes the command without prompting for confirmation.
EXAMPLE
The following example adds the specified iSNS server, to the system’s iSNS service
configuration:
naviseccli -address ss1_spa isns -addserver 111.222.33.44
Adding an iSNS server with the following IP address: 111.222.33.44.
Do you really want to perform this action (y/n)? y

OUTPUT
None if the command succeeds; status or error information if it fails.

isns -deleteserver
Deletes an iSNS server from a system’s iSNS service configuration.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli isns command with the -deleteserver function, deletes an iSNS
server from a system’s iSNS service configuration.

232

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Note

If the IP address of the server you want to delete is not configured, you will receive an
error message.
If you delete a primary server, the next server listed in the system’s iSNS service
configuration becomes the primary.
Note

The primary server is the server the iSNS service actively communicates with.
SYNTAX
isns -deleteserver IPAddr [-o]
OPTIONS
IPAddr
The IP address of the iSNS server you want to delete.
Note

You must identify the iSNS server by the server’s IP address. Specify the IP address
in the form b.c.d.e where b, c, d and e range from 0 through 255, for example,
111.222.33.44.
-o
Executes the command without prompting for confirmation.
EXAMPLE
The following example deletes the specified iSNS server from the system’s iSNS
configuration:
naviseccli -address ss1_spa isns -deleteserver 111.222.33.44
Deleting an iSNS server with the following IP address:
111.222.33.44.
Do you really want to perform this action (y/n)? y

OUTPUT
None if the command succeeds; status or error information if it fails.

isns -listserver
Displays all iSNS servers that are configured in the system’s iSNS service.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli isns command with the -listserver function, lists all servers
that are configured in a system’s iSNS service.
If multiple servers are configured in the system’s iSNS service, the -listserver
operation will list multiple IP addresses and server types. You can have only one primary
server; therefore you will only have one server designated as the primary. All other
servers are designated as backup servers.

isns -listserver

233

VNX CLI for Block

Note

The primary server is the server the iSNS service actively communicates with.
SYNTAX
isns -listserver
EXAMPLE
The following example lists the primary and backup iSNS servers for the system:
naviseccli -address ss1_spa isns -listserver

OUTPUT
IP Address: 111.222.33.44
Server Type: Backup
IP Address: 111.222.33.45
Server Type: Primary

IP Address is the IP address of the iSNS server. Server Type specifies whether the server
is set as the primary or backup server.

isns -setprimary
Sets a configured iSNS server as the primary server for a system’s iSNS service
configuration.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli isns command with the -setprimary function, establishes a
configured iSNS server as the primary server in a system’s iSNS service configuration. The
primary server is the server the iSNS service actively communicates with. You can have
only one primary server.
Note

If the IP address of the server you specify to be the primary server is not configured, you
will receive an error message.
Use this command when you want to change the primary server in a system’s iSNS
service configuration. You can also use this command to re-establish a primary server
after a failover. When a failure occurs that takes the existing primary server out of service,
the iSNS service automatically establishes a backup server as the new primary server.
You can use the isns -setprimary command to restore the original primary server as
the primary server.
Note

If you have more than one backup server, the first backup server listed becomes the new
primary server (see isns -listserver).
SYNTAX
isns -setprimary IPAddr [-o]
OPTIONS
IPAddr
The IP address of the iSNS server you want to designate as the primary server.
234

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Note

You must identify the iSNS server by the server’s IP address. Specify the IP address
in the form b.c.d.e where b, c, d and e range from 0 through 255, for example,
111.222.33.44.
-o
Executes the command without prompting for confirmation.
EXAMPLE
The following example establishes the specified iSNS server as the primary server:
naviseccli -address ss1_spa isns -setprimary 111.222.33.44
The listed IP Address will become the Primary iSNS
server: 111.222.33.44.
Do you really want to perform this action (y/n)? y

OUTPUT
None if the command succeeds; status or error information if it fails.

LUN Migration commands
This section explains the VNX CLI for Block commands that manage LUN migration.
LUN migration lets you improve the performance of a LUN by migrating the data from the
source LUN to a destination LUN that has more desirable performance characteristics.

migrate -start
Starts a LUN migration session.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli migrate command with the -start switch starts a LUN migration
session.
Note

If the maximum number of migrations already exists on the subsystem, the new session
is still created, but its state is queued.
For raw device mapping volumes (RDMs), if you are running VMware ESX Server and you
are using the migration feature to copy LUNs to larger LUNs only, after you complete the
migration you must rescan the bus at the ESX Server level. You can also rescan at the
virtual machine level (optional). You then must expand the file system at the virtual
machine level. ESX Server and the virtual machine will now recognize the completed
migration.
For configuration specifications, go to the E-Lab Interoperability Navigator on EMC Online
Support.
SYNTAX
migrate -start -source number|WWN -dest number|WWN -rate low|
medium|high|ASAP|value [-destroySnapshots] [-o]

LUN Migration commands

235

VNX CLI for Block

OPTIONS
-source number|WWN
Specifies the source LUN for the migration. You can specify the LUN ID or World Wide
Name (WWN).
-dest number|WWN
Specifies the destination LUN of the migration. You can specify the LUN ID or World
Wide Name.
Note

The destination LUN must be the same size or larger than the source LUN.
-rate low|medium|high|ASAP|value
Specifies the LUN migration rate. Valid rates are low or 0, medium or 1, high or 2,
and ASAP or 3.
Note

Do not use the ASAP migration rate when the system is in production, as the normal
host I/O may be interrupted. Use ASAP only when the system is offline (free of any
host-level I/O).
-destroySnapshots
Deletes snapshots automatically after migration if source LUN has snapshots,
including any snapshots that were taken of consistency groups while this LUN was a
member.
-o
Executes the command without prompting for confirmation.
EXAMPLE
This command starts a LUN migration session where the source LUN’s ID is 6, the
destination LUN’s ID is 7, and the LUN migration rate is low.
naviseccli migrate -start -source 6 -dest 7 -rate low

OUTPUT
None if the command succeeds; status or error information if it fails.

migrate -cancel
Cancels a LUN migration session.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli migrate command with the -cancel switch cancels an in-process
LUN migration. The destination LUN is deleted when canceling occurs. Canceling the
migration does not cause any data loss. The original LUN remains unchanged.
Note

You can cancel only one migration at a time.
SYNTAX
migrate -cancel -source number|WWN [-o]

236

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

OPTIONS
-source number|WWN
Specifies the source LUN for migration as the LUN ID or World Wide Name (WWN).
-o
Executes the command without prompting for confirmation.
EXAMPLE
This command cancels a LUN migration session whose source LUN’s ID is 6.
naviseccli migrate -cancel -source 6

OUTPUT
None if the command succeeds; status or error information if it fails.

migrate -modify
Modifies a LUN migration session.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli migrate command with the -modify switch modifies a LUN
migration session according to the parameters you specify.
SYNTAX
migrate -modify -source number|WWN [-rate low|medium|high|ASAP|
value] [-o]
OPTIONS
-source number|WWN
Specifies the source LUN of the migration you want to modify. You can specify the
LUN ID or World Wide Name (WWN).
-rate low|medium|high|ASAP|value
Specifies the LUN migration rate. Valid rates are low or 0, medium or 1, high or 2,
and ASAP or 3.
Note

Do not use the ASAP migration rate when the system is in production, as the normal
host I/O may be interrupted.
Use ASAP only when the system is offline (free of any host-level I/O).
-o
Executes the command without prompting for confirmation.
EXAMPLE
This command modifies the LUN migration rate to medium.
naviseccli migrate -modify -source 6 -rate medium

OUTPUT
None if the command succeeds; status or error information if it fails.

migrate -modify

237

VNX CLI for Block

migrate -list
Lists LUN migration sessions and their properties.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli migrate command with the -list switch lists the existing LUN
migration sessions and their properties.
SYNTAX
migrate -list [-source number|WWN]
[-dest]
[-rate]
[-state]
[-percentcomplete]
[-timeremaining]
OPTIONS
-source number|WWN
Specifies the source LUN of the migration. You can specify the LUN ID or World Wide
Name (WWN). If you specify the -source switch with a LUN, the command lists
properties for only that migration. If you do not specify a source LUN, the output lists
the properties for all migrations.
-dest
Displays the destination LUN.
-rate
Displays the LUN migration rate as low, medium, high, or ASAP.
-state
Displays the migration state as queued, migrating, migrated, transitioning, or
faulted.
-percentcomplete
Displays the percentage of the migration that has completed.
-timeremaining
Displays the estimated time remaining for the migration to complete. For the first
poll cycle after the migration is started, the Time Remaining field is displayed as ?
(question mark).
EXAMPLE
This command lists the migration sessions and their properties.
naviseccli migrate -list

OUTPUT
Source LU Name: LUN 6
Source LU ID: 6
Dest LU Name: LUN 7
Dest LU ID: 7
Migration Rate: LOW
Current State: MIGRATING
Percent Complete: 12
Time Remaining: 1 minute(s)

238

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Domain and Security commands
This section provides a brief overview of the domain and security features, and includes a
list of commands you can use to manage system domains and user access to systems.

About domains and user accounts
A domain is a group of one or more systems with Storage Management Server software
whose SPs are connected to a network and which have been assigned to the domain by
VNX CLI for Block or Unisphere. Each domain has a master node (master system) that
maintains the master copy of the domain data — the systems and global user accounts
that make up the domain.
Setting up a domain allows a group of systems to be monitored and managed using a
single login. Even if you plan to use a system by itself (manage it separately), we suggest
that you create a domain for that system.
Note

When you setup a user account, you assign a scope of either global, local, or LDAP.
Global user accounts apply to all systems within a domain. Local user accounts apply to a
specific system. LDAP uses an external server to authenticate accounts for an entire
domain.
VNX CLI for Block versions 6.24 and later support lightweight directory access protocol
(LDAP). This requires an active and operational LDAP environment to which you can
connect Unisphere security for the purpose of sharing user accounts and authenticating
usernames and passwords.
Administrators can manage accounts in a centralized directory accessible to multiple
applications. Users can use their LDAP credentials to log in and perform Unisphere and
CLI operations.
Note

In order to issue domain CLI commands, you must have global administrator privileges.
A user (that is, someone who needs to view or manage system operations) can have one
of these roles:
l

Administrator

l

Security Administrator

l

Manager

l

Monitor

l

Replication

l

Local replication

l

Replication/recovery

Note

To issue security CLI commands for user account setup, modification, or removal you
must have administrator privileges. Global administrators can manage both global and
local user accounts. Local administrators can manage only local user accounts. Table 4
provides an explanation of operations that can be performed by role and scope.
Domain and Security commands

239

VNX CLI for Block

You can assign a user a role globally (the user has the role across all systems in the
domain) or locally (the user has the role on a specific system only). Each global username
must be unique in the domain; each local username must be unique within the local
management server.
Note

Usernames and passwords can be 1 to 32 characters, including letters (case sensitive),
numbers, underscores, non-numeric, non-alpha characters, spaces, and must start with a
letter.
Operations that users with different roles can perform on page 240 defines the
operations a user can perform by role and scope.
Table 12 Operations that users with different roles can perform

User role

Can view

Can add, modify, or delete

Administrator

All domain and system
settings, and global and
local accounts

All domain and system settings, and
global and local accounts (cannot delete
the last global administrator account)

Currently, the following security administrator roles are supported only on CX and CX3 series
systems running VNX OE for Block version 02.26.xxx.yyy.zzz or higher.
Security Administrator

All security-related features, All security features. Cannot see or
global and local accounts
manage system features

Manager

All system settings in
domain

All system settings in domain

Monitor

All system settings in
domain

Nothing

Local Replication

All system settings in
domain

Some operations of MirrorView, SAN
Copy, and SnapView (see Actions
permission on page 240)

Replication

All system settings in
domain

Some operations of MirrorView, SAN
Copy, and SnapView (see Actions
permission on page 240)

Replication and
recovery

All system settings in
domain

Some operations of MirrorView, SAN
Copy, and SnapView (see Actions
permission on page 240)

Table 13 Actions permission

Command

Local replication Replication Replication/
Recovery

SnapView

240

Start a (consistent) snap session

Yes

Yes

Yes

Stop a (consistent) snap session

Yes

Yes

Yes

Activate a session to a snapshot LUN

Yes

Yes

Yes

Deactivate a session from a snapshot
LUN

Yes

Yes

Yes

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Table 13 Actions permission (continued)

Command

Local replication Replication Replication/
Recovery

Synchronize a clone

Yes

Yes

Yes

Fracture a clone

Yes

Yes

Yes

Rollback a snap session

No

No

Yes

Reverse synchronize a clone

No

No

Yes

Synchronize a mirror/consistency
group

No

Yes

Yes

Fracture a mirror/consistency group

No

No

Yes

Control the update parameters of an
asynchronous mirror

No

Yes

Yes

Modify the update frequency of an
asynchronous mirror

No

Yes

Yes

Throttle a mirror/consistency group

No

Yes

Yes

Promote a synchronous or
asynchronous secondary mirror/
consistency group

No

No

Yes

Start a session

No

Yes

Yes

Stop a session

No

Yes

Yes

Pause a session

No

Yes

Yes

Resume a session

No

Yes

Yes

Mark a session

No

Yes

Yes

Unmark a session

No

Yes

Yes

Verify a session

No

Yes

Yes

Throttle a session

No

Yes

Yes

MirrorView

SAN Copy

About LDAP and Active Directory
Unisphere supports the Lightweight Directory Access Protocol (LDAP). Since Microsoft
Active Directory is based on LDAP, Active Directory (AD) is supported as well. LDAP uses
an active and operational LDAP environment, which allows systems to share LDAP user
accounts and username/password authentication.
The administrator and security administrator can then manage the external servers. Users
can use their LDAP credentials to log in and perform CLI operations. You must map
groups and/or users from the LDAP-compliant directory service to their roles
(Administrator and Monitor) using the security -ldap commands.
Use these commands to specify the LDAP or AD server you intend to use in your domain,
and to map roles to users and user groups in the LDAP server directory.
About domains and user accounts

241

VNX CLI for Block

This feature also supports advanced functions, such as specifying attributes for which
user IDs and user/group common names are appended in the LDAP/AD server, defining
user and group object classes, and mapping roles to additional servers.
Consult with your site LDAP administrator to determine the correct parameters.
navisecclidomain and security commands on page 239 provides the list of security ldap commands used to configure the LDAP settings.

Domain and security commands overview
The commands in this section include the domain and security commands. The following
table identifies the commands.
Table 14 naviseccli domain and security commands

Command

Description
Domain commands

domain -add

Adds one or more systems to a domain.

domain -list

Displays all systems in a domain.

domain -remove

Removes a system from a domain.

domain -setmaster

Sets a system as the master system in a
domain.

domain -uninitialize

Destroys the domain and security configuration
of the system.

ntp -list

Lists the NTP configuration settings in a domain.

ntp -set

Modifies the NTP configuration in a domain.
Security commands

security -adduser

Creates a user account.

security -changeuserinfo

Changes the password and/or role of a user
account.

security -list

Displays user accounts.

security -listrole

Lists the user’s security role.

security -rmuser

Deletes a user account.
Security LDAP commands

242

security -ldap -addServer

Creates a new LDAP directory server.

security -ldap -modifyserver

Modifies the external server login configuration.

security -ldap -removeserver

Removes a server.

security -ldap -listserver

Lists the LDAP external server information.

security -ldap -addrolemapping

Creates a new role mapping.

security -ldap -modifyrolemapping

Modifies the role mapping.

security -ldap -removerolemapping

Removes the role mapping entity.

security -ldap -listrolemapping

Lists the role mapping entity.

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Table 14 naviseccli domain and security commands (continued)

Command

Description

security -ldap -synchronize

Synchronizes the accounts.

Security Certificate commands
security -certificate -add

Imports the certificate.

security -certificate -remove

Removes the specified certificate.

security -certificate -list

Lists all certificates.

security -certificate -alert BeforeExpiration

Indicates that an alert should be generated prior
to the expiration of the SSL/TLS certificate.

security -pkcs12upload

Uploads a PKCS #12 file which contains a
certificate and private key to the storage system.

security -SPcertificate -generate

Generates a new self-signed certificate and
replaces the one currently in use.

Security FIPS commands
security –fipsmode -set

Sets the FIPS mode of Unisphere.

security –fipsmode -get

Gets the FIPS mode of Unisphere.
Other Security commands

security -setport

Sets the http/https ports that Unisphere uses.

security -trustedclient -enable

Enables or disables IP Filter for all storage
systems supporting filtering.

security -trustedclient -add

Adds an IP Filter to the storage system.

security -trustedclient -list

Lists the current IP Filters for the storage system.

security -trustedclient -re

Removes IP Filters from the storage system.

domain -add
Adds system to a domain.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli domain command with the -add function, adds the system you
specify to the system domain. You can add only one system to the domain one time.
When you add a system to the domain, you specify the system’s IP address.
See domain -setmaster if you need to establish a domain. You then can add system to
the domain using domain -add.
The -olduser, -oldpassword, and -oldscope are optional switches. These
switches must be provided all together or none of them must be provided. If none of
them are provided, the user account, sysadmin with global scope is used as a default
user to operate on the system.

domain -add

243

VNX CLI for Block

Only one IP address is supported. If multiple IP addresses are provided, displays the error
message,
Invalid Command. Too many parameters Please also make sure only
ONE ip address is provided.
If the user uses domain -add to add File or Unified systems into a domain without
System account, the command fails and displays the error message,
Domain add operation failed. The local domain does not have a
system account, which is required when adding a file or unified
system into a domain. Create a system administrator account in
order to continue with adding this system into the domain.
Any File or Unified system is allowed to be added into another domain, only if it is in a
domain. Otherwise, displays the error message,
Domain add operation failed.Security is not initialized.
Security must be initialized before any domain operations can
be performed in this system. Create a global administrator to
initialize security. 10.244.212.164.
SYNTAX
domain -add IPAddr [[-olduser olduser][-oldpassword
oldpassword][-oldscope oldscope]][-o]
OPTIONS
IPAddr
The IP address of the system you want to add.
Note

You must identify the system by the system’s IP address. Specify the IP address in
the form b.c.d.e where b, c, d and e range from 0 through 255, for example,
111.222.33.44.
-olduser olduser
Specifies a valid username in the old domain.
-oldpassword oldpassword
Specifies the matching password for the -olduser.
-oldscope oldscope
Specifies the valid scope for the -olduser.
-o
Executes the command without prompting for confirmation.
EXAMPLE #1
The following example adds the specified systems, to the system domain:
naviseccli -address ss1_spa domain -add 111.222.33.44 111.222.33.45
WARNING: You are about to add following node(s) to
the domain.
111.222.33.44
111.222.33.45
Proceed? (y/n) y

EXAMPLE #2
naviseccli -h 10.14.22.33 -user a –password a –scope global domain
–add 10.14.33.44 –olduser b –oldpassword b –scope global

244

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

EXAMPLE #3
If any of the switches, -olduser, -oldpassword, or -oldscope are missing, the
following error messages are displayed accordingly:
C:\>naviseccli -h 10.244.212.164 domain -add 10.244.211.204 -oldscope
global
Invalid command line parameters.
remote system: -oldscope

Please provide the scope for the

C:\>naviseccli -h 10.244.212.164 domain -add 10.244.211.204 -olduser
global
Invalid command line parameters.
the remote system: -olduser

Please provide the user name for

C:\>naviseccli -h 10.244.212.164 domain -add 10.244.211.204 oldpassword global
Invalid command line parameters.
remote system: -oldpassword

Please provide the password for the

OUTPUT
None if the command succeeds; status or error information if it fails.

domain -list
Displays all systems in a domain.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli domain command with the -list function, lists the IP address,
name, port and secure port information for all systems in a system domain. If you want to
view only information about the master system in the domain, you can use the optional master switch.
Note

You can have only one master system in a domain (see domain -setmaster on page 248).
SYNTAX
domain -list [-master]
OPTIONS
-master
Displays only information about the master system in the domain.
EXAMPLE
The following example lists the systems in the system domain:
naviseccli -address 111.222.33.44 domain -list

OUTPUT
Node:
IP Address:
(Master)

APM00011111111
111.222.33.55

domain -list

245

VNX CLI for Block

Name:
Port:
Secure Port:
IP Address:
Name:
Port:
Secure Port:

CX300I_33_55
80
443
111.222.33.44
CX300I_33_44
80
443

domain -remove
Removes a system from a domain.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
The software package VNX-Block-Operating-Environment must be committed before this
operation is allowed.
DESCRIPTION
The naviseccli domain command with the -remove function removes the system
you specify from a system domain. When you remove a system from a domain, you
specify the system’s IP address.
If you want to move a system to a different domain, use domain -remove to remove
the system from the current domain, then domain -add to add the system to the other
domain.
Note

If you remove the master system from the domain, you destroy the domain. The CLI warns
you before you can complete the operation. If the system you want to move is the master
system in the domain, and you want to retain the domain, then you should change the
master system to another system in the domain before moving the old master (see
domain -setmaster on page 248).
SYNTAX
domain -remove IPAddr[-passwordpassword][-o]
OPTIONS
IPAddr
The IP address of the system you want to remove.
Note

You must identify the system by the system’s IP address. Specify the IP address in
the form b.c.d.e where b, c, d and e range from 0 through 255, for example,
111.222.33.44.
-password password
Overrides the default password for the global administrator.
NOTICE

You must override the default password. If you don’t override it, the system accepts
the default password that may pose a high security risk.
-o
Executes the command without prompting for confirmation.

246

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

EXAMPLE
The following example removes the specified system, from the system domain:
naviseccli -address ss1_spa domain -remove 111.222.33.44
WARNING: You are about to remove the following node
from the domain: 111.222.33.44
Proceed? (y/n) y

OUTPUT
None if the command succeeds; status or error information if it fails.

domain -uninitialize
Destroys the domain and security configuration of the system.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli domain command with the -uninitialize function destroys the
domain and security configuration of the system you specify. When you destroy the
domain and the security configuration of a system, you specify the system’s IP address.
Note

You can execute this command only on VNX Block-Only systems with a domain
containing only one VNX.
SYNTAX
domain -uninitialize IPAddr [-o]
OPTIONS
IPAddr
The IP address of the system whose domain and security configuration you need to
destroy.
-o
Executes the command without prompting for confirmation.

OUTPUT
E:\chenj20\temp\V1.1
naviseccli -h 10.244.211.132 domain
Invalid Command. Too few parameters
usage: domain
-add IPADDRESS [-olduser olduser] [-oldpassword oldpassword]
[-oldscope oldscope]
<-o>
-remove IPADDRESS [-password password] <-o>
-uninitialize IPADDRESS <-o>
-setmaster IPADDRESS <-o>
-list [-master]
naviseccli -h 10.244.211.132 domain -uninitialize 10.244.211.132
WARNING: You are about to remove the domain and security
configuration. Proceed? (y/n) y

domain -uninitialize

247

VNX CLI for Block

domain -setmaster
Sets a system as the master system in a domain.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli domain command with the -setmaster function, establishes the
system you specify as the master system in a domain. The master system holds the
master copy of all global account information in the domain. This information is copied to
all member systems in the domain. You can have only one master system in a domain.
You can use domain -setmaster to establish a domain or to change the master
system in an existing domain.
If you are using domain -setmaster to set up a domain, specify the IP address of a
new or existing system that is not part of an existing domain. This system becomes the
master and initializes the domain. You can then use the domain -add command to add
more systems to the domain.
When you use domain -setmaster to change the master system in an existing
domain, the existing master system is automatically demoted, and the system you
specify becomes the new master system.
SYNTAX
domain -setmaster IPAddr[-o]
OPTIONS
IPAddr
The IP address of the system you want to set as master.
Note

You must identify the system by the system’s IP address. Specify the IP address in
the form b.c.d.e where b, c, d and e range from 0 through 255, for example,
111.222.33.44.
-o
Executes the command without prompting for confirmation.
EXAMPLE
The following example sets the specified system as the master system in a domain:
naviseccli -address ss1_spa domain -setmaster 111.222.33.44
WARNING: You are about to set the following node as
the master of the domain: 111.222.33.44
Proceed? (y/n) y

OUTPUT
None if the command succeeds; status or error information if it fails.

ntp -list
Lists the NTP configuration settings in effect in a domain.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
248

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Only a security administrator or an administrator has the access rights.
You will receive an error message if access is denied or an invalid parameter is set.
DESCRIPTION
The naviseccli ntp command with the -list function, lists the Network Time
Protocol (NTP) configuration settings in effect in a domain.
SYNTAX
ntp -list |-control|-servers|-all
OPTIONS
-control
Displays start/stop and interval information.
-servers
Displays configured server addresses and any associated authentication
information.
-all
Displays all information.
EXAMPLE
The following example lists all the information:
naviseccli -user a -password a -scope 0 -address 10.5.1.207 ntp -list
-all

OUTPUT
Output: -all
start: YES
interval: 720 minutes
address: 10.5.1.207 128.221.142.13
serverkey: 0
keyvalue: ""
XML Output:
-list -all






0

true

NTPProvider

Operation
successfully completed. 



yes

30

10.5.4.211 128.222.132.13

1
0

"1234567812345678"
""



ntp -set
Modifies the NTP configuration in a domain.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
Only a security administrator or an administrator has access rights.
You will receive an error message if the access is denied or an invalid parameter is set.
DESCRIPTION
The naviseccli ntp command with the -set function modifies the NTP configuration
in a domain.
SYNTAX
ntp -set [-start yes|no] [-interval n -servers addr1 [addr2...]
-serverkey sk1 [sk2....] -keyvalue kval1 [kval2...]]
OPTIONS
-start yes|no
Yes starts NTP; no stops it. To start NTP, servers must have been defined and have
been displayed previously in a list command or while running this command.
-interval n
Specifies the synchronization interval in minutes ranging from 30 to 43200 (30
days).
-servers addr1 [addr2...]
Specifies the list of IPv4 NTP server addresses. At least one address must be
specified.
-serverkey sk1 [sk2...]
Specifies the list of the integer values (1-65534 inclusive). This option is required if
server authentication is desired. An ordered list is in the same order as -servers. A
value of 0 indicates no key will be used. In that case use a keyvalue of "". If
serverkey is used, every address entry must have a corresponding server key.
-keyvalue kval1 < kval2...>
Specifies the list of key values. This option is required if serverkey is specified. If
server authentication is not desired, keyvalue is not required. Enclose key values in
quotation marks. An empty value is simply a pair of quotation marks (for serverkey
value = 0). An ordered list is in the same order as serverkey above. Every server key
must have a key value. Valid key values are printable ASCII characters excluding the
space character and the # character. If specified, the length of each key must be
between 1 and 16 characters (empty value is described above).
250

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

EXAMPLE #1
Specifies all items for ss1_spa including server authentication.
naviseccli -address ss1_spa -set -start yes -interval
45 -servers 10.5.1.207 128.222.132.13 -serverkey
1 5 -keyvalue "1234567812345678" "abcdefghabcdefgh"

EXAMPLE #2
Specifies all items for ss1_spa including server authentication but the key for addr2 is
not specified.
naviseccli -address ss1_spa -set -start yes -interval
45 -servers 10.5.1.207 128.222.132.13 -serverkey
5 0 -keyvalue "1234567812345678" ""

EXAMPLE #3
Specifies items for ss1_spa choosing not to use server authentication.
naviseccli -address ss1_spa -set -start yes -interval
45 -servers 10.5.1.207

EXAMPLE #4
Stops (disables) NTP operations for ss1_spa.
Note

Does not affect synchronization interval or servers settings.
naviseccli -address ss1_spa -set -start no

EXAMPLE #5
Specifies the interval and server information for ss1_spa.
Note

Does not affect start/stop settings.
naviseccli -address ss1_spa -set -interval 45 -servers
10.5.1.207 128.222.132.13 -serverkey 5 0 -keyvalue
"1234567812345678" ""

OUTPUT
Varies depending on the switch you use.

security -adduser
Creates a user account.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
The software package VNX-Block-Operating-Environment must be committed before this
operation is allowed.
DESCRIPTION
The naviseccli security command with the -adduser function, adds a user
account to the system you specify. If you create a global account, it replicates to all
systems in the domain. When you add a user account, you specify the username,
password, scope and role.
security -adduser

251

VNX CLI for Block

System account is a special global administrator account which is used to issue CLI
command from File to Block. System account needs to be created immediately after the
upgrade to R31
The -type option differentiates the user account and system account. If –type is not
specified, the system creates the account of User type, by default.
Note

When you create the initial global administrator user account, you do not need to provide
a username and password at login.
SYNTAX
security -adduser -user username -password password -scope
global|local -role administrator|storageadmin|operator|
securityadministrator|dataprotection|localdataprotection|
datarecovery|sanadmin|networkadmin|nasadmin|vmadmin [-type
user|system] [-o]
OPTIONS
-user username
Specifies the username you want to create for the user account.
-password password
Specifies the password you want to create for the user account.
-scope global|local|LDAP
Specifies the scope (global, local, or LDAP) you want to apply to the user account.
-role administrator|storageadmin|operator|securityadministrator|dataprotection |
localdataprotection|datarecovery|sanadmin|networkadmin|nasadmin|vmadmin]
Specifies the role, administrator, storageadmin, operator, securityadministrator,
dataprotection, localdataprotection, datarecovery, sanadmin, networkadmin,
nasadmin, or vmadmin you want to apply to the user account.
-type user|system
If you specify user, a user account is created. If you specify system, a system account
is created. You cannot create more than one system account in a domain and a nonglobal or a non-administrator system account.
-o
Executes the command without prompting for confirmation.
EXAMPLE
The following example creates the initial global administrator account on the system. You
are then prompted to create a domain for the system you specify:
naviseccli -address ss1_spa security -adduser -user a -password
b -scope global -role administrator
Global security is not initialized. It is highly recommended
that you initialize global security.
Do you still want to continue? y
WARNING: You are about to add user:

a

Proceed?(y/n) y
This system is not in a domain. It is highly
recommended you create a new domain for this system.

252

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

OUTPUT
None if the command succeeds; status or error information if it fails.

security -changeuserinfo
Changes the password and/or role of a user account.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security command with the -changeuserinfo function,
modifies the password and/or role of a user account. When you modify a user account,
you specify the username and scope, then designate a new password and/or role.
Note

You can change the password in a user account without providing the user’s current
password.
Note

If a user attempts to change the role or the scope of an account with the System
designation, the command fails.
SYNTAX
security -changeuserinfo -user username -scope global|local
[-newpassword password] [-newrole administrator|manager|
monitor]
[-o]
OPTIONS
user username
Specifies the username of the user account you want to modify.
-scope global|local
Specifies the scope, global or local, of the user account you want to modify. A global
account has access to all systems in a domain.
-newpassword password
Specifies the new password you want to create for the user account.
-newrole administrator|manager|monitor
Specifies the new role, administrator, manager, or monitor, you want to apply to the
user account.
-o
Executes the command without prompting for confirmation.
EXAMPLE
The following example modifies the role of an existing user account:
naviseccli -address ss1_spa security -changeuserinfo -user
b -scope local -newrole manager
WARNING: You are about to change user:

b (local)

Proceed?(y/n) y

security -changeuserinfo

253

VNX CLI for Block

OUTPUT
None if the command succeeds; status or error information if it fails.

security -list
Displays user accounts.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security command with the -list function, lists the username,
scope, role of user accounts, and type of account.
Note

The security -list command is supported on all Unisphere systems.
SYNTAX
security –list [–user username] [–scope global|local] [-role
administrator|storageadmin|operator|securityadministrator|
dataprotection |localdataprotection|datarecovery|sanadmin|
networkadmin|nasadmin|vmadmin][-type]
OPTIONS
-user username
Identifies a specific username for which you want to display information.
-scope global|local
Identifies users with a specific scope for which you want to display information.
-role
Identifies users with a specific role for which you want to display information.
-type
Displays the type of account, either a user account or a system account.
EXAMPLE
The following example lists users with the specified scope and role:
naviseccli -address ss1_spa security -list –role
monitor -scope global

OUTPUT
Username:
Role:
Scope:

c
monitor
global

security -listrole
Lists the user’s security role.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
If no user account matches the query, an access denied error will be displayed.
DESCRIPTION
The naviseccli security command with the -listrole function, lists the user’s
security role.

254

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

SYNTAX
security -listrole
EXAMPLE
The following example lists the user’s security role:
naviseccli -h 10.14.83.44 security -listrole

OUTPUT
Role:

Administrator

security -rmuser
Deletes a user account.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security command with the -rmuser function, removes the user
account you specify. When you remove a user account, you specify the username and
scope.
Note

You must specify a scope for the user you want to remove, since you can establish two
user accounts with the same username and varying scopes, one global and one local.
SYNTAX
security –rmuser –user username –scope global|local [-o]
OPTIONS
-user username
Identifies the username of the account you want to remove.
-scope global|local
Specifies the scope, global or local, of the account you want to remove.
-o
Executes the command without prompting for confirmation.
EXAMPLE
The following example removes the specified user account:
naviseccli -address ss1_spa security -rmuser -user b -scope
local
WARNING: You are about to remove user:

b (local)

Proceed?(y/n) y

OUTPUT
None if the command succeeds; status or error information if it fails.

security -ldap -addserver
Creates a new LDAP directory server.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
security -rmuser

255

VNX CLI for Block

DESCRIPTION
The naviseccli security -ldap command with the -addserver subcommand
creates a new external server login configuration. Only a Unisphere security administrator
or administrator can connect your system to an LDAP or Active Directory (AD) service.
After defining the server connection settings, and mapping the user’s roles, users can log
in to the system with their LDAP username/password. Only two service connections can
be configured at a time.
System security must be initialized and a domain master must be selected before
configuring LDAP connection settings. Consult with the LDAP site administrator to
determine the correct parameters.
SYNTAX
security -ldap -addserver IPaddress -portnumber portnumber
-servertype LDAP|AD -protocol LDAP|LDAPS -binddn binddn
-bindpassword password -usersearchpath usersearchpath
[-groupsearchpath groupsearchpath] [-useridattribute attribute]
[-usernameattribute nameattribute] [-groupnameattribute
groupattribute] [-groupmemberattribute memberattribute]
[-userobjectclass objectclass] [-groupobjectclass groupclass]]
[-certpathToCertificatefile] [-o]
OPTIONS
IPaddress
Specifies the network IP address (IPv4) of the LDAP/AD server with the information
required to authenticate users.
-portnumber portnumber
Specifies the port number that the server will open to allow external programs to
access it. If the protocol is LDAP, the default port number is 389. If the protocol is
LDAPS, the default port number is 636.
-servertype LDAP|AD
Specifies whether the server is a LDAP directory or AD server. The default is LDAP.
-protocol LDAP|LDAPS
Lets you specify either LDAPS or LDAP protocol.
-binddn binddn
Specifies the login name for the LDAP/AD server; it cannot exceed 512 characters.
This field allows an LDAP-enabled application to access the targeted server and
search for a user ID/password to validate. It should be in "cn=, ou=, dc=, dc="
format.
-bindpassword password
Credentials used to authenticate the bind DN. If you specify the length of other
options such as -binddn, the length of bindpassword should also be specified here.
The bindPassword cannot exceed 512 characters.
-usersearchpath usersearchpath
Sets the path within the LDAP user entry database where a search for the username/
password begins. It cannot exceed 512 characters. It should be in "ou=, dc=, dc="
format.
-groupsearchpath groupsearchpath
Sets the path within the LDAP user-group entry database where a search for the
group name/password begins. It cannot exceed 512 characters. It should be in
"ou= , dc=, dc= " format. The option defaults to the User Search Path if you do not
specify the path.
-useridattribute useridattribute
Specifies the attribute to which the user ID will be appended in the LDAP/AD servers.
The directory hierarchy will be searched using this attribute/userid pair. The default
256

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

for an LDAP directory is uid and the default for an AD is sAMAccountName. It cannot
exceed 128 characters.
-usernameattribute nameattribute
Specifies the attribute to which the user’s common name (cn) will be appended in
the servers. The default is cn and it cannot exceed 128 characters.
-groupnameattribute groupattribute
Specifies the attribute to which the user group’s common name will be appended in
the servers. This is stored as an attribute of an entry within the Group Search Path of
the directory. The default is cn and it cannot exceed 128 characters.
-groupmemberattribute groupattribute
Acts as a search filter for the different attribute types to identify the different groups
of members. If you do not specify this field, then a search will be performed using
only the Group Name Attribute parameter. The default value for an LDAP directory is
uniqueMembers and the default for an AD is member. It cannot exceed 128
characters.
-userobjectclass objectclass
Defines the required and optional attributes so that the user entry can act as a
search filter in a situation where a user has multiple entries in a server. If you do not
specify this field, then a search will be performed using only the User ID Attribute
parameter. It cannot exceed 128 characters.
-groupobjectclass groupclass
Defines the required and optional attributes so that the group entry can act as a
search filter in a situation where a group has multiple entries in a server. If you do
not specify this field, then a search will be performed using only the Group Name
Attribute parameter. The default for an LDAP directory is groupOfUniqueNames and
the default for an AD is group. It cannot exceed 128 characters.
-cert pathToCertificatefile
Specifies the full pathname of the trusted certificate file to be uploaded to the
certificate store.
-o
Executes the command without prompting for confirmation.
EXAMPLE
naviseccli -h 10.32.123.229 -user a -password a -scope 0 security
-ldap -addserver 10.5.4.111 -portnumber 389 -servertype LDAP
-protocol LDAP -binddn cn=Manager,dc=ipv4,dc=com
-bindpassword ipv4int -usersearchpath ou=Users,dc=ipv4,dc=com

OUTPUT
None if the command succeeds; status or error information if it fails.

security -ldap -modifyserver
Modifies the external server login configuration.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -ldap command with the -modifyserver
subcommand modifies the settings that connect your system to an LDAP or AD service.
Consult with the LDAP/AD site administrator to determine the correct parameters. Only
the security administrator or administrator can execute this command.

security -ldap -modifyserver

257

VNX CLI for Block

SYNTAX
security -ldap -modifyserver IPaddress -bindpassword password
[-ldapserver IPaddress] [-portnumber portnumber] [-servertype
LDAP| AD] [-protocol LDAP| LDAPS] [-binddn binddn]
[-newbindpassword password] [-usersearchpath usersearchpath]
[-groupsearchpath groupsearchpath] [-useridattribute
useridattribute]
[-usernameattribute usernameattribute] [-groupnameattribute
groupnameattribute] [-groupmemberattribute
groupmemberattribute] [-userobjectclass userobjectclass]
[-groupobjectclass groupclass] [-o]
OPTIONS
IPaddress
Specifies the network IP address (IPv4) of the LDAP/AD server with the information
required to authenticate users.
-bindpassword password
Credentials used to authenticate the bind DN. If you specify the length of other
options such as -binddn, the length of bindpassword should also be specified
here. The bindpassword cannot exceed 512 characters.
-ldapserver IPaddress
Specifies the network IP address (IPv4) of the LDAP server.
-portnumber portnumber
Lets you specify the port number that the server will open to allow external programs
to access it. If the protocol is LDAP, the default port number is 389. If the protocol is
LDAPS, the default port number is 636.
-servertype LDAP|AD
Specifies whether the server is an LDAP directory or AD server. The default is LDAP.
-protocol LDAP|LDAPS
Lets you specify either LDAPS or LDAP protocol.
-binddn binddn
Specifies the login name for the LDAP/AD server; it cannot exceed 512 characters.
This field allows an LDAP-enabled application to access the targeted server and
search for a userid/password to validate. It should be in "cn=, ou=, dc=, dc="
format.
-newbindpassword password
Specifies the password that corresponds to the bind DN; and it cannot exceed 512
characters.
-usersearchpath usersearchpath
Sets the path within the LDAP user entry database where a search for the username/
password begins. It cannot exceed 512 characters. It should be in "ou=, dc=, dc="
format.
-groupsearchpath groupsearchpath
Sets the path within the LDAP user-group entry database where a search for the
group name/password begins. It cannot exceed 512 characters. It should be in
"ou= , dc=, dc= " format . The option defaults to the User Search Path if you do not
specify the path.
-useridattribute useridattribute
Specifies the attribute to which the user ID will be appended in the LDAP/AD servers.
The directory database is searched using this attribute/userid pair. The default for
an LDAP directory is uid and the default for an AD is sAMAccountName. It cannot
exceed 128 characters.
-usernameattribute usernameattribute
Specifies the attribute to which the user’s common name (cn) will be appended in
the servers. The default is cn. It cannot exceed 128 characters.
258

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

-groupnameattribute groupnameattribute
Specifies the attribute to which the user group’s common name will be appended in
the servers. This is stored as an attribute of an entry within the Group Search Path of
the directory. The default is cn. It cannot exceed 128 characters.
-groupmemberattribute groupmemberattribute
Acts as a search filter for the different attribute types to identify the different groups
of members. If you do not specify this field, then a search will be performed using
only the Group Name Attribute parameter. The default value for an LDAP directory is
uniqueMembers and the default for an AD is member. It cannot exceed 128
characters.
-userobjectclass userobjectclass
Defines the required and optional attributes so that the user entry can act as a
search filter in a situation where a user has multiple entries in a server. If you do not
specify this field, then a search will be performed using only the User ID Attribute
parameter. It cannot exceed 128 characters.
-groupobjectclass groupclass
Defines the required and optional attributes so that the group entry can act as a
search filter in a situation where a group has multiple entries in a server. If you do
not specify this field, then a search will be performed using only the Group Name
Attribute parameter. The default for an LDAP directory is groupOfUniqueNames, and
the default for an AD is group. It cannot exceed 128 characters.
-o
Executes the command without prompting for confirmation.
EXAMPLE
naviseccli -h 10.32.123.229 -user a -password a -scope 0 security
-ldap -modifyserver 10.5.4.250 -bindpassword crosstor -servertype
LDAP

OUTPUT
None if the command succeeds; status or error information if it fails.

security -ldap -removeserver
Removes a server.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -ldap command with the -removeserver
subcommand deletes an LDAP external server login configuration. It also destroys all role
mapping information related to the specified server. Only the security administrator or
administrator can execute the command.
SYNTAX
security -ldap -removeserver IPaddress [-o]
OPTIONS
IPaddress
Deletes the specified network IP address (IPv4) of the LDAP or the AD server.
-o
Executes the command without prompting for confirmation.
EXAMPLE
security -ldap -removeserver 10.5.4.250
security -ldap -removeserver

259

VNX CLI for Block

OUTPUT
None if the command succeeds; status or error information if it fails.

security -ldap -listserver
Lists the LDAP external server information.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -ldap -listserver command lists the existing
service connections, that the IP address of the LDAP server identifies. You can use the
optional switches to list a particular server. Only the security administrator or
administrator can execute the command.
SYNTAX
security -ldap -listserver [-primaryserver|-alternateserver]
OPTIONS
-primaryserver
Displays the primary server information. The connection, which is set up first, is
automatically designated as the primary and is contacted first to authenticate a user
or user request.
-alternateserver
Displays the alternate server information. The only way to change the alternate
server to primary is to delete the primary server.
EXAMPLE
Security -ldap -listserver
Primary Server Name: 10.5.4.111
Primary Server Port Number: 389
Primary Server Protocol: ldap
Primary Server ServerType: AD
Primary Server BindDn:
cn=administrator,cn=users,dc=NavilabTEST,dc=us,dc=dg,dc=
com
Primary Server UserSearchPath:
dc=NavilabTEST,dc=us,dc=dg,dc=com
Primary Server GroupSearchPath: groupsearchpath
Primary Server UserIDAttribute: testuid
Primary Server UserNameAttribute: usernameattribute
Primary Server GroupNameAttribute: groupnameattribute
Primary Server GroupMemberAttribute:
groupmemberattribute
Primary Server UserObjectClass(optional):
userobjectclass
Primary Server GroupObjectClass: groupclass
Alternate Server Name: 10.14.46.100
Alternate Server Port Number: 389
Alternate Server Protocol: ldap
Alternate Server ServerType: LDAP
Alternate Server BindDn: cn=root,dc=corp,dc=emc,dc=com
Alternate Server UserSearchPath:
ou=Group1,dc=corp,dc=emc,dc=com
Alternate Server GroupSearchPath: groupsearchpath
Alternate Server UserIDAttribute: useridattribute
Alternate Server UserNameAttribute: usernameattribute
Alternate Server GroupNameAttribute: groupnameattribute
Alternate Server GroupMemberAttribute:
groupmemberattribute

260

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Alternate Server UserObjectClass(optional):
userobjectclass
Alternate Server GroupObjectClass: groupclass

OUTPUT
None if the command succeeds; status or error information if it fails.

security -ldap -addrolemapping
Creates a new role mapping.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -ldap command with the -addrolemapping
subcommand creates a new role mapping entity for the corresponding external server.
You must initialize system security and select a domain master before configuring LDAP
connection settings. Consult with the LDAP administrator for your site to determine the
LDAP/AD names of users and groups to which you want to map Unisphere roles. Once
you have defined the server connection settings, and mapped the user’s roles, users can
log in to the system with their LDAP username/password. The roles are administrator,
manager, monitor, security administrator, replication, local replication, and replication/
recovery.
SYNTAX
security -ldap -addrolemapping IPaddress -name name -type
group|user -role role [-o]
OPTIONS
IPaddress
Specifies the network IP address (IPv4) of the LDAP or AD server with the information
required to authenticate users.
-name name
Specifies the name of the role that maps to Unisphere.
-type group|user
Specifies the type of role mapping. The group type of role mapping applies to a
group of people. The user type of role mapping applies to only one individual.
-role role
Specifies the user/group role that maps to Unisphere.
-o
Executes the command without prompting for confirmation.
EXAMPLE
security -ldap -addrolemapping 10.5.4.250 -name ldap4ipv4 -type
user -role administrator

OUTPUT
None if the command succeeds; status or error information if it fails.

security -ldap -modifyrolemapping
Modifies the role mapping.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
security -ldap -addrolemapping

261

VNX CLI for Block

DESCRIPTION
The naviseccli security -ldap command with the -modifyrolemapping
subcommand modifies the user or group role mappings to an LDAP or AD service.
SYNTAX
security -ldap -modifyrolemapping IPaddress -name name -type
group|user -role role [-o]
OPTIONS
IPaddress
Specifies the network IP address (IPv4) of the LDAP or the AD server.
-name name
Specifies the name of the role that maps to Unisphere.
-type group|user
Specifies the type of the role mapping to be modified. The group type of role
mapping applies to a group of people. The user type of role mapping applies to only
one individual.
-role role
Specifies the user/group role that maps to Unisphere.
-o
Executes the command without prompting for confirmation.
EXAMPLE
security -ldap -modifyrolemapping 10.5.4.250 -name test -type user
-role monitor

OUTPUT
None if the command succeeds; status or error information if it fails.

security -ldap -removerolemapping
Removes the role mapping entity.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -ldap command with the -removerolemapping
subcommand removes the role mapping entity from Unisphere for the corresponding
external server. Only the Unisphere administrator can remove user or group role
mappings to an LDAP or AD service.
You can delete all role mappings using the -all switch. To delete a particular role
mapping, specify the -name and -type switch.
SYNTAX
security -ldap -removerolemapping IPaddress [-name name -type
group|user] | [-all] [-o]
OPTIONS
IPaddress
Specifies the network IP address (IPv4) of the LDAP or the Active Directory server.
-name name -type group|user
Deletes role mapping with a specified role mapping name and type. The group type
of role mapping applies to a group of people. The user type of role mapping applies
to only one individual.
-all
262

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

-o

Deletes all role mappings.
Executes the command without prompting for confirmation.

EXAMPLE
security -ldap -removerolemapping 10.5.4.250 -name test -type user

OUTPUT
None if the command succeeds; status or error information if it fails.

security -ldap -listrolemapping
Lists a role mapping entity.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -ldap command with the -listrolemapping
subcommand lists the role mapping entity for the corresponding external server. It
displays the role mapping as a security administrator, administrator, manager, or
monitor. You can use the -name switch to list a particular role mapping.
SYNTAX
security -ldap -listrolemapping IPaddress [-name name]
OPTIONS
IPaddress
Specifies the network IP address (IPv4) of the LDAP or the AD server with the
information required to authenticate users.
-name name
Displays role mapping with the specified role mapping name.
EXAMPLE
security -ldap -listrolemapping 10.5.4.250

OUTPUT
Name: Test_1
Type: user
Role: administrator
Name: Test_2
Type: group
Role: security administrator

security -ldap -synchronize
Synchronizes the accounts.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -ldap command with the -synchronize
subcommand manually synchronizes the accounts with the current service.
security -ldap -listrolemapping

263

VNX CLI for Block

SYNTAX
security -ldap -synchronize [-o]
OPTIONS
-o
Executes the command without prompting for confirmation.
OUTPUT
None if the command succeeds; status or error information if it fails.

security -certificate -add
Imports the certificate.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The security -certificate -add command imports the certificate from the
certificate file. Secure CLI supports BASE64PEM format certificate.
SYNTAX
security –certificate -add -file filename [-client -role role]
OPTIONS
-file filename
Specifies the path of the certification on the local file system.
-client
Specifies that this is a client certificate and not a server certificate.
-role role
Specifies the role you want to apply to the client certificate.
EXAMPLE
naviseccli security –certificate –add -file c:\Node1.cer

security -certificate -remove
Removes the specified certificate.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -certificate -remove command removes the
specified certificate in certificate store.
SYNTAX
security –certificate –remove [-issuer issuer -serialnumber
serial number] [-client] |[-all]
OPTIONS
-issuerissuer
Specifies the issuer of the certificate that will be removed.
-serialnumberserial number
Specifies the certificate.
-all
Removes all certificates in the certificate store.
-client
264

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

Specifies that this is a client certificate rather than a server certificate.
EXAMPLE
naviseccli security –certificate –remove –issuer “CN=ICA1 1rst
Intermediate CA – Signed by Root, OU=CSP, O=RSA, ST=MA,C=US”
-serialNumber 00e2

security -certificate -list
Lists the certificates.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -certificate -list command lists all certificates
in the certificate store. Use the expire option to list only the expired certificate.
SYNTAX
security -certificate –list
[-client][-showOnly expired]
OPTIONS
-showOnly expired
Lists only the expired certificates.
-client
Lists the client SSL certificates.
EXAMPLE
naviseccli security –certificate –list

OUTPUT
_____________________________________________________________________
------------Subject:
CN=TrustedRoot,C=US,ST=MA,L=Hopkinton,EMAIL=rsa@emc.com,OU=CSP,O=RSA
Issuer:
CN=TrustedRoot,C=US,ST=MA,L=Hopkinton,EMAIL=rsa@emc.com,OU=CSP,O=RSA
Serial#:
00d8280b0c863f6d4e
Valid From:
20090407135111Z
Valid To:
20190405135111Z
______________________________________________________________________
------------Subject:
CN=ICA1 1rst Intermediate CA – Signed by Root, OU=CSP,
O=RSA, ST=MA,C=US
Issuer: CN=TrustedRoot,
C=US,ST=MA,L=Hopkinton,EMAIL=rsa@emc.com,OU=CSP,O=RSA
Serial#:
00e2
Valid From:
20090407135113Z
Valid To:
20190405135113Z
______________________________________________________________________
------------Subject: CN=ICA1 2nd Intermediate CA,OU=CSP,O=RSA,ST=MA,C=US
Issuer: CN=ICA1 1rst Intermediate CA – Signed by
Root,OU=CSP,O=RSA,ST=MA,C=US
Serial#:
00e3
Valid From:
20090407135113Z
Valid To:
20190405135113Z
______________________________________________________________________
-------------

security -certificate -list

265

VNX CLI for Block

Subject: CN=node 1 CA – Signed by ICA1, OU=CSP, O=RSA, ST=MA,C=US
Issuer: CN=ICA1 1rst Intermediate CA – Signed by Root, OU=CSP,
O=RSA, ST=MA,C=US
Serial#:
00e2
Valid From:
20090407135113Z
Valid To:
20190405135113Z
______________________________________________________________________
-------------

security -certificate -alertBeforeExpiration
Indicates that an alert should be generated prior to the expiration of the SSL/TLS
certificate.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -certificate -alertBeforeExpiration
command indicates that an alert should be generated prior to the expiration of the
SSL/TLS certificate.
SYNTAX
security -certificate -alertBeforeExpiration DAYS
OPTIONS
-alertBeforeExpiration DAYS
Sets the number of days to send an alert before the certificate expires. Valid values
are from 0 to 366.
EXAMPLE
naviseccli security -certificate -alertBeforeExpiration 10

OUTPUT
None if the command succeeds; status or error information if it fails.

security -pkcs12upload
Uploads a PKCS #12 file which contains a certificate and private key to the storage
system.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -pkcs12upload command uploads a PKCS #12 file,
which contains a certificate and private key, to the storage system.
SYNTAX
security -pkcs12upload -file FILE [-passphrase PASSPHRASE]
OPTIONS
-file FILE
Specifies the file full name of the certificate to be imported.
-passphrase PASSPHRASE
Specifies the export password of the certificate.
EXAMPLE
naviseccli security -pkcs12upload c:\cert.p12
266

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

OUTPUT
None if the command succeeds; status or error information if it fails.

security -SPcertificate -generate
Generates a new self-signed certificate and replaces the one currently in use.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -SPcertificate -generate command generates a
new self-signed certificate and replaces the one currently in use.
SYNTAX
security -SPcertificate –generate
EXAMPLE
naviseccli security -SPcertificate –generate

OUTPUT
None if the command succeeds; status or error information if it fails.

security -fipsmode -set
Sets the FIPS (Federal Information Processing Standards) mode of Unisphere.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -fipsmode -set command sets the FIPS mode of
Unisphere.
SYNTAX
security -fipsmode -set 0|1 [-o]
OPTIONS
-set 0|1
Sets the FIPS mode of Unisphere. Valid values are 0 and 1.
0
Sets the mode to Non-FIPS 140-2-compliant mode.
1
Sets the mode to FIPS 140-2-compliant mode.
-o
Executes the command without prompting for confirmation.
EXAMPLE
naviseccli security -fipsmode -set 1
WARNING: You are about to change FIPS mode. Any other existing
background management tasks will be interrupted and the system will
be unavailable for management while the environment restarts. IO
to the system will be unaffected.
Proceed?(y/n)

security -SPcertificate -generate

267

VNX CLI for Block

OUTPUT
None if the command succeeds; status or error information if it fails.

security -fipsmode -get
Gets the FIPS (Federal Information Processing Standards) mode of Unisphere.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -fipsmode -get command gets the FIPS mode of
Unisphere.
SYNTAX
security -fipsmode -get
EXAMPLE
naviseccli security -fipsmode -get

OUTPUT
FIPS 140-2 compliant: ENABLED

security -setport
Sets the http/https ports that Unisphere uses.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -setport command changes the http/https port
numbers.
SYNTAX
security -setport -port [80/443]|[2162/2163]
OPTIONS
-port [80/443]|[2162/2163]
Sets the ports that Unisphere uses. Valid port pairs are either 80/443 or 2162/2163.
EMC recommends that all systems in the domain use the same management port
pair.
EXAMPLE
naviseccli security -setport -port 80/443

OUTPUT
None if the command succeeds; status or error information if it fails.

security -trustedclient -enable
Enables or disables IP Filtering for all storage systems supporting filtering.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.

268

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

DESCRIPTION
The naviseccli security -trustedclient command with the -enable
subcommand enables or disables IP Filtering for all storage systems supporting filtering.
SYNTAX
security -trustedclient -enable yes|no [-o]
OPTIONS
-enable yes|no
Enables (yes) or disables (no) IP Filtering.
-o
Executes the command without prompting for confirmation.
EXAMPLE
naviseccli security -trustedclient -enable yes
WARNING: You are about to enable IP Filtering which may cut off
access from clients.
Proceed?(y/n) y

OUTPUT
None if the command succeeds; status or error information if it fails.

security -trustedclient -add
Adds an IP Filter to the storage system or Unisphere Domain.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -trustedclient command with the -add
subcommand adds an IP Filter to the storage system or Unisphere Domain.
Administrators and security administrators can extend remote service tool access to a
storage system's management ports by entering the IP addresses of attached, trusted
clients.
SYNTAX
security -trustedclient -add -ipaddress ADDRESS -applyto
single|all [-o]
OPTIONS
-ipaddress ADDRESS
Specifies the client's IP Address to allow access for.
-applyto single|all
Applies the filter to the connected storage system only (single) or all storage systems
in the domain (all).
-o
Executes the command without prompting for confirmation.
EXAMPLE
naviseccli security -trustedclient -add -ipaddress 10.238.74.171 applyto all
WARNING: You are about to grant access solely to this trusted client.
Proceed?(y/n) y

security -trustedclient -add

269

VNX CLI for Block

OUTPUT
None if the command succeeds; status or error information if it fails.

security -trustedclient -list
Lists the current IP Filters for the storage system and Unisphere Domain.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -trustedclient command with the -list
subcommand lists the current IP Filters for the storage system and Unisphere Domain.
SYNTAX
security -trustedclient -list [-ipaddress ADDRESS]|[-showall]
OPTIONS
-ipaddress ADDRESS
Specifies the client's IP Address to list filtering for.
-showall
Shows all trusted clients, including locals that only apply to other storage systems.
EXAMPLE
naviseccli security -trustedclient -list

OUTPUT
Current IP Filtering State: enabled
Trusted Client: 10.238.74.171
Applies To: all

security -trustedclient -remove
Removes IP Filters from the storage system or Unisphere Domain.
PREREQUISITES
You must have a user account on the system on which you want to execute the command.
DESCRIPTION
The naviseccli security -trustedclient command with the -remove
subcommand removes IP Filters from the storage system or Unisphere Domain.
SYNTAX
security -trustedclient -remove [-ipaddress ADDRESS] -applyto
single|all [-o]
OPTIONS
-ipaddress ADDRESS
Specifies the client's IP Address to remove filtering for.
-applyto single|all
Applies the filter to the connected storage system only (single) or all storage systems
in the domain (all).
-o
Executes the command without prompting for confirmation.

270

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

EXAMPLE
naviseccli security -trustedclient -remove -ipaddress 10.238.74.171 applyto all
WARNING! If you proceed, access will be terminated for the initiating
client.
Proceed?(y/n) y

OUTPUT
None if the command succeeds; status or error information if it fails.

Event Monitor commands
This section provides a brief overview of the event monitor and includes a list of
commands you can use to configure and manage Event Monitor.

Event Monitoring overview
The Event Monitor is an enterprise tool that supports centralized or distributed
monitoring of storage systems in a heterogeneous environment. Event Monitor is part of
the Agent, and it is available on many operating systems. Once configured, the Event
Monitor runs continuously as a service or daemon, observing the state of all specified
storage systems and notifying you when selected events have occurred.
The Event Monitor has portal, template, and monitor commands for portal configuration,
template management, and centralized and distributed event monitor management
respectively.
naviseccli Event Monitor commands on page 271 lists the event monitor commands.
Table 15 naviseccli Event Monitor commands

Command

Description

-portal -create

Adds a host agent to the portal system.

-portal -list

Lists the portal configurations.

-portal -migrate

Migrates the portals.

-portal -destroy

Deletes the host agent from the portal system.

-template -list

Lists the templates.

-template -import

Imports the template files.

-template -export

Exports the templates.

-template -destroy

Deletes the templates.

-template -findconflict

Finds and resolves template conflicts.

-template -swap

Swaps two templates.

-monitor -addsystem

Adds the storage system to be monitored.

-monitor -removesystem

Removes the storage system from the monitor.

-monitor -listmapping

Lists the storage template mappings.

-monitor -applytemplate

Applies the template to the monitor.

Event Monitor commands

271

VNX CLI for Block

Table 15 naviseccli Event Monitor commands (continued)

Command

Description

-monitor -stoptemplate

Stops applying the template to the monitor.

-monitor -getlog

Displays the Event Monitor log.

-monitor -enableresponse

Enables the response from the specified monitor.

-monitor -disableresponse Disables the response from the specified monitor.
-monitor -getlogsize

Gets the log size of the monitor.

-monitor -setlogsize

Sets the log size of the monitor.

-monitor -inserttestevent Inserts an event in the log.
-monitor -responsetest

Creates an artificial event.

-monitor -reloadconfig

Reloads the template file.

-portal -create
Adds a host agent to the portal system.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli -portal -create command adds the specified host agent to the
specified portal system.
SYNTAX
eventmonitor -portal -create -system portalsystemname -server
hostagentname
OPTIONS
-system portalsystemname
Specifies the portal system.
-server hostagentname
Specifies the host agent.
EXAMPLE
eventmonitor -portal -create -system cx380_123_227 -server
10.32.123.205

OUTPUT
None if the command succeeds; status or error information if it fails.

-portal -list
Lists the portal configurations.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.

272

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

DESCRIPTION
The naviseccli -portal -list command lists the portal system and its hosts.
SYNTAX
eventmonitor -portal -list
OUTPUT
Portal configuration is listed. Nothing is listed if the portal configuration is not available.

-portal -migrate
Migrates the portals.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli -portal -migrate command migrates the portal system. The
host to which the portals are connected is migrated automatically.
SYNTAX
eventmonitor -portal -migrate -source source portal system name
-dest destination portal system name
OPTIONS
-source source portal system name
Specifies the original portal configuration name.
-dest destination portal system name
Specifies the destination portal configuration name.
EXAMPLE
eventmonitor -portal -migrate -source cx380_123_223 -dest
cx380_123_227

OUTPUT
None if the command succeeds; status or error information if it fails.

-portal -destroy
Deletes the host agent from the portal system.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli -portal -destroy command deletes the specified host agent
from the specified portal system.
SYNTAX
eventmonitor -portal -destroy -system portal system name
-server hostname [-o]
OPTIONS
-system portal system name
Specifies the portal system whose host is deleted.
-portal -migrate

273

VNX CLI for Block

-server hostname
Deletes the specified host agent.
-o
Executes the command without prompting for confirmation.
EXAMPLE
eventmonitor -portal -destroy -system cx380_123_227 -server
10.32.123.205

OUTPUT
None if the command succeeds; status or error information if it fails.

-template -list
Lists the templates.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli eventmonitor -template command with the -list function
lists all the templates available in the template database of the target system.
SYNTAX
eventmonitor -template -list
OUTPUT
The templates in the database are listed; none if the templates are not available.

-template -import
Imports the template files.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli eventmonitor -template command with the -import function
imports the template file from the file system to the template database.
SYNTAX
eventmonitor -template -import -templatefilename filename
OPTIONS
-templatefilename filename
Specifies the template to be imported to the template database of the target system.
EXAMPLE
eventmonitor -template -import -templatefilename
D:\Templates\Template_Test.tpl

OUTPUT
None if the command succeeds; status or error information if it fails.

274

EMC VNX Series 5.33 Command Line Interface Reference for Block

VNX CLI for Block

-template -export
Exports the templates.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli eventmonitor -template command with the -export function
exports the template from the template database to the file system.
SYNTAX
eventmonitor -template -export -templatename templatename
-filepath localfilepath
OPTIONS
-templatename template name
Specifies the template.
-filepath localfilepath
Specifies the local file path.
EXAMPLE
eventmonitor -template -export -templatename Template_Test
-filepath D:\Templates\

OUTPUT
None if the command succeeds; status or error information if it fails.

-template -destroy
Deletes the templates.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli eventmonitor -template command with the -destroy
function deletes the specified template from the template database on the target system.
SYNTAX
eventmonitor -template -destroy -templatename templatename [-o]
OPTIONS
-templatename templatename
Deletes the specified template.
-o
Executes the command without prompting for confirmation.
EXAMPLE
eventmonitor -template -destroy -templatename Template_Test

OUTPUT
None if the command succeeds; status or error information if it fails.
-template -export

275

VNX CLI for Block

-template -findconflict
Finds and resolves template conflicts.
PREREQUISITES
For naviseccli, you must have a user account on the system on which you want to
execute the command.
DESCRIPTION
The naviseccli eventmonitor -template command with the -findconflict
function lists the conflicting templates. The -resolve switch prompts you to resolve
them.
SYNTAX
eventmonitor -template -findconflict [-resolve]
OPTIONS
-resolve
Resolves the template conflict.
EXAMPLE
eventmonitor -template -findconflict -resolve

OUTPUT
The sample output is as follows:
Event Template