Category Archives: XtremIO

EMC XTremIO CLI Reference Guide (XMSCLI)

Other CLI Reference Guides:
Isilon CLI  |  EMC ECS CLI  |  VNX NAS CLI  |  ViPR Controller CLI  NetApp Clustered ONTAP CLI  |  Data Domain CLI  |  Brocade FOS CLI

This is a quick reference guide for the EMC XTremIO CLI, including all of the commands for cluster monitoring, cluster operations, hardware management, volume operations, administration & configuration, and alerting & events.

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-initiator-group Displays information for a specific Initiator Group.
show-initiator-groups Displays information for all Initiator Groups.
show-initiator-groups-performance Displays Initiator Groups’ performance data.
show-initiator-groups-performance-small Displays Initiator Groups’ performance data for small (under 4KB) blocks.
show-initiator-groups-performance-unaligned Displays Initiator Groups’ performance data for unaligned blocks.
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
Advertisements

XtremIO Manual Log File Collection Procedure

If you have a need to gather XtremIO logs for EMC to analyze and they are unable to connect via ESRS, there is a method to gather them manually.  Below are the steps on how to do it.

1. Log in to the XtremIO Management System (XMS) GUI interface with the ‘admin‘ user account.

2. Click on the ‘Administration‘ tab, which is on the top of the XtremIO Management System (XMS) GUI banner bar.

3. On the left side of the Administration window, choose the ‘CLI Terminal‘ option.

4. Once you have the CLI terminal up, enter the following CLI command at the ‘xmcli (admin)>‘ prompt.  This command will generate a set of XtremIO dossier log files: create-debug-info.  Note that it may take a little while to complete.  Once the command completes and returns you to the ‘xmcli (admin)>’ prompt, a complete package of XtremIO dossier log files will be available for you to download.

Example:

xmcli (admin)> create-debug-info
The process may take a while. Please do not interrupt.
Debug info collected and could be accessed via http:// <XMS IP Address> /XtremApp/DebugInfo/104dd1a0b9f56adf7f0921d2f154329a.tar.xz

Important Note: If you have more than one cluster managed by the XMS server, you will need to select the specific cluster.

xmcli (e012345)> show-clusters

Cluster-Name Index State  Gates-Open Conn-State Num-of-Vols Num-of-Internal-Volumes Vol-Size UD-SSD-Space Logical-Space-In-Use UD-SSD-Space-In-Use Total-Writes Total-Reads Stop-Reason Size-and-Capacity

XIO-0881     1     active True       connected  253         0                       60.550T  90.959T      19.990T              9.944T              44

2.703T     150.288T    none        4X20TB

XIO-0782     2     active True       connected  225         0                       63.115T  90.959T      20.993T              9.944T              20

7.608T     763.359T    none        4X20TB

XIO-0355     3     active True       connected  6           0                       2.395T   41.111T      1.175T               253.995G            6.

251T       1.744T      none        2X40TB

xmcli (e012345)> create-debug-info cluster-id=3

5. Once the ‘create-debug-info‘ command completes, you can use a web browser to navigate to the HTTP address link that’s provided in the terminal session window.  After navigating to the link, you’ll be presented with a pop-up window asking you to save the log file package to your local machine.  Save the log file package to your local machine for later upload.

6. Attach the XtremIO dossier log file package you downloaded to the EMC Service Request (SR) you currently have open or are in the process of opening.  Use the ‘Attachments’ (the paperclip button) area located on the Service Request page for upload.

7. You also have the ability to view a historical listing of all XtremIO dossier log file packages that are currently available on your system. To view them, issue the following XtremIO CLI command: show-debug-info. A series of log file packages will be listed.  It’s possible EMC may request a historical log file package for baseline information when troubleshooting.  To download, simply reference the HTTP links listed under the ‘Output-Path‘ header and input the address into your web browser’s address bar to start the download.

Example:

xmcli (tech)> show-debug-info
 Name  Index  System-Name   Index   Debug-Level   Start-Time                 Create-Time               Output-Path
 1      XtremIO-SVT   1       medium        Mon Aug 14 15:55:10 2017   Mon Aug 14 16:09:40 2017  http://<XMS IP Address>/XtremApp/ DebugInfo/1aaf4b1acd88433e9aca5b022b5bc43f.tar.xz
 2      XtremIO-SVT   1       medium        Mon Aug 14 15:55:10 2017   Mon Aug 14 16:09:40 2017  http://<XMS IP Address>/XtremApp/ DebugInfo/af5001f0f9e75fdd9c0784c3d742531f.tar.xz

That’s it! It’s a fairly straightforward process.