CLI Guide
Table Of Contents
- Dell EMC PowerVault ME4 Series Storage System CLI Guide
- Contents
- Using the CLI
- Categorical list of commands
- Alphabetical list of commands
- abort copy
- abort replication
- abort scrub
- abort verify
- add disk-group
- add host-group-members
- add host-members
- add ipv6-address
- add spares
- add storage
- add volume-group-members
- check firmware-upgrade-health
- check support-assist
- clear cache
- clear disk-metadata
- clear dns-parameters
- clear events
- clear expander-status
- clear fde-keys
- clear fenced-data
- clear replication-queue
- clear support-assist-proxy
- copy volume
- create certificate
- create chap-record
- create host
- create host-group
- create peer-connection
- create replication-set
- create schedule
- create snapshots
- create task
- create user
- create vdisk
- create volume
- create volume-group
- create volume-set
- delete all-snapshots
- delete chap-records
- delete host-groups
- delete hosts
- delete initiator-nickname
- delete peer-connection
- delete pools
- delete remote-system
- delete replication-set
- delete schedule
- delete snapshot
- delete task
- delete user
- delete vdisks
- delete volume-groups
- delete volumes
- dequarantine
- exit
- expand disk-group
- expand vdisk
- expand volume
- fail
- help
- map volume
- meta
- ping
- query peer-connection
- recover replication-set
- release volume
- remove disk-groups
- remove host-group-members
- remove host-members
- remove ipv6-address
- remove spares
- remove volume-group-members
- replicate
- rescan
- reset all-statistics
- reset controller-statistics
- reset disk-error-statistics
- reset disk-group-statistics
- reset disk-statistics
- reset dns-management-hostname
- reset host-link
- reset host-port-statistics
- reset pool-statistics
- reset smis-configuration
- reset snapshot
- reset vdisk-statistics
- reset volume-statistics
- restart mc
- restart sc
- restore defaults
- resume replication-set
- rollback volume
- scrub disk-groups
- scrub vdisk
- scrub volume
- send support-assist-logs
- set advanced-settings
- set chap-record
- set cli-parameters
- set cloud-iq
- set controller-date
- set debug-log-parameters
- set disk
- set disk-group
- set disk-parameters
- set dns-management-hostname
- set dns-parameters
- set email-parameters
- set enclosure
- set expander-fault-isolation
- set expander-phy
- set fde-import-key
- set fde-lock-key
- set fde-state
- set host
- set host-group
- set host-parameters
- set host-port-mode
- set initiator
- set ipv6-network-parameters
- set iscsi-parameters
- set led
- set network-parameters
- set ntp-parameters
- set password
- set peer-connection
- set pool
- set prompt
- set protocols
- set replication-set
- set schedule
- set snapshot-space
- set snmp-parameters
- set support-assist
- set support-assist-info
- set support-assist-proxy
- set syslog-parameters
- set system
- set task
- set user
- set vdisk
- set volume
- set volume-cache-parameters
- set volume-group
- show advanced-settings
- show cache-parameters
- show certificate
- show chap-records
- show cli-parameters
- show cloud-iq
- show configuration
- show controller-date
- show controllers
- show controller-statistics
- show debug-log-parameters
- show disk-groups
- show disk-group-statistics
- show disk-parameters
- show disks
- show disk-statistics
- show dns-management-hostname
- show dns-parameters
- show email-parameters
- show enclosures
- show events
- show expander-status
- show fan-modules
- show fans
- show fde-state
- show fenced-data
- show frus
- show host-groups
- show host-phy-statistics
- show host-port statistics
- show initiators
- show inquiry
- show ipv6-addresses
- show ipv6-network-parameters
- show iscsi-parameters
- show license
- show maps
- show network-parameters
- show ntp-status
- show peer-connections
- show pools
- show pool-statistics
- show ports
- show power-supplies
- show protocols
- show provisioning
- show redundancy-mode
- show refresh-counters
- show remote-systems
- show replication-sets
- show replication-snapshot-history
- show sas-link-health
- show schedules
- show sensor-status
- show service-tag-info
- show sessions
- show shutdown-status
- show snapshot-space
- show snapshots
- show snmp-parameters
- show support-assist
- show syslog-parameters
- show system
- show system-parameters
- show tasks
- show tiers
- show tier-statistics
- show unwritable-cache
- show users
- show vdisks
- show vdisk-statistics
- show versions
- show volume-copies
- show volume-groups
- show volume-names
- show volume-reservations
- show volume-statistics
- show volumes
- shutdown
- suspend replication-set
- test
- trust
- unfail controller
- unmap volume
- verify disk-groups
- verify links
- verify vdisk
- API basetype properties
- adapt-expand-preview
- advanced-settings-table
- cache-parameter
- cache-settings
- certificate-status
- chap-records
- cli-parameters
- cloud-iq
- code-load-readiness
- code-load-readiness-reasons
- communication-ports
- compact-flash
- contact-information
- controller-cache-parameters
- controllers
- controller-statistics
- copy-volumes
- cs-replicate-tasks
- cs-replication
- cs-replication-set
- current-replication-snapshots
- debug-log-parameters
- disk-groups
- disk-groups-preview
- disk-group-statistics
- disk-group-statistics-paged
- disk-hist-statistics
- disk-statistics
- dns-parameters
- drawers
- drive-parameters
- drive-summary
- drives
- email-parameters
- enclosure-fru
- enclosure-list
- enclosures
- events
- eventsLogs
- expander-ports
- expander-versions
- expanders
- fan
- fan-module-versions
- fan-modules
- fc-port
- fde-state
- fenced-data
- fru-versions
- host
- host-group
- host-group-view
- host-port-statistics
- host-view-mappings
- initiator
- initiator-view
- inquiry
- io-modules
- iom-versions
- ipv6-network-parameters
- iscsi-parameters
- iscsi-port
- license
- local-ports
- local-ports-detail
- log-header-table
- mgmt-hostnames
- midplane-versions
- network-parameters
- ntp-status
- peer-connection-info
- peer-connections
- peer-controllers
- peer-ports
- pool-hist-statistics
- pool-statistics
- pool-summary
- pools
- port
- power-supplies
- product-info
- provisioning
- proxy-information
- psu-versions
- readcache-hist-statistics
- redundancy
- refresh-counters
- remote-ports
- remote-ports-detail
- remote-system
- replication-snapshot-history
- reset-snapshot-tasks
- resettable-statistics
- sas-host-phy-statistics
- sas-port
- sas-status-controller-a
- sas-status-drawer
- schedules
- security-communications-protocols
- sensors
- service-tag-info
- sessions
- show-other-MC-status
- shutdown-status
- sideplanes
- snap-space
- snapshots
- snapshot-with-retention-tasks
- snap-tasks
- snmp-parameters
- spares-preview
- status
- storage-preview
- support-assist
- syslog-parameters
- system
- system-parameters-table
- tasks
- tier-hist-statistics
- tier-statistics
- tier-summary
- tiers
- time-settings-table
- unhealthy-component
- unused-disks-preview
- unwritable-cache
- users
- vdisk-hist-statistics
- vdisk-statistics
- versions
- virtual-disk-summary
- virtual-disks
- volume-groups
- volume-group-view
- volume-group-view-mappings
- volume-names
- volume-reservations
- volumes
- volume-statistics
- volume-view
- volume-view-mappings
- Settings changed by restore defaults
$request->header('dataType' => 'ipa' );
$response = $user_agent->request( $request );
print $response->content;
Alternatively, the dataType in the request header can be set to json for JSON output, or to console for standard CLI text
output. Do not use the console output should for parsing. However, the console output can be useful for tabular reports that are
obtained directly from the CLI commands.
Using XML API output
The Management Controller provides access for monitoring and management using the SSH and Telnet protocols for command-
line interface semantics, or using the HTTP and HTTPS protocols for XML API request/response semantics.
You can use an XML parser, such as XML::Parser in Perl, to process the XML output and store this information as objects.
The output of each CLI command is composed of valid XML data until the CLI prompt (typically #) is encountered. The output
contains a valid XML header followed by the XML elements described in the following table.
Table 1. XML API elements
Element Description and attributes
RESPONSE The RESPONSE element is the top-level element, which contains all data output for the CLI
command that was issued. The response includes:
● A number of OBJECT elements, which varies by command.
● A status object that provides a message and return code. A return code of 0 indicates that
the command succeeded. Any other return code is an error code.
There is only one RESPONSE element per issued command.
OBJECT In general, an OBJECT element describes a storage-system component such as a disk or a
volume. An object has these attributes:
● basetype: This attribute allows output in brief mode to be correlated with metadata to
reduce the overhead of each command, as described in XML API optimization. This is also
a good field to use to detect the type of the object (e.g., a disk, a volume, etc.).
● name: The name of the object.
● oid: The unique identifier for the object in the scope of the response.
The OBJECT element can contain PROPERTY elements.
PROPERTY A PROPERTY element provides detail about the attributes of an OBJECT. A property has
these attributes:
● name: The unique name for the property within the object.
● key: Indicates whether this property is a key value to identify this object.
● type: The type of data represented by the element data.
● size: Typically the maximum size of the output. Usually only important if the console
output is displayed in rows.
● draw: Whether to show or hide this data in console format.
● sort: The type of sorting that can be applied to this property.
● display-name: The label for this data to show in user interfaces.
COMP A COMP (composition) element associates nested objects, such as a task object within a
schedule object. A composition element has these attributes:
● P: The oid of the part component.
● G: The oid of the group component.
An alternative to using COMP elements is described in XML API optimization.
ASC The association element provides a simple association description between two objects in the
response.
● A: First object.
● B: Second object.
14 Using the CLI