CLI Commands

Post Reply
chris
Site Admin
Posts: 14
Joined: Mon Dec 09, 2019 6:55 pm

CLI Commands

Post by chris » Tue Dec 10, 2019 3:54 pm

Monitoring Clusters

show-clusters - Displays the connected clusters’ information.
show-clusters-info - Displays the connected clusters’ information.
show-clusters-upgrade - Displays the clusters’ upgrade status.
show-clusters-upgrade-progress - Displays indicators of the clusters’ software upgrade progress.
show-clusters-performance - Displays clusters’ performance data.
show-clusters-performance-small - Displays clusters’ performance data for small (under 4KB) blocks.
show-clusters-performance-unaligned - Displays clusters’ performance data for unaligned blocks.
show-clusters-performance-latency - Displays clusters’ performance latency data.
modify-clusters-parameters - Displays the connected clusters iSCSI TCP port numbers.
show-clusters-savings - Displays savings parameters of the selected cluster.
modify-cluster-thresholds - Displays thin provisioning soft limits for the connected clusters.
show-clusters-data-protection-properties - Displays clusters’ data protection properties.


Managing Multiple Clusters

add-cluster - Adds a Cluster to the list of Clusters managed by the XMS.
remove-cluster - Removes a Cluster from the list of Clusters managed by the XMS.
set-context - Sets a cluster context in a multiple cluster environment and

Managing Tags

show-tags - Displays the details of all defined Tags.
show-tag - Displays the details of a specified Tag.
create-tag - Creates a Tag for an entity.
tag-object - Assigns a Tag to the specified object.
untag-object - Removes a Tag from the specified object.
modify-tag - Modifies the specified Tag caption.
remove-tag - Deletes a Tag from the Tags list.


Monitoring Cluster Performance

show-most-active - Displays the most active Volumes and Initiator Groups.
show-most-active-initiator-groups - Displays performance data of the most active Initiator Groups.
show-most-active-volumes - Displays performance data of the most active Volumes.


Monitoring X-Bricks

show-bricks - Displays a list of X-Bricks and their associated cluster.
show-clusters - Displays the connected clusters information.
show-storage-controllers - Displays the cluster’s Storage Controllers information and status.
show-ssds - Displays a list of SSDs in the cluster and their properties.
show-bbus - Displays the Battery Backup Units information.


Monitoring Storage Controllers

show-storage-controllers - Displays the cluster’s Storage Controllers information and status.
show-storage-controllers-info - Displays the cluster’s Storage Controllers information.
show-storage-controllers-fw-versions - Displays the Storage Controllers firmware version information.
show-storage-controllers-psus - Displays information on Storage Controllers power supply units.
show-storage-controllers-sensors - Displays a list of sensors and their related information.
test-xms-storage-controller-connectivity - Performs a connectivity check for the specified Storage Controller and its Managing XMS.


Monitoring SSDs

show-ssds - Displays a list of SSDs in the cluster and their properties.
show-ssds-performance - Displays the SSDs performance data.
show-slots - Displays a list of SSD slots and their properties.

Monitoring InfiniBand Switches

show-infiniband-switches - displays InfiniBand Switches’ information.
show-infiniband-switches-ports - Displays InfiniBand Switches’ port information.
show-infiniband-switches-psus - Displays a InfiniBand Switches’ PSU infomation.

Monitoring Data Protection Groups

show-data-protection-groups - Displays XDP groups status and information.
show-clusters-data-protection-properties - Displays the clusters’ data protection properties.
show-data-protection-groups-performance - Displays XDP groups performance information.


Monitoring Local Disks

show-local-disks - Displays the Storage Controller’s Local Disks information.


Monitoring BBUs

show-bbus - Displays Battery Backup Units information.

Monitoring DAEs

show-daes - Displays the cluster’s DAE information.
show-daes-psus - Displays a list of DAE power supply units (PSUs) and their properties.
show-daes-controllers - Displays a list of DAE LCCs (controllers) and their properties.

Monitoring Targets

show-targets - Displays the cluster Targets information.
show-target-groups - Displays a list of Target groups.
show-targets-fc-error-counters - Displays Fibre Channel error counter per Target.
show-target-groups-fc-error-counters - Displays Fibre Channel error counter per Target group.
show-targets-performance - Displays Targets’ performance data.
show-targets-performance-small - Displays Targets’ performance data for small (under 4KB) blocks.
show-targets-performance-unaligned - Displays Targets’ performance data for unaligned blocks.
show-target-groups-performance - Displays Target groups’ performance data.
show-target-groups-performance-small - Displays Target groups’ performance data for small (under 4KB) blocks.
show-target-groups-performance-unaligned - Displays Target groups’ performance data for unaligned blocks.


Monitoring Volumes

show-volume - Displays the specified Volume’s information.
show-volumes - Displays a list of Volumes and their information.
show-volume-snapshot-groups - Displays the defined Snapshot groups and their parameters
show-volumes-performance - Displays Volumes’ performance data.
show-volumes-performance-small - Displays Volumes’ performance data for small (under 4KB) blocks.
show-volumes-performance-unaligned - Displays Volumes’ performance data for unaligned blocks.


