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
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.
Use the alias command with no arguments to display a list of all aliases configured on the system.
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.
● ? 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).
The following aliases are pre-configured:
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 does not persist when the user interface is restarted. To create an alias command that
persists, add it to the /var/log/VPlex/cli/VPlexcli-init file.
Make sure that the alias name is unique, that is, not identical to an existing command or alias.
Examples
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
30
Commands