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
Logging out from the CLI
Use the exit command to exit the command line interface from any context.
About this task
For example:
VPlexcli:/clusters> exit
Connection closed by foreign host.
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 command line interface effectively.
The root context contains these sub-contexts:
● clusters-witness/- Manage Cluster Witness options. If the Cluster Witness optional component is installed, then the
cluster-witness context is available.
● clusters/ - Create and manage links between clusters, devices, directors, extents, system volumes, and virtual volumes.
Configure connectivity, register initiator ports, export target ports, and storage views.
● 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.
● monitoring/ - Create and manage performance monitors.
● notifications/ - Create and manage call-home events.
● 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 “/”.
Context tree searching
Search the context tree for context names and data matching specific patterns.
Using the Find command to search the context tree
Use this command to find all contexts matching a pattern. When invoked interactively, the command prints the contexts to the
screen.
Patterns can be either literal character strings or strings that include wildcard characters. For a complete list of supported CLI
wildcard characters, see the topic "Wildcards" in the CLI Reference Guide.
14
Using the VPlexcli