Monitoring Consistency Groups

show-consistency-group - Displays the parameters of the specified Consistency Group.
show-consistency-groups - Displays the parameters of all defined Consistency Groups.


Monitoring Initiators

show-initiators Displays Initiators’ data.
show-initiators-performance Displays Initiators’ performance data.
show-initiators-performance-small Displays Initiators’ performance data for small (under 4KB) blocks.
show-initiators-performance-unaligned Displays Initiators’ performance data for unaligned blocks.
show-initiators-connectivity Displays Initiators-Port connectivity and the number of the connected Targets. Specifying the Target-details input parameter, provides the Initiators-Targets connectivity map.
show-discovered-initiators-connectivity Displays the Initiators that are logged in to the cluster but not assigned to any Initiator Group.

Monitoring initiator groups

show-initiators - Displays Initiators’ data.
show-initiators-performance - Displays Initiators’ performance data.
show-initiators-performance-small - Displays Initiators’ performance data for small (under 4KB) blocks.
show-initiators-performance-unaligned - Displays Initiators’ performance data for unaligned blocks.
show-initiators-connectivity - Displays Initiators-Port connectivity and the number of the connected Targets. Specifying the Target-details input parameter, provides the Initiators-Targets connectivity map.
show-discovered-initiators-connectivity - Displays the Initiators that are logged in to the cluster but not assigned to any Initiator Group.

Monitoring Snapshot Sets

show-snapshot-set - displays the parameters of a specified Snapshot Set.
show-snapshot-sets - Displays a list of Snapshot Sets and related information.


Monitoring Cluster Alerts

show-alerts - Displays a list of active alerts and their details.
show-alert-definitions - Displays a list of pre-defined alerts and their definitions.

Managing Reports

show-report - Displays the details of a specified report.
show-reports - Displays a list of defined reports.
show-reports-data - displays a report’s data for a specified entity and category.

Managing Tags

show-tags - Displays the details of all defined Tags.
show-tag - Displays the details of a specified Tag.
create-tag - Creates a Tag for an entity.
tag-object - Assigns a Tag to a specified object.
untag-object - Removes a Tag from a specified object.
modify-tag - Modifies a specified Tag caption.
remove-tag - Deletes a Tag from the Tags list.


Managing Volumes and Snapshots

add-volume - Creates and adds a new Volume.
remove-volume - Removes a Volume.
modify-volume - Modifies a Volume’s parameters.
show-volume - Displays the specified Volume’s information.
show-volumes - Displays a list of Volumes/Snapshots (including properties of each), and the Volume Snapshot Group Index each Volume/Snapshot belongs to.
create-snapshot - Creates a Snapshot from a specified Volume.
create-snapshot-and-reassign - Creates a Snapshot from a specified Volume/Snapshot, Consistency Group, or Snapshot Set and reassigns the Volume identity characteristic to the created Snapshot.
show-volume-snapshot-groups - Displays the Volume Snapshot Group and its members.
add-volume-to-consistency-group - Adds a Volume to a Consistency Group.
create-scheduler - Creates a new Snapshot Scheduler.
show-snapshots - Displays a list of Snapshots and related information.
map-lun - Maps a Volume to an Initiator Group and assigns a Logical Unit Number (LUN) to it.


Managing Consistency Groups

add-volume-to-consistency-group - Adds a Volume to a Consistency Group.
create-consistency-group - Creates a new Consistency Group.
create-snapshot-and-reassign - Creates a Snapshot from a specified Volume/Snapshot, Consistency Group, or Snapshot set and reassigns the Volume identity characteristic to the created Snapshot.
remove-consistency-group - Deletes a Consistency Group.
remove-volume-from-consistency-group - Removes a Volume from a Consistency Group.
show-consistency-group - Displays a specified Consistency Group’s parameters.
show-consistency-groups - Displays all the defined Consistency Groups’ parameters.
create-scheduler - Creates a new Snapshot scheduler.

Managing Snapshot Sets

create-snapshot - Creates a Snapshot from a specified Volume.
create-snapshot-and-reassign - Creates a Snapshot from a specified Volume/Snapshot, Consistency Group, or Snapshot Set and reassigns the Volume identity characteristic to the created Snapshot.
show-snapshot-sets - Displays a list of Snapshot Sets and their data.
show-snapshot-set - displays the parameters of a specified Snapshot Set.
remove-snapshot-set - Removes a Snapshot Set
create-scheduler - Creates a new Snapshot scheduler.


Managing Initiator Groups

add-initiator - Adds an Initiator and associates it with an existing Initiator Group.
add-initiator-group - Adds an Initiator Group and its associated Initiators to the XtreamIO cluster.
modify-initiator - Modifies the properties of an existing Initiator.
remove-initiator - Deletes an Initiator.
remove-initiator-group - Deletes an Initiator Group.
show-initiators - Displays Initiators’ data.
show-initiator-group - Displays information for a specific Initiator Group.
show-initiator-groups - Displays information for a all Initiator Groups.
show-targets - Displays the cluster Targets’ interfaces (iSCSI or FC ports).
show-target-groups - Displays a list of Target Groups.
show-discovered-initiators-connectivity - Displays the Initiators-Targets connectivity map.
show-initiators-connectivity - Displays Initiators-Port connectivity and the number of connected Targets.
map-lun - Maps a Volume to an Initiator Group and assigns a Logical Unit Number (LUN) to it.


