EMC® VPLEX®

GeoSynchrony
Version Number 5.4.1

CLI Reference Guide

P/N 302-001-066

REV 02
Copyright © 2015 EMC Corporation. All rights reserved. Published in the USA.

Published January, 2015

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.

EMC2, EMC, EMC Centera, EMC ControlCenter, EMC LifeLine, EMC OnCourse, EMC Proven, EMC Snap, EMC SourceOne, EMC Storage
Administrator, Acartus, Access Logix, AdvantEdge, AlphaStor, ApplicationXtender, ArchiveXtender, Atmos, Authentica, Authentic
Problems, Automated Resource Manager, AutoStart, AutoSwap, AVALONidm, Avamar, Captiva, Catalog Solution, C-Clip, Celerra,
Celerra Replicator, Centera, CenterStage, CentraStar, ClaimPack, ClaimsEditor, CLARiiON, ClientPak, Codebook Correlation
Technology, Common Information Model, Configuration Intelligence, Connectrix, CopyCross, CopyPoint, CX, Dantz, Data Domain,
DatabaseXtender, Direct Matrix Architecture, DiskXtender, DiskXtender 2000, Document Sciences, Documentum, elnput, E-Lab,
EmailXaminer, EmailXtender, Enginuity, eRoom, Event Explorer, FarPoint, FirstPass, FLARE, FormWare, Geosynchrony, Global File
Virtualization, Graphic Visualization, Greenplum, HighRoad, HomeBase, InfoMover, Infoscape, InputAccel, InputAccel Express, Invista,
Ionix, ISIS, Max Retriever, MediaStor, MirrorView, Navisphere, NetWorker, OnAlert, OpenScale, PixTools, Powerlink, PowerPath,
PowerSnap, QuickScan, Rainfinity, RepliCare, RepliStor, ResourcePak, Retrospect, RSA, SafeLine, SAN Advisor, SAN Copy, SAN
Manager, Smarts, SnapImage, SnapSure, SnapView, SRDF, StorageScope, SupportMate, SymmAPI, SymmEnabler, Symmetrix,
Symmetrix DMX, Symmetrix VMAX, TimeFinder, UltraFlex, UltraPoint, UltraScale, Unisphere, Viewlets, Virtual Matrix, Virtual Matrix
Architecture, Virtual Provisioning, VisualSAN, VisualSRM, VMAX, VNX, VNXe, Voyence, VPLEX, VSAM-Assist, WebXtender, xPression,
xPresso, YottaYotta, the EMC logo, and the RSA logo, are registered trademarks or trademarks of EMC Corporation in the United States
and other countries. Vblock is a trademark of EMC Corporation in the United States.

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 the technical documentation and advisories section on the
EMC online support website.

2 EMC® VPLEX® CLI Reference Guide

CONTENTS

Preface
New Commands for VPLEX..................................................................... 11
Modified Commands for VPLEX.............................................................. 12
Removed Commands for VPLEX ............................................................. 15
New Context for VPLEX .......................................................................... 15
Related documentation ......................................................................... 23
Conventions used in this document ...................................................... 23
Where to get help.................................................................................. 24
Your comments ..................................................................................... 25
............................................................................................................. 25

Chapter 1 Using the VPLEX CLI

Log in to/log out from the CLI ...................................................................... 27
CLI context tree ........................................................................................... 29
Navigate the CLI context tree ....................................................................... 30
Using CLI commands................................................................................... 34
Page output .......................................................................................... 35
Tab completion ..................................................................................... 35
Wildcards.............................................................................................. 36
Names .................................................................................................. 37
Specifying addresses ............................................................................ 37
Command globbing............................................................................... 38
Positional command arguments ............................................................ 38
Search command history....................................................................... 40
View command history .......................................................................... 40
Get help ................................................................................................ 40

Chapter 2 VPLEX CLI Command Descriptions

advadm dismantle ...................................................................................... 41
alias ........................................................................................................... 42
amp register................................................................................................ 44
amp unregister............................................................................................ 45
array claim .................................................................................................. 46
array re-discover ......................................................................................... 47
array register............................................................................................... 50
array used-by .............................................................................................. 50
authentication directory-service configure................................................... 51
authentication directory-service map .......................................................... 55
authentication directory-service show ......................................................... 56
authentication directory-service unconfigure............................................... 57
authentication directory-service unmap ...................................................... 58
batch-migrate cancel................................................................................... 59
batch-migrate check-plan............................................................................ 60
batch-migrate clean .................................................................................... 61
batch-migrate commit ................................................................................. 62
batch-migrate create-plan ........................................................................... 63
batch-migrate pause ................................................................................... 65
batch-migrate remove ................................................................................. 66

EMC® VPLEX® CLI Reference Guide 3

Contents

batch-migrate resume ................................................................................. 67

batch-migrate start...................................................................................... 67
batch-migrate summary .............................................................................. 70
battery-conditioning disable ....................................................................... 72
battery-conditioning enable ........................................................................ 73
battery-conditioning manual-cycle cancel-request....................................... 75
battery-conditioning manual-cycle request.................................................. 76
battery-conditioning set-schedule ............................................................... 78
battery-conditioning summary .................................................................... 80
cache-invalidate ......................................................................................... 81
cache-invalidate-status ............................................................................... 85
capture begin.............................................................................................. 88
capture end ................................................................................................ 89
capture pause............................................................................................. 89
capture replay............................................................................................. 89
capture resume........................................................................................... 90
cd ............................................................................................................... 90
chart create................................................................................................. 91
cluster add.................................................................................................. 93
cluster cacheflush....................................................................................... 94
cluster configdump ..................................................................................... 95
cluster expel ............................................................................................... 96
cluster forget............................................................................................... 98
cluster shutdown ........................................................................................ 99
cluster status ............................................................................................ 101
cluster summary ....................................................................................... 104
cluster unexpel ......................................................................................... 106
cluster-witness configure .......................................................................... 108
cluster-witness disable ............................................................................. 109
cluster-witness enable .............................................................................. 112
collect-diagnostics .................................................................................... 116
configuration complete-system-setup ....................................................... 118
configuration configure-auth-service ......................................................... 119
configuration connect-local-directors ........................................................ 120
configuration connect-remote-directors..................................................... 121
configuration continue-system-setup ........................................................ 121

configuration cw-vpn-configure.................................................................. 122

configuration cw-vpn-reset........................................................................ 125
configuration enable-front-end-ports......................................................... 127
configuration event-notices-reports config ................................................ 127
configuration event-notices-reports reset .................................................. 128
configuration event-notices-reports-show ................................................. 128
configuration flashdir-backup disable ....................................................... 129
configuration flashdir-backup enable ........................................................ 129
configuration get-product-type .................................................................. 130
configuration join-clusters ........................................................................ 130
configuration metadata-backup ................................................................ 131
configuration ntp-sync-system .................................................................. 133
configuration register-product ................................................................... 136
configuration remote-clusters add-addresses ........................................... 138
configuration remote-clusters clear-addresses ......................................... 139
configuration short-write........................................................................... 141
configuration show-meta-volume-candidates ............................................ 141
configuration subnet clear ........................................................................ 142

4 EMC® VPLEX® CLI Reference Guide

 Contents

configuration subnet remote-subnet add .................................................. 144

configuration subnet remote-subnet remove ............................................. 145
configuration sync-time............................................................................. 146
configuration sync-time-clear .................................................................... 148
configuration sync-time-show ................................................................... 149
configuration system-reset........................................................................ 149
configuration system-setup....................................................................... 150
configuration upgrade-meta-slot-count ..................................................... 151
connect..................................................................................................... 153
connectivity director ................................................................................. 155
connectivity show ..................................................................................... 156
connectivity validate-be ............................................................................ 157
connectivity validate-local-com ................................................................. 160
connectivity validate-wan-com .................................................................. 161
connectivity window set ............................................................................ 163
connectivity window show ........................................................................ 165
connectivity window stat........................................................................... 166
consistency-group add-virtual-volumes ..................................................... 167
consistency-group choose-winner ............................................................. 169
consistency-group create .......................................................................... 171
consistency-group destroy ........................................................................ 174
consistency-group list-eligible-virtual-volumes .......................................... 175
consistency-group remove-virtual-volumes................................................ 176
consistency-group resolve-conflicting-detach ............................................ 177
consistency-group resume-after-data-loss-failure ...................................... 180
consistency-group resume-after-rollback ................................................... 183
consistency-group resume-at-loser............................................................ 185
consistency-group set-detach-rule active-cluster-wins ............................... 187
consistency-group set-detach-rule no-automatic-winner............................ 188
consistency-group set-detach-rule winner ................................................. 189
consistency-group summary...................................................................... 191
date .......................................................................................................... 191
describe.................................................................................................... 191
device attach-mirror .................................................................................. 192
device collapse ......................................................................................... 194
device detach-mirror ................................................................................. 194
device mirror-isolation auto-unisolation disable........................................ 197
device mirror-isolation auto-unisolation enable......................................... 199
device mirror-isolation disable .................................................................. 200
device mirror-isolation enable ................................................................... 203
device mirror-isolation show ..................................................................... 204
device resume-link-down .......................................................................... 206
device resume-link-up............................................................................... 208
director appcon......................................................................................... 208
director appdump ..................................................................................... 209
director appstatus..................................................................................... 211
director commission ................................................................................. 212
director decommission.............................................................................. 213
director fc-port-stats ................................................................................. 213
director firmware show-banks ................................................................... 215
director forget ........................................................................................... 216
director passwd ........................................................................................ 217
director ping ............................................................................................. 217
director shutdown..................................................................................... 218
director tracepath ..................................................................................... 219

EMC® VPLEX® CLI Reference Guide 5

Contents

director uptime ......................................................................................... 221

dirs ........................................................................................................... 222
disconnect ................................................................................................ 222
dm migration cancel ................................................................................. 223
dm migration clean ................................................................................... 224
dm migration commit................................................................................ 225
dm migration pause .................................................................................. 226
dm migration remove ................................................................................ 226
dm migration resume ................................................................................ 227
dm migration start .................................................................................... 228
drill-down ................................................................................................. 230
ds dd create.............................................................................................. 232
ds dd declare-winner ................................................................................ 234
ds dd destroy............................................................................................ 235
ds dd remove-all-rules .............................................................................. 235
ds dd set-log............................................................................................. 236
ds rule destroy .......................................................................................... 238
ds rule island-containing........................................................................... 239
ds rule-set copy ........................................................................................ 240
ds rule-set create ...................................................................................... 240
ds rule-set destroy .................................................................................... 241
ds rule-set what-if ..................................................................................... 242
ds summary .............................................................................................. 243
event-test ................................................................................................. 249
exec.......................................................................................................... 250
exit ........................................................................................................... 250
export initiator-port discovery ................................................................... 251
export initiator-port register ...................................................................... 251
export initiator-port register-host .............................................................. 253
export initiator-port show-logins ............................................................... 253
export initiator-port unregister .................................................................. 255
export port summary................................................................................. 255
export storage-view addinitiatorport ......................................................... 257
export storage-view addport...................................................................... 257
export storage-view addvirtualvolume....................................................... 258
export storage-view checkconfig................................................................ 260
export storage-view create ........................................................................ 260
export storage-view destroy ...................................................................... 261
export storage-view find............................................................................ 262
export storage-view find-unmapped-volumes ............................................ 263
export storage-view map ........................................................................... 264
export storage-view removeinitiatorport .................................................... 264
export storage-view removeport ................................................................ 265
export storage-view removevirtualvolume ................................................. 266
export storage-view show-powerpath-interfaces........................................ 266
export storage-view summary.................................................................... 267
export target-port renamewwns................................................................. 268
extent create............................................................................................. 269
extent destroy ........................................................................................... 270
extent summary ........................................................................................ 271
getsysinfo ................................................................................................. 272
health-check ............................................................................................. 273
help .......................................................................................................... 280
history ...................................................................................................... 282
iscsi chap back-end add-credentials ......................................................... 282

6 EMC® VPLEX® CLI Reference Guide

 Contents

iscsi chap back-end disable ...................................................................... 283

iscsi chap back-end enable ....................................................................... 284
iscsi chap back-end list-credentials........................................................... 285
iscsi chap back-end remove-credentials .................................................... 286
iscsi chap back-end remove-default-credential.......................................... 287
iscsi chap back-end set-default-credential................................................. 288
iscsi chap front-end add-credentials ......................................................... 289
iscsi chap front-end disable ...................................................................... 290
iscsi chap front-end enable ....................................................................... 291
iscsi chap front-end list-credentials........................................................... 292
iscsi chap front-end remove-credentials .................................................... 292
iscsi chap front-end remove-default-credential.......................................... 293
iscsi chap front-end set-default-credential................................................. 294
iscsi check-febe-connectivity..................................................................... 295
iscsi isns add ............................................................................................ 296
iscsi isns list ............................................................................................. 297
iscsi isns remove....................................................................................... 299
iscsi sendtargets add ................................................................................ 300
iscsi sendtargets list ................................................................................. 301
iscsi sendtargets rediscover ...................................................................... 302
iscsi sendtargets remove........................................................................... 303
iscsi targets list ......................................................................................... 304
iscsi targets logout.................................................................................... 304
local-device create .................................................................................... 305
local-device destroy .................................................................................. 308
local-device summary ............................................................................... 309
log filter create.......................................................................................... 310
log filter destroy........................................................................................ 311
log filter list............................................................................................... 312
log source create....................................................................................... 312
log source destroy..................................................................................... 313
log source list ........................................................................................... 313
logging-volume add-mirror ........................................................................ 314
logging-volume create............................................................................... 314
logging-volume detach-mirror ................................................................... 318
logging-volume destroy............................................................................. 320
logical-unit forget...................................................................................... 321
ls .............................................................................................................. 322
management-server network-service-restart .............................................. 324
management-server set-ip......................................................................... 324
manifest upgrade...................................................................................... 326
manifest version ....................................................................................... 327
meta-volume attach-mirror........................................................................ 327
meta-volume backup ................................................................................ 328
meta-volume create .................................................................................. 329
meta-volume destroy ................................................................................ 333
meta-volume detach-mirror ....................................................................... 333
meta-volume move ................................................................................... 334
meta-volume verify-on-disk-consistency.................................................... 335
monitor add-console-sink ......................................................................... 337
monitor add-file-sink................................................................................. 338
monitor collect.......................................................................................... 339
monitor create .......................................................................................... 340
About file rotation and timestamps ..................................................... 341
monitor destroy ........................................................................................ 343

EMC® VPLEX® CLI Reference Guide 7

Contents

monitor remove-sink ................................................................................. 344

monitor stat-list ........................................................................................ 344
ndu pre-check ........................................................................................... 345
ndu pre-config-upgrade............................................................................. 346
ndu recover............................................................................................... 346
ndu rolling-upgrade ssd-fw ....................................................................... 347
ndu start ................................................................................................... 351
ndu status ................................................................................................ 354
notifications call-home import-event-modifications................................... 355
notifications call-home remove-event-modifications ................................. 357
notifications call-home view-event-modifications...................................... 358
notifications call-home test....................................................................... 360
notifications job cancel ............................................................................. 360
notifications job delete ............................................................................. 361
notifications job resubmit ......................................................................... 362
notifications snmp-trap create .................................................................. 363
notifications snmp-trap destroy ................................................................ 364
password-policy reset ............................................................................... 364
password-policy set .................................................................................. 365
plugin addurl ............................................................................................ 367
plugin listurl ............................................................................................. 367
plugin register........................................................................................... 368
popd......................................................................................................... 368
pushd ....................................................................................................... 369
rebuild set-transfer-size ............................................................................ 370
rebuild show-transfer-size......................................................................... 371
rebuild status............................................................................................ 371
report aggregate-monitors......................................................................... 372
report capacity-arrays ............................................................................... 373
report capacity-clusters............................................................................. 376
report capacity-hosts ................................................................................ 377
report create-monitors .............................................................................. 378
report poll-monitors .................................................................................. 380
rp import-certificate .................................................................................. 381
rp rpa-cluster add ..................................................................................... 382
rp rpa-cluster remove ................................................................................ 388
rp summary............................................................................................... 388
rp validate-configuration ........................................................................... 390
schedule add ............................................................................................ 393
schedule list ............................................................................................. 394
schedule modify ....................................................................................... 394
schedule remove....................................................................................... 395
scheduleSYR add ...................................................................................... 396
scheduleSYR list ....................................................................................... 397
scheduleSYR remove................................................................................. 397
script ........................................................................................................ 397
security create-ca-certificate ..................................................................... 398
security create-certificate-subject.............................................................. 402
security create-host-certificate .................................................................. 403
security delete-ca-certificate ..................................................................... 406
security delete-host-certificate .................................................................. 406
security export-ca-certificate ..................................................................... 407
security export-host-certificate.................................................................. 408
security import-ca-certificate..................................................................... 409
security import-host-certificate ................................................................. 410

8 EMC® VPLEX® CLI Reference Guide

 Contents

security ipsec-configure ............................................................................ 412

security remove-login-banner.................................................................... 414
security renew-all-certificates.................................................................... 414
security set-login-banner .......................................................................... 419
security show-cert-subj ............................................................................. 420
sessions ................................................................................................... 420
set ............................................................................................................ 421
set topology.............................................................................................. 425
show-use-hierarchy................................................................................... 426
sms dump................................................................................................. 427
snmp-agent configure ............................................................................... 429
snmp-agent start....................................................................................... 430
snmp-agent status .................................................................................... 431
snmp-agent stop....................................................................................... 431
snmp-agent unconfigure ........................................................................... 431
source....................................................................................................... 432
storage-tool compose ............................................................................... 433
storage-volume auto-unbanish-interval..................................................... 434
storage-volume claim................................................................................ 435
storage-volume claimingwizard ................................................................. 438
storage-volume find-array ......................................................................... 441
storage-volume forget ............................................................................... 442
storage-volume list-banished .................................................................... 443
storage-volume resurrect .......................................................................... 444
storage-volume summary.......................................................................... 446
storage-volume unbanish.......................................................................... 449
storage-volume unclaim............................................................................ 450
storage-volume used-by............................................................................ 451
subnet clear.............................................................................................. 452
subnet create............................................................................................ 454
subnet destroy.......................................................................................... 455
subnet modify........................................................................................... 456
syrcollect .................................................................................................. 457
tree........................................................................................................... 458
unalias...................................................................................................... 459
user add ................................................................................................... 459
user event-server add-user........................................................................ 461
user event-server change-password .......................................................... 461
user list..................................................................................................... 462
user passwd ............................................................................................. 462
user remove.............................................................................................. 463
user reset.................................................................................................. 464
validate-system-configuration ................................................................... 465
vault go..................................................................................................... 466
vault overrideUnvaultQuorum ................................................................... 467
vault status ............................................................................................... 469
verify fibre-channel-switches..................................................................... 472
version...................................................................................................... 473
virtual-volume create ................................................................................ 477
virtual-volume destroy .............................................................................. 480
virtual-volume expand .............................................................................. 481
virtual-volume provision............................................................................ 485
virtual-volume summary............................................................................ 487
vpn restart ................................................................................................ 489
vpn start ................................................................................................... 490

EMC® VPLEX® CLI Reference Guide 9

Contents

vpn status................................................................................................. 490

vpn stop ................................................................................................... 491

Chapter 3 VPLEX Commands by Topic

Connectivity .............................................................................................. 493
Clusters .................................................................................................... 494
Directors ................................................................................................... 494
Data migration .......................................................................................... 495
Storage (arrays, devices, ptov, storage-volumes, virtual volumes).............. 495
Storage views...................................................................................... 496
System management ................................................................................ 497
Meta-volumes ..................................................................................... 498
Subnets and ports............................................................................... 498
Manage CLI workspace........................................................................ 498
Navigate the CLI .................................................................................. 499
Cache vaulting .................................................................................... 499
Consistency groups............................................................................. 499
Monitoring/statistics ................................................................................ 499
System status: connectivity, summaries, and reports .......................... 500
Diagnostics, dumps, healthchecks...................................................... 500
Security/authentication ............................................................................ 501
Cluster Witness ......................................................................................... 501
RecoverPoint............................................................................................. 501
Configuration/EZ-Setup............................................................................. 501
Miscellaneous........................................................................................... 502

Index

10 EMC® VPLEX® CLI Reference Guide

PREFACE

As part of an effort to improve its product lines, EMC periodically releases revisions of its
software and hardware. Therefore, some functions described in this document might not
be supported by all versions of the software or hardware currently in use. The product
release notes provide the most up-to-date information on product features.
Contact your EMC representative if a product does not function properly or does not
function as described in this document.

Note: This document was accurate at publication time. New versions of this document
might be released on the EMC online support website. Check the EMC online support
website to ensure that you are using the latest version of this document.

About this guide This document is part of the VPLEX documentation set, and describes the VPLEX
command line interface. Each major section includes introductory information and a
general procedure for completing a task.
The introductory information and detailed steps for each procedure appear in the
EMC VPLEX Management Console online help so you have the complete information
available when you actually configure and manage the storage environment, should
you require help.
This guide is part of the Management Console documentation set, and is intended for
use by customers and service providers who use the VPLEX CLI to configure and
manage a storage environment.

New Commands for VPLEX

◆ configuration ntp-sync-system - This command synchronizes system time across the
management server and directors in a single or multi-site system.
◆ connectivity validate-local-com - This command validates that the actual connectivity
over local com matches the expected connectivity.
◆ device mirror-isolation auto-unisolation disable - This command disables auto mirror
unisolation.
◆ device mirror-isolation auto-unisolation enable - This command enables auto mirror
unisolation.
◆ logging-volume detach-mirror - This command detaches a mirror from a
logging-volume.
◆ notifications job cancel - This command cancels jobs in the job queue.
◆ notifications job delete - This command permanently removes jobs from the job
queue.
◆ notifications job resubmit - This command resubmits failed or canceled jobs to the job
queue.

EMC® VPLEX® CLI Reference Guide 11

Preface

Modified Commands for VPLEX

◆ alias - Added two sentences in the description about persisting alias commands.
◆ cache-invalidate - Added note and examples to illustrate brief and verbose message
outputs.
◆ cache-invalidate status - Added description about specified and unspecified verbose
options. Added examples to illustrate brief and verbose message outputs.
◆ cluster-summary - In the field description table, changed acronym in the Operational
Status field, degraded value from HWH to text “hardware health.”
◆ cluster-witness configure - Added the [--verbose] option for this command.
◆ configuration cw-vpn-reset - Added reference to cluster-witness disable command in
the See also section.
◆ configuration enable-front-end-ports - Revised command introduction to provide
clarity. Removed first sentence from the command description.
◆ configuration event-notices-reports config - Revised command for clarity and removed
examples.
◆ configuration event-notices-reports reset - Revised command for clarity and removed
examples.
◆ configuration event-notices-reports show - Revised command for clarity and removed
examples.
◆ configuration join-clusters - Added note to command description about system on
which the command can run. Removed two unassociated command links in See also
section and added a link for the cluster add command.
◆ configuration metadata-backup - Added descriptions about the meta-volume backup
size and reference to find information about kinds of backend arrays to consider for
meta-volumes.
◆ configuration remote-clusters add-addresses - Added a reference for managing
WAN-COM procedures in the SolVe Desktop.
◆ configuration remote-clusters clear-addresses - Added a reference for managing
WAN-COM procedures in the SolVe Desktop.
◆ configuration system-setup - Removed the obsolete [-m|--setup-multiplex-specific]
option and revised description.
◆ consistency-group resume-after-rollback - Revised the caution note in the command
description to provide clarity.
◆ connect - Removed “filename” from two sentences in the command description
regarding using the -c option.
◆ device mirror-isolation enable - Added the command option
--also-enable-autounisolation, and two new examples.
◆ device mirror-isolation show - Added a configuration parameter for auto-unisolation to
the table in the command description. Updated all the examples.
◆ dm migration start - Removed warning note stating that device migrations are not
recommended between clusters.

12 EMC® VPLEX® CLI Reference Guide

 Preface

◆ ds dd set-log - Revised the reference to troubleshooting procedures in the command

description.
◆ ds rule destroy - Added description for the [-r|--rule] option and replaced the example.
◆ ds rule island-containing - Fixed typographical errors in the [-d|--delay] option
definition.
◆ director shutdown - Corrected the director context in the command example.
◆ director uptime - Replaced example to show correct director context.
◆ disconnect - Replaced example to show correct director context.
◆ health-check - Added VIAS output to first example. Revised the command description.
◆ logging-volume create - Fixed error in field name and added field descriptions in table.
◆ meta-volume create - Revised reference to troubleshooting procedures in the
command description.
◆ ndu pre-config-upgrade - Revised reference to upgrading procedures in the command
description.
◆ ndu pre-check - Revised reference to upgrading procedures in the command
description.
◆ ndu rolling-upgrade ssd-fw - Revised reference to upgrading procedures in the
command description.
◆ ndu start - Changed the IO forwarding default timeout value from 120 seconds to 360
seconds. Revised first caution note in Optional arguments to clarify that it is
mandatory to run ndu pre-check before running this command. Revised third caution
note in Optional arguments to clarify statement about WAN-COM issues. Changed the
reference to specify the VPLEX procedures in the SolVe Desktop. Added new skip
options and removed inapplicable options.
◆ notifications call-home import-event-modifications - Added “notification” after
“call-home” in Description sentences for clarity.
◆ notifications call-home test - Added “notification” after “call-home” in Description
sentences for clarity.
◆ password-policy reset - Added two notes about command usage in the command
description.
◆ password-policy set - Revised password-minimum-length default value to “8” from
“14.”
◆ popd - Replaced example to show correct director context.
◆ pushd - Replaced examples to show correct director context.
◆ rp rpa-cluster add - Updated command output examples.
◆ rp summary - Added a note about replication and MetroPoint groups. Replaced the
command output example to show MetroPoint production volumes.
◆ rp validate-configuration - Removed line in Context: “In /recoverpoint/ context,
command is validate-configuration,” as this is not an option from within the
/recoverpoint context.

EMC® VPLEX® CLI Reference Guide 13

Preface

◆ scheduleSYR add - Revised example description to reflect correct date and time for
scheduled job.
◆ security renew-all-certificates - Changed the service password in the examples to a
sample password. Added note to the command description to contact the System
Administrator for the current service password.
◆ set - Updated the example for displaying information in the eth0 context. Updated the
example for setting a storage volume’s thin-rebuild attribute to “true.” Changed
example to show new fields for "underlying-storage-block-size" and "vias-based."
◆ set topology - Added a note about using the default setting for the front-end ports and
connecting to the hosts via a switched fabric. Also added a warning message about
the consequences of changing the local COM topology.
◆ show-use-hierarchy - Removed sentence in the [-t|--targets] option about the target
requiring a fully qualified path. Replaced example showing usage hierarchy for a
specified meta-volume.
◆ sms dump - Added a note to the command description specifying that the log files
listed are a core set and do not include all log files.
◆ storage-tool compose - Changed argument name from [-s|--source-storage-volume] to
[-m|--source-mirror]. Moved the name, geometry, and storage-views arguments under
required arguments. Added consistency-group and storage-views options, and
explanation in the command description. Replaced the example.
◆ storage-volume auto-unbanish-interval - Changed reference to topic in
storage-volume-unbanish command from link to text reference.
◆ storage-volume claimingwizard - In Table 21, storage array EMC VPLEX, Command to
create hints file, revised EMC VPLEX export view map -f EMC_PROD12.txt -v <views to
EMC VPLEX export storage-view map -f EMC_PROD12.txt -v <views>.
◆ storage-volume find-array - Revised example and added a new example.
◆ storage-volume unclaim - Fixed typographical error in the --return-to-pool option
name.
◆ user add - Added required -u option to the example.
◆ user passwd - Added required -u option to the example.
◆ user remove - Added required -u option to the example.
◆ version - Added command line to first example. Replaced examples to show current
version information and correct director context.
◆ virtual-volume create - Changed command output example and added the following 
fields and descriptions to the table: recoverpoint-replication-at, and vpd-id. Added the
disconnected status to the service status field.
◆ virtual-volume destroy - Added link to virtual-volume expand command in See also
section.
◆ virtual-volume provision - Added the [-t|--thin] option to provision a thin LUN on a VNX
array for legs that support thin provisioning.

14 EMC® VPLEX® CLI Reference Guide

 Preface

Removed Commands for VPLEX

◆ security set-login-banner - Removed duplicate command.
◆ virtual-volume expand - Removed duplicate command.

New Context for VPLEX

◆ connectivity/ - Configure connectivity between back-end storage arrays, front-end
hosts, local directors, port-groups and inter-cluster WANs.

Context Tree Upgrade The cluster-connectivity context will become deprecated in a future version. It is being
replaced with the Connectivity context, which is available in this release. Use the new
context whenever possible.
The following changes apply:
◆ Any configuration that exists in cluster-connectivity/ will automatically be reflected in
the connectivity/wan-com/ context and vice versa. For example, an existing wan-com
configuration will be displayed in connectivity/wan-com.
◆ All the attributes from the cluster-connectivity/ context are present in the
connectivity/wan-com/ context.
◆ Commands to change the remote-cluster-addresses attribute:
Old: cluster-connectivity remote-clusters add-addresses
New: configuration remote-clusters add-addresses
Old: cluster-connectivity remote-clusters clear-addresses
New: configuration remote-clusters clear-addresses
◆ Member-ports is now a context instead of an attribute. The fields that are part of the
string representation of a member-port under the cluster-connectivity context are now
table columns in a long listing (ll) of a connectivity/**/member-ports/ context.
Old: cluster-connectivity/port-groups/port-group-0/member-ports (attribute)
New: connectivity/wan-com/port-groups/ip-port-group-0/member-ports (context)
◆ Inside cluster-connectivity/port-groups/port-group-0:
• “subnet” is the name of a subnet from cluster-connectivity/subnets
• “option-set” is the name of a subnet from cluster-connectivity/option-sets
If the subnet=”cluster-1-SN00” and option-set=”optionset-com-0”, then
Old: cluster-connectivity/subnets/cluster-1-SN00/
New: connectivity/wan-com/port-groups/ip-port-group-0/subnet/
Old: cluster-connectivity/option-sets/optionset-com-0
New: connectivity/wan-com/port-groups/ip-port-group-0/option-set/
◆ There is no longer any need or ability to set the subnet used by a port-group.

EMC® VPLEX® CLI Reference Guide 15

Preface

◆ The cluster-connectivity/option-sets context has no analogue under connectivity/.

Each port-group under connectivity/wan-com/port-groups has a permanent
option-set sub-context.
◆ The cluster-connectivity/subnets context has no analogue under connectivity/. Each
port-group under connectivity/wan-com/port-groups has a permanent subnet
sub-context.
‘subnet create’ - no analogue under connectivity. Use the permanent subnet in the
port-group.
‘subnet destroy’ - no analogue under connectivity.
‘subnet modify’ - use the set command to change the attributes.
‘subnet clear’ - use the configuration subnet clear command.

Cluster-connectivity Cluster-connectivity
Context
(Deprecated) This context contains information for cluster connectivities.
Context
/clusters/cluster-*/cluster-connectivity
Position
Parent - cluster-*
Children - Option-sets (deprecated), Port-groups (deprecated), Subnets (deprecated)
Context-Specific Commands
remote-clusters
Data Structure
discovery-address
discovery-port
listening-port
remote-cluster-addresses
Notes
This context is replaced by:
/clusters/cluster-*/connectivity/wan-com.

Option-sets
Option-set configuration for IP wan-com.
Context
/clusters/cluster-*/cluster-connectivity/option-sets/*
Position
Parent - cluster-connectivity (deprecated)
Children - None
Context-Specific Commands
None

16 EMC® VPLEX® CLI Reference Guide

 Preface

Data Structure
connection-open-timeout
keepalive-timeout
socket-buf-size
Notes
The currently-used option-set context is replaced by:
/clusters/cluster-*/connectivity/wan-com/port-groups/ip-port-group-*/option-set

Port-groups
A communication channel for IP wan-com composed of one port from each director of the
local cluster.
Context
/clusters/cluster-*/cluster-connectivity/port-groups/port-group-0
/clusters/cluster-*/cluster-connectivity/port-groups/port-group-1
Position
Parent - cluster-connectivity
Children - None
Context-Specific Commands
None
Data Structure
enabled
member-ports
option-set
subnet
Notes
This context is replaced by Ethernet port-groups:
/clusters/cluster-*/connectivity/wan-com/port-groups/ip-port-group-0
/clusters/cluster-*/connectivity/wan-com/port-groups/ip-port-group-1

Subnets
Network configuration for IP wan-com.
Context
/clusters/cluster-*/cluster-connectivity/subnets/*
Position
Parent - cluster-connectivity
Children - None
Context-Specific Commands
In container context:
clear

EMC® VPLEX® CLI Reference Guide 17

Preface

create
destroy
modify
In subnet instance context:
None
Data Structure
cluster-address
gateway
mtu
prefix
proxy-external-address
remote-subnet-address
Notes
The currently-used subnet context is replaced by:
/clusters/cluster-*/connectivity/wan-com/port-groups/ip-port-group-*/subnet
Named subnet instance contexts are created in the subnets container context by the
command subnet create and are removed by the command subnet destroy.

New Connectivity Connectivity

Context (Upgrade)
This context contains information about all network connectivities.
Context
/clusters/cluster-*/connectivity
Position
Parent - cluster-*
Children - back-end, front-end, local-com, wan-com
Context-Specific Commands
None
Data Structure
None
Notes
This context replaces:
/clusters/cluster-*/cluster-connectivity

Back-end
Configuration of back-end connectivity to arrays.
Context
/clusters/cluster-*/connectivity/back-end
Position
Parent - connectivity

18 EMC® VPLEX® CLI Reference Guide

 Preface

Children - port-groups
Context-Specific Commands
None
Data Structure
None

Front-end
Configuration of front-end connectivity to hosts.
Context
/clusters/cluster-*/connectivity/front-end
Position
Parent - connectivity
Children - port-groups
Context-Specific Commands
None
Data Structure
None

Local-com
Configuration for local-com inter-director connectivity.
Context
/clusters/cluster-*/connectivity/local-com
Position
Parent - connectivity
Children - port-groups
Context-Specific Commands
None
Data Structure
None

Wan-com
Configuration for wan-com inter-cluster connectivity.
Context
/clusters/cluster-*/connectivity/wan-com
Position
Parent - connectivity
Children - port-groups
Context-Specific Commands
remote-clusters add-addresses

EMC® VPLEX® CLI Reference Guide 19

Preface

remote-clusters clear-addresses
Data Structure
discovery-address
discovery-port
listening-port
remote-cluster-addresses

Port-groups
Communication channels formed by one port from each director in the local cluster.
Context
/clusters/cluster-*/connectivity/*/port-groups
Position
Parent - back-end, front-end, local-com, wan-com
Children - Ethernet-port-group, Fc-port-group
Context-Specific Commands
None
Data Structure
None
Notes
Port-groups are named according to the type (Ethernet: ip/iscsi, Fibre Channel: fc) and
numbering of the ports they contain. The existence of port-group instance contexts is
determined by the ports on the system. IP port-groups will only exist if Ethernet ports exist
and are assigned to the communication role associated with this context. Likewise, FC
port-groups will only exist if there are appropriate Fibre Channel ports.

Ethernet port-group
Communication channel composed of one Ethernet port from each director in the local
cluster.
Context
/clusters/cluster-*/connectivity/*/port-groups/ip-port-group-*
/clusters/cluster-*/connectivity/*/port-groups/iscsi-port-group-*
Position
Parent - port-groups
Children - member-ports, option-set, subnet
Context-Specific Commands
subnets clear
subnet remote-subnet add
subnet remote-subnet remove
Data Structure
enabled

20 EMC® VPLEX® CLI Reference Guide

 Preface

Notes
Port-groups are named according to the role (local-com/wan-com: ip, front-end/back-end:
iscsi) and numbering of the ports they contain. The existence of port-group instance
contexts is determined by the ports on the system. IP/iSCSI port-groups will only exist if
Ethernet ports exist and are assigned to the role associated with this context.

Fibre Channel port-group

Communication channel composed of one Fibre Channel port from each director in the
local cluster.
Context
/clusters/cluster-*/connectivity/*/port-groups/fc-port-group-*
Position
Parent - port-groups
Children - member-ports
Context-Specific Commands
None
Data Structure
enabled
Notes
Port-groups are named according to the numbering of the ports they contain. The
existence of port-group instance contexts is determined by the ports on the system. FC
port-groups will only exist if Fibre Channel ports exist and are assigned to the role
associated with this context.

Member-ports
A member port in a port-group.
Context
/clusters/cluster-*/connectivity/*/port-groups/*/member-ports/director-*
Position
Parent - Ethernet-port-group, Fc-port-group
Children - None
Context-Specific Commands
None
Data Structure
address director enabled engine port-name
Notes
Each member-port sub-context is named for the director to which the member port
belongs. This naming convention avoids the name collision caused when a port has the
same name on each director.
A long listing (ll) of the member-ports container context summarizes the information from
each member port:
Director Port Enabled Address

EMC® VPLEX® CLI Reference Guide 21

Preface

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

director-1-1-A ETH04 enabled 192.168.11.35
director-1-1-B ETH04 enabled 192.168.11.36
director-1-2-A ETH04 enabled 192.168.11.37
director-1-2-B ETH04 enabled 192.168.11.38

Option-sets
Option-set configuration for Ethernet port-groups.
Context
/clusters/cluster-*/connectivity/*/port-groups/ip-port-group*/option-set
/clusters/cluster-*/connectivity/*/port-groups/iscsi-port-group*/option-set
Position
Parent - Ethernet-port-group
Children - None
Context-Specific Commands
None
Data Structure
connection-open-timeout
keepalive-timeout
socket-buf-size

IP-com and iSCSI Subnets

Network configuration for Ethernet port-groups.
Context
/clusters/cluster-*/connectivity/*/port-groups/ip-port-group-*/subnet
/clusters/cluster-*/connectivity/*/port-groups/iscsi-port-group-*/subnet
Position
Parent - Ethernet-port-group
Children - None
Context-Specific Commands
All roles:
clear
Front-end and Back-end only:
remote-subnets add
remote-subnets remove
Data Structure
The attributes of a subnet depend on the role with which it is associated.
All roles:
mtu
prefix

22 EMC® VPLEX® CLI Reference Guide

 Preface

Front-end and Back-end only:

gateway
remote-subnets
Wan-com only:
cluster-address
gateway
proxy-external-address
remote-subnet-address

Related documentation
Related documents (available on EMC Online Support) include:
◆ EMC VPLEX Release Notes for GeoSynchrony Releases
◆ EMC VPLEX Product Guide
◆ EMC VPLEX Site Preparation Guide
◆ EMC VPLEX Hardware Installation Guide
◆ EMC VPLEX Configuration Worksheet
◆ EMC VPLEX Configuration Guide
◆ EMC VPLEX Security Configuration Guide
◆ EMC VPLEX CLI Reference Guide
◆ EMC VPLEX Administration Guide
◆ VPLEX Management Console Help
◆ EMC VPLEX Element Manager API Guide
◆ EMC VPLEX Open-Source Licenses
◆ EMC VPLEX GPL3 Open-Source Licenses
◆ EMC Regulatory Statement for EMC VPLEX
◆ Procedures provided through the Generator
◆ EMC Host Connectivity Guides

Conventions used in this document

EMC uses the following conventions for special notices.

Note: A note presents information that is important, but not hazard-related.

EMC® VPLEX® CLI Reference Guide 23

Preface



A caution contains information essential to avoid data loss or damage to the system or
equipment.

IMPORTANT
An important notice contains information essential to operation of the software.

Typographical conventions
EMC uses the following type style conventions in this document:
Normal Used in running (nonprocedural) text for:
• Names of interface elements (such as names of windows, dialog boxes,
buttons, fields, and menus)
• Names of resources, attributes, pools, Boolean expressions, buttons,
DQL statements, keywords, clauses, environment variables, functions,
utilities
• URLs, pathnames, filenames, directory names, computer names,
filenames, links, groups, service keys, file systems, notifications
Bold Used in running (nonprocedural) text for:
• Names of commands, daemons, options, programs, processes,
services, applications, utilities, kernels, notifications, system call, man
pages
Used in procedures for:
• Names of interface elements (such as names of windows, dialog boxes,
buttons, fields, and menus)
• What user specifically selects, clicks, presses, or types
Italic Used in all text (including procedures) for:
• Full titles of publications referenced in text
• Emphasis (for example a new term)
• Variables
Courier Used for:
• System output, such as an error message or script
• URLs, complete paths, filenames, prompts, and syntax when shown
outside of running text
Courier bold Used for:
• Specific user input (such as commands)
Courier italic Used in procedures for:
• Variables on command line
• User input variables
[] Square brackets enclose optional values
| Vertical bar indicates alternate selections - the bar means “or”
{} Braces indicate content that you must specify (that is, x or y or z)
... Ellipses indicate nonessential information omitted from the example

Where to get help

EMC support and product information can be obtained as follows:

24 EMC® VPLEX® CLI Reference Guide

 Preface

Product information — For documentation, release notes, software updates, or information

about EMC products, go to EMC Online Support at:
https://support.emc.com
Technical support — Go to EMC Online Support and click Service Center. You will see
several options for contacting EMC Technical Support. Note that to open a service request,
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.

Online communities — Visit EMC Community Network at https://community.EMC.com for

peer contacts, conversations, and content on product support and solutions. Interactively
engage online with customers, partners, and certified professionals for all EMC products.

Your comments
Your suggestions will help to improve the accuracy, organization, and overall quality of the
user publications. Send your opinions of this document to:
[email protected]

EMC® VPLEX® CLI Reference Guide 25

Preface

26 EMC® VPLEX® CLI Reference Guide

CHAPTER 1
Using the VPLEX CLI

This chapter covers the following topics.

◆ Log in to/log out from the CLI .................................................................................. 27
◆ CLI context tree ....................................................................................................... 29
◆ Navigate the CLI context tree ................................................................................... 30
◆ Using CLI commands............................................................................................... 34

Log in to/log out from the CLI

Log in

Note: Contact the System Administrator to obtain the service password. For more
information about user passwords, refer to the VPLEX Security Configuration Guide.

1. Log in to the service account at the cluster's management server's public IP address
using an SSH client (PuTTY or OpenSSH). Configure the SSH client as follows:
• Port 22
• SSH protocol version is set to 2
• Scrollback lines set to 20000
The log in prompt appears:
login as:

2. Type service and press ENTER. A password prompt appears:

Using keyboard-interactive authentication.
Password:

3. Type the service password and press ENTER.

A server prompt appears:
service@ManagementServer:~>

4. Type the vplexcli command to connect to the VPLEX command line interface:
service@ManagementServer:~> vplexcli

Several messages are displayed, and a username prompt appears:

Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.

Enter User Name:

5. Type service and press ENTER.

Enter User Name: service

Using the VPLEX CLI 27

Using the VPLEX CLI

A password prompt appears:

Password:

6. Type the service password and press ENTER.

The VPLEX command line interface prompt appears:
creating logfile:/var/log/VPlex/cli/session.
log_service_localhost_T28921_20101020175912

VPlexcli:/>

Log out
Use the exit command to exit the VPLEX command line interface from any context.
For example:
VPlexcli:/clusters> exit
Connection closed by foreign host.

Password Policies
The VPLEX management server uses a Pluggable Authentication Module (PAM)
infrastructure to enforce minimum password quality. For more information about
technology used for password protection, refer to the VPLEX Security Configuration Guide.
Refer to “Log in to/log out from the CLI” on page 27 for information on the commands
used to set password policies and the values allowed.
Note the following:
◆ Password policies do not apply to users configured using the LDAP server.
◆ Password policies do not apply to the service account.
◆ The Password inactive days policy does not apply to the admin account to protect the
admin user from account lockouts.
◆ During the management server software upgrade, an existing user’s password is not
changedonly the user’s password age information changes.
◆ You must be an admin user to configure a password policy.
Table 1 lists and describes the password policies and the default values.

Table 1 Default password policies

Policy name Description Default value

Minimum password The minimum number of characters used when 8

length creating or changing a password. The minimum
number of characters includes numbers,
upper-case and lower-case letters, and special
characters.

Minimum password age The minimum number of days a password can be 1

changed after the last password change.

28 EMC® VPLEX® CLI Reference Guide

 Using the VPLEX CLI

Table 1 Default password policies

Policy name Description Default value

Maximum password The maximum number of days that a password can 90

age be used since the last password change.
After the maximum number of days, the account is
locked and the user must contact the admin user
to reset the password.

Password expiry The number of days before the password expires. 15

warning A warning message indicating that the password
must be changed is displayed.

Password inactive days The number of days after a password has expired 1
before the account is locked.

The password policy for existing admin and customer-created user accounts is updated
automatically as part of the upgrade. See the VPLEX Security Configuration Guide for
information about service user account passwords.

Valid Password Characters

The following characters are allowed in a VPlexcli password:
◆ A-Z
◆ a-z
◆ 0-9
◆ . ? / * @ ^ % # + = - _ ~ : space

Note: A space is allowed only between the characters in a password, not in the beginning
or the end of the password

CLI context tree

The CLI is divided into command contexts. Some commands are accessible from all
contexts, and are referred to as ‘global commands’.
The remaining commands are arranged in a hierarchical context tree. These commands
can only be executed from the appropriate location in the context tree.
Understanding the command context tree is critical to using the VPLEX command line
interface effectively.
The root context contains these sub-contexts:
◆ cluster-witness/ - Manage VPLEX Witness options. If the VPLEX Witness optional
component is installed, the cluster-witness context will be available.
◆ clusters/ - Create and manage links between clusters, devices, extents, system
volumes and virtual volumes. Register initiator ports, export target ports, and storage
views.

CLI context tree 29

Using the VPLEX CLI

◆ connectivity/ - Configure connectivity between back-end storage arrays, front-end

hosts, local directors, port-groups and inter-cluster WANs.
◆ data-migrations/ - Create, verify, start, pause, cancel, and resume data migrations of
extents or devices.
◆ distributed-storage/ - Create and manage distributed devices and rule sets.
◆ engines/ - Configure and manage directors, fans, management modules, and power.
◆ management-server/ - Manage the Ethernet ports.
◆ monitoring/ - Create and manage performance monitors.
◆ notifications/ - Create and manage call-home events.
◆ recoverpoint/ - Manage RecoverPoint options.
◆ security/ - Configure and view authentication password-policy settings. Create, delete,
import and export security certificates. Set and remove login banners. The
authentication sub context was added to the security context.
◆ system-defaults/ - Display systems default settings.
Except for system-defaults/, each of the sub-contexts contains one or more sub-contexts
to configure, manage, and display sub-components.
Command contexts have commands that can be executed only from that context. The
command contexts are arranged in a hierarchical context tree. The topmost context is the
root context, or “/”.

Navigate the CLI context tree

Use the cd command to navigate between command contexts.
The current context is always displayed at the VPLEX command line interface prompt:

VPlexcli:/> cd /clusters/cluster-1/devices/

VPlexcli:/clusters/cluster-1/devices>

For example, to navigate from the root (/) context to the connectivity context to view
member ports for a specified iscsi-port-group:
VPlexcli:/> cd /clusters
VPlexcli:/clusters> cd cluster-1
VPlexcli:/clusters/cluster-1> cd connectivity
VPlexcli:/clusters/cluster-1/connectivity> cd back-end
VPlexcli:/clusters/cluster-1/connectivity/back-end> cd port-groups
VPlexcli:/clusters/cluster-1/connectivity/back-end/port-groups> cd
iscsi-port-group-8
VPlexcli:/clusters/cluster-1/connectivity/back-end/port-groups/iscsi-p
ort-group-8> cd member-ports
VPlexcli:/clusters/cluster-1/connectivity/back-end/port-groups/iscsi-p
ort-group-8/member-ports> ll

Director Port Enabled Address

------------------ ----- ------- -------------
director-1-1-A ETH08 enabled 10.10.100.100
director-1-1-B ETH08 enabled 10.10.100.101

30 EMC® VPLEX® CLI Reference Guide

 Using the VPLEX CLI

director-1-2-A ETH08 enabled 10.10.100.102

director-1-2-B ETH08 enabled 10.10.100.103

Alternatively, type all the context identifiers in a single command. For example, the above
navigation can be typed as:
VPlexcli:/> cd
clusters/cluster-1/connectivity/back-end/port-groups/iscsi-port-gro
up-8/member-ports> ll

Use the cd command with no arguments or followed by a space and three periods (cd ...)
to return to the root context:
VPlexcli:/engines/engine-1-1/fans> cd

VPlexcli:/>

Use the cd command followed by a space and two periods (cd ..) to return to the context
immediately above the current context:
VPlexcli:/monitoring/directors/director-1-1-B> cd ..

VPlexcli:/monitoring/directors>

To navigate directly to a context from any other context use the cd command and specify
the absolute context path. In the following example, the cd command changes the context
from the data migrations/ extent-migrations context to the engines/engine-1/fans
context:
VPlexcli:/data-migrations/extent-migrations> cd
/engines/engine-1-1/fans/

VPlexcli:/engines/engine-1-1/fans>

pushd and popd commands

◆ Use the pushd directory command to save the current directory, and jump to the
specified directory.
Once a directory is added to the pushd stack, use the pushd command with no
argument to switch back to the previous directory.
In the following example, pushd toggles between the engines and monitoring parent
contexts:
VPlexcli:/engines/engine-1-1/directors/director-1-1-A> pushd
/monitoring/directors/director-1-1-A
[/monitoring/directors/director-1-1-A,
/engines/engine-1-1/directors/director-1-1-A,
/monitoring/directors/director-1-1-A]

VPlexcli:/monitoring/directors/director-1-1-A> pushd
[/engines/engine-1-1/directors/director-1-1-A,
/monitoring/directors/director-1-1-A,
/monitoring/directors/director-1-1-A]

VPlexcli:/engines/engine-1-1/directors/director-1-1-A> pushd
[/monitoring/directors/director-1-1-A,
/engines/engine-1-1/directors/director-1-1-A,
/monitoring/directors/director-1-1-A]

VPlexcli:/monitoring/directors/director-1-1-A>

Navigate the CLI context tree 31

Using the VPLEX CLI

◆ Use the dirs command to display to the current context stack:

VPlexcli:/clusters/cluster-1> dirs
[/clusters/cluster-1, /, /,
/engines/engine-1-1/directors/director-1-1-A/hardware/ports/A5-GE01
, /]

◆ Use the popd command to remove the last directory saved by the pushd command
and jump to the new top directory.
In the following example, the dirs command displays the context stack saved by the
pushd command, and the popd command removes the top directory, and jumps to the
new top directory:
VPlexcli:/engines/engine-1-1/directors/director-1-1-A> dirs
[/engines/engine-1-1/directors/director-1-1-A,
/monitoring/directors/director-1-1-A]

VPlexcli:/engines/engine-1-1/directors/director-1-1-A> popd
[/engines/engine-1-1/directors/director-1-1-A]

VPlexcli:/monitoring/directors/director-1-1-A>

Where am I in the context tree?

The VPLEX CLI includes several features to help locate your current position in the context
tree and determine what contexts and/or commands are accessible.

Note: The context tree displays only those objects associated with directors to which the
management system is connected.

◆ The command prompt displays the current context:

VPlexcli:/> cd /monitoring/directors/director-1-1-B/monitors/

VPlexcli:/monitoring/directors/director-1-1-B/monitors>

◆ The ls command displays the sub-contexts immediately accessible from the current
context:
VPlexcli:/> ls
clusters data-migrations distributed-storage
engines management-server monitoring
notifications system-defaults

◆ The ls -l command displays more information about the current sub-contexts:

VPlexcli:/data-migrations> ls -l
Name Description
----------------- -------------------------------------
device-migrations Contains all the device migrations in the system.
extent-migrations Contains all the extent migrations in the system.

◆ For contexts where the next lowest level is a list of individual objects, the ls command
displays a list of the objects:
VPlexcli:/clusters/cluster-1/exports/ports> ls
P000000003B2017DF-A0-FC00 P000000003B2017DF-A0-FC01
P000000003B2017DF-A0-FC02 P000000003B2017DF-A0-FC03
P000000003B3017DF-B0-FC00 P000000003B3017DF-B0-FC01
P000000003B3017DF-B0-FC02 P000000003B3017DF-B0-FC03

32 EMC® VPLEX® CLI Reference Guide

 Using the VPLEX CLI

◆ The cd command followed by a <Tab> displays the same information as ls at the

context level.
For example, type cd and press <Tab> in the data-migrations context to display
available options:
VPlexcli:/data-migrations> cd <Tab>

device-migrations/ extent-migrations/

◆ The tree command displays the immediate sub-contexts in the tree using the current
context as the root:
VPlexcli:/ cd /clusters/cluster-1/devices/Symm_rC_3

VPlexcli:/clusters/cluster-1/devices/Symm_rC_3> tree
/clusters/cluster-1/devices/Symm_rC_3:
components
Symm_rC_3_extent_0
Symm_rC_3_extent_1

◆ The tree -e command displays immediate sub-contexts in the tree and any
sub-contexts under them:
VPlexcli:/clusters/cluster-1/devices/Symm_rC_3> tree -e
/clusters/cluster-1/devices/Symm_rC_3:
components
Symm_rC_3_extent_0
components
Symm0487_44C
components
Symm_rC_3_extent_1
components
Symm0487_44B
components

Note: For contexts where the next level down the tree is a list of objects, the tree command
displays the list. This output can be very long. For example:

VPlexcli:/clusters/cluster-1> tree
/clusters/cluster-1:
cluster-connectivity
cluster-links
to-cluster-2
proxy-servers
static-routes
devices
base0
components
extent_CX4_lun0_1
components
CX4_lun0
components
.
.
.
exports
initiator-ports
LicoJ006_hba0
LicoJ006_hba1
.
.

Navigate the CLI context tree 33

Using the VPLEX CLI

.
ports
P000000003CA00147-A0-FC00
P000000003CA00147-A0-FC01
.
.
.
storage-views
LicoJ009
LicoJ013
storage-elements
extents
extent_CX4_Logging_1
.
.

Using CLI commands

The commands that make up the CLI fall into two groups:
◆ Global commands that can be used in any context. For example: cd, date, ls, exit, user,
and security.
◆ Context-specific commands that can be used only in specific contexts. For example, to
use the copy command, the context must be /distributed-storage/rule-sets.
Use the help command to display a list of all commands (including the global commands)
available from the current context.
Use the help -G command to display a list of available commands in the current context
excluding the global commands:
VPlexcli:/notifications> help -G
Commands specific to this context and below:
call-home snmp-trap

Some contexts “inherit” commands from their parent context. These commands can be
used in both the current context and the context immediately above in the tree:
VPlexcli:/distributed-storage/bindings> help -G
Commands inherited from parent contexts:
dd rule rule-set summary

Some commands are loosely grouped by function. For example, the commands to create
and manage performance monitors start with the word “monitor”.
Use the <Tab> key display the commands within a command group. For example, to display
the commands that start with the word “monitor”, type “monitor” followed by the <Tab>
key:
VPlexcli:/> monitor <Tab>

add-console-sink add-file-sink collect create

destroy remove-sink
stat-list

34 EMC® VPLEX® CLI Reference Guide

 Using the VPLEX CLI

Page output
For large configurations, output from some commands can reach hundreds of lines.
Paging displays long output generated by the ll and ls commands one page at a time:
To enable paging, add -p at the end of any command:
VPlexcli:/clusters/cluster-1/storage-elements> ls storage-volumes -p

One page of output is displayed. The following message is at the bottom of the first page:
-- more --(TOP )- [h]elp

Press the spacebar to display the next page.

The message now indicates what percentage of the output has been displayed:
-- more --( 24%)- [h]elp

h - Displays instructions on how to move and search the output.

q - Exits paging mode.

Tab completion
Use the Tab key to:
◆ Complete a command
◆ Display valid contexts and commands
◆ Display command arguments

Complete a command
Use the Tab key to automatically complete a path or command until the path/command is
no longer unique.
For example, to navigate to the UPS context on a single cluster (named cluster-1), type:
cd /clusters/cluster-1/uninterruptible-power-supplies/

To type the same command using tab completion:

1. Type cd c Tab
Since 'clusters’ is the only context starting with ‘c’ at the root level, the CLI
auto-completes the selection:
cd /clusters/

2. There is only one cluster (it is unique). Press Tab to automatically specify the cluster:
cd /clusters/cluster-1/

3. Type a u to select the uninterruptible-power-supplies context and press Tab.

The u is unique at the current context, and the CLI auto-completes the selection:
cd /clusters/cluster-1/uninterruptible-power-supplies/

Using CLI commands 35

Using the VPLEX CLI

Display valid contexts and commands

Press Tab after typing a partial context path to display a list of valid commands and/or
contexts for the current context:
VPlexcli:/> cd /clusters/cluster-1/ <Tab>

cluster-connectivity/ devices/
exports/ storage-elements/
system-volumes/ uninterruptible-power-supplies/
virtual-volumes/

VPlexcli:/> cd /clusters/cluster-1/

Display command arguments

Press Tab after typing a command name to display the command’s arguments. For
example:
VPlexcli:/> monitor <Tab>

add-console-sink add-file-sink collect

create destroy remove-sink stat-list

Wildcards
The VPLEX command line interface includes 3 wildcards:
• * - matches any number of characters.
• ? - matches any single character.
• [a|b|c] - matches any of the single characters a or b or c.

* wildcard
Use the * wildcard to apply a single command to multiple objects of the same type
(directors or ports). For example, to display the status of ports on each director in a
cluster, without using wildcards:
ll engines/engine-1-1/directors/director-1-1-A/hardware/ports
ll engines/engine-1-1/directors/director-1-1-B/hardware/ports
ll engines/engine-1-2/directors/director-1-2-A/hardware/ports
ll engines/engine-1-2/directors/director-1-2-B/hardware/ports
.
.
.
Alternatively:
◆ Use one * wildcard to specify all engines, and
◆ Use a second * wildcard specify all directors:
ll engines/engine-1-*/directors/*/hardware/ports

** wildcard
Use the ** wildcard to match all contexts and entities between two specified objects. For
example, to display all director ports associated with all engines without using wildcards:
ll /engines/engine-1-1/directors/director-1-1-A/hardware/ports
ll /engines/engine-1-1/directors/director-1-1-B/hardware/ports
.

36 EMC® VPLEX® CLI Reference Guide

 Using the VPLEX CLI

.
.
Alternatively, use a ** wildcard to specify all contexts and entities between /engines and
ports:
ll /engines/**/ports

? wildcard
Use the ? wildcard to match a single character (number or letter).
ls /storage-elements/extents/0x1?[8|9]

Returns information on multiple extents.

[a|b|c] wildcard
Use the [a|b|c] wildcard to match one or more characters in the brackets.

ll engines/engine-1-1/directors/director-1-1-A/hardware/ports/A[0-1]

displays only ports with names starting with an A, and a second character of 0 or 1.

Names
Major components of the VPLEX are named as follows:
◆ Clusters - VPLEX Local™ configurations have a single cluster, with a cluster ID of
cluster 1. VPLEX Metro™ and VPLEX Geo™ configurations have two clusters with
cluster IDs of 1 and 2.
VPlexcli:/clusters/cluster-1/

◆ Engines are named <engine-n-n> where the first value is the cluster ID (1 or 2) and the
second value is the engine ID (1-4).
VPlexcli:/engines/engine-1-2/

◆ Directors are named <director-n-n-n> where the first value is the cluster ID (1 or 2), the
second value is the engine ID (1-4), and the third is A or B.
VPlexcli:/engines/engine-1-1/directors/director-1-1-A

For objects that can have user-defined names, those names must comply with the
following rules:
◆ Can contain uppercase and lowercase letters, numbers, and underscores
◆ No spaces
◆ Cannot start with a number
◆ No more than 63 characters

Specifying addresses
VPLEX uses both IPv4 and IPv6 addressing. Many commands can be specified as IPv4 or
IPv6 formats.

Using CLI commands 37

Using the VPLEX CLI

Refer to the EMC VPLEX Administration Guide for usage rules and address formats.

Command globbing
Command globbing combines wildcards and context identifiers in a single command.
Globbing can address multiple entities using a single command.

Example 1
In the following example, a single command enables ports in all engines and all directors
(A and B) whose name include 0-FC and 1-FC:
set /engines/*/directors/*/hardware/ports/*[0-1]-FC*:: enabled true

◆ First * wildcard — All engines in the cluster.

◆ Second * wildcard — All directors in the cluster.
◆ Third * wildcard — All A-side ports and all B-side ports.
◆ The [0-1] limits the selections to all port numbers that start with A0, A1, B0, or B1.
◆ Fourth * wildcard — All ports whose numbers start with A0-FC, A1-FC, B0-FC, or B1-FC.

Example 2
To display the status of all the director ports on a large configuration using no wildcards,
type:
ll /engines/engine-1-<Enclosure_ID>/directors/<director_
name>/hardware/ports

for each engine and director.

Using the * wildcard reduces this task to a single command:
ll /engines/engine-1-*/directors/*/hardware/ports

Using the ** wildcard simplifies the command even more:

ll /**/ports

Positional command arguments

Most commands require arguments.
Some command arguments are positional. That is, the argument can be typed without an
identifier IF it is entered in the position specified by the command syntax.
For example, the alias command has two arguments in the following order (syntax):
alias
[-n|--name] <alias name>
[-t|to] <“string of commands in quotes”>

Type the command with the arguments with identifiers in any order (not as specified by
the syntax):
VPlexcli:/> alias --to "cd clusters" --name cdc
or,

38 EMC® VPLEX® CLI Reference Guide

 Using the VPLEX CLI

Type the command with the arguments without identifiers in the order specified by the
command syntax:
VPlexcli:/> alias cdc "cd clusters"

--verbose argument
The --verbose argument displays additional information for some commands. For
example, without --verbose argument:
VPlexcli:/> connectivity validate-be
Cluster cluster-1
0 storage-volumes which are dead or unreachable.
0 storage-volumes which do not meet the high availability requirement
for storage volume paths*.
0 storage-volumes which are not visible from all directors.
0 storage-volumes which have more than supported (4) active paths from
same director.
*To meet the high availability requirement for storage volume paths each
storage volume must be accessible from each of the directors through 2
or more VPlex backend ports, and 2 or more Array target ports, and there
should be 2 or more ITLs.

Cluster cluster-2
0 storage-volumes which are dead or unreachable.
0 storage-volumes which do not meet the high availability requirement
for storage volume paths*.
0 storage-volumes which are not visible from all directors.
0 storage-volumes which have more than supported (4) active paths from
same director.
*To meet the high availability requirement for storage volume paths each
storage volume must be accessible from each of the directors through 2
or more VPlex backend ports, and 2 or more Array target ports, and there
should be 2 or more ITLs.

VPlexcli:/>

With --verbose argument:

VPlexcli:/> connectivity validate-be --verbose
Gathering data for cluster cluster-1
Gathering data for cluster cluster-2
Cluster cluster-1
0 storage-volumes which are dead or unreachable.
0 storage-volumes which do not meet the high availability requirement
for storage volume paths*.
0 storage-volumes which are not visible from all directors.
0 storage-volumes which have more than supported (4) active paths from
same director.
*To meet the high availability requirement for storage volume paths each
storage volume must be accessible from each of the directors through 2
or more VPlex backend ports, and 2 or more Array target ports, and there
should be 2 or more ITLs.

Cluster cluster-2
0 storage-volumes which are dead or unreachable.
0 storage-volumes which do not meet the high availability requirement
for storage volume paths*.
0 storage-volumes which are not visible from all directors.
0 storage-volumes which have more than supported (4) active paths from
same director.
*To meet the high availability requirement for storage volume paths each
storage volume must be accessible from each of the directors through 2
or more VPlex backend ports, and 2 or more Array target ports, and there
should be 2 or more ITLs.

Using CLI commands 39

Using the VPLEX CLI

VPlexcli:/>

Search command history

◆ To display the last commands typed, press the up arrow key.
◆ To search for a command typed in the current CLI session, press Ctrl-r.
The reverse search prompt is displayed:
(reverse-i-search)'':

Type the first letter of the command to search for. After the first letter is typed, the
search tool displays a list of possible matches.

View command history

Use the “up arrow” key to display the last command typed.
Use the “up arrow” key, multiple times to display recent command history.
Use the history command to display a complete list of commands executed in the current
session:
VPlexcli:/engines/engine-0-0/directors> history
VPlexcli:/> history
0 cd engines/engine-0-0/directors
1 extent unclaim *
2 ls
3 ls -l
4 extent claim *
5 ls
6 ls -l
7 ls -la

Use the history nn command to display the last nn entries in the list:
VPlexcli:/clusters/cluster-1> history 22
478 ls storage-volumes -p
479 cd clusters/cluster-1/
480 ls storage-volumes
481 cd storage-elements/
482 ls storage-volumes -p

Get help
◆ Use the help or ? command with no arguments to display all the commands available,
the current context, including global commands.
◆ Use the help or ? command with -G argument to display all the commands available,
the current context, excluding global commands:
VPlexcli:/clusters> help -G
Commands specific to this context and below:

add cacheflush configdump expel forget shutdown summary unexpel

◆ Use the help command or command -help to display help for the specified command.

40 EMC® VPLEX® CLI Reference Guide

CHAPTER 2
VPLEX CLI Command Descriptions

This chapter describes each of the VPLEX CLI commands in alphabetical order.

advadm dismantle
Dismantles VPLEX storage objects down to the storage-volume level, and optionally
unclaims the storage volumes.

Contexts All contexts.

Syntax advadm dismantle

[-r|--devices] context path,context path
[-v|--virtual-volumes] context path,context path
[--unclaim-storage-volumes]
[-f|--force]

Arguments Required arguments

[-r|--devices] context path,context path... - One or more devices to dismantle. Entries must
be separated by commas. Glob patterns may be used.
[-v|--virtual-volumes] context path,context path... - One or more virtual volume(s) to
dismantle. Entries must be separated by commas. Glob patterns may be used.

Optional arguments
--unclaim-storage-volumes - Unclaim the storage volumes after the dismantle is
completed.
[-f|--force] - Force the dismantle without asking for confirmation. Allows the command to
be run from a non-interactive script.

Description To dismantle a virtual volume, the specified volume must:

◆ Not be exported to a storage view.
◆ Not a member of a consistency group
Virtual-volumes exported through a storage-view or belonging to a consistency-group are
not eligible to be dismantled. The command will skip any volumes that are not eligible for
dismantle, print a message listing skipped volumes, and dismantle those volumes that
are eligible.
If the --force argument is used, no confirmation is displayed before the dismantle is
performed.

Example In the following example, the specified volume is dismantled:

VPlexcli:/clusters/cluster-1> advadm dismantle --verbose
--virtual-volumes virtual-volumes/test_r1_vol --force

destroyed virtual volume

/clusters/cluster-1/virtual-volumes/test_r1_vol
destroyed /clusters/cluster-2/devices/test_r1

VPLEX CLI Command Descriptions 41

VPLEX CLI Command Descriptions

Destroyed 1 out of 1 targetted extents.

destroyed
/clusters/cluster-1/storage-elements/extents/extent_CLAR0014_LUN14_
1

Example In the following example, the specified volumes are NOT dismantled because they are
exported or are members of a consistency group:
VPlexcli:/> advadm dismantle -v rC_extentSrc_C1_CHM_00*, axel_dr1_vol

The following virtual-volumes will not be dismantled because they are exported. Please remove
them from the storage-views before dismantling them:
/clusters/cluster-1/virtual-volumes/rC_extentSrc_C1_CHM_0002_vol is in
/clusters/cluster-1/exports/storage-views/chimera_setupTearDown_C1
/clusters/cluster-1/virtual-volumes/rC_extentSrc_C1_CHM_0001_vol is in
/clusters/cluster-1/exports/storage-views/chimera_setupTearDown_C1
.
.
.
The following virtual-volumes will not be dismantled because they are in consistency-groups.
Please remove them from the consistency-groups before dismantling them:
/clusters/cluster-2/virtual-volumes/axel_dr1_vol is in
/clusters/cluster-2/consistency-groups/async_sC12_vC12_nAW_CHM

No virtual-volumes to dismantle.

See also ◆ ds dd create

◆ iscsi sendtargets add
◆ virtual-volume create

alias
Creates a command alias.

Contexts All contexts.

Syntax alias
[-n|--name] name
[-t|--to] “commands and arguments to include
in the new alias”

Arguments Required arguments

[-n|--name] name - * The name of the new alias.
• Up to 63 characters.
• May contain letters, numbers, and underscores '_'. s
• Cannot start with a number.
[-t|--to] “commands and arguments” - * A string of commands and arguments enclosed in
quotation marks. This string is invoked when the aliased command is used.
* - argument is positional.

Description Aliases are shortcuts for frequently used commands or commands that require long
strings of context identifiers.

42 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Use the alias command with no arguments to display a list of all aliases configured on the
VPLEX.
Use the alias name command to display the underlying string of the specified alias.
Use the alias name “string of CLI commands” command to create an alias with the
specified name that invokes the specified string of commands.
Use the unalias command to delete an alias.
The following aliases are pre-configured:
• ? Substitutes for the help command.
• ll Substitutes for the ls -a command.
• quit Substitutes for the exit command.
An alias that executes correctly in one context may conflict with an existing command
when executed from another context (pre-existing commands are executed before aliases
if the syntax is identical).
Make sure that the alias name is unique, that is, not identical to an existing command or
alias.
If an alias does not behave as expected, delete or reassign the alias.
The CLI executes the first matching command, including aliases in the following order:
1. Local command in the current context.
2. Global command in the current context.
3. Root context is searched for a match.
An alias set at the command line will not persist when the user interface is restarted. To
create a alias command that will persist, add it to the /var/log/VPlex/cli/VPlexcli-init file.

Example Create an alias:

VPlexcli:/> alias mon-Dir-1-1-B "cd /monitoring/directors/director-1-1-B"

Display a list of aliases:

VPlexcli:/> alias
Name Description
--------------- -------------------------------------------------------
? Substitutes the 'help' command.
mon-Dir-1-1-B Substitutes the 'cd /monitoring/directors/director-1-1-B'
ll Substitutes the 'ls -al' command.
quit Substitutes the 'exit' command.

Display a specified alias:

VPlexcli:/> alias mon-Dir-1-1-B
Name Description
--------------- --------------------------------------------------------------
mon-Dir-1-1-B Substitutes the 'cd /monitoring/directors/director-1-1-B' command.

Use an alias:
VPlexcli:/> mon-Dir-1-1-B

VPlexcli:/monitoring/directors/director-1-1-B>

alias 43
VPLEX CLI Command Descriptions

See also ◆ ls
◆ unalias

amp register
Associates Array Management Provider to a single VPLEX Cluster.

Contexts /clusters/ClusterName/storage-elements/array-providers

Syntax amp register

[-n | --name] name
[-i | --ip-address] ip-address of Array Management Provider
[-u | --username] user name
[-t | --provider-type] provider type
[-p | --port-number] port number
[-c | --cluster] cluster context path
[-s | --use-ssl]
[-h | --help]
[--verbose]

Arguments Required arguments

[-n | --name] name - * The name of the Array Management Provider.
[-i | --ip-address] ip-address of Array Management Provider - * The IP address of the Array
Management Provider.
[-u | --username] user name - * The user name required for connecting to the Array
Management Provider.
[-t | --provider-type] provider type - * The type of Array Management Provider. SMI-S is
currently the only provider type supported.
[-p | --port-number] port number - * The port number to use along with the IP-address to
construct the URL indicating the Array Management Provider.
* - positional argument

Optional Arguments
[-c | --cluster] cluster context path - The VPLEX cluster associated with the Array
Management Provider. This argument may be omitted when the command is executed
from or below a cluster context (meaning the cluster is implied).
[-s | --use-ssl] - Specifies whether to use HTTP or HTTPS (SSL) protocol when connecting to
the Array Management Provider URL.
[-h |--help] - Displays the usage for this command.
[--verbose] - Provides more output during command execution.

Description An Array Management Provider (AMP) is an external array management endpoint that
VPLEX communicates with to execute operations on individual arrays. Examples of AMPs
include external SMI-S providers
An AMP exposes a management protocol/API. Array operations can be executed through
this API. Examples of Management protocols include Provisioning and Snap & Clone.
An AMP manages one or more arrays. For example, an SMI-S provider can manage multiple
arrays.

44 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Example Registering (adding) an array provider:

VPlexcli:/> amp register -n mysmis -i 10.12.234.12 -u admin -t SMI-S -p 1234 -c Hopkinton
Enter array provider password:
Enter array provider password again for verification:
Successfully registered array provider.

Example Registering (adding) an array provider with an invalid provider type:

VPlexcli:/> amp register -n mysmis -i 10.12.234.12 -u admin -t vasa -p 1234 -c Hopkinton
amp register: Evaluation of <<amp register -n mysmis -i 10.12.234.12 -u admin -t vasa -p 1234
-c Hopkinton>> failed.
cause: Command execution failed.
cause: Failed to set value for option --provider-type.
cause: 'vasa' is not a valid amp-type for command 'amp register'. Valid values: 'smi-s'
(not case sensitive).

See also ◆ amp unregister

amp unregister
Unregisters Array Management Provider.The Array Management provider is no longer
available for any operations after being unregistered.

Contexts /clusters/ClusterName/storage-elements/array-providers

Syntax amp unregister

[-n | --array-provider] array-provider context path
[-c | --cluster] cluster context
[-f | --force]
[-h | --help]
[--verbose]

Arguments Required arguments

[-n | --array-provider] array-provider context path - * The array management provider to
unregister.
* - positional argument

Optional Arguments
[-c | --cluster] cluster context - The cluster associated with the Array Management Provider.
Can be omitted when the command is executed from or below a cluster context in which
case the cluster is implied.
[-f | --force] - Force the operation without confirmation. Allows the command to be run from
a non-interactive script.
[-h |--help] - Displays the usage for this command.
[--verbose] - Provides more output during command execution.

Description An Array Management Provider (AMP) is an external array management endpoint that
VPLEX communicates with to execute operations on individual arrays. Examples of AMPs
include external SMI-S providers
The amp unregister command unregisters an array provider. The AMP is no longer
available for any operations.

amp unregister 45
VPLEX CLI Command Descriptions

After being unregistered, the array-provider is no longer available. Re-registering the

provider results in definition of a new provider.



In the initial release, the CLI provides no validation for this command. Therefore, always
ensure the AMP is safe to remove before unregistering a provider. For example, ensure
the AMP is not currently in use or required by any provisioned volumes. In the future,
validation will be added for this command.

Example Unregistering an array provider:

VPlexcli:/> amp unregister -n myAmpThatExistsAndIsNotFake

Warning: Unregistering an array-provider will permanently remove it.

Do you wish to proceed? (Yes/No): Yes

VPlexcli:/>

Example Unregistering an array provider with an invalid provider:

VPlexcli:/> amp unregister -n myExcellentAMP -c cluster-1

Unregistering an array-provider will permanently remove it. Do you wish to proceed? (Yes/No)
Yes

amp unregister: Evaluation of <<amp unregister -n myExcellentAMP -c cluster-1>> failed.

cause: Failed to unregister array-provider 'myExcellentAMP' on cluster 'cluster-1'.
cause: The array-provider 'myExcellentAMP' is not a registered array-provider on
cluster 'cluster-1'.

VPlexcli:/>

See also ◆ amp register

array claim
Claims and names unclaimed storage volumes for a given array.

Contexts All contexts.

Syntax array claim

[-s|--storage-array] context-path
[-m|--mapping-file] mapping file
[-t|--tier]
[-l|--claim]
[--force]

Arguments Required arguments

[-s|--storage-array] context-path - * Context path of the storage-array on which to claim
storage volumes.

Optional arguments
[-m|--mapping-file] mapping file - Location of the name mapping file.
[-t|--tier] mapping file - Add a tier identifier to the storage volumes to be claimed.
[-l|--claim] - Try to claim unclaimed storage-volumes.

46 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

[--force] - Force the operation without confirmation. Allows the command to be run from a
non-interactive script.
* - argument is positional.

Description Claims and names unclaimed storage volumes for a given array.
Some storage arrays support auto-naming (EMC Symmetrix/VMAX, CLARiiON/VNX,
XtremIO, Hitachi AMS 1000, HDS 9970/9980 and USP VM) and do not require a mapping
file.
Other storage arrays require a hints file generated by the storage administrator using the
array’s command line. The hints file contains the device names and their World Wide
Names. Refer to Table 21, “Create hints files for storage-volume naming,”.
Use the --mapping-file argument to specify a hints file to use for naming claimed storage
volumes. File names will be used to determine the array name.
Use the --tier argument to add a storage tier identifier in the storage-volume names.
This command can fail if there is not a sufficient number of metavolume slots. See the
troubleshooting section of the VPLEX procedures in the SolVe Desktop for a resolution to
this problem.

Example In the following example, the array claim command:

◆ Claims and all storage_volumes from the selected array
◆ Names the storage-volumes (Clar0400L_lun name) using mapping file
/tmp/Clar0400.txt
◆ Adds the tier identifier “L” to the storage-volume names:
VPlexcli:/> array claim -s FNM00083800066-0x050060160bce00f37 --mapping-file=/tmp/Clar0400.txt
--tier=L

See also ◆ storage-volume find-array

array re-discover
Re-discovers an array, and makes the array's storage volumes visible to the VPLEX.

Contexts Cluster-specific context and lower.

Syntax array re-discover

[-a|--array] context-path
[-c|--cluster] cluster-id
[-d|--hard]
[-f|--force]

Arguments Required arguments

[-a|--array] context-path - * Context path that specifies the storage-array to re-discover.
[-c|--cluster] cluster-id - Cluster ID of the target cluster.

Optional arguments
[-d|--hard] - Perform a hard rediscover. This is disruptive.

array re-discover 47
VPLEX CLI Command Descriptions



The --hard option is disruptive and can result in data unavailability and/or data loss on
live exported paths.

Logical-unit swapping occurs when the number of logical-units remains the same, when
the actual logical-units have changed. If logical-unit swapping occurred, use the --hard
argument to force renewal of all ITs in the array.
If the --hard argument is not used, this command does not detect logical-unit swapping
conditions, and I/O is not disrupted on the logical-units that have not changed.
[-f|--force] - Force the operation without confirmation. Allows the command to be run from
a non-interactive script.
* - argument is positional.

Description Manually synchronizes the export state of the target device. Used in two scenarios:
◆ When the exported LUNs from the target array to VPLEX are modified.
Newer protocol-compliant SCSI devices return a notification code when the exported
set changes, and may not require manual synchronization. Older devices that do not
return a notification, must be manually synchronized.
◆ When the array is not experiencing I/O (the transport interface is idle), there is no
mechanism by which to collect the notification code. In this scenario, do one of the
following:
• Wait until I/O is attempted on any of the LUNs,
• Disruptively disconnect and reconnect the array, or
• Use the array rediscover command.



This command cannot detect LUN-swapping conditions on the array(s) being
re-discovered. On older configurations, this might disrupt I/O on more than the given
array.

Use the ll /clusters/*/storage-elements/storage-arrays/ command to display the names

of storage arrays.

Example In the following example:

◆ The ll /clusters/*/storage-elements/storage-arrays/ command displays the names of
storage arrays.
◆ The array re-discover command re-discovers a specified array:

48 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

VPlexcli:/clusters/cluster-1> array re-discover

storage-elements/storage-arrays/EMC-0x00000000192601378 --force

from the individual storage array context:

VPlexcli:/> cd /clusters/cluster-1/storage-elements/storage-arrays/EMC-0x00000000192601378

VPlexcli:/clusters/cluster-1/storage-elements/storage-arrays/EMC-0x00000000192601378> array
re-discover --force

See also ◆ storage-volume find-array

array re-discover 49
VPLEX CLI Command Descriptions

array register
Registers the specified iSCSI storage-array.

Contexts All contexts.

Syntax array register

[-a|--array] IP address:port number
[-c|--cluster] context-path,context-path...

Arguments Required arguments

[-a|--array] IP address:port number - * IP-address and an optional port number in the
following format:
10.31.199.255:3260.
If port number is not specified the default port number 3260 is used.
[-c|--cluster] context-path,cpntext-path,... - Context paths of the clusters on which the
iSCSI array is registered.
* - argument is positional.

Description This command registers the specified iSCSI storage-array.

Example Register two iSCSI arrays:

VPlexcli:/engines/engine-1-1/directors/director-1-1-A/hardware> array register --clusters
cluster-1 --array 10.31.199.255:3260 10.31.199.255:3260

See also ◆ export initiator-port register

array used-by
Displays the components that use a specified storage-array.

Contexts All contexts.

Syntax array used-by

[-a|--array] context-path

Arguments [-a|--array] context-path - * Specifies the storage-array for which to find users. This
argument is not required if the context is the target array.
* - argument is positional.

Description Displays the components (storage-volumes) that use the specified storage array.

Example Display the usage of components in an array from the target storage array context:
VPlexcli:/clusters/cluster-1/storage-elements/storage-arrays/EMC-CLARiiON-APM00050404263>
array used-by

Used-by details for storage-array EMC-CLARiiON-APM00050404263:

/clusters/cluster-1/storage-elements/extents/extent_6006016061211100363da903017ae011_1:
SV1

/clusters/cluster-1/devices/dev_clus1:

50 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

extent_SV1_1
SV1

/clusters/cluster-1/system-volumes/log1_vol:
extent_SV1_2
SV1

/clusters/cluster-1/devices/clus1_device1:
extent_SV1_3
SV1

/clusters/cluster-1/devices/clus1_dev2:
extent_SV1_4
SV1

/clusters/cluster-1/devices/device_6006016061211100d42febba1bade011_1:
extent_6006016061211100d42febba1bade011_1
VPD83T3:6006016061211100d42febba1bade011

/distributed-storage/distributed-devices/dev1_source:
dev1_source2012Feb16_191413
extent_sv1_1
sv1

/clusters/cluster-1/system-volumes/MetaVol:
VPD83T3:6006016022131300de76a5cec256df11

/clusters/cluster-1/system-volumes/MetaVol:
VPD83T3:600601606121110014da56b3b277e011

/clusters/cluster-1/system-volumes/MetaVol_backup_2012Feb13_071901:
VPD83T3:6006016061211100c4a223611bade011

Summary:
Count of storage-volumes that are not in use: 0
Count of storage-volumes that are in use: 6

Example Display the usage of components in an array from the /storage-arrays context:
VPlexcli:/clusters/cluster-1/storage-elements/storage-arrays> array used-by --array
EMC-CLARiiON-APM00050404263

Used-by details for storage-array EMC-CLARiiON-APM00050404263:

/clusters/cluster-1/storage-elements/extents/extent_6006016061211100363da903017ae011_1:
SV1
.
.
.

See also ◆ storage-volume find-array

◆ storage-volume summary

authentication directory-service configure

Configures a directory service on the VPLEX cluster to authenticate users against a remote
directory server.

authentication directory-service configure 51

VPLEX CLI Command Descriptions

Note: The -m option is no longer supported. Use the -g and -u options for managing access
to the management server by groups and users.

Contexts All contexts.

Syntax authentication directory-service configure

[-d|--directory-server] [1|2]
[-i|--ip-address] IP address
[-b|--base-distinguished-name] “base-distinguished-name”
[-n|--bind-distinguished-name] “bind-distinguished-name”
[-p|--bind-password]
[-r|--user-search-path] “user-search-path”
[-s|--server-name] server-name
[-t|--connection-type] [1|2]
[-o|--port] port
[-c|--custom-attributes]
[-u|--map-user] “map-user”
[-g|--map-group] “map-group”
--dry-run

Arguments Required arguments

[-d|--directory-server] [1|2] - Specifies the directory server to configure on the cluster to
authenticate users.
• 1 - Configures the directory service to map attributes for OpenLDAP directory with
POSIX attributes.
• 2 - Configures the directory service to map attributes for Active Directory.

Note: If option 2 (Active Directory) is selected, use the --custom-attributes argument to

map attributes if directory server UNIX attributes are different from the default attributes
mapped by VPLEX.

[-i|--ip-address] IP address - IP address of the directory server.

[-b|--base-distinguished-name] “base-distinguished-name” - The base Distinguished
Name (DN) of the directory server. A DN is a sequence of relative distinguished names
connected by commas. For example:
dc=org,dc=company,dc=com

The Distinguished Name must be enclosed in quotes.

[-n|--bind-distinguished-name] “bind-distinguished-name” - The Bind Distinguished
Name of the OpenLDAP/Active Directory server. For example:
cn=Manager,dc=my-domain,dc=com

The Bind Distinguished Name must be enclosed in quotes.

[-p| --bind-password] - Password of Bind Distinguished Name. A prompt for the password
is displayed. The password is not displayed as it is typed.
[-r | --user-search-path] “user-search-path” - The distinguished name of the node at which
to begin user searches in the directory server. user-search-path is a sequence of relative
distinguished names connected by commas. The principal specified for a
user-search-path must belong to an organizational unit class. The user-search-path must
be enclosed in quotes.

52 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Optional arguments
[-s|--server-name] server-name - Name of the directory server. This argument is required
when the --connection-type argument is specified with a value of 2 (LDAPS).
[-t|--connection-type] {1|2} - Select the cryptographic protocol to use to connect to the
LDAP/Active Directory server. Values are:
• 1 - (Default) - Use LDAP. Communication with the LDAP/Active Directory server will
be in plain text.
• 2 - Use the Secure LDAP (LDAPS). If LDAPS is selected, use the --server-name
argument to specify the LDAP server.
[-o|--port] port - Port number of the LDAP/Active Directory server.
Range: 1- 65536.
Default: 389 when --connection-type is set to LDAP (1).
[-c|--custom-attributes] - Provide custom attribute names for attribute mapping. Prompts
for mapping the attribute names.
[-u|--map-user] “map-user” - Specifies which users can login to the management server.
The map-user must be enclosed in quotes.
[-g|--map-group] “map-group” - Specifies a group. Only members of this group within the
user search path can log in to the management server. The map-group must be enclosed
in quotes.
--dry-run - Run the command but don't do anything.

Description This command configures an authentication service on the VPLEX cluster.

VPLEX supports two types of authentication service providers to authenticate users:
OpenLDAP and Active Directory servers.
When VPLEX is configured with OpenLDAP, it uses POSIX account attribute mapping by
default. When VPLEX is configured with Active Directory server, it uses SFU 3.0 attribute
mapping by default.
If directory server UNIX attributes are different, use --custom-attributes and
--directory-server arguments.
In order to authenticate directory service users, directory service must be configured on
the VPLEX. Configuration includes:
◆ The type of directory server (OpenLDAP or Active Directory).
• OpenLDAP by default maps POSIX attributes.
• Active Directory by default maps SFU 3.0 attributes.
◆ The directory server’s IP address
◆ Whether the LDAP or LDAPs protocol is used
◆ Base Distinguished Name, for example:
dc=security,dc=orgName,dc=companyName,dc=com

◆ Bind Distinguished Name, for example:

authentication directory-service configure 53

VPLEX CLI Command Descriptions

cn=Administrator,dc=security,dc=orgName,dc=companyName,dc=com

◆ Map principal, for example:

ou=people,dc=security,dc=orgName,dc=companyName,dc=com

Best practice is to add groups rather than users. Adding groups allows multiple users to be
added using one map-principal. VPLEX is abstracted from any changes (modify/delete) to
the user.

Example Configure the Active Directory directory service on the VPLEX cluster:
VPlexcli:/> authentication directory-service configure -d 2 -i 192.168.98.101 -b
"dc=org,dc=company,dc=com" -r
"ou=vplex,dc=org,dc=company,dc=com" -n "cn=Administrator,cn=Users,dc=org,dc=company,dc=com" -t
2 -s servername -p

OR

VPlexcli:/> authentication directory-service configure -d 1 -i 192.168.98.102 -b

"dc=org,dc=company,dc=com" -r
"ou=vplex,dc=org,dc=company,dc=com" -g "cn=testgroup,dc=org,dc=company,dc=com" -n
"cn=Administrator,dc=org,dc=company,dc=com" -o
9389 -p

OR

VPlexcli:/> authentication directory-service configure -d 2 -i 192.168.98.101 -b

"dc=org,dc=company,dc=com" -r
"ou=vplex,dc=org,dc=company,dc=com" -u "uid=testuser,ou=vplex,dc=org,dc=company,dc=com" -n
"cn=Administrator,cn=Users,dc=org,dc=company,dc=com" --custom-attributes -p

Example Configure the Active Directory service using custom attributes:

Note: Default values are displayed in brackets for each attribute. Press Enter to accept the
default, or type a value and press Enter. Values for custom attributes are case sensitive.
Verify the case when specifying the value for a custom attribute.

VPlexcli:/> authentication directory-service configure -d 2 -i 10.31.52.189 -b

"dc=intranet,dc=vplex,dc=com" -r "ou=qe,ou=vbu,ou=glb,dc=intranet,dc=vplex,dc=com" -u
"cn=user1,ou=qe,ou=vbu,ou=glb,dc=intranet,dc=vplex,dc=com" -g
"cn=devgroup,ou=qe,ou=vbu,ou=glb,dc=intranet,dc=vplex,dc=com" -n
"cn=Administrator,cn=Users,dc=intranet,dc=vplex,dc=com" -p --custom-attributes

Please note that configuring LDAP means that network channel data is unencrypted. A better
option is to use LDAPS so the data is encrypted. Are you sure you want to continue the
configuration with LDAP. Continue? (Yes/No) Yes

Enter Administrator's password:

Set value for posixAccount attribute [User]:

Set value for posixGroup attribute [Group]:

Set value for uid attribute [msSFU30Name]: sAMAccountName

Set value for uidNumber attribute [msSFU30UidNumber]: uidNumber

Set value for gidNumber attribute [msSFU30GidNumber]: primaryGroupID

Set value for loginShell attribute [msSFU30LoginShell]: LoginShell

54 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Set value for homeDirectory attribute [msSFU30HomeDirectory]: unixHomeDirectory

Connecting to authentication server (may take 3 minutes) ...

VPlexcli:/>

Example Configure the OpenLDAP service on the management server:

Note: To define a different posixGroup attribute use custom attributes. Use an appropriate
objectClass attribute for posixGroup (e.g., “posixGroup” or “groupOfNames” or “Group”)
as used by the OpenLDAP server.

VPlexcli:/> authentication directory-service configure

-d 1
-i "3ffe:80c0:22c:803c:211:43ff:fede:9798"
-b "dc=security,dc=sve,dc=emc,dc=com"
-r "ou=qe,dc=security,dc=sve,dc=emc,dc=com"
-n "cn=Administrator,dc=security,dc=sve,dc=emc,dc=com"
-p

Enter Administrator's password:

Connecting to authentication server (may take 3 minutes) ...

VPlexcli:/>

See also ◆ authentication directory-service map

◆ authentication directory-service show
◆ authentication directory-service unconfigure

authentication directory-service map

Maps a directory server user or a user group to a VPLEX cluster.

Contexts All contexts.

Syntax authentication directory-service map

[-m|--map-principal] “map-principal”
[-u|--map-user] "user-principal"
[-g|--map-group] "group-principal"
--dry-run

Arguments Optional arguments

Note: Option -m for commands can only be used with the older configuration. Use the -g
and -u options for adding user and group access to the management server.

[-m|--map-principal] ”map-principal” - Map a directory Server user or user group to the

cluster. A map-principal is a sequence of relative distinguished names connected by
commas. For example:
OU=eng,dc=vplex,dc=security,dc=lab,dc=emc,dc=com

The map-principal must be enclosed in quotes.

authentication directory-service map 55

VPLEX CLI Command Descriptions

To include a backslash (\) in the map-principal, precede the backslash by a second

backslash. For example, to specify the map-principal:
CN=user\ test: (IT),OU=group,DC=company,DC=com

Enter:
“CN=user\\ test: (IT),OU=group,DC=company,DC=com"

[-u|--map-user] "user-principal" - Users matching this search string will be authenticated.

The user-principal must be enclosed in quotes.
[-g|--map-group] "group-principal" - Users in the group matching this search string are
authenticated. Members of the group should be part of the user-search-path specified
during the configuration. The group-principal must be enclosed in quotes.
--dry-run - Run the command but don’t do anything.

Description A directory server user is an account that can log in to the VPLEX Management Server.
Users can be specified explicitly or implicitly via groups.
Best practice is to add groups rather than users. Adding groups allows multiple users to be
added using one map-principal. VPLEX is abstracted from any changes (modify/delete) to
the user.

Example Map an LDAP user to VPLEX cluster:

VPlexcli> authentication directory-service map -u
"cn=user2,ou=qe,ou=vbu,ou=glb,dc=intranet,dc=vplex,dc=com"

Example Map an LDAP user group to VPLEX cluster:

VPlexcli> authentication directory-service map -g
"cn=unix_group,dc=intranet,dc=vplex,dc=com"

See also ◆ authentication directory-service configure

◆ authentication directory-service show
◆ authentication directory-service unmap

authentication directory-service show

Displays configuration of the directory service used to authenticate users.

Contexts All contexts.

Syntax authentication directory-service show

Example Display the authentication service configuration:

VPlexcli:/> authentication directory-service show
external-authentication-service: OpenLDAP

ip: 10.31.52.53

User Search Path: ou=qe,dc=security,dc=sve,dc=emc,dc=com

connection-type: Plain Text TLS

56 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

mapped-principal:
[Users ]: ['uid=testUser3,ou=qe,dc=security,dc=sve,dc=emc,dc=com']

See also

Table 1 authentication directory-service show field descriptions

Field Description

default-authentication-service Always Native VPLEX

external-authentication-service Directory service configured on the cluster.

OpenLDAP - Lightweight Directory Access Protocol.
AD - Windows Active Directory 2003 with SFU 3.5

ip IP address of the directory server.

base-dn Base Distinguished Name of the directory service. Components:

dc - domainComponent
cn - commonName
ou - organizationalUnitName
uid - userid

connection-type Cryptographic protocol used to connect to the LDAP server.

LDAP - Plain text protocol
LDAPS - Secure protocol

uri Uniform resource identifier of the directory server.

mapped-principal Users and/or groups mapped to directory server.

◆ authentication directory-service configure

◆ authentication directory-service map

authentication directory-service unconfigure

Removes the configuration of a directory service on the VPLEX cluster.

Contexts All contexts.

Syntax authentication directory-service unconfigure

[-f|--force]

Arguments Optional arguments

[-f|--force] - Force the unconfigure without asking for confirmation.

Description Removes the existing directory service configuration from the VPLEX management server.

Example Remove the existing directory service configuration:

VPlexcli:/> authentication directory-service unconfigure

This command will unconfigure the existing directory service.. Continue? (Yes/No) Yes

See also ◆ authentication directory-service configure

◆ authentication directory-service show

authentication directory-service unconfigure 57

VPLEX CLI Command Descriptions

◆ authentication directory-service unmap

authentication directory-service unmap

Unmaps the specified directory server user or user group from the VPLEX cluster.

Contexts All contexts.

Syntax authentication directory-service unmap

[-m|--map-principal] “mapped-principal”
[-u|--map-user] “user-principal”
[-g|--map-group] “group-principal”

Arguments Optional arguments

Note: Option -m for commands can only be used with the older configuration. Use the -g
and -u options for adding user and group access to the management server.

[-m|--map-principal] “mapped-principal” - Mapped directory server Distinguished Name to

unmap. For example:
ou=eng,dc=vplex,dc=security,dc=lab,dc=emc,dc=com

The map-principal must be enclosed in quotes.

To include a backslash (\) in the map-principal, precede the backslash by a second
backslash. For example, to specify the map-principal:
CN=user\ test: (IT),ou=group,DC=company,DC=com

Enter:
“CN=user\\ test: (IT),OU=group,DC=company,DC=com"

Note: The “mapped-principal” argument is case-sensitive and varies depending on the

directory service configured:

If the directory service is OpenLDAP, entries in the mapped principal argument ('ou', 'uid',
'dc) must be specified in small letters (no capitals).

If the directory service is AD, entries in the mapped principal argument ('OU', 'CN', 'DC')
must be specified in capital letters.

Use the authentication directory-service show command to display the current mapped
principals.

[-u|--map-user] "user-principal" - Users matching this search string will be authenticated.

The user-principal must be enclosed in quotes.
[-g|--map-group] "group-principal" - Users in the group matching this search string are
authenticated. Members of the group should be part of the user-search-path specified
during the configuration. The group-principal must be enclosed in quotes.

58 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Description This command unmaps a directory server user or a user group from the VPLEX cluster.
There must be at least one principal mapped. If there is only one principal, it cannot be
unmapped. If a user search path is specified, unmapping all users and group principals
will provide access to all users in the user search path.

Example Unmap a directory server user group from a VPLEX cluster:

VPlexcli:/> authentication directory-service unmap -g "cn=testgroup,dc=org,dc=company,dc=com"

OR

VPlexcli:/> authentication directory-service unmap -u

"uid=testuser,ou=vplex,dc=org,dc=company,dc=com"

OR

VPlexcli:/> authentication directory-service unmap -m "ou=testou,dc=org,dc=company,dc=com"

See also ◆ authentication directory-service configure

◆ authentication directory-service map
◆ authentication directory-service show

batch-migrate cancel
Cancels an active migration and returns the source volumes to their state before the
migration.

Contexts All contexts.

Syntax batch-migrate cancel

[-f|--file] pathname

Arguments Required arguments

[-f|--file] pathname - Directory and filename of migration plan file. Relative paths can be
used. If no directory is specified, the default directory is /var/log/VPlex/cli on the
management server.

Description Attempts to cancel every migration in the specified batch file. If an error is encountered, a
warning is printed to the console and the command continues until every migration has
been processed.

Note: In order to re-run a canceled migration plan, the batch-migrate remove command
must be used to remove the records of the migration.

Example VPlexcli:/data-migrations/device-migrations>
batch-migrate cancel --file migrate.txt

See also ◆ batch-migrate clean

◆ batch-migrate commit
◆ batch-migrate create-plan

batch-migrate cancel 59
VPLEX CLI Command Descriptions

◆ batch-migrate pause
◆ batch-migrate remove
◆ batch-migrate resume
◆ batch-migrate start
◆ batch-migrate summary

batch-migrate check-plan
Checks a batch migration plan.

Contexts All contexts.

Syntax batch-migrate check-plan

[-f|--file] pathname

Arguments Required arguments

[-f|--file] pathname - Directory and filename of migration plan file. Relative paths can be
used. If no directory is specified, the default directory is /var/log/VPlex/cli on the
management server.

Description Checks the following conditions:

◆ Block-size of source and target extents is equal (4 K bytes)
◆ Capacity of target extent is equal to, or larger than the source extent's capacity
◆ Device migrations:
• Target device has no volumes on it
• Source device has volumes on it
◆ Extent migrations:
• Target extent is claimed and ready for use
• Source extent is in use
All migration plans should be checked before being executed.



Migration of volumes in asynchronous consistency groups is not supported on volumes
that are in active use. Schedule this activity as a maintenance activity to avoid DU.

Example In the following example, a migration plan fails the check.

VPlexcli:/> batch-migrate check-plan --file MigDev-test.txt
Checking migration plan file /var/log/VPlex/cli/MigDev-test.txt.

Target device '/clusters/cluster-2/devices/dev1723_61C' has a volume.

Target device '/clusters/cluster-2/devices/dev1723_618' has a volume.
Plan-check failed, 2 problems.

Example In the following example, a migration plan passes the check.

60 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

VPlexcli:/> batch-migrate check-plan --file migrate.txt

Checking migration plan file /temp/migration_plans/migrate.txt.

Plan-check passed.

See also ◆ batch-migrate cancel

◆ batch-migrate clean
◆ batch-migrate commit
◆ batch-migrate create-plan
◆ batch-migrate pause
◆ batch-migrate remove
◆ batch-migrate resume
◆ batch-migrate start
◆ batch-migrate summary

batch-migrate clean
Cleans the specified batch migration and deletes the source devices.

Contexts All contexts.

Syntax batch-migrate clean

[-f|--file] pathname
[-e|--rename-targets]

Arguments Required arguments

[-f|--file] pathname - *Directory and filename of migration plan file. relative paths can be
used. if no directory is specified, the default directory is /var/log/VPlex/cli on the
management server.

Optional arguments
[-e|--rename-targets] - rename the target devices and virtual volumes to the source device
names.
* argument is positional.

Description Dismantles the source device down to its storage volumes and unclaims the storage
volumes.
◆ For device migrations, cleaning dismantles the source device down to its storage
volumes. The storage volumes no longer in use are unclaimed.
For device migrations only, use the optional --rename-targets argument to rename the
target device after the source device. If the target device is renamed, the virtual
volume on top of it is also renamed if the virtual volume has a system-assigned
default name.
Without renaming, the target devices retain their target names, which can make the
relationship between volumes and devices less evident.

batch-migrate clean 61
VPLEX CLI Command Descriptions

◆ For extent migrations, cleaning destroys the source extent and unclaims the
underlying storage-volume if there are no extents on it.



This command must be run before the batch-migration has been removed. The command
will not clean migrations that have no record in the CLI context tree.

Example In the following example, source devices are torn down to their storage volumes and the
target devices and volumes are renamed after the source device names:
VPlexcli:/> batch-migrate clean --rename-targets --file migrate.txt

Using migration plan file /temp/migration_plans/migrate.txt for

cleanup phase.

0: Deleted source extent

/clusters/cluster-1/devices/R20061115_Symm2264_010, unclaimed its
disks Symm2264_010

1: Deleted source extent

/clusters/cluster-1/extents/R20061115_Symm2264_011, unclaimed its
disks Symm2264_011
.
.
.

See also ◆ batch-migrate cancel

◆ batch-migrate check-plan
◆ batch-migrate commit
◆ batch-migrate create-plan
◆ batch-migrate pause
◆ batch-migrate remove

batch-migrate commit
Commits the specified batch migration.

Contexts All contexts.

Syntax batch-migrate commit

[-f|--file] pathname

Arguments Required argument

[-f|--file] pathname - *Directory and filename of migration plan file. relative paths can be
used. if no directory is specified, the default directory is /var/log/VPlex/cli on the
management server.

Description Attempts to commit every migration in the batch. Migrations in the batch cannot be
committed until all the migrations are complete.
If an error is encountered, a warning is displayed and the command continues until every
migration has been processed.

62 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

The batch migration process inserts a temporary RAID 1 structure above the source
devices/extents with the target devices/extents as an out-of-date leg of the RAID.
Migration can be understood as the synchronization of the out-of-date leg (the target).
After the migration is complete, the commit step detaches the source leg of the temporary
RAID and removes the RAID.
The virtual volume, device, or extent is identical to the one before the migration except
that the source device/extent is replaced with the target device/extent.
A migration must be committed in order to be cleaned.

Note: Use the batch-migrate summary command to verify that the migration has
completed with no errors before committing the migration.

Example VPlexcli:/> batch-migrate commit --file BSO_19

See also ◆ batch-migrate cancel

◆ batch-migrate check-plan
◆ batch-migrate clean
◆ batch-migrate create-plan
◆ batch-migrate remove

batch-migrate create-plan
Creates a batch migration plan file.

Contexts All contexts.

Syntax batch-migrate create-plan

[-f|--sources] local-devices
[-t|--targets] local-devices
[--file] pathname
[--force]

Arguments Required arguments

[-f|--sources] local-devices - * List of local-devices to migrate virtual volumes from. May
contain wildcards.
[-t|--targets] local-devices - * List of local-devices to migrate the source virtual volumes to.
May contain wildcards.
--file pathname - * Directory and filename of migration plan file. Relative paths can be
used. If no directory is specified, the default directory is /var/log/VPlex/cli on the
management server.

Optional arguments
--force - Forces an existing plan file with the same name to be overwritten.
* - argument is positional.

Description ◆ The source and target extents must be typed as a comma-separated list, where each
element is allowed to contain wildcards.

batch-migrate create-plan 63
VPLEX CLI Command Descriptions

◆ If this is an extent migration, the source and target cluster must be the same.
◆ If this is a device migration, the source and target clusters can be different.
◆ The source and target can be either local-devices or extents. Mixed migrations from
local-device to extent and vice versa are not allowed.
◆ The command attempts to create a valid migration plan from the source
devices/extents to the target devices/extents.
If there are source devices/extents that cannot be included in the plan, a warning is
printed to the console, but the plan is still created.
◆ Review the plan and make any necessary changes before starting the batch migration.

Example: perform a batch migration

1. Create a migration plan.
Use the batch-migrate create-plan command to create a plan to migrate the volumes
on all the devices at cluster-1 to the storage at cluster-2:
VPlexcli:/> batch-migrate create-plan migrate.txt --sources
/clusters/cluster-1/devices/* --targets
/clusters/cluster-2/devices/*

2. Use the batch-migrate check-plan command to check the plan:

VPlexcli:/> batch-migrate check-plan migrate.txt

If problems are found, correct the errors and re-run the command until the plan-check
passes.
3. Use the batch-migrate start command to start the migration:
VPlexcli:/> batch-migrate start migrate.txt

4. Wait for the migration to finish:

Use the batch-migrate summary command to monitor the status of the migration:
VPlexcli:/> batch-migrate summary migrate.txt

Processed 10 migrations from batch migration BR0:

committed: 0
complete: 10
in-progress: 0
paused: 0
error: 0
cancelled: 0
no-record: 0

5. When all the migrations are complete, use the batch-migrate commit command to
commit the migration:
VPlexcli:/> batch-migrate commit migrate.txt

The source volumes will now reside on the target devices.

6. Use batch-migrate clean command to clean the migration:
VPlexcli:/> batch-migrate clean --rename-targets --file migrate.txt

64 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

This will dismantle the source devices down to their storage volumes and rename the
target devices and volumes after the source device names.
7. Use the batch-migrate remove command to remove the record of the migration:
VPlexcli:/> batch-migrate remove migrate.txt

Example: Pause/resume batch migration

Pause and resume an in-progress batch migration:
VPlexcli:/> batch-migrate pause migrate.txt
VPlexcli:/> batch-migrate resume migrate.txt

A batch-migration can be canceled at any-time up until the point it is committed.

Cancel and restart a batch migration:
VPlexcli:/> batch-migrate cancel migrate.txt
VPlexcli:/> batch-migrate remove migrate.txt
VPlexcli:/> batch-migrate start migrate.txt

See also ◆ batch-migrate cancel

◆ batch-migrate check-plan
◆ batch-migrate clean
◆ batch-migrate commit
◆ batch-migrate pause
◆ batch-migrate remove
◆ batch-migrate resume
◆ batch-migrate start
◆ batch-migrate summary

batch-migrate pause
Pauses the specified batch migration.

Contexts All contexts.

Syntax batch-migrate pause

[--file] pathname

Arguments Required arguments

--file pathname - Directory and filename of migration plan file. Relative paths can be used.
If no directory is specified, the default directory is /var/log/VPlex/cli on the management
server.

Description Pauses every migration in the batch. If an error is encountered, a warning is displayed and
the command continues until every migration has been processed.
Active migrations (a migration that has been started) can be paused and resumed at a
later time.
Pause an active migration to release bandwidth for host I/O during periods of peak traffic.

batch-migrate pause 65
VPLEX CLI Command Descriptions

Resume the migration during periods of low I/O.

Use the batch-migrate pause --file pathname command to pause the specified active
migration.
Use the batch-migrate resume --file pathname command to resume the specified paused
migration.

Example VPlexcli:/> batch-migrate pause --file BS0_19

See also ◆ batch-migrate cancel

◆ batch-migrate check-plan
◆ batch-migrate clean
◆ batch-migrate commit
◆ batch-migrate create-plan
◆ batch-migrate remove
◆ batch-migrate resume
◆ batch-migrate start
◆ batch-migrate summary

batch-migrate remove
Removes the record of the completed batch migration.

Contexts All contexts.

Syntax batch-migrate remove

[--file] pathname

Arguments Required arguments

--file pathname - Directory and filename of migration plan file. Relative paths can be used.
If no directory is specified, the default directory is /var/log/VPlex/cli on the management
server.

Description Remove the migration record only if the migration has been committed or canceled.
Migration records are in the /data-migrations/device-migrations context.

Example VPlexcli:/data-migrations/device-migrations> batch-migrate remove

--file migrate.txt

or:
VPlexcli:>batch-migrate remove /data-migrations/device-migrations
--file migrate.txt.

See also ◆ batch-migrate cancel

◆ batch-migrate check-plan
◆ batch-migrate clean

66 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ batch-migrate commit
◆ batch-migrate create-plan
◆ batch-migrate pause
◆ batch-migrate resume
◆ batch-migrate start
◆ batch-migrate summary

batch-migrate resume
Attempts to resume every migration in the specified batch.

Contexts All contexts.

Syntax batch-migrate resume

[--file] pathname

Arguments Required arguments

--file pathname - Directory and filename of migration plan file. Relative paths can be used.
If no directory is specified, the default directory is /var/log/VPlex/cli on the management
server.

Description Resumes the given batch migration.

If an error is encountered, a warning is printed to the console and the command continues
until every migration has been processed.

Example VPlexcli:/> batch-migrate resume --file BS0_19

See also ◆ batch-migrate cancel

◆ batch-migrate check-plan
◆ batch-migrate clean
◆ batch-migrate commit
◆ batch-migrate create-plan
◆ batch-migrate pause
◆ batch-migrate remove
◆ batch-migrate start
◆ batch-migrate summary

batch-migrate start
Starts the specified batch migration.

Contexts All contexts.

batch-migrate resume 67
VPLEX CLI Command Descriptions

Syntax batch-migrate start

[--file] pathname
[-s|transfer-size] 40K - 128M
--force
--paused

Arguments Required arguments

--file pathname - * Directory and filename of migration plan file. Relative paths can be
used. If no directory is specified, the default directory is /var/log/VPlex/cli on the
management server.

Optional arguments
[-s|transfer-size] size - Maximum number of bytes to transfer as one operation per device.
Specifies the size of read sector designated for transfer in cache. Setting transfer size to a
lower value implies more host I/O outside the transfer boundaries. Setting transfer size to
a higher value may result in faster transfers. See About transfer-size below. Valid values
must be a multiple of 4 K.
Range: 40 K - 128 M.
Default: 128 K.
--force - Do not ask for confirmation when starting individual migrations. Allows this
command to be run using a non-interactive script, or to start cross-cluster device
migrations in a Geo system without prompting for every device.
--paused - Starts the migration in a paused state. The migration remains paused until
restarted using the batch-migrate resume command.
* - argument is positional.

Description Starts a migration for every source/target pair in the given migration-plan.



Inter-cluster migration of volumes is not supported on volumes that are in use. Schedule
this activity as a maintenance activity to avoid Data Unavailability.

Consider scheduling this activity during maintenance windows of low workload to reduce
impact on applications and possibility of a disruption.

If a migration fails to start, a warning is printed to the console. The command will continue
until every migration item has been processed.
Individual migrations may ask for confirmation when they start. Use the --force argument
to suppress these requests for confirmation.
Batch migrations across clusters can result in the following error:
VPlexcli:/> batch-migrate start /var/log/VPlex/cli/migrate.txt

The source device 'SveTest_tgt_r0_case2_1_0002' has a volume 'SveTest_tgt_r0_case2_1_0002_vol'

in a view. Migrating to device 'SveTest_src_r0_case2_2_0002' will create a synchronous
distributed device. In this GEO system, this can increase the per I/O latency on
'SveTest_tgt_r0_case2_1_0002_vol'. If applications using 'SveTest_tgt_r0_case2_1_0002_vol' are
sensitive to this latency, they may experience data unavailability. Do you wish to proceed ?
(Yes/No) y

68 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

WARNING: Failed to start migration /clusters/cluster-1/devices/SveTest_tgt_r0_case2_1_0002 -->

/clusters/cluster-2/devices/SveTest_src_r0_case2_2_0002 : Evaluation of <<dm migration start
-n BR0_0 -f /clusters/cluster-1/devices/SveTest_tgt_r0_case2_1_0002 -t
/clusters/cluster-2/devices/SveTest_src_r0_case2_2_0002 -s 128kB>> failed.
Failed to create a new data-migration.
Unable to attach mirror 'SveTest_src_r0_case2_2_0002' to distributed Device 'MIGRATE_BR0_0'.
Firmware command error.
Active metadata device does not have a free slot.
Started 0 of 1 migrations.

Refer to the troubleshooting section of the VPLEX procedures in the SolVe Desktop for
instructions on increasing the number of slots.

About transfer-size
Transfer-size is the size of the region in cache used to service the migration. The area is
globally locked, read at the source, and written at the target.
Transfer-size can be as small 40 K, as large as 128 M, and must be a multiple of 4 K. The
default recommended value is 128 K.
A larger transfer-size results in higher performance for the migration, but may negatively
impact front-end I/O. This is especially true for VPLEX Metro migrations.
A smaller transfer-size results in lower performance for the migration, but creates less
impact on front-end I/O and response times for hosts.
Set a large transfer-size for migrations when the priority is data protection or migration
performance.
Set a smaller transfer-size for migrations when the priority is front-end storage response
time.
Factors to consider when specifying the transfer-size:
◆ For VPLEX Metro configurations with narrow inter-cluster bandwidth, set the transfer
size lower so the migration does not impact inter-cluster I/O.
◆ The region specified by transfer-size is locked during migration. Host I/O to or from
that region is held. Set a smaller transfer-size during periods of high host I/O.
◆ When a region of data is transferred, a broadcast is sent to the system. Smaller
transfer-size mean more broadcasts, slowing the migration.

Example VPlexcli:/> batch-migrate start --file BS0_19 --transfer-size 1M

See also ◆ batch-migrate cancel

◆ batch-migrate check-plan
◆ batch-migrate clean
◆ batch-migrate commit
◆ batch-migrate create-plan
◆ batch-migrate pause
◆ batch-migrate remove
◆ batch-migrate resume
◆ batch-migrate summary

batch-migrate start 69
VPLEX CLI Command Descriptions

◆ dm migration start

batch-migrate summary
Displays a summary of the batch migration.

Contexts All contexts.

Syntax batch-migrate summary

[--file] pathname
[-v|--verbose]

Arguments Required arguments

--file pathname - Directory and filename of migration plan file. Relative paths can be used.
If no directory is specified, the default directory is /var/log/VPlex/cli on the management
server.

Optional arguments
[-v|verbose] - In addition to the specified migration, displays a summary for any
in-progress and paused migrations.

Description Displays a summary of the batch migration.

If the --verbose option is used, displays in the batch that are in an error state.

Example Display a batch migration:

VPlexcli:/> batch-migrate summary migrate.txt

Processed 10 migrations from batch migration migrate.txt:

committed: 0
complete: 10
in-progress: 0
paused: 0
error: 0
cancelled: 0
no-record: 0

Example Display a batch migration using the --verbose option:

batch-migrate summary batch-migrate2.txt --verbose

Command output:
source device source target device target migration status percentage eta
-------------------- cluster -------------------- cluster name -------- done ---
-------------------- --------- -------------------- --------- --------- -------- ---------- ---
temp1_r1_0_cluster-1 cluster-1 temp2_r1_0_cluster-2 cluster-2 BR1_0 complete 100 -
temp1_r1_1_cluster-1 cluster-1 temp2_r1_1_cluster-2 cluster-2 BR1_1 complete 100 -
temp1_r1_2_cluster-1 cluster-1 temp2_r1_2_cluster-2 cluster-2 BR1_2 complete 100 -
Processed 3 migrations from batch migration BR1:
committed: 0
complete: 3
in-progress: 0
queued: 0
paused: 0
error: 0
cancelled: 0

70 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

no-record: 0

Table 2 batch migration summary field descriptions

Field Description

--verbose output only

source device Local-device from which to migrate.

source cluster Cluster on which source local-device is located.

target device Local-device to which to migrate.

target cluster Cluster on which target local-device is located.

migration name Names of migration files in the batch migration.

status Status of the individual migration. See below for possible values.

eta For migrations currently being processed, the estimated time to completion.

--verbose and non --verbose output

Processed n Of the number of source-target pairs specified in the batch migration plan, the
migrations... number that have been processed.

committed Of the number of source-target pairs that have been processed, the number
that have been committed.

completed Of the number of source-target pairs that have been processed, the number
that are complete.

in-progress Of the number of source-target pairs that have been processed, the number
that are in progress.

paused Of the number of source-target pairs that have been processed, the number
that are paused.

error Jobs that encountered errors during processing.

cancelled Of the number of source-target pairs that have been processed, the number
that have been cancelled.

no-record Of the number of source-target pairs that have been processed, the number
that have no record in the context tree.

Note: If more than 25 migrations are active at the same time, they are queued, their status
is displayed as in-progress, and percentage-complete is displayed as ?.

See also ◆ batch-migrate cancel

◆ batch-migrate check-plan
◆ batch-migrate clean
◆ batch-migrate commit
◆ batch-migrate create-plan
◆ batch-migrate pause
◆ batch-migrate remove
◆ batch-migrate resume

batch-migrate summary 71
VPLEX CLI Command Descriptions

◆ batch-migrate start

battery-conditioning disable
Disables battery conditioning on the specified backup battery units.

Contexts All contexts.

Syntax battery-conditioning disable

[-s|--sps-unit] context-path,context path,...
[-c|--all-at-cluster] cluster
[-t|--bbu-type] bbu-type
[-f|--force]

Arguments Optional arguments

[-s|--sps-unit] context path,context path...- * Standby power supplies (SPS) units on which
to disable battery conditioning. If this argument is used:
• The --all-at-cluster argument must not be specified
• The --bbu-type argument is ignored.
[-c|--all-at-cluster] cluster - * The cluster on which to disable battery conditioning on all
backup battery units. If this argument is used:
• The --bbu-type argument is required
• The --sps-units argument must not be specified.
[-t|--bbu-type] bbu-type - Type of battery unit on which to disable conditioning. For the
current release, only standby-power-supply (SPS) units are supported. This argument is
ignored if the --sps-unit argument is specified.
[-f|--force] - Skips the user confirmation that appears when the battery unit on which
conditioning is being disabled is currently undergoing conditioning. Allows the command
to be executed from an non-interactive script.
* - argument is positional.

Description Automatic battery conditioning of every SPS is enabled by default. Use this command to
disable battery conditioning for all SPS units in a cluster, or a specified SPS unit.
Disabling conditioning on a unit that has a cycle in progress causes that cycle to abort,
and user confirmation is required. Use the --force argument to skip the user confirmation.
Automatic battery conditioning must be disabled during:
◆ Scheduled maintenance
◆ System upgrades
◆ Unexpected and expected power outages



For all procedures that require fully operational SPS, ensure that SPS conditioning is
disabled at least 6 hours in advance of the procedure. This prevents the SPS from
undergoing battery conditioning during the procedure.

72 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

If the procedure starts when no SPS conditioning is scheduled, it is acceptable to disable

SPS conditioning less than six hours in advance.

Use the battery-conditioning set-schedule command to select the day the automatic
monthly conditioning cycle starts.
Use the battery-conditioning manual-cycle request command to run an additional
conditioning cycle on one or more backup battery units.

Example Disable battery conditioning for all SPS units on cluster-1:

VPlexcli:/> battery-conditioning disable --all-at-cluster /clusters/cluster-1 -t sps
Battery conditioning disabled on backup battery units 'stand-by-power-supply-b,
stand-by-power-supply-a'.

Example Disable battery conditioning for a specified SPS unit and display the change:
VPlexcli:/> battery-conditioning disable -s
/engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-a
Battery conditioning disabled on backup battery units 'stand-by-power-supply-a'.

VPlexcli:/> ll
/engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-a/conditioning/
/engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-a/conditioning:
Name Value
--------------------- ----------------------------
enabled false
in-progress false
manual-cycle-requested false
next-cycle Mon Dec 05 17:00:00 MST 2011
previous-cycle Fri Nov 25 13:25:00 MST 2011
previous-cycle-result PASS

Example Disable battery conditioning on a specified SPS that is currently undergoing battery
conditioning:
VPlexcli:/> battery-conditioning disable -s
/engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-a
The backup battery unit 'stand-by-power-supply-a' is currently undergoing a conditioning cycle.
Disabling conditioning will abort the cycle and cannot be undone.
Do you wish to disable conditioning on this unit anyway? (Yes/No) y
Battery conditioning disabled on backup battery units 'stand-by-power-supply-a'.

See also ◆ battery-conditioning enable

◆ battery-conditioning manual-cycle cancel-request
◆ battery-conditioning manual-cycle request
◆ battery-conditioning set-schedule
◆ battery-conditioning summary

battery-conditioning enable
Enables conditioning on the specified backup battery units.

Contexts All contexts.

battery-conditioning enable 73
VPLEX CLI Command Descriptions

Syntax battery-conditioning enable

[-s|--sps-unit] context-path,context path,...
[-c|--all-at-cluster] cluster
[-t|--bbu-type] bbu-type

Arguments Optional arguments

[-s|--sps-unit] context path,context path...- * Standby power supplies (SPS) units on which
to enable battery conditioning. If this argument is used:
• The --all-at-cluster argument must not be specified
• The --bbu-type argument is ignored.
[-c|--all-at-cluster] cluster - * The cluster on which to enable battery conditioning on all
backup battery units. If this argument is used:
• The --bbu-type argument is required
• The --sps-units argument must not be specified.
[-t|--bbu-type] bbu-type - Type of battery unit on which to enable conditioning. For the
current release, only standby-power-supply (SPS) units are supported. This argument is
ignored if the --sps-unit argument is specified.
* - argument is positional.

Description Use this command to enable battery conditioning for all standby power supply (SPS) units
in a cluster, or for a specific SPS unit.
SPS battery conditioning assures that the battery in an engine’s standby power supply can
provide the power required to support a cache vault. A conditioning cycle consists of a 5
minute period of on-battery operation and a 6 hour period for the battery to recharge.
Automatic conditioning runs every 4 weeks, one standby power supply at a time.
Automatic battery conditioning of every SPS is enabled by default.
Automatic battery conditioning must be disabled during:
◆ Scheduled maintenance
◆ System upgrades
◆ Unexpected and expected power outages
Use this command to re-enable battery conditioning after activities that require battery
conditioning to be disabled are completed.

Example Enable battery conditioning on a specified SPS and display the change:
VPlexcli:/> battery-conditioning enable -s
/engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-a
Battery conditioning enabled on backup battery units 'stand-by-power-supply-a'.

VPlexcli:/> ll
/engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-a/conditioning/
/engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-a/conditioning:
Name Value
--------------------- ----------------------------
enabled true
in-progress false
manual-cycle-requested false
next-cycle Mon Dec 05 17:00:00 MST 2011
previous-cycle Fri Nov 25 13:25:00 MST 2011

74 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

previous-cycle-result PASS

Example Enable battery conditioning on all SPS units in cluster-1 and display the change:
VPlexcli:/> battery-conditioning enable --all-at-cluster cluster-1 -t sps
Battery conditioning enabled on backup battery units 'stand-by-power-supply-a,
stand-by-power-supply-b'.
VPlexcli:/> ll /engines/*/stand-by-power-supplies/*/conditioning

/engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-a/conditioning:
Name Value
---------------------- ----------------------------
enabled true
in-progress false
manual-cycle-requested false
next-cycle Tue Jan 03 17:00:00 MST 2012
previous-cycle Fri Dec 16 21:31:00 MST 2011
previous-cycle-result PASS

/engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-b/conditioning:
Name Value
---------------------- ----------------------------
enabled true
in-progress false
manual-cycle-requested false
next-cycle Wed Jan 04 05:00:00 MST 2012
previous-cycle Sat Dec 17 15:37:20 MST 2011
previous-cycle-result PASS

See also ◆ battery-conditioning disable

◆ battery-conditioning manual-cycle cancel-request
◆ battery-conditioning manual-cycle request
◆ battery-conditioning set-schedule
◆ battery-conditioning summary

battery-conditioning manual-cycle cancel-request

Cancels a manually requested battery conditioning cycle on the specified backup battery
unit.

Contexts All contexts.

Syntax battery-conditioning manual-cycle cancel-request

[-s|--sps-unit] context path

Arguments Required arguments

[-s|--sps-unit] - Standby power supply (SPS) unit on which to cancel a previously requested
battery conditioning. The full context path is required when this command is run from the
engines context or higher.

Description Cancels a manually requested conditioning cycle on the specified backup battery unit.
Automatic battery conditioning cycles run on every SPS every 4 weeks.
Manually requested battery conditioning cycles are in addition to the automatic cycles.

battery-conditioning manual-cycle cancel-request 75

VPLEX CLI Command Descriptions

Use this command to cancel a manual battery conditioning cycle.

IMPORTANT
This command does not abort a battery conditioning cycle that is underway. It cancels only
a request for a manual cycle.

Example Cancel a manually-scheduled SPS battery conditioning from the root context, and display
the change:
VPlexcli:/> battery-conditioning manual-cycle cancel-request -s
/engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-a
The manual conditioning cycle on 'stand-by-power-supply-a' has been canceled. The next
conditioning cycle will be performed on Sat Dec 31 17:00:00 MST 2011

VPlexcli:/> ll
/engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-a/conditioning

/engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-a/conditioning:
Name Value
---------------------- ----------------------------
enabled true
in-progress false
manual-cycle-requested false
next-cycle Sat Dec 31 17:00:00 MST 2011
previous-cycle Fri Dec 16 21:31:00 MST 2011
previous-cycle-result PASS

Example Cancel a manually-scheduled SPS battery conditioning from the engine context:
VPlexcli:/engines/engine-1-1> battery-conditioning manual-cycle cancel-request -s
stand-by-power-supply-a
The manual conditioning cycle on 'stand-by-power-supply-a' has been canceled. The next
conditioning cycle will be performed on Sat Dec 31 17:00:00 MST 2011

See also ◆ battery-conditioning disable

◆ battery-conditioning enable
◆ battery-conditioning manual-cycle request
◆ battery-conditioning set-schedule
◆ battery-conditioning summary

battery-conditioning manual-cycle request

Manually request a battery conditioning cycle on the specified backup battery unit.

Contexts All contexts.

Syntax battery-conditioning manual-cycle request

[-s|--sps-unit] context path
[-f|--force]

Arguments Required arguments

[-s|--sps-unit] - * Standby power supply (SPS) units on which to request the battery
conditioning cycle. The full context path is required when this command is run from the
engines context or higher.

76 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Optional arguments
[-f|--force] - Forces the requested battery conditioning cycle to be scheduled without
confirmation if the unit is currently in a conditioning cycle. Allows this command to be run
from non-interactive scripts.
* - argument is positional.

Description Requests a conditioning cycle on the specified backup battery unit, and displays the time
the cycle is scheduled to start. The requested battery conditioning cycle is scheduled at
the soonest available time slot for the specified unit.
If the specified unit is currently undergoing a conditioning cycle, this command requests
an additional cycle to run at the next available time slot.
If battery conditioning is disabled, the manually requested cycle will not run.
Use this command to manually schedule a battery conditioning cycle when automatic
conditioning has been disabled in order to perform maintenance, upgrade the system, or
shut down power.
The conditioning cycle invoked by this command will run in the next 6-hour window
available for the selected unit.

Note: Scheduling a manual conditioning cycle is while a conditioning cycle is already in

progress contributes to shortened battery life and is not recommended.

Example Schedule a manual SPS battery conditioning cycle from the root context and display the
change:
VPlexcli:/> battery-conditioning manual-cycle request -s
/engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-a
A manual conditioning cycle will be performed on 'stand-by-power-supply-a' on Tue Dec 20
23:00:00 MST 2011.

VPlexcli:/>
ll /engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-a/conditioning

/engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-a/conditioning:
Name Value
---------------------- ----------------------------
enabled true
in-progress false
manual-cycle-requested true
next-cycle Tue Dec 20 23:00:00 MST 2011
previous-cycle Fri Dec 16 21:31:00 MST 2011
previous-cycle-result PASS

Example Schedule a manual SPS battery conditioning from the engines/engine context when a
conditioning cycle is already underway:
VPlexcli:/engines/engine-1-1/> battery-conditioning manual-cycle request
stand-by-power-supply-a/
The backup battery unit 'stand-by-power-supply-a' is currently undergoing a conditioning cycle.
Scheduling a manual cycle now is unnecessary and discouraged as it will contribute to
over-conditioning and a shortened battery life.
Do you wish to manually schedule a conditioning cycle on this unit anyway? (Yes/No) y
A manual conditioning cycle will be performed on 'stand-by-power-supply-a' on Fri Nov 25
13:25:00 MST 2011.

See also ◆ battery-conditioning disable

battery-conditioning manual-cycle request 77

VPLEX CLI Command Descriptions

◆ battery-conditioning enable
◆ battery-conditioning manual-cycle cancel-request
◆ battery-conditioning set-schedule
◆ battery-conditioning summary

battery-conditioning set-schedule
Set the battery conditioning schedule (day of week) for backup battery units on a cluster.

Contexts All contexts.

Syntax battery-conditioning set-schedule

[-t|--bbu-type] bbu-type
[-d|--day-of-week] [sunday|monday|...|saturday]
[-c|--cluster] cluster

Arguments Required arguments

[-t|--bbu-type] bbu-type - * Type of battery backup unit to be conditioned.

Note: In the current release, the only bbu-type supported is sps.

[-d|-- day-of-week] - * Day of the week on which to run the battery conditioning. Valid
values are: sunday, monday, tuesday, wednesday, etc.
[-c|--cluster] - * Cluster on which to set the battery conditioning schedule.
* - argument is positional.

Description Sets the day of week when the battery conditioning cycle is started on all backup battery
units (BBU) on a cluster.
The time of day the conditioning cycle runs on an individual backup battery unit is
scheduled by VPLEX.
SPS battery conditioning assures that the battery in an engine’s standby power supply can
provide the power required to support a cache vault. A conditioning cycle consists of a 5
minute period of on-battery operation and a 6 hour period for the battery to recharge.
Automatic conditioning runs every 4 weeks, one standby power supply at a time.
Automatic battery conditioning of every SPS is enabled by default.
Use this command to set the day of the week on which the battery conditioning cycle for
each SPS unit (one at a time) begins.

Example Set the start day of the battery conditioning cycle for all SPS units in cluster-1 to Saturday
and display the change:
VPlexcli:/> battery-conditioning set-schedule -t sps -d saturday -c cluster-1
Battery conditioning schedule for sps units on cluster 'cluster-1' successfully set to
'saturday'.

VPlexcli:/> ll /engines/*/stand-by-power-supplies/*/conditioning/

/engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-a/conditioning:
Name Value
---------------------- ----------------------------

78 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

enabled true
in-progress false
manual-cycle-requested false
next-cycle Fri Feb 03 17:00:00 MST 2012
previous-cycle Fri Dec 16 21:31:00 MST 2011
previous-cycle-result PASS

/engines/engine-1-1/stand-by-power-supplies/stand-by-power-supply-b/conditioning:
Name Value
---------------------- ----------------------------
enabled true
in-progress false
manual-cycle-requested false
next-cycle Sat Feb 04 05:00:00 MST 2012
previous-cycle Sat Dec 17 15:37:20 MST 2011
previous-cycle-result PASS

Table 3 battery conditioning field descriptions

Field Description

enabled Whether battery conditioning is enabled on the backup battery unit.

in-progress Whether a battery conditioning cycle (either manually requested or automatic) is

currently underway on the backup battery unit.

manual-cycle-requested Whether a manually requested battery conditioning cycle is scheduled on the backup
battery unit.

next-cycle The date and time of the next battery conditioning cycle (either manually requested
or automatic) on the backup battery unit.

Note: If the engines have a different time zone setting than the management server,
and the date and time selected for the start of battery conditioning is within the
difference between the two time zones, the day selected by the --day-of-week
argument may not be the same day displayed in this field.

previous-cycle The date and time of the previous battery conditioning cycle (either manually
requested or automatic) on the backup battery unit. See Note in the “next cycle” field
above.

previous-cycle-result ABORTED - The previous battery conditioning cycle was stopped while it was
underway.
PASS - The previous battery conditioning cycle was successful.
SKIPPED - The previous cycle was not performed because battery conditioning was
disabled.
UNKNOWN - The time of the previous battery conditioning cycle cannot be
determined or no cycle has ever run on the backup battery unit.

See also ◆ battery-conditioning disable

◆ battery-conditioning enable
◆ battery-conditioning manual-cycle cancel-request
◆ battery-conditioning manual-cycle request
◆ battery-conditioning summary

battery-conditioning set-schedule 79
VPLEX CLI Command Descriptions

battery-conditioning summary
Displays a summary of the battery conditioning schedule for all devices, grouped by type
and cluster

Contexts All contexts.

Syntax battery-conditioning summary

Description Displays a summary of the conditioning schedule for all devices, grouped by type and
cluster.

Example Display battery conditioning schedule for all devices:

VPlexcli:/> battery-conditioning summary
Standby Power Supply Units

Table 4 battery conditioning summary field descriptions (page 1 of 2)

Field Description

Enabled Whether battery conditioning is enabled on the backup battery unit.

In-Progress Whether a battery conditioning cycle (either manually requested or automatic) is

currently underway on the backup battery unit.

Manual Cycle Whether a manually requested battery conditioning cycle is scheduled on the backup
Requested battery unit.

Next Cycle The date and time of the next battery conditioning cycle (either manually requested
or automatic) on the backup battery unit.

Note: If the engines have a different time zone setting than the management server,
and the date and time selected for the start of battery conditioning is within the
difference between the two time zones, the day selected by the --day-of-week
argument may not be the same day displayed in this field.

Owner VPLEX engine associated with the specified battery.

Previous Cycle The date and time of the previous battery conditioning cycle (either manually
requested or automatic) on the backup battery unit. See Note in Next Cycle.

80 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Table 4 battery conditioning summary field descriptions (page 2 of 2)

Field Description

Previous Cycle Result ABORTED - The previous battery conditioning cycle was stopped while it was
underway.
PASS - The previous battery conditioning cycle was successful.
SKIPPED - The previous cycle was not performed because battery conditioning was
disabled.
UNKNOWN - The time of the previous battery conditioning cycle cannot be
determined or no cycle has ever run on the backup battery unit.

Schedule Day of the week on which day of week when the battery conditioning cycle is started
on all backup battery units on a cluster. Configured using the battery-conditioning
set-schedule command.

Unit ID of the power supply where the specified battery is installed.

See also ◆ battery-conditioning disable

◆ battery-conditioning enable
◆ battery-conditioning manual-cycle cancel-request
◆ battery-conditioning manual-cycle request
◆ battery-conditioning set-schedule

cache-invalidate
In the virtual-volume context, invalidates the cache of a virtual-volume on all directors
based on its visibility to the clusters. In the consistency-group context, invalidates the
cache of all exported virtual-volumes in the specified consistency-group, on all directors
based on the virtual volume’s visibility to the clusters. Additionally, flushes the dirty data,
if any, on to the back-end storage volumes for virtual-volumes in asynchronous mode.

Contexts virtual-volume
consistency-group

Syntax In virtual-volume context:

virtual-volume cache-invalidate
[-v|--virtual-volume] virtual-volume
[--force]
[--verbose]

In consistency-group context:
consistency-group cache-invalidate
[-g|--consistency-group ] consistency-group context path
[--force]
[--verbose]

Arguments Required arguments

[-v|--virtual-volume] virtual-volume - * Invalidates the cache only for the specified virtual
volume. On asynchronous virtual volumes, flushes dirty data, if any. Wildcard patterns (CLI
glob patterns) are NOT allowed.

cache-invalidate 81
VPLEX CLI Command Descriptions

[-g|--consistency-group] consistency-group context path - * Invalidates the cache for all

exported virtual volumes in the consistency-group. On asynchronous virtual volumes in
the consistency group, flushes dirty data, if any. Wildcard patterns (CLI glob patterns) are
NOT allowed.

Optional arguments
[--force] - The --force option suppresses the warning message and executes the
cache-invalidate directly.
[--verbose] - The --verbose option provides more detailed messages in the command
output when specified.
* - argument is positional.

IMPORTANT
This command does suspend I/O on the virtual volume while invalidation is in progress.
Usage of this command causes data unavailability on the virtual volume for a short time in
a normal operating setup.

Description: All cached data associated with the selected volume is invalidated on all directors of the
VPLEX cluster. Subsequent reads from host application will fetch data from storage
volume due to cache miss.
Cache can be invalidated only for exported virtual volumes. There is no cache on
non-exported volumes.
When executed for a given virtual volume, based on the visibility of the virtual volume, this
command invalidates the cache for that virtual volume on the directors at cluster(s) that
export them to hosts.

IMPORTANT
The CLI must be connected to all directors in order for the cache to be flushed and
invalidated. The command performs a pre-check to verify all directors are reachable.

When executed for a given consistency-group, based on the visibility of each of the virtual
volumes in the consistency-group, this command invalidates the cache for the virtual
volume(s) part of the consistency-group on the directors at cluster(s) that export them to
hosts.
The command performs pre-checks to verify all expected directors in each cluster are
connected and in healthy state before issuing the command.
If I/O is in progress on the virtual-volume, the command issues an error requesting the
user to stop all host applications accessing the virtual-volume first.
The command issues a warning stating that the cache invalidate could cause a data
unavailability on the volume that it is issued on.
Any cached data at the host or host applications will not be cleared by this command.
Do not execute the cache-invalidate command on a Recover Point enabled virtual-volume.
The VPLEX clusters should not be undergoing an NDU while this command is being
executed.

82 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

There should be no mirror rebuilds or migrations in progress on the virtual volume on

which the command is executed.
There should be no volume expansion in progress on the virtual volume that the command
is being executed.
The applications accessing data on the virtual volume should be stopped. The application
or the host operating system should not have any access to the VPLEX virtual volume.
If the cache-invalidate needs to be executed on an Asynchronous consistency-group,
ensure that the Asynchronous consistency-group has the Operational-status set to
summary:: ok.
There are four categories of cache-invalidate results tracked and reported back by the
command:
◆ If the command completes successfully, the result output will state that the operation
was successful. The cache-invalidate-status command will not track or report any
result for this operation, as the command completed successfully.
◆ If the command cannot be run because the volume is not exported from any directors.
If any of the configured directors are not exporting the virtual volume, then an
informational message is displayed and the command output ends.
◆ If the command failed on a director. The result displays an error indicating that the
command failed on a specific director.
◆ If the command execution exceeds five minutes and there are no directors with a
failed response, a check is made on directors that have the operation running in
background. The result displays an error that shows the directors with the operation
still running, and an instruction to execute the cache-invalidate-status command to
view progress.

Note: Results from the virtual-volume cache-invalidate and consistency-group

cache-invalidate commands will be basically the same with different target types.
Different messages will be returned for the default brief mode messages and for verbose
mode messages when the --verbose option is specified.

Example Example output when cache-invalidation for the virtual-volume and consistency-group is
successful.
Brief message:
Cache invalidation successful for virtual-volume 'testvol_1'.

Cache invalidation successful for consistency-group 'test_cg_1'.

Verbose message:
Cache invalidation was successful.

Cache Invalidation Summary Volume Names

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

invalidate completed testvol_1

testvol_2

not registered with cache testvol_3 consistency-group 'test_cg_1'.

cache-invalidate 83
VPLEX CLI Command Descriptions

Example Example output when cache-invalidation failed for the virtual-volume and for the
consistency-group.
Brief message:
Cache invalidation failed for consistency-group 'test_cg_1'.

Cache invalidation failed for virtual-volume 'test_volume_1'.

Verbose message:
Cache invalidation failed.

Cache Invalidation Summary Director Names

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

I/O error director-1-1-A

director-1-1-B
director-2-1-A

invalidate completed director-2-1-B

Example Example output when any director(s) cannot be reached. The message includes an
instruction to re-issue the command.

Note: The cache-invalidate command must be completed for every director where the
virtual-volume or consistency-group is potentially registered in cache.

Virtual-volume:
Cache invalidation for virtual-volume 'testvol_1' could not be performed on directors
'director1-1-A, director-1-1-B'.

Please make sure all configured directors are connected and healthy and re-issue the command.

Consistency group:
Cache invalidation for consistency-group 'test_cg_1' could not be performed on directors
'director1-1-A, director-1-2-A'.

Please make sure all configured directors are connected and healthy and re-issue the command.

Example Example output returned when a cache-invalidate command for a virtual-volume or

consistency-group has timed out after five minutes.
Virtual volume:
Cache invalidation for virtual-volume 'test_volume_1' is not complete on the following
directors: director-1-1-A. Please use the 'virtual-volume cache-invalidate-status
test_volume_1' command to find out the current state of cache invalidation.

Consistency group:

84 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Cache invalidation for consistency-group 'test_cg_1' is not complete on the following directors:
director-1-1-A. Please use the 'consistency-group cache-invalidate-status test_cg_1' command
to find out the current state of cache invalidation.

See also ◆ cache-invalidate-status

◆ virtual-volume destroy
◆ virtual-volume provision

cache-invalidate-status
Displays the current status of a cache-invalidate operation on a virtual-volume, or for a
specified consistency group.

Contexts virtual-volume
consistency-group

Syntax In virtual-volume context:

cache-invalidate-status
[-v|--virtual-volume] virtual-volume
[-h|--help]
[--verbose]

In consistency-group context:
cache-invalidate-status
[-g|--consistency-group] consistency-group context path
[-h|--help]
[--verbose]

Arguments Required arguments

[-v | --virtual-volume] virtual-volume - * Specifies the virtual volume cache invalidation
status to display.
[-g| --consistency-group] consistency-group context path - * Specifies the consistency
group cache invalidation status to display.

Optional arguments
[-h | --help] - Displays the usage for this command.
[--verbose] - Provides a detailed summary of results for all directors when specified. If not
specified, only the default brief summary message is displayed.
* - argument is positional.

Description This command is executed only when the virtual volume cache-invalidate command or the
consistency group cache-invalidate command has exceeded the timeout period of five
minutes. If this command is executed for a reason other than timeout, the command will
return “no result.”
The cache-invalidate status command displays the current status for operations that are
successful, have failed, or are still in progress.

cache-invalidate-status 85
VPLEX CLI Command Descriptions

If the --verbose option is not specified, this command generates a brief message
summarizing the current status of the cache-invalidation for the virtual volume or
consistency group, whichever context has been specified. In the event of
cache-invalidation failure, the brief mode output will only summarize the first director to
fail, for if one director fails, the entire operation is considered to have failed.
If the --verbose option is specified, then the cache invalidate status is displayed on each
of the directors on which the cache invalidate is pending.
There are three fields of particular interest

Field Description

status indicates the status of the cache-invalidate.

in-progress cache-invalidate is running.

completed cache-invalidate is finished.
error cache-invalidate is in error state.
unknown Unable to retrieve the information. This could be because the director
is not reachable. The reason will be reflected in the cause field.
- Nothing is there to report.

result Indicates the result of the cache-invalidate.

successful - Cache-invalidate finished successfully.

failure Cache-invalidate finished with failure. The reason for the failure is
reflected in the cause field.
error - Cache-invalidate is in an error state.
- Nothing to report.

cause Displays the information for the failure of a job command.

text An error message explaining the reason for failure.

This command is read-only. It does not make any changes to storage in VPLEX or to VPLEX
in any way. It is only for providing information on the current status of cache-invalidation
operations.

Example Example output when the cache-invalidate operation finished with success.
Brief message:
Cache invalidation for consistency-group 'test_cg_1' is complete.

Verbose message:
VPlexcli:/> virtual-volume cache-invalidate-status vv1

cache-invalidate-status
-----------------------
director-1-1-A status: completed
result: successful
cause: -
director-2-1-B status: completed
result: successful
cause: -

VPlexcli:/> consistency-group cache-invalidate-status test_cg_1

cache-invalidate-status

86 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

-----------------------
director-1-1-A status: completed
result: successful
cause: -

director-1-1-B status: completed

result: successful
cause: -

Example Example output when the cache-invalidate operation finished with failure.
Brief message:
Cache invalidation for virtual-volume 'vv1' failed on director 'director-1-1-A' because: Volume
is in suspended state.

Cache invalidation for consistency-group 'test_cg_1' failed on director 'director-1-1-A'

because: I/O error.

Verbose message:
VPlexcli:/> virtual-volume cache-invalidate-status vv1
cache-invalidate-status
-----------------------
director-1-1-A status: completed
result: failure
cause: Volume is in suspended state

VPlexcli:/> consistency-group cache-invalidate-status test_cg_1

cache-invalidate-status
-----------------------
director-1-1-A status: completed
result: failed
cause: I/O error

director-1-1-B status: completed

result: failed
cause: I/O error

Example Example output when the cache-invalidate operation is still in progress.

Brief message:
Cache invalidation for virtual-volume 'vv1' is still in-progress.

Cache invalidation for consistency-group 'test_cg_1' is still in-progress.

Verbose message:
cache-invalidate-status
-----------------------
director-1-1-A status: in-progress
result: -
cause: -

director-1-1-B status: in-progress

result: -
cause: -

See also ◆ cache-invalidate

cache-invalidate-status 87
VPLEX CLI Command Descriptions

capture begin
Begins a capture session.

Contexts All contexts.

Syntax capture begin

[-s|session] session name
[-c|capture-directory] capture-directory

Arguments Required arguments

[-s|--session] session name - * Name of capture session. Output files from the capture
session are named using this value.
[-c|--capture-directory] directory - * Pathname for the capture directory.
Default capture directory: /var/log/VPlex/cli/capture
* - argument is positional.

Description The session captures saves all the stdin, stdout, stderr, and session I/O streams to 4 files:
◆ session name-session.txt - Output of commands issued during the capture session.
◆ session name-stdin.txt - CLI commands input during the capture session.
◆ session name-stdout.txt - Output of commands issued during the capture session.
◆ session name-stderr.txt - Status messages generated during the capture session.

Note: Raw tty escape sequences are not captured. Use the --capture shell option to
capture the entire session including the raw tty sequences.

Capture sessions can have nested capture sessions but only the capture session at the
top of the stack is active.
Use the capture end command to end the capture session.
Use the capture replay command to resubmit the captured input to the shell.

Example In the following example, the capture begin command starts a capture session named
TestCapture. Because no directory is specified, output files are placed in the
/var/log/VPlex/cli/capture directory on the management server.
VPlexcli:/> capture begin TestCapture
# capture begin TestCapture

VPlexcli:/>

See also ◆ capture end

◆ capture pause
◆ capture replay
◆ capture resume

88 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

capture end
Ends the current capture session and removes it from the session capture stack.

Contexts All contexts.

Syntax capture end

Description The session at the top of the stack becomes the active capture session.

Example VPlexcli:/clusters/cluster-1> capture end

# capture end TestCapture

VPlexcli:/clusters/cluster-1>

See also ◆ capture begin

◆ capture pause
◆ capture replay
◆ capture resume

capture pause
Pauses the current capture session.

Contexts All contexts.

Syntax capture pause

Description Pause/resume operates only on the current capture session.

Example VPlexcli:/> capture pause

See also ◆ capture begin

◆ capture end
◆ capture replay
◆ capture resume

capture replay
Replays a previously captured session.

Contexts All contexts.

Syntax capture replay

[-s|-session] session name
[-c|--capture-directory] directory

Arguments Required arguments

[-s|--session] session name - * Name of existing capture session.
[-c|-- capture-directory] directory - * Directory where existing captured session is located.

capture end 89
VPLEX CLI Command Descriptions

Default directory: /var/log/VPlex/cli/capture/recapture

* - argument is positional.

Description Replays the commands in the stdin.txt file from the specified capture session.
Output of the replayed capture session is written to the
/var/log/VPlex/cli/capture/recapture directory on the management server.
Output is the same four files created by capture begin.

Example VPlexcli:/> capture replay TestCapture

Attributes:
Name Value
---------------------- --------------------------------------------
allow-auto-join true
auto-expel-count 0
auto-expel-period 0
.
.
.

See also ◆ capture begin

◆ capture end
◆ capture pause
◆ capture resume

capture resume
Resumes the current capture session.

Contexts All contexts.

Syntax capture resume

Description Pause/resume operates only on the current capture session.

Example VPlexcli:/> capture resume

See also ◆ capture begin

◆ capture end
◆ capture pause
◆ capture replay

cd
Changes the working directory.

Contexts All contexts.

Arguments Optional arguments

cd <ENTER> - Change to the root directory.

90 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

cd ... - Change to the root directory.

cd .. - Change to the context immediately above the current context.
cd context - Change to the specified context.

Description Use the cd command with no arguments or followed by three periods (cd... ) to return to
the root context.
Use the cd command followed by two periods (cd..) to return to the context immediately
above the current context.
Use the cd command followed by a dash (cd -) to return to the previous context.
To navigate directly to a context from any other context, use the cd command and specify
the context path.
cd -c - and cd --context - are not supported.

Example Return to the root context:

VPlexcli:/engines/engine-1-1/fans> cd

VPlexcli:/>

Return to the context immediately above the current context:

VPlexcli:/monitoring/directors/director-1-1-B> cd ..

VPlexcli:/monitoring/directors>

Navigate directly to a context from any other context:

VPlexcli:/engines/engine-2-1/fans> cd /engines/engine-1-1/fans/

chart create
Creates a chart based on a CSV file produced by the report command.

Contexts All contexts.

Syntax chart create

[--input] “input file”
[--output] “output file”
[--series] series column
[--range] series range
[--domain] domain column
[--width] chart width
[--height] chart height
[--aggregate] aggregate-series-name

Arguments Required arguments

Note: All arguments are positional.

--input input file - CSV file to read data from, enclosed in quotes.
--output output file - PNG file to save chart to, enclosed in quotes.
--series column - The column in the CSV file to use as series.

chart create 91
VPLEX CLI Command Descriptions

--range column - The column in the CSV file to use as range.

--domain column - The column in the CSV file to use as domain.
--width nn - The width of chart graphic.
Range: 64-2048.
Default: 500.
--height nn - The height of the chart graphic.
Range: 64-2048.
Default: 500.
--aggregate aggregate-series-name - Name of aggregate series. If not specified, no
aggregate series is displayed.

Example In the following example:

◆ The exit command exits the CLI and returns to the management server.
◆ The cd command navigates to the reports directory.
◆ The tail command displays the .csv file created using the report capacity clusters
command.
◆ The vplexcli and login commands return to the CLI.
◆ The chart create command creates a chart.
◆ The exit command exits the CLI and returns to the management server.
◆ The cd command navigates to the reports directory.
◆ The ls command verifies that the .png file was created.
VPlexcli:/> exit
Connection closed by foreign host.
service@ManagementServer:~> cd /var/log/VPlex/cli/reports
service@ManagementServer:/var/log/VPlex/cli/reports> tail CapacityClusters.csv
Time, Cluster, Unclaimed disk capacity (GiB), Unclaimed storage_volumes, Claimed disk
capacity(GiB), Claimed storage_ volumes, Used storage-volume capacity
(GiB), Used storage_volumes, Unexported volume capacity (GiB), Unexported volum
es, Exported volume capacity (GiB), Exported volumes
2010-06-21 15:59:39, cluster-1, 5705.13, 341, 7947.68, 492, 360.04, 15, 3.00, 3, 2201.47, 27
.
.
.
service@ManagementServer:~> vplexcli
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.

Enter User Name: service

Password: :
creating logfile:/var/log/VPlex/cli/session.log_service_localhost_ T28921_20101020175912

VPlexcli:> chart create "CapacityClusters.csv" "CapacityClusters.png" 1 2 0 500 500

VPlexcli:/> exit
Connection closed by foreign host.
service@ManagementServer:~> cd /var/log/VPlex/cli/reports
service@ManagementServer:/var/log/VPlex/cli/reports> ll
total 48

92 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

.
.
.
-rw-r--r-- 1 service users 844 2010-07-19 15:55 CapacityClusters.csv
-rw-r--r-- 1 service users 18825 2010-07-19 15:56 CapacityClusters.png
.
.
.

See also ◆ report aggregate-monitors

◆ report capacity-arrays
◆ report capacity-clusters
◆ report capacity-hosts
◆ report create-monitors

cluster add
Adds a cluster to a running VPLEX.

Contexts All contexts.

Syntax cluster add

[-c|--cluster] context path
[-t|--to] cluster
[-f|--force]

Arguments Required arguments

[-c|--cluster] context path - * Cluster to add.
[-t|--to] cluster cluster - * Cluster to which the given cluster will be added. This is only
necessary if the system cannot be automatically determined.

Optional arguments
[-f|--force] - Forces the cluster addition to proceed even if conditions are not optimal.
* - argument is positional.

Description A cluster must be added in order to communicate with other clusters in a VPLEX.
Use the --to argument:
◆ During system bring-up when no clusters have yet been told about other clusters. In
this scenario, any cluster can be used as the system representative.
◆ Multiple systems have been detected. Connection to multiple systems, is not
supported.
If there only one system actually present, but it has split into islands due to
connectivity problems, it is highly advisable to repair the problems before proceeding.
Add the given cluster to each island separately.
If the intention is to merge two existing systems, break up one of the systems and add
it to the other system cluster-by-cluster.

Example In the following example:

cluster add 93
VPLEX CLI Command Descriptions

◆ The cluster add command adds two clusters.

◆ The cluster summary command verifies that the two clusters have the same island ID:
VPlexcli:/clusters/> cluster add cluster-1 cluster-2

VPlexcli:/clusters> cluster summary

Clusters:
NameCluster IDTLAConnectedExpelledOperational StatusHealth State
---------------------------------------------------------------------------
cluster-11FNM00103600160truefalseokok
cluster-22FNM00103600161truefalseokok

Islands:
Island ID Clusters
---------- -------------------
1 cluster-1, cluster-2

See also ◆ cluster expel

◆ cluster status
◆ cluster summary

cluster cacheflush
Flushes the cache on directors at the specified clusters to the back-end storage volumes.

Contexts All contexts.

In /clusters context, command is cacheflush.

Syntax cluster cacheflush

[-e|--sequential]
[-c|--clusters] cluster,cluster
[-v|--volumes] volumes
--verbose

Arguments Required arguments

[-c|--clusters] clusters,cluster - Flushes the cache for every exported virtual volume of every
director at the specified clusters. Entered as wildcard patterns.
[-v|--volumes] volumes - Flushes the cache only for the specified list of virtual volumes.
Entries must be separated by commas. Wildcard patterns (CLI glob patterns) are allowed.

Optional arguments
[-e|--sequential] - Flushes the cache of multiple directors sequentially. Default is to flush
the caches in parallel.
--verbose - Displays a progress report during the flush. Default is to display no output if
the run is successful.

Description
IMPORTANT
The CLI must be connected to a director before the cache can be flushed. Only exported
virtual volumes can be flushed.

94 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

When executed from a specific cluster context, this command flushes the cache of the
directors at the current cluster.

Example
VPlexcli:/clusters/> cacheflush --clusters /clusters/* --verbose --sequential

Flushing director1 director2 ...

Flushing logging_logging1_vol @ director1... done
Flushing regression_dR1a_12_vol @ director1... done
Flushing regression_dR1b_12_vol @ director1... done
.
.
.
Flushing regression_r0a_1_vol @ director1... volume not exported, skipping.
Flushing regression_r0b_1_vol @ director1... volume not exported, skipping.
Flushing regression_r0c_1_vol @ director1... volume not exported, skipping.
.
.
.
Flushing logging_logging1_vol @ director2... done
Flushing regression_dR1a_12_vol @ director2... done
Flushing regression_dR1b_12_vol @ director2... done
.
.
.
Flushing regression_r1c_1_vol @ director2... volume not exported, skipping.
Flushing regression_r1d_1_vol @ director2... volume not exported, skipping.
Flushing regression_r1e_1_vol @ director2... volume not exported, skipping.

See also ◆ cluster status

◆ cluster summary

cluster configdump
Dumps cluster configuration in an XML format, optionally directing it to a file.

Contexts All contexts.

In /clusters context, command is configdump.

Syntax cluster configdump

[-c|--cluster] cluster
[-d|--dtdOnly]
[-f|--file] filename

Arguments Optional arguments

[-c|--clusters] cluster - Dump configuration information for only the specified cluster.
[-d|--dtdOnly] - Print only the Document Type Definitions (DTD) document.
[-f|--file] filename - Direct the configdump output to the specified file.
Default location for the output file on the management server is: /var/log/VPlex/cli.

Description Dumped data includes:

◆ I/O port configurations
◆ Disk information, including paths from the directors to the storage volumes
◆ Device configuration and capacity

cluster configdump 95
VPLEX CLI Command Descriptions

◆ Volume configuration
◆ Initiators
◆ View configuration
◆ System-volume information
The XML output includes the DTD to validate the content.

Example Dump cluster-1’s configuration to an .xml file:

VPlexcli:/clusters/>configdump -c cluster-1 -f cluster1_config.xml

Example Dump the configuration at cluster-1, navigate to the cli directory on the management
server, and display the file:
VPlexcli:/clusters> configdump --verbose --file /var/log/VPlex/cli/config-dump-cluster-1.txt
--cluster cluster-1
VPlexcli:/clusters> exit
Connection closed by foreign host.
service@ManagementServer:~> cd /var/log/VPlex//cli
service@ManagementServer:/var/log/VPlex/cli>tail config-dump-cluster-1.txt
</views>
<system-volumes>
<meta-volumes>
<meta-volume active="true" block-count="23592704" block-size="4096B" geometry="raid-1"
locality="local" name="metadata_1" operational-status="ok" ready="true" rebuild-allowed="true"
size="96635715584B" system-id="metadata_1"/>
</meta-volumes>
<logging-volumes>
<logging-volume block-count="20971520" block-size="4096B" geometry="raid-0"
locality="local" name="logging_1_vol" operational-status="ok" size="85899345920B"
system-id="logging_logging_1_vol"/>
</logging-volumes>
</system-volumes>
.
.
.

See also ◆ collect-diagnostics

◆ director appcon
◆ getsysinfo
◆ sms dump

cluster expel
Expels a cluster from its current island.

Contexts All contexts.

In /clusters context, command is expel.

Syntax cluster expel

[-c|--cluster] cluster
[-f|--force]

Arguments Required arguments

[-c|--clusters] cluster - * The cluster to expel.

96 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

[-f|--force] - * Forces the cluster to be expelled.

* - argument is positional.

Description Cluster expulsion prevents a cluster from participating in a VPLEX. Expel a cluster when:
◆ The cluster is experiencing undiagnosed problems.
◆ To prepare for scheduled outage.
◆ The target cluster, or the WAN over which the rest of the system communicates with it,
is going to be inoperable for a while.
◆ An unstable inter-cluster link impacts performance.
An expelled cluster is still physically connected to the VPLEX, but not logically connected.
The --force argument is required for the command to complete.
Use the cluster unexpel command to allow the cluster to rejoin the island.

Example In the following example:

◆ The cluster expel command expels the cluster.
◆ The cluster summary and cluster status commands verify the change.
VPlexcli::/> cluster expel cluster-1 --force
Cluster 'cluster-1' has been successfully expelled.

VPlexcli:/> cluster summary

Clusters:
Name Cluster ID TLA Connected Expelled Operational Status Health State
--------- ---------- -------------- --------- -------- ------------------ -------------
cluster-1 1 FNM00103600160 true true isolated degraded
cluster-2 2 FNM00103600161 true false degraded degraded

Islands:
Island ID Clusters
--------- ---------
1 cluster-1
2 cluster-2

VPlexcli:/> cluster status

Cluster cluster-1
operational-status: isolated
transitioning-indications: suspended volumes,expelled
transitioning-progress:
health-state: degraded
health-indications: 1 suspended Devices

Cluster cluster-2
operational-status: degraded
transitioning-indications: suspended exports,suspended volumes
transitioning-progress:
health-state: degraded
health-indications: 2 suspended Devices

See also ◆ cluster unexpel

cluster expel 97
VPLEX CLI Command Descriptions

cluster forget
Tells VPLEX and Unisphere for VPLEX to forget the specified cluster.

Contexts All contexts.

In /clusters context, command is forget.

Syntax cluster forget

[-c|--cluster] context path
[-d|--disconnect]
[-f|--force]

Arguments Required arguments

[-c|--clusters] context path - * Cluster to forget.

Optional arguments
[-d|--disconnect] - Disconnect from all directors in the given cluster and remove the cluster
from the context tree after the operation is complete.
[-f|--force] - Force the operation to continue without confirmation.
* - argument is positional.

Description Removes all references to the specified cluster from the context tree.
The prerequisites for forgetting a cluster are as follows:
◆ The target cluster can not be in contact with other connected clusters.
◆ The Unisphere for VPLEX cannot be connected to the target cluster.
◆ Detach all distributed devices with legs at the target cluster (there must be no
distributed devices with legs on the target cluster).
◆ No rule sets that affect the target cluster.
◆ No globally visible devices at the target cluster.
Use the following steps to forget a cluster:
1. If connected, use the cluster forget command on the target cluster to forget the other
clusters.
2. Use the cluster forget command on all other clusters to forget the target cluster.

This command does not work if the clusters have lost communications with each other. If a
cluster is down, destroyed, or removed, use the cluster expel command to expel it.

Example VPlexcli:/clusters/> cluster forget --cluster cluster-1 --disocnnect

--force

See also ◆ cluster add

◆ cluster expel
◆ cluster status
◆ cluster unexpel

98 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

cluster shutdown
Starts the orderly shutdown of all directors at a single cluster.

Contexts All contexts.

In /clusters context, command is shutdown.

Syntax cluster shutdown

[-c|--cluster] context path
--force

Arguments Required arguments

[-c|--cluster] context path - Cluster to shut down.
[-f|--force] - Forces the shutdown to proceed.



Shutting down a VPlex cluster may cause data unavailability. Please refer to the VPLEX
procedures in the SolVe Desktop for the recommended procedure to shut down a cluster.

Description Shuts down the cluster firmware.

Note: Does not shut down the operating system on the cluster.

Use this command as an alternative to manually shutting down the directors in a cluster.
When shutting down multiple clusters:
◆ Shut each cluster down one at a time.
◆ Verify that each cluster has completed shutdown prior to shutting down the next one.
If shutting down multiple clusters, refer to the VPLEX procedures in the SolVe Desktop for
the recommended procedure for shutting down both clusters.
When a cluster completes shutting down, the following log message is generated for each
director at the cluster:
'Director shutdown complete (cluster shutdown)'

Example Start the shutdown of the specified cluster:

VPlexcli:/> cluster shutdown -c cluster-1 --force
Status Description
-------- -----------------
Started. Shutdown started.

Example In the following example:

◆ The cluster shutdown command without the --force argument starts the shutdown of
the specified cluster.
Because the --force argument was not used, a prompt to continue is displayed.
◆ The cluster summary commands display the transition to shutdown.
◆ The ll command in clusters/cluster-n context displays the shutdown cluster.

cluster shutdown 99
VPLEX CLI Command Descriptions

VPlexcli:/> cluster shutdown -c cluster-1

Warning: Shutting down a VPlex cluster may cause data unavailability. Please refer to the VPlex
documentation for the recommended procedure for shutting down a cluster. Do you wish to proceed
? (Yes/No) Yes

Status Description
-------- -----------------
Started. Shutdown started.

VPlexcli:/> cluster summary

Clusters:
Name Cluster ID TLA Connected Expelled Operational Status Health State
--------- ---------- --------- --------- -------- ------------------ ------------
cluster-1 1 FNM00103600160 true false unknown unknown
cluster-2 2 FNM00103600161 true false ok ok

Islands:
Island ID Clusters
--------- --------------------
1 cluster-1, cluster-2

VPlexcli:/> cluster summary

Clusters:
Name Cluster ID TLA Connected Expelled Operational Status Health State
--------- ---------- --------- --------- -------- ------------------ ------------
cluster-1 1 FNM00103600160 false - - -
cluster-2 2 FNM00103600161 true false degraded degraded

Islands:
Island ID Clusters
--------- ---------
2 cluster-2

Connectivity problems:
From Problem To
--------- --------- ---------
cluster-2 can't see cluster-1

VPlexcli:/> ll /clusters/cluster-1

Attributes:
Name Value
---------------------- ------------
allow-auto-join -
auto-expel-count -
auto-expel-period -
auto-join-delay -
cluster-id 7
connected false
default-cache-mode -
default-caw-template true
director-names [DirA, DirB]
island-id -
operational-status not-running
transition-indications []
transition-progress []
health-state unknown
health-indications []

See also ◆ cluster add

◆ cluster expel
◆ cluster forget

100 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ director shutdown

cluster status
Displays a cluster's operational status and health state.

Contexts All contexts.

Syntax cluster status

Example Show cluster status for a healthy cluster:

VPlexcli:/> cluster status
Cluster cluster-1
operational-status: ok
transitioning-indications:
transitioning-progress:
health-state: ok
health-indications:
local-com: ok

Cluster cluster-2
operational-status: ok
transitioning-indications:
transitioning-progress:
health-state: ok
health-indications:
local-com: ok

wan-com: ok

Example Show cluster status when a port group is not healthy:

VPlexcli:/> cluster status
Cluster cluster-1
operational-status: ok
transitioning-indications:
transitioning-progress:
health-state: ok
health-indications:
local-com: ok

Cluster cluster-2
operational-status: ok
transitioning-indications:
transitioning-progress:
health-state: ok
health-indications:
local-com: connectivity: PARTIAL

port-group-1 - FAIL - No connectivity was found from any com port.

port-group-0 - OK - All expected connectivity is present.

Example Show cluster status during an inter-cluster link outage:

VPlexcli:/> cluster status
Cluster cluster-1
operational-status: degraded
transitioning-indications: suspended exports,suspended volumes
transitioning-progress:
health-state: minor-failure

cluster status 101

VPLEX CLI Command Descriptions

health-indications: 169 suspended Devices

250 non-running remote virtual-volumes.
250 unhealthy Devices or storage-volumes
storage-volume unreachable
local-com: ok

Cluster cluster-2
operational-status: degraded
transitioning-indications: suspended exports,suspended volumes
transitioning-progress:
health-state: minor-failure
health-indications: 227 suspended Devices
250 non-running remote virtual-volumes.
250 unhealthy Devices or storage-volumes
storage-volume unreachable
local-com: ok

wan-com: connectivity: PARTIAL

port-group-1 - FAIL - No connectivity was found from any com port.

port-group-0 - OK - All expected connectivity is present.

Example Show cluster status when one cluster is shut down or expelled:
VPlexcli:/> cluster status

Cluster cluster-1
operational-status: not-running
transitioning-indications:
transitioning-progress:
health-state: unknown
health-indications:

Cluster cluster-2
operational-status: degraded
transitioning-indications: suspended exports,suspended volumes
transitioning-progress:
health-state: degraded
health-indications: 2 suspended Devices

Example Show cluster status when a storage volume is degraded:

VPlexcli:/> cluster status

Cluster cluster-1
operational-status: ok
transitioning-indications:
transitioning-progress:
health-state: ok
health-indications:
local-com: ok

Cluster cluster-2
operational-status: ok
transitioning-indications:
transitioning-progress:
health-state: degraded
health-indications: 1 degraded storage-volumes
local-com: ok

102 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

wan-com: ok

Example Show unhealthy cluster status due to engine issues:

Table 5 cluster status field descriptions (page 1 of 2)

Field Description

operational status Operational status of the cluster. During transition periods cluster moves from one
operational state to another.
cluster departure - One or more of the clusters cannot be contacted. Commands
affecting distributed storage are refused.
degraded - The cluster is not functioning at an optimal level. This may indicate
non-functioning remote virtual volumes, unhealthy devices or storage volumes,
suspended devices, conflicting director count configuration values, out-of-date
devices, and so forth.
device initializing - If clusters cannot communicate with each other, then the
distributed-device will be unable to initialize.
device out of date - Child devices are being marked fully out of date.
Sometimes this occurs after a link outage.
expelled - The cluster has been isolated from the island either manually (by an
administrator) or automatically (by a system configuration setting).
ok - The cluster is operating normally.
shutdown - The cluster’s directors are shutting down.
suspended exports - Some I/O is suspended. This could be result of a link failure or
loss of a director. Other states might indicate the true problem.

Note: it may not be a problem, and the VPLEX might be waiting for you to confirm the
resumption of I/O.

transitioning - Components of the software are recovering from a previous incident

(for example, the loss of a director or the loss of an inter-cluster link).

transitioning Additional information if the transitioning-progress is anything other than blank.

-indications

transitioning-progress Indicates progress for supported transitions.

cluster status 103

VPLEX CLI Command Descriptions

Table 5 cluster status field descriptions (page 2 of 2)

Field Description

health-state critical failure - The cluster is not functioning and may have failed completely. This
may indicate a complete loss of back-end connectivity.
degraded - The cluster is not functioning at an optimal level. This may indicate
non-functioning remote virtual volumes, unhealthy devices or storage volumes,
suspended devices, conflicting director count configuration values, or out-of-date
devices.
ok - The cluster is functioning normally.
unknown - VPLEX cannot determine the cluster's health state, or the state is invalid.
major failure - The cluster is failing and some functionality may be degraded or
unavailable. This may indicate complete loss of back-end connectivity.
minor failure - The cluster is functioning, but some functionality may be degraded.
This may indicate one or more unreachable storage volumes.

health-indications Additional information if the health-state field is anything other than “ok”.

local-com ok - All wan-com links have the expected connectivity: this port-group is operating
correctly.
warning - Some links have unexpected connectivity. This port-group is operational
but not properly configured. Performance may not be optimal.
error - Some connectivity is missing from this port-group. It is not operating correctly.
fail - All connectivity is missing from this port-group. wan-com is not operational.

wan-com full - All port-groups have a status of either ok or warning. wan-com connectivity is
complete through minor configuration errors may still exist. See individual port-group
statuses.
partial - Some port-groups have a status of error or fail, but at least one port-group
has a status of ok or warning. wan-com is operating (possibly minimally) through at
least one channel. Performance is degraded.
none- All port-groups have a status of either error or fail. wan-com is not operational.
not-applicable - The system is a single-cluster (i.e. Local) system. Validating wan-com
connectivity is not applicable.

See also ◆ cluster summary

◆ ds summary

cluster summary
Displays a summary of all clusters and the connectivity between them.

Contexts All contexts.

In /clusters context, command is summary.

Syntax cluster summary

Example Display summary for healthy clusters:

VPlexcli:/> cluster summary
Clusters:
Name Cluster ID TLA Connected Expelled Operational Status Health State
--------- ---------- -------------- --------- -------- ------------------ -------------
cluster-1 1 FNM00103600160 true false ok ok
cluster-2 2 FNM00103600161 true false ok ok

104 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Islands:
Island ID Clusters
--------- --------------------
1 cluster-1, cluster-2

Example Display cluster summary for VPLEX Metro configuration with a inter-cluster link outage:
VPlexcli:/> cluster summary
Clusters:
Name Cluster ID TLA Connected Expelled Operational Status Health State
--------- ---------- ----- --------- --------- ------------------- -------------
cluster-1 1 FNM00103600160 true false degraded minor-failure
cluster-2 2 FNM00103600161 true false degraded minor-failure

Islands:
Island ID Clusters
--------- ---------
1 cluster-1
2 cluster-2

Connectivity problems:
From Problem To
--------- --------- ---------
cluster-2 can't see cluster-1
cluster-1 can't see cluster-2

Example Display cluster summary for VPLEX Metro configuration with a cluster expelled:
VPlexcli:/> cluster summary
Clusters:
Name Cluster ID TLA Connected Expelled Operational Status Health State
--------- ---------- -------------- --------- -------- ------------------ -------------
cluster-1 1 FNM00103600160 true true isolated degraded
cluster-2 2 FNM00103600161 true false degraded degraded

Islands:
Island ID Clusters
--------- ---------
1 cluster-1
2 cluster-2

Table 6 cluster summary field descriptions (page 1 of 2)

Field Description

Clusters:

Name Name of the cluster.

Cluster ID Cluster ID. For VPLEX Local, always 1. For VPLEX Metro or Geo, 1 or 2.

TLA The Top-level Assembly. The product TLA must uniquely identify the product instance. For
VPLEX the TLA must uniquely identify the cluster (which is the rack and all physical
components in it)

Connected Whether or not the CLI is connected to at least one director in the cluster (connected to the
cluster).
true - CLI is connected to the cluster.
false - CLI is not connected to the cluster.

Expelled true - The cluster is expelled from its island.

false -The cluster is not expelled from its island.

cluster summary 105

VPLEX CLI Command Descriptions

Table 6 cluster summary field descriptions (page 2 of 2)

Field Description

Operational degraded - The cluster is not operating as configured and is not currently transitioning.
Status Examples include: degraded redundancy level (a director is dead), all exports switched to
write through because of hardware health problems, suspended virtual volumes / exports,
storage volumes not visible from all directors, meta-volume not yet processed.
isolated - The cluster is not communicating with any other clusters.
ok - The cluster is functioning normally.
transitioning - The cluster is reacting to external events and may not be operating as
configured. I/O may be suspended during the transition period.

Note: If no meta-volume has been configured, operational status is “transitioning”.

unknown - The VPLEX encountered a problem determining the operational status of the
cluster. This may indicate a degraded state, since it usually means that at least one of the
directors is not responding or is communicating abnormally.

Health State critical failure - The cluster is not functioning and may have failed completely. This may
indicate a complete loss of back-end connectivity.
degraded - The cluster is not functioning at an optimal level. This may indicate
non-functioning remote virtual volumes, unhealthy devices or storage volumes, suspended
devices, conflicting director count configuration values, out-of-date devices, and so forth.
ok - The cluster is functioning normally.
unknown - The VPLEX cannot determine the cluster's health state, or the state is invalid.
major failure - The cluster is failing and some functionality may be degraded or unavailable.
This may indicate complete loss of back-end connectivity.
minor failure - The cluster is functioning, but some functionality may be degraded. This may
indicate one or more unreachable storage volumes.

Islands:

Island ID ID of the island. For current release, always 1.

Clusters Names of clusters belonging to the island. For current release, always cluster-1 or cluster-2.

See also ◆ cluster status

cluster unexpel
Allows a cluster to rejoin the VPLEX.

Contexts All contexts.

In /clusters context, command is unexpel.

Syntax cluster unexpel

[-c|--cluster] context path]

Arguments Required arguments

[-c|--cluster] context path - Cluster to unexpel.

Description Clears the expelled flag for the specified cluster, allowing it to rejoin the VPLEX.

Example To manually unexpel a cluster, do the following:

1. Use the cluster summary command to verify that the cluster is expelled.
VPlexcli:/> cluster summary

106 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Clusters:
Name Cluster ID TLA Connected Expelled Operational Status Health State
--------- ---------- -------------- --------- -------- ------------------ -------------
cluster-1 1 FNM00103600160 true true isolated degraded
cluster-2 2 FNM00103600161 true false degraded degraded

Islands:
Island ID Clusters
--------- ---------
1 cluster-1
2 cluster-2

2. Use the ll command in the target cluster’s cluster context to display the cluster’s
allow-auto-join attribute setting.
VPlexcli:/> ll /clusters/cluster-1

/clusters/cluster-1:

Attributes:
Name Value
------------------------------ --------------------------------
allow-auto-join true
auto-expel-count 0
auto-expel-period 0
auto-join-delay 0
cluster-id 1
.
.
.

If the cluster’s allow-auto-join attribute is set to true, the cluster automatically rejoins
the system. Skip to step 4.
If the cluster’s allow-auto-join flag was set to false, proceed to step 3.
3. Navigate to the target cluster’s cluster context and use the set command to set the
cluster’s allow-auto-join flag to true. For example:
VPlexcli:/ cd clusters/cluster-1
VPlexcli:/clusters/cluster-1> set allow-auto-join true

4. Use the cluster unexpel command to manually unexpel a cluster, allowing the cluster
to rejoin VPLEX. The syntax for the command is:

For example:
VPlexcli:/clusters> cluster unexpel --cluster cluster-1

5. Use the cluster summary command to verify all clusters are in one island and working
as expected.
VPlexcli:/> cluster summary
Clusters:
Name Cluster ID TLA Connected Expelled Operational Status Health State
--------- ---------- -------------- --------- -------- ------------------ ------------
cluster-1 1 FNM00091300128 true false ok ok
cluster-2 2 FNM00091300218 true false ok ok

Islands:
Island ID Clusters
--------- --------------------
1 cluster-1, cluster-2

cluster unexpel 107

VPLEX CLI Command Descriptions

See also ◆ cluster expel

cluster-witness configure
Creates the cluster-witness context for enabling VPLEX Witness functionality and
configuration commands.

Contexts All contexts.

Syntax cluster-witness configure

[--verbose]

Arguments Optional agruments

[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description Cluster Witness is an optional component of VPLEX Metro and VPLEX Geo configurations.
Cluster Witness monitors both clusters and updates the clusters with its guidance, when
necessary. Cluster Witness allows VPLEX to distinguish between inter-cluster link failures
versus cluster failures, and to apply the appropriate detach-rules and recovery policies.

IMPORTANT
This command must be run on both management servers to create cluster-witness CLI
contexts on the VPLEX.

The following must be true for the command to run successfully:

◆ The Cluster Witness must be disabled.
◆ The VPN from this management server to the Cluster Witness server must be
established and functional.
◆ The Cluster Witness server must be operational and connected.

IMPORTANT
ICMP traffic must be permitted between clusters for this command to work properly.

To verify that ICMP is enabled, log in to the shell on the management server and use the
ping IP address command where the IP address is for a director in the VPLEX.
If ICMP is enabled on the specified director, a series of lines is displayed:
service@ManagementServer:~> ping 128.221.252.36
PING 128.221.252.36 (128.221.252.36) 56(84) bytes of data.
64 bytes from 128.221.252.36: icmp_seq=1 ttl=63 time=0.638 ms
64 bytes from 128.221.252.36: icmp_seq=2 ttl=63 time=0.591 ms
64 bytes from 128.221.252.36: icmp_seq=3 ttl=63 time=0.495 ms
64 bytes from 128.221.252.36: icmp_seq=4 ttl=63 time=0.401 ms
64 bytes from 128.221.252.36: icmp_seq=5 ttl=63 time=0.552 ms

--- 128.221.252.36 ping statistics ---

108 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

5 packets transmitted, 5 received, 0% packet loss, time 4002ms

rtt min/avg/max/mdev = 0.401/0.535/0.638/0.084 ms

If ICMP is disabled, nothing is displayed.

Press Ctrl-C to exit from ping.

Example In the following example:

◆ The ls command at the root context shows that the Cluster Witness context is not
configured.
◆ The cluster-witness configure command creates the cluster-witness context.
◆ The ls command shows the Public and Private IP addresses and the administrative
Cluster Witness state.
VPlexcli:/> ls

clusters/ data-migrations/
distributed-storage/ engines/ management-server/
monitoring/ notifications/ recoverpoint/
security/

VPlexcli:/> cluster-witness configure

VPlexcli:> ls /cluster-witness

Attributes:
Name Value
------------- -------------
admin-state disabled
private-ip-address 128.221.254.3
public-ip-address 10.31.25.45
Contexts:
components

See also ◆ EMC VPLEX Procedures in SolVe Desktop - VPLEX Witness: Install and Setup
◆ cluster-witness disable
◆ cluster-witness enable
◆ configuration cw-vpn-configure

cluster-witness disable
Disables Cluster Witness on both management servers and on Cluster Witness Server.

Contexts All contexts.

In /cluster-witness context, command is disable.

Note: This command is available only after Cluster Witness has been configured and
cluster-witness CLI context is visible.

Syntax cluster-witness disable

[-f|--force]
[-w|--force-without-server]

cluster-witness disable 109

VPLEX CLI Command Descriptions

Arguments Optional arguments

[-f|--force] - Force the operation to continue without confirmation. Allows this command to
be run from non-interactive scripts.
[-w|--force-without-server] - Force the operation to disable Cluster Witness on both clusters
when connectivity to Cluster Witness Server is lost but the two clusters are connected.
Use this option when Cluster Witness fails or disconnects from both clusters and recovery
is unlikely to happen soon.



Use the --force-without-server option with extreme care. Use this option to disable
Cluster Witness in order to use configured rule-sets for I/O to distributed volumes in
consistency groups.

Note: If Cluster Witness Server becomes reachable when --force-without-server option is

used, the command will also disable the Cluster Witness Server.

Description Disables Cluster Witness on both management servers and on Cluster Witness Server.
Allows consistency group rule-sets to dictate I/O behavior to distributed virtual volumes in
consistency groups.

IMPORTANT
Cluster Witness has no effect on distributed virtual volumes outside of consistency
groups.



Use this command from only one management server.

Disabling Cluster Witness does not imply that Cluster Witness components are shut down.
If Cluster Witness is disabled, the clusters stop sending health-check traffic to the Cluster
Witness Server and the Cluster Witness Server stops providing guidance back to the
clusters.

Note: If the Cluster Witness Server or connectivity to the Cluster Witness Server will be not
operational for a long period, use the --force-without-server argument. This prevents a
system-wide Data Unavailability of all distributed virtual volumes in consistency groups if
an additional inter-cluster link communication or cluster failure occurs while there is no
access to Cluster Witness Server and Cluster Witness is enabled. Once Cluster Witness
Server is accessible from both management servers, use the cluster-witness enable
command to re-enable the functionality.

Automatic pre-checks ensure that the Cluster Witness configuration is in a state where it
can be disabled. Pre-checks:
◆ Verify management connectivity between the management servers
◆ Verify connectivity between management servers and the Cluster Witness Server
◆ Verify all the directors are up and running

110 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Note: If the --force-without-server option is used, the automatic pre-check to verify

connectivity between management servers and the Cluster Witness Server is not
performed.

◆ Verify connectivity between directors and each management server

◆ Verify that Cluster Witness is configured on both clusters
◆ Verify that the metavolume on both clusters is healthy

Example Disable Cluster Witness from the root context:

VPlexcli:/> cluster-witness disable

"WARNING: Disabling Cluster Witness may cause data unavailability in the event of a disaster.
Please consult the VPLEX documentation to confirm that you would like to disable Cluster
Witness. Continue? Yes

Example Disable Cluster Witness from the cluster-witness context when the Cluster Witness Server
is not reachable. In the following example:
◆ The disable command fails because the Cluster Witness Server is not reachable.
◆ The disable --force-without-server command disables Cluster Witness.
◆ The ll /components command displays the state of the Cluster Witness configuration.
VPlexcli:/cluster-witness> disable
WARNING: Disabling Cluster Witness may cause data unavailability in the event of a disaster.
Please consult the VPLEX documentation to confirm that you would like to disable Cluster
Witness. Continue? (Yes/No) y

cluster-witness disable: Evaluation of <<disable>> failed.

cause: Could not disable Cluster Witness.
cause: Cluster Witness cannot be disabled due to failure of a pre-check.
cause: Unable to communicate with Cluster Witness Server. Please check the
state of the Cluster Witness Server and its
connectivity and try again

VPlexcli:/cluster-witness> disable --force-without-server

WARNING: Disabling Cluster Witness may cause data unavailability in the event of a disaster.
Please consult the VPLEX documentation to confirm that you would like to disable Cluster
Witness. Continue? (Yes/No) y

VPlexcli:/cluster-witness>ll components/

/cluster-witness/components:
Name ID Admin State Operational State Mgmt Connectivity
---------- -- ----------- ----------------- -----------------
cluster-1 1 disabled - ok
cluster-2 2 disabled - ok
server - unknown - failed

See also ◆ EMC VPLEX Procedures in SolVe Desktop - VPLEX Witness: Install and Setup
◆ cluster summary
◆ cluster-witness enable
◆ vpn status
◆ cluster-witness configure
◆ configuration cw-vpn-configure

cluster-witness disable 111

VPLEX CLI Command Descriptions

cluster-witness enable
Enables Cluster Witness on both clusters and Cluster Witness Server in a VPLEX Metro or
Geo configuration.

Contexts All contexts.

In /cluster-witness context, command is enable.

Note: This command is available only after Cluster Witness has been configured and
cluster-witness CLI context is visible.

Syntax cluster-witness enable

Description


Use this command from the management server on only one cluster.

Automatic pre-checks run before the cluster-witness enable command is issued.

Pre-checks verify that the VPLEX is in a state that Cluster Witness can be enabled.
Pre-checks:
◆ Verify management connectivity between both the management servers
◆ Verify connectivity between each management server and the Cluster Witness Server
◆ Verify connectivity between directors and each management server
◆ Verify that Cluster Witness CLI context is configured on both clusters
◆ Verify that a metavolume is present and healthy on both clusters
◆ Verify all the directors are healthy
If any of the pre-checks fail, the command displays the cause of failure on the specific
component and warns about possible Data Unavailability risk, if any.



There is no rollback mechanism. If the enable command fails on some components and
succeeds on others, it may leave the system in an inconsistent state. If this occurs,
consult the Troubleshooting Guide and/or contact EMC Customer Support.

The cluster-witness context does not appear in the VPLEX CLI unless the context has been
created using the cluster-witness configure command. The cluster-witness CLI context
appears under the root context. The cluster-witness context includes the following
sub-contexts:
◆ /cluster-witness/components/cluster-1
◆ /cluster-witness/components/cluster-2
◆ /cluster-witness/components/server

Example In the following example:

◆ The ll command verifies that Cluster Witness is configured (the context exists)

112 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ The cd command changes the context to cluster-witness

◆ The cluster-witness enable command enables Cluster Witness
◆ The ll /components/* command displays the components on cluster-1, cluster-2, and
the Cluster Witness Server:
VPlexcli:/> ll /cluster-witness

Attributes:
Name Value
------------------ -------------
admin-state disabled
private-ip-address 128.221.254.3
public-ip-address 10.31.25.235

Contexts:
Name Description
---------- --------------------------
components Cluster Witness Components

VPlexcli:/> cd /cluster-witness

VPlexcli:/cluster-witness> cluster-witness enable

VPlexcli:/cluster-witness> ll /components/*

/cluster-witness/components/cluster-1:
Name Value
----------------------- ------------------------------------------------------
admin-state enabled
diagnostic INFO: Current state of cluster-1 is in-contact (last
state change: 0 days, 56 secs ago; last message
from server: 0 days, 0 secs ago.)
id 1
management-connectivity ok
operational-state in-contact

/cluster-witness/components/cluster-2:
Name Value
----------------------- ------------------------------------------------------
admin-state enabled
diagnostic INFO: Current state of cluster-2 is in-contact (last
state change: 0 days, 56 secs ago; last message
from server: 0 days, 0 secs ago.)
id 2
management-connectivity ok
operational-state in-contact

/cluster-witness/components/server:
Name Value
----------------------- ------------------------------------------------------
admin-state enabled
diagnostic INFO: Current state is clusters-in-contact (last state
change: 0 days, 56 secs ago.) (last time of
communication with cluster-2: 0 days, 0 secs ago.)
(last time of communication with cluster-1: 0 days, 0
secs ago.)
id -
management-connectivity ok
operational-state clusters-in-contact

cluster-witness enable 113

VPLEX CLI Command Descriptions

Table 7 cluster witness display fields (page 1 of 3)

Field Description
Name Name of component,
For VPLEX clusters – name assigned to cluster.
For VPLEX Witness server – “server”.

id ID of a VPLEX cluster.
Always blank “-“ for Witness server.

admin state Identifies whether VPLEX Witness is enabled/disabled. Valid values are:
enabled - VPLEX Witness functionality is enabled on this component.
disabled - VPLEX Witness functionality is disabled on this component.
inconsistent - All Cluster Witness components are reachable over the management
network but some components report their administrative state as disabled while others
report it as enabled. This is a rare state which may result failure during enabling or
disabling.
unknown - This component is not reachable and its administrative state cannot be
determined.

private-ip-address Private IP address of the Cluster Witness Server VM used for cluster witness-specific
traffic.

public-ip-address Public IP address of the Cluster Witness Server VM used as an endpoint of the IPsec
tunnel.

diagnostic String generated by CLI based on the analysis of the data and state information reported
by the corresponding component.
WARNING: Cannot establish connectivity with Cluster Witness Server to query diagnostic
information. - Cluster Witness Server or one of the clusters is unreachable.
Local cluster-x hasn't yet established connectivity with the server - The cluster has never
connected to Cluster Witness Server.
Remote cluster-x hasn't yet established connectivity with the server - The cluster has
never connected to Cluster Witness Server.
Cluster-x has been out of touch from the server for X days, Y secs - Cluster Witness Server
has not received messages from a given cluster for longer than 60 seconds.
Cluster witness server has been out of touch for X days, Y secs - Either cluster has not
received messages from Cluster Witness Server for longer than 60 seconds.
Cluster Witness is not enabled on component-X, so no diagnostic information is available
- Cluster Witness Server or either of the clusters is disabled.

114 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Table 7 cluster witness display fields (page 2 of 3)

Operational State Operational state of the corresponding component.

For clusters – Healthy state is in-contact. All other states indicate a problem.
For Cluster Witness Server – Healthy state is clusters-in-contact. All other states indicate a
problem.
For Cluster Witness Server:
clusters-in-contact - Both clusters are in contact with each other over the inter-cluster
network.
cluster-partition - The clusters are partitioned from each other over the inter-cluster
network, and the Cluster Witness Server can still talk to each cluster. See NOTE: below.
cluster-partition - The clusters are partitioned from each other over the inter-cluster
network, and the Cluster Witness Server can still talk to each cluster. See NOTE: below.
cluster-unreachable - One cluster has either failed or become isolated (that is partitioned
from its peer cluster and disconnected from the Cluster Witness Server). See NOTE: below.
unknown - Cluster Witness Server does not know the states of one or both of the clusters
and needs to learn them before it can start making decisions. Cluster Witness Server
assumes this state upon startup.

Note: When the server’s operational state is cluster-partition or cluster-unreachable, this

may not reflect the current observation of the Cluster Witness Server. The Cluster Witness
Server state and the guidance that it provides to the clusters based on its state is
persistent -- if Cluster Witness Server observes a failure (changes its state and provides
guidance to the clusters), the Cluster Witness Server maintains this state even if current
observations change. Cluster Witness Server maintains its failure state and guidance until
both clusters and their connectivity fully recover. This policy is implemented in order to
avoid potential data corruption scenarios due to split brain (that would be possible if this
semantics were not followed).

For VPLEX clusters:

in-contact - This cluster is in contact with its peer over the inter-cluster network. Rebuilds
may be in progress. Subject to other system-wide restrictions, I/O to all distributed virtual
volumes in all synchronous consistency groups is allowed from the perspective of VPLEX
Witness.
cluster-partition - This cluster is not in contact with its peer and the Cluster Witness Server
has declared that two clusters partitioned. Subject to other system-wide restrictions, I/O
to all distributed virtual volumes in all synchronous consistency groups (with specific
preference rule set) is allowed from the perspective of VPLEX Witness.
remote-cluster-isolated-or-dead - This cluster is not in contact with its peer and the Cluster
Witness Server has declared that the remote cluster (the peer) was isolated or dead.
Subject to other system-wide restrictions, I/O to all distributed virtual volumes in all
synchronous consistency groups (with specific preference rule set) is allowed from the
perspective of VPLEX Witness.
local-cluster-isolated - This cluster is not in contact with its peer and the Cluster Witness
Server has declared that the remote cluster (the peer) is the only proceeding cluster. This
cluster must suspend I/O to all distributed virtual volumes in all synchronous consistency
groups regardless of cluster preference.
NOTE: When a cluster is isolated from both the remote cluster and Cluster Witness Server,
its state is unknown. When connectivity to VPLEX Witness server is restored, the state of
this cluster changes to local-cluster-isolated if this cluster remains partitioned from the
peer cluster.
unknown - This cluster is not in contact with its peer over the inter-cluster network and is
awaiting guidance from the Cluster Witness Server. I/O to all distributed virtual volumes in
all synchronous consistency groups is suspended regardless of cluster preference.
NOTE: When its state is local-cluster-isolated, the cluster does not receive guidance from
Cluster Witness Server. If connectivity with Cluster Witness Server is restored before the
inter-cluster link is restored state is local-cluster-isolated.

cluster-witness enable 115

VPLEX CLI Command Descriptions

Table 7 cluster witness display fields (page 3 of 3)

Mgmt Connectivity Reachability of the specified Witness component over the IP management network from
the management server where the CLI command is run.
ok - The component is reachable
failed - The component is not reachable

See also ◆ EMC VPLEX Procedures in the SolVe Desktop

◆ cluster summary
◆ cluster-witness disable
◆ vpn status
◆ cluster-witness configure
◆ configuration cw-vpn-configure

collect-diagnostics
Collects the two latest core files from each component, logs, and configuration
information from the management server and directors.

Contexts All contexts.

Syntax collect-diagnostics
--notrace
--nocores
--noperf
--noheap
--noextended
--faster
--local-only
--minimum
--allcores
--large-config
--recoverpoint-only
--out-dir directory

Arguments Optional arguments

--notrace - Do not collect fast trace dump files from the directors.
--nocores - Do not collect core files from the directors.
--noperf - Do not collect performance sink files.
--noheap - Do not dump the management console's heap.
--noextended - Omit collection of extended diagnostics. Implies use of --nocores,
--noheap, and --notrace arguments.
--faster - Omits some of the more time-consuming operations. Use only when
collect-diagnostics is expected to take very long, for example on large configurations. The
following commands are omitted: getsysinfo, export port summary and connectivity
director.
--local-only - Gathers diagnostics only from the local cluster and directors.

116 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

--minimum - Combines all space-saving and time-saving options and operates only on the
local cluster.
Use this argument when the collect-diagnostics command is expected to take a long time
or produce excessively large output files. Combines the --noextended, --faster and
--local-only arguments. Also omits the second sms dump command and output file
(smsDump-CLI_Logs_timestamp.zip).
--allcores - Collect all available core files from the directors. By default, only the two latest
core files are collected.
--large-config - Omits the cluster configdump command output. Use this argument only
when the configuration has:
◆ 8000 or more storage volumes, and
◆ 4000 or more local top-level devices, and
◆ 2000 or more distributed devices.
--recoverpoint-only - Collects only RecoverPoint diagnostic information. If there are no
cores files to be collected, the command generates only one base file.
--out-dir directory - The directory into which to save the zip file containing the collected
diagnostics.
Default: /diag/collect-diagnostics-out
Not needed for normal usage.

Description Collects logs, cores and configuration information from management server and directors.
Places the collected output files in the /diag/collect-diagnostics-out directory on the
management server.
2 compressed files are placed in /diag/collect-diagnostics-out directory:
◆ tla-diagnostics-extended-timestamp.tar.gz - Contains java heap dump, fast trace
dump, two latest core files (if they exist).
◆ tla-diagnostics-timestamp.tar.gz - Contains everything else.
Best practice is to collect both files. The extended collect-diagnostics file is usually large,
and thus takes some time to transfer.
Recommended practice is to transfer the base collect-diagnostics file
(tla-diagnostics-timestamp.tar.gz) first and begin analysis while waiting for the extended
file to transfer.
Starting in GeoSynchrony 5.1, this command also collects RecoverPoint diagnostics data:
◆ The extended .tar file includes the two latest RecoverPoint kdriver core files.
◆ The base tar file includes an additional directory: /opt/recoverpoint/. Files in this
directory include the RecoverPoint splitter logs:
◆ A zip file named director-name-time-stamp.zip contains the following splitter logs:
• vpsplitter.log.xx -
• vpsplitter.log.periodic_env -
• vpsplitter.log.current_env. -

collect-diagnostics 117
VPLEX CLI Command Descriptions

Note: On VPLEX Metro or Geo configurations, collect-diagnostics must be invoked from

each management server in order to collect complete diagnostics. Director core files and
management server diagnostics files are only collected for the local cluster.

Other than core files, director diagnostics are retrieved from ALL directors in a VPLEX Metro
or Geo unless the --local-only argument is used.

Note: Core files are always collected only from local directors. Starting in Release 5.1, only
the latest 2 core files are collected by default, and any older core files are not collected. To
collect all the core files, use the --allcores argument.



In VPLEX Metro and Geo configurations, run the collect-diagnostics command on each
management server, but NOT at the same time. Even if the --local-only argument is used,
do not run the command on both management servers at the same time.

EMC recommends that files created by collect-diagnostics be removed from the

management server as soon as possible to avoid filling management server disk
partitions.

Example Collect diagnostics, omitting the core files on the directors and the management server
console heap, and send the output to the default directory:
VPlexcli:/> collect-diagnostics --nocores --noheap

Example Collect all RecoverPoint diagnostics, including all available RecoverPoint core files, and
send the output to the default directory:
VPlexcli:/> collect-diagnostics --recoverpoint-only --allcores

See also ◆ cluster configdump

◆ director appdump
◆ getsysinfo
◆ sms dump

configuration complete-system-setup
Completes the VPLEX Metro or Geo configuration.

Contexts All contexts.

Syntax configuration complete-system-setup

Description Completes the automated EZ-Setup Wizard for VPLEX Metro and VPLEX Geo configurations.
This command must be run twice: once on each cluster.

Note: Before using this command on either cluster, first use the configuration
system-setup command (on both clusters).

118 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Example VPlexcli:/> configuration complete-system-setup

See also ◆ configuration connect-remote-directors

◆ configuration continue-system-setup
◆ configuration sync-time-clear
◆ configuration system-setup

configuration configure-auth-service
Configures the authentication service selected by the user.

Contexts All contexts.

Syntax configuration configure-auth-service

Description Configures the selected authentication service.

See the authentication directory-service configure command for a description of the
available authentication services.

Example Configure the selected authentication service:

VPlexcli:/> configuration configure-auth-service

Configure Authentication Service Provider (Optional)

You may select to use your existing LDAP or Active Directory as a directory service to
authenticate VPLEX users. To configure this, you will need the authentication service provider
server information, and the security information to map the users.

Or, you may choose not to configure an authentication service provider at this time. You may
configure an authentication service provider for authentication at any time, using VPLEX CLI
commands.

Would you like to configure an authentication service provider to authenticate VPLEX users?
(yes/no) [no]::yes

VPLEX supports the following types of authentication service providers:

1. LDAP
2. AD

Select the type of authentication service provider you would like use for VPLEX authentication.
(1 - 2) [1]: 1

Enter the Authentication Server IP Address: []: 10.31.52.53

VPLEX supports these connections types:

1. SSL
2. TLS

Select your connection type (1 - 2) [2]:

Enter the port to be used for LDAP [389]:

Configure Security Settings for Your Authentication Service Provider

To configure the Authentication Service Provider you will need: the base distinguished name,
the bind distinguished name, and the mapprincipal. Examples of these are:

configuration configure-auth-service 119

VPLEX CLI Command Descriptions

Base Distinguished Name Example: dc=security,dc=orgName,dc=companyName,dc=com

Bind Distinguished Name Example: cn=Administrator,dc=security,dc=orgName,dc=companyName,dc=com

Mapprincipal Example: ou=people,dc=security,dc=orgName,dc=companyName,dc=com

Enter the Base Distinguished Name []: dc=security,dc=sve,dc=emc,dc=com

Enter the Distinguished Bind Name []: cn=Administrator,dc=security,dc=sve,dc=emc,dc=com

Enter the mapprincipal []: ou=people,dc=security,dc=sve,dc=emc,dc=com

cstadmin: Object PAM VPLEX-PAM-Authority configured.

Enter Administrator's password:

Connecting to authentication server (may take 3 minutes) ...

Configuration of the ldap authentication service is complete

Note: After running this command, run the webserver restart command.

See also ◆ authentication directory-service configure

◆ authentication directory-service unconfigure

configuration connect-local-directors
Connects to the directors in the local cluster.

Contexts All contexts.

Syntax configuration connect-local-directors

[-f|--force]

Arguments Optional arguments

[-f|--force] - Connect to local directors regardless of current connections.

Description This command executes connect commands to all local directors.

Use the --force argument if one or more local directors are already connected.
The connections use the director’s default name. For example: director-1-1-A.

Example Connect the local directors to the cluster:

VPlexcli:/> configuration connect-local-directors

Example Use the --force argument when the directors are already connected:
VPlexcli:/> configuration connect-local-directors --force
Already connected to Plex firmware director-1-1-A
<128.221.252.35,128.221.253.35>.

Already connected to Plex firmware director-1-1-B

<128.221.252.36,128.221.253.36>.

See also ◆ configuration connect-remote-directors

◆ configuration complete-system-setup

120 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ configuration system-setup

configuration connect-remote-directors
Connects to the remote directors after the VPN connection has been established.

Contexts All contexts.

Syntax configuration connect-remote-directors

[-c|--engine-count]engine count
[-f|--force]

Arguments Optional arguments

[-c|--engine-count] engine count - Specifies the number of engines present at the remote
site.
[-f|--force] - Connect to remote directors regardless of current connections.

Description During system setup for a VPLEX Metro or Geo configuration, use the configuration
connect-remote-directors command to connect the local cluster to the directors in the
remote cluster.
Run this command twice: once from the local cluster to connect to remote directors, and
once from the remote cluster to connect to local directors.
Prerequisite: Number of directors at each cluster.

Example Connect remote directors to the directors in the local cluster:

VPlexcli:/> configuration connect-remote-directors --engine-count 2

Connected to Plex firmware director-2-1-A.

Connected to Plex firmware director-2-1-B.
Connected to Plex firmware director-2-2-A.
Connected to Plex firmware director-2-2-B.

See also ◆ configuration connect-local-directors

◆ configuration complete-system-setup
◆ configuration system-setup

configuration continue-system-setup
Continues the EZ-Setup Wizard after back-end storage is configured and allocated for the
cluster.

Contexts All contexts.

Syntax configuration continue-system-setup

Description This command validates the back-end configuration for the local cluster. The cluster must
have its back-end allocated and configured for this command to succeed.
Use the configuration system-setup command to start the EZ-Setup Wizard to configure
the VPLEX.

configuration connect-remote-directors 121

VPLEX CLI Command Descriptions

Zone the back-end storage to the port WWNs of the VPLEX back-end ports.
After the back-end storage is configured and allocated for the cluster, use this command
to complete the initial configuration.

Example VPlexcli:/> configuration continue-system-setup

See also ◆ configuration system-setup

configuration cw-vpn-configure
Establishes VPN connectivity between a VPLEX management server and the Cluster
Witness Server and starts the VPN tunnel between them. The command is interactive and
requires inputs to complete successfully.

IMPORTANT
This command must be run on both management servers to establish a 3-way VPN
between the management servers and the Cluster Witness Server.

Contexts All contexts.

Syntax configuration cw-vpn-configure

[-i|--ip-address] public-ip-address

Arguments Required arguments

[-i|--ip-address] public-ip-address - * Valid public IP address of the Cluster Witness Server.

Description
IMPORTANT
In order for this command to succeed, the following conditions must be true:
◆ VPN connectivity is established between the VPLEX management servers
◆ Cluster Witness Server is successfully deployed based on the steps in the Cluster
Witness Installation guide
◆ Cluster Witness Server is configured with a static public IP interface

This command:
◆ Configures the VPN tunnel between the local VPLEX management server and the
Cluster Witness Server.
◆ Checks if VPLEX cluster's management servers are connected by the VPN tunnel. If
Cluster Witness Server is not yet configured with VPN:
• Generates the Cluster Witness Server host certificate
• Configures the IPSec settings for Cluster Witness Server on the VPLEX management
server
• Configures the IPSec settings for the management server on the Cluster Witness
Server
• Restarts the IPSec service on the Cluster Witness Server VM

122 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ Validates Cluster Witness Server VPN connectivity with the VPLEX management server.

Prerequisites
The following information is required to complete this command:
◆ VPLEX Metro or Geo setup is successfully completed using EZSetup. This creates a
VPN connection between VPLEX management servers.
◆ Confirm that the VPLEX setup meets the requirement for Cluster Witness
configuration. See the VPLEX Cluster Witness Deployment and Configuration guide for
more information.
◆ Passphrase of the Certificate Authority Key that was provided during VPN configuration
between management servers.
◆ Passphrase for creating the Cluster Witness host certificate. This passphrase should
be different than passphrase used in creating host certificates for management
servers.

Note: If this command is run when the VPN is already configured, the following error
message is displayed: VPN connectivity is already established.

Example In the following example:

◆ Configure the VPN tunnel between VPLEX management server (10.31.25.26) to the
Cluster Witness Server (10.31.25.45) while maintaining the pre-configured VPN
connection to the other management server (10.31.25.27).
◆ Configure the VPN connection between VPLEX management server (10.31.25.27) to
the Cluster Witness Server (10.31.25.45) while maintaining the pre-configured VPN
connection to the other management server (10.31.25.26).

Note: The passphrase entered for the Cluster Witness Server Host Certificate Key is
reconfirmed with a Re-enter the passphrase for the Certificate Key prompt. This is because
the Cluster Witness Server Host Certificate Key password is created for the first time. There
is no reconfirmation prompt for the passphrase of Certificate Authority because this CA
passphrase Key is already created earlier as a part of complete-metro-setup.

In this example, run the command on the management server in the first VPLEX cluster
(10.31.25.26):
VPlexcli:/> configuration cw-vpn-configure -i 10.31.25.45

The Cluster Witness requires a VPLEX Metro or VPLEX Geo configuration. Is this system configured
as a Metro or Geo? (Y/N): y

Note: If this is not an initial install, the following prompt appears:

“Please enter the passphrase for the Certificate Authority that was provided while
configuring VPN between management servers.”

Enter the CA passphrase.

configuration cw-vpn-configure 123

VPLEX CLI Command Descriptions

If this is an initial installation of Release 5.0 or later, the CA passphrase is provided

automatically, and this question does not appear.

Enter the passphrase to create the Cluster Witness Server Host Certificate Key (at least 8
characters):passphrase
Re-enter the passphrase for the Certificate Key: passphrase
New Host certificate request /etc/ipsec.d/reqs/cwsHostCertReq.pem created

New Host certificate /etc/ipsec.d/certs/cwsHostCert.pem created and signed by the CA

Certificate /etc/ipsec.d/cacerts/strongswanCert.pem

VPN Host Certificate created successfully

Please enter the IP address of the remote cluster management server that will be included in
the 3-way VPN setup: 10.31.25.27
Verifying the VPN status between the management servers...
IPSEC is UP
Remote Management Server at IP Address 10.31.25.27 is reachable
Remote Internal Gateway addresses are reachable

Verifying the VPN status between the management server and the cluster witness server...
Cluster Witness Server at IP Address 128.221.254.3 is not reachable

Verifying the VPN status between the management server and the cluster witness server...
IPSEC is UP
Cluster Witness Server at IP Address 128.221.254.3 is reachable

Verifying the VPN status between the management servers...

IPSEC is UP
Remote Management Server at IP Address 10.31.25.27 is reachable
Remote Internal Gateway addresses are reachable

The VPN configuration between this cluster and the Witness server is complete.

The Setup Wizard has completed the automated portion of configuring your cluster.
From this point, please follow the manual procedures defined in the Installation and Setup
Guide.

VPlexcli:/>
Run the command on the management server in the second VPLEX cluster (10.31.25.27):
VPlexcli:/> configuration cw-vpn-configure -i 10.31.25.45

Cluster witness requires a VPlex Metro or VPlex Geo configuration. Is this system a Metro or
Geo? (Y/N): y

Please enter the IP address of the remote cluster management server in the plex that will be
involved in the 3 way VPN setup: 10.31.25.26
Verifying the VPN status between the management servers...
IPSEC is UP
Remote Management Server at IP Address 10.31.25.26 is reachable
Remote Internal Gateway addresses are reachable

Verifying the VPN status between the management server and the cluster witness server...
Cluster Witness Server at IP Address 128.221.254.3 is not reachable

Verifying the VPN status between the management server and the cluster witness server...
IPSEC is UP
Cluster Witness Server at IP Address 128.221.254.3 is reachable

Verifying the VPN status between the management servers...

IPSEC is UP
Remote Management Server at IP Address 10.31.25.26 is reachable
Remote Internal Gateway addresses are reachable

124 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Cluster Witness Server VPN Configuration Complete.

The Setup Wizard has completed the automated portion of configuring your cluster.
From this point, please follow the manual procedures defined in the Installation and Setup
Guide.

The log summary for configuration automation has been captured in

/var/log/VPlex/cli/VPlexconfig.log

The task summary and the commands executed for each automation task has been captured in
/var/log/VPlex/cli/VPlexcommands.txt

The output for configuration automation has been captured in

/var/log/VPlex/cli/capture/VPlexconfiguration-session.txt

See also ◆ cluster-witness configure

◆ cluster-witness disable
◆ cluster-witness enable
◆ configuration system-setup

configuration cw-vpn-reset
Resets the VPN connectivity between the management server and the Cluster Witness
Server.

Contexts All contexts.

Syntax configuration cw-vpn-reset

Description Resets the VPN between the management server on a cluster and the Cluster Witness
Server.



Use this command with EXTREME CARE. This command will erase all Cluster Witness VPN
configuration.

This command should be used only when Cluster Witness is disabled, as it is not providing
guidance to VPLEX clusters at that time.
Using the cw-vpn-reset command when Cluster Witness is enabled will cause Cluster
Witness to lose connectivity with the Cluster Witness Server and will generate a call-home
event.
In order to complete, this command requires VPN connectivity between the management
server and the Cluster Witness Server.

Note: Run this command twice: once from each management server.

Example From the first cluster:

VPlexcli:/> configuration cw-vpn-reset
This command will reset the vpn connectivity from this VPLEX instance to the Cluster Witness
Server.
Do you want to continue? (Y/N): Y

configuration cw-vpn-reset 125

VPLEX CLI Command Descriptions

To disable the VPN connectivity to the Cluster Witness Server please enter RESET (case
sensitive):RESET Verifying if there
is a VPN connection between the Management Server and the Cluster Witness Server...
Verifying if the Cluster Witness has been configured on this Management Server...
Verifying if the Cluster Witness has been enabled on this Management Server...

Successfully removed the connection name and updated the Cluster Witness Server ipsec.conf file
Successfully transferred the ipsec configuration file to the Cluster Witness Server and
restarted the IPSec process

Successfully removed the cluster witness connection name from the Management Server ipsec.conf
file
Successfully restarted the ipsec process on the Management Server

Resetting Cluster Witness Server SSH configuration.

Verifying if the Cluster Witness has been configured on this Management Server...
Verifying if the Cluster Witness has been enabled on this Management Server...
VPN Reset between the Management Server and the Cluster Witness Server is now complete.

The log summary for configuration automation has been captured in

/var/log/VPlex/cli/VPlexconfig.log

The task summary and the commands executed for each automation task has been captured in
/var/log/VPlex/cli/VPlexcommands.txt

The output for configuration automation has been captured in

/var/log/VPlex/cli/capture/VPlexconfiguration-session.txt

From the second cluster:

VPlexcli:/> configuration cw-vpn-reset
This command will reset the vpn connectivity from this VPLEX instance to the Cluster Witness
Server.
Do you want to continue? (Y/N): Y
To disable the VPN connectivity to the Cluster Witness Server please enter RESET (case
sensitive):RESET
Verifying if there is a VPN connection between the Management Server and the Cluster Witness
Server...
Verifying if the Cluster Witness has been configured on this Management Server...
Verifying if the Cluster Witness has been enabled on this Management Server...

Successfully removed the connection name and updated the Cluster Witness Server ipsec.conf file
Successfully transferred the ipsec configuration file to the Cluster Witness Server and
restarted the IPSec process

Successfully removed the certificate files from the Cluster Witness Server
Successfully removed the cluster witness connection name from the Management Server ipsec.conf
file
Successfully restarted the ipsec process on the Management Server

Resetting Cluster Witness Server SSH configuration.

Verifying if the Cluster Witness has been configured on this Management Server...
Verifying if the Cluster Witness has been enabled on this Management Server...
VPN Reset between the Management Server and the Cluster Witness Server is now complete.

The log summary for configuration automation has been captured in

/var/log/VPlex/cli/VPlexconfig.log

The task summary and the commands executed for each automation task has been captured in
/var/log/VPlex/cli/VPlexcommands.txt

The output for configuration automation has been captured in

/var/log/VPlex/cli/capture/VPlexconfiguration-session.txt

126 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

See also ◆ cluster-witness configure

◆ cluster-witness disable
◆ cluster-witness enable

configuration enable-front-end-ports
After the meta-volume is created using the EZ-Setup wizard, enable front-end ports using
this command.

Contexts All contexts.

Syntax configuration enable-front-end-ports

Description Used to complete the initial system configuration using the EZ-Setup Wizard. After the
meta-volume has been configured on the cluster, use this command to resume setup and
enable the front-end ports on the local cluster.
Prerequisite: The cluster must be configured with a meta-volume and a meta-volume
backup schedule.

Example VPlexcli:/> configuration enable-front-end-ports

See also ◆ meta-volume create

◆ configuration metadata-backup
◆ configuration complete-system-setup
◆ configuration system-setup

configuration event-notices-reports config

Configure call-home notification and system reporting settings after the initial
configuration of VPLEX.

Contexts All contexts.

Syntax configuration event-notices-reports-config

Description This command runs an interview script that prompts for values to configure call-home
notification.
If call-home notification is already configured, the current configuration information is
displayed.
If call-home notification is not configured, interview questions to configure the service
that is not configured are displayed.

Note: This command does not modify an existing configuration. Use the configuration
event-notices-reports reset command to reset (delete) an existing event notification and
reporting configuration. Then use this command to configure new settings.

configuration enable-front-end-ports 127

VPLEX CLI Command Descriptions

Before you begin

You will need the following information to complete configuration of call-home
notification:
◆ IP address of the primary SMTP server used to forward reports and call-home
notifications to EMC. EMC recommends using your ESRS gateway as the primary
connection address.
◆ (Optional) One or more IP address of secondary SMTP servers used to forward reports
and call-home notifications to EMC if the primary server fails. This address must be
different than the address for the primary SMPTP server.
◆ (Optional) One or more e-mail addresses of personnel who should receive e-mail
messages when call-home notifications occur.

See also ◆ configuration event-notices-reports reset

◆ configuration event-notices-reports show
◆ notifications call-home test
◆ scheduleSYR list

configuration event-notices-reports reset

Resets the current call-home notification and system reporting configuration.

Contexts All contexts.

Syntax configuration event-notices-reports-reset

Description This command:

◆ Deletes the current call-home notification and system reporting configuration data
◆ Disables call-home notification

See also ◆ configuration event-notices-reports config

◆ configuration event-notices-reports show
◆ notifications call-home test
◆ scheduleSYR list

configuration event-notices-reports-show
This command shows call-home notification connection records and system connections
based on the ConnectEMC configuration.

Contexts All contexts.

Syntax configuration event-notices-reports-show [options]

Arguments -h | --help - Displays the usage for this command.

128 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

--verbose - Provides more output during command execution. This may not have any effect
for some commands.

Description This command shows call-home notification connection records and system connections
based on the ConnectEMC configuration. There are no limitations.

Connection types are:

The first SMTP address to be used to send notifications to

Primary EMC.

Failover Alternate SMTP address to send notifications to EMC. Failover

connections will be attempted, in order, when the primary and
any previous failover attempts have failed.

onSuccess/onFailure Sends an email to the customer each time EMC is successfully

sent an email notification.

onFailure Sends an email to the customer each time an attempt to notify

EMC has failed.

onAllFailure Sends an email to the customer only if all attempts to notify

EMC have failed.

onSuccess Sends an email to the customer regardless of whether the

email notification to EMC succeeded.

See also ◆ configuration event-notices-reports config

◆ configuration event-notices-reports show

configuration flashdir-backup disable

Disables periodic director flashdir backups.

Contexts All contexts.

Syntax configuration flashdir-backup disable

[-h|--help]
[--verbose]

Arguments Optional arguments

[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description Disables periodic director flashdir backups.

Example VPlexcli:/> configuration flashdir-backup disable

Flashdir backups have been disabled

See also ◆ configuration flashdir-backup enable

configuration flashdir-backup enable

Enables periodic director flashdir backups.

configuration flashdir-backup disable 129

VPLEX CLI Command Descriptions

Contexts All contexts.

Syntax configuration flashdir-backup enable

[-h|--help]
[--verbose]

Arguments Optional arguments

[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description Enables periodic director flashdir backups.

Example VPlexcli:/> configuration flashdir-backup enable

Flashdir backups have been disabled

See also ◆ configuration flasjdir-backup disable

configuration get-product-type
Displays the VPLEX product type (Local, Metro, or Geo).

Contexts All contexts.

Syntax configuration get-product-type

Description Displays whether the system is a Local, Metro, or Geo configuration.

Example VPlexcli:/> configuration get-product-type

The cluster is currently configured as a VPLEX Metro

See also ◆ cluster status

◆ cluster summary
◆ version

configuration join-clusters
Validates WAN connectivity and joins the two clusters.

Contexts All contexts.

Syntax configuration join-clusters

[-i|--remote-ip] remote IP address
[-h|--help]

Arguments Optional arguments

[-i|--remote-ip] remote IP address - Specifies the IP address of the remote server.
[-h|--help] - Displays command line help.

Description This command validates WAN connectivity and joins the two clusters.

130 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Note: This command can be configured as Metro Fibre Channel using the EZ-Setup wizard.

Example Join clusters at the specified remote IP address:

VPlexcli:/> configuration join-clusters -i 10.103.97.76

Verifying the connectivity of all the directors...

Verifying that all the pre-conditions for director connectivity are satisfied...
All the directors are properly connected to each other...
Verifying island ID
Running the Join Cluster task
Verifying island ID
Added cluster 'cluster-1' to system (cluster-2).
Join Cluster task completed.

The clusters are now joined and ready for use.

See also ◆ cluster add

◆ configuration continue-system-setup
◆ configuration system-setup

configuration metadata-backup
Configures and schedules the daily backup of VPLEX metadata.

Contexts All contexts.

Syntax configuration metadata-backup

Description Selects the volumes to use as backup volumes and creates the initial backup of both
volumes.
The meta-volume’s backup size should be equal to or greater than the active meta-volume
size. The current requirement is 78G per storage volume.
See the EMC VPLEX Technical Notes for best practices regarding the kind of backend array
volumes to consider for a meta-volume.

IMPORTANT
This command must be executed on the management server in which you want to create
the backups.

Runs an interview script that prompts for values to configure and schedule the daily
backups of VPLEX metadata.
◆ Selects the volumes on which to create the backup
◆ Updates the VPlex configuration .xml file (VPlexconfig.xml)
◆ Creates an initial backup on both selected volumes
◆ Creates two backup volumes named:
• volume-1_backup_timestamp

configuration metadata-backup 131

VPLEX CLI Command Descriptions

• volume-2_backup_timestamp
◆ Schedules a backup at a time selected by the user
Enter two or more storage volumes, separated by commas.



Renaming backup metadata volumes is not supported.



Specify two or more storage volumes. Storage volumes must be:
- unclaimed
- on different arrays

Example Configure the VPLEX metadata backup schedule:

VPlexcli:/clusters/cluster-1/system-volumes> configuration metadata-backup
Configuring Meta-data Backups
To configure meta-data backups you will need to select two volumes (78G or greater), preferably
on two different arrays. Backups will occur automatically each day, at a time you specify.
Available Volumes for Meta-data Backup
Name Capacity Vendor IO Status Type
---------------------------------------- -------- -------- --------- ---------
VPD83T3:60000970000192601714533036464236 80.1G EMC alive traditional
VPD83T3:60000970000192601714533036464237 80.1G EMC alive traditional

Please select volumes for meta-data backup, preferably from two different arrays
(volume1,volume2):VPD83T3:60000970000192601714533036464236,VPD83T3:60000970000192601714533036
464237
What hour of the day should the meta-data be backed up? (0..23): 11
What minute of the hour should the meta-data be backed up? (0..59): 25
VPLEX is configured to back up meta-data every day at 11:25 (UTC).
Would you like to change the time the meta-data is backed up? [no]: no
Review and Finish
Review the configuration information below. If the values are correct, enter
yes (or simply accept the default and press Enter) to start the setup process. If the values
are not correct, enter no to go back and make changes or to exit the setup.
Meta-data Backups
Meta-data will be backed up every day at 11:25.
The following volumes will be used for the backup :
VPD83T3:60000970000192601714533036464236,
VPD83T3:60000970000192601714533036464237
Would you like to run the setup process now? [yes]:

Example Modify the existing daily backup of VPLEX metadata:

VPlexcli:/clusters/cluster-1/system-volumes> configuration metadata-backup
A back up of the meta-data is already scheduled to occur everyday at 11:25 (UTC). Do you want
change the existing schedule? (Y/N): y
Configuring Meta-data Backups
To configure meta-data backups you will need to select two volumes (78G or greater), preferably
on two different arrays. Backups will occur automatically each day, at a time you specify.

VPLEX is currently configured to backup metadata on the following volumes :

VPD83T3:60000970000192601714533036464236,
VPD83T3:60000970000192601714533036464237

Would you like to change the volumes on which to backup the metadata? [no]:
VPLEX is configured to back up meta-data every day at 11:25 (UTC).
Would you like to change the time the meta-data is backed up? [no]: yes

132 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

What hour of the day should the meta-data be backed up? (0..23): 11
What minute of the hour should the meta-data be backed up? (0..59): 00
VPLEX is configured to back up meta-data every day at 11:00 (UTC).
Review and Finish
Review the configuration information below. If the values are correct, enter
yes (or simply accept the default and press Enter) to start the setup process. If the values
are not correct, enter no to go back and make changes or to exit the setup.
Meta-data Backups
Meta-data will be backed up every day at 11:20.
The following volumes will be used for the backup :
VPD83T3:60000970000192601714533036464236,
VPD83T3:60000970000192601714533036464237
Would you like to run the setup process now? [yes]: yes

Use the ls /clusters/cluster-2/system-volumes/ command to display the backup

meta-volumes:
VPlexcli:/> ls /clusters/cluster-2/system-volumes/

/clusters/cluster-2/system-volumes:
Detroit_LOGGING_VOL_vol Detroit_METAVolume1 Detroit_METAVolume1_backup_2010Dec23_052818
Detroit_METAVolume1_backup_2011Jan16_211344

See also ◆ configuration remote-clusters clear-addresses

◆ configuration show-meta-volume-candidates
◆ configuration system-setup

configuration ntp-sync-system
Synchronizes the system time across the management server and directors in a single or
multi-site system.

Contexts All contexts.

Syntax configuration ntp-sync-system

[-d|--dry-run]
[-h|--help]
[--verbose]

Arguments Optional arguments

[-d|--dry-run] - This option will not perform any action. It displays the actions that would be
taken if the command is executed.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description This command synchronizes the time across the management server and directors in a
single or multi-site system.
After running the NDU pre-check, if you see a time drift warning execute this command first
on SMS-1, then on SMS-2.
After performing a director replacement, if you see a time drift warning, execute this
command on the corresponding management server.

configuration ntp-sync-system 133

VPLEX CLI Command Descriptions

Example Shows the time synchronization on the system completed:

[From SMS-1]
VPlexcli:/> configuration ntp-sync-system
INFO: ntp_sync_system.py: Starting cluster wide NTP time sync
INFO: ntp_sync_system.py: Synchronizing local management server time
INFO: ntp_sync_system.py: Synchronizing time on director 128.221.252.35
Syncing time via NTP.
INFO: Writing to ntp.conf file.
Shutting down network time protocol daemon (NTPD)..done
PING 128.221.252.33 (128.221.252.33) 56(84) bytes of data.
64 bytes from 128.221.252.33: icmp_seq=1 ttl=64 time=0.170 ms

--- 128.221.252.33 ping statistics ---

1 packets transmitted, 1 received, 0% packet loss, time 0ms
rtt min/avg/max/mdev = 0.170/0.170/0.170/0.000 ms
ntpd: time slew -0.000010s
Starting network time protocol daemon (NTPD)..done
executing /etc/init.d/ntp stop
executing /bin/ping 128.221.252.33 -c 1
executing /usr/sbin/ntpd -q -g
executing /sbin/hwclock --systohc -u
executing /etc/init.d/ntp start
..done
INFO: Success in setting NTP configuration.
INFO: ntp_sync_system.py: Synchronizing time on director 128.221.252.36
Syncing time via NTP.
INFO: Writing to ntp.conf file.
Shutting down network time protocol daemon (NTPD)..done
PING 128.221.253.33 (128.221.253.33) 56(84) bytes of data.
64 bytes from 128.221.253.33: icmp_seq=1 ttl=64 time=0.234 ms

--- 128.221.253.33 ping statistics ---

1 packets transmitted, 1 received, 0% packet loss, time 0ms
rtt min/avg/max/mdev = 0.234/0.234/0.234/0.000 ms
ntpd: time slew +0.000010s
Starting network time protocol daemon (NTPD)..done
INFO: Success in setting NTP configuration.
executing /etc/init.d/ntp stop
executing /bin/ping 128.221.253.33 -c 1
executing /usr/sbin/ntpd -q -g
executing /sbin/hwclock --systohc -u
executing /etc/init.d/ntp start
..done
INFO: ntp_sync_system.py: Synchronizing time on director 128.221.252.37
Syncing time via NTP.
INFO: Writing to ntp.conf file.
Shutting down network time protocol daemon (NTPD)..done
PING 128.221.252.33 (128.221.252.33) 56(84) bytes of data.
64 bytes from 128.221.252.33: icmp_seq=1 ttl=64 time=0.163 ms

--- 128.221.252.33 ping statistics ---

1 packets transmitted, 1 received, 0% packet loss, time 0ms
rtt min/avg/max/mdev = 0.163/0.163/0.163/0.000 ms
ntpd: time slew +0.000001s
Starting network time protocol daemon (NTPD)..done
INFO: Success in setting NTP configuration.
executing /etc/init.d/ntp stop
executing /bin/ping 128.221.252.33 -c 1
executing /usr/sbin/ntpd -q -g
executing /sbin/hwclock --systohc -u
executing /etc/init.d/ntp start
..done
INFO: ntp_sync_system.py: Synchronizing time on director 128.221.252.38
Syncing time via NTP.
INFO: Writing to ntp.conf file.

134 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Shutting down network time protocol daemon (NTPD)..done

PING 128.221.253.33 (128.221.253.33) 56(84) bytes of data.
64 bytes from 128.221.253.33: icmp_seq=1 ttl=64 time=0.218 ms

--- 128.221.253.33 ping statistics ---

1 packets transmitted, 1 received, 0% packet loss, time 0ms
rtt min/avg/max/mdev = 0.218/0.218/0.218/0.000 ms
ntpd: time slew +0.000047s
Starting network time protocol daemon (NTPD)..done
INFO: Success in setting NTP configuration.
executing /etc/init.d/ntp stop
executing /bin/ping 128.221.253.33 -c 1
executing /usr/sbin/ntpd -q -g
executing /sbin/hwclock --systohc -u
executing /etc/init.d/ntp start
..done
INFO: ntp_sync_system.py: Cluster wide NTP time sync completed

VPlexcli:/>

[From SMS-2]

VPlexcli:/> configuration ntp-sync-system

INFO: ntp_sync_system.py: Starting cluster wide NTP time sync
INFO: ntp_sync_system.py: Synchronizing local management server time
Shutting down network time protocol daemon (NTPD)..done
PING 10.108.185.14 (10.108.185.14) 56(84) bytes of data.
64 bytes from 10.108.185.14: icmp_seq=1 ttl=64 time=0.234 ms

--- 10.108.185.14 ping statistics ---

1 packets transmitted, 1 received, 0% packet loss, time 0ms
rtt min/avg/max/mdev = 0.234/0.234/0.234/0.000 ms
ntpd: time slew -0.000027s
Starting network time protocol daemon (NTPD)..done
INFO: ntp_sync_system.py: Synchronizing time on director 128.221.252.67
Syncing time via NTP.
INFO: Writing to ntp.conf file.
Shutting down network time protocol daemon (NTPD)..done
PING 128.221.252.65 (128.221.252.65) 56(84) bytes of data.
64 bytes from 128.221.252.65: icmp_seq=1 ttl=64 time=0.174 ms

--- 128.221.252.65 ping statistics ---

1 packets transmitted, 1 received, 0% packet loss, time 0ms
rtt min/avg/max/mdev = 0.174/0.174/0.174/0.000 ms
Starting network time protocol daemon (NTPD)..done
INFO: Success in setting NTP configuration.
executing /etc/init.d/ntp stop
executing /bin/ping 128.221.252.65 -c 1
executing /usr/sbin/ntpd -q -g
executing /sbin/hwclock --systohc -u
executing /etc/init.d/ntp start
..done
INFO: ntp_sync_system.py: Synchronizing time on director 128.221.252.68
Syncing time via NTP.
INFO: Writing to ntp.conf file.
Shutting down network time protocol daemon (NTPD)..done
PING 128.221.253.65 (128.221.253.65) 56(84) bytes of data.
From 128.221.253.68: icmp_seq=1 Destination Host Unreachable

--- 128.221.253.65 ping statistics ---

1 packets transmitted, 0 received, +1 errors, 100% packet loss, time 0ms

Starting network time protocol daemon (NTPD)..done

INFO: Success in setting NTP configuration.
executing /etc/init.d/ntp stop
executing /bin/ping 128.221.253.65 -c 1

configuration ntp-sync-system 135

VPLEX CLI Command Descriptions

executing /etc/init.d/ntp start

..done
INFO: ntp_sync_system.py: Synchronizing time on director 128.221.252.69
Syncing time via NTP.
INFO: Writing to ntp.conf file.
Shutting down network time protocol daemon (NTPD)..done
PING 128.221.252.65 (128.221.252.65) 56(84) bytes of data.
64 bytes from 128.221.252.65: icmp_seq=1 ttl=64 time=0.140 ms

--- 128.221.252.65 ping statistics ---

1 packets transmitted, 1 received, 0% packet loss, time 0ms
rtt min/avg/max/mdev = 0.140/0.140/0.140/0.000 ms
Starting network time protocol daemon (NTPD)..done
INFO: Success in setting NTP configuration.
executing /etc/init.d/ntp stop
executing /bin/ping 128.221.252.65 -c 1
executing /usr/sbin/ntpd -q -g
executing /sbin/hwclock --systohc -u
executing /etc/init.d/ntp start
..done
INFO: ntp_sync_system.py: Synchronizing time on director 128.221.252.70
Syncing time via NTP.
INFO: Writing to ntp.conf file.
Shutting down network time protocol daemon (NTPD)..done
PING 128.221.253.65 (128.221.253.65) 56(84) bytes of data.
From 128.221.253.70: icmp_seq=1 Destination Host Unreachable

--- 128.221.253.65 ping statistics ---

1 packets transmitted, 0 received, +1 errors, 100% packet loss, time 0ms

Starting network time protocol daemon (NTPD)..done

INFO: Success in setting NTP configuration.
executing /etc/init.d/ntp stop
executing /bin/ping 128.221.253.65 -c 1
executing /etc/init.d/ntp start
..done
INFO: ntp_sync_system.py: Cluster wide NTP time sync completed
executing sudo /etc/init.d/ntp stop
executing /bin/ping 10.108.185.14 -c 1
executing sudo /usr/sbin/ntpd -q -g
executing sudo /sbin/hwclock --systohc -u
executing sudo /etc/init.d/ntp start

VPlexcli:/>

See also ◆ configuration sync-time

◆ configuration sync-time-clear
◆ configuration sync-time-show

configuration register-product
Registers the VPLEX product with EMC.

Contexts All contexts.

Syntax configuration register-product

Description Use this command during installation:

◆ After configuring the external IP address and host name

136 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ Before using the configuration system-setup command.

Runs the product registration wizard. Prompts for the following information:
◆ Company contact name
◆ E-mail and phone number
◆ Mailing address.
The command uses the responses to create a file for product registration. A prompt is then
displayed asking how the registration should be sent to EMC. Two methods are available:
◆ Attach the registration file to an e-mail and send it to EMC.
◆ Send the registration file to EMC through an SMTP server.
If this option is selected, a prompt for an SMTP server IP address is displayed.

Example
VPlexcli:/> configuration register-product
Welcome to the VPLEX Product Registration Assistant. To register your
VPLEX product, please provide the information prompted for below.
This information will be sent to EMC via email or, this information will be captured in a file
that you can attach to an email to send to EMC.

Attempting to determine the VPLEX Product Serial Number from the system.

Company Site ID Number (Optional) : 12345

Company Name : EMC Test
Contact First Name : Customer
Contact Last Name : One
Contact Email Address : [email protected]
Contact Phone Number : 888-555-1212
Company Street Address : 176 Main Street
Company City : Boston
Company State or Province : MA
Company Zip or Postal Code : 01748
Company Country : USA

Which method will be used to Connect Home. Enter the number associated with your selection.
1: ESRS 2: Email Home 3: Do Not Connect Home
Connect Home using : 3
Which method will be used for Remote Support. Enter the number associated with your selection.
1: ESRS 2: WebEx
Remote Support using : 2

Please review your product registration information below.

VPLEX Product Serial Number : DEV12345678

VPLEX software version : 0.17.25.0.0
Company Site ID # : 12345
Company Name : EMC Test
First Name : Customer
Last Name : One
Business Email Address : [email protected]
Business Phone Number : 888-555-1212
Business Address : 176 Main Street
City : Boston
State/Province : MA
Zip/Postal Code : 01748
Country : USA
Connect Home Using : Do not Connect Home
Remote Support Using : WebEx

Would you like to continue with these values? (Y/N): y

configuration register-product 137

VPLEX CLI Command Descriptions

To complete the registration process, this information must be sent to EMC. We can send this
product registration information to EMC for you using an SMTP server of your choice. Would you
like to send this now?
(Y/N): n
To complete the registration process, this information must be sent to
EMC. Please attach the file located here:
/var/log/VPlex/cli/productRegistration.txt
to an email and send it to [email protected] as soon as possible to complete
your VPLEX registration.

See also ◆ configuration continue-system-setup

◆ configuration system-setup

configuration remote-clusters add-addresses

Adds entries to the /clusters/*/connectivity/wan-com::remote-cluster-addresses list.

Context All contexts.

Syntax configuration remote-clusters add-addresses

[-c |--cluster] cluster context
[-d |--default]
[-r |--remote-cluster] cluster context
[-a |--addresses] addresses [, addresses...]
[-h |--help]
[--verbose]

Arguments Optional arguments

[-c |--cluster] cluster context - * Specifies the cluster whose connectivity configuration is to
be modified. Typically the cluster above the current context.
[-d | --default] - Applies default configuration values. Default configuration pulls the
cluster-address attribute of the active subnets from all remote clusters. This option does
not require --remote-cluster or --addresses.
[-r | --remote-cluster] cluster context - Specifies the remote-cluster configuration entry to
modify. Cannot be the same context specified in --cluster. This option is not required
when --default is used. --addresses is required if this option is used.
[-a | --addresses] addresses [, addresses...] - Specifies one or more remote
ip-address:port-number entries to add for the specified --remote-cluster. This option is
not required when --default is used. If this option is used --remote-cluster is also required.
[-h | --help] - Displays the usage for this command.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.
* - argument is positional.

Description Adds one or more address:port configurations for the specified remote-cluster entry for
this cluster.
See the VPLEX procedures in the SolVe Desktop for more information on managing
WAN-COM IP addresses.

Example Add a cluster 2 address to cluster 1:

138 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

VPlexcli:/> ls /clusters/cluster-1/connectivity/wan-com

/clusters/cluster-1/connectivity/wan-com:

Attributes:
Name Value
------------------------ ---------------------------------------------------
discovery-address 224.100.100.100
discovery-port 10000
listening-port 11000
remote-cluster-addresses cluster-2 [192.168.11.252:11000]

VPlexcli:/> configuration remote-clusters add-addresses -c cluster-1/ -r cluster-2/ -a

10.6.11.252:11000

VPlexcli:/> ls /clusters/cluster-1/connectivity/wan-com

/clusters/cluster-1/connectivity/wan-com:

Attributes:
Name Value
------------------------ ---------------------------------------------------
discovery-address 224.100.100.100
discovery-port 10000
listening-port 11000
remote-cluster-addresses cluster-2 [10.6.11.252:11000, 192.168.11.252:11000]

Example Add cluster 2 addresses to cluster 1, assuming that the WAN COM port groups for cluster 2
have their cluster-address properly configured:
VPlexcli:/clusters/cluster-1/connectivity/wan-com> ls

Attributes:
Name Value
------------------------ -----------------------------
discovery-address 224.100.100.100
discovery-port 10000
listening-port 11000
remote-cluster-addresses -

VPlexcli:/clusters/cluster-1/connectivity/wan-com> remote-clusters add-addresses -d

VPlexcli:/clusters/cluster-1/connectivity/wan-com> ls

Attributes:
Name Value
------------------------ ---------------------------------------------------
discovery-address 224.100.100.100
discovery-port 10000
listening-port 11000
remote-cluster-addresses cluster-2 [10.6.11.252:11000, 192.168.11.252:11000]

See also ◆ configuration remote-clusters clear-addresses

configuration remote-clusters clear-addresses

Removes entries from the /clusters/*/connectivity/wan-com::remote-cluster-addresses
list.

Context All contexts.

configuration remote-clusters clear-addresses 139

VPLEX CLI Command Descriptions

Syntax configuration remote-clusters clear-addresses

[-c |--cluster] cluster context
[-r |--remote-cluster] cluster context
[-a |--addresses] addresses[,addresses...]
[-h |--help]
[--verbose]

Arguments Optional arguments

[-c |--cluster] cluster context - * Specifies the cluster whose connectivity configuration is to
be modified. Typically the cluster above the current context.
[-r | --remote-cluster] cluster context - * Specifies the remote-cluster configuration entry to
modify. Cannot be the same context specified in --cluster.
[-a | --addresses] addresses [, addresses...] - Specifies one or more remote
ip-address:port-number entries to remove for the specified --remote-cluster. If no entry is
specified, all entries are removed for the specified --remote-cluster.
[-h | --help] - Displays the usage for this command.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.
* - argument is positional.

Description Clears one, several, or all address:port configurations for the specified remote-cluster
entry for this cluster.
See the VPLEX procedures in the SolVe Desktop for more information on managing
WAN-COM IP addresses.

Example Clear a cluster 2 address on cluster 1:

VPlexcli:> ls /clusters/cluster-1/connectivity/wan-com

/clusters/cluster-1/connectivity/wan-com:

Attributes:
Name Value
------------------------ ---------------------------------------------------
discovery-address 224.100.100.100
discovery-port 10000
listening-port 11000
remote-cluster-addresses cluster-2 [10.6.11.252:11000, 192.168.11.252:11000]

VPlexcli:/> configuration remote-clusters clear-addresses -c cluster-1/-r cluster-2/-a

10.6.11.252:11000

VPlexcli:/> ls /clusters/cluster-1/connectivity/wan-com

/clusters/cluster-1/connectivity/wan-com:

Attributes:
Name Value
------------------------ ---------------------------------------------------
discovery-address 224.100.100.100
discovery-port 10000
listening-port 11000
remote-cluster-addresses cluster-2 [192.168.11.252:11000]

See also ◆ configuration remote-clusters add-addresses

140 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

configuration short-write
Reports whether the short-write feature is enabled or disabled and provides a way to
enable or disable the feature on a cluster.

Contexts All contexts

Syntax configuration short-write

[--status [on|off]]
[-h|--help ]

Arguments Optional Arguments

--status [ on | off ] - Enables or disables the short write feature on the cluster on which you
run the command. The default value is On.
[ -h| --help ] - Provides help for the command.

Description If the short-write command is executed with no options it shows the current status of the
short-write feature. To change whether the short-write feature is enabled or not, specify on
or off using the --status option.

Note: When changing the status of the short-write feature, if any operation fails, the
currently changed values will be reverted.

Example Using the configuration short-write command to report the status of the short-write feature
on a cluster.
vplexcli> configuration short-write
The short-write feature is enabled

Example Using the configuration short-write command to set the status of the short-write feature to
enabled on a cluster.
vplexcli> configuration short-write --status on
The short-write feature is set to enabled

configuration show-meta-volume-candidates
Display the volumes which meet the criteria for a VPLEX meta-volume.

Contexts All contexts.

Syntax configuration show-meta-volume-candidates

Description Candidate volumes are:

◆ Unclaimed
◆ At least 78 Gb capacity



If the meta-volume is configured on a CLARiiON® array, it must not be placed on the vault
drives of the CLARiiON.

configuration short-write 141

VPLEX CLI Command Descriptions

EMC recommends the following for meta-volumes:

◆ Read caching should be enabled
◆ A hot spare meta-volume be pre-configured in case of a catastrophic failure of the
active meta-volume.
Performance is not critical for meta-volumes. The minimum performance allowed is 40
MB/s and 100 4 K IOP/second. The physical spindles for meta-volumes should be
isolated from application workloads.
Availability IS critical for meta-volumes. Best practice is to mirror the meta-volume across
two or more back-end arrays. Choose the arrays used to mirror the meta-volume such that
they are not required to migrate at the same time.

Example Show meta-volume candidates:

VPlexcli:/> configuration show-meta-volume-candidates
Name Capacity Vendor IO Status Type Array Name
---------------------------------------- -------- -------- --------- ----------- ---------------------
VPD83T3:60060480000190100547533030364539 187G EMC alive traditional EMC-SYMMETRIX-190100547
VPD83T3:60000970000192601707533031333132 98.5G EMC alive traditional EMC-SYMMETRIX-192601707
VPD83T3:60000970000192601707533031333133 98.5G EMC alive traditional EMC-SYMMETRIX-192601707
VPD83T3:60000970000192601707533031333134 98.5G EMC alive traditional EMC-SYMMETRIX-192601707
VPD83T3:60000970000192601707533031333135 98.5G EMC alive traditional EMC-SYMMETRIX-192601707
VPD83T3:60000970000192601707533031333136 98.5G EMC alive traditional EMC-SYMMETRIX-192601707
VPD83T3:60000970000192601707533031333137 98.5G EMC alive traditional EMC-SYMMETRIX-192601707
VPD83T3:60000970000192601707533031333138 98.5G EMC alive traditional EMC-SYMMETRIX-192601707
VPD83T3:6006016049e02100442c66c8890ee011 80G DGC alive traditional
EMC-CLARiiON-FNM00083800068

The log summary for configuration automation has been captured in

/var/log/VPlex/cli/VPlexconfig.log

The task summary and the commands executed for each automation task has been captured in
/var/log/VPlex/cli/VPlexcommands.txt

The output for configuration automation has been captured in

/var/log/VPlex/cli/capture/VPlexconfiguration-session.txt
VPlexcli:/>

See also ◆ meta-volume create

◆ configuration metadata-backup
◆ configuration system-setup

configuration subnet clear

Clears values of all attributes in one or more subnet contexts, with exception of
maximum transfer unit attribute (mtu).

Contexts / : configuration subnet clear

/clusters/*/connectivity/*/port-groups/ip-port-group-*/ : subnet clear
/clusters/*/connectivity/*/port-groups/ip-port-group-*/subnet/ : clear

Syntax clear [--force] subnet-context[,subnet-context[, ...]]

Description If a list of subnet contexts is specified, the subnets are cleared.

Non-subnet contexts may also be specified. In this case, all subnet contexts in
ip-port-groups below the specified context will be cleared (as if '**/subnet' were

142 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

appended to the given path).

This command destroys configuration information, thereby requiring user
confirmation before executing. The list of subnets to be cleared is presented for
confirmation. This check can be bypassed by specifying the --force option.
The configuration subnet clear command:
◆ works for all subnet contexts under /clusters/*/connectivity/.
◆ does not work for legacy subnet contexts under
/clusters/*/cluster-connectivity/subnets/. Clear these contexts using the legacy
subnet clear command.
Subnet properties cannot be modified unless both of the following are true:
◆ Ports in the port-group are disabled
◆ Directors in the local cluster are reachable

Example Clear all subnets in ip-port-group-3:

VPlexcli:/clusters/cluster-1/connectivity/wan-com/port-groups/ip-port-group-3/subnet> ls
Name Value
---------------------- -----
cluster-address 192.168.10.10
gateway 192.168.10.1
mtu 1500
prefix 192.168.10.0/255.255.255.0
proxy-external-address 10.10.42.100
remote-subnet-address 192.168.100.10/255.255.255.0

VPlexcli:/clusters/cluster-1/connectivity/wan-com/port-groups/ip-port-group-3/subnet> clear
./

Clearing subnet for the following port-groups:

Cluster Role Port-Group
--------- ------- ---------------
cluster-1 wan-com ip-port-group-3

Are you sure you want to clear these subnets? (Yes/No) yes

VPlexcli:/clusters/cluster-1/connectivity/wan-com/port-groups/ip-port-group-3/subnet> ls
Name Value
---------------------- -----
cluster-address -
gateway -
mtu 1500
prefix -
proxy-external-address -
remote-subnet-address -

Example Clearing all subnets of ip-port-group-3 explicitly:

VPlexcli:/> ls /clusters/cluster-1/connectivity/wan-com/port-groups/ip-port-group-3/subnet
Name Value
---------------------- -----
cluster-address 192.168.10.10
gateway 192.168.10.1
mtu 1500
prefix 192.168.10.0/255.255.255.0
proxy-external-address 10.10.42.100

configuration subnet clear 143

VPLEX CLI Command Descriptions

remote-subnet-address 192.168.100.10/255.255.255.0

VPlexcli:/> configuration subnet clear

/clusters/cluster-1/connectivity/wan-com/port-groups/ip-port-group-3/subnet/

Clearing subnet for the following port-groups:

Cluster Role Port-Group
--------- ------- ---------------
cluster-1 wan-com ip-port-group-3
Are you sure you want to clear these subnets? (Yes/No) yes

Example Clearing all subnets of cluster-1 with confirmation:

VPlexcli:/> configuration subnet clear clusters/cluster-1/
Clearing subnet for the following port-groups:
Cluster Role Port-Group
--------- --------- ---------------
cluster-1 wan-com ip-port-group-4
cluster-1 wan-com ip-port-group-3
cluster-1 local-com ip-port-group-1
cluster-1 local-com ip-port-group-2
cluster-1 front-end ip-port-group-2
cluster-1 front-end ip-port-group-1
cluster-1 back-end ip-port-group-2
cluster-1 back-end ip-port-group-1

Are you sure you want to clear these subnets? (Yes/No) yes

configuration subnet remote-subnet add

Adds a routing entry for a remote subnet to the list of remote-subnets in an iSCSI
port-group’s subnet.

Contexts All contexts.

Syntax configuration subnet remote-subnet add

[-s|--subnet] subnet context
[-r|--remote-subnets] prefix [, prefix...]
[-h|--help]
[--verbose]

Arguments Required arguments

[-s|--subnet] subnet context - * Specifies the front-end or back-end iSCSI subnet where a
routing prefix should be added.
[-r|--remote-subnets] prefix [, prefix...] - * Specifies the routing prefixes (remote subnets)
to add to the subnet.

Optional arguments
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.
* - argument is positional.

Description Adds to a front-end or back-end iSCSI subnet, a routing prefix (remote subnet) that should
be accessed through the subnet’s gateway.

144 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Note: This command is valid only on systems that support iSCSI devices.

Example Adding two prefixes to the iSCSI port-group 1 subnet:

VPlexcli:/> configuration subnet remote-subnet add
/clusters/cluster-1/connectivity/front-end/port-groups/iscsi-port-group-1/subnet/
192.168.1.0/255.255.255.0,192.168.2.0/255.255.255.0

Successfully added 2 remote subnets.

Example Adding a prefix from within an appropriate subnet context:

VPlexcli:/clusters/cluster-1/connectivity/back-end/port-groups/iscsi-port-group-8/subnet>
remote-subnets add ./ 192.168.1.0/255.255.255.0

Successfully added 1 remote subnets.

Example Attempt to add a prefix in a front-end iSCSI port-group subnet failed:

VPlexcli:/> configuration subnet remote-subnet add
/clusters/cluster-1/connectivity/front-end/port-groups/iscsi-port-group-1/subnet/
192.168.1.0/255.255.255.0

There were errors adding remote subnets:

Prefix Error
------------------------- -------------------------------------------------------
192.168.1.0/255.255.255.0 Failed to add entry to remote-subnets on director-1-1-A

Successfully added 0 remote subnets.

See also ◆ configuration subnet clear

◆ configuration subnet remote-subnet remove

configuration subnet remote-subnet remove

Removes one or more routing entries for remote subnets from the list of remote-subnets in
an iSCSI port-group’s subnet.

Contexts All contexts.

Syntax configuration subnet remote-subnet remove

[-s|--subnet] subnet context
[-r|--remote-subnets] prefix [, prefix...]
[-h|--help]
[--verbose]

Arguments Required arguments

[-s|--subnet] subnet context - * Specifies the front-end or back-end iSCSI subnet where a
routing prefix should be removed.
[-r|--remote-subnets] prefix [, prefix...] - * Specifies the routing prefixes (remote subnets)
to remove from the subnet.

Optional arguments
[-h|--help] - Displays command line help.

configuration subnet remote-subnet remove 145

VPLEX CLI Command Descriptions

[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.
* - argument is positional.

Description Removes from a front-end or back-end iSCSI subnet, a routing prefix (remote subnet) that
should be accessed through the subnet’s gateway.

Note: This command is valid only on systems that support iSCSI devices.

Example Removing two prefixes from the iSCSI port-group 1 subnet:

VPlexcli:/> configuration subnet remote-subnet remove
/clusters/cluster-1/connectivity/front-end/port-groups/iscsi-port-group-1/subnet/
192.168.1.0/255.255.255.0,192.168.2.0/255.255.255.0

Successfully removed 2 remote subnets.

Example Removing a prefix from within an appropriate subnet context:

VPlexcli:/clusters/cluster-1/connectivity/back-end/port-groups/iscsi-port-group-8/subnet>
remote-subnets remove ./ 192.168.1.0/255.255.255.0

Successfully removed 1 remote subnets.

Example Attempt to remove a prefix from an iSCSI port-group subnet failed:

VPlexcli:/> configuration subnet remote-subnet remove
/clusters/cluster-1/connectivity/front-end/port-groups/iscsi-port-group-1/subnet/
192.168.1.0/255.255.255.0

There were errors removing remote subnets:

Prefix Error
------------------------- -------------------------------------------------------
192.168.1.0/255.255.255.0 Failed to add entry to remote-subnets on director-1-1-A

Successfully removed 0 remote subnets.

See also ◆ configuration subnet clear

◆ configuration subnet remote-subnet add

configuration sync-time
Synchronizes the time of the local management server with a remote NTP server. Remote
Metro and Geo clusters are synchronized with the local management server.

Contexts All contexts.

Syntax configuration sync-time

[-i|--remote-ip] remote-server-IP-address
[-f|--force]
[-h|--help]
[--verbose]

146 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Optional arguments

[-i|--remote-ip] remote-server-IP-address - Specifies the IP address of the remote NTP
server.
[-f|--force] - Skips the verification prompt.
[-h|--help] - Displays the command line help for this command.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description In a VPLEX Metro or Geo configuration, configuration sync-time command synchronizes

the time between the local management server and a remote management server using
NTP.



May cause the CLI or SSH session to disconnect. If this occurs, re-log in and continue
system set-up where you left off.

This command synchronizes Cluster 1 with the external NTP server, or will synchronize
Cluster 2 with the local management server on Cluster 1.
Use this command before performing any set-up on the second cluster of a VPLEX Metro or
Geo configuration.
Use this command during initial system configuration before using the configuration
system-setup command.
The command prompts for the public IP address of the NTP server, or the local
management server, if not provided.

Example Running the synchronization time task on cluster-2:

VPlexcli:/> configuration sync-time
Running the Sync Time task

Please enter the IP address of the NTP server in order to synchronize the system clock.
ATTENTION: VPlex only supports syncing Cluster-1 to an external NTP server while Cluster-2 must
be synced to Cluster-1. IP Address of NTP server:10.108.69.121

Syncing time on the management server of a Metro/Geo system could cause the VPN to require a
restart. Please Confirm (Yes: continue, No: exit) (Yes/No) yes

Shutting down network time protocol daemon (NTPD)..done

PING 10.108.69.121 (10.108.69.121) 56(84) bytes of data.
64 bytes from 10.108.69.121: icmp_seq=1 ttl=64 time=0.166 ms

--- 10.108.69.121 ping statistics ---

1 packets transmitted, 1 received, 0% packet loss, time 0ms
rtt min/avg/max/mdev = 0.166/0.166/0.166/0.000 ms
Starting network time protocol daemon (NTPD)..done
executing sudo /etc/init.d/ntp stop
executing /bin/ping 10.108.69.121 -c 1
executing sudo /usr/sbin/sntp -r -P no -u 10.108.69.121
executing sudo /etc/init.d/ntp start
Now running 'vpn status' in case the VPN was affected:
Verifying the VPN status between the management servers...
IPSEC is UP
Remote Management Server at IP Address 10.108.69.121 is reachable
Remote Internal Gateway addresses are reachable

configuration sync-time 147

VPLEX CLI Command Descriptions

Verifying the VPN status between the management server and the cluster witness server...
IPSEC is UP
Cluster Witness Server at IP Address 128.221.254.3 is reachable

Synchronize Time task completed.

Example Running the synchronization task on cluster-1:

VPlexcli:/> configuration sync-time --remote-ip 128.222.208.98 -f
Running the Sync Time task
Shutting down network time protocol daemon (NTPD)..done
PING 128.222.208.98 (128.222.208.98) 56(84) bytes of data.
64 bytes from 128.222.208.98: icmp_seq=1 ttl=62 time=0.522 ms

--- 128.222.208.98 ping statistics ---

1 packets transmitted, 1 received, 0% packet loss, time 0ms
rtt min/avg/max/mdev = 0.522/0.522/0.522/0.000 ms
Starting network time protocol daemon (NTPD)..done
executing sudo /etc/init.d/ntp stop
executing /bin/ping 128.222.208.98 -c 1
executing sudo /usr/sbin/sntp -r -P no -u 128.222.208.98
executing sudo /etc/init.d/ntp start
Now running 'vpn status' in case the VPN was affected:
Synchronize Time task completed.

See also ◆ configuration sync-time-clear

◆ configuration sync-time-show
◆ configuration system-setup

configuration sync-time-clear
Clears the NTP configuration on a management server.

Contexts All contexts.

Syntax configuration sync-time-clear

[-h|--help]
[--verbose]

Arguments Optional arguments

[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description Clears the NTP configuration and restarts the NTP protocol.
This command clears the NTP configuration on the management server of the cluster on
which it is run.

Example Clears the NTP configuration:

VPlexcli:/> configuration sync-time-clear

Shutting down network time protocol daemon (NTPD)..done

Starting network time protocol daemon (NTPD)..done
executing sudo /etc/init.d/ntp restart

148 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

See also ◆ configuration sync-time

◆ configuration sync-time-show
◆ configuration system-setup

configuration sync-time-show
Displays the NTP configuration of a cluster’s management server.

Contexts All contexts.

Syntax configuration sync-time-show

[-h|--help]
[--verbose]

Arguments Optional arguments

[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description Used to check the management server’s NTP configuration.

Example Shows that no NTP is configured:

VPlexcli:/> configuration sync-timeshow
No NTP server is configured.

Example Shows a server with NTP configured:

VPlexcli:/> configuration sync-time-show

This cluster is configured to get its time from the following servers:
10.6.210.192

See also ◆ configuration sync-time

◆ configuration sync-time-clear
◆ configuration system-setup

configuration system-reset
Resets the cluster to the manufacturing state.

Contexts All contexts.

Syntax configuration system-reset

Description Resets the cluster to the manufacturing state.

Use this command to cancel all the configuration completed using the EZ-Setup wizard
and return the VPLEX to its factory default settings. Any values specified during the
configuration session become the defaults displayed when EZ-Setup is re-run.
Run the configuration system-reset command only on a new cluster.
Do not run this command on a configured cluster.

configuration sync-time-show 149

VPLEX CLI Command Descriptions

No meta-volume may exist for this command to execute.

Example VPlexcli:/> configuration system-reset

See also ◆ configuration system-setup

configuration system-setup
Starts the EZ-Setup Wizard automated configuration tool.

Contexts All contexts.

Syntax configuration system-setup

Description Configures the VPN and establishes a secure connection between the clusters.
Use the exit command any time during the session to exit EZ-Setup.
Use the configuration system-setup command to resume EZ-Setup. The process restarts
from the first step. Any values from the previous session appear as default values.

IMPORTANT
There must be no meta-volume configured, and no storage exposed to hosts in order to
run this command.

EZ-Setup Wizard automates the following steps:

◆ Connects to the local directors
◆ Sets the cluster ID
◆ Sets the Cluster IP Seed
◆ Sets the director count
◆ Commissions the directors
◆ Configures NTP
◆ Configures Fibre Channel switch
◆ Enables COM and back-end ports
◆ Creates Web server and VPN certificate
◆ Configures VPN
◆ Configures/enables call-home
◆ Configures/enables System Reporting (SYR)

General configuration procedure

During initial installation, the configuration commands are generally used in the following
order:
◆ Use the configuration system-setup command to start the EZ-Setup Wizard. Configure
the VPLEX based on information typed in response to a series of questions.
Use the exit command to exit the EZ-Setup Wizard.

150 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Use the configuration system-setup command to restart the wizard from the first step.
Values entered in the previous session are displayed as the defaults.
◆ Zone the back-end storage to the port WWNs of the VPLEX back-end ports.
◆ Use the configuration continue-system-setup command to complete the initial
configuration.
◆ Use the configuration remote-clusters clear-addresses command to display storage
volumes that are candidates for the meta-volume (unclaimed, no extents, and at least
78 GB capacity).
◆ Create the meta-volume.
◆ Use the configuration enable-front-end-ports command to enable the front-end ports
on the local cluster.
For VPLEX Metro or Geo configurations:
◆ Use the configuration continue-system-setup command to complete the configuration
for the local cluster.
◆ Enable and zone the WAN ports.
◆ Use the configuration connect-remote-directors command to connect the local cluster
to the directors on the remote cluster, and the remote cluster to the directors on the
local cluster.
After configuration is complete, use the following commands to make modifications:
◆ Use the configuration configure-auth-service to configure the authentication service
selected by the user.
◆ Use the configuration cw-vpn-configure and configuration cw-vpn-reset commands to
manage VPLEX Witness.
◆ Use the configuration event-notices-reports-configure and configuration
event-notices-reports-reset commands to import/apply/remove customized
call-home event files.

Example VPlexcli:/> configuration system-setup

See also ◆ EMC VPLEX Configuration Guide

◆ About cluster IP seed and cluster ID section in the security ipsec-configure command
◆ configuration continue-system-setup
◆ configuration sync-time-clear

configuration upgrade-meta-slot-count
Upgrades the slot count of the active meta volume at the given cluster to 64,000 slots.

Context /clusters/cluster/system-volumes

Syntax configuration upgrade-meta-slot-count

[-c | --cluster=]cluster
[-d | --storage-volumes= volume [, volume ...]
[-h | --help ]

configuration upgrade-meta-slot-count 151

VPLEX CLI Command Descriptions

[--verbose]
[-f | --force]

Arguments Optional arguments

[-h | --help] - Displays the usage for this command.
[--verbose] - Provides more output during command execution.
[-c | --cluster=] cluster - The cluster at which to upgrade the slot count of the active meta
volume. When specified from within a /clusters/cluster context, the value of that context
is used as cluster. The -c or --cluster argument is positional.
[-d | --storage-volumes= volume [, volume ...] - Creates a temporary meta volume from one
or more storage volumes. After the command completes successfully the temporary meta
volume will be destroyed. The specified storage volumes must not be empty, and must be
at the implied or specified cluster.
Type the system IDs for the storage volumes separated by commas.

IMPORTANT
Specify two or more storage volumes. Storage volumes should be on different arrays.

[-f | --force] - Forces the upgrade to proceed without asking for confirmation.

Description On the metadata volume, each slot stores header information for each storage volume,
extent, and logging volume. This command upgrades the slot count of the active meta
volume at the given cluster to 64,000 slots.
By default, the oldest meta volume backup at the cluster serves as a temporary meta
volume.
If you specify the -d or --storage-volume option, then the command creates the temporary
meta volume from scratch from those disks. The temporary meta volume is active while
the currently-active meta volume is being upgraded. At the end of the process, VPLEX
reactivates the original meta volume and the temporary meta volume becomes a backup
again. VPLEX renames the backup to reflect the new point in time at which it became a
backup.

Meta-volumes differ from standard storage volumes in that:

◆ A meta-volume is created without first being claimed.
◆ Meta-volumes are created directly on storage volumes, not extents.



If the meta-volume is configured on a CLARiiON array, it must not be placed on the
vault drives of the CLARiiON.

◆ Performance is not critical for meta-volumes. The minimum performance allowed is

40MB/sec and 1004KIOP/second.
◆ The physical spindles for meta-volumes should be isolated from application
workloads.

EMC recommends the following for meta-volumes:

◆ Read caching enabled.

152 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ A hot spare meta-volume pre-configured in case of a catastrophic failure of the active

meta-volume.
◆ Minimum of 78 20GB.
If two or more storage-volumes are specified, they must be on two separate arrays if more
than one array is present. This command creates a RAID-1 of all the storage-volumes.

connect
Connects to a director.

Contexts All contexts.

Syntax connect
[-o|--host] [host name|IP address]
--logport port number
--secondary-host [host name|IP address]
--secondary-logport secondary port number
[-n|--name] name
[-t|--type] system type
[-p|--password] password
[-c|--connection-file] filename
[-s|--save-authentication]
--no-prompt

Arguments Optional arguments

[-o|--host] {host-name|IP address} - * Host name or IP address of the director to which to
connect.
Default: localhost.
--logport port-number - For use by EMC personnel only. A firmware log event port.
Applicable only to test versions of the firmware.
--secondary-host {host-name|IP address} - Host name or IP address of the redundant
interface on director to which to connect.
--secondary-logport secondary-port-number - For use by EMC personnel only. A firmware
log event port. Applicable only to test versions of the firmware.
--name name - * Name to assign to the director after the connection.
Default: Host name or IP address.
[-t|--type] type - For use by EMC personnel only. VPLEX can communicate with its firmware
through two styles of interfaces. Tools such as the VPLEX simulator use the 'legacy' type
interface.
[-p|--password] password - Set the password for the connection.
[-c|--connection-file] filename - Load a list of connections from file named ‘connections’ at:

connect 153
VPLEX CLI Command Descriptions

service@ManagementServer:/var/log/VPlex/cli on the VPLEX management server.

[-s|--save-authentication] - Save the authentication information used to connect to the
VPLEX without asking for confirmation.
--no-prompt - Do not prompt for a password when authentication to the VPLEX is required.
* - argument is positional.

Description Use the connect command to:

◆ Re-establish connectivity if connectivity is lost to one or more directors.
◆ Manually re-connect after a power outage if the management server is not able to
connect to the directors.
During normal system setup, connections to directors are established and stored in a file:
/var/log/VPlex/cli/connections.
Use the connect -c command if the entry for the director exists in the connections file.

Note: If the disconnect command is issued for a director, the entry in the connections file
for that director is removed from the connections file.

When a director is connected, the context tree expands with new contexts representing
the director, including:
◆ A new director context below /engines/engine/directors representing storage and
containing the director’s properties.
◆ If this is the first connection to a director at that cluster, a new cluster context below
/clusters.
◆ If this is the first connection to a director belonging to that engine, a new engine
context below /engines.
Use the connect -name name command to name the new context below
/engines/engine/directors. If is omitted, the host name or IP address is used.

Note: name is required if two host addresses are specified.

If the --connection-file argument is used, the specified file must list at least one host
address to connect to on each line with the format:
host|[secondary host][,name]
Sample connections file:
service@ManagementServer:/var/log/VPlex/cli> tail connections
128.221.252.67:5988|128.221.253.67:5988,Cluster_2_Dir_1A
128.221.252.68:5988|128.221.253.68:5988,Cluster_2_Dir_1B
128.221.252.69:5988|128.221.253.69:5988,Cluster_2_Dir_2A
128.221.252.70:5988|128.221.253.70:5988,Cluster_2_Dir_2B
128.221.252.35:5988|128.221.253.35:5988,Cluster_1_Dir1A
128.221.252.36:5988|128.221.253.36:5988,Cluster_1_Dir1B
128.221.252.36:5988,128.221.252.36
128.221.252.35:5988,128.221.252.35

Example VPlexcli:> connect --host 128.221.252.67 --secondary-host

128.221.253.67 --name director-2-1-A

154 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

See also ◆ disconnect

connectivity director
Displays connections from the specified director through data (non-management) ports.

Contexts All contexts.

Syntax connectivity director

director
[-d|--storage-volumes]
[-i|--initiators]
[-n|--directors]
[-f|--file] filename
[-s|sort-by][name|wwn|port]

Arguments Required arguments

director - Director to discover.
Optional arguments
[-d|--storage-volumes] - Display connectivity from the specified director to storage
volumes.
[-i|--initiators] - Display connectivity from the specified director to initiators.
[-n|--directors] - Display connectivity from the specified director to other directors.
[-f|--file] filename - Save the output in the specified file.
Default: /var/log/VPlex/cli
[-s|--sort-by] {name|wwn|port} - Sort output by one of the following:
name - Sort output by storage volume name.
wwn - Sort output by WorldWide name.
port - Sort output by port.

Description Prints a table of discovered storage volumes, initiators and directors. Lists the ports on
which it discovered each storage volume, initiator and director.

Example Display connectivity from director Cluster_1_DirA to initiators:

VPlexcli:/> connectivity director Cluster_1_Dir1A/ --initiators
Initiators discovered
Node WWN Port WWN Ports
------------------ ------------------ ---------------
0x20000000c992c3d5 0x10000000c992c3d5 A0-FC00,A1-FC00
0x20000000c97b1f3d 0x10000000c97b1f3d A0-FC00,A1-FC00
0x20000000c97b1f3c 0x10000000c97b1f3c A0-FC02,A1-FC02
0x20000000c97b0c3f 0x10000000c97b0c3f A0-FC00,A1-FC00
0x20000000c97b0c3e 0x10000000c97b0c3e A0-FC02,A1-FC02
0x20000000c990d6fd 0x10000000c990d6fd A0-FC02,A1-FC02
0x20000000c992c219 0x10000000c992c219 A0-FC02,A1-FC02
0x20000000c992c841 0x10000000c992c841 A0-FC00,A1-FC00

Example Display connectivity from director Cluster_1_DirA to directors:

VPlexcli:/> connectivity director Cluster_1_Dir1A/ --directors
Device VPD83T3:60000970000192601378533030303530 is a default LUN_0.

connectivity director 155

VPLEX CLI Command Descriptions

Device VPD83T3:60000970000192601723533030303530 is a default LUN_0.

Device VPD83T3:60000970000192601852533030303530 is a default LUN_0.
Directors discovered by Cluster_1_Dir1A, UUID 0x000000003ca00147:
Director UUID Protocol Address Ports
------------------ -------- ------------------ ---------------
0x000000003ca000e6 COMSCSI 0x500014424000e643 A4-FC03,A4-FC02
0x000000003cb001cb COMSCSI 0x500014425001cb43 A4-FC02,A4-FC03
0x000000003ca001cb COMSCSI 0x500014424001cb43 A4-FC02,A4-FC03
0x000000003cb00147 COMSCSI 0x5000144250014741 A4-FC01
COMSCSI 0x5000144250014740 A4-FC00
0x000000003cb000e6 COMSCSI 0x500014425000e643 A4-FC02,A4-FC03

Example Display connectivity from director Cluster_1_DirA and sort output by port:
VPlexcli:/> connectivity director Cluster_1_Dir1A/ --sort-by port
Device VPD83T3:60000970000192601378533030303530 is a default LUN_0.
Device VPD83T3:60000970000192601723533030303530 is a default LUN_0.
Device VPD83T3:60000970000192601852533030303530 is a default LUN_0.
StorageVolumes discovered - sorted by: port
Port WWN StorageVolume Name LUN
------- ------------------ ---------------------------------------- ------------------
A2-FC00 0x50000972081aeda5 VPD83T3:60000970000192601723533030313530 0x0001000000000000
VPD83T3:60000970000192601723533030313534 0x0002000000000000
0x500601603ce03506 VPD83T3:6006016021d0250026b925ff60b5de11 0x0008000000000000
VPD83T3:6006016021d0250027b925ff60b5de11 0x0001000000000000
.
.
.
A2-FC02 0x500601613ce03506 VPD83T3:6006016021d0250026b925ff60b5de11 0x0008000000000000
VPD83T3:6006016021d0250027b925ff60b5de11 0x0001000000000000
.
.
.

Example Display connectivity from director Cluster_1_DirA and sort output by storage volume
name:
VPlexcli:/> connectivity director Cluster_1_Dir1A/ --sort-by name
Device VPD83T3:60000970000192601378533030303530 is a default LUN_0.
Device VPD83T3:60000970000192601723533030303530 is a default LUN_0.
Device VPD83T3:60000970000192601852533030303530 is a default LUN_0.
StorageVolumes discovered - sorted by: name
StorageVolume Name WWN LUN Ports
---------------------------------------- ------------------ ------------------ ---------------
VPD83T3:60000970000192601723533030313530 0x50000972081aeda5 0x0001000000000000 A2-FC00,A3-FC00
VPD83T3:60000970000192601723533030313534 0x50000972081aeda5 0x0002000000000000 A2-FC00,A3-FC00
VPD83T3:6006016021d0250026b925ff60b5de11 0x500601603ce03506 0x0008000000000000 A2-FC00,A3-FC00
0x500601613ce03506 0x0008000000000000 A2-FC02,A3-FC02
.
.
.

See also ◆ connectivity show

◆ connectivity validate-be

connectivity show
Displays the communication endpoints that can see each other.

Contexts All contexts.

Syntax connectivity show

[-p|--protocol][fc|ib|tcp|udt]
[-e|--endpoints] port,port...

156 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Optional arguments

[-p|--protocol] {fc|ib|tcp|udt} - Display endpoints with only the specified protocol.
Arguments are case-sensitive, and include:
fc - Fibre Channel.
ib - InfiniBand. Not supported in the current release. Use the connectivity director
command to display IB protocol connectivity.
tcp - Transmission Control Protocol.
udt - UDP-based Data Transfer Protocol.
[-e|--endpoints] port,port... - List of one or more ports for which to display endpoints.
Entries must be separated by commas.
Default: Display endpoints for all ports.

Description Displays connectivity, but does not perform connectivity checks. Displays which ports can
talk to each other.

Example Show all connectivity:

VPlexcli:/> connectivity show
/engines/engine-1-1/directors/Cluster_1_Dir1A/hardware/ports/A4-FC00 ->
/engines/engine-1-1/directors/Cluster_1_Dir1B/hardware/ports/B4-FC00
/engines/engine-1-1/directors/Cluster_1_Dir1A/hardware/ports/A4-FC01 ->
/engines/engine-1-1/directors/Cluster_1_Dir1B/hardware/ports/B4-FC01
.
.
.

Example Use the --endpoints argument followed by the <Tab> key to display all ports:
VPlexcli:/> connectivity show --endpoints

A0-FC00/ A0-FC01/ A0-FC02/ A0-FC03/ A1-FC00/ A1-FC01/ A1-FC02/

A1-FC03/ A2-FC00/ A2-FC01/ A2-FC02/ A2-FC03/ A3-FC00/ A3-FC01/
.
.
.

Example Show connectivity to two specified ports:

VPlexcli:/> connectivity show --endpoints A4-FC01/,B4-FC02/
/engines/engine-1-1/directors/Cluster_1_Dir1B/hardware/ports/B4-FC02 ->
/engines/engine-2-1/directors/Cluster_2_Dir_1B/hardware/ports/B4-FC02
/engines/engine-2-2/directors/Cluster_2_Dir_2B/hardware/ports/B4-FC02

See also ◆ connectivity director

connectivity validate-be
Checks that the back-end connectivity is correctly configured.

Contexts All contexts.

Syntax connectivity validate-be

[-d | --detailed]
[-h | --help]
--verbose

connectivity validate-be 157

VPLEX CLI Command Descriptions

Arguments Optional arguments

[-h | --help] - Displays the usage for this command.
[-d| --detailed] - Details are displayed first, followed by the summary.
--verbose - Provides more output during command execution. This may not have any effect
for some commands.

Description This provides a summary analysis of the back-end connectivity information displayed by
connectivity director if connectivity director was executed for every director in the system.
It checks the following:
◆ All directors see the same set of storage volumes.
◆ All directors have at least two paths to each storage-volume.
◆ The number of active paths from each director to a storage volume does not exceed 4.

IMPORTANT
If the number of paths per storage volume per director exceeds 8 a warning event, but not
a call home is generated. If the number of paths exceeds 16, an error event and a
call-home notification are generated.

On VPLEX Metro systems where RecoverPoint is deployed, run this command on both
clusters.
If the connectivity director command is run for every director in the VPLEX prior to running
this command, this command displays an analysis/summary of the back-end connectivity
information.

Example Entering the connectivity validate-be command without any arguments provides a
summary output as shown.
VPlexcli:/> connectivity validate-be
Cluster cluster-1
0 storage-volumes which are dead or unreachable.
0 storage-volumes which do not meet the high availability requirement for storage volume paths*.
0 storage-volumes which are not visible from all directors.
0 storage-volumes which have more than supported (4) active paths from same director.
*To meet the high availability requirement for storage volume paths each storage volume must
be accessible from each of the directors through 2 or more VPlex backend ports, and 2 or more
Array target ports, and there should be 2 or more ITLs.

Cluster cluster-2
0 storage-volumes which are dead or unreachable.
0 storage-volumes which do not meet the high availability requirement for storage volume paths*.
5019 storage-volumes which are not visible from all directors.
0 storage-volumes which have more than supported (4) active paths from same director.
*To meet the high availability requirement for storage volume paths each storage volume must
be accessible from each of the directors through 2 or more VPlex backend ports, and 2 or more
Array target ports, and there should be 2 or more ITLs.

Example: Display a summarized validation for back-end connectivity on an unhealthy system:

VPlexcli:/> connectivity validate-be

158 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Summary
Cluster cluster-1
0 storage-volumes which are dead or unreachable.
0 storage-volumes which do not meet the high availability requirement for storage volume paths*.
0 storage-volumes which are not visible from all directors.
0 storage-volumes which have more than supported (4) active paths from same director.
*To meet the high availability requirement for storage volume paths each storage volume must
be accessible from each of the directors through 2 or more VPlex backend ports, and 2 or more
Array target ports, and there should be 2 or more ITLs.

Cluster cluster-2
0 storage-volumes which are dead or unreachable.
0 storage-volumes which do not meet the high availability requirement for storage volume paths*.
5019 storage-volumes which are not visible from all directors.
0 storage-volumes which have more than supported (4) active paths from same director.
*To meet the high availability requirement for storage volume paths each storage volume must
be accessible from each of the directors through 2 or more VPlex backend ports, and 2 or more
Array target ports, and there should be 2 or more ITLs.

Example: Display detailed validation for back-end connectivity on an unhealthy system:

VPlexcli:/> connectivity validate-be -d

Storage volumes that are not visible at all directors:

Cluster Director Storage Volumes Director Cannot See

--------- -------------- ----------------------------------------
cluster-2 director-2-1-A VPD83T3:60001440000000103017bf5045090d75
VPD83T3:60001440000000103017bf5045090d70
VPD83T3:60001440000000103017bf5045092306
VPD83T3:60001440000000103017bf5045092f3b
VPD83T3:60001440000000103017bf5045092301
...
...
VPD83T3:6006016099751d002267f6538576e011
VPD83T3:60001440000000103017bf5045092310
VPD83T3:60001440000000103017bf5045090d6b
VPD83T3:60001440000000103017bf5045092f59
VPD83T3:60001440000000103017bf5045092f54

Summary
Cluster cluster-1
0 storage-volumes which are dead or unreachable.
0 storage-volumes which do not meet the high availability requirement for storage volume paths*.
0 storage-volumes which are not visible from all directors.
0 storage-volumes which have more than supported (4) active paths from same director.

*To meet the high availability requirement for storage volume paths each storage volume must
be accessible from each of the directors through 2 or more VPlex backend ports, and 2 or more
Array target ports, and there should be 2 or more ITLs.

Cluster cluster-2
0 storage-volumes which are dead or unreachable.
0 storage-volumes which do not meet the high availability requirement for storage volume paths*.
5019 storage-volumes which are not visible from all directors.
0 storage-volumes which have more than supported (4) active paths from same director.
*To meet the high availability requirement for storage volume paths each storage volume must
be accessible from each of the directors through 2 or more VPlex backend ports, and 2 or more
Array target ports, and there should be 2 or more ITLs.

See also ◆ connectivity director

◆ connectivity show

connectivity validate-be 159

VPLEX CLI Command Descriptions

◆ connectivity validate-local-com
◆ connectivity validate-wan-com
◆ health-check
◆ validate-system-configuration

connectivity validate-local-com
Validates that the actual connectivity over local-com matches the expected connectivity.

Contexts All contexts.

Syntax connectivity validate-local-com

[-c|--cluster] context path
[-e|--show-expected]
[-p|--protocol] communication protocol
[-h|--help]
[--verbose]

Arguments Optional arguments

[-c|--cluster] context-path - Context path of the cluster where local-com should be
validated.
[-e|--show-expected] - Prints the expected connectivity map instead of comparing it to the
actual connectivity.
[-p|--protocol] communication-protocol - Specifies the protocol used for local-com (FC or
UDT). If not specified, the command will attempt to determine the protocol based on the
local-com ports in the system.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description Verifies the expected local-com connectivity. This command assembles a list of expected
local-com connectivity, compares it to the actual local-com connectivity, and reports any
missing or extra connections. This command verifies only IP- or FC-based local-com
connectivity.
Expected connectivity is determined by collecting all ports whose role is local-com and
verifying that each port in a port-group has connectivity to every other port in the same
port-group.
When both FC and IP ports with role local-com are present, the smaller subset is discarded
and the protocol of the remaining ports is assumed to be the correct protocol.

Example Local-com is fully connected, protocol is automatically determined to be IP:

VPlexcli:/clusters/cluster-1> connectivity validate-local-com

Connectivity: FULL

ip-port-group-0 - OK - All expected connectivity is present.

ip-port-group-1 - OK - All expected connectivity is present.

Example Local-com is not configured on ip-port-group-0, but is fully connected on ip-port-group-1:

160 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

VPlexcli:/> connectivity validate-local-com -c cluster-1

Connectivity: PARTIAL

ip-port-group-1 - OK - All expected connectivity is present.

Example Force validation of FC ports on an IP system:

VPlexcli:/> connectivity validate-local-com -c cluster-1 -p fc

Connectivity: NONE - No com ports were found.

Example Expected connectivity when both port-groups are detected on two directors:
VPlexcli:/> connectivity validate-local-com -c cluster-1/ -e
Expected connectivity:

ip-port-group-0
/engines/engine-unknown/directors/director-1-1-A/hardware/ports/GE00 ->
/engines/engine-unknown/directors/director-1-1-B/hardware/ports/GE00
/engines/engine-unknown/directors/director-1-1-B/hardware/ports/GE00 ->
/engines/engine-unknown/directors/director-1-1-A/hardware/ports/GE00

ip-port-group-1
/engines/engine-unknown/directors/director-1-1-A/hardware/ports/GE01 ->
/engines/engine-unknown/directors/director-1-1-B/hardware/ports/GE01
/engines/engine-unknown/directors/director-1-1-B/hardware/ports/GE01 ->
/engines/engine-unknown/directors/director-1-1-A/hardware/ports/GE01

Example Port A-0-GE02 on director 2-2-A is disabled (four directors):

VPlexcli:/clusters/cluster-2> connectivity validate-local-com
Connectivity: PARTIAL

ip-port-group-3 - OK - All expected connectivity is present.

ip-port-group-2 - ERROR - Connectivity errors were found for the following com ports:
/engines/engine-2-1/directors/director-2-1-A/hardware/ports/A0-GE02 ->
Missing connectivity to
/engines/engine-2-2/directors/director-2-2-A/hardware/ports/A0-GE02
/engines/engine-2-1/directors/director-2-1-B/hardware/ports/B0-GE02 ->
Missing connectivity to
/engines/engine-2-2/directors/director-2-2-A/hardware/ports/A0-GE02
/engines/engine-2-2/directors/director-2-2-B/hardware/ports/B0-GE02 ->
Missing connectivity to
/engines/engine-2-2/directors/director-2-2-A/hardware/ports/A0-GE02
/engines/engine-2-2/directors/director-2-2-A/hardware/ports/A0-GE02 ->
Missing all expected connectivity.

See also ◆ connectivity director

◆ connectivity show
◆ connectivity validate-be
◆ connectivity validate-wan-com
◆ health-check
◆ validate-system-configuration

connectivity validate-wan-com
Verifies the expected IP and FC WAN COM connectivity.

connectivity validate-wan-com 161

VPLEX CLI Command Descriptions

Contexts All contexts.

Syntax connectivity validate-wan-com

[-e|--show-expected]
[-p|--protocol] communication-protocol

Arguments Optional arguments

[-e|--show-expected] - Displays the expected connectivity map instead of comparing it to
the actual connectivity.
The map is a list of every port involved in the WAN COM network and the ports to which it
is expected to have connectivity.
[-p|--protocol] communication-protocol - Specifies the protocol used for WAN COM (FC or
UDT). If not specified, the command will automatically select either FC or UDT based on the
system’s FC or Ethernet WAN COM ports.

Description This command assembles a list of expected WAN COM connectivity, compares it to the
actual WAN COM connectivity and reports any discrepancies (i.e. missing or extra
connections).
This command verifies IP or FC based WAN COM connectivity.
If no option is specified, displays a list of ports that are in error: either missing expected
connectivity or have additional unexpected connectivity to other ports.
The expected connectivity is determined by collecting all ports with role wan-com and
requiring that each port in a port group at a cluster have connectivity to every other port in
the same port group at all other clusters.
When both FC and IP ports with role wan-com are present, the smaller subset is discarded
and the protocol of the remaining ports is assumed as the correct protocol.

Example Display a map of expected WAN connectivity:

VPlexcli:/> connectivity validate-wan-com -e
Expected connectivity:

ip-port-group-1
/engines/engine-1-1/directors/director-1-1-A/hardware/ports/A2-XG01 ->
/engines/engine-2-1/directors/director-2-1-A/hardware/ports/A2-XG01
/engines/engine-2-1/directors/director-2-1-B/hardware/ports/B2-XG01
/engines/engine-1-1/directors/director-1-1-B/hardware/ports/B2-XG01 ->
/engines/engine-2-1/directors/director-2-1-A/hardware/ports/A2-XG01
/engines/engine-2-1/directors/director-2-1-B/hardware/ports/B2-XG01
/engines/engine-2-1/directors/director-2-1-A/hardware/ports/A2-XG01 ->
/engines/engine-1-1/directors/director-1-1-A/hardware/ports/A2-XG01
/engines/engine-1-1/directors/director-1-1-B/hardware/ports/B2-XG01
/engines/engine-2-1/directors/director-2-1-B/hardware/ports/B2-XG01 ->
/engines/engine-1-1/directors/director-1-1-A/hardware/ports/A2-XG01
/engines/engine-1-1/directors/director-1-1-B/hardware/ports/B2-XG01

ip-port-group-0
/engines/engine-1-1/directors/director-1-1-A/hardware/ports/A2-XG00 ->
/engines/engine-2-1/directors/director-2-1-A/hardware/ports/A2-XG00
/engines/engine-2-1/directors/director-2-1-B/hardware/ports/B2-XG00
/engines/engine-1-1/directors/director-1-1-B/hardware/ports/B2-XG00 ->
/engines/engine-2-1/directors/director-2-1-A/hardware/ports/A2-XG00
/engines/engine-2-1/directors/director-2-1-B/hardware/ports/B2-XG00
/engines/engine-2-1/directors/director-2-1-A/hardware/ports/A2-XG00 ->
/engines/engine-1-1/directors/director-1-1-A/hardware/ports/A2-XG00
/engines/engine-1-1/directors/director-1-1-B/hardware/ports/B2-XG00

162 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

/engines/engine-2-1/directors/director-2-1-B/hardware/ports/B2-XG00 ->
/engines/engine-1-1/directors/director-1-1-A/hardware/ports/A2-XG00

Example Display/verify WAN connectivity when ports are healthy, connectivity is correctly
configured:
VPlexcli:/> connectivity validate-wan-com
connectivity: FULL

fc-port-group-1 - OK - All expected connectivity is present.

fc-port-group-0 - OK - All expected connectivity is present.

Example Display/verify WAN connectivity when there are errors communicating with directors or
with the port-group configuration:
VPlexcli:/> connectivity validate-wan-com
connectivity: PARTIAL

ip-port-group-1 - OK - All expected connectivity is present.

ip-port-group-0 - ERROR - Connectivity errors were found for the following com ports:
/engines/engine-1-1/directors/director-1-1-B/hardware/ports/B2-XG00 ->
Missing connectivity to /engines/engine-2-2/directors/director-2-2-B/hardware/ports/B2-XG00

Example Display/verify WAN connectivity when no connectivity was detected between any ports:
VPlexcli:/> connectivity validate-wan-com
connectivity: NONE

ip-port-group-1 - ERROR - Connectivity errors were found for the following com ports:
/engines/engine-1-1/directors/director-1-1-B/hardware/ports/B2-XG01 ->
Missing connectivity to /engines/engine-2-1/directors/director-2-1-B/hardware/ports/B2-XG01
/engines/engine-2-1/directors/director-2-1-B/hardware/ports/B2-XG01 ->
Missing connectivity to /engines/engine-1-1/directors/director-1-1-B/hardware/ports/B2-XG01

ip-port-group-0 - ERROR - Connectivity errors were found for the following com ports:
/engines/engine-1-1/directors/director-1-1-B/hardware/ports/B2-XG00 ->
Missing connectivity to /engines/engine-2-2/directors/director-2-2-B/hardware/ports/B2-XG00
/engines/engine-1-2/directors/director-1-2-A/hardware/ports/A2-XG00 ->
Missing all expected connectivity.

See also ◆ connectivity director

◆ connectivity show
◆ connectivity validate-be

connectivity window set

Sets values that control the operation of communications.



This command modifies COM parameters that should not need modification under
normal operations. Contact EMC Support before using this command.

Contexts All contexts.

connectivity window set 163

VPLEX CLI Command Descriptions

Syntax connectivity window set

[-n|--name]
{clusterId|minChangeTime|avgWaitUpperBound|
historyDecayDenominator|historyDecayNumerator|
minChangeTime|windowEnlargeDelta|windowSizeInitial
windowSizeMax|windowSizeMin}
[-v|--value] integer
[-f|--force]

Arguments Required arguments

[-n|--name] - Name of the value to set. Names include:
clusterId - Unique numeric ID assigned to the cluster. Do not attempt to change this
value.
minChangeTime - The minimum interval in milliseconds between any two com window
size calculations. The calculation will cause the history speed to decay, but not
necessarily change the window size. High settings slow response to link quality
change; low settings cause frequent window size adjustment.
Default: 1000 msec.
avgWaitUpperBound - The threshold, in milliseconds, at which the window size will
shrink. If the average waiting time of all outstanding I/Os exceeds this value, the
window size will shrink. Otherwise, if full, the window size will grow. Impacts the
maximum wait time of the high priority I/Os.
Default: 1000 msec.
windowSizeMin - The minimum com window size.
Valid range: 1-1400. Default: 1.
Must be smaller than windowSizeInitial. Setting it too high may cause a longer service
wait time.
windowSizeMax - The maximum com window size.
Valid range: 1-1400. Default: 1200.
Must be larger than windowSizeInitial. Setting it too low may cause low throughput
windowSizeInitial - The initial window size when first establishing communication
with a peer.
Valid range: 1-1400. Default: 15.
Must be larger than windowSizeMin and smaller than windowSizeMax.
windowEnlargeDelta - The delta used when increasing the window size. Modify this
parameter to change the window size increment speed.
historyDecayNumerator - Numerator of the decay factor. See
historyDecayDenominator.
Default: 1.
historyDecayDenominator - Denominator of the decay factor:
Decay Factor = historyDecayNumerator/historyDecayDenominator
Higher Decay Factor means history speed has longer and stronger effect on window
size; lower means history speed’s effect on window size is shorter and weaker.
Default: 2.
[-v|--value] - An integer value to assign to the name.

164 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Optional arguments
[-f|--force] - Force the value to be set, bypassing any confirmations or guards.

Description COM bandwidth management senses how fast I/O is sent to a peer and adjusts the I/O
window size accordingly. Adjustments ensure that:
◆ High priority I/O does not have to wait longer than a expected maximum time before
being tried the first time.
◆ Enough I/O is queued to the sending protocol to obtain the best link throughput.

Example VPlexcli:/> connectivity window set windowSizeMin 2

VPlexcli:/> connectivity window show

Name Value
----------------------- -----
avgWaitUpperBound 1000
historyDecayDenominator 2
historyDecayNumerator 1
minChangeTime 1000
windowEnlargeDelta 5
windowSizeInitial 15
windowSizeMax 1200
windowSizeMin 2

See also ◆ connectivity window show

◆ connectivity window stat

connectivity window show

Displays values that control the generic operation of communications for one or more
directors.

Contexts All contexts.

Syntax connectivity window show

Description If the values are the same for all directors, then only one set of values is displayed.
Otherwise, the values for each director are displayed individually.
For descriptions of entries in the Name field, see the connectivity window set command.

Example VPlexcli:/> connectivity window show

Name Value
----------------------- ---------
avgWaitUpperBound 500
historyDecayDenominator 2
historyDecayNumerator 1
minChangeTime 1000
windowEnlargeDelta 32768
windowSizeInitial 7925760
windowSizeMax 104857600
windowSizeMin 528384

connectivity window show 165

VPLEX CLI Command Descriptions

Table 8 connectivity window show field descriptions

Field Description

avgWaitUpperBound The threshold, in milliseconds, at which the window size will shrink. If the average
waiting time of all outstanding I/Os exceeds this value, the window size will shrink.
Otherwise, if full, the window size will grow.

historyDecayDenominator The history speed information decays over time. The unit speed (used to predict
windows size) is:
speed = decay-rate * history-speed + (1 - decay-rate) * current-speed
where the decay-rate = historyDecayNumerator/historyDecayDenominator.

historyDecayNumerator Value used to calculate the rate at which speed information decays.

minChangeTime The minimum interval in milliseconds between any two com window size
calculations. The calculation will cause the history speed to decay, but not
necessarily change the window size

windowEnlargeDelta The delta (in bytes) of increment each time the window size enlarges.

windowSizeInitial The initial COM window size, in bytes.

windowSizeMax The maximum COM window size in bytes.

windowSizeMin The minimum COM window size in bytes.

See also ◆ connectivity window set

◆ connectivity window stat

connectivity window stat

Displays the current bandwidth statistics for all directors.

Syntax connectivity window stat

Contexts All contexts.

Description

Example
VPlexcli:/> connectivity window stat
Statistics for director Cluster_1_Dir1A:
Director Current Window Size Outstanding I/O Queued I/O
---------------- ------------------- --------------- ----------
Cluster_1_Dir1B 10 0 0
Cluster_2_Dir_1A 93 0 0
Cluster_2_Dir_1B 93 0 0
Cluster_2_Dir_2A 105 0 0
Cluster_2_Dir_2B 105 0 0

Statistics for director Cluster_1_Dir1B:

Director Current Window Size Outstanding I/O Queued I/O
---------------- ------------------- --------------- ----------

166 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Cluster_1_Dir1A 22 0 0

Table 9 connectivity window stat field descriptions

Field Description

Statistics for director... Name of the local director.

Director Name of the remote director.

Current Window Size The current window size towards the remote director.

Outstanding I/O The number of I/Os currently outstanding (started) to the remote director

Queued I/O The number of I/Os in the queue, waiting to start. Outstanding I/O and Queued I/O
are exclusive to each other.

See also ◆ connectivity window set

◆ connectivity window show

consistency-group add-virtual-volumes
Adds one or more virtual volumes to a consistency group.

Contexts All contexts.

In /clusters/cluster-n/consistency-groups/group-name context, command is
add-virtual-volumes

Syntax consistency-group add-virtual-volumes

[-v|--virtual-volumes] virtual-volume,virtual-volume,...
[-g|--consistency-group] consistency-group

Arguments [-v|--virtual-volumes] virtual-volume,virtual-volume,... - * List of one or more

comma-separated glob patterns or context paths of the virtual volume(s) to add.
[-g|--consistency-group] consistency-group - * Context path of the consistency group to
which to add the specified virtual volume(s).
If the current context is a consistency-group or is below, then that consistency group is the
default. Otherwise, this argument is required.
* - argument is positional.

Description Adds the specified virtual volumes to a consistency group. The properties of the
consistency group immediately apply to the added volume.

IMPORTANT
Only volumes with visibility and storage-at-cluster properties which match those of the
consistency group can be added to the consistency group.

Maximum # of volumes in a consistency group: 1000

All volumes used by the same application and/or same host should be grouped together
in a consistency group.
Only volumes with storage at both clusters (distributed volumes) are allowed in
asynchronous consistency groups.

consistency-group add-virtual-volumes 167

VPLEX CLI Command Descriptions

If any of the specified volumes are already in the consistency group, the command skips
those volumes, but prints a warning message for each one.

IMPORTANT
When adding virtual volumes to a RecoverPoint-enabled consistency group, the
RecoverPoint cluster may not note the change for 2 minutes. Wait for 2 minutes between
adding virtual volumes to a RecoverPoint-enabled consistency group and creating or
changing a RecoverPoint consistency group.

Example Add virtual volumes to a consistency group.

In the following example:
◆ The cd command changes the context to the target consistency group.
◆ The consistency-group list-eligible-virtual-volumes command displays virtual volumes
that are eligible to be added to the consistency group.
◆ The consistency-group add-virtual-volumes command adds the specified virtual
volumes to the consistency group.
◆ The ls command in displays the change:
VPlexcli:/> cd /clusters/cluster-1/consistency-groups/TestCG

VPlexcli:/clusters/cluster-1/consistency-groups/TestCG> consistency-group
list-eligible-virtual-volumes
[TestDDevice-1_vol, TestDDevice-2_vol, TestDDevice-3_vol, TestDDevice-4_vol,
TestDDevice-5_vol]

VPlexcli:/clusters/cluster-2/consistency-groups/TestCG> add-virtual-volumes --virtual-volumes

TestDDevice-2_vol

Example Add multiple volumes using a single command. Enter separate virtual volumes by
commas:
VPlexcli:/clusters/cluster-1/consistency-groups/TestCG> add-virtual-volumes
TestDDevice-1_vol,TestDDevice-2_vol

VPlexcli:/clusters/cluster-1/consistency-groups/TestCG> ll

Attributes:
Name Value
------------------- ----------------------------------------------------------
active-clusters []
cache-mode asynchronous
detach-rule active-cluster-wins
operational-status [(cluster-1,{ summary:: ok, details:: [] }), (cluster-2,{
summary:: ok, details:: [] })]
passive-clusters [cluster-1, cluster-2]
recoverpoint-enabled false
storage-at-clusters [cluster-1, cluster-2]
virtual-volumes [TestDDevice-1_vol, TestDDevice-2_vol]
visibility [cluster-1, cluster-2]

Contexts:
Name Description
------------ -----------
advanced -
recoverpoint -

168 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

See also ◆ consistency-group create

◆ consistency-group list-eligible-virtual-volumes
◆ consistency-group remove-virtual-volumes
◆ EMC VPLEX Administration Guide

consistency-group choose-winner
Selects a winning cluster during an inter-cluster link failure.

Contexts All contexts.

In /clusters/cluster-n/consistency-groups/group-name context, command is choose
winner.

Syntax consistency-group choose-winner

[-c|--cluster] cluster
[-g|--consistency-group] consistency-group
[-f|--force]

Arguments Required arguments

[-c|--cluster] cluster - *The cluster on which to roll back and resume I/O.
[-g|--consistency-group] consistency-group - * Context path of the consistency group on
which to roll back and resume I/O.

Optional arguments
[-f|--force] - Do not prompt for confirmation. Allows this command to be run using a
non-interactive script.
* - argument is positional.

Description Use the choose-winner command when:

◆ I/O must be resumed on a cluster during a link outage
◆ The selected cluster has not yet detached its peer
◆ The detach-rules require manual intervention
The selected cluster will detach its peer cluster in preparation for continuing I/O. I/O
continues or is suspended depending on the cache mode of the consistency group:
◆ For synchronous consistency groups: I/O resumes immediately.
◆ For asynchronous consistency groups: I/O may suspend pending use of the
consistency-group resume-after-rollback command.
For asynchronous consistency groups, it may be required to roll back data to the last
consistent image.
Roll-back is required only when both clusters of an asynchronous consistency group
were active.

consistency-group choose-winner 169

VPLEX CLI Command Descriptions



When the clusters cannot communicate, it is possible to use this command to select both
clusters as the winning cluster (conflicting detach). In a conflicting detach, both clusters
resume I/O independently.

When the inter-cluster link heals in such a situation, manual intervention is required to
pick a winning cluster. The data image of the winning cluster will be used to make the
clusters consistent again. Any changes at the losing cluster during the link outage will be
discarded.

Do not use this command to specify more than one cluster as the winner.

Example Select cluster-2 as the winner for consistency group TestCG:

VPlexcli:/clusters/cluster-2/consistency-groups/TestCG> choose-winner --cluster cluster-2

WARNING: This can cause data divergence and lead to data loss. Ensure the other cluster is not
serving I/O for this consistency group before continuing. Continue? (Yes/No) Yes

In the following example:

◆ The two ls commands show an asynchronous consistency group “cg1” when an
inter-cluster link outage has occurred.
The detach-rule is 'no-automatic-winner', so I/O stops at both clusters, the status
summary is 'suspended' (showing that I/O has stopped), and the status details
contain 'cluster-departure', indicating that I/O has stopped because the clusters can
no longer communicate with one another.
◆ The choose winner command forces cluster-1 to detach cluster-2.
◆ The ls command displays the change at cluster-1.
Cluster-1 status is 'suspended, requires-resume-after-rollback.
Cluster-2, is still suspended, cluster-departure.
Cluster-1 is the winner, so it 'detached' cluster-2, but has rolled back its view of the
data to the last consistent point*.
I/O at cluster-1 remains suspended, waiting for the administrator to issue the
consistency-group resume-after-rollback command.
*Rollback is applicable only to asynchronous consistency groups.
VPlexcli:/clusters/cluster-1/consistency-groups/cg1> ls

Attributes:
Name Value
------------------- ----------------------------------------------------------
active-clusters [cluster-1, cluster-2]
cache-mode asynchronous
detach-rule no-automatic-winner
operational-status [(cluster-1,{ summary:: suspended, details::
[cluster-departure, rebuilding-across-clusters,
restore-link-or-choose-winner] }), (cluster-2,{ summary::
suspended, details:: [cluster-departure,
rebuilding-across-clusters, restore-link-or-choose-winner]
passive-clusters []

170 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

recoverpoint-enabled false
storage-at-clusters [cluster-1, cluster-2]
virtual-volumes [dd1_vol, dd2_vol]
visibility [cluster-1, cluster-2]

Contexts:
advanced recoverpoint

VPlexcli:/clusters/cluster-1/consistency-groups/cg1> choose-winner -c cluster-1

WARNING: This can cause data divergence and lead to data loss. Ensure the other cluster is not
serving I/O for this consistency group before continuing. Continue? (Yes/No) Yes

VPlexcli:/clusters/cluster-1/consistency-groups/cg1> ls

Attributes:
Name Value
------------------- ----------------------------------------------------------
active-clusters [cluster-1, cluster-2]
cache-mode asynchronous
detach-rule no-automatic-winner
operational-status [(cluster-1,{ summary:: suspended, details::
[requires-resume-after-rollback] }),
(cluster-2,{ summary:: suspended, details:: [cluster-departure]
passive-clusters []
recoverpoint-enabled false
storage-at-clusters [cluster-1, cluster-2]
virtual-volumes [dd1_vol, dd2_vol]
visibility [cluster-1, cluster-2]

Contexts:
advanced recoverpoint

See also ◆ consistency-group resume-after-data-loss-failure

◆ consistency-group resume-after-rollback
◆ consistency-group resume-at-loser
◆ consistency-group summary
◆ EMC VPLEX Administration Guide

consistency-group create
Creates and names an empty consistency group.

Contexts All contexts.

In /clusters/cluster-n/consistency-groups/group-name context, command is create.

Syntax consistency-group create

[-n|--name]consistency-group name
[-c|--cluster] cluster

Arguments [-n|--name] consistency-group name - * Name of the new consistency group. Must be
unique within a cluster. Name conflicts across clusters can be resolved by changing the
name later using the set name command.
[-c|--cluster] cluster - Context path of the cluster at which to create the consistency group.
If the current context is a cluster or below, that cluster is the default. Otherwise, this
argument is required.

consistency-group create 171

VPLEX CLI Command Descriptions

* - argument is positional.

Description Creates and names an empty consistency group.

A maximum of 1024 consistency groups with synchronous cache mode can be configured.
A maximum of 16 consistency groups with asynchronous cache mode can be configured.
Each consistency group can contain up to 1000 virtual volumes.
All consistency groups have configurable properties that determine I/O behavior,
including:
◆ cache mode - synchronous or asynchronous. Default is synchronous. Modified using
the set command.
◆ visibility - determines which clusters know about a consistency group. Default is only
to the cluster where the consistency group was created. Modified using the set
command.
◆ storage-at-clusters - tells VPLEX at which cluster the physical storage associated with a
consistency group is located. Modified using the set command.
◆ local-read-override - whether the volumes in this consistency group use the local read
override optimization. Default is true. Modified using the set command.
◆ detach-rule - determines the winning cluster when there is an inter-cluster link outage.
Modified using the consistency-group set-detach-rule active-cluster-wins,
consistency-group set-detach-rule no-automatic-winner, and consistency-group
set-detach-rule winner commands.
◆ auto-resume-at-loser - whether the loser automatically resumes I/O when the
inter-cluster link is repaired after a failure. Default is false. Modified using the set
command in
/clusters/cluster/consistency-groups/consistency-group-name/advanced context.
◆ virtual-volumes - member volumes of the consistency group. Modified using the
consistency-group add-virtual-volumes and consistency-group
remove-virtual-volumes commands.
◆ recoverpoint-enabled - allows the consistency group to be used in conjunction with
RecoverPoint. Default is false. Modified using the set command.

IMPORTANT
When enabling or disabling RecoverPoint for a consistency group, the RecoverPoint cluster
may not note the change for 2 minutes. Wait for 2 minutes between setting or changing
the recoverpoint-enabled property before creating or changing a RecoverPoint consistency
group.

Additional configurable properties are applicable only to consistency groups with

asynchronous cache mode, including:
◆ default closeout-time - default for the maximum time a delta remains open to accept
new writes. Default is 30 seconds. Modified using the set command
◆ maximum-queue-depth - configures the maximum possible depth of the delta
processing queues. Default is 6. Modified using the set command.

172 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Refer to the EMC VPLEX Administration Guide for more information about the consistency
group properties.

Example In the following example,

◆ The ls /clusters/*/consistency-groups/ command displays the names of all
consistency groups in both clusters.
◆ The consistency-group create command creates an empty synchronous consistency
group “TestCG”.
◆ The ls command in consistency group context displays the new name. The ls TestCG
command displays details about the new consistency group.

Note: Refer to the EMC VPLEX Administration Guide for a description of the fields in the
following examples.

VPlexcli:/> ls /clusters/*/consistency-groups/

/clusters/cluster-1/consistency-groups:
test10 test11 test12 test13 test14
test15 test16 test5 test6 test7 test8
test9 vs_RAM_c1wins vs_RAM_c2wins vs_oban005 vs_sun190

/clusters/cluster-2/consistency-groups:
.
.
.
VPlexcli:/> cd /clusters/cluster-1/consistency-groups/

VPlexcli:/clusters/cluster-1/consistency-groups> consistency-group create --name TestCG

--cluster cluster-1

VPlexcli:/clusters/cluster-1/consistency-groups> ls
TestCG test10 test11 test12 test13
test14 test15 test16 test5 test6
test7 test8 test9 vs_RAM_c1wins vs_RAM_c2wins
vs_oban005 vs_sun190

VPlexcli:/clusters/cluster-1/consistency-groups> ls TestCG

/clusters/cluster-1/consistency-groups/TestCG:

Attributes:
Name Value
------------------- --------------------------------------------
active-clusters []
cache-mode synchronous
detach-rule -
operational-status [(cluster-1,{ summary:: ok, details:: [] })]
passive-clusters []
recoverpoint-enabled true
storage-at-clusters []
virtual-volumes []
visibility [cluster-1]

Contexts:
advanced recoverpoint

See also ◆ consistency-group add-virtual-volumes

◆ consistency-group destroy

consistency-group create 173

VPLEX CLI Command Descriptions

◆ consistency-group remove-virtual-volumes
◆ EMC VPLEX Administration Guide

consistency-group destroy
Destroys the specified empty consistency groups.

Contexts All contexts.

In /clusters/cluster-n/consistency-groups/group-name context, command is destroy.

Syntax consistency-group destroy

[-g|--consistency-group] consistency-group,consistency-group,...
--force

Arguments Required arguments

[-g|--consistency-group] consistency-group, consistency-group, ... - * List of one or more
comma-separated context paths of the consistency groups to destroy.

Optional arguments
[-f|--force] - Force the operation to continue without confirmation. Allows this command to
be run using a non-interactive script.
* - argument is positional.

Description Destroys the specified consistency groups.

All clusters where the consistency group is visible must be operational in order for the
consistency group to be destroyed.
All clusters where the consistency group has storage-at-clusters must be operational in
order for the consistency group to be destroyed.



Before using the consistency-group destroy command on an asynchronous consistency
group, ensure that no host applications are using any member volumes of the
consistency group.

Example Destroy the specified consistency group:

VPlexcli:/clusters/cluster-1/consistency-groups> destroy TestCG
WARNING: The following items will be destroyed:
Context
---------------------------------------------
/clusters/cluster-1/consistency-groups/TestCG

Do you wish to proceed? (Yes/No)

See also ◆ consistency-group create

◆ consistency-group remove-virtual-volumes
◆ EMC VPLEX Administration Guide

174 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

consistency-group list-eligible-virtual-volumes
Displays the virtual volumes that are eligible to be added to a specified consistency group.

Contexts All contexts.

Syntax consistency-group list-eligible-volumes

[-g|consistency-group] consistency-group

Arguments [-g|--consistency-group] consistency-group - The consistency group for which the eligible
virtual volumes shall be listed.
If the current context is a consistency group or is below, a consistency group, that
consistency group is the default.
Otherwise, this argument is required.

Description Displays eligible virtual volumes that can be added to a consistency group. Eligible virtual
volumes:
◆ Must not be a logging volume
◆ Have storage at every cluster in the 'storage-at-clusters' property of the target
consistency group
◆ Are not members of any other consistency group
◆ Have no properties (detach rules, auto-resume) that conflict with those of the
consistency group. That is, detach and resume properties of either the virtual volume
or the consistency group must not be set.

Example List eligible virtual volumes from the target consistency group context:
VPlexcli:/clusters/cluster-1/consistency-groups/TestCG2>
list-eligible-virtual-volumes
[dr1_C12_0000_vol, dr1_C12_0001_vol, dr1_C12_0002_vol,
dr1_C12_0003_vol, dr1_C12_0004_vol, dr1_C12_0005_vol,
dr1_C12_0006_vol, dr1_C12_0007_vol, dr1_C12_0008_vol,
dr1_C12_0009_vol, dr1_C12_0010_vol, dr1_C12_0011_vol,
dr1_C12_0012_vol, dr1_C12_0013_vol, dr1_C12_0014_vol,
dr1_C12_0015_vol, dgc_p2z_test_vol, vmax_DR1_C1_r1_0000_12_vol,
vmax_DR1_C1_r0_0000_12_vol,
.
.
.
List eligible virtual volumes from the root context:
VPlexcli:/> consistency-group list-eligible-virtual-volumes
/clusters/cluster-1/consistency-groups/TestCG2
[dr1_C12_0000_vol, dr1_C12_0001_vol,
dr1_C12_0002_vol,dr1_C12_0003_vol, dr1_C12_0004_vol,
.
.
.

See also ◆ consistency-group add-virtual-volumes

◆ consistency-group remove-virtual-volumes
◆ consistency-group summary
◆ EMC VPLEX Administration Guide

consistency-group list-eligible-virtual-volumes 175

VPLEX CLI Command Descriptions

consistency-group remove-virtual-volumes
Removes one or more virtual volumes from the consistency group.

Contexts All contexts.

In /clusters/cluster-n/consistency-groups/group-name context, command is
remove-virtual-volumes.

Syntax consistency-group remove-virtual-volumes

[-v|--virtual-volumes] virtual-volume,virtual-volume,...
[-g|--consistency-group context path
--force

Arguments Required arguments

[-v|--virtual-volumes] virtual-volume,virtual-volume,... - *Glob pattern or a list of one or
more comma-separated context paths of the virtual volume(s) to remove from the
consistency group.
[-g|--consistency-group] context path - * Context path of the consistency group from which
to remove the specified virtual volume.
If the current context is a consistency-group or is below, then that consistency group is the
default. Otherwise, this argument is required.
--force - Do not ask for confirmation when removing volumes from an asynchronous
consistency group in a VPLEX Geo system. Allows this command to be run using a
non-interactive script.
* - argument is positional.

Description Removes one or more virtual volumes from the consistency group.
If the pattern given to --virtual-volumes argument matches volumes that are not in the
consistency group, the command skips those volumes, and prints a warning message for
each one.



Before using the consistency-group remove-virtual-volumes command on an
asynchronous consistency group, ensure that no host applications are using the volumes
you are removing.

If this is an asynchronous consistency group in a VPLEX Geo system, and one or more of
the volumes being removed is in a storage view, this command asks for confirmation
before proceeding. Volumes removed from an asynchronous group become synchronous,
and an application that is sensitive to the increased I/O latency may experience data loss
or data unavailability.
Best practice is to either:
◆ Remove the volumes from the view, or
◆ Perform the operation when I/O loads are light.
Use the --force argument to suppress the request for confirmation.

176 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

IMPORTANT
When removing virtual volumes from a RecoverPoint-enabled consistency group, the
RecoverPoint cluster may not note the change for 2 minutes. Wait for 2 minutes between
removing virtual volumes from a RecoverPoint-enabled consistency group and creating or
changing a RecoverPoint consistency group.

Example In the following example:

◆ The ls command displays the virtual volumes in consistency group TestCG.
◆ The consistency-group remove-virtual-volumes command removes a specified volume
from the consistency group.
◆ The ls command displays the change.
VPlexcli:/> ls /clusters/cluster-1/consistency-groups/TestCG

/clusters/cluster-1/consistency-groups/TestCG:
------------------------------- ----------------------------------------------
.
.
.
virtual-volumes [dr1_C12_0919_vol, dr1_C12_0920_vol,
dr1_C12_0921_vol, dr1_C12_0922_vol]
visibility [cluster-1, cluster-2]
.
.
.

VPlexcli:/> consistency-group remove-virtual-volumes

/clusters/cluster-1/virtual-volumes/dr1_C12_0920_vol --consistency-group
/clusters/cluster-1/consistency-groups/TestCG

VPlexcli:/> ls /clusters/cluster-1/consistency-groups/TestCG

/clusters/cluster-1/consistency-groups/TestCG:
Name Value
------------------------------- ----------------------------------------------
.
.
.
storage-at-clusters [cluster-1, cluster-2]
synchronous-on-director-failure -
virtual-volumes [dr1_C12_0919_vol, dr1_C12_0921_vol,
dr1_C12_0922_vol]
.
.
.

See also ◆ consistency-group create

◆ consistency-group destroy
◆ EMC VPLEX Administration Guide

consistency-group resolve-conflicting-detach
Select a winning cluster on a consistency group on which there has been a conflicting
detach.

consistency-group resolve-conflicting-detach 177

VPLEX CLI Command Descriptions

Contexts All contexts.

In /clusters/cluster-n/consistency-groups/group-name context, command is
resolve-conflicting-detach.

Syntax consistency-group resolve-conflicting-detach

[-c|--cluster] cluster
[-g|--consistency-group consistency-group
[-f|--force]

Arguments Required arguments

[-c|--cluster] cluster - * The cluster whose data image will be used as the source for
resynchronizing the data images on both clusters.
[-g|--consistency-group] consistency-group - * The consistency group on which to resolve
the conflicting detach.

Optional arguments
[-f|--force] - Do not prompt for confirmation. Allows this command to be run using a
non-interactive script.
* - argument is positional.

Description


This command results in data loss at the losing cluster.

During an inter-cluster link failure, an administrator may permit I/O to continue at both
clusters. When I/O continues at both clusters:
◆ The data images at the clusters diverge.
◆ Legs of distributed volumes are logically separate.
When the inter-cluster link is restored, the clusters learn that I/O has proceeded
independently.
I/O continues at both clusters until the administrator picks a “winning” cluster whose data
image will be used as the source to resynchronize the data images.
Use this command to pick the winning cluster. For the distributed volumes in the
consistency group:
◆ I/O at the “losing” cluster is suspended (there is an impending data change)
◆ The administrator stops applications running at the losing cluster.
◆ Any dirty cache data at the losing cluster is discarded
◆ The legs of distributed volumes rebuild, using the legs at the winning cluster as the
rebuild source.
When the applications at the losing cluster are shut down, use the consistency-group
resume-after-data-loss-failure command to allow the system to service I/O at that cluster
again.

Example Select cluster-1 as the winning cluster for consistency group “TestCG” from the TestCG
context:

178 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

VPlexcli:/clusters/cluster-1/consistency-groups/TestCG> resolve-conflicting-detach
This will cause I/O to suspend at clusters in conflict with cluster cluster-1, allowing you to
stop applications at those clusters. Continue? (Yes/No) yes

Select cluster-1 as the winning cluster for consistency group “TestCG” from the root
context:
VPlexcli:/> consistency-group resolve-conflicting-detach --cluster cluster-1
--consistency-group /clusters/cluster-1/consistency-groups/TestCG
This will cause I/O to suspend at clusters in conflict with cluster cluster-1, allowing you to
stop applications at those clusters. Continue? (Yes/No) Yes

In the following example, I/O has resumed at both clusters during an inter-cluster link
outage. When the inter-cluster link is restored, the two clusters will come back into contact
and learn that they have each detached the other and carried on I/O.
◆ The ls command shows the operational-status as ‘ok,
requires-resolve-conflicting-detach’ at both clusters.
◆ The resolve-conflicting-detach command selects cluster-1 as the winner.
Cluster-2 will have its view of the data discarded.
I/O is suspended on cluster-2.
◆ The ls command displays the change in operational status.
• At cluster-1, I/O continues, and the status is ‘ok’.
• At cluster-2, the view of data has changed and so I/O is suspended pending the
consistency-group resume-at-loser command.
VPlexcli:/clusters/cluster-1/consistency-groups/cg1> ls

Attributes:
Name Value
-------------------- -----------------------------------------
active-clusters [cluster-1, cluster-2]
cache-mode asynchronous
detach-rule no-automatic-winner
operational-status [(cluster-1,{ summary:: ok, details::
[requires-resolve-conflicting-detach] }),
(cluster-2,{ summary:: ok, details::
[requires-resolve-conflicting-detach] })]
passive-clusters []
recoverpoint-enabled false
storage-at-clusters [cluster-1, cluster-2]
virtual-volumes [dd1_vol, dd2_vol]
visibility [cluster-1, cluster-2]

Contexts:
advanced recoverpoint

VPlexcli:/clusters/cluster-1/consistency-groups/cg1> resolve-conflicting-detach -c cluster-1

This will cause I/O to suspend at clusters in conflict with cluster cluster-1, allowing you to
stop applications at those clusters. Continue? (Yes/No) Yes

VPlexcli:/clusters/cluster-1/consistency-groups/cg1> ls

Attributes:
Name Value
------------------- ----------------------------------------------------------
active-clusters [cluster-1, cluster-2]
cache-mode asynchronous
detach-rule no-automatic-winner

consistency-group resolve-conflicting-detach 179

VPLEX CLI Command Descriptions

operational-status [(cluster-1,{ summary:: ok, details:: [] }),

(cluster-2,{ summary:: suspended, details:: [requires-resume-at-loser] })]
passive-clusters []
recoverpoint-enabled false
storage-at-clusters [cluster-1, cluster-2]
virtual-volumes [dd1_vol, dd2_vol]
visibility [cluster-1, cluster-2]

Contexts:
advanced recoverpoint

See also ◆ consistency-group resume-after-data-loss-failure

◆ consistency-group resume-at-loser
◆ EMC VPLEX Administration Guide

consistency-group resume-after-data-loss-failure
Resumes I/O on an asynchronous consistency group when there are data loss failures.

Contexts All contexts.

In /clusters/cluster-n/consistency-groups/group-name context, command is
resume-after-data-loss.

Syntax consistency-group resume-after-data-loss-failure

[-c|--cluster] cluster
[-g|--consistency-group context path
[-f|--force]

Arguments Required arguments

[-c|--cluster] cluster - * The winning cluster, whose data image is used as the base for
resuming I/O.
[-g|--consistency-group] context path - * The consistency group on which to resolve the
data loss failure.

Optional arguments
[-f|--force] - Do not prompt for confirmation. Allows this command to be run using a
non-interactive script.
* - argument is positional.

Description In the event of multiple near-simultaneous director failures, or a director failure followed
very quickly by an inter-cluster link failure, an asynchronous consistency group may
experience data loss. I/O automatically suspends on the volumes in the consistency
group at all participating clusters.
Use this command to resume I/O. Specifically, this command:
◆ Selects a winning cluster whose current data image will be used as the base from
which to continue I/O.
◆ On the losing cluster, synchronizes the data image with the data image on the winning
cluster.
◆ Resumes I/O at both clusters.

180 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

This command may make the data loss larger, because dirty data at the losing cluster may
be discarded.
All the clusters participating in the consistency group must be present in order to use this
command.
If there has been no data-loss failure in the group, this command prints an error message
and does nothing.

Example Select the leg at cluster-1 as the source image to synchronize data for virtual volumes in
consistency group “TestCG” (from root context):
VPlexcli:/> consistency-group resume-after-data-loss-failure --cluster cluster-1
--consistency-group /clusters/cluster-1/consistency-groups/TestCG

Data may be discarded at clusters other than cluster-1. Continue? (Yes/No) Yes

Perform the same task from the specific consistency group context:
VPlexcli:/clusters/cluster-1/consistency-groups/TestCG> resume-after-data-loss-failure
--cluster cluster-1

Data may be discarded at clusters other than cluster-1. Continue? (Yes/No) Yes

In the following example, the auto-resume-at-loser property of the consistency group is

set to true; that is I/O automatically resumes on the losing cluster when connectivity is
restored.
◆ The ls command displays the operational status of a consistency group where
cluster-2 is the winner (detach-rule is winner) after multiple failures at the same time
have caused a data loss. The cluster-1 side of the consistency group is suspended.
◆ The resume-after-data-loss-failure command selects cluster-1 as the source image
from which to re-synchronize data.
◆ After a short wait, the ls command displays that the cluster-1 side of the consistency
group is no longer suspended:
VPlexcli:/clusters/cluster-1/consistency-groups/CG1> ls

Attributes:
Name Value
------------------- ----------------------------------------------------------
active-clusters [cluster-1, cluster-2]
cache-mode synchronous
detach-rule winner cluster-2 after 5s
operational-status [suspended, requires-resume-after-data-loss-failure]
passive-clusters []
recoverpoint-enabled false
storage-at-clusters [cluster-1, cluster-2]
virtual-volumes DR1_RAM_c2win_lr1_36_vol, DR1_RAM_c2win_lr1_16_vol,
DR1_RAM_c2win_lr0_6_vol, DR1_RAM_c2win_lrC_46_vol,
.
.
.
VPlexcli:/clusters/cluster-1/consistency-groups/CG1> resume-after-data-loss-failure -f -c
cluster-1

VPlexcli:/clusters/cluster-1/consistency-groups/CG1> ls

Attributes:
Name Value
------------------- ----------------------------------------------------------

consistency-group resume-after-data-loss-failure 181

VPLEX CLI Command Descriptions

active-clusters [cluster-2]
cache-mode synchronous
detach-rule winner cluster-2 after 5s
operational-status [ok]
passive-clusters [cluster-1]
recoverpoint-enabled false
storage-at-clusters [cluster-1, cluster-2]
virtual-volumes DR1_RAM_c2win_lr1_36_vol, DR1_RAM_c2win_lr1_16_vol,
DR1_RAM_c2win_lr0_6_vol, DR1_RAM_c2win_lrC_46_vol,
.
.
.
In the following example, the auto-resume-at-loser property of the consistency group is
set to false; that is I/O remains suspended on the losing cluster when connectivity is
restored. I/O must be manually resumed.
◆ The ls command displays the operational status of a consistency group where
cluster-1 is the winner (detach-rule is winner) after multiple failures at the same time
have caused a data loss. The cluster-1 side of the consistency group is suspended.
◆ The resume-after-data-loss-failure command selects cluster-2 as the source image
from which to re-synchronize data.
◆ After a short wait, the ls command displays that the cluster-1 side of the consistency
group remains suspended:
VPlexcli:/clusters/cluster-1/consistency-groups/CG2> ls

Attributes:
Name Value
------------------- ----------------------------------------------------------
active-clusters []
cache-mode synchronous
detach-rule winner cluster-1 after 5s
operational-status [suspended, requires-resume-after-data-loss-failure]
passive-clusters [cluster-1, cluster-2]
recoverpoint-enabled false
storage-at-clusters [cluster-1, cluster-2]
virtual-volumes DR1_RAM_c2win_lr1_7_vol, DR1_RAM_c2win_lr0_37_vol,
DR1_RAM_c2win_lr0_27_vol, DR1_RAM_c2win_lr1_27_vol,
DR1_RAM_c2win_lrC_17_vol, DR1_RAM_c2win_lr0_17_vol,
.
.
.
VPlexcli:/clusters/cluster-1/consistency-groups/CG2> resume-after-data-loss-failure -f -c
cluster-2

VPlexcli:/clusters/cluster-1/consistency-groups/CG2> ll

Attributes:
Name Value
------------------- ----------------------------------------------------------
active-clusters [cluster-2]
cache-mode synchronous
detach-rule winner cluster-1 after 5s
operational-status [suspended]
passive-clusters [cluster-1]
recoverpoint-enabled false
storage-at-clusters [cluster-1, cluster-2]
virtual-volumes DR1_RAM_c2win_lr1_7_vol, DR1_RAM_c2win_lr0_37_vol,
DR1_RAM_c2win_lr0_27_vol, DR1_RAM_c2win_lr1_27_vol,
DR1_RAM_c2win_lrC_17_vol, DR1_RAM_c2win_lr0_17_vol,
.
.
.

182 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

See also ◆ consistency-group resume-after-rollback

◆ EMC VPLEX Administration Guide

consistency-group resume-after-rollback
Resume I/O to the volumes on the winning cluster in a consistency group after:
◆ The losing clusters have been detached, and
◆ Data has been rolled back to the last point at which all clusters had a consistent view.



In a Geo configuration, on a cluster that successfully vaulted and unvaulted, the user
should contact EMC Engineering for assistance before rolling back the data prior to
re-establishing communication with the non-vaulting cluster.

Contexts All contexts.

In /clusters/cluster-n/consistency-groups/group-name context, command is
resume-after-rollback.

Syntax consistency-group resume-after-rollback

[-g|--consistency-group context path
[-f|--force]

Arguments Required arguments

[-g|--consistency-group] context path - * The consistency group on which to resume I/O at
the winning cluster.

Optional arguments
[-f|--force] - Do not prompt for confirmation. Allows this command to be run using a
non-interactive script.
* - argument is positional.

Description


This command addresses data unavailability but will cause data loss.

This command is part of a two-step recovery procedure to allow I/O to continue in spite of
an inter-cluster link failure.
1. Use the consistency-group choose-winner command to select the winning cluster.
2. Use this command to tell the winning cluster to roll back its data image to the last
point where the clusters were known to agree, and then proceed with I/O.
The first step in the recovery procedure can be automated by setting a detach-rule-set.
The second step is required only if the losing cluster has been “active” -that is, writing to
volumes in the consistency group since the last time the data images were identical at the
clusters.

consistency-group resume-after-rollback 183

VPLEX CLI Command Descriptions

If the losing cluster is active, the distributed cache at the losing cluster contains dirty data,
and without that data, the winning cluster's data image is inconsistent. Resuming I/O at
the winner requires rolling back the winner's data image to the last point where the
clusters agreed.
Applications may experience difficulties if the data changes, so the roll-back and
resumption of I/O is not automatic.
The delay gives the administrator the chance to halt applications. The administrator then
uses this command start the rollback roll-back in preparation for resuming I/O.
The winning cluster rolls back its data image to the last point at which the clusters had the
same data images, and then allows I/O to resume at that cluster.
At the losing cluster, I/O remains suspended.
When the inter-cluster link is restored, I/O remains suspended at the losing cluster, unless
the 'auto-resume' flag is set to 'true'.

Example Resume I/O on the cluster-2 leg of virtual volumes in consistency group TestCG:
VPlexcli:/clusters/cluster-2/consistency-groups/TestCG> resume-after-rollback

This will change the view of data at cluster cluster-2, so you should ensure applications are
stopped at that cluster. Continue? (Yes/No) Yes

In the following example:

◆ The consistency-group choose-winner command declares cluster-1 the winning cluster
during an inter-cluster link outage.
◆ The ls command displays a consistency group.
The consistency group is asynchronous, so I/O remains suspended, and requires
rollback to the last point where data on the two clusters was the same.
◆ The resume-after-rollback command rolls back the data image on cluster-1 to the last
point where the clusters were known to agree, and then proceeds with I/O.
◆ The ls command shows that the operational status for the consistency group on
cluster-1 is now 'ok. On cluster-2, the operational status is still suspended,
cluster-departure.
When the inter-cluster link heals, cluster-2 will discover that cluster-1 continued
servicing I/O without it. Cluster-2 must change its view of data. Operational status is
‘suspended, requires-resume-at-loser'
VPlexcli:/clusters/cluster-1/consistency-groups/cg1> choose-winner -c cluster-1
WARNING: This can cause data divergence and lead to data loss. Ensure the other cluster is not
serving I/O for this consistency group before continuing. Continue? (Yes/No) Yes

VPlexcli:/clusters/cluster-1/consistency-groups/cg1> ls

Attributes:
Name Value
------------------- ----------------------------------------------------------
active-clusters [cluster-1, cluster-2]
cache-mode asynchronous
detach-rule no-automatic-winner
operational-status [cluster-departure, rebuilding-across-clusters,
restore-link-or-choose-winner] }), (cluster-2,{ summary::
suspended, details:: [cluster-departure,

184 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

rebuilding-across-clusters, restore-link-or-choose-winner]
passive-clusters []
recoverpoint-enabled false
storage-at-clusters [cluster-1, cluster-2]
virtual-volumes [dd1_vol, dd2_vol]
visibility [cluster-1, cluster-2]

Contexts:
advanced recoverpoint

VPlexcli:/clusters/cluster-1/consistency-groups/cg1> resume-after-rollback
This will change the view of data at cluster cluster-1, so you should ensure applications are
stopped at that cluster. Continue? (Yes/No) Yes

VPlexcli:/clusters/cluster-1/consistency-groups/cg1> ls

Attributes:
Name Value
------------------- ----------------------------------------------------------
active-clusters [cluster-1, cluster-2]
cache-mode asynchronous
detach-rule no-automatic-winner
operational-status [(cluster-1,{ summary:: ok, details:: [] }),
(cluster-2,{ summary:: suspended, details:: [cluster-departure] })]
passive-clusters []
recoverpoint-enabled false
storage-at-clusters [cluster-1, cluster-2]
virtual-volumes [dd1_vol, dd2_vol]
visibility [cluster-1, cluster-2]

Contexts:
advanced recoverpoint

See also ◆ consistency-group choose-winner

◆ consistency-group resume-at-loser
◆ EMC VPLEX Administration Guide

consistency-group resume-at-loser
If I/O is suspended due to a data change, resumes I/O at the specified cluster and
consistency group.

Contexts All contexts (at the losing cluster).

In /clusters/cluster-n/consistency-groups/group-name context, command is
resume-at-loser.

Syntax consistency-group resume-at-loser

[-c|--cluster] cluster
[-s|--consistency-group] consistency-group
[-f|--force]

Arguments Required arguments

[-c|--cluster] cluster - * The cluster on which to roll back and resume I/O.
[-g|--consistency-group] consistency-group - * The consistency group on which to
resynchronize and resume I/O.

consistency-group resume-at-loser 185

VPLEX CLI Command Descriptions

Optional arguments
[-f|--force] - Do not prompt for confirmation. Without this argument, the command asks for
confirmation to proceed. This protects against accidental use while applications are still
running at the losing cluster which could cause applications to misbehave. Allows the
command to be executed from a non-interactive script.
* - argument is positional.

Description During an inter-cluster link failure, an administrator may permit I/O to resume at one of the
two clusters: the “winning” cluster.
I/O remains suspended on the “losing” cluster.
When the inter-cluster link heals, the winning and losing clusters re-connect, and the
losing cluster discovers that the winning cluster has resumed I/O without it.
Unless explicitly configured otherwise (using the auto-resume-at-loser property), I/O
remains suspended on the losing cluster. This prevents applications at the losing cluster
from experiencing a spontaneous data change.
The delay allows the administrator to shut down applications.
After stopping the applications, the administrator can use this command to:
◆ Resynchronize the data image on the losing cluster with the data image on the winning
cluster,
◆ Resume servicing I/O operations.
The administrator may then safely restart the applications at the losing cluster.
Without the '--force' option, this command asks for confirmation to proceed, since its
accidental use while applications are still running at the losing cluster could cause
applications to misbehave.

Example
VPlexcli:/clusters/cluster-2/consistency-groups/TestCG> resume-at-loser
This may change the view of data presented to applications at cluster cluster-2. You should
first stop applications at that cluster. Continue? (Yes/No) Yes

In the following example:

◆ The ls command shows consistency group cg1 as ‘suspended,
requires-resume-at-loser’ on cluster-2 after cluster-2 is declared the losing cluster
during an inter-cluster link failure.
◆ The resume-at-loser command restarts I/O on cluster-2.
◆ The ls command displays the change in operational status:
VPlexcli:/clusters/cluster-1/consistency-groups/cg1> ls

Attributes:
Name Value
------------------- ----------------------------------------------------------
active-clusters [cluster-1, cluster-2]
cache-mode asynchronous
detach-rule no-automatic-winner
operational-status [(cluster-1,{ summary:: ok, details:: [] }),
(cluster-2,{ summary:: suspended, details:: [requires-resume-at-loser] })]
passive-clusters []

186 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

recoverpoint-enabled false
storage-at-clusters [cluster-1, cluster-2]
virtual-volumes [dd1_vol, dd2_vol]
visibility [cluster-1, cluster-2]

Contexts:
advanced recoverpoint

VPlexcli:/clusters/cluster-1/consistency-groups/cg1> resume-at-loser -c cluster-2

This may change the view of data presented to applications at cluster cluster-2. You should
first stop applications at that cluster. Continue? (Yes/No) Yes

VPlexcli:/clusters/cluster-1/consistency-groups/cg1> ls

Attributes:
Name Value
------------------- ----------------------------------------------------------
active-clusters [cluster-1, cluster-2]
cache-mode asynchronous
detach-rule no-automatic-winner
operational-status [(cluster-1,{ summary:: ok, details:: [] }),
(cluster-2,{ summary:: ok, details:: [] })]
passive-clusters []
recoverpoint-enabled false
storage-at-clusters [cluster-1, cluster-2]
virtual-volumes [dd1_vol, dd2_vol]
visibility [cluster-1, cluster-2]

Contexts:
advanced recoverpoint

See also ◆ consistency-group choose-winner

◆ consistency-group resume-after-rollback
◆ EMC VPLEX Administration Guide

consistency-group set-detach-rule active-cluster-wins

Sets or changes the detach-rule for one or more asynchronous consistency groups to
“active-cluster-wins”.

Contexts All contexts.

In /clusters/cluster-n/consistency-groups/group-name context, command is
set-detach-rule active-cluster-wins.

Syntax consistency-group set-detach-rule active-cluster-wins

[-g|--consistency-group] consistency-group,consistency-group,...
[-f|--force]

Required arguments [-g|--consistency-group] consistency-group, consistency-group, ... - The consistency

groups on which to apply the active-cluster-wins detach rule.

Optional arguments [-f|--force] - Force the operation to continue without confirmation. Allows this command to
be run from non-interactive scripts. This option available in Release 5.1 and later.

Description Applies the “active-cluster-wins” detach rule to one or more specified consistency groups.

Note: This command requires user confirmation unless the --force argument is used.

consistency-group set-detach-rule active-cluster-wins 187

VPLEX CLI Command Descriptions

In the event of a cluster failure or departure, this rule-set will result in I/O continuing only
on the cluster that last received I/O. I/O will be suspended at all other clusters. If VPLEX
Witness is deployed, it will override this setting (on synchronous consistency-groups only)
if the last-active cluster has failed.
The applicable detach rule varies depending on the visibility, storage-at-clusters, and
cache mode properties of the consistency group. Table 10 lists the applicable detach rules
for various combinations of visibility, storage-at-clusters, and cache-mode.

Table 10 Consistency group detach rules

Visibility Storage-at-clusters Cache-mode Applicable detach rules

cluster-1 cluster-1 synchronous N/A

cluster-1 and cluster-2 cluster-1 and synchronous no-automatic-winner,

cluster-2 winner cluster-1
winner cluster-2

cluster-1 and cluster-2 cluster-1 synchronous no-automatic-winner,

winner cluster-1

cluster-1 and cluster-2 cluster-1 and asynchronous no-automatic-winner

cluster-2 active-cluster-wins

IMPORTANT
When RecoverPoint is deployed, it may take up to 2 minutes for the RecoverPoint cluster to
take note of changes to a VPLEX consistency group. Wait for 2 minutes after changing the
detach rule for a VPLEX consistency group before creating or changing a RecoverPoint
consistency group.

Example Set the detach-rule for a single asynchronous consistency group from the group’s context:
VPlexcli:/clusters/cluster-1/consistency-groups/TestCG> set-detach-rule active-cluster-wins

Set the detach-rule for two asynchronous consistency groups from the root context:
VPlexcli:/> consistency-group set-detach-rule active-cluster-wins -g
/clusters/cluster-1/consistency-groups/TestCG,/clusters/cluster-1/consistency -groups/TestCG2

See also ◆ consistency-group set-detach-rule no-automatic-winner

◆ consistency-group set-detach-rule winner
◆ EMC VPLEX Administration Guide

consistency-group set-detach-rule no-automatic-winner

Sets or changes the detach-rule for one or more asynchronous consistency groups to
“no-automatic-winner”.

Contexts All contexts.

In /clusters/cluster-n/consistency-groups/group-name context, command is
set-detach-rule no-automatic-winner.

188 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Syntax consistency-group set-detach-rule no-automatic-winner

[-g|--consistency-group] consistency-group,
consistency-group,...
[-f|--force]

Required arguments [-g|--consistency-group] consistency-group, consistency-group, ... - The consistency

groups on which to apply the no-automatic-winner detach rule.

Optional arguments [-f|--force] - Force the operation to continue without confirmation. Allows this command to
be run from non-interactive scripts.

Description Applies the no-automatic-winner detach rule to one or more specified consistency groups.

Note: This command requires user confirmation unless the --force argument is used.

This detach rule dictates no automatic detaches occur in the event of an inter-cluster link
failure.
Applicable to both asynchronous and synchronous consistency groups.
In the event of a cluster failure or departure, this rule-set will result in I/O being
suspended at all clusters whether or not VPLEX Witness is deployed. To resume I/O, use
either the consistency-group choose-winner or consistency-group resume-after-rollback
commands to designate the winning cluster.

IMPORTANT
When RecoverPoint is deployed, it may take up to 2 minutes for the RecoverPoint cluster to
take note of changes to a VPLEX consistency group. Wait for 2 minutes after changing the
detach rule for a VPLEX consistency group before creating or changing a RecoverPoint
consistency group.

See Table 10, “Consistency group detach rules,”

Example Set the detach-rule for a single consistency group from the group’s context:
VPlexcli:/clusters/cluster-1/consistency-groups/TestCG> set-detach-rule no-automatic-winner

Set the detach-rule for two consistency groups from the root context:
VPlexcli:/> consistency-group set-detach-rule no-automatic-winner -g
/clusters/cluster-1/consistency-groups/TestCG,/clusters/cluster-1/consistency -groups/TestCG2

See also ◆ consistency-group choose-winner

◆ consistency-group resume-after-rollback
◆ consistency-group set-detach-rule active-cluster-wins
◆ consistency-group set-detach-rule winner
◆ EMC VPLEX Administration Guide

consistency-group set-detach-rule winner

Sets the detach-rule for one or more synchronous consistency groups to winner. The
specified cluster becomes the winner after the specified number of seconds.

consistency-group set-detach-rule winner 189

VPLEX CLI Command Descriptions

Contexts All contexts.

In /clusters/cluster-n/consistency-groups/group-name context, command is
set-detach-rule winner.

Syntax consistency-group set-detach-rule winner

[-c|--cluster] cluster-id
[-d|--delay] seconds
[-g|--consistency-group] consistency-group,
consistency-group,...
[-f|--force]

Required arguments [-c|--cluster] cluster-id - The cluster that will be the winner in the event of an inter-cluster
link failure.
[-d|--delay] seconds - The number of seconds after an inter-cluster link fails before the
winning cluster detaches. Valid values for the delay timer are:
0 - Detach occurs immediately after the failure is detected.
number - Detach occurs after the specified number of seconds have elapsed. There is
no practical limit to the number of seconds, but delays longer than 30 seconds won't
allow I/O to resume quickly enough to avoid problems with most host applications.

Optional arguments [-g|--consistency-group] consistency-group, consistency-group, ... - The consistency

groups on which to apply the winner detach rule.
[-f|--force] - Force the operation to continue without confirmation. Allows this command to
be run from non-interactive scripts.

Description Applies the winner detach rule to one or more specified synchronous consistency groups.

Note: This command requires user confirmation unless the --force argument is used.

In the event of a cluster failure or departure, this rule-set will result in I/O continuing on
the selected cluster only. I/O will be suspended at all other clusters. If VPLEX Witness is
deployed it will override this selection (on synchronous consistency-groups only) if the
selected cluster has failed.
Applicable only to synchronous consistency groups.

IMPORTANT
When RecoverPoint is deployed, it may take up to 2 minutes for the RecoverPoint cluster to
take note of changes to a VPLEX consistency group. Wait for 2 minutes after changing the
detach rule for a VPLEX consistency group before creating or changing a RecoverPoint
consistency group.

See Table 10, “Consistency group detach rules,”

Example Set the detach-rule for a single consistency group from the group’s context:
VPlexcli:/clusters/cluster-1/consistency-groups/TestCG> set-detach-rule winner --cluster
cluster-1 --delay 5s

Example Set the detach-rule for two consistency groups from the root context:
VPlexcli:/> consistency-group set-detach-rule winner --cluster cluster-1 --delay 5s
--consistency-groups TestCG, TestCG2

190 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

See also ◆ consistency-group set-detach-rule active-cluster-wins

◆ consistency-group set-detach-rule no-automatic-winner
◆ EMC VPLEX Administration Guide

consistency-group summary
Displays a summary of all the consistency groups with a state other than OK.

Contexts All contexts.

Syntax consistency-group summary

Description Displays all the consistency groups with a state other than 'OK' and the consistency
groups at the risk of a rollback.

Example Display a summary of unhealthy consistency groups:

VPlexcli:/> consistency-group summary
1 consistency groups have status not 'OK'.

Consistency Goup Operational Status Status Active Passive

Name ------------------ Detailed Cluster Cluster
------------------ ------------------ ------------- ----------- -----------
GRP3 Suspended

0 consistency groups have risk of roll back.

See also ◆ consistency-group create

◆ consistency-group destroy
◆ EMC VPLEX Administration Guide

date
Displays the current date and time in Coordinated Universal Time (UTC).

Contexts All contexts.

Syntax date

Example VPlexcli:/> date

Tue Jul 20 15:57:55 UTC 2010director ping

describe
Describes the attributes of the given context.

Contexts All contexts with attributes.

consistency-group summary 191

VPLEX CLI Command Descriptions

Syntax describe
[context path]

Arguments Optional arguments

[-c|--context] context path - Context to describe.

Example In the following example, the ll command displays information about a port, and the
describe command with no arguments displays additional information.
VPlexcli:/clusters/cluster-2/exports/ports/P000000003CB001CB-B1-FC01> ll
Name Value
------------------------ ------------------
director-id 0x000000003cb001cb
discovered-initiators []
.
.
.
VPlexcli:/clusters/cluster-2/exports/ports/P000000003CB001CB-B1-FC01> describe
Attribute Description
------------------------ --------------------------------------------------
director-id The ID of the director where the port is exported.
discovered-initiators List of all initiator-ports visible from this port.
.
.
.
Use the describe context command to display information about the specified context:
VPlexcli:/> describe --context /clusters/cluster-2/exports/ports/P000000003CB001CB-B1-FC01
Attribute Description
------------------------------------------------------------------------------------- ----------------
/clusters/cluster-2/exports/ports/P000000003CB001CB-B1-FC01::director-id The ID of the director where the
port is exported.
/clusters/cluster-2/exports/ports/P000000003CB001CB-B1-FC01::discovered-initiators List of all initiator-ports visible
from this port.
.
.
.

device attach-mirror
Attaches a mirror as a RAID 1 child to another (parent) device, and starts a rebuild to
synchronize the mirror.

Contexts All contexts.

Syntax device attach-mirror

[-d|--device] {context path|name}
[-m|--mirror] {context path|name}
[-r|--rule-set] rule-set
[-f|--force]

Arguments Required arguments

[-d|--device] context path or name - * Name or context path of the device to which to attach
the mirror. Does not have to be a top-level device. If the device name is used, verify that
the name is unique throughout the VPLEX, including local devices on other clusters.

Optional arguments
[-m|--mirror] context path or name - * Name or context path of the mirror to detach. Does
not need to be a top-level device. If the name of a device is used, ensure the device name
is not ambiguous, For example, ensure that the same device name is not used by local
devices in different clusters.

192 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

[-r|--rule-set] rule-set - Rule-set to apply to the distributed device that is created when a
mirror is added to a local device.
[-f|--force] - When--force is set, do not ask for confirmation when attaching a mirror. Allows
this command to be run using a non-interactive script.
If the --force argument is not used, prompts for confirmation in two circumstances when
the mirror is remote and the parent device must be transformed into a distributed device:
◆ The rule set that will be applied to the new distributed device potentially allows
conflicting detaches; and
◆ In VPLEX GEO systems, where the parent device already has a volume in a storage
view. The new distributed device will be synchronous. Applications using the volume
may experience greater I/O latency than on the original local device. If an application
is sensitive to this latency, it may experience data unavailability.
* - argument is positional.

Description If the parent device is a RAID 0 or RAID c, it is converted to RAID 1.

If the parent device and mirror device are from different clusters, a distributed-device is
created.
A storage-volume extent cannot be used as a mirror if the parent device is a
distributed-device, or if the parent device is at a different cluster than the storage-volume
extent.
If the --rule-set argument is omitted, VPLEX assigns a default rule-set to the distributed
device as follows:
◆ If the parent device has a volume, the distributed device inherits the rule-set of the
(exported) parent.
◆ If the parent device does not have a volume, the cluster that is local to the
management server is assumed to be the winner.
Once determined, VPLEX displays a notice as to which rule-set the created
distributed-device has been assigned.
When attaching a remote mirror to a local device, or when attaching a new mirror to a
distributed device, both operations require consume slots. Both scenarios result in the
same following error message:
VPlexcli:/clusters/cluster-2/storage-elements/extents> device attach-mirror -d rhyan_dr_test
-m rhyan_mig_src_0000
device attach-mirror: Evaluation of <<device attach-mirror -d dr_test -m mig_src_0000>> failed.
cause: Unable to attach mirror 'mig_src_0000' to device 'dr_test'.
cause: Unable to attach mirror 'mig_src_0000' to distributed Device 'dr_test'.
cause: Firmware command error.
cause: Active metadata device does not have a free slot.

Refer to the troubleshooting section of the VPLEX procedures in the SolVe Desktop for
instructions on increasing the number of slots.

Note: If the RAID 1 device is added to a consistency group, the consistency group’s detach
rule overrides the device’s detach rule.

Use the rebuild status command to display the rebuild’s progress.

device attach-mirror 193

VPLEX CLI Command Descriptions

Example Attach a mirror without specifying a rule-set (allow VPLEX to select the rule-set):
VPlexcli:/clusters/cluster-1/devices> virtual-volume create test_r0c_1
VPlexcli:/clusters/cluster-1/devices> device attach-mirror --device test_r0c_1 --mirror
test_r0c_2
Distributed device 'regression_r0c_1' is using rule-set 'cluster-1-detaches'.

Attach a mirror:
VPlexcli:/> device attach-mirror --device /clusters/cluster-1/devices/site1device0 --mirror
/clusters/cluster-1/devices/site1mirror

See also ◆ consistency-group set-detach-rule winner

◆ device detach-mirror
◆ rebuild status

device collapse
Collapses a one-legged device until a device with two or more children is reached.

Contexts All contexts.

Syntax device collapse

[-d|--device] context [path|name]

Arguments Required arguments

[-d|--device] context path or name -* Name or context path of the device to collapse.
Does not have to be a top-level device. If the device name is used, verify that the name is
unique throughout the VPLEX, including local devices on other clusters.
* - argument is positional.

Description If a RAID 1 device is left with only a single child (after removing other children), use the
device collapse command to collapse the remaining structure. For example:
If RAID 1 device “A” has two child RAID 1 devices “B” and “C”, and child device “C” is
removed, A is now a one-legged device, but with an extra layer of abstraction:
A
|
B
../ \..

Use device collapse to remove this extra layer, and change the structure into:
A
../ \..

Applicable to one-legged devices that are not top-level.

Example VPlexcli:/clusters/cluster-1/devices> device collapse --device

/clusters/cluster-1/devices/A

device detach-mirror
Removes (detaches) a mirror from a RAID-1 device.

194 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Contexts All contexts.

Syntax device detach-mirror

[-d|--device] [context path|name]
[-m|--mirror] [context path|name]
[-s|--slot] slot number
[-i|--discard]
[-f|--force]

Arguments Required arguments

[-d|--device] context path or name - * Name or context path of the device from which to
detach the mirror. Does not have to be a top-level device. If the device name is used, verify
that the name is unique throughout the VPLEX, including local devices on other clusters.

Optional arguments
[-m|--mirror] context path or name - * Name or context path of the mirror to detach. Does
not have to be a top-level device. If the device name is used, verify that the name is
unique throughout the VPLEX, including local devices on other clusters.
[-s|--slot] slot number - Slot number of the mirror to be discarded. Applicable only when
the --discard argument is used.
[-i|--discard] - When specified, discards the detached mirror. The data is not discarded.
[-f|--force] -Force the mirror to be discarded. Must be used when --discard argument is
used. The --force argument is set for detaching an unhealthy
mirror it is discarded even if --discard flag is not set.
* - argument is positional.

Description Use this command to detach a mirror leg from a RAID-1 device.

Virtual volume

Top-level RAID-1 device

Device mirrors

Figure 1 RAID device and virtual volume: before detach mirror

If the RAID device supports a virtual volume, and the --discard argument is not used:
◆ The mirror (child device) is removed from the RAID-1 parent device,
◆ The detached child becomes a top-level device

device detach-mirror 195

VPLEX CLI Command Descriptions

◆ A new virtual-volume is created on top the new device. The name of the new device is
prefixed with the name of the original device.

New virtual volume

is created

Data on the
detached device
is preserved

Figure 2 Devices and virtual volumes: after detach mirror - no discard

If the RAID device supports a virtual volume, and the --discard argument is used:
◆ The mirror (child device) is removed from the RAID-1 parent device
◆ The detached child becomes a top-level device
◆ No new virtual volume is created
◆ The mirror is detached regardless of its current state. Data consistency is not
guaranteed.
◆ In GEO configurations, dirty cache data will not be flushed to the mirror at the time of
issuing the detach operation.
New virtual volume
is created

Figure 3 Devices and virtual volumes: after detach mirror - with discard

Example VPlexcli:/clusters/cluster-1> device detach-mirror --device

/clusters/cluster-1/devices/cluster1device0 --mirror
/clusters/cluster-1/devices/cluster8mirror

Example Identify and detach a dead mirror leg from a distributed device.
In the following example:
◆ The ll command in /distributed-storage/distributed-devices context displays a
stressed distributed device.

196 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ The ll device-name/distributed-device-components command displays the

components of the device (output is truncated)
Note the Slot number of the failed leg in the display.
◆ The device detach-mirror command removes the failed device using the slot number
displayed in the previous step.
◆ The ll command in /distributed-storage/distributed-devices context displays the
change:
VPlexcli:/distributed-storage/distributed-devices> ll
Name Status Operational Health State Auto Rule WOF Transfer
------------------------- ------- Status ----------- Resume Set Group Size
------------------------ ------- ----------- ------------- ------ Name Name --------
------------------ ----- ------- ----------- ------------- ------ ----- ----- --------
ESX_stretched_device running ok ok true colin - 2M
bbv_temp_device running ok ok true colin - 2M
dd_source_device running ok ok true colin - 2M
ddt running ok ok true colin - 2M
dev_test_dead_leg_2 running stressed major-failure - colin - 2M
windows_big_drive running ok ok true colin - 2M
.
.
.
VPlexcli:/distributed-storage/distributed-devices> ll
/dev_test_dead_leg_2_DD/distributed-device-components/

/distributed-storage/distributed-devices/dev_test_dead_leg_2_DD/distributed-device-components
:

Name Cluster Child Fully Operational Health ..

---------------------- ------- Slot Logged Status State....
--------------------- --------- ----- ------ ----------- ------
dev_test_alive_leg_1 cluster-1 1 true ok ok
dev_test_dead_leg_2 cluster-2 0 true error critical-failure

VPlexcli:/distributed-storage/distributed-devices> device detach-mirror --slot 0 --discard

--force --device /distributed-storage/distributed-devices/dev_test_dead_ leg_2

VPlexcli:/distributed-storage/distributed-devices> ll
Name Status Operational Health Auto Rule WOF Transfer
----------------------------- ------- Status State Resume Set Group Size
----------------------------- ------- ----------- ------ ------ Name Name --------
----------------------------- ------- ----------- ------ ------ ----- ----- --------
ESX_stretched_device running ok ok true colin - 2M
bbv_temp_device running ok ok true colin - 2M
dd_source_device running ok ok true colin - 2M
ddt running ok ok true colin - 2M
dev_test_dead_leg_2_DD running ok ok - colin - 2M
windows_big_drive running ok ok true colin - 2M
.
.
.

See also ◆ device attach-mirror

device mirror-isolation auto-unisolation disable

Disables mirror auto-unisolation.

Contexts All contexts.

Syntax device mirror-isolation auto-unisolation disable

[-f|--force]
[-h|--help]

device mirror-isolation auto-unisolation disable 197

VPLEX CLI Command Descriptions

[--verbose]

Arguments Optional arguments

[-f|--force] - Forces the operation to continue without confirmation.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description Mirror isolation provides a mechanism to automatically unisolate mirrors that were
previously isolated. When mirror isolation feature is enabled, disabling mirror
auto-unisolation will prevent the system from automatically unisolating any isolated
mirrors whose underlying storage-volume’s performance is now in the acceptable range.
For the option to manually unisolate the mirror, follow the troubleshooting procedure for
VPLEX in the SolVe Desktop.

Example Shows the result when the command is executed on all clusters when mirror isolation is
disabled:
VPlexcli:/> device mirror-isolation auto-unisolation disable

Mirror isolation provides a mechanism to automatically unisolate mirrors that were previously
isolated. This operation will prevent the system from automatically unisolating the underlying
storage-volumes once their performance is in the acceptable range. You can manually unisolate
the mirror by following the troubleshooting procedure.

Continue to disable auto-unisolation? (Yes/No) y

Auto-unisolation is disabled on clusters cluster-1,cluster-2.

Example Shows the command executed with the --force option, when the mirror-isolation feature is
disabled:
VPlexcli:/> device mirror-isolation auto-unisolation disable -f
Mirror isolation is not enabled on clusters cluster-1,cluster-2.

Mirror isolation provides a mechanism to automatically unisolate mirrors that were previously
isolated. When mirror isolation is enabled, this operation will prevent the system from
automatically unisolating the underlying storage-volumes once their performance is in the
acceptable range. You can manually unisolate the mirror by following the troubleshooting
procedure.

Auto-unisolation is disabled on clusters cluster-1,cluster-2.

Example Shows auto-unisolation was not disabled because the feature is not supported:
VPlexcli:/> device mirror-isolation auto-unisolation disable
Mirror isolation is not enabled on clusters cluster-1,cluster-2.

Mirror isolation provides a mechanism to automatically unisolate mirrors that were previously
isolated. When mirror isolation is enabled, this operation will prevent the system from
automatically unisolating the underlying storage-volumes once their performance is in the
acceptable range. You can manually unisolate the mirror by following the troubleshooting
procedure.

Continue to disable auto-unisolation? (Yes/No) y

device mirror-isolation auto-unisolation disable: Evaluation of <<device mirror-isolation

auto-unisolation disable>> failed.

198 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

cause: Could not disable auto unisolation.

cause: Could not disable auto unisolation.
Modifying auto unisolation is not supported by this version of firmware.

Example Shows auto-unisolation failed because one cluster is not available:

VPlexcli:/> device mirror-isolation auto-unisolation disable
device mirror-isolation auto-unisolation disable: Evaluation of <<device mirror-isolation
auto-unisolation disable>> failed.
cause: Could not disable auto unisolation.
cause: Firmware command error.
cause: communication error recently.

See also ◆ device mirror-isolation auto-unisolation enable

◆ device mirror-isolation disable
◆ device mirror-isolation enable
◆ device mirror-isolation show
◆ EMC VPLEX Administration Guide
◆ EMC VPLEX Procedures in SolVe Desktop

device mirror-isolation auto-unisolation enable

Enables mirror auto-unisolation.

Contexts All contexts.

Syntax device mirror-isolation auto-unisolation enable

[-h|--help]
[--verbose]

Arguments Optional arguments

[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description This command enables auto mirror unisolation.

Mirror isolation provides a mechanism to automatically unisolate mirrors that were
previously isolated. When mirror isolation is enabled, auto-unisolation allows the system
to automatically unisolate the underlying storage-volumes once their performance is in
the acceptable range.

Example Shows auto-unisolation enabled when mirror isolation is disabled on both clusters:
VPlexcli:/> device mirror-isolation auto-unisolation enable
Mirror isolation is not enabled on clusters cluster-1,cluster-2.

Auto-unisolation is enabled on clusters cluster-1,cluster-2.

Example Shows auto-unisolation enabled when mirror isolation is disabled on one of the clusters:
VPlexcli:/> device mirror-isolation auto-unisolation enable

device mirror-isolation auto-unisolation enable 199

VPLEX CLI Command Descriptions

Mirror isolation is not enabled on cluster cluster-2.

Auto-unisolation is enabled on clusters cluster-1,cluster-2.

Example Shows auto-unisolation when mirror isolation is enabled:

VPlexcli:/> device mirror-isolation auto-unisolation enable

Auto-unisolation is enabled on clusters cluster-1,cluster-2.

Example Shows auto-unisolation enable operation failed as the feature is not supported:
VPlexcli:/> device mirror-isolation auto-unisolation enable
Mirror isolation is not enabled on clusters cluster-1,cluster-2.

device mirror-isolation auto-unisolation enable: Evaluation of <<device mirror-isolation

auto-unisolation enable>> failed.
cause: Could not enable auto unisolation.
cause: Could not enable auto unisolation.
Modifying auto unisolation is not supported by this version of firmware.

Example Shows auto-unisolation enable operation failed because one cluster is not available:
VPlexcli:/> device mirror-isolation auto-unisolation enable
device mirror-isolation auto-unisolation enable: Evaluation of <<device mirror-isolation
auto-unisolation enable>> failed.
cause: Could not enable auto unisolation.
cause: Firmware command error.
cause: communication error recently.

Example Shows auto-unisolation enable operation failed because the meta volume is not ready:
VPlexcli:/> device mirror-isolation auto-unisolation enable
device mirror-isolation auto-unisolation enable: Evaluation of <<device mirror-isolation
auto-unisolation enable>> failed.
cause: Could not enable auto unisolation.
cause: Could not enable auto unisolation.
Firmware command error. The active metadata
device is not healthy enough to persist the change fully.

See also ◆ device mirror-isolation auto-unisolation disable

◆ device mirror-isolation disable
◆ device mirror-isolation enable
◆ device mirror-isolation show
◆ EMC VPLEX Administration Guide

device mirror-isolation disable

Disables mirror isolation on the specified clusters.

Contexts All contexts.

Syntax device mirror-isolation disable

200 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

[-c|--clusters]context-path [, context-path...]
[-f|--force]
[-h|--help]
[--verbose]

Arguments Optional arguments

[-c|--clusters] context-path [, context-path...] - Specifies the list of clusters on which to
disable mirror isolation.
[-f|--force] - Forces the operation to continue without confirmation.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description A RAID-1 mirror leg built upon a poorly performing storage volume can bring down the
performance of the whole RAID-1 device and increase IO latencies to the applications
using this device. VPLEX will prevent IOs to such poorly performing mirror legs to improve
the RAID-1 performance. This behavior or feature is known as mirror isolation.
When disabling the mirror isolation feature on one or more clusters, this command prints
a warning and asks for confirmation.

IMPORTANT
This command disables the mirror isolation feature and will prevent VPLEX from improving
the performance of a RAID 1 device containing a poorly performing mirror leg. This
command should only be used if redundancy is desired over RAID 1 performance
improvement.

Example Disable mirror isolation on all clusters:

VPlexcli:/> device mirror-isolation disable
Disabling the mirror isolation feature will prevent VPLEX from improving the performance of a
RAID-1 device containing a poorly performing mirror leg. This command should be only used if
redundancy is desired over RAID-1 performance improvement.

Continue to disable mirror isolation on cluster-1,cluster-2? (Yes/No) Yes

Mirror isolation has been disabled on 'cluster-1'.

Mirror isolation has been disabled on 'cluster-2'.

Example Disable mirror isolation on all clusters without being prompted to confirm:
VPlexcli:/> device mirror-isolation disable -f
WARNING: Disabling the mirror isolation feature will prevent VPLEX from improving the
performance of a RAID-1 device containing a poorly performing mirror leg. This command should
be only used if redundancy is desired over RAID-1 performance improvement.

Mirror isolation has been disabled on 'cluster-1'.

Mirror isolation has been disabled on 'cluster-2'.

Example Disable mirror isolation on one cluster:

VPlexcli:/> device mirror-isolation disable -c cluster-1

device mirror-isolation disable 201

VPLEX CLI Command Descriptions

Disabling the mirror isolation feature will prevent VPLEX from improving the performance of a
RAID-1 device containing a poorly performing mirror leg. This command should be only used if
redundancy is desired over RAID-1 performance improvement.

Continue to disable mirror isolation on cluster-1 (Yes/No) Yes

Mirror isolation has been disabled on 'cluster-1'.

Example Attempt to disable mirror-isolation on the clusters when it is already disabled:

VPlexcli:/> device mirror-isolation disable -f
WARNING: Disabling the mirror isolation feature will prevent VPLEX from improving the
performance of a RAID-1 device containing a poorly performing mirror leg. This command should
be only used if redundancy is desired over RAID-1 performance improvement.

Mirror isolation has been disabled on 'cluster-1'.

Mirror isolation has been disabled on 'cluster-2'.

Example Attempt to disable mirror-isolation on a system where mirror-isolation is not supported:

VPlexcli:/> device mirror-isolation disable -f
WARNING: Disabling the mirror isolation feature will prevent VPLEX from improving the
performance of a RAID-1 device containing a poorly performing mirror
leg. This command should be only used if redundancy is desired over RAID-1 performance
improvement.
device mirror-isolation disable: Evaluation of <<device mirror-isolation disable -f>> failed.
cause: Could not disable mirror isolation on 'cluster-1'.
cause: Firmware command error.
cause: no such command.

Example Attempt to disable mirror-isolation on both clusters and succeeded on cluster 1, but failed
on cluster 2 because the feature is not supported:
VPlexcli:/> device mirror-isolation disable
Disabling the mirror isolation feature will prevent VPLEX from improving the performance of a
RAID-1 device containing a poorly performing mirror leg. This command should be only used if
redundancy is desired over RAID-1 performance improvement.

Continue to disable mirror isolation on cluster-1,cluster-2 (Yes/No) Yes

Mirror isolation has been disabled on 'cluster-1'.

device mirror-isolation disable: Evaluation of <<device mirror-isolation disable>> failed.
cause: Could not disable mirror isolation on 'cluster-2'.
cause: Firmware command error.
cause: invalid subcommand.

See also ◆ device mirror-isolation auto-unisolation disable

◆ device mirror-isolation auto-unisolation enable
◆ device mirror-isolation enable
◆ device mirror-isolation show
◆ EMC VPLEX Administration Guide

202 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

device mirror-isolation enable

Enables mirror isolation on the specified clusters.

Contexts All contexts.

Syntax device mirror-isolation enable

[-c|--clusters] context-path [, context-path...]
[--also-enable-autounisolation]
[-h|--help]
[--verbose]

Arguments Optional arguments

[-c|--clusters] context-path [, context-path...] - Specifies the list of clusters on which to
enable mirror isolation.
[--also-enable-autounisolation] - Enables auto-unisolation if specified.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description A RAID 1 mirror leg built upon a poorly performing storage volume can bring down the
performance of the whole RAID 1 device and increase IO latencies to the applications
using this device. VPLEX will prevent IOs to such poorly performing mirror legs to improve
the RAID 1 performance. This behavior or feature is known as mirror isolation.

Note: This command enables the mirror isolation feature and should only be used if RAID
1performance improvement is desired over redundancy.

Example Enable mirror isolation on all clusters:

VPlexcli:/> device mirror-isolation enable

Mirror isolation has been enabled on 'cluster-1'.

Mirror isolation has been enabled on 'cluster-2'.

Or
VPlexcli:/> device mirror-isolation enable -c *

Mirror isolation has been enabled on 'cluster-1'.

Mirror isolation has been enabled on 'cluster-2'.

Example Enable mirror isolation on one cluster:

VPlexcli:/> device mirror-isolation enable -c cluster-1

Mirror isolation has been enabled on 'cluster-1'.

Example Attempt to enable mirror-isolation on the clusters when it is already enabled:

VPlexcli:/> device mirror-isolation enable

Mirror isolation has been enabled on 'cluster-1'.

device mirror-isolation enable 203

VPLEX CLI Command Descriptions

Mirror isolation has been enabled on 'cluster-2'.

Example Enable mirror-isolation when auto-unisolation is disabled:

VPlexcli:/> device mirror-isolation enable

Mirror isolation has been enabled on 'cluster-1'.

Mirror isolation has been enabled on 'cluster-2'.

Please be aware that auto unisolation is disabled. In order to manually enable this feature you
can use 'device mirror-isolation auto-unisolation enable'.

Example Enable mirror-isolation and auto-unisolation on both clusters:

VPlexcli:/> device mirror-isolation enable --also-enable-autounisolation

Mirror isolation has been enabled on 'cluster-1'.

Mirror isolation has been enabled on 'cluster-2'.

Auto-unisolation is enabled on clusters cluster-1,cluster-2.

Example Attempt to enable mirror-isolation on a system where mirror-isolation is not supported:

VPlexcli:/> device mirror-isolation enable
device mirror-isolation enable: Evaluation of <<device mirror-isolation enable>> failed.
cause: Could not enable mirror isolation on 'cluster-1'.
cause: Firmware command error.
cause: no such command.

Example Attempt to enable mirror-isolation on both clusters and succeeded on cluster 1, but failed
on cluster 2 because the feature is not supported:
VPlexcli:/> device mirror-isolation enable

Mirror isolation has been enabled on 'cluster-1'.

device mirror-isolation disable: Evaluation of <<device mirror-isolation enable>> failed.
cause: Could not enable mirror isolation on 'cluster-2'.
cause: Firmware command error.
cause: invalid subcommand.

See also ◆ device mirror-isolation auto-unisolation disable

◆ device mirror-isolation auto-unisolation enable
◆ device mirror-isolation disable
◆ device mirror-isolation show
◆ EMC VPLEX Administration Guide

device mirror-isolation show

Lists the configuration parameters related to mirror isolation for the specified clusters.

204 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Contexts All contexts.

Syntax device mirror-isolation show

[-c|--clusters] context-path [, context-path...]
[-h|--help]
[--verbose]

Arguments Optional arguments

[-c|--clusters] context-path [, context-path...] - Specifies the list of clusters on which to
show mirror isolation configuration parameters.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description Used to display all the configuration parameters related to mirror isolation for the
specified clusters.
The current configuration parameters supported are:

Enabled Indicates "true" if the feature is enabled, "false" if disabled and "<not
available>" if the value could not be retrieved.

Auto Unisolation Indicates “true” if the system will automatically unisolate an isolated mirror
when the underlying storage-volume’s performance is in the acceptable range,
“false” if manual unisolation was desired, and “<not available>” if the value
could not be retrieved.

Isolation Indicates the isolation sweep interval in seconds if the value was retrieved
Interval successfully, and "<not available>" if the value could not be retrieved.

Unisolation Indicates the unisolation sweep interval in seconds if the value was retrieved
interval successfully, and "<not available>" if the value could not be retrieved.

If a value for any configuration parameter cannot be retrieved for the cluster, it may be
because the feature is not supported or there was a command failure.

Example Shows the mirror isolation configuration parameters on all clusters:

VPlexcli:/> device mirror-isolation show
Cluster Enabled Auto unisolation Isolation Interval Unisolation Interval
--------- ------- ---------------- ------------------ --------------------
cluster-1 true false 60 14400
cluster-2 true false 60 14400

Or
VPlexcli:/> device mirror-isolation show -c *
Cluster Enabled Auto unisolation Isolation Interval Unisolation Interval
--------- ------- ---------------- ------------------ --------------------
cluster-1 true false 60 14400
cluster-2 true false 60 14400

Example Shows the mirror isolation configuration parameters on one cluster:

VPlexcli:/> device mirror-isolation show -c cluster-1
Cluster Enabled Auto unisolation Isolation Interval Unisolation Interval
--------- ------- ---------------- ------------------ --------------------
cluster-1 true false 60 14400

device mirror-isolation show 205

VPLEX CLI Command Descriptions

Example Shows the command executed on an invalid cluster:

VPlexcli:/> device mirror-isolation show -c blah
device mirror-isolation show: Evaluation of <<device mirror-isolation show -c blah>> failed.
cause: Command execution failed.
cause: Failed to set value for option --clusters.
cause: Could not find appropriate contexts matching '[blah]'.

Example Shows the firmware command or feature is not supported:

VPlexcli:/> device mirror-isolation show
Cluster Enabled Auto unisolation Isolation Interval Unisolation Interval
--------- --------------- ---------------- ------------------ --------------------
cluster-1 <not available> <not available> <not available> <not available>
cluster-2 <not available> <not available> <not available> <not available>

Example Shows the auto-unisolation feature is not supported:

VPlexcli:/> device mirror-isolation show
Cluster Enabled Auto unisolation Isolation Interval Unisolation Interval
--------- ------- ---------------- ------------------ --------------------
cluster-1 true <not available> 60 14400
cluster-2 true <not available> 60 14400

See also ◆ device mirror-isolation auto-unisolation disable

◆ device mirror-isolation auto-unisolation enable
◆ device mirror-isolation disable
◆ device mirror-isolation enable
◆ EMC VPLEX Administration Guide

device resume-link-down
Resumes I/O for devices on the winning island during a link outage.

Contexts All contexts.

Syntax device resume-link-down

[-c|--cluster] context path
[-r|--devices] [context path|name]
[-a|--all-at-island]
[-f|--force]

Arguments Optional arguments

[-c|--cluster] context path - Resume I/O on the specified cluster and the clusters it is in
communication with during a link outage.
Applicable only when the all-at-island argument is used or when the specified devices are
distributed devices.
Not required for local devices with global visibility.
[-r|--devices] context path or name - Name or context path of the devices for which to
resume I/O. They must be top-level devices.

206 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

[-a|--all-at-island] - Resume I/O on all devices on the chosen winning cluster and the
clusters with which it is communicating.
[-f|--force] - Force the I/O to resume.

Description Used when the inter-cluster link fails. Allows one or more suspended mirror legs to resume
I/O immediately.
For example, used when the peer cluster is the winning cluster but is known to have failed
completely.
Resumes I/O on the specified cluster and the clusters it is in communication with during a
link outage.
Detaches distributed devices from those clusters that are not in contact with the specified
cluster or detaches local devices from those clusters that are not in contact with the local
cluster.



The device resume-link-down command causes I/O to resume on the local cluster
regardless of any rule-sets applied to the device. Verify that rules and any manual
detaches do not result in conflicting detaches (cluster-1 detaching cluster-2, and
cluster-2 detaching cluster-1). Conflicting detaches will result in lost data on the losing
cluster, a full rebuild, and degraded access during the time of the full rebuild.

When the inter-cluster link fails in a VPLEX Metro or Geo configuration, distributed devices
are suspended at one or more clusters. When the rule-set timer expires, the affected
cluster is detached.
Alternatively, use the device resume-link-down command to detach the cluster
immediately without waiting for the rule-set timer to expire.



Verify that rules and any manual detaches do not result in conflicting detaches (cluster-1
detaching cluster-2, and cluster-2 detaching cluster-1).
Conflicting detaches will result in lost data on the losing cluster, a full rebuild, and
degraded access during the time of the full rebuild.

Only one cluster should be allowed to continue for each distributed device. Different
distributed devices can have different clusters continue.
Use the ll /distributed-storage/distributed-devices/device command to display the rule
set applied to the specified device.
Use the ll /distributed-storage/rule-sets/rule-set/rules command to display the detach
timer for the specified rule-set.

Example VPlexcli:/distributed-storage/distributed-devices> device

resume-link-down --all-at-island --cluster --devices DD_5d --force

See also ◆ device resume-link-up

◆ ds dd declare-winner

device resume-link-down 207

VPLEX CLI Command Descriptions

device resume-link-up
Resumes I/O on suspended top level devices, virtual volumes, or all virtual volumes in the
VPLEX.

Contexts All contexts.

Syntax device resume-link-up

[-r|--devices] context path,context path...
[-v|--virtual-volumes]context path,context path...
[-a|--all]
[-f|--force]

Arguments Optional arguments

[-r|--devices] context path, context path... - List of one or more context paths or names of
the devices for which to resume I/O. They must be top-level devices. If the device name is
used, verify that the name is unique throughout the VPLEX, including local devices on
other clusters.
[-v|--virtual-volume] context path,context path... - Resume I/O on the specified virtual
volumes.
[-a|--all] -Resume I/O on all virtual volumes on the losing cluster.
[-f|--force] - Force the I/O to resume.

Description Use this command after a failed link is restored, but I/O is suspended at one or more
clusters.
Usually applied to the mirror leg on the losing cluster when auto-resume is set to false.
During a WAN link outage, after cluster detach, the primary cluster detaches to resume
operation on the distributed device.
If the auto-resume property of a remote or distributed device is set to false and the link
has come back up, use the device resume-link-up command to manually resume the
second cluster.

Example Resume I/O on two specified devices:

VPlexcli:/distributed-storage/distributed-devices> device
resume-link-up --devices CLAR0014_LUN17_1, CLAR0014_LUN18_1 –-force

Resume I/O on a specified virtual volume:

VPlexcli:/> device resume-link-up --virtual-volumes
/clusters/cluster-1/virtual-volumes/ESX_DataStore1_vol --force

Resume I/O on all virtual volumes in the losing cluster:

VPlexcli:/> device resume-link-up --all -–force

See also ◆ device mirror-isolation disable

director appcon
Runs the application console on Linux systems.

Contexts All contexts.

208 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Syntax director appcon

--xterm-opts options
[-t|--targets] target glob,target glob...
--timeout seconds
--show-plan-only

Arguments Optional arguments

--xterm-opts -Additional options for xterm on Linux.
Default: -sb -sl 2000.
[-t|--targets] target-glob, target-glob... - List of one or more glob patterns. Operates on the
specified targets. Globs may be a full path glob, or a name pattern. If only a name pattern
is supplied, the command finds allowed targets whose names match. Entries must be
separated by commas.
Omit this argument if the current context is at or below the target context.
--timeout seconds - Sets the command timeout. Timeout occurs after the specified
number of seconds multiplied by the number of targets found.
Default: 180 seconds per target.
0: No timeout.
--show-plan-only - Shows the targets that will be affected, but the actual operation is not
performed. Recommended when the --targets argument is used.

Description Applicable only to Linux systems.

Opens the hardware application console for each director in a separate window.

Example Display the available targets:

VPlexcli:/> director appcon --show-plan-only

For /engines/engine-2-1/directors/Cluster_2_Dir_1B:

Planned target.
For /engines/engine-2-1/directors/Cluster_2_Dir_1A:

Planned target.
For /engines/engine-2-2/directors/Cluster_2_Dir_2A:
.
.
.

See also ◆ director appstatus

director appdump
Downloads an application dump from one or more boards.

Contexts All contexts.

In /engines/engine/directors context, command is appdump.

director appdump 209

VPLEX CLI Command Descriptions

Syntax director appdump

[-d|--dir] directory
[-s|--no-timestamp]
[-o|--overwrite]
[-c|--include-cores]
[-z|--no-zip]
[-p|--no-progress]
[-t|--targets] target glob,target glob...
--timeout seconds
--show-plan-only

Arguments Optional arguments

[-d|--dir] directory - Directory in which to put dump files.
Default: Current directory.
[-s|--no-timestamp] - Omits the timestamp in the dump filenames.
[-o|--overwrite] - Overwrites existing files.
Default: Not to overwrite.
[-c|--include-cores] - Includes the director's core image in the dump.



Including core images can make this command take a very long time.

[-z|--no-zip] - Turns off the packaging of dump files into a compressed zip file.
[-p|--no-progress] - Turns off progress reporting.
[-t|--targets] target-glob, target-glob... - List of one or more glob patterns. Operates on the
specified targets. Globs may be a full path glob or a name pattern. If only a name pattern is
supplied, the command finds allowed targets whose names match. Entries must be
separated by commas.
Omit this argument if the current context is at or below the target context.
--timeout seconds - Sets the command timeout. Timeout occurs after the specified
number of seconds multiplied by the number of targets found.
Default: 180 seconds per target.
0: No timeout.
--show-plan-only - Shows the targets that will be affected, but the actual operation is not
performed. Recommended when the --targets argument is used.

Description Used by automated scripts and by EMC Customer Support to help troubleshoot problems.
The hardware name and a timestamp are embedded in the dump filename. By default, the
name of the dump file is:
hardware name-YYYY.MM.DD-hh.mm.ss.zip.

Note: Timeout is automatically set to 0 (infinite) when dumping core.

Example Show the targets available for the appdump procedure:

VPlexcli:/> director appdump --show-plan-only

210 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

For /engines/engine-2-1/directors/dirB:

Planned target.
For /engines/engine-2-1/directors/dirA:

Planned target.
For /engines/engine-1-1/directors/DirA:

Planned target.
For /engines/engine-1-1/directors/DirB:

Planned target.

See Also ◆ cluster configdump

◆ collect-diagnostics
◆ getsysinfo
◆ smsdump

director appstatus
Displays the status of the application on one or more boards.

Contexts All contexts.

In /engines/engine/directors context, command is appstatus.

Syntax director appstatus

[-t|--targets] target glob, target glob...
--timeout seconds
--show-plan-only

Arguments Optional arguments

[-t|--targets] target-glob, target-glob... - List of one or more glob patterns. Operates on the
specified targets. Globs may be a full path glob or a name pattern. If only a name pattern is
supplied, the command finds allowed targets whose names match. Entries must be
separated by commas.
Omit this argument if the current context is at or below the target context.
--timeout seconds - Sets the command timeout. Timeout occurs after the specified
number of seconds multiplied by the number of targets found.
Default: 180 seconds per target.
0: No timeout.
--show-plan-only - Shows the targets that will be affected, but the actual operation is not
performed. Recommended when the --targets argument is used.

Description Used by automated scripts and by EMC Customer Support to help troubleshoot problems.

Example VPlexcli:/engines/engine-1-1/directors> appstatus

For /engines/engine-1-1/directors/Cluster_1_Dir1B:

Application Status Details

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

director appstatus 211

VPLEX CLI Command Descriptions

00601610672e201522-2 running -

For /engines/engine-1-1/directors/Cluster_1_Dir1A:

Application Status Details

------------------- ------- -------
00601610428f20415-2 running -

See also ◆ director appcon

◆ director appdump

director commission
Starts the director’s participation in the cluster.

Contexts All contexts.

In /engines/engine/directors context, command is commission.

Syntax director commission

[-n|--director] director
[-f|--force]
[-t|--timeout seconds
[-a|--apply-cluster-settings]

Arguments Required arguments

[-n|--director] director - * The director to be commissioned.

Optional arguments
[-f|--force] - Commission the director regardless of firmware version mismatch.
--timeout seconds - The maximum time to wait for --apply-cluster-settings operations to
complete, in seconds.
Default: 60 seconds.
0: No timeout.
[a|--apply-cluster-settings] - Add this director to a running cluster and apply any
cluster-specific settings. Use this argument when adding or replacing a director in an
existing VPLEX.
* - argument is positional.

Description In order to participate in a cluster, a director must be explicitly commissioned.

Uncommissioned directors can boot but do not participate in any cluster activities.
Use the version -a command to display the firmware version for all directors in the cluster.
The director commission command fails if the director's firmware version is different than
the already commissioned directors, unless the --force argument is used.

Example Add a director to a running cluster using the default timeout (60 seconds):
VPlexcli:/> director commission --director Cluster_1_Dir1A --apply-cluster-settings

See also ◆ director decommission

◆ version

212 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

director decommission
Decommissions a director. The director stops participating in cluster activities.

Contexts All contexts.

In/engines/engine/directors context, command is decommission.

Syntax director decommission

[-n|--director] director

Arguments Required arguments

[-n|--director] director - The director to de-commission.

Description This command removes the director from participating in the VPLEX, and initializes it to
only a partial operational state. The director is no longer a replication target and its
front-end ports are disabled.
Then it reboots the director.

Example VPlexcli:/> director decommission --director Cluster_1_Dir1A

See also ◆ director commission

◆ director forget
◆ director shutdown

director fc-port-stats
Displays/resets Fibre Channel port statistics for a specific director.

Contexts All contexts.

In /engines/engine/directors context, command is fc-port-stats director.
In /engines/engine/directors/director context, command is fc-port-stats

Syntax director fc-port-stats

[-d|--director] director
[-o|--role] role
[-r|--reset]

Arguments Required arguments

[-d|--director] director - Context path of the director for which to display FC statistics. Not
required if the current context is /engines/engine/directors/director.

Optional arguments
[-o|--role] role - Filter the ports included in the reply by their role.If no role is specified, all
ports at the director are included. This argument is ignored if --reset is specified. Roles
include:
• back-end - The port is used to access storage devices that the system itself does
I/O to.
• front-end - The port is used to make storage available to hosts.

director decommission 213

VPLEX CLI Command Descriptions

• inter-director-communication - The port is used to communicate with other

directors.
• local-com - The port is used to communicate with other directors at the same
cluster.
• management - The port is used to communicate with the management server.
• wan-com - The port is used to communicate with other clusters.
[-r|--reset] - Reset the statistics counters of all ports at the specified director. If this
argument is specified, --role is ignored.

Description Displays statistics generated by the Tachyon driver for FibreChannel ports at the specified
director and optionally with the specified role, or reset said statistics'
Run this command from the /engines/engine/directors/director context to display the
Fibre Channel statistics for the director in the current context.

Example Display a director’s Fibre Channel port statistics from the root context:
VPlexcli:/> director fc-port-stats -d director-2-1-A

Example Reset the port statistics counters on a director’s Fibre Channel ports from the root context:
VPlexcli:/> director fc-port-stats -d director-2-1-A --reset

Example Display a director’s Fibre Channel port statistics from the director context:
VPlexcli:/engines/engine-1-1/directors/director-1-1-A> fc-port-stat

Results for director 'director-2-1-A' at Fri Feb 10 16:10:15 MST 2012:

Port: A1-FC00 A1-FC01 A1-FC02 A1-FC03 A3-FC00 A3-FC01

Frames:
- Discarded: 0 0 0 0 0 0
- Expired: 0 0 0 0 0 0
- Bad CRCs: 0 0 0 0 0 0
- Encoding Errors: 0 0 0 0 0 0
- Out Of Order: 0 0 0 0 0 0
- Lost: 0 0 0 0 0 13

Requests:
- Accepted: 0 0 0 0 7437 7437
- Rejected: 0 0 0 0 0 0
- Started: 0 0 0 0 7437 7437
- Completed: 0 0 0 0 7437 7437
- Timed-out: 0 0 0 0 0 0
Tasks:
- Received: 0 0 0 0 7437 7437
- Accepted: 0 0 0 0 7437 7437
- Rejected: 0 0 0 0 0 0
- Started: 0 0 0 0 7437 7437
- Completed: 0 0 0 0 7437 7437
- Dropped: 0 0 0 0 0 0

214 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Table 11 director fc-port-stats field descriptions

Field Description

Frames: frames discarded, expired, or with CRC or encoding errors on this port since the counter was last reset.

Discarded Discarded frames.

Expired Expired frames.

Bad CRCs Frames with invalid CRC.

Encoding Errors Frames with encoding errors.

Requests: outgoing scsi commands issued by a VPlex initiator.

Accepted scsi requests accepted. Requests that have not been rejected.

Rejected scsi requests rejected. Requests can be rejected due to: Not an initiator, Port not
ready, no memory for allocation.

Started scsi requests started.

Completed Requests that have been completed.

Timed-out Number of requests timed out. Requests have been sent but not responded to
within 10 seconds.

Tasks: incoming scsi commands issued to a VPlex target.

Received Tasks received by the tach driver from the TSDK.

Accepted Tasks started back to the TSDK.

Rejected Tasks rejected due to: 1. connection not ready 2. IO was aborted by TSDK 3. Tried to
send more data than the initiator requested. 4. Unable to allocate enough SGL
entries.

Started Tasks sent to the upper layer for processing.

Completed Tasks completed to the upper layer.

Dropped Tasks dropped due to: 1. Connection not ready. 2. No available task buffers to
handle the incoming task.

See also ◆ monitor stat-list

director firmware show-banks

Display the status of the two firmware banks for all or specified director(s).

Contexts All contexts.

In /engines/engine/directors context, command is firmware show-banks.

Syntax director firmware show-banks

[-t|--targets] director,director...

Arguments Optional arguments

[-t|--targets] director,director... - List of one or more names of directors. Display
information only for the specified directors. Entries must be separated by commas.

director firmware show-banks 215

VPLEX CLI Command Descriptions

Description Show firmware status and version for one or more directors.

Example Show firmware banks for two specified directors:

VPlexcli:/engines> director firmware show-banks --targets Cluster_1_Dir1A, Cluster_1_Dir1B
[Director Cluster_1_Dir1B]:

Banks Status Marked for Next Reboot Director Software Version

------ -------- ---------------------- -------------------------
Bank A inactive no 1.2.43.0.0
Bank B active yes 1.2.43.2.0

[Director Cluster_1_Dir1A]:

Banks Status Marked for Next Reboot Director Software Version

------ -------- ---------------------- -------------------------
Bank A inactive no 1.2.43.0.0
Bank B active yes 1.2.43.2.0

Table 12 director firmware show-banks field descriptions

Field Description

Banks Each director has two firmware banks; A and B.

Status active - The software in this bank is currently operating on the director.
inactive - The software in this bank is not operating on the director.

Marked for next reboot no - The software in this bank will not be used the next time the director reboots.
yes - The software in this bank will be used the next time the director reboots.

Director Software version Software version currently operating in the director.

See also ◆ version

director forget
Removes a director from the VPLEX.

Contexts All contexts.

Syntax director forget

[-n|--director] director uuid

Arguments Required arguments

[-n|--director] director uuid - Director ID number. Use the ll command in
engines/engine/directors context to display director ID numbers.

Description Removes the specified director from the context tree. Deletes all information associated
with the director.

Example In the following example:

◆ The ll command in engines/engine/directors context displays director IDs.
◆ The director forget command instructs VPLEX to delete all records pertaining to the
specified director.
VPlexcli:/engines/engine-1-1/directors> ll
Name Director ID Cluster Commissioned Operational Communication
--------------- ------------------ ID ------------ Status Status

216 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

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

Cluster_1_Dir1A 0x000000003ca00147 1 true ok ok
Cluster_1_Dir1B 0x000000003cb00147 1 true ok ok

VPlexcli:/engines/engine-1-1/directors> director forget --director 0x000000003ca00147

See also ◆ director commission

◆ director decommission

director passwd
Changes the access password for the specified director.

Contexts All contexts.

In /engines/engine/directors/director context, command is passwd.

Syntax director passwd

[-n|--director] director
[-c|--current-password] current-password
[-p|--new-password] new-password

Arguments Required arguments

[-n|--director] director - The remote director on which to change the access password.
[-c|--current-password] current-password - The current access password of the specified
director.
[-p|--new-password] new-password - The new access password to set for the specified
director.

Description Changes the password for a specified director.

director ping
Displays the round-trip latency from a given director to the target machine, excluding any
VPLEX overhead.

Contexts All contexts.

In /engines/engine/directors context, command is ping.

Syntax director ping

[-i|--ip-address] ip-address
[-n|--director] director
[-w|--wait] [1 - 2147483647]

Arguments Required arguments

[-i|--ip-address] IP address - The target's IP address.

Optional arguments
[-n|--director] director - The director from which to perform the operation.

[-w|--wait] seconds - Number of seconds to wait for a response.

director passwd 217

VPLEX CLI Command Descriptions

Range: 1 - 2147483647
Default: 5.

Description ICMP traffic must be permitted between clusters for this command to work properly.

Notes To verify that ICMP is enabled, log in to the shell on the management server and use the
ping IP address command where the IP address is for a director in the VPLEX.
If ICMP is enabled on the specified director, a series of lines is displayed:
service@ManagementServer:~> ping 128.221.252.36
PING 128.221.252.36 (128.221.252.36) 56(84) bytes of data.
64 bytes from 128.221.252.36: icmp_seq=1 ttl=63 time=0.638 ms
64 bytes from 128.221.252.36: icmp_seq=2 ttl=63 time=0.591 ms
64 bytes from 128.221.252.36: icmp_seq=3 ttl=63 time=0.495 ms
64 bytes from 128.221.252.36: icmp_seq=4 ttl=63 time=0.401 ms
64 bytes from 128.221.252.36: icmp_seq=5 ttl=63 time=0.552 ms

--- 128.221.252.36 ping statistics ---

5 packets transmitted, 5 received, 0% packet loss, time 4002ms
rtt min/avg/max/mdev = 0.401/0.535/0.638/0.084 ms

If ICMP is disabled, nothing is displayed.

Press Ctrl-C to exit from ping.

Example Ping from root context:

VPlexcli:/> director ping -n director-1-1-A -i 192.168.30.67
Round-trip time to 192.168.30.67: 0.111 ms

Ping from director context:

VPlexcli:/engines/engine-1-1/directors/director-1-1-A> ping 192.168.30.68
Round-trip time to 192.168.30.68: 0.117 ms

Remote address is unreachable:

VPlexcli:/engines/engine-1-1/directors/director-1-1-A>ping 128.221.252.36
128.221.252.36 is unreachable.

See also ◆ director tracepath

director shutdown
Starts the orderly shutdown of a director’s firmware

Contexts All contexts.

In /engines/engine/directors context, command is shutdown.

Syntax director shutdown

[-f|--force]
[-n|--director] context path

Arguments Required arguments

[-f|--force] - Forces this operation.

Optional arguments
[-n|--director] context path - * Director to shut down.

218 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

* - argument is positional.

Description Shuts down the director firmware.

Note: Does not shut down the operating system on the director.

After shutdown, state of the director is as follows:

◆ Power is on.
◆ Director OS running.
◆ Director firmware (GeoSynchrony) is stopped.

Example In the following example:

◆ The director shutdown command shuts down DirA.
◆ The ll command displays the shutdown director.
VPlexcli:/engines/engine-1-1/directors/director-1-1-A> director
shutdown --force
Please check the status of the director: director-1-1-A for its
shutdown status.

Status Description
-------- -----------------
Started. Shutdown started.

VPlexcli:/engines/engine-1-1/directors/director-1-1-A> ll

Attributes:
Name Value
------------------------------ ------------------
auto-boot true
auto-restart true
.
.
.
marker-led off
operational-status stopped
.
.
.

See also ◆ cluster shutdown

◆ director commission

director tracepath
Displays the route taken by packets from a specified director to the target machine.

Contexts All contexts.

In /engines/engine/directors context, command is tracepath.

Syntax director tracepath

[-i|--ip-address] ip-address
[-n|--director] director

director tracepath 219

VPLEX CLI Command Descriptions

Arguments Required arguments

[-i|--ip-address] IP address - The target's IP address. This address is one of the Ethernet
WAN ports on another director. Use the ll port-group command to display the Ethernet
WAN ports on all directors.

Optional arguments
[-n|--director] - The name of the director from which to perform the operation. Can be either
the director's name (for example director-1-1-A) or an IP address.

Description Displays the hops, latency, and MTU along the route from the specified director to the
target at the specified IP address.
The number of hops does not always correlate to the number of switches along the route.
For example, a switch with a fire wall on each side is counted as two hops.
The reported latency at each hop is the round-trip latency from the source hop.
The MTU reported at each hop is limited by the MTU of previous hops and therefore not
necessarily the configured MTU at that hop.
In the following illustration, a director in cluster-2 (director-2-1-A) is pinged from a director
in cluster-1 (director-1-1-A) in single engine clusters. The ping travels through both
management servers before reaching its target:



If the target machine does not respond properly, the traceroute may stall. Run this
command multiple times.

Use the ll /clusters/*/cluster-connectivity/port-groups command to display the Ethernet

WAN ports on all directors (for both clusters).

Example In the following example:

◆ The ll engines/*/directors command displays the names of all directors in a 2-cluster
VPLEX.
◆ The ll /clusters/*/cluster-connectivity/port-groups command displays the IP
addresses of the Ethernet WAN ports on all directors.
◆ The director tracepath command displays the route from the specified director to the
specified address using the director’s name:
VPlexcli:/> ll /clusters/*/cluster-connectivity/port-groups

220 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

VPlexcli:/> ll /engines/*/directors

/engines/engine-1-1/directors:
Name Director ID Cluster Commissioned Operational Communication
-------------- ------------------ ID ------------ Status Status
-------------- ------------------ ------- ------------ ----------- -------------
director-1-1-A 0x0000000044603198 1 true ok ok
director-1-1-B 0x0000000044703198 1 true ok ok

/engines/engine-2-1/directors:
Name Director ID Cluster Commissioned Operational Communication
-------------- ------------------ ID ------------ Status Status
-------------- ------------------ ------- ------------ ----------- -------------
director-2-1-A 0x00000000446031b1 2 true ok ok
director-2-1-B 0x00000000447031b1 2 true ok ok

VPlexcli:/> director tracepath --director director-1-1-A --ip-address 192.168.22.146

Destination 192.168.22.146 reachable. 2 hops:
Source: endpoint 192.168.12.140, latency 0.029ms, mtu 1500, reachable
Hop 1: endpoint 192.168.12.1, latency 52.6ms, mtu 1500, reachable
Hop 2: endpoint 192.168.22.146, latency 108ms, mtu 1500, reachable

Display the route from the specified director to the specified address using the director’s
IP address:
VPlexcli:/> director tracepath 10.6.211.91 -i 10.12.136.12

See also ◆ director ping

director uptime
Prints the uptime information for all connected directors.

Contexts All contexts.

In engines/engine/directors context, command is uptime.

Syntax director uptime

Description Uptime measures the time a machine has been up without any downtime.

Example Shows director uptime:

VPlexcli:/> director uptime
Director director-1-2-A: 0 days, 0 hours, 52 minutes, 29 seconds.
Director director-1-2-B: 0 days, 0 hours, 52 minutes, 11 seconds.
Director director-2-2-A: 0 days, 0 hours, 52 minutes, 19 seconds.
Director director-2-1-A: 0 days, 0 hours, 52 minutes, 34 seconds.
Director director-2-2-B: 0 days, 0 hours, 52 minutes, 31 seconds.

director uptime 221

VPLEX CLI Command Descriptions

Director director-1-1-A: 0 days, 0 hours, 57 minutes, 2 seconds.

Director director-1-1-B: 0 days, 0 hours, 52 minutes, 24 seconds.
Director director-2-1-B: 0 days, 0 hours, 52 minutes, 28 seconds.

See also ◆ cluster shutdown

◆ director firmware show-banks

dirs
Displays the current context stack.

Contexts All contexts.

Syntax dirs

Description The stack is displayed from top to bottom, in left to right order.

Example VPlexcli:/> dirs

[/]

VPlexcli:/> cd /engines/engine-1-1/

VPlexcli:/engines/engine-1-1> dirs
[/engines/engine-1-1]

VPlexcli:/engines/engine-1-1> cd /directors/

VPlexcli:/engines/engine-1-1/directors> dirs
[/engines/engine-1-1/directors]

See also ◆ tree

disconnect
Disconnects one or more connected directors.

Contexts All contexts.

Syntax disconnect
[-n|--directors] context path,context path...

Arguments Required arguments

[-n|--directors] context path, context path... - List of one or more remote directors from
which to disconnect. Entries must be separated by commas.

Description Stops communication from the client to the remote directors and frees up all resources
that are associated with the connections.



Removes the entry in the connections file for the specified director(s).

Example VPlexcli:> disconnect --directors

/engines/engine-1-1/directors/director-1-1-B

222 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

dm migration cancel
Cancels an existing data migration.

Contexts All contexts.

In all data-migration (device or extent) contexts, command is migration cancel.
In data-migrations/extent-migrations context, command is cancel.

Syntax dm migration cancel

[-f|--force]
[-m|--migrations] context path,context path...

Arguments Required arguments

[-m|--migrations] context path,context path...- * List of one or more migrations to cancel.
Entries must be separated by commas.

Optional arguments
[-f|--force] - Forces the cancellation of the specified migration(s).
* - argument is positional.

Description Use the dm migration cancel --force --migrations context-path command to cancel a
migration.
Specify the migration by name if that name is unique in the global namespace. Otherwise,
specify a full context path.
Migrations can be canceled in the following circumstances:
◆ The migration is in progress or paused. The migration is stopped, and any resources it
was using are freed.
◆ The migration has not been committed. The source and target devices or extents are
returned to their pre-migration state.
A migration cannot be canceled if it has been committed.
To remove the migration record from the context tree, see the dm migration remove
command.

Example Cancel a migration from device-migration context:

VPlexcli:/data-migrations/device-migrations> dm migration cancel
--force --migrations migrate_012

Cancel a device migration from root context:

VPlexcli:> dm migration cancel --force --migrations
/data-migrations/device-migrations/migrate_012

See also ◆ dm migration commit

◆ dm migration pause
◆ dm migration remove
◆ dm migration resume
◆ dm migration start

dm migration cancel 223

VPLEX CLI Command Descriptions

dm migration clean
Cleans a committed data migration.

Contexts All contexts.

In /data-migrations context, command is migration clean.
In /data-migrations/device-migrations context, command is clean.
In /data-migrations/extent-migrations context, command is clean.

Syntax dm migration clean

[-f|--force]
[-e|--rename-target]
[-m|--migrations] context path,context path...

Arguments Required arguments

[-m|--migrations] context path,context path...- * List of one or more migrations to clean.
Entries must be separated by commas.

Optional arguments
[-f|--force] - Forces the cancellation of the specified migration(s).
[-e|--rename-target] - For device migrations only, renames the target device after the source
device. If the target device is renamed, the virtual volume on top of it is also renamed if
the virtual volume has a system-assigned default name.
* - argument is positional.

Description For device migrations, cleaning dismantles the source device(s) down to its storage
volumes. The storage volumes no longer in use are unclaimed.
For device migrations only, use the --rename-target argument to rename the target device
after the source device. If the target device is renamed, the virtual volume on top of it is
also renamed if the virtual volume has a system-assigned default name.
Without renaming, the target devices retain their target names, which can make the
relationship between volume and device less evident.
For extent migrations, cleaning destroys the source extent and unclaims the underlying
storage-volume if there are no extents on it.

Example
VPlexcli:/data-migrations/device-migrations> dm migration clean --force --migrations
migrate_012

Cleaned 1 data migration(s) out of 1 requested migration(s).

See also ◆ dm migration cancel

◆ dm migration commit
◆ dm migration pause
◆ dm migration remove
◆ dm migration resume
◆ dm migration start

224 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

dm migration commit
Commits a completed data migration allowing for its later removal.

Contexts All contexts.

In /data-migrations context, command is migration commit.
In /data-migrations/extent-migrations context, command is commit.
In /data-migrations/device-migrations context, command is commit.

Syntax dm migration commit

[-f|--force]
[-m|--migrations] context path,context path...

Arguments Required arguments

[-m|--migrations] context path,context path...- * List of one or more migrations to commit.
Entries must be separated by commas.
[-f|--force] - Forces the commitment of the specified migration(s).
* - argument is positional.

Description The migration process inserts a temporary RAID 1 structure above the source
device/extent with the target device/extent as an out-of-date leg of the RAID 1. The
migration can be understood as the synchronization of the out-of-date leg (the target).
After the migration is complete, the commit step detaches the source leg of the RAID 1 and
removes the RAID 1.
The virtual volume, device or extent is identical to the one before the migration except that
the source device/extent is replaced with the target device/extent.
A migration must be committed in order to be cleaned.



Verify that the migration has completed successfully before committing the migration.

Example Commit a device migration:

VPlexcli:/data-migrations/device-migrations> commit -m
beta_device_mig1 -f
Committed 1 data migration(s) out of 1 requested migration(s).

See also ◆ dm migration cancel

◆ dm migration pause
◆ dm migration remove
◆ dm migration resume
◆ dm migration start

dm migration commit 225

VPLEX CLI Command Descriptions

dm migration pause
Pauses the specified in-progress or queued data migrations.

Contexts All contexts.

In /data-migrations context, command is migration pause.
In/data-migrations/extent-migrations context, command is pause.
In/data-migrations/device-migrations context, command is pause.

Syntax dm migration pause

[-m|--migrations] context path,context path...

Arguments Required arguments

[-m|--migrations] context path,context path...- * List of one or more migrations to pause.
Entries must be separated by commas.
* - argument is positional.

Description Active migrations (a migration that has been started) can be paused and then resumed at
a later time.
Pause an active migration to release bandwidth for host I/O during periods of peak traffic.
Specify the migration by name if that name is unique in the global namespace. Otherwise,
specify a full pathname.
Use the dm migration resume command to resume a paused migration.

Example Pause a device migration:

VPlexcli:/data-migrations/device-migrations> dm migration pause --migrations migrate_012

See also ◆ dm migration cancel

◆ dm migration commit
◆ dm migration remove
◆ dm migration resume
◆ dm migration start

dm migration remove
Removes the record of canceled or committed data migrations.

Contexts All contexts.

In /data-migrations context, command is migration remove.
In/data-migrations/extent-migrations context, command is remove.
In/data-migrations/device-migrations context, command is remove.

Syntax dm migration remove

[-f|--force]
[-m|--migrations] context path,context path...

226 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Required arguments

[-m|--migrations] context path,context path...- * List of one or more migrations to remove.
Entries must be separated by commas.
[-f|--force] - Forces the removal of the specified migration(s).
* - argument is positional.

Description Before a migration record can be removed, it must be canceled or committed to release
the resources allocated to the migration.

Example Remove a migration:

VPlexcli:/data-migrations/device-migrations> remove -m beta_device_mig1 –f

Removed 1 data migration(s) out of 1 requested migration(s).

See also ◆ dm migration cancel

◆ dm migration commit
◆ dm migration pause
◆ dm migration resume
◆ dm migration start

dm migration resume
Resumes a previously paused data migration.

Contexts All contexts.

In /data-migrations context, command is migration resume.
In/data-migrations/extent-migrations context, command is resume.
In/data-migrations/device-migrations context, command is resume.

Syntax dm migration resume

[-m|--migrations] context path,context path...

Arguments Required arguments

[-m|--migrations] context path,context path...- List of one or more migrations to resume.
Entries must be separated by commas.

Description Active migrations (a migration that has been started) can be paused and then resumed at
a later time.
Pause an active migration to release bandwidth for host I/O during periods of peak traffic.
Use the dm migration resume command to resume a paused migration.

Example Resume a paused device migration:

VPlexcli:/data-migrations/device-migrations> dm migration resume --migrations migrate_012

See also ◆ dm migration cancel

dm migration resume 227

VPLEX CLI Command Descriptions

◆ dm migration commit
◆ dm migration pause
◆ dm migration remove
◆ dm migration start

dm migration start
Starts the specified migration.

Contexts All contexts.

In /data-migrations context, command is migration start.
in/data-migrations/extent-migrations context, command is start.
in/data-migrations/device-migrations context, command is start.

Syntax dm migration start

[-n|--name] migration name
[-s|--transfer-size] [40 K - 128 M]
[-f|--from] [source extent|source device]
[-t|--to] [target extent|target device]
--paused
--force

Arguments Required arguments

[-n|--name] migration name...- * Name of the new migration. Used to track the migration’s
progress, and to manage (cancel, commit, pause, resume) the migration.
[-f|--from] {source extent|source device}- * The name of source extent or device for the
migration. Specify the source device or extent by name if that name is unique in the global
namespace. Otherwise, specify a full pathname.
If the source is an extent, the target must also be an extent. If the source is a device, the
target must also be a device.
[-t|--to] {target extent|target device} - * The name of target extent or device for the
migration. Specify the target device or extent by name if that name is unique in the global
namespace. Otherwise, specify a full pathname.

Optional arguments
[-s|--transfer-size] value - Maximum number of bytes to transfer per operation per device. A
bigger transfer size means smaller space available for host I/O. Must be a multiple of 4 K.
Range: 40 KB - 128 M. Default: 128 K.
If the host I/O activity is very high, setting a large transfer size may impact host I/O. See
About transfer-size in the batch-migrate start command.
--force - Do not ask for confirmation. Allows this command to be run using a
non-interactive script.
--paused - Starts the migration in a paused state.
* - argument is positional.

228 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Description Starts the specified migration. If the target is larger than the source, the extra space on the
target is unusable after the migration. If the target is larger than the source, a prompt to
confirm the migration is displayed.

Note: Up to 25 local and 25 distributed migrations (rebuilds) can be in progress at the

same time. Any migrations beyond those limits are queued until an existing migration
completes.



Cross-cluster data migration on volumes in asynchronous consistency groups is not
recommended if they are actively servicing IOs, as the host application will be subject to
high latency. Schedule this activity as a maintenance activity to avoid data unavailability.

Extent migrations - Extents are ranges of 4K byte blocks on a single LUN presented from a
single back-end array. Extent migrations move data between extents in the same cluster.
Use extent migration to:
◆ Move extents from a “hot” storage volume shared by other busy extents,
◆ De-fragment a storage volume to create more contiguous free space,
◆ Support technology refreshes.
Start and manage extent migrations from the extent migration context:
VPlexcli:/> cd /data-migrations/extent-migrations/

VPlexcli:/data-migrations/extent-migrations>

IMPORTANT
Extent migrations are blocked if the associated virtual volume is undergoing expansion.
Refer to the virtual-volume expand command.

Device migrations - Devices are RAID 0, RAID 1, or RAID C built on extents or other devices.
Devices can be nested; a distributed RAID 1 can be configured on top of two local RAID 0
devices. Device migrations move data between devices on the same cluster or between
devices on different clusters. Use device migration to:
◆ Migrate data between dissimilar arrays
◆ Relocate a hot volume to a faster array
This command can fail on a cross-cluster migration if there is not a sufficient number of
meta volume slots. See the troubleshooting section of the VPLEX procedures in the SolVe
Desktop for a resolution to this problem.
Start and manage device migrations from the device migration context:
VPlexcli:/> cd /data-migrations/device-migrations/

VPlexcli:/data-migrations/device-migrations>

When running the dm migration start command across clusters, you might receive the
following error message:

dm migration start 229

VPLEX CLI Command Descriptions

VPlexcli:/> dm migration start -f SveTest_tgt_r0_case2_1_0002 -t SveTest_src_r0_case2_2_0002

-n cc2
The source device 'SveTest_tgt_r0_case2_1_0002' has a volume 'SveTest_tgt_r0_case2_1_0002_vol'
in a view. Migrating to device 'SveTest_src_r0_case2_2_0002' will create a synchronous
distributed device. In this GEO system, this can increase the per I/O latency on
'SveTest_tgt_r0_case2_1_0002_vol'. If applications using 'SveTest_tgt_r0_case2_1_0002_vol' are
sensitive to this latency, they may experience data unavailability. Do you wish to proceed ?
(Yes/No) y

dm migration start: Evaluation of <<dm migration start -f SveTest_tgt_r0_case2_1_0002 -t

SveTest_src_r0_case2_2_0002 -n cc2>> failed.
cause: Failed to create a new data-migration.
cause: Unable to attach mirror 'SveTest_src_r0_case2_2_0002' to distributed Device
'MIGRATE_cc2'.
cause: Firmware command error.
cause: Active metadata device does not have a free slot.

See the troubleshooting section of the VPLEX procedures in the SolVe Desktop for
instructions on increasing the number of slots.

Prerequisites for target devices/extents

The target device or extent of a migration must:
◆ Be the same size or larger than the source device or extent
If the target is larger in size than the source, the extra space cannot be utilized. For
example, if the source is 200 GB, and the target is 500 GB, only 200 GB of the target
can be used after a migration. The remaining 300 GB cannot be claimed.
◆ Not have any existing volumes on it.
Refer to the EMC VPLEX Administration Guide for detailed information on data migration.

See also ◆ batch-migrate create-plan

◆ batch-migrate start
◆ dm migration cancel
◆ dm migration commit
◆ dm migration pause
◆ dm migration remove
◆ dm migration resume

drill-down
Displays the components of a view, virtual volume or device, down to the storage-volume
context.

Contexts All contexts.

Syntax drill-down
[-v|--storage-view] context path,context path...
[-o|--virtual-volume] context path,context path...
[-r|--device] context path,context path...

230 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Required arguments

[-v|--storage-view] context path,context path...- List of one or more views to drill down.
Entries must be separated by commas. Glob style pattern matching is supported.
[-o|--virtual-volume] context path,context path... - List of one or more virtual-volumes to
drill down. Entries must be separated by commas. Glob style pattern matching is
supported.
[-r|--device] context path,context path... - List of one or more devices to drill down. Entries
must be separated by commas. Glob style pattern matching is supported.

Description Displays the components of the specified object.

To display a list of available objects, use the drill-down object-type command followed by
the <TAB> key, where object type is storage-view, device, or virtual-volume.

Example Display the components of a virtual volume:

VPlexcli:/clusters/cluster-2> drill-down --virtual-volume dd_21_vol/
virtual-volume: dd_21_vol (cluster-2)
distributed-device: dd_21
distributed-device-component: dev1723_614 (cluster-2)
extent: extent_Symm1723_614_1
storage-volume: Symm1723_614 (blocks: 0 - 4195199)
distributed-device-component: dev1852_214 (cluster-1)
extent: extent_Symm1852_214_1
storage-volume: Symm1852_214 (blocks: 0 - 4195199)

Example Display the elements of a storage view:

VPlexcli:/clusters/cluster-2> drill-down --storage-view exports/storage-views/LicoJ010
storage-view: LicoJ010 (cluster-2)
virtual-volume: base01_vol (cluster-2)
local-device: base01 (cluster-2)
extent: extent_base_volume_1
storage-volume: base_volume (blocks: 0 - 524287)
virtual-volume: dd_00_vol (cluster-2)
distributed-device: dd_00
distributed-device-component: dev1723_00 (cluster-1)
extent: extent_Symm1723_200_1
storage-volume: Symm1723_200 (blocks: 0 - 4195199)
extent: extent_Symm1723_204_1
storage-volume: Symm1723_204 (blocks: 0 - 4195199)
extent: extent_Symm1723_208_1
storage-volume: Symm1723_208 (blocks: 0 - 4195199)
extent: extent_Symm1723_20C_1
storage-volume: Symm1723_20C (blocks: 0 - 4195199)
.
.
.
virtual-volume: dev_Symm1723_91C_vol (cluster-2)
local-device: dev_Symm1723_91C (cluster-2)
extent: extent_Symm1723_91C_1
storage-volume: Symm1723_91C (blocks: 0 - 4195199)
iport: LicoJ010_hba1
iport: LicoJ010_hba0
iport: LicoJ010_hba3
iport: LicoJ010_hba2
tport: P000000003CB000E6-B1-FC00
tport: P000000003CB001CB-B0-FC00
tport: P000000003CA001CB-A0-FC00
tport: P000000003CA000E6-A0-FC00
tport: P000000003CB001CB-B1-FC00

drill-down 231
VPLEX CLI Command Descriptions

tport: P000000003CB000E6-B0-FC00
tport: P000000003CA001CB-A1-FC00
tport: P000000003CA000E6-A1-FC0

Example Display the components of a device:

VPlexcli:/clusters/cluster-2/devices> drill-down --device dev_Symm1723_918
local-device: dev_Symm1723_918 (cluster-2)
extent: extent_Symm1723_918_1
storage-volume: Symm1723_918 (blocks: 0 - 4195199)

See also ◆ tree

ds dd create
Creates a new distributed-device.

Contexts All contexts.

Syntax ds dd create
[-n|name] name
[-d|--devices] context path [,context path,...]
[-l|--logging-volumes] context path [,context path,...]
[-r| rule-set] rule-set
[-s|--source-leg] context path
[-f|--force]

Arguments Required arguments

[-n|--name] name - * The name of the new distributed-device. Must be unique across the
VPLEX.
[-d|--devices] context path [, context path,...]- * List of one or more local devices that will
be legs in the new distributed-device.
[-l|--logging-volume] context path [, context path,...]- List of one or more logging volumes
to use with this device. If no logging volume is specified, a logging volume is automatically
selected from any available logging volume that has sufficient space for the required
entries. If no available logging volume exists, an error message is returned.
* - argument is positional.

Optional arguments
[-r|--rule-set] rule-set - The rule-set to apply to the new distributed device. If the --rule-set
argument is omitted, the cluster that is local to the management server is assumed to be
the winner in the event of an inter-cluster link failure.
[-s|--source-leg] context path - Specifies one of the local devices to use as the source data
image for the new device. The command will copy data from the source-leg to the other
legs of the new device.
[-f|--force] - Forces a rule-set with a potential conflict to be applied to the new distributed
device.

Description The new distributed device consists two legs; local devices on each cluster.

232 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions



A device created by this command does not initialize its legs, or synchronize the contents
of the legs. Because of this, consecutive reads of the same block may return different
results for blocks that have never been written. Host reads at different clusters are almost
certain to return different results for the same unwritten block, unless the legs already
contain the same data.



Use this command only if the resulting device will be initialized using tools on the host.
Do not use this command if one leg of the resulting device contains data that must be
preserved. Applications using the device may corrupt the pre-existing data.

To create a device when one leg of the device contains data that must be preserved, use
the device attach-mirror command to add a mirror to the leg. The data on the leg will be
copied automatically to the new mirror.
The individual local devices may include any underlying type of storage volume or
geometry (RAID 0, RAID 1, or RAID C), but they should be the same capacity.
If a distributed device is configured with local devices of different capacities:
◆ The resulting distributed device will be only as large as the smaller local device
◆ The leftover capacity on the larger device will not be available
To create a distributed device without wasting capacity, choose local devices on each
cluster with the same capacity.
The geometry of the new device is automatically 'RAID 1'.
Each cluster in the VPLEX may contribute a maximum of one component device to the new
distributed device.
This command can fail if there is not a sufficient number of meta volume slots. See the
troubleshooting section of the VPLEX procedures in the SolVe Desktop for a resolution to
this problem.



If there is pre-existing data on a storage-volume, and the storage-volume is not claimed
as being application consistent, converting an existing local RAID device to a distributed
RAID using the ds dd create command will not initiate a rebuild to copy the data to the
other leg. Data will exist at only one cluster. To prevent this, do one of the following:

1) Claim the disk with data using the application consistent flag, or

2) Create a single-legged RAID 1 or RAID 0 and add a leg using the device attach-mirror
command.

Use the set command to enable/disable automatic rebuilds on the distributed device. The
rebuild setting is immediately applied to the device.
◆ set rebuild-allowed true starts or resumes a rebuild if mirror legs are out of sync.

ds dd create 233
VPLEX CLI Command Descriptions

◆ set rebuild-allowed false stops a rebuild in progress.

When set to true, the rebuild continues from the point where it was halted. Only those
portions of the device that have not been rebuilt are affected. The rebuild does not start
over.

Example In the following example, the ds dd create command creates a new distributed device with
the following attributes:
◆ Name: ExchangeDD
◆ Devices:
• /clusters/cluster-2/devices/s6_exchange
• /clusters/cluster-1/devices/s8_exchange
◆ Logging volumes:
• /clusters/cluster-1/system-volumes/cluster_1_loggingvol
• /clusters/cluster-2/system-volumes/cluster_2_loggingvol
◆ Rule-set: rule-set-7a
VPlexcli:/distributed-storage/distributed-devices> ds dd create --name ExchangeDD --devices
/clusters/cluster-2/devices/s6_exchange,/clusters/cluster-1/devices/s8_exchange
--logging-volumes
/clusters/cluster-1/system-volumes/cluster_1_loggingvol,/clusters/cluster-2/system-volumes/cl
uster_2_loggingvol --rule-set rule-set-7a

In the following example, the ds dd create command creates a distributed device, and
with the default rule-set:
VPlexcli:/> ds dd create --name TestDisDevice --devices
/clusters/cluster-1/devices/TestDevCluster1, /clusters/cluster-2/devices/TestDevCluster2

Distributed-device 'TestDisDevice' is using rule-set 'cluster-2-detaches'.

See also ◆ device attach-mirror

◆ ds dd destroy
◆ local-device create

ds dd declare-winner
Declares a winning cluster for a distributed-device that is in conflict after a link outage.

Contexts All contexts.

In /distributed-storage/distributed-device context, command is declare-winner.
In /distributed-storage context, command is dd declare-winner.

Syntax ds dd declare-winner
[-c|--cluster] context path
[-d|--distributed-device] context path
[-f|--force]

Arguments Required arguments

[-c|--cluster] context path - * Specifies the winning cluster.

234 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

[-d|--distributed-device] context path - Specifies the distributed-device for which to

declare a winning cluster.
[-f|--force] - Forces the 'declare-winner' command to be issued.
* - argument is positional.

Description If the legs at two or more clusters are in conflict, use the ds dd declare-winner command to
declare a winning cluster for a specified distributed device.

Example
VPlexcli:/distributed-storage/distributed-devices> ds dd declare-winner --distributed-device
DDtest_4 –-cluster cluster-2 --force

See also ◆ ds dd create

ds dd destroy
Destroys the specified distributed-device(s).

Contexts All contexts.

Syntax ds dd destroy
[-d|--distributed-devices] context path,context path...
[-f|--force]

Arguments Required arguments

[-d|--distributed-device] context path, context path,... - * List of one or more
distributed-device(s) to destroy.
[-f|--force] - Forces the distributed-device(s) to be destroyed.
* - argument is positional.

Description In order to be destroyed, the target distributed device must not host virtual volumes.

Example VPlexcli:/distributed-storage/distributed-devices> ds dd destroy

/distributed-storage/distributed-devices/TestDisDevice

WARNING: The following items will be destroyed:

Context
------------------------------------------------------
/distributed-storage/distributed-devices/TestDisDevice

Do you wish to proceed? (Yes/No) yes

See also ◆ ds dd create

ds dd remove-all-rules
Removes all rules from all distributed devices.

Contexts All contexts.

Syntax ds dd remove-all-rules
[-f|--force]

ds dd destroy 235
VPLEX CLI Command Descriptions

Arguments Optional arguments

[-f|--force] - Force the operation to continue without confirmation.

Description From any context, removes all rules from all distributed devices.



There is NO undo for this procedure.

Example

VPlexcli:/distributed-storage/distributed-devices/dd_23> remove-all-rules

All the rules in distributed-devices in the system will be removed. Continue? (Yes/No) yes

See also ◆ ds rule destroy

◆ ds rule island-containing
◆ ds rule-set copy
◆ ds rule-set create
◆ ds rule-set destroy
◆ ds rule-set what-if

ds dd set-log
Allocates/unallocates segments of a logging volume to a distributed device or a
component of a distributed device.

Contexts All contexts.

Syntax ds dd set-log
[-d|--distributed devices] context path,context path...
[-c|--distributed-device-component] context path
[-l|--logging-volumes] context path,context path...
[-n|--cancel]

Arguments Required arguments

[-d|--distributed-devices] context path, context path... - One or more distributed-device for
which segments of the specified logging volume are allocated/unallocated.
All components of the distributed-device are included.
[-c|--distributed-device-component] context path - The distributed-device component for
which segments of the specified logging volume are allocated/unallocated.
[-l|--logging-volume] context path, context path... - One or more logging-volume where the
logging volume segments are allocated/unallocated. The target volume must be created
as logging-volume.
If not specified, the VPLEX configuration automatically allocates a logging volume for each
cluster.

236 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Optional arguments
[-n|--cancel] - Cancel/unallocate the log setting for the specified component of a
distributed-device or all the components of the specified distributed-device.



Use the --cancel argument very carefully.
A warning message is issued if attempting to cancel logging volumes on a distributed
device.
Removing the logging-volume for a device deletes the existing logging entries for that
device. A FULL rebuild of the device will occur after a link failure and recovery.
Removing the logging volume for all distributed devices will remove all entries from the
logging volume. In the event of a link failure and recovery, this results in a FULL rebuild of
all distributed devices.

Description Logging volumes keep track of 4 k byte blocks written during an inter-cluster link failure.
When the link recovers, VPLEX uses the information in logging volumes to synchronize the
mirrors.



If no logging volume is allocated to a distributed device, a full rebuild of the device will
occur when the inter-cluster link is restored after an outage.



Do not change a device’s logging volume unless the existing logging-volume is corrupted
or unreachable or to move the logging volume to a new disk.

Use the ds dd set-log command only to repair a corrupted logging volume or to transfer
logging to a new disk.
Use the --distributed-devices argument to allocate/unallocate segments on the specified
logging volume to the specified device.
Use the --distributed-devices-component argument to allocate/unallocate segments on
the specified logging volume to the specified device component.

Note: Specify either distributed devices or distributed device components. Do not mix
devices and components in the same command.

If the logging volume specified by the --logging-volume argument does not exist, it is
created.
Use the --cancel argument to delete the log setting for a specified device or device
component.
This command can fail if there is not a sufficient number of meta volume slots. See the
troubleshooting procedures for VPLEX in the SolVe Desktop for a resolution to this
problem.

Example Allocate segments of a logging volume to a distributed device:

ds dd set-log 237
VPLEX CLI Command Descriptions

VPlexcli:/distributed-storage/distributed-devices/TestDisDevice> ds dd set-log
--distributed-devices TestDisDevice --logging-volumes
/clusters/cluster-2/system-volumes/New-Log_Vol

Example Remove the logging volume for a distributed device:

VPlexcli:/distributed-storage/distributed-devices/TestDisDevice> ds dd set-log
--distributed-devices TestDisDevice --cancel

Example Attempt to cancel a logging volume for a distributed device that is not fully logged:



Issuing the cancel command on a distributed device that is not fully logged will result in a
warning message.

VPlexcli:/distributed-storage/distributed-devices/dr1_C12_0249> ds dd set-log
--distributed-devices dr1_C12_0249 --cancel

WARNING: This command will remove the logging segments from distributed device 'dr1_C12_0249'.
If a distributed device is not fully logged, it is vulnerable to full rebuilds following
inter-cluster WAN link failure or cluster failure.
It is recommended that the removed logging-segments be restored as soon as possible.

See also ◆ logging-volume create

ds rule destroy
Destroys an existing rule.

Contexts All contexts.

In /distributed-storage context, command is rule destroy.

Syntax ds rule destroy

[-r|--rule] rule

Arguments Required arguments

[-r|--rule] rule - Specifies the rule to destroy.

Description A rule-set contains rules. Use the ll command in the rule-set context to display the rules in
the rule-set.

Example Use the ds rule destroy command to destroy a rule in the rule set.
VPlexcli:/distributed-storage/rule-sets/ruleset_recreate5/rules> ll
RuleName RuleType Clusters ClusterCount Delay Relevant
-------- ----------------- --------- ------------ ----- --------
rule_1 island-containing cluster-1 2 10s true

VPlexcli:/distributed-storage/rule-sets/ruleset recreate5/rules> rule destroy rule_1

See also ◆ ds rule island-containing

◆ ds rule-set copy
◆ ds rule-set create

238 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ ds rule-set destroy
◆ ds rule-set what-if

ds rule island-containing
Adds a island-containing rule to an existing rule-set.

Contexts All contexts.

In /distributed-storage context, command is rule island-containing.

Syntax ds rule island-containing

[-c|--clusters] context path,context path...
[-d|--delay] delay
[-r|rule-set] context path

Arguments Required arguments

[-c|--clusters] context path, context path... - * Clusters to which this rule applies.
[-d|--delay] delay - * Sets the delay after a link outage before the rule is applied. Values
must a positive integer and end with one of the following units:
s - delay timer in seconds (default unit)
min - delay timer in seconds
h - delay timer in hours
[-r|--rule-set] - Rule-set to which this rule is added.

* - argument is positional.

Description Describes when to resume I/O on all clusters in the island containing the specified cluster.

Example In the following example, the rule island-containing command creates a rule that dictates:
◆ VPLEX waits for 10 seconds after a link failure and then:
◆ Resumes I/O to the island containing cluster-1,
◆ Detaches any other islands.
VPlexcli:/distributed-storage/rule-sets/TestRuleSet/rules> ds rule island-containing
--clusters cluster-1 --delay 10s

VPlexcli:/distributed-storage/rule-sets/TestRuleSet/rules> ll
RuleName RuleType Clusters ClusterCount Delay Relevant
-------- ----------------- --------- ------------ ----- --------
rule_1 island-containing cluster-1 - 10s true

See also ◆ ds dd remove-all-rules

◆ ds rule destroy
◆ ds rule-set copy
◆ ds rule-set create
◆ ds rule-set destroy
◆ ds rule-set what-if

ds rule island-containing 239

VPLEX CLI Command Descriptions

ds rule-set copy
Copy an existing rule-set.

Contexts All contexts.

In /distributed-storage/rule-sets context, command is copy.
In /distributed-storage context, command is rule-set copy.

Syntax ds rule-set copy

[-s|--source] rule-set
[-d|--destination] rule-set name

Arguments Required arguments

[-s|--source] rule-set - * Source rule-set.
[-d|--destination] new-rule-set - The destination rule-set name.
* - argument is positional.

Description Copies an existing rule-set and assigns the specified name to the copy.

Example
VPlexcli:/distributed-storage/rule-sets> ll
Name PotentialConflict UsedBy
------------------ ----------------- ----------------------------------------
TestRuleSet false

VPlexcli:/distributed-storage/rule-sets> rule-set copy --source TestRuleSet --destination

CopyOfTest
VPlexcli:/distributed-storage/rule-sets> ll
Name PotentialConflict UsedBy
------------------ ----------------- ----------------------------------------
CopyOfTest false
TestRuleSet false

See also ◆ ds dd remove-all-rules

◆ ds rule destroy
◆ ds rule island-containing
◆ ds rule-set create
◆ ds rule-set destroy
◆ ds rule-set what-if

ds rule-set create
Creates a new rule-set with the given name and encompassing clusters.

Contexts All contexts.

In /distributed-storage/rule-sets context, command is create.
In /distributed-storage context, command is rule-set create.

Syntax ds rule-set create

[-n|--name] rule-set

240 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Required arguments

[-n|--name] rule-set - Name of the new rule-set.

Examples Create a rule-set:

VPlexcli:/> ds rule-set create --name TestRuleSet

Name PotentialConflict UsedBy

-------------- ----------------- ------
TestRuleSet false

See also ◆ ds dd remove-all-rules

◆ ds rule destroy
◆ ds rule island-containing
◆ ds rule-set copy
◆ ds rule-set create
◆ ds rule-set destroy
◆ ds rule-set what-if
◆ set

ds rule-set destroy
Destroys an existing rule-set.

Contexts All contexts.

In /distributed-storage/rule-sets context, command is destroy.
In /distributed-storage context, command is rule-set destroy.

Syntax ds rule-set destroy

[-r|--rule-set] rule-set

Arguments Required arguments

[-r|--rule-set] rule-set - Name of the rule-set to destroy.

Description Deletes the specified rule-set. The specified rule-set can be empty or can contain rules.
Before deleting a rule-set, use the set command to detach the rule-set from any virtual
volumes associated with the rule-set.

Example Delete a rule-set:

VPlexcli:/distributed-storage/rule-sets/NewRuleSet> ds rule-set destroy NewRuleSet
Context '/distributed-storage/rule-sets/NewRuleSet' has been removed.

In the following example:

◆ The ll command displays to which devices the rule-set is attached.
◆ The set rule-set name “” command detaches the rule set from a device.
◆ The ds rule-set destroy command deletes the rule-set.
VPlexcli:/distributed-storage/rule-sets/TestRuleSet> ll

ds rule-set destroy 241

VPLEX CLI Command Descriptions

Attributes:
Name Value
------------------ ------------------------
key ruleset_5537985253109250
potential-conflict false
used-by dd_00

VPlexcli:/distributed-storage/rule-sets/TestRuleSet> cd
//distributed-storage/distributed-devices/dd_00

VPlexcli:/distributed-storage/distributed-devices/dd_00>set rule-set-name ""

Removing the rule-set from device 'dd_00' could result in data being unavailable during a WAN
link outage. Do you wish to proceed ? (Yes/No) yes

VPlexcli:/distributed-storage/distributed-devices/dd_00>ds rule-set destroy TestRuleSet

See also ◆ ds dd remove-all-rules

◆ ds rule destroy
◆ ds rule island-containing
◆ ds rule-set copy
◆ ds rule-set create
◆ ds rule-set what-if
◆ set

ds rule-set what-if
Tests if/when I/O is resumed at individual clusters, according to the current rule-set.

Contexts All contexts.

In/distributed-storage/rule-sets context, command is what-if.
In /distributed-storage context, command is rule-set what-if.

Syntax ds rule-set what-if

[-i|--islands] “cluster-1,cluster-2”
[-r|--rule-set] context path

Arguments Required arguments

[-i|--islands] “cluster-1,cluster-2” - List of islands, in quotes. The clusters are separated by
commas, the islands by a space.
[-r|--rule-set] context path - Context path of the rule-set used in the what-if scenario.

Description Only two clusters and one island are supported for the current release.

Example Test a rule-set:

VPlexcli:/distributed-storage/rule-sets> ds rule-set what-if --islands "cluster-1,cluster-2"
--rule-set TestRuleSet
IO does not stop.

See also ◆ ds dd remove-all-rules

◆ ds rule destroy

242 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ ds rule island-containing
◆ ds rule-set copy
◆ ds rule-set create
◆ ds rule-set destroy

ds summary
Display summary information about distributed-devices.

Contexts All contexts.

In /distributed-storage context, command is summary.

Syntax ds summary

Description Displays summarized information for all distributed-devices.

Displays more detailed information for any device with a health-state or operational-status
other than 'ok', and a service-status other than 'running'.
Displays devices per cluster, and calculates total and free capacity.
Use the --verbose argument to display additional information about unhealthy volumes in
each consistency group.

Example Display summary information when no devices are unhealthy:

VPlexcli:/distributed-storage> ds summary

Slot usage summary:

Total 912 slots used by distributed device logging segments.

Distributed devices health summary:

Total 25 devices, 0 unhealthy.

Cluster summary:
Cluster cluster-2 : 25 distributed devices.
Cluster cluster-1 : 25 distributed devices.

Capacity summary:
0 devices have some free capacity.
0B free capacity of 500G total capacity.

Distributed volume summary:

Total 25 distributed devices in consistency groups, 0 unhealthy.
Total 0 distributed devices not in consistency groups, 0 unhealthy

Example Display summary information when one or more devices are unhealthy:
VPlexcli:/> ds summary

Slot usage summary:

Total 912 slots used by distributed device logging segments.

Distributed Volumes (not in Consistency Groups) Unhealthy Summary:

Device Name Health State Operational Status Service Status

----------- ------------- ------------------ -------------------
DR10 major-failure stressed cluster-unreachable

ds summary 243
VPLEX CLI Command Descriptions

Distributed volumes (in consistency groups) unhealthy summary:

CG Name Cache Mode Number of Cluster Operational Status Details

---------------- ------------ Unhealthy --------- Status -------------------------------------------
---------------- ------------ Vols --------- ---------------- -------------------------------------------
---------------- ------------ ------------- --------- ---------------- -------------------------------------------
AA_ACW_Cluster12 asynchronous 9 cluster-1 unknown []
cluster-2 suspended [cluster-departure,
restore-link-or-choose-winner]
AP_ACW_Cluster1 asynchronous 10 cluster-1 unknown []
cluster-2 suspended [cluster-departure,
restore-link-or-choose-winner]
AP_ACW_Cluster2 asynchronous 5 cluster-1 unknown []
cluster-2 suspended [cluster-departure,
restore-link-or-choose-winner]

Distributed devices health summary:

Total 25 devices, 25 unhealthy.

Cluster summary:
Cluster cluster-2 : 25 distributed devices.
Cluster cluster-1 : 25 distributed devices.

Capacity summary:
0 devices have some free capacity.
0B free capacity of 500G total capacity.

Distributed volume summary:

Total 24 distributed devices in consistency groups, 24 unhealthy.
Total 1 distributed devices not in consistency groups, 1 unhealthy.

Example Use the --verbose argument to display detailed information about unhealthy volumes in
each consistency group:
VPlexcli:/> ds summary --verbose

Slot usage summary:

Total 912 slots used by distributed device logging segments.

Distributed Volumes (not in Consistency Groups) Unhealthy Summary:

Device Name Health State Operational Status Service Status

----------- ------------- ------------------ -------------------
DR10 major-failure stressed cluster-unreachable

Distributed volumes (in consistency groups) unhealthy summary:

CG Name Cache Mode Number of Cluster Operational Status Details
---------------- ------------ Unhealthy --------- Status -------------------------------------------
---------------- ------------ Vols --------- ---------------- -------------------------------------------
---------------- ------------ ------------- --------- ---------------- -------------------------------------------
AA_ACW_Cluster12 asynchronous 9 cluster-1 unknown []
cluster-2 suspended [cluster-departure,
restore-link-or-choose-winner]
AP_ACW_Cluster1 asynchronous 10 cluster-1 unknown []
cluster-2 suspended [cluster-departure,
restore-link-or-choose-winner]
AP_ACW_Cluster2 asynchronous 5 cluster-1 unknown []
cluster-2 suspended [cluster-departure,
restore-link-or-choose-winner]

Distributed volumes (in consistency groups) unhealthy details:

CG Name Unhealthy Vols

---------------- -----------------------------------------------------------------------------------------------------
AA_ACW_Cluster12 ['DR11_vol', 'DR12_vol', 'DR13_vol', 'DR14_vol', 'DR15_vol', 'DR16_vol', 'DR17_vol', 'DR18_vol',
'DR19_vol']
AP_ACW_Cluster1 ['DR20_vol', 'DR21_vol', 'DR22_vol', 'DR23_vol', 'DR24_vol', 'DR25_vol', 'DR6_vol', 'DR7_vol',
'DR8_vol', 'DR9_vol']
AP_ACW_Cluster2 ['DRa_12_vol', 'DRb_12_vol', 'DRc_12_vol', 'DRd_12_vol', 'DRe_12_vol']

Distributed devices health summary:

244 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Total 25 devices, 25 unhealthy.

Cluster summary:
Cluster cluster-2 : 25 distributed devices.
Cluster cluster-1 : 25 distributed devices.

Capacity summary:
0 devices have some free capacity.
0B free capacity of 500G total capacity.

Distributed volume summary:

Total 24 distributed devices in consistency groups, 24 unhealthy.
Total 1 distributed devices not in consistency groups, 1 unhealthy.
luster cluster-1 : 25 distributed devices.
.

Table 13 ds summary field descriptions (page 1 of 4)

Field Description

Distributed Volumes (not in Consistency Groups) Unhealthy Summary:

Device Name Name of the device.

Health State major failure - One or more children of the distributed device is out-of-date and will
never rebuild, possibly because they are dead or unavailable.
minor failure - Either one or more children of the distributed device is out-of-date and
will rebuild, or the Logging Volume for the distributed device is unhealthy.
non-recoverable error - VPLEX cannot determine the distributed device's Health state.
ok - The distributed device is functioning normally.
unknown - VPLEX cannot determine the device's health state, or the state is invalid.

Operational Status degraded - The distributed device may have one or more out-of-date children that will
eventually rebuild.
error - One or more components of the distributed device is hardware-dead.
ok - The distributed device is functioning normally.
starting - The distributed device is not yet ready.
stressed - One or more children of the distributed device is out-of-date and will never
rebuild.
unknown - VPLEX cannot determine the distributed device's Operational state, or the
state is invalid.

Service Status cluster unreachable - VPLEX cannot reach the cluster; the status is unknown.
need resume - The other cluster detached the distributed device while it was
unreachable. The distributed device needs to be manually resumed for I/O to resume at
this cluster.
need winner - All clusters are reachable again, but both clusters had detached this
distributed device and resumed I/O. You must pick a winner cluster whose data will
overwrite the other cluster's data for this distributed device.
potential conflict - The clusters have detached each other resulting in a potential for
detach conflict.
running - The distributed device is accepting I/O.
suspended - The distributed device is not accepting new I/O; pending I/O requests are
frozen.
winner-running - This cluster detached the distributed device while the other cluster was
unreachable, and is now sending I/O to the device.

Cluster Summary Number of distributed devices on each cluster.

Capacity Summary Number of devices with free capacity, amount of free capacity for the cluster, and total
capacity for all clusters.

Distributed volumes (in consistency groups) unhealthy summary:

ds summary 245
VPLEX CLI Command Descriptions

Table 13 ds summary field descriptions (page 2 of 4)

Field Description

CG Name Name of the consistency group of which the unhealthy device is a member.

Cache Mode Cache mode of the consistency group.

Synchronous - Supported on VPLEX Local and VPLEX Metro configurations where
clusters are separated by up to 5 ms of latency. In synchronous cache mode, writes to
the back-end storage volumes are not acknowledged to the host until the back-end
storage volumes acknowledge the write.
Asynchronous - Supported on VPLEX Geo configurations where clusters separated by up
to 50 ms of latency. In asynchronous cache mode, host writes to a distributed volume
are acknowledged back to the host after the data is protected in the cache of another
director in the local cluster.

Number of unhealthy Number of unhealthy volumes in the consistency group.

volumes

246 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Table 13 ds summary field descriptions (page 3 of 4)

Field Description

Cluster Visibility of the consistency group.

cluster-1 - consistency group is visible only at cluster-1.
cluster-2- consistency group is visible only at cluster-2.
cluster-1, cluster-2 - consistency group is visible at both clusters.

Operational Status Current status for this consistency group with respect to each cluster on which it is
visible.
ok - I/O can be serviced on the volumes in the consistency group.
suspended - I/O is suspended for the volumes in the consistency group. The reasons
are described in the “operational status: details”.
degraded - I/O is continuing, but there are other problems described in “operational
status: details”:
unknown - The status is unknown, likely because of lost management connectivity.

ds summary 247
VPLEX CLI Command Descriptions

Table 13 ds summary field descriptions (page 4 of 4)

Field Description

Status Details If operational status is “ok” this field is empty: “[ ]”. Otherwise, it displays additional
information, which may be any of the following:
temporarily-synchronous - This asynchronous consistency group has temporarily
switched to 'synchronous' cache mode because of a director failure.
requires-resolve-conflicting-detach - After the inter-cluster link is restored, two clusters
have discovered that they have detached one another and resumed I/O independently.
The clusters are continuing to service I/O on their independent versions of the data. The
consistency-group resolve-conflicting-detach command must be used to make the view
of data consistent again at the clusters.
rebuilding-across-clusters - One or more distributed member volumes is being rebuilt.
At least one volume in the group is out of date at that cluster and is re-syncing. If the link
goes out at this time the entire group is suspended. Use the rebuild status command to
display which volume is out of date at which cluster.
rebuilding-within-cluster - One or more local rebuilds is in progress at this cluster.
data-safe-failure - A single director has failed. The volumes are still crash-consistent,
and will remain so, unless a second failure occurs before the first is recovered.
requires-resume-after-data-loss-failure - There have been at least two concurrent
failures, and data has been lost. For example, a director fails shortly after the
inter-cluster link fails, or when two directors fail at almost the same time. Use the
consistency-group resume-after-data-loss-failure command to select a winning cluster
and allow I/O to resume.
cluster-departure - Not all the visible clusters are in communication.
requires-resume-after-rollback - A cluster has detached its peer cluster and rolled back
the view of data, but is awaiting the consistency-group resume-after-rollback command
before resuming I/O. Displayed:
• For an asynchronous consistency group where both clusters have been writing, that
is where both clusters are active.
• At the winning side when a detach rule fires, or shortly after the consistency-group
choose-winner command picks a winning cluster.
requires-resume-at-loser - Displayed on the losing side when the inter-cluster link heals
after an outage. After the inter-cluster link is restored, the losing cluster discovers that
its peer was declared the winner and resumed I/O. Use the consistency-group
resume-at-loser command to make the view of data consistent with the winner, and to
resume I/O at the loser.
restore-link-or-choose-winner - I/O is suspended at all clusters because of a cluster
departure, and cannot automatically resume. This can happen if:
• There is no detach-rule
• If the detach-rule is 'no-automatic-winner', or
• If the detach-rule cannot fire because its conditions are not met.
For example, if more than one cluster is active at the time of an inter-cluster link outage,
the 'active-cluster-wins' rule cannot take effect. When this detail is present, I/O will not
resume until either the inter-cluster link is restored, or the user intervenes to select a
winning cluster with the consistency-group choose-winner command.
unhealthy-devices - I/O has stopped in this consistency group because one or more
volumes is unhealthy and cannot perform I/O.
will-rollback-on-link-down - If there were a link-down now, the winning cluster would
have to roll back the view of data in order to resume I/O.

See also ◆ export port summary

◆ export storage-view summary
◆ extent summary
◆ local-device summary
◆ storage-volume summary

248 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ virtual-volume provision

event-test
Verifies that the management server can receive events from a director.

Contexts All contexts.

Syntax event-test
[-n|--directors] context path,context path...
[-c|--clusters] context path,context path...
[-l|--level][emergency|alert|critical|error|warning|
notice|info|debug]
[-o|--component] component
[-m|--message] “message”

Arguments Required arguments

[-l|--level] level - Level of the event. Must be one of the following:
emergency - System is unusable.
alert - Immediate action is required.
critical - Critical condition detected.
error - Significant error condition detected.
warning - Warning condition is detected.
notice - Normal, but significant condition.
info - Information messages.
debug - Detailed event information used by EMC for debugging.
Optional arguments
[-d|--directors] context path, context path... - One or more directors from which to send the
test event.
[-c|--clusters] context path,context path... - One or more clusters from which to send the
test event. Events are sent from every director in the specified cluster(s).
[-o|--component] - Text to include in the component portion of the test message.
[-m|--message] “message” - Text of message to send in event test, enclosed in quotes.
This text is written to the firmware log prefixed by “EVENT-TEST”.

Description Tests the logging path from one or mores director to the management server.
Every component in the software that runs on the director logs messages to signify
important events. Each logged message/event is transferred from the director to the
management server and into the firmware log file.
Use this command to verify this logging path is ok. Specify what level of event should be
generated. Optionally, specifiy the text to appear in the component portion of the test
message.
Check the appropriate firmware log for the event created by this command.

Example In the following example:

event-test 249
VPLEX CLI Command Descriptions

◆ The event test command creates an alert event for the specified director.
◆ The exit command exits the CLI.
◆ The tail command displays the firmware log for the director.
VPlexcli:/> event-test --director director-2-1-A --level alert --message "Test Alert"

VPlexcli:/> exit
Connection closed by foreign host.

service@ManagementServer:~> tail /var/log/VPlex/cli/firmware.log_20100903092147

128.221.253.67/xmmg/log:5988:W/"2343":324:<1>2010/09/07 15:18:15.82: test/1 EVENT-TEST: Test
Alert

exec
Executes an external program.

Contexts All contexts.

Syntax exec command name word*

Description The program can be executed with zero or more arguments.

Note: The correct syntax for program names and arguments depends on the host system.

Example To display the date and time on Director-1-1-A:

VPlexcli:/> exec ssh 128.221.253.35 date
Tue Sep 21 14:32:52 UTC 2010

exit
Exits the shell.

Contexts All contexts.

Syntax exit
[-e|--exit-code] exit-code
[-s|--shutdown]

Arguments Optional arguments

[-e|--exit-code] exit code - Returns the specified value when the shell exits. If no exit code
is specified, then 0 is returned.
[-s|--shutdown] - When running in server mode, shuts down the shell instead of closing the
socket. No effect if not running in server mode.

Description If the shell is not embedded in another application, the shell process will stop.

Example VPlexcli:/> exit

Connection closed by foreign host.
service@ManagementServer:~>

250 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

export initiator-port discovery

Discovers initiator ports on the front-end fabric.

Contexts Cluster context and below.

In /clusters/cluster/exports context, command is initiator-port discovery.
In/clusters/cluster/exports/initiator-ports context, command is discovery.

Syntax export initiator-port discovery

[-t|--timeout] 1 - 3600
[-w|--wait] 1 - 3600
[-c|--cluster] context path]

Arguments Optional arguments

[-t|--timeout] seconds - The maximum number of seconds to wait for the front-end fabric
discovery operation to complete.
Default: 300.
Range: 1- 3600.

[-w|--wait] - The maximum number of seconds to wait for a response from the fabric
discovery.
Default: 10.
Range: 1- 3600.
[-c|--cluster] context path - Discover initiator ports on the specified cluster.

Description Initiator discovery finds unregistered initiator-ports on the front-end fabric and determines
the associations between the initiator ports and the target ports.
Use the ll command in initiator-ports context to display the same information for small
configurations (where timeout does not occur)
Use the export initiator-port discovery command for large configurations in which ls
command may encounter timeout limits.

Example Discover initiator ports on another cluster:

VPlexcli:/clusters/cluster-1/exports/initiator-ports> discovery --cluster cluster-2
Name port-wwn node-wwn type Target Port Names
------------- ------------------ ------------------ ------- --------------------------
LicoJ013_hba1 0x10000000c97b1f3d 0x10000000c97b1f3d sun-vcs
LicoJ009_hba1 0x10000000c992c841 0x10000000c992c841 sun-vcs
LicoJ007_hba3 0x10000000c98a9dae 0x10000000c98a9dae sun-vcs
LicoJ011_hba2 0x10000000c992bf61 0x10000000c992bf61 sun-vcs
LicoJ010_hba1 0x10000000c992c84b 0x10000000c992c84b sun-vcs P000000003CA000E6-A1-FC00,
P000000003CA001CB-A1-FC00,
P000000003CB000E6-B1-FC00,
P000000003CB001CB-B1-FC00
.
.
.

See also ◆ export initiator-port register

export initiator-port register

Registers an initiator-port, associating it with a SCSI address.

export initiator-port discovery 251

VPLEX CLI Command Descriptions

Contexts All contexts.

In /clusters/cluster/exports context, command is initiator-port register.
In /clusters/cluster/exports/initiator-ports context, command is register.

Syntax export initiator-port register

[-c|--cluster] context path
[-t|--type]{hpux|sun-vcs|aix|recoverpoint|default}
[-i|--initiator-port] initiator-port
[-p|--port] port

Arguments Required arguments

[-i|--initiator-port] initiator-port - * Name to assign to the registered port. Name must be
unique in the system. Command fails if the specified name is already in use.
[-p|--port] port - * Port identifier.
For Fibre Channel initiators, a WWN pair as follows: portWWN|nodeWWN. nodeWWN is
optional. Each WWN is either '0x' followed by one or more hex digits, or an abbreviation
using the format: string:number[,number]. Following are four examples:
0xd1342a|0xd1342b
hyy1:194e,4|hyy1:194e
0xd1342a
hyy1:194e,4

* - argument is positional.

Optional arguments
[-c|--cluster] context path - Cluster on which the initiator port is registered.
[-t|--type] {hpux|sun-vcs|aix|recoverpoint|default} - Type of initiator port. If no type is
specified, the default value is used.
hpux - Hewlett Packard UX
sun-vcs - Sun Solaris
aix - IBM AIX
recoverpoint - EMC RecoverPoint
default - If no type is specified.

Description Registers an initiator-port and associates it with a SCSI address. For Fibre Channel, the
SCSI address is represented by a WWN pair. Use the ll command in
/engines/engine/directors/director/hardware /ports/port context to display portWWNs
and nodeWWNs.

Example Register an existing initiator port on Fibre Channel:

VPlexcli:/clusters/cluster-1/exports/initiator-ports> register --initiator-port w2k8InitFC
--port 0xd1342a|0xd1342b

See also ◆ export initiator-port discovery

◆ export initiator-port unregister
◆ export target-port renamewwns

252 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ set

export initiator-port register-host

Creates a view, and registers each port WWN /name pair as an initiator port in that view.

Contexts All contexts.

In /clusters/cluster/exports context, command is initiator-port register-host.
In /clusters/cluster/exports/initiator-ports context, command is register-host.

Syntax export initiator-port register-host

[-p|--ports] port,port...
[-f|--file] file
[-c|--cluster] cluster context

Arguments Required arguments

[-f|--file] file - * The host declaration file path name.

Optional arguments
[-c|--cluster] cluster context - * The cluster at which to create the view.
[-p|--ports] port,port... - List of port names. If omitted, all ports at the cluster will be used.
Entries must be separated by commas.
* - argument is positional.

Description Reads host port WWNs (with optional node WWNs) and names from a host declaration file.
Creates a view, registering each port WWN /name pair as an initiator port in that view.
The host description file contains one line for each port on the host in the following
format:
<port WWN> [|node WWN>] <port name>
Hosts must be registered in order to be exported (added to a storage view). Registering
consists of naming the initiator and listing its ports WWN/GUID.
Each port of a server’s HBA/HCA must be registered as a separate initiator.

See also ◆ export initiator-port discovery

◆ export initiator-port unregister

export initiator-port show-logins

Displays the initiator port logins to the VPLEX front-end target ports.

Context All contexts.

Syntax export initiator-port show-logins

[-i|--initiator-ports] initiator ports [, initiator ports...]
[-h|--help]

export initiator-port register-host 253

VPLEX CLI Command Descriptions

Arguments Optional arguments

[-i|--initiator-ports] initiator ports [, initiator ports...] - * Specifies the initiator-ports for
which the login information is required.
[-h|--help] - Displays command line help.
* - argument is positional.

Description Displays a list of target port logins for the specified initiator ports.

Example Shows target port logins for all the initiator ports in VPLEX:
VPlexcli:/> export initiator-port show-logins *

Cluster Names Initiator Port Names Target Port Names

------------ ------------------------------- -------------------------
cluster-1 initiator_11 P000000003CA0014C-A0-FC01

cluster-1 initiator_12 P000000003CA0014C-A0-FC00

P000000003CB0014C-B0-FC00

cluster-2 initiator_21 P000000003CA00150-A0-FC01

P000000003CB00150-B0-FC01

cluster-2 initiator_22 P000000003CA00150-A0-FC00

P000000003CB00150-B0-FC00

Example Shows target port logins for initiator ports 11 and 22:
VPlexcli:/> export initiator-port show-logins -i initiator_11,initiator_22

Cluster Names Initiator Port Names Target Port Names

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

cluster-1 initiator_11 P000000003CA0014C-A0-FC01

cluster-2 initiator_22 P000000003CA00150-A0-FC00

P000000003CB00150-B0-FC00

Example Shows no target port logins for initiator port 22:

VPlexcli:/> export initiator-port show-logins initiator_22

Cluster Names Initiator Port Names Target Port Names

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

cluster-2 initiator_22 None

See also ◆ export initiator-port discovery

◆ export initiator-port register
◆ export initiator-port register-host
◆ export initiator-port unregister

254 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

export initiator-port unregister

Unregisters the specified initiator-port(s).

Contexts All contexts.

In /clusters/cluster/exports context, command is initiator-port unregister.
In /clusters/cluster/exports/initiator-ports context, command is unregister.

Syntax export initiator-port unregister

[-f|--force]
[-i|--initiator-port] initiator port [,initiator port...]

Arguments Required arguments

[-i|--initiator-port] initiator port [, initiator port...] - * One or more initiator ports to remove.
Entries must be separated by commas.

Optional arguments
[-f|--force] - Destroys the initiator-ports even if they are in use.
* - argument is positional.

Example
VPlexcli:> export initiator-port unregister -i win2k3_105_port1

See also ◆ export initiator-port register

export port summary

Displays a summary of exported ports for one or more clusters.

Contexts All contexts.

In /clusters/cluster/exports context, command is port summary.
In/clusters/cluster/exports/ports context, command is summary.

Syntax export port summary

[-c|--clusters] cluster [, cluster,...]
[-h|--help]
[--verbose]

Arguments Optional arguments

[-c|--clusters] cluster [, cluster,...] - Displays a summary of export ports for only the
specified cluster(s).
[-h|--help] - Displays command line help.
[--verbose] - Displays the names of the unhealthy volumes exported on each port.

Description Prints a summary of the views and volumes exported on each port, and a detailed
summary of the unhealthy ports.
In the root context, displays information for all clusters.
In /cluster context or below, displays information for only the current cluster.

Example Display port health for a specified cluster:

export initiator-port unregister 255

VPLEX CLI Command Descriptions

VPlexcli:/> export port summary --clusters cluster-1

Port health summary(cluster-1):

port name export status view summary

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

P000000003CA00147-A0-FC01 suspended no unhealthy views

P000000003CA00147-A0-FC03 suspended no unhealthy views
P000000003CA00147-A1-FC01 suspended no unhealthy views
.
.
.
port name health state enabled views virtual-volumes
------------------------- ------------ ------- ----- ---------------
P000000003CA00147-A0-FC00 healthy true 1 1
P000000003CA00147-A0-FC02 healthy true 2 28
P000000003CA00147-A1-FC00 healthy true 1 1
.
.
.
P000000003CB00147-B0-FC03 unhealthy true 0 0
P000000003CB00147-B1-FC01 unhealthy true 0 0
P000000003CB00147-B1-FC03 unhealthy true 0 0

Total 16 ports, 8 unhealthy.

Display port health using verbose argument:

VPlexcli:/clusters/cluster-1/exports/ports> summary --verbose
Port health summary(cluster-1):

port name export status view summary

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

P000000003CA00147-A0-FC01 suspended no unhealthy views

P000000003CA00147-A0-FC03 suspended no unhealthy views
P000000003CA00147-A1-FC01 suspended no unhealthy views
.
.
.
port name health state enabled view summary
------------------------- ------------ ------- -------------------------

P000000003CA00147-A0-FC00 healthy true view virtual-volumes

-------- ---------------
LicoJ013 1

P000000003CA00147-A0-FC02 healthy true view virtual-volumes

-------- ---------------
LicoJ013 1
LicoJ009 27
.
.
.
P000000003CB00147-B0-FC03 unhealthy true no views

P000000003CB00147-B1-FC01 unhealthy true no views

P000000003CB00147-B1-FC03 unhealthy true no views

Total 16 ports, 8 unhealthy.

See also ◆ ds summary

◆ export storage-view summary

256 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ extent summary
◆ local-device summary
◆ storage-volume summary
◆ virtual-volume provision

export storage-view addinitiatorport

Adds the specified initiator port(s) to a storage view.

Contexts All contexts.

In /clusters/cluster/exports context, command is storage-view addinitiatorport.
In /clusters/cluster/exports/storage-views context, command is addinitiatorport.

Syntax export storage-view addinitiatorport

[-v|--view] storage-view context path
[-i|--initiator-ports] initiator ports [, initiator ports...]

Arguments Required arguments

[-i|--initiator-ports] initiator ports [, initiator ports...]- * List of one or more initiator ports to
add to the view. Entries must be separated by commas.

Optional arguments
[-v|--view] storage-view context path - View to which to add the specified initiator port(s).
* - argument is positional.

Description Select ports from two different directors so as to maximize redundancy.

Example Add the initiator iE_209_hba0 to the view named Dell_209_view:

VPlexcli:/clusters/cluster-1/exports> storage-view addinitiatorport --view Dell_209_view
--initiator-ports iE_209_hba0

See also ◆ export storage-view create

◆ export storage-view removeinitiatorport

export storage-view addport

Adds the specified port(s) to the storage view.

Contexts All contexts.

In clusters/cluster/exports/storage-views/storage-view context, command is addport.

Syntax export storage-view addport

[-v|--view] context path
[-p|--ports] context path,context path...

Arguments Required arguments

[-p|--ports] context path,context path ... - * List of one or more ports to be added to the
view. Entries must be separated by commas.

export storage-view addinitiatorport 257

VPLEX CLI Command Descriptions

Optional arguments
[-v|--view] context path - Storage view to which to add the specified port(s).
* - argument is positional.

Description Use the ll /clusters/cluster/exports/ports command to display ports on the cluster.

Example VPlexcli:/clusters/cluster-1/exports/storage-views/TestStorageView>
export storage-view addport --ports P000000003CB00147-B0-FC03

See also ◆ export storage-view create

◆ export storage-view removeport

export storage-view addvirtualvolume

Adds a virtual volume to a storage view.

Contexts All contexts.

In /clusters/cluster/exports context, command is storage-view addvirtualvolume.
In /clusters/cluster/exports/storage-views context, command is addvirtualvolume.

Syntax export storage-view addvirtualvolume

[-v|--view] context path
[-f|--force]
[-o|--virtual-volumes] virtual-volume, virtual-volume...

Arguments Required arguments

[-o|--virtual-volumes] virtual volume,virtual volume ... - * List of one or more
virtual-volumes or LUN-virtual-volume pairs. Entries must be separated by commas.
LUN-virtual-volume pairs must be enclosed in parentheses (). Virtual-volumes and
LUN-virtual-volume pairs can be typed on the same command line.
When only virtual-volumes are specified, the next available LUN is automatically assigned
by VPLEX.

Optional arguments
[-v|--view] context path> - View to which to add the specified virtual volume(s).
[-f|--force] - Force the virtual-volumes to be added to the view even if they are already in
use, if they are already assigned to another view, or if there are problems determining the
view's state. Virtual-volumes that already have a LUN in the view will be re-mapped to the
newly-specified LUN.
* - argument is positional.

Description Add the specified virtual volume to the specified storage view. Optionally, specify the LUN
to assign to the virtual volume. Virtual volumes must be in a storage view in order to be
accessible to hosts.
When virtual-volumes are added using only volume names, the next available LUN number
is automatically assigned.
Virtual-volumes and LUN-virtual-volume pairs can be specified in the same command line.
For example:

258 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

r0_1_101_vol,(2,r0_1_102_vol),r0_1_103_vol

To modify the LUN assigned to a virtual volume, specify a virtual volume that is already
added to the storage view and provide a new LUN.

Example Add a virtual-volumeSymm1254_7BF_1_vol to the storage view E_209_view:

VPlexcli:/clusters/cluster-1/exports> storage-view addvirtualvolume --view E_209_view
--virtual-volumes Symm1254_7BF_1_vol

Example Modify the LUN assigned to a virtual volume already added to a view:
◆ The ll command in storage view context displays the LUN (0) assigned to a storage
volume.
◆ The export storage-view addvirtualvolume (LUN,Virtual-volume) --force command
assigns a new LUN to the virtual volume.
◆ The ll command in storage view context displays the new LUN assigned to a storage
volume:
VPlexcli:/clusters/cluster-1/exports/storage-views/TestStorageView> ll
Name Value
------------------------ --------------------------------------------------
controller-tag -
initiators []
operational-status stopped
port-name-enabled-status [P000000003CA00147-A1-FC01,true,suspended,
P000000003CB00147-B0-FC01,true,suspended]
ports [P000000003CA00147-A1-FC01, P000000003CB00147-B0-FC01]
virtual-volumes [(0,TestDisDevice_vol,VPD83T3:6000144000000010a0014760d64cb325,16G)]

VPlexcli:/clusters/cluster-1/exports/storage-views/TestStorageView> export storage-view

addvirtualvolume (5,TestDisDevice_vol) --force
WARNING: Volume 'TestDisDevice_vol' already has LUN 0 in this view; remapping to LUN 5.

VPlexcli:/clusters/cluster-1/exports/storage-views/TestStorageView> ll
Name Value
------------------------ --------------------------------------------------
controller-tag -
initiators []
operational-status stopped
port-name-enabled-status [P000000003CA00147-A1-FC01,true,suspended,
P000000003CB00147-B0-FC01,true,suspended]
ports [P000000003CA00147-A1-FC01, P000000003CB00147-B0-FC01]
virtual-volumes [(5,TestDisDevice_vol,VPD83T3:6000144000000010a0014760d64cb325,16G)]

Example Add a synchronous virtual volume to a view using the --force option from the root context:
VPlexcli:/> export storage-view addvirtualvolume --view
/clusters/Saul1/exports/storage-views/TestStorageView --virtual-volumes
dr710_20_C1Win_0038_12_vol --force

Volume {1} is synchronous and on a non-local device. Applications using this volume may
experience per I/O inter-cluster latency. If the applications are sensitive to this latency,
they may experience data unavailability. Do you wish to proceed ? (Yes/No)

See also ◆ export storage-view checkconfig

◆ export storage-view create
◆ export storage-view removevirtualvolume

export storage-view addvirtualvolume 259

VPLEX CLI Command Descriptions

export storage-view checkconfig

Checks the configuration of the views.

Contexts All contexts.

In /clusters/cluster/exports context, command is storage-view checkconfig.
In /clusters/cluster/exports/storage-views context, command is checkconfig.

Syntax export storage-view checkconfig

Description Performs the following checks:

◆ Identifies any virtual volumes that are exported more than once.
◆ Identifies views that contain only a single port.
◆ Identifies views that are disabled.

Example To check all view configurations for all clusters from the CLI, type:
VPlexcli:/> export storage-view checkconfig
Checking cluster cluster-1:
No errors found for cluster cluster-1.
Checking cluster cluster-2:
No errors found for cluster cluster-2.
Volume dd_13_vol is exported multiple times:
view: LicoJ009, lun: 14
view: LicoJ010, lun: 14
Volume dd_16_vol is exported multiple times:
view: LicoJ009, lun: 17
view: LicoJ010, lun: 17
Volume dd_12_vol is exported multiple times:
view: LicoJ009, lun: 13
view: LicoJ010, lun: 13
Volume dd_19_vol is exported multiple times:
view: LicoJ009, lun: 20
view: LicoJ010, lun: 20
.
.
.

See also ◆ export storage-view create

◆ export storage-view find
◆ export storage-view map
◆ export storage-view show-powerpath-interfaces

export storage-view create

Creates a view with the given ports.

Contexts All contexts.

Syntax export storage-view create

[-c|--cluster] context path
[-n|--name] name
[-p|--ports] context path,context path...

260 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Required arguments

[-n|--name] name - * Name of the new view. Must be unique throughout VPLEX.
[-p|--ports] context path,context path... - * List of one or more ports to add to the view.

Optional arguments
[-c|--cluster] context path - The cluster on which to create the view.
* - argument is positional.

Description A storage view is a logical grouping of front-end ports, registered initiators (hosts), and
virtual volumes used to map and mask LUNs. Storage views are used to control host
access to storage.
In order for hosts to access virtual volumes, the volumes must be in a storage view. A
storage view consists of:
◆ One or more initiators. Initiators are added to a storage view using the export
storage-view addinitiatorport command.
◆ One or more virtual-volumes. Virtual volumes are added to a storage view using the
export storage-view addvirtualvolume command.
◆ One or more FE ports. Ports are added to a storage view using the export storage-view
addport command.



The name assigned to the storage view must be unique throughout the VPLEX. In VPLEX
Metro or Geo configurations, the same name must not be assigned to a storage view on
the peer cluster.

Use the ll clusters/*/exports/storage-views command to display the names of existing

storage views before assigning a name.

Example Create a view named E_209_view for FE ports A0 and B0:

VPlexcli:/clusters/cluster-1/exports/storage-views> storage-view create --cluster
/clusters/cluster-1 --name E_209_View --ports
P000000601610428F-A0-FC00,P000000601610672E-B0-FC00

See also ◆ export storage-view addport

◆ export storage-view addinitiatorport
◆ export storage-view addvirtualvolume
◆ export storage-view destroy

export storage-view destroy

Destroys the specified storage view.

Contexts All contexts.

Syntax export storage-view destroy

[-f|--force]
[-v|--view] context path

export storage-view destroy 261

VPLEX CLI Command Descriptions

Arguments Required arguments

[-v|--view] context path ... - * Storage view to destroy.

Optional arguments
[-f|--force] - Force the storage view to be destroyed even if it is in use.
* - argument is positional.

Description Destroys the specified storage view.

Example VPlexcli:/> export storage-view destroy

/clusters/cluster-1/exports/storage-views/TestStorageView

See also ◆ export storage-view create

◆ export storage-view removeinitiatorport
◆ export storage-view removeport
◆ export storage-view removevirtualvolume

export storage-view find

Displays export views for a specified volume, LUN, initiator, or cluster. Displays next
available LUN number for all storage views.

Contexts Cluster/exports and below.

In /clusters/cluster/exports context, command is storage-view find.
In /clusters/cluster/exports/storage-views context, command is find.

Syntax export storage-view find

[-c|--cluster] cluster]
[-v|--volume] volume
[-l|--lun] LUN
[-i|--initiator] initiator
[-f|--free-lun]

Arguments Optional arguments

[-c|--cluster] cluster - Cluster to search for views.
[-v|--volume] volume - Find the views exporting the specified volume. Identify the volume
by name, VPD83 identifier, or a name pattern with wildcards.
[-l|--lun] LUN - Find the views exporting the specified LUN number.
[-i|--initiator-port] initiator - Find the views including the specified initiator. May contain
wildcards.
[-f|--free-lun] - Find the next free LUN number for all views.

Description This command is most useful for configurations with thousands of LUNs, and a large
number of views and exported virtual volumes.

Example Find the next available LUN numbers on cluster 1:

VPlexcli:/clusters/cluster-1/exports/storage-views> find --cluster cluster-1 --free-lun
View LicoJ009 : next free LUN number is 27.
View LicoJ013 : next free LUN number is 1.

262 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Find the views exporting the specified volume:

VPlexcli:/clusters/cluster-1/exports> export storage-view find --volume dd_03_vol
Views exporting volume dd_03_vol:
View LicoJ009 exports (4,dd_03_vol,VPD83T3:6000144000000010a0014760d64cb225,128G).

Find the views exported by initiators whose name starts with “Lico”:
VPlexcli:/clusters/cluster-1/exports> export storage-view find --initiator Lico*
Views including inititator Lico*:
View LicoJ009.
View LicoJ013.

See also ◆ export initiator-port discovery

◆ export storage-view find-unmapped-volumes
◆ export storage-view map
◆ export storage-view summary

export storage-view find-unmapped-volumes

Displays unexported virtual volumes.

Contexts All contexts.

Syntax export storage-view find-unmapped-volumes

[-c|--cluster] cluster

Arguments Required arguments

[-c|--cluster] cluster - Cluster for which to display unexported storage volumes.

Description Displays unexported virtual volumes in the specified cluster.

Displays the remote (on the other cluster) virtual volumes which are exported and running
I/O.

Example Display unexported volumes for the specified clusters:

See also ◆ export storage-view addvirtualvolume

◆ export-storage-view removevirtualvolume

export storage-view find-unmapped-volumes 263

VPLEX CLI Command Descriptions

export storage-view map

Displays only storage volumes with an I/O status other than 'Alive'.

Contexts All contexts.

In /clusters/cluster/exports context, command is view map.
In /clusters/cluster/exports/storage-views context, command is map.

Syntax export storage-view map

[-v|--views] view,view...
[-f|--file] filename

Arguments Required arguments

[-v|--views] view,view... - * List of one or more storage views to map. Entries must be
separated by commas. May contain wildcards.

Optional arguments
[-f|--file] file - Name of the file to which to send the output. If no file is specified, output is
to the console screen.
* argument is positional.

Example Display unhealthy storage volumes for a specified storage view:

VPlexcli:/> export storage-view map LicoJ013
VPD83T3:6000144000000010a0014760d64cb32c dev_sym1723_1FC_vol

Display unhealthy storage volumes for all storage views:

VPlexcli:/> export storage-view map --views **
VPD83T3:6000144000000010a0014760d64ca44c base0_vol
VPD83T3:6000144000000010a0014760d64cb21f dd_00_vol
.
.
.
Display unhealthy storage volumes for all the views at cluster-2:
VPlexcli:/> export storage-view map
/clusters/cluster-2/exports/storage-views/*
VPD83T3:6000144000000010a000e68dc5f76188 base01_vol
VPD83T3:6000144000000010a0014760d64cb21f dd_00_vol
VPD83T3:6000144000000010a0014760d64cb221 dd_01_vol
.
.
.

See also ◆ export storage-view find-unmapped-volumes

◆ export storage-view find
◆ export storage-view summary

export storage-view removeinitiatorport

Removes the specified initiator-port(s) from the view.

Contexts All contexts.

In /clusters/cluster/exports context, command is storage-view removeinitiatorport.

264 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

In /clusters/cluster/exports/storage-views context, command is removeinitiatorport.

Syntax export storage-view removeinitiatorport

[-v|--view] context path
[-i|--initiator-ports] context path,context path...

Arguments Required arguments

[-i|--initiator-ports] context path,context path... - * Comma- separated list of one or more
initiator ports to remove.

Optional arguments
[-v|--view] context path - The storage view from which to remove the initiator port.
* - argument is positional.

Description Use the ll /clusters/cluster/exports/storage-views/storage-view command to display the

initiator ports in the specified storage view.

Example Remove an initiator port from /clusters/cluster/exports/storage-views/storage-view

context:
VPlexcli:/clusters/cluster-1/exports/storage-views /LicoJ009>
removeinitiatorport -i LicoJ009_hba1

See also ◆ export storage-view addinitiatorport

◆ export storage-view removeport

export storage-view removeport

Removes the specified port(s) from a storage view.

Contexts All contexts.

In /clusters/cluster/exports/storage-views/storage-view context, command is removeport..
export storage-view removeport
[-v|--view] context path
[-p|--ports] context path,context path...

Arguments Required arguments

[-p|--ports] context path,context path ... - * List of one or more ports to be removed from
the view. Entries must be separated by commas.

Optional arguments
[-v|--view] context path - View from which to remove the specified port(s).
* - argument is positional.

Description Use the ll /clusters/cluster/exports/storage-views/storage-view command to display the

ports in the specified storage view

Example Remove a port from /clusters/cluster/exports/storage-views/storage-view context:

VPlexcli:/clusters/cluster-1/exports/storage-views/LicoJ009>
removeport -p P000000003CA00147-A0-FC02

See also ◆ export storage-view addport

export storage-view removeport 265

VPLEX CLI Command Descriptions

◆ export storage-view destroy

export storage-view removevirtualvolume

Removes the specified virtual volume from the view.

Contexts All contexts.

In /clusters/cluster/exports context, command is storage-view removevirtualvolume.
In /clusters/cluster/exports/storage-views context, command is removevirtualvolume.

Syntax export storage-view removevirtualvolume

[-v|--view] context path
[-f|--force]
[-o|--virtual-volumes] volume,volume...

Arguments Required arguments

[-o|--virtual-volumes] volume,volume ... - * List of one or more virtual volumes to be
removed from the view. Entries must be separated by commas.

Optional arguments
[-f|--force] - Force the virtual-volumes to be removed from the view even if the specified
LUNs are in use, the view is live, or some of the virtual-volumes do not exist in the view.
[-v|--view] context path - View from which to remove the specified virtual volume(s).
* - argument is positional.

Description Use the ll /clusters/cluster/exports/storage-views/storage-view command to display the

virtual volumes in the specified storage view

Example Delete a virtual volume from the specified storage view, even though the storage view is
active:
VPlexcli:/clusters/cluster-1/exports/storage-views> removevirtualvolume --view E209_View
--virtual-volume (1,test3211_r0_vol) --force

WARNING: The storage-view 'E209_View' is a live storage-view and is exporting storage through
the following initiator ports:
'iE209_hba1_b', 'iE209_hba0'. Performing this operation may affect hosts' storage-view of
storage. Proceeding anyway.

See also ◆ export storage-view addvirtualvolume

◆ export storage-view destroy

export storage-view show-powerpath-interfaces

Displays the mapping between PowerPath® interfaces and the VPLEX system ports.

Contexts Clusters/cluster context and below.

Syntax export storage-view show-powerpath-interfaces

[-c|--cluster] context path

266 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Optional arguments

[-c|--cluster] context path - The cluster at which to show the PowerPath interface mapping.

Example
VPlexcli:/clusters/cluster-2/exports/storage-views> export
storage-view show-powerpath-interfaces
PowerPath Interface Target Port
------------------- ---------------------------
SP A8 P000000003CA000E6-A0-FC03.0
SP A9 P000000003CB001CB-B0-FC01.0
SP A6 P000000003CA001CB-A0-FC01.0
SP A7 P000000003CB000E6-B0-FC01.0
SP A0 P000000003CA000E6-A0-FC00.0
SP A1 P000000003CA000E6-A0-FC01.0
SP A4 P000000003CA000E6-A0-FC02.0
SP A5 P000000003CB001CB-B0-FC00.0

See also ◆ export storage-view checkconfig

◆ export storage-view find
◆ export storage-view map
◆ export storage-view summary

export storage-view summary

Lists each view and the number of virtual volumes and initiators that it contains.

Contexts All contexts.

In /clusters/cluster/exports/storage-views context, command is summary.

Syntax export storage-view summary

[-c|--clusters] cluster,cluster...

Arguments Optional arguments

[-c|--cluster] cluster, cluster... - List of clusters. Entries must be separated by commas.
Display information only for storage views on the specified cluster(s).

Description At the root level, displays information for all clusters.

At the /clusters/cluster context and below, displays information only for views in the
cluster in that context.

Example Display storage view summary for a specified cluster (no unhealthy views):
VPlexcli:/> export storage-view summary --clusters cluster-1

View health summary(cluster-1):

view name health-state exported volumes ports registered initiators
--------- ------------ ---------------- ----- ---------------------
LicoJ009 healthy 27 4 4
LicoJ013 healthy 1 8 4

Total 2 views, 0 unhealthy.

Display storage view summary for all clusters (1 unhealthy view):

VPlexcli:/> export storage-view summary

export storage-view summary 267

VPLEX CLI Command Descriptions

View health summary(cluster-1):

view name health-state exported volumes ports registered initiators
---------- ------------ ---------------- ----- ---------------------
poly2_view healthy 5 4 2
view1 healthy 1 4 1

Total 2 views, 0 unhealthy.

View health summary(cluster-2):

view name operational status port summary
--------- ------------------ ------------------------------------------------

esx1_view error port name unhealthy volumes export status

----------------------- ----------------- -------------
P000000003B2017D8-A0-FC00 1 ok
P000000003B2017D8-A0-FC01 1 ok
P000000003B3017D8-B0-FC00 1 ok
P000000003B3017D8-B0-FC01 1 ok

view name health-state exported volumes port s registered initiators

--------- ------------ ---------------- ----- ---------------------
esx1_view unhealthy 10 4 2

Total 1 views, 1 unhealthy.

See also ◆ export port summary

◆ export storage-view checkconfig
◆ export storage-view map
◆ export storage-view show-powerpath-interfaces
◆ storage-volume summary

export target-port renamewwns

Renames a target port's WWN pair.

Contexts All contexts.

In /clusters/cluster/exports context, command is target-port renamewwns.

Syntax export target-port renamewwns

[-p|--port] context path
[-w|--wwns] wwns

Arguments Required arguments

[-w|--wwns] wwns - A WWN pair separated by “|”:
portWWN|nodeWWN

Each WWN is either '0x' followed by one or more hexadecimal digits or an abbreviation, in
the following format:
<string>:<number>[,<number>]
For example,
0xd1342a|0xd1342b
hyy1:194e,4|hyy1:194e

268 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

0xd1342a
hyy1:194e,4
Optional arguments
[-p|--port] context path - Target port for which to rename the WWN pair.

Description Use the ll command in /clusters/cluster/export/port context to display portWWNs and

nodeWWNs.



Disable the corresponding Fibre Channel port before executing this command.

Example
VPlexcli:/> export target-port renamewwns --wwns 0xd1342a|0xd1342b --port
P0000000000000001-FK00

See also ◆ export initiator-port discovery

extent create
Creates one or more storage-volume extents.

Contexts All contexts.

Syntax extent create

[-s|--size] size
[-o|--block-offset] integer
[-n|--num-extents] integer
[-d|--storage-volumes] storage-volume,storage-volume...

Arguments Required arguments

[-d|--storage-volumes] storage-volume,storage-volume ... - * Names of one or more
claimed storage volumes to extent. Entries must be separated by commas.

Optional arguments
[-s|--size] size - The size of each extent, in bytes. If not specified, the largest available
contiguous range of 4K byte blocks on the storage volume is used to create the specified
number of extents.
[-n|--num-extents] integer - The number of extents to create per specified storage volume.
Maximum of 128 extents per storage volume. If not specified, only one extent per
storage-volume is created.
[-o|--block-offset] integer - The block-offset on the underlying storage volume on which the
extent is created. If not specified, the block-offset is determined automatically.
* - argument is positional.

Description An extent is a slice (range of 4K byte blocks) of a storage volume. An extent can use the
entire capacity of the storage volume, or the storage volume can be carved into a
maximum of 128 extents.
Extents are the building blocks for devices.

extent create 269

VPLEX CLI Command Descriptions

If the storage volume is larger than the desired virtual volume, create an extent the size of
the desired virtual volume. Do not create smaller extents, and then use different RAIDs to
concatenate or stripe the extents.
If the storage volume is smaller than the desired virtual volume, create a single extent per
storage volume, and then use devices to concatenate or stripe these extents into a larger
device.
This command can fail if there is not a sufficient number of meta volume slots. See the
troubleshooting section of theVPLEX procedures in the SolVe Desktop for a resolution to
this problem.

Example In the following example:

◆ The ll -p **/storage-volumes command displays a list of all storage volumes.
◆ The cd command changes the context to the storage-volume context on cluster-1.
◆ The extent create command creates an extent from two claimed 16 GB storage
volumes.
VPlexcli:/> ll -p **/storage-volumes

VPlexcli:/>cd /clusters/cluster-1/storage-elements/storage-volumes

VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes> extent create

Symm1723_1DC,Symm1723_1E0

See also ◆ extent create

◆ extent destroy

extent destroy
Destroys one or more storage-volume extents.

Contexts All contexts.

Syntax extent destroy

[-f|--force]
[-s|--extents context path,context path...

270 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Required arguments

[-s|--extents] context path,context path ... - * List of one or more extents to destroy. Entries
must be separated by commas.

Optional arguments
[-f|--force] - Forces the destruction of the given extents, bypassing all guards and
confirmations.
* - argument is positional.

Description Destroys the specified extents.

Example Destroy an extent:

VPlexcli:/clusters/cluster-1/storage-elements/extent> extent destroy --force
extent_Symm1254_7BA_1
Destroyed 1 out of 1 targeted extents.

See also ◆ extent create

extent summary
Displays a list of a cluster's unhealthy extents.

Contexts All contexts.

In /clusters/cluster/storage-elements/extents context, command is summary.

Syntax extent summary

[-c|--clusters] cluster,cluster...

Arguments Optional arguments

[-c|--clusters] cluster,cluster... - List of clusters to summarize, separated by commas. May
contain glob characters.

Description Displays a cluster's unhealthy extents (if any exist), the total number of extents by use,
and calculates the total extent capacity for this cluster.
An unhealthy extent has a non-nominal health state, operational status or I/O status.
If the --clusters argument is not specified and the command is executed at or below a
specific cluster's context, information is summarized for only that cluster. Otherwise, the
extents of all clusters are summarized.

Table 14 extent summary field descriptions (page 1 of 2)

Field Description

Health summary (displayed only for unhealthy extents)

Name Name of extent.

I/O Status alive - I/O is proceeding normally on the extent.

dead - The underlying storage volume is marked as hardware-dead.
unreachable - The underlying storage volume is unreachable.

extent summary 271

VPLEX CLI Command Descriptions

Table 14 extent summary field descriptions (page 2 of 2)

Field Description

Operational degraded - The extent may be out-of-date compared to its mirror (applies only to extents
Status that are part of a RAID 1 device).
ok - The extent is functioning normally.
starting - The extent is not yet ready.
unknown - VPLEX cannot determine the extent's Operational state, or the state is invalid.

Health State degraded - The extent may be out-of-date compared to its mirror (applies only to extents
that are part of a RAID 1 device).
ok - The extent is functioning normally.
non-recoverable-error - The extent may be out-of-date compared to its mirror (applies only to
extents that are part of a RAID 1 device), and/or the Health state cannot be determined.
unknown - VPLEX cannot determine the extent's Operational state, or the state is invalid.

Extent Summary

Health extents - Total number of extents on the cluster, the number.

out-of-date - Of the total number of extents on the cluster, the number that are out-of-date
compared to their mirror.
unhealthy - Of the total number of extents on the cluster, the number with operational
status or health state that is not “ok”.

Use used - Of the total number of extents on the cluster, the number in use.
claimed - Of the total number of extents on the cluster, the number that are claimed
unclaimed - Of the total number of extents on the cluster, the number that are unclaimed.
unusable - Indicates that the underlying storage-volume of the extent is dead or
unreachable. Use the storage-volume summary command to check the storage-volume. Use
the validate-system-configuration command to check reachability from the directors.
logging - Of the total number of extents on the cluster, the number that are in use for
logging.

Capacity Total capacity on the cluster.

See also ◆ ds summary

◆ export port summary
◆ export storage-view summary
◆ local-device summary
◆ storage-volume summary
◆ virtual-volume provision

getsysinfo
Returns information about the current system.

Contexts All contexts.

Syntax getsysinfo
--output path name
--linux

272 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Optional arguments

--output path name - Location and name of the output file.
Default: /var/log/VPlex/cli/YY-sysinfo.txt
--linux - Use this if the management server is running on a Linux system. Disables the scsi
tests since Linux systems lack a scsi command.

Description The information is written in TCL format.

Example Display information and send the output to a file:

VPlexcli:/> getsysinfo --output /var/log/VPlex/cli/TestGetSysInfo
Running from localhost:/var/log/VPlex/cli
Local time 2010/08/04 14:22:43
Flag includeDebug = 0
Flag isLinux = 0
Treating this tower like version D4
clustercount = 2
26 ports - unknown system type
System does NOT have comtcp enabled

## ===== NCB: Cluster_1_Dir1A ====================

## ===== NCB: Cluster_1_Dir1B ====================

.
.
.
Raw output saved to /var/log/VPlex/cli/TestGetSysInfo.2010-08-04-14.25.raw

Table 15 getsysinfo field descriptions

Field Description

Flag includeDebug

Flag isLinux = 0 Denotes a linux simulator build. Ignore this line.

Treating this tower like version Denotes the system is Release 4.0 or later. Ignore this line.
D4

nn ports - unknown system type The getsysinfo script looked for hardware prior to Release 4.0 and did not find
it.

System does NOT have comtcp Communication protocol used on Ethernet ports for connections to other
enabled clusters prior to Release 4.0. Ignore this line.

See also ◆ cluster summary

◆ director firmware show-banks
◆ manifest version
◆ version

health-check
Displays a report indicating overall hardware/software health.

Contexts All contexts.

health-check 273
VPLEX CLI Command Descriptions

Syntax health-check
[-m|--highlevel]
[-f|--full]
--configuration
--back-end
--front-end
--cache
--consistency-group
--wan
--hardware

Arguments Optional arguments

[-m|--highlevel] - Checks for major subcomponents with error conditions. Warnings are
ignored. Used for instantaneous, high level view of the health of the VPLEX.
Default behavior if no other argument is specified.
[-f|--full] - Runs full scan.
--configuration - Perform configuration checks.
--back-end - Perform back end checks.
--front-end - Perform front end checks.
--cache - Perform cache check.
--consistency-group - Perform consistency group check.
--wan - Perform WAN health checks.
--hardware - Perform hardware checks.

Description This command provides a high level view of the system health. The command checks for
major subcomponents with error conditions, warnings, or that are OK.
Consolidates information from the following commands:
◆ version
◆ cluster status
◆ cluster summary
◆ connectivity validate-be
◆ connectivity validate-wan-com
◆ ds summary
◆ export storage-view summary
◆ virtual-volume summary
◆ storage-volume summary
◆ ll /clusters/**/system-volumes/

Example Run a high-level (default) health check on a VPLEX Metro:

VPlexcli:/> health-check
Product Version: 5.1.0.00.00.10
Clusters:
---------
Cluster Cluster Oper Health Connected Expelled

274 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Name ID State State

--------- ------- ----- -------- --------- --------
cluster-1 1 ok degraded True False
cluster-2 2 ok ok True False
cluster-1 Transition/Health Indications:
Device initializing
20 unhealthy Devices or storage-volumes

Meta Data:
----------
Cluster Volume Volume Oper Health Active
Name Name Type State State
--------- ------------------------------- -------------- ----- ------ ------
cluster-1 Advil_1 meta-volume ok ok True
cluster-1 logging_c1_log_vol logging-volume ok ok -
cluster-1 Advil_1_backup_2012Mar07_043012 meta-volume ok ok False
cluster-1 Advil_1_backup_2012Mar08_043011 meta-volume ok ok False
cluster-2 logging_c2_log_vol logging-volume ok ok -
cluster-2 Advil-2_backup_2012Mar08_043020 meta-volume ok ok False
cluster-2 Advil-2_backup_2012Mar07_043017 meta-volume ok ok False
cluster-2 Advil-2 meta-volume ok ok True
Front End:
----------
Cluster Total Unhealthy Total Total Total Total
Name Storage Storage Registered Ports Exported ITLs
Views Views Initiators Volumes
--------- ------- --------- ---------- ----- -------- -----
cluster-1 4 2 12 8 135 672
cluster-2 0 0 0 0 0 0
Storage:
--------
Cluster Total Unhealthy Total Unhealthy Total Unhealthy No Not visible
Name Storage Storage Virtual Virtual Dist Dist Dual from
Volumes Volumes Volumes Volumes Devs Devs Paths All Dirs
--------- ------- --------- ------- --------- ----- --------- ----- -----------
cluster-1 2375 10 229 10 12 0 0 0
cluster-2 2365 0 205 0 12 0 0 0

Consistency Groups:
-------------------
Cluster Total Unhealthy Total Unhealthy
Name Synchronous Synchronous Asynchronous Asynchronous
Groups Groups Groups Groups
--------- ----------- ----------- ------------ ------------
cluster-1 9 0 0 0
cluster-2 5 0 0 0

FC WAN Connectivity:
--------------------
Port Group Connectivity
------------ ------------
port-group-1 ok
port-group-0 ok

Cluster Witness:
----------------
Cluster Witness is not configured

RecoverPoint:
-------------
Cluster Total Unhealthy Total Unhealthy Total Mis-aligned Total Unhealthy
Name RP Clusters RP Clusters Replicated Replicated RP-enabled RP-enabled Registered RP Storage
Virtual Virtual Consistency Consistency RP Initiators/ Views
Volumes Volumes Groups Groups Storage Views
--------- ----------- ----------- ---------- ---------- ----------- ----------- -------------- ----------
cluster-1 1 1 1 0 8 1 8/1 0
cluster-2 - - - - - - -/- -

**This command is only able to check the health of the local cluster(cluster-1)'s RecoverPoint
configuration, therefore if this system is a VPLEX Metro or VPLEX Geo repeat this command on the remote
cluster to get the health of the remote cluster's RecoverPoint configuration.

Array Aware:
------------
Cluster Name Provider Address Connectivity Registered Total
Arrays Storage Pool
------------ -------- ------------- ------------ ---------- ------------
Hopkinton dsvea125 10.108.64.125 connected 2 13
Hopkinton dsvea123 10.108.64.123 connected 2 29

health-check 275
VPLEX CLI Command Descriptions

Providence dsvea124 10.108.64.124 connected 3 21

Example Run a full-scan health-check on a VPLEX Metro:

VPlexcli:/> health-check --full
Configuration (CONF):
Checking VPlexCli connectivity to directors.................... OK
Checking Directors Commission.................................. OK
Checking Directors Communication Status........................ OK
Checking Directors Operation Status............................ OK
Checking ports status.......................................... Error
Checking Call Home............................................. Warning
Checking Connectivity.......................................... OK
Checking COM Port Power Level.................................. OK
Checking Meta Data Backup...................................... Warning
Checking Meta Data Slot Usage.................................. Error
Back End (BE):
Checking Unreachable Storage Volumes........................... OK
Checking Degraded Storage Volumes...............................Error
Checking Unhealthy Virtual Volumes............................. OK
Back end array status.......................................... OK
Validating paths to back end arrays............................ OK
Front End (FE):
Checking Storage Views......................................... OK
Checking Front End Path........................................ OK
Cache:
Checking for sub-pages writes(25% or above of total writes).... OK
Checking Stuck IO.............................................. OK
Consistency Group Health:
Consistency Group Health....................................... OK
WAN Link:
WAN Configuration.............................................. OK
WAN Port Settings.............................................. OK
WAN Port Group Settings........................................ OK
WAN Subnet Settings............................................ OK
WAN Bridged and Routed Settings................................ OK
WAN Ping Remote IPs............................................ OK
Director Health Status:
Checking SSD Hardware.......................................... OK
Checking Director RPMs......................................... OK

Output to /var/log/VPlex/cli/health_check_full_scan.log

276 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Example Run a WAN-only scan on a VPLEX GEO system:

VPlexcli:/> health-check --wan
WAN Link:
WAN Configuration.... OK
VPlexcli:/> health-check --wan --verbose
WAN Link:
WAN Configuration.................. OK
Connectivity: full
All port-groups have a status of either ok or warning. com connectivity is
complete through minor configuration errors may still exist (see individual
port-group statuses).
port-group-1: OK
All com links have the expected connectivity: this port-group is operating
correctly.
port-group-0: OK
All com links have the expected connectivity: this port-group is operating
correctly.
EMC VPLEX CLI Guide 293
DRAFT
WAN Port Settings.................. OK
WAN Port Group Settings............ OK
WAN Subnet Settings................ OK
WAN Bridged and Routed Settings.... OK
WAN Ping Remote IPs................ OK
ping from director-1-1-A:
Remote Discovery IP:
224.100.100.100 is reachable, Round-trip time:0.328 ms
Remote Cluster IPs:
192.168.4.252 is reachable, Round-trip time:0.083 ms
192.168.5.252 is reachable, Round-trip time:0.081 ms
ping from director-1-1-B:
Remote Discovery IP:
224.100.100.100 is reachable, Round-trip time:0.431 ms
Remote Cluster IPs:
192.168.4.252 is reachable, Round-trip time:0.086 ms
192.168.5.252 is reachable, Round-trip time:0.083 ms
ping from director-1-2-A:
Remote Discovery IP:
224.100.100.100 is reachable, Round-trip time:0.297 ms
Remote Cluster IPs:
192.168.4.252 is reachable, Round-trip time:0.088 ms
192.168.5.252 is reachable, Round-trip time:0.103 ms
ping from director-1-2-B:
Remote Discovery IP:
224.100.100.100 is reachable, Round-trip time:0.311 ms
Remote Cluster IPs:
192.168.4.252 is reachable, Round-trip time:0.089 ms
192.168.5.252 is reachable, Round-trip time:0.075 ms
ping from director-2-1-A:
Remote Discovery IP:
224.100.100.100 is reachable, Round-trip time:0.371 ms
Remote Cluster IPs:
192.168.4.251 is reachable, Round-trip time:0.08 ms
192.168.5.251 is reachable, Round-trip time:0.091 ms
ping from director-2-1-B:
Remote Discovery IP:
224.100.100.100 is reachable, Round-trip time:0.443 ms
Remote Cluster IPs:
192.168.4.251 is reachable, Round-trip time:0.066 ms
192.168.5.251 is reachable, Round-trip time:0.083 ms
ping from director-2-2-A:
Remote Discovery IP:
224.100.100.100 is reachable, Round-trip time:0.347 ms
Remote Cluster IPs:
192.168.4.251 is reachable, Round-trip time:0.087 ms

health-check 277
VPLEX CLI Command Descriptions

192.168.5.251 is reachable, Round-trip time:0.087 ms

ping from director-2-2-B:
Remote Discovery IP:
224.100.100.100 is reachable, Round-trip time:0.397 ms
Remote Cluster IPs:
192.168.4.251 is reachable, Round-trip time:0.088 ms
192.168.5.251 is reachable, Round-trip time:0.087 ms

As per putty output collected from Cavalier(Geo) instance:

**********************************************************
VPlexcli:/> health-check --wan
WAN Link:
WAN Configuration.................. OK
WAN Port Settings.................. OK
WAN Port Group Settings............ OK
WAN Subnet Settings................ OK
WAN Bridged and Routed Settings.... OK
Full health check error: isReachable
Output to /var/log/VPlex/cli/health_check_full_scan.log

VPlexcli:/> health-check --wan --verbose

WAN Link:
WAN Configuration.................. OK
Connectivity: full
All port-groups have a status of either ok or warning: Com connectivity is
complete, though minor configuration errors may still exist (see individual
port-group statuses).

port-group-1: OK
All com links have the expected connectivity: this port-group is operating
correctly.

port-group-0: OK
All com links have the expected connectivity: this port-group is operating
correctly.

Example Run 2 WAN-only scans:

◆ The first in (default) high-level mode,
◆ The second in verbose mode:
VPlexcli:/> health-check --wan
WAN Link:
WAN Configuration.... OK

VPlexcli:/> health-check --wan --verbose

WAN Link:
WAN Configuration.................. OK
Connectivity: full
All port-groups have a status of either ok or warning. com connectivity is
complete through minor configuration errors may still exist (see individual
port-group statuses).

port-group-1: OK
All com links have the expected connectivity: this port-group is operating
correctly.

port-group-0: OK

278 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

All com links have the expected connectivity: this port-group is operating
correctly.

WAN Port Settings.................. OK

WAN Port Group Settings............ OK
WAN Subnet Settings................ OK
WAN Bridged and Routed Settings.... OK
WAN Ping Remote IPs................ OK
ping from director-1-1-A:
Remote Discovery IP:
224.100.100.100 is reachable, Round-trip time:0.328 ms
Remote Cluster IPs:
192.168.4.252 is reachable, Round-trip time:0.083 ms
192.168.5.252 is reachable, Round-trip time:0.081 ms
ping from director-1-1-B:
Remote Discovery IP:
224.100.100.100 is reachable, Round-trip time:0.431 ms
Remote Cluster IPs:
192.168.4.252 is reachable, Round-trip time:0.086 ms
192.168.5.252 is reachable, Round-trip time:0.083 ms
ping from director-1-2-A:
Remote Discovery IP:
224.100.100.100 is reachable, Round-trip time:0.297 ms
Remote Cluster IPs:
192.168.4.252 is reachable, Round-trip time:0.088 ms
192.168.5.252 is reachable, Round-trip time:0.103 ms
ping from director-1-2-B:
Remote Discovery IP:
224.100.100.100 is reachable, Round-trip time:0.311 ms
Remote Cluster IPs:
192.168.4.252 is reachable, Round-trip time:0.089 ms
192.168.5.252 is reachable, Round-trip time:0.075 ms
ping from director-2-1-A:
Remote Discovery IP:
224.100.100.100 is reachable, Round-trip time:0.371 ms
Remote Cluster IPs:
192.168.4.251 is reachable, Round-trip time:0.08 ms
192.168.5.251 is reachable, Round-trip time:0.091 ms
ping from director-2-1-B:
Remote Discovery IP:
224.100.100.100 is reachable, Round-trip time:0.443 ms
Remote Cluster IPs:
192.168.4.251 is reachable, Round-trip time:0.066 ms
192.168.5.251 is reachable, Round-trip time:0.083 ms
ping from director-2-2-A:
Remote Discovery IP:
224.100.100.100 is reachable, Round-trip time:0.347 ms
Remote Cluster IPs:
192.168.4.251 is reachable, Round-trip time:0.087 ms
192.168.5.251 is reachable, Round-trip time:0.087 ms
ping from director-2-2-B:
Remote Discovery IP:
224.100.100.100 is reachable, Round-trip time:0.397 ms
Remote Cluster IPs:
192.168.4.251 is reachable, Round-trip time:0.088 ms
192.168.5.251 is reachable, Round-trip time:0.087 ms

Output to /var/log/VPlex/cli/health_check_full_scan.log

Example Run high availability related checks for VPLEX/VE:

VPlexcli:/> health-check --virtual-ha

health-check 279
VPLEX CLI Command Descriptions

Virtual HA (VHA):
Checking director VM existence...... OK
Checking director existence........... OK
Checking director VM placement...... OK
Checking director runtime status..... OK
Checking virtual networking state..... Error
Checking if vSphere HA is enabled..... OK
Checking vSphere HA................... Warning
Checking if vSphere DRS is enabled.... OK
Checking VSphere DRS.................. OK
Checking VSphere DRS run time......... OK
Output to /var/log/VPlex/cli/health_check_full_scan.log

Virtual HA (VHA):
Checking director VM existence...... OK
Checking director existence........... OK
Checking director VM placement...... OK
Checking director runtime status..... OK
Checking virtual networking state..... Error
Failures
The following director VMs have an invalid number of configured NICs:
vDirector-4
vDirector-3
vDirector-1
vDirector-2
Warnings
The following director VMs do not have redundant front-end communication due to missing or
misconfigured virtual ethernet cards:
vDirector-4
vDirector-3
vDirector-1
vDirector-2

Checking if vSphere HA is enabled..... OK

Checking vSphere HA................... Warning
Warnings
The following director VMs have an invalid vSphere HA VM monitoring configuration:
vDirector-2 has vSphere HA VM monitoring configuration: vmMonitoringDisabled.
vDirector-3 has vSphere HA VM monitoring configuration: vmMonitoringDisabled.
vDirector-4 has vSphere HA VM monitoring configuration: vmMonitoringDisabled.
vDirector-1 has vSphere HA VM monitoring configuration: vmMonitoringDisabled.

Checking if vSphere DRS is enabled.... OK

Checking VSphere DRS.................. OK
Checking VSphere DRS run time......... OK

See also ◆ cluster status

◆ validate-system-configuration

help
Displays help on one or more commands.

Contexts All contexts.

Syntax help
[-i|--interactive]
[-G|--no-global]
[-n|--no-internal]

280 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Optional arguments

[-i|--interactive] - Invoke interactive help.
[-G|--no-global] - Suppresses the list of global commands for contexts other than root
context.
[-n|--internal] - Include commands that are normally used for low-level debugging and
development.
Type quit to exit interactive help.

Description If an argument is marked as required, it is always required. Additional arguments may be

required depending on the context in which the command is executed.

Example Display only commands specific to the current context:

VPlexcli:/clusters/cluster-1> help -G
Commands inherited from parent contexts:
add cacheflush configdump expel forget shutdown summary unexpel

Commands specific to this context and below:

status verify
Display help for a specified command:
VPlexcli:/clusters/cluster-1> status --help
synopsis: status [<options>]

Displays a cluster's operational-status and health-state.

options (* = required):
-h, --help
Displays the usage for this command.
--verbose
Provide more output during command execution. This may not have any effect for some
commands.
-c, --clusters= <clusters>
clusters whose operational-status to display.

Along with the operational-status, an indication of why it could be non-nominal and a progress
indicator are displayed.
Health-state has a similar indicator.

Invoke interactive help:

VPlexcli:/clusters/cluster-1> help -i

Welcome to Python 2.2! This is the online help utility.

.
.
.
help> topics

Here is a list of available topics. Enter any topic name to get more help.

ASSERTION DYNAMICFEATURES NONE TRACEBACKS

ASSIGNMENT ELLIPSIS NUMBERMETHODS TRUTHVALUE
.
.
.
help> EXPRESSIONS
------------------------------------------------------------------------

5.14 Summary

help 281
VPLEX CLI Command Descriptions

The following table summarizes the operator precedences in Python, from

lowest precedence (least binding) to highest precedence (most binding).
.
.
.

history
Displays or clears the command history list.

Contexts All contexts.

Syntax history
[-c|--clear]
[-n|--number] number

Arguments Optional arguments

[-c|--clear] - Clears the history list.
[-n|--number] number - Displays only the last n commands in the history list.

Example Display the last 8 commands executed in this CLI session:

VPlexcli:/> history 8
492 ll
493 cd d
494 cd device-migrations/
495 ll
496 cd
497 ds summary
498 export storage-view checkconfig
499 history 8

iscsi chap back-end add-credentials

Note: This command is not supported in VPLEX.

Adds one or more configuration credentials for back-end CHAP.

Contexts All contexts.

Syntax iscsi chap back-end add-credentials

[-u|--username] username
[-s|--secret] secret
[-t|--targets] target [, target...]
[-c|--cluster] cluster context
[--secured]
[-h|--help]
[--verbose]

Arguments Required arguments

[-u|--username] username - * Specifies the username to use in the configured CHAP
credentials.

282 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

[-s|--secret] secret - * Specifies the secret to use in the configured CHAP credentials. The
secret must be between 12 and 255 characters long, and can be composed of all printable
ASCII characters.
[-t|--targets] target [, target...] -* Specifies the IQNs or IP addresses of the targets for which
to configure credentials.
[--secured] - Prevents the secret from being stored as plain text in the log files.

Optional arguments
[-c|--cluster] cluster context - Specifies the context-path of the cluster at which the
back-end CHAP credentials should be added.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.
* - argument is positional.

Description Adds one or more configuration credentials for back-end CHAP.

Note: This command is valid only on systems that support iSCSI devices.

Example Add back-end CHAP credentials to targets on cluster 1:

VPlexcli:/> iscsi back-end add-credentials user_name secret_code12345 10.10.100.1 –c
/clusters/cluster-1 --secured

Successfully added credentials to 8 targets.

See also ◆ iscsi chap back-end disable

◆ iscsi chap back-end enable
◆ iscsi chap back-end list-credentials
◆ iscsi chap back-end remove-credentials
◆ iscsi chap back-end remove-default-credential
◆ iscsi chap back-end set-default-credential

iscsi chap back-end disable

Note: This command is not supported in VPLEX.

Disables back-end CHAP.

Contexts All contexts.

Syntax iscsi chap back-end disable

[-c|--cluster] cluster context
[-h|--help]
[--verbose]

iscsi chap back-end disable 283

VPLEX CLI Command Descriptions

Arguments Optional arguments

[-c|--cluster] cluster context- Specifies the context path of the cluster at which back-end
CHAP should be disabled.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description Disables back-end CHAP. Once CHAP is disabled on the back-end, all configured
credentials will be unused, but not deleted.



You will not be able to login to storage arrays that enforce CHAP if you disable back-end
CHAP that was previously configured.

Note: This command is valid only on systems that support iSCSI devices.

Example Disable back-end CHAP on cluster 1:

VPlexcli:/> iscsi chap back-end disable -c cluster-1/

Successfully disabled back-end chap.

See also ◆ iscsi chap back-end add-credentials

◆ iscsi chap back-end enable
◆ iscsi chap back-end list-credentials
◆ iscsi chap back-end remove-credentials
◆ iscsi chap back-end remove-default-credential
◆ iscsi chap back-end set-default-credential

iscsi chap back-end enable

Note: This command is not supported in VPLEX.

Enables back-end CHAP configuration.

Contexts All contexts.

Syntax iscsi chap back-end enable

[-c|--cluster] cluster context
[-h|--help]
[--verbose]

Arguments Optional arguments

[-c|--cluster] cluster context - Specifies the context path of the cluster at which back-end
CHAP should be enabled.
[-h|--help] - Displays command line help.

284 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description Enables back-end CHAP. Enabling CHAP on the back-end allows VPLEX to log in securely to
storage arrays that also have CHAP configured. To use CHAP once it is enabled, all storage
arrays must have added CHAP credentials or have set a default CHAP credential .

Note: This command is valid only on systems that support iSCSI devices.

Example Enable back-end CHAP on cluster 1:

VPlexcli:/> iscsi chap back-end enable -c cluster-1/

Successfully enabled back-end chap.

See also ◆ iscsi chap back-end add-credentials

◆ iscsi chap back-end disable
◆ iscsi chap back-end list-credentials
◆ iscsi chap back-end remove-credentials
◆ iscsi chap back-end remove-default-credential
◆ iscsi chap back-end set-default-credential

iscsi chap back-end list-credentials

Note: This command is not supported in VPLEX.

Lists all configured back-end CHAP credentials.

Contexts All contexts.

Syntax iscsi chap back-end list-credentials

[-c|--cluster] cluster context
[-h|--help]
[--verbose]

Arguments Optional arguments

[-c|--cluster] cluster context - Specifies the context path of the cluster for which the
configured back-end CHAP credentials should be listed.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description Lists all configured back-end CHAP credentials.

Note: This command is valid only on systems that support iSCSI devices.

Example List configured back-end CHAP credentials for cluster 1:

iscsi chap back-end list-credentials 285

VPLEX CLI Command Descriptions

VPlexcli:/> iscsi chap back-end list-credentials -c cluster-1/

Credential Target Username Secret

----------------- ---------------- -----------------
10.10.100.1 user chap_secret_123
10.10.100.2 vnx_username vnx_secret_123456
all default_username default_secret

See also ◆ iscsi chap back-end add-credentials

◆ iscsi chap back-end disable
◆ iscsi chap back-end enable
◆ iscsi chap back-end remove-credentials
◆ iscsi chap back-end remove-default-credential
◆ iscsi chap back-end set-default-credential

iscsi chap back-end remove-credentials

Note: This command is not supported in VPLEX.

Removes one or more configuration credentials for back-end CHAP.

Contexts All contexts.

Syntax iscsi chap back-end remove credentials

[-t|--targets] target [, target...]
[-c|--cluster] cluster context
[-h|--help]
[--verbose]

Arguments Required arguments

[-t|--targets] target [, target...] - * Specifies the IQNs or IP addresses of the targets for which
to remove credentials.

Optional arguments
[-c|--cluster] cluster context - Specifies the context path of the cluster at which the
back-end CHAP credential should be removed.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.
* - argument is positional.

Description Removes one or more configuration credentials for back-end CHAP.

Note: This command is valid only on systems that support iSCSI devices.

Example Remove a configured back-end CHAP credential on a specified IP address on cluster 1:

VPlexcli:/> iscsi chap back-end remove-credentials -c cluster-1/ 10.10.100.1

286 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Successfully removed credentials to 8 targets.

See also ◆ iscsi chap back-end add-credentials

◆ iscsi chap back-end disable
◆ iscsi chap back-end enable
◆ iscsi chap back-end list-credentials
◆ iscsi chap back-end remove-credentials
◆ iscsi chap back-end remove-default-credential
◆ iscsi chap back-end set-default-credential

iscsi chap back-end remove-default-credential

Note: This command is not supported in VPLEX.

Removes a default credential for back-end CHAP configuration.

Contexts All contexts.

Syntax iscsi chap back-end remove-default-credential

[-c|--cluster] cluster context
[-h|--help]
[--verbose]

Arguments Optional arguments

[-c|--cluster] cluster context - Specifies the context path of the cluster at which the default
back-end CHAP credential should be removed.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description Removes a default credential for back-end CHAP configuration.

Note: This command is valid only on systems that support iSCSI devices.

Example Remove default credentials for back-end CHAP from ports on cluster 1:
VPlexcli:/> iscsi chap back-end remove-default-credential -c cluster-1/

Successfully removed default credentials on 8 ports.

See also ◆ iscsi chap back-end add-credentials

◆ iscsi chap back-end disable
◆ iscsi chap back-end enable
◆ iscsi chap back-end list-credentials
◆ iscsi chap back-end remove-credentials

iscsi chap back-end remove-default-credential 287

VPLEX CLI Command Descriptions

◆ iscsi chap back-end set-default-credential

iscsi chap back-end set-default-credential

Note: This command is not supported in VPLEX.

Sets a default credential for back-end CHAP configuration.

Contexts All contexts.

Syntax iscsi chap back-end set-default-credential

[-u|--username] username
[-s|--secret] secret
[-c|--cluster] cluster context
[--secured]
[-h|--help]
[--verbose]

Arguments Required arguments

[-u|--username] username - * Specifies the username to use in the configured CHAP
credentials.
[-s|--secret] secret - * Specifies the secret to use in the configured CHAP credentials. The
secret must be between 12 and 255 characters long, and can be composed of all printable
ASCII characters.
[--secured] - Prevents the secret from being stored as plain text in the log files.

Optional arguments
[-c|--cluster] cluster context - Specifies the context path of the cluster at which the default
back-end CHAP credential should be set.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.
* - positional argument

Description Sets a default credential for back-end CHAP configuration. When back-end CHAP is
enabled, VPLEX will log into its targets using the default credential. If a specific target has
a separate credential configured, VPLEX will use that separate credential when attempting
to log into the target.

Note: This command is valid only on systems that support iSCSI devices.

Example Set a default credential for back-end CHAP configuration on cluster 1:

VPlexcli:/> iscsi chap back-end set-default-credential -c cluster-1/ -u username -s
secret123456 --secured

Successfully set default credential on 8 ports.

See also ◆ iscsi chap back-end add-credentials

◆ iscsi chap back-end disable

288 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ iscsi chap back-end enable

◆ iscsi chap back-end list-credentials
◆ iscsi chap back-end remove-credentials
◆ iscsi chap back-end remove-default-credential

iscsi chap front-end add-credentials

Note: This command is not supported in VPLEX.

Adds one or more configuration credentials for front-end CHAP.

Contexts All contexts.

Syntax iscsi chap front-end add-credentials

[-u|--username] username
[-s|--secret] secret
[-i|--initiators] initiator [, initiator...]
[-c|--cluster] cluster context
[--secured]
[-h|--help]
[--verbose]

Arguments Required arguments

[-u|--username] username - * Specifies the username to use in the configured CHAP
credentials.
[-s|--secret] secret - * Specifies the secret to use in the configured CHAP credentials. The
secret must be between 12 and 255 characters long, and can be composed of all printable
ASCII characters.
[-i|--initiators] initiator [, initiator] - * Specifies the IQNs of the initiators for which to
configure credentials.
[--secured] - Prevents the secret from being stored as plain text in the log files.

Optional arguments
[-c|--cluster] cluster context - Specifies the context path of the cluster at which the
front-end CHAP credentials should be added.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.
* - argument is positional.

Description Adds one or more configuration credentials for front-end CHAP.

Note: This command is valid only on systems that support iSCSI devices.

Example Add configuration credentials for front-end CHAP to initiators on cluster 1:

VPlexcli:/> iscsi chap front-end add-credentials -c cluster-1/ -u user -s secret123456
iqn.1991-05.com.microsoft:dahlia-w2k8 --secured

iscsi chap front-end add-credentials 289

VPLEX CLI Command Descriptions

Successfully added credentials to 8 initiators.

See also ◆ iscsi chap front-end disable

◆ iscsi chap front-end enable
◆ iscsi chap front-end list-credentials
◆ iscsi chap front-end remove-credentials
◆ iscsi chap front-end remove-default-credential
◆ iscsi chap front-end set-default-credential

iscsi chap front-end disable

Note: This command is not supported in VPLEX.

Disables front-end CHAP.

Contexts All contexts.

Syntax iscsi chap front-end disable

[-c|--cluster] cluster context
[-h|--help]
[--verbose]

Arguments Optional arguments

[-c|--cluster] cluster context - Specifies the context path of the cluster at which front-end
CHAP should be disabled.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description Disables front-end CHAP. Once CHAP is disabled on the front-end all configured
credentials will be unused, but not deleted.

Note: This command is valid only on systems that support iSCSI devices.

Example Disable front-end CHAP on cluster 1:

VPlexcli:/> iscsi chap front-end disable -c cluster-1/

Successfully disabled front-end chap.

See also ◆ iscsi chap front-end add-credentials

◆ iscsi chap front-end enable
◆ iscsi chap front-end list-credentials
◆ iscsi chap front-end remove-credentials
◆ iscsi chap front-end remove-default-credential

290 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ iscsi chap front-end set-default-credential

iscsi chap front-end enable

Note: This command is not supported in VPLEX.

Enables front-end CHAP configuration.

Contexts All contexts.

Syntax iscsi chap front-end enable

[-c|--cluster] cluster context
[-h|--help]
[--verbose]

Arguments Optional arguments

[-c|--cluster] cluster context - Specifies the context path of the cluster at which front-end
CHAP should be enabled.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description Enables front-end CHAP. Enabling CHAP on the front-end will allow initiators to log in
securely. To use CHAP once it is enabled, all initiators must have added CHAP credentials
or have set a default CHAP credential .



Initiators will no longer be able to log-in once CHAP is enabled if they do not have a
credential configured.

Note: This command is valid only on systems that support iSCSI devices.

Example Enable front-end CHAP on cluster 1:

VPlexcli:/> iscsi chap front-end enable -c cluster-1/

Successfully enabled front-end chap.

See also ◆ iscsi chap front-end add-credentials

◆ iscsi chap front-end disable
◆ iscsi chap front-end list-credentials
◆ iscsi chap front-end remove-credentials
◆ iscsi chap front-end remove-default-credential
◆ iscsi chap front-end set-default-credential

iscsi chap front-end enable 291

VPLEX CLI Command Descriptions

iscsi chap front-end list-credentials

Note: This command is not supported in VPLEX.

Lists all configured front-end CHAP credentials.

Contexts All contexts.

Syntax iscsi chap front-end list-credentials

[-c|--cluster] cluster context
[-h|--help]
[--verbose]

Arguments Optional arguments

[-c|--cluster] cluster context - Specifies the context path of the cluster for which the
configured front-end CHAP credentials should be listed.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description Lists all configured front-end CHAP credentials.

Note: This command is valid only on systems that support iSCSI devices.

Example List all configured front-end CHAP credentials for cluster 1:

VPlexcli:/> iscsi chap front-end list-credentials -c cluster-1/

Credential Initiator Username Secret

------------------------------------- -------- ------------
iqn.1991-05.com.microsoft:dahlia-w2k8 user secret123456

See also ◆ iscsi chap front-end add-credentials

◆ iscsi chap front-end disable
◆ iscsi chap front-end enable
◆ iscsi chap front-end remove-credentials
◆ iscsi chap front-end remove-default-credential
◆ iscsi chap front-end set-default-credential

iscsi chap front-end remove-credentials

Note: This command is not supported in VPLEX.

Removes one or more configuration credentials for front-end CHAP.

Contexts All contexts.

Syntax iscsi chap front-end remove-credentials

292 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

[-i|--initiators] initiator [, initiator...]

[-c|--cluster] cluster context
[-h|--help]
[--verbose]

Arguments Required arguments

[-i|--initiators] initiator [, initiator] - * Specifies the IQNs of the initiators for which to
remove credentials.

Optional arguments
[-c|--cluster] cluster context - Specifies the context path of the cluster at which the
front-end CHAP credentials should be removed.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.
* - positional argument

Description Removes one or more configuration credentials for front-end CHAP.

Note: This command is valid only on systems that support iSCSI devices.

Example Remove front-end CHAP credentials from initiators on cluster 1:

VPlexcli:/> iscsi chap front-end remove-credentials -c cluster-1/
iqn.1991-05.com.microsoft:dahlia-w2k8

Successfully removed credentials to 8 initiators.

See also ◆ iscsi chap front-end add-credentials

◆ iscsi chap front-end disable
◆ iscsi chap front-end enable
◆ iscsi chap front-end list-credentials
◆ iscsi chap front-end remove-default-credential
◆ iscsi chap front-end set-default-credential

iscsi chap front-end remove-default-credential

Note: This command is not supported in VPLEX.

Removes a default credential for front-end CHAP configuration.

Contexts All contexts.

Syntax iscsi chap front-end remove-default-credential

[-c|--cluster] cluster context
[-h|--help]
[--verbose]

iscsi chap front-end remove-default-credential 293

VPLEX CLI Command Descriptions

Arguments Optional arguments

[-c|--cluster] cluster context - Specifies the context path of the cluster at which the default
front-end CHAP credential should be removed.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description Remove a default credential for front-end CHAP configuration.

Note: This command is valid only on systems that support iSCSI devices.

Example Remove a default front-end CHAP credential configuration from cluster 1:

VPlexcli:/> iscsi chap front-end remove-default-credential -c cluster-1/

Successfully removed default credentials on 8 ports.

See also ◆ iscsi chap front-end add-credentials

◆ iscsi chap front-end disable
◆ iscsi chap front-end enable
◆ iscsi chap front-end list-credentials
◆ iscsi chap front-end remove-credentials
◆ iscsi chap front-end set-default-credential

iscsi chap front-end set-default-credential

Note: This command is not supported in VPLEX.

Sets a default credential for front-end CHAP configuration.

Contexts All contexts.

Syntax iscsi chap front-end set-default-credential

[-u|--username] username
[-s|--secret] secret
[-c|--cluster] cluster context
[--secured]
[-h|--help]
[--verbose]

Arguments Required arguments

[-u|--username] username - * Specifies the username to use in the configured CHAP
credentials.
[-s|--secret] secret - * Specifies the secret to use in the configured CHAP credentials. The
secret must be between 12 and 255 characters long, and can be composed of all printable
ASCII characters.
[--secured] - Prevents the secret from being stored as plain text in the log files.

294 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Optional arguments
[-c|--cluster] cluster context - Specifies the context path of the cluster at which the default
front-end CHAP credential should be set.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.
* - positional argument

Description Sets a default credential for front-end CHAP configuration. When front-end CHAP is
enabled, any initiator without a separate credential will be able to login using this default
credential. A specific initiator that has a separate credential configured will not be able to
login using the default credential.

Note: This command is valid only on systems that support iSCSI devices.

Example Set a default credential for front-end CHAP configuration on cluster 1:

VPlexcli:/> iscsi chap front-end set-default-credential -c cluster-1/ -u user -s secret123456
--secured

Successfully set default credential on 8 ports.

See also ◆ iscsi chap front-end add-credentials

◆ iscsi chap front-end disable
◆ iscsi chap front-end enable
◆ iscsi chap front-end list-credentials
◆ iscsi chap front-end remove-credentials
◆ iscsi chap front-end remove-default-credential

iscsi check-febe-connectivity
Note: This command is not supported in VPLEX.

Checks the front-end and back-end configurations for iSCSI connectivity.

Contexts All contexts.

Syntax iscsi check-febe-connectivity

[-c|--cluster] cluster context
[-h|--help]
[--verbose]

Arguments Optional arguments

[-c|--cluster] cluster context - Specifies the context path of the cluster at which connectivity
should be checked.
[-h|--help] - Displays command line help.

iscsi check-febe-connectivity 295

VPLEX CLI Command Descriptions

[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.

Description The command checks whether the front-end and back-end configurations for iSCSI
connectivity are valid and meet best practices for VPLEX iSCSI configuration.

Note: This command is valid only on systems that support iSCSI devices.

Example Shows port groups with overlapping subnets:

VPlexcli:/> iscsi check-febe-connectivity -c cluster-1
The following port groups have overlapping subnets:
iscsi-port-group-2 <==> iscsi-port-group-1
iscsi-port-group-1 <==> iscsi-port-group-2

Validate febe connectivity found errors in the system's configuration.

Example Shows an invalid sendtarget:

VPlexcli:/> iscsi check-febe-connectivity -c cluster-1
The following IP Addresses are used in multiple conflicting locations:
10.10.100.150:
director-1 BE01
sendtarget

Validate febe connectivity found errors in the system's configuration.

ExampleShows the front-end and back-end connectivity as valid:

VPlexcli:/> iscsi check-febe-connectivity -c cluster-1

Validate febe connectivity found no errors in the system's configuration.

See also ◆ iscsi sendtargets add

◆ iscsi sendtargets list
◆ iscsi sendtargets rediscover
◆ iscsi sendtargets remove

iscsi isns add

Note: This command is not supported in VPLEX.

Adds iSCSI iSNS servers to the cluster, so that the cluster can register the iSCSI front-ends
at those iSNS servers, allowing hosts to discover the VPLEX by querying the iSNS server.

Contexts All contexts.

Syntax iscsi isns add

[-s|--sockets] server-sockets [, server-sockets,...]
[-c|--cluster] cluster context
[-h|--help]

296 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Required arguments

[-s|--sockets] server-sockets [, server-sockets,...]-*Specifies the IP address(es), with
optional :port, of the iSNS server(s). If unspecified, the port defaults to 3205.

Optional arguments
[-c|--cluster] cluster context - Context path of the cluster on which the iSNS server should
be added.
[-h|--help] - Displays command line help.
* - argument is positional.

Description Adds one or more server addresses to the list of iSNS servers.

Note: This command is only valid on systems that support iSCSI devices.

Example Adding two iSNS servers with IP addresses of 192.168.100.2 and 192.168.101.2:
VPlexcli:/> iscsi isns add -c cluster-1 -s 192.168.100.2,192.168.101.2
Successfully added 2 iSNS servers.

Example Add two iSNS server addresses with specified ports to the list of iSNS servers.
VPlexcli:/> iscsi isns add -c cluster-1 -s 192.168.100.2:3000,192.168.101.2:3001
Successfully added 2 iSNS servers.

Example Add one iSNS server with IP address 192.168.100.3:

VPlexcli:/clusters/cluster-1> iscsi isns add -s 192.168.100.3
Successfully added 1 iSNS servers.

Example Attempt to add two iSNS servers that are already configured with the given IP addresses.
VPlexcli:/> iscsi isns add -c cluster-1 -s 192.168.100.2,192.168.101.2
Unable to configure the following iSNS servers:
iSNS Server Error
------------- -------------------------------------------------------------------
192.168.100.2 iSNS Server 192.168.100.2:3260 is already configured at cluster-1
192.168.101.2 iSNS Server 192.168.101.2:3260 is already configured at cluster-1

Successfully added 0 iSNS servers.

See also ◆ iscsi isns list

◆ iscsi isns remove

iscsi isns list

Note: This command is not supported in VPLEX.

Lists the iSNS servers configured on the cluster.

Contexts All contexts.

iscsi isns list 297

VPLEX CLI Command Descriptions

Syntax iscsi isns list

[-c|--cluster] cluster context
[-h|--help]

Arguments Optional Arguments

[-c|--cluster] cluster context - Context path of the cluster for which existing iSNS servers
should be listed.
[-h|--help] - Displays command line help.

Description Displays a list of configured iSNS servers on the specified cluster.

Note: This command is only valid on systems that support iSCSI devices. If a server is not
configured on all directors, a warning message indicates the servers are missing from
specific directors.

Example List the iSNS servers on cluster-1.

VPlexcli:/> iscsi isns list -c cluster-1

iSNS Servers for cluster-1:
Address Port
----------- ----
10.10.100.4 3260
10.10.100.2 3260
10.10.101.4 3260
10.10.101.2 3260

Example List the iSNS servers from cluster context.

VPlexcli:/clusters/cluster-1> iscsi isns list
iSNS Servers for cluster-1:
Address Port
----------- ----
10.10.100.4 3260
10.10.100.2 3260
10.10.101.4 3260
10.10.101.2 3260

Example List showing missing iSNS servers on director 2.

VPlexcli:/> iscsi isns list -c cluster-1

iSNS Servers for cluster-1:
Address Port
----------- ----
10.10.100.4 3260
10.10.100.2 3260
10.10.101.4 3260
10.10.101.2 3260

Warning: Some directors are missing iSNS Servers:

Director Address Port
---------- ----------- ----
director-2 10.10.101.4 3260
director-2 10.10.101.2 3260

See also ◆ iscsi isns add

◆ iscsi isns remove

298 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

iscsi isns remove

Note: This command is not supported in VPLEX.

Removes iSNS servers from the list of configured iSNS servers on the cluster.

Contexts All contexts.

Syntax iscsi isns remove

[-s|--sockets] server-sockets [, server-sockets,...]
[-c|--cluster] cluster context
[-h|--help]

Arguments Required arguments

[-s|--sockets] server-sockets [, server-sockets,...]-*Specifies the IP address(es), with
optional :port, of the iSNS server(s). If unspecified, the port defaults to 3205.

Optional arguments
[-c|--cluster] cluster context - Context path of the cluster from which the iSNS server should
be removed.
[-h|--help] - Displays command line help.
* - argument is positional.

Description Removes one or more server addresses from the list of iSNS servers.

Note: This command is only valid on systems that support iSCSI devices.

Example Remove two iSNS servers with IP addresses of 192.168.100.2 and 192.168.101.2:
VPlexcli:/> iscsi isns remove -c cluster-1 -s 192.168.100.2,192.168.101.2
Successfully removed 2 iSNS servers.

Example Remove two iSNS servers with IP addresses and specified ports.
VPlexcli:/> iscsi isns remove -c cluster-1 -s 192.168.100.2:3000,192.168.101.2:3001
Successfully removed 2 iSNS servers.

Example Remove one iSNS server with IP address 192.168.100.3:

VPlexcli:/clusters/cluster-1> iscsi isns remove -s 192.168.100.3
Successfully removed 1 iSNS servers.

Example Attempt to remove two iSNS servers that have already been removed.
VPlexcli:/> iscsi isns remove -c cluster-1 -s 192.168.100.2,192.168.101.2
Unable to remove the following iSNS servers:
iSNS Server Error
------------- -------------------------------------------------------------------
192.168.100.2 iSNS Server 192.168.100.2:3260 is not present at cluster-1
192.168.101.2 iSNS Server 192.168.101.2:3260 is not present at cluster-1

Successfully removed 0 iSNS servers.

iscsi isns remove 299

VPLEX CLI Command Descriptions

See also ◆ iscsi isns add

◆ iscsi isns list

iscsi sendtargets add

Note: This command is not supported in VPLEX.

Adds iSCSI storage array target portals to specified cluster, enabling ports to be
discovered.

Contexts All contexts.

Syntax iscsi sendtargets add

[-c|--cluster] cluster context
[-h|--help]
[-s|--sockets] sendtarget-sockets [, sendtarget-sockets,...]

Arguments Required arguments

[-s|--sockets] sendtarget-sockets - * Specifies the IP address(es), with optional :port, of
the iSCSI sendtargets. If unspecified, the port defaults to 3260.

Optional arguments
[-c|--cluster] cluster context - Context path of the cluster on which target portals should be
added.
[-h|--help] - Displays command line help.
* - argument is positional.

Description After an iSCSI target portal is added, discovery takes place immediately. Thereafter, periodic
discoveries are automatically performed at 30-minute intervals.

Note: This command is only valid on systems that support iSCSI devices.

Example Add two target portals with IP addresses of 192.168.100.2 and 192.168.101.2:
VPlexcli:/> iscsi sendtargets add -c cluster-1 -t 192.168.100.2, 192.168.101.2
Successfully added 2 target portals.

Example Add two target portals with IP addresses and specified ports, 192.168.100.2:3000 and
192.168.101.2:3001.
VPlexcli:/> iscsi sendtargets add -c cluster-1 -t 192.168.100.2:3000, 192.168.101.2:3001
Successfully added 2 target portals.

Example Attempt to add two target portals that are already configured with the given IP addresses.
VPlexcli:/> iscsi sendtargets add -c cluster-1 -t 192.168.100.2, 192.168.101.2
Unable to configure the following target portals:
Target Portal Error
------------- -------------------------------------------------------------------
192.168.100.2 Target portal 192.168.100.2:3260 is already configured at cluster-1
192.168.101.2 Target portal 192.168.101.2:3260 is already configured at cluster-1

300 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Successfully added 0 target portals.

See also ◆ iscsi check-febe-connectivity

◆ iscsi sendtargets list
◆ iscsi sendtargets rediscover
◆ iscsi sendtargets remove

iscsi sendtargets list

Note: This command is not supported in VPLEX.

Lists iSCSI storage array target portals in cluster.

Contexts All contexts.

Syntax iscsi sendtargets list

[-c|--cluster] cluster context
[-h|--help]
[--force]

Arguments Optional arguments

[-c|--cluster] cluster context - Context path of cluster for which existing target portals
should be listed. Defaults to local cluster if not specified.
[-h|--help] - Displays command line help.

Description Lists the iSCSI target portals available on at least one director. If a portal is not available
on all directors, a warning message indicates which portals are missing from which
directors.

Note: This command is only valid on systems that support iSCSI devices.

Example List target portals with -c option:

VPlexcli:/> iscsi sendtargets list -c cluster-1
SendTarget Addresses for cluster-1:
Address Port
----------- ----
10.10.100.4 3260
10.10.100.2 3260
10.10.101.4 3260
10.10.101.2 3260

Example List target portals from cluster context:

VPlexcli:/clusters/cluster-1> iscsi sendtargets list
SendTarget Addresses for cluster-1:
Address Port
----------- ----
10.10.100.4 3260
10.10.100.2 3260
10.10.101.4 3260

Example List target portals and encounter directors missing target ports:

iscsi sendtargets list 301

VPLEX CLI Command Descriptions

VPlexcli:/> iscsi sendtargets list -c cluster-1

SendTarget Addresses for cluster-1:
Address Port
----------- ----
10.10.100.4 3260
10.10.100.2 3260
10.10.101.4 3260
10.10.101.2 3260

Warning: Some directors are missing targets:

Director Address Port
---------- ----------- ----
director-2 10.10.101.4 3260
director-2 10.10.101.2 3260

See also ◆ iscsi check-febe-connectivity

◆ iscsi sendtargets add
◆ iscsi sendtargets rediscover
◆ iscsi sendtargets remove

iscsi sendtargets rediscover

Note: This command is not supported in VPLEX.

Issues a rediscovery on all sendtargets on the cluster.

Contexts All contexts.

Syntax iscsi sendtargets rediscover

[-c|--cluster] cluster context
[-h|--help]

Arguments Optional arguments

[-c|--cluster] cluster context - Context path of cluster for which existing target portals
should be rediscovered. Defaults to local cluster if not specified.
[-h|--help] - Displays command line help.

Description Issues a rediscovery on all sendtargets on the cluster.

Note: This command is only valid on systems that support iSCSI devices.

Example Rediscover all sendtargets on cluster 1:

VPlexcli:/> iscsi sendtargets rediscover --cluster cluster-1/
Issued sendtarget rediscovery.

See also ◆ iscsi check-febe-connectivity

◆ iscsi sendtargets add
◆ iscsi sendtargets list
◆ iscsi sendtargets remove

302 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

iscsi sendtargets remove

Note: This command is not supported in VPLEX.

Removes an iSCSI storage array's target portals from the cluster list of configured
target portals.

Contexts All contexts.

Syntax iscsi sendtargets remove

[-s|--sockets] sendtarget-sockets [, sendtarget sockets,...]
[-c|--cluster] cluster context
[-h]--help]

Arguments Required arguments

[-s|--sockets] sendtarget-sockets - * Specifies the IP address(es), with optional :port, of
the iSCSI sendtargets. If unspecified, the port defaults to 3260.

Optional arguments
[-c|--cluster] cluster context - Context path of the cluster from which the target portals
should be removed.
[-h|--help] - Displays command line help.
* - argument is positional.

Description After an iSCSI target portal is removed, a new round of discovery begins immediately.

Note: This command is only valid on systems that support iSCSI devices.

Example Remove two target portals with IP addresses of 192.168.100.2 and 192.168.101.2:
VPlexcli:/> iscsi sendtargets remove -c cluster-1 -t 192.168.100.2, 192.168.101.2
Successfully removed 2 target portals.

Example Remove two target portals with IP addresses and specified ports, 192.168.100.2:3000
and 192.168.101.2:3001.
VPlexcli:/> iscsi sendtargets remove -c cluster-1 -t 192.168.100.2:3000, 192.168.101.2:3001
Successfully removed 2 target portals.

Example Attempt to remove two target portals that are not configured with the given IP addresses.
VPlexcli:/> iscsi sendtargets remove -c cluster-1 -t 192.168.100.2, 192.168.101.2
Unable to remove the following target portals:
Target Portal Error
------------- -------------------------------------------------------------------
192.168.100.2 Target portal 192.168.100.2:3260 is not present at cluster-1
192.168.101.2 Target portal 192.168.101.2:3260 is not present at cluster-1

Successfully removed 0 target portals.

See Also ◆ iscsi check-febe-connectivity

◆ iscsi sendtargets add
◆ iscsi sendtargets list

iscsi sendtargets remove 303

VPLEX CLI Command Descriptions

◆ iscsi sendtargets rediscover

iscsi targets list

Note: This command is not supported in VPLEX.

Displays the list of iSCSI targets that are discovered on the cluster.

Contexts All contexts.

Syntax iscsi targets list

[-c|--cluster] cluster context
[-h|--help]

Arguments Optional arguments

[-c|--cluster] cluster context - Context path of cluster for which existing targets should be
listed. Defaults to local cluster if not specified.
[-h|--help] - Displays command line help.

Description Displays the list of iSCSI targets that are discovered on the cluster.

Note: This command is valid only on systems that support iSCSI devices.

Example List iSCSI targets for cluster 1:

VPlexcli:/> iscsi targets list -c cluster-1

See also ◆ iscsi targets logout

iscsi targets logout

Note: This command is not supported in VPLEX.

Logs out of iSCSI storage array targets.

304 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Contexts All contexts.

Syntax iscsi targets logout

[-t|--targets] target [, target...]
[-c|--cluster] cluster context
[-h|--help]

Arguments Required arguments

[-t|--targets] target [, target...] - * Specifies the IQNs of the iSCSI targets.

Optional arguments
[-c|--cluster] cluster context - Context path of cluster from which the target portals should
be logged out.
[-h|--help] - Displays command line help.
* - argument is positional.

Description Logs out of iSCSI targets.

Note: This command is valid only on systems that support iSCSI devices.

Example Log out of a specified target on cluster 1:

VPlexcli:/> iscsi targets logout -t iqn.1992-04.com.emc.cx.amp00114103168.a8 -c cluster-1/

Successfully logged-out of 1 targets.

Example Logout failed due to an invalid target:

VPlexcli:/> iscsi targets logout -t not-a-real-target -c cluster-1/
Unable to logout from the following targets:
Targets Error
----------------- -----------------------
not-a-real-target Firmware command error.

Successfully logged-out of 0 targets.

See also ◆ iscsi targets list

local-device create
Creates a new local-device.

Contexts All contexts.

Syntax local-device create

[-d|--stripe-depth] depth
[-n|name] name
[-g|--geometry] {raid-0|raid-1|raid-c}
[-e|extents] context path,context path...
[-s|--source-leg] context path
--force

local-device create 305

VPLEX CLI Command Descriptions

Arguments Required arguments

[-n|--name] name - * Name for the new device. Must be unique across all clusters. Devices
on different clusters that have the same name cannot be combined into a distributed
device.

Note: If this device will have another device attached (using the device attach-mirror
command to create a RAID-1), the name of the resulting RAID-1 is the name given here
plus a timestamp. Names in VPLEX are limited to 63 characters. The timestamp consumes
16 characters. Thus, if this device is intended as the parent device of a RAID-1, the device
name must not exceed 47 characters.

[-g|--geometry] {raid-0|raid-1|raid-c} - * Geometry for the new device. Valid values are
“raid-0”, “raid-1”, or “raid-c”.



Use this command to create a RAID 1 device only if:
- None of the legs contains data that must be preserved,
- The resulting device will be initialized using tools on the host, or
- The resulting device will be added as a mirror to another device.

[-e|--extents] context path,context path... - * List of one or more claimed extents to be

added to the device. Can also be other local devices (to create a device of devices).
Optional arguments
[-d|--stripe-depth] depth - Required if --geometry is raid-0. Stripe depth must be:
◆ Greater than zero
◆ No greater than the number of blocks of the smallest element of the RAID 0 device
being created
◆ A multiple of the block size: 4 K bytes
A depth of 32 means 128 K (32 x 4 K) is written to the first disk then the next 128 K is
written to the next disk.
Concatenated RAID devices are not striped.
[-s|--source-leg] context path - When geometry argument is raid-1, picks one of the extents
specified by the --extents argument to be used as the source data image for the new
device. The command copies data from the'--source-leg to the other legs of the new
device.
[-f|--force] - Create a raid-1 device even if no --source-leg is specified.
* - argument is positional.

Description A device is configured from one or more extents in a RAID 1, RAID 0, or concatenated (RAID
C) configuration.
The block sizes of the supporting extents must be the same (4 K bytes) and will determine
the local-device block size.
When creating a device with RAID 1 geometry, this command prints a warning and asks for
confirmation.

306 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions



If the --source-leg argument is not specified, this command does not initialize or
synchronize the legs of a RAID 1 device. Because of this, a RAID 1 device created by this
command does not guarantee that consecutive reads of the same block will return the
same data if the block has never been written.

To create a RAID 1 device when one leg of the device contains data that must be
preserved, use the --source-leg argument or the device attach-mirror command to add a
mirror to the leg.
By default, automatic device rebuilds are enabled on all devices. For configurations with
limited bandwidth between clusters, it may be useful to disable automatic rebuilds.
Use the set command to enable/disable automatic rebuilds on the distributed device. The
rebuild setting is immediately applied to the device.
◆ Set rebuild-allowed to true to start or resume a rebuild if the mirror legs are out of
sync.
◆ Set rebuild-allowed set to false to stop any rebuild in progress.
When automatic rebuild is re-enabled on a device where it has been disabled, the
rebuild starts again from the place where it stopped.

Example In the following example:

◆ The ll command displays the available (claimed) extents
◆ The local-device create command is used to create a 16 GB RAID 1 device named
TestDevCluster1 on cluster 1
◆ The cd command returns to the root context
◆ The ll -p**/devices command displays the new device
VPlexcli:/clusters/cluster-1/storage-elements/extents> ll
Name StorageVolume Capacity Use
--------------------- ------------- -------- -------
.
.
.
extent_Symm1852_AAC_1 Symm1852_AAC 16G claimed
extent_Symm1852_AB0_1 Symm1852_AB0 16G claimed
extent_Symm1852_AB4_1 Symm1852_AB4 16G claimed
extent_Symm1852_AB8_1 Symm1852_AB8 16G claimed

VPlexcli:/clusters/cluster-1/storage-elements/extents> local-device create --name

TestDevCluster1 --geometry raid-1 --extents
/clusters/cluster-1/storage-elements/extents/extent_Symm1852_AAC_1,/clusters/cluster-1/storag
e- elements/extents/extent_Symm1852_AB0_1

VPlexcli:/clusters/cluster-2/storage-elements/extents> cd
VPlexcli:/> ll -p **/devices
/clusters/cluster-1/devices:
Name Operational Health Block Block Capacity Geometry Visibility Transfer Virtual
--------------- Status State Count Size -------- -------- ---------- Size Volume
--------------- ----------- ------ ------- ----- -------- -------- ---------- -------- ---------
TestDevCluster1 ok ok 4195200 4K 16G raid-1 local 2M -
base0 ok ok 262144 4K 1G raid-0 local - base0_vol
base1 ok ok 262144 4K 1G raid-0 local - base1_vol

local-device create 307

VPLEX CLI Command Descriptions

In the following example, the local-device create command creates a RAID-1 device from 2
extents; extent_lun_1_1 and extent_lun_2_1 in which:
◆ extent_lun_2_1 is the same size or larger than extent_lun_1_1
◆ extent_lun_1_1 is the source leg of the new device
◆ extent_lun_2_1 is the mirror leg
VPlexcli:/> local-device create --geometry raid-1 --extents extent_lun_1_1, extent_lun_2_1
--name dev_lun_1 --source-leg extent_lun_1_1

VPlexcli:/> ls -al /clusters/cluster-1/devices/

/clusters/cluster-1/devices:

Name Operational Health Block Block Capacity Geometry Visibility Transfer Virtual
----------- Status State Count Size -------- -------- ---------- Size Volume
----------- ----------- ------ -------- ----- -------- -------- ---------- -------- --------
dev_lun_1 ok ok 20709376 4K 5G raid-1 local - -

See also ◆ device attach-mirror

◆ local-device destroy
◆ local-device summary

local-device destroy
Destroys existing local-devices.

Contexts All contexts.

Syntax local-device destroy

[-f|--force]
[-d|--devices] context path,context path...

Arguments Required arguments

[-d|--devices] context path,context path... - * List of one or more device(s) to destroy.

Optional arguments
[-f|--force] - Force the destruction of the devices without asking for confirmation.
* - argument is positional.

Description The device must not be hosting storage or have a parent device.

Example VPlexcli:/clusters/cluster-1> local-device destroy -d was_1_leg_r1

WARNING: The following items will be destroyed:

Context
---------------------------------------
/clusters/cluster-1/devices/was_1_leg_r1
Do you wish to proceed? (Yes/No)

See also ◆ local-device create

◆ local-device summary

308 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

local-device summary
Displays unhealthy local devices and a summary of all local devices.

Contexts All contexts.

In /clusters/cluster/devices context, command is summary.

Syntax local-device summary

[-c|--clusters] cluster,cluster...

Arguments Optional arguments

[-c|--clusters] cluster,cluster... - Display information only for the specified cluster(s).

Description Displays unhealthy local devices and a summary of all local devices. Unhealthy devices
have non-nominal health state, operational status, or service-status.
If the --clusters argument is not specified and the command is executed at or below a
/clusters/cluster context, information for only that cluster is displayed.

Example Display local devices for a specified cluster:

VPlexcli:/> local-device summary --clusters cluster-1
device name health state operational status service status
--------------- ---------------- ------------------ --------------
dev_sym1723_1FC critical-failure error suspended

Device Summary (no tier)

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

Health devices 5
unhealthy 1

Visibility local 5

Capacity devices w/ space 0

free capacity 0B
total capacity 12G

Table 16 local device summary field descriptions

Field Description

Health

devices Number of devices in the cluster.

unhealthy Of the total number of devices in the cluster, the number whose health state is not “ok”.

Visibility Of the total number of devices in the cluster, the number with global or local visibility.
global - The remote cluster can access the virtual volume. A virtual volume on a top-level
device that has global visibility can be exported in storage views on any cluster.
local (default) - Device is visible only to the local cluster.

Capacity

devices w/ space Of the total number of devices in the cluster, the number with available space.

free capacity Total free capacity on the cluster.

total capacity Total capacity of the cluster.

local-device summary 309

VPLEX CLI Command Descriptions

See also ◆ ds summary

◆ export port summary
◆ export storage-view summary
◆ extent summary
◆ storage-volume summary
◆ virtual-volume provision

log filter create

Adds a new firmware log filter.

Contexts All contexts.

Syntax log filter create

[-s|--source] id]
[-t|--threshold] [<|>|=]0 - 7
[-c|--component] name
[-e|--event-num] id
[-m|--message] text
[-n|--no-consume]

Arguments Optional arguments

[-s|--source] id - ID of the source log to be filtered. Use the log source list command to
display the list of source logs and their IDs.
[-t|--threshold] [<|>|=]0 - 7 - Severity of the events to write to the new log. Messages are
categorized into 8 severities (0 - 7), with 0 being the most severe:
7 - debug (debug-level messages)
6 - info (informational messages)
5 - notice (normal but significant messages)
4 - warning (warning messages)
3 - err (error messages)
2 - crit (critical messages)
1 - alert (messages that must be handled immediately)
0 - emerg (messages notifying the system as unusable)
Default modifier is ‘>’.
[-c|--component] name - Component name to filter. Takes a regular expression as an
argument. Plain strings are searched for in the component name.
[-e|--event-num] id - Used in conjunction with a specified component. An event ID to filter.
[-m|--message] text - An expression to look for in the event message. Takes a regular
expression as an argument. Plain strings are searched for in the message text.
[-n|--no-consume] - Do not halt event processing after an event matches a filter.

310 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Description Log filters define criteria for the destination of specific log data. A filter is placed in an
ordered list, and filters see a received event in the order they sit in the list (shown by the
log filter list command).
By default, filters consume received events so that a matching filter stops the processing
of the event. Use the --no-consume argument to create a filter that allows processing of
matching events to continue.

Example Filter out (hide) all messages with the string test in them:
VPlexcli:/> log filter create -m "test"
Filter added.

Filter all messages into the events log generated by the logserver component with the
string Test:
VPlexcli:/> log filter create --source 1 --component logserver --message Test
Filter added.

VPlexcli:/> log filter list

1. [Source='/var/log/VPlex/cli/events.log', Component='logserver', Message matches 'Test']
Destination='null' Consume='true'
2. Component='logserver' Destination='null' Consume='true'
3. [Threshold='>0'] Destination='null' Consume='true'

See also ◆ log filter destroy

◆ log filter list

log filter destroy

Removes a firmware log filter.

Contexts All contexts.

Syntax log filter destroy

[-f|--filter] filter

Arguments Required arguments

[-f|--filter] filter - ID of filter to be deleted.

Description The filter is removed from the filter stack.

Use the log filter list command to display the filters configured on the VPLEX, and their
associated IDs.

Example
VPlexcli:/> log filter list
1. [Source='/var/log/VPlex/cli/events.log', Component='logserver', Message matches 'Test']
Destination='null' Consume='true'
2. Component='logserver' Destination='null' Consume='true'
3. [Threshold='>0'] Destination='null' Consume='true'

VPlexcli:/> log filter destroy 1

Filter removed.

See also ◆ log filter create

◆ log filter list

log filter destroy 311

VPLEX CLI Command Descriptions

log filter list

Lists firmware log filters, in the order that they see events.

Contexts All contexts.

Syntax log filter list

Description The number printed beside each filter serves as both an identifier for the log filter destroy
command as well as the order in which each respective filter will see an event.

Example

VPlexcli:/> log filter list

1. [Message matches 'Family and Fru Id Mismatch Retrieved'] Destination='null' Consume='true'
2. [Component='logserver'] Destination='null' Consume='true'
3. [Threshold='>=4'] Destination='null' Consume='true'

See also ◆ log filter create

◆ log filter destroy

log source create

Adds a firmware log source.

Contexts All contexts.

Syntax log source create

[-s|--source] host:port
[-p|--password password
[-f|--failover-source] host:port

Arguments Required arguments

[-s|--source] host:port - * IP address and port of the log source to be added. IP addresses
of the VPLEX hardware components are listed in the VPLEX Installation and Setup Guide.
[-p|--password] password - The password to use for authenticating to the source.

Optional arguments
[-f|--failover-source] host:port - IP address and port of the failover source to be added.
* argument is positional.

Description


For use by EMC personnel only.

Creates a source for writing entries to the firmware log.

Example VPlexcli:/> log source create --source 128.221.252.69:5988

Enter the source connection password:

VPlexcli:/> log source list

1. /var/log/VPlex/cli/events.log

312 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

.
.
.
6. [128.221.252.69:5988]/cpu0/log
7. [128.221.252.69:5988]/xmmg/log

See also ◆ log source destroy

◆ log source list

log source destroy

Destroys the specified log source.

Contexts All contexts.

Syntax log source destroy

[-s|--source] host:port

Arguments Required arguments

[-s|--source] host:port - IP address and port of the log source to destroy. IP addresses of
the VPLEX hardware components are listed in the VPLEX Installation and Setup Guide.

Description


For use by EMC personnel only.

Example VPlexcli:/> log source list

1. /var/log/VPlex/cli/events.log
2. 128.221.252.67:5988,[128.221.253.67:5988]/cpu0/log
3. 128.221.252.67:5988,[128.221.253.67:5988]/xmmg/log
4. 128.221.253.68:5988,[128.221.252.68:5988]/cpu0/log
5. 128.221.253.68:5988,[128.221.252.68:5988]/xmmg/log
6. [128.221.252.69:5988]/cpu0/log
7. [128.221.252.69:5988]/xmmg/log
8. [128.221.252.70:5988],128.221.253.70:5988/cpu0/log
9. [128.221.252.70:5988],128.221.253.70:5988/xmmg/log

VPlexcli:/> log source destroy --source 128.221.252.69:5988

See also ◆ log source create

◆ log source list

log source list

Lists the various log paths from which log events are processed.

Contexts All contexts.

Syntax log source list

Description Lists the log paths from which log events are processed and their reference IDs.
Used to create log filters.

Example VPlexcli:/> log source list

log source destroy 313

VPLEX CLI Command Descriptions

1. /var/log/VPlex/cli/events.log
2. 128.221.252.35:5988,[128.221.253.35:5988]/xmmg/log
3. 128.221.252.36:5988,[128.221.253.36:5988]/cpu0/log
4. [128.221.252.35:5988],128.221.253.35:5988/cpu0/log
5. [128.221.252.36:5988],128.221.253.36:5988/xmmg/log

See also ◆ log filter create

◆ log source create

logging-volume add-mirror
Adds a logging volume mirror.

Contexts All contexts.

Syntax logging-volume add-mirror

[-v|--logging-volume] logging volume
[-m|--mirror] {name|context path}

Arguments Optional arguments

[-v|--logging-volume] logging-volume - Logging volume to which to add the mirror.
[-m|--mirror] {name|context path} - The name or context path of the device or
storage-volume extent to add as a mirror. Must be top-level device or a storage-volume
extent.

Example In the following example:

◆ The ll command in system-volumes context displays the names of existing logging
volumes.
◆ The logging-volume add-mirror command adds a mirror to one of the logging volumes.
VPlexcli:/clusters/cluster-1/system-volumes> ll
Name Volume Type Operational Health Active Ready Geometry Block Block Capacity Slots
-------- -------------- Status State ------ ----- -------- Count Size -------- -----
-------- -------------- ----------- ------ ------ ----- -------- -------- ----- -------- -----
log1_vol logging-volume ok ok - - raid-1 20448000 4K 78G -
meta1 meta-volume ok ok true true raid-1 23592704 4K 90G 32000

VPlexcli:/clusters/cluster-1/system-volumes>logging-volume add-mirror --logging-volume

log1_vol --mirror /clusters/cluster-2/storage-elements/extents/extent_Symm2194_20F0_1

See also ◆ logging-volume create

◆ logging-volume destroy

logging-volume create
Creates a new logging volume in a cluster.

Contexts All contexts.

Syntax logging-volume create

[-n|--name] name
[-g|--geometry {raid-0 |raid-1}
[-e|--extents] context path,context path...
[-d|--stripe-depth] depth

314 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Required arguments

[-n|--name] name - * Name for the new logging volume.
[-g|--geometry] {raid-0|raid-1} - * Geometry for the new volume.
[-e|--extents] context path,context path...- * List of one or more storage-volume extents to
use to create the logging volume. Must not be empty, and must contain storage-volume
extents that are all at the specified cluster. Entries must be separated by commas.

Optional arguments
[-d|--stripe-depth] depth - Required if --geometry is raid-0. Stripe depth must be:
◆ Greater than zero, but not greater than the number of blocks of the smallest element
of the RAID 0 device being created
◆ A multiple of 4 K bytes
A depth of 32 means 128 K (32 x 4 K) is written to the first disk, then the next 128 K is
written to the next disk.
Best practice regarding stripe depth is to follow the best practice of the underlying array.
Concatenated RAID devices are not striped.
* - argument is positional.

Description Creates a logging volume. The new logging volume is immediately available for use with
distributed-devices.
A logging volume is required on each cluster in VPLEX Metro and Geo configurations. Each
logging volume must be large enough to contain one bit for every page of distributed
storage space (approximately 10 GB of logging volume space for every 160 TB of
distributed devices).
Logging volumes experience a large amount of I/O during and after link outages. Best
practice is to stripe each logging volume across many disks for speed, and to have a mirror
on another fast disk.
To create a logging volume, first claim the storage volumes that will be used, and create
extents from those volumes.
◆ Use the ll /clusters/cluster/storage-elements/storage-volumes command to display
the available storage volumes on the cluster.
◆ Use the storage-volume claim -n storage-volume_name command to claim one or
more storage volumes.
◆ Use the extent create -d storage-volume_name, storage-volume_name command to
create an extent to use for the logging volume.
Repeat this step for each extent to be used for the logging volume.

Example
VPlexcli:/clusters/cluster-1/system-volumes> logging-volume create -n c1_log_vol -g raid-1 -e
extent_1 , extent_2

VPlexcli:/clusters/cluster-1/system-volumes> cd c1_log_vol

VPlexcli:/clusters/cluster-1/system-volumes/c1_log_vol> ll
/clusters/cluster-1/system-volumes/c1_log_vol

logging-volume create 315

VPLEX CLI Command Descriptions

/clusters/cluster-1/system-volumes/c1_log_vol:

Attributes:
Name Value
-------------------------------- --------------
application-consistent false
biggest-free-segment-block-count 2612155
block-count 2621440
block-size 4K
capacity 10G
component-count 1
free-capacity 9.97G
geometry raid-0
health-indications []
health-state ok
locality local
operational-status ok
rebuild-allowed -
rebuild-eta -
rebuild-progress -
rebuild-status -
rebuild-type -
stripe-depth 4K
supporting-device logging_c1_log
system-id logging_c1_log
transfer-size -
volume-type logging-volume

Contexts:
Name Description
---------- -------------------------------------------------------------------
components The list of components that support this logging-volume.
segments Shows what parts of the logging volume are assigned to log changes
on distributed-device legs.

VPlexcli:/clusters/cluster-1/system-volumes/c1_log_vol> ll
/clusters/cluster-1/system-volumes/c1_log_vol/components

/clusters/cluster-1/system-volumes/c1_log_vol/components:
Name Slot Type Operational Health Capacity
----------------------- Number ------ Status State --------
----------------------- --------- ------ --------------- -------- --------
extent_VNX-1912_LUN10_1 0 extent ok ok 15G
extent_VNX-1912_LUN11_1 1 extent ok ok 15G

VPlexcli:/clusters/cluster-1/system-volumes/c1_log_vol> ll
/clusters/cluster-1/system-volumes/c1_log_vol/segments

/clusters/cluster-1/system-volumes/c1_log_vol/segments:
Name Starting Block Use
-------------------------------------------------------- Block Count --------------------------------------------
-------------------------------------------------------- -------- ------- --------------------------------------------
allocated-c1_dr1ActC1_softConfig_CHM_C1_0000 1084 17 allocated for
c1_dr1ActC1_softConfig_CHM_C1_0000
allocated-c1_dr1ActC1_softConfig_CHM_C1_0001 1118 17 allocated for
c1_dr1ActC1_softConfig_CHM_C1_0001
.
.
.
allocated-r0_deviceTgt_C2_CHM_0001 2077 17 allocated for r0_deviceTgt_C2_CHM_0001
allocated-r1_mirrorTgt_C1_CHM_0001 2060 17 allocated for r1_mirrorTgt_C1_CHM_0001
free-1057 1057 10 free
free-2094 2094 3930066 free
free-40 40 2 free
free-82 82 2 free

VPlexcli:/clusters/cluster-1/system-volumes/c1_log_vol>

316 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Table 17 logging volume display fields

Field Description

application-consist Whether or not this storage-volume is application-consistent.

ent

biggest-free-segme The block count of the largest remaining free segment in the logging
nt-block-count volume. This is the upper limit on the size of a new allocated segment.

block-count The number of blocks in the volume.

block size The size of a single block, in kilobytes.

capacity The total number of bytes in the volume. Equals the 'block-size' multiplied
by the 'block-count'.

component-count The number of mirrors in this raid-1 logging volume.

free-capacity The number of free slots for storage-volume headers in this logging volume.

geometry Indicates the geometry or redundancy of this device. Will always be raid-1.

health-indications If health-state is not “ok”, additional information.

health-state ok - The storage volume is functioning normally.

degraded - The storage volume may be out-of-date compared to its mirror.
(This state applies only to a storage volume that is part of a RAID-1
Metadata Volume.)
unknown - VPLEX cannot determine the storage volume's Health state, or
the state is invalid.
non-recoverable error - The storage volume may be out-of-date compared to
its mirror (applies only to a storage volume that is part of a RAID-1 Metadata
Volume), and/or VPLEX cannot determine the Health state.
critical failure - VPLEX has marked the storage volume as hardware-dead.

locality Locality of the supporting device.

local - The volume is local to the enclosing cluster.
remote - The volume is made available by a different cluster than the
enclosing cluster, and is accessed remotely.
distributed - The virtual volume either has, or is capable of having, legs at
more than one cluster. *}

operational status ok - The storage volume is functioning normally.

degraded - The storage volume may be out-of-date compared to its mirror.
(This state applies only to a storage volume that is part of a RAID-1
Metadata Volume.)
unknown - VPLEX cannot determine the storage volume's Health state, or
the state is invalid.
error - VPLEX has marked the storage volume as hardware-dead.
starting - The storage volume is not yet ready.
lost-communication - The storage volume is unreachable.

rebuild-allowed Whether or not this device is allowed to rebuild.

rebuild -eta The estimated time remaining for the current rebuild to complete.

rebuild-progress The percentage of this device that has been rebuilt.

rebuild-status The rebuild status of this device.

logging-volume create 317

VPLEX CLI Command Descriptions

Table 17 logging volume display fields

Field Description

rebuild-type The rebuild type.

full - A full copy of all the blocks.
incremental - Uses a checksum differencing algorithm to transfer only those
(chunks of) blocks that are different.
comparison - A comparison copy.
resync - A resync rewrites blocks that may have been affected by a director
failure, guaranteeing that the mirror legs are identical.

stripe-depth The depth of a stripe in bytes when 'geometry' is 'raid-0'.

supporting-device The local, remote, or distributed device underlying the virtual volume.

system-id Name assigned to the logging-volume.

transfer-size The transfer size during rebuild in bytes. See About transfer-size in the
batch-migrate start command.

volume-type For logging volumes, this is always logging-volume.

/components context

Name Name of the extent.

Slot number The slot number of the component.

Type Indicates the type of component: a storage-volume, extent, or device.

Operational Status The operational status for the entity. This indicates whether the entity is
functioning, and if so, how well it is functioning.

Health State Represents an overview of the health of the extent.

Capacity Represents an overview of the capacity of the extent.

/segments context

Name Name of the segment.

Starting block Always 0.

Block count Number of blocks in the segment.

Use Indicates how the segment is used.

See also ◆ extent create

◆ logging-volume add-mirror
◆ logging-volume destroy
◆ storage-volume claim

logging-volume detach-mirror
Detaches a mirror from a logging volume.

Contexts All contexts.

318 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Syntax logging-volume detach-mirror

[-m|--mirror] mirror
[-v|--logging-volume] logging-volume
[-s|--slot] slot number
[-h|--help]
[--verbose]

Arguments Optional agruments

[-m|--mirror] mirror - * Specifies the name or context path of the logging volume mirror to
detach. If you specify the mirror, do not specify the slot number.
[-v|--logging-volume] logging-volume - Specifies the name of the logging volume from
which to detach the mirror.
[-s|--slot] slot number - Specifies the slot number of the mirror to detach. If you specify the
slot number, do not specify the mirror.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.
* - argument is positional.

Description This command detaches a mirror from a logging-volume. The logging-volume must have a
RAID1 geometry and the mirror must be a direct child of the logging-volume.
You must specify the --slot or --mirror option but not both.
To detach a mirror from a component of a logging-volume use the device detach-mirror
command.

Example Lists the attributes of the logging volume:

VPlexcli:/clusters/Hopkinton/system-volumes> ll logging_vol/

/clusters/Hopkinton/system-volumes/logging_vol:

Attributes:
Name Value
-------------------------------- --------------
application-consistent false
biggest-free-segment-block-count 2620324
block-count 2621440
block-size 4K
capacity 10G
component-count 1
free-capacity 10G
geometry raid-1
health-indications []
health-state ok
locality local
operational-status ok
provision-type legacy
rebuild-allowed true
rebuild-eta -
rebuild-progress -
rebuild-status done
rebuild-type full
stripe-depth -
supporting-device logging
system-id logging
transfer-size 128K

logging-volume detach-mirror 319

VPLEX CLI Command Descriptions

volume-type logging-volume

Contexts:
Name Description
---------- -------------------------------------------------------------------
components The list of components that support this logging-volume.
segments Shows what parts of the logging volume are assigned to log
changes on distributed-device legs.

Example Lists the logging volume components:

VPlexcli:/clusters/Hopkinton/system-volumes> ll logging_vol/components/

/clusters/Hopkinton/system-volumes/logging_vol/components:
Name Slot Type Operational Health Capacity
------------------------------- Number ------ Status State -------
------------------------------- ------- ------ ----------- ------ -------
extent_CLARiiON1389_LUN_00023_1 0 extent ok ok 10G

Example Specifies the name of the mirror to detach:

*VPlexcli:/clusters/Hopkinton/system-volumes> logging-volume detach-mirror --mirror
extent_CLARiiON1389_LUN_00023_1/*

Specifies the slot number of the mirror to detach:

*logging-volume detach-mirror --logging-volume logging_vol/ --slot 0*

See also ◆ logging-volume add-mirror

◆ logging-volume create
◆ logging-volume destroy

logging-volume destroy
Destroys an existing logging volume.

Contexts All contexts.

Syntax logging-volume destroy logging-volume

Arguments Required arguments

[-v|--logging-volume] logging-volume - * Name of logging volume to destroy.
* - argument is positional.

Description The volume to be destroyed must not be currently used to store block write logs for a
distributed-device.

Example VPlexcli:/clusters/cluster-1/system-volumes> logging-volume destroy

--logging-volume cluster_6_log_vol

See also ◆ logging-volume add-mirror

◆ logging-volume create

320 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ logging-volume detach-mirror

logical-unit forget
Forgets the specified logical units (LUNs).

Contexts All contexts.

Syntax logical-unit forget

[-s|--forget-storage-volumes]
[-u|--logical-units] context path,context path,...

Arguments Required arguments

[-u|--logical-units] context path, context path ... - List of one or more LUNs to forget.

Optional arguments
[-s|--forget-storage-volumes] - If a LUN has an associated storage-volume, forget it AND the
associated storage-volume.

Description Forget one or more logical units (LUNs). Optionally, forget the storage volume if one is
configured on the LUN. This command attempts to forget each LUN in the list specified,
logging/displaying errors as it goes.
A logical unit can only be forgotten if it has no active paths. LUNs can be remembered
even if a cluster is not currently in contact with them. This command tells the cluster that
the specified LUNs are not coming back and therefore it is safe to forget about them.
If a specified LUN has an associated storage-volume, that LUN is skipped (is not
forgotten).
Use the --verbose argument to print a message for each volume that could not be
forgotten.
Use the --forget-storage-volume argument to forget the logical-unit AND its associated
storage-volume. This is equivalent to using the storage-volume forget command on those
storage-volumes.

Example Forget the logical units in the current logical unit context:
VPlexcli:/clusters/cluster-1/storage-elements/storage-arrays/EMC-SYMMETRIX-192602773/logical-
units> logical-unit forget
13 logical-units were forgotten.
102 logical-units have associated storage-volumes and were not forgotten

Example Use the --verbose arguments to display detailed information about any logical units that
could not be forgotten:
VPlexcli:/clusters/cluster-1/storage-elements/storage-arrays/EMC-SYMMETRIX-192602773/logical-
units> logical-unit forget --forget-storage-volumes --verbose

WARNING: Error forgetting logical-unit: Logical-unit

'VPD83T3:6006016030802100e405a642ed16e111'has active paths and cannot be forgotten.
.
.
.
WARNING: Error forgetting storage-volume 'VPD83T3:60000970000192602773533030353933': The 'use'
property of storage-volume VPD83T3:60000970000192602773533030353933' is 'meta-data' but must
be 'unclaimed' or 'unusable' before it can be forgotten.
.

logical-unit forget 321

VPLEX CLI Command Descriptions

.
.
13 logical-units were forgotten:
VPD83T3:60000970000192602773533030353777
.
.
.
11 storage-volumes were forgotten:
VPD83T3:6006016030802100e405a642ed16e1099
.
.
.

See also ◆ storage-volume forget

ls
Displays information about the current object or context.

Contexts All contexts.

Syntax ls options context

[-l|--long]
[-a|--attributes]
[-A|--no-attributes]
[-t|--attribute] selector
[-p|--paged]
[-m|--commands]
[-f|--full]
[-C|--no-contexts]
[-c|--context] context,context...

Arguments Optional arguments

[-l|--long] - Display more detailed information.
[-a|--attributes] - Includes the attributes of the target contexts.
[-A|--no-attributes] - Excludes attributes.
[-t|--attribute-selector] attribute-selector - Display the contents of the specified attributes.
[-p|--paged] - Page output if it is longer than the window height.
[-m|--commands] depth - Includes commands in the listing.
[-f|--full] - Do not summarize long attribute listings.
[-C|--no-contexts] - Excludes contexts from the listing.
[-c|--context] context,context... - The contexts whose contents are to be listed.

Description If the [-c|--context] argument is omitted, displays the contents of the current context.
The contents of a context include: its child contexts, if any; its attributes, if any; and the
available commands, if any.
The context name can be any valid glob pattern.

Notes The VPLEX CLI includes ll, a pre-defined alias of ‘ls -a’.

Example Display a device’s attributes:

322 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

VPlexcli:/> ls -C /clusters/cluster-2/devices/device_CLAR0014_LUN04_1

/clusters/cluster-2/devices/device_CLAR0014_LUN04_1:
Name Value
---------------------- -----------------------
application-consistent false
block-count 2621440
block-size 4K
capacity 10G
geometry raid-0
health-indications []
health-state ok
locality local
operational-status ok
rebuild-allowed -
rebuild-eta -
rebuild-progress -
.
.
.

Use the --attribute argument to display the operational status of all directors:
VPlexcli:/> ls --attribute /engines/*/directors/*::operational-status

/engines/engine-2-1/directors/dirB:
Name Value
------------------ -----
operational-status ok

/engines/engine-2-1/directors/dirA:
Name Value
------------------ -----
operational-status ok
.
.
.
Display a cluster’s attributes and the contexts below the cluster context:
VPlexcli:/> ls /clusters/cluster-1

/clusters/cluster-1:

Attributes:
Name Value
---------------------- ------------
allow-auto-join true
auto-expel-count 0
auto-expel-period 0
auto-join-delay 0
cluster-id 1
connected true
default-cache-mode synchronous
default-caw-template true
director-names [DirA, DirB]
island-id 1
operational-status ok
transition-indications []
transition-progress []
health-state ok
health-indications []

Contexts:

ls 323
VPLEX CLI Command Descriptions

cluster-connectivity devices exports

storage-elements
system-volumes uninterruptible-power-supplies virtual-volumes

Use a glob pattern to display all the fans:

VPlexcli:/> ls --long /**/fans

Use a glob pattern to display:

◆ All fans
◆ All the uninterruptable power supply settings:
VPlexcli:/> ls --long /**/fans, /**/uninterruptible-power- supplies/*

Use the --attribute-selector argument to display the contents of the 'virtual-volumes'

attribute on all views:
VPlexcli:/> ls --attribute /clusters/*/exports/storage-views /*::virtual-volumes

See also ◆ alias

management-server network-service-restart
Restarts the network service on the management server. This command is supported in
Release 5.1.1 and later.

Contexts All contexts.

Syntax management-server network-service-restart

Description Restarts the network service on the management server.

In VPLEX Metro and Geo configurations, run this command on both management servers.

Example VPlexcli:/> management-server network-service-restart

See also ◆ vpn restart

management-server set-ip
Assigns IP address, net-mask, and gateway IP address to the specified management port.

Contexts All contexts.

Syntax management-server set-ip

[-i|--ip-netmask] destination IP address/subnet mask

[-i|--ip-netmask] destination IP address/CIDR mask

[-g|--gateway] IP address
[-p|--management-port] context path

324 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Required arguments

[-i|--ip-netmask] destination IP address:subnet mask - The address and subnet mask of
the Ethernet port. The format of the address/subnet mask depends on the version of IP.
◆ To specify an IPv4 address - The format is: destination IP address/subnet mask
For example: 172.16.2.0/255.255.255.0
◆ To specify an IPv6 address - The format is: destination IP address/CIDR netmask
For example: 3ffe:80c0:22c:803a:250:56ff:feb5:c1/64.
[-g|--gateway] IP address - The IP address of the gateway for this management server.
[-p|--management-port] context path - Ethernet port for which the parameters are
assigned/changed.

Description The VPLEX management server includes 4 Ethernet ports:

◆ eth0 - Service port.
◆ eth1 and eth2 - Internal management ports.
◆ eth3 - Public management port. The only Ethernet port in the VPLEX server that may be
connected to an external management LAN.
The IP addresses for eth0, eth1, and eth2 cannot be changed.
Use the management-server set-ip command to set the IP address and netmask for port
eth3.
Ports eth0, eth1 and eth2 do not have IPv6 addresses. Example output of the ll command
for eth0, eth1 and eth2:
/management-server/ports/eth0:
Name Value
------------- ---------------
address 128.221.253.33
auto-negotiate true
duplex auto-negotiated
gateway 10.31.52.1
inet6-address []
inet6-gateway []
net-mask 255.255.255.224
speed auto-negotiated
status ok



Changing the IP address for port eth3 can disrupt your inter-cluster link, and if VPLEX
Witness is deployed, disrupt the VPN between the VPLEX clusters and the Witness Server.

Additional failures (for example a remote VPLEX cluster failure) while VPN between the
VPLEX clusters and the Witness Server is disrupted could lead to DU for all distributed
virtual volumes in synchronous consistency groups.
For the procedure to safely change the management server IP address, refer to the
Troubleshoot => Cluster Witness section of the VPLEX procedures in the SolVe Desktop.

Example Modify an IPv4 address:

◆ The ll command displays the current setting for eth3

management-server set-ip 325

VPLEX CLI Command Descriptions

◆ The management-server set-ip command modifies the port’s IPv4 settings:

VPlexcli:/> ll /management-server/ports/eth3

/management-server/ports/eth3:
Name Value
-------------- -------------
address 10.31.52.70
auto-negotiate true
duplex full
gateway 10.31.52.21
inet6-address -
inet6-gateway -
net-mask 255.255.248.0
speed 0.977GB/s
status up

VPlexcli:/> management-server set-ip --ip-netmask 10.31.52.197/255.255.252.0 --gateway

10.31.52.1 -p eth3

Example Modify an IPv6 address:

◆ The ll command displays the current setting for eth3
◆ The management-server set-ip command modifies the port’s IPv6 settings:
VPlexcli:/> ll /management-server/ports/eth3

Name Value
------------- -----------------------------------------------------
address 10.31.52.197
auto-negotiate true
duplex full
gateway 10.31.52.1
inet6-address [3ffe:80c0:22c:803c:215:17ff:fecc:4408/64 Scope: Global,
3ffe:80c0:22c:803c:415:17ff:fecc:4408/64 Scope: Link]
inet6-gateway 3ffe:80c0:22c:803c::1
net-mask 255.255.252.0
speed 0.977GB/s
status up

VPlexcli:/> management-server set-ip --ip-netmask 3ffe:80c0:22c:803c:215:17ff:fed2:fe88/64

--gateway 3ffe:80c0:22c:803c::1 -p eth3

manifest upgrade
Loads a new manifest file, replacing the old one, if it exists.

Contexts All contexts.

Syntax manifest upgrade

[-m|--manifest] pathname

Arguments Required arguments

[-m|--manifest] pathname - Path to manifest file. Relative paths can be used.

Description The new manifest file will be validated before it replaces the old one.
If there is no current valid manifest file (corrupted or missing), the specified manifest file
is installed without confirmation.

326 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

If a valid manifest file exists, confirmation is required if the specified manifest file does
not have a newer version than the existing one.

See also ◆ manifest version

manifest version
Displays the version of the currently loaded manifest file.

Contexts All contexts.

Syntax manifest version

Description A Jython command used by scripts during upgrades.

Example VPlexcli:/> manifest version

1.106.0

See also ◆ manifest upgrade

meta-volume attach-mirror
Attaches a storage-volume as a mirror to a meta-volume.

Contexts All contexts.

Syntax meta-volume attach-mirror

[-d|--storage-volume] context path
[-v|--meta-volume] context path

Arguments Required arguments

[-d|--storage-volume] context path - Storage-volume to attach as a mirror to the
meta-volume.
[v|--meta-volume] context path - Meta-volume to which the storage-volume should be
attached as a mirror.

Description Creates a mirror and backup of the specified meta-volume. The specified
storage-volume(s):
◆ Must not be empty,
◆ Must be at the implied or specified cluster,
◆ Unclaimed,
◆ 78 GB or larger.
EMC recommends a mirror and a backup of the meta-volume are created using at least two
disks from two different arrays.

Note: A mirror can be attached when the meta-volume is first created by specifying two
storage volumes.

Example Attach storage-volume “VPD83T3:6…ade11” as a mirror to the existing meta-volume

“_dmx”:

manifest version 327

VPLEX CLI Command Descriptions

VPlexcli:/engines/engine-1-1/directors> meta-volume attach-mirror --storage-volume

VPD83T3:6006016023901d00484f496fa07ade11 --meta-volume _dmx

-volume _dmx is created at /clusters/cluster-1/system-volumes.

See also ◆ meta-volume detach-mirror

meta-volume backup
Creates a new meta-volume and writes the current in-memory system data to the new
meta-volume without activating it.

Contexts All contexts.

Syntax meta-volume backup

[-d|--storage-volumes] context path,context path...
[-c|--cluster] context path
[-f|--force]

Arguments Required arguments

[-d|--storage-volume] context path,context path...- * List of two or more storage volumes to
use in creating the backup meta-volume. The specified storage-volume(s):
◆ Must not be empty
◆ Must be at the implied or specified cluster
◆ Unclaimed
◆ 78 GB or larger
Type the system IDs for multiple (two or more) storage volumes, separated by commas.

Optional arguments
[-c|--cluster] context path - The cluster whose active meta-volume will be backed-up.
[-f|--force] - Forces the backup meta-volume to be activated without asking for
confirmation.
* - argument is positional.

Description Backup creates a point-in-time copy of the current in-memory metadata without activating
it. The new meta-volume is named:
current-metadata-namebackup_yyyyMMMdd_HHmms
Metadata is read from the meta-volume only during the boot of each director.

IMPORTANT
At boot, VPLEX reads the first meta-volume it encounters. If an out-of-date meta-volume is
visible to VPLEX, and is the first encountered during boot, that meta-volume is read.

All but the latest meta-volume should be moved to where they are not visible to VPLEX
during boot.

Create a backup meta-volume:

328 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ As part of an overall system health check before a major migration or update

◆ If the VPLEX permanently loses access to both meta-volumes.

IMPORTANT
No modifications should be made to VPLEX during the backup procedure. Make sure that
all other users are notified.

Use the ll command in the system-volumes context to verify that the meta-volume is Active
and its Ready state is true.

Example Back up the metadata to a RAID 1 of two specified storage volumes:

VPlexcli:meta-volume backup --storage-volumes VPD83T3:60060480000190300487533030354636,
VPD83T3:60060480000190300487533030343445

See also ◆ meta-volume create

◆ meta-volume destroy

meta-volume create
Creates a new meta-volume in a cluster when there is no existing active meta-volume.

Contexts All contexts.

Syntax meta-volume create

[-n|--name] name
[-d|--storage-volumes] context path,context path...
[-f|--force]

Arguments Required arguments

[-n|--name] name - * Name of the new meta-volume.
[-d|--storage-volume] context path,context path...- * List of two or more storage volumes to
use in creating the new meta-volume. The specified storage volumes must not be empty,
and must be at the implied or specified cluster.
Type the system IDs for the storage volumes separated by commas.

IMPORTANT
Specify two or more storage volumes. Storage volumes should be on different arrays.

Optional arguments
[f|--force] - Forces the meta-volume to be created without asking for confirmation.
* - argument is positional.

Description VPLEX metadata includes virtual-to-physical mappings, data about devices, virtual
volumes, and configuration settings.
Metadata is stored in cache and backed up on a specially designated external volume
called the meta-volume.

meta-volume create 329

VPLEX CLI Command Descriptions

The meta-volume is critical for system recovery. The best practice is to mirror the
meta-volume across two or more back-end arrays to eliminate the possibility of data loss.
Choose the arrays used to mirror the meta-volume such that they are not required to
migrate at the same time.
Meta-volumes differ from standard storage volumes in that:
◆ A meta-volume is created without first being claimed,
◆ Meta-volumes are created directly on storage volumes, not extents.



If the meta-volume is configured on a CLARiiON array, it must not be placed on the vault
drives of the CLARiiON.

Performance is not critical for meta-volumes. The minimum performance allowed is 40

MB/sec and 100 4 K IOP/second.
The physical spindles for meta-volumes should be isolated from application workloads.
EMC recommends the following for meta-volumes:
◆ Read caching enabled.
◆ A “hot spare” meta-volume pre-configured in case of a catastrophic failure of the
active meta-volume.
◆ Minimum of 78 GB.
If two or more storage-volumes are specified, they must be on two separate arrays if more
than one array is present. This command creates a RAID-1 of all the storage-volumes.

Example In the following example:

◆ The configuration show-meta-volume- candidates command displays possible
candidates:

Note: Example out put is truncated. Vendor, IO Status, and Type fields are omitted.

◆ The meta-volume create command creates a new mirrored volume using the 2
specified storage volumes.
◆ The ll command displays the new meta-volume.
VPlexcli:/> configuration show-meta-volume-candidates
Name Capacity...Array Name
---------------------------------------- -------- -----------------------------------
VPD83T3:60060480000190100547533030364539 187G .....EMC-SYMMETRIX-190100547
VPD83T3:60000970000192601707533031333132 98.5G.....EMC-SYMMETRIX-192601707
VPD83T3:60000970000192601707533031333133 98.5G.....EMC-SYMMETRIX-192601707
VPD83T3:60000970000192601707533031333134 98.5G.....EMC-SYMMETRIX-192601707
VPD83T3:60000970000192601707533031333135 98.5G.....EMC-SYMMETRIX-192601707
VPD83T3:60000970000192601707533031333136 98.5G.....EMC-SYMMETRIX-192601707
VPD83T3:60000970000192601707533031333137 98.5G.....EMC-SYMMETRIX-192601707
VPD83T3:60000970000192601707533031333138 98.5G.....EMC-SYMMETRIX-192601707
VPD83T3:6006016049e02100442c66c8890ee011 80G ......EMC-CLARiiON-FNM00083800068
l
.
.
.

330 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

VPlexcli:meta-volume create --name c1_meta -storage-volumes

VPD83T3:60000970000192601707533031333136, VPD83T3:60060480000190300487533030343445

VPlexcli:/>cd /clusters/cluster-1/system-volumes

VPlexcli:/clusters/cluster-1/system-volumes> ll c1_meta

/clusters/cluster-1/system-volumes/c1_meta:

Attributes:
Name Value
---------------------- -----------
active true
application-consistent false
block-count 20971264
block-size 4K
capacity 80G
component-count 2
free-slots 27199
geometry raid-1
health-indications []
health-state ok
locality local
operational-status ok
ready true
rebuild-allowed true
rebuild-eta -
rebuild-progress -
rebuild-status done
rebuild-type full
slots 32000
stripe-depth -
system-id c1_meta
transfer-size 128K
volume-type meta-volume

Contexts:
Name Description
---------- -------------------------------------------------------------------
components The list of components that support this device or system virtual
volume.

Table 18 meta-volume display fields

Field Description

active Indicates whether this is the currently-active metadata volume. The system
has only one active metadata volume at a time.

application-consist Whether or not this storage-volume is application-consistent.

ent

block-count The number of blocks.

capacity The size of the meta-volume.

component-count The number of mirrors in this raid-1 meta-data volume.

free-slots The number of free slots for storage-volume headers in this meta-volume.

geometry Indicates the geometry or redundancy of this device. Will always be raid-1.

meta-volume create 331

VPLEX CLI Command Descriptions

Table 18 meta-volume display fields

Field Description

health-indications If health-state is not “ok”, additional information.

health-state ok - The storage volume is functioning normally.

degraded - The storage volume may be out-of-date compared to its mirror.
(This state applies only to a storage volume that is part of a RAID-1
Metadata Volume.)
unknown - VPLEX cannot determine the storage volume's Health state, or
the state is invalid.
non-recoverable error - The storage volume may be out-of-date compared to
its mirror (applies only to a storage volume that is part of a RAID-1 Metadata
Volume), and/or VPLEX cannot determine the Health state.
critical failure - VPLEX has marked the storage volume as hardware-dead.

locality Locality of the supporting device.

local - The volume is local to the enclosing cluster.
remote - The volume is made available by a different cluster than the
enclosing cluster, and is accessed remotely.
distributed - The virtual volume either has, or is capable of having, legs at
more than one cluster. *}

operational status ok - The storage volume is functioning normally.

degraded - The storage volume may be out-of-date compared to its mirror.
(This state applies only to a storage volume that is part of a RAID-1
Metadata Volume.)
unknown - VPLEX cannot determine the storage volume's Health state, or
the state is invalid.
error - VPLEX has marked the storage volume as hardware-dead.
starting - The storage volume is not yet ready.
lost-communication - The storage volume is unreachable.

ready Indicates whether this metadata volume is ready or not.

rebuild-allowed Whether or not this device is allowed to rebuild.

rebuild -eta The estimated time remaining for the current rebuild to complete.

rebuild-progress The percentage of this device that has been rebuilt.

rebuild-status The rebuild status of this device.

rebuild-type The rebuild type.

full - A full copy of all the blocks.
incremental - Uses a checksum differencing algorithm to transfer only those
(chunks of) blocks that are different.
comparison - A comparison copy.
resync - A resync rewrites blocks that may have been affected by a director
failure, guaranteeing that the mirror legs are identical.

slots The total number of slots for storage-volume headers in this meta-volume.

stripe-depth The depth of a stripe in bytes when 'geometry' is 'raid-0'.

system-id Name assigned to the meta-volume.

transfer-size The transfer size during rebuild in bytes. See the “About transfer-size”
section in the batch-migrate start command.

volume-type For meta-volumes, this is always 'meta-volume'.

See also ◆ meta-volume destroy

332 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

meta-volume destroy
Destroys a meta-volume, and frees its storage volumes for other uses.

Contexts All contexts.

Syntax meta-volume destroy

[-v|--meta-volume] context path
[-f|--force]

Arguments Required arguments

[-v|--meta-volume] context path- * Meta-volume to destroy.

Optional arguments
[f|--force] - Destroys the meta-volume without asking for confirmation (allows the
command to be run from a non-interactive script). Allows the meta-volume to be
destroyed, even if the meta-volume is in a failed state and unreachable by VPLEX.
* - argument is positional.

Description The meta-volume cannot be destroyed if its active attribute is true.

Example In the following example:

◆ ll displays that the target meta-volume has an active state of false.
◆ The meta-volume destroy command destroys the meta-volume:
VPlexcli:/clusters/cluster-1/system-volumes> ll meta1

/clusters/cluster-1/system-volumes/meta1:

Attributes:
Name Value
---------------------- -----------
active false
application-consistent false
block-count 23592704
.
.
.
VPlexcli:/clusters/cluster-1/system-volumes> meta-volume destroy -v
meta1
Meta-volume 'meta1' will be destroyed. Do you wish to continue?
(Yes/No) y

See also ◆ meta-volume create

meta-volume detach-mirror
Detaches a storage-volume/mirror from a meta-volume.

Contexts All contexts.

meta-volume destroy 333

VPLEX CLI Command Descriptions

Syntax meta-volume detach-mirror

[-d|--storage-volume context path
[-v|--meta-volume] context path
[-s|--slot] slot number
[f|--force]
--discard

Arguments Required arguments

[-d|--storage-volume] context path - Storage volume to detach as a mirror from the
meta-volume.
[-v|--meta-volume] context path - * The meta-volume from which the
storage-volume/mirror should be detached.

Optional arguments
[-f|--force] - Force the mirror to be discarded. Required when the --discard argument is
used.
[-s|--slot] - The slot number of the mirror to be discarded. Applicable only when the
--discard argument is used.
--discard - Discards the mirror to be detached. The data is not discarded.
* - argument is positional.

Description Detaches the specified storage volume from a meta-volume.

Use the ll command in /clusters/cluster/system-volumes/meta-volume/components
context to display the slot number when using the discard argument.

Example
VPlexcli:/clusters/cluster-1/system-volumes/meta-vol-1/components> ll
Name Slot Type Operational Health Capacity
---------------------------------------- Number -------------- Status State --------
---------------------------------------- ------ -------------- ----------- ------ --------
VPD83T3:60000970000192601869533030373030 2 storage-volume ok ok 128G
VPD83T3:60000970000194900497533030333338 1 storage-volume ok ok 128G

VPlexcli:/clusters/cluster-1/system-volumes/meta-vol-1/components> meta-volume detach-mirror

--storage-volume VPD83T3:60000970000194900497533030333338 --meta-volume meta-vol-1

See also ◆ meta-volume attach-mirror

meta-volume move
Writes the current in-memory system data to the specified target meta-volume, then
activates it.

Contexts All contexts.

Syntax meta-volume move

[-t|--target-volume context path

Arguments Required arguments

[-t|--target-volume] context path - Storage volume to move metadata to. Target volume
must be:
◆ Unclaimed

334 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ 78 GB or larger

Description Writes the metadata to the specified meta-volume, and activates it. The specified
meta-volume must already exist (it is not created automatically).
This command fails if the destination meta volume has a lower number of meta data slots
than required to support the current configuration. This is highly likely if the target
meta-volume was manually created before Release 5.1 and has 32000 slots. Confirm this
by using the ll command in the system volume context. See the troubleshooting
procedures for VPLEX in the SolVe Desktop for information on fixing this problem.

Example To move a meta-volume from one storage volume to another:

1. Identify one or more storage volume(s) that are:
• Unclaimed
• 78 GB or larger
2. Use the meta-volume create command to create a new meta-volume. Specify the
storage volume identified in step 1 as the target volume(s).
VPlexcli:/engines/engine-1-1/directors> meta-volume create --name meta_dmx --storage-volumes
VPD83T3:6006016037202200966da1373865de11

3. Use the meta-volume move command to move the existing in-memory metadata to the
new meta-volume.
VPlexcli:/engines/engine-1-1/directors> meta-volume move --target-volume meta_dmx

See also ◆ meta-volume create

◆ meta-volume destroy

meta-volume verify-on-disk-consistency
Analyzes a meta-volume's committed (on-disk) header slots for consistency across all
mirrors/components.

Contexts All contexts.

Syntax meta-volume verify-on-disk-consistency

[-l|--log] log file
[-f|--first]offset
[-n|--number] number
[-c|--cluster] cluster
[-m|--meta-volume] meta-volume
--style {short|long|slow}

Arguments Required arguments

[-c|--cluster] cluster - The cluster at which to analyze the active meta-volume. This
argument may be omitted if the --meta-volume argument is present.
[-m|--meta-volume] meta-volume - The meta-volume to analyze. This argument may be
omitted if the --cluster argument is present.
[-l|--log] log file - Full path to the log file on the management server.
[-f|--first] first - Offset of first header to analyze.

meta-volume verify-on-disk-consistency 335

VPLEX CLI Command Descriptions

[-n|--number] number - Number of headers to analyze.

--style {short|long|slow} - The style of analysis to do. Valid values:
short - Requires special firmware support available only in Release 5.0 and later.
long - Requires special firmware support available only in Release 5.0 and later.
slow - Available for all Release versions. Downloads the meta-volume headers from
the meta-volume legs one at a time and compares them.



The slow option may take hours to complete on a production meta-volume.

Description An active meta-volume with an inconsistent on-disk state can lead to a data unavailability
(DU) during NDU.
Best practice is to NDU immediately after passing this meta-volume consistency check.

IMPORTANT
If any errors are reported, do not proceed with the NDU, and contact EMC Customer
Support.

The format and the length of time for the command to complete vary depending on the
VPLEX Release:
◆ For Release 4.2, the format of the command is:
meta-volume verify-on-disk-consistency -style slow --meta-volume meta-volume-name>

The length of time for the command to complete for Release 4.2 depends on the size
of the configuration. On a very large configuration, the command may take as long as
4 hours.

Note: Running this command is optional before upgrading from Release 4.2.

◆ For Release 5.0 and later, the format of the command is:
meta-volume verify-on-disk-consistency -style long --meta-volume meta-volume-name>

The command takes 10-20 minutes to complete.

Check the report in the log file saved at: /tmp/logfilename. The log file reports
mismatches between meta-volume RAID-1 legs.
If mismatches are detected, run the command again using the format:
meta-volume verify-on-disk-consistency -style slow --meta-volume meta-volume-name>

This version of the command takes an hour to complete.

Note: Running this command is recommended before upgrading from Release 5.0 or later.

Example Verify the specified meta-volume is consistent using the slow style:
VPlexcli:/> meta-volume verify-on-disk-consistency --style slow --meta-volume meta_cluster1

336 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Doing a slow consistency check on meta-volume

'/clusters/cluster-1/system-volumes/meta_cluster1' for slots [0,32000).
Scanning offsets [0,32000)
.............................................................................................
.........................
.............................................................................................
..........................
...............................................................
0 mismatches detected

Discover/display inconsistencies on a meta-volume using the long style:

VPlexcli:/clusters/cluster-2/system-volumes> meta-volume
verify-on-disk-consistency -c cluster-2 --style long
Doing a long consistency check on meta-volume
'/clusters/cluster-2/system-volumes/Cluster2_Meta_DGC_Vmax_mirror' for slots [0,32000).
Meta-volume is not consistent.
See /tmp/validatemeta.log for details of the inconsistencies.

See also ◆ meta-volume create

monitor add-console-sink
Adds a console sink to the specified performance monitor.

Contexts All contexts.

In /monitoring context, command is add-console-sink.

Syntax monitor add-console-sink

[-o|--format] {csv|table}
[-m|--monitor] monitor-name
--force

Arguments Required arguments

[-m|--monitor] context path - * Performance monitor to which to add a console sink.

Optional arguments
[-f|--force] - Forces the creation of the sink, even if existing monitors are delayed in their
polling.
[-o|--format] {csv|table} - The output format. Can be csv (comma-separated values)' or
table.
Default: table.
* -argument is positional.

Description Creates a console sink for the specified performance monitor. Console sinks send output
to VPLEX Management Server Console.
Every monitor must have at least one sink, and may have multiple sinks. A monitor does
not begin operation (polling and collecting performance data) until a sink is added to the
monitor.
Use the monitor add-console-sink command to add a console sink to an existing monitor.

monitor add-console-sink 337

VPLEX CLI Command Descriptions



Console monitors display the specified statistics on the Unisphere for VPLEX, interrupting
any other input/output to/from the console.

Example Add a console sink with output formatted as table (the default output format for console
sinks):
VPlexcli:/> monitor add-console-sink --monitor Director-2-1-B_TestMonitor
Navigate to the monitor context and use the ll console command to display the sink
settings:
VPlexcli:/cd /monitoring/directors/Director-2-1-B/monitors/Director-2-1-B_TestMonitor/sinks
VPlexcli:/monitoring/directors/Director-2-1-B/monitors/Director-2-1-B_TestMonitor/sinks> ll

Name Enabled Format Sink-To

------- ------- ------ -------
console true table console

VPlexcli:/monitoring/directors/Director-2-1-B/monitors/Director-2-1-B_TestMonitor/sinks> ll
console

/monitoring/directors/Director-2-1-B/monitors/Director-2-1-B_TestMonitor/sinks/console:
Name Value
------- -------
enabled true
format table
sink-to console
type console

See also ◆ monitor add-file-sink

◆ monitor remove-sink
◆ monitor create

monitor add-file-sink
Adds a file sink to the specified performance monitor.

Contexts All contexts.

In /monitoring context, command is add-file-sink.

Syntax monitor add-file-sink

[-n|--name] name
[-o|--format] {csv|table}
[-m|--monitor] monitor-name
[-f|--file] filename
--force

Arguments Required arguments

[-m|--monitor] context path - * Performance monitor to which to add a console sink.
[-f|--file] filename - * File to which to send the sink’s data.

Optional arguments
[-f|--force] - Forces the creation of the sink, even if existing monitors are delayed in their
polling.

338 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

[-n|--name] name - Name for the new sink. If no name is provided, the default name “file”
is applied.
[-o|--format] {csv|table} - The output format. Can be csv (comma-separated values)' or
table.
Default: csv.
* -argument is positional.

Description Creates a file sink for the specified monitor. File sinks send output to the specified file.
The default location of the output file is /var/log/VPlex/cli.
The default name for the file sink context is 'file”.
Every monitor must have at least one sink, and may have multiple sinks. A monitor does
not begin operation (polling and collecting performance data) until a sink is added to the
monitor
Use the monitor add-file-sink command to add a file sink to an existing monitor.

Example To add a file sink to send output to the specified .csv file:
VPlexcli:/monitoring/directors/director-1-1-A/monitors> monitor add-file-sink --monitor
director-1-1-A_stats --file /var/log/VPlex/cli/director_1_1_A.csv

Navigate to the monitor sinks context and use the ll sink-name command to display the
sink:
VPlexcli:/cd /monitoring/directors/director-1-1-A/monitors/director-1-1-A_stats/sinks
VPlexcli:/monitoring/directors/Director-1-1-A/monitors/director-1-1-A_stats/sinks> ll file

/monitoring/directors/Director-1-1-A/monitors/director-1-1-A_stats/sinks/file:
Name Value
------- -------------------------------
enabled true
format csv
sink-to /var/log/VPlex/cli/director_1_1_A.csv
type file

See also ◆ monitor add-console-sink

◆ monitor collect
◆ monitor remove-sink
◆ report create-monitors

monitor collect
Force an immediate poll and collection of performance data without waiting for the
automatic poll interval.

Contexts All contexts.

In /monitoring context, command is collect.

Syntax monitor collect

[-m|--monitors] context path,context path...

monitor collect 339

VPLEX CLI Command Descriptions

Arguments Required arguments

[-m|--monitor] context path,context path - One or more performance monitor(s) to update
immediately.

Description Polls and collects performance data from user-defined monitors. Monitors must have at
least one enabled sink.

Example
VPlexcli:/> monitor collect
/monitoring/directors/director-2-1-B/monitors/director-2-1-B_TestMonitor

VPlexcli:/>
Source: director-2-1-B_TestMonitor
Time: 2010-07-01 10:05:55
director.be-ops (counts/s):
.
.
.
◆ monitor create
◆ report poll-monitors

monitor create
Creates a performance monitor.

Contexts All contexts.

In /monitoring context, command is create.

Syntax monitor create

[-p|--period] collection-period
[-n|--name] monitor-name
[-d|--director] context-path,context-path...
[-s|--stats] stat,stat,stat...
[-t|--targets] context-path,context-path...
[-f|--force]

Arguments Required arguments

[-n|--name] monitor-name - * Name of the monitor. The name is appended to the director
on which the monitor is configured.
[-s|--stats] stat,stat,stat - * One or more statistics to monitor, separated by commas.
Use the monitor stat-list command to display the available statistics.

Optional arguments
[-p|-- period] collection-period- Frequency at which this monitor collects statistics. Valid
arguments are an integer followed by:
ms - milliseconds (period is truncated to the nearest second)
s - seconds (Default)
min - minutes
h - hours
0 - Disables automatic polling.

The default period is 30 seconds.

340 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

[-d|--director] context path, context path... - * List of one or more comma-separated

directors for which to display statistics.
[-t|--targets] context path, context path... - List of one or more comma-separated targets for
which to display statistics. Applicable only to statistics that require a target.
[-f|--force] - Forces the creation of the monitor, even if existing monitors are delayed in their
polling.
* - argument is positional.

Description Performance monitoring collects and displays statistics to determine how a port or volume
is being used, how much I/O is being processed, CPU usage, and so on.
The VPLEX collects and displays performance statistics using two user-defined objects:
◆ monitors - Gather the specified statistics.
◆ monitor sinks - Direct the output to the desired destination. Monitor sinks include the
console, a file, or a combination of the two.
The monitor defines the automatic polling period, the statistics to be collected, and the
output of the format. The monitor sinks define the output destination.
Polling occurs when:
◆ The timer defined by the monitor’s period attribute has expired.
◆ The monitor has at least one sink with the enabled attribute set to true.
Polling is suspended when:
◆ The monitor’s period is set to 0, and/or
◆ All the monitor’s sinks are either removed or their enabled attribute is set to false
Create short-term monitors to diagnose an immediate problem.
Create longer-term monitors for ongoing system management.

About file rotation and timestamps

Starting in Release 5.1, the log files created by a monitor’s file sink are automatically
rotated when they reach a size of 10 MB. The 10MB file is saved as filename.csv.n where n
is a number 1 - 10, and output is saved in a new file named filename.csv.n+1.
The .csv files are rotated up to 10 times.
In the following example, a monitor has exceeded 10MB of output. The initial 10MB are
stored in filename.csv.1. Subsequent output is stored in filename.csv.
service@sms-cluster-1:/var/log/VPlex/cli> ll my-data.csv*
-rw-r--r-- 1 service users 2910722 2012-03-06 21:23 my-data.csv
-rw-r--r-- 1 service users 10566670 2012-03-06 21:10 my-data.csv.1

If the second file exceeds, 10B, it is saved as filename.csv.2, and subsequent output is
saved in filename.csv. Up to 10 such rotations, and numbered .csv files are supported.
When the file sink is removed or the monitor is destroyed, output to the .csv file stops, and
the current .csv file is time stamped. For example:

monitor create 341

VPLEX CLI Command Descriptions

service@sms-cluster-1:/var/log/VPlex/cli> ll my-data.csv*
-rw-r--r-- 1 service users 10566670 2012-03-06 21:23 my-data.csv.1
-rw-r--r-- 1 service users 5637498 2012-03-06 21:26
my-data.csv_20120306092614973

Procedure overview To create and operate a monitor, use the following general steps:
1. Determine the type of statistic to collect from the target object.
Use the monitor stat-list category and/or the monitor stat-list * command to display
the statistics to include in the monitor.
Note whether the statistic you want to collect requires an argument (port number,
volume ID).
2. Determine how often the monitor should collect statistics.
3. Use the monitor create command to create a monitor.
4. Use the monitor add-sink commands to add one or more sinks to the monitor.
Add a console sink to send performance data to the Unisphere for VPLEX.
Add a file sink to send performance data to a specified file.
5. The monitor begins operation (polling and collecting performance data) when the sink
is added to the monitor.
To disable automatic polling without deleting the monitor or it’s sinks, do one of the
following:
• Use the set command to change the monitor’s period attribute to 0.
• Use the set command to change the sink’s enabled attribute to false.
6. Use the monitor collect command to update/collect statistics immediately without
waiting for the monitor’s automatic collection.
7. Monitor output.
Console sinks display monitor output on the console.
For file sinks, navigate to /var/log/VPlex/cli/ on the management server and use the
tail -f filename to display the output,
or:
Send output to a csv file, open the file in Microsoft Excel and create a chart.

Example Create a simple monitor with the default period, and no targets:
VPlexcli:/monitoring> monitor create --name TestMonitor --director Director-2-1-B --stats
director.fe-read,director.fe-write
Successfully created 1 monitor(s) out of 1.

To create a monitor to collect statistics from the director category on

/engines/engine1/directors/Director-2-1-B every 10 seconds:
VPlexcli:/monitoring> monitor create --name DirStats --period 10s --director
/engines/engine1/directors/Director-2-1-B --stats director.*

Create a monitor to collect statistics on all storage volumes at cluster-1:

VPlexcli:/monitoring> monitor create --name SVStats-Cluster1 --director
/engines/engine1/directors/Director-2-1-B --stats storage-volume.* --targets

342 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

/clusters/cluster-1/storage-elements/storage-volumes/*

Create a performance monitor to collect statistics on front-end port FE-ETH06:

VPlexcli:/monitoring> monitor create --name FE-ETH06-stats --director
/engines/engine-1-1/directors/director-1-1-A --stats fe-prt.* --targets
engines/engine-1-1/directors/director-1-1-A/hardware/ports/ETH06

See also ◆ monitor add-console-sink

◆ monitor-add-file-sink
◆ monitor destroy
◆ monitor stat-list
◆ report create-monitors

monitor destroy
Destroys a performance monitor.

Contexts All contexts.

In /monitoring context, command is destroy.

Syntax monitor destroy

[-m|--monitor] monitor-name,monitor-name...
[-c|--context-only]
[-f|--force]

Arguments Required arguments

[-m|--monitor] monitor-name - * List of one or more names of the monitor(s) to destroy.

Optional arguments
[-f|-- force] - Destroy monitors with enabled sinks and bypass confirmation.
[-c|--context-only] - Removes monitor contexts from the Unisphere for VPLEX and the CLI,
but does not delete monitors from the firmware. Use this argument to remove contexts
that were created on directors to which the element manager is no longer connected.

Description Deletes the specified performance monitor.

Example
VPlexcli:/> monitor destroy Cluster_2_Dir_2B_diskReportMonitor,
Cluster_2_Dir_2B_portReportMonitor,Cluster_2_Dir_2B_volumeReportMonitor
WARNING: The following items will be destroyed:

Context
------------------------------------------------------------------------------------
/monitoring/directors/Cluster_2_Dir_2B/monitors/Cluster_2_Dir_2B_diskReportMonitor
/monitoring/directors/Cluster_2_Dir_2B/monitors/Cluster_2_Dir_2B_portReportMonitor
/monitoring/directors/Cluster_2_Dir_2B/monitors/Cluster_2_Dir_2B_volumeReportMonitor

Do you wish to proceed? (Yes/No) y

Monitor 'Cluster_2_Dir_2B_volumeReportMonitor' is owned by another management console and/or

has enabled sinks. Do you wish to proceed ? (Yes/No) y

Monitor 'Cluster_2_Dir_2B_portReportMonitor' is owned by another management console and/or has

enabled sinks. Do you wish to proceed ? (Yes/No) y

monitor destroy 343

VPLEX CLI Command Descriptions

Monitor 'Cluster_2_Dir_2B_diskReportMonitor' is owned by another management console and/or has

enabled sinks. Do you wish to proceed ? (Yes/No) y

See also ◆ monitor create

◆ report create-monitors

monitor remove-sink
Removes a sink from a performance monitor.

Contexts All contexts.

In /monitoring context, command is remove-sink.

Syntax monitor remove-sink

[-s|--sinks] context path,context path...

Arguments Required arguments

[-s|--sinks] context path,context path... - * List of one or more sinks to remove. Entries
must be separated by commas.
* - argument is positional.

Description Removes one or more performance monitor sinks.

Example Remove a console sink:

VPlexcli:/monitoring/directors/director-2-1-B/monitors/director-2-1-B _TestMonitor> monitor
remove-sink console

◆ monitor add-console-sink
◆ monitor add-file-sink

monitor stat-list
Displays statistics available for performance monitoring.

Contexts All contexts.

In /monitoring context, command is stat-list.

Syntax monitor stat-list

[-c|--categories] category,category...

Arguments Optional arguments

[-c|--categories] category, category... - List of one or more statistics categories to display.

Description Performance statistics are grouped into categories Use the monitor stat-list command
followed by the <Tab> key to display the statistics categories.

Use the --categories categories argument to display the statistics available in the specified
category.
Use the * wildcard to display all statistics for all categories.

344 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Note: A complete list of the command output is available in the EMC VPLEX Administration
Guide.

VPlexcli:/> monitor stat-list --categories

cache ip-com-port rp-spl-node fc-com-port

wrt-pacing rp-spl-vol fe-director director
fe-lu be-prt ramf virtual-volume
com-cluster-io directory fe-prt cg
storage-volume

OR

Use TAB key after the command

VPlexcli:/> monitor stat-list

cache ip-com-port rp-spl-node fc-com-port

wrt-pacing rp-spl-vol fe-director director
fe-lu be-prt ramf virtual-volume
com-cluster-io directory fe-prt cg
storage-volume

See also ◆ monitor create

◆ EMC VPLEX Administration Guide

ndu pre-check
Performs a pre-NDU validation and check.

Contexts All contexts.

Syntax ndu pre-check

Description The ndu pre-check command should be run before you run a non-disruptive upgrade on a
system to upgrade GeoSynchrony. This command runs through a number of checks to see
if the non-disruptive upgrade would run into any errors in upgrading GeoSynchrony.
The checks performed by ndu pre-check are listed in the Upgrade procedure for each
software release. This procedure can be found in the VPLEX procedures in the SolVe
Desktop.



NDU pre-checks must be run within 24 hours before starting the NDU process.



NDU is not supported in a VPLEX Geo configuration if remote volumes are exported. NDU
does not proceed to the next release until the remote volumes are converted to local
volumes or distributed asynchronous volumes.

Disclaimers for multipathing in ndu pre-check give time for user to validate hosts.

ndu pre-check 345

VPLEX CLI Command Descriptions

For more detailed information about NDU pre-checks, see the upgrade procedures for
VPLEX in the SolVe Desktop.

See also ◆ ndu start

◆ ndu recover
◆ ndu status

ndu pre-config-upgrade
Disruptively upgrades a VPLEX Geo that has not been fully installed and configured.

Contexts All contexts.

Syntax ndu pre-config-upgrade

[-u|--firmware] firmware tar file
[-i|--image] firmware image file

Arguments Optional arguments

[-u|--firmware] firmware tar file - Full path to director firmware package on the management
server.
[-i|--image] firmware image file - Full path to director firmware image on the management
server.

Description Disruptively upgrades a VPLEX Geo when the VPLEX is not fully installed and configured.



This command requires the VPLEX be in a pre-config state. Specifically, do not use this
procedure unless NO meta-volume is configured (or discoverable).

This command is used as part of a non-disruptive upgrade procedure for installed systems
that have not yet been configured. For more information, see the upgrade procedures for
VPLEX in the SolVe Desktop.

See also ◆ ndu start

◆ ndu recover
◆ ndu status

ndu recover
Perform NDU recovery after a failed NDU attempt.

Contexts All contexts.

Syntax ndu recover

Description If the NDU failed before I/O is transferred from the second upgraders (running old
software) to the first upgraders (running new software), then the first upgraders are rolled
back to the old software.
If the NDU failed after I/O transfer, the directors are rolled forward to the new software.

346 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

If no recovery is needed, a message is displayed.

It is safe to run the ndu recover command multiple times.
See the upgrade procedure or the troubleshooting procedure for VPLEX in the SolVe
Desktop for details of the ndu recover command and its use.

See also ◆ ndu pre-check

◆ ndu start
◆ ndu status

ndu rolling-upgrade ssd-fw

Starts a rolling upgrade of SSD firmware on the directors.

Contexts All contexts.

Syntax ndu rolling-upgrade ssd-fw

[-i|--image] path to firmware image file
[-t|--targets] targets,targets,...
[--force]
[--check-only]
[--dry-run}
[--skip-be-switch-check]
[--skip-cluster-status-check]
[--skip-confirmations]
[--skip-distributed-device-settings-check]
[--skip-fe-switch-check]
[--skip-group-be-checks]
[--skip-group-config-checks]
[--skip-group-fe-checks]
[--skip-group-health-checks]
[--skip-meta-volume-backup-check]
[--skip-meta-volume-redundancy-check]
[--skip-remote-mgmt-version-check]
[--skip-storage-volumes-check]
[--skip-sysconfig-check]
[--skip-view-config-check]
[--skip-view-health-check]
[--skip-virtual-volumes-check]
[--skip-wan-com-check]

Arguments Required arguments

[-i|--image] firmware image file - * Full path to director firmware image on the management
server. For example:
/tmp/VPlexInstallPackages/VPlex-5.0.1.00.00.06-director-field-disk-ima
ge.tar
Optional arguments
[-t|--targets] targets,targets,... - List of directors to upgrade.
--force - Must be specified to ignore SSD firmware version checking. (To upgrade to the
same or older firmware)
--check-only - Check which directors will have their SSD firmware upgraded, not upgrade
the firmware.

ndu rolling-upgrade ssd-fw 347

VPLEX CLI Command Descriptions

--dry-run - Do not perform the ssd firmware upgrade but run the same procedure as an
actual install (including netbooting the directors).
--skip-be-switch-check - Skips the NDU pre-check for unhealthy back-end switches.
--skip-cluster-status-check - Skip the NDU pre-check for cluster problems (missing
directors, suspended exports, inter-cluster link failure).
--skip-confirmations - Skip any user confirmations normally required before proceeding
when there are NDU pre-check warnings.
--skip-distributed-device-settings-check - Skips the NDU pre-check for distributed device
settings (auto-resume set to true).
--skip-fe-switch-check - Skips the NDU pre-check for unhealthy front-end switches.
--skip-group-be-checks - Skip all NDU pre-checks related to back-end validation. This
includes the system configuration validation and unreachable storage volumes
pre-checks.
--skip-group-config-checks - Skip all NDU pre-checks related to system configuration. This
includes the system configuration validation and director commission pre-checks.
--skip-group-fe-checks - Skip all NDU pre-checks related to front-end validation. This
includes the unhealthy storage views and storage view configuration pre-checks.
--skip-group-health-checks - Skip all NDU pre-checks related to system health validation.
This includes the system configuration validation, unhealthy virtual volumes, cluster
status, and the inter-cluster communications connectivity pre-checks.
--skip-meta-volume-backup-check- Skips the check to verify that backups for the
meta-data volumes at all clusters have been configured.
--skip-meta-volume-redundancy-check - Skips the NDU pre-check for verifying the
meta-volume redundancy
--skip-remote-mgmt-version-check - Skip the remote management server version check.
--skip-storage-volumes-check - Skip the NDU pre-check for unreachable storage volumes.
--skip-sysconfig-check - Skip the system configuration validation NDU pre-check and
proceeds with NDU even if there are errors with cache replication, logging volume setup,
back-end connectivity, and metadata volume health.
--skip-view-config-check - Skip the NDU pre-check for storage view configuration (front-end
high availability). This option is required to pass the NDU pre-checks when operating a
minimum configuration. For minimum configurations, front-end high-availability
pre-checks must be performed manually.
--skip-view-health-check - Skip the NDU pre-check for unhealthy storage views.
--skip-virtual-volumes-check - Skip the NDU pre-check for unhealthy virtual volumes.
--skip-wan-com-check - Skip the inter-cluster communications connectivity NDU pre-check
and proceeds with NDU even if there are errors specifically related to inter-cluster
communications connectivity.

348 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions



Skipping the WAN communications pre-check may increase the risk for NDU failure
should the inter-cluster communication connection fail.

Note: Multiple skip options can be specified to skip multiple pre-checks. Enter skip
options separated by a space.

Description Upgrades the directors one at a time. Assures that there are directors available to service
I/O as some of the directors are being upgraded. The upgraded director rejoins the system
before the next director is upgraded.
The director SSD firmware upgrade is performed by netbooting the director to ensure that
the SSD is not in use while the firmware is being upgraded.
Non-disruptively upgrades the SSD firmware on the directors in a running VPLEX system.
Refer to the upgrade procedure for VPLEX in the SolVe Desktop for more information on
using this command.

Example: Check whether the directors need the SSD firmware upgrade (--check-only option):
VPlexcli:/> ndu rolling-upgrade ssd-fw --image
/tmp/VPlexInstallPackages/VPlex-5.0.1.00.00.06-director-field-disk-image.tar --check-only

================================================================================
[Tue Feb 22 13:32:57 2011] Checking Director SSD Firmware
================================================================================
[UPGRADE REQUIRED: director-1-1-B] SSD Model:M8SB2-30UC-EMC 118032709, FwRev: C04-6693, To:
C04-6997
[UPGRADE REQUIRED: director-1-1-A] SSD Model:M8SB2-30UC-EMC 118032709, FwRev: C04-6693, To:
C04-6997
[UPGRADE REQUIRED: director-2-1-A] SSD Model:M8SB2-30UC-EMC 118032709, FwRev: C04-6693, To:
C04-6997
[UPGRADE REQUIRED: director-2-1-B] SSD Model:M8SB2-30UC-EMC 118032709, FwRev: C04-6693, To:
C04-6997
================================================================================
The output for 'ndu ssd-fw' has been captured in
/var/log/VPlex/cli/capture/ndu-ssd-fw-session.txt

Example Use the following syntax to target specific directors for the SSD firmware upgrade using
the --targets option:
VPlexcli:/> ndu rolling-upgrade ssd-fw --image /tmp/VPlexInstallPackages/
VPlex-5.0.1.00.00.06-director-field-disk-image.tar --targets director-*-2-A

Example Use the following syntax to upgrade all the directors if the SSD firmware in the given image
is newer:
VPlexcli:/> ndu rolling-upgrade ssd-fw --image
/tmp/VPlexInstallPackages/VPlex-5.0.1.00.00.06-director-field-disk-image.tar

Example Use the following syntax to do a dry-run of the rolling upgrade of SSD firmware but skip the
actual step of writing the new SSD firmware to the SSD device.

Note: Dry-run includes netbooting the directors.

ndu rolling-upgrade ssd-fw 349

VPLEX CLI Command Descriptions

VPlexcli:/> ndu rolling-upgrade ssd-fw --dry-run --image

/tmp/VPlexInstallPackages/VPlex-5.0.1.00.00.06-director-field-disk-image.tar

Example Upgrade the SSD firmware on a subset of directors.

--targets selects only the A directors (one in each cluster in a VPLEX Metro configuration)
--force proceeds even though the SSD firmware on the directors is already up-to-date
VPlexcli:/> ndu rolling-upgrade ssd-fw -i
/tmp/VPlexInstallPackages/VPlex-5.0.1.00.00.06-director-field-disk-image.tar
--targets director-*-2-A --force

================================================================================
[Mon Jan 24 16:15:56 2011] Checking Director SSD Firmware
================================================================================
[UPGRADE REQUIRED: director-2-2-A] SSD Model:M8SB1-56UC-EMC 118032769, FwRev: C08-6997, To:
C08-6997
[UPGRADE REQUIRED: director-1-2-A] SSD Model:M8SB1-56UC-EMC 118032769, FwRev: C08-6997, To:
C08-6997
================================================================================
Performing NDU pre-checks
================================================================================
Verify director communication status.. OK
================================================================================
.
.
.
================================================================================
[Mon Jan 24 16:17:59 2011] SSD firmware upgrade /engines/engine-1-2/directors/director-1-2-A
================================================================================
Waiting for system to be stable before upgrading the SSD firmware on
/engines/engine-1-2/directors/director-1-2-A : .DONE
[PXE] Whitelisting director-1-2-a
Rebooting director-1-2-A: .DONE
Waiting for netboot. This will take several minutes.
upgrading the ssd firmware on /engines/engine-1-2/directors/director-1-2-A
SSD Desired FwRev: C08-6997
SSD Model: M8SB1-56UC-EMC 118032769, Current SSD FwRev: C08-6997
Skipping SSD Firmware Upgrade. [already at C08-6997]
.
.
.
================================================================================
[Mon Jan 24 16:39:53 2011] Successfully upgraded the SSD firmware on
/engines/engine-2-2/directors/director-2-2-A
================================================================================

================================================================================
[Mon Jan 24 16:39:53 2011] Teardown PXE Server
================================================================================
Waiting for system to be stable after upgrading the SSD firmware on directors: ...DONE
Cleaning up management server at cluster-2: .DONE

================================================================================
[Mon Jan 24 16:40:35 2011] Director SSD Firmware upgrade summary
================================================================================
director-1-2-A: SSD Model: M8SB1-56UC-EMC 118032769, Current FwRev: C08-6997, Image FwRev:
C08-6997
director-2-2-A: SSD Model: M8SB1-56UC-EMC 118032769, Current FwRev: C08-6997, Image FwRev:
C08-6997
================================================================================
The output for 'ndu ssd-fw' has been captured in
/tmp/derk/clidir/capture/ndu-ssd-fw-session.txt

350 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

VPlexcli:/>

See also ◆ ndu start

◆ The VPLEX procedures in the SolVe Desktop to upgrade/troubleshoot GeoSynchrony.

ndu start
Begins the non-disruptive upgrade (NDU) process of the director firmware.

Contexts All contexts.

Syntax ndu start

{-u|--firmware} firmware tar file
[--cws-package] cws firmware tar file
[--force]
[--force-geo]
[--skip-cws-upgrade]
[--skip-be-switch-check]
[--skip-cluster-status-check]
[--skip-confirmations]
[--skip-distributed-device-settings-check]
[--skip-fe-switch-check]
[--skip-group-be-checks]
[--skip-group-config-checks]
[--skip-group-fe-checks]
[--skip-group-health-checks]
[--skip-meta-volume-backup-check]
[--skip-meta-volume-redundancy-check]
[--skip-storage-volumes-check]
[--skip-sysconfig-check]
[--skip-view-config-check]
[--skip-view-health-check]
[--skip-virtual-volumes-check]
[--skip-wan-com-check]
[--skip-local-com-check]
[--skip-total-number-of-volumes-check]
[--skip-inter-director-mgmt-connectivity-check]
[--do-not-verify-wanlink-after-upgrade]
[--skip-async-cons-grp-drain-performance]
[--skip-storage-view-missing-lun0-check]

Arguments Required arguments

-u|--firmware firmware tar file - * Full path to director firmware package on the
management server.

Optional arguments
--cws-package cws firmware tar file - Full path to Cluster Witness Server package on the
management server.

Note: Not required if upgrading to an official product release.

--force - Ignore manifest checking of supported upgrades.

--force-geo - Force a VPLEX Geo NDU.

ndu start 351

VPLEX CLI Command Descriptions



In order to start an NDU, the VPLEX must be fully installed and a meta-volume must be
present. It is mandatory to run the ndu pre-check command before running this
command. For the director firmware upgrade to be non-disruptive to host I/O, the NDU
pre-check must pass without any errors. The system must be healthy and in a highly
available configuration.



--force-geo results in temporary data unavailability at the losing cluster for asynchronous
consistency groups.



Skipping the WAN communications pre-check may increase the risk for NDU failure due to
WAN-COM issues that could have been noted in the ndu pre-check.

--skip-cws-upgrade - Skips the upgrade of the Cluster Witness Server and proceeds with
the rest of the NDU.
--skip-be-switch-check - Skips the NDU pre-check for unhealthy back-end switches.
--skip-cluster-status-check - Skip the NDU pre-check for cluster problems (missing
directors, suspended exports, inter-cluster link failure, and so on).
--skip-confirmations - Skip any user confirmations normally required before proceeding
when there are NDU pre-check warnings.
--skip-distributed-device-settings-check - Skips the NDU pre-check for distributed device
settings (auto-resume set to true).
--skip-fe-switch-check - Skips the NDU pre-check for unhealthy front-end switches.
--skip-group-be-checks - Skip all NDU pre-checks related to back-end validation. This
includes pre-checks for system configuration validation and unreachable storage
volumes.
--skip-group-config-checks - Skip all NDU pre-checks related to system configuration. This
includes the system configuration validation and director commission pre-checks.
--skip-group-fe-checks - Skip all NDU pre-checks related to front-end validation. This
includes the unhealthy storage views and storage view configuration pre-checks.
--skip-group-health-checks - Skip all NDU pre-checks related to system health validation.
This includes the system configuration validation, unhealthy virtual volumes, cluster
status, and the inter-cluster communications connectivity pre-checks.
--skip-meta-volume-backup-check- Skips the check to verify that backups for the
meta-data volumes at all clusters have been configured.
--skip-meta-volume-redundancy-check - Skips the NDU pre-check for verifying the
meta-volume redundancy.
--skip-storage-volumes-check - Skip the NDU pre-check for unreachable storage volumes.

352 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

--skip-sysconfig-check - Skip the system configuration validation NDU pre-check and

proceed with NDU even if there are errors with cache replication, logging volume setup,
back-end connectivity, and metadata volume health.
--skip-view-config-check - Skip the NDU pre-check for storage view configuration (front-end
high availability). This option is required to pass the NDU pre-checks when operating a
minimum configuration. For minimum configurations, front-end high-availability
pre-checks must be performed manually.
--skip-view-health-check - Skip the NDU pre-check for unhealthy storage views.
--skip-virtual-volumes-check - Skip the NDU pre-check for unhealthy virtual volumes.
--skip-wan-com-check - Skip the inter-cluster communications connectivity NDU pre-check
and proceeds with NDU even if there are errors specifically related to inter-cluster
communications connectivity.
--skip-local-com-check - Skip the intra-cluster communications connectivity NDU
pre-check and proceeds with NDU even if there are errors specifically related to
intra-cluster communications.
--skip-total-number-of-volumes-check - Skip the NDU pre-check for total number of
volumes.
--skip-inter-director-mgmt-connectivity-check - Skip the NDU pre-check for inter-director
management connectivity.
--do-not-verify-wanlink-after-upgrade - NDU does not check whether first-upgraders see
each other on the WAN link after the upgrade.
--skip-async-cons-grp-drain-performance - Skip the NDU pre-check drain performance of
asynchronous consistency groups.
--skip-storage-view-missing-lun0-check - Skips the NDU pre-check for storage-views with
virtual-volumes that do not have a LUN0 ID.

Description This command starts a non-disruptive upgrade and can skip certain checks to push a
non-disruptive upgrade when the ndu pre-checks command fails. The pre-checks
executed by the ndu pre-check command verify that the upgrade from the current software
to the new software is supported, the configuration supports NDU, and the system state is
ready (clusters and volumes are healthy).
You must resolve all issues disclosed by the ndu pre-check command before running the
ndu start command.
Skip options enable ndu start to skip one or more NDU pre-checks. Skip options should be
used only after fully understanding the problem reported by the pre-check to minimize the
risk of data unavailability.

Note: Skip options may be combined to skip more than one pre-check. Multiple skip
options must be separated by a space.

ndu start 353

VPLEX CLI Command Descriptions

IMPORTANT
It is recommended that you upgrade VPLEX using the upgrade procedure found in the
SolVe Desktop. This procedure also details when the ndu start command should be used
with skip options and how to select and use those skip options.

See also ◆ ndu pre-check

◆ ndu recover
◆ ndu status
◆ The VPLEX procedures in the SolVe Desktop to upgrade/troubleshoot GeoSynchrony.

ndu status
Displays the NDU status.

Contexts All contexts.

Syntax ndu status [--verbose]

Description If an NDU firmware or OS upgrade is running, this command displays the upgrade activity.
If neither NDU firmware or OS upgrade is running, this command displays information
about the previous NDU firmware upgrade.
If the last operation was a rolling-upgrade, the OS upgrade information is displayed. The
ndu start command clears this information.
If an NDU firmware or OS upgrade has failed, this command displays a message to use the
ndu recover command.
if an NDU recovery is in progress, has succeeded or failed, this command displays a a
status message.

Example Display a successful NDU after completion:

VPlexcli:/> ndu status
Gathering NDU status...

No firmware or OS upgrade in progress.

Last Firmware Upgrade attempt on Fri, 17 Dec 2010 01:07:51
From version 2.1.17.0.0 to version 2.1.19.0.0
Was started on management server 10.6.209.61
Result: succeeded

================================================================================
[Fri Dec 17 18:05:21 2010] System state summary
================================================================================
The directors {director-1-1-B, director-1-1-A, director-1-2-B, director-1-2-A} are
operational at version 2.1.19.0.0.
================================================================================
The output for 'ndu status' has been captured in
/var/log/VPlex/cli/capture/ndu-status-session.txt

Display NDU status after an NDU failed and ndu recover was run:
VPlexcli:/> ndu status
Gathering NDU status...

354 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

No firmware or OS upgrade in progress.

Last Firmware Upgrade attempt on Fri, 17 Dec 2010 00:39:29
From version 2.1.19.0.0 to version None
Was started on management server 10.6.209.61
Result: failed
Reason: Encountered a problem while preparing to start the NDU.
Unable to extract director package files, return code 2.

NDU recover succeeded on management server 127.0.0.1 on Fri, 17 Dec 2010 01:00:27.

================================================================================
[Fri Dec 17 01:05:25 2010] System state summary
================================================================================
The directors {director-1-1-B, director-1-1-A, director-1-2-B, director-1-2-A} are
operational at version 2.1.19.0.0.
================================================================================
The output for 'ndu status' has been captured in
/var/log/VPlex/cli/capture/ndu-status-session.txt

See also ◆ ndu pre-check

◆ ndu start
◆ ndu recover
◆ The VPLEX procedures in the SolVe Desktop to upgrade/troubleshoot GeoSynchrony.

notifications call-home import-event-modifications

Imports and applies modified call-home events.

Contexts All contexts.

In /notifications context, command is call-home import-event-modifications.
In /notifications/call-home context, command is import-event-modifications.

Syntax notifications call-home import-event-modifications

[-m|--modified-events-file] filename
[-f|--force]

Arguments Required arguments

[-m|--modified-events-file] file - Path to the file containing the modified call-home events.

Optional arguments
[-f|--force] - Forces the import of the specified file without asking for confirmation. Allows
this command to be run from non-interactive scripts.

Description Imports and applies modifications to call-home events. This command imports the
specified .xml file that contains modified call-home events. There can be two types of .xml
event files:
◆ EMC-generic events are modifications recommended by EMC.
EMC provides an .xml file containing commonly requested modifications to the default
call-home events.
◆ Customer-specific events are events modified to meet a specific customer
requirement.

notifications call-home import-event-modifications 355

VPLEX CLI Command Descriptions

EMC provides a custom events file developed by EMC engineering and applied by EMC
Technical Support.
Call-home behavior changes immediately when the modified events file is applied.
If a customized events file is already applied, applying a new file overrides the existing
file.
If the same event is modified in both the customer-specific and EMC-generic files, the
modification specified in the customer-specific file is applied for that event, and the note
“Not applied” appears in the command output.
If call-home notification is disabled when the custom events file is applied, the modified
events are saved and applied when call-home notification is enabled.
Use the set command to enable/disable call-home notifications.
Use the ls notifications/call-home command to display whether call-home notification is
enabled:
VPlexcli:/> ls /notifications/call-home

/notifications/call-home:

Attributes:
Name Value
------- -----
enabled true

Example In the following example, the custom events file 'custom.xml” is imported from a directory
on the management server and applied when call-home notification is disabled:
VPlexcli:/notifications/call-home> import-event-modifications -m /home/service/demo/custom.xml

Importing the 'custom_events.xml' file will override the existing call-home events, for all the
event categories specified in the 'custom_events.xml' file.
Do you want to proceed? (Yes/No) yes

The events provided in '/home/service/Test/custom_events.xml' is saved. These events will be

applied when call-home is enabled.

VPlexcli:/notifications/call-home>

Example In the following example, a custom events file is imported when call-home notification is
enabled:
VPlexcli:/notifications/call-home> import-event-modifications --file
/home/service/Test/customCallHome.xml

Importing the 'custom_events.xml' file will override the existing call-home events, for all the
event categories specified in the 'custom_events.xml' file.
Do you want to proceed? (Yes/No) yes

See also ◆ notifications call-home remove-event-modifications

◆ notifications call-home view-event-modifications
◆ notifications call-home test

356 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

notifications call-home remove-event-modifications

Removes customized call-home events files, including customer-specific modifications
and modifications recommended by EMC.

Contexts All contexts.

In /notifications context, command is call-home remove-event-modifications.
In /notifications/call-home context, command is remove-modifications.

Syntax notifications call-home remove-event-modificatons

[-c|--customer-specific]
[-e|--emc-generic]
[-f|--force]

Arguments Optional arguments

[-c|--customer-specific] - If a customer-specific call-home events file has been imported,
removes the file.
[-e |--emc-generic] - If an EMC call-home events file has been imported, removes the file.
[-f|--force] - Removes the specified imported call-home events file without asking for
confirmation. Allows this command to be executed from a non-interactive script.

Description This command removes the specified custom call-home events file. There are two types of
.xml event files:
◆ EMC-generic events are modifications recommended by EMC.
EMC provides an .xml file containing commonly requested modifications to the default
call-home events.
◆ Customer-specific events are events modified to meet a specific customer
requirement.
EMC provides a custom events file developed by EMC engineering and applied by EMC
Technical Support.
If no file is specified, this command removes both custom call-home events files.
The specified file is not deleted from the management server. When a custom events file is
removed, the default events file LIC.xml is applied.
Use the ndu upgrade-mgmt-server command to re-import the file.

Example In the following example, the specified customer-specific call-home events file is
removed:
VPlexcli:/notifications/call-home> remove-event-modifications
--customer-specific

The Customer-Specific call-home event modifications will be removed.

Do you want to proceed? (Yes/No) y

Example In the following example, The EMC-generic call-home events file is removed:
VPlexcli:/notifications/call-home> remove-event-modifications
--emc-generic

The EMC-generic call-home event modifications will be removed.

notifications call-home remove-event-modifications 357

VPLEX CLI Command Descriptions

Do you want to proceed? (Yes/No) yes

Example In the following example, both call-home events files are removed:
VPlexcli:/notifications/call-home> remove-event-modifications

The customer-specific and EMC-generic call-home event modifications

will be removed.
Do you want to proceed? (Yes/No) yes

See also ◆ notifications call-home import-event-modifications

◆ notifications call-home view-event-modifications
◆ notifications call-home test

notifications call-home view-event-modifications

Displays any customized call-home events.

Contexts All contexts.

In /notifications context, command is call-home-view-event-modifications
In /notifications/call-home context, command is view-event-modifications.

Syntax notifications call-home view-event-modifications

[-c|--customer-specific]
[-e|--emc-generic]

Arguments Optional arguments

[-c|--customer-specific] - Displays customer specific modifications.
[-e|--emc-generic] - Displays EMC generic modifications.

Description If event modifications are applied to call-home events, this command displays those
events whose call-home events have been modified.
If the same event is modified by both the customer-specific and the EMC-generic events
files, the setting in the customer-specific file overrides the entry in the EMC-generic file.
Use this command with no arguments to display a summary of all event modifications.
Use this command with the -c or -e arguments to display a summary of only the
customer-specific or EMC generic modified events.
Use the --verbose argument to display detailed information.

Example Display a summary of event modifications:

VPlexcli:/notifications/call-home> view-event-modifications
EMC-generic events :
---------------------
event code name severity
---------- ------------- --------
0x8a023001 amf_1_WARNING INFO

Customer-specific events :
-------------------------
event code name severity

358 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

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

0x8a530006 CWS_EVENT_HEALTHY_CONNECTIVITY_INTERVAL_CHANGED WARNING
0x8a530005 CWS_EVENT_SILENCE_THRESHOLD_CHANGED INFO

Example In the following example, the same event is modified by both the customer-specific and
the EMC-generic events files. The setting in the customer-specific file overrides the setting
in the EMC-generic file:
VPlexcli:/notifications/call-home> view-event-modifications

EMC-generic events :
---------------------
event code name severity
---------- ------------ --------
0x8a2d6025 SCSI_IT_LOST WARNING
0x8a2c901c scom_28_CRIT ERROR

Customer-specific events :
-------------------------
event code name severity
---------- ------------ --------
0x8a2d6025 SCSI_IT_LOST WARNING
0x8a029060 amf_96_CRIT CRITICAL

Example Use the --verbose argument to display detailed information about customer-specific event
modifications:
VPlexcli:/notifications/call-home> view-event-modifications --customer-specific --verbose

Customer-specific events :
-------------------------

For Event Code 0x8a530006:

Modified Fields : [Severity, Resend Timeout, Default Event, Customer Description]

name: CWS_EVENT_HEALTHY_CONNECTIVITY_INTERVAL_CHANGED
severity: WARNING
component: cws
locale: CLUSTER
obsolete event: NO
resend timeout: 60
default event: TRUE
threshold count: 0
threshold interval: 0
customer description: CUSTOM Cluster Witness Server Healthy Connectivity Interval is changed.
format string: Cluster Witness Server Healthy Connectivity Interval is changed from
%u to %u seconds

For Event Code 0x8a530005:

.
.
.

See also ◆ notifications call-home import-event-modifications

◆ notifications call-home remove-event-modifications
◆ notifications call-home test

notifications call-home view-event-modifications 359

VPLEX CLI Command Descriptions

notifications call-home test

Sends a test event through call-home.

Contexts All contexts.

In /notifications context, command is call-home test.
In /notifications/call-home context, command is test.

Syntax notifications call-home test

Description Call-home can be configured to send events to EMC Support and/or one or more
recipients in your organization.
Use this command to send a test event to the configured recipients. VPLEX sends the test
call-home within 1 minute of running this command.
If call-home is configured to send event notifications to personnel in your organization,
check the e-mail accounts specified to receive notifications to verify the test event arrived.
If call-home is configured to send event notifications to EMC, contact EMC Support to
verify that the test event arrived.
Use the set command to enable/disable call-home notifications.
Use the ls notifications/call-home command to verify that call-home is enabled:
VPlexcli:/> ls /notifications/call-home

/notifications/call-home:

Attributes:
Name Value
------- -----
enabled true

Example Use the call-home test command to send a test call-home event to the configured
recipients:
VPlexcli:/notifications/call-home> call-home test
call-home test was successful.

See also ◆ configuration event-notices-reports config

◆ configuration event-notices-reports reset
◆ notifications call-home import-event-modifications
◆ notifications call-home remove-event-modifications
◆ notifications call-home view-event-modifications
◆ notifications snmp-trap create
◆ set

notifications job cancel

Cancels jobs in a Queued state from the job queue.

Contexts All contexts.

360 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

In /notifications/jobs context, command is cancel.

Syntax notifications job cancel

[-j|--jobs] job context path [, job context path...]
[-h|--help]
[--verbose]

Arguments Required arguments

[-j|--jobs] job context path [, job context path...] - * Specifies the jobs to cancel.

Optional arguments
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.
- * argument is positional.

Description This command cancels jobs that are queued in the job queue.
Only jobs that are in a Queued state can be cancelled. Once they are cancelled, the jobs
will remain in the job queue with a state of Cancelled.

See also ◆ notifications job delete

◆ notifications job resubmit

notifications job delete

Permanently removes jobs from the job queue.

Contexts All contexts.

In /notifications/jobs context, command is delete.

Syntax notifications job delete

[-s|--state] job state
[-j|--jobs] job context path [, job context path...]
[-f|--force]
[-h|--help]
[--verbose]

Arguments Required arguments

[-j|--jobs] job context path [, job context path...] - * Specifies the jobs to delete.

Optional arguments
[-s|--state] job state - Specifies a job state by which to filter the jobs. If specified, this
argument filters the jobs by their states. This option is most useful when all jobs are
specified in the command invocation.
[-f|--force] - Deletes the jobs without asking for confirmation.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution.
- * argument is positional.

notifications job delete 361

VPLEX CLI Command Descriptions

Description This command permanently removes jobs from the job queue. Jobs that are in progress
cannot be deleted.
A job that is in progress cannot be deleted. All other job states - cancelled, failed, and
successful - can be deleted.

Example Delete jobs that are in a failed state:

VPlexcli:/notifications/jobs> delete * --state failed
WARNING: The following items will be deleted:
Context
-------------------------------------------------
/notifications/jobs/Provision_4_08-04-14-17-34-51
/notifications/jobs/Provision_4_14-04-14-15-57-03
Do you wish to proceed? (Yes/No) y

Deleted 2 jobs.

Example Shows the attempt to delete two specific jobs failed (jobs were skipped):
VPlexcli:/notifications/jobs> delete Provision_4_14-04-14-15-57-03,
Provision_4_08-04-14-17-34-51
WARNING: The following items will be deleted:
Context
-------------------------------------------------
/notifications/jobs/Provision_4_08-04-14-17-34-51
/notifications/jobs/Provision_4_14-04-14-15-57-03
Do you wish to proceed? (Yes/No) y

Skipped 2 jobs.

Example Use the --verbose option to display more information for a job that is skipped. In this
example, one job was skipped, or not deleted, because it was in progress:
VPlexcli:/notifications/jobs> delete * --verbose
WARNING: The following items will be deleted:
Context
-------------------------------------------------
/notifications/jobs/Provision_4_08-04-14-17-34-51
/notifications/jobs/Provision_4_14-04-14-15-57-03
Do you wish to proceed? (Yes/No) y

WARNING: Operation Delete failed for target 'Provision_4_08-04-14-17-34-51'. Cannot delete job
'Provision_4_08-04-14-17-34-51' because its state is InProgress.

Deleted 1 job.
Skipped 1 job.

See also ◆ notifications job cancel

◆ notifications job resubmit

notifications job resubmit

Resubmits a failed or canceled job.

Contexts All contexts.

In /notifications/jobs context, command is resubmit.

362 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Syntax notifications job resubmit

[-j|--jobs] job context path [, job context path...]
[-h|--help]
[--verbose]

Arguments Required arguments

[-j|--jobs] job context path [, job context path...] - * Specifies the jobs to resubmit.

Optional arguments
[-h}--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.
- * argument is positional.

Description Resubmit failed or canceled jobs to the job queue. The jobs will be placed in a queued
state and executed in normal priority order.

See also ◆ notifications job cancel

◆ notifications job delete

notifications snmp-trap create

Creates an SNMP trap sink for call-home events.

Contexts All contexts.

In /notifications context, command is snmp-trap create.
In/notifications/call-home/snmp-traps context, command is create.

Syntax notifications snmp-trap create

[-n|--name] trap name

Arguments Required arguments

[-n|--name] trap name - Name of the SNMP trap sink.

Description The SNMP trap does not start automatically.

To start the SNMP trap, do the following:
◆ Use the set command to set the IP address of the remote-host.
◆ Use the set command to set the started attribute to true.

Example
VPlexcli:/notifications/call-home/snmp-traps> notifications snmp-trap create Test
VPlexcli:/notifications/call-home/snmp-traps> cd /Test

VPlexcli:/notifications/call-home/snmp-traps/Test> ll
Name Value
---------------- ------
community-string public
remote-host -
remote-port 162
started false

VPlexcli:/notifications/call-home/snmp-traps/Test> set remote-host 10.6.213.39

notifications snmp-trap create 363

VPLEX CLI Command Descriptions

VPlexcli:/notifications/call-home/snmp-traps/Test> set started true

See also ◆ notifications call-home test

◆ notifications snmp-trap destroy
◆ set

notifications snmp-trap destroy

Destroys one or more SNMP traps.

Contexts All contexts.

In /notifications context, command is snmp-trap destroy.
In /notifications/call-home/snmp-traps context, command is destroy.

Syntax notifications snmp-trap destroy

[-s|--snmp-trap] trap name
[-f|--force]

Arguments Optional arguments

[-s|--snmp-trap] trap name - Name of the SNMP trap sink to destroy.
[-f|--force] - Destroy an SNMP trap sink that has been started.

Description The --force argument is required to destroy an SNMP trap sink that has been started.

Example VPlexcli:/notifications/call-home/snmp-traps> notifications snmp-trap

destroy Test

See also ◆ notifications snmp-trap create

password-policy reset
Resets the password-policies to the default factory settings.

Contexts /security/authentication

Syntax password-policy reset

[-h|--help]
[-f|--force]
[--verbose]

Arguments Optional arguments

[-h |--help] - Displays the usage for this command.
[-f | --force] - Forces reset of password-policy configuration without asking for confirmation.
[--verbose] - Provides more output during command execution.

Description Resets the password-policies to the default factory settings.

Note: This command can only be run by the admin user. So it will ask for the admin
password.

364 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

After successful authentication, If you do not specify the --force option during command
execution, the command prompts with a confirmation message and, based on user input,
it will proceed.

IMPORTANT
Using this command will override all existing password-policy configurations and return
them to the default settings.

Example Resets the password-policy to the default state.

VPlexcli:/> security authentication password-policy reset
admin password:

The passpword-policy reset command will override ALL of the existing

password-policy configuration changes made to the system.

Do not run this command unless you are certain that it is required to
return password-policy to default-state.
Do you want to proceed? (Yes/No) yes

See also ◆ password-policy set

password-policy set
Each attribute in the Password policy is configurable. The new value will be updated to the
respective configuration file and existing users will be updated with these configuration.
Following sections walk through the process of setting each attribute.

Contexts /security/authentication/password-policy

Syntax set [password-minimum-length | minimum-password-age |

maximum-password-age | password-warn-days | Password inactive days ]
value

Arguments [password-minimum-length value] - Minimum number of characters for a password. This

policy is enforced during password changes and user creation. This value can be any value
between 6 and 99999. The default value is 8.
[password-minimum-days value] - Minimum number of days a password can be changed
since the last password change. The default value is 1. The value can be any value
between -1 and 99999.
[maximum-password-days value] - Maximum number of days since the last password
change a password can be used. The default for maximum-password-age is 90. The value
can be any value between 1 and 99999.
[password-warn-days value] - Number of days before the password expiry. At this time, a
warning message will be displayed indicating the impending password change. The
default value for password-warn-days is 15. Password warning days can be any value
between 1 and 99999 but the number of days should not be greater than
password-maximum-days.

password-policy set 365

VPLEX CLI Command Descriptions

[password-inactive-days value] - Number of inactive days after a password expired, before

the account is locked. During the inactive days you are forced to change this password first
before proceeding to access the Management Server. After the inactive days, the user
account will be locked. The default value for this variable is 1. The password-inactive-days
can be any value between -1 and 99999.

Description The password policies are not applicable to users configured through an LDAP server.
The password policies are not applicable to the service user.
Password inactive days is not applied to admin user to protect the admin user from
account lockouts.

Note: Password Policy can be configured only by the admin user

Example To view the existing password-policy settings, run the ll command in the
security/authentication/password-policy context:
VPlexcli:/security/authentication/password-policy> ll
Name Value
----------------------- -----
password-inactive-days 1
password-maximum-days 90
password-minimum-days 1
password-minimum-length 8
password-warn-days 15

Example To view the permissible values for the password-policy set command, enter the command
with no options:

VPlexcli:/security/authentication/password-policy> set
attribute input-description
----------------------- --------------------------------------
name Read-only.
password-inactive-days Takes an integer value between -1 and
99999. Specifying a '-1' value will disable the policy.
password-maximum-days Takes an integer value between 1 and
99999.
password-minimum-days Takes an integer value between -1 and
99999. Specifying a '-1' value will disable the policy.
password-minimum-length Takes an integer value between 6 and
99999.
password-warn-days Takes an integer value between -1 and
99999. Specifying a '-1' value will disable the policy.

Example To set the password inactive days value to 3 days, use this command:
VPlexcli:/security/authentication/password-policy> set
password-inactive-days 3
admin password:
VPlexcli:/security/authentication/password-policy> ll
Name Value
----------------------- -----
password-inactive-days 3
password-maximum-days 90

366 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

password-minimum-days 1
password-minimum-length 8
password-warn-days 15

See also ◆ password-policy reset

plugin addurl
Adds an URL to the plug-in search path.

Contexts All contexts.

Syntax plugin addurl

[-u|--urls] url,url...

Arguments Required arguments

[-u|--urls] url, url... - A list of URLs to add to the search path. Entries must be separated by
commas.

Description Note: The plugin commands are not intended for customer use.

Plug-ins extend the class path of the CLI. Plug-ins support dynamic addition of
functionality. The plugin search path is used by the plugin register command.

See also ◆ plugin listurl

◆ plugin register

plugin listurl
Lists URLs currently in the plugin search path.

Contexts All contexts.

Syntax plugin listurl

Description The search path URLs are those locations added to the plugin search path using the plugin
addurl command.

Note: The plugin commands are not intended for customer use.

Example VPlexcli:/> plugin listurl

plugin addurl 367

VPLEX CLI Command Descriptions

file:/opt/emc/VPlex/jython2.2/LibExt/AutoBundles/prodscripts.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/bin/commons-daemon.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/bin/bootstrap.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/bin/tomcat-juli.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/tomcat-i18n-es.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/tomcat-juli-adapters.ja
r, file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/catalina-tribes.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/servlet-api.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/tomcat-coyote.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/realm-adapter.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/catalina-ha.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/jasper-jdt.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/catalina.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/catalina-ant.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/jsp-api.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/annotations-api.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/jasper-el.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/jasper.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/tomcat-i18n-ja.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/el-api.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/tomcat-i18n-fr.jar,
file:/opt/emc/VPlex/apache-tomcat-6.0.x/lib/tomcat-dbcp.jar

See also ◆ plugin addurl

◆ plugin register

plugin register
Registers a shell plugin by class name.

Contexts All contexts.

Syntax plugin register

[-c|--classes] list of class names,list of class names ...

Arguments Required arguments

[-c|--classes] list of class names, list of class names... - A list of plugin classes. Entries
must be separated by commas.

Description Plugin class is found in the default classpath, or in locations added using the plugin
addurl command.
Plug-ins add a batch of commands to the CLI, generally implemented as a set of one or
more Jython modules.

Note: The plugin commands are not intended for customer use.

See also ◆ plugin addurl

◆ plugin listurl

popd
Pops the top context off the stack, and changes the current context to that context.

Contexts All contexts.

368 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Syntax popd

Description If the context stack is currently empty, an error message is displayed.

Example In the following example:

◆ The pushd command adds a third context to the context stack. The output of the
command displays the three contexts in the stack.
◆ The popd command removes the top (last added) context, changes the context to the
next one in the stack, and the output displays the two remaining contexts:
VPlexcli:/engines/engine-1-1/directors/diector-1-1-A> pushd
/engines/engine-1-1/directors/director-1-1-B
[/engines/engine-1-1/directors/director-1-1-B,
/engines/engine-1-1/directors/director-1-1-A,
/clusters/cluster-1/storage-elements/storage-arrays, /, /]

VPlexcli:/engines/engine-1-1/directors/director-1-1-B> popd
[/engines/engine-1-1/directors/director-1-1-B,
/clusters/cluster-1/storage-elements/storage-arrays, /, /]

VPlexcli:/engines/engine-1-1/directors/director-1-1-A>

See also ◆ pushd

pushd
Pushes the current context onto the context stack, and then changes the current context to
the given context.

Contexts All contexts.

Syntax pushd
[-c|--context] context

Arguments Optional arguments

[-c|--context] context - The context to push onto the context stack.

Description Adds the context to the context stack.

If no context is supplied, and there is a context on the stack, the current context is
exchanged with the top-of-stack context.
Use the popd command to remove the topmost context from the context stack.

Example Starting in the root context:

VPlexcli:/>
Use the pushd command to push the first context onto the context stack:
VPlexcli:/> pushd /clusters/cluster-1/storage-elements/storage-arrays/
[/clusters/cluster-1/storage-elements/storage-arrays, /, /]

Use the pushd command to push a second context onto the context stack:
VPlexcli:/clusters/cluster-1/storage-elements/storage-arrays> pushd
/engines/engine-1-1/directors/director-1-1-A/
[/engines/engine-1-1/directors/director-1-1-A,
/clusters/cluster-1/storage-elements/storage-arrays, /, /]

pushd 369
VPLEX CLI Command Descriptions

Now, there are two contexts on the context stack. Use the pushd command to toggle
between the two contexts:
VPlexcli:/engines/engine-1-1/directors/director-1-1-A> pushd
[/clusters/cluster-1/storage-elements/storage-arrays,
/engines/engine-1-1/directors/director-1-1-A, /, /]

VPlexcli:/clusters/cluster-1/storage-elements/storage-arrays> pushd
[/engines/engine-1-1/directors/director-1-1-A,
/clusters/cluster-1/storage-elements/storage-arrays, /, /]

VPlexcli:/engines/engine-1-1/directors/director-1-1-A>

See also ◆ popd

rebuild set-transfer-size
Changes the transfer-size of the given devices.

Contexts All contexts.

Syntax rebuild set-transfer-size

[-r|--devices] context path,context path...
[-l|--limit] limit

Arguments Required arguments

[-r|-devices] context path,context path... - * List of one or more devices for which to change
the transfer size. Wildcards are permitted. Entries must be separated by commas.
[-l|--limit] limit - * Transfer size in bytes. Maximum number of bytes to transfer as one
operation per device. Specifies the size of read sector designated for transfer in cache.
Setting this value smaller implies more host I/O outside the transfer boundaries. Setting
the value larger may result in faster transfers. Valid values must be multiples of 4K.
Range: 40K-128M.
See About transfer-size in the batch-migrate start command.
* - argument is positional.

Description If the target devices are rebuilding when this command is issued, the rebuild is paused
and resumed using the new transfer-size.

Note: If there are queued rebuilds, the rebuild may not resume immediately.

Example Set the transfer-size on a specified device to 1M:

VPlexcli:/> rebuild set-transfer-size --devices /clusters/cluster-1/devices/testdevice --limit
1M
Set the transfer-size for all devices to 2M:
VPlexcli:/> rebuild set-transfer-size /clusters/*/devices/* 2M

Set the transfer-size for all distributed devices to 10K:

VPlexcli:/distributed-storage/distributed-devices> rebuild set-transfer-size * 10k

See also ◆ rebuild show-transfer-size

370 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ rebuild status

rebuild show-transfer-size
Shows the transfer-size of specified RAID 1 devices.

Contexts All contexts.

Syntax rebuild show-transfer-size

[-r|--devices] context path
Optional arguments
[-r|-devices] context path... - List of one or more RAID 1 devices for which to display the
transfer size. Entries must be separated by commas. Wildcards are permitted.

Example Display the rebuild transfer size for a specified device:

VPlexcli:/> rebuild show-transfer-size TestDevice
device name transfer-size
------------- -------------
TestDevice 2M

Display rebuild transfer size for selected devices:

VPlexcli:/> rebuild show-transfer-size dd_0*
device name transfer-size
----------- -------------
dd_00 2M
dd_01 2M
dd_02 2M
.
.
.
Display rebuild transfer size for all distributed devices:
VPlexcli:/> rebuild show-transfer-size *
device name transfer-size
------------- -------------
TestDevice 2M
dd_00 2M
dd_01 2M
dd_02 2M
.
.
.

See also ◆ rebuild set-transfer-size

◆ rebuild status

rebuild status
Displays all global and cluster-local rebuilds along with their completion status.

Contexts All contexts.

Syntax rebuild status

--show-storage-volumes

rebuild show-transfer-size 371

VPLEX CLI Command Descriptions

Optional arguments
--show-storage-volumes - Displays all storage volumes that need to be rebuilt, both active
and queued. If not present, only the active rebuilds are displayed.

Description Completion status is listed as:

rebuilt/total (complete%)

Example Check rebuild status from storage volume context:

VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes> rebuild status
[1] disks marked for rebuild

Global rebuilds:
No active global rebuilds.

cluster-1 local rebuilds:

device rebuild type rebuilder director rebuilt/total percent finished throughput ETA
------------ ------------ ------------------ ------------- ---------------- ---------- ----
test3313_r1 full s10_428f 1.23G/4G 30.81% 90.1M/s

Check rebuild status from distributed-device-components/volume/components/ context,

and display storage volumes that need to be rebuilt:
VPlexcli:/distributed-storage/distributed-devices/testvol1/distributed-device-components/C2te
stvol0000/components> rebuild status --show-storage-volumes
StorageVolumes marked for rebuild:
cluster-2:
extent_60060160639028006413c641e2a7e011_1

[1] storage_volumes marked for rebuild

Global rebuilds:
device rebuild type rebuilder director rebuilt/total percent finished throughput ETA
-------- ------------ ------------------ ------------- ---------------- ---------- ---------
testvol1 full s1_220d_spa 4.06G/11.2G 36.17% 9.94M/s 12.3min

Local rebuilds:
No active local rebuilds.

See also ◆ rebuild show-transfer-size

report aggregate-monitors
Aggregate the reports generated by the report create-monitors or monitor commands.

Contexts All contexts.

Syntax report aggregate-monitors

[-d|--directory] directory
Optional arguments
[-d|-directory] directory- Directory in which to create the .csv files.
Default directory path: /var/log/VPlex/cli/reports/ on the management server.

Description The reports are aggregated by cluster.

An aggregate report is generated for:
◆ Each cluster
◆ Each type of per director report in the specified directory

372 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

This command assumes that the per director reports have filenames with the following
format:
<report type>ReportMonitor_<director>.csv
All other files in the directory will be ignored.
Aggregate report filenames are in the following format:
<report type>Performance_<cluster>.csv
If an aggregate report already exists, it will be overwritten.

Example VPlexcli:/> report aggregate-monitors

Aggregating port reports at cluster cluster-2 ...
Aggregating port reports at cluster cluster-1 ...
Aggregating volume reports at cluster cluster-2 ...
Aggregating volume reports at cluster cluster-1 ...
.
.
.
Output files saved in /var/log/VPlex/cli/reports/:
◆ diskPerformance_cluster-1.csv
◆ diskPerformance_cluster-2.csv
◆ portPerformance_cluster-1.csv
◆ portPerformance_cluster-2.csv
◆ volumePerformance_cluster-1.csv
◆ volumePerformance_cluster-2.csv

See also ◆ report capacity-arrays

◆ report capacity-clusters
◆ report capacity-hosts
◆ report create-monitors
◆ report poll-monitors

report capacity-arrays
Generates a capacity report.

Contexts All contexts.

Syntax report capacity-arrays

[-t|--tier-regx] regular expression
[-d|--directory] directory
Optional arguments
[-t|-tier-regex] regular expression - Regular expression which when applied to the
storage-volume name, returns the tier ID in a group. Most expressions must be enclosed in
quotes.
Default: value of /system-defaults::tier-regular-expression

report capacity-arrays 373

VPLEX CLI Command Descriptions

[-d|-directory] directory - Directory in which to create the csv files. Output is written to two
files:
◆ File for local storage: CapacityArraysLocal.csv
◆ File for shared storage: CapacityArraysShared.csv.
Default directory path: /var/log/VPlex/cli/reports/* on the management server.

Description Generates a capacity report for all the storage in a VPLEX, grouped by storage arrays.
This command assumes the following:
◆ All storage volumes in a storage array have the same tier value.
◆ The tier is indicated in the storage-volume name. The tier attribute in the virtual
volumes context is ignored.
If a file is specified, output is formatted as:
<time>,<cluster name>,<array name>,<tier string>,<alloc>,<unalloc devices>,<unalloc
storage-volumes> <time>,<alloc>,<unalloc devices>

If the files already exist, the report is appended to the end of the files.

Note: Tier IDs are required to determine the tier of a storage-volume/storage array. Storage
volumes that do not contain any of the specified IDs are given the tier value 'no-tier'.

The report is separated into two parts: local storage and shared storage.
◆ Local storage is accessible only from the same cluster where the storage is physically
located. Information in the report for local storage includes:
• Cluster id
• Storage array
• Tier - the tier of the storage array
• Allocated - storage that is visible through a view (exported)
• Unallocated-device - storage that is in devices, but not visible from a view. For
example, a virtual volume that has not been exported or free space in a device that
is not part of a virtual volume.
• Unallocated-storage-volume - storage in unused storage volumes.
◆ Shared storage is accessible from clusters other than where it is physically located
(distributed and remote virtual volumes). Information in the report for shared storage
includes:
• allocated - storage that is visible through a view (exported)
• unallocated-device - storage that is in devices, but not visible from a view. For
example, a virtual volume that has not been exported or free space in a device that
is not part of a virtual volume.

Note: Unreachable storage volumes are not included in 'unallocated-storage-volume'. If

the storage array of a virtual volume/device cannot be determined, its capacity is
allocated to the 'unknown array'.

374 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

There is no 'tier' indicator for shared storage because the tiers may be different for
each mirror of a distributed-device.
There are no shared storage volumes. Storage Volumes are only locally accessible and
are part of the cluster allocation.

Display the report file To display the raw report file, do the following:
1. Exit to the management server:
VPlexcli:/> exit
Connection closed by foreign host.
service@ManagementServer:~>

2. Navigate to the VPLEX CLI reports directory (or the specified output directory):
service@ManagementServer:~> cd /var/log/VPlex/cli/reports
service@ManagementServer:/var/log/VPlex/cli/reports> ll
total 48
-rw-r--r-- 1 service users 2253 2010-08-12 15:46
CapacityArraysLocal.csv
-rw-r--r-- 1 service users 169 2010-08-12 15:46
CapacityArraysShared.csv
.
.
.
3. Use the cat filename command to display the file:
service@ManagementServer:/var/log/VPlex/cli/reports> cat CapacityArraysLocal.csv
Time, Cluster name, Array name, Tier string, Allocated volumes (GiB), Unalloc devices (GiB),
Unalloc storage_volumes (GiB)
2010-06-21 16:00:32, cluster-1, EMC-0x00000000192601378, no-tier, 0, 0, 5666242560000
2010-06-21 16:00:32, cluster-1, EMC-0x00000000192601852, no-tier, 0, 0, 5292530073600

Example

VPlexcli:/> report capacity-arrays

Local Storage (in GiB):
cluster-1:
EMC-0x00000000192601378:
tier: no-tier
alloc: 0.000
unalloc devices: 0.000
unalloc storage-volumes: 5277.100
EMC-0x00000000192601852:
tier: no-tier
alloc: 0.000
unalloc devices: 0.000
unalloc storage-volumes: 4929.053
.
.
.
Shared Storage (in GiB):
alloc: 2192.468
unalloc devices: 0.000

Tier summary (local, by cluster):

cluster-1
Unallocated Unallocated
Tier Allocated (GiB) Devices (GiB) StorageVolumes (GiB)
no-tier 9.000 3.000 10596.152
cluster-2
Unallocated Unallocated
Tier Allocated (GiB) Devices (GiB) StorageVolumes (GiB)
no-tier 2.000 4.000 8467.749

report capacity-arrays 375

VPLEX CLI Command Descriptions

"report capacity-arrays" was not able to extract the tier id from the following
storage-volumes/devices. Please ensure that the tier-regex contains 1 capture group.
tier-regex: ^[^_]+([HL])_.+$
storage-volumes/devices:
Symm1723_1FC
CX4_lun0
base_volume
Symm1852_1C0
VPD83T3:60000970000192601378533030313530
Symm1852_5C0
VPD83T3:60000970000192601378533030313538

See also ◆ report capacity-clusters

◆ report capacity-hosts

report capacity-clusters
Generates a capacity report for every cluster.

Contexts All contexts.

Syntax report capacity-clusters

[-d|--directory] directory
Optional arguments
[-d|-directory] directory- Directory in which to create the csv files. Output is written to a file
named CapacityClusters.csv.
Default directory path: /var/log/VPlex/cli/reports/ on the management server.
If the --verbose argument is used:
◆ Storage_volumes and volumes are listed before the summary is printed.
◆ Two additional files are created: CapacityClustersVolumes.csv and
CapacityClustersStorageVolumes.csv.

Description Information includes:

◆ Unclaimed storage-volume capacity in GB.
◆ Number of unclaimed storage volumes.
◆ Claimed storage-volume capacity in GB.
◆ Number of claimed storage volumes.
◆ Used storage-volume capacity in GB.
◆ Number of used storage volumes.
◆ Unexported virtual volume capacity in GB.
◆ Number of unexported virtual volumes.
◆ Exported virtual volume capacity in GB.
◆ Number of exported virtual volumes.

Example
VPlexcli:/> report capacity-clusters

376 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Cluster, Unclaimed disk capacity (GiB), Unclaimed storage_volumes, Claimed disk capacity(GiB),
Claimed storage_volumes, Used storage-volume capacity (GiB), Used storage_volumes, Unexported
volume capacity (GiB), Unexported volumes, Exported volume capacity (GiB), Exported volumes
cluster-1, 5705.13, 341, 7947.68, 492, 360.04, 15, 3.00, 3, 2201.47, 27
cluster-2, 5337.10, 328, 7995.69, 495, 2478.45, 137, 20.00, 3, 2178.46, 25
VPlexcli:/> report capacity-clusters --verbose
Cluster, StorageVolume Name, VPD83 ID, Capacity, Use, Vendor
cluster-1,CX4_Logging,VPD83T3:6006016021d02500e6d58bab2227df11,80G,used,DGC
cluster-1,CX4__M0,VPD83T3:6006016021d02500be83caff0427df11,90G,-data,DGC
cluster-1,CX4__M1,VPD83T3:6006016021d02500bf83caff0427df11,90G,claimed,DGC
cluster-1,CX4_lun0,VPD83T3:6006016021d0250026b925ff60b5de11,10G,used,DGC
.
.
.

See also ◆ report capacity-arrays

◆ report capacity-hosts

report capacity-hosts
Generates a host capacity report.

Contexts All contexts.

Syntax report capacity-hosts

[-d|--directory] directory
Optional arguments
[-d|-directory] directory- Directory in which to create the csv files. Output is written to a file
named CapacityHosts.csv.
Default directory path: /var/log/VPlex/cli/reports/ on the management server.
If the --verbose argument is used, an additional file is created: CapacityHostsViews.csv

Description Information includes:

◆ Number of views.
◆ Total exported capacity in GB.
◆ Number of exported virtual volumes per cluster.

Example
VPlexcli:/> report capacity-hosts
Cluster, Views, Exported capacity (GiB), Exported volumes
cluster-1, 2, 2209.47, 28
cluster-2, 1, 2178.46, 25

The --verbose argument prints view details:

VPlexcli:/> report capacity-hosts --verbose
Cluster, View name, Initiator ports, Target ports, Volumes, Capacity
cluster-1, LicoJ013, LicoJ013_hba3 LicoJ013_hba2 LicoJ013_hba1 LicoJ013_hba0,
P000000003CA00147-A1-FC00 P000000003CA00147-A1-FC02 P000000003CB00147-B0-FC02
P000000003CB00147-B1-FC00 P000000003CA00147-A0-FC00 P000000003CB00147-B0-FC00
P000000003CA00147-A0-FC02 P000000003CB00147-B1-FC02, dev_sym1723_1FC_vol, 8G

report capacity-hosts 377

VPLEX CLI Command Descriptions

cluster-1, LicoJ009, LicoJ009_hba1 LicoJ009_hba0 LicoJ009_hba3 LicoJ009_hba2,

P000000003CA00147-A1-FC02 P000000003CB00147-B0-FC02 P000000003CA00147-A0-FC02
P000000003CB00147-B1-FC02, dd_09_vol dev_sym1723_1FC_vol TestDisDevice_vol dd_15_vol dd_16_vol
dd_20_vol dd_22_vol dd_18_vol dd_02_vol dd_12_vol dd_07_vol dd_19_vol dd_14_vol dd_13_vol
dd_04_vol dd_08_vol dd_11_vol dd_05_vol base0_vol dd_10_vol dd_23_vol dd_01_vol dd_00_vol
dd_17_vol dd_06_vol dd_03_vol dd_21_vol, 2.15T
cluster-2, LicoJ010, LicoJ010_hba1 LicoJ010_hba0 LicoJ010_hba3 LicoJ010_hba2,
P000000003CB000E6-B1-FC00 P000000003CB001CB-B0-FC00 P000000003CA001CB-A0-FC00
P000000003CA000E6-A0-FC00 P000000003CB001CB-B1-FC00 P000000003CB000E6-B0-FC00
P000000003CA001CB-A1-FC00 P000000003CA000E6-A1-FC00, base01_vol dd_09_vol dd_15_vol dd_16_vol
dd_20_vol dd_22_vol dd_18_vol dd_02_vol dd_12_vol dd_19_vol dd_07_vol dd_14_vol dd_13_vol
dd_04_vol dd_08_vol dd_11_vol dd_05_vol dd_10_vol dd_23_vol dd_01_vol dd_00_vol dd_17_vol
dd_06_vol dd_03_vol dd_21_vol, 2.13T
.
.
.
Cluster, Views, Exported capacity (GiB), Exported volumes
cluster-1, 2, 2209.47, 28
cluster-2, 1, 2178.46, 25

See also ◆ report capacity-clusters

◆ report capacity-arrays

report create-monitors
Creates three performance monitors for each director in the VPLEX: storage-volume
performance, port performance, and virtual volume performance. Each monitor has one
file sink.

Contexts All contexts.

Syntax report create-monitors

[-d|--directory] directory
[--force]
Optional arguments
[-d|-directory] directory- Directory in which to create the csv files.
Default directory path: /var/log/VPlex/cli/reports/ on the management server.
--force - Forces the creation of the monitor, even if existing monitors are delayed in their
polling.

Description Creates three monitors for each director in the VPLEX. Monitors are named:
◆ Cluster_n_Dir_nn_diskReportMonitor
◆ Cluster_n_Dir_nn_portReportMonitor
◆ Cluster_n_Dir_nn_volumeReportMonitor
The period attribute for the new monitors is set to 0 (automatic polling is disabled). Use
the report poll-monitors command to force a poll.
Each monitor has one file sink. The file sinks are enabled.
By default, output files are located in /var/log/VPlex/cli/reports/ on the management
server. Output filenames are in the following format:
<Monitor name>_<Cluster_n_Dir_nn.csv

378 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Disk report monitors collect:

◆ storage-volume.per-storage-volume-read-latency
◆ storage-volume.per-storage-volume-write-latency.
Port report monitors collect:
◆ be-prt.read
◆ be-prt.write
◆ fe-prt.ops
◆ fe-prt.read
◆ fe-prt.write
Volume report monitors collect:
◆ virtual-volume.ops
◆ virtual-volume.read
◆ virtual-volume.write

Example In the following example:

◆ The report create-monitors command creates a diskReportMonitor,
portReportMonitor, and volumeReportMonitor for each director in the VPLEX,
◆ The ll /monitoring/directors/*/monitors command displays the new monitors:
VPlexcli:/> report create-monitors
Creating monitor diskReportMonitor on Director Cluster_1_Dir1A monitoring 981 targets, file
/var/log/VPlex/cli/reports/diskReportMonitor_Cluster_1_Dir1A.csv.
Successfully created 1 monitor(s) out of 1.

time: 11 sec
Creating monitor volumeReportMonitor on Director Cluster_1_Dir1A monitoring 30 targets, file
/var/log/VPlex/cli/reports/volumeReportMonitor_Cluster_1_Dir1A.csv.
Successfully created 1 monitor(s) out of 1.

time: 0 sec
Creating monitor portReportMonitor on Director Cluster_1_Dir1A monitoring 16 targets, file
/var/log/VPlex/cli/reports/portReportMonitor_Cluster_1_Dir1A.csv.
Successfully created 1 monitor(s) out of 1.Creating monitor diskReportMonitor on Director
Cluster_1_Dir1A monitoring 981 targets, file
/var/log/VPlex/cli/reports/diskReportMonitor_Cluster_1_Dir1A.csv.
Successfully created 1 monitor(s) out of 1.
.
.
.
VPlexcli:/> ll /monitoring/directors/*/monitors

/monitoring/directors/Cluster_1_Dir1A/monitors:
Name Ownership Collecting Period Average Idle For Bucket Bucket Bucket Bucket
----------------------------------- --------- Data ------ Period -------- Min Max Width Count
----------------------------------- --------- ---------- ------ ------- -------- ------ ------- ------ ------
Cluster_1_Dir1A_diskReportMonitor true true 0s - 7.1min 100 1600100 25000 64
Cluster_1_Dir1A_portReportMonitor true true 0s - 6.88min - - - 64
Cluster_1_Dir1A_volumeReportMonitor true true 0s - 6.9min - - - 64

/monitoring/directors/Cluster_1_Dir1B/monitors:
Name Ownership Collecting Period Average Idle Bucket Bucket Bucket Bucket
----------------------------------- --------- Data ------ Period For Min Max Width Count
----------------------------------- --------- ---------- ------ ------- ------- ------ ------- ------ ------
Cluster_1_Dir1B_diskReportMonitor true true 0s - 6.88min 100 1600100 25000 64
Cluster_1_Dir1B_portReportMonitor true true 0s - 6.68min - - - 64
Cluster_1_Dir1B_volumeReportMonitor true true 0s - 6.7min - - - 64

report create-monitors 379

VPLEX CLI Command Descriptions

.
.
.
In the following example, the --force argument forces the creation of monitors, even
though the creation results in missed polling periods:
VPlexcli:/> report create-monitors --force
Creating monitor diskReportMonitor on Director Cluster_1_Dir1A monitoring 981 targets, file
/var/log/VPlex/cli/reports/diskReportMonitor_Cluster_1_Dir1A.csv.
WARNING: One or more of your monitors is currently at least 25.0% behind its polling period.

Successfully created 1 monitor(s) out of 1.

WARNING: One or more of your monitors is currently at least 25.0% behind its polling period.

time: 1 sec
Creating monitor volumeReportMonitor on Director Cluster_1_Dir1A monitoring 30 targets, file
/var/log/VPlex/cli/reports/volumeReportMonitor_Cluster_1_Dir1A.csv.
WARNING: One or more of your monitors is currently at least 25.0% behind its polling period.

Successfully created 1 monitor(s) out of 1.

WARNING: One or more of your monitors is currently at least 25.0% behind its polling period.
.
.
.

See also ◆ monitor add-file-sink

◆ monitor create
◆ monitor destroy
◆ monitor remove-sink
◆ report poll-monitors

report poll-monitors
Polls the report monitors created by the report create-monitors command.

Contexts All contexts.

Syntax report poll-monitors

Description The monitors created by the report create-monitors command have their period attribute
set to 0 seconds (automatic polling is disabled) and one file sink.
Use this command to force an immediate poll and collection of performance data for
monitors created by the report create-monitors command.
Output is written to files located in /var/log/VPlex/cli/reports/ on the management
server.

Example
VPlexcli:/> report poll-monitors
Collecting data for director Cluster_2_Dir_1B monitor Cluster_2_Dir_1B_diskReportMonitor.
Collecting data for director Cluster_2_Dir_1B monitor Cluster_2_Dir_1B_portReportMonitor.
Collecting data for director Cluster_2_Dir_1B monitor Cluster_2_Dir_1B_volumeReportMonitor.
.
.
.

380 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

See also ◆ monitor collect

◆ report create-monitors

rp import-certificate
Imports a RecoverPoint security certificate from the specified RPA cluster.

Contexts All contexts.

Syntax rp import-certificate

Description This command runs an interview script to import the RecoverPoint security certificate.
In Metro systems, run this command on both management servers.



This command restarts VPLEX CLI and GUI sessions on the VPLEX cluster to which the RPA
cluster is attached. With this release, using this command will lead to loss of VPLEX
Integrated Array Services (VIAS) provisioning jobs created.

Before you begin

You will need the IP address of the RecoverPoint cluster from which to import the security
certificate.

Example Import the RecoverPoint security certificate from the RPA cluster at IP address
10.6.210.85:
VPlexcli:/> rp import-certificate
This command will cause the VPLEX CLI process to restart if security settings are modified.
This will require a new log in from all connected CLI and GUI clients.

To proceed type CONTINUE or hit enter to abort: CONTINUE

Please enter the IP v4 address of the RP cluster: 10.6.210.85

-----Certificate Details-----

Owner: CN=RecoverPoint, OU=Unified Storage Division, O=EMC Corporation, L=Ramat-Gan, ST=Israel,

C=IL
Issuer: CN=RecoverPoint, OU=Unified Storage Division, O=EMC Corporation, L=Ramat-Gan,
ST=Israel, C=IL
Serial number: 4d907d4c
Valid from: Mon Mar 28 12:21:32 UTC 2011 until: Thu Mar 25 12:21:32 UTC 2021
Certificate fingerprints:
MD5: CF:38:C3:55:A9:99:AC:A6:79:12:7C:83:C3:95:23:CB
SHA1: 4D:D6:29:30:ED:0A:77:6D:38:4E:10:D3:2E:37:29:CB:45:DC:9E:C0
Signature algorithm name: SHA1withRSA
Version: 3

Trust this certificate? (Y/N): Y

The management server console process will now restart, please press any key when you are ready.
Please wait a minute before reconnecting.

Press '<Enter>' to continue ...<Enter>

Stopping EMC VPlex Management Console: Connection closed by foreign host.
service@sms-advil-2:/opt/emc/VPlex/tools/utils>

See also ◆ rp summary

rp import-certificate 381
VPLEX CLI Command Descriptions

◆ rp validate-configuration

rp rpa-cluster add
Associates a cluster of RecoverPoint Appliances to single VPLEX cluster.

Contexts All contexts.

Syntax rp rpa-cluster add

[-o|--host] rpa site management IP address
[-u|--admin-username] rpa admin-username
[-c|--cluster] cluster-id

Arguments Required arguments

[-o|--host] rpa site management IP address - * The RPA cluster management IP address.
[-u|--admin-username] admin-user-name - * The administrative username of the RPA

Optional arguments
[-c|--cluster] cluster-id - Context path of the VPLEX cluster associated with this cluster of
RPAs. If no VPLEX cluster is specified, the ID of the local cluster is used. The local cluster is
the cluster whose cluster-id matches the management server’s IP seed. See “About cluster
IP seed and cluster ID” in the security ipsec-configure command.
* argument is positional.

Description Adds information about a RecoverPoint Appliance cluster to VPLEX. Used by VPLEX to
connect to RecoverPoint and retrieve replication information.
In Metro systems, run this command on both management servers.

Note: This command prompts for the RPA administrative password.

Note: Configuration of RPAs is not permitted during VPLEX NDU.

After the RPA cluster is added, information about the RPA cluster and its consistency
groups and volumes appear in the following VPLEX CLI contexts and commands:
◆ /recoverpoint/rpa-clusters/ip_address/volumes
◆ /clusters/cluster_name/consistency-groups/cg_name/recoverpoint
◆ rp summary command
◆ rp validate-configuration command

Example Add a RecoverPoint RPA cluster:

VPlexcli:/> rp rpa-cluster add -o 10.108.65.217 -u admin -c cluster-1
Enter rpa-cluster administrative password: Admin-password
Enter rpa-cluster administrative password again for verification:
Admin-password

Example Display RPA clusters.

◆ ll /recoverpoint/rpa-clusters displays summarized information about the RPA cluster.

382 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ ll /recoverpoint/rpa-clusters /ip-address displays detailed information about the RPA

cluster
◆ ll /recoverpoint/rpa-clusters/ip-address/consistency-groups/ displays summarized
information about consistency groups in the RPA cluster.
◆ ll /recoverpoint/rpa-clusters/ip-address/consistency-groups/cg-name displays
detailed information about the specified consistency group.
◆ ll /recoverpoint/rpa-cluster /ip-address/volumes/ displays volumes managed by the
RPA.
◆ ls /recoverpoint/rpa-cluster /ip-address/volumes/volume-name displays detailed
information about the specified volume
VPlexcli:/> ll /recoverpoint/rpa-clusters

/recoverpoint/rpa-clusters:
RPA Host VPLEX Cluster RPA Site RPA ID RPA Version
----------- ------------- --------- ------ -----------
10.6.210.87 cluster-1 Tylenol-1 RPA 1 4.1(d.147)
10.6.211.3 cluster-2 Tylenol-2 RPA 1 4.1(d.147)

VPlexcli:/> ll recoverpoint/rpa-clusters/10.6.210.87/

/recoverpoint/rpa-clusters/10.6.210.87:

Attributes:
Name Value
---------------------- -------------------------------------------------------
admin-username admin
config-changes-allowed true
rp-health-indications [Problem detected with RecoverPoint RPAs and splitters]
rp-health-status warning
rp-software-serial-id -
rpa-host 10.6.210.87
rpa-id RPA 1
rpa-site Tylenol-1
rpa-version 4.1(d.147)
vplex-cluster cluster-1

Contexts:
Name Description
------------------ -----------------------------------------------------------
consistency-groups Contains all the RecoverPoint consistency groups which
consist of copies local to this VPLEX cluster.
volumes Contains all the distributed virtual volumes with a local
extent and the local virtual volumes which are used by this
RPA cluster for RecoverPoint repository and journal volumes
and replication volumes.

VPlexcli:/> cd recoverpoint/rpa-clusters/10.6.210.87/consistency-groups

VPlexcli:/recoverpoint/rpa-clusters/10.6.210.87/consistency-groups> ll
Name
----
CG-1
CG-2
CG-3

VPlexcli:/recoverpoint/rpa-clusters/10.6.210.87/consistency-groups> ll CG-1

/recoverpoint/rpa-clusters/10.6.210.87/consistency-groups/CG-1:

Attributes:

rp rpa-cluster add 383

VPLEX CLI Command Descriptions

Name Value
----------------------------- ----------------------
active-replicating-rp-cluster Tylenol-1
distributed-group false
enabled true
preferred-cluster Tylenol-1
preferred-primary-rpa RPA2
production-copy Pro-1
protection-type MetroPoint Replication
uid 7a59f870

Contexts:
Name Description
---------------- -------------------------------------------------------------
copies Contains the production copy and the replica copies of which
this RecoverPoint consistency group consists.
links Contains all the communication pipes used by RecoverPoint to
replicate consistency group date between the production copy
and the replica copies.
replication-sets Contains all the replication sets of which this RecoverPoint
consistency group consists.

VPlexcli:/recoverpoint/rpa-clusters/10.6.210.87/consistency-groups/CG-1> ll copies

/recoverpoint/rpa-clusters/10.6.210.87/consistency-groups/CG-1/copies:
Name
-----
Pro-1
Pro-2
REP-1
REP-2
REP-3

VPlexcli:/recoverpoint/rpa-clusters/10.6.210.87/consistency-groups/CG-1> ll links

/recoverpoint/rpa-clusters/10.6.210.87/consistency-groups/CG-1/links:
Name
------------
Pro-1->REP-1
Pro-1->REP-3
Pro-2->REP-2
Pro-2->REP-3

VPlexcli:/recoverpoint/rpa-clusters/10.6.210.87/consistency-groups/CG-1> ll replication-sets

/recoverpoint/rpa-clusters/10.6.210.87/consistency-groups/CG-1/replication-sets:

Name
-----
RSet0
RSet1
RSet2
RSet3

384 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

VPlexcli:/> ll recoverpoint/rpa-clusters/10.6.210.87/volumes/ty_dr1_pro_vol

/recoverpoint/rpa-clusters/10.6.210.87/volumes/ty_dr1_pro_vol:
Name Value
------------------------- --------------------------------
rp-consistency-group CG-1
rp-consistency-group-copy Pro-1
rp-replication-set RSet0
rp-role Production Source
rp-type Replication
rpa-site Tylenol-1
size 5G
uid 6000144000000010f03de8cb2f4c66d9
vplex-cluster cluster-1
vplex-consistency-group cg1_pro

Table 19 recoverpoint display fields (page 1 of 3)

Field Description

in /recoverpoint/rpa-clusters and rpa-clusters/ip-address contexts

admin-username A pre-configured RecoverPoint user with an admin role granted all system permissions to
manage RecoverPoint. Excluded privileges: downloading objects located on the RPAs,
changing users and roles, security levels, and LDAP configuration.

config-changes- Whether or not RecoverPoint appliance configuration changes are currently allowed
allowed (maintenance mode). RecoverPoint appliance configuration changes are not allowed
during VPLEX NDU.

rp-health-indication If rp-health-status is anything other than OK, additional information about the problem
s and the component that is impacted.

rp rpa-cluster add 385

VPLEX CLI Command Descriptions

Table 19 recoverpoint display fields (page 2 of 3)

Field Description

rp-health-status Operational health of the RP cluster components including WAN, volumes. RPAs, and
splitters.
OK - All components of the RP configuration are operating as expected.
error - One or more components of the RP configuration is not operating as expected. The
rp-health-indications field displays additional information.
warning - One or more components of the RP configuration is not operating as expected.
The rp-health-indications field displays additional information.
unknown - VPLEX cannot connect to the RPA cluster.

RPA Host Management IP address of the RPA.

VPLEX Cluster Cluster ID or name of the VPLEX cluster associated with the RPA.

RPA Site Name of the RPA site. There can be up to two sites in a RecoverPoint installation; a local
site and a remote site. In one-site configurations (CDP), both the production and local
copy reside at the local site. In two-site configurations (stretch CDP, CRR, and CLR), the
production copy is at the local site and the remote copy is at the remote site.

RPA ID ID of the primary/preferred RPA.

RPA Version Version of RecoverPoint on the RPA, in the following format:

MajorVersion.MinorVersion.ServicePack.Patch (branch.build)

in /recoverpoint/rpa-clusters/ip-address/consistency-groups context

copies Contains the production copy and the replica copies of which this RecoverPoint
consistency group consists.

links Contains all the communication pipes used by RecoverPoint to replicate consistency group
date between the production copy and the replica copies.

replication-sets Contains all the replication sets of which this RecoverPoint consistency group consists.

in /recoverpoint/rpa-clusters/ip-address/volumes context

Name Name of the volume as it appears in VPLEX.

RPA Site See RPA Site field description above.

RP Type Role the volume is serving in RecoverPoint replication.

Journal - One or more volumes dedicated on the storage at each copy in a RecoverPoint
configuration. Journals are defined per copy, and can consist of multiple journal volumes.
Replication - All volumes of a replication set. One production volume and one or two
replica volumes.
Repository - A special volume that must be dedicated on the SAN-attached storage at each
site, for each RPA cluster. The repository volume serves all RPAs of the particular cluster
and splitters associated with that cluster. It stores configuration information about the
RPAs and RecoverPoint consistency groups, which enables a properly functioning RPA to
seamlessly assume the replication activities of a failing RPA from the same cluster.

386 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Table 19 recoverpoint display fields (page 3 of 3)

Field Description

RP Role The function of a copy, in regards to RecoverPoint failover.

Initially, RecoverPoint configurations can consist of a Production Source and a local replica
and/or a remote replica.
• After a temporary failover, the Production Source becomes the Replica at Production
and the Remote Replica (or Local Replica) becomes the Remote (or Local) Source.
• After a permanent failover: the Replica at Production becomes the Production Source
and the Remote (or Local) Source becomes the Remote (or Local) Replica.
Local Replica - The replica at the local site. Also, the role of the local copy, before failover.
Production Source - The role of a consistency group production copy, before failover.
Remote Replica - The replica at the remote site that is being replicated to in CRR or CLR
configurations. Also denotes the role of the replica at the remote site, before failover.

RP Group If the volume is a member of a RecoverPoint consistency group, the name of the group.

VPLEX Group The VPLEX consistency group to which this volume belongs. Production and replica
volumes associated with RecoverPoint must be in VPLEX consistency groups that have the
following attributes:
• Cache-mode property is synchronous
• Consistency groups with the “visibility” property set to both clusters must also have
their “storage-at-clusters” set to both clusters.
• Recoverpoint-enabled property set to true.

Capacity Capacity of the volume.

In /recoverpoint/rpa-clusters/ip-address/volumes/volume context

rp-consistency-grou See RP Group field description above.

p

rp-consistency-grou The RecoverPoint copy to which the volume belongs.

p- copy In CDP and CRR configurations, there is one production copy and one replica copy.
In CLR configurations, there is one production copy and two replica copies (one local copy
at the production site and one remote copy at the disaster recovery site).
The production copy consists of production volumes and the production journal, which
may consist of one or more journal volumes.
The non-production copies (i.e. replica copies) each consist of replica volumes and a
replica journal, which may consist of one or more journal volumes.

rp-replication-set The RecoverPoint replication set to which the volume belongs. Replication sets consist of
the production source volume and the replica volume(s) to which it replicates.
Every storage volume in the production storage must have a corresponding volume at each
copy.

rp-role See RP Role field description above.

rp-type See RP Type field description above.

rpa-site See RPA Site field description above.

rpa-software-serial- Software serial ID for each rpa-cluster.

d

size See Capacity field description above.

uid Unique Identifier for the volume. A 64-bit number used to uniquely identify each VPLEX
volume.

vplex-cluster The VPLEX cluster with which this RPA cluster is associated.

vplex-consistency- The name of the VPLEX consistency group of which this volume is a member.
group

rp rpa-cluster add 387

VPLEX CLI Command Descriptions

See also ◆ rp rpa-cluster remove

◆ rp summary
◆ rp validate-configuration

rp rpa-cluster remove
Removes information about a RecoverPoint Appliance from VPLEX.

Contexts All contexts.

Syntax rp rpa-cluster remove

[-r|--rpa] IP-address

Arguments Required arguments

[-r|--rpa-cluster] IP-address - The site management IP address of the RPA cluster to remove.

Description Removes information about a RPA cluster from VPLEX.

Removes the following commands and contexts from the VPLEX CLI:
◆ /recoverpoint/rpa-clusters/ip_address/volumes
◆ /clusters/cluster_name/consistency-groups/cg_name/recoverpoint
◆ rp summary command
◆ rp validate-configuration command
Use the ll command in /recoverpoint/rpa-clusters context to display the site management
IP address.

Example Remove an RPA:

VPlexcli:/> ll /recoverpoint/rpa-clusters

/recoverpoint/rpa-clusters:
RPA Host VPLEX Cluster RPA Site RPA ID RPA Version
----------- ------------- -------- ------ -----------
10.6.210.75 cluster-1 Site1 RPA 1 3.5(l.26)

VPlexcli:/> rp rpa-cluster remove --rpa-cluster 10.6.210.75

VPlexcli:/> ls recoverpoint/rpa-clusters/10.6.210.75

ls: No context found for 'recoverpoint/rpa-clusters/10.6.210.75'

See also ◆ rp rpa-cluster add

◆ rp summary

rp summary
Displays a summary of replication for the entire VPLEX cluster, across all connected RPA
sites/clusters.

Contexts All contexts.

388 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

In /recoverpoint/ context, command is summary.

Syntax rp summary

Description This command calculates the total number of volumes and the total capacity for each RP
type and RP role it finds in the /recoverpoint/rpa-clusters context.
Also prints cumulative information.
RecoverPoint MetroPoint summary information is included in the totals.

Note: Distributed volumes used as production source volumes in MetroPoint replication

will have their capacity added to both cluster 1 and cluster 2 totals. Adding the total
replicated capacity of both clusters together produces a number that is larger than the
actual total replicated capacity of the VPLEX Metro system, as those particular volumes
are counted twice.

A summary of the number of production source volumes for MetroPoint groups is

displayed after the individual cluster summary, showing the shared capacity of those
volumes.

Example Display a VPLEX Metro with RecoverPoint RPAs deployed at both VPLEX clusters:
VPlexcli:/> rp summary

RecoverPoint Replication Totals:

VPLEX Cluster RP Type RP Role Total Volumes Total Capacity

------------- ----------- ----------------- ------------- --------------
cluster-1 Replication Production Source 3 15G
Local Replica 1 5G
Remote Replica 3 15G
Journal 5 50G
Repository 1 5G
------------- --------------
Totals: 13 90G

VPLEX Cluster RP Type RP Role Total Volumes Total Capacity

------------- ----------- ----------------- ------------- --------------
cluster-2 Replication Production Source 2 10G
Local Replica 2 10G
Remote Replica 0 0G
Journal 2 20G
Repository 1 5G
------------- --------------
Totals: 7 45G

RecoverPoint MetroPoint Replication summary:

1 MetroPoint group(s) are configured with 2 Production Source volumes using a total capacity
of 10G.
Distributed Volumes used for MetroPoint replication will be counted in the capacity of each
cluster above.

rp summary 389
VPLEX CLI Command Descriptions

Table 20 rp summary display fields

Field Description

VPLEX Cluster Name of the VPLEX cluster associated with a RecoverPoint RPA.

RP Type Type of volume.

Journal - One or more volumes dedicated on the storage at each copy in a
RecoverPoint configuration. Journals are defined per copy, and can consist
of multiple journal volumes.
Replication - All volumes of a replication set. One production volume and
one or two replica volumes.
Repository - A special volume that must be dedicated on the SAN-attached
storage at each site, for each RPA cluster. The repository volume serves all
RPAs of the particular cluster and splitters associated with that cluster. It
stores configuration information about the RPAs and RecoverPoint
consistency groups, which enables a properly functioning RPA to
seamlessly assume the replication activities of a failing RPA from the same
cluster.

RP Role The function of a copy, in regards to failover.

Initially, RecoverPoint configurations can consist of a Production Source
and a Local Replica and/or a Remote Replica.
• After a temporary failover, the Production Source becomes the Replica at
Production and the Remote Replica (or Local Replica) becomes the
Remote (or Local) Source.
• After a permanent failover: the Replica at Production becomes the
Production Source and the Remote (or Local) Source becomes the
Remote (or Local) Replica.
Local Replica - The replica at the local site. Also, the role of the local copy,
before failover.
Production Source - Production copy, before failover.
Remote Replica - The replica at the remote site that is being replicated to in
CRR or CLR configurations. Also denotes the role of the replica at the remote
site, before failover.

Total Volumes Number of volumes protected by RecoverPoint at the specified VPLEX

cluster.

Total Capacity Total capacity of the volumes protected by RecoverPoint at the specified
VPLEX cluster.

See also ◆ rp rpa-cluster add

◆ rp rpa-cluster remove
◆ rp validate-configuration

rp validate-configuration
Validates the RecoverPoint splitter configuration.

Contexts All contexts.

Syntax rp validate-configuration

Description This command checks the system configuration with respect to RecoverPoint and displays
errors or warnings if errors are detected.

390 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

For VPLEX Metro configurations, run this command on both management servers.



When RPAs are zoned to VPLEX using single-channel mode (2 RPA ports are zoned to
VPLEX front end ports, and 2 RPA ports are zoned to the VPLEX back end ports) this
command reports the ports as “WARNING”. This is because the command checks that all
4 ports on the RPA are zoned to both VPLEX front end and back end ports (dual-channel
mode). See the second example listed below.

Best practice is to zone every RPA port to both VPLEX front end and back end ports. For
configurations where this is not possible or desirable, this command detects the port
configuration, displays a warning. Administrators who have purposely configured
single-channel mode can safely ignore the warning.

This command performs the following checks:

Splitter checks:
◆ VPLEX splitters are installed.
◆ All splitter versions agree.
◆ The VPLEX splitter status is OK.
RecoverPoint cluster checks:
◆ VPLEX management server can reach all the attached RecoverPoint clusters
Storage view checks:
◆ Storage views do not have mixed RecoverPoint and non-RecoverPoint initiator ports.
◆ RecoverPoint storage views have access to multiple ports.
◆ No volume is exposed to more than one RecoverPoint cluster.
◆ No RecoverPoint journal or repository volumes are exposed to hosts.
Initiator port checks:
◆ All the RecoverPoint initiator ports are registered.
◆ All the registered RecoverPoint initiator ports are used.
RP Cluster:
◆ VPLEX management server can reach all the attached RecoverPoint Clusters.
Consistency group checks:
◆ VPLEX consistency groups are aligned with RecoverPoint consistency groups.
Volumes checks:
◆ All production volumes are not remote volumes.
◆ All distributed production volumes have detach rule set correctly.
◆ All distributed production volumes have cache mode set correctly.
◆ All production and replica volumes are in RecoverPoint-enabled VPLEX consistency
groups.

rp validate-configuration 391
VPLEX CLI Command Descriptions

◆ No replica volume is a remote volume.

◆ All distributed replica volumes have detach rule set correctly.
◆ All distributed replica volumes have cache mode set correctly.
◆ All journal and repository volumes are local volumes.
◆ All repository volumes are not in any VPLEX consistency group.

Example Check a healthy RecoverPoint configuration:

VPlexcli:/> rp validate-configuration
This command may take several minutes to complete. Please be patient.
==============================================================================
Validate the VPLEX Splitters
==============================================================================
Validating that VPLEX Splitters are installed
OK
Validating that all splitter versions agree
OK
Validating the VPLEX Slitter status
OK
==============================================================================
Validate Storage Views
==============================================================================
Validating that storage views do not have mixed non-recoverpoint and recoverpoint initiator
ports OK
Validating that recoverpoint storage views have access to multiple recoverpoint ports
OK
==============================================================================
Validate Initiator Ports
==============================================================================
Validating that all the recoverpoint initiator ports are registered
OK
Validating that all the registered recoverpoint initiator ports are used
OK
==============================================================================
Validation Summary
==============================================================================
Your system appears healthy. There were no problems found in the system.

Example Detect RPA ports that are zoned as single-channel mode:

VPlexcli:/> rp validate-configuration
This command may take several minutes to complete. Please be patient.
.
.
.
=======================================================================
Validate the VPLEX to RPA zoning
=======================================================================

Validating that VPLEX sees all expected initiator ports from RPAs
WARNING

VPLEX does not see RPA initiator port: 0x500124804dc50283

VPLEX does not see RPA initiator port: 0x500124824dc50283

VPLEX does not see RPA initiator port: 0x500124804a00021b

VPLEX does not see RPA initiator port: 0x500124824a00021b

392 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Validating that VPLEX sees all expected backend RPA ports

WARNING

VPLEX does not see RPA back end port: 0x500124814dc50283

VPLEX does not see RPA back end port: 0x500124834dc50283

VPLEX does not see RPA back end port: 0x500124814a00021b

VPLEX does not see RPA back end port: 0x500124834a00021b

=======================================
Validation Summary
=======================================
The following potential problems were found in the system:

1 problem(s) were found with RecoverPoint Clusters.

8 potential problem(s) were found with the zoning between VPLEX and RecoverPoint.

Example Detect a mis-configured storage-view:

VPlexcli:/> rp validate-configuration
.
.
.
Validating that storage views do not have mixed non-recoverpoint and recoverpoint initiator
ports ERROR
Storage view rp-view-demo has mixed types of initiator ports.
.
.
.
==============================================================================
Validation Summary
==============================================================================
The following potential problems were found in the system:
1 problem(s) were found with storage views.

See also ◆ rp rpa-cluster add

◆ rp rpa-cluster remove
◆ rp summary

schedule add
Schedules a job to run at the specified times.

Contexts All contexts.

Syntax schedule add

[-t|--time] time
[-c|--command] command

Arguments Required arguments

[-t|--time] time - * Date and time the job executes in crontab-style format enclosed in quote
marks. Values are specified in the crontab-style format:

schedule add 393

VPLEX CLI Command Descriptions

“<Minute> <Hour> <Day of the Month> <Month> <Day of the week>”

Minute - 0-59.
Hour - 0-23.
Day of the Month - 1-31.
Month - 1-12, January = 1...December = 12
Day of the week - 0-6, Sunday = 0...Saturday = 6
[-c|--command] command - * The CLI command to be executed at the specified time.
* - argument is positional.

Example To run the tree command every night at 1:00 a.m.:

VPlexcli:/> schedule add "* 1 * * *" --command tree

See also ◆ schedule list

◆ schedule modify
◆ schedule remove

schedule list
Lists all scheduled jobs.

Contexts All contexts.

Syntax schedule list

Example VPlexcli:/> schedule list

[0] 30 13 * * 3 syrcollect
[1] * 1 * * * tree
[2] * 2 * * * tree

See also ◆ schedule modify

◆ schedule remove

schedule modify
Modifies an existing scheduled job.

Contexts All contexts.

Syntax schedule modify

[-j|--job] job ID
[-t|--time] time
[-c|--command] command

Arguments Required arguments

[-j|--job] job ID - * ID of the scheduled job as displayed by the schedule list command.
[-t|--time] time - * Date and time the job executes in crontab-style format enclosed in quote
marks. Values are specified in the following format:

394 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

“<Minute> <Hour> <Day of the Month> <Month> <Day of the week>”

Minute - 0-59.
Hour - 0-23.
Day of the Month - 1-31.
Month - 1-12, January = 1...December = 12
Day of the week - 0-6, Sunday = 0...Saturday = 6
[-c|--command] command - * The CLI command to be executed at the specified time.
* - argument is positional.

Example To modify a job with the ID of 3 so that it runs every day at 11:00 a.m. type:
VPlexcli:/> schedule list
[0] 30 13 * * 3 syrcollect
[1] * 1 * * * tree
[2] * 2 * * * tree
[3] * 3 * * * tree

VPlexcli:/> schedule modify 3 -t "* 11 * * *" -c tree

See also ◆ schedule list

◆ schedule remove

schedule remove
Removes a scheduled job.

Contexts All contexts.

Syntax schedule remove

[-j|--job] job ID

Arguments Required arguments

[-j|--job] job ID - * ID of the scheduled job as displayed by the schedule list command.
* - argument is positional.

Example Remove job with the ID of 3:

VPlexcli:/> schedule list
[0] 30 13 * * 3 syrcollect
[1] * 1 * * * tree
[2] * 2 * * * tree
[3] * 3 * * * tree

VPlexcli:/> schedule remove 3

Removed scheduled job 3.

VPlexcli:/> schedule list

[0] 30 13 * * 3 syrcollect
[1] * 1 * * * tree
[2] * 2 * * * tree

See also ◆ schedule list

◆ schedule modify

schedule remove 395

VPLEX CLI Command Descriptions

scheduleSYR add
Schedules a weekly SYR data collection.

Contexts All contexts.

Syntax scheduleSYR add

[-d|--dayOfWeek] 0-6
[-t|--hours] 0-23
[-m|--minutes] 0-59

Arguments Required arguments

[-d|--dayOfWeek] 0-6 - Day of the week run the collection.
Valid values are 0-6, where Sunday = 0...Saturday = 6.
[-t|--hours] 0-23 - Hour at which to run the collection.
[-m|--minutes] 0-59 - Minute at which to run the collection.

Description Typically, SYR collection and reporting are configured at initial system setup. Use this
command to add a scheduled SYR collection time if none was configured.
SYR data collection can be scheduled to occur at most once a week. Attempts to add
another weekly schedule results in an error.
SYR reporting gathers VPLEX configuration files and forward them to EMC. SYR reports
provide:
◆ Faster problem resolution and RCA
◆ Proactive maintenance
◆ Data for performance analysis
To modify the existing SYR collection time, use the scheduleSYR remove command to
delete the current time, and the scheduleSYR add command to specify a new collection
time.

Example Schedule an SYR collection for every Wednesday at 12:30 p.m.:

VPlexcli:/> scheduleSYR add -d 3 -t 12 -m 30
SYR data collection job scheduled

VPlexcli:/> scheduleSYR list

SYR data collection job is currently scheduled at:
Day of Week: 3 (Sunday=0, Monday=1,...Saturday=6)
Hours: 12
Minutes: 30

See also ◆ configuration event-notices-reports config

◆ configuration event-notices-reports reset
◆ schedule list
◆ scheduleSYR list
◆ scheduleSYR remove
◆ syrcollect

396 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

scheduleSYR list
Lists the scheduled SYR data collection job.

Contexts All contexts.

Syntax scheduleSYR list

Example List the SYC collection schedule:

VPlexcli:/> scheduleSYR list
SYR data collection job is currently scheduled at:
Day of Week: 1 (Sunday=0, Monday=1,...Saturday=6)
Hours: 23
Minutes: 30

See also ◆ configuration event-notices-reports config

◆ configuration event-notices-reports reset
◆ scheduleSYR add
◆ scheduleSYR remove

scheduleSYR remove
Removes the currently scheduled SYR data collection job.

Contexts All contexts.

Syntax scheduleSYR remove

Description Only one SYR data collection can be scheduled. The current SYR collection cannot be
modified. To modify the SYR data collection job:
◆ Use the scheduleSYR remove command to remove the existing collection job.
◆ Use the scheduleSYR add command to create a new collection job.

Example Remove a scheduled collection:

VPlexcli:/> scheduleSYR remove
Removing SYR data collection job scheduled at:
Day of Week: 3 (Sunday=0, Monday=1,...Saturday=6)
Hours: 13
Minutes: 30
SYR data collection job removed successfully

See also ◆ configuration event-notices-reports config

◆ configuration event-notices-reports reset
◆ scheduleSYR add
◆ scheduleSYR list

script
Changes to interactive Jython scripting mode.

scheduleSYR list 397

VPLEX CLI Command Descriptions

Contexts All contexts.

Syntax script
[-i|--import] module
[-u|--unimport] module
Optional arguments
[-i|--import] module - Import the specified Jython module without changing to interactive
mode. After importation, commands registered by the module are available in the CLI. If
the module is already imported, it is explicitly reloaded.
[-u|--unimport] module - Unimport the specified Jython module without changing to
interactive mode. All the commands that were registered by that module are unregistered.

Description Changes the command mode from VPLEX CLI to Jython interactive mode.
To return to the normal CLI shell, type a period '.' and press ENTER.
Use the --import and --export arguments to import/export the specified Jython module
without changing to interactive mode.

Example Enter Jython interactive mode:

VPlexcli:/> script
Jython 2.2 on java1.6.0_03

>>>

Exit Jython interactive mode:

>>> .

VPlexcli:/>

Import/unimport the specified Jython module without changing to interactive mode:

VPlexcli:/> script --import ndu

VPlexcli:/> script --unimport ndu

See also ◆ source

security create-ca-certificate
Creates a new Certification Authority (CA) certificate.

Contexts All contexts.

Syntax security create-ca-certificate

[-l|--keylength] 384-2048
[-d|--days] 365-1825
[-o|--ca-cert-outfilename] filename
[-f|--ca-key-outfilename] filename
[-s|--ca-subject-filename] filename

Optional arguments
[-l|--keylength] length - The length (number of bits) for the CA key.

Default: 2048. Range: 384 - 2048

398 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

[-d|--days] days - Number of days that the certificate is valid.

Default: 1825 (5 years). Range: 365 - 1825.

[-o|--ca-cert-outfilename] filename - CA Certificate output filename.

Default: strongswanCert.pem.
[-f|--ca-key-outfilename] filename - CA Key output filename.
Default: strongswanKey.pem.
[-s|--ca-subject-filename] filename - Name of the CA subject information file that contains
the subject information to create the CA certificate.

Description A management server authenticates users against account information kept on its local
file system. An authenticated user can manage resources in the clusters.
The Certification Authority (CA) is used to sign management server certificates.
The security create-ca-certificate and security create-host-certificate commands create the
CA and host certificates using a pre-configured Distinguished Name where the Common
Name is the VPLEX cluster Top Level Administrator (TLA). If the TLA is not already set, it
must be set manually to prevent certificate creation failure.
Alternatively, use the --ca-subject-filename argument to create a custom Distinguished
Name. Specify the full path of the subject file unless the subject file is in the local CLI
directory.
This command creates two objects on the management server:
◆ A CA certificate file valid for 1825 days (5 years). The file is located at:
/etc/ipsec.d/cacerts/strongswanCert.pem
◆ A private key protected by a passphrase. The CA key is located at:
/etc/ipsec.d/private/strongswanKey.pem

Using the security commands

Note: Take note of the passphrases you use to create these certificates and save them in a
secure location. They will be required at other times when maintaining the VPLEX clusters.

The steps to configure security on a VPLEX differ depending on whether the configuration
is a VPLEX Local or VPLEX Metro/Geo.
For VPLEX Local configurations:
1. Use the security create-ca-certificate command to create the CA certificate.
2. Write down the passphrase entered during the creation of CA certificate.
3. Use the security create-host-certificate command to create the host certificate.
A prompt is displayed for the passphrase used to create the CA certificate.
4. Write down the passphrase entered during the creation of host certificate.
5. Use the security ipsec-configure command to start the VPN process.

security create-ca-certificate 399

VPLEX CLI Command Descriptions

A prompt for the passphrase used to create the host certificate is displayed.
For VPLEX Metro and Geo configurations:

Note: Take note of the passphrases you use to create these certificates and save them in a
secure location. They will be required at other times when maintaining the VPLEX clusters.

On the first cluster:

1. scp the CA certificate file (default name: strongswanCert.pem)
from: /etc/ipsec.d/cacerts on the first cluster
to: /etc/ipsec.d/cacerts directory on the second cluster
2. scp the CA passphrase (default name: strongswanKey.pem)
from: /etc/ipsec.d/private directory on the first cluster
to: /etc/ipsec.d/private directory on the second cluster
For example:
scp /etc/ipsec.d/cacerts/strongswanCert.pem
[email protected]:/etc/ipsec.d/cacerts

scp /etc/ipsec.d/private/strongswanKey.pem
[email protected]:/etc/ipsec.d/private

On the second cluster:

3. Use the security create-host-certificate command to create the host certificate.
A prompt is displayed for the passphrase used to create the CA certificate.
4. Write down the passphrase entered during the creation of host certificate.
Set up the VPN between clusters:
On the first cluster:
5. Use the security ipsec-configure command to start the VPN process.
A prompt for the passphrase used to create the host certificate is displayed.
security ipsec-configure -l 1 -r 2 -i 10.12.177.74

On the second cluster:

6. Use the security ipsec-configure command to start the VPN process.
A prompt for the passphrase used to create the host certificate on the second
cluster is displayed.
security ipsec-configure -l 2 -r 1 -i 10.12.177.71

IMPORTANT
In VPLEX Metro and Geo configurations: Use the same CA certificate passphrase for host
certificates on management servers 1 and 2.

Example Create a default CA certificate with the default CA certificate subject information.
VPlexcli:/> security create-ca-certificate

400 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Please enter the passphrase for the CA Certificate Key:

Re-enter the passphrase for the Certificate Key:

New CA certificate strongswanCert.pem created
New CA key strongswanKey.pem created

Example Create a default CA certificate (strongswanCert.pem) with custom CA certificate subject

information. In the following example,
• The security create-certificate-subject command creates a custom subject file.
named TestSubject.txt.
• The security create-ca-certificate command creates a default CA certificate with the
specified custom subject file
VPlexcli:/> security create-certificate-subject -c US -s NewYork -m EMC -u EMC -l NewYork -n
CommonTestName -e [email protected] -o TestSubject.txt

VPlexcli:/> security create-ca-certificate --ca-subject-filename TestSubject.txt

The following files are created in the specified directories:

• /etc/ipsec.d/cacerts/strongswanCert.pem
• /etc/ipsec.d/private/strongswanKey.pem

Example Create a custom CA certificate with a custom CA certificate subject information. In the
following example:
• The security create-certificate-subject command creates a custom subject file.
named TestSubject.txt.
• The security create-ca-certificate command creates a custom CA certificate with the
specified custom subject file.
VPlexcli:/> security create-certificate-subject -c US -s NewYork -m EMC -u EMC -l NewYork -n
CommonTestName -e [email protected] -o TestSubject.txt

VPlexcli:/> security create-ca-certificate --ca-cert-outfilename TestCACert.pem

--ca-key-outfilename TestCAKey.pem --ca-subject-filename TestSubject.txt

The following files are created in the specified directories:

• /etc/ipsec.d/cacerts/TestCACert.pem
• /etc/ipsec.d/private/TestCAKey.pem

See also ◆ security create-certificate-subject

◆ security create-host-certificate
◆ security delete-ca-certificate
◆ security delete-host-certificate
◆ security export-ca-certificate
◆ security export-host-certificate
◆ security import-ca-certificate
◆ security import-host-certificate
◆ security ipsec-configure

security create-ca-certificate 401

VPLEX CLI Command Descriptions

◆ security show-cert-subj
◆ EMC VPLEX Security Configuration Guide

security create-certificate-subject
Creates a subject file used in creating security certificates.

Contexts All contexts.

Syntax security create-certificate-subject

[-c|--country] country
[-s|--state] state
[-m|--org-name] organizational name
[-u|--org-unit] organizational unit
[-l|--locality] locality
[-n|--common-name] name
[-e|--email] e-mail
[-o|--subject-out-filename] filename
[--force]

Arguments Required arguments

[-o|--subject-out-filename] filename - The filename of the subject file.

Optional arguments
[-c|--country] country - The Country value for the country key in the subject file.
[-s|--state] state - The State value for the state key in the subject file.
[-m|--org-name] organizational name - Organizational Name value for the organizational
name key in the subject file.
[-u|--org-unit] organizational unit - Organizational Unit value for the organizational unit key
in the subject file.
[-l|--locality] locality - Locality value for the locality key in the subject file.
[-n|--common-name] name - Name value for the name key in the subject file.
[-e|--email] e-mail - E-mail value for the e-mail key in the subject file.
[-o|--subject-out-filename] Output Subject Filename - The filename of the subject file to be
created.
--force - Overwrites the specified subject-out-filename if a file of that name already exists.
If a file with the subject-out-filename already exists and the --force argument is not
specified, the command fails.

Description Creates a subject file used in certificate creation.

Example Create a default certificate subject file:

VPlexcli:/> security create-certificate-subject --subject-out-filename TestSubject.txt
The certificate subject file TestSubject.txt file is created at /var/log/VPlex/cli directory
with the following information:
SUBJECT_COUNTRY=US
SUBJECT_STATE=Massachusetts

402 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

SUBJECT_LOCALITY=Hopkinton
SUBJECT_ORG=EMC
SUBJECT_ORG_UNIT=EMC
SUBJECT_COMMON_NAME=FNM00102200421
[email protected]

Example Create a custom certificate subject file:

VPlexcli:/> security create-certificate-subject -c US -s NewYork -m EMC -u EMC -l NewYork -n
CommonTestName -e [email protected] --subject-out-filename TestSubject.txt

The certificate subject file TestSubject.txt file is created at /var/log/VPlex/cli directory

with the following information:
SUBJECT_COUNTRY=US
SUBJECT_STATE=NewYork
SUBJECT_LOCALITY=NewYork
SUBJECT_ORG=EMC
SUBJECT_ORG_UNIT=EMC
SUBJECT_COMMON_NAME=CommonTestName
[email protected]

See also ◆ security create-certificate-subject

◆ security create-host-certificate
◆ security export-ca-certificate
◆ security export-host-certificate
◆ security import-ca-certificate
◆ security import-host-certificate
◆ security ipsec-configure
◆ security show-cert-subj
◆ EMC VPLEX Security Configuration Guide

security create-host-certificate
Creates a new host certificate and signs it with an existing CA certificate.

Contexts All contexts.

security create-host-certificate 403

VPLEX CLI Command Descriptions

Syntax security create-host-certificate

[-l|--keylength] 384-2048
[-d|--days] 365-730
[-o|--host-cert-outfilename] filename
[-f|--host-key-outfilename] filename
[-r|--ca-subject-filename] filename
[-c|--ca-cert-filename] ca certificate
[-k|--ca-key-filename] ca key
[-s|--host-subject-filename] filename
[-g|--get-master-ca]
Optional arguments
[-l|--keylength] length - The length (number of bits) for the CA key.

Default: 2048. Range: 384 - 2048.

[-d|--days] days - Number of days that the certificate is valid.

Default: 730 (2 years). Range: 365 - 730.

[-o|--host-cert-outfilename] filename - Host certificate output filename.

Default: hostCert.pem.
[-f|--host-key-outfilename] filename - Host key output filename.
Default: hostKey.pem.
[-r|--host-cert-req-outfilename] filename - host certificate Request output filename.
Default: hostCertReq.pem.
[-c|--ca-cert-filename] ca certificate - CA certificate used to sign the host certificate.
Default: strongswanCert.pem.
[-k|--ca-key-filename] ca key - CA Key used to sign the host certificate.
Default: strongswanKey.pem
[-s|--host-subject-filename] filename - File that contains the subject information to create
the host certificate.
[-g|--get-master-ca] - Pulls the master CA to the requesting cluster and creates the digital
certificate. Copies the updated serial file back to the master server so that the master
server has a serial number that is up to date with the number of digital certificates that the
CA created. Enables strict browsers (FireFox) to connect to different clusters from the same
browser.

Description Generates a host certificate request and signs it with the Certification Authority certificate
created by the security create-ca-certificate command.
The CA Certificate and CA Key must be created prior to running this command.
The host certificate is stored at /etc/ipsec.d/certs.
The host key is stored at /etc/ipsec.d/private.
The host certificate request is stored at /etc/ipsec.d/reqs.
The CA certificate file is read from /etc/ipsec.d/cacerts.
The CA Key is read from /etc/ipsec.d/private.

404 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Example Create a default host certificate with the default host certificate subject information:
VPlexcli:/> security create-host-certificate

The following files are created in the specified directories:

• /etc/ipsec.d/certs/hostCert.pem
• /etc/ipsec.d/private/hostKey.pem

Example Create a custom host certificate with the default host certificate subject information:
VPlexcli:/>security create-host-certificate --host-cert-outfilename
TestHostCert.pem --host-key-outfilename TestHostKey.pem

The following files are created in the specified directories:

• /etc/ipsec.d/certs/TesthostCert.pem
• /etc/ipsec.d/private/TesthostKey.pem

Example Create a custom host certificate with custom host certificate subject information. In the
following example:
• The security create-certificate-subject command creates a custom subject file
named TestSubject.txt.
• The security create-host-certificate command creates a custom host certificate with
the specified custom subject file.

VPlexcli:/> security create-certificate-subject -c US -s NewYork -m EMC -u EMC -l NewYork -n

CommonTestName -e [email protected] -o TestSubject.txt

VPlexcli:/> security create-host-certificate --host-cert-outfilename TestHostCert.pem

--host-key-outfilename TestHostKey.pem --host-subject-filenam TestSubject.txt

The following files are created in the specified directories:

• /etc/ipsec.d/cacerts/TestHostCert.pem
• /etc/ipsec.d/private/TestHostKey.pem

See also ◆ security create-certificate-subject

◆ security create-host-certificate
◆ security delete-ca-certificate
◆ security delete-host-certificate
◆ security export-ca-certificate
◆ security export-host-certificate
◆ security import-ca-certificate
◆ security import-host-certificate
◆ security ipsec-configure
◆ security show-cert-subj
◆ “Using the security commands” in the security create-ca-certificate command
◆ EMC VPLEX Security Configuration Guide

security create-host-certificate 405

VPLEX CLI Command Descriptions

security delete-ca-certificate
Deletes the specified CA certificate and its key.

Contexts All contexts.

Syntax security delete-ca-certificate

[-o|--ca-cert-outfilename] filename
[-f|--ca-key-outfilename] filename

Arguments Required arguments

None (to delete default CA certificate).

Optional arguments
[-o|--ca-cert-outfilename] filename - CA Certificate output filename.
Default: strongswanCert.pem.
[-f|--ca-key-outfilename] filename - CA Key output filename.
Default: strongswanKey.pem.

Description Deletes the CA certificate and deletes the entries from the lockbox that were created by
EZ-setup.

Example Delete the default CA certificate and key:

VPlexcli:/> security delete-ca-certificate

The following files are deleted from the specified directories:

◆ /etc/ipsec.d/cacerts/strongswanCert.pem
◆ /etc/ipsec.d/private/strongswanKey.pem

Example Delete a custom CA certificate (not the default):

VPlexcli:/> security delete-ca-certificate -o TestCACert.pem -f TestCAKey.pem

The following files are deleted from the specified directories:

◆ /etc/ipsec.d/cacerts/TestCACert.pem
◆ /etc/ipsec.d/private/TestCAKey.pem

See also ◆ security create-ca-certificate

◆ security delete-host-certificate
◆ EMC VPLEX Security Configuration Guide

security delete-host-certificate
Deletes the specified host certificate.

Contexts All contexts.

Syntax security delete-hostcertificate

[-o|--host-cert-outfilename] filename
[-f|--host-key-outfilename] filename

406 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Required arguments

None (to delete default host certificate).

Optional arguments
[-o|--host-cert-outfilename] filename - host certificate output filename.
Default: hostCert.pem.
[-f|--host-key-outfilename] filename - Host key output filename.
Default: hostKey.pem.

Description Deletes the specified host certificate and deletes the entries from the lockbox that were
created by EZ-setup.

Example Delete the default host certificate and key:

VPlexcli:/> security delete-host-certificate

The following files are deleted from the specified directories:

◆ /etc/ipsec.d/certs/hostCert.pem
◆ /etc/ipsec.d/private/hostKey.pem

Example Delete a custom (not the default) host certificate:

VPlexcli:/>security delete-host-certificate -o TestHostCert.pem -f TestHostKey.pem

The following files are deleted from the specified directories:

◆ /etc/ipsec.d/certs/TestHostCert.pem
◆ /etc/ipsec.d/private/TestHostKey.pem

See also ◆ security create-ca-certificate

◆ security create-host-certificate
◆ security delete-ca-certificate

security export-ca-certificate
Exports a CA certificate and CA key to a given location.

Contexts All contexts.

Syntax security export-ca-certificate

[-c|--ca-cert-filepath] absolute path
[-k|--ca-key-filepath] absolute path
[-e|--ca-export-location] export location

Arguments Required arguments

[-e|--ca-export-location] absolute path - The absolute path of the location to which to
export the CA Certificate and CA Key.

Optional arguments
[-c|--ca-cert-filepath] absolute filepath - The absolute path of the CA certificate file to
export.

security export-ca-certificate 407

VPLEX CLI Command Descriptions

Default: /etc/ipsec.d/cacerts/strongswanCert.pem.
[-k|--ca-key-filepath] absolute filepath - The absolute path of the CA Key file to export.
Default: /etc/ipsec.d/private/strongswanKey.pem.

Description Exports the CA certificate to the specified location.

Note: The user executing this command must have write privileges at the location to which
the certificate is exported.

The import/export of CA certificates does not work for external CA certificates.

Example Export the default CA certificate and key to /var/log/VPlex/cli:

VPlexcli:/> security export-ca-certificate -e /var/log/VPlex/cli

Example Export a custom CA certificate and it's key (created using the security create-ca-certificate
command) to /var/log/VPlex/cli:
VPlexcli:/> security export-ca-certificate -c /etc/ipsec.d/cacerts/TestCACert.pem -k
/etc/ipsec.d/private/TestCAKey.pem -e /var/log/VPlex/cli

See also ◆ security create-ca-certificate

◆ security create-certificate-subject
◆ security create-host-certificate
◆ security export-host-certificate
◆ security import-ca-certificate
◆ security import-host-certificate
◆ security ipsec-configure
◆ security show-cert-subj
◆ “Using the security commands” in the security create-ca-certificate command
◆ EMC VPLEX Security Configuration Guide

security export-host-certificate
Exports a host certificate and host key to the specified location.

Contexts All contexts.

Syntax security export-host-certificate

[-c|--host-cert-filepath] absolute path
[-k|--host-key-filepath] absolute path
[-e|--host-export-location] export location

Arguments Required arguments

[-e|--host-export-location] absolute path - The absolute path of the location to which to
export the host certificate and host key.

408 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Optional arguments
[-c|--host-cert-filepath] absolute filepath - The absolute path of the host certificate file to
export.
Default: /etc/ipsec.d/certs/hostCert.pem
[-k|--host-key-filepath] absolute filepath - The absolute path of the host key file to export.
Default: /etc/ipsec.d/private/hostKey.pem

Description Exports the host certificate to the specified location.

Note: The user executing this command must have write privileges at the location to which
the certificate is exported.

Example Export the default host certificate and key to /var/log/VPlex/cli:

VPlexcli:/> security export-host-certificate -e /var/log/VPlex/cli

Example Export a custom host certificate and it's key (created using the security
create-host-certificate command) to /var/log/VPlex/cli:
VPlexcli:/> security export-host-certificate -c /etc/ipsec.d/certs/TestHostCert.pem -k
/etc/ipsec.d/private/TestHostKey.pem -e /var/log/VPlex/cli

See also ◆ security create-ca-certificate

◆ security create-certificate-subject
◆ security create-host-certificate
◆ security export-ca-certificate
◆ security import-ca-certificate
◆ security show-cert-subj
◆ EMC VPLEX Security Configuration Guide

security import-ca-certificate
Imports a CA certificate and CA key from a given location.

Contexts All contexts.

Syntax security import-ca-certificate

[-c|--ca-cert-filepath] absolute path
[-k|--ca-key-filepath] absolute path
[-i|--ca-cert-import-location] import location
[-j|--ca-key-import-location] import location

Arguments Required arguments

[-c|--ca-cert-filepath] absolute path The absolute path of the CA certificate file to import.
[-k|--ca-key-filepath] absolute path - The absolute path of the CA key file to import.

security import-ca-certificate 409

VPLEX CLI Command Descriptions

Optional arguments
[-i|--ca-cert-import-location] import location - The absolute path of the location to which to
import the CA certificate.
Default location - /etc/ipsec.d/cacerts.
[-j|--ca-key-import-location] import location - The absolute path of the location to which to
import the CA certificate.
Default location - /etc/ipsec.d/private.

Description Imports the CA certificate from the specified location.

Note: The user executing this command must have write privileges at the location from
which the certificate is imported.

If the import locations for the CA certificate and CA key has files with the same names,
they are overwritten.
The import/export of CA certificates does not work for external CA certificates.

Example Import the CA certificate and its key from a specified location to the default CA certificate
and key location (/var/log/VPlex/cli):
VPlexcli:/> security import-ca-certificate -c /var/log/VPlex/cli/strongswanCert.pem -k
/var/log/VPlex/cli/strongswanKey.pem

◆ The imported CA certificate file is copied to /etc/ipsec.d/cacerts

◆ The imported CA key is copied to /etc/ipsec.d/private

Example Import the CA certificate and key from /var/log/VPlex/cli directory to a custom location:
VPlexcli:/> security import-ca-certificate -c /var/log/VPlex/cli/strongswanCert.pem -k
/var/log/VPlex/cli/strongswanKey.pem -i /Test/cacerts -j /Test/private

◆ The imported CA certificate file is copied to /Test/cacerts

◆ The imported CA key is copied to /Test/private

See also ◆ security create-ca-certificate

◆ security create-certificate-subject
◆ security create-host-certificate
◆ security export-ca-certificate
◆ security import-host-certificate
◆ security ipsec-configure
◆ security show-cert-subj
◆ EMC VPLEX Security Configuration Guide

security import-host-certificate
Imports a host certificate and host key from a given location.

410 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Contexts All contexts.

Syntax security import-host-certificate

[-c|--host-cert-filepath] absolute path
[-k|--host-key-filepath] absolute path
[-i|--host-cert-import-location] import location
[-j|--host-key-import-location] import location

Arguments Required arguments

[-c|--host-cert-filepath] absolute path - The absolute path of the host certificate file to
import.
[-k|--host-key-filepath] absolute path - The absolute path of the host key file to import.

Optional arguments
[-i|--host-cert-import-location] import location - The absolute path of the location to which
to import the host certificate.
Default location - /etc/ipsec.d/certs.
[-j|--host-key-import-location] import location - The absolute path of the location to which
to import the host certificate.
Default location - /etc/ipsec.d/private.

Description Imports the host certificate from the specified location.

Note: The user executing this command must have write privileges at the location from
which the certificate is imported.

If the import locations for the host certificate and host key have files with the same
names, the files are overwritten.

Example Import the host certificate and key from /var/log/VPlex/cli:

VPlexcli:/> security import-host-certificate -c /var/log/VPlexcli/hostCert.pem -k
/var/log/VPlex/cli/hostKey.pem

◆ The imported host certificate file is copied to /etc/ipsec.d/certs

◆ The imported host key is copied to /etc/ipsec.d/private

Example Import the host certificate and it's key from /var/log/VPlex/cli to a custom host certificate
and key location:
VPlexcli:/> security import-ca-certificate -c /var/log/VPlexcli/hostCert.pem -k
/var/log/VPlex/cli/hostKey.pem -i /Test/certs -j /Test/private

◆ The imported host certificate file is copied to /Test/cacerts

◆ The imported host key is copied to /Test/private

See also ◆ security create-ca-certificate

◆ security create-certificate-subject
◆ security create-host-certificate
◆ security export-ca-certificate

security import-host-certificate 411

VPLEX CLI Command Descriptions

◆ security import-ca-certificate
◆ security ipsec-configure
◆ security show-cert-subj
◆ EMC VPLEX Security Configuration Guide

security ipsec-configure
Configures IPSec after the CA and host certificates have been created.

Contexts All contexts.

Syntax security ipsec-configure

[-i|--remote-ms-ipaddr] Remote IP address
[-c|--host-cert-filename] host certificate
[-k|--host-key-filename] host key

Arguments Required arguments

[-i|--remote-ms-ipaddr] Remote IP address - IP address of the remote management server.

Optional arguments
[-c|--host-cert-filename] host certificate - host certificate filename.
[-k|--host-key-filename] host key - host key filename.

Description This command does the following:

◆ Backs up the existing ipsec.conf and ipsec.secrets files.
◆ Configures ipsec.conf and ipsec.secrets with the latest VPN configuration.
◆ Enables the IPSec service at rc3, rc4, and rc5 run levels.
◆ Starts the VPN.
The following steps must be completed before using this command:
1. On the first cluster, use the security create-ca-certificate command to create the CA
certificate.
2. On the first cluster, use the security create-host-certificate command to create the
host certificate.
3. Copy (scp) the CA certificate:
From: /etc/ipsec.d/cacerts/strongswanCert.pem on the first cluster
To: etc/ipsec.d/cacerts/ on the second cluster.
4. Copy (scp) the CA key:
From: /etc/ipsec.d/private/strongswanKey.pem on the first cluster
To: /etc/ipsec.d/cacerts/ on the second cluster.
5. On the second cluster, use the security create-host-certificate command to create the
host certificate.
6. On the second cluster, use the security ipsec-configure command, and specify the IP
address of the first cluster.

412 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

7. On the second cluster, use the security ipsec-configure command. Specify the IP
address of the first cluster.
8. On the first cluster, use the security ipsec-configure command. Specify the IP address
of the second cluster.
9. On either cluster, use the vpn status command to verify that the VPN is established.

Note: This command should be used only in VPLEX Metro and VPLEX Geo configurations to
create the VPN tunnel between clusters.

The distinguished name (DN) used to configure the ipsec is read from the host certificate
created on the remote management server. The filename of the host certificate file created
on the remote management server must be hostCert.pem.

About cluster IP seed and cluster ID

The VPLEX IP seed is used to generate the IP addresses used by the internal components
of the VPLEX. For more information about components and their IP addresses, refer to EMC
VPLEX Installation and Setup Guide.
Cluster ID is used by the virtualization software (inter director messaging, cluster
identification).
For the current release, the IP seed is the same value as the cluster ID, and always either 1
(cluster-1) or 2 (cluster-2).

Example In the following example:

◆ On first cluster: the security ipsec-configure command configures IPsec to second
cluster at 10.6.209.33
◆ On second cluster: the security ipsec-configure command configures IPsec to first
cluster at 10.6.209.32
◆ On the first cluster, the vpn status command confirms that the VPN to the second
cluster is up
◆ On the second cluster, the vpn status command confirms that the VPN to the first
cluster is up
VPlexcli-1 VPlexcli:/> security ipsec-configure -i 10.6.209.33

  VPlexcli-2 VPlexcli:/> security ipsec-configure -i 10.6.209.32

VPlexcli-1 VPlexcli:/> vpn status

Verifying the VPN status between the management servers...
IPSEC is UP
Remote Management Server at IP Address 10.6.209.33 is reachable
Remote Internal Gateway addresses are reachable

  VPlexcli-2 VPlexcli:/> vpn status

Verifying the VPN status between the management servers...
IPSEC is UP
Remote Management Server at IP Address 10.6.209.32 is reachable
Remote Internal Gateway addresses are reachable

See also ◆ security create-ca-certificate

◆ security create-certificate-subject

security ipsec-configure 413

VPLEX CLI Command Descriptions

◆ security create-host-certificate
◆ security export-ca-certificate
◆ security import-ca-certificate
◆ security show-cert-subj
◆ “Using the security commands” in the security create-ca-certificate command
◆ EMC VPLEX Security Configuration Guide

security remove-login-banner
Removes the login banner from the management server.

Contexts All contexts.

Syntax security remove-login-banner

[-f|--force]

Arguments Optional arguments

[-f|--force] - Forces the removal of the login banner without asking for any user
confirmation. Allows this command to be run from non-interactive scripts.

Description Removes a custom login banner from the management server.

The change takes effect at the next login to the management server.

Example Remove the login banner:

VPlexcli:/> security remove-login-banner

The login banner of this management server will be removed.

Do you want to proceed ? (Yes/No) yes

See also ◆ security set-login-banner

◆ EMC VPLEX Security Configuration Guide

security renew-all-certificates
Renews CA and host security certificates.

Contexts All contexts.

Syntax security renew-all-certificates

Description When VPLEX is installed, EZ-Setup creates one CA certificate and two or three host
certificates:
◆ Certification Authority (CA) certificate shared by all clusters
◆ VPN host certificate
◆ Web server host certificate
◆ VPLEX Witness host certificate (when VPLEX Witness is installed)

414 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

All types of certificates expire and must be periodically renewed. By default:

◆ CA certificates must be renewed every 5 years
◆ Host certificates must be renewed every 2 years
Starting in Release 5.0.1 Patch, use the security renew-all-certificates CLI command to
renew all security certificates on a VPLEX system.
In Metro and Geo systems , run the command twice, once on each cluster. For systems
with VPLEX Witness deployed, make sure you run the command first on the cluster where
VPLEX Witness was initially installed. See the “Before you begin” section below for the
steps to determine the correct cluster.
You can use the command at any time to renew certificates whether or not they are about
to expire.
Each certificate has an associated passphrase. For releases prior to 4.2, VPLEX was not
aware of any passphrases. For releases after 4.2, VPLEX may or may not be aware of
passphrases. Previous to 5.0.1 Patch, VPLEX is never aware of the passphrase for the
VPLEX Witness certificate. During renewal, you are prompted to enter any passphrases
that VPLEX does not know.
After renewal, VPLEX is aware of all passphrases.
There are two general methods for renewing passphrases:
◆ Renew the security certificates using their current passphrases.
VPLEX may find the current passphrases for the CA, VPN, and Web server security
certificates, but prior to 5.0.1 Patch, never finds the current passphrase for the VPLEX
Witness security certificate.
If you choose to renew the certificates using their current passphrases, you are
prompted to provide the passphrase for any certificate that VPLEX does not find.

IMPORTANT
In Metro and Geo systems , you are always prompted for the Certificate Authority (CA)
passphrase when you run the command on the second cluster.

When renewing the certificates on the second cluster of a Metro or Geo system , you
may be prompted to enter the service password. Contact the System Administrator to
obtain the current service password.

◆ Renew the certificates using a common passphrase.

All certificates are renewed using the same passphrase.



In Metro and Geo systems , do not renew the security certificates using the current
passphrases if you do not have a record of the Certificate Authority (CA) passphrase. You
must provide the current CA passphrase when you renew the certificates on the second
cluster. If you do not have a record of the CA passphrase, do not renew the certificates
until you have the passphrase or renew with a common passphrase.

security renew-all-certificates 415

VPLEX CLI Command Descriptions

Before you begin: ◆ Navigate to the /ect/ssl directory on the management servers, and see on which
cluster the file index.txt includes this string: CN=VPlex VPN CWS. If the string is
present, run the renewal command on that cluster first.
◆ Use the vpn status command to verify that the VPN tunnel between clusters is
operational, and the Cluster Witness Server is reachable. Do not proceed if these
conditions are not present.
◆ Use the ll cluster-witness command to verify that the cluster-witness admin-state is
disabled. If it is enabled, use the cluster-witness disable command to disable it.

Example: Renew certificates on a VPLEX Local

The following is the simplest renewal case:
◆ VPLEX Local
◆ Using a common passphrase
VPlexcli:/> security renew-all-certificates
If this is a VPLEX Local deployment, follow the prompts below to renew all certificates. If
this is a VPLEX Metro or Geo, please contact EMC Support.

Do you want to continue renewing all certificates? (Y/N): yes

Detecting all the VPLEX certificates currently configured on the system...<
The following certificates will be renewed:
Certificate Type Expiration Date New Expiration Date
-------------------------- ------------------------ ------------------------
Host Certificate (VPN) Sep 11 16:22:22 2013 GMT Sep 11 16:22:22 2015 UTC
Certificate Authority (CA) Sep 10 16:22:21 2016 GMT Sep 9 16:22:21 2021 UTC
Host Certificate (WEB) Sep 11 16:22:24 2013 GMT Sep 11 16:22:24 2015 UTC

The certificates above will be renewed, to expire on the dates shown. Do you want to continue?
(Y/N): y
Would you like to renew the certificates using the current passphrases? (Y/N): no

Please create a passphrase (at least 8 chars) to be used for all the certificate renewals:
Re-enter the passphrase for the Certificate Key: CA-passphrase
Renewing CA certificate...
The CA certificate was successfully renewed.
Renewing VPN certificate...
The VPN certificate was successfully renewed.
Renewing WEB certificate...
Your Java Key Store has been created.
https keystore: /var/log/VPlex/cli/.keystore
started web server on ports {'http': 49880, 'https': 49881}
The Web certificate was successfully renewed.
Generating certificate renewal summary...
All VPLEX certificates have been renewed successfully

Example: Renew certificates on a VPLEX Geo with VPLEX Witness

The following example renews security certificates in a more complex scenario:
• VPLEX Geo
• Using current passphrases
• VPLEX does not find any current passphrases
• VPLEX Witness is installed

416 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

On the cluster where the VPLEX Witness certificate was created

VPlexcli:/> security renew-all-certificates
Please note that to renew certificates on a Metro or Geo deployment, this command must be run
on both clusters.

WARNING : After running this command on the first cluster, the VPN tunnel between clusters will
be down temporarily until you run this command on the second cluster. This will not affect I/O
but will result in the inability to manage the remote cluster.

Detecting all the VPLEX certificates currently configured on the system...

The following certificates will be renewed:

Certificate Type Expiration Date New Expiration Date

-------------------------- ------------------------ ------------------------
Host Certificate (VPN) Sep 12 17:10:10 2013 GMT Sep 12 17:10:10 2015 UTC
Host Certificate (CW) Sep 12 17:10:18 2013 GMT Sep 12 17:10:18 2015 UTC
Certificate Authority (CA) Sep 11 17:10:08 2016 GMT Sep 10 17:10:08 2021 UTC
Host Certificate (WEB) Sep 12 17:10:16 2013 GMT Sep 12 17:10:16 2015 UTC

The certificates above will be renewed, to expire on the dates shown. Do you want to
continue?(Y/N): y

Would you like to renew the certificates using the current passphrases? (Y/N): y

Some or all of the passphrases are not available, so new passphrases must be created:

Please create a passphrase (at least 8 chars) for the Certificate Authority renewal:
CA-passphrase

Re-enter the passphrase for the Certificate Key: CA-passphrase

Please create a passphrase (at least 8 chars) for the VPN certificate renewal: VPN-passphrase

Re-enter the passphrase for the Certificate Key: VPN-passphrase

Please create a passphrase (at least 8 chars) for the web certificate renewal: WEB-passphrase

Re-enter the passphrase for the Certificate Key: WEB-passphrase

Please create a passphrase (at least 8 chars) for the cluster witness certificate renewal:
CWS-passphrase

Re-enter the passphrase for the Certificate Key: CWS-passphrase

Renewing CA certificate...
The CA certificate was successfully renewed.

Renewing VPN certificate...

The VPN certificate was successfully renewed.

Renewing WEB certificate...

Your Java Key Store has been created.
https keystore: /var/log/VPlex/cli/.keystore
started web server on ports {'http': 49880, 'https': 49881}
The Web certificate was successfully renewed.

Renewing CW certificate...
The CWS certificate was successfully renewed.

Generating certificate renewal summary...

Certificates have been successfully renewed on this cluster. To complete the renewal process,
run this command on the second cluster.

security renew-all-certificates 417

VPLEX CLI Command Descriptions

* The VPN tunnel between clusters will be down temporarily

On the second cluster

VPlexcli:/> security renew-all-certificates
Please note that to renew certificates on a Metro or Geo deployment, this command must be run
on both clusters.

WARNING : After running this command on the first cluster, the VPN tunnel between clusters will
be down temporarily until you run this command on the second cluster. This will not affect I/O
but will result in the inability to manage the remote cluster.

Before continuing to renew certificates on this cluster, please confirm that certificates have
been renewed on the other cluster.

Have certificates have been renewed on the other cluster? (yes/no) (Y/N): y
Detecting all the VPLEX certificates currently configured on the system...

The following certificates will be renewed:

Certificate Type Expiration Date New Expiration Date

-------------------------- ------------------------ ------------------------
Host Certificate (VPN) Sep 12 17:13:04 2013 GMT Sep 12 17:13:04 2015 UTC
Certificate Authority (CA) Sep 11 17:10:08 2016 GMT Sep 10 17:10:08 2021 UTC
Host Certificate (WEB) Sep 12 17:13:09 2013 GMT Sep 12 17:13:09 2015 UTC

The certificates above will be renewed, to expire on the dates shown. Do you want to continue?
(Y/N): y

Would you like to renew the certificates using the current passphrases? (Y/N): y

Some or all of the passphrases are not available, so new passphrases must be created:

Please enter the 'service' account password( 8 chars ) for the Remote Management Server:
emc12345

Re-enter the password: emc12345

Please enter the passphrase for the Certificate Authority on the remote cluster: CA-passphrase

Re-enter the passphrase for the Certificate Key: CA-passphrase

Please create a passphrase (at least 8 chars) for the VPN certificate renewal: VPN-passphrase

Re-enter the passphrase for the Certificate Key: VPN-passphrase

Please create a passphrase (at least 8 chars) for the web certificate renewal: WEB-passphrase

Re-enter the passphrase for the Certificate Key: WEB-passphrase

Renewing CA certificate...
The CA certificate was successfully renewed.

Renewing VPN certificate...

The VPN certificate was successfully renewed.

Renewing WEB certificate...

Your Java Key Store has been created.
https keystore: /var/log/VPlex/cli/.keystore
started web server on ports {'http': 49880, 'https': 49881}
The Web certificate was successfully renewed.

Generating certificate renewal summary...

418 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

After certificate renewal: enable VPLEX Witness

If VPLEX Witness was disabled before the security certificates were renewed:
◆ Use the cluster-witness enable command to re-enable VPLEX Witness.
◆ Use the ll cluster-witness command to verify that the admin-state is enabled.

See also ◆ security create-ca-certificate

◆ security create-host-certificate
◆ security export-ca-certificate
◆ security import-ca-certificate
◆ security import-host-certificate

security set-login-banner
Applies a text file as the login banner on the management server.

Contexts All contexts.

Syntax security set-login-banner

[-b|--login-banner-file] file
[-f|--force]

Arguments Required arguments

[-b|--login-banner-file] file - Full pathname to the file containing the formatted login banner
text.

Optional arguments
[-f|--force] - Forces the addition of the login banner without asking for any user
confirmation. Allows this command to be run from non-interactive scripts.

Description This command sets the login banner for the management server. This command applies
the contents of the specified text file as the login banner.
The change takes effect at the next login to the management server.
The formatting of the text in the specified text file is replicated in the banner.
There is no limit to the number of characters or lines in the specified text file.
Use this command to create a customized login banner. The formatting of the text in the
specified text file is replicated in the banner.

Example In the following example, a text file “login-banner.txt” containing the following lines is
specified as the login banner:
VPLEX cluster-1/Hopkinton
Test lab 3, Room 6, Rack 47
Metro with RecoverPoint CDP
VPlexcli:/> security set-login-banner -b
/home/service/login-banner.txt
The text provided in the specified file will be set as the Login banner
for this management server.

security set-login-banner 419

VPLEX CLI Command Descriptions

Any previously applied banner will be overwritten.

Do you want to proceed ? (Yes/No) Yes

At next login to the management server, the new login banner is displayed:
login as: service
VPLEX cluster-1/Hopkinton
Test lab 3, Room 6, Rack 47
Metro with RecoverPoint CDP
Password:

See also ◆ security remove-login-banner

◆ EMC VPLEX Security Configuration Guide

security show-cert-subj
Displays the certificate subject file.

Contexts All contexts.

Syntax security show-cert-subj

[s|--subject-infilename] filename

Arguments Required arguments

[-s|--subject-infilename] filename - Filename of the certificate subject file to display. The
file is assumed to reside in the following directory on the management server:
/var/log/VPlex/cli

Description Displays the certificate subject file.

Example VPlexcli:/> security show-cert-subj -s CACertSubjectInfo.txt

SUBJECT_COUNTRY=US
SUBJECT_STATE=Massachusetts
SUBJECT_LOCALITY=Hopkinton
SUBJECT_ORG=EMC
SUBJECT_ORG_UNIT=EMC
SUBJECT_COMMON_NAME=FNM00094400134
[email protected]

See also ◆ security create-certificate-subject

sessions
Displays active Unisphere for VPLEX sessions.

Contexts All contexts.

Syntax sessions

Description Displays the username, hostname, port and start time of active sessions to the Unisphere
for VPLEX.

Example VPlexcli:/> sessions

Type Username Hostname Port Creation Time
------------- -------- --------- -----
----------------------------
TELNET_SHELL service localhost 23848 Wed Sep 15 15:34:33 UTC 2010

420 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

DEFAULT_SHELL - - - Tue Aug 03 17:16:07 UTC 2010

set
Changes the value of a writable attribute(s) in the given context.

Contexts All contexts.

Syntax set
[-d|--default]
[-f|--force]
[-a|--attributes] selector pattern
[-v|--value] new value
Optional arguments
[-d|--default] - Sets the specified attribute(s) to the default values, if any exist. If no
attributes are specified, displays the default values for attributes in the current/specified
given context.
[-f|--force] - Force the value to be set, bypassing any confirmations or guards.
[-a|--attributes] selector pattern - * Attribute selector pattern.
[-v|--value] new value - * The new value to assign to the specified attribute(s).
* - argument is positional.

Description Use the set command with no arguments to display the attributes available in the current
context.
Use the set --default command with no additional arguments to display the default values
for the current context or a specified context.
Use the set command with an attribute pattern to display the matching attributes and the
required syntax for their values.
Use the set command with an attribute pattern and a value to change the value of each
matching attribute to the given value.
An attribute pattern is an attribute name optionally preceded with a context glob pattern
and a double-colon (::). The pattern matches the named attribute on each context
matched by the glob pattern.
If the glob pattern is omitted, set assumes the current context.
If the value and the attribute name are omitted, set displays information on all the
attributes on all the matching contexts.

Example Display which attributes are writable in the current context, and their valid inputs:
VPlexcli:/distributed-storage/distributed-devices/TestDisDevice> set
attribute input-description
-------------------------------------------------------------------------------------------------------
application-consistent Takes one of '0', '1', 'f', 'false', 'n', 'no', 'off', 'on', 't', 'true', 'y', 'yes'
(not case sensitive).
auto-resume Takes one of '0', '1', 'f', 'false', 'n', 'no', 'off', 'on', 't', 'true', 'y', 'yes'
(not case sensitive).
block-count Read-only.
block-size Read-only.
capacity Read-only.
clusters-involved Read-only.
.

set 421
VPLEX CLI Command Descriptions

.
.
Use the --default argument without any attribute(s) to display the default values for the
current (or specified) context's attributes:
VPlexcli:/distributed-storage/distributed-devices/TestDisDevice> set --default
attribute default-value
---------------------- -----------------
application-consistent No default value.
auto-resume No default value.
block-count No default value.
.
..

Example Change the name of a meta-volume:

VPlexcli:/clusters/cluster-1/system-volumes/new_meta1_backup_2010May24_163810> set name
backup_May24_pre_refresh

Example Display information about attributes in the eth0 context:

VPlexcli:/> set /management-server/ports/eth0
attribute input-description
--------------------------------------------- -----------------
/management-server/ports/eth0::address Read-only.
/management-server/ports/eth0::auto-negotiate Read-only.
/management-server/ports/eth0::duplex Read-only.
/management-server/ports/eth0::gateway Read-only.
/management-server/ports/eth0::inet6-address Read-only.
/management-server/ports/eth0::inet6-gateway Read-only.
/management-server/ports/eth0::name Read-only.
/management-server/ports/eth0::net-mask Read-only.
/management-server/ports/eth0::speed Read-only.
/management-server/ports/eth0::status Read-only.

Example Display the address attribute for eth0:

VPlexcli:/> set /management-server/ports/eth0::address
attribute input-description
-------------------------------------- -----------------
/management-server/ports/eth0::address Read-only.

Example Set the remote IP address and started attributes for SNMP traps:
VPlexcli:/notifications/call-home/snmp-traps/Test> set remote-host 10.6.213.39
VPlexcli:/notifications/call-home/snmp-traps/Test> set started true

Example Attach a rule-set cluster1_Active to the device dd_00:

VPlexcli:/distributed-storage/distributed-devices> set dd_00::rule-set-name cluster1_Active

Example Set a storage volume’s thin-rebuild attribute to true:

VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes/clar_LUN83> set thin-rebuild
true
VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes/clar_LUN83> ll
Name Value
---------------------- -------------------------------------------------------
application-consistent false
.
.
.

422 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

storage-volumetype normal
system-id VPD83T3:6006016061212e00b0171b696696e211
thin-rebuild true
total-free-space 0B
underlying-storage-block-size 512
use used
used-by [extent_test01_1]
vendor-specific-name DGC
vias-based false

Example Use the set enabled false --force command in notifications/call-home context to disable
call-home notifications (recommended during disruptive operations):
VPlexcli:/> cd /notifications/call-home/

VPlexcli:/notifications/call-home> set enabled false --force

Use the set enabled true command in notifications/call-home context to enable call-home
notifications:
VPlexcli:/> cd /notifications/call-home/

VPlexcli:/notifications/call-home> set enabled true

Example Enable and display ports:

VPlexcli:/engines/engine-1-1/directors/director-1-1-A/hardware/ports> ll
Name Address Role Port Status
------- ------------------ --------- -----------
A0-FC00 0x5000144260006e00 front-end no-link
A0-FC01 0x5000144260006e01 front-end up
A0-FC02 0x5000144260006e02 front-end up
A0-FC03 0x0000000000000000 front-end down
A1-FC00 0x5000144260006e10 back-end up
A1-FC01 0x5000144260006e11 back-end up
A1-FC02 0x5000144260006e12 back-end no-link
A1-FC03 0x5000144260006e13 back-end no-link
A2-FC00 0x5000144260006e20 wan-com up
A2-FC01 0x5000144260006e21 wan-com up
A2-FC02 0x5000144260006e22 wan-com no-link
A2-FC03 0x5000144260006e23 wan-com no-link
A3-FC00 0x5000144260006e30 local-com up
A3-FC01 0x5000144260006e31 local-com up
A3-FC02 0x0000000000000000 - down
A3-FC03 0x0000000000000000 - down

VPlexcli:/engines/engine-1-1/directors/director-1-1-A/hardware/ports> set
A0-FC03::enabled true

VPlexcli:/engines/engine-1-1/directors/director-1-1-A/hardware/ports> ll
Name Address Role Port Status
------- ------------------ --------- -----------
A0-FC00 0x5000144260006e00 front-end no-link
A0-FC01 0x5000144260006e01 front-end up
A0-FC02 0x5000144260006e02 front-end up
A0-FC03 0x5000144260006e03 front-end no-link
A1-FC00 0x5000144260006e10 back-end up
A1-FC01 0x5000144260006e11 back-end up
A1-FC02 0x5000144260006e12 back-end no-link
A1-FC03 0x5000144260006e13 back-end no-link
A2-FC00 0x5000144260006e20 wan-com up
A2-FC01 0x5000144260006e21 wan-com up
A2-FC02 0x5000144260006e22 wan-com no-link
A2-FC03 0x5000144260006e23 wan-com no-link
A3-FC00 0x5000144260006e30 local-com up

set 423
VPLEX CLI Command Descriptions

A3-FC01 0x5000144260006e31 local-com up

A3-FC02 0x0000000000000000 - down
A3-FC03 0x0000000000000000 - down

Example Change and display the name of a virtual volume:

Note: Changing a virtual-volume name will not cause any impact to host IO (DU).

VPlexcli:/clusters/cluster-1/virtual-volumes/EMC-CLARiiON-0075-VNX-LUN122_1_vol>
set -a name -v new_name

VPlexcli:/clusters/cluster-1/virtual-volumes/new_name> ll
Name Value
------------------ -----------------------------------------------
block-count 2621440
block-size 4K
cache-mode synchronous
capacity 10G
consistency-group -
expandable true
health-indications []
health-state ok
locality local
operational-status ok
scsi-release-delay 0
service-status running
storage-tier -
supporting-device device_EMC-CLARiiON-APM00113700075-VNX_LUN122_1
system-id EMC-CLARiiON-0075-VNX-LUN122_1_vol
volume-type virtual-volume

Return to the virtual-volumes context and change directory to the new name:
VPlexcli:/clusters/cluster-1/virtual-volumes/new_name> cd ..

VPlexcli:/clusters/cluster-1/virtual-volumes> cd new_name

Run a listing on the volume to display the new name for the system-id:

VPlexcli:/clusters/cluster-1/virtual-volumes/new_name> ll
Name Value
------------------ -----------------------------------------------
block-count 2621440
block-size 4K
cache-mode synchronous
capacity 10G
consistency-group -
expandable true
health-indications []
health-state ok
locality local
operational-status ok
scsi-release-delay 0
service-status running
storage-tier -
supporting-device device_EMC-CLARiiON-APM00113700075-VNX_LUN122_1
system-id new_name
volume-type virtual-volume

See also ◆ storage-volume claim

424 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ storage-volume unclaim

set topology
Changes the topology attribute for a Fibre Channel port.

Contexts /engines/engine/directors/director/hardware/ports/port

Syntax set topology [p2p|loop]

Arguments Required arguments

p2p - Sets the port’s topology as point-to-point. The port comes up as an F-port.
Use the p2p topology to connect the Fibre Channel fabric to a node.
loop - Sets the port’s topology as loop. The port comes up as an FL-Port.
Use the loop topology to connect a Fibre Channel Arbitrated Loop (ring-style network
topology) to a fabric.

Description Change the default setting for a Fibre Channel port.

Default: p2p.

Note: According to best practices, the front-end ports should be set to the default p2p and
connected to the hosts via a switched fabric.



It is not recommended to change the topology on the local COM ports, as it can lead to
the directors going down and data unavailability.

Example Navigate to a FC port context and set the topology as p2p:

VPlexcli:/> cd /engines/engine-1-1/directors/Cluster_1_Dir1A/hardware/ports/A4-FC02
VPlexcli:/engines/engine-1-1/directors/Cluster_1_Dir1A/hardware/ports/A4-FC02> set topology
p2p

VPlexcli:/engines/engine-1-1/directors/Cluster_1_Dir1A/hardware/ports/A4-FC02> ll
Name Value
------------------ ------------------
address 0x5000144240014742
current-speed 8Gbits/s
description -
enabled true
max-speed 8Gbits/s
node-wwn 0x500014403ca00147
operational-status ok
port-status up
port-wwn 0x5000144240014742
protocols [fc]
role wan-com
target-port -
topology p2p

See also ◆ set

set topology 425

VPLEX CLI Command Descriptions

show-use-hierarchy
Display the complete usage hierarchy for a storage element from the top-level element
down to the storage-array.

Contexts All contexts.

Syntax show-use-hierarchy
[-t|--targets] context path,context path,...

Arguments Required arguments

[-t|--targets] context path, context path,... - * Comma separated list of target storage
elements.
You can specify meta, logging and virtual volumes, local and distributed devices, extents,
storage-volumes or logical-units on a single command line.

Note: A complete context path to the targets must be specified. For example:

show-use-hierarchy /clusters/cluster-1/storage-elements/storage-volumes/volume

or:

show-use-hierarchy /clusters/cluster-1/storage-elements/storage-volumes/*

* - argument is positional.
This command drills from the specified target up to the top-level volume and down to the
storage-array. The command will detect sliced elements, drill up through all slices and
indicate in the output that slices were detected. The original target is highlighted in the
output. '

Example Display the usage hierarchy for the specified volume:

VPlexcli:/> show-use-hierarchy -t
/distributed-storage/distributed-devices/r1_crossClusterDeviceMigrationSrc_C2_CHM_0001
storage-view: chimera_setupTearDown_C2 (cluster-2)
virtual-volume: r1_crossClusterDeviceMigrationSrc_C2_CHM_0001_vol (5G, distributed @
cluster-1, running)
distributed-device: r1_crossClusterDeviceMigrationSrc_C2_CHM_0001 (5G, raid-1)
distributed-device-component:
r1_crossClusterDeviceMigrationSrc_C2_CHM_00012012Jul25_051049 (5G, raid-1, cluster-2)
extent: extent_r1_crossClusterDeviceMigrationSrc_C2_CHM_0001_0 (5G)
storage-volume: VPD83T3:60000970000192601690533031364331 (100G, 30 slices)
logical-unit: VPD83T3:60000970000192601690533031364331
storage-array: EMC-SYMMETRIX-192601690
extent: extent_r1_crossClusterDeviceMigrationSrc_C2_CHM_0001_1 (5G)
storage-volume: VPD83T3:60000970000192601690533031364330 (100G, 30 slices)
logical-unit: VPD83T3:60000970000192601690533031364330
storage-array: EMC-SYMMETRIX-192601690
distributed-device-component: r1_crossClusterDeviceMigrationTgt_C1_CHM_0001 (5G, raid-1,
cluster-1)
extent: extent_r1_crossClusterDeviceMigrationTgt_C1_CHM_0001_0 (5G)
storage-volume: VPD83T3:60000970000192601690533031364231 (100G, 30 slices)
logical-unit: VPD83T3:60000970000192601690533031364231
storage-array: EMC-SYMMETRIX-192601690
extent: extent_r1_crossClusterDeviceMigrationTgt_C1_CHM_0001_1 (5G)
storage-volume: VPD83T3:60000970000192601690533031364230 (100G, 30 slices)
logical-unit: VPD83T3:60000970000192601690533031364230

426 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

storage-array: EMC-SYMMETRIX-192601690

Example Display the usage hierarchy for the specified meta volume:
VPlexcli:/clusters/cluster-1/system-volumes/meta_1> cd ..
VPlexcli:/clusters/cluster-1/system-volumes> show-use-hierarchy meta_1
meta-volume: meta_1 (78G, raid-1, cluster-1)
storage-volume: VPD83T3:6006016047a02d0046a94fcee916e111 (78G)
logical-unit: VPD83T3:6006016047a02d0046a94fcee916e111
storage-array: EMC-CLARiiON-APM00114103169
storage-volume: VPD83T3:60060480000190300487533030363245 (80G)
logical-unit: VPD83T3:60060480000190300487533030363245
storage-array: EMC-SYMMETRIX-190300487

Example Display the usage hierarchy for the specified logging volume:
VPlexcli:/> show-use-hierarchy clusters/cluster-1/system-volumes/log_1_vol
logging-volume: log_1_vol (2.01G, raid-1, cluster-1)
extent: extent_Symm0487_039A_1 (2.01G)
storage-volume: Symm0487_039A (2.01G)
logical-unit: VPD83T3:60060480000190300487533030333941
storage-array: EMC-SYMMETRIX-190300487

Example Display the usage hierarchy for the specified extent:

VPlexcli:/clusters/cluster-1/storage-elements/extents> show-use-hierarchy
rC_C1_ramcloud_0180_extent_0
virtual-volume: rC_C1_ramcloud_0180_vol (200G, local @ cluster-1, unexported)
local-device: rC_C1_ramcloud_0180 (200G, raid-c, cluster-1)
extent: rC_C1_ramcloud_0180_extent_0 (100G)
storage-volume: VPD83T3:60001440000000103017dfea883553bb (100G)
logical-unit: VPD83T3:60001440000000103017dfea883553bb
storage-array: EMC-Invista-14403b
extent: rC_C1_ramcloud_0180_extent_1 (100G)
storage-volume: VPD83T3:60001440000000103017dfea883553b9 (100G)
logical-unit: VPD83T3:60001440000000103017dfea883553b9
storage-array: EMC-Invista-14403b

See also ◆ drill-down

◆ tree

sms dump
Collects the logs files on the management server.

Contexts All contexts.

Syntax sms dump

[-d|--destination-directory] destination directory
[-t|--target_log] target logName

Arguments Required arguments

[-d| --destination-directory] destination directory - Destination directory for the sms dump
logs.

Optional arguments
[-t|--target_log] target logName - Collect only files specified under logName from
smsDump.xml.

sms dump 427

VPLEX CLI Command Descriptions

Description Collects the following log files:

Note: The log files listed below are the core set of files along with other files that are not
listed.

Clilogs
/var/log/VPlex/cli/client.log* -- VPlexcli logs, logs dumped by VPlexcli scripts
/var/log/VPlex/cli/session.log* -- what the user does in a VPlexcli session
/var/log/VPlex/cli/firmware.log* -- nsfw.log files from all directors

ConnectEMC
/var/log/ConnectEMC/logs/* -- connectemc logs
/opt/emc/connectemc/archive -- connectemc logs
/opt/emc/connectemc/failed -- connectemc logs
/opt/emc/connectemc/*.xml -- connectemc logs
/opt/emc/connectemc/*.ini -- connectemc logs
/var/log/VPlex/cli/ema_adaptor.log*

Configuration
/var/log/VPlex/cli/*.config
/var/log/VPlex/cli/*xml
/var/log/VPlex/cli/*.properties
/var/log/VS1/cli/persistentstore.xml -- generated when user connects to VPlexcli
/var/log/VPlex/cli/connections -- what the VPlexcli is connected to.
/var/log/VPlex/cli/VPlexcommands.txt
/var/log/VPlex/cli/VPlexconfig.xml
/var/log/VPlex/cli/VPlexcli-init
/opt/vs1/backup/*.ini
/opt/vs1/backup/*.xml
/opt/emc/VPlex/*.xml
/opt/emc/VPlex/*.properties

Upgrade
/var/log/VPlex/cli/capture/* (ndu status files)
/tmp/VPlexInstallPackages/*.xml
/tmp/VPlexInstallPackages/*.properties
/tmp/VPlexInstallPackages/*.log
/var/log/install.log

428 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

System
/var/log/warn*
/var/log/messages*
/var/log/boot.msg
/var/log/boot.omsg
/var/log/firewall
/etc/sysconfig/SuSEfirewall2
/etc/sysconfig/network/ifcfg*
/etc/sysconfig/network/ifroute*
/etc/sysctl.conf

Example Collect the logs files on the management server and send them to the designated
directory:
VPlexcli:/> sms dump --destination-directory /var/log/VPlex/cli
Initiating sms dump...
sms dump completed to file
/var/log/VPlex/cli/smsDump_2010-09-15_16.40.20.zip.

See also ◆ cluster configdump

◆ collect-diagnostics
◆ director appdump
◆ getsysinfo

snmp-agent configure
Configures the VPLEX SNMP agent service on the local cluster.

Contexts All contexts.

Syntax snmp-agent configure

Description Configures SNMP agent on the local cluster, and starts the SNMP agent.
snmp-agent configure checks the number of directors in the local cluster and configures
the VPLEX SNMP agent on the VPLEX management server. Statistics can be retrieved from
all directors in the local cluster.

Note: All the directors have to be operational and reachable through the VPLEX
management server before the SNMP agent is configured.
When configuration is complete, the VPLEX snmp-agent starts automatically.

The VPLEX SNMP agent:

◆ Supports retrieval of performance-related statistics as published in the
VPLEX-MIB.mib.

snmp-agent configure 429

VPLEX CLI Command Descriptions

◆ Runs on the management server and fetches performance related data from individual
directors using a firmware specific interface.
◆ Provides SNMP MIB data for directors for the local cluster only.
◆ Runs on Port 161 of the management server and uses the UDP protocol.
◆ Supports the following SNMP commands:
• SNMP Get
• SNMP Get Next
• SNMP get Bulk
The SNMP Set command is not supported in this release.
VPLEX supports SNMP version snmpv2c.
VPLEX MIBs are located on the management server in the /opt/emc/VPlex/mibs directory.
Use the public IP address of the VPLEX management server to retrieve performance
statistics using SNMP.

Example VPlexcli:/> snmp-agent configure

The community string is already configured to be: private.
Choosing to continue will change the existing community string.

Do you want to continue? (yes/no)yes

What community string should the agent use? [private]: public

VPlexcli:/>

See also ◆ snmp-agent start

◆ snmp-agent status
◆ snmp-agent stop
◆ snmp-agent unconfigure

snmp-agent start
Starts the SNMP agent service.

Contexts All contexts.

Syntax snmp-agent start

Description Starts the SNMP agent on the local cluster.

The SNMP agent must be configured before this command can be used.

Example VPlexcli:/> snmp-agent start

SNMP agent has been started.

See also ◆ snmp-agent configure

◆ snmp-agent status
◆ snmp-agent stop

430 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ snmp-agent unconfigure

snmp-agent status
Displays the SNMP agent service on the local cluster.

Contexts All contexts.

Syntax snmp-agent status

Description Displays the status of the SNMP agent on the local cluster.

Example SNMP agent is running:

VPlexcli:/> snmp-agent status
SNMP Agent Service status is: Running

SNMP agent is not configured (not running):

VPlexcli:/> snmp-agent status
SNMP Agent Service status is: Unconfigured

See also ◆ snmp-agent configure

◆ snmp-agent start
◆ snmp-agent stop
◆ snmp-agent unconfigure

snmp-agent stop
Stops the SNMP agent service.

Contexts All contexts.

Syntax snmp-agent stop

Description Stops the SNMP agent on the local cluster.

The SNMP agent must be configured before this command can be used.

Example VPlexcli:/> snmp-agent stop

SNMP agent has been stopped.

See also ◆ snmp-agent configure

◆ snmp-agent start
◆ snmp-agent status
◆ snmp-agent unconfigure

snmp-agent unconfigure
Destroys the SNMP agent.

snmp-agent status 431

VPLEX CLI Command Descriptions

Contexts All contexts.

Syntax snmp-agent unconfigure

Description Unconfigures the SNMP agent on the local cluster, and stops the agent.

Example VPlexcli:/> snmp-agent unconfigure

SNMP agent has been unconfigured.

See also ◆ snmp-agent configure

◆ snmp-agent start
◆ snmp-agent status
◆ snmp-agent stop

source
Reads and executes commands from a script.

Contexts All contexts.

Syntax source
[-f|--file] filename

Arguments Required arguments

[-f| --file] filename - * Name of the script file to read and execute.
* - argument is positional.

Description Filenames use the syntax of the underlying platform.

The script file may contain any CLI commands.
If the exit command is included, the shell exits immediately, without processing the
commands that follow it in the file.

Example In the following example, a text file Source.txt contains only two commands:
service@ManagementServer:/var/log/VPlex/cli> cat Source.txt
version -a
exit
When executed:
The first command in the file is run
The exit command exits the command shell
VPlexcli:/> source --file /var/log/VPlex/cli/Source.txt
What Version Info
---------------------------------------------- -------------- ----
Product Version 4.1.0.00.00.12 -
SMSv2 0.16.15.0.0 -
Mgmt Server Base D4_MSB_7 -
Mgmt Server Software D4.70.0.9 -
/engines/engine-2-1/directors/Cluster_2_Dir_1B 1.2.43.9.0 -
/engines/engine-2-1/directors/Cluster_2_Dir_1A 1.2.43.9.0 -
/engines/engine-1-1/directors/Cluster_1_Dir1B 1.2.43.9.0 -
/engines/engine-1-1/directors/Cluster_1_Dir1A 1.2.43.9.0 -
/engines/engine-2-2/directors/Cluster_2_Dir_2B 1.2.43.9.0 -
/engines/engine-2-2/directors/Cluster_2_Dir_2A 1.2.43.9.0 -

Connection closed by foreign host.

service@ManagementServer:~>

432 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

See also ◆ script

storage-tool compose
Creates a virtual-volume on top of the specified storage-volumes, building all intermediate
extents, local, and distributed devices as necessary.

Contexts All contexts.

Syntax storage-tool compose

[-n|--name] name
[-g|--geometry] {raid-0|raid-1|raid-c}
[-d|--storage-volumes] storage-volume [, storage-volume...]
[-m|--source-mirror] source-mirror
[-c|--consistency-group] consistency-group context path
[-v|--storage-views] storage-view context path [, storage-view
context path...]
[-h|--help]
[--verbose]

Arguments Required arguments

[-n|--name] name - * Specifies the name for the new virtual volume. Must be unique across
the system.
[-g|--geometry] {raid-0|raid-1|raid-c} - * Specifies the desired geometry to use for the local
devices at each cluster. Valid values are raid-0, raid-1, or raid-c.
[-d|--storage-volumes] storage-volume [, storage-volume...] - * Specifies a list of storage
volumes from which to build the virtual volume. These may be claimed, but must be
unused.

Optional arguments
[-m|--source-mirror] source-mirror - Specifies the storage volume to use as a source mirror
when creating local and distributed devices.

Note: If specified, --source-mirror will be used as a source-mirror when creating local and
distributed RAID 1 devices. This will trigger a rebuild from the source-mirror to all other
mirrors of the RAID 1 device (local and distributed). While the rebuild is in progress the
new virtual volume (and supporting local and/or distributed devices) will be in a degraded
state, which is normal. This option only applies to RAID 1 local or distributed devices. The
--source-mirror may also appear in --storage-volumes.

[-c|--consistency-group] consistency-group context path - Specifies a consistency-group to

which the new virtual-volume should be added. The new virtual-volume’s global geometry
must be compatible with the consistency-group’s storage-at-clusters attribute.
[-v|--storage-views] storage-view context path [, storage-view context path...] - Specifies
the storage-views to which the new virtual-volume will be added. The new virtual-volume’s
global geometry must be compatible with the storage-view’s locality.
[-h|--help] - Displays command line help.
[--verbose] - Provides more help during command execution. This may not have any effect
for some commands.
* - argument is positional.

storage-tool compose 433

VPLEX CLI Command Descriptions

Description This command supports building local or distributed (i.e., DR1-based) virtual volumes
with RAID 0, RAID 1, or RAID C local devices. It does not support creating multi-device
storage hierarchies (i.e., a RAID 1 on RAID 0s on RAID Cs).
For RAID 1 local devices, a maximum of eight legs may be specified.
If the new virtual-volume’s global geometry is not compatible with the specified
consistency-group or storage-views, the virtual-volume will not be created. However,
failure to add the new virtual-volume to the specified consistency-group or storage-views
does not constitute an overall failure to create the storage and will not be reported as
such.

Note: In the event of an error, the command will not attempt to perform a roll-back and
destroy any intermediate storage objects it has created. If cleanup is necessary, use the
show-use-hierarchy command on each storage-volume to identify all residual objects and
delete each one manually.

Example Create a virtual volume with RAID 1 local devices and specified storage volumes:
VPlexcli:/> storage-tool compose --name TEST --geometry raid-1 --storage-volumes
VPD83T3:60060160cea33000fc39e04dac48e211, VPD83T3:60060160cea33000fb9c532eac48e211,
VPD83T3:600601605a903000f2a9692fa548e211, VPD83T3:600601605a903000f3a9692fa548e211

See also ◆ storage-volume unclaim

◆ virtual-volume provision

storage-volume auto-unbanish-interval
Displays or changes auto-unbanish interval on a single director.

Contexts All contexts.

In /clusters/cluster/storage-elements/storage-volumes context, command is
auto-unbanish-interval.

Syntax storage-volume auto-unbanish-interval

[-n|--director] context path
[-i|--interval] [seconds]

Arguments Required arguments

[-n|--director] context path - * The director on which to show or change the delay for
automatic unbanishment.

Optional arguments
[-i|--interval] [ seconds] - Number of seconds the director firmware waits before
unbanishing a banished storage-volume (LUN).
Range: 20 seconds - no upper limit.
Default: 30 seconds.
* - argument is positional.

Description See “Banished storage volumes (LUNs)” in the storage-volume unbanish command
description.

434 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

At regular intervals, the VPLEX directors looks for logical units that were previously
banished. If VPLEX finds banished logical units, it unbanishes them. This process
happens automatically and continuously, and includes a delay interval with a default
value of 30 seconds.
Every 30 seconds the process looks for previously banished logical units and unbanishes
any it finds.
Use this command to display and/or change the delay interval.

Note: This change in the interval value is not saved between restarts of the director
firmware (NDU, director reboots). When the director firmware is restarted, the interval
value is reset to the default of 30 seconds.

Use the auto-unbanish-interval --director director command to display the current delay
(in seconds) for automatic unbanishment on the specified director.
Use the auto-unbanish-interval --director director --interval interval command to change
the delay timer for the specified director to the specified number of seconds.
The default metric for setting the --interval argument is seconds, but minutes and hours,
and days are accepted. The following are valid values for the --interval argument: 2s,
2second, 2seconds, 2sec, 2min, 2minute, 2minutes, 2hr, 2hours, 2hour.

Note: The interval is displayed in seconds.

Example In the following example:

◆ The auto-unbanish-interval --director director --interval interval command changes the
delay timer to 200 seconds.
◆ The auto-unbanish-interval --director director command displays the new setting.
VPlexcli:/> storage-volume auto-unbanish-interval --director director-1-1-A --interval 200

VPlexcli:/> storage-volume auto-unbanish-interval --director director-1-1-A

200 seconds

See also ◆ storage-volume list-banished

◆ storage-volume unbanished

storage-volume claim
Claims the specified storage volumes.

Contexts All contexts.

In /clusters/cluster/storage-elements/storage-volumes context, command is claim.

Syntax storage-volume claim

[--appc]
[-n|--name] new name
--thin-rebuild
--batch-size integer]
[-d|--storage-volumes] context path,context path...

storage-volume claim 435

VPLEX CLI Command Descriptions

[-f|--force]

Arguments Required arguments

[-d|--storage-volumes] context path,context path... - * List of one or more storage volumes
to claim.

Optional arguments
[--appc] - Make the specified storage volumes application consistent. Prevents data
already on the specified storage volumes from being deleted or overwritten during the
process of constructing a virtual volume.
After a virtual volume is constructed using this storage volume, there is no restriction on
the access to the data, i.e. the data can be overwritten by host I/O.



The application consistent attribute may be modified using the “set” command but only
when the storage-volume is in the claimed state. The application consistent attribute
may not be altered for storage volumes that are unclaimed or in use.

[-n|--name] new name - The new name of the storage-volume after it is claimed.
--thin-rebuild - Claims the specified storage volumes as “thin”. Thin storage allocates
blocks of data on demand versus allocating all the blocks up front.
If a storage volume has already been claimed, it can be designated as thin using the set
command.
--batch-size integer - When using wildcards to claim multiple volumes with one command,
the maximum number of storage volumes to claim at once.
[-f|--force] - Force the storage-volume to be claimed. For use with non-interactive scripts.
* - argument is positional.

Description A storage volume is a device or LUN that is visible to VPLEX. The capacity of storage
volumes is used to create extents, devices and virtual volumes.
Storage volumes must be claimed, and optionally named before they can be used in a
VPLEX cluster. Once claimed, the storage volume can be used as a single extent occupying
the volume’s entire capacity, or divided into multiple extents (up to 128).
This command can fail if there is not a sufficient number of meta volume slots. See the
troubleshooting section of the VPLEX procedures in the SolVe Desktop for a resolution to
this problem.

Thin provisioning
Thin provisioning allows storage to migrate onto a thinly provisioned storage volumes
while allocating the minimal amount of thin storage container capacity.
Thinly provisioned storage volumes can be incorporated into RAID 1 mirrors with similar
consumption of thin storage container capacity.

436 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

VPLEX preserves the unallocated thin pool space of the target storage volume by detecting
zeroed data content before writing, and suppressing the write for cases where it would
cause an unnecessary allocation. VPLEX requires the user to specify thin provisioning for
each back-end storage volume. If a storage volume is thinly provisioned, the thin-rebuild
attribute must be to true either during or after claiming.



If a thinly provisioned storage volume contains non-zero data before being connected to
VPLEX, the performance of the migration or initial RAID 1 rebuild is adversely affected.
System volumes are supported on thinly provisioned LUNs, but these volumes must have
their full capacity of thin storage container resources set aside and not be in competition
for this space with any user-data volumes on the same pool.

If:
◆ The thin storage allocation pool runs out of space, and
◆ If this is the last redundant leg of the RAID 1,
further writing to a thinly provisioned device causes the volume to lose access to the
device, a DU.

Example In the following example:

◆ The ll command in storage-volumes context displays the available storage.
◆ The claim command claims the specified unclaimed storage volume from the
clusters/cluster/storage-elements/storage-volumes context.
VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes>ll
.
.

VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes>claim --storage-volumes
VPD83T3:6006016021d025007029e95b2327df11

Example Claim a storage volume and name it Symm1254_7BF from the clusters/cluster context:
VPlexcli:/clusters/cluster-1> storage-volume claim -name Symm1254_7BF -d
VPD83T3:60000970000192601254533030374241

Example Claim storage volumes using the --thin-rebuild option. In the following example:
◆ The claim command with --thin-rebuild claims two storage volumes as thin storage
(from the clusters/cluster/storage-elements/storage-volumes context)
◆ The ll command displays one of the claimed storage volumes:

storage-volume claim 437

VPLEX CLI Command Descriptions

VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes> claim --thin-rebuild

--storage-volumes
VPD83T3:6006016091c50e005057534d0c17e011,VPD83T3:6006016091c50e005257534d0c17e011
Of the 2 storage-volumes that were given, 2 storage-volumes were claimed.

VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes> ll
VPD83T3:6006016091c50e005057534d0c17e011

/clusters/cluster-1/storage-elements/storage-volumes/VPD83T3:6006016091c50e005057534d0c17e011
:
Name Value
---------------------- -------------------------------------------------------
application-consistent false
block-count 524288
block-size 4K
capacity 2G
description -
free-chunks ['0-524287']
health-indications []
health-state ok
io-status alive
itls 0x5000144230354911/0x5006016930600523/6,
0x5000144230354910/0x5006016930600523/6,
0x5000144230354910/0x5006016830600523/6,
0x5000144230354911/0x5006016830600523/6,
0x5000144220354910/0x5006016930600523/6,
0x5000144220354910/0x5006016830600523/6,
0x5000144220354911/0x5006016930600523/6,
0x5000144220354911/0x5006016830600523/6
largest-free-chunk 2G
locality -
operational-status ok
storage-array-name EMC-CLARiiON-APM00042201310
storage-volumetype normal
system-id VPD83T3:6006016091c50e005057534d0c17e011
thin-rebuild true
total-free-space 2G
use claimed
used-by []
vendor-specific-name DGC

Example Claim multiple storage volumes whose names begin with VPD83T3:600601602:
VPlexcli:/clusters/cluster-1> storage-volume claim --storage-volumes VPD83T3:600601602*

See also ◆ set

◆ storage-volume claimingwizard
◆ storage-volume unclaim

storage-volume claimingwizard
Finds unclaimed storage volumes, claims them, and names them appropriately.

Contexts All contexts.

In /clusters/cluster/storage-elements/storage-volumes context, command is
claimingwizard.

438 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Syntax storage-volume claimingwizard

[-c|--cluster] cluster
[-f|--file] file,file...
[-d|--dryRun]
[-t|--set-tier] list
[--force]
--appc
--thin-rebuild

Arguments Optional arguments

[-c|--cluster] cluster - Cluster on which to claim storage.
[-f|--file] file,file... - List of one or more files containing hints for storage-volume naming,
separated by commas. Required for claiming volumes on storage arrays that do not
include their array and serial number in response to SCSI inquiries.
[-d|dryRun] - Do a dry-run only, do not claim and name the storage volumes.
[-t|--set-tier] list - Set a storage tier identifier per storage array in the storage-volume
names. Type multiple arrayName, tier-character pairs separated by commas. Storage tier
identifiers cannot contain underscores.
[--force] - Forces a successful run of the claimingwizard. For use with non-interactive
scripts.
--appc - Make the specified storage volumes 'application consistent'. Prevents data
already on the specified storage volume from being deleted or overwritten.



Once set, the application consistent attribute cannot be changed. This attribute can only
be set when the storage- volumes/extents are in the claimed state.

--thin-rebuild - Claims the specified storage volumes as “thin”. Thin storage allocates
blocks of data on demand versus allocating all the blocks up front. Thin provisioning
eliminates almost all unused storage and improves utilization rates.

Description Storage volumes must be claimed, and optionally named before they can be used in a
VPLEX cluster.
Storage tiers allow the administrator to manage arrays based on price, performance,
capacity and other attributes. If a tier ID is assigned, the storage with a specified tier ID
can be managed as a single unit. Storage volumes without a tier assignment are assigned
a value of ‘no tier’.
This command can fail if there is not a sufficient number of meta volume slots. See the
troubleshooting section of the VPLEX procedures in the SolVe Desktop for a resolution to
this problem.

Example Use the --set-tier argument to add or change a storage tier identifier in the storage-volume
names from a given storage array. For example:
VPlexcli:/clusters/cluster-1> storage-volume claimingwizard --set-tier ="(Clar0400, L),
(Symm04A1, H)"

names all storage volumes from the CLARiiON array as Clar0400L_<lun name>, and all
storage volumes from the Symmetrix® array as Symm04A1H_<lun name>

storage-volume claimingwizard 439

VPLEX CLI Command Descriptions

EMC Symmetrix, HDS 9970/9980 and USP V storage arrays include their array and serial
number in response to SCSI inquiries. The claiming wizard can claim their storage volumes
without additional information. Names are assigned automatically.
Other storage arrays require a hints file generated by the storage administrator using the
array’s command line. The hints file contains the device names and their World Wide
Names.
Use the --file argument to specify a hints file to use for naming claimed storage volumes.
The following table lists examples to create hint files:

Table 21 Create hints files for storage-volume naming

Storage array Command to create hints file

EMC CLARiiON navicli -h 192.168.47.27 getlun -uid -name > Clar0400.txt

EMC Symmetrix symdev -sid 781 list -wwn > Symm0781.txt

EMC VPLEX export storage-view map -f EMC_PROD12.txt -v <views>

IBM DS4300 SMcli 192.168.97.121 -c "show logicalDrives;" > DS4300_121.txt

IBM Nextra xcli -c nextra_lab -x vol_list > Nextra_lab.txt

HP EVA sssu "select manager <hostname> username=<username>

password=<password>" "select
system <systemname> "ls vdisk full" > <filename.txt>

Generic Text file of the following format:

> Generic storage-volumes
> VPD83T3:600a0b800011ea0a000073c5468cedbd MyName1
> 600a0b800011ea0a000073c5468cedbc MyName2
> vpd83t3:600A0b800011EA0a000073c5468cEdbD MyName3
For generic storage volumes, names may include letters, numbers, and '_'.

Example In the following example, the claimingwizard command with no arguments claims storage
volumes from an EMC Symmetrix array:
VPlexcli:/clusters/cluster-1> storage-volume claimingwizard
VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes> ll

Name VPD83 ID Capacity Use Vendor IO Type Thin

---------------------------------------- ---------------------------------------- -------- --------- ------- Status --------------
Rebuild
---------------------------------------- ---------------------------------------- -------- --------- ------- ------ -------------- ------
-
Symm2773_05F3 VPD83T3:60000970000192602773533030354633 10G claimed EMC alive normal false
Symm2773_05F4 VPD83T3:60000970000192602773533030354634 10G claimed EMC alive normal false
Symm2773_05F5 VPD83T3:60000970000192602773533030354635 10G claimed EMC alive normal false
Symm2773_05F6 VPD83T3:60000970000192602773533030354636 10G claimed EMC alive normal false
Symm2773_05F7 VPD83T3:60000970000192602773533030354637 10G claimed EMC alive normal false
Symm2773_05F8 VPD83T3:60000970000192602773533030354638 10G claimed EMC alive normal false
Symm2773_05F9 VPD83T3:60000970000192602773533030354639 10G claimed EMC alive normal false

Note that the Symmetrix storage volumes are named in the format:
Symm<last 4 digits of array serial number>_<Symmetrix Device Number>

Example In the following example:

◆ The --cluster argument specifies cluster-1

440 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ The --file argument specifies a CLARiiON hints file containing device names and World
Wide Names
◆ The --thin-rebuild argument claims the specified storage volumes as “thin” (data will
be allocated on demand versus up front)
VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes> claimingwizard --cluster
cluster-1 --file /home/service/clar.txt --thin-rebuild
Found unclaimed storage-volume VPD83T3:6006016091c50e004f57534d0c17e011 vendor DGC : claiming
and naming clar_LUN82.

Found unclaimed storage-volume VPD83T3:6006016091c50e005157534d0c17e011 vendor DGC : claiming

and naming clar_LUN84.

Claimed 2 storage-volumes in storage array clar

Claimed 2 storage-volumes in total.

Example Find and claim storage volumes on any array in cluster-1 that does not require a hints file
from the /clusters/cluster/storage-elements/storage-volumes context:
VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes> claimingwizard

Found unclaimed storage-volume VPD83T1:HITACHI R45150040023 vendor HITACHI : claiming and

naming HDS20816_0023.

Found unclaimed storage-volume VPD83T1:HITACHI R45150040024 vendor HITACHI : claiming and

naming HDS20816_0024.
.
.
.
Fri, 20 May 2011 16:38:14 +0000 Progress : 6/101 storage_volumes processed (6%).
.
.
.
Fri, 20 May 2011 16:38:14 +0000 Progress : 96/101 storage_volumes processed (96%).
.
.
.
Claimed 37 storage-volumes in storage array Symm0487

Claimed 64 storage-volumes in storage array HDS20816

Claimed 101 storage-volumes in total.

See also ◆ storage-volume claim

◆ storage-volume unclaim

storage-volume find-array
Searches storage arrays for the specified storage-volumes.

Contexts All contexts.

In /clusters/cluster/storage-elements/storage-volumes context, command is find-array.

Syntax storage-volume find-array

[-d|--opt_s_vol] storage-volume

storage-volume find-array 441

VPLEX CLI Command Descriptions

Arguments Required arguments

[-d|--opt_s_vol] storage-volume - * Storage volume pattern for which to search.
The pattern conforms to 'glob'.
The following pattern symbols are supported: *, ?, [seq], [!seq].
* argument is positional.

Description Searches all the storage arrays in all clusters for the specified storage-volumes.
The search is case-sensitive.

Example Find all storage arrays for storage volumes in cluster-1:

VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes> find-array *
Searching for cluster-1_journal
Storage-volume: cluster-1_journal is in:
/clusters/cluster-1/storage-elements/storage-arrays/EMC-Invista-14403b
Searching for cluster-1_journal_1
Storage-volume: cluster-1_journal_1 is in:
/clusters/cluster-1/storage-elements/storage-arrays/EMC-Invista-14403b
Searching for CLAR1912_10G_Aleve_1_vol_1
Storage-volume: CLAR1912_10G_Aleve_1_vol_1 is in:
/clusters/cluster-1/storage-elements/storage-arrays/EMC-CLARiiON-APM00111501912
Searching for CLAR1912_10G_Aleve_1_vol_2
Storage-volume: CLAR1912_10G_Aleve_1_vol_2 is in:
/clusters/cluster-1/storage-elements/storage-arrays/EMC-CLARiiON-APM00111501912
.
.
.

Example Find a storage array for a specified storage-volume:

VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes> find-array -d
VPD83T3:60060160d2a02c00ff3b1abb99e3e011
Searching for VPD83T3:60060160d2a02c00ff3b1abb99e3e011
Storage-volume: VPD83T3:60060160d2a02c00ff3b1abb99e3e011 is in:
/clusters/cluster-1/storage-elements/storage-arrays/EMC-CLARiiON-APM00111402062

OR

VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes> find-array --opt_s_vol

VPD83T3:60060160d2a02c00ff3b1abb99e3e011
Searching for VPD83T3:60060160d2a02c00ff3b1abb99e3e011
Storage-volume: VPD83T3:60060160d2a02c00ff3b1abb99e3e011 is in:
/clusters/cluster-1/storage-elements/storage-arrays/EMC-CLARiiON-APM00111402062

See also ◆ storage-volume claimingwizard

storage-volume forget
Tells the cluster that a storage-volume or a set of storage volumes are physically removed.

Contexts All contexts.

In /clusters/cluster/storage-elements/storage-volumes context, command is forget.

Syntax storage-volume forget

[-d|--storage-volumes] context path

442 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Required arguments

[-d|--storage-volumes] context path, context-path...- * List of one or more storage volumes
to forget.
* - argument is positional.

Description Storage-volumes can be remembered even if a cluster is not currently in contact with
them. Use this command to tell the cluster that the storage-volumes are not coming back
and therefore it is safe to forget about them.
Storage volumes can only be forgotten if they are unclaimed or unusable, and
unreachable.
This command also forgets the logical-unit for this storage-volume.
Use the storage-volume forget command to tell the cluster that unclaimed and
unreachable storage volumes are not coming back and it is safe to forget them.
Forgotten storage volumes are removed from the context tree.
Use the --verbose argument to print a message for each volume that could not be
forgotten.
Use the logical-unit forget command for the functionality supported by the removed
arguments.

Example Forget a specified storage volume:

VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes> forget --storage-volume
VPD83T3:6006016021d0250027b925ff60b5de11

Example Forget all unclaimed, unused, and unreachable storage volume on the cluster:
VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes> storage-volume forget *
3 storage-volumes were forgotten.

Example Use the --verbose argument to display detailed information while you forget all unclaimed,
unused, and unreachable storage volumes on the cluster:
VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes> storage-volume forget *
--verbose
WARNING: Error forgetting storage-volume 'VPD83T3:60000970000192602773533030353933': The 'use'
property of storage-volume VPD83T3:60000970000192602773533030353933' is 'meta-data' but must
be 'unclaimed' or 'unusable' before it can be forgotten.
.
.
.
3 storage-volumes were forgotten:
VPD83T3:6006016030802100e405a642ed16e111
.
.

See also ◆ logical-unit forget

◆ storage-volume unclaim

storage-volume list-banished
Displays banished storage-volumes on a director.

storage-volume list-banished 443

VPLEX CLI Command Descriptions

Contexts All contexts.

In /clusters/cluster/storage-elements/storage-volumes context, command is
list-banished.

Syntax storage-volume list-banished

[-n|--director] context path

Arguments Required arguments

[-n|--director] context path - *The director whose banished storage-volumes to display.

Description Displays the names of storage-volumes that are currently banished for a given director.

See “Banished storage volumes (LUNs)” in the storage-volume unbanish command

description.

Example In the following example; director-1-1-A has one banished storage-volume:

VPlexcli:/> storage-volume list-banished --director director-1-1-A
There is 1 banished storage-volume on director 'director-1-1-A':
Symm0487_0C1B

See also ◆ storage-volume auto-unbanish-interval

◆ storage-volume unbanish

storage-volume resurrect
Resurrect the specified storage-volumes.

Contexts All contexts.

In /clusters/cluster/storage-elements/storage-volumes context, command is resurrect.

Syntax storage-volume resurrect

[-d|--storage-volume] context path,context path...
[-f|--force]

Arguments Required arguments

[-d|--storage-volume] context path,context path... - List of one or more storage volume with
dead I/O status to resurrect.

Optional arguments
[-f|--force] - Force the storage-volume resurrect and bypass the test.

Description Resurrects the specified dead storage volumes and tests the resurrected device before
setting its state to healthy.
A storage-volume is declared dead:
◆ After VPLEX retries a failed I/O to the backend arrays 20 times without success.
◆ If the storage-volume is reachable but errors prevent the I/O from succeeding.
A storage volume declared hardware dead cannot be unclaimed or removed (forgotten).
Use this command to resurrect the storage volume. After the storage volume is
resurrected, it can be unclaimed and removed.

444 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

IMPORTANT
Fix the root cause before resurrecting a storage volume because the volume can be
successfully resurrected only to go back to dead on the next I/O.

Note: This command will not work if the storage volume is marked unreachable.

This command has no ill effects if issued for a healthy storage volume.
LUNs exported from storage arrays can disappear or display I/O errors for various reasons,
including:
◆ Marked read-only during copies initiated by the storage array
◆ Unrecoverable device errors
◆ Snapshot activation/deactivation on the storage array
◆ An operator shrinks the size of a storage-volume, causing the VPLEX to refuse to do
I/O to the storage-volume.
◆ 100% allocated thin pools
◆ Persistent reservation on storage volume
◆ Dropped frames due to bad cable or SFP
Dead storage volumes are indicated by:
• The cluster summary command shows degraded health-state and one or more
unhealthy storage volumes. For example:
VPlexcli:/clusters/cluster-2/> cluster status
Cluster cluster-2
operational-status: ok
transitioning-indications:
transitioning-progress:
health-state: degraded
health-indications: 1 unhealthy Devices or storage-volumes

◆ The storage-volume summary command shows the I/O status of the volume as dead.
For example:
VPlexcli:/> storage-volume summary
SUMMARY (cluster-1)
StorageVolume Name IO Status Operational Status Health State
------------------------ --------- ------------------ ----------------
dead_volume dead error critical-failure

Symptom:
Storage-volume is dead

Example Resurrect two storage volumes:

VPlexcli:/> storage-volume resurrect --storage-volumes Symm1852_BAC,Symm1852_BA8

See also ◆ cluster status

◆ storage-volume forget
◆ storage-volume summary

storage-volume resurrect 445

VPLEX CLI Command Descriptions

storage-volume summary
Displays a list of a cluster's storage volumes.

Contexts All contexts.

In /clusters/cluster/storage-elements/storage-volumes context, command is summary.

Syntax storage-volume summary

[-c|--clusters] cluster,cluster...
Optional arguments
[-c|--clusters] cluster,cluster... - Displays storage volumes for only the specified clusters.

Description Displays a two-part summary for each cluster's storage volumes:

◆ I/O status, operational status, and health state for each unhealthy storage volume.
◆ Summary of health-state, vendor, use, and total capacity for the cluster.
Use the -clusters argument to restrict output to only the specified clusters.
If no argument is used, and the command is executed at or below a /clusters/cluster
context, output is for the specified cluster only.
Otherwise, output is for all clusters.

Example Display default summary (all clusters) on a VPLEX with unhealthy volumes:
VPlexcli:/> storage-volume summary

SUMMARY (cluster-1)
StorageVolume Name IO Status Operational Status Health State
---------------------------------------- ----------- ------------------ ----------------
Clar0106_LUN14 alive degraded degraded

Storage-Volume Summary (no tier)

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

Health out-of-date 0
storage-volumes 363
unhealthy 1

Vendor DGC 114

EMC 248
None 1

Use meta-data 4
unusable 0
used 358

Capacity total 2T

SUMMARY (cluster-2)
Storage-Volume Summary (no tier)
---------------------- --------------------
Health out-of-date 0
storage-volumes 362
unhealthy 0
Vendor DGC 114
EMC 248

Use meta-data 4
used 358

446 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Capacity total 1.99T

Example Display summary for only cluster-1 on a VPLEX with unhealthy volumes:
VPlexcli:/> storage-volume summary --clusters cluster-1
StorageVolume Name IO Status Operational Status Health State
------------------ ----------- ------------------ ----------------
Log1723_154 unreachable error critical-failure
Log1852_154 unreachable error critical-failure
Meta1723_150 unreachable error critical-failure
Meta1852_150 unreachable error critical-failure
Symm1378_0150 unreachable error critical-failure
Symm1378_0154 unreachable error critical-failure
.
.
Storage-Volume Summary (no tier)
---------------------- --------------------

Health out-of-date 0
storage-volumes 981
unhealthy 966

Vendor DGC 15
None 966

Use claimed 824

meta-data 1
unclaimed 11
unusable 143
used 2

Capacity total 16T

When slot usage reaches 90%, this command also displays the following:
Meta Slots total 64000
reclaimable 9600
used 57600
storage-volumes 8000
extents 24000
logging-segments 25600

Example Display summary for both clusters in a VPLEX with no unhealthy storage volumes:
VPlexcli:/> storage-volume summary
SUMMARY (cluster-1)
Storage-Volume Summary (no tier)
---------------------- ---------------------

Health out-of-date 0
storage-volumes 2318
unhealthy 0

Vendor EMC 2318

Use claimed 2172

meta-data 2
used 144

Capacity total 198T

SUMMARY (cluster-2)
Storage-Volume Summary (no tier)
---------------------- ---------------------

storage-volume summary 447

VPLEX CLI Command Descriptions

Health out-of-date 0
storage-volumes 2318
unhealthy 0

Vendor EMC 2318

Use claimed 2172

meta-data 2
used 144

Capacity total 198T

Table 22 storage-volume summary field descriptions (page 1 of 2)

Field Description

Health summary (displayed only for unhealthy storage volumes)

Name Name of storage volume.

I/O Status alive - I/O is proceeding normally on the storage volume.

dead - VPLEX has marked the storage volume as dead; I/O cannot proceed on the storage
volume. This can happen when a certain number of I/Os to the storage volume fails.
unreachable - The storage volume is unreachable.

Operational ok - The storage volume is functioning normally.

Status degraded - The storage volume may be out-of-date compared to its mirror. (This state
applies only to a storage volume that is part of a RAID 1 Metadata Volume.)
unknown - VPLEX cannot determine the storage volume's Operational state, or the state is
invalid.
error - VPLEX has marked the storage volume as hardware-dead.
starting - The storage volume is not yet ready.
lost communication - The storage volume is unreachable.

Health State degraded - The extent may be out-of-date compared to its mirror (applies only to extents
that are part of a RAID 1 device).
ok - The extent is functioning normally.
non-recoverable-error - The extent may be out-of-date compared to its mirror (applies only
to extents that are part of a RAID 1 device), and/or the Health state cannot be determined.
unknown - VPLEX cannot determine the extent's Operational state, or the state is invalid.
critical failure - VPLEX has marked the storage volume as hardware-dead.

Storage-Volume Summary

out-of-date Of the total number of storage volumes on the cluster, the number that are out-of-date
compared to their mirror.

storage-volumes Total number of storage volumes on the cluster.

unhealthy Of the total number of storage volumes on the cluster, the number with health state that is
not “ok”.

Vendor Of the total number of storage volumes on the cluster, the number from the specified
vendor.

claimed Of the total number of storage volumes on the cluster, the number that are claimed.

meta-data Of the total number of storage volumes on the cluster, the number in use as meta-volumes.

unclaimed Of the total number of storage volumes on the cluster, the number that are unclaimed.

448 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Table 22 storage-volume summary field descriptions (page 2 of 2)

Field Description

used Of the total number of storage volumes on the cluster, the number that are in use.

Capacity Total capacity of all storage on the cluster.

Meta Slots Total - The total slots used.

reclaimable - The number of slots that can be reclaimed.
used - The number of slots that are used.
storage-volume - The number of slots used for storage volumes.
extents - The number of slots used for extents.
logging-segments - The number of slots used for logging segments.

See also ◆ ds summary

◆ ds dd set-log
◆ export port summary
◆ export storage-view summary
◆ extent summary
◆ local-device summary
◆ storage-volume resurrect
◆ virtual-volume provision

storage-volume unbanish
Unbanishes a storage-volume on one or more directors.

Contexts All contexts.

In /clusters/cluster/storage-elements/storage-volumes context, command is unbanish.

Syntax storage-volume unbanish

[-n|--directors] context path,context path...
[-d|--storage-volume] context path

Arguments Required arguments

[-n|--directors] context path,context path,... - * The directors on which to unbanish the
given storage-volume.

Optional arguments
[-d|--storage-volume] - The storage-volume to unbanish.
This argument is not required if the current context is a storage-volume or below. If the
current context is a storage-volume or below, it operates on that storage volume.
* - argument is positional.

Description VPLEX examines path state information for LUNs on arrays. If the path state information is
inconsistent, VPLEX banishes the LUN, and makes it inaccessible.

storage-volume unbanish 449

VPLEX CLI Command Descriptions

Use this command to unbanish a banished LUN (storage volume).

Banished storage volumes (LUNs)

LUNs (storage volumes) are banished when VPLEX detects an unexpected configuration of
array controllers and/or paths to arrays. Under normal active/passive operation, one
controller for any given LUN is active, the other is passive.
If the path to the active controller fails, the passive path transitions to active. The
transition must wait for the failed active controller to drain its pending I/Os. This transient
state may be seen during disk replacement, hot sparing, and disk failure.
If VPLEX detects a LUN in this state, VPLEX waits 20 seconds for the LUN to return to
normal. If the LUN does not return to the expected state, VPLEX banishes the LUN.

Example In the following example:

◆ The list-banished command shows a volume is banished from director 1-1-A
◆ The unbanish command unbanishes the volume.
◆ The list-banished command shows the change:
VPlexcli:/> storage-volume list-banished --director director-1-1-A
There is 1 banished storage-volume on director 'director-1-1-A':
Symm0487_0C1B

VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes/Symm0487_0C1B> storage-volume
unbanish --director director-1-1-A
director-1-1-A Unbanished.

VPlexcli:/clusters/cluster-1/storage-elements/storage-volumes/Symm0487_0C1B> storage-volume
list-banished --director director-1-1-A
There are no banished storage-volumes on director 'director-1-1-A'.

See also ◆ storage-volume auto-unbanish-interval

◆ storage-volume list-banished

storage-volume unclaim
Unclaims the specified previously claimed storage volumes.

Contexts All contexts.

In /clusters/cluster/storage-elements/storage-volumes context, command is unclaim.

Syntax storage-volume unclaim

[-b|--batch-size] integer
[-d|--storage-volumes] context path,context path...
[-r|--return-to-pool]

Arguments Required arguments

[-d|--storage-volumes] context path, context path... - * Specifies the storage volumes to
unclaim.

Optional arguments
[-b|--batch-size] integer - Specifies the maximum number of storage volumes to unclaim at
once.

450 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

[-r|--return-to-pool] - Returns the storage capacity of each VIAS-based volume to the pool
on the corresponding storage-array.
* - argument is positional.

Description Use the storage-volume unclaim command to return the specified storage volumes to the
unclaimed state.
The target storage volume must not be in use.

Note: When the storage-volume unclaim command is used with VIAS based and non VIAS
based storage volumes the result of the command will be different. VIAS based virtual
volumes will be removed from VPLEX they will no longer be visible. Non VIAS based
storage volumes will be marked as unclaimed. This is the intended behavior.

Unclaim a “thin” storage volume

When a storage-volume is unclaimed, the thin-rebuild attribute is set to false.

Note: The thin-rebuild attribute can only be modified for storage volumes that are either
claimed or used. When the unclaimed storage-volume is claimed and its state is claimed
or used, use the set command to modify the thin-rebuild attribute.

Example In the following example:

◆ The ll command in storage-volumes context displays storage volumes, including their
use state,
◆ The storage-volume unclaim command unclaims two claimed volumes:
VPlexcli:/clusters/cluster-2/storage-elements/storage-volumes> ll

VPlexcli:/clusters/cluster-2/storage-elements/storage-volumes> unclaim -d
Basic_c1_ramdisk_100GB_686_

See also ◆ set

◆ storage-volume claim

storage-volume used-by
Displays the components that use the specified storage volumes.

Contexts All contexts.

storage-volume used-by 451

VPLEX CLI Command Descriptions

In /clusters/cluster/storage-elements/storage-volumes context, command is used-by.

Syntax storage-volume used-by

[-d|--storage-volumes] context path,context path...

Arguments Required arguments

[-d|--storage-volumes] context path,context path... - * List of one or more storage volumes
for which to find users.

Description To manually deconstruct an encapsulated storage volume, remove each layer starting from
the top.
Use the storage-volume used-by command to see the layers from the bottom up.

Example VPlexcli:/clusters/cluster-2/storage-elements/storage-volumes> used-by

CX4_lun0
/clusters/cluster-1/devices/base0:
extent_CX4_lun0_1
CX4_lun0

/clusters/cluster-1/devices/base1:
extent_CX4_lun0_2
CX4_lun0

/clusters/cluster-1/devices/base2:
extent_CX4_lun0_3
CX4_lun0

/clusters/cluster-1/devices/base3:
extent_CX4_lun0_4
CX4_lun0

/clusters/cluster-1/storage-elements/extents/extent_CX4_lun0_5:
CX4_lun0

/clusters/cluster-1/storage-elements/extents/extent_CX4_lun0_6:
CX4_lun0

subnet clear
Clears one or more attributes of an existing subnet configuration.

Contexts All contexts.

Syntax subnet clear

[-s|--subnet] subnet
[-a|--attribute] attribute

Arguments Required arguments

[-s|--subnet] subnet - * The subnet configuration to modify.

Optional arguments
[-a|--attribute] attribute - * The name of the attribute to modify.
* argument is positional

Description Clears (sets to null) one or more of the following attributes of an existing subnet
configuration:

452 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ cluster-address
◆ gateway
◆ prefix

IMPORTANT
Use the subnet modify command to configure new values for the attributes.

Example In the following example:

◆ The ll command displays a subnet’s attributes.
◆ The subnet clear command clears (sets to null) the cluster-address attribute.
◆ The subnet modify command configures a new cluster-address.
◆ The ll command displays the new configuration:
VPlexcli:/clusters/cluster-1/cluster-connectivity/subnets/cluster-1-SN01> ll
Name Value
---------------------- --------------------------
cluster-address 192.168.12.200
gateway 192.168.12.1
mtu 9000
prefix 192.168.12.0:255.255.255.0
proxy-external-address -
remote-subnet-address 192.168.22.0:255.255.255.0

VPlexcli:/clusters/cluster-1/cluster-connectivity/subnets/cluster-1-SN01> clear
cluster-address

VPlexcli:/clusters/cluster-1/cluster-connectivity/subnets/cluster-1-SN01> ll
Name Value
---------------------- --------------------------
cluster-address -
gateway 192.168.12.1
mtu 9000
prefix 192.168.12.0:255.255.255.0
proxy-external-address -
remote-subnet-address 192.168.22.0:255.255.255.0

VPlexcli:/clusters/cluster-1/cluster-connectivity/subnets/cluster-1-SN01> subnet modify

cluster-address 192.168.10.200

VPlexcli:/clusters/cluster-1/cluster-connectivity/subnets/cluster-1-SN01> ll
Name Value
---------------------- --------------------------
cluster-address 192.168.10.200
gateway 192.168.12.1
mtu 9000
prefix 192.168.12.0:255.255.255.0
proxy-external-address -
remote-subnet-address 192.168.22.0:255.255.255.0

See also ◆ subnet create

◆ subnet destroy
◆ subnet modify

subnet clear 453

VPLEX CLI Command Descriptions

subnet create
Creates a new subnet.

Contexts All contexts.

In /clusters/cluster-1/cluster-connectivity/subnets context, command is create.

Syntax subnet create

[-n|--name] subnet name
[-c|--cluster] cluster
[-a|--cluster-address] address
[-g|--gateway] IP address
[-m|--mtu] size
[-p|--prefix] prefix
[-e|--proxy-external-address] address
[-r|--remote-subnet-address] remote subnet address

Arguments Required arguments

[-n|--name] subnet name - * The name of the subnet to create.

Optional arguments
[-c|--cluster] cluster - Context path of the target owner cluster.
[-a|--cluster-address] address - The public address of the cluster to which this subnet
belongs.
[-g|--gateway] IP address - The gateway address for this subnet.
[-m|--mtu] size - The maximum Transfer Unit size for this subnet.
Range - An integer between 96 and 9000.



The VPLEX CLI accepts MTU values lower than 96, but they are not supported.
Entering a value less than 96 prevents the port-group from operating.

[-p|--prefix] prefix - The prefix/subnet mask for this subnet. Specified as an IP address and
subnet mask in integer dot notation, separated by a colon. For example,
192.168.20.0/255.255.255.0
[-e|--proxy-external-address] address - The externally published cluster address for this
subnet. Can be one of:
◆ w.x.y.z where w,x,y,z are [0..255] - Configures the specified IP address. For example:
10.0.1.125.
◆ empty - Clears any configured IP address.
[-r|--remote-subnet-address] address - The [destination IP]:[netmask] subnet in the remote
cluster that is reachable from the local subnet. Can be one of:
◆ w.x.y.z where w,x,y,z are [0..255] - Configures the specified IP address. For example:
172.16.2.0/255.255.255.0.
◆ empty - Clears any configured IP address
* argument is positional.

454 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Description Creates a new subnet configuration.

Example Create a subnet from the cluster-connectivity/subnet context:

VPlexcli:/clusters/cluster-1/cluster-connectivity/subnets> create --name TestSubNet --cluster
cluster-1 --gateway 192.168.10.1 --prefix 192.168.10.0/255.255.255.0

Subnet was created at '/clusters/cluster-1/cluster-connectivity/subnets/TestSubNet'.

VPlexcli:/clusters/cluster-1/cluster-connectivity/subnets> ll TestSubNet

/clusters/cluster-1/cluster-connectivity/subnets/TestSubNet:
Name Value
---------------------- --------------------------
cluster-address -
gateway 192.168.10.1
mtu 1500
prefix 192.168.10.0/255.255.255.0
proxy-external-address -
remote-subnet-address -

See also ◆ subnet clear

◆ subnet destroy
◆ subnet modify

subnet destroy
Destroys a subnet configuration.

Contexts All contexts.

Syntax subnet destroy

[-s|--subnet] subnet
--force

Arguments Required arguments

[-s|--subnet] subnet - * Context path of the subnet configuration to destroy.

Optional arguments
--force - Forces the subnet configuration to be destroyed without asking for confirmation.
Allows this command to be run from non-interactive scripts.
* argument is positional

Description Destroys the specified subnet configuration.

This command fails if the specified subnet is currently assigned to any port or port-group.

Example Destroy a subnet from the /cluster-connectivity/subnets context:

VPlexcli:/clusters/cluster-2/cluster-connectivity/subnets> subnet destroy --subnet TestSubnet

Example Destroy a subnet from the root context:

VPlexcli:> subnet destroy /clusters/cluster-2/cluster-connectivity/subnets/TestSubnet

See also ◆ subnet clear

subnet destroy 455

VPLEX CLI Command Descriptions

◆ subnet create
◆ subnet modify

subnet modify
Modifies an existing subnet configuration.

Contexts All contexts.

Syntax subnet modify

[-s|--subnet] subnet
[-a|--cluster-address] address
[-g|--gateway] IP address
[-p|--prefix] prefix

Arguments Required arguments

[-s|--subnet] subnet - * Context path of the subnet configuration to modify.

Optional arguments
[-a|--cluster-address] address - The public address of the cluster to which this subnet
belongs.
[-g|--gateway] IP address - The gateway address for this subnet.
[-p|--prefix] prefix - The prefix/subnet mask for this subnet. Specified as an IP address and
subnet mask in integer dot notation, separated by a colon. For example,
192.168.20.0/255.255.255.0



If the prefix is changed, ensure that the cluster IP address, gateway address, and port IP
addresses are all consistent with the subnet prefix.

* argument is positional.

Description Modifies one or more of the following attributes of an existing subnet configuration:
◆ cluster-address
◆ gateway
◆ prefix

Example Modify a subnet’s prefix:

VPlexcli:/clusters/cluster-1/cluster-connectivity/subnets/cluster-1-SN01> subnet modify
--prefix 192.168.20.0/255.255.255.0

Example Modify a subnet’s public IP address:

VPlexcli:/clusters/cluster-1/cluster-connectivity/subnets/cluster-1-SN01> subnet modify
--cluster-address 192.168.12.200

See also ◆ subnet clear

◆ subnet create
◆ subnet destroy

456 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

syrcollect
Collects system configuration data for System Reporting (SYR).

Contexts All contexts.

Syntax syrcollect
[-d|--directory] directory

Arguments Optional arguments

[-d|--directory] directory - Non-default directory in which to store the output. Files saved in
the non-default directory are not automatically sent to EMC.
Default: Files are stored in the Event_Msg_Folder in the directory specified in the
EmaAdaptorConfig.properties file.
EmaAdaptorConfig.properties and the Event_Msg_Folder are located in /opt/emc/VPlex
on the management server.
Files in the default directory are automatically sent to EMC.

Description Manually starts a collection of SYR data, and optionally sends the resulting zip file to EMC.
Run this command after every major configuration change or upgrade.
Data collected includes:
◆ VPLEX information
◆ RecoverPoint information (if RecoverPoint is configured)
◆ Cluster information
◆ Engine/chassis information
◆ RAID information
◆ Port information
◆ Back end storage information
The output of the command is a zipped xml file named:
<VPLEXTLA>_Config_<TimeStamp>.zip.
in the specified output directory.
Files in the default directory are automatically sent to EMC.
Use the --directory argument to specify a non-default directory. Output files sent to a
non-default directory are not automatically sent to EMC.

Example Start an SYR data collection, and send the output to EMC:
VPlexcli:/> syrcollect

Example Start an SYR data collection, and send the output to the specified directory:
VPlexcli:/> syrcollect -d /var/log/VPlex/cli

syrcollect 457
VPLEX CLI Command Descriptions

See also ◆ scheduleSYR add

◆ scheduleSYR list
◆ scheduleSYR remove

tree
Displays the context tree.

Contexts All contexts.

Syntax tree
[-e|--expand]
[-c|--context] subcontext root
[-s|--select] glob pattern

Arguments Optional arguments

[-e|--expand] - Expand the subcontexts.
[-c|--context] subcontext root - The subcontext to use as the root for
the tree.
[-s|--select] glob pattern - Glob pattern for selecting the contexts in
the tree.

Description Displays the sub-context tree.

Use the tree command with no arguments to display the sub context tree from the current
context.
Use the --context subcontext root to display the sub context tree from the specified
subcontext.
Use the --expand argument to expand the sub-contexts if applicable.
Use the --select glob pattern argument to display contexts in the specified sub-tree that
match the glob pattern. The glob pattern may match more contexts that are outside the
given sub-tree.

Example Display contexts below the current context:

VPlexcli:/management-server> tree
/management-server:
ports
eth0
eth1
eth2
eth3

Display contexts below the specified context:

VPlexcli:/> tree --context /clusters/cluster-1/devices/dev_sym1723_1FC
/clusters/cluster-1/devices/dev_sym1723_1FC:
components
extent_Symm1723_1FC_1
components
Symm1723_1FC
components

See also ◆ drill-down

458 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ set

unalias
Removes a command alias.

Contexts All contexts.

Syntax unalias
[-n|--name] name
[-a|--all]

Arguments Optional arguments

[-n|--name] name - The name of the alias to remove.
[-a|--all] - Remove all defined aliases.

Example In the following example:

◆ alias displays a list of all aliases on the VPLEX
◆ unalias deletes the specified alias
◆ alias confirms the deletion:
VPlexcli:/> alias
Name Description
------------ -------------------------------------------
? Substitutes the 'help' command.
GoToDir_2_2A Substitutes the 'cd
/engines/engine-2-2/directors/Cluster_2_Dir_2A' command.
ll Substitutes the 'ls -al' command.
quit Substitutes the 'exit' command.

VPlexcli:/> unalias GoToDir_2_2A

VPlexcli:/> alias
Name Description
---- ---------------------------------
? Substitutes the 'help' command.
ll Substitutes the 'ls -al' command.
quit Substitutes the 'exit' command.

See also ◆ alias

user add
Adds a username to the VPLEX management server.

Contexts All contexts.

Syntax user add

[-u|--username] username

Arguments Required arguments

[-u|--username] username - Username to add.

Description Administrator privileges are required to execute the user add command.

unalias 459
VPLEX CLI Command Descriptions

VPLEX has two pre-configured CLI users that can not be removed: admin and service.

Note: In VPLEX Metro and Geo configuration, VPLEX CLI accounts created on one
management server are not propagated to the second management server. The user list
command displays only those accounts configured on the local management server, not
both server.

Note: Administrative privileges are required to add, delete, and reset user accounts. The
password for the admin account must be reset the first time the admin account is
accessed. After the admin password has been reset, the admin user can manage (add,
delete, reset) user accounts.

To change the password for the admin account, ssh to the management server as user
“admin”. Enter the default password teS6nAX2. A prompt to change the admin account
password appears. Enter a new password.

Example Login to the CLI as an Administrator user.

At the CLI prompt, type the user add username command:
VPlexcli:/> user add -u TestUser

A prompt for the Administrator password appears:

admin password:

Type the password for the Administrator username.

A prompt for the new password for the username being added appears:
New password:

Type the password for the new username.

A prompt to confirm the password appears:
Confirm password:

Re-type the password.

Type the user list command to verify the new username is added:

VPlexcli:/> user list

Username
--------
admin
service
TestUser

See also ◆ user event-server change-password

◆ user passwd
◆ user remove
◆ user reset

460 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

user event-server add-user

Adds a user name to the event server.

Contexts User context.

Syntax user event-server add-user

[-u|--username] username
[-h|--help]
[--verbose]

Arguments Required arguments

[-u|--username] username - * Specifies the user name to add in the event server.

Optional arguments
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.
* - argument is positional.

Description Used to add a user to the event server to access VPLEX events.

Example Add a user to the event server:

VPlexcli:/> user event-server add-user -u temp1

Enter the new password:

Confirm new password:

The username "temp1" was successfully added in the event-server.

See also ◆ user event-server change-password

user event-server change-password

Changes the password for a user accessing the event server.

Contexts User context.

Syntax user event-server change-password

[-u|--username]username
[-h|--help]
[--verbose]

Arguments Required arguments

[-u|--username] username - * Specifies the user name for which to change the password.

Optional arguments
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.
* - argument is positional.

user event-server add-user 461

VPLEX CLI Command Descriptions

Description Used to change the password that the external subscribers use to access VPLEX events.

Example An event-server user changes the default password:

VPlexcli:/> user event-server change-password -u temp1

Enter current password:

Enter the new password:

Confirm new password:

See also ◆ user event-server add-user

user list
Displays usernames configured on the local VPLEX management server.

Contexts All contexts.

Syntax user list

Description Displays the configured usernames.

Note: In VPLEX Metro and Geo configuration, VPLEX CLI accounts created on one
management server are not propagated to the second management server. The user list
command displays only those accounts configured on the local management server, not
both servers.

Example Display the user accounts configured on the local management server:
VPlexcli:/> user list
Username
--------
admin
service
TestUser

See also ◆ user add

◆ user passwd
◆ user remove
◆ user reset

user passwd
Allows a user to change the password for their own username.

Contexts All contexts.

Syntax user passwd

[-u|--username] username

462 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Required arguments

[-u|--username] username - *Username for which to change the password.
* - argument is positional.

Description Executable by all users to change the password only for their own username.

Example VPlexcli:/> user passwd -u TestUser

A prompt for the current password appears:

old password:

Type the current password for the username.

A prompt for the new password appears:
New password:

Type the new password. Passwords must be at least 8 characters long, and must not be
dictionary words.
A prompt to confirm the new password appears:
Confirm password:

Retype the new password.

See also ◆ user add

◆ user event-server change-password
◆ user remove
◆ user reset

user remove
Removes a username from the VPLEX management server.

Contexts All contexts.

Syntax user remove

[-u|--username] username

Arguments Required arguments

[-u|--username] username - Username to remove.

Description Administrator privileges are required to execute the user remove command.

Note: Administrative privileges are required to add, delete, and reset user accounts. The
password for the admin account must be reset the first time the admin account is
accessed. After the admin password has been reset, the admin user can manage (add,
delete, reset) user accounts.

user remove 463

VPLEX CLI Command Descriptions

To change the password for the admin account, ssh to the management server as user
“admin”. Enter the default password teS6nAX2. A prompt to change the admin account
password appears. Enter a new password.

Example Login as an Administrator user.

Type the user remove username command:
VPlexcli:/> user remove -u TestUser

A prompt for the Administrator password appears:

admin password:

Type the password for the Administrator username.

The specified user username is removed.
Type the user event-server change-password command to verify the removal.

See also ◆ user add

◆ user event-server change-password
◆ user passwd
◆ user reset

user reset
Allows an Administrator user to reset the password for any username.

Contexts All contexts.

Syntax user reset

[-u|--username] username

Arguments Required arguments

[-u|--username] username - The username whose password is to be reset.

Description Resets the password for any username.

Administrator privileges are required.

Note: Administrative privileges are required to add, delete, and reset user accounts. The
password for the admin account must be reset the first time the admin account is
accessed. After the admin password has been reset, the admin user can manage (add,
delete, reset) user accounts.

To change the password for the admin account, ssh to the management server as user
“admin”. Enter the default password teS6nAX2. A prompt to change the admin account
password appears. Enter a new password.

All users can change the password for their own account using the user passwd command.

Example Login as an Administrator user.

464 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Type the user reset --username username command:

VPlexcli:/> user reset --username TestUser

A prompt for the Administrator password appears:

admin password:

Type the password for the Administrator username.

A prompt for new password for the username being reset appears:
New password:

Type a new password for the username.

A prompt to confirm the new password appears:
Confirm password:

Re-type the new password.

See also ◆ user add

◆ user event-server change-password
◆ user passwd
◆ user remove

validate-system-configuration
Performs a basic system configuration check.

Contexts All contexts.

Syntax validate-system-configuration

Description This command performs the following checks:

◆ Validates cache mirroring.
◆ Validates the logging volume.
◆ Validates the meta-volume.
◆ Validates back-end connectivity.

Example Validate system configuration:

VPlexcli:/> validate-system-configuration
Validate cache replication
Checking cluster cluster-1 ...
rmg component not found skipping the validation of cache replication.
ok

Validate logging volume

No errors found
ok

Validate back-end connectivity

Cluster cluster-2
0 storage-volumes which are dead or unreachable.

validate-system-configuration 465
VPLEX CLI Command Descriptions

0 storage-volumes which do not meet the high availability

requirement for storage volume paths*.
0 storage-volumes which are not visible from all directors.

*To meet the high availability requirement for storage volume paths
each storage volume must be accessible from each of the directors
through 2 or more VPlex backend ports, and 2 or more Array target
ports, and there should be 2 or more ITLs.
Cluster cluster-1
10 storage-volumes which are dead or unreachable.
0 storage-volumes which do not meet the high availability
requirement for storage volume paths*.
0 storage-volumes which are not visible from all directors.

*To meet the high availability requirement for storage volume paths
each storage volume must be accessible from each of the directors
through 2 or more VPlex backend ports, and 2 or more Array target
ports, and there should be 2 or more ITLs.
Errors were encountered in the back-end connectivity. Please run
'connectivity validate-be -d' for details.

Validate meta-volume
Checking cluster cluster-1 ...
Checking cluster cluster-2 ...
ok

See also ◆ cluster status

◆ connectivity validate-be
◆ health-check

vault go
Initiates a manual vault on every director in a given cluster under emergency conditions.

Contexts All contexts.

Syntax vault go
[-c|--cluster] cluster
[--force]

Arguments [-c|--cluster] cluster - Specify the cluster on which to start cache vaulting.
[--force] - Force the operation to continue without confirmation. Allows this command to be
run from non-interactive scripts.

Description Use this command to initiate a manual dump from every director in a given cluster to
persistent local storage under emergency conditions.
Use this command to manually start cache vaulting if an emergency shutdown is required
and the storage administrator cannot wait for automatic vaulting to begin.

Example Start a manual vault on cluster-1:

VPlexcli:/> vault go --cluster cluster-1

See also ◆ vault overrideUnvaultQuorum

◆ vault status
◆ EMC VPLEX Administration Guide

466 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

vault overrideUnvaultQuorum
Allows the cluster to proceed with the recovery of the vaults without all the required
directors.

Contexts All contexts.

Syntax vault overrideUnvaultQuorum

[-c|--cluster] cluster
--evaluate-override-before-execution
--force

Arguments [-c|--cluster] cluster - Overrides unvault quorum for the specified cluster.
--evaluate-override-before-execution - Evaluates the possible outcome of running this
command but does not do anything.
--force - Force the operation to continue without confirmation. Allows this command to be
run from non-interactive scripts.

Description


This command could result in data loss.

Use this command to tell the cluster not to wait for all the required director(s) to rejoin the
cluster before proceeding with vault recovery.
Use this command with the --evaluate-override-before-execution argument to evaluate the
cluster's vault status and make a decision whether to accept a possible data loss and
continue to bring the cluster up. The evaluation provides information as to whether the
cluster has sufficient vaults to proceed with the vault recovery that will not lead to data
loss.

Note: One valid vault can be missing without experiencing data loss.

Example Evaluate vault quorum

In the following example, the --evaluate-override-before-execution argument evaluates
the cluster's unvault quorum state in the following circumstances:
◆ Three directors in a dual engine configuration booted and joined the cluster.
◆ None of these directors have a valid vault.
◆ The cluster is waiting for the remaining director to join the cluster before unvault
recovery quorum is established.
VPlexcli:/> vault overrideUnvaultQuorum --evaluate-override-before-execution -c cluster-1
Cluster's unvault recovery quorum status:
Only 3 out of 4 configured directors on this cluster are running, and none has reported a
valid vault.
All configured directors must be present to verify if any director has successfully vaulted
dirty data the last time the cluster was servicing I/O.
Missing directors in the cluster: director-1-1-A

vault overrideUnvaultQuorum 467

VPLEX CLI Command Descriptions

Example Override unvault quorum wait state (no valid vaults)

In the following example, the command overrides the unvault quorum wait state in the
following circumstances:
◆ None of the operational directors have valid vaults
◆ One director is not operational
VPlexcli:/> vault overrideUnvaultQuorum -c cluster-1
Warning: Execution of this command can result in possible data loss based on the current vault
status of the cluster.
Cluster's unvault recovery quorum status:
Only 3 out of 4 configured directors on this cluster are running, and none has reported a valid
vault.
All configured directors must be present to verify if any director has successfully vaulted
dirty data the last time the cluster was servicing I/O.
Missing directors in the cluster: director-1-1-A

Do you wish to override unvault quorum? (Yes/No) No

Execution of the override unvault quorum has been canceled by user!

Example Override unvault quorum wait state (3 of 4 valid vaults)

In the following example, the command overrides the unvault quorum wait state in the
following circumstances:
◆ Three of four configured directors are operational and have valid vaults
◆ One director is not operational
VPlexcli:/> vault overrideUnvaultQuorum -c cluster-1
Warning: Execution of this command can result in possible data loss based on the current vault
status of the cluster.
Cluster's unvault recovery quorum status:
3 out of 4 directors that were servicing I/O the last time the cluster had vaulted are present,
which is sufficient to proceed with vault recovery.

Do you wish to override unvault quorum? (Yes/No) Yes

Execution of the override unvault quorum has been issued!

Example Override unvault quorum wait state (2 of 4 valid vaults)

In the following example, the command evaluates the cluster vault status and overrides
the unvault quorum when:
◆ Three of four configured directors are operational
◆ Two operational directors have valid vaults
VPlexcli:/> vault overrideUnvaultQuorum -c cluster-1

Warning: Execution of this command can result in possible data loss based on the current vault
status of the cluster.

Cluster's unvault quorum status:

Only 2 out of 4 directors that were servicing I/O the last time the cluster had vaulted are
present, which is insufficient to proceed with vault recovery.
Number of directors reporting a valid vault in the cluster: 2
Number of directors reporting an invalid vault in the cluster: 1
Missing directors in the cluster: director-1-2-B

Do you wish to override unvault quorum? (Yes/No) No

Execution of the override unvault quorum has been canceled by the user!!

468 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

See also ◆ vault go

◆ vault status
◆ EMC VPLEX Administration Guide
◆ The VPLEX procedures in the SolVe Desktop

vault status
Displays the current cache vault/unvault status of the cluster.

Contexts All contexts.

Syntax vault status

[-c|--cluster] cluster

Arguments Optional arguments

[-c|--cluster] cluster -Displays vault status for the specified cluster.
--verbose - Displays additional description and data.

Description Cache vaulting safeguards dirty data during power outages. Cache vaulting dumps all dirty
data to persistent local storage. Vaulted data is recovered (unvaulted) when power is
restored.
This command always displays the cluster’s vault state and the vault state of each of the
cluster’s directors.
When run after a vault has begun and the vault state is Vault Writing or Vault Written, the
following information is displayed:
◆ Total number of bytes to be vaulted in the cluster
◆ Estimated time to completion for the vault
When run after the directors have booted and unvaulting has begun and the states are
Unvaulting or Unvault Complete, the following information is displayed:
◆ Total number of bytes to be unvaulted in the cluster
◆ Estimated time to completion for the unvault
◆ Percent of bytes remaining to be unvaulted
◆ Number of bytes remaining to be unvaulted
If you enter the --verbose argument, the command displays the following information:
◆ Average vault or unvault rate.
If this command is run after the directors have booted, unvaulted, and are waiting to
acquire an unvault quorum:
◆ The state is Unvault Quorum Waiting.
◆ The output displays a list of directors that are preventing the cluster from gaining
unvault quorum.
If the --verbose argument is used, the following additional information is displayed:

vault status 469

VPLEX CLI Command Descriptions

◆ Vaulted data is valid or invalid.

◆ Required number of directors to proceed with the recovery of vault.
◆ Number of directors missing and preventing the cluster from proceeding with the
recovery of vault.

Table 23 Vault state field descriptions

Vault State Description

Vault Inactive Vault/Unvault is not in progress.

Power Loss Detected Power loss has been detected. Waiting for power to be restored.

Power Loss Confirmed Power did not get restored.

Power Restored Power has been restored.

Vault Requested Initial vault request has been received.

Stop I/O The director is stopping all I/O.

Vault Writing Dirty data is being written to local persistent storage.

Vault Written Dirty data has been written to local persistent storage.

Unvaulting Vaulted dirty data is being read from local persistent storage.

Unvault Complete All vaulted dirty data has been read from local persistent storage.

Unvault Quorum Waiting Waiting on all director(s) required before proceeding with the recovery of the vault.

Vault Recovering Recovering all the vaulted dirty data to VPLEX global cache from the local director's
memory.

Example Display the summarized status for a cluster that is not currently vaulting or unvaulting:
VPlexcli:/> vault status --cluster cluster-1

================================================================================
Cluster level vault status summary
================================================================================
Cluster:/clusters/cluster-1
Cluster is not vaulting/unvaulting.
================================================================================
Director level summary
================================================================================
/engines/engine-1-1/directors/director-1-1-B:
state: Vault Inactive
/engines/engine-1-1/directors/director-1-1-A:
state: Vault Inactive

Example Display detailed status when a cluster is vaulting:

VPlexcli:/> vault status -c cluster-2 --verbose
================================================================================
Cluster level vault status summary
================================================================================
Cluster:/clusters/cluster-2
Cluster is vaulting
Total number of bytes remaining to vault in the cluster: 1.104809984 GB
Estimated time remaining for cluster's vault completion: 10 seconds
================================================================================
Director level vault status summary
================================================================================
/engines/engine-2-1/directors/director-2-1-B:

470 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

state: Vaulting - Writing vault data to vault disk

Total number of bytes to vault: 566.403072 MB
Total number of bytes vaulted: 8.220672 MB
Total number of bytes remaining to vault: 558.182400 MB
Percent vaulted: 1%
Average vault rate: 54.050816 MB/second
Estimated time remaining to vault complete: 10 seconds
/engines/engine-2-1/directors/director-2-1-A:
state: Vaulting - Writing vault data to vault disk
Total number of bytes to vault: 554.848256 MB
Total number of bytes vaulted: 8.220672 MB
Total number of bytes remaining to vault: 546.627584 MB
Percent vaulted: 1%
Average vault rate: 51.875840 MB/second
Estimated time remaining to vault complete: 10 seconds

Example Display detailed information when a cluster is un-vaulting:

VPlexcli:/> vault status -c cluster-2 --verbose

================================================================================
Cluster level unvault status summary
================================================================================
Cluster:/clusters/cluster-2
Cluster is unvaulting.
Total number of bytes remaining to unvault in the cluster: 583.499776 MB
Estimated time remaining for cluster's unvault completion: 24 seconds
================================================================================
Director level unvault status summary
================================================================================
/engines/engine-2-1/directors/director-2-1-B:
state: Unvaulting - Reading vaulted data from vault in to the local
director's memory
Total number of bytes to unvault: 566.403072 MB
Total number of bytes unvaulted: 289.505280 MB
Total number of bytes remaining to unvault: 276.897792 MB
Percent unvaulted: 51%
Average unvault rate: 14.471168 MB/second
Estimated time remaining to unvault complete: 19 seconds
/engines/engine-2-1/directors/director-2-1-A:
state: Unvaulting - Reading vaulted data from vault in to the local
director's memory
Total number of bytes to unvault: 554.848256 MB
Total number of bytes unvaulted: 248.246272 MB
Total number of bytes remaining to unvault: 306.601984 MB
Percent unvaulted: 44%
Average unvault rate: 12.410880 MB/second
Estimated time remaining to unvault complete: 24 seconds

Example Display when a cluster is waiting to acquire an unvault quorum:

VPlexcli:/> vault status -c cluster-1 --verbose

================================================================================
Cluster level summary
================================================================================
Cluster:/clusters/cluster-1
Cluster is waiting on all director(s) required before proceeding with the recovery of vault
Number of directors required to be present before cluster can proceed with the recovery
of the vault : 4
Number of directors present with valid vaults: 0
Number of directors present with invalid vaults: 3
Number of directors missing and possibly preventing the cluster to proceed with the
recovery of the vault : 1
Missing directors: director-1-1-A

vault status 471

VPLEX CLI Command Descriptions

================================================================================
Director level summary
================================================================================
/engines/engine-1-1/directors/director-1-1-B:
state: Waiting for unvault recovery quorum - Waiting on all director(s) required before
proceeding with the recovery of vault
Vault does not contain any data
Required number of directors to proceed with the recovery of vault: 4
Number of directors preventing the cluster to proceed with the recovery of vault: 1
Missing director list: director-1-1-A
/engines/engine-1-2/directors/director-1-2-B:
state: Waiting for unvault recovery quorum - Waiting on all director(s) required before
proceeding with the recovery of vault
Vault does not contain any data
Required number of directors to proceed with the recovery of vault: 4
Number of directors preventing the cluster to proceed with the recovery of vault: 1
Missing director list: director-1-1-A
/engines/engine-1-2/directors/director-1-2-A:
state: Waiting for unvault recovery quorum - Waiting on all director(s) required before
proceeding with the recovery of vault
Vault does not contain any data
Required number of directors to proceed with the recovery of vault: 4
Number of directors preventing the cluster to proceed with the recovery of vault: 1
Missing director list: director-1-1-A
/engines/engine-1-1/directors/director-1-1-A:
director could not be reached

See also ◆ vault go

◆ vault overrideUnvaultQuorum
◆ EMC VPLEX Administration Guide

verify fibre-channel-switches
Verifies that the Fibre Channel switch on each cluster's internal management network has
been configured correctly.

Contexts /clusters/cluster-n

Syntax verify fibre-channel-switches

Passwords for the service accounts on the switches are required to run this command.

Example Verify the internal management network:

VPlexcli:/clusters/cluster-2> verify fiber-channel-switches

Please enter the service account password for the Management Server:

Re-enter the password:

Please enter the service account password for the fibre channel switch at IP 128.221.252.66:

Re-enter the password:

Executing on the first switch.
This will take a few moments...

Please enter the service account password for the fibre channel switch at IP 128.221.253.66:

Re-enter the password:

Executing on the second switch.

472 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

This will take a few moments...

Both fiber channel switch configurations were successfully verified.

version
Display version information for connected directors.

Contexts All contexts.

Syntax version
[-a|--all]
[-n|directors] context path,context path...
--verbose

Arguments Optional arguments

[-a|--all] - Displays version information for all connected directors.
[-n|--directors] context path, context path... - * Displays version information for only the
specified directors.
--verbose - Displays version information for individual software components on each
director.
* - argument is positional.

Description This command displays version information for all directors, a specified director, or
individual software components for each director.

Example Display management server/SMS version information:

VPlexcli:/> version
What Version Info
-------------------- -------------- ----
Product Version 5.4.0.00.00.10 -
SMSv2 D35.20.0.10.0 -
Mgmt Server Base D35.20.0.1 -
Mgmt Server Software D35.20.0.13 -

Example Display management server/SMS version and version for the specified director:
VPlexcli:/> version director-2-1-B
What Version Info
-------------------------------------------- -------------- ----
Product Version 5.4.0.00.00.10 -
SMSv2 D35.20.0.10.0 -
Mgmt Server Base D35.20.0.1 -
Mgmt Server Software D35.20.0.13 -
/engines/engine-2-1/directors/director-2-1-B 6.5.54.0.0 -

Example Display version information for management server, SMS, and all directors:
VPlexcli:/> version -a
What Version Info
-------------------------------------------- -------------- ----
Product Version 5.4.0.00.00.10 -
SMSv2 D35.20.0.10.0 -
Mgmt Server Base D35.20.0.1 -
Mgmt Server Software D35.20.0.13 -
/engines/engine-2-1/directors/director-2-1-B 6.5.54.0.0 -

version 473
VPLEX CLI Command Descriptions

/engines/engine-2-1/directors/director-2-1-A 6.5.54.0.0 -
/engines/engine-1-1/directors/director-1-1-B 6.5.54.0.0 -
/engines/engine-1-1/directors/director-1-1-A 6.5.54.0.0 -

Example Display version information for individual software components on each director. See
Software components table below for a description of the components.
VPlexcli:/> version -a --verbose
Product Version: 5.4.0.00.00.10

What: SMSv2
Version: D35.20.0.10.0
Build time: June 09, 2014 at 11:38:36PM EDT
Build machine: dudleyed05
Build OS: Linux version 2.6.27-7-generic on amd64
Build compiler: 1.6.0_45
Build source: /spgear/spgear_misc/htdocs/harness/release/1795/work/ui/src

What: Mgmt Server Base

Version: D35.20.0.1

What: Mgmt Server Software

Version: D35.20.0.13

For director /engines/engine-2-1/directors/director-2-1-B:

What: O/S
Version: D35.20.0.1 (SLES11)

What: Director Software

Version: 6.5.54.0.0

What: ECOM
Version: 6.5.1.0.0-0

What: VPLEX Splitter

Version: 4.1.b_vplex_D35_00_Ottawa_MR1.10-1

What: ZECL
Version: 6.5.52.0.0-0

What: ZPEM
Version: 6.5.52.0.0-0

What: NSFW
Version: 65.1.54.0-0

What: BIOS Rev

Version: 08.50

What: POST Rev

Version: 43.80

What: FW Bundle Rev

Version: 12.60

What: SSD Model: P30056-MTFDBAA056SAL 118032803

Version: 0005

For director /engines/engine-2-1/directors/director-2-1-A:

What: O/S

474 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Version: D35.20.0.1 (SLES11)

What: Director Software

Version: 6.5.54.0.0

What: ECOM
Version: 6.5.1.0.0-0

What: VPLEX Splitter

Version: 4.1.b_vplex_D35_00_Ottawa_MR1.10-1

What: ZECL
Version: 6.5.52.0.0-0

What: ZPEM
Version: 6.5.52.0.0-0

What: NSFW
Version: 65.1.54.0-0

What: BIOS Rev

Version: 08.50

What: POST Rev

Version: 43.80

What: FW Bundle Rev

Version: 12.60

What: SSD Model: P30056-MTFDBAA056SAL 118032803

Version: 0005

For director /engines/engine-1-1/directors/director-1-1-B:

What: O/S
Version: D35.20.0.1 (SLES11)

What: Director Software

Version: 6.5.54.0.0

What: ECOM
Version: 6.5.1.0.0-0

What: VPLEX Splitter

Version: 4.1.b_vplex_D35_00_Ottawa_MR1.10-1

What: ZECL
Version: 6.5.52.0.0-0

What: ZPEM
Version: 6.5.52.0.0-0

What: NSFW
Version: 65.1.54.0-0

What: BIOS Rev

Version: 08.50

What: POST Rev

Version: 43.80

What: FW Bundle Rev

Version: 12.60

What: SSD Model: P30056-MTFDBAA056SAL 118032803

Version: 0005

version 475
VPLEX CLI Command Descriptions

For director /engines/engine-1-1/directors/director-1-1-A:

What: O/S
Version: D35.20.0.1 (SLES11)

What: Director Software

Version: 6.5.54.0.0

What: ECOM
Version: 6.5.1.0.0-0

What: VPLEX Splitter

Version: 4.1.b_vplex_D35_00_Ottawa_MR1.10-1

What: ZECL
Version: 6.5.52.0.0-0

What: ZPEM
Version: 6.5.52.0.0-0

What: NSFW
Version: 65.1.54.0-0

What: BIOS Rev

Version: 08.50

What: POST Rev

Version: 43.80

What: FW Bundle Rev

Version: 12.60

What: SSD Model: P30056-MTFDBAA056SAL 118032803

Version: 0005

Table 24 Software components

Component Abbreviation Description

Product Version VPLEX version information.

Mgmt Server Base Novel Linux distribution.

Mgmt Server Software Version of the software on the management server.

Director Operating System Novell Linux distribution.

Cluster Witness Server Version of the Cluster Witness Sever VM.

Software

OS Operating system running on the director.

Director Software Version of the software on the specified director.

ECOM The EMC Common Object Manager is a hub of communications and common
services for applications based on EMC’s Common Management Platform.

VPLEX Splitter RecoverPoint splitter version.

ZECL A kernel module in the director that interfaces with the ZPEM process to
provide, among other things, access to the I2C bus.

476 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Table 24 Software components

Component Abbreviation Description

ZPEM Manages the overall health of the hardware. It includes monitoring of the
various Field Replaceable Units (FRUs), Power and Temperature values and
monitoring of external entities like the Standby Power Supply (SPS), COM FC
Switch and the UPS used to provide backup power to the FC switches.

NSFW VPLEX GeoSynchrony™ software. VPLEX operating system running in the

clusters.

FW Bundle Rev Firmware revision.

POST Rev Power On Self Test revision.

BIOS Rev Boot firmware revision.

SSD Model Solid state disk drive model information.

virtual-volume create
Creates a virtual volume on a host device.

Contexts All contexts.

Syntax virtual-volume create

[-r|--device] context path
[-t|--set-tier] tier]

Arguments Required arguments

[-r|--device] context path - * Device on which to host the virtual volume.

Optional arguments
[-t|--set-tier] - Set the storage-tier for the new virtual volume.
* - argument is positional.

Description A virtual volume is created on a device or a distributed device, and is presented to a host
through a storage view. Virtual volumes are created on top-level devices only, and always
use the full capacity of the device or distributed device.
The underlying storage of a virtual volume may be distributed over multiple storage
volumes, but appears as a single contiguous volume.
The specified device must not already have a virtual volume and must not have a parent
device.
Use the --set-tier argument to set the storage tier for the new virtual volume.

About storage tier IDs

Storage tiers are user-defined classes of storage, usually based on price, performance,
capacity, and other factors. Storage tiers allow administrators to group like arrays so they
can be managed as a unit.
The storage-tier identifier is displayed to the host as part of the virtual volumes’s product
ID.
Use the storage-tier identifier to logically group storage.

virtual-volume create 477

VPLEX CLI Command Descriptions

For example, assign Symmetrix arrays as tier 1 storage, and CLARiiON as tier 2 storage.
Use the ll command in a specific virtual volume’s context to display the current
storage-tier.
Use the set command to modify a virtual volume’s storage-tier.

Example In the following example:

◆ The virtual-volume create command creates a new virtual volume,
◆ The cd command navigates to the new virtual volume’s context,
◆ The ll command displays the new virtual volume:
VPlexcli:/> virtual-volume create --device
/distributed-storage/distributed-devices/dd_vol_1 --set-tier 1

VPlexcli:/clusters/cluster-1/virtual-volumes> cd dd_vol_1

VPlexcli:/clusters/cluster-1/virtual-volumes/dd_vol_1> ll

Name Value
-------------------------- ----------------------------------------
block-count 1310720
block-size 4K
cache-mode synchronous
capacity 5G
consistency-group -
expandable true
expandable-capacity 0B
expansion-method storage-volume
expansion-status -
health-indications []
health-state ok
locality distributed
operational-status ok
recoverpoint-protection-at []
recoverpoint-usage -
scsi-release-delay 0
service-status running
storage-tier -
supporting-device dd_sample1
system-id dd_vol_1
volume-type virtual-volume
vpd-id VPD83T3:6000144000000010f02886e1aa9e6b15

Table 25 virtual-volume field descriptions (page 1 of 3)

Field Description

block count The number of blocks in the volume.

block size The size of a single block, in kilobytes.

cache-mode Indicates whether the volume use synchronous (write-through) or asynchronous

(write-back) IO.

capacity The total number of bytes in the volume. Equals the 'block-size' multiplied by the
'block-count'.

consistency-group The name of the consistency group to which this volume belongs, if any.

478 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Table 25 virtual-volume field descriptions (page 2 of 3)

Field Description

expandable-capaci Excess capacity not yet exposed to the host by the virtual volume. This capacity is
ty available for expanding the virtual volume.
Zero (0) - Expansion is not supported on the virtual volume or that there is no capacity
available for expansion.
Non-zero - The capacity available for virtual volume expansion using the storage-volume
method.

expansion-method The expansion method that can be used to expand the virtual volume.
concatenation - The virtual volume can be expanded only by adding the specified extents.
not-supported - The virtual volume cannot be expanded. This includes virtual volumes that
are members of RecoverPoint consistency groups.
storage-volume - The virtual volume can be expanded using storage array based volume
expansion or by migrating to a larger device.

expansion-status Expansion status for the volume.

- - None of the other expansion states apply. No operation is blocked by this state.
failed - An expansion has failed. The expansion has failed and the expansion must be
re-tried. If the expansion is not retried this state will persist for up-to 2 days. See
health-indications for more information.

Note: When an expansion fails, the overall health, operational-status, or service-status of

the virtual-volume is not degraded.

in-progress - An expansion has been started, but has not completed. The following
operations are blocked on the volume: additional expansion, migration, and NDU.
unknown - VPLEX could not determine the expansion status of the volume.

health-indications Indicates the reasons for a health-state that is not 'ok' or the reasons a volume expansion
failed.

health state major failure - One or more of the virtual volume's underlying devices is out-of-date, but
will never rebuild.
minor failure - One or more of the virtual volume's underlying devices is out-of-date, but
will rebuild.
non-recoverable error - VPLEX cannot determine the virtual volume's Health state.
ok - The virtual volume is functioning normally.
unknown -VPLEX cannot determine the virtual volume's Health state, or the state is invalid.

locality local - The virtual volume relies completely on storage at its containing cluster.
remote - The virtual volume is a proxy for a volume whose storage resides at a different
cluster. I/O to a remote virtual volume travels between clusters.
distributed - The virtual volume is the cluster-local representation of a distributed RAID-1.
Writes to a distributed volume travels to all the clusters at which it has storage; reads
come, if possible, from the local leg.

operational status degraded - The virtual volume may have one or more out-of-date devices that will
eventually rebuild.
error - One or more of the virtual volume's underlying devices is hardware-dead.
ok - The virtual volume is functioning normally.
starting -The virtual volume is not yet ready.
stressed - One or more of the virtual volume's underlying devices is out-of-date and will
never rebuild.
unknown - VPLEX cannot determine the virtual volume's Operational state, or the state is
invalid.

recoverpoint-protec The list of VPLEX cluster names at which virtual volumes are protected by RecoverPoint. For
tion-at MetroPoint protected VPLEX volumes, this field will contain the names of both VPLEX
clusters, indicating protection at both sites.

virtual-volume create 479

VPLEX CLI Command Descriptions

Table 25 virtual-volume field descriptions (page 3 of 3)

Field Description

recoverpoint-usage The replication role this virtual-volume is being used for by attached RecoverPoint clusters,
if any.
Production Source - Volumes that are written to by the host applications. Writes to
production volumes are split such that they are sent to both the normally designated
volumes and RPAs
Local Replica - Local volumes to which production volumes replicate.
Remote Replica - remote volumes to which production volumes replicate
Journal - Volumes that contain data waiting to be distributed to target replica volumes and
copies of the data previously distributed to the target volumes.
Repository - A volume dedicated to RecoverPoint for each RPA cluster that stores
configuration information about the RPAs and RecoverPoint consistency groups.
- The volume is not currently being used by RecoverPoint.

scsi-release-delay A SCSI release delay time in milliseconds. Optimum value is 0 to 2 seconds. Setting a very
high value could break the SCSI semantics. If another reserve arrives at this cluster within
this time frame, neither release nor reserve will be sent across the WAN.

service-status The service status of a virtual-volume.

running - I/O is running for the virtual-volume.
inactive - The virtual-volume is part of an inactive storage-view and is not visible from the
host.
unexported- The virtual-volume is unexported.
suspended - I/O is suspended for the virtual-volume.
cluster-unreachable - Cluster is unreachable at this time.
need-resume - Issue re-attach to resume after link has returned.
disconnected - Applies to distributed volumes used with RecoverPoint as replica volumes,
or in production failure scenarios. It will clear when the volume is no longer used as a
RecoverPoint replica, or after production failback is complete.

storage-tier The storage-tier for the virtual-volume.

supporting-device The local, remote, or distributed-device underlying this virtual volume.

system-id The internal system ID for the storage.

volume-type Always virtual-volume.

vpd-id The VPD identifier for the virtual volume.

See also ◆ virtual-volume destroy

◆ virtual-volume expand
◆ virtual-volume provision

virtual-volume destroy
Destroys existing virtual volumes.

Contexts All contexts.

Syntax virtual-volume destroy

[-v|--virtual-volumes] context path,context path...
[-f|--force]

480 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Arguments Required arguments

[-v|--virtual-volumes] context path, context path... - List of one or more virtual volumes to
destroy. Entries must be separated by commas. The specified virtual volumes must not be
exported to hosts.

Optional arguments
[-f|--force] - Forces the destruction of the virtual volumes without asking for confirmation.
Allows this command to be run from non-interactive scripts.

Description Deletes the virtual volume and leaves the underlying structure intact. The data on the
volume is no longer accessible.
Only unexported virtual volumes can be deleted. To delete an exported virtual volume,
first remove the volume from the storage view.

Example VPlexcli:/clusters/cluster-1> virtual-volume destroy -v

was_1_leg_r1_vol/

WARNING: The following items will be destroyed:

Context
-----------------------------------------------------
/clusters/cluster-1/virtual-volumes/was_1_leg_r1_vol
Do you wish to proceed? (Yes/No) y

See also ◆ virtual-volume create

◆ virtual-volume expand
◆ virtual-volume provision

virtual-volume expand
Non-disruptively increases the capacity of an existing virtual volume.

Contexts All contexts.

In clusters/cluster/virtual-volumes/context and below, command is expand.

Syntax virtual-volume expand

[-v|--virtual-volume] context path
[-e|--extent] extent
[-f|--force]

Arguments Required arguments

[-v|--virtual-volume] context path - * The virtual volume to expand.
◆ For both storage-volume and concatenation methods of expansion, the virtual-volume
must be expandable, and have a geometry of RAID 1, RAID C, or RAID 0.
◆ For storage-volume expansions, the virtual-volume must be expandable, and have a
geometry of RAID 1, RAID C, RAID 0, or DR1.

Optional arguments
[-e|--extent] context path - * The target local device or extent to add to the virtual-volume
using the concatenation method of expansion. The local device or extent must not have a
virtual-volume on top of it.

virtual-volume expand 481

VPLEX CLI Command Descriptions

[-f|--force] - The meaning of this argument varies, depending on whether the --extent
argument is used (expansion method = concatenation) or not used (expansion-method =
storage-volume)
◆ For storage-volume expansion, the --force argument skips the confirmation message.
◆ For concatenation expansion, the --force argument expands a virtual-volume built on a
RAID-1 device using a target that is not a RAID-1 and or/is not as redundant as the
device supporting the virtual-volume.
* - argument is positional.

Description This command expands the specified virtual volume using one of two methods;
storage-volume or concatenation.
The ll command output shows whether the volume is expandable, the expandable
capacity (if any), and the expansion method available for the volume. For example:
VPlexcli:> ll /clusters/cluster-1/virtual-volumes/ Test_volume
Name Value
------------------- --------------
.
.
.
capacity 0.5G
consistency-group -
expandable true
expandable-capacity 4.5G
expansion-method storage-volume
expansion-status -
.
.
.
There are two methods to expand a virtual volume; storage-volume and concatenation.
◆ storage-volume - If the virtual-volume has a non-zero expandable-capacity, this
command will expand the capacity of the virtual-volume by it's full
expandable-capacity.
To use the storage-volume method of expansion, use this command without the
--extent argument. The storage-volume method of expansion adds the entire amount
of the expandable-capacity to the volume’s configured capacity.
◆ concatenation - (also known as RAID-C expansion) Expand the virtual volume by
adding the specified extents or devices.
The concatenation method does not support non-disruptive expansion of DR1
devices.
Use this command with the --extent argument to expand a virtual volume using the
concatenation method of expansion.
Before expanding a storage volume, understand the limitations of the function and the
prerequisites required for volumes to be expanded. See the VPLEX Administration Guide
for more information on how expansion works. For procedure to expand virtual volumes,
see the VPLEX procedures in the SolVe Desktop.

Example Expand a volume using the storage-volume method:

482 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ The ll clusters/cluster-1/virtual-volumes command displays virtual volumes, and

whether the volumes are expandable, and the expandable capacity, if any (not all
columns are shown in example).
◆ The ll clusters/cluster-1/virtual-volumes/virtual-volume command displays the
method (storage-volume) of expansion applicable to the volume.
◆ The expand command starts the expansion of the specified virtual volume.
◆ The ll clusters/cluster-1/virtual-volumes command displays the expanded volume:
VPlexcli:/clusters/cluster-1/virtual-volumes> ll /clusters/cluster-1/virtual-volumes
/clusters/cluster-1/virtual-volumes:

Name ...Capacity Locality Supporting Cache Expandable Expandable ...

... Device Mode Capacity ...
----------------- ...--------- -------- ----------- ----------- ------------ ---------- ...
Raid0_1Ga_11_vol ...5G local raid1-dev synchronous true 4.5G
RaidC_1Gb_11_vol ...5G local raid1-dev synchronous true 0B
Test_volume ...0.5G local Test synchronous true 4.5G
.
.
.
VPlexcli:/clusters/cluster-1/virtual-volumes> ll /clusters/cluster-1/virtual-volumes/
Test_volume
Name Value
------------------- --------------
block-count 131072
block-size 4K
cache-mode synchronous
capacity 0.5G
consistency-group -
expandable true
expandable-capacity 4.5G
expansion-method storage-volume
expansion-status -
.
.
.
VPlexcli:/clusters/cluster-1/virtual-volumes> expand -v Test_volume/
Virtual Volume expansion can take some time and once started, cannot be cancelled. Some
operations such as upgrades and data migrations will not be possible during the expansion. In
some cases hosts and their applications may need to be restarted once the expansion has
completed. Do you wish to proceed ? (Yes/No) yes

The expansion of virtual-volume 'Test_volume' has started.

VPlexcli:/clusters/cluster-1/virtual-volumes> cd Test_volume/

VPlexcli:/clusters/cluster-1/virtual-volumes/Test_volume> ll
Name Value
------------------- --------------
block-count 131072
block-size 4K
cache-mode synchronous
capacity 0.5G
consistency-group -
expandable true
expandable-capacity 4.5G
expansion-method storage-volume
expansion-status in-progress
health-indications []
.
.
.
VPlexcli:/clusters/cluster-1/virtual-volumes> ll /clusters/cluster-1/virtual-volumes

virtual-volume expand 483

VPLEX CLI Command Descriptions

/clusters/cluster-1/virtual-volumes:

Name ...Capacity Locality Supporting Cache Expandable Expandable ...

... Device Mode Capacity ...
----------------- ...--------- -------- ----------- ----------- ------------ ---------- ...
Raid0_1Ga_11_vol ...5G local raid1-dev synchronous true 4.5G
RaidC_1Gb_11_vol ...5G local raid1-dev synchronous true 0B
Test_volume ...5G local Test synchronous true 0B
.
.
.

Example Expand a virtual volume using the concatenation method:

◆ The ll clusters/cluster-1/virtual-volumes command displays the available virtual
volumes, and whether the volumes are expandable.
◆ The ll clusters/cluster-1/virtual-volumes/volume-name command displays that the
concatenation method must be used to expand the target volume.
◆ The ll /clusters/cluster-1/storage-elements/extents command displays available
extents.
◆ The virtual-volume expand --virtual-volume virtual-volume --extent extent command
adds the specified extent to the specified virtual volume:
VPlexcli:/> ll /clusters/cluster-1/virtual-volumes
/clusters/cluster-1/virtual-volumes:

Name Operational Health ... ... Expandable

----------------- Status State ... ... ----------
----------------- ----------- ------ ... ... ----------
Raid0_1Ga_11_vol ok ok ... ... true
RaidC_1Gb_11_vol ok ok ... ... true
Raid1_1Gc_11_vol ok ok ... ... true
Test-Device_vol ok ok ... ... true
.
.
.
VPlexcli:/> ll /clusters/cluster-1/virtual-volumes/Test-Device-vol
Name Value
------------------ --------------------------------
.
.
.
expandable true
expansion-method concatenation
health-indications []
.
.
.
VPlexcli:/> ll /clusters/cluster-1/storage-elements/extents

/clusters/cluster-1/storage-elements/extents:
Name StorageVolume Capacity Use
-------------------------------- ----------------------- -------- -------
extent_Symm1554Tdev_061D_1 Symm1554Tdev_061D 100G used
extent_Symm1554Tdev_0624_1 Symm1554Tdev_0624 100G used
extent_Symm1554Tdev_0625_1 Symm1554Tdev_0625 100G used
extent_Symm1554_0690_1 Symm1554_0690 8.43G used
extent_Symm1554_0691_1 Symm1554_0691 8.43G used
extent_Symm1554_0692_1 Symm1554_0692 8.43G used
.
.
.

484 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

VPlexcli:/> cd /clusters/cluster-1/virtual-volumes/Test-Device_vol

VPlexcli:/clusters/cluster-1/virtual-volumes/Test-Device_vol> expand --virtual-volume

Test-Device_vol --extent ext_Symm1254_7BF_1

See also ◆ batch-migrate pause

◆ batch-migrate resume
◆ dm migration pause
◆ dm migration resume
◆ virtual-volume create
◆ virtual-volume destroy
◆ VPLEX Administration Guide

virtual-volume provision
Provisions new virtual volumes using storage pools.

Contexts All contexts.

Syntax virtual-volume provision

[-b|--base-name] base-name
[-p|--storage-pools] storage-pools [, storage-pools...]
[-n|--number-of-volumes] number-of-volumes
[-c|--capacity] capacity
[-g|--consistency-group] consistency-group context-path
[-v|--storage-views] storage-views [, storage-views...]
[-t|--thin]
[-h|--help]
[--verbose]

Arguments Required arguments

[-b|--base-name] base-name - * Specifies the base-name of the virtual-volumes to
provision.
[-p|--storage-pools] storage-pools [, storage-pools] - * Specifies the storage-pools to use
for provisioning. Storage pools must be given in cluster name, storage-array name,
storage-pool name [cluster name, storage-array name, storage-pool name...] tuple format.
A maximum of four tuples can be specified.

IMPORTANT
Storage pool names that contain spaces must be enclosed by double quotation marks.

[-n|--number-of-volumes] number-of-volumes - * Specifies the number of volumes to

provision. Each volume will have the same RAID geometry and capacity. A maximum of ten
volumes can be provisioned at one invocation.
[-c|--capacity] capacity - * Specifies the capacity of the virtual-volumes in MB, GB, TB, etc.
The minimum size is 150 MB.

virtual-volume provision 485

VPLEX CLI Command Descriptions

Optional arguments
[-g|--consistency-group] consistency-group context-path - Specifies the consistency-group
to which to add the virtual-volumes.

Note: During VPLEX Integrated Array Services (VIAS) virtual volume provisioning, the
virtual volume can be added to new or existing VPLEX consistency groups using VPLEX
GUI. However, VPLEX command line interface will only support adding virtual volumes to
existing VPLEX consistency groups.

[-v|--storage-views] storage-views [, storage-views] - Specifies the storage-views to which

to add the virtual-volumes.
[-t|--thin] - When specified, provisioning will attempt to create a thin LUN on a VNX array
that has pools that are capable of creating both thick and thin LUNs. If any of the
VNX-based legs does not support thin provisioning, when this flag is set the command will
create a thick LUN.
[-h|--help] - Displays command line help.
[--verbose] - Provides more output during command execution. This may not have any
effect for some commands.
* - argument is positional.

Description Provisions new virtual volumes using storage pools. The RAID geometry is determined
automatically by the number and location of the specified pools.

Example Provision two 10GB DR1 virtual volumes:

VPlexcli:/> virtual-volume provision -b test_name -n 2 -c 10GB -p (cluster-1, dsvea123,
storage_pool_1), (cluster-2, dsvea124, storage_pool_2)

VPlexcli:/> A volume provisioning job was created and may be tracked by executing 'ls
/notifications/jobs/Provision_1_01-01-2014:00:00:01'.

Example List the job notification to track the status of the provisioning operation:

Note: The Job IDs created for volume provisioning will be active for 48 hours and their
expiration times posted. Jobs will be deleted and will need to be recreated if any of the
following occur: failures to the management server, such as shutdown, restart, VPLEX
Management Server upgrade, or VPLEX Management Console restart.

VPlexcli:/> ls /notifications/jobs/Provision_1_01-01-2014:00:00:01

JobID State Description Last Update Time

-------------------------------- ------- ------------ -------------------------
Provision_1_01-01-2014:00:00:01 InProgress Provision In progress 01-01-2014:00:01:16-UTC

Example Provision virtual-volumes from the specified storage pool:

VPlexcli:/> virtual-volume provision -b myVolume -n 1 -c 152MB -p (Hopkinton,
EMC-CLARiiON-APM00121401916, "Concrete storage pool 0000 for APM00121401916 storage system")

A volume provisioning job was created and may be tracked by executing 'ls
/notifications/jobs/Provision_1_19-02-14:19:46:00'.

486 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

See also ◆ storage-tool compose

◆ storage-volume unclaim

virtual-volume summary
Displays a summary for all virtual volumes.

Contexts All contexts.

In /clusters/cluster-n/virtual-volumes context, command is summary.

Syntax virtual-volume summary

[-c|--clusters] cluster,cluster

Arguments Optional arguments

[-c|--clusters] cluster,cluster... - List of one or more names of clusters. Display information
for only the specified clusters. Entries must be separated by commas.

Description Displays a list of any devices with a health-state or operational-status other than 'ok'.
Displays a summary including devices per locality (distributed versus local), cache-mode
(synchronous versus asynchronous), and total capacity for the cluster.
Displays any volumes with an expandable capacity greater than 0, and whether an
expansion is in progress.
If the --clusters argument is not specified and the command is executed at or below a
/clusters/cluster context, information is displayed for the current cluster.
Otherwise, virtual volumes of all clusters are summarized.

Example In the following example, all devices on cluster-1 are healthy:

VPlexcli:/clusters/cluster-1/virtual-volumes> virtual-volume summary
Virtual-volume health summary (cluster-1):

Total 589 virtual-volumes, 0 unhealthy.

Expansion summary:
No expansion activity.
Locality summary:
distributed : 65 virtual-volumes.
local : 494 virtual-volumes.
remote : 30 virtual-volumes.
Cache-mode summary:
asynchronous : 64 virtual-volumes.
synchronous : 525 virtual-volumes.
Total virtual-volume capacity is 87.9T.

Example In the following example, one distributed virtual volume has expandable capacity at both
clusters:
VPlexcli:/> virtual-volume summary
Virtual-volume health summary (cluster-1):

Total 2152 virtual-volumes, 0 unhealthy.

Expansion summary:

virtual-volume name expandable-capacity capacity expansion-status

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

virtual-volume summary 487

VPLEX CLI Command Descriptions

dr_one2one_CX_0_vol 10G 10G -

Total 1 expansion: 0 in-progress, 0 failed.

Locality summary:
distributed : 903 virtual-volumes.
local : 1074 virtual-volumes.
remote : 175 virtual-volumes.
Cache-mode summary:
asynchronous : 878 virtual-volumes.
synchronous : 1274 virtual-volumes.
Total virtual-volume capacity is 43.7T.

Virtual-volume health summary (cluster-2):

Total 1991 virtual-volumes, 0 unhealthy.

Expansion summary:

virtual-volume name expandable-capacity capacity expansion-status

------------------- ------------------- -------- ----------------
dr_one2one_CX_0_vol 10G 10G -

Total 1 expansion: 0 in-progress, 0 failed.

Locality summary:
distributed : 903 virtual-volumes.
local : 960 virtual-volumes.
remote : 128 virtual-volumes.
Cache-mode summary:
asynchronous : 878 virtual-volumes.
synchronous : 1113 virtual-volumes.
Total virtual-volume capacity is 43.9T.

Table 26 virtual-volume summary field descriptions (page 1 of 2)

Field Description

Virtual-volume health summary (displayed only for unhealthy volumes)

volume name Name of the virtual volume.

health state major failure - One or more of the virtual volume's underlying devices is out-of-date, but
will never rebuild.
minor failure - One or more of the virtual volume's underlying devices is out-of-date, but
will rebuild.
non-recoverable error - VPLEX cannot determine the virtual volume's Health state.
ok - The virtual volume is functioning normally.
unknown -VPLEX cannot determine the virtual volume's Health state, or the state is
invalid.

operational status degraded - The virtual volume may have one or more out-of-date devices that will
eventually rebuild.
error - One or more of the virtual volume's underlying devices is hardware-dead.
ok - The virtual volume is functioning normally.
starting -The virtual volume is not yet ready.
stressed - One or more of the virtual volume's underlying devices is out-of-date and will
never rebuild.
unknown - VPLEX cannot determine the virtual volume's Operational state, or the state is
invalid.

488 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

Table 26 virtual-volume summary field descriptions (page 2 of 2)

Field Description

service status The service status of a virtual-volume.

running - I/O is running for the virtual-volume.
inactive - The virtual-volume is part of an inactive storage-view and is not visible from the
host.
unexported- The virtual-volume is unexported.
suspended - I/O is suspended for the virtual-volume.
cluster-unreachable - Cluster is unreachable at this time.
need-resume - Issue re-attach to resume after link has returned.
disconnected - Applies to distributed volumes used with RecoverPoint as replica volumes,
or in production failure scenarios. It will clear when the volume is no longer used as a
RecoverPoint replica, or after production failback is complete.

Summaries

Total Total number of virtual volumes on the cluster, and number of unhealthy virtual volumes.

Locality summary distributed - Number of distributed virtual volumes.

local - Number of local virtual volumes.
remote - Number of remote volumes.

Cache-mode asynchronous - Number of virtual volumes with asynchronous cache mode.

summary synchronous - number of virtual volumes with synchronous cache mode.

Expansion virtual-volume name - Name of any volume with expandable capacity greater than 0 or an
summary expansion underway.
expandable-capacity - Additional capacity (if any) added to the back end storage volume
not yet added to the VPLEX virtual volume.
capacity - Current capacity of the virtual volume.
expansion-status - Indicates whether an expansion is possible is in progress, or has
failed. A value of “-” indicates expansion is possible, but is not in progress, and has not
failed.

See also ◆ ds summary

◆ export port summary
◆ export storage-view summary
◆ extent summary
◆ local-device summary

vpn restart
Restarts the VPN connection between management servers.

Contexts All contexts.

Syntax vpn restart

Description Restarts the VPN.

Example VPlexcli:/> vpn restart

See also ◆ vpn status

◆ vpn start

vpn restart 489

VPLEX CLI Command Descriptions

◆ vpn stop

vpn start
Starts the VPN connection between management servers.

Contexts All contexts.

Syntax vpn start

Description Starts the VPN.

Example VPlexcli:/> vpn start

See also ◆ vpn restart

◆ vpn status
◆ vpn stop

vpn status
Verifies the VPN connection between management servers.

Contexts All contexts.

Syntax vpn status

Description Verifies whether the VPN connection between the management servers is operating
correctly and checks whether all the local and remote directors can be reached (pinged).
If Cluster Witness is deployed, verifies the VPN connection between the management
servers and the Cluster Witness Server.

Example Display VPN status (no Cluster Witness):

VPlexcli:/> vpn status
Verifying the VPN status between the management servers...
IPSEC is UP
Remote Management Server at IP Address 10.31.25.27 is reachable
Remote Internal Gateway addresses are reachable
Verifying the VPN status between the management server and the cluster witness server...
Cluster Witness Server at IP Address 128.221.254.3 is not reachable

Example Display VPN status when Cluster Witness is deployed:

VPlexcli:/> vpn status
Verifying the VPN status between the management servers...
IPSEC is UP
Remote Management Server at IP Address 10.31.25.27 is reachable
Remote Internal Gateway addresses are reachable

Verifying the VPN status between the management server and the cluster witness server...
IPSEC is UP
Cluster Witness Server at IP Address 128.221.254.3 is reachable

See also ◆ About cluster IP seed and cluster ID in the security ipsec-configure command.
◆ vpn restart

490 EMC® VPLEX® CLI Reference Guide

 VPLEX CLI Command Descriptions

◆ vpn start
◆ vpn stop

vpn stop
Stops the VPN connection between management servers.

Contexts All contexts.

Syntax vpn stop

Description Stops the VPN connection between management servers.

Example VPlexcli:/> vpn stop

See also ◆ vpn restart

◆ vpn status
◆ vpn start

vpn stop 491

VPLEX CLI Command Descriptions

492 EMC® VPLEX® CLI Reference Guide

CHAPTER 3
VPLEX Commands by Topic

VPLEX CLI commands, grouped by the following general topics:

◆ Connectivity
◆ Clusters
◆ Directors
◆ Data migration
◆ Storage (arrays, devices, ptov, storage-volumes, virtual volumes)
• Storage views
◆ System management
• Meta-volumes
• Subnets and ports
• Manage CLI workspace
• Navigate the CLI
• Cache vaulting
• Consistency groups
◆ Monitoring / Statistics
• System status: connectivity, summaries, and reports
• Diagnostics, dumps, healthchecks
◆ Security / Authentication
◆ RecoverPoint
◆ Cluster Witness
◆ Configuration/EZ-Setup
◆ Miscellaneous

Connectivity
iscsi chap back-end add-credentials
iscsi chap back-end disable
iscsi chap back-end enable
iscsi chap back-end list-credentials
iscsi chap back-end remove-credentials
iscsi chap back-end remove-default-credential
iscsi chap back-end set-default-credential
iscsi chap front-end add-credentials
iscsi chap front-end disable

VPLEX Commands by Topic 493

VPLEX Commands by Topic

iscsi chap front-end enable

iscsi chap front-end list-credentials
iscsi chap front-end remove-credentials
iscsi chap front-end remove-default-credential
iscsi chap front-end set-default-credential
iscsi check-febe-connectivity
iscsi isns add
iscsi isns list
iscsi isns remove
iscsi sendtargets add
iscsi sendtargets list
iscsi sendtargets rediscover
iscsi sendtargets remove
iscsi targets list
iscsi targets logout

Clusters
cluster add
cluster cacheflush
cluster configdump
cluster expel
cluster forget
cluster local-ha repair-directors power-on
cluster local-ha repair-dirs
cluster local-ha repair-network-configuration
cluster local-ha repair-vsphere-ha
cluster local-ha-validate
cluster shutdown
cluster status
cluster summary
cluster unexpel
configuration short write
report capacity-clusters

Directors
connect
connectivity director
director appcon
director commission
director decommission
director forget
director passwd
director shutdown
director uptime
disconnect

494 EMC® VPLEX® CLI Reference Guide

 VPLEX Commands by Topic

Data migration
batch-migrate cancel
batch-migrate check-plan
batch-migrate clean
batch-migrate commit
batch-migrate create-plan
batch-migrate pause
batch-migrate remove
batch-migrate resume
batch-migrate start
batch-migrate summary
dm migration cancel
dm migration clean
dm migration commit
dm migration pause
dm migration remove
dm migration resume
dm migration start

Storage (arrays, devices, ptov, storage-volumes, virtual volumes)

advadm dismantle
amp register
amp unregister
array claim
array re-discover
array register
copy-session create*
device attach-mirror
device collapse
device detach-mirror
device mirror-isolation auto-unisolation disable
device mirror-isolation auto-unisolation enable
device mirror-isolation disable
device mirror-isolation enable
device mirror-isolation show
device resume-link-down
device resume-link-up
ds dd create
ds dd declare-winner
ds dd destroy
ds dd remove-all-rules
ds dd set-log
ds rule destroy
ds rule island-containing
ds rule-set copy
ds rule-set create
ds rule-set destroy
ds rule-set what-if

Data migration 495

VPLEX Commands by Topic

ds summary
extent create
extent destroy
extent summary
local-device create
local-device destroy
local-device summary
rebuild set-transfer-size
rebuild show-transfer-size
report capacity-arrays
set
show-use-hierarchy
storage-tool compose
storage-volume auto-unbanish-interval
storage-volume claim
storage-volume claimingwizard
storage-volume find-array
storage-volume forget
storage-volume list-banished
storage-volume resurrect
storage-volume summary
storage-volume unbanish
storage-volume unclaim
storage-volume used-by
virtual-volume create
virtual-volume destroy
virtual-volume expand
virtual-volume provision
virtual-volume summary

Storage views
export initiator-port discover
export initiator-port register
export initiator-port register-host
export initiator-port unregister
export port summary
export storage-view addinitiatorport
export storage-view addport
export storage-view addvirtualvolume
export storage-view checkconfig
export storage-view create
export storage-view destroy
export storage-view find
export storage-view find-unmapped-volumes
export storage-view map
export storage-view removeinitiatorport
export storage-view removepor
export storage-view removevirtualvolume
export storage-view show-powerpath-interfaces
export storage-view summary

496 EMC® VPLEX® CLI Reference Guide

 VPLEX Commands by Topic

System management
battery-conditioning disable
battery-conditioning enable
battery-conditioning manual-cycle cancel-request
battery-conditioning manual-cycle request
battery-conditioning set-schedule
battery-conditioning summary
cache-invalidate
cache-invalidate-status
configuration remote-clusters add-addresses
configuration remote-clusters clear-addresses
configuration sync-time
configuration sync-time-clear
configuration sync-time-show
date
exec
exit
log filter create
log filter destroy
log filter list
log source create
log source destroy
log source list
logging-volume add-mirror
logging-volume create
logging-volume detach-mirror
logging-volume destroy
logical-unit forget
management-server net-service-restart*
manifest upgrade
manifest version
ndu copy-upgrade-package
ndu upgrade-mgmt-server
notifications call-home import-event-modifications
notifications call-home remove-event-modifications
notifications call-home view-event-modifications
notifications snmp-trap create
notifications snmp-trap destroy
report capacity-hosts
schedule add
schedule list
schedule modify
schedule remove
scheduleSYR add
scheduleSYR list
scheduleSYR remove
script
set
sessions
snmp-agent configure

System management 497

VPLEX Commands by Topic

snmp-agent start
snmp-agent status
snmp-agent stop
snmp-agent unconfigure
source
user add
user event-server add-user
user event-server change-password
user list
user passwd
user remove
user reset
version
vpn restart
vpn start
vpn status
vpn stop

Meta-volumes
configuration metadata-backup
configuration show-meta-volume-candidates
meta-volume attach-mirror
meta-volume backup
meta-volume create
meta-volume destroy
meta-volume detach-mirror
meta-volume move
meta-volume verify-on-disk-consistency

Subnets and ports

configuration subnet clear
configuration subnet remote-subnet add
configuration subnet remote-subnet clear
export target-port renamewwns
set topology
subnet create
subnet destroy
subnet modify

Manage CLI workspace

alias
capture begin
capture end
capture pause
capture replay
capture resume
describe
dirs

498 EMC® VPLEX® CLI Reference Guide

 VPLEX Commands by Topic

drill-down
unalias
security remove-login-banner
security set-login-banner

Navigate the CLI

cd
help
history
ls
popd
pushd
tree

Cache vaulting
vault go
vault overrideUnvaultQuorum
vault status

Consistency groups
consistency-group add-virtual-volumes
consistency-group cache-invalidate
consistency-group choose-winner
consistency-group create
consistency-group destroy
consistency-group list-eligible-volumes
consistency-group remove-virtual-volumes
consistency-group resolve-conflicting-detach
consistency-group resume-after-data-loss-failure
consistency-group resume-after-rollback
consistency-group resume-at-loser
consistency-group set-detach-rule active-cluster-wins
consistency-group set-detach-rule no-automatic-winner
consistency-group set-detach-rule winner
consistency-group summary
set

Monitoring/statistics
monitor add-console-sink
monitor add-file-sink
monitor collect
monitor create
monitor destroy
monitor remove-sink
monitor stat-list
report aggregate-monitors
report create-monitors

Monitoring/statistics 499
VPLEX Commands by Topic

report poll-monitors

System status: connectivity, summaries, and reports

cluster summary
connectivity show
connectivity validate-be
connectivity validate-local-com
connectivity validate-wan-com
connectivity window set
connectivity window show
connectivity window stat
consistency-group summary
director ping
director tracepath
ds summary
event-test
export port summary
export storage-view checkconfig
export storage-view summary
extent summary
local-device summary
ls
notifications call-home test
notifications job cancel
notifications job delete
notifications job resubmit
rebuild show-transfer-size
rebuild status
report capacity-arrays
report capacity-clusters
report capacity-hosts
storage-volume summary
validate-system-configuration
verify fibre-channel-switches
virtual-volume summary

Diagnostics, dumps, healthchecks

collect-diagnostics
collect-recoverpoint-diagnostics
director appdump
director appstatus
director firmware show-banks
director ping
getsysinfo
health-check
sms dump
syrcollect

500 EMC® VPLEX® CLI Reference Guide

 VPLEX Commands by Topic

Security/authentication
authentication directory-service configure
authentication directory-service map
authentication directory-service show
authentication directory-service unconfigure
authentication directory-service unmap
authentication password-policy set
authentication password-policy reset
configuration configure-auth-service
password-policy reset
password-policy set
security create-ca-certificate
security create-certificate-subject
security create-host-certificate
security delete-ca-certificate
security delete-hostcertificate
security export-ca-certificate
security export-host-certificate
security import-ca-certificate
security import-host-certificate
security renew-all-certificates
security ipsec-configure
security show-cert-subj
user event-server add-user
user event-server change-password

Cluster Witness
cluster-witness configure
cluster-witness disable
cluster-witness enable
configuration cw-vpn-configure
configuration cw-vpn-reset

RecoverPoint
rp rpa-cluster add
rp rpa-cluster remove
rp summary
rp validate-configuration

Configuration/EZ-Setup
configuration complete-system-setup
configuration connect-local-directors
configuration connect-remote-directors
configuration continue-system-setup
configuration cw-vpn-configure

Security/authentication 501
VPLEX Commands by Topic

configuration cw-vpn-reset
configuration enable-front-end-ports
configuration event-notices-reports config
configuration event-notices-reports reset
configuration event-notices-reports-show
configuration get-product-type
configuration join-clusters
configuration register-product
configuration system-reset
configuration system-setup
configuration show-meta-volume-candidates
configuration upgrade-meta-slot-count

Miscellaneous
alias
chart create

502 EMC® VPLEX® CLI Reference Guide

 Index

INDEX C
cache-invalidate
consistency-group 81, 116
virtual-volume 81, 116
A
call-home import-event-modifications 355
add-console-sink, monitor 337
call-home remove-event-modifications 357
add-file-sink, monitor 338
call-home-view-event-modifications 358
addinitiatorport, export view 257
cancel
add-mirror, logging-volume 314
dm migration 223
addport, export view 257
capacity-clusters, report 376
addurl, plugin 367
capacity-hosts, report 377
addvirtualvolume, export view 258
capture
aggregate, report monitors 372
begin 88
appdump, director 209
end 89
array register 50
pause 89
array used-by 50
replay 89
attach-mirror
resume 90
meta-volume 327
checkconfig, export view 260
authentication 51, 55, 57, 58
check-plan, batch-migrate 60
authentication directory-service 56
claim, storage-volume 435
authentication directory-service configure 51
claimingwizard 438
authentication directory-service map 55
clean, dm migration 224
authentication directory-service show 56
CLI
authentication directory-service unconfigure 57
? wildcard 37
* wildcard 36
B ** wildcard 36
Batch migration accessing help 40
perform a migration 64 context tree 29, 30
batch-migrate display command arguments 36
check-plan 60 executing commands 34
pause 65 Log in 27
remove 66 Log out 28
resume 67 log out 28
start 67 login 27
summary 70 page output 35
batch-migrate cancel 59 positional arguments 38
battery-conditioning disable 72 Tab completion 35
battery-conditioning enable 73 using commands 34
battery-conditioning manual-cycle cancel-request 75 -verbose and --help arguments 39
battery-conditioning manual-cycle request 76 viewing command history 40
battery-conditioning set-enabled 73 Where am I in the context tree? 32
battery-conditioning set-schedule 78 CLI commands
battery-conditioning summary 80 cd 33
begin, capture 88 globbing 38
ls 32
popd 31
positional arguments 38

EMC® VPLEX® CLI Reference Guide 503

Index

pushd 31 configuration flashdir-backup enable 129

tree 33 configuration metadata-backup 131
verbose and --help arguments 39 configuration register-product 136
wildcards 36 configuration show-meta-volume-candidates 139
CLI context tree 30 configuration sync-time-clear 148
CLI workspace configuration sync-time-show 146, 149
command history 40 configuration system-reset 148
cluster configuration virtual
capacity report 376 change-service-password 153
summary 104 setup-federation 153
cluster configdump 95 unregister-vsphere-plugin 153
cluster IP seed 413 update-datastore-info 153
cluster local-ha update-vcenter-ip-address 153
repair-directors power-on 99 configuration, validate 465
cluster shutdown 99 connect 153
cluster summary connectivity
cluster expelled 105, 106 show 156
healthy cluster 104 validate-be 157
link outage 105 window set 163
cluster virtual-ha window show 165
repair-datastore-placement 108 window stat 166
cluster-witness connectivity validate-wan-com 160
configure 108 consistency-group
create context 108 cache-invalidate 81, 116
VPN connectivity 122 consistency-group choose-winner 169
vpn prerequisites 123 consistency-group create 171
cluster-witness disable 109 consistency-group destroy 174
cluster-witness enable 112 consistency-group list-eligible-volumes 175
collect consistency-group remove-virtual-volumes 176
monitor 339 consistency-group resolve-conflicting-detach 177
command history, viewing 40 consistency-group resume-after-data-loss-failure 180
commission, director 212 consistency-group resume-after-rollback 183
commit, dm migration 225 consistency-group resume-at-loser 185
configuration consistency-group summary 191
remote-clusters add-addresses 138 console sessions 420
remote-clusters clear-addresses 139 copy rule-set 240
short-write 141 create
show-meta-volume-candidates 141 distributed-device 232
subnet remote-subnet add 144 export view 260
subnet remote-subnet remove 145 log filter 310
configuration complete-geo-setup 118 log source 312
configuration configure-auth-service 119 logging-volume 314
configuration connect-local-directors 120 meta-volume 329
configuration cws-vpn-configure 122 monitor 340
configuration cw-uninstall 127 create extent 269
configuration event-notices-reports-config 127 create, snmp-trap 363
configuration event-notices-reports-reset 128 create-ca-certificate

504 EMC® VPLEX® CLI Reference Guide

 Index

security 398 directory-serevice unconfigure 57

create-cert-subj directory-service configure 51
security 402 directory-service map 55
create-host-certificate directory-service unmap 58
security 403 dirs 222
create-monitors, report 378 disable
mirror-isolation device 200
disconnect 222
D
discovering
declare-winner, distributed-device 234
initiator ports 251
destroy
Display
distributed-device 235
default values 422
export view 261
multiple objects using globs 324
extent 270
object’s attributes 322
local-device 308
object’s attributes and contexts 323
log filter 311
operational status 323
log source 313
writable attributes 421
logging-volume 318, 320
distributed-device
meta-volume 333
create 232
monitor 343
declare-winner 234
rule 238
destroy 235
rule-set 241
set-log 236
volume 480
distributed-storage
destroy, snmp-trap 364
dd create 232
Detach
dd declare-winner 234
mirror leg 196
dd destroy 235
detach-mirror, device 194
dd set-log 236
device
rule destroy 238
destroy local 308
rule island-containing 239
detach-mirror 194
rule-set copy 240
mirror-isolation auto-unisolation enable 199
rule-set destroy 241
mirror-isolation auto-unisolation-disable 197
dm
mirror-isolation disable 200
migration cancel 223
mirror-isolation enable 203
migration clean 224
mirror-isolation show 204
migration commit 225
resume-link-down 206
migration remove 226
resume-link-up 208
migration resume 227
director
migration start 228
appdump 209
dr
commission 212
create 232
passwd 217
declare-winner 234
ping 217
destroy 235
shutdown 218
set-log 236
director appcon 208
drill-down 230
director fc-port-stats 213
ds
director firmware show-banks 215
dd create 232
director tracepath 219
dd declare-winner 234
director traceroute 219

EMC® VPLEX® CLI Reference Guide 505

Index

dd destroy 235 find, export view 262

dd set-log 236 find-array, storage-volume 441
rule destroy 238 find-unmapped-volumes, export view 263
rule island-containing 239 forget
rule-set copy 240 storage-volume 442
rule-set destroy 241
G
E gateway IP address
end, capture 89 set 324
event-test 249 getsysinfo 272
exec 250
executing CLI commands 34
H
exit 250
help 280
export
help command
initiator-port register 251
CLI 40
initiator-port register-host 253
help, accessing in CLI 40
initiator-port unregister 255
history 282
port summary 255
host, capacity report 377
target-port renamewwns 268
view addinitiatorport 257
view addport 257 I
view addvirtualvolume 258 import-event-modifications 355
view checkconfig 260 initiator ports
view create 260 discovering 251
view destroy 261 initiator-port
view find 262 register 251
view find-unmapped-volumes 263 register-host 253
view map 264 unregister 255
view removeinitiatorport 264 IP address
view removeport 265 set 324
view removevirtualvolume 266 IP seed 413
view show-powerpath-interfaces 266 ipsec-configure
view summary 267 security 412
export initiator-port iscsi
show-logins 253 isns list 297
export initiator-port discovery 251 isns remove 299
export target-port renamewwns 268 sendtargets list 301
extent sendtargets rediscover 302
create 269 sendtargets remove 303
destroy 270 targets list 304
summary 271 iscsi chap
unclaim 272 back-end
Extent migrations 229 set-default-credential 288
back-end add-credentials 282
F back-end disable 283
back-end enable 284
file rotation 341
back-end list-credentials 285

506 EMC® VPLEX® CLI Reference Guide

 Index

back-end remove-default-credential 287 log source 313

front-end add-credential 289 listurl, plugin 367
front-end disable 290 local-device
front-end enable 291 destroy 308
front-end list-credentials 292 summary 309
front-end remove-credentials 292 local-device-create 305
front-end remove-default-credential 293 log
front-end set-default-credential 294 filter create 310
iscsi chap back-end filter destroy 311
add credentials 282 filter list 312
disable 283 source create 312
enable 284 source destroy 313
list-credentials 285 source list 313
remove-credentials 286 Log in to CLI 27
remove-default credential 287 Log out from CLI 28
set-default-credential 288 log source create 312
iscsi chap front-end log source destroy 313
add-credential 289 logging-volume
disable 290 add-mirror 314
enable 291 create 314
list-credentials 292 destroy 318, 320
remove-credentials 292 logging-volume detach-mirror 318
remove-default-credential 293 logical-unit forget 321
set-default-credential 294 ls 322
iscsi isns
list 297
M
remove 299
management-server
iscsi isns add 296
set-ip 324
iscsi sendtargets
management-server set-ip 324
list 301
manifest
rediscover 302
upgrade 326
remove 303
version 327
iscsi targets
map, export view 264
list 304
metadata
iscsi targets logout 305
backup
island-containing rule 239
initial 132
modify schedule 132
J modify backup schedule 132
Jython 397 schedule backup 131
metadata backup
display backup volumes 133
L
meta-volume
list 322
attach-mirror 327
iscsi isns 297
create 329
iscsi sendtargets 301
destroy 333
iscsi targets 304
move 334
log filter 312
migration

EMC® VPLEX® CLI Reference Guide 507

Index

cancel 223 notifications 358

clean 224 call-home remove-event-modifications 357
commit 225 notifications call-home
remove 226 import-event-modifications 355
resume 227 remove-event-modifications 357
start 228 test 360
migrations view-event-modifications 358
device 229 notifications call-home import-event-modification 355
extent 229 notifications call-home test 360
prerequisites 230 notifications job
mirror leg cancel 360
detach 196 delete 361
monitor resubmit 362
add 337 notifications job cancel 360, 361
add-console-sink 337 notifications job delete 361
add-file-sink 338 notifications job resubmit 362
collect 339
create 340
P
destroy 343
passwd, director 217
remove-sink 344
password-policy reset 364
stat-list 344
password-policy set 365
monitor add 337
pause
monitors, aggregate 372
batch-migrate 65
move, meta-volume 334
capture 89
Performance monitoring
N file rotation 341
Names 37 ping 217
VPLEX components 37 plugin
NDU addurl 367
display status 354 listurl 367
pre-config-upgrade 346 register 368
pre-ndu validation 345 poll-monitors, report 380
recover from failed ndu 346 popd 368
rolling upgrade SSD firmware 347 port, export summary 255
upgrade unconfigured Geo 346 pushd 369
ndu pre-check 345
ndu pre-config-upgrade 345
R
ndu recover 346
rebuild
ndu rolling-upgrade c41-to-sles 347
setlimit 370
ndu rolling-upgrade c41x-to-sles 347
showlimit 371
ndu rolling-upgrade ssd-fw 347
status 371
ndu start 351
RecoverPoint Appliance
ndu status 354
remove 388
net-mask
Re-discover an array 47
set 324
register
Network
initiator-port 251
set IP address 324

508 EMC® VPLEX® CLI Reference Guide

 Index

plugin 368 security

register-host, export initiator-port 253 create-ca-certificate 398
remove create-cert-subj 402
batch-migrate 66 create-host-certificate 403
dm migration 226 ipsec-configure 412
iscsi isns 299 renew-all-certificates 414
iscsi sendtargets 303 show-cert-subj 420
removeinitiatorport, export view 264 security delete-ca-certificate 406
remove-modifications 357 security delete-host-certificate 406
removeport, export view 265 security remove-login-banner 414
remove-sink, monitor 344 security renew-all-certificates 414
removevirtualvolume, export view 266 security set-login-banner 419
renamewwns, export target-port 268 set
Renew security certificates 414 connectivity window 163
replay, capture 89 set topology 425
report set, command 421
aggregate-monitors 372 set-ip
capacity-clusters 376 management-server 324
capacity-hosts 377 setlimit, rebuild 370
create-monitors 378 set-log, distributed-device 236
poll-monitors 380 show 56, 420
report create-monitors 378 connectivity 156
restart network service 324 connectivity window 165
resume show hierarchy 426
batch-migrate 67 show-cert-subj
capture 90 security 420
dm migration 227 showlimit, rebuild 371
resume-link-down, device 206 show-powerpath-interfaces, export view 266
resume-link-up, device 208 show-use-hierarchy 426
resurrect, storage-volume 444 shutdown
rp import-certificate 381 director 218
rp rpa add 382 sink
rp rpa remove 388 add-console 337
rp rpa summary 388 add-file 338
rp validate configuration 390 remove 344
rule sms dump 427
destroy 238 snmp 429
island-containing 239 snmp-agent configure 429
rule-set snmp-agent start 430
copy 240 snmp-agent status 431
destroy 241 snmp-agent stop 431
snmp-agent unconfigure 431
snmp-trap, create 363
S
snmp-trap, destroy 364
schedule add 393
source 432
schedule modify 394
start
schedule remove 395
batch-migrate 67
script, command 397

EMC® VPLEX® CLI Reference Guide 509

Index

dm migration 228 manifest 326

stat, connectivity window 166 used-by, storage-volume 451
stat-list, monitor 344 user
status event-server change-password 461
rebuild 371 user add 459
status VPN 490 user event-server
storage tier IDs 477 add-user 461
storage tiers 477 user reset 464
storage-tool
compose 433
V
storage-volume
validate-be, connectivity 157
claim 435
validate-system-configuration 465
claimingwizard 438
vault go 466
find-array 441
vault overrideUnvaultQuorum 467
forget 442
verify fibre-channel-switches 472
resurrect 444
version 473
summary 446
manifest 327
unclaim 450
view
used-by 451
addinitiatorport 257
subnet clear 452, 455
addport 257
subnet create 454
addvirtualvolume 258
subnet destroy 455
checkconfig 260
subnet modify 456
create 260
summary
destroy 261
batch-migrate 70
find 262
cluster 104
find-unmapped-volumes 263
export port 255
map 264
export view 267
removeinitiatorport 264
extent 271
removeport 265
local-device 309
removevirtualvolume 266
storage-volume 446
show-powerpath-interfaces 266
volume 487
summary 267
system, validate configuration 465
view-event-modifications 358
virtual-volume
T provision 485
target-port, renamewwns 268 virtual-volume cache-invalidate 81, 116
test, call-home notifications 360 virtual-volume expand 481
Thin provisioning 436 volume
tree 458 destroy 480
summary 487
vpn restart 489
U
vpn status 490
unalias 459
vsphere register-vm 491
unclaim extent 272
unclaim, storage-volume 450
unregister, initiator-port 255 W
upgrade WAN COM

510 EMC® VPLEX® CLI Reference Guide

 Index

verify connectivity 161

wizard, claiming 438

EMC® VPLEX® CLI Reference Guide 511

Index

512 EMC® VPLEX® CLI Reference Guide