Dell EMC

XtremIO Storage Array

X1 and X2 Cluster Types
XMS Versions 6.3.0, 6.3.1, 6.3.2 and 6.3.3
XIOS Versions 4.0.15, 4.0.25, 4.0.26, 4.0.27, 4.0.31, 6.0.0, 6.0.1, 6.0.2, 6.1.0,
6.2.0, 6.2.1, 6.2.2, 6.3.0, 6.3.1, 6.3.2 and 6.3.3

Admin CLI Guide

P/N 302-005-923
REV. 05
Copyright © 2021 Dell Inc. or its subsidiaries. Published in the USA.

Published April, 2021

Dell believes the information in this publication is accurate as of its publication date. The information is subject to change without
notice.

The information in this publication is provided as is. Dell makes no representations or warranties of any kind with respect to the
information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose. Use,
copying, and distribution of any Dell software described in this publication requires an applicable software license.

Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be property of their respective
owners.

For the most up-to-date regulatory document for your product line, go to Dell EMC Online Support (https://support.emc.com).

2 Dell EMC XtremIO Storage Array CLI Guide

CONTENTS

Preface

Chapter 1 Introduction
Using the Command Line Interface (CLI) ........................................................ 8
Accessing the CLI via an SSH Client ......................................................... 9
Accessing the CLI via an SSH Key Authentication................................... 10
Using the CLI Help....................................................................................... 10
General Guidelines................................................................................ 10
Using Filters .......................................................................................... 11
Specifying Output Parameters ............................................................... 12
Setting Output Display .......................................................................... 13
Objects Naming Limitations ........................................................................ 13
Completion Codes ...................................................................................... 14

Chapter 2 Admin CLI Commands

Introduction................................................................................................ 16
CLI Commands Quick Finder........................................................................ 17
General....................................................................................................... 30
Maintenance............................................................................................... 32
General ................................................................................................. 32
FRU Replacement .................................................................................. 37
Service Maintenance Commands .......................................................... 48
Hardware Diagnostics ........................................................................... 51
Troubleshooting.......................................................................................... 80
Test connectivity ................................................................................... 80
Log Bundle............................................................................................ 85
Health Check......................................................................................... 87
Administration............................................................................................ 88
User management ................................................................................. 88
Certificate Management ........................................................................ 97
Cluster Management (Cluster Level) .................................................... 100
Cluster Management (XMS Level) ........................................................ 114
XMS Notifiers ...................................................................................... 127
IP Addresses ....................................................................................... 136
Provisioning.............................................................................................. 138
Tag Management................................................................................. 138
Volume and Snapshot Management.................................................... 143
Snapshot Set Management ................................................................. 166
Consistency Group Management ......................................................... 169
Initiator and Initiator Group Management............................................ 176
Scheduler Management ...................................................................... 187
Target Management ............................................................................ 193
LUN Mapping ...................................................................................... 196
Quality of Service ................................................................................ 199
iSCSI Management.............................................................................. 204
Data Protection Group Management.................................................... 210

Dell EMC XtremIO Storage Array CLI Guide 3

Contents

Data Protection ......................................................................................... 212

Retention Policy .................................................................................. 212
Local Protection .................................................................................. 218
Remote Protection............................................................................... 228
Cluster Data and Status ............................................................................ 258
Notifications ....................................................................................... 258
Performance........................................................................................ 272
Statistics and Reports ......................................................................... 305
Query Commands ..................................................................................... 318

4 Dell EMC XtremIO Storage Array CLI Guide

PREFACE

As part of an effort to improve its product lines, Dell EMC periodically releases revisions of
its software and hardware. Therefore, some functions described in this document might
not be supported by all versions of the software or hardware currently in use. The product
release notes provide the most up-to-date information on product features.
Contact your Dell EMC technical support professional if a product does not function
properly or does not function as described in this document.

Note: This document was accurate at publication time. Go to Dell EMC Online Support
(https://support.emc.com) to ensure that you are using the latest version of this
document.



This document provides specific information on XtremIO clusters that are managed by
XMS versions 6.3.0 and 6.3.1. For XtremIO clusters that are managed by earlier XMS
versions, refer to the appropriate XtremIO product documents which are provided for
these versions.

Purpose
This document provides the required information for using the EMC XtremIO Storage Array.

Audience
This document is intended for the Dell host storage administrator, system administrator,
or operator who will be involved in managing the XtremIO Storage Array.

Related Documentation
The following Dell EMC publications provide additional information:
 XtremIO Storage Array Host Configuration Guide
 XtremIO Storage Array Site Preparations Guide for X2 Cluster Type
 XtremIO Storage Array Site preparations Guide for X1 Cluster Type
 XtremIO Storage Array Security Configuration Guide
 XtremIO Storage Array User Guide
 XtremIO Storage Array RESTful API Guide
 XtremIO Storage Array XIOS Release Notes
 XtremIO Storage Array XMS Release Notes

Preface 5
Preface

6 Dell EMC XtremIO Storage Array CLI Guide

CHAPTER 1
Introduction

This chapter includes the following topics:

 Using the Command Line Interface (CLI) .................................................................... 8
 Using the CLI Help................................................................................................... 10
 Objects Naming Limitations .................................................................................... 13
 Completion Codes .................................................................................................. 14

Introduction 7
Introduction

Using the Command Line Interface (CLI)

You can manage and monitor the XtremIO Storage Array, using the CLI.
You can access the CLI via an SSH client (see “Accessing the CLI via an SSH Client” on
page 9)
When accessing the CLI via an SSH client, you can authenticate either using a name and a
password or using SSH key authentication (see “Accessing the CLI via an SSH Key
Authentication” on page 10).

Note: In Storage Controllers running XIOS version 4.0.25-22 (or later) and in XMS running
version 4.2.2-18 (or later) the sshd configuration was enhanced to disable weak ciphers
for SSL connectivity. This was done to enhance security and resolve some vulnerabilities
that occurred when this algorithm was used. Due to this change, some older versions of
the PuTTY SSH client and WinSCP SFTP client may cause an error when accessing or
transferring files to or from the XMS. For further details, refer to Dell EMC KB# 504645
(https://support.emc.com/kb/504645).
To avoid such errors, make sure that WinSCP and PuTTY (or any SSH client and SFTP client
used) are updated to the most recent version to enable accessing and transferring files to
or from the XMS.

8 Dell EMC XtremIO Storage Array CLI Guide

 Introduction

Accessing the CLI via an SSH Client

Note: The CLI access via SSH requires two sets of credentials. The first set is generic to any
user. The second set is user-specific according to the user assigned to you by the System
or Storage Administrator.

To access the CLI via an SSH client:

1. SSH to the XMS server with the following credentials:
• User - xmsadmin
• Password - the password assigned by your system administrator
2. Log in to XtremIO, using the username and password assigned by your system
administrator (refer to the XtremIO Storage Array User Guide); the XMCLI session
prompt appears, allowing you to run only XMCLI commands according to your user’s
role.

Figure 1 CLI Terminal - Session Prompt

Using the Command Line Interface (CLI) 9

Introduction

Accessing the CLI via an SSH Key Authentication

An administrator may associate an SSH public key with the administrator’s account and
configure the SSH client to present the corresponding private key upon login. This allows
secure access to the CLI without entering any credentials.

To access the CLI via an SSH key authentication:

1. Create a user on a remote server and generate an SSH public key pair.
2. Copy the user’s public key content to your clipboard.
3. Log in to the XMCLI with an administrative account.
4. Run the add-user-account XMCLI command with the "public-key" parameter.
5. From the remote server, log in to the XMS, using ssh user@xms; the user logs into
the XMCLI directly.

Using the CLI Help

General Guidelines
To use the CLI Help more efficiently, follow these guidelines:
 Typing a question mark followed by a string or a partial string displays all commands
that contain the typed string.
 Typing a partial string and then pressing the Tab key twice displays all commands that
match the typed string.
 To view the usage and parameters of a specific command, type a question mark or the
word help followed by the command name and press Enter.
 For input parameters that have a set of possible values, type the command name
followed by the parameter, and then press the Tab key twice to receive the full list of
possible values. For example, typing the following:
add-event-handler-definition entity=<Tab> <Tab>
provides the following output:
xmcli (admin)> add-event-handler-definition entity=
BatteryBackupUnit DAEController InfinibandSwitch IscsiPortal
NVRAM StorageController TargetGroup X-Brick Cluster DAEPSU
InfinibandSwitchPSU IscsiRoute SSD StorageControllerPSU
UserAccount XEnv ConsistencyGroup DAERowController Initiator
LocalDisk Scheduler SyrNotifier Volume Xms DAE
DataProtectionGroup InitiatorGroup Module SnapshotSet Target
VolumeSnapshotGroup

10 Dell EMC XtremIO Storage Array CLI Guide

 Introduction

Using Filters
All show commands, i.e. commands that provide information about the system (rather
than manipulate it) support the option to filter the displayed results of the command. Any
object property can be selected as a filter.
If you want to use multiple filters, separate them with a logical AND or a logical OR, using
ampersand (&) and comma, respectively. The filter implements all AND rules first and then
all OR rules on the received results.
The filters are based on a logical statement as described in the following table.

Object Type Logical Statement

Numeric • eq - equal
• ne - not equal
• ge - greater equal
• gt - greater than
• lt - less than
• le - less equal

String Like - contains all or part of the string

Date time yyyy-mm-dd hh:mm:ss + different to Greenwich time

Filter syntax:
Filter=property1:OPERATOR:value&property2:OPERATOR:value
Filter example:
show-volumes filter=Vol-Size:gt:1T&vol-name:like:ProdTime
For the usage of filters, see “help-filters” on page 30.

Using the CLI Help 11

Introduction

Specifying Output Parameters

Running a "show" type command results in a default list of output parameters. This list
may not meet your needs on the following cases:
 The displayed list is extensive, making it hard to locate the relevant output data, when
only a subset of the output parameters is relevant.
 You need data that is not included in the default parameter list (as it does not contain
all possible output parameters).
Using the prop-list input parameter when running the command enables you to
specify which output parameters should be displayed in response.
The usage of the prop-list parameter is as follows:
prop-list=[property1, property2, property3, etc.]
The following example demonstrates using the prop-list input parameter
show-targets prop-list=[Name, Mac-Addr]
You can view the full parameter list by typing the command name followed by
prop-list=[ and then hitting the Tab key twice.

12 Dell EMC XtremIO Storage Array CLI Guide

 Introduction

Setting Output Display

All show commands, i.e. commands that provide information about the system (rather
than manipulate it) display the output data in a table format by default, as shown in the
following example:

xmcli (admin)> show-daes-fans

Name Index DAE-Index Fan-Pair-Index Fan-Pair-HW-Label Fan-Pair-Status
X1-DAE 1 1 1 Fan0 healthy
X1-DAE 1 1 2 Fan1 healthy
X1-DAE 1 1 3 Fan2 healthy
X1-DAE 1 1 4 Fan3 healthy

Some of the "show" type commands enables using the vertical input parameter, which
displays the command output as a list, as shown in the following example:

xmcli (admin)> show-daes-fans vertical

Name: X1-DAE
Index: 1
DAE-Index: 1
Fan-Pair-Index: 1
Fan-Pair-HW-Label: Fan0
Fan-Pair-Status: healthy
Name: X1-DAE
Index: 1
DAE-Index: 1
Fan-Pair-Index: 2
Fan-Pair-HW-Label: Fan1
Fan-Pair-Status: healthy
Name: X1-DAE
Index: 1
DAE-Index: 1
Fan-Pair-Index: 3
Fan-Pair-HW-Label: Fan2
Fan-Pair-Status: healthy
Name: X1-DAE
Index: 1
DAE-Index: 1
Fan-Pair-Index: 4
Fan-Pair-HW-Label: Fan3
Fan-Pair-Status: healthy

Objects Naming Limitations

Volume and object names used as parameters in the CLI commands must comply with the
following limitations:
 Allowed length: up to 64 characters
 Valid characters:
• Alphanumeric characters
• Space character
• The following characters: ~ ! @ # $ % ^ * _ + { } | : ? . -
 Invalid characters: & / < > ( )

Objects Naming Limitations 13

Introduction

Completion Codes
The following table contains a list of general completion codes that can be returned by any
command.

Output Parameter Description

unauthorized_command The user account which issued this command does not have the
required authorization level.

user_not_found The specified user account does not exist.

ok The command completed successfully.

invalid_command The issued command is invalid.

invalid_input Invalid values were entered with the command. For example, a
string was entered for a property that requires an IP address.

system_communication_err The management server cannot communicate with the cluster,

or possibly due to a network error.

system_general_error An error has occurred in the cluster.

system_is_busy The command cannot be completed because the cluster is busy.

system_timeout the command timed out before it was completed.

no_sys_response_retrying The management server lost communication with the cluster after a
command was issued and it is not known if the command
completed successfully.
This error should clear once communication with the cluster has
been restored.

uncertain_object_error The current state of the component for which this command was
issued is not known.
An uncertainty_error completion code has already been issued for
this component.
If this completion code appears, some XMCLI commands display
"pending" under the certainty-state field. If this persists, contact
XtremIO.

invalid_in_cur_sys_state The command is invalid because of the current Cluster State. For
example, a stop-cluster command was issued and the cluster is
already stopped.

14 Dell EMC XtremIO Storage Array CLI Guide

CHAPTER 2
Admin CLI Commands

This chapter includes the following topics:

 Introduction............................................................................................................ 16
 CLI Commands Quick Finder.................................................................................... 17
 General................................................................................................................... 30
 Maintenance........................................................................................................... 32
 Troubleshooting...................................................................................................... 80
 Administration........................................................................................................ 88
 Provisioning.......................................................................................................... 138
 Cluster Data and Status ........................................................................................ 258

Admin CLI Commands 15

Admin CLI Commands

Introduction
This chapter lists all admin-level CLI commands.
For each command, the following information is provided:
 Command name
 Command description
 Command usage syntax
 Input and output parameters details
 Command usage example

16 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

CLI Commands Quick Finder

Command Description Page

acknowledge-advisory-notice Acknowledges an Advisory Notice. 271

acknowledge-alert Acknowledges an active alert. 266

add-cluster Adds a cluster to the list of clusters managed by 32

the XMS.

add-copy-volume-to-consistency-gr Creates a copy of a Volume which is a member of a 173

oups Consistency Group and adds the copy to all
Consistency Groups specified in a list.

add-event-handler-definition Adds a new event handling rule. 258

add-initiator Adds an Initiator and associates it with an existing 180

Initiator Group.

add-initiator-group Adds a new Initiator Group and assigns Initiators 176

to it.

add-iscsi-portal Creates an iSCSI portal (IP/VLAN) on a specific 204

iSCSI Target port.

add-iscsi-route Configures a new routing rule for iSCSI traffic. 204

add-ldap-config Adds a new LDAP configuration profile to the LDAP 137

configuration table.

add-local-protection-session Adds a new local protection session. 218

add-protection-retention-policy Adds a new Retention Policy. 212

add-qos-policy Adds a new Quality of Service policy. 199

add-remote-protection-ip-link Adds an IP link between a source cluster and a 228

target cluster.

add-remote-protection-peer-xms Registers a remote XMS to the local XMS. 232

add-remote-protection-session Creates a new Remote Protection Session. 234

add-remote-protection-volume-pair Pairs a source and target Volumes and adds them 244
to the Remote Protection Session.

add-ssd Adds an SSD to the X-Brick and initializes it. 39

add-user-account Creates a new user account to XMS. 88

add-volume Creates a new Volume. 143

add-volume-to-consistency-group Adds a Volume to an existing Consistency Group. 169

add-xms-secondary-ip-address Adds a secondary XMS IP address and default 122

gateway.

calculate-savings Calculates saving metrics for the specified Volume 165

Snapshot Group, derived from Data Reduction
Ratio per volume and copy efficiency features.

clear-volume-reservation Removes LUN reservations to release them for 162

access.

CLI Commands Quick Finder 17

Admin CLI Commands

Command Description Page

control-led Turns an indicator LED on or off. 46

copy-protection-retention-policy Copies all retention policies or a specified 213

Retention Policy from one cluster to another.

create-consistency-group Creates a new Consistency Group. 170

create-debug-info Creates a log bundle. 85

create-protection-copy Creates a Protection Copy of a Consistency Group 152

or a Snapshot Set.

create-repurpose-copy Creates a Snapshot Set or Consistency Group with 151

a Regular Volume copy of the specified Volume.

create-scheduler Creates a new Protection Scheduler. 187

create-server-certificate-signing-req Instructs the server to generate a public-private 97

uest key pair and a certificate signing request.

create-snapshot Creates a Copy from a specified Volume. 153

create-snapshot-and-reassign Creates a Snapshot from a specified 154

Volume/Snapshot, Consistency Group, or
Snapshot Set and reassigns the Volume identity
characteristic to the created Snapshot.

create-tag Creates a new Tag for a specified entity. 138

deactivate-storage-controller Deactivates an active Storage Controller. 41

exit Closes the CLI terminal. 30

export-performance-history Exports the cluster’s performance history to CSV 273

file.

export-xms-cluster-configuration Exports a backup file containing all XMS and 118

cluster objects to a down-loadable file.

help Displays the available CLI commands. 30

help-filters Displays the list of all available CLI commands 30

output filters and syntax examples.

import-xms-cluster-configuration Imports XMS and cluster configuration from a 119

configuration file.

install-self-signed-server-certificate Installs the new self-signed certificate. 98

manage-local-protection-session Starts, suspends or resumes a local protection 219

session.

manage-remote-protection-session Enables to perform actions in the context of the 238

Remote Protection Session.

map-lun Maps a Volume to an Initiator Group and assigns a 196

Logical Unit Number (LUN) to it.

modify-alert-definition Modifies the default parameters of a defined alert 266

type.

modify-chap Modifies the CHAP configuration parameters. 209

modify-cluster-thresholds Modifies the properties for thin provisioning soft 102

limits for the connected clusters.

18 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Command Description Page

modify-clusters-parameters Modifies various cluster configuration 100

parameters.

modify-consistency-group Modifies the Q0S-related parameters of the 245

specified Consistency Group.

modify-consistency-group-volumes Modifies the Volume type for the specified a 172

Consistency Group.

modify-datetime Sets or modifies the cluster’s date and time, 124

timezone, or NTP server parameters.

modify-dns-servers Sets or modifies the IP address of the primary 95

and/or secondary DNS server.

modify-email-notifier Modifies the Email notification settings. 127

modify-event-handler-definition Modifies an event handling rule. 260

modify-initiator Modifies the properties of an existing Initiator. 182

modify-initiator-group Modifies the "Operating System" setting of the 177

specified Initiator Group.

modify-ip-addresses Modifies the XMS and/or Storage Controllers’ 136

management IP configuration.

modify-iscsi-portal Modifies an iSCSI portal parameters. 205

modify-ldap-config Modifies an LDAP configuration profile. 93

modify-local-protection-session Modifies the parameters of a local protection 220

session.

modify-login-banner Modifies the login banner text. 124

modify-password Modifies the XMS user account’s password. 91

modify-performance-data-collectio Modifies the performance data collection mode of 272

n specified Volumes.

modify-protection-retention-policy Modifies the parameters of a Retention Policy. 214

modify-qos-policy Modifies the parameter of a selected Quality of 200

Service policy.

modify-remote-protection-ip-link Modifies the parameters of an IP link between a 229

source cluster and a target cluster.

modify-remote-protection-peer-xms Modifies the parameters of a remote XMS 233

registered at the local XMS.

modify-remote-protection-session Modifies the parameters of a Remote Protection 236

Session.

modify-remote-protection-snapshot Modifies the name of a Protection Snapshot Set. 248

-set

modify-scheduler Modifies an existing Protection Scheduler. 189

modify-server-certificate Initiates loading of a signed certificate and a key. 99

modify-server-name Defines or modifies the XMS’s URL. 125

modify-snmp-notifier Modifies the SNMP notification settings. 129

CLI Commands Quick Finder 19

Admin CLI Commands

Command Description Page

modify-ssh-firewall Modifies the lock mode of the SSH firewall. 109

modify-syr-notifier Modifies the ESRS (EMC Secure Remote Support) 132

notification parameters.

modify-syslog-notifier Adds or removes servers from the Syslog server 134

list.

modify-tag Modifies a specified Tag’s caption. 138

modify-target Modifies a Target’s parameters. 193

modify-target-group Modifies a Target Group’s parameters. 195

modify-technician-port-tunnel Opens or closes a technician port tunnel to a 38

specific Storage Controller.

modify-user-account Modifies an XMS user account’s parameters. 89

modify-volume Modifies a Volume’s parameters. 144

modify-xms-parameters Modifies the XMS’s parameters. 173

power-off Powers off a Storage Controller or an entire 48

cluster.

power-on Powers on a Storage Controller. 48

query-remote-protection-objects Provides customized monitoring data for Remote 318

Protection objects.

quit Closes the CLI terminal. 30

refresh-advisory-notices Queries for new Advisory Notices and refreshes 271

the displayed list.

refresh-data Refreshes a copy of a Volume or Consistency 157

Group.

refresh-xms-ssh-key Generates a new unique SSH key on the XMS and 117
updates all related clusters accordingly.

remove-cluster Removes a cluster from the list of clusters 33

managed by the XMS.

remove-consistency-group Deletes a Consistency Group. 171

remove-debug-info Deletes an existing log bundle 85

remove-event-handler-definition Removes an event handling rule. 262

remove-exported-configuration Removes an XMS and cluster configuration file. 120

remove-initiator Deletes an Initiator. 181

remove-initiator-group Deletes an Initiator Group. 177

remove-iscsi-portal Deletes a portal mapping from a Target. 205

remove-iscsi-route Deletes an iSCSI routing rule. 206

remove-ldap-config Removes an LDAP configuration profile from the 92

LDAP configuration table.

remove-local-protection-session Deletes a local protection session. 221

20 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Command Description Page

remove-protection-retention-policy Deletes a protection Retention Policy. 215

remove-qos-policy Deletes a selected Quality of Service policy. 201

remove-remote-protection-ip-link Deletes an IP link between a source cluster and a 230

target cluster.

remove-remote-protection-peer-xm Removes a registration of a remote XMS from the 233

s local XMS.

remove-remote-protection-session Deletes a replication session. 240

remove-remote-protection-volume- Removes a Volume pair from the Remote 245

pairs Protection Session.

remove-scheduler Deletes a Protection Scheduler. 190

remove-secured-snap-flag Modifies the secured-snap flag to false, to enable 199

the Volume deletion.

remove-snapshot-set Removes a Snapshot Set 166

remove-tag Removes a Tag from the tags list. 139

remove-user-account Removes an XMS user account. 90

remove-volume Removes a Volume. 146

remove-volume-from-consistency-g Removes a Volume from a Consistency Group. 170

roup

remove-xms-secondary-ip-address Removes a secondary XMS IP address and default 122

gateway

rename Renames a component of the XtremIO Storage 31

Array.

restart-xms Restarts the XMS service. 50

restore-data Restores data of a Volume or Consistency Group. 156

restore-xms-simulator-configuratio Restores XMS and cluster objects from an 126

n exported configuration or a log bundle.

resume-scheduler Resumes a suspended Protection Scheduler. 190

run-health-check-assessment Runs a Health Check Script on the cluster. 87

send-email-notification Verifies the Email configuration by sending a test 128

message containing a user-defined text.

send-snmp-notification Verifies the SNMP configuration by sending a test 130

message containing a user-defined text.

send-syr-notification Sends a predefined ESRS (EMC Secure Remote 133

Support) notification.

send-syslog-notification Verifies the Syslog configuration by sending a test 135

message containing a user-defined text.

set-context Sets a cluster context in a multiple cluster 109

environment and renders the need to specify the
cluster ID.

set-interactive-mode Sets interactive/non-interactive mode for the 123

XMS, to enable running CLI scripts.

CLI Commands Quick Finder 21

Admin CLI Commands

Command Description Page

show-advisory-notice Displays the details of a specified Advisory 269

Notice.

show-advisory-notices Displays a list of outstanding Advisory Notices 270

and their details.

show-alert-definitions Displays a list of pre-defined alerts and their 267

definitions.

show-alerts Displays a list of active alerts and their details. 268

show-bbus Displays the Battery Backup Units information. 43

show-bricks Displays a list of X-Bricks and their associated 45

cluster.

show-chap Displays the cluster’s configured CHAP 208

authentication and discovery modes.

show-cluster-dae-temperature-thre Shows the currently configured thresholds for the 111

sholds cluster's DAE temperature sensors.

show-cluster-ssd-temperature-thres Shows the currently-configured thresholds for the 113

holds cluster's SSD temperature sensors.

show-clusters Displays the main properties and the status of 33

connected clusters.

show-clusters-data-protection-prop Displays the clusters’ data protection properties. 102

erties

show-clusters-info Displays additional information about configured 103

clusters.

show-clusters-parameters Displays configured clusters parameters. 105

show-clusters-performance Displays the Clusters’ performance data. 274

show-clusters-performance-latency Displays the Clusters’ performance latency data. 275

show-clusters-performance-small Displays the Clusters’ performance data for small 276

blocks.

show-clusters-performance-unalign Displays the Clusters’ performance data for 277

ed unaligned blocks.

show-clusters-savings Displays a list of data-reduction related values per 106

cluster.

show-clusters-thresholds Displays thin provisioning soft limits for the 108

connected clusters.

show-clusters-upgrade Displays the clusters’ software upgrade status. 35

show-clusters-upgrade-progress Displays indicators of the clusters’ software 36

upgrade progress.

show-consistency-group Displays the members and properties of the 174

specified Consistency Group.

show-consistency-groups Displays a list of all Consistency Groups and their 175

properties.

show-consistency-groups-performa Displays the Consistency Groups’ performance 296

nce data.

22 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Command Description Page

show-copies Displays a list of all copies of the specified 160

Volume or Consistency Group.

show-daes Displays the list of DAEs and their properties. 51

show-daes-controllers Displays the list of DAE Controllers and their 52

properties.

show-daes-controllers-sas-error-co Displays a list of diagnostic counters that can 312

unters indicate problems in the SAS link between the
Storage Controller/DAE Row Controller and the
specified DAE Row Controller.

show-daes-controllers-sas-ports Displays the DAE Controllers SAS ports 55

information.

show-daes-fans Displays the list of DAE fans and their properties. 58

show-daes-psus Displays the list of DAE power suppliers and their 57

properties.

show-daes-row-controllers Displays the list of DAE Row Controllers and their 53

properties.

show-daes-row-controllers-sas-erro Displays a list of diagnostic counters that can 313

r-counters indicate problems in the SAS link between the
DAE Row Controller/SSD and the specified DAE
Row Controller.

show-daes-row-controllers-sas-port Displays the DAE Row Controllers SAS ports 56

s information.

show-data-protection-groups Displays a list of DPGs and their properties. 210

show-data-protection-groups-perfo Displays Data Protection Groups performance 298

rmance information.

show-datetime Displays the Cluster’s time-related information. 123

show-debug-info Lists the log bundles that were created on the 86

XMS.

show-discovered-initiators-connect Displays a list of Initiator ports discovered by the 80

ivity Storage Controllers.

show-dns-servers Displays the IP addresses of the primary and 95

secondary DNS servers (if configured).

show-email-notifier Displays the Email notification settings. 128

show-event-details Displays the details of the specified event. 263

show-event-handler-definitions Displays the existing event handling rules. 262

show-events Displays cluster and XMS events. 264

show-exported-configurations Displays a list of the available XMS/cluster 118

configuration backups.

show-infiniband-switches Displays InfiniBand Switches’ information. 59

show-infiniband-switches-ports Displays InfiniBand Switches’ port information. 60

show-infiniband-switches-ports-err Displays status of the InfiniBand Switches' ports 309

or-counters error counters.

CLI Commands Quick Finder 23

Admin CLI Commands

Command Description Page

show-infiniband-switches-psus Displays InfiniBand Switches’ PSUs information. 62

show-initiator Lists the properties for a specific Initiator. 184

show-initiator-group Displays information for a specific Initiator Group. 178

show-initiator-groups Displays a list of all Initiator Groups and their 179

properties.

show-initiator-groups-performance Displays Initiator Groups’ performance data. 278

show-initiator-groups-performance- Displays Initiator Groups’ performance data for 279

small small blocks.

show-initiator-groups-performance- Displays Initiator Groups’ performance data for 280

unaligned unaligned blocks.

show-initiators Lists all Initiators and their properties. 185

show-initiators-connectivity Displays a list of configured Initiator ports and the 81

number of available paths.

show-initiators-performance Displays Initiators’ performance data. 281

show-initiators-performance-small Displays Initiators’ performance data for small 282

block sizes.

show-initiators-performance-unalig Displays Initiators’ performance data for 283

ned unaligned data block.

show-ip-addresses Displays the XMS and Storage Controllers’ 137

management IP configuration.

show-iscsi-portals Displays the list of iSCSI portals and their 206

properties.

show-iscsi-routes Displays the list of iSCSI routes and their 207

properties.

show-ldap-configs Lists the LDAP server configurations and their 94

parameters.

show-leds Displays the values for the identification and 64

status LEDs.

show-local-disks Displays the Storage Controllers’ disks 63

information.

show-local-protection-consistency- Displays the details of a Consistency Group that is 221

group a part of a local protection session.

show-local-protection-consistency- Displays the details of all Consistency Group that 222

groups are a part of a local protection session.

show-local-protection-session Displays the details of a specified local protection 223

session.

show-local-protection-sessions Displays the details of all local protection 225

sessions.

show-local-protection-snapshot-set Lists the Snapshot Sets related to a specified 226

s Local Protection Session.

show-lun-mappings Displays a list of all mappings between Volumes 197

and Initiator Groups.

24 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Command Description Page

show-most-active Displays the most active Volumes and Initiator 164

Groups.

show-most-active-initiator-groups Displays performance data of the most active 163

Initiator Groups.

show-most-active-volumes Displays performance data of the most active 162

Volumes.

show-nvrams Displays a list of Storage Controllers NVRAM cards 63

and their properties

show-protection-retention-policies Displays the parameters of all defined retention 217

policies.

show-protection-retention-policy Displays the parameters of a specified Retention 216

Policy.

show-qos-policies Displays the parameters of all defined Quality of 202

Service policies.

show-qos-policy Displays the parameters of a selected Quality of 201

Service policy.

show-remote-protection-clusters Displays all clusters managed either by local or 256

remote XMS and can be used for Remote
Protection.

show-remote-protection-consistenc Displays the properties of a Remote Protection 251

y-group Consistency Group.

show-remote-protection-consistenc Displays the properties of all Remote Protection 252

y-groups Consistency Groups.

show-remote-protection-domain Displays the replication domain. 256

show-remote-protection-ip-link Displays the parameters of the specified IP link. 230

show-remote-protection-ip-links Displays the parameters of all IP links. 231

show-remote-protection-ip-links-pe Displays Remote Protection IP links performance 303

rformance information.

show-remote-protection-peer-xms Displays all remote XMSs registered at the local 234

XMS.

show-remote-protection-ports Displays all ports configured as Remote Protection 257

targets.

show-remote-protection-session Displays the parameters of a Remote Protection 241

Session.

show-remote-protection-sessions Displays the parameters of all Remote Protection 243

Sessions.

show-remote-protection-sessions-p Displays Remote Protection Performance 299

erformance information.

show-remote-protection-snapshot- Displays the properties of a Remote Protection 249

set Snapshot Set.

show-remote-protection-snapshot- Displays the PITs of a Remote Protection Session. 250

sets

show-remote-protection-targets-per Displays Remote Protection targets performance 301

formance information.

CLI Commands Quick Finder 25

Admin CLI Commands

Command Description Page

show-remote-protection-volume Displays the properties of a Volume that is a part 253

of a Remote Protection Session.

show-remote-protection-volume-pa Displays the properties of a Volume pair. 245

ir

show-remote-protection-volume-pa Displays the properties of all Volume pair of a 246

irs Remote Protection Session.

show-remote-protection-volumes Displays the properties of all Volumes included in 254

a specified Consistency Group that is part of a
Remote Protection Session.

show-remote-servers-status Displays the NTP, DNS and default gateway server 96

connectivity status.

show-report Displays the details of a specified report. 315

show-reports Displays the list of defined reports. 316

show-reports-data Displays detailed report’s data for the specified 317

entity and category.

show-scheduler Displays the properties of the specified Protection 191

Scheduler.

show-schedulers Displays a list of Protection Schedulers and their 192

properties.

show-server-certificate Displays the currently loaded certificate. 98

show-server-certificate-signing-req Displays the certificate signing request. 98

uest

show-server-name Displays the server name, according to the name 125

configuration mode.

show-slots Displays the list of all DAE(s) SSD slots and their 65
properties.

show-snapshot-set Displays the parameters of the specified 167

Snapshot Set.

show-snapshot-sets Displays the list of Snapshot Sets and their data. 168

show-snapshots Displays the list of Snapshots and related 158

information.

show-snmp-notifier Displays SNMP notification configuration. 131

show-ssd Displays the properties of a single DAE SSD. 67

show-ssd-sas-error-counters Displays the list of diagnostic counters that can 305

indicate problems in the SAS link between the
DAE Row Controller and a specified SSD.

show-ssds Displays a list of DAE SSDs and their properties. 66

show-ssds-diagnostic Displays SSDs’ diagnostic information. 40

show-ssds-performance Displays SSDs’ performance data. 284

show-storage-controllers Displays a list of Storage Controllers and their 69

properties.

26 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Command Description Page

show-storage-controllers-fw-versio Displays the Storage Controllers’ firmware version 70

ns information.

show-storage-controllers-infiniban Displays the Storage Controllers’ InfiniBand error 307

d-error-counters counters.

show-storage-controllers-infiniban Displays the Storage Controllers’ InfiniBand port 71

d-ports information.

show-storage-controllers-info Displays the Storage Controllers’ information. 72

show-storage-controllers-psus Displays a list of Storage Controller’s PSUs and 73

their properties.

show-storage-controllers-sas-error- Displays a list of diagnostic counters that can 306

counters indicate problems in the SAS link between the
DAE Controller and the specified Storage
Controller.

show-storage-controllers-sas-ports Displays the Storage Controllers’ SAS ports 75

information.

show-storage-controllers-sensors Displays a list of Storage Controllers sensors and 76

their properties.

show-syr-notifier Displays the ESRS (EMC Secure Remote Support) 133

information notification configuration.

show-syslog-notifier Displays the Syslog server notification status. 135

show-tag Displays the details of the specified Tag. 139

show-tags Displays a list of Tags and their properties. 140

show-target-groups Displays the list of Target Groups. 195

show-target-groups-fc-error-counter Displays Fibre Channel error counters per Target 310

s Group.

show-target-groups-performance Displays Target Groups’ performance data. 285

show-target-groups-performance-s Displays Target Groups’ performance data for 286

mall small blocks.

show-target-groups-performance-u Displays Target Groups’ performance data for 287

naligned unaligned blocks.

show-targets Displays a list of iSCSI and FC Target interfaces 194

and their properties.

show-targets-fc-error-counters Displays Fibre Channel error counters per Target. 311

show-target-sfp Displays monitoring data and warning thresholds 77

of an SFP that is plugged in a specified Target
port.

show-targets-iscsi-counters Displays error counters information for iSCSI 314

targets.

show-targets-performance Displays Targets’ performance data. 288

show-targets-performance-small Displays Targets’ performance data for small 289

blocks.

show-targets-performance-unaligne Displays Targets’ performance data for unaligned 290

d blocks.

CLI Commands Quick Finder 27

Admin CLI Commands

Command Description Page

show-targets-sfps Displays monitoring data of SFPs that are 79

plugged-in target ports.

show-technician-port-tunnels Shows the status of the defined technician port 37

tunnels.

show-timezones Displays the list of available timezones. 123

show-user-accounts Displays the XMS user account information. 90

show-volume Displays the specified Volume’s information. 148

show-volume-reservations Displays the specified Volume’s SCSI reservation 161

information.

show-volume-snapshot-groups Displays the list of Volume Snapshot Groups and 150

their properties.

show-volumes Displays the list of Volumes with their associated 146

Snapshots and their parameters.

show-volumes-performance Displays the Volumes’ performance data. 292

show-volumes-performance-small Displays the Volumes’ performance data for small 294

blocks.

show-volumes-performance-unalig Displays the Volumes’ performance data for 295

ned unaligned blocks.

show-volumes-savings Displays saving metrics per Volume or group of 165

Volumes, derived from Data Reduction Ratio per
volume and copy efficiency features.

show-xenvs Displays the list of Storage Controller 110

X-Environments, their state and CPU utilization.

show-xms Displays the XMS machine’s information. 114

show-xms-esrsve-registration Displays registration status of clusters to 117

primary/secondary ESRS-VE gateways.

show-xms-info Displays information on server statistics, disk 136

usage and Ethernet interfaces.

show-xms-parameters Displays the XMS’s parameters. 116

shutdown-xms Stops the XMS service or shuts down the 49

machine.

start-cluster Starts cluster services and allows a user to access 49

the storage array.

stop-cluster Stops cluster services. 50

suspend-scheduler Suspends an active Protection Scheduler. 190

tag-object Tags an object. 141

test-ip-connectivity Verifies the connectivity between a Storage 82

Controller and a specified IP address.

test-ip-connectivity-netcat Verifies the connectivity between a source IP 82

address and a specified destination IP address
and TCP/UDP port.

28 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Command Description Page

test-ip-connectivity-ping Verifies ping connectivity between a source IP 83

address and a destination IP address.

test-xms-storage-controller-connect Verifies the connectivity between the XMS and a 84

ivity Storage Controller.

test-xms-tcp-connectivity Performs a connectivity check for the specified 128

TCP port and the XMS.

unmap-lun Removes a Volume’s mappings to one or more 198

Initiator Groups.

untag-object Removes a Tag from the specified object. 142

CLI Commands Quick Finder 29

Admin CLI Commands

General
exit
The exit admin-level command closes the CLI terminal.
Displayed data is removed upon exiting the CLI terminal and does not appear when the
terminal is reopened.
Usage:
exit

help
The help admin-level command displays the list of all available CLI commands, or
provides full usage information of a specified command.
Using the help command followed by a string or a partial string displays all available CLI
command names that contain that string.
Usage:
help
help dae

help-filters
The help-filters admin-level command displays the list of all available CLI
commands output filters and syntax examples.
Usage:
help-filters
For information and usage examples of available output filters, see “Using Filters” on
page 11.

quit
The quit admin-level command closes the CLI terminal.
Displayed data is removed upon exiting the CLI terminal and does not appear when the
terminal is reopened.
Usage:
quit

30 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

rename
The rename admin-level command renames a component of the XtremIO Storage Array.
Usage:
rename ( new-caption=<string> | new-name=<string> ) (
tar-id=<name or index> | vol-id=<name or index> | ig-id=<name
or index> | initiator-id=<name or index> | usr-id=<name or
index> | cg-id=<name or index> | xms-id=<name or index> |
volume-snapshot-group-id=<name or index> | tg-id=<name or
index> | tag-id=<name or index> | snapshot-set-id=<name or
index> | cluster-id=<name or index> | scheduler-id=<name or
index> )
NOTE! At least one property from the following list is
mandatory: new-name, new-caption.
NOTE! At least one property from the following list is
mandatory: xms-id, cluster-id, tar-id, vol-id, ig-id,
initiator-id, usr-id, volume-snapshot-group-id, cg-id, tg-id,
tag-id, snapshot-set-id, scheduler-id.
NOTE! All object IDs should be renamed using the new-name
parameter, except tags which should be renamed using the
new-caption parameter.

Input Parameter Description Value Mandatory

new-caption New caption String Only one of the

following parameters
new-name New name String must be selected:
• new-caption
• new-name

cluster-id Cluster ID Name or index Only one of the

following parameters
scheduler-id Scheduler ID Name or index must be selected:
• cluster-id
xms-id XMS ID Name or index
• scheduler-id
vol-id Volume ID Name or Index • xms-id
• vol-id
tar-id Target ID Name or index • tar-id
tag-id Tag ID Name or Index • tag-id
• snapshot-set-id
snapshot-set-id Snapshot Set ID Name or Index • cg-id
• tg-id
cg-id Consistency Group ID Name or Index
• ig-id
tg-id Target Group ID Name or Index • usr-id
• initiator-id
ig-id Initiator Group ID Name or index
• volume-snapshot-gro
usr-id User ID Name or index up-id
See Important Note
initiator-id Initiator ID Name or index below.

volume-snapshot-grou SG ID Name or Index

p-id

General 31
Admin CLI Commands

IMPORTANT
For renaming tag-id use the new-caption parameter. For all other objects, use the
new-name parameter.

Example:
rename vol-id="voltest" new-name="voltest1"

Maintenance
General

add-cluster
The add-cluster admin-level command adds a Cluster to the list of Clusters managed
by the XMS.
Usage:
add-cluster sc-mgr-host=<Host name> [ force ]

Input Parameter Description Value Mandatory

sc-mgr-host Storage Controller IP Host Name Yes

address or host name

force Add the cluster even if N/A No

it is currently managed
by another XMS

Example:
add-cluster sc-mgr-host="1.2.3.4"

32 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

remove-cluster
The remove-cluster admin-level command removes a Cluster from the list of Clusters
managed by the XMS.
Usage:
remove-cluster cluster-id=<id: name or index>
cluster-psnt=<cluster PSNT>
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index Yes

cluster-psnt Cluster PSNT PSNT Yes

Example:
remove-cluster cluster-id="My_Cluster"
cluster-psnt="XIO###########"

show-clusters
The show-clusters admin-level command displays the main properties and the status
of clusters managed by the XMS.
Usage:
show-clusters [cluster-id=<id: name or index> ]
[duration=<number of seconds>] [cluster-id=<cluser ID>]
[frequency=<number of seconds>] [vertical] [ filter ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

filter Filters the command See “Using Filters” on No

output page 11.

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Maintenance 33
Admin CLI Commands

Example:
show-clusters vertical

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

State The cluster’s current state

Gates-Open Indicates whether the cluster is serving I/Os.

Conn-State Connection status:

• Disconnected - XMS is currently disconnected from the cluster.
• Connected - XMS is currently connected to the cluster.

Num-Of-Vols The total number of defined Volumes in the cluster

Num-Of-Internal-Volumes Number of internal Volumes

Vol-Size The total amount of disk space defined for all Volumes in the
cluster

UD-SSD-Space The total physical (SSD) space

Logical-Space-In-Use The total logical address space written to the cluster before
deduplication

Logical-Space-In-Deletion-Pr The total logical address space that is being deleted.

ocess

UD-SSD-Space-In-Use The physical (SSD) space currently in use by User Data.

Total-Writes The total bytes written to the cluster since installation

Total-Reads The total bytes read by the cluster since installation

Stop-Reason The reason for cluster halt (if any)

Size-and-Capacity The number of X-Bricks and the cluster’s capacity of the cluster

34 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-clusters-upgrade
The show-clusters-upgrade admin-level command displays clusters’ NDU status.
Usage:
show-clusters-upgrade [ duration=<seconds> ] [ cluster-id=<id:
name or index> ] [ frequency=<seconds> ] [ filter=<> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

filter Filters the command See “Using Filters” on No

output page 11.

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:

show-clusters-upgrade

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

State The cluster’s state

Upgrade-State The cluster’s upgrade state

Start-Time A time stamp indicating the cluster’s upgrade starting point

Activation-Time A time stamp indicating when the current software was activated

Storage-Controller-Name The Storage Controller’s name

Index The Storage Controller’s index number

Mgr-Addr The management IP address of the Storage Controller

SW-Version The Storage Controller’s software version

SW-Build The software build number

OS-Version The OS version

FW-State The firmware’s state

Upgrade-Failure-Reason Indicates whether the upgrade has failed and specify the failure
reason.

Maintenance 35
Admin CLI Commands

show-clusters-upgrade-progress
The show-clusters-upgrade-progress admin-level command displays indicators
of the clusters’ NDU progress.
Usage:
show-clusters-upgrade-progress [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

filter Filters the command See “Using Filters” on No

output page 11.

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:

show-clusters-upgrade-progress

Output Parameter Description

Storage-Controller-Name The Storage Controller’s name

Index The Storage Controller’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Step-Number The current upgrade step number

Step-Information Current upgrade step information

36 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

FRU Replacement

show-technician-port-tunnels
The show-technician-port-tunnels admin-level command shows the status of
the defined XMS technician port tunnels.
Usage:
show-technician-port-tunnels [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-technician-port-tunnels

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

Storage-Controller-Name The Storage Controller’s name

Index The Storage Controller’s index number

Tech-Tunnel-State The state of the Tech tunnel (opened or closed)

Maintenance 37
Admin CLI Commands

modify-technician-port-tunnel
The modify-technician-port-tunnel admin-level command creates or terminates
an XMS technician port tunnel to a specific Storage Controller.
Usage:
modify-technician-port-tunnel sc-id=<id: name or index> ( open
| close ) [ cluster-id=<id: name or index> ]
NOTE! Exactly one property from the following list is
mandatory: open, close.

Input Parameter Description Value Mandatory

sc-id Storage Controller ID id: Name or Index Yes

close Close tunnel N/A Only one of the

following parameters
open Open tunnel N/A must be selected:
• close
• open

cluster-id Cluster ID id: Name or Index No

Example:
modify-technician-port-tunnel sc-id="X1-SC1" open

38 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

add-ssd

Note: This command applies to X1 cluster type only.

The add-ssd admin-level command adds an SSD to the X-Brick and initializes it.
Usage:
add-ssd brick-id=<name or index> ssd-uid=<string> [
cluster-id=<id: name or index> ] [ is-foreign-xtremapp-ssd ] [
is-encrypted-unreadable-ssd ] [ ssd-name=<string> ]

Input Parameter Description Value Mandatory

brick-id X-Brick ID Name or index Yes

ssd-uid SSD’s UID String Yes

cluster-id Cluster ID id: name or index No

is-encrypted-unreadab Indicates whether the N/A No

le-ssd SSD is encrypted with
an unknown PIN.
Triggers resetting the
PIN and wiping the
data.

is-foreign-xtremapp-ss Allows to override the N/A No

d foreign SSD state and
add a foreign SSD to
the X-Brick.

ssd-name SSD’s Name String No

Example:
add-ssd brick-id="X1" ssd-uid="wwn-0x5000000000000000"
is-foreign-xtremapp-ssd

Maintenance 39
Admin CLI Commands

show-ssds-diagnostic
The show-ssds-diagnostic admin-level command displays SSDs’ diagnostic
information.
Usage:
show-ssds-diagnostic [ duration=<seconds> ] [ cluster-id=<id:
name or index> ] [ frequency=<seconds> ] [ vertical ] [
filter=<> ] [ prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-ssds-diagnostic

Output Parameter Description

Name The SSD’s name

Index The SSD’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Brick-Name The name of the X-Brick in which the SSD is inserted

Index The X-Brick’s index number

Slot The X-Brick’s DAE slot number in which the SSD is inserted

Smart-Err-Asc The ASC code of the latest SMART error

Smart-Err-Acsq The ASCQ code of the latest SMART error

Last-IO-Err-Type The error type of the last I/O (none, ssd_error or timeout)

Last-IO-Err-Time The date and time of the last I/O error

IO-Err-Sense The Sense Code of the I/O error

IO-Err-Asc The ASC error of the latest I/O error

IO-Err-Ascq The ASCQ error of the latest I/O error

40 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

IO-Err-Vendor-Specific The vendor specific information of the latest I/O error

SSD-Link1-State The status of link1 of the SSD

SSD-Link2-State The status of link2 of the SSD

activate-storage-controller
The activate-storage-controller admin-level command activates a replaced or
deactivated Storage Controller.
Usage:
activate-storage-controller sc-id=<name or index> [
cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

sc-id Storage Controller Name or index Yes

object ID

cluster-id Cluster ID Name or Index No

Example:
activate-storage-controller sc-id="X1-SC1"

deactivate-storage-controller
The deactivate-storage-controller admin-level command deactivates an active
Storage Controller (e.g. for replacing purposes).

Note: Deactivating a Storage Controller will stop any processing done on the Storage
Controller and will impact system performance, as well as prevent host access to its target
ports.

Usage:
deactivate-storage-controller sc-id=<name or index> [
cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

sc-id Storage Controller Name or index Yes

object ID

cluster-id Cluster ID Name or Index No

Example:
deactivate-storage-controller sc-id="X1-SC1"

Maintenance 41
Admin CLI Commands

show-nvrams

Note: This command applies to X2 cluster type only.

The show-nvrams admin-level command displays a list of Storage Controllers NVRAM

cards and their properties.
Usage:
show-nvrams [ duration=<seconds> ] [ cluster-id=<id: name or
index> ] [ frequency=<seconds> ] [ prop-list=<List of property
strings> ] [ filter=<> ] [ vertical ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

filter Filters the command See “Using Filters” on No

output page 11.

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:
show-nvrams duration=60 frequency=10

Output Parameter Description

Name The X-Brick’s name

Index The X-Brick’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Storage-Controller-Name The Storage Controller’s name

Index The Storage Controller’s index number

HW-State Status of the hardware

Status The NVRAM’s health status

Fail-Reason The reason for the NVRAM’s failure

FW-Version The NVRAM’s firmware version

Serial-Number The NVRAM’s serial number

42 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-bbus

Note: This command applies to X1 cluster type only.

The show-bbus admin-level command displays the Battery Backup Units information.
Usage:
show-bbus [ duration=<seconds> ] [ cluster-id=<id: name or
index> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<list of property strings> ] [ vertical ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

filter Filters the command See “Using Filters” on No

output page 11.

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Maintenance 43
Admin CLI Commands

Example:
show-bbus cluster-id=1 vertical

Output Parameter Description

Name The BBU’s name

Index The BBU’s index number

Model-Name The BBU’s model

Serial-Number The BBU’s serial number

Power-Feed The BBU’s power feed (A or B)

Lifecycle-State The BBU’s lifecycle state (healthy, disconnected, failed or initializing)

Connectivity-State The status of BBU’s connectivity to the Storage Controller

Enabled-State Indicates whether the BBU is enabled.

Input Indicates whether there is an external power feed to the BBU (on or
off)

Battery-Charge (%) The percentage of the battery charge. If the BBU is unreachable or
disabled, this parameter is NULL.

BBU-Load The percentage of the current BBU load

Voltage The input voltage of the BBU. If the BBU is unreachable or disabled,
this parameter is NULL.

FW-Version The BBU’s Firmware version

Part-Number A string identifier of the part (assigned by Dell EMC)

Brick-Name The X-Brick’s name

Index The X-Brick’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Outlet1-Status The status of outlet 1 (on or off)

Outlet2-Status The status of outlet 2 (on or off)

44 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-bricks
The show-bricks admin-level command displays a list of X-Bricks and their associated
cluster.
Usage:
show-bricks [ duration=<seconds> ] [ cluster-id=<id: name or
index> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-bricks duration=60 frequency=10

Output Parameter Description

Brick-Name The X-Brick’s name

Index The X-Brick’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

State The X-Brick’s current state:

• Not_in-sys - The X-Brick is not an active part of the cluster.
• In_sys - The X-Brick is part of the cluster.

Maintenance 45
Admin CLI Commands

control-led
The control-led admin-level command helps locating a specific hardware component
by turning on its identification LED.

Note: The Identification LEDs can be either Steady On/Off or Blinking On/Off depending
on the component they are on. Refer to the XtremIO Storage Array User Guide for the valid
values for each LED type.

Usage:
control-led entity=<'SSD', 'DAELCC', 'LocalDisk',
'StorageController', 'DAE'> led-mode=<off, blinking, on>
object-id-list=<list of ids: name or index> [ inverse-mode ] [
cluster-id=<id: name or index> ] [ brick-id=<name or index> ] [
slot-num-list=<list of integers> ]

Input Parameter Description Value Mandatory

entity FRU ’Slot’, ’DAE’, Yes

’StorageController’,
’NVRAM’,
’DAERowController’,
’SSD’, ’LocalDisk’,
’DAEController’

led-mode The desired LED mode ’on’, ’off’, ’blinking’ Yes

object-id-list Object ID list List of IDs: name or Yes

index
e.g if
entity=StorageControll
er, format is ["X1-SC1",
"X1-SC2"]

cluster-id Cluster ID Name or Index No

inverse-mode Applies the specified N/A No

LED mode to all
instances of the entity
specified except for
those in the
object-id-list.

brick-id X-Brick ID Name or Index No

slot-num-list Slot number list List of Integers No

Example:
control-led entity=SSD object-id=["wwn-0x5000000000000000"]
led-mode=blinking

46 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

power-on-dae-slots

Note: This command applies to X2 cluster type only.

The power-on-dae-slots admin-level command powers-on the cluster’s DAE slots

after a critical ambient temperature event.
Usage:
power-on-dae-slots [ cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

Example:
power-on-dae-slots

Maintenance 47
Admin CLI Commands

Service Maintenance Commands

power-off
The power-off admin-level command powers off a an entire cluster or a Storage
Controller.
Powering off a Storage Controller will prevent host access to its target ports. Powering off
the entire cluster will stop cluster services.

Note: Powering off a Storage Controller requires to deactivate it first. See

“deactivate-storage-controller” on page 41 for the command usage.

Usage:
power-off [ sc-id=<id: name or index> ] [ cluster-id=<id: name
or index> ] [ force ] [ shut-down-reason=<free text> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

sc-id Storage Controller’s ID Name or index No

shut-down-reason Shut down reason free text No

Example:
power-off sc-id="X1-SC1"



Unless otherwise requested by Dell EMC Global Tech Support, this command should not
be used to shut down the Cluster. For instructions on shutting down the cluster, refer to
the XtremIO Storage Array User Guide.

power-on
The power-on admin-level command powers up a Storage Controller.
Powering on a Storage Controller brings the Target ports back online.
Usage:
power-on sc-id=<id: name or index> [ cluster-id=<id: name or
index> ]

Input Parameter Description Value Mandatory

sc-id Storage Controller’s ID Name or index Yes

cluster-id Cluster’s ID Name or index No

Example:
power-on sc-id="X1-SC1"

48 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

shutdown-xms
The shutdown-xms admin-level command stops the XMS service or shuts down the
machine.
Usage:
shutdown-xms [ shutdown-type=<service (default), machine> ]

Input Parameter Description Value Mandatory

shutdown-type Shutdown type service (default), No

machine

Example:
shutdown-xms shutdown-type="machine"

start-cluster
The start-cluster admin-level command starts cluster services and allows a user to
access the storage array.
Usage:
start-cluster [ cluster-id=<id: name or index> ] [ force ]

Input Parameter Description Value Mandatory

cluster-id Cluster’s ID Name or index No

force Force start N/A No

Example:
start-cluster cluster-id=1

Maintenance 49
Admin CLI Commands

stop-cluster
The stop-cluster admin-level command stops cluster services.

Note: Stopping cluster services prevents all hosts from accessing the storage array.

Usage:
stop-cluster cluster-psnt=<PSNT> [ cluster-id=<id: name or
index> ] [ abort-start-attempt ] [ force ]
NOTE! The following property is mandatory: cluster-psnt
NOTE! Only one property from the following list is allowed:
force, abort-start-attempt

Input Parameter Description Value Mandatory

cluster-psnt The PSNT of the cluster PSNT Yes

cluster-id Cluster’s ID Name or index No

force Force stop N/A No

Example:
stop-cluster cluster-psnt="XIO###########"

Note: Do not use this command unless specifically instructed to do so by Dell EMC Global
Tech Support.

restart-xms
The restart-xms admin-level command restarts the XMS service.
Usage:
restart-xms [ restart-type=<service (default), machine> ]

Input Parameter Description Value Mandatory

restart-type Restart type service (default), No

machine

Example:
restart-xms

50 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Hardware Diagnostics

show-daes
The show-daes admin-level command displays the list of DAEs and their properties.
Usage:
show-daes [ duration=<seconds> ] [ cluster-id=<id: name or
index> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<List of property string> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-daes

Output Parameter Description

Name The DAE’s name

Index The DAE’s index number

Model-Name The DAE’s model

Serial-Number The DAE’s serial number

HW-State The field replaceable unit state (healthy, disconnected, failed, or

initializing)

Part-Number A string identifier of the part (assigned by Dell EMC)

Brick-Name The X-Brick’s name

Index The X-Brick’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

HW-Revision The DAE’s hardware revision number

FW-Version The DAE’s firmware version

Maintenance 51
Admin CLI Commands

show-daes-controllers
The show-daes-controllers admin-level command displays the list of DAE
controllers (referred to as LCCs in X1 cluster type) and their properties.
Usage:
show-daes-controllers [ duration=<seconds> ] [ cluster-id=<id:
name or index> ] [ frequency=<seconds> ] [ vertical ] [
filter=<> ] [ prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

filter Filters the command See “Using Filters” on No

output page 11.

Prop-List Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:

show-daes-controllers vertical

Output Parameter Description

Name The DAE Controller’s name

Index The DAE Controller’s index number

Model-Name The DAE Controller’s model name

Serial-Number The DAE Controller’s serial number

Lifecycle-State The DAE Controller’s lifecycle status

Enabled-State The field replaceable unit state (healthy, disconnected, failed, or

initializing)

Enabled-State Indicates whether the DAE Controller is enabled.

HW-Revision The DAE Controller’s hardware revision number

Location-Index The controller’s index in relation to the DAE

Location The DAE Controller’s physical location (bottom or up)

DAE-Controller-Temp The DAE Controller’s temperature

FW-Version The DAE Controller’s firmware version

Part-Number A string identifier of the part (assigned by Dell EMC)

DAE-Name The DAE’s name

52 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

DAE-Index The DAE’s index number

Brick-Name The X-Brick’s name

Index The X-Brick’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

DAE-Controller-HW-Label The DAE Controller’s physical identifier

show-daes-row-controllers

Note: This command applies to X2 cluster type only.

The show-daes-row-controllers admin-level command displays the list of DAE

Row Controllers and their properties.
Usage:
show-daes-row-controllers [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
vertical ] [ filter=<> ] [ prop-list=<List of property strings>
]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Maintenance 53
Admin CLI Commands

Example:

show-daes-row-controllers vertical

Output Parameter Description

Name The DAE Row Controller’s name

Index The DAE Row Controller’s index number

DAE-Name The DAE Controller’s name

DAE-Index The DAE Controller’s index number

Location The DAE Row Controller’s physical location (left or right)

Location-Index The DAE Row Controller’s location index

DAE-Row-Controller-HW-Lab The DAE Row Controller’s physical identifier

el

Lifecycle-State The DAE Controller’s hardware revision number

Failure-Reason The DAE Row Controller’s failure reason

Enabled-State Indicates whether the DAE Controller is enabled.

DAE-Row-Controller-Temp The DAE Row controller’s temperature

Model-Name The DAE Row Controller’s model name

Serial-Number The DAE Row Controller’s serial number

Identify-Led The DAE Row Controller’s identify LED state (on or off)

Status-Beacon The DAE Row Controller’s status LED state (on or off)

Part-Number A string identifier of the part (assigned by Dell EMC)

FW-Version The DAE Row Controller’s firmware version

FW-State The DAE Row Controller’s firmware health status

HW-Revision The DAE Row Controller’s hardware version

Cluster-Name The cluster’s name

Index The cluster’s index number

54 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-daes-controllers-sas-ports
The show-daes-controllers-sas-ports admin-level command displays the DAE
Controllers (referred to as LCCs in X1 cluster type) SAS ports information.
Usage:
show-daes-controllers-sas-ports [ duration=<seconds> ] [
dae-id=<name or index> ] [ frequency=<seconds> ] [
cluster-id=<id: name or index> ] [ vertical ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

dae-id DAE object ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

Example:

show-daes-controllers-sas-ports

Output Parameter Description

Name The DAE Controller’s name

Index The DAE Controller’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

SAS-Port-State The port’s state (up, or down)

SAS-Port-Rate The port rate (in gbps)

SAS-Port-Health-State The port health state (healthy, degraded, failed)

SAS-Port-Health-Level The port health level

SAS-Port-Enabled-State The port enabled state (enabled or system_disabled)

SAS-Last-24h-Number-of-Ph The number of phy problems in the last 24 hours

y-Problems

Port-HW-Label The DAE Controller SAS port physical identifier

Maintenance 55
Admin CLI Commands

show-daes-row-controllers-sas-ports

Note: This command applies to X2 cluster type only.

The show-daes-row-controllers-sas-ports admin-level command displays the

DAE Row Controllers SAS ports information.
Usage:
show-daes-row-controllers-sas-ports [ duration=<seconds> ] [
dae-row-controller-id=<name or index> ] [ frequency=<seconds> ]
[ cluster-id=<id: name or index> ] [ vertical ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

dae-row-controller-id DAE Row Controller ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

Example:

show-daes-row-controllers-sas-ports

Output Parameter Description

Name The DAE Controller’s name

Index The DAE Controller’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

SAS-Port1-State The port’s state (up, or down)

SAS-Port1-Rate The port rate (in gbps)

SAS1-Port-Health-State The port health state (healthy, degraded, failed)

SAS1-Port-Health-Level The port health level

SAS1-Port-Enabled-State Indicates whether the SAS port is enabled or disabled.

SAS1-Last-24h-Number-Of- The number of phy problems in the last 24 hours

Phy-Problems

56 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-daes-psus
The show-daes-psus admin-level command displays the list of DAE PSUs and their
properties.
Usage:
show-daes-psus [ duration=<seconds> ] [ cluster-id=<id: name or
index> ] [ frequency=<seconds> ] [ vertical ] [ filter=<> ] [
prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-daes-psus

Output Parameter Description

Name The PSU’s name

Index The PSU’s index number

Serial-Number The PSU’s serial number

Location-Index The PSU’s index in relation to the Storage Controller

Power-Feed The PSU’s power feed (A or B)

Lifecycle-State The field replaceable unit state (healthy, disconnected, failed, or

initializing)

Input Indicates whether there is input power to the supply (on or off).

Location The PSU’s physical location in the DAE

HW-Revision The PSU’s hardware revision

Part-Number A string identifier of the part (assigned by Dell EMC)

DAE-Name The DAE’s name

DAE-Index The DAE’s Index number

Brick-Name The X-Brick’s name

Index The X-Brick’s index number

Maintenance 57
Admin CLI Commands

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

PSU-HW-Label The PSU’s physical identifier

DAE-PSU-Temp DAE PSU temperature (valid values 20C - 140C)

show-daes-fans
The show-daes-fans admin-level command displays the list of DAE fans and their
properties.
Usage:
show-daes-fans [ duration=<seconds> ] [ cluster-id=<id: name or
index> ] [ frequency=<seconds> ] [ vertical ] [
jbod-index=<name or index> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

jbod DAE ID Name or Index No

-index

Example:

show-daes-fans jbod-index=1

Output Parameter Description

Name The DAE fan name

Index The DAE fan’s index number

Cluster-Name The cluster’s name

DAE-index The DAE index number

Fan-Pair-Index The DAE fan pair’s index

Fan-Pair-HW-Label The DAE fan pair physical identifier

Fan-Pair-Status The status of the fan pair

58 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-infiniband-switches
The show-infiniband-switches admin-level command displays InfiniBand
Switches’ information.
Usage:
show-infiniband-switches [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
vertical ] [ filter=<> ] [ prop-list=<List of property string> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-infiniband-switches

Output Parameter Description

Name The InfiniBand Switch’s name

Index The InfiniBand Switch’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Location-Index The port number in the InfiniBand Switch

Serial-Number The InfiniBand Switch’s serial number

Part-Number A string identifier of the part (assigned by Dell EMC)

Lifecycle-State The InfiniBand Switch’s current functional status

FW-Version Firmware version

FW-Version-Error Indicates whether there is an error in the InfiniBand Switchs FW

version.

FAN-Drawer-State The status of the FAN drawer

FAN1-State FAN1 health state

FAN2-State FAN2 health state

FAN3-State FAN3 health state

Maintenance 59
Admin CLI Commands

Output Parameter Description

FAN4-State FAN4 health state

IB-Switch-HW-Label The InfiniBand Switch’s physical identifier

Fan-Module1-HW-Label FAN1 physical identifier

Fan-Module2-HW-Label FAN2 physical identifier

Fan-Module3-HW-Label FAN3 physical identifier

Fan-Module4-HW-Label FAN4 physical identifier

show-infiniband-switches-ports
The show-infiniband-switches-ports admin-level command displays InfiniBand
Switches’ port information.
Usage:
show-infiniband-switches-ports [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
vertical ] [ filter=<> ] [ prop-list=<List of property strings>
]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

60 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:

show-infiniband-switches-ports

Output Parameter Description

Port-Index The port number on the switch

Peer-Type Connected device type (Storage Controller or InfiniBand Switch)

Port-In-Peer-Index Index of port in connected device

Link-Rate-In Gbps Link rate in Giga bit per second (usually 40Gbps)

Port-State The port’s state: up or down

Enabled-State Indicates whether the port is enabled

Health-State The port’s health state

Link-Health-Level The link’s health level

Name The InfiniBand Switch’s name

Index The InfiniBand Switch’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

IBSwitch-Port-HW-Label The InfiniBand Switch’s physical identifier

Maintenance 61
Admin CLI Commands

show-infiniband-switches-psus
The show-infiniband-switches-psus admin-level command displays InfiniBand
Switches’ PSUs information.
Usage:
show-infiniband-switches-psus [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
vertical ] [ filter=<> ] [ prop-list=<list of property strings>
]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-infiniband-switches-psus

Output Parameter Description

Name The PSU’s name

Index The PSU’s index number

Cluster-Name The cluster’s name

Index The cluster’s serial number

Location-Index The PSU number in the InfiniBand Switch

Location The PSU’s physical location (right or left)

Input-Power Indicates whether input power is on or off.

Lifecycle-State PSU’s health state

Power-Feed The PSU’s power feed

PSU-HW-Label The PSU’s physical identifier

62 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-local-disks
The show-local-disks admin-level command displays the Storage Controllers’ local
disks information.
Usage:
show-local-disks [ duration=<seconds> ] [ cluster-id=<id: name
or index> ] [ frequency=<seconds> ] [ vertical ] [ filter=<> ] [
prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-local-disks

Output Parameter Description

Name The disk’s name

Index The disk’s index number

Serial-Number The disk’s serial number

Location-Index The disk’s location in the server

State State of the disk: healthy or fault

Enabled-State Enabled or disabled

FW-Version Firmware version

Part-Number A string identifier of the part (assigned by Dell EMC)

UID Unique ID

Disk-Type Disk type (SSD or HDD)

Disk-Expected-Type The disk type the cluster expects to have for the drive (SSD or
HDD)

Disk-Purpose The disk’s purpose (journal_and_boot_disk, trace_disk)

Storage-Controller-Name Storage Controller’s name

Index Storage Controller’s index number

Maintenance 63
Admin CLI Commands

Output Parameter Description

Brick-Name X-Brick’s name

Index X-Brick’s index number

Cluster-Name Cluster’s name

Index Cluster’s index number

Encryption-Status Indicates whether encryption is enabled.

show-leds
The show-leds admin-level command displays the values for the identification and
status LEDs.
Usage:
show-leds [ duration=<seconds> ] [ cluster-id=<id: name or
index> ] [ frequency=<seconds> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

Example:
show-leds

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

Entity The type of the entity represented by the LED

Name The name of the entity represented by the LED

Index The index of the entity represented by the LED

Identify-Beacon The identification LED status (off/blinking)

Status-Beacon The status LED status (off/blinking)

64 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-slots
The show-slots admin-level command displays the list of all DAE(s) SSD slots and their
properties.
Usage:
show-slots [ duration=<seconds> ] [ cluster-id=<id: name or
index> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-slots

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

Brick-Name The name of the X-Brick to which the slot belongs

Index The X-Brick’s index number within the DAE

Slot # The DAE slot number

State The slot’s current status in relation to an SSD

Error-Reason Indicates an error related to the slot.

UID The unique identifier (WWN) of the disk inserted in the slot

Product-Model The model of the SSD inserted in the slot

SSD-Size The size of the SSD inserted in the slot

Maintenance 65
Admin CLI Commands

show-ssds
The show-ssds admin-level command displays a list of DAE SSDs and their properties.
Usage:
show-ssds [ brick-id=<id: name or index> ][ duration=<seconds>
] [ cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
vertical ] [ filter=<> ] [ prop-list=<List of property strings>
]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

filter Filters the command See “Using Filters” on No

output page 11.

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:

show-ssds

Output Parameter Description

Name The SSD’s name

Index The SSD’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Brick-Name The name of the X-Brick in which the SSD is inserted

Index The X-Brick’s index number

Slot # The X-Brick’s DAE slot number in which the SSD is inserted

Model-Name The SSD’s model

FW-Version The SSD’s firmware version

FW-State The SSD’s firmware state

Part-Number A string identifier of the part (assigned by Dell EMC)

SSD-Size The SSD’s disk space size

DPG-Name The name of the XDP group to which the SSD is associated

Index The Data Protection Group’s index number

66 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

SSD-DPG-State The SSD’s current position status

Lifecycle The SSD’s lifecycle status

State The SSD’s current status

Endurance-Remaining-% Percentage of the SSD’s remaining endurance

Certainty-State Indicates whether there is a pending command associated with the

SSD.

Encryption-Status Indicates whether encryption is enabled.

SSD-Temp The SSD’s temperature

show-ssd
The show-ssd admin-level command displays the properties of a single DAE SSD.
Usage:
show-ssd ssd-id=<name or index> [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

ssd-id SSD ID Name or Index Yes

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Maintenance 67
Admin CLI Commands

Example:
show-ssd ssd-id="wwn-0x5000cca04e05faa0"

Output Parameter Description

Name The SSD’s name

Index The SSD’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Brick-Name The name of the X-Brick in which the SSD is inserted

Index The X-Brick’s index number

Slot # The X-Brick’s DAE slot number in which the SSD is inserted

Product-Model The SSD’s model

FW-Version The SSD’s firmware version

FW-State The SSD’s firmware state

Part-Number A string identifier of the part (assigned by Dell EMC)

SSD-Size The SSD’s disk space size

DPG-Name The name of the XDP group to which the SSD is associated

Index The Data Protection Group’s index number

SSD-DPG-State The SSD’s current position status

State The SSD’s current status

Endurance-Remaining-% Percentage of the SSD’s remaining endurance

Certainty-State Indicates whether there is a pending command associated with the

SSD.

Encryption-Status Indicates whether encryption is enabled.

68 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-storage-controllers
The show-storage-controllers admin-level command displays a list of Storage
Controllers and their properties.
Usage:
show-storage-controllers [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
vertical ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-storage-controllers

Output Parameter Description

Storage-controller-Name The Storage Controller’s name

Index The Storage Controller’s index number

Mgr-Addr The management IP of the Storage Controller

IB-Addr-1 The Storage Controller’s internal back-end IP address for port 1,

used for communication to the InfiniBand Switch

IB-Addr-2 The Storage Controller’s internal back-end IP address for port 2,

used for communication to the InfiniBand Switch

X-Brick-Name The ID of the X-Brick to which the Storage Controller belongs

X-Brick-Index The X-Brick’s index number

Cluster-Name The name of the cluster to which the Storage Controller belongs

Index The cluster’s index number

Lifecycle-State The Storage Controller’s state

Health-State A summary state that describes the Storage Controller’s overall

state, including hardware and software components of
Xtremapp (currently to be ignored)

Enabled-State The Storage Controller’s enabled state

Maintenance 69
Admin CLI Commands

Output Parameter Description

Stop-Reason The reason for the Storage Controller’s stop (if any)

Conn-State The Storage Controller’s connectivity state to the XMS

Journal-State The Storage Controller’s journal health state

SC-HW-Label The Storage Controller physical identifier

show-storage-controllers-fw-versions
The show-storage-controllers-fw-versions admin-level command displays
the Storage Controllers’ firmware version information.
Usage:
show-storage-controllers-fw-versions [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-storage-controllers-fw-versions

Output Parameter Description

Cluster-Name Cluster’s name

Index Cluster’s index number

Storage-Controller-Name The Storage Controller’s name

Index The Storage Controller’s index number

PCI-Disk-Controller PCI Disk controller firmware

IPMI-BMC IPMI firmware

FC-HBA FC Targets firmware

PCI-10GE-HBA iSCSI Targets firmware

PCI-IB-HBA InfiniBand Targets firmware

70 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

BIOS Storage Controller BIOS firmware

SDR Sensor Device Record (a FW related to the Storage Controller IPMI

sensors)

ME Sub-component of the BMC

show-storage-controllers-infiniband-ports
The show-storage-controllers-infiniband-ports admin-level command
displays the Storage Controllers’ InfiniBand port information.
Usage:
show-storage-controllers-infiniband-ports [ duration=<seconds>
] [ cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
vertical ] [ filter=<> ] [ prop-list=<list of property strings>
]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-storage-controllers-infiniband-ports

Output Parameter Description

Name The InfiniBand port’s name

Index Index number in the cluster

Port-Index The InfiniBand port’s index number

Peer-Type Connected device type

Port-In-Peer-Index Index of port in connected device

Link-Rate-In-Gbps Link rate in Giga bit per second

Port-State The InfiniBand port’s state: up or down

Storage-Controller-Name Storage Controller’s name

Maintenance 71
Admin CLI Commands

Output Parameter Description

Index Storage Controller’s index number

Brick-Name X-Brick’s name

Index X-Brick’s index number

Cluster-Name Cluster’s name

Index Cluster’s index number

Health-Level The InfiniBand port’s health level

Health-State The InfiniBand port’s health state

Enabled-State Indicates whether the InfiniBand port is enabled.

IB-Port-HW-Label InfiniBand port physical identifier

show-storage-controllers-info
The show-storage-controllers-info admin-level command displays the Storage
Controllers’ information.
Usage:
show-storage-controllers-info [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
vertical ] [ filter=<> ] [ prop-list=<list of property strings>
]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-storage-controllers-info

Output Parameter Description

Storage-Controller-Name The Storage Controller’s name

Index The Storage Controller’s index number

Mgr-Addr The IP address used to access the Storage Controller’s manager

72 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

Brick-Name The Storage Controller management interface

Index The X-Brick’s index number

Cluster-Name The name of the cluster to which the Storage Controller belongs

Index The cluster’s index number

State The Storage Controller’s activity state

Conn-State The Storage Controller’s connectivity status

SW-Version The Storage Controller’s software version

SW-Build The software build number

HW-Model The Storage Controller’s hardware model

OS-Version The OS version number

Serial-Number The Storage Controller’s serial number

Part-Number A string identifier of the part (assigned by Dell EMC)

Sym-Storage-Controller Indicates whether SYM runs on the Storage Controller.

SC-Start-Timestamp Date and time of the last start-up (after reboot)

show-storage-controllers-psus
The show-storage-controllers-psus admin-level command displays a list of the
Storage Controller’s PSUs and their properties.
Usage:
show-storage-controllers-psus [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
vertical ] [ filter=<> ] [ prop-list=<list of property strings>
]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Maintenance 73
Admin CLI Commands

Example:

show-storage-controllers-psus

Output Parameter Description

Name PSU’s name

Index PSU’s index number

Serial-Number PSU’s serial number

Location-Index The PSU’s index in relation to the Storage Controller

Power-Feed The PSU’s power feed

Lifecycle-State The field replaceable unit state (healthy, disconnected, failed, or

in transient state)

Input Indicates whether there is input power to the supply (on or off).

Location The PSU’s physical location (right or left)

HW-Revision PSU’s hardware revision

Part-Number A string identifier of the part (assigned by Dell EMC)

Storage-Controller-Name Storage Controller’s name

Index Storage Controller’s index number

Brick-Name X-Brick’s name

Index X-Brick’s index number

Cluster-Name Cluster’s name

Index Cluster’s index number

PSU-HW-Label The PSU’s physical identifier

74 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-storage-controllers-sas-ports
The show-storage-controllers-sas-ports admin-level command displays the
Storage Controllers’ SAS ports information.
Usage:
show-storage-controllers-sas-ports [ duration=<seconds> ] [
sc-id=<id: name or index> ] [ cluster-id=<id: name or index> ] [
frequency=<seconds> ] [filter=<> ] [ prop-list=<list of
property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

sc-id Storage Controller ID Name or Index No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-storage-controllers-sas-ports

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s Index Number

Storage-Controller-Name The Storage Controller’s name

Index The Storage Controller’s Index Number

SAS1-Port-State The state of SAS1 port (up or down)

SAS1-Port-Enabled-State Indicates whether port is SAS1 port is enabled.

SAS1-Port-Rate The rate of SAS1 port (in gbps)

SAS1-Port-Health-Level SAS1 port’s health status

SAS1-Port-Wrong-Conn Indicates whether SAS1 port is connected to the wrong DAE

Controller, DAE Controller port or an unknown DAE.

SAS1-Port-HW-Label SAS1 port physical identifier

SAS2-Port-State The state of SAS2 port (up or down)

SAS2-Port-Enabled-State Indicates whether port is SAS2 port is enabled.

SAS2-Port-Rate The rate of SAS2 port (in Gbps)

Maintenance 75
Admin CLI Commands

Output Parameter Description

SAS2-Port-Health-Level SAS2 port’s health level

SAS2-Port-Wrong-Conn Indicates whether SAS2 port is connected to the wrong DAE

Controller, DAE Controller port or an unknown DAE.

SAS2-Port-HW-Label SAS2 port physical identifier

show-storage-controllers-sensors
The show-storage-controllers-sensors admin-level command displays a list of
Storage Controllers sensors and their properties.
Usage:
show-storage-controllers-sensors [ sensor-type=<'temperature',
'power_unit', 'current', 'fan', 'voltage', 'processor',
'power_supply'> ] [ sc-id=<id: name or index> ] [
cluster-id=<id: name or index> ] [ faulty-only ] [
frequency=<seconds> ] [ duration=<seconds> ] [ filter ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

faulty-only Show only faulty N/A No

sensors

frequency Monitor intervals Seconds No

sc-id Storage Controller ID Name or Index No

sensor-type Filter by sensor type 'temperature', No

'power_unit', 'current',
'fan', 'voltage',
'processor',
'power_supply'

filter Filters the command See “Using Filters” on No

output page 11.

76 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:

show-storage-controllers-sensors

Output Parameter Description

Storage-Controller-Name The Storage Controller’s name

Index The Storage Controller’s Index Number

Sensor-Type The sensor’s type

Sensor-Name The sensor’s name

Health-State The sensor’s health state

Value The sensor’s current value

Upper-Threshold The sensor’s upper threshold

Lower-Threshold The sensor’s lower threshold

Units The sensor’s measurement units

show-target-sfp
The show-target-sfp admin-level command displays monitoring data and warning
thresholds of an SFP that is plugged in a specified Target port.
Usage:
show-target-sfp tar-id=<name or index> [ cluster-id=<name or
index> ]

Input Parameter Description Value Mandatory

tar-id Target ID Name or Index Yes

cluster-id Cluster ID Name or Index No

Example:
show-target-sfp tar-id="X1-SC1-iscsi1"

Output Parameter Description

Name The Target’s name

Index The Target’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Port-State The state of the iSCSI/FC port’ physical connection

Presence Indicates the presence status of the SFP (present, not_present,

not_applicable)

Temperature The measured SFP temperature

Temperature-Low-Warning-Thre The threshold for SFP low temperature warning

shold

Maintenance 77
Admin CLI Commands

Output Parameter Description

Temperature-High-Warning-Thr The threshold for SFP high temperature warning

eshold

Voltage The measured SFP supply voltage

Voltage-low-warning-Threshold The threshold for SFP low voltage warning

Voltage-High-Warning-Threshol The threshold for SFP high voltage warning

d

TX-Current The measured SFP TX bias current in mA

TX-Current-Low-Warning-Thresh The threshold for SFP low TX current warning

old

TX-Current-High-Warning-Thres The threshold for SFP high TX current warning

hold

TX-Power The measured SFP TX output optical power in mW

TX-Power-Low-Warning-Thresh The threshold for SFP low TX power warning

old

TX-Power-High-Warning-Thresh The threshold for SFP high TX power warning

old

RX-Power The measured SFP RX optical power in mW

RX-Power The threshold for SFP low RX power warning

Warning-Low-Threshold

RX-Power-High-Warning-Thresh The threshold for SFP high RX power warning

old

78 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-targets-sfps
The show-targets-sfps admin-level command displays monitoring data of SFPs that
are plugged-in target ports.
Usage:
show-targets-sfps [ filter=<> ]

Input Parameter Description Value Mandatory

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-targets-sfps sc-id="X1-SC1"

Output Parameter Description

Name The Target’s name

Index The Target’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Port-State The state of the iSCSI/FC port’ physical connection

Presence Indicates the presence status of the SFP (present, not_present,

not_applicable)

Temperature The measured SFP temperature

Voltage The measured SFP supply voltage

TX-Current The measured SFP TX bias current in mA

TX-Power The measured SFP TX output optical power in mW

RX-Power The measured SFP RX optical power in mW

Maintenance 79
Admin CLI Commands

Troubleshooting
Test connectivity

show-discovered-initiators-connectivity
The show-discovered-initiators-connectivity admin-level command
displays a list of Initiator ports discovered by the Storage Controllers.
Usage:
show-discovered-initiators-connectivity [ target-details ] [
cluster-id=<id: name or index> ] [iscsi-portal-details=<true,
false> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

target-details Target details info N/A No

iscsi-portal-details Display iSCSI portals true, false No

details info

Example:
show-discovered-initiators-connectivity

Output Parameter Description

Cluster Name The Initiator’s Cluster name

Index The Initiator’s Cluster index number

Port-type Initiator’s port type (iSCSI or FC)

Port-address Initiator’s port address

Num-of-conn-targets Number of Targets the Initiator is connected to

Target-List List of Target IDs

Num-of-iSCSI-Portals Number of iSCSI portals this Initiator is connected to

80 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-initiators-connectivity
The show-initiators-connectivity admin-level command displays a list of
configured Initiator ports and the number of available paths.
Usage:
show-initiators-connectivity [ target-details ] [
cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

target-details Target details info N/A No

Example:

show-initiators-connectivity

Output Parameter Description

Cluster Name The Initiator’s Cluster name

Index The Initiator’s Cluster index number

Initiator-Name The Initiator name

Index The Initiator index number

Port-Type The Initiator’s port type (iSCSI or FC)

Port-Address The Initiator’s port address

Num-Of-Conn-Targets The number of Targets the Initiator is connected to

Troubleshooting 81
Admin CLI Commands

test-ip-connectivity
The test-ip-connectivity admin-level command verifies the connectivity between
a Storage Controller and a specified IP address.
Usage:
test-ip-connectivity sc-id=<name or index> ip-addr=<IP Address>
interface=<ISCSI1, ISCSI2, ISCSI3, ISCSI4 or sc_management> [
cluster-id=<name or index> ]
NOTE! The following properties are mandatory: interface,
ip-addr, sc-id

Input Parameter Description Value Mandatory

interface Interface ISCSI1, ISCSI2, ISCSI3, Yes

ISCSI4,
sc_management

ip-addr The IP address to be IP address Yes

tested

sc-id Storage Controllers’ ID Name or index Yes

source

cluster-id Cluster ID Name or Index No

Example:
test-ip-connectivity interface=ISCSI1 ip-addr="10.0.0.1"
sc-id="X1-SC1"

test-ip-connectivity-netcat
The test-ip-connectivity-netcat admin-level command verifies the connectivity
between a source IP address and a specified destination IP address and TCP/UDP port.
Usage:
test-ip-connectivity-netcat src-host-ip=<IP address>
dst-host-ip=<IP address> dest-port-number=<Integer> [
connection-type=<TCP, UDP> ] [ cluster-id=<name or index> ]
NOTE! The following properties are mandatory: src-host-ip,
dst-host-ip, dest-port-number

Input Parameter Description Value Mandatory

src-host-ip Source host IP adress IP address Yes

dst-host-ip Destination host IP IP address Yes

address

dest-port-number Destination TCP/UDP Integer Yes

port

connection-type Connection type TCP, UDP No

cluster-id Cluster ID Name or Index No

82 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:
test-ip-connectivity-netcat src-host-ip="10.10.10.1"
dst-host-ip="1.2.3.4" dest-port-number=12

Output Parameter Description

Test-Output Output of the netcat test as provided by the OS

test-ip-connectivity-ping
The test-ip-connectivity-ping admin-level command verifies ping connectivity
between a source IP address and a destination IP address.
Usage:
test-ip-connectivity-ping src-host-ip=<IP address>
dst-host-ip=<IP address> [ ping-size=<Integer> ] [
df-flag=<True, False> ] [ cluster-id=<name or index> ]
NOTE! The following properties are mandatory: src-host-ip,
dst-host-ip

Input Parameter Description Value Mandatory

src-host-ip Source host IP adress IP address Yes

dst-host-ip Destination host IP IP address Yes

address

ping-size ping size in KB Integer (default value No

32)

df-flag Do not fragment flag to True, False No

avoid fragmentation

cluster-id Cluster ID Name or Index No

Example:
test-ip-connectivity-ping src-host-ip="10.10.10.1"
dst-host-ip="1.2.3.4"

Output Parameter Description

Test-Output Output of the ping test as provided by the OS

Troubleshooting 83
Admin CLI Commands

test-xms-storage-controller-connectivity
The test-xms-storage-controller-connectivity admin-level command
verifies the connectivity between the XMS and a Storage Controller.
Usage:
test-xms-storage-controller-connectivity sc-id=<name or index>
[ cluster-id=<name or index> ] [ packet-size=<positive integer>
]

Input Parameter Description Value Mandatory

sc-id Storage Controller ID Name or Index Yes

cluster-id Cluster ID Name or index No

packet-size Packet size Positive Integer No

Example:
test-xms-storage-controller-connectivity sc-id="X1-SC1"

84 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Log Bundle

create-debug-info
The create-debug-info admin-level command creates a log bundle.
Usage:
create-debug-info [ sc-mgr-host=<Host name> ] [ cluster-id=<id:
name or index> ] [ with-perf-data ] [ with-vmcore ] [ force ] [
debug-info-name=<string> ] [ datetime=<date-time string> ] [
debug-level=<small, medium (default)> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

datetime Date and time (e.g. date-time string No

2012-05-15 11:58:48)

debug-info-name Debug info name String (without spaces No

or special characters)

debug-level Debug level of the log small, medium No

collection. When (default) large, huge
omitted, default is
Medium.

force Force N/A No

sc-mgr-host Storage Controller IP Host name No

Address or Hostname

with-perf-data Collects performance N/A No

data.

with-vmcore Collects vmcore file. N/A No

Example:
create-debug-info

remove-debug-info
The remove-debug-info admin-level command deletes an existing log bundle.
Usage:
remove-debug-info debug-info-id=<name or index>

Input Parameter Description Value Mandatory

debug-info-id Name or index of the Name or index Yes

archive

Example:
remove-debug-info debug-info-id=1

Troubleshooting 85
Admin CLI Commands

show-debug-info
The show-debug-info admin-level command lists the log bundles that were created on
the XMS.
Usage:
show-debug-info [ duration=<seconds> ] [ frequency=<seconds> ]

Input Parameter Description Value Mandatory

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

Example:

show-debug-info

Output Parameter Description

Name The debug information’s name

Index The debug information’s index number

Cluster-Name The name of the cluster to which the Storage Controller belongs

Index The cluster’s index

Debug-Level The debug level of the log collection: small, medium

Creation-Start-Time Time stamp of log creation starting point

Create-Time Time stamp of debug collection completion

Output-Url Copies this URL to access/DL the debug file.

86 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Health Check

run-health-check-assessment
The run-health-check-assessment admin-level command, runs a Health Check
Script on the cluster.
Usage:
run-health-check-assessment [ cluster-id=<id: Name or Index> ]
[ tech-password=<String> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

tech-password Technician password String No

in case there is no
default password

Example:
run-health-check-assessment cluster-id=1

show-debug-info

Output Parameter Description

Name The debug information’s name

Index The debug information’s index number

Cluster-Name The name of the cluster to which the Storage Controller belongs

Index The cluster’s index

Debug-Level The debug level of the log collection: small, medium

Creation-Start-Time Time stamp of log creation starting point

Create-Time Time stamp of debug collection completion

Output-Url Copies this URL to access/DL the debug file.

Troubleshooting 87
Admin CLI Commands

Administration
User management

add-user-account
The add-user-account admin-level command creates a new user account to XMS.
Usage:
add-user-account usr-name=<string> role=<'read_only', 'admin',
'configuration', 'technician'> ( password=<string> |
public-key=<public key> ) [ inactivity-timeout=<integer> ]
NOTE! Only one property from the following list must be
selected: password, public-key.

Input Parameter Description Value Mandatory

role User Role read-only, admin, Yes

configuration,
technician

usr-name User Name String Yes

password User Password String Only one of the

following parameters
public-key User public key public key must be selected:
• password
• public-key

inactivity-timeout Inactivity timeout in Integer [0 - 720] No

minutes

Example:
add-user-account role=configuration usr-name="New_User"
password="p@ssw0rd"

88 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

modify-user-account
The modify-user-account admin-level command modifies an XMS user account’s
parameters.
Usage:
modify-user-account usr-id=<name or index> ( password=<string>
| public-key=<public key> | usr-name=<string> |
role=<'read_only', 'admin', 'configuration', 'technician'> |
inactivity-timeout=<integer> )
NOTE! At least one property from the following list is
mandatory: password, public-key, role, usr-name,
inactivity-timeout.

Input Parameter Description Value Mandatory

usr-id User ID Name or index Yes

inactivity-timeout Inactivity timeout in Integer At least one of the

minutes following parameters
must be selected:
password User password String • inactivity-timeout
public-key User public key String • password
• public-key
role User role ’read_only’, ’admin’, • role
’configuration’, • usr-name
’technician’
See Important note
usr-name User name String below.

IMPORTANT
The following parameter group is exclusive (you can select only one parameter from the
group): [password, public-key]

Example:
modify-user-account usr-id="Existing_User" role=administrator

Administration 89
Admin CLI Commands

remove-user-account
The remove-user-account admin-level command removes an XMS user account.
If the account is currently active (i.e. a command is in progress), account removal may fail.
Only users with administrative roles can remove other user accounts. Users cannot
remove their own accounts.
Usage:
remove-user-account usr-id=<name or index>

Input Parameter Description Value Mandatory

usr-id User ID Name or index Yes

Example:
remove-user-account usr-id="user1"

show-user-accounts
The show-user-accounts admin-level command displays the XMS user account
information.
Usage:
show-user-accounts [ duration=<seconds> ] [ frequency=<seconds>
]

Input Parameter Description Value Mandatory

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

Example:
show-user-accounts duration=300 frequency=10

Output Parameter Description

Name The user’s name

Index The user’s index number

Role The user’s permission level

External-Account Indicates whether the user was authenticated by an external server

and is not defined locally.

Inactivity-Timeout The number of minutes with no activity after which the user needs
to re-login

90 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

modify-password
The modify-password admin-level command modifies the XMS user account’s
password. If the usr-id parameter is not provided, then the current XMS user account’s
password is modified.
Usage:
modify-password [ password=<string> ] [ usr-id=<name or index>
]

Input Parameter Description Value Mandatory

password User password String No

usr-id User ID Name or index No

Example:
modify-password usr-id="admin" password="123456"

add-ldap-config
The add-ldap-config admin-level command adds a new LDAP configuration profile to
the LDAP configuration table.
Usage:
add-ldap-config
server-urls=<["ldap://ad.example.com","ldaps://ad.example.com:3
001"]>
roles=<["admin:CN=SuperUsers,DC=example,DC=com","read_only:CN=U
sers,DC=example,DC=com"]>
search-filter=<(sAMAccountName={username})> [
binddn=<CN=<value>,OU=<value>,DC=<value>,DC=<value>> ] [
bindpw=<password> ] [ timeout=<(default: 1500)> ] [
search-base=<OU=<value>,DC=<value>,DC=<value>> ] [
user-to-dn-rule=<{username}@example.com> ] [
cache-expire-hours=<Credentials cache expiration (default: 24
hours)> ] [ ca-cert-data=<string> ]

Input Parameter Description Value Mandatory

roles Role to DN mapping ["admin:CN=SuperUse Yes

list rs,DC=example,DC=co
m","read_only:CN=Us
ers,DC=exmaple,DC=c
om"

search-filter Search filter sAMAccountName={u Yes

sername}

server-urls Server URLs ["ldap://ad.exmaple.c Yes

om"]

binddn Bind DN CN=<value>,OU=<value No

>,DC=<value>,DC=<valu
e>

bindpw Bind password Password No

Administration 91
Admin CLI Commands

Input Parameter Description Value Mandatory

ca-cert-data X509 server certifiate String No

cache-expire-hours Credential expiration Credentials cache No

expiration (default: 24
hours)

search-base Search base OU=<value>,DC=<value>, No

DC=<value>

timeout Connection timeout Integer (default: 1500 No

seconds)

user-to-dn-rule User to DN {username}@example. No

substitution com

Example:
add-ldap-config
server-urls=["ldap://ad.example.com","ldaps://ad.example.com:30
01"] search-filter="sAMAccountName={username}"
roles=["admin:CN=SuperUsers,DC=example,DC=com","read_only:CN=Us
ers,DC=example,DC=com"] binddn="CN=Test
User,OU=Users,DC=exmaple,DC=com"
[search-base="OU=support,DC=help,DC=com"
user-to-dn-rule="{username}@example.com"

remove-ldap-config
The remove-ldap-config admin-level command removes an LDAP configuration
profile from the LDAP configuration table.
Usage:
remove-ldap-config ldap-config-id=<index>

Input Parameter Description Value Mandatory

ldap-config-id LDAP configuration index Yes

profile ID

Example:
remove-ldap-config ldap-config-id=1

92 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

modify-ldap-config
The modify-ldap-config admin-level command modifies an LDAP configuration
profile.
Usage:
modify-ldap-config ldap-config-id=<index> (
binddn=<CN=<value>,OU=<value>,DC=<value>,DC=<value>> |
server-urls=<["ldap://ad.example.com","ldaps://ad.example.com:3
001"]> | user-to-dn-rule=<{username}@example.com> |
cache-expire-hours=<Credentials cache expiration (default: 24
hours)> |
roles=<["admin:CN=SuperUsers,DC=example,DC=com","read_only:CN=U
sers,DC=example,DC=com"]> | ca-cert-data=<string> |
search-base=<OU=<value>,DC=<value>,DC=<value>> |
search-filter=<(sAMAccountName={username})> | bindpw=<password>
| timeout=<(default: 1500)> )
NOTE! At least one property from the following list is
mandatory: binddn, server-urls, user-to-dn-rule,
cache-expire-hours, roles, ca-cert-data, search-base,
search-filter, bindpw, timeout.

Input Parameter Description Value Mandatory

ldap-config-id LDAP configuration ID Index Yes

binddn Bind DN CN=<value>,OU=<value At least one of the

>,DC=<value>,DC=<valu following parameters
e> must be selected:
• binddn
bindpw Bind password Password
• bindpw
ca-cert-data X509 server certificate String • ca-cert-data
• cache-expire
cache-expire Credential expiration Credentials cache • roles
expiration (default: 24
• search-base
hours)
• search-filter
roles Role to DN mapping ["admin:CN=SuperUse • server-urls
list rs,DC=example,DC=co • timeout
m","read_only:CN=Us • user-to-dn-rule
ers,DC=exmaple,DC=c
om"

search-base Search base OU=<value>,DC=<value>,

DC=<value>

search-filter Search filter sAMAccountName={u

sername}

server-urls Server URLs ["ldap://ad.exmaple.c

om"]

timeout Connection timeout Integer (default: 1500

seconds)

user-to-dn-rule User to DN {username}@example.

substitution com

Administration 93
Admin CLI Commands

Example:
modify-ldap-config ldap-config-id=1
binddn="CN=alexs,DC=app-lab,DC=xtremio,DC=com"
search-base="OU=guiadmin,DC=app-lab,DC=xtremio,DC=com"
search-filter="userPrincipalName={username}"
roles=["configuration:CN=XtremIOread,OU=guiadmin,DC=app-lab,DC=
xtremio,DC=com"] server-urls=["ldap://10.82.36.84"]

show-ldap-configs
The show-ldap-configs admin-level command lists the LDAP server configurations
and their parameters.
Usage:
show-ldap-configs [ duration=<seconds> ] [ frequency=<seconds>
]

Input Parameter Description Value Mandatory

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

Example:
show-ldap-configs

Output Parameter Description

Index The number of entry in the LDAP configuration table

Bind-DN A distinguished name for querying groups and performing searches

on behalf of other users

Search-Base The starting point for the search in the directory tree. Comprises of
multiple objects separated by commas, including:
• cn: common name
• ou: organizational unit
• o: organization
• c: country

Search-Filter Determines what entries are returned, following a search. For

example:
• sAMAccountName={sam}
• sAMAccountName={username}

LDAP-Servers The field replaceable unit state (healthy, disconnected, failed, or

initializing)

User-to-DN-Rule A mapping of the user input to the search criteria

Role-Mapping The list of XMS roles (Active Directory group mapping roles)

94 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

Timeout The time in seconds before switching to the secondary server or

failing the request, in case no answer is received from the server

Credentials-Expiration The time in hours (1 to 24) before the cached user authentication
expires and re-authentication is required

CA-Cert-File Certificate file for server validation (when LDAPS protocol is used)

modify-dns-servers
The modify-dns-servers admin-level command sets or modifies the IP address of
the primary and/or secondary DNS server.
Usage:
modify-dns-servers ( primary=<IP Address> | secondary=<IP
Address> )
NOTE! At least one property from the following list is
mandatory: primary, secondary.

Input Parameter Description Value Mandatory

primary Primary IP Address IP Address At least one of the

following parameters
secondary Secondary IP Address IP Address must be selected:
• primary
• secondary

Example:
modify-dns-server primary="1.2.3.4"

show-dns-servers
The show-dns-servers admin-level command displays the IP addresses of the
primary and secondary DNS servers (if configured).
Usage:
show-dns-servers
Example:
show-dns-servers

Output Parameter Description

Primary Primary DNS server IP Address

Secondary Secondary DNS server IP Address

Administration 95
Admin CLI Commands

show-remote-servers-status
The show-remote-servers-status admin-level command displays a list of all
external servers (NTP, DNS, primary gateway and, if configured, secondary gateway), their
IP addresses and connectivity information.
Usage:
show-remote-servers-status
Example:
show-remote-servers-status

Output Parameter Description

Server-Type The server’s type (DNS, Gateway)

Server-IP The server’s IP address

Server-Status The server’s status (reachable/unreachable)

96 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Certificate Management

create-server-certificate-signing-request
The create-server-certificate-signing-request admin-level command
instructs the server to generate a public-private key pair and a certificate signing request
(CSR) that can be sent to a third party certification authority (CA) for signing.
Usage:
create-server-certificate-signing-request [
cert-alt-name=<alternative name e.g. IP=1.2.3.4
DNS.1=server.example.com DNS.2=1.2.3.4> ] [ cert-state=<string>
] [ cert-org-name=<string> ] [ cert-email=<Email address> ] [
cert-ip=<IP address> ] [ cert-common-name=<domain name, e.g.
xms.example.com> ] [ server-key-size=<integer between 2048 and
4096> ] [ cert-locality=<string> ] [
cert-org-unit-name=<string> ] [ server-key-string=<string> ] [
cert-country=<Two-letter ISO_3166-1 country code, e.g. US> ]

Input Parameter Description Value Mandatory

cert-alt-name Certificate alternative e.g. IP=1.2.3.4 No

name DNS.1=server.exmapl
e.com DNS.2=1.2.3.4

cert-common-name Fully qualified domain Domain name, e.g. No

name xms.example.com

cert-country Certificate country Two letter ISO_3166-1 No

name country code, e.g. US

cert-email Email address Email address No

cert-ip IP address IP address No

cert-locality Locality String No

cert-org-name Organization name String No

cert-org-unit-name Organizational unit String No

name

cert-state State or province String No

server-key-size Server key size Integer between 2048 No

and 4096

server-key-string Server private key String No

Example:
create-server-certificate-signing-request

Administration 97
Admin CLI Commands

install-self-signed-server-certificate
The install-self-signed-server-certificate admin-level command installs
the new self-signed certificate.
Usage:
install-self-signed-server-certificate [cert-ip=<IP address>
|cert-common-name=<domain name, e.g. xms.example.com> ]
[cert-alt-name<subject alternative name, e.g. IP=1.2.3.4
DNS.1=server.exmaple.com DNS.2=1.2.3.4> ]
[server-certificate-signing-request-string=<string> ] [
server-key-string=<string> ]

Input Parameter Description Value Mandatory

cert-alt-name Subject alternative E.g. IP=1.2.3.4 No

name DNS.1=server.exampl
e.com DNS.2=1.2.3.4

cert-common-name Fully qualified domain domain name, e.g. No

name xms.example.com

cert-ip IP Address IP Address No

server-certificate-signi Certificate Signing String No

ng-request-string Request

server-key-string RSA private key (if the String No

CSR was not created
by XMS)

example:
install-self-signed-server-certificate
cert-common-name="xms.example.com"

show-server-certificate
The show-server-certificate admin-level command displays the currently loaded
certificate.
Usage:
show-server-certificate
example:
show-server-certificate

show-server-certificate-signing-request
The show-server-certificate-signing-request admin-level command
displays the certificate signing request.
Usage:
show-server-certificate-signing-request
example:
show-server-certificate-signing-request

98 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

modify-server-certificate
The modify-server-certificate admin-level command initiates loading of a
signed certificate and a key. It is possible to load a signed certificate, matching the current
CSR or a signed certificate paired with a private key.
Usage:
modify-server-certificate server-certificate-string=<string> [
chain-certificate-string=<string> ] [
server-key-string=<string> ]

Input Parameter Description Value Mandatory

server-certificate-strin X509 Server Certificate String Yes

g

server-key-string X509 private key String No

chain-certificate-string Chain of X509 String No

Certificates

Administration 99
Admin CLI Commands

Cluster Management (Cluster Level)

modify-clusters-parameters
The modify-clusters-parameters admin-level command modifies the following
cluster parameters:
 SNMP Heartbeat
 SSH timeout while copying logs
 ESX device connectivity mode
 Obfuscated Log Bundle
 ODX Mode
 Performance Data Collection mode
 Replication TCP Port
 Installation type
Usage:
modify-clusters-parameters [ ( enable-heartbeat |
disable-heartbeat ) | iscsi-tcp-port=<integer> |
odx-mode=<enabled, disabled> | obfuscate-debug=<enabled,
disabled> | debug-create-timeout=<normal, high, none> |
replication-tcp-port=<integer> |
esx-device-connectivity-mode=<apd, pdl> |
performance-data-collection=<enabled, disabled> |
installation-type=<standard_installation_rpq ] [
installation-type=<standard_installation, rpq> ]
[installation_type-details=<string> ] [ entity=<Volume> ] [
cluster-id=<name or index> ]
NOTE! At least one property from the following list is
mandatory: iscsi-tcp-port, odx-mode, replication-tcp-port,
obfuscate-debug, debug-create-timeout,
esx-device-connectivity-mode, disable-heartbeat,
enable-heartbeat, performance-data-collection,
installation-type
NOTE! Only one property from the following list is allowed:
enable-heartbeat, disable-heartbeat
NOTE! When enabling performance-data-collection, the entity
property is mandatory.

100 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Input Parameter Description Value Mandatory

debug-create-timeout Debug info creation ’high’, ’none’, ’normal’ At least one of the
timeout following parameters
must be selected:
esx-device-connectivit Device connectivity ’apd’ (currently this • debug-create-timeou
y-mode mode value cannot be t
modified)
• esx-device-connectivi
disable-heartbeat Disables SNMP N/A ty-mode
Heartbeat. • disable-heartbeat
• enable-heartbeat
enable-heartbeat Enables SNMP N/A • iscsi-tcp-port
Heartbeat.
• obfuscate-debug
iscsi-tcp-port iSCSI TCP Port Integer • odx-mode
• performance-data-col
obfuscate-debug Obfuscates debug enabled, disabled lection
info. • replication-tcp-port
odx-mode ODX mode enabled, disabled • installation-type

performance-data-coll Modifies the enabled, disabled

ection Performance Data
Collection mode of all
instances of the
specified entity.

replication-tcp-port Remote protection TCP Integer

port

installation-type Installation type standard_installation,

rpq

cluster-id The cluster’s ID Name or Index No

entity Entity name Volume No

installation-type-detail Installation details String No

s must be provided if
installation_type is not
standard

Example:
modify-clusters-parameters cluster-id="My_Cluster"
odx-mode=enabled obfuscate-debug=enabled

Administration 101
Admin CLI Commands

modify-cluster-thresholds
The modify-cluster-thresholds admin-level modifies the properties for thin
provisioning soft limits for connected clusters.
Usage:
modify-cluster-thresholds vaai-tp-limit=<range 0-100> [
cluster-id=<name or index> ]

Input Parameter Description Value Mandatory

vaai-tp-limit VAAI TP Limit Range 0 - 100 Yes

cluster-id Cluster ID Name or index No

Example:
modify-cluster-thresholds vaai-tp-limit=89

show-clusters-data-protection-properties
The show-clusters-data-protection-properties admin-level command
displays clusters’ data protection properties.
Usage:
show-clusters-data-protection-properties [cluster-id=<id: name
or index> ] [ duration=<seconds> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

102 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:

show-clusters-data-protection-properties

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

Min-SSDs-Per-Healthy-DPG The minimum number of active SSDs for a healthy state Data
Protection Group

Max-SSDs-Per-DPG The maximum number of SSDs allowed per Data Protection Group

show-clusters-info
The show-clusters-info admin-level command displays additional information,
which is not displayed in the show-clusters command, about configured clusters.
Usage:
show-clusters-info [cluster-id=<id: name or index> ] [
duration=<seconds> ] [ frequency=<seconds> ] [ vertical ] [
filter ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

filter Filters command See “Using Filters” on No

output page 11.

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Administration 103
Admin CLI Commands

Example:
show-clusters-info vertical duration=300 frequency=10

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

State The cluster’s current state

Conn-State Connection status:

• Disconnected - XMS is currently disconnected from the
cluster.
• Connected - XMS is currently connected to the cluster.

Activation-Time Time stamp of cluster activation in DATE & TIME format, e.g. Tue
Oct 8 11:12:42 2013

Start-Time Time stamp of cluster start in DATE &TIME format (e.g. Tue Oct 8
11:12:42 2013)

SW-Version The cluster’s software version

PSNT The cluster’s Product Serial Number Tag (assigned by Dell EMC)

Encryption-Mode The cluster’s encryption mode

Encryption-Supported Indicates whether the cluster supports encryption.

Encryption-Mode-State The cluster’s encryption mode’s state

Compression-Mode The cluster’s compression mode

SSH-Firewall-Mode The cluster’s SSH firewall mode

OS-Upgrade-Ongoing Indicates whether an OS upgrade process is ongoing.

Cluster-Expansion-In-Progress Indicates whether cluster expansion is in progress (not

supported in this version).

Upgrade-State The cluster’s upgrade status

104 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-clusters-parameters
The show-clusters-parameters admin-level command displays configured clusters
parameters.
Usage:
show-clusters-parameters [cluster-id=<id: name or index> ] [
duration=<seconds> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-clusters-parameters

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

ODX-Mode Indicates whether ODX (Microsoft’s Offloaded Data Transfer) is

enabled.

iSCSI-TCP--Port The cluster’s iSCSI listen TCP port number (default 3260)

Obfuscate-Debug-Info Indicates whether log bundle obfuscates client sensitive

information.

Debug-Info-Creation-Timeout The timeout used for log bundle creation

Send-SNMP-Heartbeat Indicates whether sending an SNMP Heartbeat is enabled.

Replication-TCP-Port The cluster’s replication TCP port number (default value is 1758)

ESX-Device-Connectivity-Mode Indicates the connectivity mode (currently, the mode is APD and
cannot be modified).

Volumes-Performance-Data-C Indicates whether Performance Data Collection is enabled or

ollection disabled.

Administration 105
Admin CLI Commands

show-clusters-savings
The show-clusters-savings admin-level command displays a list of data-reduction
related values per cluster.
Usage:
show-clusters-savings [cluster-id=<id: name or index> ] [
duration=<seconds> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-clusters-savings

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

Data-Reduction-Ratio The cluster’s data reduction ratio (calculated using the data
deduplication and data compression)

Thin-Provisioning-Ratio The cluster’s thin provisioning ratio (used disk space compared to
allocated disk space)

Dedup-Ratio The cluster’s deduplication ratio (calculated data written to the

array compared to unique data on SSD)

Compression-Factor The cluster’s compression factor (calculated using the unique data
on the SSD compared to the physical capacity used)

106 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-memory-usage
The show-memory-usage admin-level command shows the current memory usage
parameters.
Usage:
show-memory-usage [cluster-id=<id: name or index> ] [
duration=<seconds> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-memory-usage

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

Total-Memory-In-Use (%) The total memory used (in percent)

Total-Memory-In-Use (MB) The total memory used (in MB)

Total-Memory (MB) Total memory (in MB)

Shared-Memory-Utilization-Level Shared memory in use recoverable ratio level

A2H-Utilized (%) A2H memory utilization

H2P-Utilized (%) H2P memory utilization

A2H-In-Use (MB) A2H memory in use

H2P-In-Use (MB) H2P memory in use

Shared-Memory-Efficiency-Level The shared memory efficiency level

Shared-Memory-In-Use Shared memory in use

Shared-Memory-Utilization Level of shared memory utilization

Administration 107
Admin CLI Commands

show-clusters-thresholds
The show-clusters-thresholds admin-level command displays thin provisioning
soft limits for the connected clusters.
Usage:
show-clusters-thresholds [cluster-id=<id: name or index> ] [
duration=<seconds> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-clusters-thresholds

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

Thin-Provisioning-Soft-Limit Percentage value of limit placed on storage space

108 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

set-context
The set-context admin-level command sets a cluster context in a multiple cluster
environment and renders the need to specify the cluster ID.
Usage:
set-context ( all | cluster-id=<id: name or index> )
NOTE! At lease one property from the following list is
mandatory: all, cluster-id
NOTE! Only one property from the following list is allowed: all,
cluster-id.

Input Parameter Description Value Mandatory

all All clusters N/A Only one of the

following parameters
cluster-id Cluster ID Name or Index must be selected:
• all
• cluster-id

Example:
set-context all

modify-ssh-firewall
The modify-ssh-firewall command admin-level modifies the lock mode of the SSH
firewall.
Usage:
modify-ssh-firewall ssh-firewall-mode=<'locked', 'unlocked'> [
cluster-id=<name or index> ]

Input Parameter Description Value Mandatory

ssh-firewall-mode SSH firewall mode locked, unlocked Yes

cluster-id Cluster ID Name or Index No

Example:
modify-ssh-firewall ssh-firewall-mode=locked

Administration 109
Admin CLI Commands

show-xenvs
The show-xenvs admin-level command displays the list of Storage Controller
X-Environments, their state and CPU utilization.
Usage:
show-xenvs [ duration=<seconds> ] [ cluster-id=<id: name or
index> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-xenvs cluster-id=1

Output Parameter Description

XEnv-Name The XEnv’s name

Index The XEnv’s index number

Cluster-Name The Cluster’s name

Index The Cluster’s index number

CPU (%) The current percentage of CPU usage

CSID The unique clustering ID used for internal messaging

State The XEnv’s current state: active or inactive

Storage-Controller-Name The Storage Controller’s name

Index The Storage Controller’s index number

Brick-Name The X-Brick’s name

Index The X-Brick’s index number

110 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-cluster-dae-temperature-thresholds

Note: This command applies to X2 cluster type only.

The show-cluster-dae-temperature-thresholds admin-level command shows

the currently configured thresholds for the cluster's DAE temperature sensors.
Usage:
show-cluster-dae-temperature-thresholds [cluster-id=<id: name
or index> ] [ filter=<> ] [ prop-list=<List of property strings>
]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or index No

filter Filter command output See “Using Filters” on No

page 11.

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:
show-cluster-dae-temperature-thresholds

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

DAE-Controllers/Row-Critica The temperature threshold that triggers issuing a critical

l-Temperature-Threshold temperature alert for te DAE Controller/Row.

DAE-Controllers/Row-High-T The temperature threshold that triggers issuing a high temperature

emperature-Threshold alert for te DAE Controller/Row.

Administration 111
Admin CLI Commands

modify-cluster-dae-temperature-thresholds

Note: This command applies to X2 cluster type only.

The modify-cluster-dae-temperature-thresholds admin-level command

modifies the DAE temperature monitoring parameters.
Usage:
modify-cluster-dae-temperature-thresholds (
dae-temperature-clear-hysteresis=<range 0-3> |
dae-temperature-monitor-mode=<enabled or disabled> |
dae-temperature-period-delay=<range 30-60> ) [ cluster-id=<name
or index> ]
NOTE! At least one property from the following list is
mandatory: dae-temperature-clear-hysteresis,
dae-temperature-monitor-mode, dae-temperature-period-delay.

Input Parameter Description Value Mandatory

dae-temperature-clear Hysteresis to clear the Range 0 - 3 At least one of the

-hysteresis dae temperature alert. following parameters
must be selected:
dae-temperature-moni Indicates the status of enabled, disabled • dae-temperature-clea
tor-mode the dae temperature r-hysteresis
monitoring
• dae-temperature-mo
dae-temperature-perio The duration of the Range 30 - 60 nitor-mode
d-delay delay period before • dae-temperature-peri
action. od-delay

cluster-id Cluster name Name or Index No

Example:
modify-cluster-dae-temperature-thresholds
dae-temperature-clear-hysteresis=2 monitor-mode=enabled

112 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-cluster-ssd-temperature-thresholds

Note: This command applies to X2 cluster type only.

The show-cluster-ssd-temperature-thresholds admin-level command shows

the currently-configured thresholds for the cluster's SSD temperature sensors.
Usage:
show-cluster-ssd-temperature-thresholds [cluster-id=<id: name
or index> ] [ filter=<> ] [ prop-list=<List of property strings>
]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or index No

filter Filter command output See “Using Filters” on No

page 11.

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:
show-clusters-ssd-temperature-thresholds

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

SSD-Critical-Temperature-Th The temperature threshold that triggers issuing a critical

reshold temperature alert for the SSD.

SSD-High-Temperature-Thre The temperature threshold that triggers issuing a high temperature

shold alert for te SSD.

Administration 113
Admin CLI Commands

Cluster Management (XMS Level)

show-xms
The show-xms admin-level command displays the XMS machine’s parameters.
Usage:
show-xms [ duration=<seconds> ] [ frequency=<seconds> ]

Input Parameter Description Value Mandatory

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

Example:
show-xms duration=300 frequency=10

Output Parameter Description

Name The Management cluster’s name

Index The Management cluster’s index number

SW-Version The XMS software version

XMS-IP-Addr-With-Subnet The XMS IP address and the address subnet

XMS-Secondary-IP-Addr-With-Sub The secondary XMS IP address and the address subnet

net

XMS-Mgmt-Ifc The interface name for the XMS IP management

REST-API-Protocol-Version Version number of the RESTful API protocol

IP-Version IP version (IPV4, IPV6)

Default-User-Inactivity-Timeout Default user inactivity timeout

Repeating-Alert-Threshold The set threshold for repeating alerts

Min-TLS-Version The minimal TLS version supported by the XMS (1.0 (default),
1.1 or 1.2)

114 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-xms-info
The show-xms-info admin-level command displays information on server statistics,
disk usage and Ethernet interfaces.
Usage:
show-xms-info [ duration=<seconds> ] [ frequency=<seconds> ]

Input Parameter Description Value Mandatory

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

Example:
show-xms-info duration=300 frequency=10

Server Statistics Output

Output Parameter Description

Name The Management server’s name

Index The Management server’s index number

Avg-CPU Average CPU usage

Total-RAM Total RAM capacity

Used-RAM Used RAM capacity

Curr-Logs-Size Current size of logs

Uptime Time measured since XMS was down

Disk Usage Output

Output Parameter Description

Name Disk name

Index Disk index number

1k-Blocks Number of 1KB blocks on disk

Available The available space on the disk

Used The used space on the disk

Administration 115
Admin CLI Commands

Ethernet Interfaces Output

Output Parameter Description

Name Interface name

Index Interface index number

IP Interface IP address

Secondary-IP Secondary IP address of the interface

MAC-Address Interface MAC address

State Interface state (up, down)

Received-Bytes Number of received bytes

Received-Packets Number of received packets

Sent-Bytes Number of sent bytes

Sent-Packets Number of sent packets

Dropped-Packets Number of dropped packets

show-xms-parameters
The show-xms-parameters admin-level command displays the XMS’s parameters.
Usage:
show-xms-parameters [ duration=<seconds> ] [
frequency=<seconds> ]

Input Parameter Description Value Mandatory

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

Example:
show-xms-parameters duration=300 frequency=10

Output Parameter Description

Name The Management cluster’s name

Index The Management cluster’s index number

Advisory-Notification-Processing Indicates if Advisory Notifications processing is enabled.

Repeating-Alert-Threshold The threshold set for repeating alerts

Default-User-Inactivity-Timeout Default user inactivity timeout

Min-TLS-Version Minimum version of Transport Layer Security allowed

116 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-xms-esrsve-registration
The show-xms-esrsve-registration admin-level command displays registration
status of clusters to primary/secondary ESRS-VE gateways.
Usage:
show-xms-esrsve-registartion [ duration=<seconds> ] [
frequency=<seconds> ] [ cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

Example:
show-xms-esrsve-registration duration=300 frequency=10

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

Primary-Esrs-Key Indicates whether the cluster is registered to a primary

ESRS-VE gateway (registered, not registered)

Secondary-Esrs-Key Indicates whether the cluster is registered to a secondary

ESRS-VE gateway (registered, not registered)

refresh-xms-ssh-key
The refresh-xms-ssh-key admin-level command generates a new unique SSH key
on the XMS and updates all related clusters accordingly.
Usage:
refresh-xms-ssh-key
Example:
refresh-xms-ssh-key

Administration 117
Admin CLI Commands

show-exported-configurations
The show-exported-configurations admin-level command displays a list of the
available XMS/cluster configuration backups.
Usage:
show-exported-configurations
Example:
show-exported-configurations

Output Parameter Description

Backup-Name Name of the backup file

Created Date and time of backup creation

URL Location of the backup file

Example:
show-exported-configurations

Note: For details on how to copy an exported configuration file from an XMS to another
XMS, refer to the XtremIO Storage Array User Guide.

export-xms-cluster-configuration
The export-xms-cluster-configuration admin-level command exports a
backup file containing all XMS and cluster objects to a downloadable file.

Note: Passwords are not stored on the exported file.

Note: It is possible to export a cluster configuration of an X1 cluster and import it to an X2

cluster.

Usage:
export-xms-cluster-configuration [ cluster-id=<name or index> ]
[ prefix=<string> ]

Input Parameter Description Value Mandatory

cluster-id Target cluster ID Name or index No

prefix The prefix to be added String No

to the created tarball
file

Example:
export-xms-cluster-configuration

118 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

import-xms-cluster-configuration
The import-xms-cluster-configuration admin-level command imports XMS
and cluster configuration from a configuration file.

Note: It is possible to export a cluster configuration of an X1 cluster and import it to an X2

cluster.

Usage:
import-xms-cluster-configuration filename=<file name (string)>
[ ( all | objects-to-import=<UserAccount, Tag, InitiatorGroup,
Volume, ConsistencyGroup, Scheduler, Target, Initiator,
IscsiPortal, IscsiRoute, LdapConfig, LunMapping, SyrNotifier,
EmailNotifier, SnmpNotifier, SyslogNotifier, AlertDefinition,
DNS, Chap, NTP> ) ] [ cluster-id=<name or index> ] [
import-cluster-name ] [ snapshots ]
NOTE! Only one property from the following list must be
selected: all, objects-to-import.

Input Parameter Description Value Mandatory

filename File Name String Yes

all Import all objects N/A Only one of the

following parameters
objects-to-import List of objects to UserAccount, Tag, must be selected:
import InitiatorGroup, • all
Volume,
• objects-to-import
ConsistencyGroup,
Scheduler, Target,
Initiator, IscsiPortal,
IscsiRoute,
LdapConfig,
LunMapping,
SyrNotifier,
EmailNotifier,
SnmpNotifier,
SyslogNotifier,
AlertDefinition, DNS,
Chap, NTP

cluster-id Target cluster ID Name or index No

import-cluster-name Import cluster name N/A No

snapshots Import Snapshots N/A No

Example:
import-xms-cluster-configuration filename="backup1"
objects-to-import=[Volume, InitiatorGroup, Initiator] snapshots

Administration 119
Admin CLI Commands

remove-exported-configuration
The remove-exported-configuration admin-level command removes an XMS and
cluster configuration file.
Usage:
remove-exported-configuration filename=<string>

Input Parameter Description Value Mandatory

filename File Name String Yes

Example:
remove-exported-configuration filename="backup1"

120 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

modify-xms-parameters
The modify-xms-parameters admin-level command modifies one or more of the
XMS’s parameters.
Usage:
modify-xms-parameters (
advisory-notifications-processing=<enabled,disabled> |
appsync-mode=<enabled, disabled> | cloud-iq-reporting=<true,
false> | default-user-inactivity-timeout=<integer> |
max-repeating-alert=<integer 10-100000> | min-tls-version=<e.g.
"1.0", "1.1", "1.2"> | xms-server-ldap-authentication=<enabled,
disabled> | debug-info-auto-collect=<enabled, disabled> )
NOTE! At least one property from the following list is
mandatory: default-user-inactivity-timeout,
max-repeating-alert, advisory-notifications-processing,
min-tls-version, appsync-mode, cloud-iq-reporting,
xms-server-ldap-authentication, debug-info-auto-collect.

Input Parameter Description Value Mandatory

advisory-notifications- Enable or disable enabled, disabled At least one of the

processing Advisory notifications following parameters
processing must be selected:
• advisory-notification
appsync-mode Enable/disable enabled, disabled s-processing
AppSync
• appsync-mode
cloud-iq-reporting Turn CloudIQ reporting true, false • cloud-iq-reporting
on/off • default-user-inactivit
y-timeout
default-user-inactivity- Default user inactivity Integer • max-repeating-alert
timeout timeout in minutes
• min-tls-version
max-repeating-alert Repeating alerts Integer 10-100000 • xms-server-ldap-auth
threshold, alerts per entication
day • debug-info-auto-colle
ct
min-tls-version TLS version e.g. "1.0" "1.1" "1.2"

xms-server-ldap-authe Enable/disable XMS enabled, disabled

ntication server LDAP
authentication

debug-info-auto-collec Enable/disable debug enabled, disabled

t info automatic
collection.

Example:
modify-xms-parameters default-user-inactivity-timeout=30
max-repeating-alert=10

Administration 121
Admin CLI Commands

add-xms-secondary-ip-address
The add-xms-secondary-ip-address admin-level command adds a secondary XMS
IP address and default gateway.
Usage:
add-xms-secondary-ip-address ( xms-secondary-ip-and-sn=<string>
| xms-secondary-gw-addr=<string> )

Input Parameter Description Value Mandatory

xms-secondary-ip-and XMS secondary IP String At least one of the

-sn address and following parameters
subnetmask must be selected:
• xms-secondary-ip-an
xms-secondary-gw-ad XMS secondary String d-sn
dr gateway address
• xms-secondary-gw-a
ddr

Example:
add-xms-secondary-ip-address xms-secondary-gw-addr="10.10.10.1"

remove-xms-secondary-ip-address
The remove-xms-secondary-ip-address admin-level command removes a
secondary XMS IP address and default gateway.
Usage:
remove-xms-secondary-ip-address

Input Parameter Description Value Mandatory

Example:
remove-xms-secondary-ip-address

122 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

set-interactive-mode
The set-interactive-mode admin-level command sets interactive/non-interactive
mode for the XMS, to enable running CLI scripts.
Usage:
set-interactive-mode [ disable ]

Input Parameter Description Value Mandatory

disable Disable interactive N/A No

mode

Example:
set-interactive-mode

show-timezones
The show-timezones admin-level command displays the list of available timezones.
Usage:
show-timezones

Input Parameter Description Value Mandatory

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

Example:
show-timezones

show-datetime
The show-datetime admin-level command displays time-related information.
Usage:
show-datetime
Example:
show-datetime

Output Parameter Description

Mode Either manual (when no NTP servers are defined) or automatic

(when one or more NTP servers are defined)

NTP-Servers Displays the list of defined NTP Servers.

Cluster-Time The cluster’s set date and time

Cluster-Time-Zone Time zone in which the cluster is located

UTC-Offset The offset from Greenwich time (in Hours)

DST Indicates whether Daylight Saving Time is applied.

Administration 123
Admin CLI Commands

modify-datetime
The modify-datetime admin-level command sets or modifies the cluster’s date and
time, timezone, or NTP server parameters.
Usage:
modify-datetime ( datetime=<date-time string> |
ntp-servers=<list of NTP servers> | timezone=<time zone> )
NOTE! At least one property from the following list is
mandatory: datetime, ntp-servers, timezone.

Input Parameter Description Value Mandatory

datetime Datetime Datetime string, e.g. At least one of the

2013-12-20 17:46:24 following parameters
must be selected:
ntp-servers NTP server list List of NTP servers • datetime
timezone Time zone Time zone, e.g. • ntp-servers
US/Pacific • timezone

Example:
modify-datetime datetime="2016-01-01 10:00:00"

modify-login-banner
The modify-login-banner admin-level command modifies the login banner text.
Usage:
modify-login-banner banner=<ascii string>

Input Parameter Description Value Mandatory

banner CLI/GUI banner ascii string (up to Yes

3771 characters)

Example:
modify-login-banner banner="New_Banner"

124 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-server-name
The show-server-name admin-level command displays the server name, according to
the name configuration mode, as follows:
 Fixed mode - The server name is manually set by the user (using modify-server-name).
 DNS mode - The server name is drawn from reverse DNS lookup (enabled, using
modify-server-name).
 Dynamic mode - The server name is set according to the user’s URL request.
Usage:
show-server-name
Example:
show-server-name

modify-server-name
The modify-server-name admin-level command defines or modifies the XMS’s URL.
The user can also enable/disable reverse DNS lookup to retrieve the URL, based on the
XMS’s IP address.
Usage:
modify-server-name ( server-name=<e.g. xms.example.com> |
enable-reverse-dns | enable-user-url )
NOTE! At least one property from the following list is
mandatory: server-name, enable-reverse-dns, enable-user-url.

Input Parameter Description Value Mandatory

enable-reverse-dns Indicates whether to N/A At least one of the

enable reverse DNS following parameters
lookup. must be selected:
• enable-reverse-dns
enable-user-url Server redirects based N/A
• enable-user-url
on user URL.
• server-name
server-name Server name E.g. xms.example.com

Example:
modify-server-name server-name="XMS.domain.com"

Administration 125
Admin CLI Commands

restore-xms-simulator-configuration
The restore-xms-simulator-configuration admin-level command restores
XMS and cluster objects from an exported configuration or a log bundle.

Note: This command can be used only in Simulator mode.

Usage:
restore-xms-simulator-configuration

Input Parameter Description Value Mandatory

file-path Path of the SQL dump N/A Yes

file

Example:
restore-xms-simulator-configuration

126 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

XMS Notifiers

modify-email-notifier
The modify-email-notifier admin-level command modifies the Email notification
settings.
Usage:
modify-email-notifier [ ( add-recipient=<added recipient> |
remove-recipient=<removed recipient> | recipient-list=<list of
recipients> ) ] [ company-name=<company name> ] [
contact-details=<contact details> ] [ disable ] [ enable ] [
mail-password=<password for smtp mail relay> ] [
mail-relay-address=<IP or DNS for smtp mail relay> ] [
mail-user=<user for smtp mail relay> ] [
reset-configuration=<N\A> ] [ sender=<Sender> ]
NOTE! Only one property from the following list is allowed:
add-recipient, remove-recipient, recipient-list

Input Parameter Description Value Mandatory

add-recipient Adds one recipient to Host name or IP No

the list. address

remove-recipient Removes one recipient Host name or IP No

from the list. address

recipient-list A list of email List of recipients No

recipients

company-name The company’s name Company name No

contact-details The contact details Contact details No

disable Disables the mail N/A No

notifier.

enable Enables the mail N/A No

notifier.

mail-password A password for SMTP Password for SMTP No

mail relay mail relay

mail-relay-address IP or DNS for SMTP IP or DNS for SMTP No

mail relay mail relay

mail-user A user for SMTP mail User for SMTP mail No

relay relay

reset-configuration Resets the N/A No

configuration.

sender The sender’s email Sender No

address

Administration 127
Admin CLI Commands

Example:
modify-email-notifier
recipient-list=["[email protected]","[email protected]"]
transport=smtp mail-relay-address="smtp.domain.com"
mail-user="user" mail-password="123456" sender="[email protected]"

send-email-notification
The send-email-notification admin-level command verifies the Email notification
configuration by sending a test message containing a user-defined text.
Usage:
send-email-notification text

Input Parameter Description Value Mandatory

text Notification text String Yes

Example:
send-email-notification text="Test_Email"

show-email-notifier
The show-email-notifier admin-level command displays the Email notification
settings.
Usage:
show-email-notifier [ duration=<seconds> ] [
frequency=<seconds> ]

Input Parameter Description Value Mandatory

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

Example:
show-email-notifier

Output Parameter Description

Enabled The active status of the Email notifier

Transport Mail transport to user:

• HTML
• SMTP

Sender Sender’s email address

Recipients List of email recipients

Proxy-Address The proxy server’s address for HTML mail

Proxy-Port The proxy server’s port for HTML mail

128 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

Proxy-User The proxy server’s user for HTML mail

Mail-Relay-Address The mail relay server for SMTP mail

Mail-User The user for SMTP mail delivery

Company-Name The sender’s company name

Contact-Details The sender’s contact details

modify-snmp-notifier
The modify-snmp-notifier admin-level command modifies the SNMP notification
settings.
Usage:
modify-snmp-notifier [enable |disable ] [enable-heartbeat
|disable-heartbeat ] [ heartbeat-frequency=<minutes (5-1440)> ]
[ username=<string> ] [ remove-recipient=<Remove one recipient
from the list> ] [ community=<string> ] [ priv-key=<string> ] [
port=<port number> ] [ add-recipient=<Add one recipient to the
list> ] [ auth-key=<string> ] [ recipient-list=<list of
recipients> ] [ version=<v1, v2c or v3> ] [ auth-protocol=<md5,
sha, no_auth> ] [ priv-protocol=<des, aes128, no_priv> ]

Input Parameter Description Value Mandatory

add-recipient Adds one recipient to Host name or IP No

the list. address

auth-key SNMP v3 String No

authentication key

auth-protocol SNMP v3 md5, sha, no_auth No

authentication
protocol

community SNMP community String No

string

disable Indicates whether the N/A No

notification is
disabled.

disable-heartbeat Disables SNMP N/A No

Heartbeat.

enable Indicates whether the N/A No

notification is
enabled.

enable-heartbeat Enables SNMP N/A No

Heartbeat.

heartbeat-frequency SNMP Heartbeat Minutes (5 - 1440) No

frequency

port UDP port (default 162) Port number No

priv-key SNMP v3 privilege key String No

Administration 129
Admin CLI Commands

Input Parameter Description Value Mandatory

priv-protocol SNMP v3 privilege des, aes128, no_priv No

protocol

recipient-list Recipient server list List: IP or server name No

remove-recipient Removes one recipient Host name or IP No

from the list. address

username SNMP v3 username String No

version SNMP version v1, v2c or V3 No

IMPORTANT
The following groups are exclusive (you can select only one of the parameters in a group):
[enable, disable], [enable-heartbeat, disable-heartbeat], [add-recipient, remove-recipient,
recipient-list]

Example:
modify-snmp-notifier enable-heartbeat
add-recipient="host.example.com"

send-snmp-notification
The send-snmp-notification admin-level command verifies the SNMP notification
configuration by sending a test message, containing a user-defined text.
Usage:
send-snmp-notification text

Input Parameter Description Value Mandatory

text Description text String Yes

Example:
send-snmp-notification text="SNMP notification"

130 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-snmp-notifier
The show-snmp-notifier admin-level command displays SNMP notification
configuration.
Usage:
show-snmp-notifier [ duration=<seconds> ] [ frequency=<seconds>
]

Input Parameter Description Value Mandatory

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

Example:

show-snmp-notifier

Output Parameter Description

Enabled Indicates whether SNMP notification is enabled or disabled.

Recipients Notifications’ recipients

SNMP-Version SNMP version

Trap-Port TCP port for SNMP traps (default port 162)

Community Used for SNMP authentication

User-Name SNMP v3 username

Auth-Key SNMP v3 authentication key

Priv-Key SNMP v3 privilege key

Auth-Protocol SNMP v3 authentication protocol

Priv-Protocol SNMP v3 privilege protocol

Engine-ID A unique ID for the SNMP agent

Administration 131
Admin CLI Commands

modify-syr-notifier
The modify-syr-notifier admin-level command modifies the ESRS (EMC Secure
Remote Support) notification parameters.
Usage:
modify-syr-notifier ( enable | disable |
reset-configuration=<N\A> | site-name=<name (can contain
spaces)> | frequency=<hours> | connection-type=<esrsvegw,
esrsgw, email> ) [ email-server=<Hostname or IP for mail
server> ] [ esrs-gw-host=<IP for ESRS Gateway> ] [
esrs-gw-host-secondary=<IP for ESRS Gateway> ] [
email-user=<Mail server username> ] [ email-password=<Email
server password> ] [ email-sender=<Sender name> ] [
username=<Windows NT user name> ] [ password=<PIN + RSA FOB> ]
NOTE! At least one property from the following list is
mandatory: site-name, connection-type, frequency, enable,
disable, reset-configuration.

Input Parameter Description Value Mandatory

connection-type SYR notifier esrsvegw, esrsgw, At least one of the

connection type email following parameters
must be selected:
disable Disable N/A • connection-type
enable Enable N/A • disable
• enable
frequency frequency Hours (positive • frequency
number) • reset-configuration
reset-configuration Reset configuration N/A • site-name

site-name Site name Name (can contain

spaces)

esrs-gw-host-secondar Secondary Gateway IP for ESRS Gateway No

y host

email-password Email password Email server password No

email-recipient Email recipient for Recipient name No

redirection of SYR
notifications

email-sender Email sender Sender name No

email-server Email server Hostname or IP for No

mail server

email-user Mail username Mail server username No

esrs-gw-host Gateway host IP for ESRS Gateway No

esrsve-polling-interval ESRS VE polling Hours (1 - 168) No

interval

username ESRS VE user name Windows NT user No

name

password ESRS VE password PIN + RSA FOB No

132 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:
modify-syr-notifier connection-type=esrsgw

send-syr-notification
The send-syr-notification admin-level command verifies the SYR notification
configuration by sending a test message, containing a user-defined text.
Usage:
send-syr-notification [ test-event ] [ cluster-id=<name or
index> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID name or index No

test-event Send a test event. N/A No

Example:
send-syr-notification

show-syr-notifier
The show-syr-notifier admin-level command displays the ESRS (EMC Secure
Remote Support) notification configuration.
Usage:
show-syr-notifier [ duration=<seconds> ] [ frequency=<seconds>
]

Input Parameter Description Value Mandatory

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

Example:

show-syr-notifier

Output Parameter Description

Enabled Indicates whether support information notification is enabled or

disabled.

Config-File-Frequency Configuration File updating frequency (hours)

Advisory-Polling-Interval Advisory polling interval (hours)

ConnectEMC-Config A divider between the SYR notifier configuration information

(Enabled, Frequency), and the various settings related to the xms
configuration of ConnectEMC and ESRS

Site Name Indicates the customer’s site where the cluster is installed.

PSNT The cluster’s Product Serial Number Tag (assigned by Dell EMC)

Administration 133
Admin CLI Commands

Output Parameter Description

Connection-Type Type of connection (esrsvegw, esrsgw, email)

Esrsve-Connection-State Status of ESRS VE connection

Esrsve-Clusters-Connectivity Connectivity status of ESRS VE clusters (connected, partially

-State disconnected, all clusters disconnected)

modify-syslog-notifier
The modify-syslog-notifier admin-level command adds or removes servers from
the Syslog server list. There can be up to 6 Syslog targets.
Usage:
modify-syslog-notifier ( enable | disable ) [
remove-target=<remove one target from the list> ] [
add-target=<add one target to the list> ] [ targets=<list of
syslog targets with optional port. required when enabling> ]
NOTE! At least one property from the following list must be
selected: disable, enable.

Input Parameter Description Value Mandatory

disable Disable N/A Only one of the

following parameters
enable Enable N/A must be selected:
• disable
• enable

add-target Add target Target No

remove-target Remove target Target No

targets Target list List of Syslog Targets No

with optional port
(required when
enabling)

IMPORTANT
At least one parameter should be specified.

Example:
modify-syslog-notifier add-target="10.10.10.10"

134 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-syslog-notifier
The show-syslog-notifier admin-level command displays the Syslog server
notification status.
Usage:
show-syslog-notifier [ duration=<seconds> ] [
frequency=<seconds> ]

Input Parameter Description Value Mandatory

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

Example:
show-syslog-notifier

Output Parameter Description

Enabled Indicates whether the Syslog server notification option is enabled

or disabled.

Targets Displays the list of Syslog Targets with optional port.

send-syslog-notification
The send-syslog-notification admin-level command checks the Syslog
notification configuration by sending a notification per the set configuration, containing
the supplied text.
Usage:
send-syslog-notification text

Input Parameter Description Value Mandatory

text Description text String Yes

Example:
send-syslog-notification text="Syslog text"

Administration 135
Admin CLI Commands

IP Addresses

modify-ip-addresses
The modify-ip-addresses admin-level command modifies the XMS and/or Storage
Controllers’ management IP configuration.

Note: For the detailed procedure of changing IP configurations, refer to the XtremIO
Storage Array User Guide.

Usage:
modify-ip-addresses ( sc-ip-list=<[sc-id=value
sc-ip-sn="value",...]> | xms-ip-sn=<IP Address/Subnet> |
xms-gw-addr=<IP Address> | sc-gw-addr=<IP Address> ) [
cluster-id=<id: name or index> ]
NOTE! At least one property from the following list is
mandatory: xms-ip-sn, xms-gw-addr, sc-gw-addr, sc-ip-list.

Input Parameter Description Value Mandatory

sc-gw-addr Storage Controller’s IP address At least one of the

management network following parameters
gateway address must be selected:
• sc-gw-addr
sc-ip-list Storage Controllers’ IP [sc-id=value
• sc-ip-list
list sc-ip-sn=value
ipmi-ip-sn=value,...] • xms-gw-addr
• xms-op-sn
xms-gw-addr XMS gateway address IP address

xms-ip-sn XMS IP/Subnet IP address/Subnet

cluster-id Cluster ID Name or Index No

Example:
modify-ip-addresses sc-gw-addr="10.10.10.1"

136 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-ip-addresses
The show-ip-addresses admin-level command displays the XMS and Storage
Controllers’ managment IP configuration.
Usage:
show-ip-addresses [ duration=<seconds> ] [ cluster-id=<id: name
or index> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-ip-addresses

Input Parameter Description

Name XMS name

Index XMS index

Xms-IP-Addr XMS IP address

Xms-IP-Addr-Subnet XMS address subnet mask

Xms-GW-Addr XMS Gateway address

Xms-Secondary-IP-Addr Secondary XMS IP address

Xms-Secondary-IP-Addr-Subnet Secondary XMS address subnet mask

Xms-Secondary-GW-Addr Secondary XMS Gateway address

Storage-Controller-Name Storage Controller name

Index Storage Controller index

Cluster-Name Cluster Name

Index Cluster index

Mgr-Addr-Subnet Management Storage Controller address subnet mask

MGMT-GW-IP Management Storage Controller Gateway IP address

Administration 137
Admin CLI Commands

Provisioning
Tag Management

create-tag
The create-tag admin-level command creates a Tag for an entity.
Usage:
modify-tag tag-id=<name or index> caption=<string> [
xms-id=<name or index> ]

Input Parameter Description Value Mandatory

entity Entity name InfinibandSwitch, DAE, Yes

Initiator,
BatteryBackupUnit,
Scheduler,
StorageController, Da
taProtectionGroup,
X-Brick, Volume,
Cluster, InitiatorGroup,
SSD, SnapshotSet,
ConsistencyGroup,
Target

tag-name Tag name full path Tag name Yes

Example:
create-tag entity=Volume tag-name="New_Tag"

modify-tag
The modify-tag admin-level command modifies a specified Tag caption.
Usage:
modify-tag tag-id=<Tag ID> caption=<new caption> [xms-id=<XMS
ID>]

Input Parameter Description Value Mandatory

caption New Tag caption String Yes

tag-id Tag ID Name or Index Yes

xms-id XMS ID Name or Index No

Example:
modify-tag tag-id="Old_Name" caption="New_Name"

138 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

remove-tag
The remove-tag admin-level command deletes a Tag from the tags list.
Usage:
remove-tag tag-id=<name or index>

Input Parameter Description Value Mandatory

tag-id Tag ID Name or index Yes

Example:
remove-tag tag-id=13

show-tag
The show-tag admin-level command displays the details of the specified Tag.
Usage:
show-tag tag-id=<name or index> [ prop-list=<list of property
strings> ]

Input Parameter Description Value Mandatory

tag-id Tag ID Name or index Yes

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:

show-tag tag-id="My_Tag"

Output Parameter Description

Name The Tag’s full path name

Index The Tag’s index number

Entity The entity type

Number-of-Items The number of entities assigned with the Tag

Creation-Time The date and time of the Tag’s creation

Object-List List of all objects assigned with the specified Tag (name and index)

Provisioning 139
Admin CLI Commands

show-tags
The show-tags admin-level command displays a list of Tags and their details.
Usage:
show-tags [ entity=<string> ] [ prop-list=<list of property
strings> ]

Input Parameter Description Value Mandatory

entity Entity InfinibandSwitch, DAE, No

Initiator,
BatteryBackupUnit,
Scheduler,
StorageController, Da
taProtectionGroup,
X-Brick, Volume,
Cluster, InitiatorGroup,
SSD, SnapshotSet,
ConsistencyGroup,
Target

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:
show-tags entity="Volume"

Output Parameter Description

Name The Tag’s full path name

Index The Tag’s index number

Entity The entity type

Number-of-Items The number of entities assigned with the Tag

Creation-Time The date and time of the Tag’s creation

140 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

tag-object
The tag-object admin-level command tags the specified object.
Usage:
tag-object tag-id=<name or index> entity=<string>
entity-details=<name or index> [ cluster-id=<id: name or index>
]

Input Parameter Description Value Mandatory

entity Entity InfinibandSwitch, DAE, Yes

Initiator,
BatteryBackupUnit,
Scheduler,
StorageController,
DataProtectionGroup,
X-Brick, Volume,
Cluster, InitiatorGroup,
SSD, SnapshotSet,
ConsistencyGroup,
Target

entity-details Object ID Name or index Yes

tag-id Tag ID Name or index Yes

cluster-id Cluster ID ID:Name or index No

Example:
tag-object entity=Volume entity-details="vol1"
tag-id="/Volume/myTag1"

Provisioning 141
Admin CLI Commands

untag-object
The untag-object admin-level command removes a Tag from the specified object.
Usage:
untag-object tag-id=<name or index> entity=<string>
entity-details=<name or index> [ cluster-id=<id: name or index>
]

Input Parameter Description Value Mandatory

entity Entity type InfinibandSwitch, DAE, Yes

Initiator,
BatteryBackupUnit,
Scheduler,
StorageController, Da
taProtectionGroup,
X-Brick, Volume,
Cluster, InitiatorGroup,
SSD, SnapshotSet,
ConsistencyGroup,
Target

entity-details Object ID Name or index Yes

tag-id Tag ID Name or index Yes

cluster-id Cluster ID Name or index No

Example:
untag-object entity=Volume entity-details="My_Vol"
tag-id="My_Tag"

142 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Volume and Snapshot Management

add-volume
The add-volume admin-level command creates a new Volume.
Usage:
add-volume vol-name=<string> vol-size=<integer suffixed by
[kmgtp]> [ alignment-offset=<range 0-31> ] [
application-type=<Epic, Hyper-V VMs, Oracle DB, Other DB, SAP,
VDI, VMware VMs, Others> ] [ cluster-id=<name or index> ] [
lb-size=<512 or 4096> ] [ management-locked ] [
qos-enabled-mode=<enabled, disabled, monitor_only> ] [
qos-policy-id=<id: name or index> ] [ small-io-alerts=<enabled
or disabled> ] [ tag-list=<list of ids: name or index> ] [
unaligned-io-alerts=<enabled or disabled> ] [
vaai-tp-alerts=<enabled or disabled> ]

Input Parameter Description Value Mandatory

vol-name Volume name String (up to 128 Yes

characters)

vol-size Volume size Integer suffixed by Yes

[mgtpk].
e.g. vol-size="10t",
creates a Volume of
10TB. Volume size
must be in multiples
of 16K.

alignment-offset Alignment offset • For 512 block size, No

according to block size offset range is 0-15.
• for 4096 block size,
there is no offset.
• If omitted, offset is
0.

application-type Application type of the Epic, Hyper-V VMs, No

Volume Oracle DB, Other DB,
SAP, VDI, VMware
VMs, Others

cluster-id Cluster ID Name or index. Can be No

omitted if only one
cluster is defined.

lb-size Block size 512 (default) or 4096 No

management-locked Indicates whether N/A No

(X2 cluster type only) Volume is
management-locked.

qos-enabled-mode QoS enabled mode enabled, disabled, No

monitor_only

qos-policy-id QoS policy ID Name or index No

small-io-alerts Small I/O alerts status Enabled or Disabled No

Provisioning 143
Admin CLI Commands

Input Parameter Description Value Mandatory

unaligned-io-alerts Unaligned I/O alerts Enabled or Disabled No

status

vaai-tp-alerts VAAI TP Alerts status Enabled or Disabled No

tag-list Tag ID list List of IDs: Name or No

Index

Example:
add-volume cluster-id="My_Cluster" vol-name="New_Volume"
vol-size="1t"

modify-volume
The modify-volume admin-level command modifies a Volume’s parameters.
Usage:
modify-volume vol-id=<name or index> ( application-type=<Epic,
Hyper-V VMs, Oracle DB, Other DB, SAP, VDI, VMware VMs, Others>
| qos-enabled-mode=<enabled, disabled, monitor_only> |
qos-policy-id=<id: name or index> | remove-qos-policy |
vaai-tp-alerts=<enabled or disabled> | small-io-alerts=<enabled
or disabled> | vol-access=<string> | vol-size=<integer suffixed
by [kmgtp]> | unaligned-io-alerts=<enabled or disabled> |
vol-name=<new volume name (rename)> |
management-locked=<enabled or disabled> ) [ cluster-id=<id:
name or index> ]
NOTE! The following property is mandatory: vol-id
NOTE! At least one property from the following list is
mandatory: application-type, qos-enabled-mode, qos-policy-id,
remove-qos-policy, vol-size, vol-name, small-io-alerts,
unaligned-io-alerts, vaai-tp-alerts, vol-access,
management-locked.

Input Parameter Description Value Mandatory

vol-id Volume ID Name or index Yes

144 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Input Parameter Description Value Mandatory

application-type Application type Epic, Hyper-V VMs, At least one of the

Oracle DB, Other DB, following parameters
SAP, VDI, VMware must be selected:
VMs, Others • application-type
• qos-enabled-mode
qos-enabled-mode QoS enabled mode enabled, disabled,
monitor_only • qos-policy-id
• remove-qos-policy
qos-policy-id QoS policy ID Name or index • small-io-alerts
• unaligned-io-alerts
remove-qos-policy Remove QoS policy N/A
association • vaai-tp-alerts
• vol-access
small-io-alerts Small I/O alerts enabled or disabled • vol-name
• vol-size
unaligned-io-alerts Unaligned I/O alerts enabled or disabled
• management-locked
vaai-tp-alerts VAAI TP alerts enabled or disabled

vol-access Volume access rights no_access - Only SCSI

discovery command
can succeed. Write
and read commands
will fail.

read_access - SCSI
read commands and
discovery commands
can succeed. Write
commands will fail.

write_access - The
host can write to the
Volume.

vol-name New Volume name String (up to 128

characters)

vol-size Volume size Integer suffixed by

[mgtpk]. Volume size
must be in multiples of
16KB.

management-locked Indicates whether the enabled or disabled

(X2 cluster type only) Volume is
management-locked

cluster-id Cluster ID Name or Index No

Example:
modify-volume vol-id="Volume" vol-size="2t"

Provisioning 145
Admin CLI Commands

remove-volume
The remove-volume admin-level command removes a Volume.
Usage:
remove-volume vol-id=<name or index> [ cluster-id=<id: name or
index> ]

Input Parameter Description Value Mandatory

vol-id Volume ID Name or index Yes

cluster-id Cluster ID Name or Index No

Example:
remove-volume vol-id="vol1"

show-volumes
The show-volumes admin-level command displays the list of Volumes and related
information.
Usage:
show-volumes [sg-id=<name or index> ][ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
tag-list=<List of ids: name or index> ] [ filter=<> ] [
prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

sg-id Snapshot Group ID Name or Index No

tag-list Tag ID list List of IDs: Name or No

Index

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

146 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:
show-volumes cluster-id=1 tag-list=["tag1","tag2"]

Output Parameter Description

Volume-Name The Volume’s name

Index The Volume’s index number

Cluster-Name The name of the cluster to which the Volume belongs

Index The cluster’s index number

Vol-Size The Volume’s provisioned disk space

LB-Size The Volume’s type

VSG-Space-In-Use The total user data space written to the Volume Snapshot Group
before deduplication and compression

Offset The Volume’s defined alignment offset

Created-From-Volume The Volume that was the Snapshot source for this Volume

VSG-Index The Volume Snapshot Group index number

Small-IO-Alerts Indicates whether small I/O alerts are enabled.

Unaligned-IO-Alerts Indicates whether unaligned I/O alerts are enabled.

VAAI-TP-Alerts Indicates whether VAAI TP alerts are enabled.

Total-Writes The total number of write operations written to a Volume. A logical

space before deduplication.

Total-Reads The total number of reads on a Volume. A logical space before

deduplication.

NAA-Identifier The SCSI Network Address Authority (NAA) identifier for the Volume

Certainty-State Indicates whether there is a pending command associated with the

Volume.

Created-By-Application The application that created the Volume (XMS, Scheduler)

Volume-Type The Volume type (regular, read-only)

Creation-Time The date and time of the Volume or Snapshot creation in UTC
timezone

Vol-Access Access permissions to the Volume (no_access, read_access or

write_access)

Provisioning 147
Admin CLI Commands

show-volume
The show-volume admin-level command displays the specified Volume’s information.
Usage:
show-volume vol-id=<name or index> [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
vertical ] [ filter=<> ] [ prop-list=<List of property strings>
]

Input Parameter Description Value Mandatory

vol-id Volume’s id Name or index Yes

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:
show-volume vol-id="vol1" vertical

Output Parameter Description

Volume-Name The Volume’s name

Index The Volume’s index number

Vol-Size The Volume’s block size

LB-Size The Volume’s type

Logical-Space-In-Use The total user data space written to the Volume Snapshot Group
before deduplication and compression

Offset The Volume’s defined alignment offset

Created-From-Volume The Volume that was the Snapshot source for this volume

VSG-Index The Volume Snapshot Group’s index

Cluster-Name The name of the cluster to which the Volume belongs

Index The cluster’s index number

Small-IO-Alerts Indicates whether small I/O alerts are enabled.

Unaligned-IO-Alerts Indicates whether unaligned I/O alerts are enabled.

VAAI-TP-Alerts Indicates whether VAAI TP alerts are enabled.

Total-Writes The total number of write operations written to a Volume. A logical

space before deduplication.

148 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

Total-Reads The total number of reads on a Volume. A logical space before

deduplication.

Created-By-Application The application that created the Volume (XMS, Scheduler)

Volume-Type The Volume type (regular, read-only)

NAA-Identifier The SCSI Network Address Authority (NAA) identifier for the Volume,
as exposed to the Initiators

Certainty Indicates whether there is a pending command associated with the

Volume.

Tag-List The list of Tags assigned to the Volume

Creation-Time The date and time of the Volume or Snapshot creation

Volume-Access Access permissions to the Volume (no_access, write_access or

read_access)

Management-Locked Indicates whether the Volume is management locked

Last-Refresh-From-Object-N The ID of the object used for refreshing the Volume

ame

Last-Refresh-Time Data and time of last Volume refresh

Created-By-Ext-Client Indicates whether the Volume was created by an external client

Application-Type The type of application using the Volume

Performance-Data-Collectio Indicates the Volume’s Performance Data Collection mode (enabled

n or inherit_cluster_mode which is the cluster’s Performance Data
Collection mode).

secured-snap Indicates whether the Volume is protected from manual

manipulation.

Provisioning 149
Admin CLI Commands

show-volume-snapshot-groups
The show-volume-snapshot-groups admin-level command displays the list of
Volume Snapshot Groups and their parameters.
Usage:
show-volume-snapshot-groups [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-volume-snapshot-groups

Output Parameter Description

Cluster-Name The Cluster name

Index The Cluster index number

Index The VSG index number

Num-of-Vols The number of Volumes in the VSG

Num-of-Internal-Volumes The number of Volumes created by external application for

internal usage

Vol-Size The amount of disk space allocated for the Volume

Thin-Provisioning-Ratio The ratio of thin provisioning in the Snapshot Group

Logical-Space-In-Use The amount of logical disk space in the Volume

Reached-Max-Snapshots Indicates whether the maximum number of Snapshots

allowed for the Snapshot group has been reached (including
the deleted Snapshots that still consume resources).

Removing-Snapshots-In-Progress Indicates whether Snapshots are currently being deleted or

merged (i.e. more Snapshots can be created soon).

150 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

create-repurpose-copy
The create-repurpose-copy admin-level command creates a Repurpose Copy of a
Consistency Group or a Snapshot Set.
Usage:
create-repurpose-copy [ ( from-consistency-group-id=<id: name
or index> | from-snapshot-set-id=<id: name or index> |
from-volume-list=<list of IDs: name or index> ) ]
new-consistency-group-name=<string> [
new-snapshot-set-name=<string> ] [ new-vol-suffix=<string> ] [
cluster-id=<id: name or index> ] [
management-locked=<Enabled/Disabled> ] [ qos-policy-id=<name or
index> ] [ qos-enabled-mode=<enabled, disabled, monitor_only> ]
NOTE! At least one property from the following list is
mandatory: [ from-consistency-group-id, from-snapshot-set-id,
from-volume-id ]
NOTE! Only one property from the following list is allowed: [
from-snapshot-set-id, from-consistency-group-id, from-volume-id
].

Input Parameter Description Value Mandatory

from-consistency-grou Consistency Group ID Name or Index At least one of the

p-id following parameters
must be selected:
from-snapshot-set-id Snapshot Set ID Name or Index • from-consistency-gro
up-id
from-volume-list Source Volume list List of IDs: Name or
Index • from-snapshot-set-id
• from-volume-list

new-consistency-grou Consistency Group String Yes

p-name name

new-snapshot-set-na The name for the new String No

me Snapshot Set

new-vol-suffix New Volume suffix String No

management-locked Management locked enabled, disabled No

Volumes

cluster-id Cluster ID Name or Index No

qos-policy-id The index of the QoS Name or Index No

policy associated with
the Consistency Group

qos-enabled-mode The QoS operation enabled, disabled, No

mode monitor_only

Example:
create-repurpose-copy from-consistency-group-id=1
new-vol-suffix="_my-vol"

Provisioning 151
Admin CLI Commands

create-protection-copy

Note: This command applies to X2 cluster type only.

The create-protection-copy admin-level command creates a Protection Copy of a

Consistency Group, Volume list or a Snapshot Set.
Usage:
create-protection-copy ( from-consistency-group-id=<id: name or
index> | from-snapshot-set-id=<id: name or index> |
from-volume-list=<list of IDs: name or index> ) [
new-vol-suffix=<string> ] [ cluster-id=<id: name or index> ] [
mangement-locked=<Enabled/Disabled> ] [
snapshot-set-name=<String> ]
NOTE! At least one property from the following list is
mandatory: from-consistency-group-id, from-snapshot-set-id,
from-volume-list.

Input Parameter Description Value Mandatory

from-consistency-grou Consistency Group ID Name or Index At least one of the

p-id following parameters
must be selected:
from-snapshot-set-id Snapshot Set ID Name or Index • from-consistency-gro
up-id
from-volume-list Volume list List of IDs: name or
index • from-snapshot-set-id
• from-volume-list

cluster-id Cluster ID Name or Index No

management-locked Management locked Enabled/Disabled No

new-vol-suffix Snapshot name suffix String No

snapshot-set-name New Snapshot Set String No

name

Example:
create-protection-copy from-consistency-group-id=1
new-vol-suffix="_my-vol"

152 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

create-snapshot
The create-snapshot admin-level command creates a Copy of the specified Volume.
Usage:
create-snapshot ( snapshot-set-id=<id: name or index> |
volume-list=<list of ids: name or index> |
consistency-group-id=<id: name or index> | tag-list=<list of
ids: name or index> ) [ snapshot-type=<"regular", "readonly"> ]
[ snapshot-set-name=<string> ] [ snap-suffix=<string> ] [
cluster-id=<id: name or index> ]
NOTE! At least one property from the following list is
mandatory: consistency-group-id, snapshot-set-id, volume-list,
tag-list.

Input Parameter Description Value Mandatory

consistency-group-id Consistency Group ID Name or Index At least one of the

following parameters
snapshot-set-id Snapshot Set ID Name or Index must be selected:
• consistency-group-id
tag-list Tag ID list List of IDs: Name or
Index • snapshot-set-id
• tag-list
volume-list Volume list List of IDs: Name or • volume-list
Index

cluster-id Cluster ID Name or Index No

snap-suffix Snapshot name suffix String No

snapshot-set-name Snapshot Set name String No

snapshot-type Snapshot type ’regular’ or ’readonly’ No

Example:
create-snapshot consistency-group-id="CG1"
snap-suffix="_Snapshot"

Provisioning 153
Admin CLI Commands

create-snapshot-and-reassign
The create-snapshot-and-reassign admin-level command creates a Snapshot
from a specified Volume/Snapshot, Consistency Group, or Snapshot Set and reassigns the
Volume identity characteristic to the created Snapshot. When the command is used to
refresh a Snapshot Set, a Snapshot Set Tag can be used to specify the refreshed object.

Note: creating and reassigning a snapshot can be done between single Volumes, between
a Snapshot Set and a Consistency Group (or vice versa) and between two Snapshot Sets.

Usage:
create-snapshot-and-reassign ( from-snapshot-set-id=<id: name
or index> | from-snapshot-set-tag-id=<id: name or index> |
from-consistency-group-id=<id: name or index> |
from-volume-id=<id: name or index> ) (
to-snapshot-set-tag-id=<id: name or index> |
to-consistency-group-id=<id: name or index> |
to-snapshot-set-id=<id: name or index> | to-volume-id=<id: name
or index> ) [ backup-snap-suffix=<string> ] [
backup-snapshot-type=<readonly, regular> ] [ no-backup ] [
cluster-id=<id: name or index> ] [ snapshot-set-name=<string> ]
NOTE! Only one property from the following list must be
selected: from-consistency-group-id, from-snapshot-set-id,
from-volume-id, from-snapshot-set-tag-id.
NOTE! Only one property from the following list must be
selected: to-consistency-group-id, to-snapshot-set-id,
to-volume-id, to-snapshot-set-tag-id.

Input Parameter Description Value Mandatory

from-consistency-grou ID of the Consistency Name or Index Only one of the

p-id Group being following parameters
Snapshotted must be selected:
• from-consistency-gro
from-snapshot-set-id ID of the Snapshot Set Name or Index up-id
being Snapshotted
• from-snapshot-set-id
from-snapshot-set-tag ID of the Tag assigned Name or Index • from-snapshot-set-ta
-id to the Snapshot Set g-id
being Snapshotted • from-volume-id

from-volume-id ID of the Volume being Name or Index

Snapshotted

to-consistency-group-i ID of the target Name or Index Only one of the

d Consistency Group following parameters
must be selected:
to-snapshot-set-id ID of the target Name or Index • to-consistency-group
Snapshot Set -id
to-snapshot-set-tag-id ID of the Tag assigned Name or Index • to-snapshot-set-id
to the target Snapshot • to-snapshot-set-tag-i
Set d
• to-volume-id
to-volume-id ID of the target Volume Name or Index

no-backup Remove source object N/A No

154 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Input Parameter Description Value Mandatory

snapshot-set-name Created Snapshot Set String No

name

backup-snap-suffix Snapshot name suffix String No

backup-snapshot-type Snapshot type readonly, regular No

cluster-id Cluster ID Name or Index No

Example (Restore):
create-snapshot-and-reassign
from-volume-id="Last_Good_Timestamp"
to-volume-id="Production_Volume
Example (Refresh):
create-snapshot-and-reassign from-volume-id="Test_Host_Volume"
to-volume-id="Latest_Production_Snapshot

Provisioning 155
Admin CLI Commands

restore-data

Note: This command applies to X2 cluster type only.

The restore-data admin-level command restores data of a Volume or Consistency

Group.
Usage:
restore-data ( from-consistency-group-id | from-snapshot-set-id
| from-volume-id ) ( to-consistency-group-id | to-volume-id ) [
backup-snap-suffix=<String> ] [ cluster-id=<Name or Index> ] [
dry-run ] [ no-backup ] [ snapshot-set-name=<String> ]
NOTE! Only one property from the following list is mandatory: [
from-consistency-group-id, from-volume-id, from-snapshot-set-id
]
NOTE! Only one property from the following list is mandatory: [
to-consistency-group-id, to-volume-id ]
NOTE! Only one property from the following list is allowed: [
from-consistency-group-id, from-volume-id, from-snapshot-set-id
]
NOTE! Only one property from the following list is allowed: [
to-consistency-group-id, from-volume-id ]

Input Parameter Description Value Mandatory

from-consistency-grou ID of the Consistency Name or Index Only one of the

p-id Group being following parameters
Snapshotted must be selected:
• from-consistency-gro
from-snapshot-set-id ID of the Snapshot Set Name or Index up-id
being Snapshotted
• from-snapshot-set-id
from-volume-id ID of the Volume being Name or Index • from-volume-id
Snapshotted

to-consistency-group-i ID of the target Name or Index Only one of the

d Consistency Group following parameters
must be selected:
to-volume-id ID of the target Volume Name or Index • to-consistency-group
-id
• to-volume-id

backup-snap-suffix Snapshot name suffix String No

cluster-id Cluster ID Name or Index No

dry-run dry-run-flag N/A No

no-backup Remove source object N/A No

snapshot-set-name Created Snapshot Set String No

name

156 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:
restore-data from-volume-id="Last_Good_Timestamp"
to-volume-id="Production_Volume"

refresh-data

Note: This command applies to X2 cluster type only.

The refresh-data admin-level command refreshes a copy of a Volume or Consistency

Group.
Usage:
refresh-data ( from-snapshot-set-id=<id: name or index> |
from-consistency-group-id=<id: name or index> |
from-volume-id=<id: name or index> ) (
to-consistency-group-id=<id: name or index> | to-volume-id=<id:
name or index> ) [ backup-snap-suffix=<string> ] [ no-backup ] [
ignore-empty-pair ] [ dry-run ] [ snapshot-set-name=<string> ]
[ cluster-id=<id: name or index> ]
NOTE! Only one property from the following list must be
selected: from-consistency-group-id, from-snapshot-set-id,
from-volume-id.
NOTE! Only one property from the following list must be
selected: to-consistency-group-id, to-volume-id.

Input Parameter Description Value Mandatory

from-consistency-grou ID of the Consistency Name or Index Only one of the

p-id Group being following parameters
Snapshotted must be selected:
• from-consistency-gro
from-snapshot-set-id ID of the Snapshot Set Name or Index up-id
being Snapshotted
• from-snapshot-set-id
from-volume-id ID of the Volume being Name or Index • from-volume-id
Snapshotted

to-consistency-group-i ID of the target Name or Index Only one of the

d Consistency Group following parameters
must be selected:
to-volume-id ID of the target Volume Name or Index • to-consistency-group
-id
• to-volume-id

no-backup Remove data prior to N/A No

the refresh operation

snapshot-set-name Created Snapshot Set String No

name

backup-snap-suffix Snapshot name suffix String No

Provisioning 157
Admin CLI Commands

Input Parameter Description Value Mandatory

ignore-empty-pair When on, refresh is N/A No

performed for all
paired Volumes and
unpaired Volumes are
ignored. When off,
refresh will fail if there
is at lease one
unpaired Volume in
either the ’to’ or the
’from’ objects.

cluster-id Cluster ID Name or Index No

dry-run Enable a dry run of the N/A No

refresh action.

Example:
refresh-data from-volume-id="Last_Good_Timestamp"
to-volume-id="Production_Volume refresh-copy-dry-run

show-snapshots
The show-snapshots admin-level command displays the list of Snapshots and related
information.
Usage:
show-snapshots ancestor-vol-id=<name or index> [sg-id=<name or
index> ][ cluster-id=<id: name or index> ] [ tag-list=<List of
ids: name or index> ] [ frequency=<seconds> ] [
duration=<seconds> ] [ filter=<> ] [ prop-list=<List of
property strings> ]

Input Parameter Description Value Mandatory

ancestor-vol-id Ancestor Volume ID Name or Index Yes

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

sg-id Snapshot Group ID Name or Index No

tag-list Tag ID list List of IDs: Name or No

Index

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

158 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:
show-snapshots ancestor-vol-id="vol1"

Output Parameters Description

Volume-Name The Volume’s name

Index The Volume’s index number

Cluster-Name The name of the cluster to which the Volume belongs

Index The cluster’s index number

Vol-Size The Volume’s provisioned disk space

LB-Size The Volume’s type

VSG-Space-In-Use The total user data space written to the Volume Snapshot Group
before deduplication and compression

Offset The Volume’s defined alignment offset

Created-From-Volume The Volume that was the Snapshot source for this Volume

VSG-Index The Volume Snapshot Group index number

Small-IO-Alerts ’disabled’, ’enabled’

Unaligned-IO-Alerts ’disabled’, ’enabled’

VAAI-TP-Alerts ’disabled’, ’enabled’

Total-Writes The total amount of write actions

Total-Reads The total amount of read actions

NAA-Identifier The SCSI Network Address Authority (NAA) identifier for the
Snapshot

Certainty-State Indicates whether there is a pending command associated with the

Initiator.

Created-By-Application The application that created the Snapshot (XMS, Scheduler)

Volume-Type The Snapshot type (regular, read-only)

Creation-Time The date and time on which the Snapshot was created

Vol-Access Access permissions to the snapshot (read_access, write_access,

no_access)

Provisioning 159
Admin CLI Commands

show-copies
The show-copies admin-level command displays a list of all copies of the specified
Volume or Consistency Group.
Usage:
show-copies ( vol-id=<Name or Index> | cg-id=<Name or Index> ) [
cluster-id=<Name or Index> ] [ duration=<seconds> ] [
frequency=<seconds> ] [ tag-list=<list of ids: Name or Index> ]
[ prop-list=<List of property strings> ] [ filter=<> ] [
from-time=<YYYY-MM-DD HH:MM:SS> ] [ to-time=<YYYY-MM-DD
HH:MM:SS> ] [ protection-only ]
NOTE! Only one of the following properties is mandatory: [
cg-id, vol-id ]

Input Parameter Description Value Mandatory

cg-id Consistency Group ID Name or Index Only one of the

following parameters
vol-id Volume ID Name or Index must be selected:
• cg-id
• vol-id

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

tag-list Tag ID list List of ids: Name or No

Index

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

from-time Start date and time of YYYY-MM-DD No

the timeframe HH:MM:SS

to-time End date and time of YYYY-MM-DD No

the timeframe HH:MM:SS

protection-only Show only Protection N/A No

Copies

160 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:
show-copies vol-id="Reserved_Volume"

Output Parameter Description

Cluster-Name The cluster name

Index The cluster index

Creation-Time Date and time of copy creation

Last-Refresh-Time Date and time of last refresh of the copy

Type Type of the copy (Volume, Linked Consistency Group, Snapshot

Set)

Snapshot-Set-Name Snapshot Set name

Linked-CG-Name Linked Consistency Group name

Volume-Name Volume name

Created-By-App The application that created the copy (XMS, Scheduler)

show-volume-reservations
The show-volume-reservations admin-level command displays the specified
Volume’s SCSI reservation information.
Usage:
show-volume-reservations vol-id=<name or index> [
cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

vol-id Volume ID Name or Index Yes

cluster-id Cluster ID Name or Index No

Example:

show-volume-reservations vol-id="Reserved_Volume"

Output Parameter Description

Index The cluster’s index number

Cluster-Name The cluster’s name

Index The Volume’s index number

Volume-Name The Volume name

State State (not_reserved, reserved_scsi2, reserved_scsi3)

Holder-Initiator-Port-Address Initiator port address of the holder

Holder-Target-Port-Address Target port address of the holder

Reservation-Type Reservation type

Reservation-Scope Reservation Scope

Provisioning 161
Admin CLI Commands

clear-volume-reservation
The clear-volume-reservation admin-level command removes specified Volume
reservations to release them for access.

Note: Improper use of this command may lead to data inconsistencies.

Usage:
clear-volume-reservation vol-id=<name or index> [
cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

vol-id Volume ID Name or index Yes

cluster-id Cluster ID Name or Index No

Example:
clear-volume-reservation vol-id="Reserved_Volume"

show-most-active-volumes
The show-most-active-volumes admin-level command displays performance data
of the most active Volumes.
Usage:
show-most-active-volumes [ duration=<seconds> ] [
frequency=<seconds> ] [ sort-by=<bw or iops> ]

Input Parameter Description Value Mandatory

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

sort-by Filtering criteria iops, latency, bw No

Example:

show-most-active-volumes sort-by=bw

Output Parameter Description

Name The Volume’s name

Index The Volume’s index number

162 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

Write-BW (MB/s)

Read-BW (MB/s)

Write-IOPS
These properties indicate the current Bandwidth/IOPS.
Read-IOPS

BW (MB/s)

IOPS

Cluster-Name The Cluster’s name

Index The Cluster’s index number

show-most-active-initiator-groups
The show-most-active-initiator-groups admin-level command displays
performance data of the most active Initiator Groups.
Usage:
show-most-active-initiator-groups [ duration=<seconds> ] [
frequency=<seconds> ] [ sort-by=<bw, iops, latency> ]

Input Parameter Description Value Mandatory

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

sort-by Filtering criteria bw, iops, latency No

Example:

show-most-active-initiator-groups sort-by=iops

Output Parameter Description

IG-Name Initiator Group’s name

Index Initiator Group’s index number

Write-BW (MB/s)

Read-BW (MB/s)

Write-IOPS
These properties indicate the current Bandwidth/IOPS.
Read-IOPS

BW (MB/s)

IOPS

Cluster-Name The Cluster’s name

Index The Cluster’s index number

Provisioning 163
Admin CLI Commands

show-most-active
The show-most-active admin-level command displays the most active Volumes and
Initiator Groups.
Usage:
show-most-active [ duration=<seconds> ] [ frequency=<seconds> ]
[ sort-by=<bw or iops> ]

Input Parameter Description Value Mandatory

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

sort-by Filtering criteria iops, latency, bw No

Example:
show-most-active

Note: The output is displayed for most active Volumes and most active Initiator Groups.

Output Parameter Description

Volume-Name The component’s name

Index The component’s index

Write-BW (MB/s)

Read-BW (MB/s)

Write-IOPS
These properties indicate the current Bandwidth/IOPS.
Read-IOPS

BW (MB/s)

IOPS

Cluster-Name The Cluster’s name

Index The Cluster’s index number

164 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

calculate-savings
The calculate-savings admin-level command calculates saving metrics for the
specified Volume Snapshot Group, derived from Data Reduction Ratio per volume and
copy efficiency features.
Usage:
calculate-savings [ ( vol-id=<Name or Index> | vol-list=<list
of ids: Name or Index> | cg-id=<Name or Index> ) ] [
cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

cg-id Consistency Group ID Name or index At least one of the

following parameters
vol-id Volume ID Name or index must be selected:
• cg-id
vol-list Object ID list List of ids: name or
index • vol-id
• vol-list

cluster-id Cluster ID Name or index No

Example:

calculate-savings cg-id=12

show-volumes-savings
The show-volumes-savings admin-level command displays saving metrics per
Volume or group of Volumes, derived from Data Reduction Ratio per volume and copy
efficiency features.
Usage:
show-volumes-savings [ cluster-id=<Name or Index> ] [
duration=<seconds> ] [ frequency=<seconds> ] [ prop-list=<List
of property strings> ] [ filter=<> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Provisioning 165
Admin CLI Commands

Example:

show-volumes-savings

Output Parameters Description

Cluster-Name The cluster name

Index The cluster index number

Volume-Name The Volume name

Index The Volume index number

Unique-Physical-Space The minimal amount of physical capacity that will be reclaimed

when the entity is deleted

Data-Reduction-Ratio Data reduction benefit

Host-Accessible-Size The amount of non-zero data that can be read from the Volume

VSG-Id The VSG index

Unique-Physical-Space The minimal amount of physical capacity that will be reclaimed

when the VSG is deleted

Data-Reduction-Ratio Data Reduction Ratio of the VSG

Copy-Efficiency The ratio between Snapshot logical space and actual logical space
in use

Calculation-Timestamp The time of the last savings calculation

Snapshot Set Management

remove-snapshot-set
The remove-snapshot-set admin-level command deletes a Snapshot Set.
Usage:
remove-snapshot-set ss-id=<name or index> [ cluster-id=<id:
name or index> ]

Input Parameter Description Value Mandatory

ss-id Snapshot Set Index Name or Index Yes

number

cluster-id Cluster ID Name or Index No

Example:
remove-snapshot-set ss-id="snapset1"

166 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-snapshot-set
The show-snapshot-set admin-level command displays the parameters of the
specified Snapshot Set.
Usage:
show-snapshot-set ss-id=<name or index> [ duration=<seconds> ]
[ cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
vertical ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

ss-id Snapshot Set ID Name or Index Yes

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:
show-snapshot-set ss-id="volspider101458418635655" vertical

Output Parameters Description

Name The Snapshot Set’s name

Index The Snapshot Set’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Consistency-Group-Name The Consistency Group’s name

CG-ID The Consistency Group’s index number

Num-of-Vols The number of Snapshotted Volumes in the Snapshot Set

Creation-Time The Snapshot Set’s date and time of creation

Volume-List The list of Snapshotted Volumes in the Snapshot Set

Tags The list of Tags assigned to the Snapshot Set

Provisioning 167
Admin CLI Commands

show-snapshot-sets
The show-snapshot-sets admin-level command displays the list of Snapshot Sets
and related information.
Usage:
show-snapshot-sets [ cluster-id=<id: name or index> ] [
frequency=<seconds> ] [ cg-id=<name or index> ] [ vertical ] [
duration=<seconds> ] [ tag-list=<List of ids: name or index> ] [
from-time=<date/time format: yyyy-mm-dd hh:mm:ss e.g.
"2017-06-20 12:45:33> ] [ to-time=<date/time format: yyyy-mm-dd
hh:mm:ss e.g. "2017-06-20 12:45:33> ] [
include-remote-protection ] [ prop-list=<list of property
strings> ] [ filter=<> ]

Input Parameter Description Value Mandatory

cg-id Consistency Group ID Name or Index No

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

tag-list Tag ID list List of IDs: Name or No

Index

vertical Vertical layout N/A No

from-time From local date/time date/time format: No

yyyy-mm-dd hh:mm:ss
e.g. "2017-06-20
12:45:33"

to-time To local date/time date/time format: No

yyyy-mm-dd hh:mm:ss
e.g. "2017-06-20
12:45:33"

include-remote-protec Include Remote N/A No

tion Protection Snapshot
Sets

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

168 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:

show-snapshot-sets

Output Parameters Description

Name The Snapshot Set’s name

Index The Snapshot Set’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Consistency-Group-Name The Consistency Group’s name

CG-ID The Consistency Group’s index number

Num-of-Vols The number of Snapshotted Volumes in the Snapshot Set

Creation-Time The Snapshot Set’s date and time of creation

Volume-List The list of Snapshotted Volumes in the Snapshot Set

Created-By-Application The application that created the Snapshot (XMS, Scheduler)

Consistency Group Management

add-volume-to-consistency-group
The add-volume-to-consistency-group admin-level command adds a Volume to
an existing Consistency Group.
Usage:
add-volume-to-consistency-group cg-id=<name or index>
vol-id=<name or index> [ cluster-id=<id: name or index> ] [
reference-volume-id=<name or index> ]

Input Parameter Description Value Mandatory

cg-id Consistency Group ID Name or Index Yes

vol-id Volume ID Name or Index Yes

cluster-id Cluster ID Name or Index No

reference-volume-id Reference Volume ID Name or Index No

(when adding a paired
Volume)

Example:
add-volume-to-consistency-group cg-id="CG_1"
vol-id="Existing_Volume"

Provisioning 169
Admin CLI Commands

remove-volume-from-consistency-group
The remove-volume-from-consistency-group admin-level command removes a
Volume from a Consistency Group.
Usage:
remove-volume-from-consistency-group cg-id=<name or index>
vol-id=<name or index> [ cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

cg-id Consistency Group ID Name or Index Yes

vol-id Volume ID Name or Index Yes

cluster-id Cluster ID Name or Index No

Example:
remove-volume-from-consistency-group vol-id="vol1" cg-id="cg1"

create-consistency-group
The create-consistency-group admin-level command creates a new Consistency
Group.
Usage:
create-consistency-group [ cluster-id=<id: name or index> ] [
consistency-group-name=<string> ] [ management-locked=<enabled,
disabled> ] [ qos-enabled-mode=<enabled, disabled,
monitor_only> ] [qos-policy-id=<id: name or index> ] [
vol-list=<list of ids: name or index> ] [ tag-list=<list of ids:
name or index> ] [ result-object-tag-list=<list of ids: name or
index> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

consistency-group-na Consistency Group String No

me name

management-locked Management Locked enabled, disabled No

qos-enabled-mode QoS enabled mode enabled, disabled, No

monitor_only

qos-policy-id QoS policy ID Name or index No

tag-list Tag ID list List of ids: Name or No

Index

vol-list Object ID list List of ids: Name or No

Index

result-object-tag-list Tag ID list List of ids: Name or No

Index

170 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:
create-consistency-group consistency-group-name="New_CG"
tag-list["/Volume/Tag_Name"] vol-list=["Volume1","Volume2"]

modify-consistency-group
The modify-consistency-group admin-level command modifies the QoS-related
parameters of the specified Consistency Group.
Usage:
modify-consistency-group cg-id=<id: name or index> ( [
qos-enabled-mode=<enabled, disabled, monitor_only> ] [
qos-policy-id=<id: name or index> ] [ remove-qos-policy ] ) [
cluster-id=<id: name or index> ]
Note! At least one property from the following list is
mandatory: qos-enabled-mode, qos-policy-id, remove-qos-policy

Input Parameter Description Value Mandatory

cg-id Consistency Group ID id: name or index Yes

qos-enabled-mode Status of the QoS enabled, disabled, At least one of the

enabled mode monitor_only following parameters
must be selected:
qos-policy-id QoS policy ID id: name or index • qos-enabled-mode
remove-qos-policy Remove QoS policy N/A • qos-policy-id
association • remove-qos-policy

cluster-id Cluster ID id: Name or Index No

Example:
modify-consistency-group cg-id="myCG" qos-enabled-mode=enabled

remove-consistency-group
The remove-consistency-group admin-level command deletes a Consistency
Group.
Usage:
remove-consistency-group cg-id=<name or index> [
cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

cg-id Consistency Group ID Name or Index Yes

cluster-id Cluster ID Name or Index No

Example:
remove-consistency-group cg-id="CG1"

Provisioning 171
Admin CLI Commands

modify-consistency-group-volumes
The modify-consistency-group-volumes admin-level command modifies the
Volume type for the specified a Consistency Group.
Usage:
modify-consistency-group-volumes cg-id=<name or index> [ (
vol-access=<string> | management-locked=<Enabled/Disabled> ) ]
[ cluster-id=<id: name or index> ]
NOTE! The following property is mandatory: cg-id
NOTE! At least one property from the following list is
mandatory: vol-access, management-locked
NOTE! Only one property from the following list is allowed:
vol-access, management-locked

Input Parameter Description Value Mandatory

cg-id Consistency Group ID Name or Index Yes

management-locked Management locked Enabled/Disabled At least one of the

following parameters
vol-access Volume access rights no_access - Only SCSI must be selected:
discovery command • management-locked
can succeed. Write
• vol-access
and read commands
will fail.

read_access - SCSI
read commands and
discovery commands
can succeed. Write
commands will fail.

write_access - The
host can write to the
Volume.

cluster-id Cluster ID Name or Index No

Example:
modify-consistency-group-volumes cg-id="Existing_CG"
vol-access=write_access

172 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

add-copy-volume-to-consistency-groups
The add-copy-volume-to-consistency-groups admin-level command creates a
copy of a Volume which is a member of a Consistency Group and adds the copy to all
Consistency Groups specified in a list.
Usage:
add-copy-volume-to-consistency-groups reference-cg=<Name or
Index> reference-volume=<Name or Index> cg-list=<list of ids:
Name or Index> volume-name-suffix-list=<String> [
cluster-id=<id: Name or Index> ]
NOTE! The following properties are mandatory: [ cg-list,
reference-cg, reference-volume, volume-name-suffix-list ]

Input Parameter Description Value Mandatory

cg-list Object ID list List of ids: Name or Yes

Index

reference-cg The index of the Name or Index Yes

Consistency Group to
which the source
Volume belongs

reference-volume The source Volume Name or Index Yes

index

volume-name-suffix-lis Created Volume suffix String Yes

t list

cluster-id Cluster ID Name or Index No

Example:
add-copy-volume-to-consistency-groups cg-list=["CG1", "CG2"]
reference-cg-id="MyCG" reference-volume-id="MyVol"
volume-name-suffix-list=["vol1", "vol2"]

Provisioning 173
Admin CLI Commands

show-consistency-group
The show-consistency-group admin-level command displays the members and
parameters of the specified Consistency Group.
Usage:
show-consistency-group cg-id=<name or index> [
duration=<seconds> ] [ cluster-id=<id: name or index> ] [
frequency=<seconds> ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cg-id Consistency Group ID Name or Index Yes

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:

show-consistency-group cg-id="My_CG"

Output Parameters Description

Name The Consistency Group’s name

Index The Consistency Group’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Num-Of-SnapshotSets The number of Snapshot Sets in the Consistency Group

Num-Of-Vols The number of Volumes in the Consistency Group

Volume-List The Consistency Group’s members list

Tag-List The Consistency Group’s associated Tags

Created-By-Application The application that created the Consistency Group (recoverpoint,

xms, replication)

Certainty Indicates whether there is a pending command associated with the

Consistency Group.

Creation-Time Date and time on which the Consistency Group was created

Last-Refresh-Time Date and time of the last Consistency Group refresh

174 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameters Description

Last-Refreshed-From-Object The ID of the object used to refresh the Consistency Group

-Name

Created-By-Ext-Client Indicates whether the Consistency Group was created by an

external client

Application-Type Application type

show-consistency-groups
The show-consistency-groups admin-level command displays a list of all
Consistency Groups and their parameters.
Usage:
show-consistency-groups [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
tag-list=<List of ids: name or index> ] [ filter=<> ] [
prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

tag-list Tag ID list List of ids: Name or No

Index

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-consistency-groups tag-list=["mytag"]

Output Parameters Description

Name The Consistency Group’s name

Index The Consistency Group’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Num-of-Vols The number of Volumes in the Consistency Group

Created-By-Application The application that created the Consistency Group

Certainty-State Indicates whether there is a pending command associated with the

Consistency Group.

Provisioning 175
Admin CLI Commands

Initiator and Initiator Group Management

An Initiator Group (IG) is a set of Initiators that would probably translate to a host with
multiple HBAs or a cluster of hosts.
Using Initiator Groups makes it easier to group the operation of LUN masking on this entity

add-initiator-group
The add-initiator-group admin-level command adds a new Initiator Group and
assigns Initiators to it.

Note: If you wish to add Initiators as part of creating the Initiator Group, then it is not
possible to configure CHAP for these Initiators.

Usage:
add-initiator-group [ cluster-id=<id: name or index> ] [
ig-name=<string> ] [ initiator-list=<[initiator-name=value
port-address=value,...]> ] [ qos-enabled-mode=<enabled,
disabled, monitor_only> ] [ qos-policy-id=<id: name or index> ]
[ tag-list=<list of ids: name or index> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

ig-name Initiator Group name String No

initiator-list List of associated [initiator-name=value No

Initiators (name and port-address=value,...
port number) ] (port-address is the
Initiator iQN or WWN)

qos-enabled-mode QoS enabled mode enabled, disabled, No

monitor_only

qos-policy-id QoS policy ID Name or Index No

tag-list Tag ID list List of IDs: Name or No

Index

Example:
add-initiator-group ig-name="New_IG"
tag-list=[/InitiatorGroup/tag1"]

176 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

modify-initiator-group
The modify-initiator-group admin-level command modifies the "Operating
System" setting of the specified Initiator Group.
Usage:
modify-initiator-group ig-id=<name or index> (
ig-name=<string> | operating-system=<linux, windows, esx,
solaris, aix, hpux, other> | qos-enabled-mode=<enabled,
disabled, monitor_only> | qos-policy-id=<name or index> |
remove-qos-policy ) [ cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

ig-id Initiator Group ID Name or Index Yes

ig-name Initiator Group name String At least one of the

following parameters
operating-system Operating System linux, windows, esx, must be selected:
solaris, aix, hpux, • ig-name
other
• operating-system
qos-enabled-mode QoS enabled mode enabled, disabled, • qos-enabled-mode
monitor_only • qos-policy-id
• remove-qos-policy
qos-policy-id QoS policy ID Name or index

remove-qos-policy Remove qos policy N/A

association

cluster-id Cluster ID Name or Index No

Example:
modify-initiator-group ig-name="IG1" operating-system="linux"

remove-initiator-group
The remove-initiator-group admin-level command deletes an Initiator Group.
Usage:
remove-initiator-group ig-id=<name or index> [ cluster-id=<id:
name or index> ]

Input Parameter Description Value Mandatory

ig-id Initiator Group ID Name or index Yes

cluster-id Cluster ID Name or INdex No

Example:
remove-initiator-group ig-id="IG-1"

Provisioning 177
Admin CLI Commands

show-initiator-group
The show-initiator-group admin-level command displays information for a specific
Initiator Group.
Usage:
show-initiator-group ig-id=<name or index> [ duration=<seconds>
] [ cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

ig-id Initiator Group ID Name or index Yes

cluster-id Cluster ID id: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:

show-initiator-group ig-id="My_IG"

Output Parameter Description

IG-Name The Initiator Group’s name

Index The Initiator Group’s index number

Num-of-Initiators The number of Initiators in the Initiator Group

Num-of-Vols The number of Volumes mapped to the Initiator Group

Certainty Indicates whether there is a pending command associated with the

Initiator Group.

Tag-List The Tags assigned to the Initiator Group (full path name and index)

178 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-initiator-groups
The show-initiator-groups admin-level command displays a list of all Initiator
Groups and their parameters.
Usage:
show-initiator-groups [ duration=<seconds> ] [ cluster-id=<id:
name or index> ] [ frequency=<seconds> ] [ tag-list=<List of
ids: name or index> ] [ filter=<> ] [ prop-list=<List of
property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

tag-list Tag ID list List of ids: Name or No

Index

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-initiator-groups

Output Parameter Description

IG-Name The Initiator Group’s name

Index The Initiator Group’s index number

Cluster-Name The Initiator Group’s Cluster name

Index The Initiator Group’s Cluster index number

Num-of-Initiators Number of Initiators in the group

Num-of-Vols Number of Volumes mapped to the Initiator Group

Certainty Indicates whether there is a pending command associated with the

Initiator Group.

Tag-List The Tags assigned to the Initiator Group (full path name and index)

Provisioning 179
Admin CLI Commands

add-initiator
The add-initiator admin-level command adds an Initiator and associates it with an
existing Initiator Group.
Usage:
add-initiator ig-id=<name or index> port-address=<string> [
cluster-id=<id: name or index> ] [
cluster-discovery-user-name=<string> ] [
initiator-discovery-user-name=<string> ] [
operating-system=<linux, windows, esx, solaris, aix, hpux,
other> ] [ initiator-discovery-password=<string> ] [
cluster-discovery-password=<string> ] [
cluster-authentication-user-name=<string> ] [
cluster-authentication-password=<string> ] [
initiator-authentication-password=<string> ] [
initiator-authentication-user-name=<string> ] [
initiator-name=<string> ]

Input Parameter Description Value Mandatory

ig-id Initiator Group ID name or index Yes

port-address Port address (iQNs or String Yes

WWNs)

cluster-authentication- CHAP authentication String No

password cluster password

cluster-authentication- CHAP authentication String No

user-name cluster user name

cluster-discovery-pass CHAP discovery cluster String No

word password

cluster-discovery-user- CHAP discovery cluster String No

name user name

cluster-id Cluster ID Name or Index No

initiator-authenticatio CHAP authentication String No

n-password password

initiator-authenticatio CHAP authentication String No

n-user-name user name

initiator-discovery-pas CHAP discovery String No

sword password

initiator-discovery-use CHAP discovery user String No

r-name name

initiator-name Initiator name String No

operating-system Operating system linux, windows, esx, No

solaris, aix, hpux,
other

180 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:
add-initiator ig-id="Existing_IG"
port-address="10:00:00:00:00:00:00:00"

remove-initiator
The remove-initiator admin-level command deletes an Initiator.
Usage:
remove-initiator initiator-id=<name or index> [ cluster-id=<id:
name or index> ]

Input Parameter Description Value Mandatory

initiator-id Initiator ID Name or index Yes

cluster-id Cluster ID Name or Index No

Example:
remove-initiator initiator-id="ig-1"

Provisioning 181
Admin CLI Commands

modify-initiator
The modify-initiator admin-level command modifies the properties of an existing
Initiator.
Usage:
modify-initiator initiator-id=<name or index> (
initiator-discovery-password=<string> |
cluster-discovery-user-name=<string> |
cluster-authentication-user-name=<string> |
initiator-discovery-user-name=<string> |
cluster-discovery-password=<string> |
remove-initiator-authentication-credentials |
port-address=<string> | path-redundancy-monitor-mode=<enabled,
disabled> | cluster-authentication-password=<string> |
remove-initiator-discovery-credentials |
initiator-authentication-password=<string> |
operating-system=<linux, windows, esx, solaris, aix, hpux,
other> | remove-cluster-discovery-credentials |
initiator-authentication-user-name=<string> |
initiator-name=<string> |
remove-cluster-authentication-credentials ) [ cluster-id=<id:
name or index> ]
NOTE! At least one property from the following list is
mandatory: port-address, initiator-name,
path-redundancy-monitor-mode,
initiator-authentication-user-name,
initiator-authentication-password,
initiator-discovery-user-name, initiator-discovery-password,
cluster-authentication-user-name,
cluster-authentication-password, cluster-discovery-user-name,
cluster-discovery-password,
remove-initiator-authentication-credentials,
remove-initiator-discovery-credentials,
remove-cluster-authentication-credentials,
remove-cluster-discovery-credentials, operating-system.

182 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Input Parameter Description Value Mandatory

initiator-id Initiator ID Name or index Yes

cluster-authentication- CHAP authentication String At least one of the

password cluster password following parameters
must be selected:
cluster-authentication- CHAP authentication String
user-name user name Note: See important
information under the
cluster-discovery-pass CHAP discovery String
word password table.

cluster-discovery-user- CHAP discovery user String • cluster-authenticatio

name name n-password
initiator-authenticatio CHAP authentication String • cluster-authenticatio
n-password password n-user-name
• cluster-discovery-pas
initiator-authenticatio CHAP authentication String sword
n-user-name user name • cluster-discovery-use
r-name
initiator-discovery-pas CHAP discovery String • initiator-authenticati
sword password on-password
initiator-discovery-use CHAP discovery user String • initiator-authenticati
r-name name on-user-name
• initiator-discovery-pa
initiator-name Initiator name String ssword
• initiator-discovery-us
operating-system Operating system linux, windows, esx, er-name
solaris, aix, hpux,
• initiator-name
other
• operating-system
port-address Port address String • port-address
• path-redundancy-mo
path-redundancy-mon Enable/Disable the enabled, disabled nitor-mode
itor-mode monitoring mode of
• remove-cluster-authe
path redundancy
ntication-credential
remove-cluster-authen Removes CHAP cluster N/A s
tication-credentials authentication • remove-cluster-disco
credentials. very-credentials
• remove-initiator-auth
remove-cluster-discov Removes CHAP cluster N/A entication-credenti
ery-credentials discovery credentials. als
• remove-initiator-disc
remove-initiator-authe Removes CHAP N/A overy-credentials
ntication-credentials Initiator
authentication See Important note
credentials. below.

remove-initiator-disco Removes CHAP N/A

very-credentials Initiator discovery
credentials.

cluster-id Cluster ID Name or Index No

Provisioning 183
Admin CLI Commands

IMPORTANT
The following parameters must be used as all-or-none pairs (select both parameters or
none of them):
[cluster-authentication-password, cluster-authentication-user-name],
[cluster-discovery-password, cluster-discovery-user-name],
[initiator-authentication-password, initiator-authentication-user-name],
[initiator-discovery-password, initiator-discovery-user-name]

Example:
modify-initiator initiator-id="Initiator"
port-address="50:00:00:00:00:00:00:00"

show-initiator
The show-initiator admin-level command lists the parameters of a specified
Initiator.
Usage:
show-initiator [ duration=<seconds> ] [ cluster-id=<id: name or
index> ] [ frequency=<seconds> ] [ vertical ] [ filter=<> ] [
prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

initiator-id Initiator ID Name or Index Yes

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:

show-initiator initiator-id=1

Output Parameter Description

Initiator-Name The Initiator’s name

Index The Initiator’s index number

Cluster-Name The Cluster’s name

Index The Cluster’s index number

Port-Type The Initiator’s port type (iSCSI or FC)

Port-Address The Initiator’s port address (WWN or iQN)

IG-Name The associated Initiator Group’s name

184 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

Index The associated Initiator Group’s index number

Certainty Indicates whether there is a pending command

associated with the Initiator.

Path-Redundancy-Monitor-Mode Indicates whether the path redundancy monitor is

enabled or disabled.

Path-Redundancy-State Status of path redundancy (uninitialized, redundant,

non redundant, no I/O, degraded no active,
degraded non redundant, degraded disconnected,
monitor disabled)

Non-Redundant-Volumes A list of non-redundant Volumes

Chap-Authentication-Initiator-User-name CHAP authentication Initiator user name

Chap-Discovery-Initiator-User-Name CHAP discovery Initiator user name

Chap-Authentication-Cluster-User-Name CHAP authentication cluster user name

Chap-Discovery-Cluster-User-Name CHAP discovery cluster user name

Initiator-OS The Initiator’s operating system (linux, windows,

esx, solaris, aix, hpux, other)

show-initiators
The show-initiators admin-level command lists all Initiators and their parameters.
Usage:
show-initiators [ duration=<seconds> ] [ cluster-id=<id: name
or index> ] [ frequency=<seconds> ] [ vertical ] [ filter=<> ] [
prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Provisioning 185
Admin CLI Commands

Example:

show-initiators

Output Parameter Description

Initiator-Name The Initiator’s name

Index The Initiator’s index number

Cluster-Name The Cluster’s name

Index The Cluster’s index number

Port-Type The Initiator’s port type (iSCSI or FC)

Port-Address The Initiator’s port address (WWN or iQN)

IG-Name The associated Initiator Group’s name

Index The associated Initiator Group’s index number

Certainty Indicates whether there is a pending command

associated with the Initiator.

Path-Redundancy-State Status of path redundancy (uninitialized, redundant,

non redundant, no I/O, degraded no active,
degraded non redundant, degraded disconnected,
monitor disabled)

Chap-Authentication-Initiator-User-name CHAP authentication Initiator user name

Chap-Discovery-Initiator-User-Name CHAP discovery Initiator user name

Chap-Authentication-Cluster-User-Name CHAP authentication cluster user name

Chap-Discovery-Cluster-User-Name CHAP discovery cluster user name

Initiator-OS The Initiator’s operating system (linux, windows,

esx, solaris, aix, hpux, other)

186 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Scheduler Management

Note: Protection Schedulers are used only with X1 cluster type.

create-scheduler
The create-scheduler admin-level command creates a new Protection scheduler.
Refer to the XtremIO Storage Array User Guide for details on the scheduler-type and
time parameters
Usage:
create-scheduler snapshot-object-id=<name or index>
snapshot-object-type=<string> scheduler-type=<interval /
explicit> time=<string - interval [h:m:s] / explicit [day:h:m]>
( snapshots-to-keep-number=<integer> |
snapshots-to-keep-time=<integer suffixed by [Mhdmy]> ) [
enabled-state=<enabled / user_disabled> ]
[scheduler-name=<string> ] [ suffix=<string> ] [
snapshot-type=<string> ] [ cluster-id=<id: name or index> ]
NOTE! At least one property from the following list is
mandatory: snapshots-to-keep-number, snapshots-to-keep-time.

Input Parameter Description Value Mandatory

scheduler-type Scheduler type interval or explicit Yes

snapshot-object-id Snapshotted object ID Name or Index Yes

snapshot-object-type The object whose String Yes

Snapshot is taken
(Consistency Group,
Volumes/Snapshot,
Snapshot Set (for X1
cluster type only))

time Schedule for Snapshot String in [h:m:s] Yes

creation format for interval
mode and [d:h:m] for
explicit mode

snapshots-to-keep-nu Number of Snapshots Integer Only one of the

mber to keep following parameters
must be selected:
snapshots-to-keep-tim Timeframe for keeping Integer with [Mhdmy] • snapshots-to-keep-n
e Snapshots (minute - hour - day - umber
month - year) suffix
• snapshots-to-keep-ti
me

cluster-id Cluster ID Name or Index No

enabled-state Indicates whether the enabled / user No

scheduler is enabled. disabled

scheduler-name Scheduler name String No

Provisioning 187
Admin CLI Commands

Input Parameter Description Value Mandatory

snapshot-type Snapshot type String No

suffix Snapshot name suffix String No

tag-list Tag ID list List of IDs: Name or No

Index

Example:
create-scheduler scheduler-type=interval
snapshot-object-type=Volume snapshot-object-id="Volume1"
snapshots-to-keep-number=2 time="10:20:15"

188 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

modify-scheduler
The modify-scheduler admin-level command modifies an existing Protection
scheduler’s parameters. Refer to the XtremIO Storage Array User Guide for details on the
scheduler-type and time parameters.
Usage:
modify_scheduler scheduler-id=<name or index> (
snapshot-object-type=<string> | suffix=<string> |
scheduler-type=<interval / explicit> | time=<string - interval
[h:m:s] / explicit [day:h:m]> | snapshot-object-id=<name or
index> | snapshots-to-keep-number=<integer> |
snapshot-type=<string> | snapshots-to-keep-time=<string of an
integer suffixed by [Mhdmy]> ) [ cluster-id=<id: name or index>
]
NOTE! At least one property from the following list is
mandatory: snapshot-object-type, snapshot-type, suffix,
snapshots-to-keep-time, snapshot-object-id,
snapshots-to-keep-number, scheduler-type, time.

Input Parameter Description Value Mandatory

scheduler-id Scheduler ID Name or index Yes

scheduler-type Scheduler type Interval or Explicit At least one of the

following parameters
snapshot-object-id Snapshotted object ID Name or Index must be selected:
• scheduler-type
snapshot-object-type Object type Volume, SnapSet,
ConsistencyGroup • snapshot-object-id
• snapshot-object-type
snapshot-type Snapshot type readonly, regular • snapshot-type
• snapshots-to-keep-n
snapshots-to-keep-nu Number of Snapshots Integer umber
mber to keep
• snapshots-to-keep-ti
snapshots-to-keep-tim Time frame for keeping Integer with [Mhdmy] me
e Snapshots (minute - hour - day - • suffix
month - year) suffix • time
suffix Snapshot name suffix String

time Schedule for Snapshot String in [h:m:s]

creation format for interval
mode and [d:h:m] for
explicit mode

cluster-id Cluster ID Name or Index No

Example:
modify-scheduler snapshot-object-type=Volume
snapshot-object-id="Database_01" scheduler-type=interval
time="0:30:0" snapshots-to-keep-time="3d"

Provisioning 189
Admin CLI Commands

remove-scheduler
The remove-scheduler admin-level command deletes a Protection scheduler.
Usage:
remove-scheduler scheduler-id=<name or index> [
remove-snapshot-sets ] [ cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

scheduler-id Scheduler ID Name or index Yes

cluster-id Cluster ID Name or Index No

remove-snapshot-sets Remove Snapshot N/A No

Sets

Example:
remove-scheduler scheduler-id="scheduler1"

resume-scheduler
The resume-scheduler admin-level command resumes a suspended Protection
Scheduler.
Usage:
resume-scheduler scheduler-id=<id: name or index> [
cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

scheduler-id Scheduler ID Name or index Yes

cluster-id Cluster ID Name or Index No

Example:
resume-scheduler scheduler-id=1

suspend-scheduler
The suspend-scheduler admin-level command suspends and active Protection
Scheduler.
Usage:
suspend-scheduler scheduler-id=<id: name or index> [
cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

scheduler-id Scheduler ID Name or index Yes

cluster-id Cluster ID Name or Index No

Example:
suspend-scheduler scheduler-id=1

190 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-scheduler
The show-scheduler admin-level command displays the parameters of a specified
Protection Scheduler.
Usage:
show-scheduler scheduler-id=<name or index> [
duration=<seconds> ] [ cluster-id=<id: name or index> ] [
frequency=<seconds> ] [ vertical ] [ filter=<> ] [
prop-list=<list of property strings> ]
NOTE! The following parameter is mandatory: scheduler-id

Input Parameter Description Value Mandatory

scheduler-id Scheduler ID Name or Index Yes

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

Vertical Vertical Layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:
show-scheduler scheduler-id="My_Scheduler"

Output Parameters Description

Name The scheduler’s name

Index The scheduler’s index number

Snapped-Object-Name The name of the Snapshotted object

Snapped-Object-Index The ID of the Snapshotted object

Snapped-Object-Type The type of the Snapshotted object

Snapshot-Type The type of the created snapshot (writable or read-only)

Suffix The created Snapshots assigned suffix

Scheduler-Type The scheduler type (Interval or Explicit)

Schedule The set schedule

Snapshots-To-Keep-Number The maximum number of Snapshots to keep

Snapshots-To-Keep-Time The time frame in which to keep Snapshots

Provisioning 191
Admin CLI Commands

Output Parameters Description

Enabled-State The scheduler’s state

Last-Activation-Time The scheduler’s last activation time

Last-Activation-Status The scheduler’s last activation status

show-schedulers
The show-schedulers admin-level command displays a list of Protection Schedulers
and their parameters.
Usage:
show-schedulers [ duration=<seconds> ] [ cluster-id=<id: name
or index> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-schedulers

Output Parameters Description

Name The scheduler’s name

Index The scheduler’s index number

Snapped-Object-Index The ID of the Snapshotted object

Snapped-Object-Type The type of the Snapshotted object

Snapshot-Type The type of the created snapshot (writable or read-only)

Suffix The created Snapshots assigned suffix

Snapshots-To-Keep-Time The time frame in which to keep Snapshots

Snapshots-To-Keep-Number The maximum number of Snapshots to keep

Scheduler-Type The scheduler type (Interval or Explicit)

Schedule The set schedule

192 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameters Description

Enabled-State The scheduler’s state

Last-Activation-Time The scheduler’s last activation time

Last-Activation-Status The scheduler’s last activation status

Target Management

modify-target
The modify-target admin-level command modifies a Target parameters.
Usage:
modify-target tar-id=<name or index> ( mtu=<integer> |
ip-addr-sn=<IP Address/Subnet Bits> |
port-enabled-state=<enabled, user_disabled> |
port-type=<’iscsi’, ’eth_replication’> |
refresh-replication-password ) [ cluster-id=<id: name or index>
]
NOTE! At least one property from the following list is
mandatory: mtu, ip-addr-sn, port-type,
refresh-replication-password

Input Parameter Description Value Mandatory

tar-id The Target’s name or Name or Index Yes

index number

mtu Maximum Integer At least one of the

transmission unit size following parameters
must be selected:
port-enabled-state Enable/disable port enabled, • mtu
user_disabled
• port-enabled-state
port-type Port type ’iscsi’, • port-type
’eth_replication’ • refresh-replication-p
assword
refresh-replication-pas Refresh Remote N/A
sword Protection password

cluster-id Cluster ID Name or Index No

Example:
modify-target tar-id="X1-SC1-iscsi1" mtu=1500

Provisioning 193
Admin CLI Commands

show-targets
The show-targets admin-level command displays a list of iSCSI and FC Target
interfaces and their properties.
Usage:
show-targets [ cluster-id=<id: name or index> ] [ sc-id=<name
or index> ] [ filter=<> ] [ prop-list=<List of property strings>
] [ duration=<seconds> ] [ frequency=<seconds> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

sc-id Storage Controller ID Name or index No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

port-type Port type eth_replication, iscsi, No

fc, all

vertical Vertical alignment N/A No

Example:

show-targets

Output Parameter Description

Name The Target’s name

Index The Target’s index number

Cluster Name The relevant cluster’s name

Index The relevant cluster’s index

Port-Type The Target’s port type (FC or iSCSI)

Port-Address The Target’s port address

Mac-Addr The MAC (Ethernet) address of the iSCSI Target port

Port-Speed The actual port’s speed

Port-State The port’s state: up or down

Health-Level Indicates the result of port diagnostics performed on Target port.

Storage-Controller-Name The name of the Storage Controller the Target is associated to

Index The Storage Controller’s index number

TG-Name The name of the Target Group to which the Target belongs

Index The Target Group’s index number

194 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

MTU Maximum transmission unit size

Jumbo-Frames Indicates whether jumbo frames are enabled.

Certainty Indicates whether there is a pending command associated with

the Target.

Relative-Id A port ID for backward compatibility

Target-Port-HW-Label The Target port’s physical identifier

modify-target-group
The modify-target admin-level command modifies a Target Group’s parameters.
Usage:
modify-target-group tg-id=<name or index> mtu=<integer> [
cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

mtu Maximum Integer Yes

transmission unit size

tg-id Target Group ID Name or index Yes

cluster-id Cluster ID Name or Index No

Example:
modify-target-group tg-id="Default" mtu=1500

show-target-groups
The show-target-groups admin-level command displays the list of Target Groups.
Usage:
show-target-groups [ duration=<seconds> ] [ cluster-id=<id:
name or index> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Provisioning 195
Admin CLI Commands

Example:

show-target-groups

Output Parameter Description

TG-Name The Target Group’s name

Index The Target Group’s index number

Cluster-Name The name of the cluster to which the Target Group is related

Index The cluster’s index number

LUN Mapping

map-lun
The map-lun admin-level command maps a Volume to an Initiator Group and assigns a
Logical Unit Number (LUN) to it.
Usage:
map-lun vol-id=<name or index> ig-id=<name or index. If
omitted, means "Undefined Initiators"> [ cluster-id=<id: name
or index> ] [ lun=<integer> ] [ tg-id=<name or index> ]

Input Parameter Description Value Mandatory

vol-id Volume ID Name or ID Yes

ig-id Initiator Group ID Name or Index. If Yes

omitted, means
"undefined initiators".

lun The number of the Integer No

logical unit as
exposed to the host
Initiator.
Host/OS may place
limits on the allowed
maximum value.

tg-id Target group ID Name or ID No

cluster-id Cluster ID Name or Index No

Example:
map-lun vol-id="Volume" ig-id="Host" lun=5
cluster-id="My_Cluster"

196 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-lun-mappings
The show-lun-mappings admin-level command displays a list of all mappings
between Volumes and Initiator Groups.
Usage:
show-lun-mappings ( vol-id=<name or index> | ig-id=<name or
index> ) [ duration=<seconds> ] [ cluster-id=<id: name or
index> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<list of property strings> ]
NOTE! Only one property from the following list is allowed:
ig-id, vol-id.

Input Parameter Description Value Mandatory

ig-id Initiator Group ID Name or Index No

vol-id Volume ID Name or Index No

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

filter Filters the command See “Using Filters” on No

output page 11.

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:

show-lun-mappings vol-id="My_Vol"

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index

Volume-Name The mapped Volume’s name

Index The mapped Volume’s index number

IG-Name The mapped Initiator Group’s name

Index The mapped Initiator Group’s index number

TG-Name The mapped Target Group’s name

Index The mapped Target Group’s index number

Provisioning 197
Admin CLI Commands

Output Parameter Description

LUN The LUN value

Mapping-Index The mapping index number

Certainty-State Indicates whether there is a pending command associated with the

object.

unmap-lun
The unmap-lun admin-level command removes a Volume’s mapping to one or more
Initiator Groups.
Usage:
unmap-lun vol-id=<name or index> ( all | ig-id=<name or index.
If omitted, means "Undefined Initiators"> ) [ cluster-id=<id:
name or index> ] [ tg-id=<name or index> ]
NOTE! The following property is mandatory: vol-id
NOTE! At least one property from the following list is
mandatory: all, ig-id
NOTE! Only one property from the following list is allowed: all,
ig-id

Input Parameter Description Value Mandatory

vol-id Volume ID Name or index Yes

all All mappings N/A Only one of the

following parameters
ig-id Initiator Group ID Name or index. If must be selected:
omitted, it means • all
’undefined initiators’.
• ig-id

tg-id Target Group ID Name or index No

cluster-id Cluster ID id: Name or Index No

Example:
unmap-lun vol-id="vol1" all

198 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Quality of Service

add-qos-policy
The add-qos-policy admin-level command creates a new Quality of Service policy.
Usage:
add-qos-policy qos-policy-name=<string> limit-type=<fixed,
adaptive> ( max-bw=<integer suffixed by [km] |
max-iops=<integer> ) [ burst-percentage=<integer> ] [
cluster-id=<id: name or index> ] [ io-size=<512b, 1kb, 2kb,
4kb, 8kb, 16kb, 32kb, 64kb, 128kb, 256kb, 512kb, 1mb> ]
NOTE! The following properties are mandatory: limit-type,
qos-policy-name
NOTE! At least one property from the following list is
mandatory: max-bw, max-iops
NOTE! Only one property from the following list is allowed:
max-bw, max-iops
NOTE! io-size needs to be set if max-iops is defined.

Input Parameter Description Value Mandatory

qos-policy-name QOS policy name string Yes

limit-type The type of limit on fixed, adaptive Yes

QOS policy

max-bw Maximum BW integer suffixed by [kb, Only one of the

mb] following parameters
must be selected:
max-iops Max IOPS integer • max-bw
• max-iops

burst-percentage Percentage of allowed integer No

burst

cluster-id Cluster ID id: Name or Index No

io-size I/O size 512b, 1kb, 2kb, 4kb, Yes if max-iops is

8kb, 16kb, 32kb, defined
64kb, 128kb, 256kb,
512kb, 1mb

Example:
add-qos-policy qos-policy-name="myPolicy" limit-type=fixed
max-iops=100

Provisioning 199
Admin CLI Commands

modify-qos-policy
The modify-qos-policy admin-level command modifies the parameter of a selected
Quality of Service policy.
Usage:
modify-qos-policy qos-policy-id=<id: name or index> (
burst-percentage=<integer> | io-size=<512b, 1kb, 2kb, 4kb, 8kb,
16kb, 32kb, 64kb, 128kb, 256kb, 512kb, 1mb>
| limit-type=<fixed, adaptive> | ( max-bw=<integer suffixed by
[km]> | max-iops=<integer> ) | qos-policy-name=<new Volume name
(rename)> ) [ cluster-id=<id: name or index> ]
NOTE! The following property is mandatory: qos-policy-id
NOTE! At least one property from the following list is
mandatory: qos-policy-name, limit-type, max-bw, max-iops,
io-size, burst-percentage
NOTE! Only one property from the following list is allowed:
max-bw, max-iops
NOTE! io_size needs to be set if max-iops is defined.

Input Parameter Description Value Mandatory

qos-policy-id QoS policy ID id: name or index Yes

burst-percentage Percentage of allowed integer At least one of the

burst following parameters
must be selected:
io-size I/O size 512b, 1kb, 2kb, 4kb, • burst-percentage
8kb, 16kb, 32kb,
• io-size
64kb, 128kb, 256kb,
512kb, 1mb • limit-type
• max-bw
limit-type The type of limit on fixed, adaptive • max-iops
QOS policy • qos-policy-name
max-bw Maximum BW integer suffixed by Only one of the
[km] following parameters
is allowed:
max-iops Max IOPS integer • max-bw
• max-iops
qos-policy-name QOS policy name string

cluster-id Cluster ID id: Name or Index No

Example:
modify-qos-policy qos-policy-id=12 qos-policy-name="new name"

200 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

remove-qos-policy
The remove-qos-policy admin-level command removes a selected Quality of Service
policy.
Usage:
remove-qos-policy qos-policy-id=<id: name or index> [
cluster-id=<id: name or index> ]
NOTE! The following property is mandatory: qos-policy-id

Input Parameter Description Value Mandatory

qos-policy-id QoS policy ID id: name or index Yes

cluster-id Cluster ID id: Name or Index No

Example:
remove-qos-policy qos-policy-id=12

show-qos-policy
The show-qos-policy admin-level command displays the parameters of a selected
Quality of Service policy.
Usage:
show-qos-policy qos-policy-id=<id: name or index> [
cluster-id=<id: name or index> ] [ duration=<seconds> ] [
frequency=<seconds> ] [ filter ]
NOTE! The following property is mandatory: qos-policy-id

Input Parameter Description Value Mandatory

qos-policy-id QoS policy ID id: name or index Yes

cluster-id Cluster ID id: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

filter Filters the command See “Using Filters” on No

output page 11.

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Provisioning 201
Admin CLI Commands

Example:
show-qos-policy qos-policy-id=12

Output Parameter Description

Name The QoS policy name

Index The QoS policy index

Limit-Type The policy limit type (fixed or adaptive)

Max-IOPS The policy’s max limit in IOPS

IO-Size The set I/O size in Bytes

Max-BW The policy’s max limit in bandwidth (in KB/s)

Burst-Percentage The policy’s allowed burst limit (percentage above max)

show-qos-policies
The show-qos-policies admin-level command displays the parameters of all defined
Quality of Service policies.
Usage:
show-qos-policies [ cluster-id=<id: name or index> ] [
duration=<seconds> ] [ frequency=<seconds> ] [ filter ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

filter Filters the command See “Using Filters” on No

output page 11.

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

202 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:
show-qos-policies

Output Parameter Description

Name The QoS policy name

Index The QoS policy index

Limit-Type The policy limit type (fixed or adaptive)

Max-IOPS The policy’s max limit in IOPS

IO-Size The set I/O size in Bytes

Max-BW The policy’s max limit in bandwidth (in KB/s)

Burst-Percentage The policy’s allowed burst limit (percentage above max)

Note: The selected policy’s burst-percentage should not be defined to be compatible with
admission control.

Note: To enable the system-level admission control, an approved RPQ (Request for
Product Qualification) is required.

Provisioning 203
Admin CLI Commands

iSCSI Management

add-iscsi-portal
The add-iscsi-portal admin-level command creates an iSCSI portal (IP/VLAN) on a
specific iSCSI Target port.

Note: iSCSI Targets cannot have the same subnet as the management network.

Usage:
add-iscsi-portal tar-id=<name or index> ip-addr=<IP
Address/Subnet Bits> [ cluster-id=<id: name or index> ] [
vlan=<integer> ]

Input Parameter Description Value Mandatory

ip-addr Portal IP Address IP Address/Subnet Yes

Bits

tar-id Target ID Name or index Yes

vlan VLAN ID 0 (no VLAN tag) to No

4094

cluster-id Cluster ID id: Name or Index No

Example:
add-iscsi-portal tar-id="X1-SC1-iscsi1" ip-addr="1.2.3.4/24"

add-iscsi-route
The add-iscsi-route admin-level command configures a new routing rule for iSCSI
traffic.
Usage:
add-iscsi-route gateway=<IP Address>
destination-network-and-mask=<Destination network/mask> [
iscsi-route-name=<string> ] [ cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

destination-network-a Destination network Destination Yes

nd-mask and mask network/mask

gateway Gateway IP Address IP Address Yes

iscsi-route-name iSCSI Route name String No

cluster-id Cluster Index number Name or Index No

Example:
add-iscsi-route destination-network-and-mask="1.2.3.0/24"
gateway="1.2.3.4"

204 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

modify-iscsi-portal
The modify-iscsi-portal admin-level command modifies an iSCSI portal
parameters.
Usage:
modify-iscsi-portal portal-id=<index> ( vlan=<integer> |
ip-addr=<IP Address/Subnet Bits> ) [ cluster-id=<id: name or
index> ]
NOTE! At least one property from the following list is
mandatory: ip-addr, vlan.

Input Parameter Description Value Mandatory

portal-id Portal ID Index Yes

ip-addr Portal IP address IP address/subnet bits At least one of the

following parameters
vlan VLAN ID Integer must be selected:
• ip-addr
• vlan

cluster-id Cluster Index number Name or Index No

Example:
modify-iscsi-portal portal-id="X1-SC1-iscsi1"
ip-addr="1.2.3.4/24" vlan=5

remove-iscsi-portal
The remove-iscsi-portal admin-level command deletes a portal mapping from a
Target.

Note: The Target will no longer receive iSCSI traffic via the portal.

Usage:
remove-iscsi-portal ip-addr=<IP Address/Subnet Bits> [
cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

ip-addr Portal’s IP Address IP Address/ Yes

Subnet Bits

cluster-id Cluster ID id: Name or Index No

Example:
modify-iscsi-portal ip-addr="10.2.2.1/24"

Provisioning 205
Admin CLI Commands

remove-iscsi-route
The remove-iscsi-route admin-level command deletes an iSCSI routing rule.
Usage:
remove-iscsi-route iscsi-route-id=<name or index> [
cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

iscsi-route-id iSCSI route id Name or index Yes

cluster-id Cluster ID id: Name or Index No

Example:
remove-iscsi-route iscsi-route-id="iSCSIRoute1"

show-iscsi-portals
The show-iscsi-portals admin-level command displays the list of iSCSI portals and
their properties.
Usage:
show-iscsi-portals [ duration=<seconds> ] [ cluster-id=<id:
name or index> ] [ frequency=<seconds> ] [ filter ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

filter Filters the command See “Using Filters” on No

output page 11.

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

206 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:

show-iscsi-portals

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index

Portal-Index The Target portal index

Target-Name The Target port name

Index The port’s index number

IP-Address The portal’s IP address

Port-Address The port’s address

VLAN The port’s virtual LAN

Certainty-State Indicates whether there is a pending command associated with the

iSCSI portal.

show-iscsi-routes
The show-iscsi-routes admin-level command displays the list of iSCSI routes and
their properties.
Usage:
show-iscsi-routes [ duration=<seconds> ] [ cluster-id=<id: name
or index> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Provisioning 207
Admin CLI Commands

Example:

show-iscsi-routes

Output Parameter Description

Name The route’s name

Index The route’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Destination-Network-and-Mask The route’s destination subnet

Gateway The route’s gateway

Certainty-State Indicates whether there is a pending command associated

with the iSCSI route.

show-chap
The show-chap admin-level command displays the cluster’s configured CHAP
authentication and discovery modes.
Usage:
show-chap [cluster-id=<id: name or index> ] [
duration=<seconds> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

208 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:

show-chap

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index

Chap-Discovery-Mode The CHAP discovery mode (Disabled, Initiator, Initiator and Target)

Chap-Authentication-Mode The CHAP authentication mode (Disabled, Initiator, Initiator and

Target)

modify-chap
The modify-chap admin-level command modifies the CHAP configuration parameters.
Usage:
modify-chap ( chap-discovery-mode=<disabled, initiator or
initiator_and_target> | chap-authentication-mode=<disabled,
initiator or initiator_and_target> ) [ cluster-id=<name or
index> ]
NOTE! At least one property from the following list is
mandatory: chap-discovery-mode, chap-authentication-mode.

Input Parameter Description Value Mandatory

chap-authentication- CHAP Authentication disabled, initiator, At least one of the

mode Mode initiator_and_target following parameters
must be selected:
chap-discovery-mode CHAP Discovery Mode disabled, initiator, • chap-authentication-
initiator_and_target mode
• chap-discovery-mode

cluster-ID Cluster Identification Name or Index No

Example:
modify-chap chap-discovery-mode=initiator
chap-authentication-mode=initiator_and_target

Provisioning 209
Admin CLI Commands

Data Protection Group Management

show-data-protection-groups
The show-data-protection-groups admin-level command displays a list of Data
Protection Groups and their properties.
Usage:
show-data-protection-groups [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
vertical ] [ filter=<> ] [ prop-list=<list of property strings>
]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

210 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:

show-data-protection-groups

Output Parameter Description

Name The Data Protection Group’s name

Index The Data Protection Group’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

State The Data Protection Group’s state

Useful-SSD-Space The available physical capacity in the Data Protection Group

User-Space The total SSD space available to the XtremIO Storage Array for user
data

User-Space-In-Use The SSD space currently in use

User-Space-Percent-Free The free user space (percentage)

Rebuild-Progress The progress of a rebuild action for the Data Protection Group
following SSD failure

Preparation-Progress The Data Protection Group is being added to the cluster and is in
preparation.

Proactive-Metadata-Loading Indicates whether there is lazy load in progress.

Rebuild-Prevention Indicates whether a rebuild was prevented due to insufficient user

data space.

Brick-Name The X-Brick’s name

Index The X-Brick’s index number

Provisioning 211
Admin CLI Commands

Data Protection
Retention Policy

add-protection-retention-policy
The add-protection-retention-policy admin-level command adds a new
Retention Policy.
Usage:
add-protection-retention-policy cluster-id=<Name or Index>
retention-policy-name=<String> short-period-duration=<String>
short-period-copies=<Integer> [ middle-period-duration=<String>
] [ middle-period-copies=<Integer> ] [
long-period-duration=<String> ] [ long-period-copies=<Integer>
] [ xms-name=<name> ]
NOTE! The following properties are mandatory: [ cluster-id,
retention-policy-name, short-period-duration,
short-period-copies ]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index Yes

retention-policy-name Retention Policy name String Yes

short-period-copies Number of short Integer Yes

period copies

short-period-duration Duration of short String Yes

period

middle-period-copies Number of middle Integer No

period copies

middle-period-duratio Duration of middle String No

n period

long-period-copies Number of long period Integer No

copies

long-period-duration Duration of long String No

period

xms-name XMS name Name No

Example:
add-protection-retention-policy

212 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

copy-protection-retention-policy
The copy-protection-retention-policy admin-level command copies all
retention policies or a specified Retention Policy from one cluster to another.
Usage:
copy-protection-retention-policy cluster-id=<Name or Index>
retention-policy-name=<String> short-period-duration=<String>
short-period-copies=<Integer> [ middle-period-duration=<String>
] [ middle-period-copies=<Integer> ] [
long-period-duration=<String> ] [ long-period-copies=<Integer>
] [ xms-name=<name> ]
NOTE! The following properties are mandatory: [
from-cluster-id, to-cluster-id ]
NOTE! The following properties are mandatory and exclusive: [
copy-all, retention-policy-id ]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

from-cluster-id Source cluster ID Name or Index Yes

to-cluster-id Target cluster ID Name or Index Yes

copy-all Copy all retention N/A Only one of the

policies from the following parameters
source cluster must be selected:
• copy-all
retention-policy-id Retention Policy ID Name or Index
• retention-policy-id

from-xms-name Source XMS Name or Index No

to-xms-name Target XMS Name or Index No

Example:
copy-protection-retention-policy from-

Data Protection 213

Admin CLI Commands

modify-protection-retention-policy
The modify-protection-retention-policy admin-level command modifies the
parameters of a Retention Policy.

Note: All parameters must be assigned. Partial assignment resets the unassigned
parameters to the system defaults.

Usage:
modify-protection-retention-policy cluster-id=<Name or Index>
retention-policy-name=<String> short-period-duration=<String>
short-period-copies=<Integer> [ middle-period-duration=<String>
] [ middle-period-copies=<Integer> ] [
long-period-duration=<String> ] [ long-period-copies=<Integer>
] [ xms-name=<name> ]
NOTE! The following properties are mandatory: [ cluster-id,
retention-policy-id ]
NOTE! At least one of the following parameters must be selected:
[ retention-policy-name, short-period-copies,
short-period-duration, middle-period-copies,
middle-period-duration, long-period-copies,
long-period-duration ]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index Yes

retention-policy-id Retention Policy Index Name or Index Yes

retention-policy-name Retention Policy name String At least one of the

following parameters
short-period-copies Number of short Integer must be selected:
period copies • retention-policy-nam
e
short-period-duration Duration of short String
period • short-period-copies
• short-period-duration
middle-period-copies Number of middle Integer • middle-period-copies
period copies • middle-period-durati
on
middle-period-duratio Duration of middle String
n period • long-period-copies
• long-period-duration
long-period-copies Number of long period Integer
copies

long-period-duration Duration of long String

period

xms-name XMS name Name No

214 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:
modify-protection-retention-policy

remove-protection-retention-policy
The remove-protection-retention-policy admin-level command deletes a
protection Retention Policy.
Usage:
remove-protection-retention-policy cluster-id=<Name or Index>
retention-policy-id=<Name or Index> [ xms-name=<Name> ]
NOTE! The following properties are mandatory: [ cluster-id,
retention-policy-id ]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index Yes

retention-policy-id Retention Policy Index Name or Index Yes

xms-name XMS name Name No

Example:
remove-protection-retention-policy

Data Protection 215

Admin CLI Commands

show-protection-retention-policy
The show-protection-retention-policy admin-level command displays the
parameters of a specified Retention Policy.
Usage:
show-protection-retention-policy cluster-id=<Name or Index>
retention-policy-id=<Name or Index> [ prop-list=<list of
property strings> ] [ xms-name=<name> ]
NOTE! The following properties are mandatory: [ cluster-id,
retention-policy-id ]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index Yes

retention-policy-id Retention Policy Index Name or Index Yes

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

xms-name XMS name name No

Example:
show-protection-retention-policy

Output Parameter Description

Name Retention Policy name

Index Retention Policy index

XMS-ID Remote XMS index

Cluster-ID Remote cluster index

Num-References Number of Remote Protection Sessions using this policy

Protection-Window-Duratio The longest time a protection copy is configured to be retained at

n-In-Days the target cluster

Protection-Window-Num-Co The total number of protection copies retained at the target cluster
pies

Short-Retention-Copies Number of copies to be retained in the short retention period

Short-Period-Unit Unit of retention for the short period (minutes, hours, days)

Short-Period-Duration Duration of the short period in the specified units

Middle-Period-Unit Unit of retention for the middle period (minutes, hours, days)

216 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

Middle-Period-Duration Duration of the middle period in the specified units

Middle-Retention-Copies Number of copies to be retained in the middle retention period

Long-Period-Unit Unit of retention for the long period (minutes, hours, days)

Long-Period-Duration Duration of the long period in the specified units

Long-Retention-Copies Number of copies to be retained in the long retention period

Certainty Indicates whether the remote manager is synchronized with the

system

Replication-Session-List A list of all Remote Protection Sessions using this Retention Policy

show-protection-retention-policies
The show-protection-retention-policies admin-level command displays the
parameters of all defined retention policies.
Usage:
show-protection-retention-policies [ cluster-id=<Name or Index>
] [ prop-list=<list of property strings> ] [ xms-name=<name> ]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

xms-name XMS name name No

Example:
show-protection-retention-policies

Output Parameter Description

Name Retention Policy name

Index Retention Policy index

XMS-ID Remote XMS index

Cluster-ID Remote cluster index

Num-References Number of Remote Protection Sessions using this policy

Data Protection 217

Admin CLI Commands

Output Parameter Description

Protection-Window-Duratio The longest time (in days) a PIT is retained

n-In-Days

Protection-Window-Num-Co The total number of PITs retained

pies

Certainty Indicates whether the remote manager is synchronized with the

system

Local Protection

add-local-protection-session
The add-local-protection-session admin-level command adds a new Local
Protection Session.
Usage:
add-local-protection-session protection-session-name=<String>
snapped-object-id=<Name or Index> snapped-object-type=<Volume,
ConsistencyGroup> local-protection-type=<interval, explicit>
schedule=<String - interval [h:m:s] / explicit [day:h:m]> [
cluster-id=<Name or Index> ] [ enabled-state=<enabled,
user_disabled> ] [ retention-policy-id=<Name or Index> ] [
suffix=<string> ] [ create-secured-snap=<True, false> ]
NOTE! The following properties are mandatory: [
protection-session-name, snapped-object-id,
snapped-object-type, local-protection-type, schedule ]

Input Parameter Description Value Mandatory

local-protection-type Local Protection interval, explicit Yes

Session type

protection-session-na Local Protection String Yes

me Session name

schedule Schedule for Snapshot Interval [h:m:s] / Yes

creation explicit [day:h:m]

snapped-object-id Object ID of the Name or Index Yes

snapped object

snapped-object-type Type of the snapped Volume, Consistency Yes

object Group

cluster-id Cluster ID Name or Index No

enabled-state Local Protection enabled, No

enabled state user_disabled

218 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Input Parameter Description Value Mandatory

retention-policy-id Retention Policy ID Name or Index No

suffix Snapshot name suffix String No

create-secured-snap Indicates if all False (default), True No

Snapshots created by
the Local Protection
Session will be
created as secured

Example:
add-local-protection-session local-protection-type=interval
protection-session-name="localProt1" schedule="22:30:00"
snapped-object-id=1 snapped-object-type=Volume

manage-local-protection-session
The manage-local-protection-session admin-level command starts, suspends
or resumes a Local Protection Session.
Usage:
manage-local-protection-session protection-session-id=<Name or
Index> [ cluster-id=<Name or Index> ] [ operation=<start,
suspend, resume> ]
NOTE! The following properties are mandatory:
protection-session-id

Input Parameter Description Value Mandatory

protection-session-id Local Protection Name or Index Yes

Session ID

cluster-id Cluster ID Name or Index No

operation Operation to perform start, suspend, No

resume

Example:
manage-local-protection-session protection-session-id=1
operation=start

Data Protection 219

Admin CLI Commands

modify-local-protection-session
The modify-local-protection-session admin-level command modifies the
parameters of a Local Protection Session.
Usage:
modify-local-protection-session protection-session-id=<Name or
Index> [ new-protection-session-name=<String> ] [
local-protection-type=<interval, explicit> ] [ schedule=<string
- interval [h:m:s] / explicit [day:h:m]> ] [
retention-policy-id=<Name or Index> ] [ suffix=<String> ] [
remove-retention-policy ] [ create-secured-snap=<True, False> ]
NOTE! The following property is mandatory:
protection-session-id
NOTE! At least one of the following parameters must be selected:
[new-protection-session-name, local-protection-type, schedule,
retention-policy-id, suffix, remove-retention-policy,
create-secured-snap]

Input Parameter Description Value Mandatory

protection-session-id Protection Session ID Name or Index Yes

new-protection-sessio Local Protection String At least one of the

n-name Session name following parameters
must be selected:
local-protection-type Local Protection interval, explicit • new-protection-sessi
Session type on-name
schedule Schedule for Snapshot Interval [h:m:s] / • local-protection-type
creation explicit [day:h:m] • schedule
• retention-policy-id
retention-policy-id Retention-policy-id Name or Index • suffix
suffix Snapshot name suffix String • remove-retention-pol
icy
remove-retention-polic Removes the current N/A • create-secured-snap
y retention policy and
re-applies the
system's 'default'
retention behavior.

create-secured-snap Indicates whether all True, False (default)

snapshots created by
the local protection
session will be created
as secured_snap.

Example:
modify-local-protection-session protection-session-id=1
new-protection-session-name="localProt2"

220 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

remove-local-protection-session
The remove-local-protection-session admin-level command deletes a Local
Protection Session.
Usage:
remove-local-protection-session protection-session-id=<Name or
Index> [ cluster-id=<Name or Index> ] [ remove-snapshot-sets ]
NOTE! The following property is mandatory: [
protection-session-id ]

Input Parameter Description Value Mandatory

protection-session-id Local Protection Name or Index Yes

Session ID

cluster-id Cluster ID Name or Index No

remove-snapshot-sets Remove generated N/A No

Snapshot Sets

Example:
remove-local-protection-session protection-session-id=1

show-local-protection-consistency-group
The show-local-protection-consistency-group admin-level command
displays the details of a Consistency Group that is a part of a Local Protection Session.
Usage:
show-local-protection-consistency-group
consistency-group-id=<Name or Index> [ cluster-id=<Name or
Index> ] [ vertical ]
NOTE! The following property is mandatory: [
consistency-group-id ]

Input Parameter Description Value Mandatory

consistency-group-id Consistency Group ID Name or Index Yes

cluster-id Cluster ID Name or Index No

vertical Vertical layout N/A No

Example:
show-local-protection-consistency-group consistency-group-id=1

Output Parameter Description

Name Consistency Group name

Index Consistency Group index

Cluster-Name Cluster name

Data Protection 221

Admin CLI Commands

Output Parameter Description

Index Cluster index

Num-Of-SnapshotSets Number of Snapshot Sets created for the Consistency Group

Num-Of-Vols Number of Volumes in the Consistency Group

Created-By-Application The application that created the Consistency Group (XMS,

Scheduler)

Volume-List List of the Volumes in the Consistency Group

show-local-protection-consistency-groups
The show-local-protection-consistency-groups admin-level command
displays the details of all Consistency Group that are a part of a Local Protection Session.
Usage:
show-local-protection-consistency-groups [ cluster-id=<Name or
Index> ] [ vertical ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

vertical Vertical layout N/A No

Example:
show-local-protection-consistency-groups

Output Parameter Description

Name Consistency Group name

Index Consistency Group index

Cluster-Name Cluster name

Index Cluster index

Num-Of-SnapshotSets Number of Snapshot Sets created for the Consistency Group

Num-Of-Vols Number of Volumes in the Consistency Group

Created-By-Application The application that created the Consistency Group (XMS,

Scheduler)

Volume-List List of the Volumes in the Consistency Group

222 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-local-protection-session
The show-local-protection-session admin-level command displays the details
of a specified Local Protection Session.

Note: To locate all secured Local Protection Sessions, use the prop-list input parameter
with the create-secured-snap property.

Usage:
show-local-protection-session protection-session-id=<Name or
Index> [ cluster-id=<Name or Index> ] [ duration=<seconds> ] [
filter=<> ] [ frequency=<seconds> ] [ prop-list=<list of
property strings> ] [ vertical ]
NOTE! The following property is mandatory: [
protection-session-id ]

Input Parameter Description Value Mandatory

protection-session-id Local Protection Name or Index Yes

Session ID

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

filter Filters the command See “Using Filters” on No

output page 11.

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

vertical Vertical layout N/A No

Example:
show-local-protection-session protection-session-id=1

Output Parameter Description

Name Local Protection Session name

Index Local Protection Session index

LocalProtection-State Local Protection Session status (enabled, user_disabled)

Cluster-ID Cluster name and index

Snapped-Object-Id Index of the snapped object

Retention-Policy-Id Name and index of the applied Retention Policy

RPO (seconds) Recovery Point Objective in seconds

Data Protection 223

Admin CLI Commands

Output Parameter Description

Current-Protection-Window- The actual total number of PITs retained on the Local Protection
Copies Session

Current-Protection-Window- The actual protection time frame (in days) for which the copies exist
Duration-in-Days

RPO-Status Indicates whether the RPO is according to the user setting

Num-PITs Number of PITs existing for the Local Protection Session

Next-Scheduled-Cycle Date and time of the next scheduled Local Protection cycle

Lag (sec) The time that passed since the last consistent PIT was replicated (in
seconds)

Last-Cycle-Start-Time Date and time of last Remote Protection cycle

Last-Run-Completed-Snaps The most recent completed Snapshot Set created by this Local
hot-Set Protection Session

Num-Missing-Short-Period- The number of PITs missing for the short period (compared to the
PITs configured number)

Num-Missing-Middle-Period The number of PITs missing for the middle period (compared to the
-PITs configured number)

Num-Missing-Long-Period-P The number of PITs missing for the long period (compared to the
ITs configured number)

Protection-Window-Complia Indicates the percentage of compliance of the protection window

nce with the Local Protection Session

Severity Severity of alerts received for this Local Protection Session

Create-Secured-Snap Indicates if all Snapshots created by the Local Protection Session

will be created as secured Snapshots (default value-false).

224 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-local-protection-sessions
The show-local-protection-sessions admin-level command displays the details
of all Local Protection Sessions.
Usage:
show-local-protection-sessions [ cluster-id=<Name or Index> ] [
duration=<seconds> ] [ filter=<> ] [ frequency=<seconds> ] [
prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration seconds No

filter Filters the command See “Using Filters” on No

output page 11.

frequency Monitor intervals seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:
show-local-protection-sessions

Output Parameter Description

Name Local Protection Session name

Index Local Protection Session index

RPO-Status Indicates whether RPO is according to user specification

LocalProtection-State Status of the Local Protection Session (enabled, user_disabled)

Cluster-ID Cluster name and index

Snapped-Object-Id Name and index of the snapped object

RPO (seconds) Recovery Point Objective in seconds

Current-Protection-Window- Actual number of copies retained for this Local Protection Session
Copies

Retention-Policy-Id Name and index of the Retention Policy

Data Protection 225

Admin CLI Commands

show-local-protection-snapshot-sets
The show-local-protection-snapshot-sets admin-level command lists the
Snapshot Sets related to a specified Local Protection Session.
Usage:
show-local-protection-snapshot-sets protection-session-id=<Name
or Index> [ cluster-id=<Name or Index> ] [ duration=<seconds> ]
[ filter=<> ] [ frequency=<seconds> ] [ prop-list=<list of
property strings> ] [ from-time=<date/time format: e.g.
"2018-06-04 14:21:29"> ] [ to-time=<date/time format: e.g.
"2018-06-04 14:21:29"> ] [ vertical ]

Input Parameter Description Value Mandatory

protection-session-id Protection Session ID Name or Index Yes

cluster-id Cluster ID Name or Index No

duration Monitor duration seconds No

filter Filters the command See “Using Filters” on No

output page 11.

frequency Monitor intervals seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

from-time From local date/time Date/time format: e.g. No

"2018-06-04
14:21:29"

to-time To local date/time Date/time format: e.g. No

"2018-06-04
14:21:29"

Vertical Vertical layout N/A No

226 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:
show-local-protection-snapshot-sets
protection-session-id="MySession"

Output Parameter Description

Name Snapshot Set name

Index Snapshot Set index

Creation-Time Snapshot Set creation time

Cluster-ID Cluster name and index

Created-By-Application Name of application that created the Snapshot Set (recoverpoint,

odx, xms, scheduler, local_protection, remote_protection_source,
remote_protection_target, remote_protection_manager)

Session-Owner-ID ID of the application that created the Snapshot Set

Data Protection 227

Admin CLI Commands

Remote Protection

add-remote-protection-ip-link
The add-remote-protection-ip-link admin-level command adds an IP link
between a source cluster and a target cluster.
Usage:
add-remote-protection-ip-link source-cluster-id=<Name or Index>
source-ip-addr-sn=<IP Address/Subnet Bits>
target-cluster-id=<Name or Index> target-ip-addr-sn=<IP
Address/Subnet Bits> [ ip-link-name=<String> ] [
source-xms-name=<name> ] [ target-xms-name=<name> ]
NOTE! The following properties are mandatory:
[source-cluster-id, source-ip-addr-sn, target-cluster-id,
target-ip-addr-sn]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

source-cluster-id Source cluster ID Name or Index Yes

source-ip-addr-sn Source IP address IP Address/Subnet Yes

Bits

target-cluster-id Target cluster ID Name or Index Yes

target-ip-addr-sn Target IP address IP Address/Subnet Yes

Bits

ip-link-name IP Link name String No

source-xms-name Source XMS name name No

target-xms-name Target XMS name name No

Example:
add-remote-protection-ip-link source-cluster-id="Xbrick11"
source-ip-addr-sn="1.1.1.10/24" target-cluster-id="Xbrick21"
target-ip-addr-sn="1.1.1.20/24"

228 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

modify-remote-protection-ip-link
The modify-remote-protection-ip-link admin-level command modifies the
parameters of an IP link between a source cluster and a target cluster.
Usage:
modify-remote-protection-ip-link ip-link-id=<Name or Index>
[(enable | disable) | refresh-link-credentials |
number-of-sockets=<Integer 4-128> | ip-link-name=<String>]
NOTE! The following property is mandatory: [ip-link-id]
NOTE! At least one of the following properties is mandatory:
[disable, enable, ip-link-name, number-of-sockets,
refresh-link-credentials]
NOTE! Only one property from the following is allowed:
[enabled, disabled]

Input Parameter Description Value Mandatory

ip-link-id IP Link ID Name or Index Yes

disable Disable IP Link N/A At least one of the

following parameters
enable Enable IP Link N/A must be selected:
• disable
ip-link-name IP Link name String
• enable
number-of-sockets The maximum number Integer 4-128 • ip-link-name
of sockets per a • number-of-sockets
specified IP link • refresh-link-credentia
ls
refresh-link-credential Refresh IP Link N/A
s credentials

Example:
modify-remote-protection-ip-link ip-link-id=1 enable

Data Protection 229

Admin CLI Commands

remove-remote-protection-ip-link
The remove-remote-protection-ip-link admin-level command deletes an IP
link between a source cluster and a target cluster.
Usage:
remove-remote-protection-ip-link ip-link-id=<Name or Index> [
force ]
NOTE! The following property is mandatory: [ ip-link-id ]

Input Parameter Description Value Mandatory

ip-link-id IP Link ID Name or Index Yes

force Force remove N/A No

Example:
remove-remote-protection-ip-link ip-link-id=1

show-remote-protection-ip-link
The show-remote-protection-ip-link admin-level command displays the
parameters of the specified IP link.
Usage:
show-remote-protection-ip-link ip-link-id=<Name or Index> [
prop-list=<List of property strings> ]
NOTE! The following property is mandatory: [ ip-link-id ]

Input Parameter Description Value Mandatory

ip-link-id IP Link ID Name or Index Yes

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:
show-remote-protection-ip-link ip-link-id=1

Output Parameter Description

Name IP Link name

Index IP Link Index

A-End-XMS-ID Source XMS Index

A-End-Cluster-ID Source cluster Index

A-End-IP-Addr Source IP address

Z-End-XMS-ID Target XMS Index

230 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

Z-End-Cluster-ID Target cluster Index

Z-End-IP-Addr Target IP address

IP-Link-State IP Link status

Ip-Link-Consistency IP Lind consistency

Certainty Indicates whether there is a pending command associated with the

IP Link.

Max-Number-of-Sockets The maximum number of sockets per a specified IP link

show-remote-protection-ip-links
The show-remote-protection-ip-links admin-level command displays the
parameters of all IP links.
Usage:
show-remote-protection-ip-links [ cluster-id=<Name or Index> ]
[ peer-cluster-id=<Name or Index> ] [ peer-xms-name=<name> ] [
protection-session-id=<Name or Index> ] [ xms-name=<name> ]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

peer-cluster-id Peer cluster ID Name or Index No

peer-xms-name Peer XMS name String No

protection-session-id Remote Protection Name or Index No

Session ID

xms-name XMS name String No

Example:
show-remote-protection-ip-links

Output Parameter Description

Name IP Link name

Index IP Link Index

A-End-XMS-ID Source XMS Index

A-End-Cluster-ID Source cluster Index

A-End-IP-Addr Source IP address

A-End-Port-ID Source port Index

Z-End-XMS-ID Target XMS Index

Data Protection 231

Admin CLI Commands

Output Parameter Description

Z-End-Cluster-ID Target cluster Index

Z-End-IP-Addr Target IP address

Z-End-Port-ID Target port Index

IP-Link-State IP Link status

Ip-Link-Consistency-State IP Lind consistency

Certainty Indicates whether there is a pending command associated with the

IP Link.

add-remote-protection-peer-xms
The add-remote-protection-peer-xms admin-level command registers a remote
XMS to the local XMS.
Usage:
add-remote-peer-xms remote-ip-addr=<IP Address>
remote-xms-alias-name=<name> remote-xms-user=<Sting>
remote-user-password=<String> [ local-xms-alias-name=<name> ]
NOTE! The following properties are mandatory: [remote-ip-addr,
remote-xms-alias-name, remote-xms-user, remote-user-password]

Input Parameter Description Value Mandatory

remote-ip-addr XMS IP Address IP Address Yes

remote-user-password XMS user password of String Yes

peer XMS (admin level
or higher)

remote-xms-alias-nam Remote XMS alias to String Yes

e be used in Remote
Protection domain

remote-xms-user XMS user name of String Yes

peer XMS (admin level
or higher)

local-xms-alias-name Local XMS alias to be String No

used in Remote
Protection domain

Example:
add-remote-peer-xms remote-ip-addr="1.1.1.10"
remote-xms-alias-name="XMS1" remote-xms-user="admin"
remote-user-password="MyPwd"

232 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

modify-remote-protection-peer-xms
The modify-remote-protection-peer-xms admin-level command modifies the
parameters of a remote XMS registered at the local XMS.
Usage:
modify-remote-protection-peer-xms xms-alias-name=<Name> [
new-xms-alias-name=<name> | new-ip-addr=<IP Address> ]
NOTE! The following property is mandatory: [xms-alias-name]
NOTE! At least one of the following properties is mandatory:
[new-ip-addr, new-xms-alias-name]

Input Parameter Description Value Mandatory

xms-alias-name XMS alias of the String Yes

remote XMS

new-ip-addr New IP Address IP Address At least one of the

following parameters
new-xms-alias-name New XMS alias of the String must be selected:
remote XMS • new-ip-addr
• new-xms-alias-name

Example:
modify-remote-protection-peer-xms xms-alias-name="XMS1"
new-xms-alias-name="NewXMS"

remove-remote-protection-peer-xms
The remove-remote-protection-peer-xms admin-level command removes a
registration of a remote XMS from the local XMS.
Usage:
remove-remote-protection-peer-xms xms-alias-name=<Name>
NOTE! The following property is mandatory: [xms-alias-name]

Input Parameter Description Value Mandatory

xms-alias-name XMS alias of the Name Yes

remote XMS

Example:
remove-remote-protection-peer-xms xms-alias-name="XMS1"

Data Protection 233

Admin CLI Commands

show-remote-protection-peer-xms
The show-remote-protection-peer-xms admin-level command displays all
remote XMSs registered at the local XMS.
Usage:
show-remote-protection-peer-xms
Example:
show-remote-protection-peer-xms

Output Parameter Description

Name The XMS name

Index The XMS Index

IP-Address The XMS IP Address

XMS-Connectivity-State The XMS connectivity status

add-remote-protection-session
The add-remote-protection-session admin-level command creates a new
Remote Protection Session.
Usage:
add-remote-protection-session protection-session-name=<String>
rpo=<Integer> source-cluster-id=<Name or Index>
source-consistency-group-id=<Name or Index>
target-cluster-id=<Name or Index> [ (
target-consistency-group-id=<Name or Index> |
auto-provision-target ) ] [
protection-window-compliance-alert=<enabled, disabled> ] [
source-retention-policy-id=<Name or Index> ] [
source-xms-name=<name> ] [ start-on-craetion ] [
target-retention-policy-id=<Name or Index> ] [
target-volume-access=<no_access, read_only> ] [
target-xms-name=<name> ] [ enable-verification=<enabled,
disabled> ], async-bw-limit=<integer> ] [
replication-mode=<async, sync> ]
NOTE! The following properties are mandatory:
[protection-session-name, rpo, source-cluster-id,
source-consistency-group-id, target-cluster-id]
NOTE! At least one property from the following list is
mandatory: [target-consistency-group-id, auto-provision-target]
NOTE! Only one property from the following list is allowed:
[target-consistency-group-id, auto-provision-target]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

234 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Input Parameter Description Value Mandatory

protection-session-na Remote Protection String Yes

me Session name

rpo Recovery Point Integer Yes

Objective (in seconds)

source-cluster-id Source cluster ID Name or Index Yes

source-consistency-gr Source object ID Name or Index Yes

oup-id

target-cluster-id Target cluster ID Name or Index Yes

auto-provision-target Duplicate Source N/A At least one of the

Consistency Group on following parameters
target must be selected:
• auto-provision-target
target-consistency-gro Target Volume ID Name or Index
• target-consistency-gr
up-id
oup-id

protection-window-co Enable or disable enabled, disabled No

mpliance-alert alerts on missing PITs

source-retention-polic ID of existing Name or Index No

y-id Retention Policy on
the source cluster

source-xms-name Source XMS name String No

start-on-creation Activate session upon N/A No

creation

target-retention-policy ID of existing Name or Index No

-id Retention Policy on
the target cluster

target-volume-access Target Volume access no_access, read-only No

target-xms-name Target XMS name String No

enable-verification Data verification enabled, disabled No

enabled state

async-bw-limit The maximum Integer (default value No

bandwidth that may 0, min value 20)
be utilized for this
async replication
session (mbps)

replication-mode The replication type 'async' (default), No

'sync',

Example:
add-remote-protection-session
protection-session-name="MySession" rpo=3000
source-cluster-id="SourceCluster"
source-consistency-group-id=22
target-cluster-id="TargetCluster" auto-provision-target

Data Protection 235

Admin CLI Commands

modify-remote-protection-session
The modify-remote-protection-session admin-level command modifies the
parameters of a Remote Protection Session.
Usage:
modify-remote-protection-session protection-session-id=<Name or
Index> [ ( source-retention-policy-id=<Name or Index> |
remove-source-retention-policy ) | (
target-retention-policy-id=<Name or Index> |
remove-target-retention-policy ) |
new-protection-session-name=<String> | rpo=<Integer> |
replication-mode=<async,sync> |
target-volume-access=<no_access, read_only> |
protection-window-compliance-alert=<enabled, disabled> |
release-lock ] | [ async-bw-limit=<Integer> ] | [
enable-verification=<enabled, disabled> ] [ force ]
NOTE! The following property is mandatory:
[protection-session-id]
NOTE! At least one property from the following list is
mandatory: [new-protection-session-name, rpo,
source-retention-policy-id, remove-source-retention-policy,
target-retention-policy-id, remove-target-retention-policy,
target-volume-access, protection-window-compliance-alert,
release-lock, async-bw-limit, enable-verification]
NOTE! Only one property from the following list is allowed:
[source-retention-policy-id, remove-source-retention-policy]
NOTE! Only one property from the following list is allowed:
[target-retention-policy-id, remove-target-retention-policy]

Input Parameter Description Value Mandatory

protection-session-id Remote Protection Name or Index Yes

Session ID

236 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Input Parameter Description Value Mandatory

new-protection-sessio Remote Protection String At least one of the

n-name Session name following parameters
must be selected:
protection-window-co Enable or disable enabled, disabled • new-protection-sessi
mpliance-alert alerts on missing PITs on-name
release-lock Release Remote N/A • protection-window-c
Protection Session ompliance-alert
lock • release-lock
• remove-source-retent
remove-source-retenti Remove source N/A ion-policy
on-policy Retention Policy • remove=target-retent
ion-policy
remove-target-retentio Remove target N/A
n-policy Retention Policy • rpo
• replication-mode
rpo Recovery Point Integer • source-retention-poli
Objective (in seconds) cy-id
• target-retention-polic
replication-mode Indicates the type of async (default), sync y-id
replication
• target-volume-access
source-retention-polic Source Retention Name or Index • async-bw-limit
y-id Policy ID • enable-verification
target-retention-policy Target Retention Policy Name or Index
-id ID

target-volume-access Target Volume access no_access, read_only

async-bw-limit The maximum Integer

bandwidth that may
be utilized for this
async replication
session

enable-verification Data verification enabled, disabled

enabled state

force Release Remote N/A No

Protection Session
lock regardless of
remote connectivity

Example:
modify-remote-protection-session protection-session-id=1 rpo=30

Data Protection 237

Admin CLI Commands

manage-remote-protection-session
The manage-remote-protection-session admin-level command enables to
perform actions in the context of the Remote Protection Session.

Note: For details on the various Remote Protection Session actions, refer to For details on
the different operations, refer to the XtremIO Storage Array User Guide.

Usage:
manage-remote-protection-session protection-session-id=<Name or
Index> operation=<start, suspend, terminate, resume,
replicate_now, create-bookmark, failover, failover_cleanup,
test_copy_start, test_copy_finish, remove_snapshot_sets> (
snapshot-sets-to-remove-side=<source, target> )
(cluster-id=<name or index> ) [ bookmark-name=<String> ] [
keep-target-ss=<True, false> ] [ cluster-id=<Name or Index> ] [
force ] [ retention-time=<minutes> ] [ snapshto-set-id=<Name
or Index> ] [
snapshot-set-selection=<using_latest_snapshot_set,
use_test_copy_snapshot_set, sync_and_failover> ] [
snapshot-sets-to-remove-side=<source, target> ] [
snapshot-sets-to-remove-since=<date/time format: e.g.
"2018-01-23 11:46:37"> ] [
snapshot-sets-to-remove-until=<date/time format: e.g.
"2018-01-23 11:46:37"> ] [ start-replication-with-failover ] [
suspend-type=<graceful, immediate> ] [ xms-name=<name> ]
NOTE! The following properties are mandatory:
[protection-session-id, operation]
NOTE! Only one property from the following list is allowed:
[snapshot-sets-to-remove-side]
NOTE! Only one property from the following list is allowed:
[cluster-id]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

238 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Input Parameter Description Value Mandatory

protection-session-id Remote Protection Name or Index Yes

Session ID

operation Type of operation to start, suspend, Yes

perform. terminate, resume,
replicate_now,
create-bookmark,
failover,
failover_cleanup,
test_copy_start,
test_copy_finish,
remove_snapshot-sets

bookmark-name The name of the String No

Snapshot Set created
by replicate_now
(valid only when
operation=replicate_n
ow)

keep-target-ss Enables not to remove True, false No

the PITs from the
target that becomes
source (valid only
when
operation=failover)

cluster-id Cluster ID Name or Index No

force Force stop N/A No

retention-time Number of minutes to Minutes No

retain the bookmark;
use 0 to retain
indefinitely.

snapshot-set-id Snapshot Set ID Name or Index No

snapshot-set-selectio Snapshot Set using_latest_snapshot No

n selection type _set,
use_text_copy_snaps
hot_set,
sync_and_failover

snapshot-sets-to-remo Location of the source, target No

ve-side Snapshot Sets to be
removed

snapshot-sets-to-remo Start date and time or date/time format: e.g. No

ve-since period from which to "2018-01-23
remove Snapshot Sets 11:46:37"

snaphot-sets-to-remov End date and time of date/time format: e.g. No

e-until period from which to "2018-01-23
remove Snapshot Sets 11:46:37"

Data Protection 239

Admin CLI Commands

Input Parameter Description Value Mandatory

start-replication-with-f Start Remote N/A No

ailover Protection Session on
failover

suspend-type Type of suspension graceful, immediate No

xms-name XMS name Name No

Example:
manage-remote-protection-session protection-session-id=1
operation=suspend

remove-remote-protection-session
The remove-remote-protection-session admin-level command deletes a
Remote Protection Session.
Usage:
remove-remote-protection-session protection-session-id=<Name or
Index> [ force ] [ remove-target-volumes ]
NOTE! The following property is mandatory: [
protection-session-id ]

Input Parameter Description Value Mandatory

protection-session-id Remote Protection Name or Index Yes

Session ID

force Force stop N/A No

remove-target-volume Remove Volumes on N/A No

s the target cluster

Example:
remove-remote-protection-session protection-session-id=1

240 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-remote-protection-session
The show-remote-protection-session admin-level command displays the
parameters of a Remote Protection Session.
Usage:
show-remote-protection-session protection-session-id=<Name or
Index> [ prop-list=<List of property strings> ]
NOTE! The following property is mandatory: [
protection-session-id ]

Input Parameter Description Value Mandatory

protection-session-id Remote Protection Name or Index Yes

Session ID

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:
show-remote-protection-session protection-session-id=1

Output Parameter Description

Name The Remote Protection Session name

Index The Remote Protection Session Index

Replication-State The status of the Remote Protection Session

Replication-State-Details The Remote Protection Session state details

Replication-Direction The Remote Protection Session direction

Block-Access-Type Block access type (no_access, read_only)

Source-XMS-ID Source XMS name and index

Source-Cluster-ID Source cluster name and index

Source-CG-ID Source Consistency Group name and index

Target-XMS-ID Target XMS name and index

Target-Cluster-ID Target cluster name and index

Target-CG-ID Target Consistency Group name and index

Num-Of-Vols Number of replicated Volumes

RPO Recovery Point Objective (in seconds)

Protection-Window-Num-Co The total number of protection copies retained at the target cluster
pies

Protection-Window-Duratio The longest time a protection copy is configured to be retained at

n-in-Days the target cluster

Data Protection 241

Admin CLI Commands

Output Parameter Description

Source-Retention-Policy-ID Source Retention Policy name and index

Target-Retention-Policy-ID Target Retention Policy name and index

Number-of-Target-PITs Number of PITs on the target cluster

Target-PIT-Num-Copies-Stat Indicates whether the number of PITs on the target cluster matches
us user configuration

Target-PIT-Window-size-Stat Indicates whether the target protection window size matches user
us configuration

Number-of-Source-PITs Number of PITs on the source cluster

Cycle-Time-Remaining Number of seconds remaining for current cycle

Cycle-Percent-Remaining Percent of cycle remaining for current cycle

Next-Scheduled-Cycle Date and time of next scheduled cycle

Replication-Mode Remote Protection Session mode

Lag The time that passed since the last consistent PIT was replicated (in
seconds)

BW Bandwith (KB/sec)

Transfer-Efficiency-Ratio Indicates the efficiency of the Remote Protection Session

Cycle-Start-Time Cycle start time

Last-Cycle-Start-Time Last cycle start time

Last-Cycle-Completed-Snap The most recent completed PIT that exists in the target cluster
shot-Set

Last-Cycle-Duration Last Remote Protection Session cycle duration (in seconds)

Last-Cycle-Link-BW Last Remote Protection Session cycle link bandwidth (KB/Sec)

Last-Cycle-Effective-Bandwi The effective bandwidth on the link

dth

Last-Cycle-Transfer-Efficienc Indicates the Remote Protection Session efficiency

y-Ratio

Cycle-Number The current cycle for the Remote Protection Session

Num-Missing-Short-Period- The number of Snapshot Sets that are missing on the source cluster
Snapshot-Sets according to the configured short period of the Retention Policy for
this Remote Protection Session

Num-Missing-Middle-Period The number of Snapshot Sets that are missing on the source cluster
-Snapshot-Sets according to the configured middle period of the Retention Policy
for this Remote Protection Session

Num-Missing-Long-Perios-S The number of Snapshot Sets that are missing on the source cluster
napshot-Sets according to the configured long period of the Retention Policy for
this Remote Protection Session

Target-Missing-PITs-Alert Indicates whether generation of alerts and events for missing PITs
is enabled or disabled.

Test-Copy-Mode Indicates whether the Remote Protection Session currently has a

PIT that is used as test copy.

242 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

Current-Command-Name The name of the last command applied

Current-Command-Status Indicates the status of the last command applied to the Remote
Protection Session.

Replication-Session-Consist The state of this Remote Protection Session from XMS point of view.
ency-State

Obj-Severity The Remote Protection Session severity level based on the severity
of all current alerts

Current-Protection-Window- The actual total number of PITs retained on the Protection Session
Copies

protection-window-complia Indicates whether missing PITs alers are enabled or disabled.

nce-alert

Async-BW-Limit The maximum bandwidth that may be utilized for this async
Replication Session (mbps)

show-remote-protection-sessions
The show-remote-protection-sessions admin-level command displays the
parameters of all Remote Protection Sessions.
Usage:
show-remote-protection-sessions [ filter=<> ] [ prop-list=<List
of property strings> ]

Input Parameter Description Value Mandatory

filter Filters the command See “Using Filters” on No

output page 11.

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Data Protection 243

Admin CLI Commands

Example:
show-remote-protection-sessions

Output Parameter Description

Name The Remote Protection Session name

Index The Remote Protection Session Index

Replication-State The status of the Remote Protection Session

Source-Cluster-ID Source cluster name index

Source-CG-ID Source Consistency Group name and index

Target-Cluster-ID Target cluster name and index

Target-CG-ID Target Consistency Group name and index

Lag The time that passed since the last consistent PIT was replicated (in
seconds)

RPO Recovery Point Objective (in seconds)

Target-Policy-ID Target policy name and index

Cycle-Percent-Remaining The percentage of the Remote Protection Session cycle that

remains to be transferred

add-remote-protection-volume-pair
The add-remote-protection-volume-pair admin-level command pairs a source
and target Volumes and adds them to the Remote Protection Session.
Usage:
add-remote-protection-volume-pair source-vol-id=<Name or Index>
target-vol-id=<Name or Index> source-cluster-id=<Name or Index>
target-cluster-id=<Name or Index> protection-session-id=<Name
or Index> [ source-xms-name=<name> ] [ target-xms-name=<name> ]
[ volume-pair-name=<String> ]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

protection-session-id Remote Protection Name or Index Yes

Session ID

source-cluster-id Source cluster ID Name or Index Yes

source-vol-id Source Volume ID Name or Index Yes

target-cluster-id Target cluster ID Name or Index Yes

target-vol-id Target Volume ID Name or Index Yes

244 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Input Parameter Description Value Mandatory

source-xms-name Source XMS name Name No

target-xms-name Target XMS name Name No

volume-pair-name Volume pair name String No

Example:
add-remote-protection-volume-pair protection-session-id=1
source-cluster-id="SourceCluster" source-vol-id=25
target-cluster-id="TargetCluster" target-vol-id=32

remove-remote-protection-volume-pairs
The remove-remote-protection-volume-pairs admin-level command removes
a Volume pair from the Remote Protection Session.
Usage:
remove-remote-protection-volume-pairs volume-pair-list=<list of
IDs: Name or Index> [ force ]

NOTE! The following property is mandatory: [volume-pair-list]

Input Parameter Description Value Mandatory

volume-pair-list Volume Pair ID list List of IDs: Name or Yes

Index

force Force remove N/A No

Example:
remove-remote-protection-volume-pairs
volume-pair-list=["VolPair1", "VolPair2"]

show-remote-protection-volume-pair
The show-remote-protection-volume-pair admin-level command displays the
properties of a Volume pair.
Usage:
show-remote-protection-volume-pair volume-pair-id=<Name or
Index> [ prop-list=<List of property strings> ]
NOTE! The following property is mandatory: [ volume-pair-id ]

Input Parameter Description Value Mandatory

volume-pair-id Volume Pair RM ID Name or Index Yes

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Data Protection 245

Admin CLI Commands

Example:
show-remote-protection-volume-pair volume-pair-id=10

Output Parameter Description

Name The Volume pair name

Index The Volume pair index

Replication-Session-Pairing- Remote Protection Session pairing label name and index

Label-ID

Volume--Pair-Pairing-Label-I An object ID of the Volume Pair within RM domain

D

Source-XMS-ID Source XMS index

Source-Cluster-ID Source cluster index

Source-Volume-Pair-ID Source Volume Pair index

Source-Volume-ID Source Volume index

Target-XMS-ID Target XMS index

Target-Cluster-ID Target Cluster name and index

Target-Volume-Pair-ID Target Volume pair index

Target-Volume-ID Target Volume index

Volume-Pair-Consistency-St The state of this Volume Pair from

ate

Certainty Indicates whether the Replication Manager is synchronized with the

system.

show-remote-protection-volume-pairs
The show-remote-protection-volume-pairs admin-level command displays the
properties of all Volume pair of a Remote Protection Session.
Usage:
show-remote-protection-volume-pairs [
protection-session-id=<Name or Index> ]

Input Parameter Description Value Mandatory

protection-session-id Remote Protection Name or Index No

Session ID

246 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:
show-remote-protection-volume-pairs

Output Parameter Description

Name The Volume pair name

Index The Volume pair index

Replication-Session-Pairing- Remote Protection Session pairing label name and index

Label-ID

Volume--Pair-Pairing-Label-I An object ID of the Volume Pair within RM domain

D

Source-XMS-ID Source XMS index

Source-Cluster-ID Source cluster index

Source-Volume-Pair-ID Source Volume Pair index

Source-Volume-ID Source Volume index

Target-XMS-ID Target XMS index

Target-Cluster-ID Target Cluster name and index

Target-Volume-Pair-ID Target Volume pair index

Target-Volume-ID Target Volume index

Volume-Pair-Consistency-St The state of this Volume Pair

ate

Obj-Severity The Volume pair object severity level based on the severity of all
current alerts

Certainty Indicates whether the Replication Manager is synchronized with the

system.

Data Protection 247

Admin CLI Commands

modify-remote-protection-snapshot-set
The modify-remote-protection-snapshot-set admin-level command modifies
the name of a Protection Snapshot Set.
Usage:
modify-remote-protection-snapshot-set new-name=<string>
cluster-id=<Name or Index> [ ( snapshot-set-id=<Name or Index>
) ] [ xms-name=<name> ]
NOTE! The following properties are mandatory [cluster-id,
new-name]
NOTE! At least on property from the following list is mandatory
[snapshot-set-id]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

new-name New Snapshot Set String Yes

name

cluster-id Cluster ID Name or Index Yes

snapshot-set-id Snapshot Set ID Name or Index At least one of the

following parameters
must be selected:
• snapshot-set-id

xms-name XMS name Name No

Example:
modify-remote-protection-snapshot-set new-name="ProtCopy2"
cluster-id="MyCluster" snapshot-set-id=25

248 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-remote-protection-snapshot-set
The show-remote-protection-snapshot-set admin-level command displays the
properties of a Remote Protection Session Snapshot Set.
Usage:
show-remote-protection-snapshot-set cluster-id=<Name or Index>
snapshot-set-id=<Name or Index> [ xms-name=<name> ]
NOTE! The following properties are mandatory [ cluster-id,
snapshot-set-id ]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index Yes

snapshot-set-id Snapshot Set ID Name or Index Yes

xms-name XMS name Name No

Example:
show-remote-protection-snapshot-set cluster-id="MyCluster"
snapshot-set-id=12

Output Parameter Description

Name The Snapshot Set name

Index The Snapshot Set index

Creation-Time The Snapshot Set creation date and time

XMS-ID The XMS ID

Cluster-ID The cluster name and Index

Num-Of-Vols The number of Volumes in the Snapshot Set

Created-By-App Indicates the application that initiated the creation of the Snapshot
Set

Vol-List Snapshot Set Volume list

Replication-State The status of the Remote Protection Session

Session-Owner-ID ID of the session owner

Data Protection 249

Admin CLI Commands

show-remote-protection-snapshot-sets
The show-remote-protection-snapshot-sets admin-level command displays
the PITs of a Remote Protection Session.
Usage:
show-remote-protection-snapshot-sets
protection-session-id=<Name or Index> ( role=<target, source,
both> ) ( cluster-id=<Name or Index> ) [ from-time=<date/time
format e.g. "2018-01-24 09:53:23"> ] [ to-time=<date/time
format e.g. "2018-01-24 09:53:23"> ] [ xms-name=<name> ]
NOTE! The following property is mandatory [
protection-session-id ]
NOTE! Only one property from the following list is allowed [
role ]
NOTE! Only one property from the following list is allowed [
cluster-id ]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

protection-session-id Remote Protection Name or Index Yes

Session ID

cluster-id Cluster ID Name or Index No

from-time From local date/time date/time format e.g. No

"2018-01-24
09:53:23"

role Remote Protection target, source, both No

Session role

to-time To local date/time date/time format e.g. No

"2018-01-24
09:53:23"

xms-name XMS name Name No

Example:
show-remote-protection-snapshot-sets protection-session-id=5

Output Parameter Description

Name Snapshot Set Name

Index Snapshot Set index

Creation-Time The Snapshot Set creation date and time

XMS-ID The XMS ID

Cluster-ID The cluster name and Index

250 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

Created-By-App Indicates the application that initiated the creation of the Snapshot
Set

Replication-State The status of the Remote Protection Session

Session-Owner-ID ID of the session owner

show-remote-protection-consistency-group
The show-remote-protection-consistency-group admin-level command
displays the properties of a Remote Protection Session Consistency Group.
Usage:
show-remote-protection-consistency-group cg-id=<Name or Index>
cluster-id=<Name or Index> [ xms-name=<name> ]
NOTE! The following properties are mandatory [ cg-id,
cluster-id ]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

cg-id Consistency Group ID Name or Index Yes

cluster-id Cluster ID Name or Index Yes

xms-name XMS name Name No

Example:
show-remote-protection-consistency-group cluster-id="MyCluster"
cg-id=5

Output Parameter Description

Name The Consistency Group name

Index The Consistency Group index

Cluster-Name The cluster name

Index The cluster index

Num-Of-Snapshot-Sets Number of created Snapshot Sets

Num-Of-Vols The number of Volumes in the Consistency Group

Volume-List Consistency Group Volume list

Tag-List List of Tags

Created-By-Application Indicates the application that initiated the creation of the

Consistency Group.

Data Protection 251

Admin CLI Commands

Output Parameter Description

Certainty Indicates whether the Replication Manager is synchronized with the

system.

Creation-Time Date and Time of Consistency Group creation

Last-Refresh-Time Date and time of last refresh

Last-Refresh-From-Object-N The name of the object used to refresh this Consistency Group
ame

Num-Replication-Sessions Number of Remote Protection Sessions for the Consistency Group

show-remote-protection-consistency-groups
The show-remote-protection-consistency-groups admin-level command
displays the properties of all Remote Protection Session Consistency Groups.
Usage:
show-remote-protection-consistency-groups cluster-id=<Name or
Index> [ xms-name=<name> ]
NOTE! The following property is mandatory [ cluster-id ]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index Yes

xms-name XMS name Name No

Example:
show-remote-protection-consistency-groups
cluster-id="MyCluster"

Output Parameter Description

Name The Consistency Group name

Index The Consistency Group index

Cluster-Name The cluster name

Index The cluster index

Num-Of-Snapshot-Sets Number of created Snapshot Sets

Num-Of-Vols The number of Volumes in the Consistency Group

Created-By-Application Indicates the application that initiated the creation of the

Consistency Group.

Certainty Indicates whether the Replication Manager is synchronized with the

system.

252 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

Tag-List List of Tags

Creation-Time Date and Time of Consistency Group creation

Last-Refresh-Time Date and time of last refresh

Last-Refresh-From-Object-N The name of the object used to refresh this Consistency Group
ame

show-remote-protection-volume
The show-remote-protection-volume admin-level command displays the
properties of a Volume that is a part of a Remote Protection Session.
Usage:
show-remote-protection-volume cluster-id=<Name or Index>
volume-id=<Name or Index> [ xms-name=<name> ]
NOTE! The following properties are mandatory [ volume-id,
cluster-id ]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index Yes

volume-id Volume ID Name or Index Yes

xms-name XMS name Name No

Example:
show-remote-protection-volume cluster-id="MyCluster"
volume-id=30

Output Parameter Description

Name The Volume name

Index The Volume index

Vol-Size The Volume size

LB-Size The Logical Block size

Logical-Space-In-Use The amount of logical disk space in the Volume

Alignment-Offset Alignment offset of the Volume according to block size

Created-From-Volume The Volume that was the Snapshot source for this Volume

VSG-Index Index of the Volumes Volume Snapshot Group

Cluster-Name The cluster name

Data Protection 253

Admin CLI Commands

Output Parameter Description

Index The cluster index

Small-IO-Alerts Indicates whether small I/O alerts are enabled.

Unaligned-IO-Alerts Indicates whether unaligned I/O alerts are enabled.

VAAI-TP-Alerts Indicates whether VAAI TP alerts are enabled.

Total-Writes The total number of write operations written to a Volume

Total-Reads The total number of read operations on a Volume

Created-By-App The application that created the Volume (XMS, Remote Protection)

Volume-Type The Volume type (regular or read-only)

NAA-Name The name assigned to this Volume by the Network Address

Authority

Certainty Indicates whether the Replication Manager is synchronized with the

system.

Tag-List List of Tags assigned to this Volume

Creation-Time Date and time of Volume creation

Volume-Access The Volume access level (read_access, write_access, no_access)

Management-Locked Indicates whether the Volume is management-locked.

Last-Refresh-Time The most recent date and time on which the Volume was refreshed

show-remote-protection-volumes
The show-remote-protection-volumes admin-level command displays the
properties of all Volumes included in a specified Consistency Group that is part of a
Remote Protection Session (can be applied to source cluster or target cluster).
Usage:
show-remote-protection-volumes cg-id=<Name or Index>
cluster-id=<Name or Index> [ xms-name=<Name> ]
NOTE! The following properties are mandatory [cg-id,
cluster-id]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

cg-id Consistency Group ID Name or Index Yes

cluster-id Cluster ID Name or Index Yes

xms-name XMS name Name No

254 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:
show-remote-protection-volumes cluster-id="MyCluster"
cg-id="MyCG"

Output Parameter Description

Name The Volume name

Index The Volume index

Cluster-Name The cluster name

Index The cluster index

Vol-Size The Volume size

LB-Size The Logical Block size

Logical-Space-In-Use The amount of logical disk space in the Volume

Alignment-Offset Alignment offset of the Volume according to block size

Created-From-Volume The Volume that was the Snapshot source for this Volume

VSG-Index Index of the Volumes Volume Snapshot Group

Small-IO-Alerts Indicates whether small I/O alerts are enabled.

Unaligned-IO-Alerts Indicates whether unaligned I/O alerts are enabled.

VAAI-TP-Alerts Indicates whether VAAI TP alerts are enabled.

Total-Writes The total number of write operations written to a Volume

Total-Reads The total number of read operations on a Volume

NAA-Name The name assigned to this Volume by the Network Address

Authority

Certainty Indicates whether the Replication Manager is synchronized with the

system.

Created-By-Application The application that created the Volume (XMS, Remote Protection)

Volume-Type The Volume type (regular or read-only)

Creation-Time Date and time of Volume creation

Volume-Access The Volume access level (read_access, write_access, no_access)

Tag-List List of Tags assigned to this Volume

Data Protection 255

Admin CLI Commands

show-remote-protection-clusters
The show-remote-protection-clusters admin-level command displays all
clusters managed either by local or remote XMS and can be used for Remote Protection.
Usage:
show-remote-protection-clusters
Example:
show-remote-protection-clusters

Output Parameter Description

Name The XMS name

Index The cluster index

Cluster-Id The cluster name

PSNT-Serial-Number Cluster PSNT number

Num-Remote-Replication-Se Number of Remote Protection Sessions

ssions

Number-Of-Links Number of links

Cluster-Connectivity-State Cluster connectivity status

Cluster-Active-Status Cluster activity status

show-remote-protection-domain
The show-remote-protection-domain admin-level command displays the
replication domain.
Usage:
show-remote-protection-domain
Example:
show-remote-protection-domain

Output Parameter Description

XMS-Name The XMS name

XMS-IP-Address The XMS IP address

Num-Replication-Sessions Number of Remote Protection Sessions

Number-Of-Links Number of links

256 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-remote-protection-ports
The show-remote-protection-ports admin-level command displays all ports
configured as Remote Protection Session targets.
Usage:
show-remote-protection-ports cluster-id=<Name or Index> [
xms-name=<name> ]
NOTE! The following property is mandatory [ cluster-id ]
NOTE! When providing the cluster index as the cluster-id
parameter, it is required to provide the xms-name parameter as
well; alternatively, it is possible to provide the cluster name
as cluster-id.

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index Yes

xms-name XMS name Name No

Example:
show-remote-protection-ports cluster-id="MyCluster"

Output Parameter Description

Cluster-Name Cluster name

Index Cluster index

Name Port name

Index Port index

Port-Address Port address

Port-State Port Status (up or down)

Number-Of-Links Number of links

Data Protection 257

Admin CLI Commands

Cluster Data and Status

Notifications

add-event-handler-definition
The add-event-handler-definition admin-level command adds a new event
handling rule.
Usage:
add-event-handler-definition actions=<List of actions to
perform: email, snmp, syslog> category=<event category list:
'audit', 'state_change', 'hardware', 'user_threshold',
'activity', 'security', 'software'> severity=<severity level
list: 'information', 'clear', 'critical', 'major', 'minor'> [
related-alert-code=<Alert code number> ] [ entity-details=<name
or index> ] [ entity=<string> ] [ disable ] [ enable ]

Input Parameter Description Value Mandatory

actions Action list email, snmp, syslog Yes

category Event category list ’audit’, Yes

’state_change’,
’hardware’,
’user_threshold’,
’activity’, ’security’,
’software’

severity Severity level list ’information’, ’clear’, Yes

’major’, ’critical’,
’minor’

cluster-id Cluster ID Name or Index No

disable Disables event N/A No

handler

enable Enables event handler N/A No

258 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Input Parameter Description Value Mandatory

entity Entity name InitiatorGroup, No

InfinibandSwitchPSU,
UserAccount, Alert,
Xms, DAE, X-Brick,
Volume, D
AELCC, LocalDisk,
Scheduler,
VolumeSnapshotGrou
p,
StorageControllerPSU,
TargetGroup, DAEPSU,
Initiator, Target,
StorageController,
DataProtectionGroup,
InfinibandSwitch, Ale
rtDefinition,
SnapshotSet,
BatteryBackupUnit,
IscsiRoute, XEnv,
IscsiPortal, Module,
Cluster, SSD,
ConsistencyGroup

entity-details Entity Id Name or index No

related-alert-code Related alert code Alert code number No

number

Example:
add-event-handler-definition category=["audit","hardware"]
actions=["email"] severity=["clear","major"]

Cluster Data and Status 259

Admin CLI Commands

modify-event-handler-definition
The modify-event-handler-definition admin-level command modifies an event
handling rule.
Usage:
modify-event-handler-definition event-handler-id=<ID> (
actions=<List of actions to perform: email, snmp, syslog> |
category=<Event category list: 'audit', 'state_change',
’notification’, 'hardware', 'user_threshold', 'activity',
'security', 'software'> | severity=<Severity level list:
'information', 'clear', 'critical', 'major', 'minor'> |
entity=<string> | entity-details=<name or index> |
cluster-id=<name or index> | related-alert-code=<Alert code
number> | disable | enable )
NOTE! The following property is mandatory: event-handler-id
NOTE! At least one property from the following list is
mandatory: actions, category, disable, enable, severity,
entity, entity-details, related-alert-code, cluster-id.

Input Parameter Description Value Mandatory

event-handler-id Event handler ID ID Yes

260 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Input Parameter Description Value Mandatory

actions Action list List of actions to At least one of the

perform: email, snmp, following parameters
syslog must be selected:
• actions
category Event category list ’audit’,
• category
’state_change’,
’notification’, • disable
’hardware’, • enable
’user_threshold’, • entity
’activity’, ’security’, • entity-details
’software’
• related-alert-code
disable Disables event N/A • severity
handler • cluster-id

enable Enables event handler N/A

entity Entity type InitiatorGroup,

InfinibandSwitchPSU,
UserAccount, Alert,
Xms, DAE, X-Brick,
Volume, DAELCC,
LocalDisk, Scheduler,
VolumeSnapshotGrou
p,
StorageControllerPSU,
TargetGroup, DAEPSU,
Initiator, Target,
StorageController,
DataProtectionGroup,
InfinibandSwitch,
AlertDefinition,
SnapshotSet,
BatteryBackupUnit,
IscsiRoute, XEnv,
IscsiPortal, Module,
Cluster, SSD,
ConsistencyGroup

entity-details Entity ID Name or index

related-alert-code Related Alert Code Alert code number

severity Severity level list ’information’, ’clear’,

’major’, ’critical’,
’minor’

cluster-id Cluster ID Name or Index

Example:
modify-event-handler-definition event-handler-id=38
severity=["critical","major"] enable

Cluster Data and Status 261

Admin CLI Commands

remove-event-handler-definition
The remove-event-handler-definition admin-level command removes an event
handling rule.
Usage:
remove-event-handler-definition event-handler-id=<ID>

Input Parameter Description Value Mandatory

event-handler-id Event handler ID ID Yes

Example:
remove-event-handler-definition event-handler-id=11

show-event-handler-definitions
The show-event-handler-definitions admin-level command displays the
existing event handling rules.
Usage:
show-event-handler-definitions
Example
show-event-handler-definitions

Output Parameter Description

ID Event’s ID

Actions Event’s action (Email, SNMP, Syslog)

category Event’s category (audit, state_change, hardware, user_threshold,

activity, security, software)

Severity Event’s severity level (Information, Clear, Major, Critical, Minor)

Entity Event’s associated entity

Entity-Details Entity’s details

Related-Alert-Code The related alert code

Type The event handler’s creator (System or User)

Enabled True, False

262 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-event-details
The show-event-details admin-level command displays the details of the specified
event.
Usage:
show-event-details event-id=<positive integer> [ full-object ]

Input Parameter Description Value Mandatory

event-id Event ID Positive Integer Yes

full-object Full Object N/A No

Example:

show-event-details event-id=1

Output Parameter Description

Event-ID Event ID as specified in the input

Date/Time Date and time of the event

Event-Code Event code

Related-Alert-Code Related alert code

Category Event category

Severity Event severity level

Entity The entity to which the event refers

Entity-Details Entity details

Description Event description

Related-Events Events related to the detailed event

User The name of the user that invoked the operation

User-Location The location (IP address) of the user that invoked the operation

User-Type The type of access the user used

Cluster Data and Status 263

Admin CLI Commands

show-events
The show-events admin-level command displays cluster and XMS events.
Usage:
show-events [ cluster-id=<name or index> ] [ vertical ] [
from-event-id=<positive integer> ] [ entity=<string> ] [
from-date-time=<date/time format: "2013-11-23", "2013-11-23
10:14:15", "2013-11-23 10:14:15.123"> ] [ category=<'audit',
'state_change', 'notification' 'hardware', 'user_threshold',
'activity', 'security', 'software'> ] [
severity=<'information', 'clear', 'critical', 'major', 'minor'>
] [ free-text=<text string> ] [ entity-details=<name or index>
] [ limit=<positive integer> ] [ to-date-time=<date/time
format: "2013-11-23", "2013-11-23 10:14:15", "2013-11-23
10:14:15.123"> ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Is Mandatory

category Event category ’audit’, No

’state_change’,
’notification’,
’hardware’,
’user_threshold’,
’activity’, ’security’,
’software’

cluster-id Cluster ID Name or Index No

entity Event’s associated BatteryBackupUnit, No

entity Cluster,
ConsistnecyGroup,
DAEController,
DAEPSU,
DAERowController,
DataProtectionGroup,
InfinibandSwitch,
InfinibandSwitchPSU,
Initiator,
InitiatorGroup,
IscsiPortal, IscsiRoute,
LocalDisk,
LocalProtection,
Module, NVRAM, SSD,
Scheduler,
SnapshotSet,
StorageController,
StorageControllerPSU,
SyrNotifier, Target,
TargetGroup,
UserAccount, Volume,
VolumeSnapshotGrou
p, X-Brick, Xenv, Xms

entity-details Object ID Name or index No

free-text Free text search String No

264 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Input Parameter Description Value Is Mandatory

from-date-time Date and time start date/time format: No

point "2013-11-23","2013-1
1-23 10:14:15"
"2013-11-23
10:14:15.123"

from-event-id Shows events Positive integer No

following this event id.

limit Maximum number of Integer No

records to display that
adhere to all the filter
criteria

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

severity Severity level Information, Clear, No

Major, Critical, Minor

to-date-time Date and time end date/time format: No

time "2013-11-23","2013-1
1-23 10:14:15"
"2013-11-23
10:14:15.123"

vertical Displays the command vertical No

output in a (e.g. show-events
non-tabular format vertical)
(vertical lines).

Example:

show-events

Output Parameter Description

Event ID Event Index number

Date/Time Date and time of the event

Event Code Event code

Related Alert Code Related alert code

Category Event category

Severity Event severity level

Cluster ID Cluster Index Number

Entity The entity to which the event refers

Entity Details Entity details

Description Event description

Cluster Data and Status 265

Admin CLI Commands

acknowledge-alert
The acknowledge-alert admin-level command acknowledges an active alert.
Usage:
acknowledge-alert alert-id=<name or index>

Input Parameter Description Value Mandatory

alert-id Index number of the Name or index Yes

alert to acknowledge

Example:
acknowledge-alert alert-id=1

modify-alert-definition
The modify-alert-definition admin-level command modifies the default
parameters of a defined alert type.
Usage:
modify-alert-definition alert-type=<Alert Type> (
send-to-call-home=<Send SYR notification upon raise> |
severity=<'information', 'clear', 'critical', 'major', 'minor'>
| activity-mode=<'disabled', 'enabled'> |
clearance-mode=<'auto_clear', 'ack_required'> |
threshold=<range 0-100> )
NOTE! At least one property from the following list is
mandatory: activity-mode, clearance-mode, severity,
send-to-call-home, threshold.

Input Parameter Description Value Mandatory

alert-type Alert type All defined alerts Yes

activity-mode Monitor duration ’disabled’, ’enabled’ At least one of the

following parameters
clearance-mode Clearance mode ’auto-clear’, must be selected:
’ack-required’ • activity-mode
send-to-call-home Send to Call-Home yes, no • clearance-mode
• send-to-call-home
severity Severity level ’information’, ’minor’, • severity
’major’, ’critical’ • threshold
threshold Threshold value Range 0 - 100

Example:
modify-alert-definition alert-type="disk_empty"
activity-mode=enabled threshold=80

266 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-alert-definitions
The show-alert-definitions admin-level command displays a list of pre-defined
alerts and their definitions.
Usage:
show-alert-definitions [ duration=<seconds> ] [
frequency=<seconds> ]

Input Parameter Description Value Mandatory

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

Example:
show-alert-definitions

Output Parameter Description

Alert-Type The alert’s type

Short-Description The alert’s description

Activity-Mode Indicates whether to issue an alert upon state change.

Clearance-Mode The alert’s clearance mode:

• Acknowledgment required
• Auto clear

Severity If no threshold is defined, it indicates the alert severity level.

Alert-Code The alert’s unique code

Send-To-Call-Home Sends SYR notification when the alert is raised.

User-Modified Indicates that the alert definition was modified by the user.

Threshold The threshold set for sending the alert

Threshold-Type The threshold type

Cluster Data and Status 267

Admin CLI Commands

show-alerts
The show-alerts admin-level command displays a list of active alerts and their details.
Usage:
show-alerts [ duration=<seconds> ] [ cluster-id=<id: name or
index> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-alerts

Output Parameter Description

Index The alert’s ID

Description The alert’s description

Severity The alert’s severity level (Information, Major, Critical, or Minor)

Raise-Time The date and time on which the alert was raised

Entity The cluster component to which the alert refers

Name The component’s name

Index The component’s index number

Cluster-Name The cluster’s name

Index The cluster’s index

Alert-Type The alert’s type

State The alert’s status

Alert-Code The alerts code number

268 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-advisory-notice
The show-advisory-notice admin-level command displays the details of the
specified Advisory Notice.
Usage:
show-advisory-notice advisory-notice-id=<name or index> [
duration=<seconds> ] [ cluster-id=<id: name or index> ] [
frequency=<seconds> ] [ vertical ]

Input Parameter Description Value Mandatory

advisory-notice-id Advisory Notice ID Name or Index Yes

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

Example:
show-advisory-notice advisory-notice-id=12 vertical

Output Parameter Description

Index The Advisory Notice’s Index number

Notice-Category The Advisory Notice’s category (cluster_sw, document, message)

Advisory-Text The Advisory Notice’s text

Advisory-Notice-State The Advisory Notice’s status (outstanding, acknowledged)

Creation-Time The date and time on which the Advisory Notice was created

Associated-Cluster-Id The associated cluster’s index number

Associated-Cluster-Psnt The associated cluster’s PSNT

Download-Completion-St Completion status of the download process (if exists)

ate

Cluster Data and Status 269

Admin CLI Commands

show-advisory-notices
The show-advisory-notices admin-level command displays a list of outstanding
Advisory Notices and their details.
Usage:
show-advisory-notices [ all ] [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

all Show all Advisory N/A No

Notices (including
acknowledged and
outdated notices)

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

filter Filter command output See “Using Filters” on No

page 11.

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters “Specifying Output
Parameters” on
page 12.

Example:
show-advisory-notices all

Output Parameter Description

Index The Advisory Notice’s Index number

Notice-Category The Advisory Notice’s category (cluster_sw, document, message)

Advisory-Text The Advisory Notice’s text

Advisory-Notice-State The Advisory Notice’s status (outstanding, acknowledged)

Creation-Time The date and time on which the Advisory Notice was created

Associated-Cluster-Id The associated cluster’s index number

Associated-Cluster-Psnt The associated cluster’s PSNT

Download-Completion-St Completion status of the download process (if exists)

ate

270 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

acknowledge-advisory-notice
The acknowledge-advisory-notice admin-level command acknowledges an
Advisory Notice.
Usage:
acknowledge-advisory-notice advisory-notice-id=<name or index>
[ cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

advisory-notice-id Index number of the Name or Index Yes

Advisory Notice to
acknowledge

cluster-id Cluster ID Name or Index No

Example:
acknowledge-advisory-notice advisory-notice-id=1

refresh-advisory-notices
The refresh-advisory-notices admin-level command queries for new Advisory
Notices and refreshes the displayed list.
Usage:
refresh-advisory-notices [ cluster-id=<id: name or index> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

Example:
refresh-advisory-notices cluster-id=1

Cluster Data and Status 271

Admin CLI Commands

Performance

modify-performance-data-collection
The modify-performance-data-collection admin-level command modifies the
Performance Data Collection mode of specified Volumes.
Usage:
modify-performance-data-collection-mode
collection-mode=<enabled, inherit_cluster_mode> vol-list=<list
of ids: name or index> [ cluster-id=<name or index> ]
Note! The following properties are mandatory: collection-mode,
vol-list

Input Parameter Description Value Mandatory

collection-mode Performance Data enabled, Yes

Collection mode inherit_cluster_mode

vol-list Object ID list List of ids: name or Yes

index

cluster-id Cluster ID Name or index No

vol-list=["vol1","testvol"]

272 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

export-performance-history
The export-performance-history admin-level command exports the cluster’s
performance history to CSV file. The exported data can be up to seven days back. Records
interval is five seconds.
Usage:
export-performance-history [ utc ] [ filename=<string> ] [
cluster-id=<name or index> ]

Input Parameter Description Value Mandatory

filename Name of the export file String No

utc Timestamps in UTC or N/A No

local time

cluster-id Cluster ID Name or index No

The exported data consists of the following fields:

Field Description

Date-Time Date and time of the system reading. Readings are

collected in 5 seconds granularity.

Write-BW (KB) The total Write Bandwidth (in KB) over the sampling
period

Read-BW (KB) The total Read Bandwidth (in KB) over the sampling
period

Write-IOPs The Write IOPS over the sampling period

Read-IOPs The Read IOPS over the sampling period

Write-Latency (usec) The average write latency over the sampling period

Read-Latency (usec) The average read latency over the sampling period

Avg-Latency (usec) The average latency, which is a weighted average

between read latency and write latency, over the
sampling period

Example:
export-performance-history filename="historyBrik1" utc

Cluster Data and Status 273

Admin CLI Commands

show-clusters-performance
The show-clusters-performance admin-level command displays clusters’
performance data.
Usage:
show-clusters-performance [cluster-id=<id: name or index> ] [
duration=<seconds> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-clusters-performance duration=300 frequency=10

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

Write-BW (MB/s)

Read-BW (MB/s)

Write-IOPS

Read-IOPS
These properties indicate the current Bandwidth/IOPS.
BW (MB/s)

IOPS

Total-Write-IOs

Total-Read-IOs

274 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-clusters-performance-latency
The show-clusters-performance-latency admin-level command displays
clusters’ performance latency data. The command’s output is broken-down by I/O size.
Usage:
show-clusters-performance-latency [cluster-id=<id: name or
index> ] [ duration=<seconds> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-clusters-performance-latency

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

Write-Latency The latency for write operations (in μsec)

Read-Latency The latency for read operations (in μsec)

Avg-Latency The average latency (in μsec)

Cluster Data and Status 275

Admin CLI Commands

show-clusters-performance-small
The show-clusters-performance-small admin-level command displays clusters’
performance data for small blocks.

Note: Small blocks refer to blocks smaller than 16KB for X2 cluster type and smaller than
8KB for X1 cluster type.

Usage:
show-clusters-performance-small [cluster-id=<id: name or index>
] [ duration=<seconds> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-clusters-performance-small

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

S-Write-BW (MB/s)

S-Read-BW (MB/s)

S-Write-IOPS

S-Read-IOPS These properties indicate the current Bandwidth/IOPS of I/Os

which are smaller than 16KB for X2 cluster type or smaller than 8KB
S-BW (MB/s) for X1 cluster type.

S-IOPS

Total-S-Write-IOs

Total-S-Read-IOs

276 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-clusters-performance-unaligned
The show-clusters-performance-unaligned admin-level command displays
clusters’ performance data for unaligned blocks.

Note: Unaligned blocks refer to blocks unaligned to 16KB offsets for X2 cluster type and to
blocks unaligned to 8KB offsets for X1 cluster type.

Usage:
show-clusters-performance-unaligned [cluster-id=<id: name or
index> ] [ duration=<seconds> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-clusters-performance-unaligned

Output Parameter Description

Cluster-Name The cluster’s name

Index The cluster’s index number

U-Write-BW (MB/s)

U-Read-BW (MB/s)

U-Write-IOPS
These properties indicate the current Bandwidth/IOPS of I/Os
U-Read-IOPS
which are not aligned with 16KB for X2 cluster type or not aligned
with 8KB for X1 cluster type when a single host I/O request results
U-BW (MB/s)
in multiple internal requests.
U-IOPS

Total-U-Write-IOs

Total-U-Read-IOs

Cluster Data and Status 277

Admin CLI Commands

show-initiator-groups-performance
The show-initiator-groups-performance admin-level command displays
Initiator Groups’ performance data.
Usage:
show-initiator-groups-performance [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-initiator-groups-performance

Output Parameter Description

IG-Name Initiator Group name

Index Initiator Group index

Cluster-Name The Cluster’s name

Index The Cluster’s index number

Write-BW (MB/s)

Write-IOPS

Read-BW (MB/s)

Read-IOPS

BW (MB/s)
These properties indicate current Bandwidth/IOPS and exceeded
IOPS Bandwidth/IOPS.

Total-Write-IOs

Total-Read-IOs

QOS-Exceeded-BW

QOS-Exceeded-IOPS

278 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-initiator-groups-performance-small
The show-initiator-groups-performance-small admin-level command
displays Initiator Groups’ performance data for small blocks.

Note: Small blocks refer to blocks smaller than 16KB for X2 cluster type and smaller than
8KB for X1 cluster type.

Usage:
show-initiator-groups-performance-small [ duration=<seconds> ]
[ cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-initiator-groups-performance-small

Output Parameter Description

IG-Name The Initiator Group’s name

Index The Initiator Group’s index

Cluster-Name The Cluster’s name

Index The Cluster’s index number

S-Write-BW (MB/s)

S-Write-IOPS

S-Read-BW (MB/s)

S-Read-IOPS These properties indicate the current Bandwidth/IOPS of I/Os

which are smaller than 16KB for X2 cluster type or smaller than 8KB
S-BW (MB/s) for X1 cluster type.

S-IOPS

Total-S-Write-IOs

Total-S-Read-IOs

Cluster Data and Status 279

Admin CLI Commands

show-initiator-groups-performance-unaligned
The show-initiator-groups-performance-unaligned admin-level command
displays Initiator Groups’ performance data for unaligned blocks.

Note: Unaligned blocks refer to blocks unaligned to 16KB offsets for X2 cluster type and to
blocks unaligned to 8KB offsets for X1 cluster type.

Usage:
show-initiator-groups-performance-unaligned [
duration=<seconds> ] [ cluster-id=<id: name or index> ] [
frequency=<seconds> ] [ filter=<> ] [ prop-list=<List of
property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-initiator-groups-performance-unaligned

Output Parameter Description

IG-Name The Initiator Group’s name

Index The Initiator Group’s index

Cluster-Name The Cluster’s name

Index The Cluster’s index number

U-Write-BW (MB/s)

U-Write-IOPS

U-Read-BW (MB/s)
These properties indicate the current Bandwidth/IOPS of I/Os
U-Read-IOPS
which are not aligned with 16KB for X2 cluster type or not aligned
U-BW (MB/s) with 8KB for X1 cluster type when a single host I/O request results
in multiple internal requests.
U-IOPS

Total-U-Write-IOs

Total-U-Read-IOs

280 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-initiators-performance
The show-initiators-performance admin-level command displays Initiators’
performance data.
Usage:
show-initiators-performance [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-initiators-performance

Output Parameter Description

Initiator-Name The Initiator’s name

Index The Initiator’s index number

Write-BW (MB/s)

Write-IOPS

Read-BW (MB/s)

Read-IOPS These properties indicate the current Bandwidth/IOPS.

BW (MB/s)

IOPS

Total-Write-IOs

Total-Read-IOs

Cluster Data and Status 281

Admin CLI Commands

show-initiators-performance-small
The show-initiators-performance-small admin-level command displays
Initiators’ performance data for small block sizes.

Note: Small blocks refer to blocks smaller than 16KB for X2 cluster type and smaller than
8KB for X1 cluster type.

Usage:
show-initiators-performance-small [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

filter Filters the command See “Using Filters” on No

output page 11.

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:

show-initiators-performance-small

Output Parameter Description

Initiator-Name The Initiator’s name

Index The Initiator’s index number

S-Write-BW (MB/s)

S-Write-IOPS

S-Read-BW (MB/s)

S-Read-IOPS These properties indicate the current Bandwidth/IOPS of I/Os

which are smaller than 16KB for X2 cluster type or smaller than 8KB
S-BW (MB/s) for X1 cluster type.

S-IOPS

Total-S-Write-IOs

Total-S-Read-IOs

282 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-initiators-performance-unaligned
The show-initiators-performance-unaligned admin-level command displays
Initiators’ performance data for unaligned data block.

Note: Unaligned blocks refer to blocks unaligned to 16KB offsets for X2 cluster type and to
blocks unaligned to 8KB offsets for X1 cluster type.

Usage:
show-initiators-performance-unaligned [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-initiators-performance-unaligned

Output Parameter Description

Initiator-Name The Initiator’s name

Index The Initiator’s index number

u-Write-BW (MB/s)

u-Write-IOPS

u-Read-BW (MB/s)
These properties indicate the current Bandwidth/IOPS of I/Os
u-Read-IOPS
which are not aligned with 16KB for X2 cluster type or not aligned
with 8KB for X1 cluster type when a single host I/O request results
u-BW (MB/s)
in multiple internal requests.
u-IOPS

Total-U-Write-IOs

Total-U-Read-IOs

Cluster Data and Status 283

Admin CLI Commands

show-ssds-performance
The show-ssds-performance admin-level command displays SSDs’ performance
data.
Usage:
show-ssds-performance [ duration=<seconds> ] [ cluster-id=<id:
name or index> ] [ frequency=<seconds> ] [ filter=<> ] [
prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-ssds-performance

Output Parameter Description

Name The SSD’s name

Index The SSD’s index number

Cluster-Name The Cluster’s name

Index The Cluster’s index number

Write-BW (MB/s)

Read-BW (MB/s)

Write-IOPS
These properties indicate the current Bandwidth/IOPS.
Read-IOPS

BW (MB/s)

IOPS

284 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-target-groups-performance
The show-target-groups-performance admin-level command displays Target
Groups’ performance data.
Usage:
show-target-groups-performance [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-target-groups-performance

Output Parameter Description

TG-Name The Target Group’s name

Index The Target Group’s index number

Cluster-Name The Cluster’s name

Index The Cluster’s index number

Write-BW (MB/s)

Read-BW (MB/s)

Write-IOPS

Read-IOPS
These properties indicate the current Bandwidth/IOPS.
BW (MB/s)

IOPS

Total-Write-IOs

Total-Read-IOs

Cluster Data and Status 285

Admin CLI Commands

show-target-groups-performance-small
The show-target-groups-performance-small admin-level command displays
Target Groups’ performance data for small blocks.

Note: Small blocks refer to blocks smaller than 16KB for X2 cluster type and smaller than
8KB for X1 cluster type.

Usage:
show-target-groups-performance-small [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-target-groups-performance-small

Output Parameter Description

TG-Name The Target Group’s name

Index The Target Group’s index number

S-Write-BW (MB/s)

S-Read-BW (MB/s)

S-Write-IOPS

S-Read-IOPS These properties indicate the current Bandwidth/IOPS of I/Os

which are smaller than 16KB for X2 cluster type or smaller than 8KB
S-BW (MB/s) for X1 cluster type.

S-IOPS

Total-S-Write-IOs

Total-S-Read-IOs

286 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-target-groups-performance-unaligned
The show-target-groups-performance-unaligned admin-level command
displays Target Groups’ performance data for unaligned blocks.

Note: Unaligned blocks refer to blocks unaligned to 16KB offsets for X2 cluster type and to
blocks unaligned to 8KB offsets for X1 cluster type.

Usage:
show-target-groups-performance-unaligned [ duration=<seconds> ]
[ cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-target-groups-performance-unaligned

Output Parameter Description

TG-Name The Target Group’s name

Index The Target Group’s index number

U-Write-BW (MB/s)

U-Read-BW (MB/s)

U-Write-IOPS
These properties indicate the current Bandwidth/IOPS of I/Os
U-Read-IOPS
which are not aligned with 16KB for X2 cluster type or not aligned
with 8KB for X1 cluster type when a single host I/O request results
U-BW (MB/s)
in multiple internal requests.
U-IOPS

Total-U-Write-IOs

Total-U-Read-IOs

Cluster Data and Status 287

Admin CLI Commands

show-targets-performance
The show-targets-performance admin-level command displays Targets’
performance data.
Usage:
show-targets-performance [ active ] [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

active Show only active N/A No

Targets

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-targets-performance

Output Parameter Description

Name The Target’s name

Index The Target’s index number

Cluster-Name The Cluster’s name

Index The Cluster’s index number

Write-BW (MB/s)

Read-BW (MB/s)

Write-IOPS

Read-IOPS
These properties indicate the current Bandwidth/IOPS.
BW (MB/s)

IOPS

Total-Write-IOs

Total-Read-IOs

288 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-targets-performance-small
The show-targets-performance-small admin-level command displays Targets’
performance data for small blocks.

Note: Small blocks refer to blocks smaller than 16KB for X2 cluster type and smaller than
8KB for X1 cluster type.

Usage:
show-targets-performance-small [ active ] [ duration=<seconds>
] [ cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

active Shows only active N/A No

Targets.

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-targets-performance-small

Output Parameter Description

Name The Target’s name

Index The Target’s index number

Cluster-Name The Cluster’s name

Index The Cluster’s index number

Cluster Data and Status 289

Admin CLI Commands

Output Parameter Description

S-Write-BW (MB/s)

S-Read-BW (MB/s)

S-Write-IOPS

S-Read-IOPS These properties indicate the current Bandwidth/IOPS of I/Os

which are smaller than 16KB for X2 cluster type or smaller than 8KB
S-BW (MB/s) for X1 cluster type.

S-IOPS

Total-S-Write-IOs

Total-S-Read-IOs

show-targets-performance-unaligned
The show-targets-performance-unaligned admin-level command displays
Targets’ performance data for unaligned blocks.

Note: Unaligned blocks refer to blocks unaligned to 16KB offsets for X2 cluster type and to
blocks unaligned to 8KB offsets for X1 cluster type.

Usage:
show-targets-performance-unaligned [ active ] [
duration=<seconds> ] [ cluster-id=<id: name or index> ] [
frequency=<seconds> ] [ filter=<> ] [ prop-list=<List of
property strings> ]

Input Parameter Description Value Mandatory

active Shows only active N/A No

Targets.

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

290 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Example:
show-targets-performance-unaligned

Output Parameter Description

Name The Target’s name

Index The Target’s index number

Cluster-Name The Cluster’s name

Index The Cluster’s index number

U-Write-BW (MB/s)

U-Read-BW (MB/s)

U-Write-IOPS
These properties indicate the current Bandwidth/IOPS of I/Os
U-Read-IOPS which are not aligned with 16KB for X2 cluster type or not aligned
with 8KB for X1 cluster type when a single host I/O request results
U-BW (MB/s)
in multiple internal requests.
U-IOPS

Total-U-Write-IOs

Total-U-Read-IOs

Cluster Data and Status 291

Admin CLI Commands

show-volumes-performance
The show-volumes-performance admin-level command displays the Volumes’
performance data.
Usage:
show-volumes-performance [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-volumes-performance cluster-id=1

Output Parameter Description

Volume-Name The Volume’s name

Index The Volume’s index number

Cluster-Name The Cluster’s name

Index The Cluster’s index number

292 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

Write-BW (MB/s)

Read-BW (MB/s)

Write-IOPS

Read-IOPS

BW (MB/s)

IOPS

Total-Write-IOs
These properties indicate current Bandwidth/IOPS, exceeded
Total-Read-IOs Bandwidth/IOPS and Replication Bandwidth/IOPS.

QOS-Exceeded-BW

QOS-Exceeded-IOPS

Rep-Read-IOPS

Rep-Write-IOPS

Rep-Read-BW (Kbps)

Rep Write-BW (Kbps)

Cluster Data and Status 293

Admin CLI Commands

show-volumes-performance-small
The show-volumes-performance-small admin-level command displays the
Volumes’ performance data for small blocks.

Note: Small blocks refer to blocks smaller than 16KB for X2 cluster type and smaller than
8KB for X1 cluster type.

Usage:
show-volumes-performance-small [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

filter Filters the command See “Using Filters” on No

output page 11.

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:
show-volumes-performance-small cluster-id=1

Output Parameter Description

Volume-Name The Volume’s name

Index The Volume’s index number

Cluster-Name The Cluster’s name

Index The Cluster’s index number

S-Write-BW (MB/s)

S-Read-BW (MB/s)

S-Write-IOPS

S-Read-IOPS These properties indicate the current Bandwidth/IOPS of I/Os

which are smaller than 16KB for X2 cluster type or smaller than 8KB
S-BW (MB/s) for X1 cluster type.

S-IOPS

Total-S-Write-IOs

Total-S-Read-IOs

294 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-volumes-performance-unaligned
The show-volumes-performance-unaligned admin-level command displays the
Volumes’ performance data for unaligned blocks.

Note: Unaligned blocks refer to blocks unaligned to 16KB offsets for X2 cluster type and to
blocks unaligned to 8KB offsets for X1 cluster type.

Usage:
show-volumes-performance-unaligned [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-volumes-performance-unaligned cluster-id=1

Output Parameter Description

Volume-Name The Volume’s name

Index The Volume’s index number

Cluster-Name The Cluster’s name

Index The Cluster’s index number

U-Write-BW (MB/s)

U-Read-BW (MB/s)

U-Write-IOPS
These properties indicate the current Bandwidth/IOPS of I/Os
U-Read-IOPS
which are not aligned with 16KB for X2 cluster type or not aligned
with 8KB for X1 cluster type when a single host I/O request results
U-BW (MB/s)
in multiple internal requests.
U-IOPS

Total-U-Write-IOs

Total-U-Read-IOs

Cluster Data and Status 295

Admin CLI Commands

show-consistency-groups-performance
The show-consistency-groups-performance admin-level command displays the
Consistency Groups’ performance data.
Usage:
show-consistency-groups-performance [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output. page 11.

Example:
show-volumes-performance cluster-id=1

Output Parameter Description

Name The Volume’s name

Index The Volume’s index number

Cluster-Name The Cluster’s name

Index The Cluster’s index number

296 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

Write-BW (MB/s)

Write-IOPS

Read-BW (MB/s)

Read-IOPS

BW (MB/s)

IOPS

Read-Latency (usec)

Write-Latency (usec) These properties indicate the current Bandwidth/IOPS and latency.

Avg-Latency (usec)

Total-Write-IOs

Total-Read-IOs

Total-Writes

Total-Reads

QOS-Exceeded-BW

QOS-Exceeded-IOPS

Cluster Data and Status 297

Admin CLI Commands

show-data-protection-groups-performance
The show-data-protection-groups-performance admin-level command
displays XDP groups performance information.
Usage:
show-data-protection-groups-performance [ duration=<seconds> ]
[ cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-data-protection-groups-performance

Output Parameter Description

Name The Data Protection Group’s name

Index The Data Protection Group’s index number

Cluster-Name The Cluster’s name

Index The Cluster’s index number

Write-BW (MB/s)

Read-BW (MB/s)

Write-IOPS
These properties indicate the current Bandwidth/IOPS.
Read-IOPS

BW (MB/s)

IOPS

298 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-remote-protection-sessions-performance
The show-remote-protection-sessions-performance admin-level command
displays Remote Protection performance information.
Usage:
show-remote-protection-sessions-performance [
duration=<seconds> ] [ cluster-id=<Name or Index> ] [
frequency=<seconds> ] [ filter=<> ] [ prop-list=<List of
property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-remote-protection-sessions-performance

Output Parameter Description

Name The Data Protection Group’s name

Index The Data Protection Group’s index number

A-End-Source-XMS-ID The index of the XMS managing the source cluster

A-End-Cluster-ID The index of the source cluster

Cycle-Number Remote Protection Session cycle number

BW (KB/s) Bandwidth in KB/s

Transfer-Efficiency-Ratio Indicates the efficiency of the Remote Protection Session.

Lag (sec) The time that passed since the last consistent PIT was replicated (in
seconds)

RPO-Compliance-Ratio Indicates the percentage of compliance of the session to its

specified RPO.

Current-Protection-Window- The actual protection time frame (in days) for which the copies exist
Duration-In-Days

Cycle-Duration (sec) Duration of the current Remote Protection Session cycle in seconds

Cycle-Percent-Remaining The percentage of the Remote Protection Session cycle that

remains to be transferred

Cluster Data and Status 299

Admin CLI Commands

Output Parameter Description

Cycle-Start-Time The current Remote Protection Session cycle start time

Cycle-Time-Remaining (sec) Number of seconds that remains for the current Remote Protection
Session cycle

Last-Cycle-Completed-Pit The most recent completed PIT

Last-Cycle-Start-Time The start time of the last completed Remote Protection Session
cycle

Last-Cycle-Duration (sec) The duration of the last completed cycle in seconds

Last-Cycle-Effective-Bandwi Indicates the effective KB/sec on the link

dth (KB/s)

Last-Cycle-Transfer-Efficienc Indicates the efficiency of the Remote Protection.

y-Ratio

Last-Cycle-Full-Pages The number of full pages handled during the last completed
Remote Protection Session cycle

Last-Cycle-Num-Hash-Pages The number of hash pages handled during the last completed
Remote Protection Session cycle

Last-Cycle-Link-BW (KB/s) The total link bandwidth during the last completed Remote
Protection Session cycle

Last-Cycle-Number The last cycle that was fully completed (transmitted to the target)

Last-Cycle-Num-Short-Hash- The total number of short hash mismatches in the last completed
Mismatch Remote Protection Session cycle

Last-Cycle-Total-Pages The total number of pages sent during the last completed Remote
Protection Session cycle

Last-Cycle-Num-Zero-Pages The number of zero pages handled during the last completed
Remote Protection Session cycle

Last-Cycle-Requests-Sent The total number of requests sent during the last completed
Remote Protection Cycle

Last-Cycle-Requests-Sent-R The rate of sent requests rate during the last completed Remote
ate (Req/s) Protection Cycle

Last-Cycle-Requests-Round- The average request round trip time during the last completed
Trip-Time (usec) Remote Protection Session cycle

Last-Cycle-Requests-Receiv The number of requests received during the last completed Remote
ed Protection Session cycle

Last-Cycle-Requests-Receiv The rate of received requests rate during the last completed Remote
ed-Rate (Req/s) Protection Session cycle

Last-Cycle-Sent (KB) The data sent during the last completed Remote Protection Session
cycle (in KB)

Last-Cycle-Send-Rate (KB/s) The send rate during the last completed Remote Protection Session
cycle

Last-Cycle-Received (KB) The data received during the last completed Remote Protection
Session cycle (in KB)

Last-Cycle-Received-Rate The receive rate during the last completed Remote Protection
(KB/s) Session cycle

Total-All-Pages The total number of all pages sent

300 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

Total-Full-Pages The total number of full pages sent

Total-Zero-Pages The total number of zero pages sent

Total-Full-Hash-Pages The total number of full hash pages sent

Total-Requests-Sent The total number of requests sent

Total-Requests-Received The total number of requests received

Total-KBytes-Sent The total amount of KBs sent

Total-Data-Received The total amount of KBs received

A-End-Number-Of-Source-Pi The number of Snapshot Sets currently existing for the source
ts cluster

Z-End-Number-Of-Source-Pit The number of Snapshot Sets currently existing for the target
s cluster

show-remote-protection-targets-performance
The show-remote-protection-targets-performance admin-level command
displays Remote Protection Session targets performance information.
Usage:
show-remote-protection-targets-performance [ duration=<seconds>
] [ cluster-id=<Name or Index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<List of property strings> ] [ vertical
]

Input Parameter Description Value Mandatory

cluster-id Cluster ID ID: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

vertical Vertical layout N/A No

Cluster Data and Status 301

Admin CLI Commands

Example:

show-remote-protection-targets-performance

Output Parameter Description

Name The Data Protection Group’s name

Index The Data Protection Group’s index number

Cluster-Name The cluster name

Index The cluster index

Avg-Latency-16KB(usec) Average latency for 16KB in usec

Total-Read-IOs Total read IOPS

Total-Write-IOs Total write IOPS

Total-Reads Total reads

Total-Writes Total writes

BW(MB/s) Bandwidth in MB/second

IOPS IOPS

Read-BW(MB/s) Read bandwidth in MB/second

Read-Latency(usec) Read latency in usec

Write-BW(MB/s) Write bandwidth in MB/second

Write-IOPS Write IOPS

Write-Latency(usec) Write latency in usec

Num-PKTS-Rx Number of packets received

Total-KB-Rx Total Kbytes received

Num-PTKS-Tx Number of packets transmitted

Total-KB-Tx Total Kbytes transmitted

Num-Crc-Err Number of discarded packets

Num-No-Buff-Err Number of valid packets discarded due to lack of buffer

Num-Tx-Err Number of packets that could not be transmitted and were

discarded

302 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-remote-protection-ip-links-performance
The show-remote-protection-ip-links-performance admin-level command
displays Remote Protection IP links performance information.
Usage:
show-remote-protection-ip-links-performance [cluster-id=<id:
name or index> ] [ duration=<seconds> ] [ frequency=<seconds> ]
[ filter=<> ] [ prop-list=<List of property strings> ] [
vertical ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

vertical Vertical layout N/A No

Example:

show-remote-protection-ip-links-performance

Output Parameter Description

Name The cluster name

Index The cluster index number

A-End-Cluster-ID Source cluster index

Z-End-Cluster-ID Target cluster index

Name IP link name

A-End-Ping-RTT Source cluster ping round trip time in usec

A-End-Request-Response-Ti Source cluster request response time in usec

me

A-End-Requests-Processing- Source cluster request processing time in usec

Time

Accumulated-A-End-Reques Accumulated number of requests sent from the source cluster

ts-Sent

A-End-BW-Requests-Send-R Bandwidth rate of requests sent from source cluster in KB/s

ate

Accumulated-A-End-Reques Accumulated number of requests received by the source cluster

ts-Received

Cluster Data and Status 303

Admin CLI Commands

Output Parameter Description

A-End-Requests-Received-R Rate of requests received by the source cluster (requests per

ate second)

Accumulated-A-End-Sent Accumulate data size sent from the source cluster in KB

A-End-Send-Rate Rate of send from the source cluster in KB/s

Accumulated-A-End-Data-Re Accumulated data size received by the source cluster

ceived

A-End-Received-Rate Rate of receive by the source cluster in KB/s

A-End-Total-Packets Total number of packets received by the source cluster

A-End-Dropped-Packets Number of packets dropped by the source cluster

A-End-Dropped-Packets-Rati Ratio of dropped packets at the source cluster

o

Z-End-Request-Response-Ti Target cluster request response time in usec

me

Z-End-Requests-Processing- Target cluster request processing time in usec

Time

Accumulated-Z-End-Request Accumulated rate of requests received by the target cluster in KB/s

s-Received-Rate (KB/s)

Z-End-Total-Packets Total number of packets received by the target cluster

Z-End-Dropped-Packets Number of packets dropped by the target cluster

Z-End-Dropped-Packets-Rati Ratio of dropped packets at the target cluster

o

304 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Statistics and Reports

show-ssd-sas-error-counters
The show-ssd-sas-error-counters admin-level command displays the list of
diagnostic counters that can indicate problems in the SAS link between the DAE Row
Controller and a specified SSD.
Usage:
show-ssd-sas-error-counters ssd-id=<name or index> [
duration=<seconds> ] [ cluster-id=<id: name or index> ] [
frequency=<seconds> ]

Input Parameter Description Value Mandatory

ssd-id SSD ID Name or Index Yes

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

Example:

show-ssd-sas-error-counters ssd-id="wwn-0x5000cca04e05faa0"

Output Parameter Description

Name The SSD’s name

Index The SSD’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Port-Index The port index number

Invalid-Dwords The number of invalid Dwords over the link

Disparity-Errors The number of Dwords with a running disparity errors

Loss-Dword-Sync The number of times the link lost Dword synchronization

Phy-Resets The number of times the SAS phy undergone reset

Cluster Data and Status 305

Admin CLI Commands

show-storage-controllers-sas-error-counters
The show-storage-controllers-sas-error-counters admin-level command
displays a list of diagnostic counters that can indicate problems in the SAS link between
the DAE Controller and the specified Storage Controller.
Usage:
show-storage-controllers-sas-error-counters [
duration=<seconds> ] [ sc-id=<id: name or index> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

sc-id Storage Controller ID Name or Index No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-storage-controllers-sas-error-counters [
duration=<seconds> ] [ sc-id=<id: name or index> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ]

Output Parameter Description

Storage-Controller-Name The SSD’s name

Index The SSD’s index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Port-Index The port index number

Phy-Index The SAS phy index number

Invalid-Dwords The number of invalid Dwords over the link

Disparity-Errors The number of Dwords with a running disparity errors

Loss-Dword-Sync The number of times the link lost Dword synchronization

Phy-Resets The number of times the SAS phy undergone reset

306 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-storage-controllers-infiniband-error-counters
The show-storage-controllers-infiniband-error-counters admin-level
command displays the Storage Controllers’ InfiniBand error counters.
Usage:
show-storage-controllers-infiniband-error-counters [
duration=<seconds> ] [ cluster-id=<id: name or index> ] [
frequency=<seconds> ] [ vertical ] [ filter=<> ] [
prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-storage-controllers-infiniband-error-counters

Cluster Data and Status 307

Admin CLI Commands

Output Parameter Description

Storage-Controller-Name The Storage Controller’s name

Index The Storage Controller’s index

Port-Index The port’s index number

Symb-Errs

Symb-Errs-pm

Symb-Errs-pl

Recovers

Recovers-pm

Recovers-pl

Lnk-Downed

Lnk-Downed-pm

Lnk-Downed-pl

Rcv-Errs These properties correspond to standard InfiniBand ports

diagnostic counters.
Rcv-Errs-pm

Rcv-Errs-pl

Rmt-Phys-Errs

Rmt-Phys-Errs-pm

Rmt-Phys-Errs-pl

Integ-Errs

Integ-Errs-pm

Integ-Errs-pl

Link-Rate-In-Gbps The link rate in Gbps

308 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-infiniband-switches-ports-error-counters
The show-infiniband-switches-ports-error-counters admin-level
command displays status of the InfiniBand Switches' ports error counters.
Usage:
show-infiniband-switches-ports-error-counters [
duration=<seconds> ] [ cluster-id=<id: name or index> ] [
frequency=<seconds> ] [ vertical ] [ filter=<> ] [
prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:
show-storage-controllers-infiniband-error-counters

Output Parameter Description

Name The InfiniBand Switch’s name

Index The InfiniBand Switch’s index

Cluster-Name The cluster’s name

Index The cluster’s index

Port-Num The InfiniBand Switch’s port number

Last-Day-Num-Faults The number of ports that were disabled during the last day

Last-Day-Num-Problems The number of problems (multiple errors during a 10 seconds

period) during the last day

Cluster Data and Status 309

Admin CLI Commands

Output Parameter Description

IB-Symb-Errs

IB-Recovers

IB-Lnk-Downed
These properties correspond to standard InfiniBand Switches ports
IB-Rcv-Errs diagnostic counters.

IB-Rmt-Phys-Errs

IB-Integrity-Errs

IB-Buffer-Overrun-Errs

Is-Active Indicates whether the port is active.

show-target-groups-fc-error-counters
The show-target-groups-fc-error-counters admin-level command displays
Fibre Channel error counters per Target Group.
Usage:
show-target-groups-fc-error-counters [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
filter=<> ] [ prop-list=<list of property strings> ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-target-groups-fc-error-counters

Output Parameter Description

TG-Name The Target Group’s name

Index The Target Group’s index number

Cluster-Name The name of the cluster to which the Target Group belongs

Index The cluster’s index

Dumped-Frames The total number of dumped frames

310 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

Output Parameter Description

Sync-Loss The total number of synchronization losses

Signal-Loss The number of times an invalid CRC error has occurred

Invalid-Crc The total number of invalid CRC frames

Link-Failure The total number of link failures

Prim-Seq-Err The number of prime sequential protocol errors

show-targets-fc-error-counters
The show-targets-fc-error-counters admin-level command displays Fibre
Channel error counters per Target.
Usage:
show-targets-fc-error-counters [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
vertical ] [ filter=<> ] [ prop-list=<list of property strings>
]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-targets-fc-error-counters

Output Parameter Description

Name The Target’s name

Index The Target’s index number

Cluster-Name The name of the cluster to which the Target belongs

Index The cluster’s index

Dumped-Frames The total number of dumped frames

Sync-Loss The total number of synchronization losses

Signal-Loss The number of times an invalid CRC error has occurred

Cluster Data and Status 311

Admin CLI Commands

Output Parameter Description

Invalid-Crc The total number of invalid CRC frames

Link-Failure The total number of link failures

Prim-Seq-Err The number of prime sequential protocol errors

show-daes-controllers-sas-error-counters
The show-daes-controllers-sas-error-counters admin-level command
displays a list of diagnostic counters that can indicate problems in the SAS link between
the Storage Controller/DAE Row Controller and the specified DAE Row Controller.
Usage:
show-daes-controllers-sas-error-counters [cluster-id=<cluster
ID>] [ dae-controller-id=<name or index> ] [duration=<number of
minutes>] [frequency=<number of seconds>] [ vertical ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

dae-controller-id DAE Controller ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

Example:

show-daes-controllers-sas-error-counters

Output Parameter Description

Name The DAE Controller’s name

Index The DAE Controller’s index number

Cluster-Name The name of the cluster to which the DAE Controller belongs

Index The cluster’s index

Phy-Index The SAS phy index number

Invalid-Dwords The number of invalid Dwords over the link

Disparity-Errors The number of Dwords with a running disparity errors

Loss-Dword-Sync The number of times the link lost Dword synchronization

Phy-Resets The number of times the SAS phy undergone reset

312 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-daes-row-controllers-sas-error-counters

Note: This command applies to X2 cluster type only.

The show-daes-row-controllers-sas-error-counters admin-level command

displays a list of diagnostic counters that can indicate problems in the SAS link between
the DAE Row Controller/SSD and the specified DAE Row Controller.
Usage:
show-daes-row-controllers-sas-error-counters
[cluster-id=<cluster ID>] [ dae-controller-id=<name or index> ]
[duration=<number of minutes>] [frequency=<number of seconds>]
[ vertical ]

Input Parameter Description Value Mandatory

cluster-id Cluster ID id: Name or Index No

dae-row-controller-id DAE Row Controller ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

Example:

show-daes-row-controllers-sas-error-counters
dae-row-controller-id=1 vertical

Output Parameter Description

Name The DAE Row Controller’s name

Index The DAE Row Controller’s index number

Cluster-Name The name of the cluster to which the DAE Row Controller belongs

Index The cluster’s index

Phy-Index The SAS phy index number

Invalid-Dwords The number of invalid Dwords over the link

Disparity-Errors The number of Dwords with a running disparity errors

Loss-Dword-Sync The number of times the link lost Dword synchronization

Phy-Resets The number of times the SAS phy undergone reset

Cluster Data and Status 313

Admin CLI Commands

show-targets-iscsi-counters
The show-targets-iscsi-counters admin-level command displays error counters
information for iSCSI targets.
Usage:
show-targets-iscsi-counters [ duration=<seconds> ] [
cluster-id=<id: name or index> ] [ frequency=<seconds> ] [
vertical ] [ filter=<> ] [ prop-list=<list of property strings>
]

Input Parameter Description Value Mandatory

cluster-id Cluster ID Name or Index No

duration Monitor duration Seconds No

frequency Monitor intervals Seconds No

vertical Vertical layout N/A No

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

filter Filters the command See “Using Filters” on No

output page 11.

Example:

show-targets-iscsi-counters

Output Parameter Description

Name The iSCSI counter name

Index The iSCSI counter index number

Cluster-Name The cluster’s name

Index The cluster’s index number

Port-Address Port address

Num-PKTS-Rx Number of packets received

Total-KB-Rx Total packets received

Num-PKTS-Tx Number of packets transmitted

Total-KB-Tx Total packets transmitted

Num-Crc-Err Number of detected CRC errors

Num-NO-Buff-Err Number of detected No Buffer errors

Num-Tx-Err Number of detected transmission errors

314 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-report
The show-report admin-level command displays the details of a specified report.
Usage:
show-report report-id=<name or index> [prop-list=<> ]

Input Parameter Description Value Mandatory

report-id Report ID Name or Index Yes

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:

show-report report-id=1

Output Parameter Description

Name Report’s name

Index Reports Index number

Title Report’s title

Entity Report’s entity subject

Category Report’s category

Object-List Object list referred to in the report

Property-List Properties displayed in the report

Source-Definition The report’s source

View-Type The report’s view type

Public Indicates whether the report is public.

Cluster Data and Status 315

Admin CLI Commands

show-reports
The show-reports admin-level command displays the list of defined reports.
Usage:
show-reports [ prop-list=<List of property strings> ]

Input Parameter Description Value Mandatory

prop-list Allows to show more A list of property No

or less properties than strings (e.g. ["prop1",
the default output "prop2"] ). See
parameters. “Specifying Output
Parameters” on
page 12.

Example:
show-reports

Output Parameter Description

Name Report’s name

Index Reports Index number

Title Report’s title

Entity Report’s entity subject

Category Report’s category

Granularity Reporting granularity

From-Time Time of report start

To-Time Time of report end

Time-Frame Report’s time frame

Source-Definition Report’s source

Public Indicates whether the report is public.

316 Dell EMC XtremIO Storage Array CLI Guide

 Admin CLI Commands

show-reports-data
The show-reports-data admin-level command displays detailed report’s data for the
specified entity and category.
Usage:
show-reports-data entity=<string> category=<string> [
to-time=<date/time format: eg. "2013-11-23 10:14:15"> ] [
cluster-id=<name or index> ] [ vertical ] [ granularity=<text
string. auto for best match> ] [ obj-list=<list of ids: name or
index> ] [ time-frame=<text string. to use without from/to> ] [
from-time=<date/time format: eg. "2013-11-23 10:14:15"> ] [
export-to-file=<string> ]

Input Parameter Description Value Mandatory

category Report category Latency, Capacity, Yes

Bandwidth, IOPS,
TotalIOs,
LinkDiagnostics,
Resources

entity Entity type Cluster, Yes

DataProtectionGroup,
IPLink, Initiator,
InitiatorGroup,
InitiatorGroupTag,
ReplicationStatus,
SSD, SnapshotGroup,
Tag, Target,
TargetGroup, Volume,
VolumeTag, XEnv,
XreplicationSession,
Xms

export-to-file File name String No

from-time From Date/Time date/time format (e.g. No

"2015-05-2310:14:15
")

granularity Data granularity ten_minutes, No

one_day, one_minute,
one_hour, auto, raw
(use auto for best
match)

obj-list Object ID list List of ids: Name or No

Index

time-frame Time frame for Text string to use No

monitoring without from/to

to-time To Date/Time date/time format (e.g. No

"2015-05-2310:14:15
")

vertical Vertical layout N/A No

cluster-id Cluster ID Name or Index No

Cluster Data and Status 317

Admin CLI Commands

Example:
show-reports-data category=IOPS entity=Volume
obj-list=["vol1","testvol"] from-time="2016-03-03 10:15:16"
export-to-file="iops_vol" granularity=one_hour

Query Commands
query-remote-protection-objects
The query-remote-protection-objects admin-level command provides
customized monitoring data for Remote Protection objects.

Usage:
query-remote-protection-objects class=<IPLink, RSnapSet, RTag,
RVolume, ReplicationDomain, RetentionPolicy, RConsistencyGroup,
RSystem, RTarget, RXMS, ReplicationSession, VolumePair>
cluster-id=<Name or Index> xms-name=<Name> [ obj-list=<List of
ids: Name or Index> ] [ prop-list=<List of property strings> ]
NOTE! The following properties are mandatory: [ class,
cluster-id, xms-name ]

Input Parameter Description Value Mandatory

class Class IPLink, RSnapSet, Yes

RTag, RVolume,
ReplicationDomain,
RetentionPolicy,
RConsistencyGroup,
RSystem, RTarget,
RXMS,
ReplicationSession,
VolumePair

cluster-id Cluster ID Name or Index Yes

xms-name XMS name Name Yes

obj-list Object ID list List of ids: Name or No

Index

prop-list Property list A list of property No

strings (e.g. ["prop1",
"prop2"] ). See
“Specifying Output
Parameters” on
page 12.

Example:
query-remote-protection-objects class=RetentionPolicy
cluster-id="MyCluster" xms-name="XMS1"

318 Dell EMC XtremIO Storage Array CLI Guide