Managing Initiators

add-initiator - Adds an Initiator and associates it with an existing Initiator Group.
modify-initiator - Modifies the properties of an existing Initiator.
remove-initiator - Deletes an Initiator.
show-initiators - Displays Initiators’ data.
rename - Renames a component of the XtremIO Storage Array.
show-chap - Displays the cluster’s configured CHAP authentication and discovery modes.
modify-chap - Modifies Chap configuration parameters.


Managing Schedulers

create-scheduler - Creates a new Snapshot Scheduler.
modify-scheduler - Modifies a Snapshot Scheduler’s parameters.
remove-scheduler - Removes a Snapshot Scheduler.
show-scheduler - Displays the parameters of the specified Scheduler.
show-schedulers - Displays the defined Schedulers parameters.
suspend-scheduler - Suspends the activity of an active Scheduler.
resume-scheduler - Resumes the activity of a suspended Scheduler.


Managing alerts

acknowledge-alert Acknowledges an alert and removes it from the dashboard Active Alerts list. The alert remains in the Alert List window. Alerts with Clear Mode set to Acknowledge Required, remain on the Alert List until they are acknowledged.
modify-alert-definition Modifies the alert definition properties for a specified alert type.
show-alert-definitions Displays a list of pre-defined alerts and their definitions.

Managing events

add-event-handler-definition Adds a definition to an event handling rule.
remove-event-handler-definition Deletes the event handling rule definitions.
modify-event-handler-definition Modifies the definition of event handling rules.
show-event-handler-definitions Displays the event handling rule definitions.

Managing iSCSI portals and routes

add-iscsi-portal - Maps a portal to a Target.
add-iscsi-route - Adds and configures iSCSI route parameters.
remove-iscsi-portal - Deletes a portal mapping from a Target.
remove-iscsi-route - Deletes an iSCSI routing configuration.
show-iscsi-portals - Displays a list of iSCSI portals and their properties.
show-iscsi-routes - Displays a list of iSCSI routes and their properties.


Managing Cluster Limits

modify-cluster-thresholds - Modifies the properties for thin provisioning soft limits for connected clusters.
modify-alert-definition - Modifies the alert definition properties for a specified alert type.

Managing Cluster ODX mode

modify-clusters-parameters - Modifies various cluster parameters.
show-clusters-parameters - Displays various cluster parameters.


Configuring CHAP Parameters

modify-chap - Modifies CHAP configuration parameters.
show-chap - Displays the cluster’s configured CHAP authentication and discovery modes.


Managing User Accounts

add-user-account - Adds a new user account.
remove-user-account - Removes a user account.
modify-user-account - Modifies the user account parameters.
modify-password - Used to modify one’s own password, or for entitled users (Configuration and Admin) to modify others’ passwords.
show-user-accounts - Displays the user accounts information.


LDAP server configuration

add-ldap-config - Adds a new LDAP configuration profile to the LDAP configuration table.
modify-ldap-config - Modifies an LDAP configuration profile.
remove-ldap-config - Removes an LDAP configuration profile from the LDAP configuration table.
show-ldap-configs - Displays the LDAP users’ authentication configuration data.

Configuring the Inactivity Timeout

show-xms - Displays the XtremIO management System information.
modify-xms-parameters - Modifies the XMS’s user inactivity timeout.


Managing Email settings

modify-email-notifier - Modifies the email notification settings.
show-email-notifier - Displays the Email notification settings.


Managing SNMP configuration

modify-snmp-notifier - Modifies the SNMP notification settings.
show-snmp-notifier - Shows the SNMP notification settings.


Managing Syslog notification configuration

show-syslog-notifier - Displays the Syslog server notification status and data.
modify-syslog-notifier - Enables Syslog configuration.


Cluster Operations

show-clusters - Obtain the name and index of the cluster
stop-cluster cluster-id=<cluster name> - To stop the cluster via the CLI
start-cluster cluster-id=<cluster name> - To start the cluster via the CLI
power-off cluster-id=<cluster name> shut-down-reason=”reason” - Power off the cluster via the CLI
show-storage-controllers cluster-id=<cluster-name> - View all of the Storage Controllers in the cluster.
show-clusters-performance - Verify that no I/O requests are sent from the host with this command prior to planned shutdown
show-targets-performance cluster-id=<cluster name> - Verify that all output counters for the relevant cluster
show-email-notifier {enable | disable} - Verify email notifications (may want to disable for planned maintenance)
modify-ip-addresses - View the existing Storage Controllers and their respective index numbers.
modify-datetime - Set the time zone.
refresh-xms-ssh-key - Generate a new, unique SSH key for the cluster you are working with

Post Reply