CLI Guide
Table Of Contents
- Dell EMC Storage Systems CLI Guide for the metro node appliance
- Contents
- Introduction
- Using the VPlexcli
- Commands
- advadm dismantle
- alias
- array claim
- array forget
- array re-discover
- array used-by
- back-end degraded list
- back-end degraded recover
- 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
- capture begin
- capture end
- capture pause
- capture replay
- capture resume
- cd
- cluster add
- cluster configdump
- cluster expel
- cluster forget
- cluster show-remote-devices
- cluster shutdown
- cluster status
- cluster summary
- cluster unexpel
- collect-diagnostics
- configuration get-product-type
- configuration join-clusters
- configuration metadata-backup
- configuration show-meta-volume-candidates
- configuration upgrade-meta-slot-count
- connectivity director
- connectivity list all
- connectivity list directors
- connectivity list initiators
- connectivity list storage-volumes
- connectivity show
- connectivity validate-be
- connectivity validate-local-com
- consistency-group add-virtual-volumes
- consistency-group choose-winner
- consistency-group convert-to-local
- consistency-group create
- consistency-group destroy
- consistency-group list-eligible-virtual-volumes
- consistency-group remove-virtual-volumes
- consistency-group resolve-conflicting-detach
- consistency-group resume-at-loser
- consistency-group set-detach-rule no-automatic-winner
- consistency-group set-detach-rule winner
- consistency-group summary
- date
- describe
- 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
- device resurrect-dead-storage-volumes
- director commission
- director decommission
- director fc-port-stats
- director firmware show-banks
- director forget
- director passwd
- director ping
- director shutdown
- director tracepath
- director uptime
- dirs
- disconnect
- dm migration cancel
- dm migration clean
- dm migration commit
- dm migration pause
- dm migration remove
- dm migration resume
- dm migration start
- drill-down
- ds dd convert-to-local
- 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
- ds summary
- exec
- exit
- export initiator-port discovery
- export initiator-port register
- export initiator-port register-host
- export initiator-port show-logins
- 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 removeport
- export storage-view removevirtualvolume
- export storage-view show-powerpath-interfaces
- export storage-view summary
- export target-port renamewwns
- extent create
- extent destroy
- extent summary
- find
- front-end-performance-stats start
- front-end-performance-stats status
- front-end-performance-stats stop
- getsysinfo
- health-check
- help
- history
- local-device create
- local-device destroy
- local-device summary
- 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
- ls
- 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
- monitor add-console-sink
- monitor add-file-sink
- monitor collect
- monitor create
- monitor destroy
- monitor get-stats
- monitor remove-sink
- monitor stat-list
- ndu pre-check
- ndu pre-config-upgrade
- ndu recover
- ndu start
- ndu status
- plugin addurl
- plugin listurl
- plugin register
- popd
- pushd
- rebuild set-transfer-size
- rebuild show-transfer-size
- rebuild status
- report capacity-clusters
- report capacity-hosts
- rm
- schedule add
- schedule list
- schedule modify
- schedule remove
- scheduleSYR add
- scheduleSYR list
- scheduleSYR remove
- script
- sessions
- set
- set topology
- show-use-hierarchy
- sms dump
- source
- storage-tool dismantle
- 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 list-thin-capable
- storage-volume resurrect
- storage-volume summary
- storage-volume unbanish
- storage-volume unclaim
- storage-volume used-by
- syrcollect
- tree
- unalias
- validate-system-configuration
- version
- virtual-volume create
- virtual-volume destroy
- virtual-volume expand
- virtual-volume list-thin
- virtual-volume re-initialize
- virtual-volume set-thin-enabled
- virtual-volume summary
- wait
- webserver
- Index
Optional arguments
[-d|--storage-
volumes] storage-volume
[, storage-volume...]
* Specifies a list of storage volumes to build the virtual volume from. These may be claimed, but
must be unused.
[-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
Specifies the context path of a consistency group that the new virtual volume should be added
to. The new virtual-volume’s global geometry must be compatible with the consistency group’s
storage-at-clusters attribute.
[-v|--storage-
views] storage-view
[, storage-view...]
Specifies the context path of the storage views that the new virtual volume will be added to. The
new virtual volume’s global geometry must be compatible with the storage view’s locality.
[-t|--thin]
Specifies whether the new virtual-volume is thin-enabled or not. The supporting storage-volumes
must be thin-capable in order for a virtual-volume to be thin-enabled. The virtual-volume must
also have a valid RAID geometry to be thin-enabled.
[-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.
Description
This command supports building local or distributed (i.e., distributed RAID 1 based) virtual volumes with RAID 0, RAID 1, or RAID
C local devices. It does not support creating multi-device storage hierarchies (such as 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.
The --stop-at option imposes the following constraints on other options:
● If --stop-at=virtual-volume, only the --consistency-group and --storage-views options can be specified.
● If --stop-at=local-device, storage-volumes from only one cluster can be specified.
● If--stop-at=distributed-device, storage-volumes from at least two clusters must be specified.
Example
Create a thin-capable virtual volume with RAID 0 local devices and specified storage volumes:
VPlexcli:/clusters/cluster-1/virtual-volumes> storage-tool compose --name myVolume --
storage-volumes thin_capable_sv_1
--thin --geometry raid-0
Successfully created /clusters/cluster-1/virtual-volumes/myVolume.
VPlexcli:/clusters/cluster-1/virtual-volumes> ll myVolume/
286
Commands