Docu62760 XtremIO 4.0.2 and 4.0.4 Storage Array User Guide

Download as pdf or txt
Download as pdf or txt
You are on page 1of 568

EMC

XtremIO Storage Array


Versions 4.0.2 and 4.0.4

User Guide
P/N 302-002-485
REV. 05

Copyright 2016 EMC Corporation. All rights reserved. Published in the USA.
Published September, 2016
EMC 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. EMC Corporation 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 EMC software described in this publication requires an applicable software license.
EMC2, EMC, and the EMC logo are registered trademarks or trademarks of EMC Corporation in the United States and other countries.
All other trademarks used herein are the property of their respective owners.
For the most up-to-date regulatory document for your product line, go to EMC Online Support (https://support.emc.com).

EMC XtremIO Storage Array User Guide

CONTENTS

Preface
Part 1

Introduction

Chapter 1

System Description
System Overview.........................................................................................
X-Brick ........................................................................................................
Scale-Out Architecture ................................................................................
10TB Starter X-Brick (5TB) .....................................................................
System Features..........................................................................................
Scalable Performance ...........................................................................
Even Data Distribution...........................................................................
Inline Data Reduction............................................................................
High Availability ....................................................................................
Non-Disruptive Upgrade ........................................................................
Thin Provisioning ..................................................................................
XtremIO Data Protection (XDP)...............................................................
Snapshots (XtremIO Virtual Copies - XVC)..............................................
VMware VAAI Integration .......................................................................
Data at Rest Encryption .........................................................................
XtremIO Management Server (XMS).............................................................
System GUI .................................................................................................
Command Line Interface..............................................................................
RESTful API .................................................................................................
Ports and Protocols .....................................................................................

Chapter 2

14
15
16
17
17
17
18
19
21
22
22
23
24
26
27
27
28
28
28
29

Using the Graphical User Interface (GUI)


GUI Window ................................................................................................
Menu Bar Icons ...........................................................................................
Accessing the GUI .......................................................................................
Installing a Local Java Bundle................................................................
Dashboard Workspace ................................................................................
Storage Pane.........................................................................................
Performance Pane .................................................................................
Alerts Pane............................................................................................
Configuration Workspace ............................................................................
Volumes View .......................................................................................
Consistency Groups View ......................................................................
Snapshot Sets View ..............................................................................
Initiator Groups View.............................................................................
Initiators View .......................................................................................
Schedulers View ...................................................................................
Inventory Workspace...................................................................................
Inventory Table View .............................................................................
Cluster Configuration ............................................................................

EMC XtremIO Storage Array User Guide

32
33
34
39
44
46
48
49
51
52
56
59
62
64
66
68
76
94

Contents

Alerts & Events Workspace .......................................................................... 98


Alerts Tab.............................................................................................. 99
Events Tab .......................................................................................... 102
Reports Workspace ................................................................................... 104
Administration Workspace ........................................................................ 106
Security Tab ........................................................................................ 107
Notification Tab................................................................................... 110
XMS Tab.............................................................................................. 113
CLI Terminal Tab.................................................................................. 114
Support Window ....................................................................................... 115
About Window .......................................................................................... 116

Chapter 3

Managing Multiple Clusters


Managing Multiple Clusters Setting, Using the GUI ....................................
Selecting a Cluster ..............................................................................
Selecting a Storage Pane View ............................................................
Managing Multiple Clusters, Using the CLI.................................................
Managing a Specific Cluster in a Multiple Cluster Setting.....................

Chapter 4

Managing the Hardware


Managing Hardware Tags ..........................................................................
Object Naming Limitations ..................................................................
Managing Tags, Using the GUI .............................................................
Managing Tags, Using the CLI..............................................................
Hardware Components LEDs ....................................................................
Using the Identification LEDs...............................................................

Chapter 5

130
130
130
134
135
136

Monitoring the Cluster


Monitoring the Storage .............................................................................
Monitoring the Efficiency.....................................................................
Monitoring the Volume Capacity..........................................................
Monitoring the Physical Capacity.........................................................
Monitoring the Performance ......................................................................
Monitoring the Performance, Using the GUI .........................................
Monitoring the Performance, Using the CLI ..........................................
Monitoring the Hardware Elements ...........................................................
Monitoring the Clusters .......................................................................
Monitoring the X-Bricks .......................................................................
Monitoring the Storage Controllers ......................................................
Monitoring the SSDs ...........................................................................
Monitoring the InfiniBand Switches.....................................................
Monitoring the Data Protection Groups................................................
Monitoring the Local Disks ..................................................................
Monitoring the Battery Backup Units ...................................................
Monitoring the DAEs............................................................................
Monitoring the Targets ........................................................................
Monitoring the Storage Elements ..............................................................
Monitoring the Volumes ......................................................................
Monitoring the Consistency Groups.....................................................
Monitoring the Initiators......................................................................
Monitoring the Initiator Groups ...........................................................
Monitoring the Snapshot Sets .............................................................

120
121
122
126
126

EMC XtremIO Storage Array User Guide

140
140
141
141
142
142
143
144
144
146
147
148
149
149
152
153
154
155
158
158
161
163
165
167

Contents

Monitoring the Alerts ................................................................................


Monitoring Alerts, Using the GUI..........................................................
Monitoring Alerts, Using the CLI ..........................................................
Managing the Reports ...............................................................................
Predefined Reports..............................................................................
Viewing Reports ..................................................................................
Managing Reports, Using the GUI ........................................................
Managing Reports, Using the CLI .........................................................

Chapter 6

Managing Volume Operations


Overview...................................................................................................
Managing Storage Elements Tags ..............................................................
Object Naming Limitations ..................................................................
Managing Tags, Using the GUI .............................................................
Managing Tags, Using the CLI..............................................................
Managing Volumes and Snapshots ...........................................................
Volumes Overview...............................................................................
Snapshots Overview ...........................................................................
Managing Volumes and Snapshots, Using the GUI ..............................
Managing Volumes and Snapshots, Using the CLI ...............................
Managing the Consistency Groups ............................................................
Managing Consistency Groups, Using the GUI .....................................
Managing Consistency Groups, Using the CLI ......................................
Managing the Snapshot Sets ....................................................................
Managing Snapshot Sets, Using the GUI..............................................
Managing Snapshot Sets, Using the CLI ..............................................
Managing the Initiator Groups...................................................................
Managing Initiator Groups, Using the GUI ............................................
Managing Initiator Groups, Using the CLI.............................................
Managing Initiators ...................................................................................
Managing Initiators, Using the GUI ......................................................
Managing Initiators, Using the CLI .......................................................
Managing Mapping ...................................................................................
Basic Mapping Scenario......................................................................
Using Tags for Mapping.......................................................................
Using the Mapping Wizard ..................................................................
Managing the Schedulers..........................................................................
Managing the Schedulers, Using the GUI.............................................
Managing Schedulers, Using the CLI....................................................

Chapter 7

169
169
169
170
170
171
172
179

182
183
183
184
189
190
190
191
193
221
222
222
235
236
236
248
249
249
259
260
260
262
263
263
267
269
272
272
277

Managing Alerts and Events


Overview...................................................................................................
Managing the Alerts ..................................................................................
Managing Alerts, Using the GUI ...........................................................
Managing Alerts, Using the CLI ............................................................
Managing the Events.................................................................................
Managing Events, Using the GUI..........................................................
Managing Events, Using the CLI...........................................................

EMC XtremIO Storage Array User Guide

280
280
280
284
285
285
289

Contents

Chapter 8

Cluster Administration and Configuration


Configuring the iSCSI Portals and Routes...................................................
Managing iSCSI Portals and Routes, Using the GUI ..............................
Managing iSCSI Portals and Routes, Using the CLI ...............................
Configuring the iSCSI Port Number ............................................................
Configuring the iSCSI Port via the GUI..................................................
Setting the Maximum Transmission Unit for iSCSI......................................
Configuring Jumbo Frames via the GUI .................................................
Configuring the Cluster Limits ...................................................................
Configuring Cluster Limits via the GUI..................................................
Configuring Cluster Limits via the CLI...................................................
Configuring the Cluster ODX Mode.............................................................
Configuring the ODX Mode via the GUI.................................................
Configuring the ODX Mode via the CLI .................................................
Configuring the iSCSI Security Parameters (CHAP) .....................................
Configuring CHAP via the GUI ..............................................................
Configuring CHAP via the CLI ...............................................................
Configuring the Cluster Encryption ............................................................
Configuring the User Accounts...................................................................
User Accounts Overview ......................................................................
Managing User Accounts, Using the GUI ..............................................
Managing User Accounts, Using the CLI...............................................
Configuring the LDAP Users Authentication ...............................................
Setting the XMS Server LDAP Configuration .........................................
Configuring LDAP Settings via the GUI .................................................
Configuring LDAP Settings via the CLI ..................................................
Configuring the Default Inactivity Timeout .................................................
Configuring the Inactivity Timeout via the GUI......................................
Configuring the Inactivity Timeout via the CLI ......................................
Configuring Email Settings ........................................................................
Managing Email Settings, Using the GUI ..............................................
Managing Email Settings, Using the CLI...............................................
Configuring the SNMP ...............................................................................
Configuring SNMP, Using the GUI ........................................................
Configuring SNMP, Using the CLI .........................................................
XtremIO MIB........................................................................................
Configuring the Remote Syslog Notification ...............................................
Configuring Remote Syslog via the GUI ................................................
Configuring Syslog Settings via the CLI ................................................
Customizing the Login Screen Banner .......................................................
Customizing the Login Screen Banner via the GUI................................
Customizing the Login Screen Banner via the CLI.................................

Chapter 9

Cluster Operations
Locating the Cluster ..................................................................................
Stopping the Cluster .................................................................................
Stopping the Cluster via the GUI..........................................................
Stopping the Cluster via the CLI...........................................................
Starting the Cluster ...................................................................................
Starting the Cluster via the GUI............................................................
Starting the Cluster via the CLI.............................................................
Powering Off the Cluster............................................................................
Powering Off the Cluster via the GUI ....................................................
Powering Off the Cluster via the CLI .....................................................

292
292
297
298
298
300
301
302
302
303
303
303
304
305
306
307
307
308
308
308
311
312
313
314
321
322
322
323
324
324
326
327
327
329
329
330
330
331
332
332
332

EMC XtremIO Storage Array User Guide

334
334
334
336
337
337
337
338
338
339

Contents

Powering Up the Cluster ............................................................................


Powering Up the Cluster after an Emergency Shutdown .......................
Powering Up Procedure .......................................................................
Powering Up the Battery Backup Units.................................................
Powering Up the Storage Controllers ...................................................
Powering Up the XMS ..........................................................................
Starting the Cluster .............................................................................
Shutting Down the Cluster - Planned Shutdown.........................................
Planned Cluster Shutdown Overview ...................................................
Pre-Shutdown Procedure.....................................................................
Shutting Down the Service ..................................................................
Shutting Down the Hardware...............................................................
Shutting Down the XMS.......................................................................
Shutting Down the Cluster - Emergency Shutdown.....................................
Changing the IP Configurations .................................................................
Changing the IP Configurations in a Single Cluster Environment ..........
Changing the IP Configurations in a Multiple Cluster Environment .......
Updating the XMS NTP Server Address ................................................
Setting the Cluster Time and Date .............................................................
Managing the Virtual XMS .........................................................................
Deploying a Virtual XMS ......................................................................
Relocating a Virtual XMS .....................................................................
Restoring Access to the Virtual XMS ....................................................
Refreshing the Unique SSH Key .................................................................

Chapter 10

340
340
341
342
345
346
347
348
348
348
350
350
351
352
354
354
357
360
361
362
362
364
364
366

CLI Guide
Using the Command Line Interface (CLI) ....................................................
Accessing the CLI via the GUI...............................................................
Accessing the CLI via an SSH Client .....................................................
Accessing the CLI via an SSH Key Authentication.................................
Objects Naming Limitations ......................................................................
Completion Codes.....................................................................................
CLI Commands Quick Finder .....................................................................
General.....................................................................................................
Maintenance.............................................................................................
Create cluster / CE...............................................................................
FRU Replacement ................................................................................
Start/stop/power commands ..............................................................
Hardware Diagnostics .........................................................................
Troubleshooting........................................................................................
Test connectivity .................................................................................
Debug .................................................................................................
Administration ..........................................................................................
User management ...............................................................................
Certificate Management ......................................................................
Cluster Management (Cluster Level) ....................................................
Cluster Management (XMS Level) ........................................................
XMS Notifiers ......................................................................................
IP Addresses .......................................................................................
Provisioning..............................................................................................
Tag Management.................................................................................
Volume and Snapshot Management....................................................
Snapshot Set Management .................................................................
Consistency Group Management .........................................................

EMC XtremIO Storage Array User Guide

368
368
369
369
370
371
372
380
382
382
386
392
394
411
411
413
415
415
420
422
427
432
438
440
440
442
451
453

Contents

Initiator and Initiator Group Management............................................


Scheduler Management ......................................................................
Target Management ............................................................................
LUN Mapping ......................................................................................
iSCSI Management..............................................................................
Data Protection Group Management....................................................
Cluster Data and Status.............................................................................
Alerts and Events ................................................................................
Performance........................................................................................
Statistics and Reports .........................................................................

Appendix A

456
463
466
468
470
474
475
475
481
502

Alerts and Events Details


General XMS Event Codes ......................................................................... 510
Alerts Details ............................................................................................ 510
Events Details ........................................................................................... 538

Appendix B

Replacing the Default SSL Certificate


Overview...................................................................................................
Creating a CSR ..........................................................................................
Submitting the CSR ...................................................................................
Converting the Certificate Format...............................................................
Installing the Certificate ............................................................................
Installing a Third Party Certificate that was Created without CSR ................

Appendix C

560
561
562
562
563
564

XtremIO WebUI (Web User Interface)


Overview................................................................................................... 566
Enabling the WebUI................................................................................... 566
Accessing the WebUI................................................................................. 566

EMC XtremIO Storage Array User Guide

PREFACE

As part of an effort to improve its product lines, 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 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 EMC Online Support
(https://support.emc.com) to ensure that you are using the latest version of this
document.

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

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

Related Documentation
The following EMC publications provide additional information:

XtremIO Storage Array Host Configuration Guide

XtremIO Storage Array Site Preparations Guide

XtremIO Storage Array Security Configuration Guide

XtremIO Storage Array RESTful API Guide

XtremIO Storage Array Release Notes

Preface

Preface

10

EMC XtremIO Storage Array User Guide

Introduction
EMC XtremIO Storage Array User Guide is part of the XtremIO documentation set and is
intended for use by system administrators responsible for performing day-to-day
operations of an XtremIO cluster.
This document provides instructions for managing and monitoring the EMC XtremIO
Storage Array.
Chapters in this document provide information on the following topics:

Chapter 1, System Description


Provides a detailed overview of the system and its features.
Chapter 2, Using the Graphical User Interface (GUI)
Provides a detailed description of the systems GUI.
Chapter 3, Managing Multiple Clusters
Provides instructions for managing a multiple-cluster configuration.

Chapter 4, Managing the Hardware


Provides instructions for managing the clusters hardware components.

Chapter 5, Monitoring the Cluster


Provides instructions for monitoring the cluster and its various elements and
components, including advanced monitoring.
Chapter 6, Managing Volume Operations
Provides instructions for managing Volumes, Initiator Groups and LUN mapping.
Chapter 7, Managing Alerts and Events
Provides instructions for managing alerts and events.
Chapter 8, Cluster Administration and Configuration
Provides instructions for configuring user accounts, email settings, SNMP, and
notifications.
Chapter 9, Cluster Operations
Provides instructions for operating the EMC XtremIO Storage Array.

Chapter 10, CLI Guide


Provides a complete CLI guide, with all CLI commands grouped according to user
activities.
Appendix A, Alerts and Events Details
Provides detailed lists of all alerts and events.

11

Appendix B, Replacing the Default SSL Certificate


Provides instructions for replacing the default SSL certificate for the XMS with a
certificate issued by a trusted third party (Certificate Authority).
Appendix C, XtremIO WebUI (Web User Interface),
Provides instructions for accessing and using the XtremIO WebUI.

Note: For details on configuring hosts connected to the XtremIO storage, refer to the
XtremIO Host Configuration Guide.

12

EMC XtremIO Storage Array User Guide

CHAPTER 1
System Description
This chapter includes the following topics:

System Overview.....................................................................................................
X-Brick ....................................................................................................................
Scale-Out Architecture ............................................................................................
System Features......................................................................................................
XtremIO Management Server (XMS).........................................................................
System GUI .............................................................................................................
Command Line Interface..........................................................................................
RESTful API .............................................................................................................
Ports and Protocols .................................................................................................

System Description

14
15
16
17
27
28
28
28
29

13

System Description

System Overview
The XtremIO Storage Array is an all-flash system, based on a scale-out architecture. The
system uses building blocks, called X-Bricks, which can be clustered together, as shown in
Figure 2.
The system operation is controlled via a stand-alone dedicated Linux-based server, called
the XtremIO Management Server (XMS). Each XtremIO cluster requires its own XMS host,
which can be either an EMC-supplied physical server or a virtual server, deployed on a
customer-supplied server, running VMware ESX. The array continues operating if it is
disconnected from the XMS, but cannot be configured or monitored.
XtremIO's array architecture is specifically designed to deliver the full performance
potential of flash, while linearly scaling all resources such as CPU, RAM, SSDs, and host
ports in a balanced manner. This allows the array to achieve any desired performance
level, while maintaining consistency of performance that is critical to predictable
application behavior.
The XtremIO Storage Array provides a very high level of performance that is consistent over
time, system conditions and access patterns. It is designed for high granularity true
random I/O.
The cluster's performance level is not affected by its capacity utilization level, number of
Volumes, or aging effects. Moreover, performance is not based on a "shared cache"
architecture and therefore it is not affected by the dataset size or data access pattern.
Due to its content-aware storage architecture, XtremIO provides:

Even distribution of metadata

No data or metadata hotspots

Easy setup and no tuning

14

Even distribution of data blocks, inherently leading to maximum performance and


minimal flash wear

Advanced storage functionality, including Inline Data Deduplication and Compression,


thin provisioning, advanced data protection (XDP), Snapshots, and more

EMC XtremIO Storage Array User Guide

System Description

X-Brick
Figure 1 shows an X-Brick.
1U

Battery
Backup Unit

1U

Second
Storage Controller

2U

DAE

1U

First
Storage Controller

5U

Figure 1 X-Brick

An X-Brick is the basic building block of an XtremIO array.


Each X-Brick is comprised of:

One 2U Disk Array Enclosure (DAE), containing:


25 eMLC SSDs (standard X-Brick) or 13-25 eMLC SSDs (10TB Starter X-Brick [5TB])
Two redundant power supply units (PSUs)
Two redundant SAS interconnect modules

One Battery Backup Unit

Two 1U Storage Controllers (redundant storage processors)


Each Storage Controller includes:
Two redundant power supply units (PSUs)
Two 8Gb/s Fibre Channel (FC) ports
Two 10GbE iSCSI (SFP+) ports
Two 40Gb/s InfiniBand ports
One 1Gb/s management/IPMI port

Note: For details on X-Brick racking and cabinet requirements, refer to EMC XtremIO
Storage Array Site Preparation Guide.
Note: For details on required rack spaces for all cluster configurations refer to EMC
XtremIO System Specification.

X-Brick

15

System Description

Scale-Out Architecture
An XtremIO Storage Array can include a single X-Brick or a cluster of multiple X-Bricks, as
shown in Figure 2 and Table 1.

Figure 2 Cluster Configurations for Single, Two, Four, Six and Eight X-Brick clusters

Note: A 10TB Starter X-Brick (5TB) is physically similar to a single X-Brick cluster, except
for the number of SSDs in the DAE (13 SSDs in a 10TB Starter X-Brick [5TB] instead of 25
SSDs in a standard single X-Brick).
With clusters of two or more X-Bricks, XtremIO array uses a redundant 40Gb/s QDR
InfiniBand network for back-end connectivity between the Storage Controllers, ensuring a
highly available, ultra-low latency network. The InfiniBand network is a fully managed
component of the XtremIO array, and administrators of XtremIO arrays do not need to have
specialized skills in InfiniBand technology.

16

EMC XtremIO Storage Array User Guide

System Description

A single X-Brick cluster consists of:

One X-Brick

One additional Battery Backup Unit

A cluster of multiple X-Bricks consists of:

Two, four, six or eight X-Bricks

Two InfiniBand Switches

Table 1 Cluster Configurations as Single and Multiple X-Brick clusters


Single
X-Brick
cluster

Two X-Brick
cluster

Four X-Brick
cluster

Six X-Brick
cluster

Eight X-Brick
cluster

No. of X-Bricks

No. of InfiniBand
Switches

No. of Additional
Battery Backup Units

10TB Starter X-Brick (5TB)


XtremIOs 10TB Starter X-Brick (5TB) is identical to a standard X-Brick cluster, with the
exception that it is equipped with only 13 SSDs instead of 25. The 10TB Starter X-Brick
(5TB) may be expanded to a regular X-Brick, using a Starter X-Brick Expansion Kit which
includes additional 12 SSD units.

System Features
Scalable Performance
XtremIO is designed so as to scale out in order to meet future performance and capacity
needs, not only for new applications, but also for those already deployed. XtremIO's
architecture allows performance and capacity to be increased by adding building blocks
(X-Bricks), while maintaining a single point of management and balance of resources
across the cluster.
Scale out is an intrinsic part of the XtremIO's architecture and can be performed without a
forklift upgrade of the existing hardware or any need for prolonged data transfers.
When additional performance or capacity is required, the XtremIO Storage Array can be
scaled-out by adding additional X-Bricks. Multiple X-Bricks are joined together over a
redundant, high-availability, ultra-low latency InfiniBand network.
When the cluster expands, resources remain balanced, and data in the array is distributed
across all X-Bricks to maintain consistent performance and equivalent flash wear levels.

System Features

17

System Description

Storage capacity and performance scale linearly, such that two X-Bricks supply twice the
IOPS, four X-Bricks supply four times the IOPS, six X-Bricks supply six times the IOPS and
eight X-Bricks supply eight times the IOPS of the single X-Brick configuration. However, the
latency remains consistently low (less than 1ms) as the cluster scales out, as shown in
Figure 3.

Figure 3 Linear Performance Scalability with Consistent Low Latency

Even Data Distribution


To external applications, XtremIO appears and behaves like a standard block storage
array. However, due to its unique architecture, it takes a fundamentally different approach
to internal data organization. Instead of using logical addresses, XtremIO uses the block
content to decide where to place data blocks.
XtremIO uses data blocks internally. In a write operation, any data chunks that are larger
than the native block size are broken down into standard blocks when they first enter the
array. The system calculates a unique fingerprint for each of the incoming data blocks,
using a special mathematical algorithm.
This unique fingerprint is used for two primary purposes:

To determine where the data block is placed within the array

Inline Data Reduction

Because of the way the fingerprinting algorithm works, the ID numbers appear completely
random and are evenly distributed over the possible range of fingerprint values. This
results in an even distribution of data blocks across the entire cluster and all SSDs within
the array. In other words, with XtremIO it is neither necessary to check the space utilization
levels on different SSDs, nor to actively manage equal data writes to every SSD. XtremIO
inherently provides even distribution of data by placing the blocks based on their unique
IDs.

18

EMC XtremIO Storage Array User Guide

System Description

Inline Data Reduction


XtremIO's unique Inline Data Reduction is achieved by utilizing the following techniques:

Inline Data Deduplication

Inline Data Compression

Inline Data Deduplication


Inline data deduplication is the removal of redundancies from data before it is written to
the flash media.
XtremIO automatically and globally deduplicates data as it enters the system.
Deduplication is performed in real-time and not as a post-processing operation. With
XtremIO, there are no resource-consuming background processes and no additional
reads/writes (which are associated with post-processing). Therefore, it does not
negatively affect performance of the storage array, does not waste the available resources
that are allocated for the host I/O, and does not consume flash wear cycles.
With XtremIO, data blocks are stored according to their content, and not according to their
user level address within the Volumes. This ensures perfect load balancing across all
devices in the system in terms of capacity and performance. Each time a data block is
modified, it can be placed on any set of SSDs in the system, or not written at all if the
block's content is already known to the system.
The system inherently spreads the data across the array, using all SSDs evenly and
providing perfect wear leveling. Even if the same logical block address (LBA) is repeatedly
written by a host computer, each write is directed to a different location within the XtremIO
array. If the host writes the same data over and over again, it will be deduplicated,
resulting in no additional writes to the flash.
XtremIO uses a content-aware, globally deduplicated cache for highly efficient data
deduplication. The system's unique content-aware storage architecture enables achieving
a substantially larger cache size with a small DRAM allocation. Therefore, XtremIO is the
ideal solution for difficult data access patterns, such as the "boot storms" that are
common in virtual desktop (VDI) environments.
The system also uses the content fingerprints, not only for Inline Data Deduplication, but
also for uniform distribution of data blocks across the array. This provides inherent load
balancing for performance and enhances flash wear level efficiency, since the data never
needs to be rewritten or rebalanced.
Performing this process inline, and globally across the array, translates into fewer writes to
the SSDs. This increases SSD endurance and eliminates performance degradation that is
associated with post-processing deduplication.
XtremIO's Inline Data Deduplication and its intelligent data storage process ensure:

Balanced usage of the system resources, maximizing the system performance

Minimum amount of flash operations, maximizing the flash longevity

Equal data distribution, resulting in evenly balanced flash wear across the system

No system level garbage collection (as opposed to post-processing data reduction)

Smart usage of SSD capacity, minimizing storage costs

System Features

19

System Description

Inline Data Compression


Inline Data Compression is the compression of the already deduplicated data before it is
written to the flash media.
XtremIO automatically compresses data after all duplications have been removed. This
ensures that the compression is performed only for unique data blocks. Data compression
is performed in real-time and not as a post-processing operation.
The nature of the data set determines the overall compressibility rate. The compressed
data block is then stored on the array.
Compression reduces the total amount of physical data that needs to be written on the
SSD. This reduction minimizes the Write Amplification (WA) of the SSDs, thereby
improving the endurance of the flash array.
XtremIO's Inline Data Compression provides the following benefits:

Data compression is always inline and is never performed as a post-processing


activity. Therefore, the data is always written only once.
Compression is supported for a diverse variety of data sets (e.g. database data, VDI,
VSI environments, etc.).
Data compression complements data deduplication in many cases. For example, in a
VDI environment deduplication dramatically reduces the required capacity for cloned
desktops. Consequently, compression reduces the specific user data. As a result, an
increased number of VDI desktops can be managed by a single X-Brick.
Compression saves storage capacity by storing data blocks in the most efficient
manner.
When combined with XtremIO's powerful Snapshot capabilities, XtremIO can easily
support petabytes of functional application data.

Total Data Reduction


XtremIO's data deduplication and data compression complement each other. Data
deduplication reduces physical data, by eliminating redundant data blocks. Data
compression further reduces the data footprint, by eliminating data redundancy within the
binary level of each data block.

20

EMC XtremIO Storage Array User Guide

System Description

High Availability
Preventing data loss and maintaining service in case of multiple failures is one of the core
features in the architecture of XtremIO's All Flash Storage Array.
From the hardware perspective, no component is a single point of failure. Each Storage
Controller, DAE and InfiniBand Switch in the cluster is equipped with dual power supplies.
The cluster also has dual Battery Backup Units and dual network and data ports (in each
of the Storage Controllers). Two InfiniBand Switches are cross connected and create a dual
data fabric. Both the power input and the different data paths are constantly monitored,
and any failure triggers a recovery attempt or failover.
The software architecture is built in a similar way. Every piece of information that is not
committed to the SSD is kept in multiple locations, called Journals. Each software module
has its own Journal, which is not kept on the same Storage Controller, and can be used to
restore data in case of unexpected failure. Journals are regarded as highly important and
always kept on Storage Controllers with battery backed up power supplies. In case of a
problem with the Battery Backup Unit, the Journal fails over to another Storage Controller,
which is protected by another Battery Backup Unit. In case of global power failure, the
Battery Backup Units ensure that all Journals are written to vault drives in the Storage
Controllers and the cluster is turned off.
In addition, due to its scale-out design and the XDP data protection algorithm, each
X-Brick is preconfigured as a single redundancy group. This eliminates the need to select,
configure and tune redundancy groups.
XtremIO's Active-Active architecture is designed to ensure maximum performance and
consistent latency. The cluster includes a self-healing mechanism that attempts to recover
from any failure and resume full functionality. An attempt to restart a failed component is
performed once before a failover action. Storage Controller failover is carried out as the
last resort. Based on the nature of the failure, the cluster attempts to failover the relevant
software component, while maintaining the operation of other components, thus
minimizing the performance impact. The whole Storage Controller fails over only if
recovery attempts are not successful or if the cluster must act in the best interest of
protecting against data loss.
When a component that was temporarily unavailable recovers, a failback is initiated. This
process is carried out at the software component or Storage Controller level. An
anti-bounce mechanism prevents the cluster from failing back to an unstable component
or to a component that is under maintenance.

System Features

21

System Description

Non-Disruptive Upgrade
During Non-Disruptive Upgrades (NDU) of the XtremIO Operating System, the cluster
performs the upgrade procedure on a live cluster, updates all Storage Controllers in the
cluster, and restarts the cluster service. The NDU process takes less than 30 seconds.
Since the underlying Linux Kernel is active throughout the upgrade process, the hosts do
not detect any path disconnection during the application restart period.
In the rare case of a Linux kernel or firmware upgrade, it is possible to upgrade the XtremIO
All Flash Array without any service interruption and without any risk of data loss. The NDU
procedure is launched from the XtremIO Management Server and is able to upgrade the
XtremIO software and the underlying operating system and firmware.
During Linux/firmware NDU, the cluster automatically fails over a component and
upgrades its software. After completing the upgrade and verifying the component's
health, the cluster fails back to it and the process repeats itself on other components.
During the upgrade process the cluster is fully accessible, no data is lost, and the
performance impact is kept to minimum.

Thin Provisioning
XtremIO storage is natively thin provisioned, using a small internal block size. This
provides fine-grained resolution for the thin provisioned space.
All Volumes in the cluster are thin provisioned, meaning that the cluster consumes
capacity only when it is actually needed. XtremIO determines where to place the unique
data blocks physically inside the cluster after it calculates their fingerprint IDs. Therefore,
it never pre-allocates or thick-provisions storage space before writing.
As a result of XtremIO's content-aware architecture, blocks can be stored at any location in
the cluster (and only metadata is used to refer to their locations) and the data is written
only when unique blocks are received.
Therefore, unlike thin provisioning with many disk-oriented architectures, with XtremIO
there is no space creeping and no garbage collection. Furthermore, the issue of Volume
fragmentation over time is not applicable to XtremIO (as the blocks are scattered all over
the random-access array) and no defragmentation utilities are needed.
XtremIO's inherent thin provisioning also enables consistent performance and data
management across the entire life cycle of the Volumes, regardless of the cluster capacity
utilization or the write patterns to the cluster.

22

EMC XtremIO Storage Array User Guide

System Description

XtremIO Data Protection (XDP)


The XtremIO storage system provides "self-healing" double-parity data protection with a
very high efficiency.
The system requires very little capacity overhead for data protection and metadata space.
It does not require dedicated spare drives for rebuilds. Instead, it leverages the "hot
space" concept, where any free space available in the array can be utilized for failed drive
reconstructions. The system always reserves sufficient distributed capacity for performing
a single rebuild.
In a rare case of double SSD failure, even with a full capacity of data, the array uses the
free space to rebuild the data of one of the drives. It rebuilds the second drive once one of
the failed drives is replaced. If there is enough free space to rebuild the data of both
drives, it is performed simultaneously.
XtremIO maintains its performance, even at high capacity utilization, with minimal
capacity overhead. The system does not require mirroring schemes (and their associated
100% capacity overhead).
XtremIO requires far less reserved capacity for data protection, metadata storage,
Snapshots, spare drives and performance, leaving much more space for user data. This
lowers the cost per usable GB.
The XtremIO storage system provides:

N+2 data protection

Incredibly low data protection capacity overhead of 8%

Performance superior to any RAID algorithm (RAID 1, the RAID algorithm that is most
efficient for writes, requires over 60% more writes than XtremIO Data Protection.)
Flash endurance superior to any RAID algorithm, due to smaller amount of writes and
even distribution of data
Automatic rebuild in case of drive failure and faster rebuild times than traditional RAID
algorithms
Superior robustness with adaptive algorithms that fully protect incoming data, even
when failed drives exist in the system
Administrative ease through fail-in-place support

System Features

23

System Description

Snapshots (XtremIO Virtual Copies - XVC)


Snapshots are instantaneous copy images of Volume data with the state of the data
captured exactly as it appeared at the specific point in time that the Snapshot was
created, enabling users to save the Volume data state and then access the specific
Volume data whenever needed, including after the source Volume has changed.
A Snapshot can be taken either directly from a source Volume or from other Snapshots
within a source Volumes group (Volume Snapshot Group). XtremIO Snapshots are
inherently writeable, but can be created as read-only to maintain immutability.
The original copy of the data remains available without interruption, while the Snapshot
can be used to perform other functions on the data. Changes made to the Snapshots
source do not change or impact on the Snapshot data.
XtremIO's Snapshot technology is implemented by leveraging the content-aware
capabilities of the system (Inline Data Reduction), optimized for SSD media, with a unique
metadata tree structure that directs I/O to the right time stamp of the data. This allows
efficient snapshotting that can sustain high performance, while maximizing the media
endurance, both in terms of the ability to create multiple Snapshots and the amount of I/O
that a Snapshot can support.
When creating a Snapshot, the system generates a pointer to the ancestor metadata (of
the actual data in the system). Therefore, creating a Snapshot is a very quick operation
that does not have any impact on the system and does not consume any capacity.
Snapshot capacity consumption occurs only if a change requires writing a new unique
block.
XtremIO Snapshots are space-efficient both in terms of additional metadata consumed
and physical capacity. Snapshots are implemented, using redirect-on-write methodology,
where new writes to the source Volume (or Snapshot) are redirected to new locations, and
only metadata is updated to point to the new data location. This method guarantees no
performance degradation while Snapshots are created.
Snapshots can be accessed like any other Volume in the cluster in read write access
mode, and enable a wide range of uses, including:

24

Logical corruption protection Creating frequent Snapshots that are based on a


defined recovery point objective (RPO) interval enables you to utilize Snapshots for
recovery of logical data corruption. The Snapshots are saved in the system for as long
as deemed necessary, and remain available for recovery use, should logical data
corruption occur, thus enabling recovery of an earlier application state (prior to logical
data corruption occurrence) to a known point in time prior to the corruption of the
data.
Backups Presenting Snapshots to a backup server (or agent) enables offloading the
backup process from the production server.
Development and testing Taking Snapshots of the production data enables the user
to create multiple (space-efficient and high-performance) copies of the production
system for the development and testing purposes.
Clones Using persistent writable Snapshots enables achieving clone-like
capabilities. The Snapshots can act as clones of the production Volume to multiple
servers. Clone performance is identical to that of the production Volume.

EMC XtremIO Storage Array User Guide

System Description

Offline processing Snapshots can be used as a means to offload data processing


from the production server. For example, if you need to run a heavy process on data
(which may be detrimental to the production server's performance), you can use
Snapshots to create a recent copy of the production data and then mount it on a
different server. The process can then be run (on the other server), without consuming
the production server's resources.

XtremIO offers the following efficient tools for managing Snapshots and optimizing their
usability:

Consistency Groups Consistency Groups (CG) are used to create a consistent image
of a set of Volumes, usually used by a single application, such as database. With
XtremIO CGs, you can create a Snapshot of all Volumes in a group, using a single
command. This ensures that all Volumes are created at the same time. Many
operations that are applied on a single Volume can also be applied on a CG.
Snapshot Set A Snapshot Set is a group of Snapshots that were taken, using a
single command and represents a point in time of a group. A Snapshot Set can be the
result of a Snapshot taken on a CG, on another Snapshot Set or on a set of Volumes
that were selected manually. A Snapshot Set maintains a relationship with the
ancestor from which it was created.
Read-Only Snapshots By design, XtremIO Snapshots are regular Volumes and are
created as writable Snapshots. In order to satisfy the need for local backup and
immutable copies, there is an option to create a read-only Snapshot. A read-only
Snapshot can be mapped to an external host such as a backup application, but it is
not possible to write to it.
Scheduler The Scheduler can be used for local protection use cases. It can be
applied to a Volume, a CG or a Snapshot Set. Each Scheduler can be defined to run at
an interval of seconds, minutes or hours. Alternatively, it can be set to run at a specific
time of a day or a week. Each Scheduler has a retention policy, based on the number
of copies the customer would like to hold or based on the age of the oldest Snapshot.
Restore Using a single command, it is possible to restore a production Volume or a
CG from one of its descendant Snapshot Sets. The SCSI face of the production Volume
will be moved to a Snapshot of the required Snapshot Set without the need for the
host application to rescan and rediscover a new Volume.
Refresh The refresh command is a powerful tool for test and development
environments and for the offline processing use case. With a single command, a
Snapshot of the production Volume or CG is taken and the SCSI face of the Volume,
which was mapped to the test and development application, is moved to it. This
allows the test and development application to work on current data without the need
to copy data or to rescan.

System Features

25

System Description

VMware VAAI Integration


XtremIO is fully VAAI compliant, allowing vSphere server to offload I/O intensive work to
the XtremIO array and provide accelerated storage vMotion, VM provisioning, and thin
provisioning functionality.
In addition, XtremIO's VAAI integration improves the X-copy efficiency even further, by
making the whole operation metadata driven. With XtremIO, due to Inline Data Reduction
and in-memory metadata, no actual data blocks are copied during the X-copy command.
The cluster only creates new pointers to the existing data, and the entire process is carried
out in the Storage Controllers' memory. Therefore, it does not consume the resources of
the storage array and has no impact on the cluster performance.
For example, a VM image can be cloned extremely fast (even multiple times) with XtremIO.
The XtremIO features for VAAI support include:

Zero Blocks/Write Same


Used for zeroing-out disk regions (VMware term: HardwareAcceleratedInit).
This feature provides accelerated Volume formatting.

Clone Blocks/Full Copy/XCOPY


Used for copying or migrating data within the same physical array
(VMware term: HardwareAcceleratedMove).
On XtremIO, this allows VM cloning to take place almost instantaneously, without
affecting user I/O on active VMs.

Record based locking/Atomic Test & Set (ATS)


Used during creation and locking of files on a VMFS Volume, for example, during
powering-down/powering-up of VMs (VMware term: HardwareAcceleratedLocking).
This feature is designed to address access contention on ESX Volumes shared by
multiple VMs.

Block Delete/UNMAP/TRIM
Allows for unused space to be reclaimed, using the SCSI UNMAP feature
(VMware term: BlockDelete; vSphere 5.x only). This can also be performed manually,
in VMware version 5.1, using the vmkfstool command (for details, refer to VMware
documentation).

26

EMC XtremIO Storage Array User Guide

System Description

Data at Rest Encryption


Data at Rest Encryption is designed to protect customers data that is stored on
non-volatile media, such as SSD, in case it is removed from the XtremIO cluster or from the
customer premises.
The encryption is based on Self Encrypting Drives (SED). These drives have a special
designed hardware component that performs the encryption without causing any
performance degradation. The encryption key Media Encryption Key (MEK) is
generated on board the drive and never leaves the drive. When encryption is enabled, the
cluster generates an Authentication Key (AK) PIN that is used to lock and unlock the SSD
encryption. The Authentication Key is kept securely in the cluster and is used to unlock the
SSD during the system start. Removing an SSD from the cluster locks the SSD and renders
the media on it unreadable.
If there is a suspicion that the PIN was compromised or when a periodical key rollover is
required by regulations, a cluster re-encryption is performed to change the SSD
authentication PIN.
XtremIO supports these encryption capabilities on supported hardware after software
upgrade, even when the cluster is populated with data, without causing any data loss. The
Authentication Key can also be changed instantly without losing data.
The XtremIO cluster encrypts the data that is stored on the DAEs SSD and on the internal
Storage Controllers SSD.

XtremIO Management Server (XMS)


The XMS enables you to control and manage the XtremIO cluster, including:

Creating, and initializing new clusters

Monitoring cluster health and events

Monitoring cluster performance

Collecting cluster performance statistics

Providing GUI, CLI and RESTful API services to clients

Implementing Volume management and Data Protection Groups operation logic

Providing operational support functions such as stopping and starting the cluster or
any of the Storage Controllers
Collecting supporting materials (log bundle) on the cluster for support and offline
troubleshooting purposes

The XMS is preinstalled with the CLI and GUI. It can be installed on a dedicated physical
server, or as a VMware virtual host.
To ensure adequate communication between the XMS and the cluster, 1 Gbps connectivity
is required between the XMS and the clusters managed by the XMS.

XtremIO Management Server (XMS)

27

System Description

Since the XMS is not in the data path, it can be disconnected from the XtremIO cluster
without affecting the I/O. An XMS failure only affects monitoring and configuration
activities, such as creating and deleting Volumes. However, when using a virtual XMS, it is
possible to take advantage of VMware vSphere HA features to easily overcome such
failures.
Even if the entire XMS server is lost or destroyed, a new XMS can still be recovered and
rebuilt from the cluster. For more information, contact EMC Global Tech Support.

System GUI
The system GUI is implemented, using a Java client. The GUI client software communicates
with the XMS, using standard TCP/IP protocols, and can be used in any location that
allows the client to access the XMS.
The GUI provides easy-to-use tools for performing most of the cluster operations (certain
management operations must be performed, using the CLI). Additionally, operations on
multiple components, such as creating multiple Volumes, can only be performed using the
GUI.

Command Line Interface


The system's Command Line Interface (CLI) allows administrators and other XtremIO
cluster users to perform supported management operations. It is preinstalled on the XMS
and can be accessed, using the standard SSH protocol or via CLI window in the GUI.

RESTful API
The XtremIO's RESTful API allows HTTP-based interface for automation, orchestration,
query and provisioning of the system. With the RESTful API, third party applications can be
used to control and fully administer the array. Therefore, it allows flexible management
solutions to be developed for the XtremIO array.
For more information, refer to XtremIO Storage Array RESTful API Guide.

28

EMC XtremIO Storage Array User Guide

System Description

Ports and Protocols


Figure 4 describes the ports and protocols used by the XtremIO cluster.
X-Brick

Clients
CLI

GUI

RESTful
API
Storage Controller

HTTPS
(TCP/443)

HTTPS
(TCP/443)

HTTPS
(TCP/443)

NTP

XIOS

SSH
(TCP/22)

HTTPS
(TCP/443)

OS

ICMP

NTP
(UDP/
123)
IPV6
(TCP/
11112)

XMLRPC
(TCP/
11111
and
11000 11032)

SCSI
Targets

BMC

SSH
(TCP/22
and
22000 22032)

Fibre
Channel

ISCSI
(TCP/3260)

Hosts

IPMI
(TCP/23000-23032)

XMS
Reporting

UI

Connect
EMC

OS

NTP

XIOS
Authentication Manager

XMS

SSH
(TCP/22)
SNMP
(UDP/
162)

Syslog
(UDP/
514)
HTTPS
(TCP/
443)

HTTPS
(TCP/443)

HTTPS
(TCP/
443
& 8443)

SSH
(TCP/22)

FTPS
(TCP/
990
& 989)

SMTP
(TCP/25)

LDAP
(TCP/389 and 3268)
LDAPS
(TCP/636 and 3269)

HTTPS
(TCP/
443
& 8443)

Corporate
Active Directory
LDAP Server

Corporate
Email
Server

ESRS
GWs
Corporate
External
Logging
System

NTP
(UDP/123)

ESRS

NTP
Server

Figure 4 Ports and Protocols1

1. ICMP between the XMS and the Storage Controller is used for diagnostic purposes only.

Ports and Protocols

29

System Description

30

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

CHAPTER 2
Using the Graphical User Interface (GUI)
This chapter includes the following topics:

GUI Window ............................................................................................................ 32


Menu Bar Icons ....................................................................................................... 33
Accessing the GUI ................................................................................................... 34
Dashboard Workspace ............................................................................................ 44
Configuration Workspace ........................................................................................ 51
Inventory Workspace............................................................................................... 68
Alerts & Events Workspace ...................................................................................... 98
Reports Workspace ............................................................................................... 104
Administration Workspace .................................................................................... 106
Support Window ................................................................................................... 115
About Window ...................................................................................................... 116

31

Using the Graphical User Interface (GUI)

GUI Window
The XtremIO Storage Array provides a user-friendly GUI for managing and monitoring the
cluster, without the need to be familiar with the CLI. In addition, the GUI presents a
graphical representation of the clusters state.
The interface is divided into the following sections, as shown in Figure 5:

Menu bar - contains icons for selecting the workspace you want to work in, About
window and Logout.
Cluster display bar - provides the following:
List of the existing clusters in the system
Currently-visible cluster
Cluster locator (in case of a multiple-cluster configuration)

Workspace - contains the window panes through which you can monitor and manage
the cluster.
Status bar - shows the clusters connection status, XMS date and time zone, and the
current user name.

Menu Bar
Cluster Display Bar

Workspace

Status Bar
Figure 5 GUI Window Sections

32

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Menu Bar Icons


Table 2 explains the menu bar icons.
Table 2 Menu Bar Icons
Icon

Description
Dashboard
Displays the Dashboard Workspace (see page 44).

Configuration
Displays the Configuration Workspace (see page 51).

Inventory
Displays the Inventory Workspace (see page 68).

Alerts & Events


Displays the Alerts & Events Workspace (see page 98).

Reports
Displays the Reports Workspace (see page 104).

Administration
Displays the Administration Workspace (see page 106).

Support
Displays the Support Window (see page 115).

About
Displays the About Window (see page 116).

Logout
Enables you to log out of the XtremIO cluster and log in as a different user
(see Logging In as a Different User on page 311).

Menu Bar Icons

33

Using the Graphical User Interface (GUI)

Accessing the GUI


Note: For information on supported Java versions, refer to XtremIO Storage Array Release
Notes.
Note: The recommended screen resolution for viewing the XtremIO GUI is 1440 X 900 or
above. The minimum supported resolution is 1280 X 720.
To access the GUI:
1. In your browser, enter the IP address of the XMS, received from your system
administrator to display the XtremIO Splash screen, as shown in Figure 6.

Figure 6 XtremIO Splash Screen

2. If there are any Java interoperability issues, download the Java bundle (see Installing
a Local Java Bundle on page 39).
3. Click the root certificate hyperlink to download the certificate.

34

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

4. When prompted, select open to open the certificate file.

Figure 7 Certificate Dialog Box

5. In the Certificate dialog box, click Install Certificate.

Figure 8 Certificate Import Wizard - Welcome Screen

Accessing the GUI

35

Using the Graphical User Interface (GUI)

6. On the Certificate Import Wizard welcome screen, click Next.

Figure 9 Certificate Import Wizard - Certificate Store

7. In the Certificate Store screen, select the Place all certificates in the following store
option, and click Browse.

Figure 10 Select Certificate Store - Trusted Root Certification Authorities

8. In the Select Certificate Store dialog box, select the Trusted Root Certification
Authorities folder and click OK.

36

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

9.

In the Certificate Import Wizard, click Next.

Figure 11 Certificate Import Wizard - Finish Screen

10. Click Finish.


11. Repeat steps 2-9 and select Third-Party Root Certification Authorities as the Certificate
Store.

Figure 12 Select Certificate Store - Third-Party Root Certification Authorities

12. From the XtremIO splash screen, click Launch.


13. If you are asked to save the file webstart.jnlp, click Save and double-click the file to run it.

Accessing the GUI

37

Using the Graphical User Interface (GUI)

14. Wait for the application to load; the Login screen appears, as shown in Figure 13.

Figure 13 Login Screen

15. Enter your username and password as provided to you by your system/storage
administrator.
16. Click Login; the system launches the XtremIO Storage Management Application and
displays the Dashboard workspace, as shown in Figure 22.
Note: For details on replacing the default SSL certificate for the XMS with a certificate
issued by a trusted third party, refer to Replacing the Default SSL Certificate on
page 559.

38

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Installing a Local Java Bundle


For any Java interoperability issues, XtremIO provides a pre-packaged GUI UI Java bundle
to be downloaded, before logging in.
XtremIO offers Java bundles compatible with Windows and Macintosh Operating Systems.
Upon lunching the XtremIO GUI, the system detects the OS used by the clients and
provides a link to a compatible Java bundle.
To install the local Java bundle when using Windows OS:
1. In your browser, enter the IP address of the XMS, received from your system
administrator to display the XtremIO Splash screen, as shown in Figure 14.

Figure 14 XtremIO Splash Screen (Windows)

2. Click the Windows bundle link at the bottom of the splash screen.

Accessing the GUI

39

Using the Graphical User Interface (GUI)

3. When prompted, select open to view the zip folder contents.

Figure 15 Zip Folder Contents

4. Extract the XtremIO Storage Management Application Folder by selecting the folder
and clicking Extract. Use the browser to select a folder of your choice and click OK.
5. In your local folder, open the XtremIO Storage Management Application folder and
double-click XtremIO Launch.vbs; the XtremIO Login Screen appears, as shown in
Figure 16.

Figure 16 Login Screen

Note: It is recommended to create a shortcut to the XtremIO Launch.vbs file to make it


accessible whenever a login is required.

40

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

To install the local Java bundle when using Macintosh OS:


1. In your browser, enter the IP address of the XMS, received from your system
administrator, to display the XtremIO Splash screen, as shown in Figure 14.

Figure 17 XtremIO Splash Screen (Macintosh)

2. Click the Mac bundle link at the bottom of the splash screen.

Figure 18 File Download in Process

Accessing the GUI

41

Using the Graphical User Interface (GUI)

3. Wait for the dmg file to download.

Figure 19 File Download Completed

4. Double-click the dmg file to open the XtremIO Management Application folder.

Figure 20 XtremIO Management Application Folder

42

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

5. Double-click the icon in the XtremIO Management Application folder to launch the
XtremIO management application.

Figure 21 Login Screen

Accessing the GUI

43

Using the Graphical User Interface (GUI)

Dashboard Workspace
The Dashboard workspace, as shown in Figure 22, appears upon:

Logging in to the XtremIO Storage Management Application

Clicking the Dashboard icon from the Menu bar

Storage

Performance

Alerts

Figure 22 Dashboard Workspace - Single Cluster View

The Dashboard workspace is divided into the following panes:

44

Storage (see page 46)

Performance (see page 48)

Alerts (see page 49)

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Clicking Manage All Clusters displays the aggregated data of all clusters managed by the
XMS. The overall efficiency storage parameters are displayed for all clusters and
separately for each cluster.

Menu Bar
Cluster Selector
Display Order
Options
Aggregated
Storage Info

First Cluster
Storage Info

Second Cluster
Storage Info
Status Bar
Figure 23 Dashboard Workspace - Multiple Clusters View

Dashboard Workspace

45

Using the Graphical User Interface (GUI)

Storage Pane
Figure 24 shows the Storage pane of the Dashboard workspace for a single cluster view
(i.e. a single cluster configuration or, in a multiple cluster configuration, when a specific
cluster is selected from the clusters drop-down menu on the cluster display bar).

Figure 24 Storage Pane of the Dashboard Workspace - Single Cluster View

Via the Storage pane you can monitor the following parameters:

Overall Efficiency

Data Reduction Ratio


Data Deduplication
Data Compression

Thin Provisioning Savings

Volume Capacity (with a progress bar, showing used and free Volume capacity)

Physical Capacity (with a progress bar, showing used and free physical capacity)

46

Inventory (displaying a list of the clusters hardware components and links to the
components detailed data - see Managing the Hardware on page 129)

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

If a hardware component suffers from an alert, its color changes according to the alerts
severity:

Yellow - minor alert

Orange - major alert

Red - critical alert

The Storage pane of the Dashboard workspace for a multiple cluster view is displayed
when the Manage All Clusters option is selected from the clusters drop-down menu in the
Cluster Display bar. The Storage pane in a multiple cluster view displays information both
across all clusters and for each individual cluster. For details refer to Managing Multiple
Clusters Setting, Using the GUI on page 120.

Dashboard Workspace

47

Using the Graphical User Interface (GUI)

Performance Pane
Figure 25 shows the Performance pane of the Dashboard workspace and its main
elements.

Bandwidth Tab
IOPS Tab
Latency Tab
Most Active Items

Read Color Indicator


Write Color Indicator

Item Selector

Current
Total
Gauge

Time Period
Selector

History
Graph

Figure 25 Performance Pane of the Dashboard Workspace

Table 3 describes the main elements of the Performance pane.


Table 3 Performance Pane Main Elements

48

Element

Description

Bandwidth Tab

Displays the cluster performance with Bandwidth as the unit of measure


(MB/s).

IOPS Tab

Displays the cluster performance with IOPS as the unit of measure


(IOPS rate).

Latency Tab

Displays the cluster performance with Latency as the unit of measure (s).

Most Active Items

Displays the 7 most active Block Sizes, Initiator Groups or Volumes (as
selected in the Item Selector).

Read Color
Indicator

Indicates the Read color (pale blue).

Write Color
Indicator

Indicates the Write color (dark blue).

Current Total
Gauge

Indicates the aggregated transfer rate for all Volumes by MB/s or IOPS.

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Table 3 Performance Pane Main Elements


Element

Description

History Graph

Displays the performance history in terms of IOPS, Bandwidth or latency


(according to the selected tab) over a selected period of time.

Item Selector

Enables you to select the desired item to monitor (Block Size, Initiator Group
or Volume) from the drop-down list.

Time Period
Selector

Enables you to select the desired time period from the drop-down list (Last
Hour, Last 6 Hours, Last 24 Hours, Last 3 Days or Last Week) for the History
Graph.

Alerts Pane
Figure 26 shows the Alerts pane of the Dashboard workspace.

Figure 26 Alerts Pane of the Dashboard Workspace

The Alerts pane displays the current cluster alerts, which are color coded according to
severity:

Green - Cleared alert

Blue - Information alert

Yellow - Minor alert

Orange - Major alert

Red - Critical alert

For each alert the following details are listed:

Severity

Code

Date and Time

Entity

Entity Details

Description

Dashboard Workspace

49

Using the Graphical User Interface (GUI)

You can sort the displayed alerts by each of these column headings.
To sort the alerts by a column heading, click the heading; The arrow, displayed above the
selected heading indicates whether the sorting is in ascending or descending order.
Right-clicking the Alerts pane displays the Alerts drop-down menu, as shown in Figure 27

Figure 27 Alerts Pane Right-Click Drop-Down Menu

Table 4 describes the drop-down menus active options.


Table 4 Alerts Pane Drop-Down Menu Options
Icon

Description
Acknowledge Alert
Acknowledges the selected alert and removes it from the Alerts
list.
Modify Alert Definition
Enables you to change the selected alerts definition.
Copy Rows
Enables you to copy rows.
Copy Cell
Enables you to copy a cell.
Properties
Displays the selected alerts properties.

50

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Configuration Workspace
To access the Configuration workspace, click the Configuration icon in the menu bar.
The Configuration workspace consists of an entity list pane and a main view pane. Clicking
an entity from the list displays the list of defined entities and their details in the main
pane. Double-clicking an entity from the list opens the list of Tags that are defined for that
entity type.
The entity list consists of the following:

Volumes

Consistency Groups

Snapshot Sets

Initiator Groups

Initiators

Schedulers

Figure 28 shows the main panes in the Configuration Workspace.

Menu Bar

Object Details
Pane

Storage
Objects Tab

Related Objects
Pane
Summary Bar
Figure 28 Configuration Workspace

Configuration Workspace

51

Using the Graphical User Interface (GUI)

Volumes View
To open the Volumes view, click Volumes in the entity list.
Figure 29 shows the Volumes view.

Figure 29 Volumes View

52

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Table 5 describes the main icons in the Volumes View.


Table 5 Volumes View Icons
Icon

Description
Create Volume
Enables you to add new Volumes.
Create Snapshot
Enables you to create Snapshots of defined Volumes (also
available in the Volumes right-click menu).
Create/Modify Mapping
Maps the selected Volumes to the selected Initiator Groups
(also available in the Volumes right-click menu).
Add to Consistency Group
Adds the selected Volume to a Consistency Group (also
available in the Volumes right-click menu).
Create Scheduler
Enables you to create a scheduler for taking snapshots of
storage objects.
Manage Tags
Enables you to manage the selected Volumes Tags (also
available in the Volumes right-click menu).
View Menu
Enables you to select all items in the Initiators table.

The bottom pane provides separate tabs with details on the following Volume-related
elements:

Mapping

Volume Snapshot Groups

Consistency Groups

Snapshot Sets

Schedulers

Alerts

Configuration Workspace

53

Using the Graphical User Interface (GUI)

Volumes Right-Click Menu


Figure 30 shows the drop-down menu, which appears upon right-clicking an item in the
Volumes list.

Figure 30 Volumes List Right-Click Drop-Down Menu

54

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Table 6 describes the drop-down menus active options.


Table 6 Volumes Pane Drop-Down Menu Active Options
Icon

Description
Modify
Enables you to resize a Volume and to modify
the Volume alert settings.
Rename
Enables you to change the name of the selected
item.
Create/Modify Mapping
Enables you to map the selected Volumes to the
selected Initiator Groups.
Create Consistency Group
Enables you to create a new Consistency Group.
Add to Consistency Group
Enables you to add Volumes to a Consistency
Group.
Remove Volumes
Enables you to remove Volumes from a
Consistency Group.
Create Snapshot
Enables you to create a Snapshot of the
selected Volume.
Restore From Read-only Snapshot
Enables you to restore the selected Volume
from a read-only Snapshot.
Refresh this Volume
Enables you to refresh the selected Volume.
Create Scheduler
Enables you to create a Scheduler for
snapshotting Volumes/Snapshots.
Delete Schedulers
Enables you to delete Schedulers defined for
the Volume/Snapshot.
Delete
Enables you to delete the selected object.
Manage Tags
Enables you to manage the selected Volume
Tags.
Copy Rows
Enables you to copy rows.
Copy Cell
Enables you to copy a cell.

Configuration Workspace

55

Using the Graphical User Interface (GUI)

Consistency Groups View


To open the Consistency Groups view, click Consistency Groups in the entity list.
Figure 31 shows the Consistency Groups view.

Figure 31 Consistency Groups View

Table 7 describes the main icons in the Consistency Groups View.


Table 7 Consistency Groups View Icons
Icon

Description
Create Consistency Group
Enables you to add a new Consistency Group.
Create Snapshot
Enables you to create Snapshots of the defined Consistency
Groups (also available in the Consistency Group right-click
menu).
Create/Modify Mapping
Maps the selected Consistency Groups to the selected
Initiator Groups (also available in the Consistency Group
right-click menu).
Add Volumes
Enables you to add Volumes to the selected Consistency
Group (also available in the Consistency Group right-click
menu).
Manage Tags
Enables you to manage the selected Consistency Groups
Tags (also available in the Consistency Group right-click
menu).
View Menu
Enables you to select all items in the Initiators table.

56

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

The bottom pane provides separate tabs with details on the following
Consistency-Group-related elements:

Volumes

Mapping of Member Volumes

Snapshot Sets

Schedulers

Alerts

Consistency Group Right-Click Menu


Figure 32 shows the drop-down menu, which appears upon right-clicking an item in the
Consistency Groups pane.

Figure 32 Consistency Groups Pane Right-Click Drop-Down Menu

Configuration Workspace

57

Using the Graphical User Interface (GUI)

Table 8 describes the drop-down menus options.


Table 8 Consistency Groups Pane Drop-Down Menu Options
Icon

Description
Rename
Enables you to change the name of the selected item.
Create/Modify Mapping
Enables you to map the Volumes of the selected
Consistency Group to the selected Initiator Groups.
Add Volume to CG
Enables you to add a Volume to the selected
Consistency Group.
Remove Volumes
Enables you to remove a Volume from the selected
Consistency Group.
Create Snapshot
Enables you to create a Snapshot of the selected
Consistency Group.
Restore From Snapshot
Enables you to restore the selected Consistency Group
from a backup Snapshot.
Refresh this Consistency Group
Enable you to refresh the selected Consistency Group
from a Snapshot.
Create Scheduler
Enables you to create a Scheduler for snapshotting
Volumes in the selected Consistency Group.
Delete Schedulers
Enables you to delete defined Schedulers.
Delete
Enables you to delete the selected Consistency Group.
Manage Tags
Enables you to manage the selected Consistency
Groups Tags.
Copy Rows
Enables you to copy rows.
Copy Cell
Enables you to copy a cell.

58

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Snapshot Sets View


To open the Snapshot Sets view, click Snapshot Sets in the entity list.
Figure 33 shows the Snapshot Sets view.

Figure 33 Snapshot Sets View

Table 9 describes the main icons in the Snapshot Sets View.


Table 9 Snapshot Sets View Icons
Icon

Description
Create Snapshot
Enables you to create Snapshots of the selected Snapshot Set
(also available in the Snapshot Set right-click menu).
Refresh this Snapshot Set
Enables you to refresh the selected Snapshot Set.
Create/Modify Mapping
Maps the Snapshots in the selected Snapshot Set to the
selected Initiator Groups (also available in the Snapshot Set
right-click menu).
Manage Tags
Enables you to manage the selected Snapshot Sets Tags (also
available in the Snapshot Set right-click menu).
View Menu
Enables you to select all items in the Initiators table.

The bottom pane provides separate tabs with details on the following
Snapshot-Sets-related elements:

Volumes

Mapping of Member Volumes

Consistency Groups

Schedulers

Alerts
Configuration Workspace

59

Using the Graphical User Interface (GUI)

Snapshot Sets Right-Click Menu


Figure 34 shows the drop-down menu, which appears upon right-clicking an item in the
Snapshot Sets pane.

Figure 34 Snapshot Sets Pane Right-Click Drop-Down Menu

60

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Table 10 describes the drop-down menus options.


Table 10 Snapshot Sets Pane Drop-Down Menu Options
Icon

Description
Rename
Enables you to change the name of the selected Snapshot
Set.
Create/Modify Mapping
Enables you to map the Snapshots in the selected
Snapshot Set to the selected Initiator Groups.
Create Snapshot
Enables you to create Snapshots of the defined Snapshot
Sets.
Refresh this Snapshot Set
Enables you to refresh the selected Snapshot Set.
Create Scheduler
Enables you to create a Scheduler for snapshotting
Snapshots in the Selected Snapshot Set.
Delete Schedulers
Enables you to delete defined Schedulers.
Delete
Enables you to delete the selected Snapshot Set.
Manage Tags
Enables you to manage the selected Snapshot Sets Tags.
Copy Rows
Enables you to copy rows.
Copy Cell
Enables you to copy a cell.

Configuration Workspace

61

Using the Graphical User Interface (GUI)

Initiator Groups View


To open the Initiator Groups view, click Initiator Groups in the entity list.
Figure 35 shows the Initiator Groups view.

Figure 35 Initiator Groups View

Table 11 describes the main icons in the Initiator Groups View.


Table 11 Initiator Groups View Icons
Icon

Description
Create Initiator Group
Enables you to create a new Initiator Group.
Create/Modify Mapping
Maps the selected Initiator Group to selected Volumes
(also available in the Initiator Group right-click menu).
Refresh Initiators Connectivity
Scans the Initiators list and refreshes Initiators
connectivity display.
Manage Tags
Enables you to manage the selected Initiator Groups Tags
(also available in the Initiator Group right-click menu).
View Menu
Enables you to select all items in the Initiators table.

The bottom pane provides separate tabs with details on the following
Initiator-Groups-related elements:

62

Mapping

Initiators

Targets

Alerts

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Initiator Groups Right-Click Menu


Figure 36 shows the drop-down menu, which appears upon right-clicking an item in the
Initiator Groups pane.

Figure 36 Initiator Group Pane Right-Click Drop-Down Menu

Table 12 describes the drop-down menu icons.


Table 12 Initiator Groups Pane Drop-Down Menu Options
Icon

Description
Modify Initiator Group
Enables you to modify the properties of the selected
Initiator Group, and to add or remove Initiators.
Create/Modify Mapping
Maps the selected Initiator Group to selected Volumes.
Rename
Enables you to change the name of the selected Initiator
Group.
Delete
Enables you to delete the selected Initiator Group.
Manage Tags
Enables you to manage the selected Initiator Group Tags.
Copy Rows
Enables you to copy rows.
Copy Cell
Enables you to copy a cell.

Configuration Workspace

63

Using the Graphical User Interface (GUI)

Initiators View
To open the Initiators view, click Initiators in the entity list.
Figure 37 shows the Initiators view.

Figure 37 Initiators View

Table 13 describes the main icons in the Initiators View.


Table 13 Initiators View Icons
Icon

Description
Refresh Initiators Connectivity
Scans the Initiators list and refreshes Initiators
connectivity display.
Manage Tags
Enables you to manage the selected Initiators Tags (also
available via Initiators right-click menu).
View Menu
Enables you to select all items in the Initiators table.

The bottom pane provides separate tabs with details on the following Initiators-related
elements:

64

Targets

Alerts

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Initiators Right-Click Menu


Figure 38 shows the drop-down menu, which appears upon right-clicking an item in the
Initiators pane.

Figure 38 Initiators Right-Click Drop-Down Menu

Table 14 describes the drop-down menu icons.


Table 14 Initiators Pane Drop-Down Menu Options
Icon

Description
Configure CHAP
Enables you to configure the Challenge-Handshake
Authentication Protocol.
Rename
Enables you to change the name of the selected Initiator.
Manage Tags
Enables you to manage the selected Initiator Tags.
Copy Rows
Enables you to copy rows.
Copy Cell
Enables you to copy a cell.

Configuration Workspace

65

Using the Graphical User Interface (GUI)

Schedulers View
To open the Schedulers view, click Schedulers in the entity list.
Figure Figure 39 shows the Schedulers view.

Figure 39 Schedulers View

Table 15 describes the main icons in the Schedulers View.


Table 15 Schedulers View Icons
Icon

Description
Manage Tags
Enables you to manage the selected Schedulers Tags (also
available via Schedulers right-click menu).
View Menu
Enables you to select all items in the Schedulers table.

The bottom pane provides details on Schedulers-related alerts.

66

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Schedulers Right-Click Menu


Figure 40 shows the drop-down menu, which appears upon right-clicking an item in the
Schedulers pane.

Figure 40 Schedulers Right-Click Drop-Down Menu

Table 16 describes the drop-down menu icons.


Table 16 Schedulers Right-Click Menu Icons
Icon

Description
Modify Snapshot Scheduler
Enables you to modify the selected Scheduler parameters.
Rename
Enables you to change the name of the selected Scheduler.
Delete
Enables you to delete the selected Scheduler.
Resume Scheduler
Enables you to reactivate a suspended Scheduler.
Suspend Scheduler
Enables you to suspend an active Scheduler.
Manage Tags
Enables you to manage the selected Scheduler Tags.
Copy Rows
Enables you to copy rows.
Copy Cell
Enables you to copy a cell.

Configuration Workspace

67

Using the Graphical User Interface (GUI)

Inventory Workspace
Figure 41 shows the Inventory Workspace.
To access the Inventory workspace, click the Inventory icon in the menu bar.
Cluster View
Toggle
Buttons

Cluster
Selection

Encryption
Indicator
X-Brick Pane
Menu Bar

X-Brick
Selection

X-Brick
Details
Pane

Figure 41 Inventory Workspace

The Inventory workspace has two display options:

Graphical View

Table View

You can set the desired view, using the Cluster View toggle buttons.
Table 17 describes the main icons of the Cluster View Toggle Buttons.
Table 17 Cluster View Toggle Buttons Icons
Icon

Description
Table View
Displays the inventory list of the X-Brick and its components.
Graphical View
Displays the graphic image of the X-Brick and its components
(default view).

68

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Inventory Graphical View


To open the clusters Inventory graphical view, click the Graphical View icon in the Cluster
View Toggle Buttons (see Table 17).
The Inventory workspace graphical view consists of the following sections:

Cluster Selection - displays the cluster or clusters in the system and the currently
managed cluster.
X-Brick Selection - displays the X-Bricks of the managed cluster and allows the user to
select an X-Brick to be presented in detail in the X-Brick Details pane.
Encryption Indicator - indicates the current encryption status of the selected X-Brick.
X-Brick Pane Menu Bar - provides options for manipulating the X-Brick Details pane
display, as detailed in Table 20.

If a hardware component has a pending alert, its color changes according to the alerts
severity:

Yellow - minor alert

Orange - major alert

Red - critical alert

In a multiple X-Brick cluster, selecting an X-Brick or an InfiniBand Switch in the Cluster


pane (on the left) displays the details of the selected component in the X-Brick pane on
the right.
Hovering the mouse pointer over the a cluster, X-Brick or hardware component displays a
tool-tip with information and status, as shown in Figure 42.

Figure 42 Hovering the Mouse Cursor over the Hardware Component to View its Status

Inventory Workspace

69

Using the Graphical User Interface (GUI)

Hardware Drop-Down Menu Options


Table 18 describes the active options of drop-down menus, which appear upon
right-clicking a hardware component.
Table 18 Hardware Drop-Down Menu Active Options
Icon

Description
Turn On Identification LED for...
Turns on the identification LED of the
selected component.
Change All Other Identification LEDs
Turns on/off the identification LEDs of all but
the selected component.
Add SSD
Enables you to add an SSD to the cluster
(appears when right-clicking an SSD).
Remove SSD
Enables you to remove an SSD from the
cluster (appears when right-clicking an SSD).
Display Alerts
Displays alerts for the selected item.

70

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Hardware Components LEDs


Many of the XtremIO Storage Array hardware components are equipped with two LED types
that enable you to monitor the components health:

Identification LED - Used to identify a component in the cluster.

Status LED - Used to indicate the status of the component.

In addition to the actual LEDs on the physical hardware components, identical graphical
representation of the LEDs appears in the GUIs hardware image.
The possible states of the LEDs are:

Off

Steady On/Blink On (depending on the LED type)

Table 19 provides details of the hardware components LEDs.


Table 19 Hardware Components LEDs
Component

Identification LED

Identification LED
Possible States

Status LED

Storage Controller

Yes

Steady On, off

Yes

Storage Controller SSD

Yes

Steady On, off

Yes

Storage Controller HDD

Yes

Steady On, off

Yes

Storage Controller PSU & Fan

No

N/A

Yes

DAE

Yes

Blink On, off

Yes

DAE SSD

Yes

Blink On, off

Yes (called "Data LED")

DAE Controller

Yes

Blink On, off

Yes

DAE PSU & Fan

No

N/A

Yes

Battery Backup Unit

No

N/A

Yes

InfiniBand Switch

No

N/A

Yes

InfiniBand Switch PSU

No

N/A

Yes

InfiniBand Switch Fan

No

N/A

Yes

Physical XMS

No

N/A

Yes

Physical XMS PSU & Fan

No

N/A

Yes

Inventory Workspace

71

Using the Graphical User Interface (GUI)

Using the GUI to Activate the Identification LEDs


You can identify a component in the cluster, using the following methods:

Turning on the components identification LED


Turning on the LEDs of all other components of the same type (all but the selected
component), if the component has failed and does not respond

To turn on a components identification LED:


1. On the dashboard menu bar, click the Inventory icon.
2. Hover the mouse pointer over the relevant hardware component and right-click to
open the drop-down menu.
3. Select Turn On Identification LED for <components name>; a message appears, stating
that the components LED will be turned On/Off.

Figure 43 Turn On LED

4. Click OK.
Note: If the components identification LED is already turned on, a check sign appears
next to the Turn On Identification LED option and the message box that follows states
that the LED will be turned off.
To turn all other identification LEDs on or off:
1. On the dashboard menu bar, click the Hardware icon.
2. Hover the mouse pointer over the relevant hardware component and right-click to
open the drop-down menu.
3. Select Change all other <component type> Identification LEDs.

Figure 44 Change All Other LEDs

4. In the Change All Other Identification LEDs dialog box, select the desired state of the
LEDs (On or Off) and click OK; the LEDs of all components, except for the LED of the
component you want to identify, change their state.

72

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Graphical View Main Elements


Table 20 describes the main icons in the X-Brick pane Menu Bar when Graphical View is
selected .
Table 20 X-Brick Pane Menu Bar Options (Graphical View)
Icon

Description
Show Front
Displays the front side view of the hardware.
Show Back
Displays the back side view of the hardware.
Customize View
Enables you to show/conceal the status LEDs. When the Show
Cable Connectivity option is selected, Customize View provides
a rich dialog for selecting which cables to display and in what
manner (for details, refer to Hardware Customize view).
Show Cable Connectivity
Displays the cable connectivity scheme on the back side of the
hardware, as shown in Figure 47.

Figure 45, Figure 46 and Figure 47 show the possible displays of the Inventory workspace
when Graphical View is selected.

Figure 45 Hardware Front View

Inventory Workspace

73

Using the Graphical User Interface (GUI)

Figure 46 Hardware Back View

Figure 47 Hardware Back View with Cable Connectivity

74

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Hardware Customize view


The Customize View option provides different results according to context:

When the front or the back view are displayed, clicking Customize View enables you to
show the displayed hardware components fault LEDs.

Figure 48 Customize View - Front or Back View

When Cable Connectivity is displayed, clicking Customize View enables you to show
the fault LEDs of the displayed components, and to set the following connectivity
display parameters:
Displayed connectivity line type
Displayed connectivity type group
Displayed connectivity types
Connectivity display colors

Figure 49 Customize View - Cable Connectivity

Inventory Workspace

75

Using the Graphical User Interface (GUI)

Inventory Table View


To open the clusters Inventory table view, click the Table View icon in the Cluster View
Toggle Buttons (see Table 17).

Component
Details

Inventory
List Pane

Related
Entities
Data
Summary
Figure 50 Cluster Table View

Table 21 describes the main icons in the X-Brick pane Menu Bar when Table View is
selected.
Table 21 X-Brick Pane Menu Bar Options (Table View)
Icon

Description
Configure Cluster
Enables you to configure the selected clusters properties
(available only when the Clusters window is open). See
Cluster Configuration on page 94.
Manage Tags
Enables you to manage the selected Schedulers Tags (also
available via Schedulers right-click menu).
View Menu
Enables you to select all items in the Schedulers table.

The Inventory List View provides details on the clusters components. The following
windows are displayed:

76

Inventory List pane - displays a list of all clusters components and their quantities.
Component - displays a table of all instances of the selected component and provides
detailed component data.
Related entities - displays a table of entities that are relevant to the selected
component and provides relevant data on each entity.
Data summary - summarizes the number of displayed components and selected
components.

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Clusters View
To open the Clusters view, click Clusters in the Inventory List pane.
Figure 51 shows the Clusters view.

Figure 51 Inventory List - Clusters View

Table 22 describes the main icons in the Clusters View.


Table 22 Clusters View Icons
Icon

Description
Configure Cluster
Enables you to configure the selected clusters properties (also
available via Clusters right-click menu). See Cluster
Configuration on page 94.
Manage Tags
Enables you to manage the selected clusters Tags (also
available via Clusters right-click menu).
View Menu
Enables you to view more information or select all rows (see
Table 23).

Table 23 describes the icons in the View Menu drop-down menu.


Table 23 View Menu Drop-Down Menu Icons
Icon

Description
Select all rows
Enables you to select all the rows in the Component
Details pane. You can also select all rows, using Ctrl A.

Show more/less info


Enables you to control the amount of data displayed for
the selected component.

Inventory Workspace

77

Using the Graphical User Interface (GUI)

The following data is provided for each cluster:

Cluster Name

Cluster PSNT

Cluster Software Version

Cluster State

Cluster Health State

Total Physical Capacity

Used Physical Capacity (percentage)

Free Physical Capacity

Number of Volumes

Cluster Connection State

Cluster Tags

Clicking the Show More Info icon (see Table 23) displays the following additional
information for each Cluster:

78

Cluster Stop Reason

Encryption Supported

Used Physical Capacity

Encryption Mode

Free Physical Capacity (percentage)

CHAP Authentication Mode

Total Logical Capacity

CHAP Discovery Mode

Used Logical Capacity

ODX Mode

Used Logical Capacity (percentage)

SC FP Temperature Monitoring Mode

Free Logical Capacity

Thin Provisioning Soft Limit

Free Logical Capacity (percentage)

Start Time

Deduplication

Activation Time

Compression

Upgrade State

Data Reduction Ratio

OS Upgrade

Thin Provisioning Savings (percentage)

Expansion

Overall Efficiency

PSNT Part Number

SSH Firewall Mode

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Figure 52 shows the drop-down menu, which appears upon right-clicking an item in the
Clusters table.

Figure 52 Cluster Table Right-Click Menu

Table 24 describes the drop-down menu icons.


Table 24 Cluster View Right-Click Menu Icons
Icon

Description
Configure Cluster
Enables you to configure the selected cluster properties.
See Cluster Configuration on page 94.
Maintenance
Displays a drop-down menu with cluster maintenance
options (see Table 25).
Rename
Enables you to change the name of the selected cluster.
Manage Tags
Enables you to assign a Tag to the selected cluster.
Copy Rows
Enables you to copy rows.
Copy Cell
Enables you to copy a cell.

Table 25 describes the options in the Maintenance drop-down menu.


Table 25 Cluster Maintenance Drop-Down Menu Icons
Icon

Description
Stop Cluster
Enables you to stop the Cluster. This option appears when
the cluster is active.
Start Cluster
Enables you to start a stopped Cluster. This option appears
when the cluster is stopped.
Power-Off
Enables you to power-off the Cluster.

Inventory Workspace

79

Using the Graphical User Interface (GUI)

The following related entities are displayed:

X-Bricks

Storage Controllers

InfiniBand Switches

SSDs

Battery Backup Units

XEnvs

Alerts

X-Bricks View
To display the X-Bricks window, click X-Bricks in the Inventory List pane.

Figure 53 Inventory List - X-Bricks View

The following data is provided for each X-Brick:

X-Brick name

Cluster name (in a multiple cluster setting)

X-Brick Tags

Figure 54 shows the drop-down menu, which appears upon right-clicking an item in the
X-Bricks table.

Figure 54 X-Brick Table Right-Click Menu

80

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Table 26 describes the drop-down menu icons.


Table 26 X-Brick View Right-Click Menu Icons
Icon

Description
Rename
Enables you to change the name of the selected X-Brick.
Manage Tags
Enables you to assign a Tag to the selected X-Brick.
Copy Rows
Enables you to copy rows.
Copy Cell
Enables you to copy a cell.

The following related entities are displayed:

Storage Controllers

Data Protection Groups

DAE Controllers

Slots

SSDs

Battery Backup Units

Alerts

Storage Controllers View


To display the Storage Controllers window, click Storage Controllers in the Inventory List
pane.

Figure 55 Inventory List - Storage Controllers View

Inventory Workspace

81

Using the Graphical User Interface (GUI)

The following data is provided for each Storage Controller:

Storage Controller Name

Cluster Name (in multiple Cluster settings)

Management Address

Lifecycle State

Health State

Enabled State

Connection State

Stop Reason

SAS1 Port State

SAS1 Port Rate

SAS2 Port State

SAS2 Port Rate

Serial Number

Tags

Clicking the Show More Info icon (see Table 23) displays the following additional
information for each Storage Controller:

82

SAS1 Port Health Level

Management Port Auto-Negotiation Mode

SAS2 Port Health Level

Management Port Duplex

Hosting SYM (is a sym)

Management Link Health Level

IB Address 1

SW Version

IB Address 2

SW Build

Upgrade State

OS Version

Date-Time + TZ

FW Version Error

Gateway Address

HW Model

Management Port State

Part Number

Management Port Speed

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Figure 56 shows the drop-down menu, which appears upon right-clicking an item in the
Storage Controllers table.

Figure 56 Storage Controllers Table Right-Click Menu

Table 27 describes the drop-down menu icons.


Table 27 Storage Controllers View Right-Click Menu Icons
Icon

Description
Turn On Identification LED for
Storage Controller
Turns on the identification
LED of the selected Storage
Controller.
Change All Other Storage
Controllers Identification
LEDs
Turns on/off the
identification LEDs of all but
the selected Storage
Controller.
Rename
Enables you to change the
name of the selected Storage
Controller.
Manage Tags
Enables you to assign a Tag to
the selected Storage
Controller.
Copy Rows
Enables you to copy rows.
Copy Cell
Enables you to copy a cell.

The following related entities are displayed:

Local Disks

Storage Controller Power Supply

Targets

XEnvs

Alerts
Inventory Workspace

83

Using the Graphical User Interface (GUI)

Data Protection Groups View


To display the Data Protection Groups window, click Data Protection Groups in the
Inventory List pane.

Figure 57 Inventory List - Data Protection Groups View

The following data is provided for each DPG:

DGP Name

Cluster Name (in multiple Cluster settings)

DPG Protection State

Rebuild Progress (percentage)

SSD Preparation Progress (percentage)

Proactive Metadata Loading

Total SSD Size

Useful SSD Space

User Space

In Use User Space

Free User space (percentage)

Free User space level

Tags

Clicking the Show More Info icon (see Table 23) displays the following additional
information for each Storage Controller:

84

Available Rebuilds

Rebuild Prevention Reason

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Figure 58 shows the drop-down menu, which appears upon right-clicking an item in the
Data Protection Group table.

Figure 58 Data Protection Group Table Right-Click Menu

Table 28 describes the drop-down menu icons.


Table 28 Data Protection Group View Right-Click Menu Icons
Icon

Description
Rename
Enables you to change the name of the selected Data
Protection Group.
Manage Tags
Enables you to assign a Tag to the selected Data Protection
Group.
Copy Rows
Enables you to copy rows.
Copy Cell
Enables you to copy a cell.

The following related entities are displayed:

SSDs

Alerts

Inventory Workspace

85

Using the Graphical User Interface (GUI)

DAEs View
To display the DAEs window, click DAEs in the Inventory List pane.

Figure 59 Inventory List - DAEs View

The following data is provided for each DAE:

DAE Name

Cluster Name (in multiple Cluster settings)

X-Brick Name

Lifecycle State

Product Model

Serial Number

Tags

Clicking the Show More Info icon (see Table 23) displays the following additional
information for each Storage Controller:

86

Part Number

FW Version

HW Revision

Status LED

Identify LED

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Figure 60 shows the drop-down menu, which appears upon right-clicking an item in the
DAEs table.

Figure 60 DAEs Table Right-Click Menu

Table 29 describes the drop-down menu icons.


Table 29 DAEs View Right-Click Menu Icons
Icon

Description
Turn On Identification LED for DAE
Turns on the identification LED of the
selected DAE.
Change All Other DAE Identification LEDs
Turns on/off the identification LEDs of all but
the selected DAE.
Rename
Enables you to change the name of the
selected DAE.
Manage Tags
Enables you to assign a Tag to the selected
DAE.
Copy Rows
Enables you to copy rows.
Copy Cell
Enables you to copy a cell.

The following related entities are displayed:

DAE Controllers

DAE Power Supply

Alerts

Inventory Workspace

87

Using the Graphical User Interface (GUI)

SSDs View
To display the SSDs window, click SSDs in the Inventory List pane.

Figure 61 Inventory List - SSDs View

The following data is provided for each SSD:

SSD Index

DPG State

Slot

Lifecycle State

Cluster Name (In multiple Cluster settings)

Endurance Remaining (percentage)

X-Brick Name

Encryption State

WWN

Enabled State

Connection State

Product Model

Size

Serial Number

Space In Use

Tags

Clicking the Show More Info icon (see Table 23) displays the following additional
information for each Storage Controller:

88

Health State

Part Number

Failure Reason

Status LED

FW Version

Identify LED

FW Version Error

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Figure 62 shows the drop-down menu, which appears upon right-clicking an item in the
SSDs table.

Figure 62 SSDs Table Right-Click Menu

Table 30 describes the drop-down menu icons.


Table 30 SSDs View Right-Click Menu Icons
Icon

Description
Turn On Identification LED for SSD
Turns on the identification LED of the
selected SSD.
Change All Other SSD Identification LEDs
Turns on/off the identification LEDs of all but
the selected SSD.
Add SSD
Enables you to add a new SSD to the list.
Remove SSD
Enables you to remove an SSD from the list.
Rename
Enables you to change the name of the
selected SSD.
Manage Tags
Enables you to assign a Tag to the selected
SSD.
Copy Rows
Enables you to copy rows.
Copy Cell
Enables you to copy a cell.

The bottom pane displays SSD-related alert information.

Inventory Workspace

89

Using the Graphical User Interface (GUI)

Targets View
To display the Targets window, click Targets in the Inventory List pane.

Figure 63 Inventory List - Targets View

The following data is provided for each Target:

Target Name

Cluster Name (in multiple Cluster settings)

Port Type

Port State

Port Speed

Port Address

Number of Portals

Tags

Clicking the Show More Info icon (see Table 23) displays the following additional
information for each Storage Controller:

90

Jumbo Frames Enabled

MTU

Port MAC Address

Port Health Level

Error Reason

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Figure 64 shows the drop-down menu, which appears upon right-clicking an item in the
Targets table.

Figure 64 Targets Table Right-Click Menu

Table 31 describes the drop-down menu icons.


Table 31 Targets View Right-Click Menu Icons
Icon

Description
Rename
Enables you to change the name of the selected
Target.
Manage Tags
Enables you to assign a Tag to the selected Target.
Copy Rows
Enables you to copy rows.
Copy Cell
Enables you to copy a cell.

The following related entities are displayed:

Portals

Alerts

Inventory Workspace

91

Using the Graphical User Interface (GUI)

Battery Backup Units View


To display the Battery Backup Units window, click Battery Backup Units in the Inventory
List pane.

Figure 65 Inventory List - Battery Backup Units View

The following data is provided for each BBU:

BBU Name

Cluster Name (in multiple Cluster settings)

Input

Lifecycle State

Connection State

Power Feed

Battery Charge Percent Level

Load Percent Level

Load Level

Serial Number

Tags

Clicking the Show More Info icon (see Table 23) displays the following additional
information for each Storage Controller:

92

Voltage

Product Model

Part Number

FW Version

FW Version Error

HW Revision

Enabled State

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Figure 66 shows the drop-down menu, which appears upon right-clicking an item in the
BBUs table.

Figure 66 BBUs Table Right-Click Menu

Table 32 describes the drop-down menu icons.


Table 32 BBUs View Right-Click Menu Icons
Icon

Description
Rename
Enables you to change the name of the selected BBU.
Manage Tags
Enables you to assign a Tag to the selected BBU.
Copy Rows
Enables you to copy rows.
Copy Cell
Enables you to copy a cell.

The bottom pane displays Battery-Backup-Unit-related alert information.

Inventory Workspace

93

Using the Graphical User Interface (GUI)

Cluster Configuration
To access the Configure Cluster window:
1. On the menu bar, click the Inventory icon.
2. On the Inventory menu bar, click Table View.
3. In the Inventory List tab, click Clusters.
4. Click a cluster to select it and click Configure in the menu bar (you can also right-click
a cluster on the list and select Configure from the drop-down menu).
The Configure Cluster window includes the following tabs:

iSCSI Network Configuration

iSCSI Ports Configuration

iSCSI Security Configuration

VAAI TP Limit

ODX Mode Configuration

Encryption

iSCSI Network Configuration Tab


Figure 67 shows the iSCSI Network Configuration tab of the Configure Cluster window.

Figure 67 Configure Cluster - iSCSI Network Configuration Tab

94

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

iSCSI Ports Configuration Tab


Figure 68 shows the iSCSI Ports Configuration tab of the Configure Cluster window.

Figure 68 Configure Cluster - iSCSI Ports Configuration Tab

iSCSI Security Configuration Tab


Figure 69 shows the iSCSI Security Configuration tab of the Configure Cluster window.

Figure 69 Configure Cluster - iSCSI Security Configuration Tab

Inventory Workspace

95

Using the Graphical User Interface (GUI)

VAAI TP Limit Tab


Figure 70 shows the VAAI TP Limit tab of the Configure Cluster window.

Figure 70 Configure Cluster - VAAI TP Limit Tab

ODX Mode Configuration Tab


Figure 71 shows the ODX Mode Configuration tab of the Configure Cluster window.

Figure 71 Configure Cluster - ODX Mode Configuration Tab

96

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Encryption Tab
Figure 72 shows the Encryption tab of the Configure Cluster window.

Figure 72 Configure Cluster - Encryption Tab

Inventory Workspace

97

Using the Graphical User Interface (GUI)

Alerts & Events Workspace


Figure 73 shows the Alerts & Events workspace (with the Alerts tab selected).
To access the Alerts & Events workspace, click the Alerts & Events icon on the menu bar.

Figure 73 Alerts Tab in Alerts & Events Workspace

98

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Alerts Tab
Figure 74 shows the main elements and icons of the Alerts tab in the Alerts & Events
workspace.
Alerts Tab
Events Tab

Search Alerts
Text Box

Display Alert
Definitions

Hide
Acknowledged
Alerts Checkbox

Acknowledge
Alert

Figure 74 Main Elements and Icons of the Alerts Tab

Table 33 describes the Alerts tab elements and icons.


Table 33 Alerts Tab Elements and Icons
Icon

Description
Search Alerts Text Box
Enables you to filter the alerts display by typing a
search string. The cluster displays only alerts that
match the search string.
Hide Acknowledged Alerts
Enables you to remove the acknowledged alerts
from the display.
Display Alert Definitions
Displays Alert Definitions.
Acknowledge Alert
Acknowledges the selected alert.

Alerts & Events Workspace

99

Using the Graphical User Interface (GUI)

The Alerts pane displays the managed cluster alerts, which are color coded according to
severity:

Green - Cleared alert

Blue - Information alert

Yellow - Minor alert

Orange - Major alert

Red - Critical alert

For each alert, the following details are listed:

Severity

Code

Date and Time

Entity

Entity Details

Description

You can sort the displayed alerts by each of these column headings.
To sort the alerts by a column heading, click the heading. The arrow, displayed above the
selected heading, indicates whether the sorting is in ascending or descending order.
Right-clicking the Alerts pane displays the Alerts drop-down menu, as shown in Figure 75

Figure 75 Alerts Pane Right-Click Drop-Down Menu

100

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Table 34 describes the drop-down menus active options.


Table 34 Alerts Pane Drop-Down Menu Options
Icon

Description
Acknowledge Alert
Acknowledges the selected alert.
Modify Alert Definition
Enables you to change the selected alerts definition.
Copy Rows
Enables you to copy rows.
Copy Cell
Enables you to copy a cell.
Properties
Displays the selected alerts properties.

Alerts & Events Workspace

101

Using the Graphical User Interface (GUI)

Events Tab
Figure 76 shows the Events tab in the Alerts & Events Workspace.
Alerts Tab
Events Tab

Display Event Handlers


Stop Refresh

Filters

Events Display

Display Info

Figure 76 Events Tab

The Events tab consists of the following sections:

Filters - Includes the filters you can use to determine which events are displayed.

Events Display - Displays the constantly-updated events list.

Display Info - Shows the currently-displayed page number. You can browse the events
list by selecting a different page number or clicking Next and Previous to move
forward and backward, respectively, through the list.

The Events Display pane shows the clusters current events, which are color coded
according to severity:

102

Blue - Information event

Yellow - Minor event

Orange - Major event

Red - Critical event

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Table 35 describes the parameters that are provided for each event.
Table 35 Event Parameters
Event Parameter

Description

Severity

Displays the events severity level both literally and by the


assigned color.

Event Code

Specifies the events unique code.

Date and Time

Indicates the date and time stamp of the events occurrence.

Category

Specifies the events category (Software, Audit Log, Security, Life


Cycle, Hardware, Activity, State Change).

Entity

Specifies the entity to which the event refers.

Entity Details

Specifies the details of the event-related entity.

Description

Displays the events detailed description.

You can sort the displayed events by each of these column headings. To sort the events by
a column heading, click the heading. The arrow, displayed above each heading, indicates
whether the sorting is in ascending or descending order.

Alerts & Events Workspace

103

Using the Graphical User Interface (GUI)

Reports Workspace
Figure 77 shows the Reports workspace and its main elements and icons.
To access the Reports workspace, click the Reports icon in the menu bar.

Run Report
New Report

Reports' Tabs

All Reports
Pane

Refresh Report

Report
Display Pane

Figure 77 Reports Workspace

Table 36 describes the icons in the Reports workspace.


Table 36 Reports Workspace Icons
Icon

Description
New Report
Enables you to add a new report.
Run Report
Enables you to run a report and view it in the Report Display pane.
Refresh Report
Enables you to refresh the displayed report.

104

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Table 37 describes the active options of the drop-down menu, which appear upon
right-clicking an item in the Reports workspace.
Table 37 Reports Workspace Drop-Down Menu Options
Icon

Description
Edit Report
Enables you to modify the defined reports properties.
Export Report Data
Enables you to export the selected reports data to a file.
Open Report
Opens the selected report and displays it in the main window
(appears interchangeably with Close Report according to reports
current state).
Close Report
Closes the selected reports display (appears interchangeably with
Open Report according to the reports current state).
Delete Report
Removes the defined report from the reports list.
Copy Report
Enables you to copy a report as a base for a new report.

Reports Workspace

105

Using the Graphical User Interface (GUI)

Administration Workspace
Figure 78 shows the Administration workspace.
To access the Administration workspace, click the Administration icon in the menu bar.

Figure 78 Administration Workspace (with Security Tab Selected)

When you select a tab in the Administration workspace, the available screens for that tab
are displayed in the left pane. The Administration workspace consists of the following
tabs:

Security - The Security tab includes the following screens:


Users Administration
LDAP Configuration
Default Inactivity Timeout

Notification - The Notification tab includes the following screens:


Email Configuration
SNMP Configuration
Syslog Configuration

XMS - The XMS tab includes the following screens:


Login banner

CLI Terminal

Upon selecting a tab, the tabs options are displayed in the left pane. When you select one
of the options, the corresponding screen appears in the main pane of the Administration
workspace.

106

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Security Tab
Users Administration
Figure 79 shows the Users Administration screen.
To access the Users Administration screen, select the Security tab in the Administration
workspace and then select the Users Administration option from the left pane of the
Security tab.

Figure 79 Users Administration Screen

The Users Administration screen displays the defined users list. For each user, the
following details are listed:

User Name

Role

Is External

Timeout (in minutes)

Public Key - for remote users

You can sort the displayed users by each of these column headings. To sort the users by a
column heading, click the heading. The arrow, displayed above each heading, indicates
whether the sorting is in ascending or descending order.

Administration Workspace

107

Using the Graphical User Interface (GUI)

In the Users Administration screen you can:

With Admin role:


Add a user.
Edit user data.
Remove a user.
Log in as a different user.

With Configuration or Read-Only roles:


Change your password.
Log in as a different user.
Note: A user with Configuration or Read-Only role cannot see other users in the cluster.

LDAP Configuration
Figure 80 shows the LDAP Configuration screen.
To access the LDAP Configuration screen, select the Security tab in the Administration
workspace and then select the LDAP Configuration option from the left pane of the Security
tab.

Figure 80 LDAP Configuration Screen

108

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

The LDAP Configuration screen displays the LDAP server configuration data, including the
following details:

LDAP profile Name

Bind DN

Search base

Search filter

Server URL

User to DN rule

Roles

Timeout (in msec)

Cache Expire (in hours)

CA certificate file name

Using the LDAP Configuration screen, you can:

Modify LDAP configuration profiles.

Add and remove server URLs.

Add, update and remove XMS role to Active Directory group mapping rules.

Default Inactivity Timeout


Figure 81 shows the Default Inactivity Timeout screen.
To access the Default Inactivity Timeout screen, select the Security tab in the Administration
workspace and then select the Default Inactivity Timeout option from the left pane of the
Security tab.

Figure 81 Default Inactivity Timeout Screen

The XMS Configuration screen enables you to set the inactivity timeout duration, after
which users are requested to log in to the cluster again.

Administration Workspace

109

Using the Graphical User Interface (GUI)

Notification Tab
Email Configuration
Figure 82 shows the Email Configuration screen.
To access the Email Configuration screen, select the Email Configuration option from the
left pane of the Administration workspace.

Figure 82 Email Configuration Screen

The Email Configuration screen displays email-related data. Sending email notifications
allows the system administrators to remotely monitor the cluster.
The Email Configuration window enables you to:

110

Select sending email notification and set the frequency.

Add and remove mail recipients from the list.

Configure email senders properties.

Determine the mail sending mechanism.

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

SNMP Configuration
Figure 83 shows the SNMP Configuration screen.
To access the SNMP Configuration screen, select the SNMP Configuration option from the
left pane of the Administration workspace.

Figure 83 SNMP Configuration Screen

The SNMP Configuration screen enables you to send SNMP notification and configure the
following SNMP notification configuration data:

SNMP notification recipients list

SNMP Version

Community

Trap Port

SNMP V3 Properties

Administration Workspace

111

Using the Graphical User Interface (GUI)

Syslog Configuration
Figure 84 shows the Syslog Configuration screen.
To access the Syslog Configuration screen, select the Syslog Configuration option from the
left pane of the Administration workspace.

Figure 84 Syslog Configuration Screen

The Syslog Configuration screen lists the IP addresses or names of the Syslog servers,
currently configured on the XMS, and enables you to send Syslog notifications.
Using the Syslog Configuration screen you can:

112

Activate/Deactivate sending Syslog notifications.

Update the Syslog servers list, by adding and removing servers.

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

XMS Tab
Login Banner
Figure 85 shows the XMS Configuration screen.
To access the XMS Configuration screen, select the XMS tab.

Figure 85 Login Banner Screen

The Login Banner screen enables you to configure the login banner text.

Administration Workspace

113

Using the Graphical User Interface (GUI)

CLI Terminal Tab


Figure 86 shows the CLI Terminal screen.
To access the CLI Terminal screen, select the CLI Terminal tab in the Administration
workspace.

Figure 86 CLI Terminal Screen

The CLI Terminal screen enables you to use the command line interface and run CLI
commands according to your users role.
In the CLI Terminal, you can:

114

Copy the displayed text by selecting the text.

Paste the copied text into the command line by right-clicking the screen.

Use the scroll bar to scroll the screen up/down.

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Support Window
Figure 87 shows the Support window.
To access the Support window, click the Support icon in the menu bar.

Figure 87 Support Window

The Support window provides the following options:

Product Support page

Online training

Community

Downloads

Live chat

Service center

Update user profile

Support Window

115

Using the Graphical User Interface (GUI)

About Window
Figure Figure 88 shows the About window.
To access the About window, click the About icon in the menu bar.

Figure 88 About Window

The About window provides the following information:

Product name

Copyright statement

System version and Build numbers

Build ID

Companys website URL

Service request contact information

116

Installation details (Clicking the Installation Details icon displays the Installation
Details window, as shown in Figure 89.)

EMC XtremIO Storage Array User Guide

Using the Graphical User Interface (GUI)

Figure 89 Installation Details Window

About Window

117

Using the Graphical User Interface (GUI)

118

EMC XtremIO Storage Array User Guide

CHAPTER 3
Managing Multiple Clusters
This chapter includes the following topics:

Managing Multiple Clusters Setting, Using the GUI ................................................ 120


Managing Multiple Clusters, Using the CLI............................................................. 126

Managing Multiple Clusters

119

Managing Multiple Clusters

Managing Multiple Clusters Setting, Using the GUI


A multiple Cluster setting describes a setting in which a single XMS is used to manage
multiple clusters.
When using a multiple cluster setting, the dashboard workspace enables you to view each
of the clusters data separately, or a summary of all clusters.

Menu Bar
Cluster Selector
Display Order
Options
Aggregated
Storage Info

First Cluster
Storage Info

Second Cluster
Storage Info
Status Bar
Figure 90 Multiple Cluster - Dashboard window

The Cluster Selector allows you to set the display scope, by selecting a specific single
cluster or a multiple cluster view. Selecting a multiple cluster view displays aggregated
information for all clusters and each data item is associated to its cluster by the cluster
name.
The display scope can be set for the following Dashboard menu options:

Dashboard

Configuration

Inventory (table view)

Inventory (graphical view) - can be viewed only in the scope of a single cluster

Alerts and Events

Support

The following menu bar options display XMS level information and are therefore not
affected by cluster scope:

120

Reports

Administration

EMC XtremIO Storage Array User Guide

Managing Multiple Clusters

Selecting a Cluster
To select a cluster:
1. Using the Cluster Selector, click Manage All Clusters to open the Clusters drop-down
list.
2. Select the relevant Cluster from the list to view it on the Dashboard window.
Alternatively, you can click the Search Cluster and Replace and select or type the
Cluster name to be displayed.

Figure 91 Search Cluster and Replace

Managing Multiple Clusters Setting, Using the GUI

121

Managing Multiple Clusters

Selecting a Storage Pane View


The Storage pane of the Dashboard workspace for a multiple cluster view is displayed
when the Manage All Clusters option is selected from the clusters drop-down menu in the
Cluster Display bar. The Storage pane in a multiple cluster view displays information both
across all clusters and for each individual cluster.
Figure 92 shows the Storage pane of the Dashboard workspace for a multiple cluster view.

Figure 92 Storage Pane of the Dashboard Workspace - Multiple Clusters

122

EMC XtremIO Storage Array User Guide

Managing Multiple Clusters

The Storage pane provides the following views:

Data Reduction Ratio (DRR) - provides deduplication, compression and thin


provisioning saving data, both averaged across all Clusters and for each separate
Cluster.
To display the Inventory view, click the
menu bar of the Storage pane.

icon in a specific cluster pane or in the main

Figure 93 Storage Pane - Data Reduction Ratio View

Managing Multiple Clusters Setting, Using the GUI

123

Managing Multiple Clusters

Capacity - provides Volume and physical capacity data (used vs. free), both
aggregated across all Clusters and for each separate Cluster.
To display the Capacity view, click the
menu bar of the Storage pane.

Figure 94 Storage Pane - Capacity View

124

EMC XtremIO Storage Array User Guide

icon in a specific cluster pane or in the main

Managing Multiple Clusters

Inventory - provides an inventory list of the clusters hardware components (X-Bricks,


Storage Controllers and SSDs), both aggregated for all Clusters and for each separate
Cluster, and links to the components detailed data (see Managing the Hardware on
page 129). In addition, you can access the alert list for each component.
To display the Inventory view, click the
menu bar of the Storage pane.

icon in a specific cluster pane or in the main

Figure 95 Storage Pane- Inventory View

You can select a different view for each cluster and for the total clusters view, by selecting
a view from the relevant sections menu. Alternatively, you can select the same view for all
individual clusters and total clusters section by selecting a view from the menu located in
the general section of the Storage pane.
Using the Order By drop-down menu, you can order the clusters in the Storage pane by the
following parameters:

Name

Severity

Free physical capacity (percentage)

Physical capacity

Managing Multiple Clusters Setting, Using the GUI

125

Managing Multiple Clusters

Managing Multiple Clusters, Using the CLI


Managing a Specific Cluster in a Multiple Cluster Setting
When running cluster-related CLI commands in a multiple cluster setting, it is required to
specify the target cluster, using the cluster-id parameter.
If you want to address a specific cluster during a CLI session, you can set the cluster
context, using the set-context CLI command (see set-context on page 425). After
you set a context, it is not required to specify the cluster ID in cluster-related CLI
commands. When the cluster context is set, you can manage the other clusters via CLI,
only by specifying the cluster name or ID.
Note: When using the cluster-id parameter, it is recommended to specify the Cluster
name rather than the cluster ID, since the latter may change in case of cluster migration
between XMSs (see Cluster Migration).
Note: Specifying the cluster ID in cluster-related commands is not required in a single
cluster setting. However, it is recommended to specify the cluster ID to support a future
change to a multiple cluster setting.

Cluster Migration
Note: To migrate a Cluster, the Cluster version should run the same or a lower version than
the XMS version to which it is being migrated.
Cluster migration from one XMS to another is performed, using the add-cluster and
remove-cluster commands. When migrating a cluster, it is recommended to perform
the following steps prior to removing the cluster from the XMS:

Run the show-reports-data command, to export the clusters performance data


to a file (seeshow-reports-data on page 508).
Note: Performance data is not migrated with the Cluster, and is reset in the destination
XMS.

126

Run the show-clusters command and register the ID or name of the cluster that is
removed from the source XMS (see show-clusters on page 383).
Run the show-storage-controllers command and register one of the clusters
Storage Controllers IP addresses, to be used when the cluster is added to the XMS
(see show-storage-controllers on page 404).

EMC XtremIO Storage Array User Guide

Managing Multiple Clusters

CLI Commands for Managing Multiple Clusters


Use the following CLI commands for managing multiple clusters:
Command

Description

add-cluster

Adds a Cluster to the list of Clusters managed by the XMS.

remove-cluster

Removes a Cluster from the list of Clusters managed by the


XMS.

set-context

Sets a cluster context in a multiple cluster environment and


renders the need to specify the cluster ID unnecessary.

Managing Multiple Clusters, Using the CLI

127

Managing Multiple Clusters

128

EMC XtremIO Storage Array User Guide

CHAPTER 4
Managing the Hardware
This chapter includes the following topics:

Managing Hardware Tags ...................................................................................... 130


Hardware Components LEDs ................................................................................ 135

Managing the Hardware

129

Managing the Hardware

Managing Hardware Tags


The XtremIO Storage Array provides users with a tagging system for marking cluster
hardware elements. Tagging elements enables users to logically group, locate and
manage multiple entities and provides a clearer view of hardware elements affiliation.
Each object can have multiple Tags to reflect the objects function and position. Using Tag
nesting, you can create a hierarchy that reflects the relationship between the cluster
objects.
You can use tagging to aggregate objects, based on functional or business requirements.
Tags can be managed via the GUI and the CLI.

Object Naming Limitations


Tag names must comply with the following limitations:

Allowed length: up to 64 characters

Valid characters:
Alphanumeric characters
Space character
The following characters: ~ ! @ # $ % ^ * _ + { } | : ? . -

Invalid characters: & / < > ( )

Managing Tags, Using the GUI


Creating Tags
You can create Tags for the following hardware elements:

130

Clusters

X-Bricks

Data Protection Groups

Storage Controllers

DAEs

SSDs

Battery Backup Units

Targets

EMC XtremIO Storage Array User Guide

Managing the Hardware

To create Tags for the clusters hardware elements:


1. On the menu bar, click Inventory.
2. In the Inventory List (left pane), click the Manage Tags icon.

Figure 96 Create Tag - Inventory

3. Type a meaningful name in the Tag Caption field.


4. Select a color for the Tag. You can select a different color for each object type by
clicking Color (gray square) to open the color palette, and clicking a color.
5. Select the object types to which you want to assign the new Tag. If you want to select
all objects, click Select All.
6. Click OK; the new Tag is added to the selected object types.
Note: The created Tag is not assigned to specific objects. To assign the Tag to objects, see
Assigning Tags to Hardware Elements on page 132.

Managing Hardware Tags

131

Managing the Hardware

Assigning Tags to Hardware Elements


To assign a Tag to a hardware element:
1. On the menu bar, click Inventory.
2. In the Inventory List (left pane), click the object type you wish to Tag, to display the
defined objects in the main window.
3. Right-click an object from the list in the main window and select Manage Tags. You can
select multiple objects from the list, using the Ctrl and Shift keys.

Figure 97 Assigning Tags to Physical Objects

The Manage Tags for <object type> window displays the object type and all Tags that
were defined for it.
Note: In case of multiple objects, the window is titled Manage Tags for <number of
objects>.
4. Select the Tags you want to assign to the object and click OK.
Note: Another way to assign a Tag is to drag and drop the object you want to tag from the
main window to the Tag that is located below the object type in the Inventory List tab.

132

EMC XtremIO Storage Array User Guide

Managing the Hardware

Editing Tags
To edit Tags for hardware elements:
1. On the menu bar, click Inventory.
2. In the Inventory List (left pane), double-click the relevant object type to open the list of
Tags defined for that object type.
3. Right-click the Tag you wish to modify and select Modify Tag from the drop-down list.

Figure 98 Modify Tag

In the Modify Tag dialog box you can edit the following parameters:
Tag caption
Tag color
4. Click OK.

Removing Tags
To remove a hardware element Tag:
1. On the menu bar, click Inventory.
2. In the Inventory List (left pane), double-click the relevant object type to open the list of
Tags defined for that object type.
3. Right-click the Tag you wish to remove and select Delete Tag from the drop-down list.
4. Click Yes to confirm; the Tag is deleted from the object type Tag list.

Managing Hardware Tags

133

Managing the Hardware

Managing Tags, Using the CLI


Use the following CLI commands for managing Tags:

134

Command

Description

show-tags

Displays the details of all defined Tags.

show-tag

Displays the details of a specified Tag.

create-tag

Creates a Tag for an entity.

tag-object

Assigns a Tag to the specified object.

untag-object

Removes a Tag from the specified object.

modify-tag

Modifies the specified Tag caption.

remove-tag

Deletes a Tag from the Tags list.

EMC XtremIO Storage Array User Guide

Managing the Hardware

Hardware Components LEDs


The XtremIO Storage Array hardware components are equipped with two LED types that
enable you to monitor the components health:

Identification LED - Used to identify a component in the cluster.

Status LED - Used to indicate the status of the component.

In addition to the actual LEDs on the physical hardware components, identical graphical
representation of all LEDs appear in the GUIs hardware image.
The possible states of the LEDs are:

Off

On (beacon)

Table 38 provides details of the hardware components LEDs.


Table 38 Hardware Components LEDs
Component

Identification LED

Status LED

GUI

Physical

GUI

Physical

Storage Controller

Yes

Yes

Yes

Yes

Storage Controller SSD

Yes

Yes

Yes

Yes

Storage Controller HDD

Yes

Yes

Yes

Yes

Storage Controller PSU

No

No

Yes

Yes

DAE

Yes

Yes

Yes

Yes

DAE SSD

Yes

Yes

Yes

Yes

DAE Controller

Yes

Yes

Yes

Yes

InfiniBand Switch

No

No

No

Yes

InfiniBand Switch Power supply

No

No

No

Yes

InfiniBand Switch Fan

No

No

No

Yes

Battery Backup Unit

No

No

No

No

Physical XMS

N/A

Yes

N/A

No

Virtual XMS

N/A

No

N/A

No

Hardware Components LEDs

135

Managing the Hardware

Using the Identification LEDs


You can identify a component in the cluster, using the following methods:

Turning on the components identification LED


Turning on the LEDs of all other components (all but the selected component), if the
component has failed and does not respond

To turn on a components identification LED:


1. On the dashboard menu bar, click the Inventory icon.
2. On the Inventory menu bar, click the Graphical View icon to display the graphical view
of the cluster.
Note: The Graphical View can be used only in a single cluster setting or when a
specific cluster is selected in a multiple cluster setting.
3. Hover the mouse pointer over the relevant hardware component and right-click to
open the drop-down menu.
4. Select Turn Identification LED On for <components name>; a message appears, stating
that the components LED will be turned On/Off.
5. Click OK.
Note: If the components identification LED is already turned on, a check sign appears
next to the Turn Identification LED On option and the message box that follows states
that the LED will be turned off.

136

EMC XtremIO Storage Array User Guide

Managing the Hardware

To turn all other identification LEDs on or off:


1. On the dashboard menu bar, click the Inventory icon.
2. On the Inventory menu bar, click the Graphical View icon to display the graphical view
of the cluster.
Note: The Graphical View can be used only in a single cluster setting or when a
specific cluster is selected in a multiple cluster setting.
3. Hover the mouse pointer over the relevant hardware component and right-click to
open the drop-down menu.
4. Select Change all other <component type> Identification LEDs for Cluster <cluster
name>.

5. In the Change All Other Identification LEDs dialog box, select the desired state of the
LEDs (On or Off) and click OK; LEDs of all components, except for the LED of the
component you want to identify, change their state.

Hardware Components LEDs

137

Managing the Hardware

138

EMC XtremIO Storage Array User Guide

CHAPTER 5
Monitoring the Cluster
This chapter includes the following topics:

Monitoring the Storage .........................................................................................


Monitoring the Performance ..................................................................................
Monitoring the Hardware Elements .......................................................................
Monitoring the Storage Elements ..........................................................................
Monitoring the Alerts ............................................................................................
Managing the Reports ...........................................................................................

Monitoring the Cluster

140
142
144
158
169
170

139

Monitoring the Cluster

Monitoring the Storage


To monitor the cluster storage status:
1. On the menu bar, click the Dashboard icon to display the Dashboard workspace, as
shown in Figure 22 on page 44.
2. Monitor the storage parameters in the Storage pane, as shown in Figure 24 on
page 46.

Monitoring the Efficiency


You can monitor the cluster efficiency status from the Efficiency section of the Storage
pane in the Dashboard workspace.

Figure 99 Overall Efficiency Section

The Efficiency section displays the following data:

Overall Efficiency - the disk space saved by the XtremIO Storage Array, calculated as:
Volume capacity
-----------------------------------------------------------Physical space used

Data Reduction Ratio - the Inline Data Deduplication and Compression ratio, calulated
as:
Logical space in use
---------------------------------------------------------Physical space used

Deduplication Ratio - the real-time Inline Data Deduplication ratio, calculated as:
Logical space in use
---------------------------------------------------------Unique data on SSD

Compression Ratio - the real-time Inline Compression ratio, calculated as:


Unique data on SSD
---------------------------------------------------------Physical space used

140

Thin Provisioning Savings - used disk space compared to allocated disk space

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

Monitoring the Volume Capacity


You can monitor the Volume capacity status in the Volume Capacity section of the Storage
pane in the Dashboard workspace.

Figure 100 Volume Capacity Section

The Volume capacity section displays the following data:

Total disk space defined by the Volumes

Physical space used

Logical space used

Hovering the mouse pointer over the Volume Capacity bar displays a tool-tip with detailed
information.

Monitoring the Physical Capacity


You can monitor the physical capacity status from the Physical Capacity section of the
Storage pane in the Dashboard workspace.

Figure 101 Physical Capacity Section

The Physical Capacity section displays the following data:

Total physical capacity

Used physical capacity

Hovering the mouse pointer over the Physical capacity bar displays a tool-tip with detailed
information.

Monitoring the Storage

141

Monitoring the Cluster

Monitoring the Performance


Monitoring the Performance, Using the GUI
To monitor the cluster performance, using the GUI:
1. On the menu bar, click the Dashboard icon to display the Dashboard workspace, as
shown in Figure 22 on page 44.
2. In the Performance pane (see Figure 25 on page 48), select the desired parameters:
Select the measurement unit of the display by clicking one of the following tabs:
Bandwidth - MB per second (MB/s)
IOPS - Input/Out operations per second
Latency - microseconds (s) - applies only to the activity history graph.
Select the desired item to be monitored from the Item Selector:
Block Size
Initiator Groups
Volumes
Set the Activity History time frame by selecting from one of the following periods
from the Time Period Selector:
Last Hour
Last six Hours
Last 24 Hours
Last 3 Days
Last Week
The Activity History time frame starting point is the last time the XMS was started.
You can zoom in on the displayed history graph to view a more detailed display of the
selected time period (i.e. more time points displayed for the selected period).
Zooming-in on the history graph does not change the aggregation on data. Different views
of the same time period with different time scales (for example, last week versus last hour)
may result in different graphs.
Zooming-in the GUI performance history chart to a time period of one hour or less provides
raw data granularity and is therefore the most exact. However, zooming-out to a range that
is higher than an hour provides a chart, based on an aggregate of averages, which may
differ from the one hour chart.

142

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

To zoom in and out on the history graph:


1. Drag the mouse over the desired section in the history graph to select it.

Figure 102 History Graph - Zoom-In

The highlighted section is displayed in a Zoomed view.

Figure 103 History Graph - Zoomed View

2. Repeat step 1 to zoom again on a selected section of the zoomed area.


3. Drag the mouse up or left to return to the regular graph view.
Note: Zooming in on the history graph displays the aggregated information in higher
resolution. It does not increase the amount of aggregated information. To change the
amount of aggregated data, select a different time frame from the drop-down menu.
For more information, see Performance Pane on page 48.

Monitoring the Performance, Using the CLI


Use the following CLI commands for monitoring the clusters performance:
Command

Description

show-most-active

Displays the most active Volumes and Initiator Groups.

show-most-active-initiator-groups

Displays performance data of the most active Initiator


Groups.

show-most-active-volumes

Displays performance data of the most active Volumes.

Monitoring the Performance

143

Monitoring the Cluster

Monitoring the Hardware Elements


Monitoring the Clusters
Monitoring the Clusters, Using the GUI
You can quickly view general information on the Clusters components by hovering the
mouse pointer over the Cluster in the Rack pane of the Inventory workspace.

Figure 104 Cluster Tool-Tip

144

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

You can also monitor the cluster via the status bar of the GUI window.

Figure 105 GUI Window - Status Bar

The status bar displays the following data:

Number of Clusters

The Cluster status

XMS and clusters date and time zone

Current logged-in user

Note: To view a summary of the existing clusters data, click the Table View icon in the
Cluster View Toggle Buttons and then click Clusters in the Hardware tab. For details, see
Clusters View on page 77.

Monitoring the Clusters, Using the CLI


Use the following CLI commands for monitoring the clusters:
Command

Description

show-clusters

Displays the connected clusters information.

show-clusters-info

Displays the connected clusters information.

show-clusters-upgrade

Displays the clusters upgrade status.

show-clusters-upgrade-progress

Displays indicators of the clusters software upgrade


progress.

show-clusters-performance

Displays clusters performance data.

show-clusters-performance-small

Displays clusters performance data for small (under


4KB) blocks.

show-clusters-performance-unaligned

Displays clusters performance data for unaligned blocks.

show-clusters-performance-latency

Displays clusters performance latency data.

modify-clusters-parameters

Displays the connected clusters iSCSI TCP port numbers.

show-clusters-savings

Displays savings parameters of the selected cluster.

modify-cluster-thresholds

Displays thin provisioning soft limits for the connected


clusters.

show-clusters-data-protection-propert
ies

Displays clusters data protection properties.

Monitoring the Hardware Elements

145

Monitoring the Cluster

Monitoring the X-Bricks


Monitoring the X-Bricks, Using the GUI
To view the X-Bricks information:
1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 41 on page 68.
2. On the Inventory menu bar, click the Graphical View icon to display the graphical view
of the cluster.
Note: The Graphical View can be used only in a single cluster setting or when a
specific cluster is selected in a multiple cluster setting.
3. In the left pane, select the X-Brick whose Storage Controller you wish to monitor; the
graphic view of the selected X-Brick is displayed in the main window.
The following actions enable you to view the displayed X-Bricks details in the main
window:
Hovering the mouse pointer over different parts of the component to view the
components parameters and associated alerts
Clicking Show Front to view the X-Bricks front side
Clicking Show Back to view the X-Bricks back side
Clicking Show Cable Connectivity to view the X-Bricks cable connections
You can view the X-Bricks alerts by right-clicking the X-Brick and clicking Display
<X-Brick name> Alerts.
Note: To view a summary of the X-Brick data, click the Table View icon in the Cluster View
Toggle Buttons and then click X-Bricks in the Hardware tab. For more information, see
X-Bricks View on page 80.

Monitoring the X-Bricks, Using the CLI


Use the following CLI command for monitoring the X-Bricks:

146

Command

Description

show-bricks

Displays a list of X-Bricks and their associated cluster.

show-clusters

Displays the connected clusters information.

show-storage-controllers

Displays the clusters Storage Controllers information and status.

show-ssds

Displays a list of SSDs in the cluster and their properties.

show-bbus

Displays the Battery Backup Units information.

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

Monitoring the Storage Controllers


Monitoring the Storage Controllers, Using the GUI
To view the Storage Controllers information:
1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 41 on page 68.
2. On the Inventory menu bar, click the Graphical View icon to display the graphical view
of the cluster.
Note: The Graphical View can be used only in a single cluster setting or when a
specific cluster is selected in a multiple cluster setting.
3. In the left pane, select the X-Brick whose Storage Controller you wish to monitor.
4. Hover the mouse pointer over a Storage Controller graphic representation in the main
window, to view the Storage Controller information.
You can view the Storage Controllers alerts by right-clicking the Storage Controller and
clicking Display <Storage Controller name> Alerts.
Note: To view a summary of the Storage Controller data, click the Table View icon in the
Cluster View Toggle Buttons and then click Storage Controllers in the Hardware tab. For
more information, see DAEs View on page 86.

Monitoring the Storage Controllers, Using the CLI


Use the following CLI commands for monitoring the Storage Controllers:
Command

Description

show-storage-controllers

Displays the clusters Storage Controllers information and


status.

show-storage-controllers-info

Displays the clusters Storage Controllers information.

show-storage-controllers-fw-versions

Displays the Storage Controllers firmware version


information.

show-storage-controllers-psus

Displays information on Storage Controllers power supply


units.

show-storage-controllers-sensors

Displays a list of sensors and their related information.

test-xms-storage-controller-connectiv
ity

Performs a connectivity check for the specified Storage


Controller and its managing XMS.

Monitoring the Hardware Elements

147

Monitoring the Cluster

Monitoring the SSDs


Monitoring the SSDs, Using the GUI
To view the SSDs information:
1. From the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 41 on page 68.
2. On the Inventory menu bar, click the Graphical View icon to display the graphical view
of the cluster.
Note: The Graphical View can be used only in a single cluster setting or when a
specific cluster is selected in a multiple cluster setting.
3. In the left pane, select the relevant X-Brick.
4. Hover the mouse pointer over an SSD graphic representation in the main window to
view the SSD information.
You can view an SSDs alerts by right-clicking the SSD and clicking Display <SSD name>
Alerts.
Note: To view a summary of SSDs data, click the Table View icon in the Cluster View Toggle
Buttons and then click SSDs in the Hardware tab. For more information, see SSDs View
on page 88.

Monitoring the SSDs, Using the CLI


Use the following CLI commands for monitoring the SSDs:

148

Command

Description

show-ssds

Displays a list of SSDs in the cluster and their properties.

show-ssds-performance

Displays the SSDs performance data.

show-slots

Displays a list of SSD slots and their properties.

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

Monitoring the InfiniBand Switches


Monitoring the InfiniBand Switches, Using the GUI
To view the InfiniBand Switches information:
1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 41 on page 68.
2. On the Inventory menu bar, click the Graphical View icon to display the graphical view
of the cluster.
Note: The Graphical View can be used only in a single cluster setting or when a
specific cluster is selected in a multiple cluster setting.
3. In the left pane, select the relevant InfiniBand Switch.
4. Hover the mouse pointer over the InfiniBand Switch graphic representation in the
main window to view the InfiniBand Switch information.

Monitoring the InfiniBand Switches, Using the CLI


Use the following CLI commands for monitoring the InfiniBand Switches:
Command

Description

show-infiniband-switches

displays InfiniBand Switches information.

show-infiniband-switches-p
orts

Displays InfiniBand Switches port information.

show-infiniband-switches-p
sus

Displays a InfiniBand Switches PSU infomation.

Monitoring the Data Protection Groups


Data Protection Groups Overview
A Data Protection Group is a set of SSDs that form a redundancy group. Each Data
Protection Group has a name, health state, and defined usable SSD space.
Each X-Brick contains one Data Protection Group, which is created during the initial
configuration. The Data Protection Group cannot be removed.
A Data Protection Group's health is indicated by the following states:

Protection state

Process in progress

Monitoring the Hardware Elements

149

Monitoring the Cluster

Data Protection Group State


The Data Protection Group state indicates the maximum number of disks that can fail
before data loss. The possible state values are:

Normal - The Data Protection Group is fully protected.


Degraded - The Data Protection Group has encountered a single or dual SSD-failure
with no data or service loss, but possible performance degradation. When there is
sufficient free space, the Data Protection Group automatically initiates a rebuild. When
capacity is insufficient or the cluster has reached its minimum number of SSDs, rebuild
does not start until at least one failed SSD is replaced. When two SSDs fail, a critical
alert is issued. The alert is cleared when the subsequent rebuild is complete.
Error - The Data Protection Group has encountered more than two SSD failures.
Multiple SSD failure is manageable, provided that the rebuild occurs before the next
failure and there is sufficient space for an additional rebuild. If three SSDs fail
simultaneously or are removed from an X-Brick, service is stopped and data loss
occurs. In case of removed SSDs, if any of the SSDs is re-inserted, the cluster can be
re-started and no data is lost.

Data Protection Process in Progress


The Data Protection Group process in progress state indicates that a process is being run.
The process in progress is related to the current protection state.
The processes can be one of the following:

Rebuild (including resync) - The Data Protection Group is performing a rebuild,


following SSD failure. The rebuild process starts automatically without stopping the
service.
Integrate - A new SSD has been inserted and is being added to the Data Protection
Group. The cluster identifies the new SSD and stops the rebuild process. This process
results in increased space, allowing rebuilds to be completed successfully.
Rebalance - The XtremIO Storage Array has added a new SSD to the Data Protection
Group and is re-balancing the load.

When a Data Protection Group's state is unhealthy, the cluster issues the following alert:
"Cluster is in a degraded mode, additional SSD failure will cause service and data loss".
For more information, see Monitoring the Storage Elements on page 158.

150

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

Monitoring Data Protection Groups, Using the GUI


To view Data Protection Groups (DPGs) information:
1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 41 on page 68.
2. On the Inventory menu bar, click the Graphical View icon to display the graphical view
of the cluster.
Note: The Graphical View can be used only in a single cluster setting or when a
specific cluster is selected in a multiple cluster setting.
3. In the left pane, select the relevant X-Brick.
4. Hover the mouse pointer over SSDs that are members of the DPG in the main window
to view the Data Protection Group status.
You can view a DPGs alerts by right-clicking the DPG and clicking Display <DPG name>
Alerts.
Note: To view a summary of DPGs data, click the Table View icon in the Cluster View Toggle
Buttons and then click Data Protection Groups in the Hardware tab. For more information,
see Data Protection Groups View on page 84.

Monitoring Data Protection Groups, Using the CLI


Use the following CLI commands for monitoring Data Protection Groups:
Command

Description

show-data-protection-groups

Displays XDP groups status and information.

show-clusters-data-protection Displays the clusters data protection properties.


-properties
show-data-protection-groupsperformance

Displays XDP groups performance information.

Monitoring the Hardware Elements

151

Monitoring the Cluster

Monitoring the Local Disks


Monitoring the Local Disks, Using the GUI
To view the Local Disks information:
1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 41 on page 68.
2. On the Inventory menu bar, click the Graphical View icon to display the graphical view
of the cluster.
Note: The Graphical View can be used only in a single cluster setting or when a
specific cluster is selected in a multiple cluster setting.
3. In the left pane, select the relevant X-Brick.
4. Hover the mouse pointer over a Local Disk graphic representation in the main window
to view the Local Disk information.
You can view a Local Disks alerts by right-clicking the DPG and clicking Display <Local
Disk name> Alerts.

Monitoring the Local Disks, Using the CLI


Use the following CLI command for monitoring the Local Disks:

152

Command

Description

show-local-disks

Displays the Storage Controllers Local Disks information.

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

Monitoring the Battery Backup Units


Monitoring the BBUs, Using the GUI
To view BBUs information:
1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 41 on page 68.
2. On the Inventory menu bar, click the Graphical View icon to display the graphical view
of the cluster.
Note: The Graphical View can be used only in a single cluster setting or when a
specific cluster is selected in a multiple cluster setting.
3. In the left pane, select the relevant X-Brick.
4. Hover the mouse pointer over a BBUs graphic representation in the main window. Use
both front and back views to view the BBU information.
You can view a BBUs alerts by right-clicking a BBU and clicking Display <BBU name>
Alerts.
Note: To view a summary of existing BBUs data, click the Table View icon in the Cluster
View Toggle Buttons and then click Battery Backup Units in the Hardware tab. For more
information, see Battery Backup Units View on page 92.

Monitoring Battery Backup Units, Using the CLI


Use the following CLI command for monitoring the BBUs:
Command

Description

show-bbus

Displays Battery Backup Units information.

Monitoring the Hardware Elements

153

Monitoring the Cluster

Monitoring the DAEs


Monitoring the DAEs, Using the GUI
To view the DAEs information:
1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 41 on page 68.
2. On the Inventory menu bar, click the Graphical View icon to display the graphical view
of the cluster.
Note: The Graphical View can be used only in a single cluster setting or when a
specific cluster is selected in a multiple cluster setting.
3. In the left pane, select the relevant X-Brick.
4. Hover the mouse pointer over a DAEs graphic representation in the main window. Use
both front and back views to view the DAE information.
You can view a DAEs alerts by right-clicking a DAE and clicking Display <DAE name>
Alerts.
Note: To view a summary of DAEs data, click the Table View icon in the Cluster View Toggle
Buttons and then click DAEs in the Hardware tab. For more information, see DAEs View
on page 86.

Monitoring DAEs, Using the CLI


Use the following CLI commands for monitoring the DAEs:

154

Command

Description

show-daes

Displays the clusters DAE information.

show-daes-psus

Displays a list of DAE power supply units (PSUs) and their


properties.

show-daes-controllers

Displays a list of DAE LCCs (controllers) and their properties.

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

Monitoring the Targets


Targets Overview
A Target is a physical port, located on a Storage Controller.
The XtremIO Storage Array supports the following Target types:

iSCSI - a 10GbE NIC port for connecting to iSCSI networks. There are two iSCSI Targets
per Storage Controller.
FC - an FC HBA port for connecting to fiber optic cable networks. There are two FC
Targets per Storage Controller.

The clusters Targets form the XtremIO Storage Arrays front-end to which application
servers connect for receiving storage services.
On the XtremIO array, all LUNs are exposed on all target ports. The Targets are grouped
into one, default, Target Group. It is not possible to create other Target Groups consisting
of subsets of the default Target Group.
During the initial cluster configuration, the XtremIO Storage Array discovers each of the
Storage Controllers Targets and adds them to a default Target Group.

Monitoring the Hardware Elements

155

Monitoring the Cluster

Monitoring Targets, Using the GUI


To monitor the clusters Targets, using the GUI:
1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 41 on page 68.
2. In the Inventory menu bar, click the Graphical View icon to display the graphical view
of the cluster.
Note: The Graphical View can be used only in a single cluster setting or when a
specific cluster is selected in a multiple cluster setting.
3. In the left pane, select the relevant X-Brick.
4. Click Show Back to view the rear side of the X-Brick in the main window.
5. Hover the mouse pointer over the Storage Controllers to view the tool-tip information
about the Target ports. The information includes port name, state, address, and
existing alerts.

Figure 106 Tool-Tip Information

You can view a detailed view of a Targets alerts by right-clicking the Target and
clicking Display <Target name> Alerts.
Note: To view a summary of Targets data, click the Table View icon in the Cluster View
Toggle Buttons and then click Targets in the Hardware tab. For more information, see
Cluster Configuration on page 94.
For more information about Targets connection, see Monitoring the Initiators, Using the
GUI on page 163.
You can also monitor iSCSI portals and routes, using the iSCSI Network Configuration
screen (see Notification Tab on page 110).

156

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

Monitoring Targets, Using the CLI


Use the following CLI commands for monitoring Targets:
Command

Description

show-targets

Displays the cluster Targets information.

show-target-groups

Displays a list of Target groups.

show-targets-fc-error-counters

Displays Fibre Channel error counter per Target.

show-target-groups-fc-error-counters

Displays Fibre Channel error counter per Target


group.

show-targets-performance

Displays Targets performance data.

show-targets-performance-small

Displays Targets performance data for small


(under 4KB) blocks.

show-targets-performance-unaligned

Displays Targets performance data for unaligned


blocks.

show-target-groups-performance

Displays Target groups performance data.

show-target-groups-performance-small

Displays Target groups performance data for small


(under 4KB) blocks.

show-target-groups-performance-unaligned

Displays Target groups performance data for


unaligned blocks.

Monitoring the Hardware Elements

157

Monitoring the Cluster

Monitoring the Storage Elements


Monitoring the Volumes
Volumes Overview
You can define various quantities of disk space as Volumes in an active cluster.
Volumes are defined by:

Volume size - the quantity of disk space reserved for the Volume

LB size - the logical block size in bytes

Alignment-offset - a value for preventing unaligned access performance problems

Note: When using the GUI, selecting a predefined Volume type sets both the
alignment-offset and LB size values. Using the CLI, you can define the alignment-offset
and LB size values separately.

Monitoring Volumes, Using the GUI


To monitor the clusters Volumes, using the GUI:
1. On the menu bar, click the Configuration icon to display the Configuration workspace,
as shown in Figure 28 on page 51.
2. On the Storage tab (left pane) click Volumes; the main window displays the defined
Volumes list.

Figure 107 Configuration Workspace - Volumes Pane

158

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

For each Volume, the following properties are displayed:


Volume Name
Cluster Name
Is Read Only
Is Mapped
NAA Identifier
Space In Use (VSG)
Volume Size
Logical Block Size
Alignment Offset
Tags
You can filter the Volumes display by typing a search string in the filter window or by
selecting one or more of the available filter options:
Writable
Read-Only
Mapped
Unmapped
Volume
Snapshot
3. Click a Volume in the top table and click a tab in the bottom table to view additional
Volume-related data. Available data tabs include:
Mapping
Volume Snapshot Groups
Consistency Groups
Snapshot Sets
Schedulers
Alerts

Monitoring the Storage Elements

159

Monitoring the Cluster

Monitoring Volumes, Using the CLI


Use the following CLI commands for monitoring Volumes:

160

Command

Description

show-volume

Displays the specified Volumes information.

show-volumes

Displays a list of Volumes and their information.

show-volume-snapshot-groups

Displays the defined Snapshot groups and


their parameters

show-volumes-performance

Displays Volumes performance data.

show-volumes-performance-small

Displays Volumes performance data for small


(under 4KB) blocks.

show-volumes-performance-unaligned

Displays Volumes performance data for


unaligned blocks.

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

Monitoring the Consistency Groups


Consistency Groups Overview
Consistency Groups are a hierarchical layer above Volumes that enables grouping several
Volumes together (e.g. Volumes that have a common database) and manipulating them so
that data will be cross-consistent for all members in the group.

Monitoring Consistency Groups, Using the GUI


To monitor the clusters Consistency Groups, using the GUI:
1. On the menu bar, click the Configuration icon to display the Configuration workspace,
as shown in Figure 28 on page 51.
2. On the Storage tab (left pane) click Consistency Groups; the main window displays the
defined Consistency Groups list.

Figure 108 Configuration Workspace - Consistency Groups Pane

Monitoring the Storage Elements

161

Monitoring the Cluster

For each Consistency Group, the following properties are displayed:


Consistency Group Name
Cluster Name
Is Read Only
Is Mapped
Number of Volumes
Number of Snapshot Sets
Tags
You can filter the Consistency Groups display by typing a search string in the filter
window or by selecting one of the available filter options:
Writable
Read-Only
Mapped
Unmapped
3. Click a Consistency Group in the top table and click a tab in the bottom table to view
additional Consistency-Group-related data. Available data tabs include:
Volumes
Mapping of Member Volumes
Snapshot Sets
Schedulers
Alerts

Monitoring Consistency Groups, Using the CLI


Use the following CLI commands for monitoring Consistency Groups:

162

Command

Description

show-consistency-group

Displays the parameters of the specified


Consistency Group.

show-consistency-groups

Displays the parameters of all defined


Consistency Groups.

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

Monitoring the Initiators


Initiators Overview
The XtremIO Storage Array uses the term "Initiators" to refer to ports which can access a
Volume.

Monitoring the Initiators, Using the GUI


To monitor the clusters Initiators, using the GUI:
1. On the menu bar, click the Configuration icon to display the Configuration workspace,
as shown in Figure 28 on page 51.
2. On the Storage tab (left pane) click Initiators; the main window displays the defined
Initiators list.

Figure 109 Configuration Workspace - Initiators Pane

For each Initiator, the following properties are displayed:


Initiator Name
Cluster Name
Initiator Group
Operating System
Port Type
Port Address
Number of Connected Targets
Tags

Monitoring the Storage Elements

163

Monitoring the Cluster

You can filter the Initiators display by typing a search string in the filter window or by
selecting one of the available filter options:
Mapped
Unmapped
3. Click an Initiator in the top table and click a tab in the bottom table to view additional
Initiator-related data. Available data tabs include:
Targets
Alerts

Monitoring Initiators, Using the CLI


Use the following CLI commands for monitoring the Initiators:

164

Command

Description

show-initiators

Displays Initiators data.

show-initiators-performance

Displays Initiators performance data.

show-initiators-performance-small

Displays Initiators performance data for small


(under 4KB) blocks.

show-initiators-performance-unaligned

Displays Initiators performance data for


unaligned blocks.

show-initiators-connectivity

Displays Initiators-Port connectivity and the


number of the connected Targets. Specifying the
Target-details input parameter, provides the
Initiators-Targets connectivity map.

show-discovered-initiators-connectivity

Displays the Initiators that are logged in to the


cluster but not assigned to any Initiator Group.

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

Monitoring the Initiator Groups


Initiator Groups Overview
The XtremIO Storage Array uses the term Initiators to refer to ports which can access a
Volume. Initiators can be managed by assigning them to an Initiator Group. The Initiators
within an Initiator Group share access to one or more of the cluster's Volumes.

Monitoring Initiator Groups, Using the GUI


To monitor the clusters Initiator Groups, using the GUI:
1. On the menu bar, click the Configuration icon to display the Configuration workspace,
as shown in Figure 28 on page 51.
2. On the Storage tab (left pane) click Initiator Groups; the main window displays the
defined Initiator Groups list.

Figure 110 Configuration Workspace - Initiator Groups Pane

For each Initiator Group, the following properties are displayed:


Initiator Group Name
Cluster Name
Number of Mapped Volumes
Number of Connections
Tags
You can filter the Initiator Groups display by selecting one or more of the available
filter options:
Mapped
Unmapped

Monitoring the Storage Elements

165

Monitoring the Cluster

3. Click an Initiator Group in the top table and click a tab in the bottom table to view
additional Initiator-Group-related data. Available data tabs include:
Mapping
Initiators
Targets
Alerts

Monitoring Initiator Groups, Using the CLI


Use the following CLI commands for monitoring initiator groups:

166

Command

Description

show-initiator-group

Displays information for a specific Initiator Group.

show-initiator-groups

Displays information for all Initiator Groups.

show-initiator-groups-performance

Displays Initiator Groups performance data.

show-initiator-groups-performance-small

Displays Initiator Groups performance data for


small (under 4KB) blocks.

show-initiator-groups-performance-unaligned

Displays Initiator Groups performance data for


unaligned blocks.

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

Monitoring the Snapshot Sets


Snapshot Sets Overview
An XtremIO Storage Array Snapshot Set is an entity that groups a set of Snapshots
generated at the same point in time. A Snapshot Set is created by performing a snapshot
operation on a single Volume or multiple Volumes, a Snapshot Set or a Consistency Group.

Monitoring Snapshot Sets, Using the GUI


To monitor the clusters Snapshot Sets, using the GUI:
1. On the menu bar, click the Configuration icon to display the Configuration workspace,
as shown in Figure 28 on page 51.
2. On the Storage tab (left pane) click Snapshot Sets; the main window displays the
defined Snapshot Sets list.

Figure 111 Configuration Workspace - Snapshot Sets Pane

For each Snapshot Set, the following properties are displayed:


Snapshot Set Name
Cluster Name
Creation Time
Is Read Only
Is Mapped
Originated From
Number of Volumes
Tags

Monitoring the Storage Elements

167

Monitoring the Cluster

You can filter the Snapshot Sets display by typing a search string in the filter window
or by selecting one of the available filter options:
Writable
Read-Only
Mapped
Unmapped
3. Click a Snapshot Set in the top table and select a tab in the bottom table to view
additional Snapshot-Set-related data. Available data tabs include:
Volumes
Mapping of Member Volumes
Consistency Groups
Schedulers
Alerts

Monitoring Snapshot Sets, Using the CLI


Use the following CLI commands for monitoring Snapshot Sets:

168

Command

Description

show-snapshot-set

displays the parameters of a specified


Snapshot Set.

show-snapshot-sets

Displays a list of Snapshot Sets and related


information.

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

Monitoring the Alerts


The XtremIO Storage Array provides a predefined list of alerts.
An alert indicates a condition that requires user attention and in some cases, user
intervention.
To view the alerts list, refer to Alerts and Events Details on page 509.

Monitoring Alerts, Using the GUI


The Alerts pane in the Dashboard workspace displays active alerts, as explained in Alerts
Pane on page 49.
You can right-click an alert to:

Acknowledge the alert.

Edit the alerts definitions.

View the alerts properties.

When an alert is acknowledged or cleared, it is removed from the table.

You can view the alerts of a specific hardware element by selecting the element from
the list in the Inventory workspace and clicking the Alerts tab. See Monitoring the
Hardware Elements on page 144.
You can view the alerts of a specific cluster element by selecting the element from the
list in the Configuration workspace and clicking the Alerts tab. See Monitoring the
Storage Elements on page 158.
You can view the full alerts list in the Alerts tab of the Alerts & Events workspace, as
explained in Alerts & Events Workspace on page 98.

Monitoring Alerts, Using the CLI


Use the following CLI commands for monitoring clusters alerts:
Command

Description

show-alerts

Displays a list of active alerts and their details.

show-alert-definitions

Displays a list of pre-defined alerts and their definitions.

Monitoring the Alerts

169

Monitoring the Cluster

Managing the Reports


XtremIO Storage Array enables you to collect historical data, perform analysis and run
reports.
For a description of the Reports window, see Reports Workspace on page 104.

Predefined Reports
XtremIO provides a set of predefined reports that cannot be edited or deleted. However,
you can create a copy of a predefined report and modify it according to your needs to
create a user-defined report. The predefined reports include:

Latency
Cluster Latency
Latency by Block Size

IOPS
Cluster IOPS
IOPS by Block Size

Capacity
Data Reduction
Physical Capacity
Thin Provisioning Savings
Volume Capacity

Resources
SSD Endurance
XEnv Utilization

Bandwidth
Cluster Bandwidth
Cluster Bandwidth by Block Size

The predefined reports are marked as "(Predefined)" after the reports title.

170

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

Viewing Reports
To view a report:

Double-click the report name in the Reports list. You can also click the report name to
select it and then click the Run button, or right-click the report from the Reports list
and select Run from the menu. The report data is displayed in the main window and
the icon next to the report in the report list is changed to indicate that it is opened.

To view multiple reports:

Double-click the reports you want to view and toggle between them by clicking the
reports tabs.

To view multiple reports in a split screen mode:


1. Double-click the reports you want to view.
2. Drag the tab of one of the opened reports to the bottom status bar; the screen is split
and the dragged report can be viewed below the other opened reports.
3. You can repeat the drag-and-drop action to further split the screen. You can also drag a
report into another report to create a separate tabbing of the two reports.
To zoom in and out on a reports view:
1. Right-click the report view and select Zoom In or Zoom Out from the drop-down list.
2. Select the relevant axes from the sub-list (both axis, domain axis or range axis); the
report view is changed accordingly.
You can also drag the mouse to select a section of the report to zoom in on it.
Note: Zooming in on the report view displays the aggregated information in higher
resolution. It does not increase the amount of aggregated information. To change the
amount of aggregated data, select a different time frame when you define the report
parameters.
To print the report view:

Right-click the report view and select Print from the drop-down list.

To save the report view in png format:


1. Right-click the report view and select Save as from the drop-down list.
2. Select PNG from the sub-list.

Managing the Reports

171

Monitoring the Cluster

Managing Reports, Using the GUI


Adding a Report
When you generate a new report, you need to address the following report parameters:

Time frame - You can set the following time frames for the data collection:
Real-time monitor - generates a real-time monitor that polls data every five
seconds. Data is displayed as a sliding window that is constantly updated. Closing
and re-opening the monitor causes the previous data to be lost.
Last hour - provides data from the last 60 minutes in one minute polling
granularity.
Last day - provides data from the last 24 hours in ten minutes polling granularity.
Last week - provides data from the last 7 days in one hour polling granularity.
Last year - provides data from the last 365 days in one day polling granularity.
Custom range - is a user defined time frame. The user sets a start date and time
(default setting - first day of available data) and an end date and time (default
setting - current date and time).

Access rights - specify the reports access rights, i.e. whether it is public or private
(default - private). A private report is accessible to the reports creator. a public report
can be viewed by all users, and can be edited and deleted by the reports creator.
Reports that were generated as public by another user are marked as "public" and
reports that were generated as public by you are marked "my public".
When a user account is deleted, private reports created by that user become
inaccessible. Public reports can still be viewed by all users, but can be edited and
deleted only by a Tech user.

Category and entity type - specify the data you wish to collect, namely, a category and
an entity type.
Possible Categories are:
Bandwidth - small and unaligned
CPU
Capacity
Compression
IOPS - small and unaligned
Latency - small and unaligned
Memory
Performance
Small
Space
Unaligned

172

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

Possible entity types are:


Cluster
Data Protection Group
Initiator
Initiator Group
Module
SSD
Target
Target Group
Volume
Volume Snapshot Group
XIOS
XMS

Display type - select the display type of your report. Available display types are:
Table
Bar Chart
Pie Chart
Line Chart

Managing the Reports

173

Monitoring the Cluster

To add a report to the report list, you can generate a new report or modify a copy of a
pre-defined report according to your needs.
To generate a report:
1. On the menu bar, click the Report icon; the Report window appears.
2. On the All Reports pane, click New; the Add New Report wizard appears.

Figure 112 Add New Report - Display Type

3. Type a name for the report in the Report name field. The name does not have to be
unique. The default assigned name is Report <index> with an ascending serial
number.
4. Set the reports access rights by selecting the Public Report checkbox, if you want the
report to be viewed by other users (the report is private by default, i.e. the checkbox is
not selected).
5. Set the time frame for the report by selecting it from the drop-down list in the Select
time section. If you select Custom Time, set the From and To date and time.
6. Select Category or Entity Type and select an item from the relevant drop-down list; the
unselected drop-down list becomes active. Only the items that are relevant to your
selection are displayed.
7. Select an item from the second list.
8. Select a display type by clicking one of the options. Only the relevant options are
enabled.

174

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

9. Click Next.

Figure 113 Add New Report - Properties

10. Select the relevant elements from the list. You can use the following:
Typing a string in the search window to filter the list.
Clicking the Select All icon to select all items on the list.
Clicking the Deselect All icon to unselect all items on the list.
Clicking the Show All/Show Only Selected icon to show all items or to show only
the items you selected, respectively.
Note: Elements content and display differ according to the selected entity type.
11. Select the elements properties to appear in the report.
Note: Properties content and display differ according to the selected category and
entity type.
12. Set the aggregation level (default is Average).
Note: Setting the aggregation level is not enabled for real-time reports.

Managing the Reports

175

Monitoring the Cluster

13. Click Next.

Figure 114 Add New Report - Review

14. If you want to run the report immediately after its creation, select Run Report
Immediately.
15. Review the reports parameters and click Finish; the report is added to the report list
and if you selected to run it upon creation, the reports data appears in the main
window.
To modify a copy of a pre-defined report:
1. On the menu bar, click the Report icon; the Report window appears.
2. On the All Reports pane, right-click the report you want to modify and select Copy from
the drop-down menu; the copy of the selected report appears below the source on the
report list. The copy is titled <source report name>-copy (My Public).
3. Right-click the copy and select Modify from the drop-down list to modify the reports
copy.
Note: When editing a copy of a report, you cannot change the category and entity type.
4. Edit the reports name in the Report name field. The report copys default name is
<source name>-copy. The name does not have to be unique.
5. Set the reports access rights. The report copy is public by default. To change it to
private, clear the Public Report option.

176

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

6. Select a time frame from the drop-down list in the Select time section to edit the time
frame for the report. If you select Custom Time, set the From and To date and time.
7. Click one of the display options to edit the display type. Only the relevant options are
enabled.
8. Click Next.
9. Select the relevant elements from the list. You can use the following:
Filter the list by typing a string in the search window.
Select all items on the list by clicking the Select All icon

Unselect all items on the list by clicking the Deselect All icon
Show all available items by clicking the Show All icon

Show only the items you selected by clicking the Show Only Selected icon

Note: Elements content and display differ according to the selected entity type.
10. Select the elements properties to appear in the report.
Note: Properties content and display differ according to the selected category and
entity type.
11. Set the aggregation level (default is Average).
Note: Setting the aggregation level is not enabled for real-time reports.
12. Click Next.
13. If you want to run the report immediately after its creation, select Run Report
Immediately.
14. Review the reports parameters and click Finish; the edited report appears on the
Reports list. If you selected to run it, the reports data appears in the main window.

Modifying a Report
To edit a report:
1. Right-click the report on the report list and select Modify from the drop-down list.
Note: When editing a copy of a report, you cannot change the category and entity type.
2. Edit the reports name in the Report name field. The report copys default name is
<source name>-copy. The name does not have to be unique.
3. Set the reports access rights. The report copy is public by default. To change it to
private, clear the Public Report option.
4. Select a time frame from the drop-down list in the Select Time section to edit the time
frame for the report. If you select Custom Time, set the From and To date and time.

Managing the Reports

177

Monitoring the Cluster

5. Click one of the display options to edit the display type. Only the relevant options are
enabled.
6. Click Next.
7. Select the relevant elements from the list. You can use the following:
Filter the list by typing a string the search window.
Click the Select All icon
Click the Deselect All icon

to select all the items on the list.


to un select all the items on the list.

Click the Show All/Show Only Selected icon


only the items you selected, respectively.

to show all the items or to show

Note: Elements content and display differ according to the selected entity type.
8. Select the elements properties to appear in the report.
Note: Properties content and display differ according to the selected category and
entity type.
9. Set the aggregation level (default is Average).
Note: Setting the aggregation level is not enabled for real-time reports.
10. Click Next.
11. If you want to run the report immediately after its creation, select Run Report
Immediately.
12. Review the reports parameters and click Finish; the edited report appears on the
report list. If you selected to run it, the reports data appears in the main window.

Closing a Report
To close a report:

On the Reports list, right-click the report and select Stop and Close from the
drop-down menu or right-click the report tab and select Close; the report is closed
and the icon next to the report in the report list is changed to indicate it is closed.

Deleting a Report
To delete a report:

On the Reports list, right-click the report and select Delete from the drop-down menu;
the report is deleted from the list.
Note: Predefined reports cannot be deleted.

178

EMC XtremIO Storage Array User Guide

Monitoring the Cluster

Exporting a Report
To export a report:
1. Right-click the report from the Reports list and select Export Report Data from the
menu.

Figure 115 Export Report File Name

2. In the File Name dialog box, provide a name for the exported report file.
3. Click OK; the displayed success message specifies the exported report location.

Figure 116 Export Report - Success Message

4. Click Close.
Note: The reports are exported in CSV format. The time stamp of the exported reports is in
UTC time.
Note: Reports with Real Time Monitor time definition cannot be exported.

Managing Reports, Using the CLI


Use the following CLI commands for managing reports:
Command

Description

show-report

Displays the details of a specified report.

show-reports

Displays a list of defined reports.

show-reports-data

displays a reports data for a specified entity and category.

Managing the Reports

179

Monitoring the Cluster

180

EMC XtremIO Storage Array User Guide

CHAPTER 6
Managing Volume Operations
This chapter includes the following topics:

Overview...............................................................................................................
Managing Storage Elements Tags ..........................................................................
Managing Volumes and Snapshots .......................................................................
Managing the Consistency Groups ........................................................................
Managing the Snapshot Sets ................................................................................
Managing the Initiator Groups...............................................................................
Managing Initiators ...............................................................................................
Managing Mapping ...............................................................................................
Managing the Schedulers......................................................................................

Managing Volume Operations

182
183
190
222
236
249
260
263
272

181

Managing Volume Operations

Overview
One of the primary capabilities of the XtremIO Storage Array is to provision Volumes
(LUNs) to the connected servers.
A Volume is a defined quantity of disk space. Once you have created a Volume, you can
provision it to your servers, enabling them to treat the Volume as a SCSI device.
Once Volumes are provisioned, it is possible to create Snapshots (instantaneous copy
images) of Volume data.
XtremIO's Snapshot technology enables sustaining high performance, while maximizing
the media endurance, both in terms of the ability to create multiple Snapshots and the
amount of I/O that a Snapshot can support.
This chapter describes Volume characteristics and explains how to manage Volumes and
Snapshots, using the XtremIO Storage Array GUI and CLI.

182

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Managing Storage Elements Tags


XtremIO Storage Array provides users with a tagging system for marking the various
storage elements. Tagging objects enables you to logically group, locate and manage
multiple entities, and perform operations on multiple objects, using a single user
command. You can use tagging to aggregate objects based on business requirements, and
assign Tags according to related applications for ease-of-management.
Each object can have multiple Tags to reflect the objects function and position. Using Tag
nesting, you can create a hierarchy that reflects the relationship between different cluster
objects.
Tags can be used both via the GUI and the CLI.
Using Tags, you can perform the following:

Filter Volumes for creating a Consistency Group.

Filter objects for reports.

Create aggregated Tag reports (using Volume Tags and IG Tags).

Map hosts of a cluster to a Volume (using IG Tags).

Object Naming Limitations


Tag names must comply with the following limitations:

Allowed length: up to 64 characters

Valid characters:
Alphanumeric characters
Space character
The following characters: ~ ! @ # $ % ^ * _ + { } | : ? . -

Invalid characters: & / < > ( )

Managing Storage Elements Tags

183

Managing Volume Operations

Managing Tags, Using the GUI


Creating Tags
You can create Tags for the following storage elements:

Volumes

Consistency Groups

Snapshot Sets

Initiator Groups

Initiators

Schedulers

To create Tags for clusters storage elements:


1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click the Create Tag icon.

Figure 117 Create Tags - Configuration

3. Type a Tag name in the Tag caption field.


4. Select the Tag color. You can select a different color for each object type by clicking the
Color (gray) square to open the color palette and clicking a color.
5. Select the object types you wish to assign the new Tag to. If you want to select all
objects, click Select All.
6. Click OK; the new Tag is added to the selected object types.
Note: The created Tag is not assigned to specific objects. To assign the Tag to objects, see
Assigning Tags to Storage Elements on page 185.

184

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Assigning Tags to Storage Elements


To assign a Tag to a storage element:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click the object type you wish to tag to display the
defined objects in the main window.
3. Right-click an object from the list in the main window and select Manage Tags. You can
select multiple objects from the list, using the Ctrl and Shift keys.

Figure 118 Assigning Tags to Logical Objects

The Manage Tags for <object> window displays the object type and all Tags that were
defined for it. Tags that are already assigned to the object are checked.
Note: For multiple objects, the dialog boxs title is Manage Tags for <number of
objects>.
4. Select the Tags you want to assign to the object and click OK.
Note: Another way to assign a Tag is to drag and drop the object you want to tag from the
main window to the Tag that is located below the object type in the Storage tab.

Managing Storage Elements Tags

185

Managing Volume Operations

Assigning and Creating Tags as Part of a Create/Refresh Procedure


You can assign and create Tags as part of the following procedures:

Creating Volumes (single or multiple)

Creating Consistency Groups

Creating Snapshot Sets

Creating Initiator Groups

Creating Snapshots of Volumes/Consistency Group/Snapshot Sets

Refreshing Volumes/Snapshots/Consistency Groups/Snapshot Sets

Creating Schedulers

To assign and create a Tag (as part of a create/refresh procedure):


1. Click Next to open the Manage Tags window.

Figure 119 Manage Tags Window

Note: The Manage Tags window, shown in Figure 119, is for Volume Tags. The
windows title is changed according to the relevant storage object.
The Manage Tags for <object> window displays the object type and all Tags that were
defined for it. Tags that are already assigned to the object are checked.
Note: For multiple objects, the dialog boxs title is Manage Tags for <number of
objects>.
2. Select the Tags you want to assign to the object.

186

EMC XtremIO Storage Array User Guide

Managing Volume Operations

3. If you want to create a new Tag for the object, perform steps 4 - 8. Otherwise, skip
these steps.
4. Click Create Tag.

Figure 120 Create Tag Window

Note: The Object type is already selected according to the relevant storage object.
5. Type a Tag name in the Tag caption field.
6. Select the Tag color. You can select a different color for each object type by clicking the
Color (gray) square to open the color palette and clicking a color.
7. Click to open the drop-down list of the relevant object and select the Tags nesting
path.
8. Click OK; the new Tag is added to the selected object types and is automatically
selected.

Managing Storage Elements Tags

187

Managing Volume Operations

Modifying Tags
To modify storage elements Tags:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), double-click the relevant object type to open the list of
Tags defined for that object type.
3. Right-click the Tag you wish to modify and select Modify Tag from the drop-down list.

Figure 121 Modify Tag

4. In the Modify Tag dialog box you can edit the following parameters:
Tag caption
Tag color
5. Click OK.

Removing Tags
To remove storage elements Tags:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), double-click the relevant object type to open the list of
Tags defined for that object type.
3. Right-click the Tag you wish to remove and select Delete Tag from the drop-down list.
4. Click Yes to confirm; the Tag is deleted from the object type Tag list.

188

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Managing Tags, Using the CLI


Use the following CLI commands for managing Tags:
Command

Description

show-tags

Displays the details of all defined Tags.

show-tag

Displays the details of a specified Tag.

create-tag

Creates a Tag for an entity.

tag-object

Assigns a Tag to a specified object.

untag-object

Removes a Tag from a specified object.

modify-tag

Modifies a specified Tag caption.

remove-tag

Deletes a Tag from the Tags list.

Managing Storage Elements Tags

189

Managing Volume Operations

Managing Volumes and Snapshots


This section describes Volume and Snapshots characteristics and explains how to manage
them, using the XtremIO Storage Array GUI and CLI.

Volumes Overview
A Volume is a set of blocks, presented to the operating environment as a range of
consecutive logical blocks with disk-like storage and I/O semantics. It is possible to define
various quantities of disk space as Volumes in an active cluster.
Volumes have the following main characteristics:

Volume size - the quantity of disk space reserved for the Volume

LB size - the logical block size in bytes

Alignment-offset - a value for preventing unaligned access performance problems

Volume type - Writable or Read-Only


A Volume is created as Writable, while a Snapshot can be created as either Writable or
Read-Only.

Access rights - the permitted access level of a Volume (see below)

Note: In the GUI, selecting a predefined Volume type defines the alignment-offset and LB
size values. In the CLI, you can define the alignment-offset and LB size values separately.
A Volume can have one of the following access levels:

No access - With this access level, all SCSI commands for accessing data on the
Volume (read and write commands) fail, and all SCSI discovery commands (i.e
inquiries on Volume characteristics without accessing the data on the Volume)
succeed.
Read access - With this access level, all SCSI write commands fail, and all SCSI read
and discovery commands succeed.
Write access - With this access level, the host is authorized to write to the Volume and
all commands succeed.

After creating Volumes and Snapshots, you can modify them and change their access
level:

A Snapshots access level can be modified only if it was originally created as Writable.

A Volumes access level can be modified, since it is always created as Writable.

Note: Volumes and Snapshots access rights can be modified only via CLI (see
modify-volume on page 443).

190

EMC XtremIO Storage Array User Guide

Managing Volume Operations

To manage the disk space, using Volumes:


1. Create a Volume and define its allocation of disk space (see Managing Volumes and
Snapshots on page 190).
2. Create an Initiator Group and its related Initiators (ports - see Managing the Initiator
Groups on page 249).
3. Allow the Initiators to access the Volume's disk space by mapping the Initiator Group
to a selected Volume (see Managing Mapping on page 263).

Snapshots Overview
Snapshots are instantaneous copy images of Volume data with the state of the data
exactly as it appeared at the specific point in time the Snapshot was created. Snapshots
enable you to save the Volume data state and then access the specific Volume data
whenever needed, even after the source Volume has changed.
A Snapshot can be taken either directly from a source Volume or from any of its
Snapshots. Changes in the Volume data do not change the Snapshot.
Snapshots can be used to serve several purposes, such as a means of data protection and
backup, data analysis and reporting.
Accessing Snapshots is performed the same way as accessing Volumes in the cluster in
Read/Write access mode.
Snapshots can be saved in the system for as long as deemed necessary.
XtremIO uses the following storage objects for managing Snapshots and optimizing their
usability:

Volume Snapshot Groups - A Volume Snapshot Group (VSG) includes a Volume and all
Snapshots derived from it. The VSG is referred to in reports of used space, i.e. the
space used by a Volume and all its derived snapshots are reported, rather than the
space used by a single volume.
Consistency Groups - Consistency Groups (CG) are used to create a consistent image of
a set of Volumes. Using Consistency Groups, you can create Snapshots of all Volumes
in a group, using a single command, thus ensuring that all Snapshots are created at
the same point in time.
Snapshot Set - A Snapshot Set is a group of Snapshots that were taken (of a
Consistency Group or of multiple Volumes that are not members of a group), using a
single command and provides a point-in-time representation of a group.
Read-Only Snapshots - A read-only Snapshot cannot be written to. Therefore, it
provides an immutable copy of data and can be mapped to an external host, such as a
backup application.
Scheduler - The Scheduler defines a timetable for taking Snapshots of a Volume, a
Consistency Group or a Snapshot Set.

The following Snapshot types are available:

Snapshot of a Volume/Snapshot.

Managing Volumes and Snapshots

191

Managing Volume Operations

Snapshot Set - a Snapshot of a set of members (Volumes/Snapshots,


Volume/Snapshots within a Consistency Group, Snapshots within a Snapshot Set).
A Snapshot of a set of up to 256 members (maximum) can be created per operation,
enabling the system to create a cross-consistent Snapshot containing the exact
same-point-in-time image for all members. This can be carried out manually by
selecting a set of Volumes for snapshotting, or by placing Volumes in a Consistency
Group container and creating a Snapshot of the Consistency Group.

Snapshot of tagged Volumes or Snapshots - the system creates a cross-consistent


copy of all Volumes or Snapshots that are assigned a specific Tag.

To create a Snapshot, the following pre-conditions are required:

Defined Volumes to be used as the source of the created Snapshot.


Defined Initiator Groups and Initiators (optional) - although not mandatory for defining
Snapshots, Initiators enable mapping Volumes to host, allowing read and write
operations to be performed.

Mapping of Volumes to Initiators (optional) - to enable read and write operations.

Tags (optional) - to simplify multiple Snapshot operations.

Regardless of the Snapshots source (Volume, Snapshot, CG or Snapshot Set), the


Snapshot operation results in a Snapshot Set containing the Snapshot or Snapshots of
the source.

192

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Managing Volumes and Snapshots, Using the GUI


Creating Volumes
Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).
To create Volumes:
1. On the menu bar, click Configuration.
2. In the Storage tab, click Volumes to open the Volumes window.
3. On the Volume window menu bar, click Create Volume. You can also right-click
Volumes in the Storage tab and select Create Volume.

Figure 122 Create Volumes

Managing Volumes and Snapshots

193

Managing Volume Operations

4. In the Create Volumes screen, define the following:


Name - the name of the Volume (up to 256 characters)
Size - the amount of disk space allocated for this Volume:
Minimum Volume size is 1MB.
Size should be in multiples of 8KB.
Allowed units for allocation are KB, MB, GB, TB and PB.
Logical Block Size - From the drop-down list, select one of the following types that
define the LB size and alignment-offset:
Normal (512 LBs)
4KB LBs
Note: In general, a 512B logical block size should be used for a new XtremIO
volume. Refer to the XtremIO Host Configuration Guide for disk formatting
information according to Operating System.
VAAI TP Alerts - Set to enabled if you want an alert to be sent when the storage
capacity reaches the set limit (refer to Configuring Cluster Limits via the GUI on
page 302).
Small IO Alerts - Set to enabled if you want an alert to be sent when small I/Os
(<4KB) are detected.
Unaligned IO Alerts - Set to enabled if you want an alert to be sent when unaligned
I/Os are detected.

194

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Volume Summary

Figure 123 Add New Volumes - Summary Line

The summary line displays the number of Volumes defined in the list and their total
disk space.
Note: Using this method, you can add multiple Volumes with varying definitions. If you
want to add multiple Volumes with the same size and type, refer to Creating Multiple
Volumes on page 196.
5. To assign and/or create Tags for the new Volumes, refer to Assigning and Creating
Tags as Part of a Create/Refresh Procedure on page 186.
Note: To assign and create Tags outside the Volume creation context, refer to
Managing Tags, Using the GUI on page 184.
6. Click Finish; the new Volumes are added in the Volumes table.

Managing Volumes and Snapshots

195

Managing Volume Operations

Creating Multiple Volumes


Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).
To create multiple Volumes with the same size and type:
1. On the menu bar, click Configuration.
2. In the Storage tab, click Volumes to open the Volumes window.
3. On the Volume window menu bar, click Create Volume. You can also right-click
Volumes in the Storage tab and select Create Volume.
4. In the Create Volumes window, click Add Multiple.

Figure 124 Add Multiple Volumes Dialog Box

5. Define the following:


Number of Volumes
Name - When you add multiple Volumes, all Volumes are assigned with a uniform
prefix (set in the Name field) and a unique numeral suffix assigned automatically
(e.g. vol1, vol2...).
Start Index - Each Volume must have a unique name. Each time you add multiple
Volumes, the suffix automatically starts at 1. Therefore, adding multiple Volumes
more than once while using the same prefix, results in repeating names.
To solve this, when you are adding Volumes with an existing prefix, select the Start
Index option and set the start index to obtain unique names (e.g. if the existing
Volumes are vol1, vol2 and vol3 and you want to create four more Volumes with the
vol prefix, set the Start Index at 4).
Size - the amount of disk space allocated for this Volume:
Minimum Volume size is 1MB.
Size should be in multiples of 8KB.
Allowed units for allocation are KB, MB, GB, TB and PB.

196

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Logical Block Size - From the drop-down list, select one of the following types that
define the LB size and alignment-offset:
Normal (512 LBs)
4KB LBs
Note: In general, a 512B logical block size should be used for a new XtremIO
volume. Refer to the XtremIO Host Configuration Guide for disk formatting
information according to Operating System.
Enable Small IO Alerts - Select this checkbox if you want an alert to be sent when
small I/Os (<4KB) are detected.
Enable Unaligned IO Alerts - Select this checkbox if you want an alert to be sent
when unaligned I/Os are detected.
Enable VAAI TP Alerts - Select this checkbox if you want an alert to be sent when
the storage capacity reaches the set limit (refer to Configuring the Cluster
Encryption on page 307).
6. Click OK; the new Volumes appear in the Volumes list of the Create Volume dialog box.
Note:
You can use the following tools in the Add New Volumes window:

Copy/Paste - Right-click a Volume and select Copy. Right-click in a row and select Paste.

Select multiple Volumes - Select a Volume, hold Shift and select additional Volumes.

Remove Volumes - Select a Volume and click Remove.

7. To assign and/or create Tags for the new Volumes, refer toAssigning and Creating
Tags as Part of a Create/Refresh Procedure on page 186.
Note: To assign and create Tags for the new Volumes outside of the Volume creation
context, refer to Managing Tags, Using the GUI on page 184.
8. Click Finish; the new Volumes appear in the Volumes table in the Volumes window.

Managing Volumes and Snapshots

197

Managing Volume Operations

Creating Snapshots
Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).
To create a Snapshot:
1. On the menu bar, click Configuration.
2. In the Storage tab, click Volumes to open the Volumes window.
3. Select a Volume from the Volumes table.
Note: To select multiple members listed sequentially, select a member, hold Shift and
select the additional members. To select multiple individual list members, select a
member, hold Ctrl and select the additional list members.
4. On the Volumes table Menu Bar, click Create Snapshot. Another option is to right-click
one of the selected objects and select Create Snapshot from the drop-down menu.

Figure 125 Create Snapshot Dialog Box

5. Set the new Snapshot Set name. The default name is SnapshotSet.<EPOCH>.
6. Set the Snapshot suffix that will be added to all the Snapshots in the Snapshot Set.
The default suffix is <EPOCH>.
7. Set the Snapshot type by selecting Writable or Read-Only (default value is Writable).

198

EMC XtremIO Storage Array User Guide

Managing Volume Operations

8. To assign and/or create Tags for the new Snapshot Set, refer to Assigning and
Creating Tags as Part of a Create/Refresh Procedure on page 186.
9. To assign and/or create Tags for the new Snapshot, refer to Assigning and Creating
Tags as Part of a Create/Refresh Procedure on page 186.
Note: To assign and create Tags for the new Snapshot and/or Snapshot Set outside of
the Snapshot/Snapshot Set creation context, refer to Managing Tags, Using the GUI
on page 184.
10. Click Finish; the new Snapshot Set appears in the Snapshot Set window, and the
Snapshots included in the Snapshot Set appear in the Volumes window.
Note: It is recommended to view the created Snapshots in the Snapshot Set
workspace. See Managing the Snapshot Sets on page 236.

Snapshot Operations
The following operations are performed the same way for Snapshots and Volumes. Refer
to the corresponding Volume procedures:

Viewing Snapshots (refer to Viewing Volumes on page 200)

Viewing Snapshot properties (refer to Viewing Volume Properties on page 201)

Renaming Snapshots (refer to Renaming Volumes on page 202)

Deleting Snapshots (refer to Deleting Volumes on page 204)

Viewing Snapshot alerts (refer to Managing Volumes and Snapshots, Using the CLI
on page 221)
Mapping Snapshots to Initiators (refer to Mapping Volumes to Initiator Groups on
page 208)
Accessing Snapshots via Initiators (refer to Managing Initiator Groups, Using the CLI
on page 259)

Managing Volumes and Snapshots

199

Managing Volume Operations

Viewing Volumes
Note: This procedure is used for Volumes and Snapshots.
To view Volumes and Snapshots:
1.

On the menu bar, click Configuration.

2. In the Storage tab, double-click Volumes to open the Volume Tags list and display the
Volume window.
3. If you wish to view only Volumes and Snapshots tagged by a specific Tag, click the Tag
in the Volumes Tag list.
Note: The Volumes table includes both Volumes and Snapshots. Each object can be
identified by its icon, as shown in Figure 126.

Volume Icon
Snapshot Icon

Figure 126 Volumes and Snapshot Table

Viewing the Volume Performance


To view the Volume performance:
1. On the menu bar, click Dashboard.
2. Select the Bandwidth or IOPS tab to view performance according to those units.
3. In the Most Active section, make sure that Volumes is selected from the drop-down
menu.
Note: You can view the top four most active Volumes in the Dashboard. To view the
performance of all Volumes, use the show-volume CLI command.

200

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Viewing Volume Properties


Note: This procedure is used for Volumes and Snapshots.
To view Volume properties:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Volumes to display the Volumes window.

Figure 127 Volumes Table

The Volumes table displays the following properties for each Volume:
Volume name
Cluster Name (in multiple clusters settings)
Creation Time
Is Read Only
Is mapped
NAA identifier
Space in Use (VSG)
Volume Size
Logical block size
Alignment offset
Tags
Clicking the Show More Info icon (see Table 23) displays the following additional
information for each Volume:
Created from Volume
Created by Application
Volume Access
VAAI TP Alerts
Small IO Alerts
Unaligned IO Alerts

Managing Volumes and Snapshots

201

Managing Volume Operations

Renaming Volumes
Note: This procedure is used for Volumes and Snapshots.
To rename a Volume:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Volumes to open the Volumes window.
3. Right-click the relevant Volume in the Volumes table and select Rename from the
drop-down menu.

Figure 128 Rename Volume Dialog Box

4. In the Rename dialog box, enter the name for the Volume (up to 128 characters).
5. Click OK.

Modifying Volumes
Note: This procedure is used for Volumes and Snapshots.
The following Volume modifications can be made:

Resize Volumes - Resizing a Volume (altering the amount of space allocated for the
Volume) enables increasing1 the size of mapped (exported) or unmapped volumes or
Snapshots. Volumes do not have to be unmapped in order to be resized.
Resizing a volume with one or more Snapshots does not change the size of the
existing Snapshots. Resizing a Snapshot does not change the size of its source entity.

Enable or disable alerts:


Small I/O alerts
Unaligned I/O alerts
VAAI TP alerts

Note: Small I/O alerts, Unaligned alerts and VAAI TP alerts are described on page 194.

1. The Resize feature in the current software version only enables increasing the Volume and
Snapshot sizes.
202

EMC XtremIO Storage Array User Guide

Managing Volume Operations

To modify volume properties:


1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Volumes to display the Volumes window.
3. Double-click the Volume you wish to modify; the Modify Volume dialog box is
displayed (you can also right-click the Volume and select Modify from the drop-down
list).

Figure 129 Modify Volume Dialog Box

4. Type the Volume size in the Size field:


Minimum Volume size is 1MB.
Size should be in multiples of 8KB.
Allowed units for allocation are KB, MB, GB, TB and PB.
5. Select or clear the Volume Alerts options to enable or disable the corresponding
alerts.
6. Click OK.
Note: After resizing a Volume, the host must perform a full re-scan.

Managing Volumes and Snapshots

203

Managing Volume Operations

Deleting Volumes
Note: This procedure is used for Volumes and Snapshots.
Note: Mapped Volumes cannot be deleted. To delete mapped Volumes, unmap them prior
to deletion.
Note: A Volume cannot be deleted if there is a Scheduler defined for it. The Scheduler
must be deleted prior to deleting the Volume.
To delete a Volume:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Volumes to display the Volumes window.
3. Right-click the Volume you want to delete and select Delete from the drop-down menu.
You can select multiple Volumes, using the Shift and Ctrl keys.
Note: To delete mapped Volumes, unmap the Volumes and then delete them.
Note: Volumes that are members of a Consistency Group cannot be deleted and must
be removed from the Consistency Group prior to deletion.
4. Confirm the deletion by clicking Yes; the Volumes are deleted from the Volumes
window.

204

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Creating a Consistency Group


Consistency Groups (CG) are used to create a consistent image of a set of Volumes.
Grouping multiple Volumes and Snapshots into a Consistency Group simplifies performing
actions, such as creating Snapshots, and ensures that all Snapshots are created at the
same point in time.
Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).
To create a Consistency Group:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Volumes to display the Volumes window.
3. From the Volume list, select the Volumes/Snapshots you want to include in the
Consistency Group. You can select multiple Volumes, using the Shift and Ctrl keys.
4. Right-click one of the selected Volumes and select Create Consistency Group from the
drop-down menu.

Figure 130 Create Consistency Group

5. In the Create Consistency Group dialog box, type a unique name for the Consistency
Group.

Managing Volumes and Snapshots

205

Managing Volume Operations

6. To assign and/or create Tags for the new Consistency Group, refer to Assigning and
Creating Tags as Part of a Create/Refresh Procedure on page 186.
Note: To assign and create Tags for the new Consistency Group outside of the
Consistency Group creation context, refer to Managing Tags, Using the GUI on
page 184.
7. Click Finish; the new Consistency Group is added to the Consistency Group table in the
Consistency Group window.

Adding Volumes to a Consistency Group


Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).
To add Volumes to a Consistency Group:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Volumes to display the Volumes window.
3. Select a Volume/Snapshot from the Volume list. You can select multiple Volumes,
using the Shift and Ctrl keys.
4. On the Volume pane menu bar, click Add Volume to Consistency Group. You can also
right-click the selected Volume and select Add Volume to Consistency Group from the
drop-down menu.

Figure 131 Add Volume to Consistency Group

206

EMC XtremIO Storage Array User Guide

Managing Volume Operations

5. Select the Consistency Groups to which you want to add the Volumes. You can select
more than one Consistency Group, using the following options from the menu bar:
Type a text string to filter the displayed Consistency Group list.
Click the Select All icon
Click the Deselect All icon
Click the Show All icon

to select all displayed Consistency Groups.


to revoke the Consistency Group selection.
to display all defined Consistency Groups.

Click the Show Only Selected icon


from the display.

to remove unselected Consistency Groups

6. Click Finish; the selected Volumes are added to the selected Consistency Groups.
Note: You can also add Volumes to a Consistency Group by first selecting a Consistency
Group and then selecting Volumes to add to it. See Adding a Volume to a Consistency
Group on page 228 for details.

Managing Volumes and Snapshots

207

Managing Volume Operations

Removing Volumes from a Consistency Group


Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).


Removing a Volume from a Consistency Group may cause loss of cross-consistency of
future Snapshots and compromise the ability to restore data from Snapshots taken prior
to the Volume removal.
To remove Volumes from a Consistency Group:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Volumes to open the Volumes window.
3. On the Volumes list, right-click a Volume/Snapshot from the Volume list that is a
member of a Consistency Group and select Remove Volume from Consistency Group
from the drop-down menu.

Figure 132 Remove Volume from Consistency Group - Warning

4. Click Yes to confirm; the Volume is removed from the Consistency Group.
Note: It is recommended to remove Volumes from a Consistency Group by first selecting a
Consistency Group and then selecting Volumes to remove from it. See Removing a
Volume from a Consistency Group on page 229 for details.

Creating a Snapshot Scheduler for Volumes or Snapshots


To create a Snapshot Scheduler for Volumes or Snapshots, refer to Creating a Scheduler
on page 272.

Mapping Volumes to Initiator Groups


Refer to Managing Mapping on page 263.

208

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Restoring Data from a Snapshot


XtremIO enables your storage array to recover from data corruption by restoring the
corrupted data from an undamaged backup copy (Snapshot), created at an earlier point in
time. The restored Volume will contain the same data as the source backup.
To restore a production Volume, the following pre-conditions must exist:

The Volume must have a read-only Snapshot, created at a point in time before the
Volumes data was corrupted.
The source and target Volumes must be of the same size.

The restore operation uses the Snapshot to replace the corrupted production Volume
without changing the SCSI face (NAA) of the restored entity. As a result, the corrupted
Volume is restored without the need for remapping or rescanning on the host side.
The restore action can be applied in the following cases:

Restoring a Volume from a Snapshot

Restoring a Snapshot from a Snapshot

Restoring a Consistency Group from a Snapshot Set (see Restoring a Consistency


Group from a Snapshot Set on page 224)

Note: To enable restoring a Volume, unmount it from the host before starting the restore
procedure. After restoration is complete, re-mount the restored Volume.
Note: If the Volume you wish to restore is a member of a Consistency Group, it may impact
data consistency withing the group. Confirm the restore action before proceeding.
Note: Data can be restored only from read-only source Volumes.
Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).

Managing Volumes and Snapshots

209

Managing Volume Operations

To restore a Volumes data from a Snapshot:


1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Volumes to display the Volumes window.
3. On the Volume list, right-click the Volume whose data you wish to restore, and click
Restore from Read-Only Snapshot from the drop-down list.

Figure 133 Restore from Read-Only Snapshot - Select Snapshot

The Volume table displays the Snapshots taken for the specified Volume or Snapshot.

210

EMC XtremIO Storage Array User Guide

Managing Volume Operations

4. From the table, select a Snapshot you want to use as the source for restoring the
Volumes data. Use the following options from the menu bar:
Type a text string to filter the displayed Snapshot list.
Click the Select All icon
Click the Deselect All icon
Click the Show All

to select all displayed Snapshots.


to revoke the Snapshot selection.

to display all defined Snapshots.

Click the Show Only Selected icon


the display.

to remove the unselected Snapshots from

Note: You can select only one Snapshot from the list.
5. The original Volumes data (before restoring) is kept by default as backup. If you want
to remove it, clear the Keep the backup of the Data prior to Restore/Refresh operation
option.
6. Click Finish; the restored Volume is placed in a newly-created Snapshot Set. If you
kept the backup, a new Snapshot is added to the Volumes list, containing the original
data (before restoring).

Managing Volumes and Snapshots

211

Managing Volume Operations

Refreshing a Volume
XtremIO enables you to take a Snapshot of an existing storage object, and later refresh the
Snapshot data to match that of the source objects current state without the need to
explicitly change the mapping and zoning of the host.
The refresh operation replaces an outdated storage object with an updated version
without changing the SCSI face (NAA) of the refreshed object. As a result, the outdated
object is refreshed without the need for remapping or rescanning on the host side.
The following examples are use cases that are supported by Refresh:

Copy of production environment (e.g. DataBase, Data Warehouse, Real-Time


Analytics):
A Snapshot of a production Volume is mapped to a different host. At a certain point in
time (or upon demand), the Snapshot is refreshed from the production Volume.
Support for development life-cycle:
Multiple copies are created from the production Volume. The copies are serving the
development environment (e.g. post-production, QA, Development). At a certain point
in time (or upon demand), each copy can be refreshed from another copy (e.g.
development copy refreshed from post-production copy, QA copy refreshed from
development copy).

The refresh operation can be applied in the following cases:

Refreshing a Snapshot with an updated source Volume

Refreshing a source Volume with a Snapshot

Refreshing a Snapshot with another Snapshot

Note: Before applying the refresh procedure, unmount the refreshed object. After refresh
is complete, re-mount the refreshed object.
Note: If the Volume you wish to restore is a member of a Consistency Group, it may impact
data consistency withing the group. Confirm the restore action before proceeding.
Note: The source and target Volumes must be of the same size.
Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).

212

EMC XtremIO Storage Array User Guide

Managing Volume Operations

To refresh a Snapshot:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Volumes to display the Volumes window.
3. On the Volume list, right-click the Snapshot whose data you wish to refresh and click
Refresh from the drop-down list.

Figure 134 Refresh - Select Snapshot

The Select Snapshot window displays the selected Snapshots source Volume and all
Snapshots of the source Volume.
4. Select the Snapshot or Volume you want to use for refreshing the Snapshot, using the
following options from the menu bar:
Type a text string to filter the displayed Snapshot list.
Click the Select All icon
Click the Deselect All icon
Click the Show All icon

to select all displayed Snapshots.


to revoke the Snapshot selection.
to display all defined Snapshots.

Click the Show Only Selected icon


display.

to remove the unselected Snapshot from the

Note: You can select only one object from the list.
5. The original Snapshot data (before the refresh action) is kept by default. If you want to
remove it, clear the Keep the backup of the Data prior to Restore/Refresh operation
option.

Managing Volumes and Snapshots

213

Managing Volume Operations

6. To assign and/or create Tags for the created Snapshot Set, refer to Assigning and
Creating Tags as Part of a Create/Refresh Procedure on page 186.
7. To assign and/or create Tags for the created Snapshot, refer to Assigning and
Creating Tags as Part of a Create/Refresh Procedure on page 186.
Note: To assign and create Tags outside of the refresh procedure context, refer to
Managing Tags, Using the GUI on page 184.
8. Click Finish; a new Snapshot Set is added to the Snapshot Set list, containing the
refreshed Snapshot. If you kept the data backup, the old Snapshot Set, will contain
the original data (before the refresh operation) as a newly created Snapshot.
Note: If the Snapshot Set containing the refreshed Snapshot has an associated Scheduler,
and you selected to remove the backup, the Scheduler should be deleted before the
refresh operation. A new Scheduler should be created for the newly created snapshot set
(containing the refreshed snapshot) when the refresh operation is complete. Refer to
Deleting a Scheduler on page 275 and Creating a Scheduler on page 272.

214

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Viewing the Volumes-Related Information


The Volumes Window displays, in addition to the defined Volumes and Snapshots,
additional related information. The following information is available in the pane below
the Volumes table:

Mapping

Consistency Groups

Snapshot Sets

Volume Snapshot Groups

Schedulers

Alerts

To view the mapping information:

Select a Volume and click the Mapping tab.

Figure 135 Mapping Tab

The Mapping tab displays the following data:


Volume
The Initiator Groups mapped to the Volume and the number of LUNs for each
Initiator Group

Managing Volumes and Snapshots

215

Managing Volume Operations

To view the Consistency Group information:

Select a Volume and click the Consistency Groups tab.

Figure 136 Consistency Groups Tab

The Consistency Groups tab displays the following data:


Name
Cluster
Read-Only
Mapped
Number of Volumes
Number of Snapshot Sets
Tags

216

EMC XtremIO Storage Array User Guide

Managing Volume Operations

To view the Snapshot Set information:

Select a Volume and click the Snapshot Sets tab.

Figure 137 Snapshot Sets Tab

The Snapshot Sets tab displays the following data:


Name
Cluster
Creation Time
Read-Only
Mapped
Originated From
Number of Volumes
Tags

Managing Volumes and Snapshots

217

Managing Volume Operations

To view the Volume Snapshot Groups information:

Select a Volume and click the Volume Snapshot Groups tab.

Figure 138 Volume Snapshot Groups Tab

The Volume Snapshot Groups tab displays the following data:


VSG Name and Volume/Snapshot nesting
Total Volumes
Include hidden Volumes
Allocated Size
Space in Use (VSG)
Total Logical Volumes Size
Thin Provisioning Ratio
Number of Internal Volumes
Max Snapshot Reached
Snapshot Removal in Progress

218

EMC XtremIO Storage Array User Guide

Managing Volume Operations

To view the Schedulers information:

Select a Volume and click the Schedulers tab.

Figure 139 Schedulers Tab

The Schedulers tab displays the following data:


Scheduler Name
Cluster
Snapshot Source Name
Snapshot Source Type
Snapshot Type
Interval
Explicit Schedule
Snapshots to Keep - Number
Snapshots to Keep - Time
Last Activation Time
Last Activation State
Scheduler State
Tags

Managing Volumes and Snapshots

219

Managing Volume Operations

To view the alerts information:

Select a Volume and click the Alerts tab.

Figure 140 Alerts Tab

The Alerts tab displays the following data:


Severity
Cluster
Code
Date and Time
Entity
Entity Details
Description

220

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Managing Volumes and Snapshots, Using the CLI


Use the following CLI commands for managing Volumes and Snapshots:
Command

Description

add-volume

Creates and adds a new Volume.

remove-volume

Removes a Volume.

modify-volume

Modifies a Volumes parameters.

show-volume

Displays the specified Volumes information.

show-volumes

Displays a list of Volumes/Snapshots (including properties of


each), and the Volume Snapshot Group Index each
Volume/Snapshot belongs to.

create-snapshot

Creates a Snapshot from a specified Volume.

create-snapshot-and-reassign

Creates a Snapshot from a specified Volume/Snapshot,


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

show-volume-snapshot-groups Displays the Volume Snapshot Group and its members.


add-volume-to-consistency-gro
up

Adds a Volume to a Consistency Group.

create-scheduler

Creates a new Snapshot Scheduler.

show-snapshots

Displays a list of Snapshots and related information.

map-lun

Maps a Volume to an Initiator Group and assigns a Logical Unit


Number (LUN) to it.

Managing Volumes and Snapshots

221

Managing Volume Operations

Managing the Consistency Groups


A Consistency Group is a set of writable Volumes and Snapshots. Using Consistency
Groups enables logically grouping together storage objects and simultaneously
manipulating all members of the group (for example, creating cross-consistent Snapshots
on several Volumes that serve a single database).
Note: A Consistency Group cannot include read-only Volumes.
This section explains how to manage Consistency Groups.

Managing Consistency Groups, Using the GUI


Creating a Consistency Group
Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).
To create a Consistency Group:
1. On the menu bar, click Configuration.
2. In the Storage tab, click Consistency Groups to open the Consistency Groups window.
3. On the Consistency Groups window menu bar, click Create Consistency Group. You can
also right-click Consistency Groups in the Storage tab and select Create Consistency
Group.

Figure 141 Create Consistency Group

4. Type a unique name for the Consistency Group.

222

EMC XtremIO Storage Array User Guide

Managing Volume Operations

5. If you want to add Volumes to the new Consistency Group, select the Volumes from the
Volumes list.
Note: You can select only writable Volumes to be members of a Consistency Group.
6. To assign and/or create Tags for the new Consistency Group, refer to Assigning and
Creating Tags as Part of a Create/Refresh Procedure on page 186.
Note: To assign and create Tags outside of the Consistency Group creation context, see
Managing Tags, Using the GUI on page 184.
7. Click Finish; the new Consistency Group appears in the Consistency Group table in the
Consistency Group window.

Creating a Snapshot of a Consistency Group


A Snapshot of a Consistency Group is a Snapshot Set where all Snapshots are taken at the
same point in time.
Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).
To create a Snapshot of a Consistency Group:
1. On the menu bar, click Configuration.
2. In the Storage tab, click Consistency Groups to open the Consistency Group view.
3. Right-click a Consistency Group and select Create Snapshot from the drop-down
menu.

Figure 142 Create Consistency Group Snapshot - Snapshot Parameters

Managing the Consistency Groups

223

Managing Volume Operations

4. In the Select Snapshot Parameters window, configure the following:


Snapshot Set name (default name - SnapshotSet.<EPOCH>)
Snapshot suffix (default suffix - .<EPOCH>)
Snapshot type (writable or read-only)
5. To assign and/or create Tags for the new Snapshot Set, refer to Assigning and
Creating Tags as Part of a Create/Refresh Procedure on page 186.
6. To assign and/or create Tags for the new Snapshots, refer to Assigning and Creating
Tags as Part of a Create/Refresh Procedure on page 186.
Note: To assign and create Tags outside of the Consistency Group Snapshot procedure
context, refer to Managing Tags, Using the GUI on page 184.
7. Click Finish; the new Snapshot Set appears in the Snapshot Set table and the new
Snapshots appear in the Volumes table.

Creating a Snapshot Scheduler for Consistency Groups


To create a Snapshot Scheduler for Consistency Groups, refer to Creating a Scheduler on
page 272.

Restoring a Consistency Group from a Snapshot Set


XtremIO enables you to recover from data corruption of a Consistency Group by restoring
the corrupted data from an undamaged backup copy (Snapshot Set) created in an earlier
point in time. The restored Consistency Group will contain the same data as the Snapshot
Set backup.
To restore a production Consistency Group, there must be a read-only Snapshot Set
created at a point in time before the Consistency Groups data was corrupted.
The restore operation uses the Snapshot Set to replace the corrupted production
Consistency Group without changing the SCSI face (NAA) of the restored entity. As a result,
the corrupted Consistency Group is restored without the need for remapping of rescanning
on the host side.
Note: To enable restoring a Consistency Group, unmount the contained Volumes before
starting the restore procedure. After restoration is complete, re-mount the restored
Volumes.
Note: Data can be restored only from read-only source Snapshot Sets.
Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).

224

EMC XtremIO Storage Array User Guide

Managing Volume Operations

To restore a Consistency Group from a Snapshot Set:


1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Consistency Groups.
3. In the Consistency Group list, right-click the Consistency Group whose data you wish
to restore and click Restore from Snapshot from the drop-down list.

Figure 143 Restore from Snapshot - Select Snapshot

The Select Snapshot window displays all the read-only Snapshot Sets generated for
the selected Consistency Group.
4. Select a Snapshot Set to be the source of the restore Snapshot, using the following
options from the menu bar:
Type a text string to filter the displayed Snapshot list.
Click the Select All icon
Click the Deselect All icon
Click the Show All icon

to select all displayed Snapshots.


to revoke the Snapshot selection.
to display all defined Snapshots.

Click the Show Only Selected icon


display.

to remove the unselected Snapshot from the

Note: You can only select one Snapshot Set from the list.
5. The original data of the Consistency Group is kept by default. If you want to remove it,
clear the Keep the backup of the Data prior to Restore/Refresh operation option.
6. Click Finish; the Volumes in the Consistency Group are restored while maintaining
their original names. If you kept the backup, a new Snapshot Set is added to the
Snapshot Set list, containing the original data in the Consistency Group Volumes
(before the restore operation) but under new Volume names.

Managing the Consistency Groups

225

Managing Volume Operations

Refreshing a Consistency Group


XtremIO enables you to take a Snapshot of an existing storage object, and later refresh the
Snapshot data to match that of the source objects current state without the need to
explicitly change the mapping and zoning of the host.
The refresh operation replaces an outdated storage object with an updated version
without changing the SCSI face (NAA) of the refreshed object. As a result, the outdated
object is refreshed without the need for remapping or rescanning on the host side.
The following examples are use cases that are supported by Refresh:

Copy of production environment (e.g. DataBase, Data Warehouse, Real-Time


Analytics):
A Snapshot of a Consistency Group with production Volumes is mapped to a different
host. At a certain point in time (or upon demand), the Snapshot is refreshed from the
production CG.
Support for development life-cycle:
Multiple copies are created from the production CG. The copies are serving the
development environment (e.g. post-production, QA, Development). At a certain point
in time (or upon demand), each copy can be refreshed from another copy (e.g.
development copy refreshed from post-production copy, QA copy refreshed from
development copy).

The refresh operation can be applied in the following cases:

Refreshing a Snapshot Set with an updated source Consistency Group

Refreshing a Consistency Group with an updated Snapshot Set

Refreshing a Snapshot Set with another, updated, Snapshot Set

The most prevalent use case is to refresh an outdated Snapshot or Snapshot Set with an
updated source Volume or Consistency Group, respectively. However, you can use the
Refresh procedure to refresh a Volume or Consistency Group with a Snapshot or Snapshot
Set data, if necessary.
Note: Before applying the refresh procedure, unmount the refreshed object. After refresh
is complete, re-mount the refreshed object.
Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).
Note: The source and target Volumes must be of the same size.

226

EMC XtremIO Storage Array User Guide

Managing Volume Operations

To refresh a Consistency Group:


1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Consistency Groups.
3. In the Consistency Group list, right-click the Consistency Group whose data you wish
to refresh and select Refresh from the drop-down list.

Figure 144 Refresh - Select Snapshot

The Select Snapshot window displays all Snapshot Sets of the selected Consistency
Group.
4. Select the Snapshot Set you want to use for refreshing the Consistency Group, using
the following options from the menu bar:
Type a text string to filter the displayed Snapshot list.
Click the Select All icon
Click the Deselect All icon
Click the Show All icon

to select all displayed Snapshots.


to revoke the Snapshot selection.
to display all defined Snapshots.

Click the Show Only Selected icon


display.

to remove the unselected Snapshot from the

Note: You can only select one Snapshot Set from the list.
5. The original data in the Consistency Group (before the refresh) is kept by default. If you
want to remove it, clear the Keep the backup of the Data prior to Restore/Refresh
operation option.

Managing the Consistency Groups

227

Managing Volume Operations

6. To assign and/or create Tags for the created Snapshot Set, refer to Assigning and
Creating Tags as Part of a Create/Refresh Procedure on page 186.
7. To assign and/or create Tags for the created Snapshot(s), refer to Assigning and
Creating Tags as Part of a Create/Refresh Procedure on page 186.
Note: To assign and create Tags outside of the refresh from Snapshot procedure
context, see Managing Tags, Using the GUI on page 184.
8. Click Finish; the data in the Consistency Group is refreshed while retaining the original
Volumes names. If you selected to keep the data backup, a new Snapshot Set is
added to the Snapshot Set list containing the original data (before the refresh
operation) with a new name.

Adding a Volume to a Consistency Group


Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).
To add Volumes to a Consistency Group:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Consistency Groups.
3. Select a Consistency Group and click Add Volumes on the menu bar, or right-click the
Consistency Group and select Add Volumes from the drop-down menu.

Figure 145 Add Volume to Consistency Group - Select Volumes

228

EMC XtremIO Storage Array User Guide

Managing Volume Operations

4. The defined Volumes appear in the Volume list. Select the Volume or Volumes you
wish to add to the Consistency Group, using the following options from the menu bar:
Type a text string to filter the displayed Volume list.
Click the Select All icon
Click the Deselect All icon
Click the Show All icon

to select all displayed Volumes.


to revoke the Volume selection.
to display all defined Volumes.

Click the Show Only Selected icon


display.

to remove the unselected Volumes from the

5. Click OK; the selected Volumes are added to the Consistency Group.
Note: You can also add Volumes to a Consistency Group by selecting Volumes and then
selecting the target Consistency Group. See Adding Volumes to a Consistency Group on
page 206 for details.

Removing a Volume from a Consistency Group


Note: Removing a Volume from a Consistency Group prevents cross-consistency of future
Snapshots.


Removing a Volume from a Consistency Group may cause loss of cross-consistency of
future Snapshots and compromise the ability to restore data from Snapshots taken prior
to the Volume removal.
To remove Volumes from a Consistency Group:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Consistency Groups.
3. In the Consistency Groups list, right-click a Consistency Group and select Remove
Volumes from the drop-down menu.

Figure 146 Remove Volume from Consistency Group - Warning

Managing the Consistency Groups

229

Managing Volume Operations

4. Click Yes to confirm.

Figure 147 Remove Volume from Consistency Group

5. Select the Volume or Volumes that you wish to remove and click Finish; the Volume is
removed from the Consistency Group.
Note: You can also remove Volumes from a Consistency Group by selecting Volumes and
then selecting the target Consistency Group. See Removing Volumes from a Consistency
Group on page 208 for details.

230

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Deleting a Consistency Group


Note: A Consistency Group cannot be deleted if there is a Scheduler defined for it. The
Scheduler must be deleted prior to deleting the Consistency Group.
To delete a Consistency Group:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Consistency Groups.
3. Right-click the Consistency Group you want to delete and select Delete Consistency
Group from the drop-down menu. You can select multiple Consistency Groups, using
the Shift and Ctrl keys.
Note: When you delete a Consistency Group, its Volumes are not deleted.

Figure 148 Delete Consistency Group Notification

4. Confirm the deletion by clicking Yes; the Consistency Group is deleted from the
Consistency Group window.

Managing the Consistency Groups

231

Managing Volume Operations

Viewing the Consistency Groups Related Information


The Consistency Groups Window displays, in addition to the defined Consistency Groups,
additional related information. The following information is available in the pane below
the Consistency Group table:

Volumes

Mapping of Member Volumes

Snapshot Sets

Schedulers

Alerts

To view the Volumes information:

Select a Consistency Group and click the Volumes tab.

Figure 149 Volumes Tab

The Volumes tab displays the following data:


Volume Name
Cluster Name (in multiple cluster settings)
Read-Only indication
Mapped indication
NAA Identifier
Space in Use (VSG)
Volume Size
Logical Block Size
Alignment Offset
Tags

232

EMC XtremIO Storage Array User Guide

Managing Volume Operations

To view the Mapping of Member Volumes information:

Select a Consistency Group and click the Mapping of Member Volumes tab.

Figure 150 Mapping of Member Volumes Tab

The Mapping of Member Volumes tab displays the following data:


Volume Name
Number of mappings created between the Volume and each Initiator Group
To view the Snapshot Sets information:

Select a Consistency Group and click the Snapshot Sets tab.

Figure 151 Snapshot Sets Tab

The Snapshot Sets tab displays the following data:


Snapshot Set Name
Cluster Name (in multiple clusters settings)
Creation Time
Read-Only indication
Mapped indication
Originated From (entity name)
Number of Volumes
Tags

Managing the Consistency Groups

233

Managing Volume Operations

To view the Schedulers information:

Select a Consistency Group and click the Schedulers tab.

Figure 152 Schedulers Tab

The Schedulers tab displays the following data:


Scheduler Name
Cluster Name (in multiple clusters settings)
Snapshot Source Type
Snapshot Type
Interval
Explicit Schedule
Snapshots to Keep - Number
Snapshots to Keep - Time
Last Activation Time
Last Activation State
Scheduler State
Tags

234

EMC XtremIO Storage Array User Guide

Managing Volume Operations

To view the Alerts information:

Select a Consistency Group and click the Alerts tab.

Figure 153 Alerts Tab

The Alerts tab displays the following data:


Severity Level
Cluster Name (in multiple clusters settings)
Alert Code
Date and Time
Entity
Entity Details
Description

Managing Consistency Groups, Using the CLI


Use the following CLI commands for managing Consistency Groups:
Command

Description

add-volume-to-consistencygroup

Adds a Volume to a Consistency Group.

create-consistency-group

Creates a new Consistency Group.

create-snapshot-and-reassi
gn

Creates a Snapshot from a specified Volume/Snapshot,


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

remove-consistency-group

Deletes a Consistency Group.

remove-volume-from-consis
tency-group

Removes a Volume from a Consistency Group.

show-consistency-group

Displays a specified Consistency Groups parameters.

show-consistency-groups

Displays all the defined Consistency Groups parameters.

create-scheduler

Creates a new Snapshot scheduler.

Managing the Consistency Groups

235

Managing Volume Operations

Managing the Snapshot Sets


Managing Snapshot Sets, Using the GUI
Creating a Snapshot of a Snapshot Set
Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).
To create a Snapshot of a Snapshot Set:
1. On the menu bar, click Configuration.
2. In the Storage tab, click Snapshot Sets to display the Snapshot Sets window.
3. Select a Snapshot Set from the table and click Create Snapshot on the menu bar. You
can also right-click the Snapshot Set and select Create Snapshot from the drop-down
menu.

Figure 154 Create Snapshot - Select Snapshot Set

4. In the Create Snapshot dialog box, set the following parameters:


Snapshot Set name (default name - SnapshotSet.<epoch>)
Snapshot Suffix (default suffix - <EPOCH>)
Snapshot Type (writable or read-only)

236

EMC XtremIO Storage Array User Guide

Managing Volume Operations

5. To assign and/or create Tags for the new Snapshot Set, refer to Assigning and
Creating Tags as Part of a Create/Refresh Procedure on page 186.
6. To assign and/or create Tags for the new Snapshot(s), refer to Assigning and Creating
Tags as Part of a Create/Refresh Procedure on page 186.
Note: To assign and create Tags outside of the Snapshot/Snapshot Set creation
context, see Managing Tags, Using the GUI on page 184.
7. Click Finish; a new Snapshot set is added to the Snapshot Set table in the Snapshot
Set window.

Refreshing a Snapshot Set


It is recommended to refresh a Snapshot Set, using a Tag assigned to it, as described
below. When using a Tag to refresh a Snapshot Set, the Tag is removed from the Snapshot
Set that requires refreshing and assigned to the new, refreshed Snapshot Set, thus
enabling you to easily track and locate the updated Snapshot Set in the Snapshot Set list.
You can also refresh the Snapshot Set by specifying the Snapshot Set you wish to refresh,
as described on page 241.
Note: If the Snapshot Set that is being refreshed (specified either by Tag or explicitly) has
scheduler(s) attached to it, the scheduler(s) remain intact on the original Snapshot Set,
and are not be created on the newly created Snapshot Set.
Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).
Note: The source and target Volumes for the refresh operation must be of the same size.

Managing the Snapshot Sets

237

Managing Volume Operations

To refresh a Snapshot Set, using Tags:


1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Snapshot Sets to display the Snapshot Set
window.
3. If you have not created Tag for Snapshot Sets (see Creating Tags on page 184),
right-click Snapshot Sets in the Storage tab (left pane) and select Create Tag from the
drop-down list, to create a new Tag (in the example below, the new Tag is titled
MyTag).

Figure 155 New Snapshot Set Tag

238

EMC XtremIO Storage Array User Guide

Managing Volume Operations

4. If you have not assigned a Tag to the Snapshot Set you wish to refresh (see Assigning
Tags to Storage Elements on page 185), double-click Snapshot Sets in the Storage
tab to view the Snapshot Set Tag list and drag the relevant Snapshot Set from the
Snapshot Set table to the relevant Tag in the Tag list to assign it.

Figure 156 Tag Assigned to a Snapshot Set

Note: Assigning the Tag to more than one Snapshot Set disables the option to refresh
the Snapshot Set via the Tag.
5. In the Storage tab, right-click the Tag assigned to the Snapshot Set you wish to refresh
and select Refresh Snapshot Set from this Tag from the drop-down list.

Figure 157 Refreshing a Snapshot Set via Tag - Select Snapshot

6. In the Select Snapshot area, select whether you wish to refresh from the parent
Consistency Group to a child Snapshot Set or to refresh from another Snapshot Set.
Managing the Snapshot Sets

239

Managing Volume Operations

7. If you selected to refresh from a Snapshot Set, select a Snapshot Set from the table,
using the following options from the menu bar:
Type a text string to filter the displayed Snapshot Set list.
Click the Select All icon
Click the Deselect All icon
Click the Show All icon

to select all displayed Snapshot Sets.


to revoke the Snapshot Set selection.
to display all defined Snapshot Sets.

Click the Show Only Selected icon


from the display.

to remove the unselected Snapshot Sets

Note: You can select only one Snapshot Set from the list.
8. The source of the Snapshot before the refresh operation is kept by default. If you want
to remove it, clear the Keep the backup of the Data prior to Restore/Refresh operation
option.
Note: If the Snapshot Set you wish to refresh has an associated Scheduler and you
selected to remove the backup, the refresh operation will fail and an error message
will appear. To perform the refresh, the Scheduler should be deleted. A new Scheduler
can be created for the newly created (refreshed) Snapshot Set when the refresh
operation is complete. Refer to Deleting a Scheduler on page 275 and Creating a
Scheduler on page 272.
9. To assign and/or create additional Tags for the Snapshot Set, refer to Assigning and
Creating Tags as Part of a Create/Refresh Procedure on page 186.
10. To assign and/or create additional Tags for the Snapshots included in the refreshed
Snapshot Set, refer to Assigning and Creating Tags as Part of a Create/Refresh
Procedure on page 186.
11. Click Finish; a new (refreshed) Snapshot Set is added to the Snapshot Set table and is
tagged by the Tag originally assigned to the outdated Snapshot Set. The new
Snapshots are added to the Volumes table.

240

EMC XtremIO Storage Array User Guide

Managing Volume Operations

To refresh a Snapshot Set, using Snapshot Set:


1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Snapshot Sets to display the Snapshot Set
window.
3. In the Snapshot Set list, right-click the Snapshot Set whose data you wish to refresh
and select Refresh from the drop-down list.

Figure 158 Refresh Snapshot Set

4. Select whether you wish to refresh from the parent Consistency Group to a child
Snapshot Set or to refresh from another Snapshot Set.
5. If you selected to refresh from a Snapshot Set, select a Snapshot Set from the table,
using the following options from the menu bar:
Type a text string to filter the displayed Snapshot Set list.
Click the Select All icon
Click the Deselect All icon
Click the Show All icon

to select all displayed Snapshot Sets.


to revoke the Snapshot Set selection.
to display all defined Snapshot Sets.

Click the Show Only Selected icon


from the display.

to remove the unselected Snapshot Sets

Note: You can select only one Snapshot Set from the list.

Managing the Snapshot Sets

241

Managing Volume Operations

6. The source of the Snapshot before the refresh operation is kept by default. If you want
to remove it, clear the Keep the backup of the Data prior to Restore/Refresh operation
option.
Note: If the Snapshot Set you wish to refresh has an associated Scheduler and you
selected to remove the backup, the refresh operation will fail. To perform the refresh,
the Scheduler should be deleted. A new Scheduler can be created for the newly
created (refreshed) Snapshot Set when the refresh operation is complete. Refer to
Deleting a Scheduler on page 275 and Creating a Scheduler on page 272.
7. To assign and/or create Tags for the created Snapshot Set, refer to Assigning and
Creating Tags as Part of a Create/Refresh Procedure on page 186.
8. To assign and/or create Tags for the created Snapshots included in the Snapshot Set,
refer to Assigning and Creating Tags as Part of a Create/Refresh Procedure on
page 186.
9. Click Finish; a new Snapshot Set is added to the Snapshot Set table, containing the
refreshed data with the original Volumes names. if you kept the backup, a new
Snapshot Set is added to the Snapshot Sets list containing the original data with new
Volume names.

Creating a Snapshot Scheduler for Snapshot Sets


To create a Snapshot Scheduler for Snapshot Sets, refer to Creating a Scheduler on
page 272.

242

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Deleting a Snapshot Set


Note: A Snapshot Set cannot be deleted if there is a Scheduler defined for it. The
Scheduler must be deleted prior to deleting the Snapshot Set.
Note: When you delete a Snapshot Set, the Snapshots contained in the set are deleted. However,
the following entities are not deleted:

Mapped volumes

Snapshots that are members of a Consistency Group

Snapshots that have defined schedulers

To delete a Snapshot Set:


1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Snapshot Sets to display the Snapshot Set
window.
3. Right-click the Snapshot Set you want to delete and select Delete from the drop-down
menu. You can select multiple Snapshot Sets, using the Shift and Ctrl keys.
If the Snapshot Set has a defined Scheduler, it cannot be deleted and the following
warning is displayed.

Figure 159 Delete Snapshot Set - Snapshot Schedulers Exist

Click OK to confirm; the Snapshot Set is not deleted until its Schedulers are
deleted.
If any Snapshots contained in the Snapshot Set are either mapped, members of a
Consistency Group or have defined Schedulers, these Snapshots are not deleted
and the following warning is displayed.

Figure 160 Delete Snapshot Set - Some Snapshots Cannot be Deleted

Click Yes if you want to delete the Snapshot Set and the contained Snapshots that
can be deleted.

Managing the Snapshot Sets

243

Managing Volume Operations

If the Snapshot Set and it contained Snapshots can be deleted, the following
warning is displayed.

Figure 161 Delete Snapshot Set Confirmation

Click Yes to confirm; the Snapshot Set and its contained Snapshots are deleted.

244

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Viewing the Snapshot Sets Related Information


The Snapshot Sets Window displays, in addition to the defined Snapshot Sets, additional
related information. The following information is available in the pane below the Snapshot
Sets table:

Volumes

Mapping of Member Volumes

Consistency Groups Sets

Schedulers

Alerts

To view the Volumes information:

Select a Consistency Group and click the Volumes tab.

Figure 162 Volumes Tab

The Volumes tab displays the following data:


Volume Name
Cluster Name (in multiple cluster settings)
Read-Only indication
Mapped indication
NAA Identifier
Space in Use (VSG)
Volume Size
Logical Block Size
Alignment Offset
Tags

Managing the Snapshot Sets

245

Managing Volume Operations

To view the Mapping of Member Volumes information:

Select a Consistency Group and click the Mapping of Member Volumes tab.

Figure 163 Mapping of Member Volumes Tab

The Mapping of Member Volumes tab displays the following data:


Volume Name
Number of mappings created between the Volume and each Initiator Group
To view the Consistency Groups Sets information:

Select a Consistency Group and click the Consistency Groups tab.

Figure 164 Consistency Groups Tab

The Consistency Groups tab displays the following data:


Consistency Group Set Name
Cluster Name (in multiple cluster settings)
Read-Only indication
Mapped indication
Number of Volumes
Number of Snapshot Sets
Tags

246

EMC XtremIO Storage Array User Guide

Managing Volume Operations

To view the Schedulers information:

Select a Consistency Group and click the Schedulers tab.

Figure 165 Schedulers Tab

The Schedulers tab displays the following data:


Scheduler Name
Cluster Name (in multiple cluster settings)
Snapshot Source Type
Snapshot Type
Interval
Explicit Schedule
Snapshots to Keep - Number
Snapshots to Keep - Time
Last Activation Time
Last Activation State
Scheduler State
Tags

Managing the Snapshot Sets

247

Managing Volume Operations

To view the Alerts information:

Select a Consistency Group and click the Alerts tab.

Figure 166 Alerts Tab

The Alerts tab displays the following data:


Severity Level
Cluster Name (in multiple cluster settings)
Alert Code
Date and Time
Entity
Entity Details
Description

Managing Snapshot Sets, Using the CLI


Use the following CLI commands for managing Snapshot Sets:

248

Command

Description

create-snapshot

Creates a Snapshot from a specified Volume.

create-snapshot-and-reassi
gn

Creates a Snapshot from a specified Volume/Snapshot,


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

show-snapshot-sets

Displays a list of Snapshot Sets and their data.

show-snapshot-set

displays the parameters of a specified Snapshot Set.

remove-snapshot-set

Removes a Snapshot Set

create-scheduler

Creates a new Snapshot scheduler.

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Managing the Initiator Groups


The XtremIO Storage Array uses the term "Initiators" to refer to ports that can access a
Volume.
Initiators can be managed by the XtremIO Storage Array by assigning them to an Initiator
Group. To do this, edit an Initiator Group in the GUI and add the Initiator's properties, or
run the relevant CLI command (refer to Managing Initiator Groups, Using the CLI on
page 259).
The Initiators within an Initiator Group share access to one or more of the cluster's
Volumes. You can define which Initiator Groups have access to which Volumes, using LUN
mapping (refer to Managing Mapping on page 263).
This section explains how to manage Initiator Groups.

Managing Initiator Groups, Using the GUI


Viewing Initiator Groups
To view Initiator Groups:
1.

On the menu bar, click Configuration.

2. If you wish to view all the defined Initiator Groups, click Initiator Groups to open the
Initiator Groups window. To view only Initiator Groups tagged by a specific Tag,
double-click Initiator Groups to open the Initiator Group Tags list and select a Tag from
the list.

Figure 167 Initiator Groups Table

Managing the Initiator Groups

249

Managing Volume Operations

Creating Initiator Groups


Note: Initiators are added to the cluster by defining them in an Initiator Group. You can
define Initiators when adding a group or later by using the Edit Initiator Group option. To
remove an Initiator, edit the group and delete the Initiator's properties.
Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).
To create an Initiator Group:
1. On the menu bar, click Configuration.
2. In the Storage tab, click Initiator Groups to display the Initiator Groups table.
3. On the Initiator Groups window menu bar, click Create Initiator Group. You can also
right-click Initiator Groups in the Storage tab and select Create Initiator Group from the
drop-down menu.

Figure 168 Create Initiator Group

4. In the Create Initiator Group dialog box, type a name for the group.

250

EMC XtremIO Storage Array User Guide

Managing Volume Operations

5. Click Add to add Initiators to the new Initiator Group; the Add Initiator Dialog box
appears.

Figure 169 Add Initiator Dialog Box

6. In the Add Initiator dialog box, define the following:


Initiator Name - Enter a name for the Initiator. The name identifies the Initiator in
the GUI or CLI lists.
Operating System - Select from the drop-down list.
Note: Setting the Initiators Operating System is required for optimal
interoperability and stability of the host with XtremIO storage. You can adjust the
setting while the host is online and connected to the XtremIO cluster with no I/O
impact.
Initiator Port Address - Add an Initiator's port address (i.e. the SCSI identification
of the Initiator port). The port address depends on the port type, as follows:
iSCSI ports - addresses are in IQN or EUI format, e.g. eui.02004567A425678D,
iqn.1991-05.com.microsoft:win-1htai3q0tmg
Fibre Channel ports - addresses using upper or lower case hexadecimal digit
are valid, using the following formats:
* XX:XX:XX:XX:XX:XX:XX:XX
* XXXXXXXXXXXXXXXX
* 0xXXXXXXXXXXXXXXXX
Note: To see unused port addresses, click the Initiator Port Address drop-down
arrow in the Add Initiator dialog box. If the Initiator was not previously discovered,
the drop-down list is empty and you need to type the Initiator port address.

Managing the Initiator Groups

251

Managing Volume Operations

7. To assign and/or create Tags for the new Initiator Group, refer to Assigning and
Creating Tags as Part of a Create/Refresh Procedure on page 186.
Note: To assign and create Tags outside of the Initiator Group creation context, see
Managing Tags, Using the GUI on page 184.
8. Click Finish; the new Initiator Group is added to the Initiator Groups table.

Editing Initiator Groups


To edit an Initiator Group:
1. On the menu bar, click Configuration.
2. In the Storage tab, click Initiator Groups to display the Initiator Groups window.
3. Right-click the group you want to edit and select Modify Initiator Group from the
drop-down menu.

Figure 170 Modify Initiator Group

4. If you wish to modify the Initiator Groups name, type the new name in the Initiator
Group Name field.
5. If you wish to delete an Initiator from the Initiator Group, select the Initiator and click
Remove.

252

EMC XtremIO Storage Array User Guide

Managing Volume Operations

6. If you wish to modify the properties of an Initiator within the group, select the Initiator
by clicking it and click Modify.

Figure 171 Modify Initiator - Fibre Channel

Figure 172 Modify Initiator - iSCSI

Note: The displayed dialog box is different for Fibre Channel and iSCSI Initiators.

Managing the Initiator Groups

253

Managing Volume Operations

7. In the Modify Initiator dialog box for Fibre Channel Initiators, modify the following as
needed:
Initiator Name
Operating System - Select one of the following options from the drop-down list:
Linux, Windows, ESX, Solaris, AIX, HP-UX, other
Note: Setting the Initiators Operating System is required for optimal
interoperability and stability of the host with XtremIO storage. You can adjust the
setting while the host is online and connected to the XtremIO cluster with no I/O
impact.
Initiator Port Address (see To create an Initiator Group: on page 250)
Note: To use unused port addresses, click the drop-down arrow in the Initiator Port
Address column.
In the Modify Initiator dialog box for iSCSI Initiators, modify the following as needed:
Initiator Name
Operating System - Select one of the following options from the drop-down list:
Linux, Windows, ESX, Solaris, AIX, HP-UX, other
Note: Setting the Initiators Operating System is required for optimal
interoperability and stability of the host with XtremIO storage. You can adjust the
setting while the host is online and connected to the XtremIO cluster with no I/O
impact.
Initiator Port Address - the SCSI identification of the Initiator port (see To create an
Initiator Group: on page 250)
Note: To use unused port addresses, click the drop-down arrow in the Initiator Port
Address column.

254

EMC XtremIO Storage Array User Guide

Managing Volume Operations

CHAP Discovery (Initiator):


Name
Password
CHAP Authentication (Initiator):
Name
Password
CHAP Discovery (Cluster):
Name
Password
CHAP Authentication (Cluster):
Name
Password
8. Click OK; the updated Initiator appears in the Initiator Group dialog box.
9. When you have completed modifying the Initiators, click OK; the updated Initiator
Group appears in the Initiator Groups table.

Renaming Initiator Groups


To rename an Initiator Group:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Initiator Groups to display the Initiator Group
window.
3. Right-click the relevant Initiator Group in the Initiator Groups table and select Rename
from the drop-down menu.

Figure 173 Rename Initiator Group Dialog Box

4. In the Rename dialog box, enter the name for the Initiator Group.
5. Click OK.

Managing the Initiator Groups

255

Managing Volume Operations

Deleting Initiator Groups


To delete an Initiator Group:
1. On the menu bar, click Configuration.
2. In the Storage tab, click Initiator Groups to display the Initiator Groups table.
3. Right-click the group you want to remove and select Delete from the drop-down menu.
4. Confirm the deletion by clicking OK.
Note: If you are deleting an Initiator Group that is mapped to Volumes, deleting the
group disconnects it from the mapped Volumes.

Creating and Modifying Mapping


Refer to Managing Mapping on page 263.

Viewing the Initiator Group Related Information


The Initiator Group Window displays, in addition to the defined Initiator Groups,
additional related information. The following information is available in the pane below
the Initiator Groups table:

Mapping

Initiators

Targets

Alerts

To view the mapping information:

Select an Initiator Group and click the Mapping tab.

Figure 174 Mapping Tab

The Mapping tab displays the following data:


Volume - the Volumes mapped to the selected Initiator Group
LUN - the Logical Unit Number assigned for each connection

256

EMC XtremIO Storage Array User Guide

Managing Volume Operations

To view the Initiators information:

Select an Initiator Group and click the Initiators tab.

Figure 175 Initiators Tab

The Initiator tab displays the following data:


Initiator Name
Cluster (in a multiple cluster setting)
Initiator Group
Operating System
Port Type
Port Address
Number of Connected Targets
Tags
To view the Targets information:

Select an Initiator Group and click the Targets tab.

Figure 176 iSCSI Targets Tab

The Targets tab displays the following data:


Initiator Group to Target Connections
Total Initiators
Total Connections - the number of connected Targets
A graphic portrayal of the Targets with indication for connection

Managing the Initiator Groups

257

Managing Volume Operations

To view the Alerts information:

Select an Initiator group and click the Alerts tab.

Figure 177 Alerts Tab

The Alerts tab displays the following data:


Severity
Cluster
Code
Date and Time
Entity
Entity Details
Description

258

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Managing Initiator Groups, Using the CLI


Use the following CLI commands for managing Initiator Groups:
Command

Description

add-initiator

Adds an Initiator and associates it with an existing Initiator Group.

add-initiator-group

Adds an Initiator Group and its associated Initiators to the XtreamIO


cluster.

modify-initiator

Modifies the properties of an existing Initiator.

remove-initiator

Deletes an Initiator.

remove-initiator-group

Deletes an Initiator Group.

show-initiators

Displays Initiators data.

show-initiator-group

Displays information for a specific Initiator Group.

show-initiator-groups

Displays information for a all Initiator Groups.

show-targets

Displays the cluster Targets interfaces (iSCSI or FC ports).

show-target-groups

Displays a list of Target Groups.

show-discovered-initiatorsconnectivity

Displays the Initiators-Targets connectivity map.

show-initiators-connectivity

Displays Initiators-Port connectivity and the number of connected


Targets.

map-lun

Maps a Volume to an Initiator Group and assigns a Logical Unit


Number (LUN) to it.

Managing the Initiator Groups

259

Managing Volume Operations

Managing Initiators
Managing Initiators, Using the GUI
Creating an Initiator
Refer to Creating Initiator Groups on page 250.

Editing an Initiator
Refer to Editing Initiator Groups on page 252.

Removing an Initiator
Refer to Editing Initiator Groups on page 252.

Renaming an Initiator
To rename an Initiator:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Initiators to display the Initiators window.
3. Right-click the relevant Initiator in the Initiators table and select Rename from the
drop-down menu.

Figure 178 Rename Initiator Dialog Box

4. In the Rename dialog box, edit the name for the Initiator.
5. Click OK.

Configuring CHAP
iSCSI Initiators and Targets prove their identity to each other, using the
Challenge-Handshake Authentication Protocol (CHAP), which includes a mechanism to
prevent clear text passwords from appearing on the wire.
You can configure CHAP for Initiator login and for the discovery phase. You can also
configure Mutual CHAP for the Initiator to authenticate the XtremIO Targets.
Note: The following procedure refers only to iSCSI Initiators.
To configure an Initiators CHAP credentials:
1. On the menu bar, click Configuration.
2. In the Storage tab, click Initiators to display the Initiators window.

260

EMC XtremIO Storage Array User Guide

Managing Volume Operations

3. Right-click the Initiator you want to edit and select Configure CHAP from the
drop-down menu.

Figure 179 CHAP Configuration - iSCSI Initiators

4. In the CHAP Configuration dialog box, configure the following parameters:


Operating System - select one of the following options from the drop-down list:
Linux, Windows, ESX, Solaris, AIX, HP-UX, other
CHAP Discovery (Initiator):
Name
Password
CHAP Authentication (Initiator):
Name
Password
CHAP Discovery (Cluster):
Name
Password
CHAP Authentication (Cluster):
Name
Password
5. Click OK.

Managing Initiators

261

Managing Volume Operations

Managing Initiators, Using the CLI


Use the following CLI commands for managing Initiators:

262

Command

Description

add-initiator

Adds an Initiator and associates it with an existing


Initiator Group.

modify-initiator

Modifies the properties of an existing Initiator.

remove-initiator

Deletes an Initiator.

show-initiators

Displays Initiators data.

rename

Renames a component of the XtremIO Storage Array.

show-chap

Displays the clusters configured CHAP authentication


and discovery modes.

modify-chap

Modifies Chap configuration parameters.

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Managing Mapping
To allow Initiators within an Initiator Group to access a Volume's disk space, you can map
the Volume to the Initiator Group.
When mapping a Volume to an Initiator Group, a Logical Unit Number (LUN) is
automatically assigned.
You can map an Initiator Group to multiple Volumes. The Initiator Group's first mapping
receives a LUN of 1. Additional mappings receive LUNs in sequential order. These
numbers can be changed later to any desired LUN.
Note: The mapping procedure can be performed only with a single cluster view. If you are
managing a multiple cluster environment, make sure to select the relevant cluster before
starting the procedure (see Selecting a Cluster on page 121).

Basic Mapping Scenario


Mapping can be performed from either the Volumes or the Initiator Groups workspace.
To map Volumes to Initiator Groups:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Volumes to display the Volumes window.
3. From the Volume list, click to select the Volume you wish to map. You can select
multiple Volumes, using the Ctrl and Shift keys.

Managing Mapping

263

Managing Volume Operations

4. In the menu bar, click Create/Modify Mapping. You can also right-click a selected
Volume and select Create/Modify Mapping from the drop-down menu.

Figure 180 Create Mapping - Select Initiator Group

5. From the Initiator Groups pane in the Create Mapping dialog box, select the Initiator
Groups you wish to map to the selected Volumes. Use the following options from the
menu bar:
Type a text string to filter the displayed Initiator Group list.
Click the Select All icon
Click the Deselect All icon
Click the Show All

to select all displayed Initiator Groups.


to revoke the Initiator Group selection.

to display all defined Initiator Groups.

Click the Show Only Selected icon


from the display.

to remove the unselected Initiator Groups

Use the Select Currently Mapped Initiator Groups button to select the Initiator Groups
that are already mapped to the Volumes you selected for mapping.

264

EMC XtremIO Storage Array User Guide

Managing Volume Operations

6. Click Next.

Figure 181 Create Mapping - Select LUNs

7. In the Select LUNs dialog box, you can change the LUN number assigned to the
configured mapping. If you set an invalid LUN number, it appears in red.
8. Click Finish; the specified Volumes and Initiator Groups are mapped. A check sign is
added for each of the mapped Volumes in the Mapped column of the Volumes
window. For each Initiator Group, the number of mapped Volumes is indicated in the
Initiator Groups table.

Managing Mapping

265

Managing Volume Operations

To map Initiator Groups to Volumes:


1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Initiator Groups to display the Initiator Groups
window.
3. From the Initiator Groups list, click to select the Initiator Group you wish to map. You
can select multiple Initiator Groups, using the Ctrl and Shift keys.
4. On the menu bar, click Create/Modify Mapping. You can also right-click a selected
Initiator Group and select Create/Modify Mapping from the drop-down menu.

Figure 182 Create Mapping - Select Volumes

5. From the Volumes table in the Create Mapping dialog box, select the Volumes you
wish to map to the selected Initiator Group. Use the following options from the menu
bar:
Type a text string to filter the displayed Volumes list.
Click the Select All icon
Click the Deselect All icon
Click the Show All

to select all displayed Volumes.


to revoke the Volumes selection.

to display all defined Volumes.

Click the Show Only Selected icon


display.

to remove the unselected Volumes from the

6. If you want to select Volumes that are already mapped to the Initiator Group you
selected for mapping, click Select Currently Mapped Volumes.

266

EMC XtremIO Storage Array User Guide

Managing Volume Operations

7. Click Next.

Figure 183 Create Mapping - Select LUNs

8. In the Select LUNs dialog box, you can change the LUN number assigned to the
configured mapping. If you set an invalid LUN number, it appears in red.
9. Click Finish; the specified Initiator Groups and Volumes are mapped. A check sign is
added for each of the mapped Volumes in the Mapped column of the Volumes
window. For each Initiator Group, the number of mapped Volumes is indicated in the
Initiator Groups table.

Using Tags for Mapping


Tags are not required to perform Volume mapping. However, using Tags can significantly
simplify mapping of Volumes or Initiator Groups that represent a logical set.
Since Tags are used to represent logical grouping of objects based on a common
characteristic or affiliation, it is possible to use Tags to simplify the object selection.
Rather than selecting individual Volumes or Initiator Groups, you can simply select one or
more Tags to perform mapping of the Volumes and Initiator Groups associated with these
Tags.
To map Volumes to Initiator Groups, using Tags:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), double-click the object type you wish to use for mapping
(e.g. Volumes, Consistency Groups, etc.); the Tag list for that object is displayed below
the objects name.

Managing Mapping

267

Managing Volume Operations

3. In the Storage tab, double-click Initiator Groups; the Tag list for Initiator Groups is
displayed.
4. Select a Tag from each list (using the Ctrl key).
5. Right-click one of the Tags and select Create/Modify Mapping.

Figure 184 Mapping Wizard

The Mapping Wizard skips the Volume and Initiator Group selection steps (these steps
are made redundant by using Tags) and displays the assigned LUNs.
6. Edit the assigned LUNs, if necessary.
7. Click Finish to apply the new mapping details.

268

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Using the Mapping Wizard


The mapping wizard is a powerful tool that enables you to locate the relevant objects and
perform mapping of multiple objects in a few simple steps.

Wizard access - There are various ways to open the mapping wizard, according to the
required mapping:
To map all Volumes associated with a Tag, right-click the Tag (nested under
Volumes in the Storage tab) and select Create/Modify Mapping.
To map all Initiator Groups associated with a Tag, right-click the Tag (nested under
Initiator Groups in the Storage tab) and select Create/Modify Mapping.
To map all Volumes in a Consistency Group, right-click the Consistency Group and
select Create/Modify Mapping.
To map all Volumes in a Snapshot Set, right-click the Snapshot Set and select
Create/Modify Mapping.

Figure 185 Mapping Wizard - Volumes

Managing Mapping

269

Managing Volume Operations

Filtering - You can use the mapping wizards filter to select the items you wish to map
by typing a full or partial string in the filter field. You can filter the displayed items by
any of the displayed fields, e.g. Tag name, NAA identifier, Volume name, size, etc.
The summary line below the table indicates the resulting number of items (out of the
total available) and the filtering agent used.

Selecting LUNs - In the Select LUNs window, you can edit the displayed LUN numbers.
If a LUN number already exists in the cluster configuration, the number is displayed
with white (regular) background. If a LUN number is different than the existing cluster
configuration, it is displayed with a blue background. Invalid LUNs are displayed with
a red background.

Figure 186 Mapping Wizard - LUNs

You can clear the LUN mapping table and refill it with existing LUN mappings, using the
Unmap All and Map All buttons, respectively. The assigned LUN numbers are applied
only when you click Finish.

270

EMC XtremIO Storage Array User Guide

Managing Volume Operations

The mapping table also displays mapping of a Volume across multiple Initiator
Groups.

Figure 187 Mapping Wizard - Multiple LUNs

Managing Mapping

271

Managing Volume Operations

Managing the Schedulers


Managing the Schedulers, Using the GUI
Creating a Scheduler
You can create a Scheduler for snapshotting a Volume/Snapshot, Consistency Group or a
Snapshot Set.
Note: This procedure can be performed only with a single cluster view. If you are managing
a multiple cluster environment, make sure to select the relevant cluster before starting the
procedure (see Selecting a Cluster on page 121).
To create a Snapshot Scheduler:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click the storage object for which you want to create a
Scheduler to display the objects window.
3. In the main window, select an object (Volume, Consistency Group or Snapshot Set)
from the list and click Create Scheduler on the menu bar. You can also right-click the
selected object and select Create Scheduler from the drop-down list.

Figure 188 Create Snapshot Scheduler - Definition

4. In the Scheduler Definition dialog box, type in a unique name for the Scheduler.
5. The Scheduler is enabled by default. If you want to disable it, select Disable from the
Scheduler State drop-down list.
6. In the Schedule section, select whether you wish Snapshots to be created at a fixed
interval or at an explicit time.

272

EMC XtremIO Storage Array User Guide

Managing Volume Operations

7. If you selected the Fixed Interval option, set the time interval by selecting one of the
following options:
15 seconds
30 seconds
Minutes (set the number)
Hours (set the number)
8. If you selected the Explicit Time option, set the time and select a day.
9. Set the Retention Policy:
Set the number of the latest Snapshots that will be retained. Using this policy, the
specified number of snapshots will be retained. The age limit is calculated
accordingly and shown as additional information.
Set the age limit in days beyond which a Snapshot is deleted. The number of the
retained snapshots is calculated according to the specified age limit, and shown
as additional information.
10. In the Snapshot section, set the Snapshot Suffix and select the Snapshot Type
(writable or read-only).
11. To assign and/or create Tags for the new Scheduler, refer to Assigning and Creating
Tags as Part of a Create/Refresh Procedure on page 186.
Note: To assign and create Tags not as part of the Scheduler creation context, refer to
Managing Tags, Using the GUI on page 184.
12. Click Finish; the new Scheduler is added to the list in the Schedulers window and the
new Snapshot Set that will contain all created snapshots is added to the Snapshot Set
list in the Snapshot Sets window.

Managing the Schedulers

273

Managing Volume Operations

Modifying a Scheduler
To modify a Scheduler:
1. In the menu bar, click Configuration.
2. In the Storage tab (left pane), click Schedulers to display the Schedulers window.
3. Right-click the relevant Scheduler in the Schedulers table and select Modify Snapshot
Scheduler from the drop-down menu.

Figure 189 Modify Snapshot Scheduler

4. In the Modify Snapshot Scheduler dialog box, modify the necessary parameters out of
the following:
Scheduler name
Scheduler state
Schedule parameters
Retention policy
Snapshot parameters
5. Click OK; the Schedulers parameters are updated.

274

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Renaming a Scheduler
To rename a Scheduler:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Schedulers to display the Schedulers window.
3. Right-click the relevant Scheduler in the Schedulers table and select Rename from the
drop-down menu.

Figure 190 Rename Scheduler Dialog Box

4. In the Rename dialog box, edit the name for the Scheduler.
5. Click OK.

Deleting a Scheduler
To delete a Scheduler:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Schedulers to display the Schedulers window.
3. Right-click the relevant Scheduler in the Schedulers table and select Delete from the
drop-down menu.

Figure 191 Delete Scheduler Warning Message

4. If you want to delete the Snapshot Sets created by the Scheduler, select this option.
5. Click Yes to confirm; the Scheduler is removed from the Schedulers list.

Managing the Schedulers

275

Managing Volume Operations

Suspending a Scheduler
Note: While a Scheduler is suspended, new Snapshots are not created. However, the
retention policy is still applied, i.e. Snapshots are deleted according to the specified
retention parameters.
To suspend a Scheduler:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Schedulers to display the Schedulers window.
3. Right-click the relevant Scheduler in the Schedulers table and select Suspend
Scheduler from the drop-down menu.
4. Click Yes to confirm; the Scheduler is suspended and the Scheduler State parameter in
the Schedulers table is changed to Disabled.

Resuming a Suspended Scheduler


Note: When a Scheduler is resumed, Snapshots are created according to the specified
schedule, and deleted according to the specified retention policy.
To resume a Suspended Scheduler:
1. On the menu bar, click Configuration.
2. In the Storage tab (left pane), click Schedulers.
3. Right-click the relevant suspended Scheduler in the Schedulers table and select
Resume Scheduler from the drop-down menu.
4. Click Yes to confirm; the Scheduler is reactivated and the Scheduler State parameter in
the Schedulers table is changed to Enabled.

276

EMC XtremIO Storage Array User Guide

Managing Volume Operations

Managing Schedulers, Using the CLI


Scheduler Type and Time Parameters
When you define or modify a scheduler, it is required to specify (among other parameters)
the scheduler-type parameter and the time parameter that derives from it.
Schedulers type can be either explicit or interval.

Interval scheduler - the time parameter specifies the time intervals at which snapshot
are taken, and is specified in the format of h:m:s (hours : minutes : seconds).
The valid values for the time parameter are as follows:
Hours: 0 - 72
Minutes: 0 - 59
Seconds: 0, 15, 30
At least one of the time parameter variants must have a value other than zero.
If Hours or Minutes values are other than zero, Seconds value must be zero (i.e.
snapshots are created every x hours and y minutes).
If Seconds are specified (i.e. 15 or 30), Hours and Minutes values must be zero (i.e.
snapshots are created every 15 or 30 seconds).
Example of the time parameter usage for an interval scheduler:
create-scheduler scheduler-type=interval time=[1:30:0] ...
The scheduler created in the example creates a snapshot every hour and a half.

Explicit scheduler - the time parameter specifies the specific day and time at which the
snapshots are taken, and is specified in the format of d:h:m [day of the week : hour :
minute].
The valid values for the time parameter are as follows:
Day of the week: 0 stands for every day; 1- 7 stands for Sunday to Saturday,
respectively
Hour: 0 - 23
Minute: 0 - 59
Example of the time parameter usage for an explicit scheduler:
create-scheduler scheduler-type=explicit time=[1:12:30] ...
The scheduler created in the example creates a snapshot every Sunday at 12:30.

Managing the Schedulers

277

Managing Volume Operations

Scheduler Related CLI Commands


Use the following CLI commands for managing Schedulers:

278

Command

Description

create-scheduler

Creates a new Snapshot Scheduler.

modify-scheduler

Modifies a Snapshot Schedulers parameters.

remove-scheduler

Removes a Snapshot Scheduler.

show-scheduler

Displays the parameters of the specified Scheduler.

show-schedulers

Displays the defined Schedulers parameters.

suspend-scheduler

Suspends the activity of an active Scheduler.

resume-scheduler

Resumes the activity of a suspended Scheduler.

EMC XtremIO Storage Array User Guide

CHAPTER 7
Managing Alerts and Events
This chapter includes the following topics:

Overview............................................................................................................... 280
Managing the Alerts .............................................................................................. 280
Managing the Events............................................................................................. 285

Managing Alerts and Events

279

Managing Alerts and Events

Overview
The XtremIO Storage Array provides pre-defined sets of alerts and events for the cluster
and XMS (including those for sub-components of a cluster).
An event can be triggered as a result of the following conditions:
A state change

An auditable action

A user-triggered activity

Software or hardware condition changes (such as in and out of error states)

If a condition requires user attention and/or intervention, an alert is triggered.


Note: There may be events with no alerts defined for them.
The alert contains information regarding the nature of the reported issue, its severity, system impact and recommended repair flow.
The alert is cleared once the condition requiring attention and/or intervention no longer
exists.

Managing the Alerts


You can use the alert system to view active alerts, edit alerts properties, and display and
acknowledge alerts.

Managing Alerts, Using the GUI


You can use the alert system to view active alerts, edit alerts properties, and display and
acknowledge alerts.
You can view the alerts in:

280

The Alerts pane of the Dashboard workspace, as described in Alerts Pane on


page 49
The Alerts tab of the Alerts & Events workspace, as described in Alerts Tab on
page 99

EMC XtremIO Storage Array User Guide

Managing Alerts and Events

Displaying Alerts Definitions


To display alerts definitions:
1. On the menu bar, click the Alerts & Events icon to display the Alerts & Events
workspace, as shown in Figure 73 on page 98.
2. On the Alerts tab, click the Display Alert Definitions icon (see Figure 74 on page 99);
the Alert Definition dialog box appears.

Figure 192 Alert Definition Dialog box

For each alert, the following information is displayed:


Alert name
Alert code
Entity
Severity level
Activity mode
Clear mode
You can edit an alerts definition by selecting it and clicking Edit, or by double-clicking the
alert to open the Edit Alert Definition dialog box.
To close the Alert Definitions dialog box, click Close.

Managing the Alerts

281

Managing Alerts and Events

Editing Alert Definition


To edit an alerts Definition:
1. On the Alerts tab, click the Display Alert Definitions icon (see Figure 74 on page 99);
the Alert Definition dialog box appears.
2. Double-click an alert or click an alert to select it and click Modify; the Modify Alert
Definition dialog box appears.

Figure 193 Modify Alert Definition Dialog Box

Note: You can also open the Modify Alert Definition dialog box by right-clicking an
alert in the Alerts tab and selecting Modify Alert Definition from the drop-down menu.
3. Modify the following characteristics:
Activity Mode - Determines whether the alert is enabled or disabled.
Clear Mode - Determines whether the alert is cleared automatically when the
condition it refers to is resolved, or requires acknowledgment.
Severity - Determines the severity level of the alert (displayed both textually and by
color).
4. Click OK.

282

EMC XtremIO Storage Array User Guide

Managing Alerts and Events

Viewing the Alert Properties


To view an alerts properties:
1. Double-click an alert in the Alerts tab or right-click an alert to select it and select
Properties from the drop-down menu; the Alert Properties dialog box appears.

Figure 194 Alert Properties Dialog Box

The Alert Properties dialog box displays the following:


Alerts name
Alerts severity level
Alerts code
Alerts time stamp, indicating when it was first recognized by the XMS
Name of the entity to which the alert refers
The entitys details
Alerts description
System Impact - the possible impact of the active alert on the cluster
Repair Flow - the required repair action to be performed on the cluster
You can acknowledge the alert or modify its definition in the Alert Properties dialog
box.
2. Click OK to close the dialog box.

Managing the Alerts

283

Managing Alerts and Events

Acknowledging an Alert
When you acknowledge an alert, it is removed from the Alert panel of the dashboard.
However, acknowledged alerts remain on the Alert List and the word Acknowledged is
added in parentheses to the Severity column.
Alerts that have the Clear Mode field set as Acknowledge Required, remain on the Alert
list even after the alert issue is resolved, and can be removed from the Alert list only after
they are acknowledged (the alert may be acknowledged before the issue is resolved).
To acknowledge an alert:

Right-click the alert and select acknowledge alert.

Note: You can remove the acknowledged alerts from the displayed alerts list by clicking
the Hide Acknowledged Alerts check box in the Alerts tab of the Alerts & Events
workspace.

Managing Alerts, Using the CLI


Setting Thresholds
Using the CLI it is possible to set thresholds for user capacity and receive alerts when the
set threshold is exceeded. You can set the threshold for the following alerts:

user_physical_capacity_high

user_physical_capacity_very_high

The alerts default parameters are:

State - disabled

Severity - minor

Threshold user_physical_capacity_high - 70%


user_physical_capacity_very_high - 80%

To view the alerts settings, run the show-alert-definitions CLI command.


To modify the alerts settings run the modify-alert-definitions CLI command.

Managing Alerts
Use the following CLI commands for managing alerts:

284

Command

Description

acknowledge-alert

Acknowledges an alert and removes it from the dashboard Active


Alerts list. The alert remains in the Alert List window. Alerts with
Clear Mode set to Acknowledge Required, remain on the Alert List
until they are acknowledged.

modify-alert-definition

Modifies the alert definition properties for a specified alert type.

show-alert-definitions

Displays a list of pre-defined alerts and their definitions.

EMC XtremIO Storage Array User Guide

Managing Alerts and Events

Managing the Events


Managing Events, Using the GUI
Viewing Events Properties
To view events properties:
1. On the menu bar, click the Alerts & Events icon to display the Alerts & Events
workspace, as shown in Figure 73 on page 98.
2. Select the Events tab, as shown in Figure 76 on page 102.
3. Double-click an event to open the Event Properties dialog box.

Figure 195 Event Properties Dialog Box

The Event Properties dialog box displays the following:


Events ID
Events severity level
Events code
Related alert code
Events time stamp indicating when it was first recognized by the XMS
Events category
Name of the entity to which the event refers
Entitys details
Events description
4. Browse through the events list, using the Up and Down buttons.
5. Click OK to close the dialog box.

Managing the Events

285

Managing Alerts and Events

Filtering Events
You can filter events, using the filters in the Events tab of the Alerts & Events workspace.

Figure 196 Event Filters

The filters include:

Severity level - Select one or more of the following levels:


Critical
Major
Minor
Information

Event Code - Type an event code or a part of an event code to view only the matching
events.
Date and Time - Set a date and time frame by selecting From Date/Time, To Date/Time,
or both, and setting the date and time data.
Category - Select one or more of the following categories:
Software
Audit Log
Security
Life Cycle
Inventory
Activity
State Change

Entity - Select the entity and entity details from the respective drop-down lists.

Search - Type a search string to search for matching events.

To clear event filters settings, click Restore to Default.

286

EMC XtremIO Storage Array User Guide

Managing Alerts and Events

Managing Event Handlers


Event handlers allow you to perform various actions for events with different properties.
You can add, edit and remove event handlers according to your needs.
To display the Event Handlers dialog box:
1. On the menu bar, click the Alerts & Events icon to display the Alerts & Events
workspace, as shown in Figure 73 on page 98.
2. On the Events tab, click the Display Event Handlers icon (located in the top-right
corner of the window); the Event Handlers dialog box appears.

Figure 197 Event Handlers Dialog Box

For each event handler, the following information is displayed:


Actions - the actions that are performed following the event
Category - the events category
Severity - the events severity level
Entity - the entity type to which the event refers
Entity Details - the specific entity to which the event refers

Managing the Events

287

Managing Alerts and Events

To add an event handler:


1. In the Event Handlers dialog box, click Add; the Add Event Handler dialog box
appears.

Figure 198 Add Event Handler Dialog Box

2. Set the event properties for which to perform the action (for detailed categories
values, refer to Filtering Events):
a. Click the Category drop-down list to expand it and select an event category (default
is All).
b. Click the Severity drop-down list to expand it and select a severity level (default is
All).
Note: When setting a severity level, only events with the selected severity level are
addressed. This does not affect events with other (higher or lower) severity levels.
c. Click the Entity drop-down list to expand it and select an entity type (default is All).
d. If you selected an entity (other than All), click the Entity Details drop-down list to
select the entity details.
3. Select the actions to be performed following the events you defined. You need to
select at least one of the following actions:
Send e-mail
Send SNMP Trap
Write to Log File - this option is automatically performed and therefore grayed out.
Send to Syslog
4. Click OK; the new event handler is added to the Event Handler table.

288

EMC XtremIO Storage Array User Guide

Managing Alerts and Events

To edit an event handler properties:


1. In the Event Handlers dialog box, select an event handler by clicking its entry in the
table.
2. Click Modify; the Modify Event Handler dialog box appears.

Figure 199 Modify Event Handler Dialog Box

3. Edit the event handler properties and click OK; the updated event handler appears in
the Event Handlers table.
To remove an event handler:
1. In the Event Handler dialog box, select an event handler by clicking its entry in the
table.
2. Click Remove.
3. Confirm removal by clicking Yes in the Remove Event Handler dialog box; the event
handler is removed from the Event Handlers table.

Managing Events, Using the CLI


Use the following CLI commands for managing events:
Command

Description

add-event-handler-definition

Adds a definition to an event handling rule.

remove-event-handler-definition

Deletes the event handling rule definitions.

modify-event-handler-definition

Modifies the definition of event handling rules.

show-event-handler-definitions

Displays the event handling rule definitions.

Managing the Events

289

Managing Alerts and Events

290

EMC XtremIO Storage Array User Guide

CHAPTER 8
Cluster Administration and Configuration
This chapter includes the following topics:

Configuring the iSCSI Portals and Routes...............................................................


Configuring the iSCSI Port Number ........................................................................
Setting the Maximum Transmission Unit for iSCSI..................................................
Configuring the Cluster Limits................................................................................
Configuring the Cluster ODX Mode.........................................................................
Configuring the iSCSI Security Parameters (CHAP) .................................................
Configuring the Cluster Encryption ........................................................................
Configuring the User Accounts...............................................................................
Configuring the LDAP Users Authentication ...........................................................
Configuring the Default Inactivity Timeout .............................................................
Configuring Email Settings ....................................................................................
Configuring the SNMP ...........................................................................................
Configuring the Remote Syslog Notification ...........................................................
Customizing the Login Screen Banner ...................................................................

Cluster Administration and Configuration

292
298
300
302
303
305
307
308
312
322
324
327
330
332

291

Cluster Administration and Configuration

Configuring the iSCSI Portals and Routes


To establish an iSCSI connection for transferring data, you should first define an iSCSI
portal. An iSCSI portal is an IPv4 address and port associated with a Target port.
Each iSCSI Target can be associated with multiple portals.
If an IP connection requires routing to remote networks, you can define routing rules that
apply to the iSCSI Target ports only.

Managing iSCSI Portals and Routes, Using the GUI


Configuring the iSCSI Portals
To configure an iSCSI portal:
1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 78 on page 106.
2. Click the Table View icon to view the list of hardware elements.
3. On the Inventory List tab (left pane), click Clusters to view the defined clusters in the
main window.
4. Select the relevant cluster and click Configure from the menu bar.
5. In the Configure Cluster Dialog box, click the iSCSI Network Configuration tab; the
iSCSI Network Configuration screen appears, as shown in Figure 200.

Figure 200 Configure Cluster - iSCSI Network Configuration Tab

292

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

6. In the iSCSI Portal Table, click Add; the Add iSCSI Portal dialog box appears.

Figure 201 Add iSCSI Portal Dialog Box

7. Select a Target port from the Target Port drop-down list.


8. Type the portals IP address and subnet bits.
Note: iSCSI Targets cannot have the same subnet as the management network.
9. Click OK to confirm and close the dialog box; the defined portal is added to the iSCSI
portals table.
Click the arrow next to the Target port name, to view all the defined portals associated with
a Target port.
Note: Only active/relevant options are described in Add iSCSI Portal dialog box.

Configuring the iSCSI Portals and Routes

293

Cluster Administration and Configuration

Modifying the iSCSI Portal Data


To modify the iSCSI portal data:
1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 78 on page 106.
2. Click the Table View icon to view the list of hardware elements.
3. On the Inventory List tab (left pane), click Clusters to view a list of the defined clusters
in the main window.
4. Select the relevant cluster and click Configure Cluster from the menu bar.
5. In the Configure Cluster dialog box, click the iSCSI Network Configuration tab; the
iSCSI Network Configuration screen appears, as shown in Figure 200.
6. In the iSCSI Portal table, click the portal you wish to modify and click Modify.

Figure 202 Modify iSCSI Portal Dialog Box

7. Modify the portals parameters (Target Port, IP Addres/Subnet bits).


8. Click OK to confirm the changes and close the dialog box.

Removing an iSCSI Portal


To remove an iSCSI portal:
1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 78 on page 106.
2. Click the Table View icon to view the list of hardware elements.
3. On the Inventory List tab (left pane), click Clusters to view a list of the defined clusters
in the main window.
4. Right-click the relevant cluster and select Configure Cluster from the drop-down menu.
5. In the Configure Cluster dialog box, click the iSCSI Network Configuration tab.
6. In the iSCSI Portal table, click the portal you wish to remove and click Remove.
7. Click Yes to confirm the removal; the portal is deleted from the table.

294

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

Configuring the iSCSI Routes


In rare cases, iSCSI Initiators are connected to different network subnets and require a
router to connect to the iSCSI portals.
To configure an iSCSI route:
1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 78 on page 106.
2. Click the Table View icon to view the list of hardware elements.
3. On the Inventory List tab (left pane), click Clusters to view a list of the defined clusters
in the main window
4. Select the relevant cluster and click Configure Cluster in the menu bar.
5. In the Configure Cluster dialog box, click the iSCSI Network Configuration tab.
6. In the iSCSI Routes Table, click Add; the Add iSCSI Route dialog box appears.

Figure 203 Add iSCSI Route Dialog Box

7. Type the route name.


8. Type the destination subnet/subnet bits according to the displayed example.
9. Type the gateway IP according to the displayed example.
10. Click OK to confirm and close the dialog box; the defined route is added to the iSCSI
Routes table.

Configuring the iSCSI Portals and Routes

295

Cluster Administration and Configuration

Modifying an iSCSI Route


To modify a defined iSCSI route:
1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 78 on page 106.
2. Click the Table View icon to view the list of hardware elements.
3. On the Inventory List tab (left pane), click Clusters to view a list of the defined clusters
in the main window.
4. Select the relevant cluster and click Configure Cluster in the menu bar.
5. In the Configure Cluster dialog box, click the iSCSI Network Configuration tab.
6. In the iSCSI Routes table, click the route entry you want to modify and click Modify;
the Modify ISCSI Route dialog box appears.

Figure 204 Modify iSCSI Route Dialog Box

7. Modify the iSCSI route parameters.


8. Click OK to confirm the changes and close the dialog box.

Removing an iSCSI Route


To remove an iSCSI route:
1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 78 on page 106.
2. Click the Table View icon to view the list of hardware elements.
3. On the Inventory List tab (left pane), click Clusters to view a list of the defined clusters
in the main window.
4. Select the relevant cluster and click Configure Cluster in the menu bar.
5. In the Configure Cluster dialog box, click the iSCSI Network Configuration tab.
6. In the iSCSI Route table, click to select the route entry you wish to remove.
7. Click Remove.
8. Click Yes to confirm routes removal; the route is deleted from the table.

296

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

Managing iSCSI Portals and Routes, Using the CLI


Use the following CLI commands for managing iSCSI portals and routes:
Command

Description

add-iscsi-portal

Maps a portal to a Target.

add-iscsi-route

Adds and configures iSCSI route parameters.

remove-iscsi-portal

Deletes a portal mapping from a Target.

remove-iscsi-route

Deletes an iSCSI routing configuration.

show-iscsi-portals

Displays a list of iSCSI portals and their properties.

show-iscsi-routes

Displays a list of iSCSI routes and their properties.

Configuring the iSCSI Portals and Routes

297

Cluster Administration and Configuration

Configuring the iSCSI Port Number


Using the iSCSI Ports Configuration screen you can:

Change iSCSI TCP port -


The XtremIO cluster uses the iSCSI default port (3260). You can change the default
port.
Enable or disable jumbo frames -
When jumbo frames are enabled, you can set the Ethernet adapter MTU to any value
between 1500 bytes and 9216 bytes.

Configuring the iSCSI Port via the GUI


The Listen TCP Port field displays port 3260 by default.
Note: Configuring the iSCSI port number can be done only when the cluster is inactive.
Note: The default TCP Port value is grayed out. To enable the field and change the port
number, the cluster needs to be stopped.
To change the TCP Port number:
1. Stop the cluster (see Stopping the Cluster via the GUI on page 334).
2. On the menu bar, click the Inventory icon to display the Inventory workspace.
3. Click the Table View icon to view the list of hardware elements.
4. On the Inventory List tab (left pane), click Clusters to view a list of the defined clusters
in the main window.
5. Select the relevant cluster and click Configure Cluster on the menu bar.
6. On the menu bar, click Configure to open the Configure Cluster window.

298

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

7. In the Configure Cluster dialog box, click the iSCSI Ports Configuration tab.

Figure 205 Configure Cluster - iSCSI Ports Configuration Tab

8. In the Listen TCP Port field, enter the new port number.
9. Click Apply and Close.
10. Start the cluster (see Starting the Cluster via the GUI on page 337).

Configuring the iSCSI Port Number

299

Cluster Administration and Configuration

Setting the Maximum Transmission Unit for iSCSI


iSCSI networks enable traffic of SCSI commands over TCP/IP data packets. Setting the
Maximum Transmission Unit (MTU) may influence the bandwidth, latency and reliability of
the network.
With the XtremIO Storage Array, the maximum transmission unit can be set to a value
ranging from 1,500 bytes (default) up to 9,216 bytes. The top value is referred to as jumbo
frames.
The following are the main pros and cons of increasing the default MTU size:
Pros:

Each packet carries more user data, while protocol overheads, such as headers or
underlying per-packet delays, remain fixed.
Fewer packets are processed for the same amount of data.

Cons:

Large packets occupy a slow link for more time than smaller packets, causing greater
delays to subsequent packets.
Larger packets are more likely to be corrupt. Corruption of a single bit in a packet
requires that the entire packet be retransmitted.

To transfer a packet successfully from one NIC to another, the entire LAN path must be
configured to support the specific packet's size. Otherwise, the packet may be either
fragmented to a supported size, or in other cases, discarded (if the TCP header "Don't
Fragment" flag is set). When increasing the MTU, it is necessary to verify that every NIC on
the path (between the host and the XtremIO Storage Controller) supports the requested
MTU.

300

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

Configuring Jumbo Frames via the GUI


When enabled, Jumbo Frames Maximum Transmission Unit (MTU) is set by default to
9216. Re-enabling the Jumbo Frames option after disabling it, displays the last MTU value
set before it was disabled.
Note: Enabling and disabling the Jumbo Frame option is carried out per cluster and
requires restarting the iSCSI service which will cause existing connections to drop.
Note: When configuring jumbo frames:

The set MTU should match the maximal MTU supported in your networking infrastructure.

All networking devices, including switches and hosts, should support the new MTU.

Disregarding this or setting a wrong MTU can result in packet fragmentation or discarded packets.

To enable the Jumbo Frames option:


1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 78 on page 106.
2. Click Table View to view the list of hardware elements.
3. On the Inventory List tab (left pane), click Clusters to view a list of the defined clusters
in the main window.
4. Click to select the relevant cluster and click Configure in the menu bar.
5. In the Configure Cluster dialog box, click the iSCSI Ports Configuration tab.
6. On the Port Properties Configuration section, select the Enable Jumbo Frames option.
7. Set the MTU value, using the up and down arrows.
8. Click Apply.

Setting the Maximum Transmission Unit for iSCSI

301

Cluster Administration and Configuration

Configuring the Cluster Limits


The Cluster Limits section in the Cluster Configuration screen enables you to set a thin
provisioning soft limit (TPST). The limit is set as a percentage of the storage capacity and
can be up to 100%. The set limit is used as the threshold that triggers sending a warning
on the SCSI interface for Volumes with set VAAI limits.

Configuring Cluster Limits via the GUI


To set the cluster VAAI TP limit:
1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 78 on page 106.
2. Click the Table View icon to view the list of hardware elements.
3. On the Inventory List tab (left pane), click Clusters to view a list of the defined clusters
in the main window.
4. Select the relevant cluster and click Configure in the menu bar.
5. In the Configure Cluster dialog box, click the VAAI TP Limit tab.

Figure 206 Configure Cluster - VAAI TP Limit Tab

6. On the VAAI TP Limit section, leave the dont limit option unselected, to set a thin
provisioning soft limit.
7. Set the limit, using the up and down arrows. The limit can be set between 1% and
100%.
8. Click Apply and Close.

302

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

Configuring Cluster Limits via the CLI


Using the CLI, it is possible to set thresholds for user capacity and receive alerts when the
threshold is exceeded. Refer to Setting Thresholds on page 284 for details.
Use the following CLI command for setting the cluster limits:
Command

Description

modify-cluster-thresholds

Modifies the properties for thin provisioning soft limits for


connected clusters.

modify-alert-definition

Modifies the alert definition properties for a specified alert type.

Configuring the Cluster ODX Mode


XtremIO is an ODX-capable storage array, supporting offloaded read and write operations
for Windows environments. ODX is supported within the domain of an XtremIO array (i.e.
source and destination LUNs must reside on the same array).
XtremIO provides the Initiator with its preferred optimal transfer size (0 - 256MB).
However, Initiators are not obligated to use the optimal size.
ODX support is provided on all FE interfaces (FC or iSCSI) and is supported for both
Volumes and Snapshots.
Note: As part of the ODX copy operation, data is read from the tokens and then written to
the target Volumes. The tokens are internal data structures and are not visible to external
users. As a result, the performance data shown in the XtremIO User Interface accounts for
the write operations on the target Volumes, but does not reflect the read operations which
are done as part of ODX copy. This behavior is expected.

Configuring the ODX Mode via the GUI


Note: The ODX Mode field is grayed out. To enable the field and configure the ODX mode,
the cluster needs to be stopped.
To configure the ODX mode:
1. Stop the cluster (see Stopping the Cluster via the GUI on page 334).
2. On the menu bar, click the Inventory icon to display the Inventory workspace.
3. Click the Table View icon to view the list of hardware elements.
4. On the Inventory List tab (left pane), click Clusters to view a list of the defined clusters
in the main window.
5. Select the relevant cluster and click Configure Cluster on the menu bar.

Configuring the Cluster ODX Mode

303

Cluster Administration and Configuration

6. In the Configure Cluster dialog box, click the ODX Mode Configuration tab.

Figure 207 Configure Cluster - ODX Mode Configuration Tab

7. In the ODX Mode field, select Enabled or Disabled from the drop-down list.
8. Click Close.
9. Start the cluster (see Starting the Cluster via the GUI on page 337).

Configuring the ODX Mode via the CLI


Use the following CLI command for setting the clusters ODX mode:

304

Command

Description

modify-clusters-parameters

Modifies various cluster parameters.

show-clusters-parameters

Displays various cluster parameters.

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

Configuring the iSCSI Security Parameters (CHAP)


iSCSI Initiators and Targets prove their identity to each other, using the
Challenge-Handshake Authentication Protocol (CHAP), which includes a mechanism to
prevent clear text passwords from appearing on the wire.
It is possible to configure CHAP for Initiator login and for the discovery phase. It is also
possible to configure Mutual CHAP for the Initiator to authenticate the XtremIO Targets.
When using CHAP, each Initiator that is added to an Initiator Group is assigned with a
username and password (sometimes called CHAP secret). The same username and
password must be configured on the hosts side and be used for the first login. Initiators
that do not provide the correct username and password are rejected and will not be able
to read and write data.
It is possible to configure CHAP username and password for the discovery phase. When
configured, hosts must provide the correct username and password to be able to discover
the available Targets on the XtremIO cluster.
Note: Login username and password cannot be the same as the discovery username and
password.
When Mutual CHAP is configured, the hosts authenticate the cluster, using a
pre-configured username and password. When Mutual CHAP is enabled, a unique set of
username and password is configured for each Initiator for login and discovery. The
system administrator must configure the username and password on the host side to
enable it to authenticate the XtremIO Targets.
Note: When working in Mutual CHAP mode (Initiator and Target), the clusters username
and password should be different from any of the Initiators' usernames and passwords.

Configuring the iSCSI Security Parameters (CHAP)

305

Cluster Administration and Configuration

Configuring CHAP via the GUI


To configure the Initiators discovery CHAP:
1. On the menu bar, click the Inventory icon to display the Inventory workspace, as
shown in Figure 78 on page 106.
2. Click the Table View icon to view the list of hardware elements.
3. On the Inventory List tab (left pane), click Clusters to view a list of the defined clusters
in the main window.
4. Select the relevant cluster and click Configure in the menu bar.
5. In the Configure Cluster dialog box, click the iSCSI Security Configuration tab.

Figure 208 Configure Cluster - iSCSI Security Configuration Tab

6. If you want to configure CHAP for discovery, select the value for CHAP Discovery Mode
from the drop-down list as follows:
Disabled - default mode, CHAP Discovery is not active.
Initiator - the Target allows discovery only for Initiators with pre-configured name
and password.
Initiator and Target - Initiator and Target perform authentication before discovery.
7. If you want to configure CHAP for authentication, repeat step 6 in the CHAP
Authentication Mode area.
Note: when enabling CHAP (either "Initiator" or "Initiator and Target" mode), it is required
to configure the iSCSI Initiators with Username and Password.

306

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

Configuring CHAP via the CLI


Use the following CLI command for configuring CHAP parameters:
Command

Description

modify-chap

Modifies CHAP configuration parameters.

show-chap

Displays the clusters configured CHAP authentication and


discovery modes.

Configuring the Cluster Encryption


Note: Cluster encryption is applicable only for clusters with hardware that supports
encryption.
Note: Clusters running version 4.0.0 and above are encrypted by default.
Note: Changing the encryption status can be performed only on a stopped cluster.
Note: Disabling cluster encryption is supported only in clusters running version 4.0.2.
Note: For certain countries, cluster encryption is disabled and cannot be enabled.
You can view the clusters encryption status, using the GUI (see Encryption Tab on
page 97) or CLI (see show-clusters-info on page 423).
To configure the cluster encryption, contact EMC Global Tech Support.

Configuring the Cluster Encryption

307

Cluster Administration and Configuration

Configuring the User Accounts


User Accounts Overview
You can create user accounts and define their authorization roles as required. Each user
account has its own User ID (i.e. the user account name), password, and the users
authorized capabilities and roles.
You can create user accounts for remote CLI users. These users can access the cluster only
via the CLI. When creating a user account for a remote user, a public key is defined instead
of a password.
The following user accounts are built into the cluster with predefined authorization roles
and cannot be removed, renamed or modified:

Admin - This role can perform all user commands and manage all user accounts,
except for the Tech user account.
Tech - This role can perform all commands and manage all user accounts. This account
is for use only by XtremIO Storage Array trained support personnel.
Configuration - This role can perform all storage array configuration actions but cannot
manage users.
Read-Only - This role can view all storage array information but cannot perform any
configuration changes.

Managing User Accounts, Using the GUI


Adding a User
To add a new user:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Security tab and select Users Administration from the left pane; the Users
Administration screen appears, as shown in Figure 79 on page 107.
3. Click Add to open the Add New User dialog box (you can also right-click an existing
user and select Add).

308

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

Figure 209 Add New User Dialog Box

4. Select the new users role from the drop-down list (Administrator, Configuration, or
Read-Only).
5. Type a unique user name.
6. Select the authentication method, according to the user type (By Password or By
Public Key).
7. If you selected the Password option, type a password and confirm it.
If you selected the Public Key option, enter the public key.
Note: Public key users are limited to CLI access and are used to run scripts from
external hosts without requiring a password. Creating the user on the external hosts
and generating an SSH public key pair is out of the scope of this document and should
be carried out according to the external hosts' OS procedures.

Figure 210 Add New User Dialog Box - Public Key

Configuring the User Accounts

309

Cluster Administration and Configuration

8. Set the Inactivity Timeout for the user. The displayed default value is set in the XMS
Configuration screen (see Customizing the Login Screen Banner on page 332).
9. Click OK to confirm and close the dialog box; the new user is added to the users list.
Note: If the added user was authenticated by an external server (i.e. Active Directory) and
is not locally defined, the Is External field is set to Yes.

Modifying the User Role, Name and Password


To modify a users data:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Security tab and select Users Administration from the left pane; the Users
Administration screen appears, as shown in Figure 79 on page 107.
3. In the users table, click the relevant user to select it and then click Modify to open the
Modify User dialog box (you can also right-click the users entry and select Modify).
The parameters in the dialog box match the edited user type (i.e. password or public
key).

Figure 211 Modify User Data Dialog Box

4. Modify the users characteristics. You can change the users role, name, password or
public key and inactivity timeout.
5. Click OK to confirm the changes and close the dialog box.

310

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

Removing a User
To remove a user:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Security tab and select Users Administration from the left pane; the Users
Administration screen appears, as shown in Figure 79 on page 107.
3. In the users table, select the users entry and click Remove (you can also right-click the
users entry and select Remove).
4. Click OK to confirm the deletion and close the dialog box.

Logging In as a Different User


To log in as a different user:
1. On the Menu Bar, click the Logout icon (see GUI Window on page 32); the Log in
dialog box appears.
2. Type the other users name and password and click Login.

Managing User Accounts, Using the CLI


Use the following CLI commands for managing user accounts:
Command

Description

add-user-account

Adds a new user account.

remove-user-account

Removes a user account.

modify-user-account

Modifies the user account parameters.

modify-password

Used to modify ones own password, or for entitled users


(Configuration and Admin) to modify others passwords.

show-user-accounts

Displays the user accounts information.

Configuring the User Accounts

311

Cluster Administration and Configuration

Configuring the LDAP Users Authentication


The Lightweight Directory Access Protocol (LDAP) is an application protocol for accessing
and maintaining distributed directory information services over an Internet Protocol (IP)
network.
XtremIO Storage Array supports LDAP users authentication. Once configured for LDAP
authentication, the XMS redirects users authentication to the configured LDAP or Active
Directory (AD) servers and allows access to authenticated users only. Users XMS
permissions are defined, based on a mapping between the users LDAP/AD groups and
XMS roles.
The XMS server LDAP Configuration feature allows using single or multiple servers for the
external users authentication for their login to the XMS server.
The LDAP operation is performed once when logging with external user credentials to an
XMS server. The XMS server operates as an LDAP client and connects to an LDAP service
running on an external server. The LDAP Search is performed, using the pre-configured
LDAP Configuration profile and the external user login credentials.
LDAP profiles are used when authentication is performed against several Directory
Services in one Active Directory Forest. Each profile is checked in order and once a positive
answer is received the user is authenticated. If no positive answer is received, the user is
denied access. It is recommended to define two servers URLs per profile for
high-availability of the service. The two servers used should be of the same Directory
Service and should act as backup for one another. The XMS connects to the first server
URL on the list and only if there is no response (time-out), it connects to the second server
URL.
If the authentication is successful, the external user logs in to the XMS server and
accesses the full or limited XMS server functionality (according to the XMS Role that was
assigned to the AD users Group). The external users credentials are saved in the XMS
server cache and a new user profile is created in the XMS User Administration
configuration. From that point, the external user authentication is performed internally by
the XMS server without connecting to an external server. The XMS server will re-perform
the LDAP Search only after the LDAP Configuration Cache time expires or at the next
successful external user login if the external user credentials were removed from the XMS
server User Administration manually.
XtremIO LDAP integration supports the following LDAP options:

LDAP clear text LDAP communication between XMS and LDAP server. LDAP uses the
default port 389 or port 3268 for global catalog.
LDAPS secure LDAP communication, using Transport Layer Security (TLS) between
the XMS and the LDAP server. LDAPS can be used either with a root certificate to
validate the server authenticity or without it. LDAPS uses the default port 636 or 3269
for global catalog.
Start TLS secure LDAP communication that starts at a non-secure port and enhances
the security mid-session. Start TLS uses port 389 or port 3268 for global catalog.

LDAP user authentication can be configured and managed via either GUI or CLI.

312

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

Setting the XMS Server LDAP Configuration


Before setting the XMS server LDAP configuration, note the following:

An administrative access to the DS server is required to define or modify the required


information on the DS server. As an option, the DS Groups distinguishedName, DS
Users userPrincipalName and other required information can be obtained remotely,
using a third party LDAP browsing software with the DS administrative (Bind DN) user
access.
LDAP configuration parameters and values should be set in accordance with the DS
server (for example Microsoft Active Directory) users and groups configuration.

Configuring the LDAP Users Authentication

313

Cluster Administration and Configuration

Configuring LDAP Settings via the GUI


Adding the LDAP Configurations
To add an LDAP configuration:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Security tab and select LDAP Configuration from the left tab; the LDAP
Configuration screen appears, as shown in LDAP Configuration Screen on page 108.
3. Click Add; the Add New LDAP Configuration dialog box appears.

Figure 212 Add New LDAP Configuration Dialog Box

314

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

4. Set the following parameters to configure the LDAP authentication:


Parameter

Description

Mandatory

Bind DN

A full Distinguished Name of a user that has


permissions for querying groups and perform
searches on behalf of other users

Yes

Bind Password

A password for the Bind DN

Yes

Search Base

Defines the starting point of the search in the DS


directory tree. A search base is built from multiple
objects, separated by commas, including:
cn: common name
ou: organizational unit
o: organization
c: country
dc: domain

No

Search Filter

An LDAP expression that defines which user object Yes


attribute is checked against which part of the user
input.
For example:
sAMAccountName={sam}- looks for a user
attribute called sAMAccountName, that
matches the "user" name to the right of a
backslash or to the left of an at (@) sign of the
user input during log in.
sAMAccountName={username} - looks for a
user attribute called sAMAccountName, that
matches the user name as entered by the user.
UserPrincipalName={username} - looks
for a user attribute called
UserPrincipalName, in the format of
user@domain, that matches the user name as
entered by the user.
The users input is parsed according to the
following fields:
{userame} - user name as entered by the user
{user} - user name after translation by
"username_to _dn" pattern
{domain} - the field to the left of the
backslash after "username_to_dn" translation
{sam} - "user" name to the right of a backslash
or to the left of an at (@) sign after
"user_to_dn" translation
{domain_dn} - contents of the "domain"
field, reconstructed into Distinguished Name
syntax

User to DN Rule

A rule that modifies the users input before the


search criteria for simplified use. The rule can
append a prefix or a suffix to the users input to
save typing.
Examples:
Ds1/{username} - adds the Ds1/ prefix to
the users input
{username}@domain.com- adds the
@domain.com postfix to the user input

No

Configuring the LDAP Users Authentication

315

Cluster Administration and Configuration

Parameter

Description

Mandatory

Timeout

The time in seconds before switching to the


secondary server or failing the request following
the servers failure to reply

No

Cache Expire

The time in hours (1 to 24) before the cached user


authentication expires and re-authentication is
required

Yes

Server URLs

LDAP server addresses. Format can be either


ldap:\\<IP> or ldap:\\<hostname>
(except when using certificates, see note below).
See Configuring the Server URLs on page 318.

Yes

Active Directory
Groups

XMS roles assignment to DS groups (represented


by their DN). See Configuring the Active Directory
Rules on page 319.

Yes

CA Certificate

Used for server root certificate validation (for


LDAPS). The certificate should be in PEM format.

No

Note: When using a certificate, the XMS validates the certificate correctness, including
the server name. In this case, make sure that the server URLs are defined in name
format and are matching the names in the certificate.
5. Click OK; the new LDAP configuration profile is added to the configuration table.
Note: You can configure up to ten LDAP profiles.
Note: For an LDAP configuration profile example, see Configuring LDAP Settings via the
CLI on page 321.

316

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

Modifying the LDAP Configurations


To modify an LDAP configuration:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Security tab and select LDAP Configuration from the left tab; the LDAP
Configuration screen appears, as shown in LDAP Configuration Screen on page 108.
3. Double-click the entry you want to edit or select the entry and click Modify; the Modify
LDAP Configuration dialog box appears.

Figure 213 Edit LDAP Configuration Dialog Box

4. Edit the relevant configuration parameters (to edit Active Directory Groups, refer to
Configuring the Active Directory Rules on page 319).
5. Click OK to save the changes.

Configuring the LDAP Users Authentication

317

Cluster Administration and Configuration

Removing the LDAP Configurations


To remove an LDAP configuration:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Security tab and select LDAP Configuration from the left tab; the LDAP
Configuration screen appears, as shown in LDAP Configuration Screen on page 108.
3. Double-click the entry you want to remove and click Remove.
4. Click Yes to confirm; the entry is removed from the LDAP configuration table.

Configuring the Server URLs


To add a server URL:
1. In the Add New LDAP Configuration dialog box, click the Add button to the right of the
Server URLs section; the Add Server URL dialog box appears.

Figure 214 Add Server URL Dialog Box

2. Type the URL (IP address or full name), including the protocol LDAP, LDAPS or LDAPTLS
and the optional port (e.g. LDAP://10.2.2.3). Use the following formats according to
the desired protocol:
Protocol

Format

LDAP

ldap://10.2.2.3

LDAPS

ldaps://10.2.2.3

Start TLS

ldaptls://10.2.2.3

Note: If no port is specified, the default ports 389 and 636 are used for LDAP and
LDAPS, respectively. For global catalog, include the GC port (usually port 3268 for
LDAP and 3269 LDAPS).
3. Click OK; the new URL is added to the Server URLs list.

318

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

To remove a server URL:


1. On the LDAP Configuration window, double-click the relevant entry or select it and
click Modify to open the Modify LDAP Configuration dialog box.
2. From the Server URLs list, select the URL you want to remove and click the Remove
button to the right of the Server URLs section; the selected URL is removed from the
Server URLs list.
3. Click OK to save the changes.

Configuring the Active Directory Rules


To add an Active Directory mapping rule:
1. In the Add New LDAP Configuration dialog box, click the Add button to the right of the
Active Directory Group section; the Add Role dialog box appears.

Figure 215 Add Role Dialog Box

2. From the Role drop-down menu, select the XMS role (Administrator, Configuration, or
Read-Only).
3. In the Active directory group field, type the Distinguished Name (DN) of the AD group
you want to map to the selected role.
4. Click OK; the new mapping rule is added to the Active Directory Group list.
To edit an Active Directory mapping rule:
1. On the LDAP Configuration window, double-click the entry you want to Modify or select
it and click Modify to open the Modify LDAP Configuration dialog box.
2. From the Active Directory Group pane, select the rule you want to Modify and click
Modify; the Add Role dialog box appears.

Figure 216 Add Role Dialog Box - Edit

3. In the Add Role dialog box, modify the mapping rule properties and click OK.
4. In the Modify LDAP Configuration dialog box, click OK to save the changes.

Configuring the LDAP Users Authentication

319

Cluster Administration and Configuration

To remove an Active Directory mapping rule:


1. On the LDAP Configuration window, double-click the entry you want to edit or select
the entry and click Modify to open the Modify LDAP Configuration dialog box.
2. From the Active Directory Group pane, select the rule you want to remove and click
Remove.
3. Click OK; the selected rule is removed from the mapping rules list.
4. In the Modify LDAP Configuration dialog box, click OK to save the changes.

Using the LDAP Authentication


To use LDAP Authentication:
1. Define an LDAP server and system parameters (LDAP protocol and a port if it is
different than the default).
2. Define a user with a search permission on the defined LDAP server. Enter the user
name and password in the Bind DN and Bind Password fields, respectively.
Note: The XMS uses the defined user (Bind DN) when searching for authenticated
users.
3. Define the search starting point (Search Base) to make the search more efficient.
Searching sub-trees is supported.
4. Define the search filter, i.e. which user AD attribute to search for and what part of the
users input to use.
For example:
for using the full user input and searching for UserPrincipalName, define the following
search filter: (UserPrincipalName={username})
5. Identify the AD groups associated with XMS user roles.
6. Define a mapping between the AD groups and XMS user roles.
You can simplify the login process for user by automatically adding a prefix or suffix to the
user entry and using the User to DN rule, thus omitting the need to enter the full domain
name. For example, adding @example.com to the username, renders entering
[email protected] unnecessary.
To use the global catalog:
1. Add the default catalog port to the server URL (e.g. LDAP://1.1.1.1:3268).
2. Enter the Bind DN and Bind Password.
3. Define the search filter. It is recommended to use a UserPrincipalName that is unique
in the catalog.
4. Map the AD groups to the XMS roles.
Note: For using global catalog, do not enter a Search Base and do not use a "User to DN"
rule.

320

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

Configuring LDAP Settings via the CLI


Use the following CLI commands for managing the LDAP server configuration:
Command

Description

add-ldap-config

Adds a new LDAP configuration profile to the LDAP configuration


table.

modify-ldap-config

Modifies an LDAP configuration profile.

remove-ldap-config

Removes an LDAP configuration profile from the LDAP configuration


table.

show-ldap-configs

Displays the LDAP users authentication configuration data.

The following examples display the output of the show-ldap-configs command for
different environments:

Output for Linux environment:


xmcli (admin)> show-ldap-configs
Index: 1
Bind DN: CN=Manager,DC=fbu,DC=umsg,DC=lab,DC=emc,DC=com
Search Base: OU=Users,DC=fbu,DC=umsg,DC=lab,DC=emc,DC=com
Search Filter: CN={username}
LDAP Servers: [ldap://10.245.XX.XX]
User to DN Rule:
CN={username},OU=Users,DC=fbu,DC=umsg,DC=lab,DC=emc,DC=com
Role Mapping:
[admin:CN=XIOGUIadmins,OU=Users,DC=fbu,DC=umsg,DC=lab,DC=emc,DC=com]
Timeout: 1500
Credetials-Expiration (hours): 24

Output for Windows environment:


xmcli (admin)> show-ldap-configs
Index: 1
Bind DN:
CN=Administrator,CN=Users,DC=fbu,DC=umsg,DC=lab,DC=emc,DC=com
Search Base: ou=XIO,dc=fbu,dc=umsg,dc=lab,dc=emc,dc=com
Search Filter: sAMAccountname={username}
LDAP Servers: [ldap://10.245.XX.XX]
User to DN Rule:
Role Mapping:
[admin:CN=XIOadmins,OU=XIO,DC=fbu,DC=umsg,DC=lab,DC=emc,DC=com]
Timeout: 1500
Credetials-Expiration (hours): 24

Configuring the LDAP Users Authentication

321

Cluster Administration and Configuration

The following example displays the usage of the add_ldap_config command:


xmcli (admin)> add-ldap-config binddn="CN=Mark Mark.
Mark,OU=XIO-DRM-LAB,DC=ds1,DC=drm,DC=lab,DC=emc,DC=com"
bindpw="welcome1" search-base="DC=ds1,DC=drm,DC=lab,DC=emc,DC-com"
search-filter="sAMAccountName={sam}"
server-urls=["ldap://10.103.224.44",
"ldap://10.103.224.45"]
roles=["admin:CN=admin-XIO,OU=XIO-DRM-LAB,DC=ds1,DC=drm,DC=lab,DC=emc
,DC=com"]
xmcli (admin)>

Configuring the Default Inactivity Timeout


The XtremIO Storage array enables you to set the inactivity timeout duration, after which
users are requested to log in to the cluster again.
The default inactivity timeout is ten minutes and it can be changed in full minute
granularity. The possible inactivity timeout range is 0 (no timeout) to 12 hours.
User accounts that are created after the inactivity timeout configuration will have the new
default value.
The user is notified 60 seconds before the timeout expiration. When the timeout expires,
the user is prompted for the username and password. After logging in, the screen that
appeared before timeout expiration re-appears.
All login and re-login actions are logged in the audit log.
The XtremIO Storage Array also enables you to set an inactivity timeout per user to allow
monitoring clients to be connected with no interruptions. For details, see Configuring the
User Accounts on page 308.

Configuring the Inactivity Timeout via the GUI


To configure the inactivity timeout via the GUI:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Security tab and select Default Inactivity Timeout from the left pane; the
Default Inactivity Timeout screen appears, as shown in Figure 81 on page 109.
3. Select the Default Inactivity Timeout option to enable it (if it is disabled) and type in
the new default inactivity timeout value.
4. Click Apply to save the changes.

322

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

Configuring the Inactivity Timeout via the CLI


Use the following CLI commands for configuring the inactivity timeout:
Command

Description

show-xms

Displays the XtremIO management System information.

modify-xms-parameters

Modifies the XMSs user inactivity timeout.

Configuring the Default Inactivity Timeout

323

Cluster Administration and Configuration

Configuring Email Settings


Managing Email Settings, Using the GUI
Enabling Email Notifications
To enable email notifications:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Notification tab, and select Email Configuration from the left pane; the Email
Configuration screen appears, as shown in Figure 82 on page 110.
3. Select the Send email notifications option.
4. Click Apply to save the changes.

Adding Email Recipients


To add a new email recipient:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Notification tab, and select Email Configuration from the left pane; the Email
Configuration screen appears, as shown in Figure 82 on page 110.
3. Click Add; the Add Recipient dialog box appears.

Figure 217 Add Email Recipient Dialog Box

4. Type the recipients email address.


5. Click OK to confirm and close the dialog box; the new recipient is added to the
recipients list.
Note: Click Undo if you want to revoke the changes.
6. Click Apply to save the changes.

324

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

Removing Email Recipients


To remove an email recipient:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Notification tab, and select Email Configuration from the left pane; the Email
Configuration screen appears, as shown in Figure 82 on page 110.
3. Select the recipient you want to remove.
4. Click Remove; the recipient is deleted from the recipients list.
Note: Click Undo if you want to revoke the recipients removal.
5. Click Apply to save the changes.

Configuring the Email Sender Properties


To configure the email sender properties:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Notification tab, and select Email Configuration from the left pane; the Email
Configuration screen appears, as shown in Figure 82 on page 110.
3. Type the sender email address in the Sender text box.
4. Type the companys name in the Company Name text box.
5. Type the required contact information in the Contact Details text box.
Note: Click Undo if you want to revoke the configuration.
6. Click Apply to save the changes.

Configuring Email Settings

325

Cluster Administration and Configuration

Configuring the Email Sending Mechanism


To configure the email sending mechanism:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Notification tab, and select Email Configuration from the left pane; the Email
Configuration screen appears, as shown in Figure 82 on page 110.
3. Click one of the Transport options (HTTP or SMTP) to select the mail sending topology:
If you select HTTP, fill in the HTTP Proxy Server fields (Address, Port, Username, and
Password).
If you select SMTP, fill in the SMTP Information fields (Mail Relay Address,
Username, and Password).
Note: Click Undo if you want to revoke the configuration.
4. Click Apply to save the changes.

Managing Email Settings, Using the CLI


Use the following CLI commands for managing Email settings:

326

Command

Description

modify-email-notifier

Modifies the email notification settings.

show-email-notifier

Displays the Email notification settings.

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

Configuring the SNMP


Note: To make sure the correct host information is sent via the SNMP traps, it is required to
use a valid DNS configuration or use the CLI command modify-server-name on
page 430.

Configuring SNMP, Using the GUI


Enabling the SNMP Notifications
To enable SNMP notifications:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Notification tab, and select SNMP Configuration from the left pane; the SNMP
Configuration screen appears, as shown in Figure 83 on page 111.
3. Select the Send SNMP notifications option.
4. Click Apply to save the changes.

Adding an SNMP Notification Recipient


To add an SNMP notification recipient:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Notification tab and select SNMP Configuration from the left pane; the SNMP
Configuration screen appears, as shown in Figure 83 on page 111.
3. Click Add; the Add Recipient dialog box appears.

Figure 218 Add SNMP Notification Recipient Dialog Box

4. Type the recipients address.


5. Click OK to confirm and close the dialog box; the new recipient is added to the table.
Note: Click Undo if you want to revoke the changes.
6. Click Apply to save the changes.

Configuring the SNMP

327

Cluster Administration and Configuration

Removing an SNMP Notification Recipient


To remove an SNMP notification recipient:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Notification tab and select SNMP Configuration from the left pane; the SNMP
Configuration screen appears, as shown in Figure 83 on page 111.
3. In the SNMP Recipients table, click to select a recipient entry.
4. Click Remove.
5. Click Yes to confirm; the recipient is removed from the table.
Note: Click Undo if you want to revoke the changes.
6. Click Apply to save the changes.

Configuring the SNMP Properties


To configure the SNMP properties:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Notification tab and select SNMP Configuration from the left pane; the SNMP
Configuration screen appears, as shown in Figure 83 on page 111.
3. Select the SNMP Version (V1, V2C or V3).
4. If you selected V3 as the SNMP version, configure the following properties:
User name
Authentication protocol (No Authentication, MD5, SHA1 or Unexpected Value)
Authentication key
Privacy protocol (No Privacy, DES, AES128 or Unexpected Value)
Privacy key
5. Set the Community/SNMPV3 Context Name field (the default entry is public
[read-only]).
6. Set the Trap Port field (the default entry is 162).
Note: Click Undo if you want to revoke the changes.
7. Click Apply to save the changes.

328

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

Configuring SNMP, Using the CLI


Use the following CLI commands for managing SNMP configuration:
Command

Description

modify-snmp-notifier

Modifies the SNMP notification settings.

show-snmp-notifier

Shows the SNMP notification settings.

XtremIO MIB
XtremIO MIB is a trap definition file that can be installed in an external trap receiver/SNMP
trap and be used to parse XtremIO SNMP traps.
To use the XtremIO MIB:
1. Download the XtremIO MIB file from the EMC Support page for XtremIO.
Note: For details on the XtremIO MIB file to download from the Support page, refer to
the Release Notes of the version installed on the XtremIO cluster.
2. Import the XtremIO MIB to your SNMP server, according to the server procedures
(outside the scope of this guide).
3. Configure SNMP traps in XMS (refer to Configuring the SNMP on page 327).
4. Start using the MIB.
Note: The Object IDs that are sent in the trap text are internal to XtremIO and are not
mapped by this MIB.

Configuring the SNMP

329

Cluster Administration and Configuration

Configuring the Remote Syslog Notification


The XtremIO Storage Array enables you to send events to a remote syslog server. You can
configure up to 6 syslog servers and use the event handlers configuration to select the
events that will be sent via the syslog interface.
Remote syslog can be configured via the GUI or CLI.

Configuring Remote Syslog via the GUI


Enabling Syslog Notification
To enable Syslog notification:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Notification tab and select Syslog Configuration from the left pane; the
Syslog Configuration screen appears, as shown in CLI Terminal Tab on page 114.
3. Select the Send Syslog Notification option.
4. Click Apply to save the changes.

Adding a Syslog Server


To add a Syslog server:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Notification tab and select Syslog Configuration from the left pane; the
Syslog Configuration screen appears, as shown in CLI Terminal Tab on page 114.
3. Click Add; the Add Syslog Target dialog box appears.

Figure 219 Add Syslog Target Dialog Box

4. Type the server IP address or name. You can include the optional port
(e.g. 10.1.1.1:1022).
5. Click OK; the server is added to the Target list.
6. Click Apply to save the changes.

330

EMC XtremIO Storage Array User Guide

Cluster Administration and Configuration

Removing a Syslog Server


To remove a Syslog server:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the Notification tab and select Syslog Configuration from the left pane; the
Syslog Configuration screen appears, as shown in CLI Terminal Tab on page 114.
3. Select the server you want to remove by clicking it.
4. Click Remove; the server is removed from the Target list.
5. Click Apply to save the changes.

Selecting Events for Syslog Server


To select the event that will be sent to the Syslog server, refer to Managing Event
Handlers on page 287.

Configuring Syslog Settings via the CLI


Use the following CLI commands for managing Syslog notification configuration:
Command

Description

show-syslog-notifier

Displays the Syslog server notification status and data.

modify-syslog-notifier

Enables Syslog configuration.

Configuring the Remote Syslog Notification

331

Cluster Administration and Configuration

Customizing the Login Screen Banner


You can customize the login screen banner by adding text. XtremIO supports customizing
the login banner in SSH, HTML and JAVA:

SSH - The customized text is displayed when an SSH session is opened.


HTML - The customized text is displayed in the HTML landing page, below the
download button.
Java - The customized text is displayed in the Java Login splash screen.

Note: The added banner text can be up to 3771 characters long.


The login screen banner customization can be done via both GUI and CLI.

Customizing the Login Screen Banner via the GUI


To customize the login banner via the GUI:
1. On the menu bar, click the Administration icon to display the Administration
workspace, as shown in Figure 78 on page 106.
2. Click the XMS tab and select Login Banner from the left pane; the Login Banner screen
appears, as shown in Figure 85 on page 113.
3. Type in the customized text and click Apply.

Customizing the Login Screen Banner via the CLI


Use the following CLI command for customizing the XMS banner:

332

Command

Description

modify-login-banner

Enables you to customize the XMS banner text.

EMC XtremIO Storage Array User Guide

CHAPTER 9
Cluster Operations
This chapter includes the following topics:

Locating the Cluster ..............................................................................................


Stopping the Cluster .............................................................................................
Starting the Cluster ...............................................................................................
Powering Off the Cluster........................................................................................
Powering Up the Cluster ........................................................................................
Shutting Down the Cluster - Planned Shutdown.....................................................
Shutting Down the Cluster - Emergency Shutdown.................................................
Changing the IP Configurations .............................................................................
Setting the Cluster Time and Date .........................................................................
Managing the Virtual XMS .....................................................................................
Refreshing the Unique SSH Key .............................................................................

Cluster Operations

334
334
337
338
340
348
352
354
361
362
366

333

Cluster Operations

Locating the Cluster


Before starting or stopping the cluster, it is important to verify that you are performing the
procedure on the correct cluster.
To locate the correct cluster:
1. If possible, physically locate the appropriate cluster and its components.
2. Run the following XMCLI command to obtain the name and index of the appropriate
cluster:
show-clusters
xmcli (admin)> show-clusters
Cluster-Name
Index
State
Xbrick1
1
active
Xbrick2
2
active

Conn-State
connected
connected

...
...
...

Note: When executing a procedure for starting or stopping the cluster, specify the cluster
name or index whenever it is required to run a cluster-related command.
Note: It is recommended to use the cluster name (and not the cluster ID) as the cluster
identifier in cluster-related XMCLI commands.

Stopping the Cluster


Stopping the Cluster via the GUI
To stop the cluster via the GUI:
1. On the menu bar, click Inventory.
2. Click the Table View icon to view the list of hardware elements.
3. On the Inventory List tab, click Clusters to open the Clusters window.
4. On the Inventory menu bar, click Table View.
5. Right-click the relevant cluster and select Maintenance > Stop.

Figure 220 Stop Cluster Notification

6. Click OK to confirm.

334

EMC XtremIO Storage Array User Guide

Cluster Operations

7. If you want to cancel the stopping procedure, click Cancel on the progress bar.

Figure 221 Stop Cluster Progress Bar

When the cluster is stopped, the cluster icon changes and an alert appears in the
Alerts tab.

Figure 222 Stopped Cluster

Stopping the Cluster

335

Cluster Operations

Stopping the Cluster via the CLI


To stop the cluster via the CLI:
1. Run the following XMCLI command:
stop-cluster cluster-id=<cluster name>


Verify that you specify the correct cluster name.
The following message appears:
xmcli (admin)>stop-cluster cluster-id="Xbrick1"
Warning: You are about to stop the cluster service. All
connected initiators will be denied access to cluster data.
Are you sure you want to stop <cluster name>? (Yes/No):/No):
2. Enter Yes and wait until the cluster completes carrying out the command and displays
the following message.
Stopped Cluster Xbrick1. Cluster state: stopped

Note: This process may take several minutes.


3. Run the show-clusters XMCLI command and verify that the State of the relevant
cluster is stopped.
xmcli (admin)> show-clusters
Cluster-Name Index State
xbrick1
1
stopped

Conn-State
connected

...
...

Total-Writes Total-Reads Stop-Reason


11.472T
17.209T
user_deactivated

Note: If performing the above steps does not stop the cluster (i.e. if the State is not
stopped after more that 10 minutes), contact EMC Global Tech Support.

336

EMC XtremIO Storage Array User Guide

Cluster Operations

Starting the Cluster


Starting the Cluster via the GUI
To start the cluster via the GUI:
1. On the menu bar, click Inventory.
2. Click the Table View icon to view the list of hardware elements.
3. On the Inventory List tab, click Clusters to open the Clusters window.
4. On the Inventory menu bar, click Table View.
5. Right-click the relevant cluster and select Maintenance > Start.
Note: This menu option is visible only when the cluster is stopped.
6. When the cluster is started, the clusters icon changes to indicate that it is active.

Starting the Cluster via the CLI


To start the cluster via the CLI:
1. Run the following XMCLI command:
start-cluster cluster-id=<cluster name>


Verify that you specify the correct cluster name.
xmcli (admin)> start-cluster cluster-id="Xbrick1"
The process may take a few minutes. Please do not interrupt.
Started Cluster
xmcli (admin)>

Note: This process may take several minutes.


2. Run the show-clusters XMCLI command and view the results to verify that:
State is active.
Conn-State is connected.
xmcli (admin)> show-clusters
Cluster-Name
Index
State
Xbrick1
1
active
Xbrick2
2
active

Conn-State
connected
connected

...
...
...

Note: If the cluster is not active and connected, contact EMC Global Tech Support.

Starting the Cluster

337

Cluster Operations

Powering Off the Cluster


Powering Off the Cluster via the GUI
Note: After powering off the cluster, it is not possible to turn it on via the GUI. To power the
cluster on, physical access to the cluster is required.
Note: If you are powering off an active cluster, the cluster will stop before powering off.
Note: After powering off the cluster, it may take up to 30 minutes before you can start the
cluster again.
To power off the cluster via the GUI:
1. On the menu bar, click Inventory.
2. In the Inventory List tab, click Clusters to open the Clusters window.
3. On the Inventory menu bar, click Table View.
4. Right-click the relevant cluster and select Maintenance > Power Off.

Figure 223 Power Off Notification

5. Provide a power off reason by typing it in the Power Off notification dialog box. The
Comment is registered in the log file.
6. Click OK. When the cluster power off procedure is complete, it becomes inaccessible
via the GUI.

338

EMC XtremIO Storage Array User Guide

Cluster Operations

Powering Off the Cluster via the CLI


To power off the cluster via the CLI:
1. Run the following XMCLI command to shut down the clusters Storage Controllers.
power-off cluster-id=<cluster name>
shut-down-reason="reason"


Verify that you are specifying the correct cluster name.
Note: The shut-down-reason parameter is mandatory if you are specifying the
Cluster ID (cluster-id), and optional if you are specifying the Storage Controller ID
(sc-id).
xmcli (admin)> power-off cluster-id="Cluster1"
shut-down-reason="maintenance"
Please note: Restarting the cluster after powering it off
will require physical access to the system.
Are you sure you want to power-off all Storage Controllers
in Cluster Cluster1[1]? (Yes/No):

2. Type Yes to confirm the power off action.


3. If the cluster is running the following question appears:
Cluster Cluster1[1] is running. Are you sure you want to
stop the cluster and power-off all Storage Controllers?
(Yes/No):
Type Yes to confirm stopping and powering off the cluster.
4. Wait for the command to complete successfully.
Please wait a few minutes for the cluster to stop. Do not
touch the power cables until the command returns.
[################################################] 100%
Done!
(elapsed time 00:03:36)
Powering of cluster
Cluster Cluster1 [1] Storage Controllers power-off succeeded

Powering Off the Cluster

339

Cluster Operations

Powering Up the Cluster



If RecoverPoint is connected to the XtremIO cluster running version 4.0.2-80 (or below),
pause the activity of the Consistency Groups that are configured to replicate with the
cluster, using RecoverPoint native replication. Replication should be resumed after the
cluster is powered-up.
If further assistance is required to pause in RecoverPoint, contact EMC Global Tech
Support.
If you are unable to perform this operation, do not proceed with the power-up procedure
and contact EMC Global Tech Support for further instructions.
For further details, refer to EMC KB# 479972 (https://support.emc.com/kb/479972).

Powering Up the Cluster after an Emergency Shutdown


Note: This procedure should be carried out before powering up the cluster, only if the
performed emergency shutdown involved disconnecting the DAE power cables of X-Brick
No. 1, as described in Shutting Down the Cluster - Emergency Shutdown on page 352.
Before powering up the cluster:
1. Check if the two DAE power cables of X-Brick No. 1 (usually the lowest X-Brick in the
rack) are connected to their ports, as shown in Figure 224.

Figure 224 Power Connection Ports (Shown with Arrows) on the Rear Side of DAE

If the DAE power cables are connected to their ports, skip to step 2 .
If the DAE power cables are disconnected from their ports, proceed as follows:
1. Make sure that the clusters power is turned off, by verifying that the rack's PDU
(to which the cluster is connected) is turned off.
Note: Make sure that no other equipment is connected to the PDU.
2. Connect the two DAE power cables of X-Brick No. 1 (usually the lowest X-Brick in
the rack) to their ports, as shown in Figure 224.
3. Turn on the racks PDU (to which the cluster is connected).
2. Proceed to Powering Up Procedure.

340

EMC XtremIO Storage Array User Guide

Cluster Operations

Powering Up Procedure
Note: This procedure requires running XMCLI commands with Administrator privileges.

If the cluster has been shut down due to a power loss, it automatically restarts when
the power is restored.
To start the cluster for the first time, carry out the complete powering up procedure, as
described below.
To start the cluster following an emergency shut down, carry out the complete
powering up procedure, as described below. Before powering up the Battery Backup
Units, power up the PDU that was powered off during the emergency shut down.
To restart the cluster following a logical shutdown (such as a stop-cluster
command), you can perform only the procedure for Starting the Cluster on
page 347.

Note: If the cluster was shut down, using an emergency shutdown procedure, turn on the
racks PDU (to which the cluster is connected).
To power up the cluster, carry out the following procedures:
1. See the Note above.
2. Powering Up the Battery Backup Units on page 342
3. Powering Up the Storage Controllers on page 345
4. Powering Up the XMS on page 346
5. Starting the Cluster on page 347

Powering Up the Cluster

341

Cluster Operations

Powering Up the Battery Backup Units


Note: If the cluster was shut down in an emergency procedure, power up the PDU that was
powered off during the emergency shut down before powering up the Battery Backup
Units.
Note: if the Battery Backup Units were shut down due to a power outage, they power up
automatically when they are charged to 70% of their full capacity.
Battery Backup Units of an XtremIO cluster can be of one of the following types:

If the front panel of the Battery Backup Unit is as shown in Figure 225, the Battery
Backup Unit is 5P 1550i R.

Figure 225 Front Panel of the 5P 1550i Battery Backup Unit

If the front panel of the Battery Backup Unit is as shown in Figure 226, the Battery
Backup Unit is 1550 Evolution.

Figure 226 Front Panel of the 1550 Evolution Battery Backup Unit

342

EMC XtremIO Storage Array User Guide

Cluster Operations

Powering Up the 5P 1550i Battery Backup Units


To power up the 5P 1550i R Battery Backup Units:
1. Verify that the graphical LCD display of the Battery Backup Unit is lit (indicating that
the Battery Backup Unit is receiving mains power).
2. Verify that the Power On indicator (on the front panel of the Battery Backup Unit, as
shown in Figure 227) is not lit.
Note: If the Power On indicator is lit, the Battery Backup Unit is already powered up.

Power On Indicator
Power Button

Figure 227 Power Button and Power On Indicator on the Front Panel of the 5P 1550i Battery
Backup Unit

3. Press and hold the Power button to turn on the Battery Backup Unit, as shown in
Figure 227.
4. Wait for the Battery Backup Unit to complete its startup self test.
5. Verify that:
The Power On indicator is lit, as shown in Figure 228.
The graphical LCD display shows the Normal mode screen, as shown in Figure 228.

Power On Indicator

Figure 228 5P 1550i Battery Backup Unit Powered On

6. Repeat the above steps to power up all Battery Backup Units in the cluster.
Note: In order to start the cluster, at least one of the Battery Backup Units (in a single
X-Brick cluster), or one Battery Backup Unit per X-Brick pair (in a multiple X-Brick
cluster) must be charged to not less than 70% of its full capacity (as indicated on the
graphical LCD display).

Powering Up the Cluster

343

Cluster Operations

Powering Up the 1550 Evolution Battery Backup Units


To power up the 1550 Evolution Battery Backup Units:
1. Verify that the Charge indicator LEDs (on the front panel of the Battery Backup Unit, as
shown in Figure 229) are lit (indicating that the Battery Backup Unit is receiving mains
power).

Charge
Indicator
LEDs
Figure 229 Charge Indicator LEDs on the Front Panel of the 1550 Evolution Battery Backup Unit

2. Verify that the Power button (on the front panel of the Battery Backup Unit, as shown
in Figure 230) is not lit.

Power Button
Figure 230 Power Button on the Front Panel of the 1550 Evolution Battery Backup Unit

3. Press and hold the Power button to turn on the Battery Backup Unit.
4. Wait for the Battery Backup Unit to complete its startup self test, until its LED
indicators become steady.
5. Verify that the Load Protected indicator of the Battery Backup Unit is lit, as shown in
Figure 231.

Load
Protected
Indicator
Figure 231 Load Protected Indicator on the Front Panel pf the 1550 Evolution Battery Backup
Unit

6. Repeat the above steps to power up all Battery Backup Units in the cluster.
Note: To start the cluster, at least one of the Battery Backup Units (in a single X-Brick
cluster), or one Battery Backup Unit per X-Brick pair (in a multiple X-Brick cluster) must
be charged to not less than 70% of its full capacity (i.e. three lit charge indicator LEDs,
as shown in Figure 229).

344

EMC XtremIO Storage Array User Guide

Cluster Operations

Powering Up the Storage Controllers


Note: if the Storage Controllers were shut down due to a power outage, they power up
automatically when the Battery Backup Units are powered up.
To power up the Storage Controllers:
1. Locate the relevant cluster and obtain its name and index. Refer to Locating the
Cluster on page 334 for details.
2. Run the following XMCLI command to view all of the Storage Controllers in the cluster.
show-storage-controllers cluster-id=<cluster-name>
xmcli (admin)> show-storage-controllers cluster-id="Xbrick1"
Storage-Controller-Name Index Mgr-Addr
IB-Addr-1
IB-Addr-2
IPMI-Addr Brick-Name Index Cluster-Name Index State Enabled-State Unorderly-Stop-Reason Conn-State
X1-SC1
1
10.76.218.197 169.254.0.1 169.254.0.2 10.76.214.197 X1
1
Xbrick1
1
healthy enabled
none
connected
X1-SC2
2
10.76.218.198 169.254.0.17 169.254.0.18 10.76.214.198 X1
1
Xbrick1
1
healthy enabled
none
connected

IPMI-State
connected
connected

Note: You can run the XMCLI command only if the cluster has already been initialized.
3. For each Storage Controller whose Conn-State is not shown as connected, power on
the Storage Controllers manually, by pressing the Power button on the top-right side of
the front panel, as shown in Figure 232.
Power
Button
Figure 232 Power Button on the Front Panel of the Storage Controller

4. Run the show-storage-controllers XMCLI command again to confirm that all


the Storage Controllers are connected.
Note: Verify that you specify the correct cluster name.

Powering Up the Cluster

345

Cluster Operations

Powering Up the XMS


To power up the XMS, proceed as follows:

If the cluster uses a virtual XMS machine, follow the instructions for Powering Up the
Virtual XMS on page 346.
If the cluster uses a physical XMS machine, follow the instructions for Powering Up
the Physical XMS on page 346.

Powering Up the Virtual XMS


To power up the virtual XMS machine:
1. In the vSphere Web client application, select the VMs and Templates view.
2. On the left pane, locate the virtual XMS.
3. Right-click the XMS and, from the drop-down menu, select Power On.
4. Verify that the XMS has started.

Powering Up the Physical XMS


To power up the physical XMS machine:
1. Verify that the Power button (on the top-right side of the physical XMS, as shown in
Figure 233) is not lit.
Power
Button

Figure 233 Power Button on the Front Panel of the Physical XMS

Note: If the Power button is lit, the XMS is already powered up.
2. Press the Power button to turn on the XMS and wait for it to power up; the buttons
green light illuminates.
3. Verify that the XMS has completed powering up by issuing a PING command to the
XMSs defined IP Address and receiving a successful reply.

346

EMC XtremIO Storage Array User Guide

Cluster Operations

Starting the Cluster


To start the cluster:
1. Locate the relevant cluster and obtain its name and index. Refer to Locating the
Cluster on page 334 for details.
2. Verify that all of the following components in the rack are powered up:
Physical XMS (optional unit)
PDU
Battery Backup Units (powered up and charged)
Storage Controllers
DAEs
InfiniBand Switches (only in multiple X-Brick clusters)
Note: If the last service stop has been due to an unexpected event, such as a power
disruption, the service automatically restarts.
3. Start the cluster, using the GUI (see Starting the Cluster via the GUI on page 337)
and wait for the procedure to complete successfully.
Note: You can also start the cluster, using the CLI. See Starting the Cluster via the CLI
on page 337).

Powering Up the Cluster

347

Cluster Operations

Shutting Down the Cluster - Planned Shutdown


Planned Cluster Shutdown Overview
To Shut down the cluster, carry out the following procedures:
1. Pre-Shutdown Procedure on page 348
2. Shutting Down the Service on page 350
3. Shutting Down the Hardware on page 350

Pre-Shutdown Procedure
Before starting the shutdown procedure, it is important to verify that you are shutting
down the correct cluster. It is also important to verify that no I/O operations are in
progress.
To perform the pre-shutdown procedure:
1. Locate the relevant cluster and obtain its name and index. Refer to Locating the
Cluster on page 334 for details.
2. Run the show-clusters XMCLI command. Review the output to verify the following:
The State parameter is active.
The Conn-State parameter is connected.
xmcli (admin)> show-clusters
Cluster-Name
Index
State
Xbrick167
1
active
Xbrick185
2
active

Conn-State
connected
connected

...
...
...

Note: If the cluster is not active and connected, contact EMC Global Tech Support.

348

EMC XtremIO Storage Array User Guide

Cluster Operations

3. Verify that no I/O requests are sent from the host, as follows:
Verify that user applications are stopped and that any mount points are
dismounted.
Run the following XMCLI command:
show-clusters-performance
xmcli (admin)> show-clusters-performance
Cluster-Name Index Write-BW(MB/s) Write-IOPS Read-BW(MB/s) Read-IOPS BW(MB/s) IOPS
Xbrick1
1
0.000
0
0.000
0
0.000
0

...
...

Verify that all output counters for the relevant cluster display zero, indicating no
I/O requests from the host.
Run the following XMCLI command:
show-targets-performance cluster-id=<cluster name>
xmcli (admin)> show-targets-performance cluster-id="Xbrick1"
Name
Index Write-BW(MB/s) Write-IOPS Read-BW(MB/s) Read-IOPS
X1-SC1-fc1
1
0.000
0
0.000
0
X1-SC1-fc2
2
0.000
0
0.000
0
X1-SC1-iscsi1 5
0.000
0
0.000
0
X1-SC1-iscsi2 6
0.000
0
0.000
0
X1-SC2-fc1
11
0.000
0
0.000
0
X1-SC2-fc2
12
0.000
0
0.000
0
X1-SC2-iscsi1 15
0.000
0
0.000
0
X1-SC2-iscsi2 16
0.000
0
0.000
0

BW(MB/s)
0.000
0.000
0.000
0.000
0.000
0.000
0.000
0.000

IOPS
0
0
0
0
0
0
0
0

Total-Write-IOs
0
0
0
0
0
0
0
0

Total-Read-IOs
0
0
0
0
0
0
0
0

Verify that all output counters display zero, indicating no I/O requests from the
host.
4. Disable Email notifications to prevent shutdown-induced notifications from being sent
to the Email:
1. Run the following XMCLI command to check whether Email Notifications are
enabled on the cluster:
show-email-notifier
2. If Email notifications are enabled, run the following XMCLI command to disable
them:
modify-email-notifier disable
5. Disable SYR notification to prevent shutdown-induced notifications from being sent to
SYR:
1. Run the following XMCLI command to check whether SYR notifications are
configured on the cluster:
show-syr-notifier
2. If SYR notifications are enabled, run the following XMCLI command to disable
them:
modify-syr-notifier disable
Note: You can also disable other notifiers (e.g. SNMP, SYSLOG, etc.).

Shutting Down the Cluster - Planned Shutdown

349

Cluster Operations

Shutting Down the Service


This procedure should be carried out to shut down the service in regular circumstances.
Note: If you need to perform an emergency shutdown, refer to Shutting Down the Cluster
- Emergency Shutdown on page 352.
Note: If the XMS is not accessible, shutting down the service as described in the following
procedure is not possible. An emergency shutdown procedure should be performed
instead. Refer to Shutting Down the Cluster - Emergency Shutdown on page 352.
To shut down the service:
1. Perform the Pre-Shutdown Procedure on page 348.
If the cluster state is stopped, the service is already down and no further action is
required.
If the state is active, proceed to the next step.
If the state is other than stopped or active, contact EMC Global Tech Support,
due to a risk of data loss.
2. Stop the cluster, using the GUI (see Stopping the Cluster via the GUI on page 334)
and wait for the procedure to complete successfully.
Note: You can also stop the cluster, using the CLI. See Stopping the Cluster via the
CLI on page 336).

Shutting Down the Hardware


To shut down the hardware:
1. Verify that the service is shut down properly, as per the instructions in Shutting Down
the Service on page 350.


If the service is not shut down properly, data loss may occur upon shutting down the
hardware.
2. Power off the cluster, using the GUI (see Powering Off the Cluster via the GUI on
page 338).
Note: You can also power off the cluster, using the CLI. See Powering Off the Cluster
via the CLI on page 339.

350

EMC XtremIO Storage Array User Guide

Cluster Operations

3. Turn off the clusters power supply by turning off the rack's PDU (to which the cluster is
connected).
Note: Make sure that no other equipment is connected to the PDU.
4. Power off the Battery Backup Unit by pressing its power button.
Note: If you wish to start the cluster, refer to Starting the Cluster on page 347 for details.

Shutting Down the XMS


To shut down the XMS, proceed as follows:

If the cluster uses a virtual XMS machine, follow the instructions for Shutting Down
the Virtual XMS on page 351.
If the cluster uses a physical XMS machine, follow the instructions for Shutting Down
the Physical XMS on page 351.

Shutting Down the Virtual XMS


To shut down the virtual XMS machine:
1. In the vSphere Web client application, select VMs and Templates.
2. On the left pane, locate the virtual XMS.
3. Right-click the XMS and select Shut Down Guest OS.
4. Verify that the XMS is stopped.

Shutting Down the Physical XMS


To shut down the physical XMS machine:
1. Verify that the Power button (located on the top-right side of the physical XMS) is lit.
Power
Button

Figure 234 Power Button on the Front Panel of the Physical XMS

Note: If the Power button is not lit, the XMS is already shut down.
2. Power off the XMS by running the following XMCLI command:
shutdown-xms shutdown-type=machine
Alternatively, you can turn the XMS off by pressing the Power button (see Figure 234).

Shutting Down the Cluster - Planned Shutdown

351

Cluster Operations

Shutting Down the Cluster - Emergency Shutdown


This procedure should only be carried out to power off the cluster in an emergency
situation, where it is not possible to power off the cluster via the XMS.
Note: If possible, it is recommended to power off the cluster via the XMS, as described in
Shutting Down the Cluster - Planned Shutdown on page 348.
To physically power off the cluster in case of an emergency:
1. Press the power button of at least two Storage Controllers simultaneously for five
seconds, to stop the cluster service and power off the Storage Controllers.
Note: If the cluster is connected to ESRS, a dial-home is sent to EMC, indicating that
the cluster has performed an emergency shutdown. A member of the EMC Global Tech
Support will contact you for follow-up.
2. Check the status of the orange LED indicators of all DAEs and SSDs.
If the orange LED indicators of all DAEs and SSDs start to blink, perform the
following steps:
1. Wait for the orange LED indicators of all DAEs and SSDs to stop blinking
(approximately five minutes). This time period allows the cluster to harden the
volatile data on disks.


Do not disconnect the power at this stage. If the cluster is not given the required
time to secure the volatile data on the disks, data loss may occur upon shutting
down the hardware.
2. Wait for the blue LED indicators of the Storage Controllers (ID LEDs) to blink.
3. Wait for the Storage Controllers green LED indicators (Power LEDs) to turn off.
Note: At this point, the Storage Controllers blue ID LEDs are still blinking.
4. When the Storage Controllers Power LEDs are turned off, disconnect the power
from the system by powering down the racks PDUs.
Note: Make sure that no other equipment is connected to the PDUs.
5. Skip to step 3 , to power off the Battery Backup Unit and complete the
shutdown procedure.

352

EMC XtremIO Storage Array User Guide

Cluster Operations

If the orange LED indicators of all DAEs and SSDs do not start blinking within a ten
seconds time frame, perform the following steps:
1. Pull out the two DAE power cables of X-Brick 1 (usually the lowest X-Brick in the
rack) from their ports, as shown in Figure 235.

Figure 235 Power Connection Ports on the Rear Side of the DAE

2. Wait for five minutes to allow the cluster to harden the volatile data on disks.


If the cluster is not given the required time to secure the volatile data on the disks,
data loss may occur upon shutting down the hardware.
3. Disconnect the power from the cluster by powering down the racks PDUs.
Note: Make sure that no other equipment is connected to the PDUs.
3. Power off the Battery Backup Units in the XtremIO cluster by pressing the power button
on each BBU.
Note: If you wish to power up the cluster, refer to Powering Up the Cluster after an
Emergency Shutdown on page 340 for details.

Shutting Down the Cluster - Emergency Shutdown

353

Cluster Operations

Changing the IP Configurations


Changing the IP Configurations in a Single Cluster Environment
This section describes how to change the cluster and XMS IP addresses in the following
scenarios:

Cluster is neither physically relocated nor moved to another IP network.

Cluster is not physically relocated but is moved to another IP network.

Cluster is physically relocated and moved to another IP network.

Note: Before changing the IP configurations, verify that the IP addresses are correct and
reachable in the new location scheme.

Cluster is Neither Physically Relocated Nor Moved to Another IP Network


To change the IP configurations of the cluster and XMS, when the cluster is neither
physically relocated nor moved to another IP network:
1. Log in to the XMCLI as admin.
2. Run the show-storage-controllers command to view the existing Storage
Controllers and their respective index numbers.
xmcli (admin) > show-storage-controllers
Storage-Controller-Name Index Mgr-Addr
... State
X1-SC1
1
10.75.220.10 ... healthy
X1-SC2
2
10.75.217.10 ... healthy

Health-State Enabled-State Conn-State


healthy
enabled
connected
healthy
enabled
connected

...
...
...

3. Run the modify-ip-addresses XMCLI command to modify the Management IPs of


the XMS and Storage Controllers.
Note: The example below demonstrates how to use the modify-ip-addresses
command on a cluster with two Storage Controllers. To use the command on a cluster
with a larger number of Storage Controllers, add the additional IP addresses to the list.
Use the Storage Controllers respective index numbers as they appear in the
show-storage-controller command output.
Usage: modify_ip_addresses property=value list
PROPERTY
MANDATORY
DESCRIPTION
VALUE
-------------------------------------------------------------------------------------------------------------cluster-id
No
Cluster ID
id:name or index
sc-gw-addr
One from Group 1
Storage Controller Gateway Address
IP Address
sc-ip-list
One from Group 1
Storage Controller List
[sc-id=value sc-ip-sn="value" ...]
xms-gw-addr
One from Group 1
XMS Gateway Address
IP Address
xms-ip-sn
One from Group 1
XMS IP/Subnet
IP Address/Subnet

354

EMC XtremIO Storage Array User Guide

Cluster Operations

For example:
xmcli (admin)> modify-ip-addresses sc-ip-list=[sc-id=1
sc-ip-sn="10.76.219.133/20",sc-id=2 sc-ip-sn="10.76.219.134/20"]
xms-ip-sn="10.76.208.77/20" rollback
ATTENTION: XMS can lose connection to nodes.
Are you sure you want to modify IP settings? (Yes/No): yes
16:21:44 - Modifiying IPs. Command will take approximately 135 seconds to complete.
16:21:44 - Changing XMS IP. CLI will disconnect. Please reconnect momentarily to
the new IP 10.76.208.77 (or old IP 10.76.208.76 in case of failure).
16:21:49 - Checking connection to SYM
Done!
xmcli was terminated by the XMS
Note: If the XMS and SYM addresses are wrong, the cluster reverts to the old
configuration.
Note: If the IP address for one of the Storage Controllers is wrong, run the
modify-ip-addresses command again with the correct address.
4. Run the following CLI commands to verify that the IP configurations are changed
successfully and that Storage Controllers are healthy and connected:
show-xms
xmcli (admin) > show-xms
Name Index
SW-Version
xms 1
4.0.0-xxx

Xms-IP-Addr
10.76.208.77

Xms-Mgmt-Ifc
eth0

REST-API-Protocol-Version IP-Version
2.0
ipv4

...
...

show-storage-controllers
xmcli (admin) > show-storage-controllers
Storage-Controller-Name Index Mgr-Addr
... State
X1-SC1
1
10.76.219.133 ... healthy
X1-SC2
2
10.76.208.77 ... healthy

Health-State Enabled-State Conn-State


healthy
enabled
connected
healthy
enabled
connected

...
...
...

Make a note of the Storage Controllers names and IDs as they appear in the output (to
be used in step 6 ).
5. Run the show-clusters CLI command to verify that the cluster is active and
connected.
xmcli (admin)> show-clusters
Cluster-Name
Index
State
Xbrick1
1
active

Gates-Open
true

Conn-State
connected

...
...

Changing the IP Configurations

355

Cluster Operations

6. For each Storage Controller, run the rename CLI command to modify the Storage
Controllers name to a temporary name, and then run the rename command again to
reassign the Storage Controller with the original name.
xmcli (admin)> rename new-name="dummy" sc-id=1
Object X1-SC1 [1] renamed to dummy
xmcli (admin)> rename new-name="X1-SC1" sc-id=1
Object dummy [1] renamed to X1-SC1
xmcli (admin)> rename new-name="dummy" sc-id=2
Object X1-SC2 [2] renamed to dummy
xmcli (admin)> rename new-name="X1-SC2" sc-id=2
Object dummy [2] renamed to X1-SC2

Note: The example above demonstrates how to use the rename command to rename
two Storage Controllers. In a cluster with more than two Storage Controllers, run the
rename command twice for each Storage Controller (to change the name to a
temporary name and then back to the original name), using the Storage Controllers
respective index number as it appears in the show-storage-controller
command output.

Cluster is Not Physically Relocated But is Moved to Another IP Network


The procedure for moving the cluster to another IP network without physically relocating it,
is to be performed only by EMC approved technical personnel.
To move the cluster to another IP network, without physically relocating it, contact EMC
Global Tech Support.

Cluster is Physically Relocated and Moved to Another IP Network


The procedure for physically relocating the cluster and moving it to another IP network is
to be performed only by EMC approved technical personnel.
To physically relocate the cluster and move it to another IP network, contact EMC Global
Tech Support.

356

EMC XtremIO Storage Array User Guide

Cluster Operations

Changing the IP Configurations in a Multiple Cluster Environment


This section describes how to change the cluster and XMS IP addresses in a multiple
cluster environment. The following scenarios are described:

Cluster is neither physically relocated nor moved to another IP network.

Cluster is not physically relocated but is moved to another IP network.

Cluster is physically relocated and moved to another IP network.

Note: Before changing the IP configurations, verify that the IP addresses are correct and
reachable in the new location scheme.

Cluster is Neither Physically Relocated nor Moved to Another IP Network


To change the IP configurations of the cluster and XMS, when cluster is neither physically
relocated nor moved to another IP network:
1. Log in to the XMCLI as admin.
2. Run the show-storage-controllers command to view the existing Storage
Controllers and their respective index number.
xmcli (admin) > show-storage-controllers
Storage-Controller-Name Index Mgr-Addr
X1-SC1
1
10.76.219.130
X1-SC2
2
10.76.219.131
X2-SC1
1
10.76.219.50
X2-SC2
2
10.76.219.51

Cluster-Name
cluster12
cluster12
cluster10
cluster10

Index State
1
healthy
1
healthy
2
healthy
2
healthy

Health-State
healthy
healthy
healthy
healthy

Enabled-State
enabled
enabled
enabled
enabled

Conn-State
connected
connected
connected
connected

..
..
..
..
..

3. For each cluster, run the modify-ip-addresses XMCLI command to modify the
Storage Controllers IP addresses.
Note: The cluster-id parameter can be found listed under the Index column in
the show-clusters command.
Note: The example below demonstrates how to use the modify-ip-addresses
command on a cluster with two Storage Controllers. To use the command on a cluster
with a larger number of Storage Controllers, add the additional IP addresses to the list.
Use the Storage Controllers respective index numbers as they appear in the
show-storage-controller command output.

Usage: modify_ip_addresses property=value list


PROPERTY
MANDATORY
DESCRIPTION
VALUE
-------------------------------------------------------------------------------------------------------------cluster-id
No
Cluster ID
id:name or index
sc-gw-addr
One from Group 1
Storage Controller Gateway Address
IP Address
sc-ip-list
One from Group 1
Storage Controller List
[sc-id=value sc-ip-sn="value" ...]
xms-gw-addr
One from Group 1
XMS Gateway Address
IP Address
xms-ip-sn
One from Group 1
XMS IP/Subnet
IP Address/Subnet

Changing the IP Configurations

357

Cluster Operations

For example:
xmcli (admin)> modify-ip-addresses cluster-id="Cluster12" sc-ip-list=[sc-id=1
sc-ip-sn="10.76.219.133/20",sc-id=2 sc-ip-sn="10.76.219.134/20"] rollback
ATTENTION: XMS can lose connection to nodes.
Are you sure you want to modify IP settings? (Yes/No): yes
16:02:26 - Modifiying IPs. Command will take approximately 135 seconds to complete.
16:02:26 - Updating XMS IPs.
16:02:26 - Checking connection to SYM.
Done!
Modify IP completed successfully
Name: xms
Index: 1
Xms-IP-Addr: 10.76.208.77
Xms-GW-Addr: Name: 10.76.208.1
Storage-Controller-Name Index Cluster-Name Index Mgr-Addr-Subnet MGMT-GW-IP
X1-SC1 Name:
1
Cluster12
1
10.76.219.133/20 10.76.219.1
X1-SC2 Name:
2
Cluster12
1
10.76.219.134/20 10.76.219.1
4. When the IP addresses of all Storage Controllers are modified, run the
modify-ip-addresses XMCLI command to modify the XMS IP address.
Note: The cluster-id parameter can be found listed under the Index column in
the show-clusters command output. You can specify any cluster of the multiple
cluster setting.
xmcli (admin)> modify-ip-addresses cluster-id="Cluster12"
xms-ip-sn="10.76.208.77/20" xms-gw-addr="10.76.208.1"
ATTENTION: XMS can lose connection to nodes.
Are you sure you want to modify IP settings? (Yes/No): yes
15:56:11 - Modifiying IPs. Command will take approximately 135 seconds to complete.
15:56:11 - Changing XMS IP. CLI will disconnect. Please reconnect momentarily to
the new IP 10.76.208.77 (or old IP 10.76.208.76 in case of failure).
Done!
xmcli was terminated by the XMS
5. Run the show-storage-controllers XMCLI command to verify that the IP
configurations are changed successfully and that the Storage Controllers are healthy
and connected.
xmcli (admin) > show-storage-controllers
Storage-Controller-Name Index Mgr-Addr
X1-SC1
1
10.76.219.133
X1-SC2
2
10.76.219.134
X2-SC1
1
10.76.219.53
X2-SC2
2
10.76.219.54

Cluster-Name
cluster12
cluster12
cluster10
cluster10

Index State
1
healthy
1
healthy
2
healthy
2
healthy

Health-State
healthy
healthy
healthy
healthy

Enabled-State
enabled
enabled
enabled
enabled

Conn-State
connected
connected
connected
connected

..
..
..
..
..

Make a note of the Storage Controllers names and IDs as they appear in the output (to
be used in step 8 ).

358

EMC XtremIO Storage Array User Guide

Cluster Operations

6. Run the show-xms XMCLI commands to verify that the XMS IP is changed
successfully.
xmcli (admin) > show-xms
Name Index
SW-Version
xms 1
4.0.0-xxx

Xms-IP-Addr
10.76.208.77

Xms-Mgmt-Ifc
eth0

REST-API-Protocol-Version IP-Version
2.0
ipv4

...
...

7. Run the show-clusters CLI command to verify that the IP configurations are
changed successfully.
xmcli (admin)> show-clusters
Cluster-Name
Index
State
cluster12
1
active
cluster10
2
active

Gates-Open
true
true

Conn-State
connected
connected

...
...
...

Make sure that each clusters status is active and connected.


Note: If the IP address for one of the Storage Controllers is wrong (provided it is not the
SYM address), run the modify-ip-addresses command again with the correct
address.
8. For each Storage Controller, run the rename CLI command to modify the Storage
Controllers name to a temporary name, and then run the rename command again to
reassign the Storage Controller with the original name.
xmcli (admin)> rename new-name="dummy" sc-id=1 cluster-id="Cluster12"
Object X1-SC1 [1] renamed to dummy
xmcli (admin)> rename new-name="X1-SC1" sc-id=1 cluster-id="Cluster12"
Object dummy [1] renamed to X1-SC1
xmcli (admin)> rename new-name="dummy" sc-id=2 cluster-id="Cluster12"
Object X1-SC2 [2] renamed to dummy
xmcli (admin)> rename new-name="X1-SC2" sc-id=2 cluster-id="Cluster12"
Object dummy [2] renamed to X1-SC2
xmcli (admin)> rename new-name="dummy" sc-id=1 cluster-id="Cluster10"
Object X1-SC1 [1] renamed to dummy
xmcli (admin)> rename new-name="X2-SC1" sc-id=1 cluster-id="Cluster10"
Object dummy [1] renamed to X1-SC1
xmcli (admin)> rename new-name="dummy" sc-id=2 cluster-id="Cluster10"
Object X1-SC2 [2] renamed to dummy
xmcli (admin)> rename new-name="X2-SC2" sc-id=2 cluster-id="Cluster10"
Object dummy [2] renamed to X1-SC2

Note: The example above demonstrates how to use the rename command to rename
four Storage Controllers in a two cluster setting. In a cluster with more than two
Storage Controllers, run the rename command twice for each Storage Controller (to
change the name to a temporary name and then back to the original name), using the
Storage Controllers respective index number as it appears in the
show-storage-controller command output.

Changing the IP Configurations

359

Cluster Operations

Cluster is Not Physically Relocated But is Moved to Another IP Network


The procedure for moving the cluster to another IP network without physically relocating it,
is to be performed only by EMC approved technical personnel.
To move the cluster to another IP network, without physically relocating it, contact EMC
Global Tech Support.

Cluster is Physically Relocated and Moved to Another IP Network


The procedure for physically relocating the cluster and moving it to another IP network, is
to be performed only by EMC approved technical personnel.
To physically relocate the cluster and move it to another IP network, contact EMC Global
Tech Support.

Updating the ESRS Configurations


If ESRS is used, the ESRS configurations should be updated by EMC Global Tech Support
personnel after changing the XMS IP addresses.
To update the ESRS configurations, contact the EMC Global Tech Support.

Updating the XMS NTP Server Address


This procedure configures the time zone and updates the XMS NTP time sync service with
the new NTP server(s).
To update the XMS NTP Server Address:
1. Log in to the XMCLI as admin.
2. Use the modify-datetime XMCLI command to set the time zone.
xmcli (admin)> modify-datetime timezone=US/Eastern
Cluster time is now: 2013-10-24 16:30:12 EDT
3. Use the modify-datetime XMCLI command to set the new NTP server address(es)
on the XMS.
xmcli (admin)> modify-datetime
ntp-servers=["10.10.10.20","10.10.10.30"]
Replace the current ntp-server list:[10.10.10.20,10.10.10.30]?
Yes/No: Yes
Syncing to time servers: [10.10.10.20,10.10.10.30]

Note: It may take up to one hour for clocks to sync.


4. Run the show-datetime XMCLI command to verify that the clocks are synchronized.
xmcli (admin)> show-datetime
Mode
NTP-Servers Cluster-Time
Cluster-Time-Zone
Automatic
10.10.10.20 2014-10-23 16:30:12 EST US/Eastern
o
10.10.10.30

360

EMC XtremIO Storage Array User Guide

Cluster Operations

Setting the Cluster Time and Date


It is recommended to use an NTP server to synchronize date and time across the cluster.
However, you can disable the NTP server synchronization by setting the clusters date and
time manually.
To set the clusters date and time manually:
1. Log in to the XMCLI as admin.
2. Use the modify-datetime XMCLI command to set the time zone (if needed).
xmcli (admin)> modify-datetime timezone=US/Eastern
Cluster time is now: 2014-12-11 16:30:12 EST
3. Use the modify-datetime XMCLI command to manually set the date and time.
xmcli (admin)> modify-datetime datetime="2014-12-10 17:32:41"

Cluster time is now: 2014-12-10 17:32:41 EST


4. Run the show-datetime XMCLI command and verify that the mode is set to Manual,
indicating that the NTP server synchronization is disabled:
xmcli (admin)> show-datetime
Mode
NTP-Servers Cluster-Time
Cluster-Time-Zone
Manual
2014-12-10 17:32:48 EST US/Eastern

Setting the Cluster Time and Date

361

Cluster Operations

Managing the Virtual XMS


Deploying a Virtual XMS
Note: For Virtual XMS requirements, refer to the XtremIO Storage Array Site Preparation
Guide.
An OVA image (VMware template machine file type), which includes all required packages
for installing the XMS, is provided.
To install a virtual XMS in preparation for the XtremIO cluster installation, opt to deploy the
OVA template.
Note: If you choose not to deploy the OVA template, the deployment will be performed as
part of the cluster installation procedure.
To deploy an OVA image:
1. Access the EMC Support page for XtremIO.
2. Download the OVA Template. For details on which OVA Template to download from the
Support page, refer to the XtremIO Storage Array Release Notes of the version you are
installing.
Note: Before proceeding, access the EMC Support page and verify that the MD5
checksum of the package you downloaded matches the MD5 checksum that appears
in the support page for that package.
3. Log in to the vCenter Server, using the vSphere Web Client.
4. Select an inventory object that is a valid parent object of the virtual XMS machine (e.g.
datacenter, folder, cluster, resource pool or host).

362

EMC XtremIO Storage Array User Guide

Cluster Operations

5. Select Actions > All vCenter Actions > Deploy OVF Template.

Figure 236 Deploy OVA Image

6. On the 1a Select Source pane, click Local file and then click Browse.
7. Select the XMS OVA template and click Next.

Figure 237 Display OVA Template

8. On the 1b Review Details pane, review the details of the OVA Template and click Next.
9. On the 2a Select Name and Folder pane, type a name for the virtual XMS and select a
destination folder and click Next.
10. On the 2b Select a Resource pane, select a server/cluster to run the virtual XMS and
click Next.
11. On the 2c Select Storage pane, select a datastore to provision the virtual XMS.
12. From the Select virtual disk format drop-down list, select Thin Provision disk format for
the XMSs virtual disk and click Next.
Note: It is recommended to deploy a virtual machine with Thin Provision settings to
ensure that the XMS does not consume more space than it actually requires. With
XtremIO version 4.0 and above, 200GB of disk capacity are pre-allocated for the
virtual XMS, following cluster initialization.

Managing the Virtual XMS

363

Cluster Operations

13. On the 2d Select networks pane, configure the network used for the virtual XMS and
click Next.
14. On the 3 Ready to complete pane, verify that the virtual XMS VM that is about to be
created meets (or exceeds) the following requirements:
Parameter

Value

RAM

8GB capacity

CPU

2 X vCPU

NIC

1 X vNIC

Virtual HD

Single HD with 900GB capacity (recommended (thin-provisioned)

15. Click Finish to deploy the template.


16. Connect to the virtual XMS via a physical console, using a pre-defined IP address or a
vShere Web Client console.

Relocating a Virtual XMS


Once a virtual XMS has been deployed, it can be relocated to another ESX server and/or
virtual storage location. Relocation of the virtual XMS can be achieved seamlessly without
disrupting the cluster or virtual XMS, by leveraging VMware vSphere to preform either a
vMotion or Storage vMotion function.
All virtual XMS requirements must be met in full for the ESX server and virtual storages
new destination, including protected shared storage (for details, see the XtremIO Storage
Array Site Preparation Guide).
Note: It is very important to ensure that the new destination location of the virtual storage
for the virtual XMS does not originate from an XtremIO cluster.

Restoring Access to the Virtual XMS


The Virtual XMS should be deployed on a thin provisioning virtual disk. Storage capacity
for the virtual XMS is allocated on demand rather than all in advance. Refer to the XtremIO
Storage Array Site Preparations Guide for details on the required storage resources for the
Virtual XMS.
As a result, the Virtual XMS may encounter a scenario in which the datastore it is deployed
on is full because it was fully consumed by other virtual machines deployed on the same
datastore as the Virtual XMS.
When the ESX host detects such a state, it suspends the Virtual XMS and displays a
warning indicating that no more disk space is available for the Virtual XMS. The warning is
displayed on the vCenter Server webUI.

364

EMC XtremIO Storage Array User Guide

Cluster Operations

Figure 238 Virtual Disk Full Warning

At this point the Virtual XMS is suspended and there is no access to any XtremIO
management interface that is executed from the XMS (e.g. CLI, GUI, RESTful API and SSH).
However, there is no impact on cluster service on any of the clusters that are connected to
the affected Virtual XMS.
The following procedure is used to restore access to the Virtual XMS.
To restore access to the virtual XMS:
1. Take steps to free disk space on the affected datastore (e.g. by removing other virtual
machines that are no longer needed from the datastore). Alternatively, you can extend
the datastore by allocating additional storage resources to it.
2. If additional time is required, select the Cancel option on the displayed warning and
click OK; the virtual XMS is powered off due to the lack of free disk space on the
affected datastore.
Note: Trying to power up a Virtual XMS when the datastore it is deployed on is full, will
fail with an error.

Figure 239 Power Virtual Machine Failure Message

3. When there is sufficient free disk space and the XMS is suspended, select the Retry
option on the displayed warning and click OK to resume the Virtual XMS operation. If
the Virtual XMS is powered off, power it up, using vSphere webUI. At this point access
to all XMS interfaces is resumed.

Managing the Virtual XMS

365

Cluster Operations

Refreshing the Unique SSH Key


The XtremIO clusters are shipped from the factory with a default SSH key, enabling root
access from the XMS to the Storage Controllers, from the Storage Controllers to the XMS
and between Storage Controllers.
If you wish to generate a new, unique SSH key for the cluster you are working with, run the
following CLI command after completion of cluster installation and creation:
refresh-xms-ssh-key
Note: Running this command creates the same SSH key for all clusters managed by the
same XMS.
When running the command in a multi-cluster setting, if not all clusters are available, a
warning is issued, listing the clusters for which the SSH key was not changed. In this case,
wait for all the clusters to become available and run the command again, resulting in a
new key to be generated for all clusters.
If a cluster with a unique SSH key is removed from an XMS and added to a new XMS that
has a default SSH key, the added cluster is assigned with the same default XMS SSH key
as that of all other clusters managed by the XMS.

366

EMC XtremIO Storage Array User Guide

CHAPTER 10
CLI Guide
This chapter includes the following topics:

Using the Command Line Interface (CLI) ................................................................


Objects Naming Limitations ..................................................................................
Completion Codes.................................................................................................
CLI Commands Quick Finder ..................................................................................
General .................................................................................................................
Maintenance.........................................................................................................
Troubleshooting....................................................................................................
Administration ......................................................................................................
Provisioning ..........................................................................................................
Cluster Data and Status.........................................................................................

CLI Guide

368
370
371
372
380
382
411
415
440
475

367

CLI Guide

Using the Command Line Interface (CLI)


You can manage and monitor the XtremIO Storage Array, using the CLI.
You can access the CLI via:

The GUI (see Accessing the CLI via the GUI on page 368)

An SSH client (see Accessing the CLI via an SSH Client on page 369)

An SSH key authentication (see Accessing the CLI via an SSH Key Authentication on
page 369)

Accessing the CLI via the GUI


To access the CLI through the GUI:
1. From the main menu, select Administration.
2. From the left pane, select CLI Terminal; the CLI Terminal screen appears, as shown in
Figure 240, allowing you to run CLI commands according to your users role.

Figure 240 CLI Terminal Pane

368

EMC XtremIO Storage Array User Guide

CLI Guide

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 Managing User Accounts, Using the GUI on page 308); the
XMCLI session prompt appears, allowing you to run only XMCLI commands according
to your users role.

Figure 241 CLI Terminal - Session Prompt

Accessing the CLI via an SSH Key Authentication


An administrator may register a user account via an SSH Key Authentication which does
not require credentials to log in.
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 users 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 Command Line Interface (CLI)

369

CLI Guide

Objects Naming Limitations


Volume 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: ~ ! @ # $ % ^ * _ + { } | : ? . -

370

Invalid characters: & / < > ( )

EMC XtremIO Storage Array User Guide

CLI Guide

Completion Codes
The following table contains a list of general completion codes that can be issued 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
or

The management server cannot communicate with the cluster,


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.

Completion Codes

371

CLI Guide

CLI Commands Quick Finder

372

Command

Description

Page

acknowledge-alert

Acknowledges an alert and removes it from the active


alerts list.

478

activate-storage-controller

Activates a replaced or non-active Storage Controller.

388

add-cluster

Adds a cluster to the list of clusters managed by the


XMS.

382

add-event-handler-definition

Adds a definition to an event handling rule.

475

add-initiator

Adds an Initiator and associates it with an existing


Initiator Group.

460

add-initiator-group

Adds an Initiator Group and its associated Initiators to


the XtremIO cluster.

456

add-iscsi-portal

Maps a portal to a Target.

470

add-iscsi-route

Adds and configures iSCSI route parameters.

470

add-ldap-config

Adds a new LDAP configuration profile to the LDAP


configuration table.

417

add-ssd

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

387

add-user-account

Adds a new user account.

415

add-volume

Configures and adds a new Volume.

442

add-volume-to-consistency-gr Adds a Volume to a Consistency Group.


oup

453

assign-ssd

Assigns an existing SSD to a Data Protection Group.

387

clear-volume-reservation

Removes LUN reservations to release them for access.

450

control-led

Turns an indicator LED on or off.

391

create-consistency-group

Creates a new Consistency Group.

454

create-debug-info

Creates a debug archive log collection.

413

modify-ip-addresses

Establishes an IP link to a remote cluster.

438

create-scheduler

Creates a new Snapshot Scheduler.

463

create-server-certificate-signi
ng-request

Instructs the server to generate a public-private key


pair and a certificate signing request.

420

create-snapshot

Creates a Snapshot from a specified Volume.

447

create-snapshot-and-reassig
n

Creates a Snapshot from a specified


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

448

create-tag

Creates a new Tag for a specified entity.

440

deactivate-storage-controller

Deactivates an active Storage Controller.

389

exit

Closes the CLI terminal.

380

export-performance-history

Exports the clusters performance history to CSV file.

481

EMC XtremIO Storage Array User Guide

CLI Guide

Command

Description

Page

help

Displays the available CLI commands.

380

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


ficate

421

map-lun

Maps a Volume to an Initiator Group and assigns a


Logical Unit Number (LUN) to it.

468

modify-alert-definition

Modifies alert definition properties for a specified


alert type.

478

modify-chap

Modifies the CHAP configuration parameters.

473

modify-consistency-group-vol
umes

Modifies the Volume type for the specified a


Consistency Group.

455

modify-clusters-parameters

Modifies various cluster parameters.

422

modify-cluster-thresholds

Modifies the properties for thin provisioning soft


limits for the connected clusters.

422

modify-datetime

Sets or modifies the clusters date and time,


timezone, or NTP server parameters.

430

modify-dns-servers

Sets or modifies the IP address of the primary and


secondary DNS servers.

419

modify-email-notifier

Modifies the email notification settings.

432

modify-eth-port

Modifies the Ethernet port of the cluster.

412

modify-event-handler-definiti
on

Modifies the definition of event handling rules.

475

modify-initiator

Modifies the properties of an existing Initiator.

461

modify-ip-addresses

Modifies the XMS networking configuration.

438

modify-iscsi-portal

Modifies an iSCSI portal parameters.

470

modify-ldap-config

Modifies an LDAP configuration profile.

418

modify-login-banner

Enables customization of the login banner text.

430

modify-password

Modifies the users password.

416

modify-scheduler

Modifies a Snapshot Schedulers parameters.

464

modify-server-certificate

Initiates loading of a signed certificate and a key.

421

modify-server-name

Defines or modifies the XMSs URL.

430

modify-snmp-notifier

Modifies the SNMP notification settings.

434

modify-ssh-firewall

Modifies the lock mode of the SSH firewall.

425

modify-syr-notifier

Modifies the ESRS (EMC Secure Remote Support)


notification parameters.

436

modify-syslog-notifier

Sets or modifies the Syslog notifier list.

437

modify-tag

Modifies a specified Tags caption.

440

modify-target

Modifies a Targets parameters.

466

modify-target-group

Modifies a Target Groups parameters.

468

CLI Commands Quick Finder

373

CLI Guide

374

Command

Description

Page

modify-technician-port-tunne
l

Opens or closes a Tech port tunnel to a specific


Storage Controller.

386

modify-user-account

Modifies the user-account parameters.

415

modify-volume

Modifies a Volumes parameters.

443

modify-webui

Enables or disables the XtremIO WebUI technology


preview mode.

431

modify-xms-parameters

Modifies the XMSs user inactivity timeout.

429

power-off

Powers off a Storage Controller or an entire cluster.

392

power-on

Powers up a Storage Controller.

392

quit

Closes the CLI terminal.

380

refresh-xms-ssh-key

Generates a new unique SSH key on the XMS and


updates all related clusters accordingly.

427

remove-cluster

Removes a cluster from the list of clusters managed


by the XMS.

382

remove-consistency-group

Deletes a Consistency Group.

454

remove-debug-info

Deletes the debug info file.

413

remove-event-handler-definiti Deletes event handling rule definitions.


on

475

remove-initiator

Deletes an Initiator.

460

remove-initiator-group

Deletes an Initiator Group.

457

modify-ip-addresses

Deletes an IP link to a remote cluster.

438

remove-iscsi-portal

Deletes a portal mapping from a Target.

471

remove-iscsi-route

Deletes an iSCSI routing configuration.

471

remove-ldap-config

Deletes an LDAP configuration profile from the LDAP


configuration table.

417

remove-scheduler

Deletes a Snapshot Scheduler from the Scheduler list.

464

remove-snapshot-set

Deletes a Snapshot Set from the Snapshot Set list.

451

remove-ssd

Removes an SSD from a Data Protection Group.

387

remove-tag

Deletes a Tag from the tags list.

440

remove-user-account

Deletes a user account from the user account list.

415

remove-volume

Deletes a Volume from the Volumes list.

443

remove-volume-from-consiste Removes a Volume from a Consistency Group.


ncy-group

454

rename

Renames a component of the XtremIO Storage Array.

381

restart-xms

Restarts the XtremIO management system.

393

resume-scheduler

Resumes the activity of a suspended Scheduler.

464

send-email-notification

Sends an Email notification.

432

EMC XtremIO Storage Array User Guide

CLI Guide

Command

Description

Page

send-snmp-notification

Sends an SNMP notification.

434

send-syr-notification

Sends a predefined ESRS (EMC Secure Remote


Support) information notification.

436

set-context

Sets a cluster context in a multiple cluster


environment and renders the need to specify the
cluster ID unnecessary.

425

show-alert-definitions

Displays a list of pre-defined alerts and their


definitions.

479

show-alerts

Displays a list of active alerts and their details.

480

show-bbus

Displays the Battery Backup Units information.

390

show-bricks

Displays a list of X-Bricks and their associated Cluster.

391

show-chap

Displays the Clusters configured CHAP authentication


and discovery modes.

472

show-clusters

Displays the main properties and the status of


connected clusters.

383

show-clusters-data-protectio
n-properties

Displays the Clusters data protection properties.

422

show-clusters-info

Displays additional information on the connected


Clusters.

423

show-clusters-parameters

Displays the parameters of the selected Cluster.

424

show-clusters-performance

Displays the Clusters performance data.

482

show-clusters-performance-la Displays the Clusters performance latency data.


tency

482

show-clusters-performance-s
mall

Displays the Clusters performance data for small


(under 4KB) blocks.

483

show-clusters-performance-u
naligned

Displays the Clusters performance data for unaligned


blocks.

484

show-clusters-savings

Displays savings parameters of the selected Cluster.

424

show-clusters-thresholds

Displays thin provisioning soft limits for the


connected Clusters.

425

show-clusters-upgrade

Displays the Clusters software upgrade status.

384

show-clusters-upgrade-progr
ess

Displays indicators of the Clusters software upgrade


progress.

385

show-consistency-group

Displays the specified Consistency Groups


parameters.

455

show-consistency-groups

Displays all defined Consistency Groups parameters.

456

show-daes

Displays the Clusters DAE information.

394

show-daes-controllers

Displays the list of DAE controllers and their


properties.

395

show-daes-psus

Displays the list of DAE power suppliers and their


properties.

396

CLI Commands Quick Finder

375

CLI Guide

376

Command

Description

Page

show-data-protection-groups

Displays XDP groups status and information.

474

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


information.
performance

501

show-datetime

Displays the Clusters time-related information.

429

show-debug-info

Displays debug information created using


create-debug-info command.

414

show-discovered-initiators-co Displays the Initiators-Targets connectivity map.


nnectivity

411

show-dns-servers

Displays the IP addresses of the primary and


secondary DNS servers (if configured).

420

show-email-notifier

Displays the Email notification settings.

433

show-event-details

Displays the details of the specified event.

476

show-event-handler-definitio
ns

Displays the event handling rule definitions.

476

show-events

Displays the Clusters events.

477

show-infiniband-switches

Displays InfiniBand Switches information.

397

show-infiniband-switches-por Displays InfiniBand Switches port information.


ts

398

show-infiniband-switches-ps
us

Displays InfiniBand Switches PSUs information

399

show-initiator-group

Displays information for a specific Initiator Group.

457

show-initiator-groups

Displays information for all Initiator Groups.

458

show-initiator-groups-perfor
mance

Displays Initiator Groups performance data.

485

show-initiator-groups-perfor
mance-small

Displays Initiator Groups performance data for small


(under 4KB) blocks.

486

show-initiator-groups-perfor
mance-unaligned

Displays Initiator Groups performance data for


unaligned blocks.

487

show-initiators

Displays Initiators data.

462

show-initiators-connectivity

Displays Initiators-port connectivity and the number


of connected Targets.

411

show-initiators-performance

Displays Initiators performance data.

488

show-initiators-performancesmall

Displays Initiators performance data for small (under


4KB) block sizes.

489

show-initiators-performanceunaligned

Displays Initiators performance data for unaligned


data block.

490

show-ip-addresses

Displays the XMS networking configuration, including


IP addresses, network mask and default GW.

439

show-iscsi-portals

Displays the list of iSCSI portals and their properties.

471

show-iscsi-routes

Displays the list of iSCSI routes and their properties.

472

EMC XtremIO Storage Array User Guide

CLI Guide

Command

Description

Page

show-ldap-configs

Displays the LDAP server configuration parameters.

419

show-leds

Displays the values for the identification and status


LEDs.

401

show-local-disks

Displays the Storage Controllers local disks


information.

400

show-lun-mappings

Displays the LUN mapping information between


Volumes and Initiators.

469

show-most-active

Displays the most active Volumes and Initiator


Groups.

451

show-most-active-initiator-gr
oups

Displays performance data of the most active Initiator


Groups.

459

show-most-active-volumes

Displays performance data of the most active


Volumes.

450

show-remote-servers-status

Displays NTP, DNS, gateway servers information.

420

show-report

Displays the details of a specified report.

507

show-reports

Displays the list of defined reports.

507

show-reports-data

Displays report data for the specified entity and


category.

508

show-scheduler

Displays the parameters of the specified Scheduler.

465

show-schedulers

Displays the defined Schedulers parameters.

466

show-server-certificate

Displays the currently loaded certificate.

421

show-server-certificate-signin Displays the certificate signing request.


g-request

421

show-server-name

Displays the server name, according to the name


configuration mode.

430

show-slots

Displays the list of SSD slots and their properties.

402

show-snapshot-set

Displays the parameters of the specified Snapshot


Set.

452

show-snapshot-sets

Displays the list of Snapshot Sets and their data.

453

show-snapshots

Displays the list of Snapshots and related


information.

449

show-snmp-notifier

Displays SNMP notification configuration.

435

show-ssds

Displays the list of SSDs in the Cluster and their


properties.

403

show-ssd-sas-counters

Displays the specified SSDs SAS counters


information.

502

show-ssds-performance

Displays SSDs performance data.

491

show-storage-controllers

Displays the Clusters Storage Controllers information


and status.

404

show-storage-controllers-fw-v Displays the Storage Controllers firmware version


information.
ersions

405

CLI Commands Quick Finder

377

CLI Guide

378

Command

Description

Page

show-storage-controllers-infi
niband-counters

Displays the Storage Controllers InfiniBand different


counters.

503

show-storage-controllers-infi
niband-ports

Displays the Storage Controllers InfiniBand port


information.

406

show-storage-controllers-info

Displays the Storage Controllers information.

407

show-storage-controllers-psu
s

Displays the Storage Controllers Power Supply Units


information.

408

show-storage-controllers-sasports

Displays the Storage Controllers SAS ports


information.

409

show-storage-controllers-sen
sors

Displays the list of sensors and their related


information.

410

show-sw-image-details

Displays software updates and versions that are


included in the package. Content may vary between
different versions.

385

show-sw-images

Displays the names and version numbers of the


available software images.

385

show-syr-notifier

Displays the ESRS (EMC Secure Remote Support)


information notification configuration.

437

show-syslog-notifier

Displays the Syslog server notification status.

438

show-tag

Displays the details of the specified Tag.

440

show-tags

Displays the list of all defined Tags.

441

show-target-groups

Displays the list of Target Groups.

468

show-target-groups-fc-error-c
ounters

Displays Fibre Channel error counter per Target Group.

504

show-target-groups-performa
nce

Displays Target Groups performance data.

492

show-target-groups-performa
nce-small

Displays Target Groups performance data for small


(under 4KB) blocks.

493

show-target-groups-performa
nce-unaligned

Displays Target Groups performance data for


unaligned blocks.

494

show-targets

Displays the Cluster Targets information.

467

show-targets-fc-error-counter
s

Displays Fibre Channel error counter per Target.

505

show-targets iscsi-counters

Displays iSCSI-related counters.

506

show-targets-performance

Displays Targets performance data.

495

show-targets-performance-s
mall

Displays Targets performance data for small (under


4KB) blocks.

496

show-targets-performance-un
aligned

Displays Targets performance data for unaligned


blocks.

497

show-technician-port-tunnels

Shows the status of the defined technician port


tunnels.

386

show-timezones

Displays the timezones list.

429

EMC XtremIO Storage Array User Guide

CLI Guide

Command

Description

Page

show-user-accounts

Displays the user accounts information.

416

show-volume

Displays the specified Volumes information.

445

show-volumes

Displays the list of Volumes with their associated


Snapshots and their parameters.

444

show-volume-snapshot-grou
ps

Displays the list of Volumes and their information.

446

show-volumes-performance

Displays the Volumes performance data.

498

show-volumes-performance-s Displays the Volumes performance data for small


(under 4KB) blocks.
mall

499

show-volumes-performanceunaligned

Displays the Volumes performance data for


unaligned blocks.

500

show-xenvs

Displays the list of Storage Controller x-envs and their


properties.

426

show-xms

Displays the XtremIO management system


information.

427

show-xms-info

Displays information on server statistics, disk usage


and Ethernet interfaces.

428

shutdown-xms

Stops the XMS service or shuts down the XtremIO


Management System.

392

start-cluster

Starts a stopped Cluster and enables it to respond to


host I/Os and process data.

393

stop-cluster

Stops an active Cluster and disables data processing


in an orderly manner.

393

suspend-scheduler

Suspends the activity of an active Scheduler.

465

tag-object

Assigns a Tag to a specified object.

441

test-ip-connectivity

Performs a connectivity test to the specified IP


address.

412

test-xms-storage-controller-co Performs a connectivity test to the specified Storage


nnectivity
Controller and its managing XMS.

412

test-xms-tcp-connectivity

Performs a connectivity check for the specified TCP


port and the XMS.

412

unmap-lun

Removes a Volumes LUN mappings.

469

untag-object

Removes a Tag from the specified object.

441

CLI Commands Quick Finder

379

CLI Guide

General
exit
The exit command closes the CLI terminal and returns to the administration screen.
Displayed data is removed upon exiting the CLI terminal and does not appear when the
terminal is reopened.

help
The help command displays the list of all available CLI commands. For full usage
information of specific command, type a question mark, followed by the command.
For example:
?show-volumes

quit
The quit command closes the CLI terminal and returns to the administration screen.
Displayed data is removed upon exiting the CLI terminal and does not appear when the
terminal is reopened.

380

EMC XtremIO Storage Array User Guide

CLI Guide

rename
The rename command renames a component of the XtremIO Storage Array.
Input Parameter

Description

Value

Mandatory

new-caption

New caption

String

One from Group 1*

new-name

New name

String

One from Group 1*

sc-id

Storage Controller ID

Name or index

One from Group 2**

cluster-id

Cluster ID

Name or index

One from Group 2**

xms-id

XMS ID

Name or index

One from Group 2**

vol-id

Volume ID

Name or Index

One from Group 2**

dpg-id

Data Protection Groups ID

Name or index

One from Group 2**

tar-id

Target ID

Name or index

One from Group 2**

tag-id

Tag ID

Name or Index

One from Group 2**

storage-controller-psu-id

Storage Controller PSU ID

Name or Index

One from Group 2**

snapshot-set-id

Snapshot Set ID

Name or Index

One from Group 2**

dae-lcc-id

DAE LCC ID

Name or Index

One from Group 2**

tg-id

Target Group ID

Name or Index

One from Group 2**

dae-id

DAE ID

Name or Index

One from Group 2**

mdl-id

Module ID

Name or index

One from Group 2**

ib-switch-id

InfiniBand Switch ID

Name or Index

One from Group 2**

ssd-id

SSD ID

Name or index

One from Group 2**

xenv-id

XEnv ID

Name or index

One from Group 2**

ig-id

Initiator Group ID

Name or index

One from Group 2**

brick-id

Brick ID

Name or index

One from Group 2**

usr-id

User ID

Name or index

One from Group 2**

initiator-id

Initiator ID

Name or index

One from Group2**

dae-psu-id

DAE PSU ID

Name or Index

One from Group 2**

volume-snapshot-group-id

SG ID

Name or Index

One from Group 2**

local-disk-id

LocalDisk ID

Name or Index

One from Group 2**

ib-switch-psu-id

InfiniBand Switch PSU ID

Name or Index

One from Group 2**

cg-id

Consistency Group ID

Name or Index

One from Group 2**

*)Group1:[new-caption, new-name]
**)Group2:[tag-id, dae-lcc-id,ib-switch-id, brick-id, cluster-id, dpg-id, ig-id,
ib-switch-psu-id, dae-psu-id, volume-snapshot-group-id, initiator-id,mdl-id, sc-id, ssd-id,
tar-id, storage-controller-psu-id, cg-id, tg-id, local-disk-id, dae-id, usr-id, vol-id, xenv-id,
xms-id, snapsot-set-id]

General

381

CLI Guide

Maintenance
Create cluster / CE
add-cluster
The add-cluster command adds a Cluster to the list of Clusters managed by the XMS.
Input Parameter

Description

Value

Mandatory

sc-mgr-host

Storage Controller IP
address or host name

Host Name

Yes

force

Force add

N/A

No

remove-cluster
The remove-cluster command removes a Cluster from the list of Clusters managed by
the XMS.

382

Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

Name or Index

Yes

EMC XtremIO Storage Array User Guide

CLI Guide

show-clusters
The show-clusters command displays the main properties and the status of
connected clusters.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

vertical

Vertical layout

N/A

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters index number

State

The clusters 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 space (SSD) available to the XtremIO Storage


Array

Logical-Space-In-Use

The total logical address space written to the cluster before


deduplication

UD-SSD-Space-in-Use

The physical (SSD) space currently in use after deduplication.


This value may be lower than the Address-Space property if the
deduplication ratio is greater than 1.

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 clusters capacity

Maintenance

383

CLI Guide

show-clusters-upgrade
The show-clusters-upgrade command displays clusters software upgrade status.

384

Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters index number

State

The clusters state

Upgrade-State

The clusters upgrade state

Start-Time

A time stamp indicating the clusters upgrade starting point

Activation-Time

A time stamp indicating when the current software was activated

Storage-Controller-Name

The Storage Controllers name

Index

The Storage Controllers index number

Mgr-Addr

The management IP address of the Storage Controller

SW-Version

The Storage Controllers software version

SW-Build

The software build number

OS-Version

The OS version

FW-State

The firmwares state

Upgrade-Failures

Indicates if upgrade has failed.

EMC XtremIO Storage Array User Guide

CLI Guide

show-clusters-upgrade-progress
The show-clusters-upgrade-progress command displays indicators of the
clusters software upgrade progress.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Storage-Controller-Name

The Storage Controllers name

Index

The Storage Controllers index number

Cluster-Name

The clusters name

Index

The clusters index number

Step-Number

The current upgrade step number

Step-Information

Current upgrade step information

show-sw-images
The show-sw-images command displays the names and version numbers of the
available software images.
Output Parameter

Description

Package-Name

Name of the software package

Package-is-Valid

Indicates if the software package is valid.

Version

Version number of the software package

MD5-Signature

The images MD5 signature

show-sw-image-details
The show-sw-image-details command displays software updates and versions that
are included in the package. The content may vary between different versions.
Input Parameter

Description

Value

Mandatory

package

Software package file


name

File name

Yes

Maintenance

385

CLI Guide

FRU Replacement
show-technician-port-tunnels
The show-technician-port-tunnels shows the status of the defined technician
tunnels.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

id: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters index number

Storage-Controller-Name

The Storage Controllers name

Index

The Storage Controllers index number

Tech-Tunnel-State

The state of the Tech tunnel (opened or closed)

modify-technician-port-tunnel
The modify-technician-port-tunnel opens or closes a Tech port tunnel to a
specific Storage Controller.
Input Parameter

Description

Value

Mandatory*

sc-id

Storage Controller ID

id: Name or Index

Yes

close

Close tunnel

N/A

One from Group 1

open

Open tunnel

N/A

One from Group 1

cluster-id

Cluster ID

id: Name or Index

No

*)Group 1: [close, open]

386

EMC XtremIO Storage Array User Guide

CLI Guide

add-ssd
The add-ssd command adds an SSD to the X-Brick and initializes it.
Input Parameter

Description

Value

Mandatory

brick-id

X-Brick ID

Name or index

Yes

ssd-uid

SSDs UID

String

Yes

cluster-id

Cluster ID

id: name or index

No

N/A

No

is-encrypted-unreadab
le-ssd
is-foreign-xtremapp-ss
d

Allows to override the


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

N/A

No

ssd-name

SSDs Name

String

No

remove-ssd
The remove-ssd command removes an SSD from a Data Protection Group. An SSD that
belongs to a Data Protection Group cannot be removed.
If the SSD has already been physically removed from its slot in the X-Brick, the SSD is
immediately eliminated from cluster records. If it is still inserted, its status is defined as
Eject Pending. After it is removed, the cluster automatically removes the SSD.
Input Parameter

Description

Value

Mandatory

ssd-id

SSD ID

Name or index

Yes

cluster-id

Cluster ID

id: name or index

No

assign-ssd
The assign-ssd command assigns an existing SSD to a Data Protection Group.
Input Parameter

Description

Value

Mandatory

dpg-id

XDP group ID

Name or index

Yes

ssd-id

SSD ID

Name or index

Yes

cluster-id

Cluster ID

Name or Index

No

Maintenance

387

CLI Guide

show-ssds-diagnostic
The show-ssds-diagnostic command displays SSDs diagnostic information.
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

Output Parameter

Description

Name

The SSDs name

Index

The SSDs index number

Cluster-Name

The clusters name

Index

The clusters index number

Brick-Name

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

Index

The X-Bricks index number

Slot #

The X-Bricks 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

IO-Err-Vendor-Specific

The vendor specific information of the latest I/O error

activate-storage-controller
The activate-storage-controller command activates a replaced or non-active
Storage Controller.

388

Input Parameter

Description

Value

Mandatory

sc-id

Storage Controller
object ID

Name or index

Yes

cluster-id

Cluster ID

ID: Name or Index

No

EMC XtremIO Storage Array User Guide

CLI Guide

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

Description

Value

Mandatory

sc-id

Storage Controller
object ID

Name or index

Yes

cluster-id

Cluster ID

ID: Name or Index

No

Maintenance

389

CLI Guide

show-bbus
The show-bbus command displays the Battery Backup Units information.

390

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

Output Parameter

Description

Name

The BBUs name

Index

The BBUs index number

Model

The BBUs model

Serial-Number

The BBUs serial number

Power-Feed

The BBUs power feed (A or B)

State

Indicates if the BBU is healthy, disconnected, failed, or initializing.

Connectivity-State

The BBUs connectivity state to the Storage Controller

Enabled-State

Indicates whether the BBU is enabled.

Input

Indicates if there is external power feed to the BBU (on or off).

Battery-Charge

Percentage of BBU battery charge. If the BBU is unreachable or


disabled, this parameter is NULL.

BBU-Load

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 BBUs Firmware version

Part-Number

A string identifier of the part (assigned by EMC)

Brick-Name

The X-Bricks name

Index

The X-Bricks index number

Cluster-Name

The clusters name

Index

The clusters index number

EMC XtremIO Storage Array User Guide

CLI Guide

show-bricks
The show-bricks command displays a list of X-Bricks and their associated cluster.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Brick-Name

The X-Bricks name

Index

The X-Bricks index number

Cluster-Name

The clusters name

Index

The clusters index number

State

The X-Bricks 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.

control-led
The control-led command can be used to locate 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 Hardware Components LEDs on page 71 for the
valid values for each LED type.
Input Parameter

Description

Value

Mandatory

entity

FRU

SSD, DAELCC, LocalDisk,


StorageController, DAE

Yes

led-mode

The desired LED mode

on, off, blinking

Yes

object-id-list

Object ID list

List of IDs: name or index


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

Yes

cluster-id

Cluster ID

id: name or index

No

inverse-mode

Applies the specified


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

N/A

No

Maintenance

391

CLI Guide

Start/stop/power commands
power-off
The power-off command powers off a Storage Controller or an entire cluster.
Powering off a Storage Controller disconnects all connected hosts from the paths to this
controller. However, power-cycling the entire cluster causes the entire cluster not to
respond to host I/O requests. The Storage Controller must be deactivated before this
command can run.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

Name or Index

No

force

Force power off

N/A

No

sc-id

Storage Controllers ID

Name or index

No

shut-down-reason

Shut down reason

free text

No


Unless otherwise requested by EMC Global Tech Support, this command should not be
used to shut down the Cluster. For instructions on shutting down the cluster, refer to
Shutting Down the Cluster - Planned Shutdown on page 348.

power-on
The power-on command powers up a Storage Controller.
Powering on a Storage Controller connects all hosts to this controller. Powering on the
entire cluster causes the entire cluster to respond to host I/O requests.
Input Parameter

Description

Value

Mandatory

sc-id

Storage Controllers ID

Name or index

Yes

cluster-id

Clusters ID

Name or index

No

shutdown-xms
The shutdown-xms command stops the XMS service or shuts down the XtremIO
Management System.

392

Input Parameter

Description

Value

Mandatory

shutdown-type

Shutdown type

service (default),
machine

No

EMC XtremIO Storage Array User Guide

CLI Guide

start-cluster
The start-cluster command starts a stopped cluster and enables it to respond to
host I/Os and process data.
Input Parameter

Description

Value

Mandatory

cluster-id

Clusters ID

Name or index

No

force

Force stop

N/A

No

stop-cluster
The stop-cluster command stops an active cluster (active x-envs only) and disables
data processing in an orderly manner.
Input Parameter

Description

Value

Mandatory

cluster-id

Clusters ID

Name or index

No

force

Force stop

N/A

No

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

restart-xms
The restart-xms command restarts the XtremIO Management System.
Input Parameter

Description

Value

Mandatory

restart-type

Restart type

service (default),
machine

No

Maintenance

393

CLI Guide

Hardware Diagnostics
show-daes
The show-daes command displays the clusters DAE information.

394

Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Name

The DAEs name

Index

The DAEs index number

Model

The DAEs model

Serial-Number

The DAEs serial number

State

The field replaceable unit state (healthy, disconnected, failed, or


initializing)

FW-Version

The DAEs firmware version

Part-Number

A string identifier of the part (assigned by EMC)

Brick-Name

The X-Bricks name

Index

The X-Bricks index number

Cluster-Name

The clusters name

Index

The clusters index number

HW-Revision

The DAEs hardware revision number

EMC XtremIO Storage Array User Guide

CLI Guide

show-daes-controllers
The show-daes-controllers command displays the list of DAE controllers (LCCs) and
their properties.
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

Output Parameter

Description

Name

The DAE Controllers name

Index

The DAE Controllers index number

Model

The DAE Controllers model

Serial-Number

The DAE Controllers serial number

State

The field replaceable unit state (healthy, disconnected, failed, or


initializing)

Enabled-State

Indicates if DAE Controller is enabled.

HW-Revision

The DAE Controllers hardware revision number

index-in-DAE

The controllers index in relation to the DAE

Location

The DAE Controllers physical location (bottom or up)

FW-Version

The DAE Controllers firmware version

Part-Number

A string identifier of the part (assigned by EMC)

DAE-Name

The DAEs name

DAE-Index

The DAEs index number

Brick-Name

The X-Bricks name

Index

The X-Bricks index number

Cluster-Name

The clusters name

Index

The clusters index number

Maintenance

395

CLI Guide

show-daes-psus
The show-daes-psus command displays the list of DAE power supply units (PSUs) and
their properties.

396

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

Output Parameter

Description

Name

The PSUs name

Index

The PSUs index number

Serial-Number

The PSUs serial number

Location-Index

The PSUs index in relation to the Storage Controller

Power-Feed

The PSUs power feed (A or B)

State

The field replaceable unit state (healthy, disconnected, failed, or


initializing)

Input

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

Location

The PSUs physical location in the DAE

HW-Revision

The PSUs hardware revision

Part-Number

A string identifier of the part (assigned by EMC)

DAE-Name

The DAEs name

DAE-Index

The DAEs Index number

Brick-Name

The X-Bricks name

Index

The X-Bricks index number

Cluster-Name

The clusters name

Index

The clusters index number

EMC XtremIO Storage Array User Guide

CLI Guide

show-infiniband-switches
The show-infiniband-switches command displays InfiniBand Switches
information.
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

Output Parameter

Description

Name

The InfiniBand Switchs name

Index

The InfiniBand Switchs index number

Cluster-Name

The clusters name

Index

The clusters index number

Index-in-Cluster

The port number in the InfiniBand Switch

Serial-Number

The InfiniBand Switchs serial number

Part-Number

A string identifier of the part (assigned by EMC)

State

The InfiniBand Switchs current functional status

FW-Version

Firmware version

FW-Version-Error

Indicates if there is an error in the InfiniBand Switchs FW version.

FAN-Drawer-State

The status of the FAN drawer

Maintenance

397

CLI Guide

show-infiniband-switches-ports
The show-infiniband-switches-ports command displays InfiniBand Switches
port information.

398

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

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 ports state: up or down

IBSwitch-Name

The InfiniBand Switchs name

IBSwitch-Index

The InfiniBand Switchs index number

Cluster-Name

The clusters name

Index

The clusters index number

EMC XtremIO Storage Array User Guide

CLI Guide

show-infiniband-switches-psus
The show-infiniband-switches-psus command displays InfiniBand Switches
PSUs information.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Name

The PSUs name

Index

The PSUs index number

Cluster-Name

The clusters name

Index

The clusters serial number

Index-In-Cluster

The PSU number in the InfiniBand Switch

Location

The PSUs physical location (right or left)

Input-Power

Indicates whether input power is on or off.

State

PSUs health state

Maintenance

399

CLI Guide

show-local-disks
The show-local-disks command displays the Storage Controllers local disks
information.

400

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

Output Parameter

Description

Name

The disks name

Index

The disks index number

Serial-Number

The disks serial number

Location-Index

The disks 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 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 disks purpose (journal_and_boot_disk, trace_disk)

Storage-Controller-Name

Storage Controllers name

Index

Storage Controllers index number

Brick-Name

X-Bricks name

Index

X-Bricks index number

Cluster-Name

Clusters name

Index

Clusters index number

Encryption-Status

Indicates if encryption is enabled.

EMC XtremIO Storage Array User Guide

CLI Guide

show-leds
The show-leds command displays the values for the identification and status LEDs.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters 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)

Maintenance

401

CLI Guide

show-slots
The show-slots command displays the list of SSD slots within the DAE, and their
properties.

402

Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

id: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters index number

Brick-Name

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

Index

The X-Bricks index number within the DAE

Slot #

The DAE slot number

State

The slots 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

EMC XtremIO Storage Array User Guide

CLI Guide

show-ssds
The show-ssds command displays the list of SSDs in the cluster and their properties.
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

Output Parameter

Description

Name

The SSDs name

Index

The SSDs index number

Cluster-Name

The clusters name

Index

The clusters index number

Brick-Name

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

Index

The X-Bricks index number

Slot #

The X-Bricks DAE slot number in which the SSD is inserted

Product-Model

The SSDs model

FW-Version

The SSDs firmware version

FW-State

The SSDs firmware state

Part-Number

A string identifier of the part (assigned by EMC)

SSD-Size

The SSDs disk space size

DPG-Name

The name of the XDP group to which the SSD is associated

Index

The Data Protection Groups index number

SSD-XDP-State

The SSDs current position status

State

The SSDs current status

Endurance-Remaining-%

Percentage of the SSDs remaining endurance

Certainty-State

Indicates if there is a pending command associated with the SSD.

Encryption-Status

Indicates if encryption is enabled.

Maintenance

403

CLI Guide

show-storage-controllers
The show-storage-controllers command displays the clusters Storage
Controllers information and status.

404

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

Output Parameter

Description

Storage-controller-Name

The Storage Controllers name

Index

The Storage Controllers index number

Mgr-Addr

The management IP of the Storage Controller

IB-Addr-1

The Storage Controllers internal back-end IP address for port 1,


used for communication to the InfiniBand Switch

IB-Addr-2

The Storage Controllers internal back-end IP address for port 2,


used for communication to the InfiniBand Switch

Brick-Name

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

Index

The X-Bricks index number

Cluster-Name

The name of the cluster to which the Storage Controller belongs

Index

The clusters index number

State

The Storage Controllers state

Health-State

A summary state that describes the Storage Controllers overall


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

Enabled-State

The Storage Controllers enabled state

Stop-Reason

The reason for the Storage Controllers stop (if any)

Conn-State

The Storage Controllers connectivity state to the XMS

Journal-State

The Storage Controllers journal state

EMC XtremIO Storage Array User Guide

CLI Guide

show-storage-controllers-fw-versions
The show-storage-controllers-fw-versions command displays the Storage
Controllers firmware version information.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Cluster-Name

Clusters name

Index

Clusters index number

Storage-Controller-Name

The Storage Controllers name

Index

The Storage Controllers 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

BIOS

Storage Controller BIOS firmware

SDR

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


sensors)

ME

Sub-component of the BMC

Maintenance

405

CLI Guide

show-storage-controllers-infiniband-ports
The show-storage-controllers-infiniband-ports command displays the
Storage Controllers InfiniBand port information.

406

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

Output Parameter

Description

Name

Ports name

Index

Index number in the cluster

Port-Index

Ports 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 ports state: up or down

Storage-Controller-Name

Storage Controllers name

Index

Storage Controllers index number

Brick-Name

X-Bricks name

Index

X-Bricks index number

Cluster-Name

Clusters name

Index

Clusters index number

Health-Level

Ports health level

EMC XtremIO Storage Array User Guide

CLI Guide

show-storage-controllers-info
The show-storage-controllers-info command displays the Storage Controllers
information.
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

Output Parameter

Description

Storage-Controller-Name

The Storage Controllers name

Index

The Storage Controllers index number

Mgr-Addr

The IP address used to access the Storage Controllers manager

Brick-Name

The Storage Controller management interface

Index

The X-Bricks index number

Cluster-Name

The name of the cluster to which the Storage Controller belongs

Index

The clusters index number

State

The Storage Controllers activity state

Conn-State

The Storage Controllers connectivity status

SW-Version

The Storage Controllers software version

SW-Build

The software build number

HW-Model

The Storage Controllers hardware model

OS-Version

The OS version number

Serial-Number

The Storage Controllers serial number

Part-Number

A string identifier of the part (assigned by EMC)

Sym-Storage-Controller

Indicates if SYM runs on the Storage Controller.

SC-Start-Timestamp

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

Maintenance

407

CLI Guide

show-storage-controllers-psus
The show-storage-controllers-psus command displays the Storage Controllers
power supply units (PSUs) information.

408

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

Output Parameter

Description

Name

PSUs name

Index

PSUs index number

Serial-Number

PSUs serial number

Location-Index

The PSUs index in relation to the Storage Controller

Power-Feed

The PSUs power feed

State

The field replaceable unit state (healthy, disconnected, failed, or


in transient state)

Enabled-State

Indicates if PSU is enabled.

Input

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

Location

The PSUs physical location (right or left)

HW-Revision

PSUs hardware revision

Part-Number

A string identifier of the part (assigned by EMC)

Storage-Controller-Name

Storage Controllers name

Index

Storage Controllers index number

Brick-Name

X-Bricks name

Index

X-Bricks index number

Cluster-Name

Clusters name

Index

Clusters index number

EMC XtremIO Storage Array User Guide

CLI Guide

show-storage-controllers-sas-ports
The show-storage-controllers-sas-ports command displays the Storage
Controllers SAS ports information.
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

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters Index Number

Storage-Controller-Name

The Storage Controllers name

Index

The Storage Controllers Index Number

SAS1-Port-State

The state of SAS1 port (up or down)

SAS1-Port-Rate

The rate of SAS1 port (in gbps)

SAS1-Port-Health-Level

SAS1 ports health status

SAS1-Port-Wrong-Conn

Indicates whether SAS1 port is connected to the wrong DAE


Controller, DAE Controller port or an unknown DAE.

SAS2-Port-State

The state of SAS2 port (up or down)

SAS2-Port-Rate

The rate of SAS2 port (in Gbps)

SAS2-Port-Health-Level

SAS2 ports health level

SAS2-Port-Wrong-Conn

Indicates whether SAS2 port is connected to the wrong DAE


Controller, DAE Controller port or an unknown DAE.

Maintenance

409

CLI Guide

show-storage-controllers-sensors
The show-storage-controllers-sensors command displays the list of sensors
and their related information.

410

Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

Name or Index

No

duration

Monitor duration

Seconds

No

faulty-only

Show only faulty


sensors

N/A

No

frequency

Monitor intervals

Seconds

No

sc-id

Storage Controller ID

Name or Index

No

sensor-type

Filter by sensor type

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

No

Output Parameter

Description

Storage-Controller-Name

The Storage Controllers name

Index

The Storage Controllers Index Number

Sensor-Type

The sensors type

Sensor-Name

The sensors name

Health-State

The sensors health state

Value

The sensors current value

Upper-Threshold

The sensors upper threshold

Lower-Threshold

The sensors lower threshold

Units

The sensors measurement units

EMC XtremIO Storage Array User Guide

CLI Guide

Troubleshooting
Test connectivity
show-discovered-initiators-connectivity
The show-discovered-initiators-connectivity command displays the
Initiators-Targets connectivity map.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

id: Name or Index No

target-details

Target details info

N/A

Output Parameter

Description

Cluster Name

The Initiators Cluster name

Index

The Initiators Cluster index number

Port-type

Initiators port type (iSCSI or FC)

Port-address

Initiators port address

Num-of-conn-targets

Number of Targets the Initiator is connected to

No

show-initiators-connectivity
The show-initiators-connectivity command displays Initiators-port
connectivity and the number of connected Targets.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

id: Name or Index

No

target-details

Target details info

N/A

No

Output Parameter

Description

Cluster Name

The Initiators Cluster name

Index

The Initiators Cluster index number

Name

The Targets name

Index

The Targets index number

Port-Type

The Initiators port type (iSCSI or FC)

Port-Address

The Initiators port address

Num-Of-Conn-Targets

The number of Targets the Initiator is connected to

Troubleshooting

411

CLI Guide

test-ip-connectivity
The test-ip-connectivity command performs a connectivity test to the specified IP
address.
Input Parameter

Description

Value

Mandatory

interface

Interface

ISCSI1, ISCSI2,
sc_management

Yes

ip-addr

The IP address to be
tested

IP address

Yes

sc-id

Storage Controllers ID
source

Name or index

Yes

cluster-id

Cluster ID

Name or Index

No

test-xms-storage-controller-connectivity
The test-xms-storage-controller-connectivity command performs a
connectivity check for the specified Storage Controller and its managing XMS.
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

test-xms-tcp-connectivity
The test-xms-tcp-connectivity command checks the connection of the XMS to
external systems.
Input Parameter

Description

Value

Mandatory

port

The servers TCP port

Port number

Yes

server

The servers IP
address

IP address

Yes

modify-eth-port
The modify-eth-port command modifies the Ethernet port of the cluster.
Input Parameter

Description

Value

Mandatory*

mgmt-port-autoneg-m
ode

Ethernet port
Auto-negotiation
mode

enabled, disabled

One from Group 1

mgmt-port-duplex

Ethernet port duplex

full, half

One from Group 1

mgmt-port-speed

Ethernet port speed

100MB, 1GB

One from Group 1

cluster-id

Cluster ID

Name or Index

No

*)Group1:[mgmt-port-autoneg-mode, mgmt-port-duplex, mgmt-port-speed]

412

EMC XtremIO Storage Array User Guide

CLI Guide

Debug
create-debug-info
The create-debug-info command creates a debug archive log collection.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

id: Name or Index

No

datetime

Date and time (e.g.


date-time string
2012-05-15 11:58:48)

No

debug-info-name

Debug info name

String (without spaces


or special characters)

No

debug-level

Debug level of the log


collection. When
omitted, default is
Medium.

tiny, small, medium


(default) large, huge

No

sc-mgr-host

Storage Controller IP
Address or Hostname

Host name

No

with-perf-data

Collect performance
data

N/A

No

remove-debug-info
The remove-debug-info command deletes the debug info file.
Input Parameter

Description

Value

Mandatory

debug-info-id

Name or index of the


archive

Name or index

Yes

Troubleshooting

413

CLI Guide

show-debug-info
The show-debug-info command displays all the debug information available in XMS.

414

Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Name

The debug informations name

Index

The debug informations index number

Cluster-Name

The name of the cluster to which the Storage Controller belongs

Index

The clusters index

Debug-Level

The debug level of the log collection: tiny, small, medium, large, huge

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.

EMC XtremIO Storage Array User Guide

CLI Guide

Administration
User management
add-user-account
The add-user-account command adds a new user account to XMS.
Input Parameter

Description

Value

Mandatory*

role

User Role

admin/configuration/
read-only

Yes

usr-name

User Name

String

Yes

password

User Password

String

One from Group1

public-key

User public key

public key

One from Group1

inactivity-timeout

Inactivity timeout in
minutes

Integer

No

*)Group 1: [password, public-key]

modify-user-account
The modify-user-account command modifies the user-account parameters.
Input Parameter

Description

Value

Mandatory*

usr-id

User ID

Name or index

Yes

inactivity-timeout

Inactivity timeout
in minutes

Integer

One from Group1

password

User password

String

One from Group1

public-key

User public key

String

One from Group1

role

User role

read_only,
admin,
configuration,
technician

One from Group1

usr-name

User name

String

One from Group 1

*)Group 1: [inactivity-timeout, password, public-key, role, usr-name]

remove-user-account
The remove-user-account command removes a 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.
Input Parameter

Description

Value

Mandatory

usr-id

User ID

Name or index

Yes

Administration

415

CLI Guide

show-user-accounts
The show-user-accounts command displays the user accounts information.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Name

The users name

Index

The users index number

Role

The users permission level

External-Account

Indicates if 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

modify-password
The modify-password command modifies the users password. If the usr-id
parameter is not provided, then the current users password is modified.

416

Input Parameter

Description

Value

Mandatory

password

User password

String

No

usr-id

User ID

Name or index

No

EMC XtremIO Storage Array User Guide

CLI Guide

add-ldap-config
The add-ldap-config command adds a new LDAP configuration profile to the LDAP
configuration table.
Input Parameter

Description

Value

Mandatory

binddn

Bind DN

CN=<value>,OU=<value>,DC=<valu Yes
e>,DC=<value>

bindpw

Bind Password

Password

roles

Role to DN Mapping
List

["admin:CN=SuperUsers,DC=exa Yes
mple,DC=com","read_only:CN=U
sers,DC=exmaple,DC=com"

server-urls

Server URLs

["ldap://ad.exmaple.com"]

Yes

ca-cert-data

X509 server
certifiate

String

No

cache-expire

Credential
Expiration

Credentials cache expiration


(default: 24 hours)

No

search-base

Search Base

OU=<value>,DC=<value>,DC=<value> No

search-filter

Search Filter

sAMAccountName={username}

No

timeout

Connection Timeout

Integer (default: 1500 seconds)

No

user-to-dn-rule

User to DN
substitution

{username}@example.com

No

Yes

remove-ldap-config
The remove-ldap-config command removes an LDAP configuration profile from the
LDAP configuration table.
Input Parameter

Description

Value

Mandatory

ldap-config-id

LDAP configuration
profile ID

index

Yes

Administration

417

CLI Guide

modify-ldap-config
The modify-ldap-config command modifies an LDAP configuration profile.

418

Input Parameter

Description

Value

Mandatory

ldap-config-id

LDAP configuration
ID

Index

Yes

binddn

Bind DN

CN=<value>,OU=<value>,DC=<valu No
e>,DC=<value>

bindpw

Bind Password

Password

No

ca-cert-data

X509 server
certificate

String

No

cache-expire

Credential
Expiration

Credentials cache expiration


(default: 24 hours)

No

roles

Role to DN Mapping
List

["admin:CN=SuperUsers,DC=exa No
mple,DC=com","read_only:CN=U
sers,DC=exmaple,DC=com"

search-base

Search Base

OU=<value>,DC=<value>,DC=<value> No

search-filter

Search Filter

sAMAccountName={username}

No

server-urls

Server URLs

["ldap://ad.exmaple.com"]

No

timeout

Connection Timeout

Integer (default: 1500 seconds)

No

user-to-dn-rule

User to DN
substitution

{username}@example.com

No

EMC XtremIO Storage Array User Guide

CLI Guide

show-ldap-configs
The show-ldap-configs command displays the LDAP server configuration
parameters.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

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)

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 command sets or modifies the IP address of the primary
DNS server (mandatory input) and/or the secondary DNS server (optional input).
Input Parameter

Description

Value

Mandatory*

primary

Primary IP Address

IP Address

One from Group 1

secondary

Secondary IP Address

IP Address

One from Group 1

*Group1) [primary, secondary]

Administration

419

CLI Guide

show-dns-servers
The show-dns-servers command displays the IP addresses of the primary and
secondary DNS servers (if configured).
Output Parameter

Description

Primary

Primary DNS server IP Address

Secondary

Secondary DNS server IP Address

show-remote-servers-status
The show-remote-servers-status command displays NTP, DNS, gateway servers
information.
Output Parameter

Description

Server-Type

The servers type (DNS, Gateway)

Server-IP

The servers IP address

Server-Status

The servers status (reachable/unreachable)

Certificate Management
create-server-certificate-signing-request
The create-server-certificate-signing-request 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.

420

Input Parameter

Description

Value

Mandatory

cert-common-name

Fully qualified domain name

Domain name, e.g.


xms.example.com

No

cert-country

Certificate country name

Two letter ISO_3166-1


country code, e.g. US

No

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 name

String

No

cert-state

State or province

String

No

server-key-size

Server key size

Integer between 2048


and 4096

No

server-key-string

Server private key

String

No

EMC XtremIO Storage Array User Guide

CLI Guide

install-self-signed-server-certificate
The install-self-signed-server-certificate command installs the new self
signed certificate.
Input Parameter

Description

Value

Mandatory

cert-common-name

Fully qualified domain name

domain name, e.g.


xms.example.com

No

cert-ip

IP Address

IP Address

No

server-certificate-signing
-request-string

Certificate Signing Request

String

No

server-key-string

RSA private key, if the CSR was


not created by XMS

String

No

show-server-certificate
The show-server-certificate command displays the currently loaded certificate.

show-server-certificate-signing-request
The show-server-certificate-signing-request command displays the
certificate signing request.

modify-server-certificate
The modify-server-certificate 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.
Input Parameter

Description

Value

Mandatory

server-certificate-string

X509 Server Certificate

String

Yes

server-key-string

X509 private key

String

No

chain-certificate-string

Chain of X509 Certificates

String

No

Administration

421

CLI Guide

Cluster Management (Cluster Level)


modify-clusters-parameters
The modify-clusters-parameters command modifies various cluster parameters.
Input Parameter

Description

Value

Mandatory*

debug-create-timeout

Debug info creation


timeout

high, none, normal

One from Group 1

iscsi-tcp-port

iSCSI TCP Port

Integer

One from Group 1

obfuscate-debug

Obfuscate debug info

enabled, disabled

One from Group 1

odx-mode

ODX mode

enabled, disabled

One from Group 1

cluster-id

The clusters ID

Name or Index

No

*)Group1:[debug-create-timeout, iscsi-tcp-port, obfuscate-debug, odx-mode]

modify-cluster-thresholds
The modify-cluster-thresholds modifies the properties for thin provisioning soft
limits for connected clusters.
Input Parameter

Description

Value

Mandatory

vaai-tp-limit

VAAI TP Limit

Range 0 - 100

Yes

cluster-id

Cluster ID

Name or index

No

show-clusters-data-protection-properties
The show-clusters-data-protection-properties command displays clusters
data protection properties.

422

Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters 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

EMC XtremIO Storage Array User Guide

CLI Guide

show-clusters-info
The show-clusters-info command displays additional information, which is not
displayed in the show-clusters command, about connected clusters.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

vertical

Vertical layout

N/A

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters index number

State

The clusters 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 clusters software version

PSNT

The clusters Product Serial Number Tag (assigned by EMC)

Encryption-Mode

The clusters encryption mode

Encryption-Supported

Indicates if the cluster is encryption supported.

Encryption-Mode-State

The clusters encryption modes state

Compression-Mode

The clusters compression mode

SSH-Firewall-Mode

The clusters SSH firewall mode

OS-Upgrade-Ongoing

Indicates if an OS upgrade process is ongoing.

Cluster-Expansion-In-Progress

Indicates if cluster expansion is in progress.

Upgrade-State

The clusters upgrade status

Administration

423

CLI Guide

show-clusters-parameters
The show-clusters-parameters command displays connected clusters iSCSI TCP
port numbers.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters index number

ODX-Mode

Indicates whether ODX (Microsofts Offloaded Data Transfer) is


enabled.

iSCSI-TCP--Port

The clusters 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

show-clusters-savings
The show-clusters-savings command displays savings parameters of the selected
cluster.

424

Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters index number

Data-Reduction-Ratio

The clusters data reduction ratio (calculated using the data


deduplication and data compression)

Thin-Provisioning-Ratio

The clusters thin provisioning ratio (used disk space compared to


allocated disk space)

Dedup-Ratio

The clusters deduplication ratio (calculated data written to the


array compared to unique data on SSD)

Compression-Factor

The clusters compression factor (calculated using the unique data


on the SSD compared to the physical capacity used)

EMC XtremIO Storage Array User Guide

CLI Guide

show-clusters-thresholds
The show-clusters-thresholds command displays thin provisioning soft limits for
the connected clusters.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters index number

Thin-Provisioning-Soft-Limit

Percentage value of limit placed on storage space

set-context
The set-context command sets a cluster context in a multiple cluster environment and
renders the need to specify the cluster ID unnecessary.
Input Parameter

Description

Value

Mandatory

all

All clusters

N/A

One from Group 1

cluster-id

Cluster ID

Name or Index

One from Group 2

Mandatory groups:
Group1:[all, cluster-id]
Exclusive groups:
Group1:[all]
Group2:[cluster-id]

modify-ssh-firewall
The modify-ssh-firewall command modifies the lock mode of the SSH firewall.
Input Parameter

Description

Value

Mandatory

ssh-firewall-mode

SSH firewall mode

locked, unlocked

Yes

cluster-id

Cluster ID

Name or Index

No

Administration

425

CLI Guide

show-xenvs
The show-xenvs command displays the list of Storage Controller XEnvs and their
properties.

426

Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

XEnv-Name

The XEnvs name

Index

The XEnvs index number

Cluster-Name

The Clusters name

Index

The Clusters index number

CPU (%)

The current percentage of CPU usage

CSID

The unique clustering ID used for internal messaging

State

The XEnvs current state: active or inactive

Storage-Controller-Name

The Storage Controllers name

Index

The Storage Controllers index number

Brick-Name

The X-Bricks name

Index

The X-Bricks index number

EMC XtremIO Storage Array User Guide

CLI Guide

Cluster Management (XMS Level)


show-xms
The show-xms command displays the XtremIO management System information.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Name

The Management clusters name

Index

The Management clusters index number

Xms-IP-Addr

The IP address of the XMS

Xms-Mgmt-Ifc

The interface name for the XMS IP management

REST-API-Protocol-Version

Version number of the REST API protocol

IP-Version

IP version (IPV4, IPV6)

Default-User-Inactivity-Timeout

Default user inactivity timeout

refresh-xms-ssh-key
The refresh-xms-ssh-key command generates a new unique SSH key on the XMS
and updates all related clusters accordingly.

Administration

427

CLI Guide

show-xms-info
The show-xms-info command displays information on server statistics, disk usage and
Ethernet interfaces.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Server Statistics
Output Parameter

Description

Name

The Management servers name

Index

The Management servers 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

428

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

EMC XtremIO Storage Array User Guide

CLI Guide

Ethernet Interfaces
Output Parameter

Description

Name

Interface name

Index

Interface index number

IP

Interface IP address

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

modify-xms-parameters
The show-xms-parameters command modifies the XMSs user inactivity timeout.
Input Parameter

Description

Value

Mandatory

default-user-inactivitytimeout

User Inactivity Timeout


in minutes

Integer

Yes

show-timezones
The show-timezones command displays the timezones list.

show-datetime
The show-datetime command displays time-related information.
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 clusters 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 if Daylight Saving Time is applied.

Administration

429

CLI Guide

modify-datetime
The modify-datetime command sets or modifies the clusters date and time,
timezone, or NTP server parameters. The commands input parameters must include at
least one of these parameters.
Input Parameter

Description

Value

Mandatory*

datetime

Datetime

Datetime string, e.g.


2013-12-20 17:46:24

One from Group 1

ntp-servers

NTP server list

List of NTP servers

One from Group 1

timezone

Time zone

Time zone, e.g.


US/Pacific

One from Group 1

*) Group 1:[datetime, ntp-server, timezone]

modify-login-banner
The modify-login-banner command allows customizing the login banner text.
Input Parameter

Description

Value

Mandatory

banner

CLI/GUI banner

ascii string (up to


3771 characters)

Yes

show-server-name
The show-server-name 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 show-report).
DNS mode - The server name is drawn from reverse DNS lookup (enabled, using
show-report).
Dynamic mode - The server name is set according to the users URL request.

modify-server-name
The modify-server-name command defines or modifies the XMSs URL. The user can
also enable/disable reverse DNS lookup to retrieve the URL, based on the XMSs IP
address.
Input Parameter

Description

Value

Mandatory*

enable-reverse-dns

Indicates if to enable
reverse DNS lookup.

N/A

One from Group 1

enable-user-url

Server redirects based


on user URL

N/A

One from Group 1

server-name

Server name

E.g. xms.example.com

One from Group 1

*Group1) [enable-reverse-dns, enable-user-url server-name]

430

EMC XtremIO Storage Array User Guide

CLI Guide

modify-webui
The modify-webui command enables or disables the XtremIO WebUI technology
preview mode.
Input Parameter

Description

Value

Mandatory

disable

Disable WebUI

N/A

One from Group 1

enable

Enable WebUI

N/A

One from Group 1

Mandatory groups:
Group1:[disable, enable]

backup-xms
The backup-xms command backs up the XMS data to a downloadable file.
When the backup process is completed, a link for the file is displayed:
xmcli (tech) > backup-xms
...........................................
XMS backed-up and may be accessed via
https://10.101.60.255/xtremapp/DebugInfo/xms_backup_4.0.2_150216_1001_XMS_backup_2016
_02_15_100112.tar.gz

Administration

431

CLI Guide

XMS Notifiers
modify-email-notifier
The modify-email-notifier command modifies the email notification settings.
Input Parameter

Description

Value

Mandatory

add-recipient

Adds one recipient to the list.

Host name or IP
address

No

company-name

The companys name

Company name

No

contact-details

The contact details

Contact details

No

disable

Disables the mail notifier.

N/A

No

enable

Enables the mail notifier.

N/A

No

mail-password

A password for SMTP mail relay Password for SMTP


mail relay

No

mail-relay-address

IP or DNS for SMTP mail relay

IP or DNS for SMTP


mail relay

No

mail-user

A user for SMTP mail relay

User for SMTP mail


relay

No

proxy-address

IP or DNS address for HTTP


proxy

IP or DNS for HTTP


proxy

No

proxy-password

A password for HTTP proxy

Password for HTTP


proxy

No

proxy-port

A port for HTTP proxy

Port for HTTP proxy

No

proxy-user

A user name for HTTP proxy

user name for HTTP


proxy

No

recipient-list

A list of email recipients

List of recipients

No

remove-recipient

Removes one recipient from


the list.

Host name or IP
address

No

reset-configuration

Resets the configuration.

N/A

No

sender

The senders email address

Sender

No

transport

The mail transport mechanism


to be used

SMTP or HTTP

No

send-email-notification
The send-email-notification command checks the email notification
configuration, by sending an email notification per the set configuration, containing the
supplied text.

432

Input Parameter

Description

Value

Mandatory

text

Description text

N/A

Yes

EMC XtremIO Storage Array User Guide

CLI Guide

show-email-notifier
The show-email-notifier command displays the Email notification settings.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Enabled

The active status of the email notifier

Transport

Mail transport to user:


HTML
SMTP

Sender

Senders email address

Recipients

List of email recipients

Proxy-Address

The proxy servers address for HTML mail

Proxy-Port

The proxy servers port for HTML mail

Proxy-User

The proxy servers 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 senders company name

Contact-Details

The senders contact details

Administration

433

CLI Guide

modify-snmp-notifier
The modify-snmp-notifier command modifies the SNMP notification settings.
Input Parameter

Description

Value

Mandatory

add-recipient

Adds one recipient to the list.

Host name or IP
address

No

auth-key

SNMP v3 authentication key

String

No

auth-protocol

SNMP v3 authentication protocol

md5, sha, no_auth

No

community

SNMP community string

String

No

disable

Indicates if the notification is


disabled.

N/A

No

enable

Indicates if the notification is


enabled.

N/A

No

port

UDP port (default 162)

Port number

No

priv-key

SNMP v3 privilege key

String

No

priv-protocol

SNMP v3 privilege protocol

des, aes128, no_priv

No

recipient-list

Recipient server list

List: IP or server name

No

remove-recipient

Removes one recipient from the


list.

Host name or IP
address

No

username

SNMP v3 username

String

No

version

SNMP version

v1, v2c or V3

No

send-snmp-notification
The send-snmp-notification command checks the SNMP notification configuration
by sending an SNMP notification per the set configuration, containing the supplied text.

434

Input Parameter

Description

Value

Mandatory

text

Description text

N/A

Yes

EMC XtremIO Storage Array User Guide

CLI Guide

show-snmp-notifier
The show-snmp-notifier command displays SNMP notification configuration.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Enabled

Indicates if 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

435

CLI Guide

modify-syr-notifier
The modify-syr-notifier command modifies the ESRS (EMC Secure Remote
Support) notification parameters.
Input Parameter

Description

Value

Mandatory*

connection-type

Connection type

SYR Notifier connection type


(possible values: "esrsgw",
"ipclient", "email", "ftps")

One from
Group 1

disable

Disable

N/A

One from
Group 1

enable

Enable

N/A

One from
Group 1

frequency

frequency

Hours (positive number)

One from
Group 1

reset-configuration

Reset configuration

N/A

One from
Group 1

site-name

Site name

Name (can contain spaces)

One from
Group 1

esrs-gw-host-secondary Secondary Gateway


host

IP for ESRS Gateway

No

email-password

Mail password

Mail server password

No

email-sender

Mail sender

Sender name

No

email-server

Mail server

Hostname or IP for mail server

No

email-user

Mail username

Mail server username

No

esrs-gw-host

Gateway host

IP for ESRS Gateway

No

*)Group 1: [connection-type, disable, enable, frequency, reset-configuration, site-name]

send-syr-notification
The send-syr-notification command checks the SYR notification configuration by
sending a predefined ESRS (EMC Secure Remote Support) information notification per the
set configuration containing a test event.

436

Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

name or index

No

test-event

Send a test event.

N/A

No

EMC XtremIO Storage Array User Guide

CLI Guide

show-syr-notifier
The show-syr-notifier command displays the ESRS (EMC Secure Remote Support)
information notification configuration.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Enabled

Indicates if support information notification is enabled or disabled.

Frequency

Notification frequency (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 customers site where the cluster is installed.

PSNT

The clusters Product Serial Number Tag (assigned by EMC)

modify-syslog-notifier
The modify-syslog-notifier command sets or modifies the Syslog notifier list.
There can be up to 6 Syslog notifiers.
Input Parameter

Description

Value

Mandatory*

disable

Disable

N/A

No

enable

Enable

N/A

No

add-target

Add target

Add one target to the


list

No

remove-target

Remove target

Remove one target


from the list

No

targets

Target list

List of Syslog Targets


with optional port
(required when
enabling)

No

*Exclusive Group: [disable, enable]

Administration

437

CLI Guide

show-syslog-notifier
The show-syslog-notifier command displays the Syslog server notification status.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Enabled

Indicates if the Syslog server notification option is enabled or


disabled.

Targets

Displays the list of Syslog Targets with optional port.

IP Addresses
modify-ip-addresses
The modify-ip-addresses command modifies the XMS networking configuration,
including IP addresses, network mask and default GW.
Input Parameter

Description

Value

Mandatory*

sc-gw-addr

Storage Controllers
management network
gateway address

IP address

One from Group 1

sc-ip-list

Storage Controllers IP
list

[sc-id=value sc-ip-sn=value
ipmi-ip-sn=value,...]

One from Group 1

xms-gw-addr

XMS gateway address

IP address

One from Group 1

xms-ip-sn

XMS IP/Subnet

IP address/Subnet

One from Group 1

cluster-id

Cluster ID

Name or Index

No

rollback

Rollback changes in
case of failure

N/A

No

*)Group1:[sc-gw-addr, sc-ip-list, xms-gw-addr, xms-ip-sn]

438

EMC XtremIO Storage Array User Guide

CLI Guide

show-ip-addresses
The show-ip-addresses command displays the XMS networking configuration,
including IP addresses, network mask and default GW.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Input Parameter

Description

Name

XMS name

Index

XMS index

Xms-IP-Addr

XMS IP address

Xms-GW-Addr

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 adress subnet mask

MGMT-GW-IP

Management Storage Controller Gateway IP address

Administration

439

CLI Guide

Provisioning
Tag Management
create-tag
The create-tag command creates a Tag for an entity.
Input Parameter

Description

Value

Mandatory

entity

Entity

String

Yes

tag-name

Tag name

full path Tag name

Yes

modify-tag
The modify-tag command modifies a specified Tag caption.
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

remove-tag
The remove-tag command deletes a Tag from the tags list.
Input Parameter

Description

Value

Mandatory

tag-id

Tag ID

Name or index

Yes

show-tag
The show-tag command displays the details of the specified Tag.

440

Input Parameter

Description

Value

Mandatory

tag-id

Tag ID

Name or index

Yes

Output Parameter

Description

Name

The Tags full path name

Index

The Tags 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 Tags creation

Object-List

List of all objects assigned with the specified Tag (name and index)

EMC XtremIO Storage Array User Guide

CLI Guide

show-tags
The show-tags command displays the details of all defined Tags.
Input Parameter

Description

Value

Mandatory

entity

Entity

String

No

Output Parameter

Description

Name

The Tags full path name

Index

The Tags 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 Tags creation

tag-object
The tag-object command assigns a Tag to a specified object.
Input Parameter

Description

Value

Mandatory

entity

Entity

String

Yes

entity-details

Entity ID

Name or index

Yes

tag-id

Tag ID

Name or index

Yes

cluster-id

Cluster ID

ID:Name or index

No

untag-object
The untag-object command removes a Tag from the specified object.
Input Parameter

Description

Value

Mandatory

entity

Entity

String

Yes

entity-details

Entity ID

Name or index

Yes

tag-id

Tag ID

Name or index

Yes

cluster-id

Cluster ID

ID:Name or index

No

Provisioning

441

CLI Guide

Volume and Snapshot Management


add-volume
The add-volume command creates and adds a new Volume.

442

Input Parameter

Description

Value

Mandatory

vol-name

Volume name

String (up to 128 characters)

Yes

vol-size

Volume size

Integer suffixed by [kmgtp].


e.g. vol-size="10t", creates a
Volume of 10TB. Volume size
must be in multiples of 8K.

Yes

alignment-offset

For 512 block size, offset


Alignment offset
range is 0-15.
according to block size
for 4096 block size, there is
no offset.
If omitted, offset is 0.

No

cluster-id

Cluster ID

Name or index. Can be omitted


if only one cluster is defined.

No

lb-size

Block size

512 (default) or 4096

No

small-io-alerts

Small I/O alerts

Enabled or Disabled

No

unaligned-io-alerts

Unaligned I/O alerts

Enabled or Disabled

No

vaai-tp-alerts

VAAI TP Alerts

Enabled or Disabled

No

tag-list

Tag ID list

List of IDs: Name or Index

No

EMC XtremIO Storage Array User Guide

CLI Guide

modify-volume
The modify-volume command modifies a Volumes parameters.
Input Parameter

Description

Value

Mandatory*

vol-id

Volume ID

Name or index

Yes

small-io-alerts

Small I/O alerts

Enabled or Disabled

One from Group1

unaligned-io-alerts

Unaligned I/O alerts

Enabled or Disabled

One from Group1

vaai-tp-alerts

VAAI TP alerts

Enabled or Disabled

One from Group1

vol-access

Volume access rights

no_access - only SCSI


discovery command
can succeed. Write
and read commands
will fail

One from Group1

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

Volume name

String (up to 128


characters)

One from Group1

vol-size

Volume size

Integer suffixed by
[mgtpk]. Volume size
must be in multiples of
8K.

One from Group1

cluster-id

Cluster ID

Name or Index

No

*)Group1: [small-io-alerts, unaligned-io-alerts, vaai-tp-alerts, vol-access, vol-name, vol-size]

remove-volume
The remove-volume command removes a Volume.
Input Parameter

Description

Value

Mandatory

vol-id

Volume ID

Name or index

Yes

cluster-id

Cluster ID

Name or Index

No

Provisioning

443

CLI Guide

show-volumes
The show-volumes command displays the list of Volumes and related information.

444

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


Index

No

Output Parameter

Description

Volume-Name

The Volumes name

Index

The Volumes index number

Cluster-Name

The name of the cluster to which the Volume belongs

Index

The clusters index number

Vol-Size

The Volumes provisioned disk space

LB-Size

The logical block size in bytes

VSG-Space-In-Use

The total user data space written to the Volume Snapshot Group
before deduplication and compression

Offset

The Volumes 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 if there is a pending command associated with the


Volume.

Created-By-Application

The application that created the Volume (XMS, Scheduler)

EMC XtremIO Storage Array User Guide

CLI Guide

Output Parameter

Description

Volume-Type

The Volume type (regular, read-only)

Creation-Time

The date and time of the Volume or Snapshot creation

Vol-Access

Access permissions to the Volume (no_access, read_access or


write_access)

show-volume
The show-volume command displays the specified Volumes information.
Input Parameter

Description

Value

Mandatory

vol-id

Volumes 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

Output Parameter

Description

Volume-Name

The Volumes name

Index

The Volumes index number

Vol-Size

The Volumes block size

LB-Size

The Volumes type

VSG-Space-In-Use

The total user data space written to the Volume Snapshot Group
before deduplication and compression

Offset

The Volumes defined alignment offset

Created-From-Volume

The Volume that was the Snapshot source for this volume

VSG-Index

The Volume Snapshot Groups index

Cluster-Name

The name of the cluster to which the Volume belongs

Index

The clusters 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.

Created-By-Application

The application that created the Volume (XMS, Scheduler)

Volume-Type

The Volume type (regular, read-only)


Provisioning

445

CLI Guide

Output Parameter

Description

NAA-Identifier

The SCSI Network Address Authority (NAA) identifier for the Volume,
as exposed to the Initiators

Certainty-State

Indicates if there is a pending command associated with the


Volume.

Tags

The list of Tags assigned to the Volume

Creation-Time

The date and time of the Volume or Snapshot creation

Vol-Access

Access permissions to the Volume (no_access, write_access or


read_access)

show-volume-snapshot-groups
The show-volume-snapshot-groups command displays the list of Volumes with
their associated Snapshots and their parameters.

446

Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

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 if 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 if Snapshots are currently being deleted or merged


(i.e. more Snapshots can be created soon).

EMC XtremIO Storage Array User Guide

CLI Guide

create-snapshot
The create-snapshot command creates a Snapshot from a specified Volume.
Input Parameter

Description

Value

Mandatory*

consistency-group-id

Consistency Group ID

Name or Index

One from Group 1

snapshot-set-id

Snapshot Set ID

Name or Index

One from Group 1

tag-list

Tag ID list

List of IDs: Name or


Index

One from Group 1

volume-list

Volume list

List of IDs: Name or


Index

One from Group 1

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 (default) or
readonly

No

*)Group 1: [consistency-group-id, snapshot-set-id, tag-list, volume-list]

Provisioning

447

CLI Guide

create-snapshot-and-reassign
The create-snapshot-and-reassign 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.
Input Parameter

Description

Value

Mandatory*

from-consistency-grou
p-id

ID of the Consistency
Group being snapped

Name or Index

One from Group1

from-snapshot-set-id

ID of the Snapshot Set


being snapped

Name or Index

One from Group1

from-snapshot-set-tag- ID of the Tag assigned


id
to the Snapshot Set
being snapped

Name or Index

One from Group1

from-volume-id

ID of the Volume being


snapped

Name or Index

One from Group1

to-consistency-group-i
d

ID of the target
Consistency Group

Name or Index

One from Group2

to-snapshot-set-id

ID of the target
Snapshot Set

Name or Index

One from Group2

to-snapshot-set-tag-id

ID of the Tag assigned


to the target Snapshot
Set

Name or Index

One from Group2

to-volume-id

ID of the target Volume Name or Index

One from Group2

no-backup

Remove source object

N/A

No

snapshot-set-name

Created Snapshot Set


name

String

No

backup-snap-suffix

Snapshot name suffix

String

No

backup-snapshot-type

Snapshot type

readonly, regular

No

cluster-id

Cluster ID

Name or Index

No

*)Group1: [from-consistency-group-id, from-snapshot-set-id, from-snapshot-set-tag-id,


from-volume-id]
*)Group2: [to-consistency-group-id, to-snapshot-set-id, to-snapshot-set-tag-id, to-volume-id]

448

EMC XtremIO Storage Array User Guide

CLI Guide

show-snapshots
The show-snapshots command displays the list of Snapshots and related information.
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


Index

No

Output Parameters

Description

Volume-Name

The Volumes name

Index

The Volumes index number

Cluster-Name

The name of the cluster to which the Volume belongs

Index

The clusters index number

Vol-Size

The Volumes provisioned disk space

LB-Size

The Volumes type

VSG-Space-In-Use

The total user data space written to the Volume Snapshot Group
before deduplication and compression

Offset

The Volumes 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 if there is a pending command associated with the


Initiator.

Created-By-Application

The application that created the Snapshot (XMS, Scheduler)

Provisioning

449

CLI Guide

Output Parameters

Description

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)

clear-volume-reservation
The clear-volume-reservation command removes LUN reservations to release
them for access.
Input Parameter

Description

Value

Mandatory

vol-id

Volume ID

Name or index

Yes

cluster-id

Cluster ID

Name or Index

No

show-most-active-volumes
The show-most-active-volumes command displays performance data of the most
active Volumes.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

sort-by

Filtering criteria

bw or iops

No

Output Parameter

Description

Name

The Volumes name

Index

The Volumes 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

450

Cluster-Name

The Clusters name

Index

The Clusters index number

EMC XtremIO Storage Array User Guide

CLI Guide

show-most-active
The show-most-active command displays the most active Volumes and Initiator
Groups.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

sort-by

Filtering criteria

bw or iops

No

The output is displayed for most active Volumes and most active Initiator Groups.
Output Parameter

Description

Volume-Name

The components name

Index

The components index

Write-BW (MB/s)
Read-BW (MB/s)
Write-IOPS
Read-IOPS

These properties indicate the current Bandwidth/IOPS.

BW (MB/s)
IOPS
Cluster-Name

The Clusters name

Index

The Clusters index number

Snapshot Set Management


remove-snapshot-set
The remove-snapshot-set command deletes a Snapshot set.
Input Parameter

Description

Value

Mandatory

ss-id

Snapshot Set Index


number

Name or Index

Yes

cluster-id

Cluster ID

Name or Index

No

Provisioning

451

CLI Guide

show-snapshot-set
The show-snapshot-set command displays the parameters of the specified Snapshot
Set.

452

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

Output Parameters

Description

Name

The Snapshot Sets name

Index

The Snapshot Sets index number

Cluster-Name

The clusters name

Index

The clusters index number

Consistency-Group-Name

The Consistency Groups name

CG-ID

The Consistency Groups index number

Num-of-Vols

The number of snapped Volumes in the Snapshot Set

Creation-Time

The Snapshot Sets date and time of creation

Volume-List

The list of snapped Volumes in the Snapshot Set

Tags

The list of Tags assigned to the Snapshot Set

EMC XtremIO Storage Array User Guide

CLI Guide

show-snapshot-sets
The show-snapshot-sets command displays the list of Snapshot sets and related
information.
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


Index

No

vertical

Vertical layout

N/A

No

Output Parameters

Description

Name

The Snapshot Sets name

Index

The Snapshot Sets index number

Cluster-Name

The clusters name

Index

The clusters index number

Consistency-Group-Name

The Consistency Groups name

CG-ID

The Consistency Groups index number

Num-of-Vols

The number of snapped Volumes in the Snapshot Set

Creation-Time

The Snapshot Sets date and time of creation

Volume-List

The list of snapped 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-from-consistency-group command adds a Volume to a
Consistency Group.
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

Provisioning

453

CLI Guide

remove-volume-from-consistency-group
The remove-volume-from-consistency-group command removes a Volume from
a Consistency Group.
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

create-consistency-group
The create-consistency-group command creates a new Consistency Group.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

Name or Index

No

consistency-group-name

Consistency Group name String

No

tag-list

Tag ID list

List of ids: Name or


Index

No

vol-list

Object ID list

List of ids: Name or


Index

No

remove-consistency-group
The remove-consistency-group command deletes a Consistency Group.

454

Input Parameter

Description

Value

Mandatory

cg-id

Consistency Group ID

Name or Index

Yes

cluster-id

Cluster ID

Name or Index

No

EMC XtremIO Storage Array User Guide

CLI Guide

modify-consistency-group-volumes
The modify-consistency-group-volumes command modifies the Volume type for
the specified a Consistency Group.
Input Parameter

Description

Value

Mandatory

cg-id

Consistency Group ID

Name or Index

Yes

vol-access

Volume access rights

no_access - Only SCSI


discovery command
can succeed. Write
and read commands
will fail.

One from Group1

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

show-consistency-group
The show-consistency-group command displays the parameters of the specified
Consistency Group.
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

Output Parameters

Description

Name

The Consistency Groups name

Index

The Consistency Groups index number

Cluster-Name

The clusters name

Index

The clusters index number

Volume-List

The Consistency Groups members list

Tags

The Consistency Groups associated Tags

Created-By-Application

The appication that created the Consistency Group

Certainty-State

Indicates if there is a pending command associated with the


Consistency Group.

Provisioning

455

CLI Guide

show-consistency-groups
The show-consistency-groups command displays the parameters of all defined
Consistency Groups.
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


Index

No

Output Parameters

Description

Name

The Consistency Groups name

Index

The Consistency Groups index number

Cluster-Name

The clusters name

Index

The clusters 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 if there is a pending command associated with the


Consistency Group.

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 command adds an Initiator Group and its associated
Initiators to the XtreamIO cluster.

456

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
Initiators (name and
port number)

[initiator-name=value
port-address=value,...]
(port-address is the Initiator
iQN or WWN)

No

tag-list

Tag ID list

List of IDs: Name or Index

No

EMC XtremIO Storage Array User Guide

CLI Guide

remove-initiator-group
The remove-initiator-group command deletes an Initiator Group.
Input Parameter

Description

Value

Mandatory

ig-id

Initiator Group ID

Name or index

Yes

cluster-id

Cluster ID

Name or INdex

No

show-initiator-group
The show-initiator-group command displays information for a specific Initiator
Group.
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

Output Parameter

Description

IG-Name

The Initiator Groups name

Index

The Initiator Groups 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-State

Indicates if there is a pending command associated with the


Initiator Group.

Tags

The Tags assigned to the Initiator Group (full path name and index)

Provisioning

457

CLI Guide

show-initiator-groups
The show-initiator-groups command displays information for a all Initiator
Groups.

458

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


Index

No

Output Parameter

Description

IG-Name

The Initiator Groups name

Index

The Initiator Groups index number

Cluster-Name

The Initiator Groups Cluster name

Index

The Initiator Groups Cluster index number

Num-of-Initiators

Number of Initiators in the group

Num-of-Vols

Number of Volumes mapped to the Initiator Group

Certainty-State

Indicates if there is a pending command associated with the


Initiator Group.

EMC XtremIO Storage Array User Guide

CLI Guide

show-most-active-initiator-groups
The show-most-active-initiator-groups command displays performance data
of the most active Initiator Groups.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

sort-by

Filtering criteria

bw or iops

No

Output Parameter

Description

IG-Name

Initiator Groups name

Index

Initiator Groups 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
Cluster-Name

The Clusters name

Index

The Clusters index number

Provisioning

459

CLI Guide

add-initiator
The add-initiator command adds an Initiator and associates it with an existing
Initiator Group.
Input Parameter

Description

Value

Mandatory

ig-id

Initiator Group ID

name or index

Yes

port-address

Port address (iQNs or


WWNs)

String

Yes

cluster-authentication- CHAP authentication


password
cluster password

String

No

cluster-authentication- CHAP authentication


user-name
cluster user name

String

No

CHAP discovery cluster


password

String

No

cluster-discovery-user- CHAP discovery cluster


name
user name

String

No

cluster-id

Cluster ID

Name or Index

No

initiator-authenticatio
n-password

CHAP authentication
password

String

No

initiator-authenticatio
n-user-name

CHAP authentication
user name

String

No

initiator-discovery-pas
sword

CHAP discovery
password

String

No

initiator-discovery-use
r-name

CHAP discovery user


name

String

No

initiator-name

Initiator name

String

No

operating-system

Operating system

linux, windows, esx,


solaris, aix, hpux,
other

No

cluster-discovery-pass
word

remove-initiator
The remove-initiator command deletes an Initiator.

460

Input Parameter

Description

Value

Mandatory

initiator-id

Initiator ID

Name or index

Yes

cluster-id

Cluster ID

Name or Index

No

EMC XtremIO Storage Array User Guide

CLI Guide

modify-initiator
The modify-initiator command modifies the properties of an existing Initiator.
Input Parameter

Description

Value

Mandatory*

initiator-id

Initiator ID

Name or index

Yes

cluster-authentication- CHAP authentication


password
cluster password

String

One from Group 1

cluster-authentication- CHAP authentication


user-name
user name

String

One from Group 1

String

One from Group 1

cluster-discovery-user- CHAP discovery user


name
name

String

One from Group 1

initiator-authenticatio
n-password

CHAP authentication
password

String

One from Group 1

initiator-authenticatio
n-user-name

CHAP authentication
user name

String

One from Group 1

initiator-discovery-pas
sword

CHAP discovery
password

String

One from Group 1

initiator-discovery-use
r-name

CHAP discovery user


name

String

One from Group 1

initiator-name

Initiator name

String

One from Group 1

operating-system

Operating system

linux, windows, esx,


solaris, aix, hpux,
other

One from Group 1

port-address

Port address

String

One from Group 1

remove-cluster-authen Remove CHAP cluster


tication-credentials
authentication
credentials.

N/A

One from Group 1

remove-cluster-discov
ery-credentials

Remove CHAP cluster


discovery credentials.

N/A

One from Group 1

remove-initiator-authe
ntication-credentials

Remove CHAP Initiator


authentication
credentials.

N/A

One from Group 1

remove-initiator-disco
very-credentials

Remove CHAP Initiator


discovery credentials.

N/A

One from Group 1

cluster-id

Cluster ID

Name or Index

No

cluster-discovery-pass
word

CHAP discovery
password

*)Group 1:
[cluster-authentication-password,cluster-authentication-user-name,cluster-discovery-password,
cluster-discovery-user-name,initiator-authentication-password,initiator-authentication-user-nam
e,initiator-discovery-password,initiator-discovery-user-name,initiator-name,operating-system,
port-address,remove-cluster-authentication-credentials,remove-cluster-discovery-credentials,r
emove-initiator-authentication-credentials,remove-initiator-discovery-credentials]

Provisioning

461

CLI Guide

show-initiators
The show-initiators command displays Initiators data.

462

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

Output Parameter

Description

Initiator-Name

The Initiators name

Index

The Initiators index number

Cluster-Name

The Clusters name

Index

The Clusters index number

Port-Type

The Initiators port type (iSCSI or FC)

Port-Address

The Initiators port address (WWN or iQN)

IG-Name

The associated Initiator Groups name

Index

The associated Initiator Groups index number

Certainty-State

Indicates if there is a pending command associated


with the Initiator.

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 Initiators operating system (linux, windows,


esx, solaris, aix, hpux, other)

EMC XtremIO Storage Array User Guide

CLI Guide

Scheduler Management
create-scheduler
The create-scheduler command creates a new Snapshot scheduler. Refer to
Scheduler Type and Time Parameters on page 277 for details on the scheduler-type
and time parameters.
Input Parameter

Description

Value

Mandatory*

scheduler-type

Scheduler type

Interval or Explicit

Yes

snapshot-object-id

Snapped object ID

Name or Index

Yes

snapshot-object-type

The object whose


Snapshot is taken
(Consistency Group,
Volumes/Snapshot,
Snapshot Set)

String

Yes

time

Schedule for Snapshot


creation

String in [h:m:s]
format for interval
mode and [d:h:m] for
explicit mode

Yes

snapshots-to-keep-nu
mber

Number of Snapshots
to keep

Integer

One from Group 1

snapshots-to-keep-tim Timeframe for keeping


e
Snapshots

Integer with [Mhdmy]


(minute - hour - day month - year) suffix

One from Group 1

cluster-id

Cluster ID

Name or Index

No

enabled-state

Indicates if scheduler
is enabled.

enabled / user
disabled

No

snapshot-type

Snapshot type

String

No

suffix

Snapshot name suffix

String

No

*)Group1: [snapshots-to-keep-number, snapshots-to-keep-time]

Provisioning

463

CLI Guide

modify-scheduler
The modify-scheduler command modifies a Snapshot schedulers parameters. Refer
to Scheduler Type and Time Parameters on page 277 for details on the
scheduler-type and time parameters.
Input Parameter

Description

Value

Mandatory*

scheduler-id

Scheduler ID

Name or index

Yes

scheduler-type

Scheduler type

Interval or Explicit

One from Group 1

snapshot-object-id

Snapped object ID

Name or Index

One from Group 1

snapshot-object-type

Class

String

One from Group 1

snapshot-type

Snapshot type

String

One from Group 1

snapshots-to-keep-nu
mber

Number of Snapshots
to keep

Integer

One from Group 1

snapshots-to-keep-tim Time frame for keeping


e
Snapshots

Integer with [hdy]


suffix

One from Group 1

suffix

Snapshot name suffix

String

One from Group 1

time

Schedule for Snapshot


creation

String in [h:m:s]
format for interval
mode and [d:h:m] for
explicit mode

One from Group 1

cluster-id

Cluster ID

Name or Index

No

*)Group1: [scheduler-type, snapshot-object-id, snapshot-object-type, snapshot-type,


snapshots-to-keep-number, snapshots-to-keep-time, suffix, time]

remove-scheduler
The remove-scheduler command deletes a Snapshot scheduler.
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
Sets

N/A

No

resume-scheduler
The resume-scheduler command resumes the activity of a suspended Scheduler.

464

Input Parameter

Description

Value

Mandatory

scheduler-id

Scheduler ID

Name or index

Yes

cluster-id

Cluster ID

Name or Index

No

EMC XtremIO Storage Array User Guide

CLI Guide

suspend-scheduler
The suspend-scheduler command suspends the activity of an active Scheduler.
Input Parameter

Description

Value

Mandatory

scheduler-id

Scheduler ID

Name or index

Yes

cluster-id

Cluster ID

Name or Index

No

show-scheduler
The show-scheduler command displays the parameters of a specified Scheduler.
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

Output Parameters

Description

Name

The schedulers name

Index

The schedulers index number

Snapped-Object-Name

The name of the snapped object

Snapped-Object-Index

The ID of the snapped object

Snapped-Object-Type

The type of the snapped 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

Enabled-State

The schedulers state

Last-Activation-Time

The schedulers last activation time

Last-Activation-Status

The schedulers last activation status

Provisioning

465

CLI Guide

show-schedulers
The show-schedulers command displays the defined Schedulers parameters.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameters

Description

Name

The schedulers name

Index

The schedulers index number

Snapped-Object-Index

The ID of the snapped object

Snapped-Object-Type

The type of the snapped 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

Enabled-State

The schedulers state

Last-Activation-Time

The schedulers last activation time

Last-Activation-Status

The schedulers last activation status

Target Management
modify-target
The modify-target command modifies a Target parameters.

466

Input Parameter

Description

Value

Mandatory

mtu

Maximum transmission unit size

Integer

Yes

tar-id

The Targets name or index number

Name or index

Yes

cluster-id

Cluster ID

Name or Index

No

EMC XtremIO Storage Array User Guide

CLI Guide

show-targets
The show-targets command displays the cluster Targets interfaces (iSCSI or FC ports).
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

Output Parameter

Description

Name

The Targets name

Index

The Targets index number

Cluster Name

The relevant clusters name

Index

The relevant clusters index

Port-Type

The Targets port type (FC or iSCSI)

Port-Address

The Targets port address

Mac-Addr

The MAC (Ethernet) address of the iSCSI Target port

Port-Speed

The actual ports speed

Port-State

The ports state: up or down

Health-Level

Indicates 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 Controllers index number

TG-Name

The name of the Target Group to which the Target belongs

Index

The Target Groups index number

MTU

Maximum transmission unit size

Jumbo-Frames

Indicates whether jumbo frames are enabled.

Certainty-State

Indicates if there is a pending command associated with the


Target.

Relative-Id

A port ID for backward compatibility

Provisioning

467

CLI Guide

modify-target-group
The modify-target command modifies a Target Groups parameters.
Input Parameter

Description

Value

Mandatory

mtu

Maximum transmission unit size

Integer

Yes

tg-id

Target Group ID

Name or index

Yes

cluster-id

Cluster ID

Name or Index

No

show-target-groups
The show-target-groups command displays the list of Target Groups.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

id: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

TG-Name

The Target Groups name

Index

The Target Groups index number

Cluster-Name

The name of the cluster to which the Target Group is related

Index

The clusters index number

LUN Mapping
map-lun
The map-lun command maps a Volume to an Initiator Group and assigns a Logical Unit
Number (LUN) to it.

468

Input Parameter

Description

Value

Mandatory

vol-id

Volume ID

Name or ID

Yes

ig-id

Initiator Group ID

Name or Index. If
omitted, means
"undefined initiators".

Yes

lun

The number of the logical unit


as exposed to the host
Initiator.
Host/OS may place limits on
the allowed maximum value.

Integer

No

tg-id

Target group ID

Name or ID

No

cluster-id

Cluster ID

id: Name or Index

No

EMC XtremIO Storage Array User Guide

CLI Guide

show-lun-mappings
The show-lun-mappings command displays the LUN mapping information between
Volumes and Initiators.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

ig-id

Initiator Group ID

Name or Index

No

vol-id

Volume ID

Name or Index

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters index

Volume-Name

The mapped Volumes name

Index

The mapped Volumes index number

IG-Name

The mapped Initiator Groups name

Index

The mapped Initiator Groups index number

TG-Name

The mapped Target Groups name

Index

The mapped Target Groups index number

LUN

The LUN value

Mapping-Index

The mapping index number

Certainty-State

Indicates if there is a pending command associated with the object.

unmap-lun
The unmap-lun command removes a Volumes LUN mappings.
Input Parameter

Description

Value

Mandatory*

vol-id

Volume ID

Name or index

Yes

all

All mappings

N/A

One from
Group 1

ig-id

Initiator Group ID

Name or index. If omitted, it


means undefined initiators.

One from
Group 1

tg-id

Target Group ID

Name or index

No

cluster-id

Cluster ID

id: Name or Index

No

*) Group 1: [all, ig-id]

Provisioning

469

CLI Guide

iSCSI Management
add-iscsi-portal
The add-iscsi-portal maps a portal (a combination of an IP address, IP port, and
optionally a VLAN) to a Target. This mapping enables the Target port to accept iSCSI traffic
via the portal.
Note: iSCSI Targets cannot have the same subnet as the management network.
Input Parameter

Description

Value

Mandatory

ip-addr

Portal IP Address

IP Address/Subnet Bits

Yes

tar-id

Target ID

Name or index

Yes

vlan

VLAN ID

0 (no VLAN tag) to 4094

No

cluster-id

Cluster ID

id: Name or Index

No

add-iscsi-route
The add-iscsi-route command adds and configures iSCSI route parameters.
Input Parameter

Description

Value

Mandatory

destination-network- Destination network


and mask
and-mask

Destination network/mask

Yes

gateway

Gateway IP Address

IP Address

Yes

iscsi-route-name

iSCSI Route name

String

No

cluster-id

Cluster Index
number

Name or Index

No

modify-iscsi-portal
The modify-iscsi-portal command modifies an iSCSI portal parameters.
Input Parameter

Description

Value

Mandatory*

portal-id

Portal ID

Index

Yes

ip-addr

Portal IP address

IP address/subnet bits

One from Group 1

vlan

VLAN ID

Integer

One from Group 1

cluster-id

Cluster Index
number

Name or Index

No

*)Group 1: [ip-addr, vlan]

470

EMC XtremIO Storage Array User Guide

CLI Guide

remove-iscsi-portal
The remove-iscsi-portal command deletes a portal mapping from a Target. The
Target will no longer receive iSCSI traffic via the portal.
Input Parameter

Description

Value

Mandatory

ip-addr

Portals IP Address

IP Address/
Subnet Bits

Yes

cluster-id

Cluster ID

id: Name or Index

No

remove-iscsi-route
The remove-iscsi-route command deletes an iSCSI routing configuration.
Input Parameter

Description

Value

Mandatory

iscsi-route-id

iSCSI route id

Name or index

Yes

cluster-id

Cluster ID

id: Name or Index

No

show-iscsi-portals
The show-iscsi-portals command displays the list of iSCSI portals and their
properties.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

id: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters index

Portal-Index

The Target portal index

Target-Name

The Target port name

Index

The ports index number

IP-Address

The portals IP address

Port-Address

The ports address

VLAN

The ports virtual LAN

Certainty-State

Indicates if there is a pending command associated with the iSCSI


portal.

Provisioning

471

CLI Guide

show-iscsi-routes
The show-iscsi-routes command displays the list of iSCSI routes and their
properties.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

id: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Name

The routes name

Index

The routes index number

Cluster-Name

The clusters name

Index

The clusters index number

Destination-Network-and-Mask

The routes destination subnet

Gateway

The routes gateway

Certainty-State

Indicates if there is a pending command associated with the


iSCSI route.

show-chap
The show-chap command displays the clusters configured CHAP authentication and
discovery modes.

472

Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters 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)

EMC XtremIO Storage Array User Guide

CLI Guide

modify-chap
The modify-chap command modifies the CHAP configuration parameters.
Input Parameter

Description

Value

Mandatory*

chap-authenticationmode

CHAP Authentication
Mode

Disabled, Initiator, Initiator


and Target

One from
Group 1

chap-discovery-mode

CHAP Discovery Mode

Disabled, Initiator, Initiator


and Target

One from
Group 1

cluster-ID

Cluster Identification

Name or Index

No

*) Group 1: [chap-authentication-mode, chap-discovery-mode]

Provisioning

473

CLI Guide

Data Protection Group Management


show-data-protection-groups
The show-data-protection-groups command displays XDP groups status and
information.
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

Output Parameter

Description

Name

The Data Protection Groups name

Index

The Data Protection Groups index number

Cluster-Name

The clusters name

Index

The clusters index number

State

The Data Protection Groups 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.

474

Rebuild-Prevention

Indicates if a rebuild was prevented due to insufficient user data


space.

Brick-Name

The X-Bricks name

Index

The X-Bricks index number

EMC XtremIO Storage Array User Guide

CLI Guide

Cluster Data and Status


Alerts and Events
add-event-handler-definition
The add-event-handler-definition command adds a definition to an event
handling rule.
Input Parameter

Description

Value

Mandatory

actions

Action list

List of actions: email, snmp.

Yes

category

Event category

audit, state_change,
hardware, activity, security,
lifecycle, software

Yes

entity

Entity

String

No

entity-details

Entity Id

Name or index

No

related-alert-code

Related alert code

Alert code number

No

severity

Severity level

information, major, critical,


minor

No

modify-event-handler-definition
The modify-event-handler-definition command modifies the definition of
event handling rules.
Input Parameter

Description

Value

Mandatory

actions

Action list

List of actions to perform:


email, SNMP

Yes

event-handler-id

Event handler
definition ID

ID

Yes

category

Event category

audit, state_change,
hardware, activity, security,
lifecycle, software

No

entity

Entity

String

No

entity-details

Entity ID

Name or index

No

related-alert-code

Related Alert Code

Alert code number

No

severity

Severity level

information, major, critical,


minor

No

remove-event-handler-definition
The remove-event-handler-definition command deletes event handling rule
definitions.
Input Parameter

Description

Value

Mandatory

event-handler-id

Event handler
definition ID

ID

Yes

Cluster Data and Status

475

CLI Guide

show-event-handler-definitions
The show-event-handler-definitions command displays the event handling rule
definitions.
Output Parameter

Description

ID

Events ID

Actions

Events action (email, SNMP, log)

category

Events category

Severity

Events severity level (Information, Major, Critical, Minor)

Entity

Events associated entity

Entity-Details

Entitys details

Related-Alert-Code

The related alert code

show-event-details
The show-event-details command displays the details of the specified event.

476

Input Parameter

Description

Value

Mandatory

event-id

Event ID

Positive Integer

Yes

full-object

Full Object

N/A

No

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

EMC XtremIO Storage Array User Guide

CLI Guide

show-events
The show-events command displays cluster and XMS events. The input parameters are
filters that limit the displayed output.
Input Parameter

Description

Value

Is Mandatory

category

Event category

audit, state_change,
hardware, activity, security,
lifecycle, software

No

cluster-id

Cluster ID

Name or Index

No

entity

Events associated
entity

String

No

entity-details

Entity ID

Name or index

No

free-text

Free text search

String

No

from-date-time

Date and time start


point

date/time format:
"2013-11-23","2013-11-23
10:14:15" "2013-11-23
10:14:15.123"

No

from-event-id

Positive integer
Shows events
following this event id.

No

limit

Maximum number of
records to display that
adhere to all the filter
criteria

Integer

No

prop-list

Allows to show more


or less properties than
the default output
parameters.

List of strings

No

severity

Severity level

Information, Major, Critical,


Minor

No

to-date-time

Date and time end


time

date/time format:
"2013-11-23","2013-11-23
10:14:15" "2013-11-23
10:14:15.123"

No

vertical

Displays the command


output in a
non-tabular format
(vertical lines).

vertical
(e.g. show-events vertical)

No

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

Cluster Data and Status

477

CLI Guide

Output Parameter

Description

Severity

Event severity level

Cluster ID

Cluster Index Number

Entity

The entity to which the event refers

Entity Details

Entity details

Description

Event description

acknowledge-alert
The acknowledge-alert command acknowledges an alert and removes it from the
dashboard Active Alerts list. The alert remains in the Alert List window. Alerts with Clear
Mode set to Acknowledge Required, remain in the Alert List until they are acknowledged.
Input Parameter

Description

Value

Mandatory

alert-id

Index number of the


alert to acknowledge

Name or index

Yes

modify-alert-definition
The modify-alert-definition command modifies alert definition properties for a
specified alert type.
Input Parameter

Description

Value

Mandatory*

alert-type

Alert type

All defined alerts

Yes

activity-mode

Monitor duration

disabled, enabled

One from
Group 1

clearance-mode

Clearance mode

auto-clear,
ack-required

One from
Group1

send-to-call-home

Send to Call-Home

Send SYR notification


upon raise

One from
Group1

severity

Severity level

information, minor,
major, critical

One from
Group1

threshold

Threshold value

Range 0 - 100

One from
Group1

*)Group 1: [activity-mode, clearance-mode, send-to-call-home, severity, threshold]

478

EMC XtremIO Storage Array User Guide

CLI Guide

show-alert-definitions
The show-alert-definitions command displays a list of pre-defined alerts and
their definitions.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Alert-Type

The alerts type

Short-Description

The alerts description

Activity-Mode

Indicates if to issue an alert upon state change.

Clearance-Mode

The alerts clearance mode:


Acknowledgment required
Auto clear

Severity

If no threshold is defined, it indicates the alert severity level.

Alert-Code

The alerts unique code

Send-To-Call-Home

Sends SYR notification when the alert is raised.

Use-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

479

CLI Guide

show-alerts
The show-alerts command displays a list of active alerts and their details.

480

Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

id: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Index

The alerts ID

Description

The alerts description

Severity

The alerts 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 components name

Index

The components index number

Cluster-Name

The clusters name

Index

The clusters index

Alert-Type

The alerts type

State

The alerts status

Alert-Code

The alerts code number

EMC XtremIO Storage Array User Guide

CLI Guide

Performance
export-performance-history
The export-performance-history command exports the clusters performance
history to CSV file. The exported data can be up to seven days back. Records interval is five
seconds.
Input Parameter

Description

Value

Mandatory

filename

Name of the export file

String

No

utc

Timestamps in UTC or local


time

N/A

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

Cluster Data and Status

481

CLI Guide

show-clusters-performance
The show-clusters-performance command displays clusters performance data.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters index number

Write-BW (MB/s)
Read-BW (MB/s)
Write-IOPS
Read-IOPS
BW (MB/s)

These properties indicate the current Bandwidth/IOPS.

IOPS
Total-Write-IOs
Total-Read-IOs

show-clusters-performance-latency
The show-clusters-performance-latency command displays clusters
performance latency data.

482

Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters 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)

EMC XtremIO Storage Array User Guide

CLI Guide

show-clusters-performance-small
The show-clusters-performance-small command displays clusters performance
data for small (under 4KB) blocks.
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters index number

S-Write-BW (MB/s)
S-Read-BW (MB/s)
S-Write-IOPS
S-Read-IOPS
S-BW (MB/s)

These properties indicate the current Bandwidth/IOPS of I/Os


which are smaller than 4KB.

S-IOPS
Total-S-Write-IOs
Total-S-Read-IOs

Cluster Data and Status

483

CLI Guide

show-clusters-performance-unaligned
The show-clusters-performance-unaligned command displays clusters
performance data for unaligned blocks (I/O blocks whose size is not a multiplication of
4KB or which have an offset).
Input Parameter

Description

Value

Mandatory

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Cluster-Name

The clusters name

Index

The clusters index number

U-Write-BW (MB/s)
U-Read-BW (MB/s)
U-Write-IOPS
U-Read-IOPS
U-BW (MB/s)
U-IOPS
Total-U-Write-IOs
Total-U-Read-IOs

484

EMC XtremIO Storage Array User Guide

These properties indicate the current Bandwidth/IOPS of unaligned


I/Os which are greater than 4KB.

CLI Guide

show-initiator-groups-performance
The show-initiator-groups-performance command displays Initiator groups
performance data.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

IG-Name

Initiator Group name

Index

Initiator Group index

Cluster-Name

The Clusters name

Index

The Clusters index number

Write-BW (MB/s)
Write-IOPS
Read-BW (MB/s)
Read-IOPS
BW (MB/s)

These properties indicate the current Bandwidth/IOPS.

IOPS
Total-Write-IOs
Total-Read-IOs

Cluster Data and Status

485

CLI Guide

show-initiator-groups-performance-small
The show-initiator-groups-performance-small command displays Initiator
Groups performance data for small (under 4KB) blocks.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

IG-Name

The Initiator Groups name

Index

The Initiator Groups index

Cluster-Name

The Clusters name

Index

The Clusters index number

S-Write-BW (MB/s)
S-Write-IOPS
S-Read-BW (MB/s)
S-Read-IOPS
S-BW (MB/s)
S-IOPS
Total-S-Write-IOs
Total-S-Read-IOs

486

EMC XtremIO Storage Array User Guide

These properties indicate the current Bandwidth/IOPS of I/Os


which are smaller than 4KB.

CLI Guide

show-initiator-groups-performance-unaligned
The show-initiator-groups-performance-unaligned command displays
Initiator Groups performance data for unaligned blocks (I/O blocks whose size is not a
multiplication of 4KB or which have an offset).
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

IG-Name

The Initiator Groups name

Index

The Initiator Groups index

Cluster-Name

The Clusters name

Index

The Clusters index number

U-Write-BW (MB/s)
U-Write-IOPS
U-Read-BW (MB/s)
U-Read-IOPS
U-BW (MB/s)

These properties indicate the current Bandwidth/IOPS of unaligned


I/Os which are greater than 4KB I/Os.

U-IOPS
Total-U-Write-IOs
Total-U-Read-IOs

Cluster Data and Status

487

CLI Guide

show-initiators-performance
The show-initiators-performance command displays Initiators performance
data.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Initiator-Name

The Initiators name

Index

The Initiators index number

Write-BW (MB/s)
Write-IOPS
Read-BW (MB/s)
Read-IOPS
BW (MB/s)
IOPS
Total-Write-IOs
Total-Read-IOs

488

EMC XtremIO Storage Array User Guide

These properties indicate the current Bandwidth/IOPS.

CLI Guide

show-initiators-performance-small
The show-initiators-performance-small command displays Initiators
performance data for small (under 4KB) block sizes.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Initiator-Name

The Initiators name

Index

The Initiators index number

S-Write-BW (MB/s)
S-Write-IOPS
S-Read-BW (MB/s)
S-Read-IOPS
S-BW (MB/s)

These properties indicate the current Bandwidth/IOPs of I/Os


which are smaller than 4KB.

S-IOPS
Total-S-Write-IOs
Total-S-Read-IOs

Cluster Data and Status

489

CLI Guide

show-initiators-performance-unaligned
The show-initiators-performance-unaligned command displays Initiators
performance data for unaligned data block (I/O blocks whose size is not a multiplication
of 4KB or which have an offset).
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Initiator-Name

The Initiators name

Index

The Initiators index number

u-Write-BW (MB/s)
u-Write-IOPS
u-Read-BW (MB/s)
u-Read-IOPS
u-BW (MB/s)
u-IOPS
Total-U-Write-IOs
Total-U-Read-IOs

490

EMC XtremIO Storage Array User Guide

These properties indicate the current Bandwidth/IOPS of unaligned


I/Os which are greater than 4KB I/Os

CLI Guide

show-ssds-performance
The show-ssds-performance command displays SSDs performance data.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Name

The SSDs name

Index

The SSDs index number

Cluster-Name

The Clusters name

Index

The Clusters 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

Cluster Data and Status

491

CLI Guide

show-target-groups-performance
The show-target-groups-performance command displays Target Groups
performance data.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

TG-Name

The Target Groups name

Index

The Target Groups index number

Cluster-Name

The Clusters name

Index

The Clusters index number

Write-BW (MB/s)
Read-BW (MB/s)
Write-IOPS
Read-IOPS
BW (MB/s)
IOPS
Total-Write-IOs
Total-Read-IOs

492

EMC XtremIO Storage Array User Guide

These properties indicate the current Bandwidth/IOPS.

CLI Guide

show-target-groups-performance-small
The show-target-groups-performance-small command displays Target Groups
performance data for small (under 4KB) blocks.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

TG-Name

The Target Groups name

Index

The Target Groups index number

S-Write-BW (MB/s)
S-Read-BW (MB/s)
S-Write-IOPS
S-Read-IOPS
S-BW (MB/s)

These properties indicate the current Bandwidth/IOPS of I/Os


which are smaller than 4KB.

S-IOPS
Total-S-Write-IOs
Total-S-Read-IOs

Cluster Data and Status

493

CLI Guide

show-target-groups-performance-unaligned
The show-target-groups-performance-unaligned command displays Target
Groups performance data for unaligned blocks (I/O blocks whose size is not a
multiplication of 4KB or which have an offset).
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

TG-Name

The Target Groups name

Index

The Target Groups index number

U-Write-BW (MB/s)
U-Read-BW (MB/s)
U-Write-IOPS
U-Read-IOPS
U-BW (MB/s)
U-IOPS
Total-U-Write-IOs
Total-U-Read-IOs

494

EMC XtremIO Storage Array User Guide

These properties indicate the current Bandwidth/IOPS of unaligned


I/Os which are greater than 4KB.

CLI Guide

show-targets-performance
The show-targets-performance command displays Targets performance data.
Input Parameter

Description

Value

Mandatory

active

Show only active


Targets

N/A

No

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Name

The Targets name

Index

The Targets index number

Cluster-Name

The Clusters name

Index

The Clusters index number

Write-BW (MB/s)
Read-BW (MB/s)
Write-IOPS
Read-IOPS
BW (MB/s)

These properties indicate the current Bandwidth/IOPS.

IOPS
Total-Write-IOs
Total-Read-IOs

Cluster Data and Status

495

CLI Guide

show-targets-performance-small
The show-targets-performance-small command displays Targets performance
data for small (under 4KB) blocks.
Input Parameter

Description

Value

Mandatory

active

Show only active


Targets.

N/A

No

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration.

Seconds

No

frequency

Monitor intervals.

Seconds

No

Output Parameter

Description

Name

The Targets name

Index

The Targets index number

Cluster-Name

The Clusters name

Index

The Clusters index number

S-Write-BW (MB/s)
S-Read-BW (MB/s)
S-Write-IOPS
S-Read-IOPS
S-BW (MB/s)
S-IOPS
Total-S-Write-IOs
Total-S-Read-IOs

496

EMC XtremIO Storage Array User Guide

These properties indicate the current Bandwidth/IOPS of I/Os


which are smaller than 4KB.

CLI Guide

show-targets-performance-unaligned
The show-targets-performance-unaligned command displays Targets
performance data for unaligned blocks (I/O blocks whose size is not a multiplication of
4KB or which have an offset).
Input Parameter

Description

Value

Mandatory

active

Show only active


Targets.

N/A

No

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration.

Seconds

No

frequency

Monitor intervals.

Seconds

No

Output Parameter

Description

Name

The Targets name

Index

The Targets index number

Cluster-Name

The Clusters name

Index

The Clusters index number

U-Write-BW (MB/s)
U-Read-BW (MB/s)
U-Write-IOPS
U-Read-IOPS
U-BW (MB/s)

These properties indicate the current Bandwidth/IOPS of unaligned


I/Os which are greater than 4KB.

U-IOPS
Total-U-Write-IOs
Total-U-Read-IOs

Cluster Data and Status

497

CLI Guide

show-volumes-performance
The show-volumes-performance command displays the Volumes performance
data.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Volume-Name

The Volumes name

Index

The Volumes index number

Cluster-Name

The Clusters name

Index

The Clusters index number

Write-BW (MB/s)
Read-BW (MB/s)
Write-IOPS
Read-IOPS
BW (MB/s)
IOPS
Total-Write-IOs
Total-Read-IOs

498

EMC XtremIO Storage Array User Guide

These properties indicate the current Bandwidth/IOPS.

CLI Guide

show-volumes-performance-small
The show-volumes-performance-small command displays the Volumes
performance data for small (under 4KB) blocks.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Volume-Name

The Volumes name

Index

The Volumes index number

Cluster-Name

The Clusters name

Index

The Clusters index number

S-Write-BW (MB/s)
S-Read-BW (MB/s)
S-Write-IOPS
S-Read-IOPS
S-BW (MB/s)

These properties indicate the current Bandwidth/IOPS of I/Os


which are smaller than 4KB.

S-IOPS
Total-S-Write-IOs
Total-S-Read-IOs

Cluster Data and Status

499

CLI Guide

show-volumes-performance-unaligned
The show-volumes-performance-unaligned command displays the Volumes
performance data for unaligned blocks (I/O blocks whose size is not a multiplication of
4KB or which have an offset).
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Volume-Name

The Volumes name

Index

The Volumes index number

Cluster-Name

The Clusters name

Index

The Clusters index number

U-Write-BW (MB/s)
U-Read-BW (MB/s)
U-Write-IOPS
U-Read-IOPS
U-BW (MB/s)
U-IOPS
Total-U-Write-IOs
Total-U-Read-IOs

500

EMC XtremIO Storage Array User Guide

These properties indicate the current Bandwidth/IOPS of unaligned


I/Os which are greater than 4KB.

CLI Guide

show-data-protection-groups-performance
The show-data-protection-groups-performance command displays XDP
groups performance information.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

ID: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Name

The Data Protection Groups name

Index

The Data Protection Groups index number

Cluster-Name

The Clusters name

Index

The Clusters 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

Cluster Data and Status

501

CLI Guide

Statistics and Reports


show-ssd-sas-counters
The show-ssd-sas-counters command displays the list of diagnostic counters that
can indicate problems in the SAS link between the DAE controller and a specified SSD.

502

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

Output Parameter

Description

Name

The SSDs name

Index

The SSDs index number

Cluster-Name

The clusters name

Index

The clusters 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

EMC XtremIO Storage Array User Guide

CLI Guide

show-storage-controllers-infiniband-counters
The show-storage-controllers-infiniband-counters command displays
the Storage Controllers InfiniBand different counters.
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

Output Parameter

Description

Storage-Controller-Name

The Storage Controllers name

Index

The Storage Controllers index

Port-Index

The ports 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 indicate standard diagnostic counters for


InfiniBand ports.

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

Cluster Data and Status

503

CLI Guide

show-target-groups-fc-error-counters
The show-target-groups-fc-error-counters command displays Fibre Channel
error counter per Target Group.

504

Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

id: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

TG-Name

The Target Groups name

Index

The Target Groups index number

Cluster-Name

The name of the cluster to which the Target Group belongs

Index

The clusters 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

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

EMC XtremIO Storage Array User Guide

CLI Guide

show-targets-fc-error-counters
The show-targets-fc-error-counters command displays Fibre Channel error
counter per Target.
Input Parameter

Description

Value

Mandatory

cluster-id

Cluster ID

id: Name or Index

No

duration

Monitor duration

Seconds

No

frequency

Monitor intervals

Seconds

No

Output Parameter

Description

Name

The Targets name

Index

The Targets index number

Cluster-Name

The name of the cluster to which the Target belongs

Index

The clusters 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

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

Cluster Data and Status

505

CLI Guide

show-targets iscsi-counters
The show-targets-iscsi-counters command displays iSCSI counters information.

506

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

Output Parameter

Description

Name

The iSCSI counter name

Index

The iSCSI counter index number

Cluster-Name

The clusters name

Index

The clusters 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

EMC XtremIO Storage Array User Guide

CLI Guide

show-report
The show-report command displays the details of a specified report.
Input Parameter

Description

Value

Mandatory

report-id

Report ID

Name or Index

Yes

Output Parameter

Description

Name

Reports name

Index

Reports Index number

Title

Reports title

Entity

Reports entity subject

Category

Reports category

Object-List

Object list referred to in the report

Property-List

Properties displayed in the report

Source-Definition

The reports source

View-Type

The reports view type

Public

Indicates if report is public.

show-reports
The show-reports command displays the list of defined reports.
Output Parameter

Description

Name

Reports name

Index

Reports Index number

Title

Reports title

Entity

Reports entity subject

Category

Reports category

Granularity

Reporting granularity

From-Time

Time of report start

To-Time

Time of report end

Time-Frame

Reports time frame

Source-Definition

Reports source

Public

Indicates if report is public.

Cluster Data and Status

507

CLI Guide

show-reports-data
The show-reports-data command displays a reports data for the specified entity and
category.

508

Input Parameter

Description

Value

Mandatory

category

Report category

String

Yes

entity

Class

String

Yes

export-to-file

File name

String

No

from-time

From Date/Time

date/time format (e.g.


"2015-05-2310:14:15
")

No

granularity

Data granularity

text string.auto for


best match

No

obj-list

Object ID list

List of ids: Name or


Index

No

time-frame

Time frame for


monitoring

Text string to use


without from/to

No

to-time

To Date/Time

date/time format (e.g.


"2015-05-2310:14:15
")

No

vertical

Vertical layout

N/A

No

cluster-id

Cluster ID

Name or Index

No

EMC XtremIO Storage Array User Guide

APPENDIX A
Alerts and Events Details
This section provides details on the available alerts and events in the XtremIO system.
This section includes the following topics:

General XMS Event Codes ..................................................................................... 510


Alerts Details ........................................................................................................ 510
Events Details ....................................................................................................... 538

Alerts and Events Details

509

Alerts and Events Details

General XMS Event Codes


The following are general XMS event codes:

5000100 - all audit events

5000200 - all events that are triggered by user action

5000000 - all other XMS events

Alerts Details

Alert Name

Alert
Code

sys_ud_ssd_space_limited

0200302

sys_ud_ssd_space_very_limited

System Impact

Severity

Clusters free physical


capacity is low. Threshold:
more than 85 percent is
used.

Currently there is no impact on


the cluster. However, if the
remaining physical space is
fully consumed, the cluster
data will become read-only,
which may cause some hosts
to disconnect and/or have
limited data access
(read-only).

Minor

0200303

Clusters free physical


capacity is critically low.
Threshold: more than 90
percent is used.

Currently there is no impact on


the cluster. However, if the
remaining physical space is
fully consumed, the cluster
data will become read-only,
which may cause some hosts
to disconnect and/or have
limited data access
(read-only).

Major

sys_ud_ssd_space_no_free

0200304

Cluster has no free


physical capacity.

No physical space is available.


Some hosts may disconnect
from Volumes. Volume access
is limited to read-only.

Critical

sys_stopping

0200505

Cluster service is stopping:


Stop reason is <field1>.

Field1:sto The cluster is not servicing


pped_rea I/Os.
son

Critical

sys_stopped

0200506

Cluster service has


stopped:<field1>-<field2>.

Field1:sys The cluster is not servicing


_stop_typ I/Os.
e
Field2:sto
pped_rea
son

Critical

sys_starting

0200507

Cluster is in the process of


starting.

def_sys_in_failed_state

0200508

Cluster initialization has


failed.

The cluster has failed to start


and is not servicing I/Os.

Critical

sys_state_unknown

0200509

Cluster state cannot be


determined. XMS is unable
to obtain the cluster state.

The XMS cannot communicate


with the cluster manager. The
cluster may still be servicing
I/Os.

Major

510

EMC XtremIO Storage Array User Guide

Description

Field

Minor

Alerts and Events Details

Alert Name

Alert
Code

Description

sys_state_down

0200511

sys_stop_failed

Field

System Impact

Severity

Cluster state is down.

The cluster is not servicing


I/Os.

Critical

0200512

Cluster service has failed


to stop.

The cluster is not servicing


I/Os.

Critical

sys_failed_stop

0200604

Cluster stop failure

The cluster may not be


servicing I/Os.

Major

sys_unorderly_stopping

0200606

Cluster service stop, with


fast journal flushing, is in
progress.

The cluster is in the process of


stopping data services.

Major

sys_orderly_stopping

0200607

Cluster stop, with full


journal flushing, is in
progress.

The cluster is in the process of


stopping data services and
will not service I/Os.

Major

system_upgrade_bring_up

0200806

Cluster is starting with the


new upgraded version.

Minor

system_upgrade_waiting_for_ver 0200807
sion

Upgrade process is waiting


for the new version to be
activated.

Minor

system_upgrade_preparing

0200808

Upgrade process is
preparing the cluster for
upgrade.

Minor

system_upgrade_failed

0200809

Upgrade process has failed


with reason <field1>.

system_rollback_ongoing

0200811

Upgrade process has


failed. Rollback is in
progress.

disconnected_from_sys_mgr

0200901

Cluster manager is
running, but it is
disconnected from XMS
due to <field1>.

sys_sharedmemory_limited

0201002

The cluster may not be


servicing I/Os

Major

There may be some


performance impact during
the roll-back process.

Major

The XMS is no longer showing


real-time system information
(including Events/Alerts, and
performance information). The
cluster may be up and
servicing I/Os. If the cluster
goes down, the XMS will not
reflect its status.

Minor

Shared memory
consumption is high.
Threshold: more than 85
percent in use.

If memory is depleted, some


hosts may disconnect from
Volumes and Volume access
will be limited to read-only.

Minor

sys_sharedmemory_very_limited 0201003

Shared memory is very


high. Threshold: more than
90 percent in use

If memory is depleted, some


hosts may disconnect from
Volumes and Volume access
will be limited to read-only.

Major

sys_sharedmemory_no_free

Shared memory pool has


been depleted: more than
95 percent in use.

No shared memory space is


available for data. Some hosts
may disconnect from Volumes.
Volumes access is limited to
read-only.

Critical

0201004

Field1:
upgrade_
failure_re
ason

Field1:
sys_mgr_
conn_erro
r_reason

Alerts Details

511

Alerts and Events Details

Alert Name

Alert
Code

data_consistency_error

0201102

Data consistency error was


encountered.

active_cluster_memory_recovery
_true

0201403

Activate-clusters-memory-r
ecovery command is
active.

sys_sharedmem_inefficiency_m
edium

0202002

System shared memory


pools are not optimally
balanced.

The cluster shared memory


pool is not properly balanced.
New allocations may fail when
it is fully depleted.

Major

sys_sharedmem_inefficiency_hi
gh

0202003

System shared memory


pools are imbalanced.

The cluster shared memory


pool is not properly balanced.
New allocations may fail when
it is fully depleted.

Critical

vaai_tp_limit_threshold_exceed
ed

0202102

Clusters VAAI thin


provisioning soft limit of
<field1> percent has been
exceeded. The threshold is
<field1> percent.

Some applications require


available capacity to remain
below this threshold.

Minor

sys_expansion_progress_yes

0202202

Cluster expansion is in
progress.

Minor

sys_encrypt_started

0202302

Data at Rest Encryption


has started.

Info.

sys_encrypt_switch_incomplete

0202303

Data at Rest Encryption is


incomplete.

Major

sys_chap_init_missing_cluster_c
redentials

0202401

CHAP is enabled. Add


cluster authentication
credentials to initiators.
Otherwise, a failure will
occur when an initiator is
disconnected and then
re-connected.

The Initiator is unavailable


until credentials are assigned.

Minor

sys_chap_init_missing_credenti
als

0202502

CHAP is enabled. Add


authentication credentials
to initiators. Otherwise, a
failure will occur when an
initiator is disconnected
and then re-connected.

The Initiator is unavailable


until credentials are assigned.

Minor

sys_hw_pkg_inconsistent

0203101

Not all Storage Controllers


have the same hardware
package.

FRU replacement may be


affected.

Major

system_proactive_loading_true

0203104

System performing
proactive metadata
loading.

sys_shdmemory_limited_recover 0204102
able

512

EMC XtremIO Storage Array User Guide

Description

Shared memory
consumption is high.
Threshold: more than 90%
of total is used; significant
memory is recoverable.

Field

System Impact

Severity

Data inconsistency is
suspected. The cluster should
not be used until the error is
cleared.

Critical

Minor

Field1:
vaai_tp_li
mit

Info.

If memory is depleted, some


hosts may disconnect from
Volumes and Volume access
will be limited to read-only.

Minor

Alerts and Events Details

Alert Name

Alert
Code

Description

Field

System Impact

Severity

sys_shdmemory_very_limited_re
coverable

0204103

Shared memory
consumption is very high.
Threshold: more than 93%
of total is used; significant
memory is recoverable.

If memory is depleted, some


hosts may disconnect from
Volumes and Volume access
will be limited to read-only.

Major

sys_shdmemory_no_free_recove
rable

0204104

Shared memory
consumption is depleted.
Threshold: more than 95%
of total is used; significant
memory is recoverable.

If memory is depleted, some


hosts may disconnect from
Volumes and Volume access
will be limited to read-only.

Criticla

failed_brick_state

0300102

XMS has detected an


X-Brick that is not
configured to be part of a
cluster.

The X-Brick will not be used by


the cluster.

Major

unsupported_disk_in_brick

0300203

Unsupported disk type or


model was detected in slot
<field1>.

Field1:
The SSD cannot be used by
ssd_slot_ the cluster.
array[].slo
t_num

Minor

uninitialized_ssd_in_brick

0300204

Uninitialized disk was


detected in slot <field1>.

Field1:
The SSD device cannot be
ssd_slot_ used until it is initialized.
array[].slo
t_num

Minor

foreign_xtremapp_ssd_in_brick

0300205

Foreign SSD from a


different X-Brick or cluster
was detected in slot
<field1>. id=<field2>.

Field1:
The SSD will not be used until
ssd_slot_ it is added to the cluster.
array[].slo
t_num
Field2:
ssd_slot_
array[].slo
t_uid

Minor

slot_error_in_brick

0300206

The state of slot <field1>


cannot be determined due
to an error: <field2>

Field1:
ssd_slot_
array[].slo
t_num
Field2:
ssd_slot_
array[].slo
t_error_re
ason

The SSD in this slot will not be


used. To keep the cluster in
optimal configuration, this
issue should be promptly
addressed.

Major

sas1_port_down

0400202

Storage Controller SAS port


1 is down.

Connectivity from Storage


Controller SAS port 1 to the
DAE is down.

Major

sas2_port_down

0400302

Storage Controller SAS port


2 is down.

Connectivity from Storage


Controller SAS port 2 to the
DAE is down.

Major

node_sas1_3gbps_rate

0400403

SAS port is running at


partial rate of 3GBPS.

Storage Controller SAS port 1


speed is less than optimal.
Cluster performance may be
impacted.

Minor

disconnected_from_node_mgr

0400503

Storage Controller is
disconnected from the
XMS.

Major

Alerts Details

513

Alerts and Events Details

Alert Name

Alert
Code

journal_fault

0400703

Journaling on this Storage


Controller has been
disabled.

journal_dumping

0400704

Journal information is in
the process of destaging
from the Storage Controller
memory to persistent
media (SSDs).

node_ram_too_low

0400902

Insufficient RAM: actual is


<field1> but expected is
<field2>.

node_temp_level_2_unknown

0401102

Storage Controller
temperature IPMI
information is unavailable.

node_temp_level_3_warning

0401103

IPMI reported abnormal


temperature.

In case of excessively high


temperature, the Storage
Controller may shut down.

Minor

node_temp_level_4_minor

0401104

IPMI reported abnormal


temperature.

In case of excessively high


temperature, the Storage
Controller may shut down.

Minor

node_temp_level_5_major

0401105

IPMI reported abnormal


temperature.

In case of excessively high


temperature, the Storage
Controller may shut down.

Major

node_temp_level_6_critical

0401106

IPMI reported abnormal


temperature.

In case of excessively high


temperature, the Storage
Controller may shut down.

Major

node_fan_level_2_unknown

0401202

Storage Controller fan IPMI


information is unavailable.

The cluster is unable to read


the Storage Controller fan
information. The fan may not
work properly.

Minor

node_fan_level_3_warning

0401203

IPMI reported abnormal


fan sensor indications.

Minor

node_fan_level_4_minor

0401204

IPMI reported abnormal


fan sensor indications.

Minor

node_fan_level_5_major

0401205

IPMI reported abnormal


fan sensor indications.

Major

node_fan_level_6_critical

0401206

IPMI reported abnormal


fan sensor indications.

Major

node_volt_level_2_unknown

0401302

Storage Controller voltage


IPMI information is
unavailable.

Minor

node_volt_level_3_warning

0401303

IPMI reported abnormal


voltage levels.

Minor

514

EMC XtremIO Storage Array User Guide

Description

Field

System Impact

Severity
Major

The destaging is part of the


Storage Controller stop
process.

Field1:ra This Storage Controller cannot


m
be used in the cluster.
Field2:ex
pected_ra
m

Major

Major

Minor

Alerts and Events Details

Alert Name

Alert
Code

node_volt_level_4_minor

0401304

IPMI reported abnormal


voltage levels.

node_volt_level_5_major

0401305

IPMI reported abnormal


voltage levels.

Major

node_volt_level_6_critical

0401306

IPMI reported abnormal


voltage levels.

Major

node_curt_level_2_unknown

0401402

Storage Controller current


IPMI information is
unavailable.

Minor

node_curt_level_3_warning

0401403

IPMI reported abnormal


current levels.

Minor

node_curt_level_4_minor

0401404

IPMI reported abnormal


current levels.

Minor

node_curt_level_5_major

0401405

IPMI reported abnormal


current levels.

Major

node_curt_level_6_critical

0401406

IPMI reported abnormal


current levels.

Major

alert_def_node_intsense_level_
3_warning

0401503

Internal processors
reported with abnormal
values.

Minor

alert_def_node_intsense_level_
4_minor

0401504

Internal processors
reported with abnormal
values.

Minor

alert_def_node_intsense_level_
6_critical

0401506

Internal processors
reported with abnormal
values.

Major

eth_port_down

0401602

Storage Controller
management port is down.

eth_port_unknown

0401603

Storage Controller
management port state
cannot be determined.

Major

node_ib1_level_2_unknown

0401702

InfiniBand port 1: link


status cannot be
determined.

Minor

node_ib1_level_3_warning

0401703

InfiniBand port 1: link


status is not healthy. The
port state is <field1>.

Field1:
ib1_port_
state

Sub-optimal InfiniBand port


health may affect cluster
performance.

Minor

node_ib1_level_4_minor

0401704

InfiniBand port 1: link


status is not healthy. The
port state is <field1>.

Field1:
ib1_port_
state

Sub-optimal InfiniBand port


health may affect cluster
performance.

Minor

node_ib1_level_5_major

0401705

InfiniBand port 1: link


status is not healthy. The
port state is <field1>.

Field1:
ib1_port_
state

Sub-optimal InfiniBand port


health may affect cluster
performance.

Major

Description

Field

System Impact

Severity

The cluster may still be


running normally. However,
this should be investigated to
keep the cluster running in a
healthy state.

Minor

While this should not impact


the cluster service, Storage
Controller management
access is affected.

Major

Alerts Details

515

Alerts and Events Details

Alert Name

Alert
Code

node_ib1_level_6_critical

0401706

Description

Field

System Impact

Severity

InfiniBand port 1: link


status is not healthy. The
port state is <field1>.

Field1:
ib1_port_
state

Sub-optimal InfiniBand port


health may affect cluster
performance.

Major

node_wrong_ib1_port_connectio 0401802
n

Storage Controller's
InfiniBand port 1 is
connected to the wrong
port on the infiniBand
Switch.

Overall cluster impact is


limited as long as the other
InfiniBand connectivity is
healthy.

Major

node_wrong_ib1_switch_connec
ted

0401803

Storage Controller's
InfinBand port 1 is
connected to the wrong
InfiniBand Switch.

Overall cluster impact is


limited as long as the other
InfiniBand connectivity is
healthy.

Major

node_ib1_port_down

0401902

Storage Controller
InfiniBand port 1 is down.

Cluster performance may be


impacted.

Major

node_ib1_port_unknown

0401903

Storage Controller
InfiniBand port 1 port state
cannot be determined.

node_ib2_level_2_unknown

0402102

InfiniBand port 2: link


status cannot be
determined.

node_ib2_level_3_warning

0402103

InfiniBand port 2: link


status is not healthy. The
port state is <field1>.

node_ib2_level_4_minor

0402104

node_ib2_level_5_major

node_ib2_level_6_critical

Major

Overall cluster impact is


limited as long as the other
InfiniBand connectivity is
healthy.

Minor

Field1:
ib2_port_
state

Sub-optimal InfiniBand port


health may affect cluster
performance.

Minor

InfiniBand port 2: link


status is not healthy. The
port state is <field1>.

Field1:
ib2_port_
state

Sub-optimal InfiniBand port


health may affect cluster
performance.

Minor

0402105

InfiniBand port 2: link


status is not healthy. The
port state is <field1>.

Field:
ib2_port_
state

Sub-optimal InfiniBand port


health may affect cluster
performance.

Major

0402106

InfiniBand port 2: link


status is not healthy. The
port state is <field1>.

Field
ib2_port_
state

Sub-optimal InfiniBand port


health may affect cluster
performance.

Major

node_wrong_ib2_port_connectio 0402202
n

Storage Controller's
InfinBand port 2 is
connected to the wrong
port on the InfinBand
Switch.

Overall cluster impact is


limited as long as the other
InfiniBand connectivity is
healthy.

Major

node_wrong_ib2_switch_connec
ted

0402203

Storage Controller's
InfinBand port 2 is
connected to the wrong
InfiniBand Switch.

Overall cluster impact is


limited as long as the other
InfiniBand connectivity is
healthy.

Major

node_ib2_port_down

0402302

Storage Controller
InfiniBand port 2 is down.

Overall cluster impact is


limited as long as the other
InfiniBand connectivity is
healthy.

Major

node_ib2_port_unknown

0402303

Storage Controller
InfiniBand port 2 is
unknown.

Overall cluster impact is


limited as long as the other
InfiniBand connectivity is
healthy.

Major

516

EMC XtremIO Storage Array User Guide

Alerts and Events Details

Alert Name

Alert
Code

upgrade_failed

Description

Field

System Impact

Severity

0402403

Storage Controller upgrade


has failed: <field1>. Current
version is <field2>.

Field1:
upgrade_
failure_re
ason
Field2:
sw_versio
n

The Storage Controller was not


upgraded to the requested
version and is excluded from
the cluster.

Major

node_upgrade_in_progress

0402404

Storage Controller upgrade


is in progress.

node_orderly_stop

0402502

Storage Controller has


stopped gracefully.

The Storage Controller is


stopped and is not servicing
I/Os. Cluster performance is
impacted. Failover cannot
occur to the non-functional
Storage Controller.

Major

node_unorderly_stop

0402503

Storage Controller has


stopped.

The Storage Controller is


stopped and is not servicing
I/Os. Cluster performance is
impacted. Failover cannot
occur to the non-functional
Storage Controller.

Major

node_failed_stop

0402504

Storage Controller stop


process has failed. Cluster
is in unrecoverable state
and data integrity is
suspected.

The cluster is down and is not


serving I/Os.

Major

node_orderly_stopping

0402505

Storage Controller is in the


process of graceful stop.

The Storage Controller is


stopped and is not servicing
I/Os. Cluster performance is
impacted. Failover cannot
occur to the non-functional
Storage Controller.

Major

node_unorderly_stopping

0402506

Storage Controller is in the


process of immediate stop.

The Storage Controller is


stopped and is not servicing
I/Os. Cluster performance is
impacted. Failover cannot
occur to the non-functional
Storage Controller.

Major

node_user_disabled

0402602

Storage Controller was


deactivated (disabled) by
user request.

The Storage Controller is


currently not servicing I/Os.
For optimal performance and
resiliency, both Storage
Controllers of an X-Brick
should be active.

Major

node_system_disabled

0402603

Storage Controller has


been deactivated by the
cluster.

The Storage Controller is


currently not servicing I/Os.
For optimal performance and
resiliency, both Storage
Controllers of an X-Brick
should be active.

Major

Minor

Alerts Details

517

Alerts and Events Details

Alert Name

Alert
Code

Description

node_fru_failed

0402703

node_fru_disconnected

System Impact

Severity

Storage Controller is faulty.

The Storage Controller is


currently not servicing I/Os.
For optimal performance and
resiliency, both Storage
Controllers of an X-Brick
should be active.

Major

0402704

Storage Controller has


been removed (physically
or logically).

The Storage Controller is


currently not servicing I/Os.
For optimal performance and
resiliency, both Storage
Controllers of an X-Brick
should be active.

Major

node_fru_uninitialized

0402705

Storage Controller is not


initialized.

The Storage Controller is


currently not servicing I/Os.
For optimal performance and
resiliency, both Storage
Controllers of an X-Brick
should be active.

Minor

node_fru_prepare_failed

0402706

FRU replacement has failed


for the Storage Controller

The Storage Controller is


currently not servicing I/Os.
For optimal performance and
resiliency, both Storage
Controllers of an X-Brick
should be active.

Minor

node_fw_upgrading

0402802

Storage Controllers
software or firmware is
being upgraded.

Upgrade is in progress.

Info.

node_fw_invalid

0402803

Storage Controller's OS or
firmware version is
incompatible. Storage
Controller cannot be used.

This Storage Controller is not


servicing I/Os.

Major

node_fw_mismatch

0402804

Unexpected Storage
Controller's OS or firmware
version has been detected.

Despite the version mismatch,


the Storage Controller may be
servicing I/Os.

Minor

node_free_ram_low

0402902

The Storage Controllers


memory utilization is high.

Sub-optimal Storage
Controller memory utilization
may result in performance
degradation.

Major

node_file_descriptors_high

0402912

Excessive number of open


file descriptors

mgmt_port_half_duplex

0403102

Storage Controller
management port is set to
half duplex.

node_dimm_level_2_unknown

0403302

Storage Controller DIMM


memory card information
is unavailable.

Minor

node_dimm_level_3_warning

0403303

Memory card (DIMM)


health fault

Minor

node_dimm_level_4_minor

0403304

Memory card (DIMM)


health fault

Minor

518

EMC XtremIO Storage Array User Guide

Field

Major
This may result in connectivity
issues.

Major

Alerts and Events Details

Alert Name

Alert
Code

node_dimm_level_5_major

0403305

Memory card (DIMM)


health fault

Major

node_dimm_level_6_critical

0403306

Memory card (DIMM)


health fault

Major

inconsistent_fc_tar_speed

0403402

Clusters FC Target ports


are running at different
speeds.

Inconsistent FC port speed


may impact cluster
performance.

Minor

inconsistent_scsi_tar_speed

0403502

iSCSI Target ports do not


have the same speed.

Inconsistent iSCSI port speed


may impact the cluster
performance.

Minor

node_sas2_3gbps_rate

0403603

SAS port is running at the


partial rate of 3GBPS

Storage Controller SAS port 2


speed is less than optimal.
Cluster performance may be
impacted.

Minor

node_eth_10m_rate

0403801

ETH management port is at


sub-optimal rate of 10M.

XMS communication with the


cluster may be severely
degraded.

Major

node_eth_100m_rate

0403802

ETH management port is at


sub-optimal rate of 100M.

XMS communication with the


cluster may be degraded.

Minor

node_ethport_level_2_unknown

0403902

Management link health


status cannot be
determined.

Storage Controller
management port may not be
available. Storage Controller
information in the XMS the
may reflect the last reported
values.

Minor

node_ethport_level_3_warning

0403903

Management link health


status is marginal.

Storage Controller
management port
communication is
sub-optimal.

Minor

node_ethport_level_4_minor

0403904

Management link health is


limited.

Storage Controller
management port
communication is
sub-optimal.

Minor

node_ethport_level_5_major

0403905

Management link health is


problematic. Attention is
required.

Storage Controller
management port
communication is
sub-optimal.

Major

node_ethport_level_6_critical

0403906

Management link health is


faulty. Immediate attention
is required.

The storage Controller may not


be managed.

Major

node_sas1_conn_wrong_lcc

0404002

Storage Controller SAS port


1 is connected to the
wrong DAE Controller.

A faulty SAS port connection


to the DAE may affect cluster
HA functionality.

Major

node_sas1_conn_wrong_lcc_por
t

0404003

Storage Controller SAS port


1 is connected to the
wrong port of the DAE
Controller.

A faulty SAS port connection


to the DAE may affect cluster
HA functionality.

Major

Description

Field

System Impact

Severity

Alerts Details

519

Alerts and Events Details

Alert Name

Alert
Code

node_sas1_conn_unknown_dae

0404004

Storage Controller SAS port


1 is not connected to the
DAE of this Storage
Controller's X-Brick.

node_sas1_level_2_unknown

0404102

SAS port 1 link health


status cannot be
determined.

node_sas1_level_3_warning

0404103

SAS port 1 link is


sub-optimal.

Sub-optimal SAS port health


may affect cluster
performance.

Minor

node_sas1_level_4_minor

0404104

SAS port 1 link is


sub-optimal.

Sub-optimal SAS port health


may affect cluster
performance.

Minor

node_sas1_level_5_major

0404105

SAS Port 1 link is faulty.

Faulty SAS port health may


affect cluster performance.

Major

node_sas1_level_6_critical

0404106

SAS Port 1 link is faulty.

Faulty SAS port health may


affect cluster performance.

Major

node_sas2_level_2_unknown

0404202

SAS port 2 link health


status cannot be
determined.

node_sas2_level_3_warning

0404203

SAS port 2 link is


sub-optimal.

Sub-optimal SAS port health


may affect cluster
performance.

Minor

node_sas2_level_4_minor

0404204

SAS port 2 link is


sub-optimal.

Sub-optimal SAS port health


may affect cluster
performance.

Minor

node_sas2_level_5_major

0404205

SAS Port 2 link is faulty.

Faulty SAS port health may


affect cluster performance.

Major

node_sas2_level_6_critical

0404206

SAS Port 2 link is faulty.

Faulty SAS port health may


affect cluster performance.

Major

node_fp_temperature_warning

0404502

Storage Controller
temperature is high as
reported by front panel
sensor.

In case of excessively high


temperature, the Storage
Controller may shut down.

Major

node_fp_temperature_high

0404503

Storage Controller
temperature is critically
high as reported by front
panel sensor.

In case of excessively high


temperature, the Storage
Controller may shut down.

Critical

node_ipmiport_invalid_wiring

0404602

Dedicated IPMI link


internal cable is connected
incorrectly.

Some maintenance operations


on this X-Brick may be
affected.

Major

journal_failjover

0404702

The cluster has detected a


journal fault in this Storage
Controller.

The journal on this Storage


Controller is currently not
usable. However, every journal
has a mirrored copy in a
different Storage Controller.

Major

520

EMC XtremIO Storage Array User Guide

Description

Field

System Impact

Severity

Wrong SAS port connection to


the DAE may affect cluster HA
functionality.

Major

Minor

Minor

Alerts and Events Details

Alert Name

Alert
Code

journal_failback

0404703

journal_failed

Description

Field

System Impact

Severity

The cluster has detected a


journal failover in this
Storage Controller.

The journal on this Storage


Controller is currently not
usable. However, every journal
has a mirrored copy in a
different Storage Controller.

Major

0404704

The cluster has detected a


journal failback in this
Storage Controller.

The journal on this Storage


Controller is currently not
usable. However, every journal
has a mirrored copy in a
different Storage Controller.

Minor

ded_ipmi_port_down

0404902

Storage Controller
dedicated IPMI port
connected to the peer
Storage Controller is down.

Some maintenance operations


on this X-Brick may not be
available.

Major

node_discover_dae_true

0405002

Cluster has discovered new


DAE hardware.

Minor

node_discover_daepsu_true

0405102

Cluster has found new DAE


PSU. Replace procedure is
required.

Minor

node_discover_ibsw_true

0405202

Cluster has found new


InfiniBand Switch. Replace
procedure is required.

Minor

node_discover_localdisk_true

0405302

Cluster has found new


Local Disk. Replace
procedure is required.

Minor

node_discover_localdisk_true

0405402

Cluster has found new


Storage Controller PSU.
Replace procedure is
required.

Minor

node_sas2_conn_wrong_lcc

0405502

Storage Controller SAS port


2 is connected to the
wrong DAE Controller.

A faulty SAS port connection


to the DAE may affect cluster
HA functionality.

Major

node_sas2_conn_wrong_lcc_por
t

0405503

Storage Controller SAS port


2 is connected to the
wrong port of the DAE
Controller.

A faulty SAS port connections


to the DAE may affect cluster
HA functionality.

Major

node_sas2_conn_unknown_dae

0405504

Storage Controller SAS port


2 is not connected to the
DAE of this Storage
Controller's X-Brick.

Wrong SAS port connections


to the DAE may affect cluster
HA functionality.

Major

node_discover_dae_ctrl_true

0405602

Cluster has found new DAE


Controller. Replace
procedure is required.

Minor

node_discover_bbu_true

0405702

Cluster has found new


BBU. Replace procedure is
required.

Minor

node_disk_limited_space

0406102

Disk space level is low.


Field1:fre
<field1> Kbytes is available. e_disk_s
pace

Minor

Alerts Details

521

Alerts and Events Details

Alert Name

Alert
Code

node_disk_no_free_space

Description

Field

0406103

Not enough disk space.


Only <field1> Kbytes is
available.

Field1:fre
e_disk_s
pace

notifier_disabled

0406202

Event notifiers were


disabled.

node_tech_tunnel_opened

0407002

Technician tunnel to XMS


is open. Please close it
when maintenance is
done.

node_unbalanced_failback_allo
wed

0408003

An internal module in the


system performed failover.
The system is now healthy
and ready for failback.

disk_empty

0500102

Storage Controller local


disk in slot <field1> of type
<field2> used as <field3> is
empty.

Field1:
slot_num
Field2:
local_dis
k_type
Field3:
local_dis
k_purpos
e

Major

disk_unanticipated_disk

0500103

Storage Controller local


disk slot <field1> is
expected to be empty, but
contains a disk.

Field1:slo
t_num

Major

disk_unsupported_disk

0500104

Storage Controller local


disk in slot <field1> is an
unsupported disk model or
type.

Field1:slo
t_num

Major

disk_uninitialized

0500106

Storage Controller local


disk in slot <field1> is
uninitialized.

Field1:slo
t_num

Major

localdisk_user_disabled

0500202

Storage Controller local


disk was deactivated
(disabled) by user request.

The disabled local disk is not


being used.

Major

localdisk_system_disabled

0500203

Cluster has disabled the


Storage Controller local
disk.

The disabled local disk is not


being used.

Major

localdisk_fru_failed

0500303

Storage Controller's local


disk has failed.

The local disk cannot be used. Major

localdisk_fru_disconnected

0500304

Storage Controller's local


disk is disconnected.

The local disk cannot be used. Major

localdisk_fru_uninitialized

0500305

Storage Controller's local


disk is not initialized.

The local disk cannot be used. Minor

localdisk_fru_prepare_failed

0500306

FRU replacement has failed


for the Storage Controllers
local disk.

The local disk cannot be used. Minor

522

EMC XtremIO Storage Array User Guide

System Impact

Severity
Major

Syr/Syslog/Email/SNMP
notifications will not be sent
for this cluster.

Info.

Major

The cluster may experience


performance degradation until
it is rebalanced.

Minor

Alerts and Events Details

Alert Name

Alert
Code

localdisk_fw_upgrading

0500402

Firmware is being
upgraded.

localdisk_fw_invalid

0500403

Storage Controller's local


disk firmware version is
incompatible.

The local disk cannot be used. Major

localdisk_fw_mismatch

0500404

Storage Controller's local


disk firmware version is
incorrect.

The cluster will try to use the


disk. If it is unable the use the
local disk, the Storage
Controller may be stopped.

Minor

nodepsu_user_disabled

0600201

Storage Controller PSU was


manually disabled by user
request.

There is no impact on the


cluster as long as other
Storage Controller PSU is
healthy and has power input.

Major

nodepsu_system_disabled

0600203

Cluster has disabled the


Storage Controller PSU.

There is no impact on the


cluster as long as other
Storage Controller PSU is
healthy and has power input.

Major

nodepsu_fru_failed

0600303

Storage Controller's PSU


has failed.

Overall cluster impact is


limited as long as the other
Storage Controller PSU is
healthy.

Major

nodepsu_fru_disconnected

0600304

Storage Controller's PSU is


disconnected from the
cluster.

Overall cluster impact is


limited as long as the other
Storage Controller PSU is
healthy.

Major

nodepsu_fru_uninitialized

0600305

Storage Controller's PSU is


not initialized.

Overall cluster impact is


limited as long as the other
Storage Controller PSU is
healthy.

Minor

nodepsu_fru_prepare_failed

0600306

FRU replacement has failed


for the Storage Controllers
PSU.

Overall cluster impact is


limited as long as the other
Storage Controller PSU is
healthy.

Minor

nodepsu_fw_upgrading

0600402

Firmware is in the process


of being upgraded.

nodepsu_fw_mismatch

0600404

Storage Controller's PSU


firmware version is
incorrect. The cluster will
try to use the PSU.

If this PSU can be used, there


is no impact on cluster.
Otherwise, the impact is
limited as long as other PSU in
Storage Controller is healthy.

Minor

nodepsu_no_input

0600701

Storage Controllers PSU


has no input.

Overall cluster impact is


limited as long as the other
Storage Controller PSU is
healthy.

Major

rg_degraded

0800102

An SSD has failed and the


DPG resiliency is degraded.

The cluster will perform a DPG


rebuild.

Major

rg_dual_failure

0800103

DPG has a dual SSD failure


and is in degraded
protection mode.

Description

Field

System Impact

Severity
Info.

Informat
ion

Critical

Alerts Details

523

Alerts and Events Details

Alert Name

Alert
Code

rg_error

0800104

rg_double_degrade

System Impact

Severity

DPG group has too many


simultaneous SSD failures.

The cluster is down and is not


servicing I/Os.

Critical

0800106

DPG has two simultaneous


SSD failures and is in
degraded protection
mode.

The cluster will perform a DPG


rebuild.

Critical

rebuild_0_to_20_done

0800211

DPG rebuild has started.

The cluster performance


during rebuild may be
impacted.

Info.

rebuild_20_to_40_done

0800221

DPG rebuild is in progress.


More than <field1> percent
of the rebuild has
completed.

Field1:reb The cluster performance


uild_prog during rebuild may be
ress
impacted.

Info.

rebuild_40_to_60_done

0800231

DPG rebuild is in progress.


More than <field1> percent
of the rebuild has
completed.

Field1:reb The cluster performance


uild_prog during rebuild may be
ress
impacted.

Info.

rebuild_60_to_80_done

0800241

DPG rebuild is in progress.


More than <field1> percent
of the rebuild has
completed.

Field1:reb The cluster performance


uild_prog during rebuild may be
ress
impacted.

Info.

rebuild_99_done

0800251

DPG rebuild is in progress.


More than <field1> percent
of the rebuild has been
completed.

Field1:reb
uild_prog
ress

Info.

prepare_0_to_20_done

0800321

DPG SSD preparation is in


progress. <field1> percent
of the process has been
completed.

Field1:
ssd_prep
aration_p
rogress

Info.

20_to_40_done

0800331

DPG SSD preparation is in


progress. <field1> percent
of the process has been
completed.

Field1:
ssd_prep
aration_p
rogress

Info.

prepare_40_to_60_done

0800341

DPG SSD preparation is in


progress. <field1> percent
of the process has been
completed.

Field1:
ssd_prep
aration_p
rogress

Info.

prepare_60_to_80_done

0800351

DPG SSD preparation is in


progress. <field1> percent
of the process has been
completed.

Field1:
ssd_prep
aration_p
rogress

Info.

prepare_99_done

0800361

DPG SSD preparation is in


progress. <field1> percent
of the process has been
completed.

Field1:
ssd_prep
aration_p
rogress

Info.

rg_no_available_rebuilds

0800402

DPG cannot sustain any


more SSD failures.

524

EMC XtremIO Storage Array User Guide

Description

Field

There is insufficient space to


allow an additional rebuild, or
the allowed SSD failures have
reached maximum.

Major

Alerts and Events Details

Alert Name

Alert
Code

rg_low_on_available_rebuilds

0800403

DPG can sustain only one


additional SSD failure.

small_io_ratio_low

0800602

Volume small block I/O


ratio has reached <field1>
percent.

small_io_ratio_medium

0800603

small_io_ratio_high

Description

Field

System Impact

Severity

There is insufficient space to


allow more than one
additional rebuild, or the
allowed multiple SSD failures
have occurred.

Minor

Field1:
small_io_
ratio

For optimal cluster


performance, unnecessary
small I/O should be avoided.

Minor

Volume small block I/O


ratio has reached <field1>
percent.

Field1:
small_io_
ratio

For optimal cluster


performance, unnecessary
small I/O should be avoided.

Minor

0800604

Volume small block I/O


ratio has reached <field1>
percent.

Field1:
small_io_
ratio

For optimal cluster


performance, unnecessary
small I/O should be avoided.

Major

unalign_io_ratio_low

0800702

Volume unaligned block


I/O ratio has reached
<field1> percent.

Field1:
For optimal cluster
unaligned performance, unnecessary
_io_ratio unaligned I/O should be
avoided.

Minor

unalign_io_ratio_medium

0800703

Volume unaligned block


I/O ratio has reached
<field1> percent.

Field1:
For optimal cluster
unaligned performance, unnecessary
_io_ratio unaligned I/O should be
avoided.

Minor

unalign_io_ratio_high

0800704

Volume unaligned block


I/O ratio has reached
<field1> percent.

Field1:un
aligned_i
o_ratio

Major

vol_add_pending

0800802

Volume is in an ambiguous
state after an add request.

Minor

volume_modify_pending

0800803

Volume is in an ambiguous
state after a modification
request.

Minor

volume_remove_pending

0800804

Volume is in an ambiguous
state after a remove
request.

Minor

ssd_not_in_rg

0900102

SSD is not configured in


any DPG.

This SSD is currently not used


by the cluster.

Info.

ssd_failed_in_rg

0900103

SSD has failed.

The number of SSDs in the


DPG is less than optimal.
Impact is limited as long as all
other SSDs are on-line and
there is sufficient free space to
rebuild in case another SSD
fails.

Major

ssd_eject_pending

0900105

SSD is waiting to be
ejected from its SSD slot.

The number of SSDs in the


DPG is less than optimal.
Cluster impact is limited as
long as all other SSDs are
on-line and there is sufficient
free space to rebuild in case
another SSD fails.

Minor

For optimal cluster


performance, unnecessary
unaligned I/O should be
avoided.

Alerts Details

525

Alerts and Events Details

Alert Name

Alert
Code

ssd_assigning_to_rg

0900106

ssd_diag_level_2_unknown

System Impact

Severity

SSD is being assigned to


the DPG.

The number of SSDs in the


DPG is less than optimal.
Cluster impact is limited as
long as all other SSDs are
on-line and there is sufficient
free space to rebuild in case
another SSD fails.

Minor

0900202

State of the SSD cannot be


determined. The SSD state
is unknown.

The impact on the cluster is


minimal as long as all other
SSDs are healthy, and there is
sufficient free space to rebuild
if another SSD fails. Cluster
performance may be
impacted.

Minor

ssd_diag_level_4_minor

0900204

Diagnostics detected a
problem in the SSD.

The impact on the cluster is


minimal as long as other SSDs
are healthy.

Minor

ssd_diag_level_5_major

0900205

Diagnostics detected a
major problem in the SSD.

The impact on the cluster is


minimal as long as all other
SSDs are healthy, and there is
sufficient free space to rebuild
if another SSD fails.

Major

ssd_diag_level_6_critical

0900206

Diagnostics detected a
critical problem in the SSD.

The impact on the cluster is


minimal as long as all other
SSDs are healthy, and there is
sufficient free space to rebuild
if another SSD fails.

Major

ssd_link1_level_2_unknown

0900302

Link 1 state of the SSD


cannot be determined. The
SSD state is unknown.

The impact on the cluster is


minial as long as the other
Storage Controller link is
working as expected or link 2
is functional. Cluster
performance may be
degraded.

Minor

ssd_link1_level_3_warning

0900303

Cluster diagnostics
detected a minor problem
in link 1 of the SSD.

The impact on the cluster is


minimal as long as the other
Storage Controller link is
working as expected or link 2
is functional. Cluster
performance may be
degraded.

Minor

ssd_link1_level_4_minor

0900304

Cluster diagnostics
detected a problem in link
1 of the SSD.

The impact on the cluster is


minimal as long as the other
Storage Controller link is
working as expected or link 2
is functional. Cluster
performance may be
degraded.

Minor

ssd_link1_level_5_major

0900305

Cluster diagnostics
detected a major problem
in link 1 of the SSD.

The impact on the cluster is


minimal as long as the other
Storage Controller link is
working as expected or link 2
is functional. Cluster
performance may be
degraded.

Major

526

EMC XtremIO Storage Array User Guide

Description

Field

Alerts and Events Details

Alert Name

Alert
Code

ssd_link1_level_6_critical

0900306

ssd_link2_level_2_unknown

Description

Field

System Impact

Severity

Cluster diagnostics
detected a critical problem
in link 1 of the SSD.

The impact on the cluster is


minimal as long as the other
Storage Controller link is
working as expected or link 2
is functional. Cluster
performance may be
degraded.

Major

0900402

Link 2 state of the SSD


cannot be determined. The
SSD state is unknown.

The impact on the cluster is


minimal as long as the other
Storage Controller link is
working as expected or link 1
is functional. Cluster
performance may be
degraded.

Minor

ssd_link2_level_3_warning

0900403

Cluster diagnostics
detected a minor problem
in link 2 of the SSD.

The impact on the cluster is


minimal as long as the other
Storage Controller link is
working as expected or link 1
is functional. Cluster
performance may be
degraded.

Minor

ssd_link2_level_4_minor

0900404

Cluster diagnostics
detected a problem in link
2 of the SSD.

The impact on the cluster is


minimal as long as the other
Storage Controller link is
working as expected or link 1
is functional. Cluster
performance may be
degraded.

Minor

ssd_link2_level_5_major

0900405

Cluster diagnostics
detected a major problem
in link 2 of the SSD.

The impact on the cluster is


minimal as long as the other
Storage Controller link is
working as expected or link 1
is functional. Cluster
performance may be
degraded.

Major

ssd_link2_level_6_critical

0900406

Cluster diagnostics
detected a critical problem
in link 2 of the SSD.

The impact on the cluster is


minimal as long as the other
Storage Controller link is
working as expected or link 1
is functional. Cluster
performance may be
degraded.

Major

ssd_user_disabled

0900602

SSD was manually


disabled by user request.

The SSD will not be used in


the DPG group.

Major

ssd_system_disabled

0900603

The cluster has disabled


the SSD. It will no longer be
in service.

The SSD will not be used in


the DPG group.

Major

ssd_fru_failed

0900703

SSD has failed.

The SSD will not be used in


the DPG group.

Major

ssd_fru_disconnected

0900704

SSD is disconnected.

The SSD will not be used in


the DPG group.

Major

ssd_fru_uninitialized

0900705

SSD is not initialized.

The SSD will not be used in


the DPG group.

Minor

Alerts Details

527

Alerts and Events Details

Alert Name

Alert
Code

ssd_fru_prepare_failed

0900706

FRU replacement has failed


for the SSD.

ssd_fw_upgrading

0900802

Firmware is in process of
being upgraded.

ssd_fw_invalid

0900803

Firmware version of the


SSD is incompatible.

The SSD will not be used in


the DPG group.

Major

ssd_fw_mismatch

0900804

Firmware version of the


SSD is incorrect.

The SSD will not be used in


the DPG group.

Minor

ssd_add_pending

0901102

SSD add request has not


completed successfully.

Minor

ssd_modify_pending

0901103

SSD modify request has


not completed
successfully.

Minor

ssd_remove_pending

0901104

SSD remove request has


not completed
successfully.

Minor

ssd_limited_endurance

0901202

Wear level (endurance) of


the SSD is low. The
remaining wear level for
this SSD is <field1> percent.

Field1:per The SSD will be used until it


cent_end fails or endurance is
urance_re exhausted.
maining

Minor

ssd_very_limited_endurance

0901203

Wear level (endurance) of


the SSD is very low and
has reached a critical level.
The remaining wear level
for this SSD is <field1>
percent.

Field1:per The SSD will be used until it


cent_end fails or endurance is
urance_re exhausted.
maining

Major

ssd_none_remaining_endurance

0901204

SSD endurance level is


exhausted and completely
worn out. The remaining
wear level for this SSD is
<field1> percent.

Field1:per The SSD will be used until it


cent_end fails.
urance_re
maining

Critical

tar_not_found

1100202

Target port is not found or


missing.

The target port is unusable


and cannot serve I/Os.

Major

tar_fc_counter

1100203

Target port has FC counter


error.

The target port has errors, and


may not serve I/Os.

Minor

target_level_2_unknown

1100402

Target port state cannot be


determined. The Target
port state is unknown.

Cluster performance may be


impacted and the port may
not serve I/Os.

Minor

target_level_3_warning

1100403

Target port diagnostics


detected a minor problem.

Cluster performance may be


impacted. The port may not
serve I/Os and cluster
performance may be
impacted.

Minor

target_level_4_minor

1100404

Target port diagnostics


detected a problem.

Cluster performance may be


impacted. The port may not
serve I/Os and cluster
performance may be
impacted.

Minor

528

EMC XtremIO Storage Array User Guide

Description

Field

System Impact

Severity

The SSD will not be used in


the DPG group.

Minor
Info.

Alerts and Events Details

Alert Name

Alert
Code

target_level_5_major

1100405

target_level_6_critical

Description

Field

System Impact

Severity

Target port diagnostics


detected a major problem.

Cluster performance may be


impacted. The port may not
serve I/Os and cluster
performance may be
impacted.

Major

1100406

Target port diagnostics


detected a critical
problem.

Cluster performance may be


impacted. The port may not
serve I/Os and cluster
performance may be
impacted.

Major

target_add_pending

1100502

Target is in an ambiguous
state after an add request.

Minor

target_modify_pending

1100503

Target is in an ambiguous
state after a modification
request.

Minor

target_remove_pending

1100504

Target is in an ambiguous
state after a remove
request.

Minor

xenv_failover

1200107

Internal sub-process
(XEnv) state is performing
failover.

Internal sub-process is in the


process of fail-over into the
other Storage Controller.

Major

xenv_failback

1200108

Internal sub-process
(XEnv) state is performing
failback as part of process
recovery.

Internal sub-process is in the


process of failing back into the
other Storage Controller.
Cluster performance may be
impacted for s short period of
time during the fail-back
process.

Info.

module_failover

1300106

Internal sub-process
(module) state is
performing fail-over.

Cluster performance may be


impacted.

Major

module_failback

1300107

Internal sub-process
(module) state is
performing fail-back as
part of process recovery.

Cluster performance may be


impacted.

Info.

ibswitch_level_2_unknown

1400102

InfiniBand Switch link


state for port <field1>
cannot be determined. The
link state is unknown.

Field1:po
rt_index

Overall cluster impact is


limited as long as the other
InfiniBand Switch ports are
healthy.

Minor

ibswitch_level_3_warning

1400103

InfiniBand Switch link


state for port <field1> has a
minor problem.

Field1:po
rt_index

Overall cluster impact is


limited as long as the other
InfiniBand Switch ports are
healthy.

Minor

ibswitch_level_4_minor

1400104

InfiniBand Switch link


state for port <field1> has a
problem.

Field1:po
rt_index

Overall cluster impact is


limited as long as the other
InfiniBand Switch ports are
healthy.

Major

ibswitch_level_5_major

1400105

InfiniBand Switch link


state for port <field1> has a
major problem.

Field1:po
rt_index

Overall cluster impact is


limited as long as the other
InfiniBand Switch ports are
healthy.

Major

Alerts Details

529

Alerts and Events Details

Alert Name

Alert
Code

ibswitch_level_6_critical

Description

Field

System Impact

Severity

1400106

InfiniBand Switch link


state for port <field1> has a
critical problem.

Field1:po
rt_index

Overall cluster impact is


limited as long as the other
InfiniBand Switch ports are
healthy.

Major

ibswitch_user_disabled

1400302

The InfiniBand Switch was


manually disabled by user
request.

Cluster impact is limited as


long as the other InfiniBand
switch is up and running with
healthy links.

Major

ibswitch_system_disabled

1400303

The cluster has disabled


the InfiniBand Switch.

Cluster impact is limited as


long as the other InfiniBand
switch is up and running with
healthy links.

Major

ibswitch_fru_failed

1400403

InfiniBand Switch has


failed.

Cluster impact is limited as


long as the other InfiniBand
switch is up and running with
healthy links.

Major

ibswitch_fru_disconnected

1400404

InfiniBand Switch is
disconnected.

Cluster impact is limited as


long as the other InfiniBand
switch is up and running with
healthy links.

Major

ibswitch_fru_uninitialized

1400405

InfiniBand Switch is not


initialized.

Cluster impact is limited as


long as the other InfiniBand
switch is up and running with
healthy links.

Minor

ibswitch_fru_prepare_failed

1400406

FRU replacement has failed


for the InfiniBand Switch.

Cluster impact is limited as


long as another switch is up
and running and links are
healthy.

Minor

ibswitch_fw_upgrading

1400502

Firmware is in the process


of being upgraded.

The InfiniBand switch will be


used upon successful
upgrade.

Info.

ibswitch_fw_invalid

1400503

InfiniBand Switch firmware


version is incompatible.

The InfiniBand Switch cannot


be used. Cluster impact is
limited as long as the other
InfiniBand switch is up and
running with healthy links.

Major

ibswitch_fw_mismatch

1400504

InfiniBand Switch firmware


version is incorrect.

The cluster will try to use the


InfiniBand Switch. Cluster
impact is limited as long as
the other InfiniBand switch is
up and running with healthy
links.

Minor

ibswitch_unknown_model

1400505

The InfiniBand Switch


model is not supported in
this cluster's software
version.

Cluster impact is limited as


long as the other InfiniBand
switch is up and running with
healthy links.

Major

ibswitch_wrong_connection

1400602

Incorrect connection
between Storage
Controller(s) and
InfiniBand Switch was
detected.

530

EMC XtremIO Storage Array User Guide

Major

Alerts and Events Details

Alert Name

Alert
Code

ibswitch_one_fan_failed

1400702

One of the IB Switch Fans


has failed.

ibswitch_fan_drawer_failed

1400703

The Fan drawer of the IB


Switch has failed.

The InfiniBand Switch may


fail.

Major

ibswitch_s2s_ib1_port_down

1400801

InfiniBand Switch to
InfiniBand Switch port 17
is down.

Overall cluster impact is


limited as long as the other
InfiniBand Switch ports are
healthy.

Minor

ibswitch_s2s_ib2_port_down

1400901

InfiniBand Switch to
InfiniBand Switch port 18
is down.

Overall cluster impact is


limited as long as the other
InfiniBand Switch ports are
healthy.

Minor

no_ups_load

1500102

No power (load) is being


consumed from the BBU.

One or more Storage


Controller are not protected by
the BBU. The cluster may still
run normally if another power
source is stable for the
Storage Controllers.

Major

low_threshold_ups_load

1500103

Power being consumed


from the BBU is excessive.
The current power
consumption (load) is
<field1> percent of the
BBU's full load capability.

Field1:up
s_load_in
_percent

Consumed load from the BBU


is lower than expected. The
cluster may still run normally if
another power source for the
Storage Controllers is stable.

Minor

med_threshold_ups_load

1500104

Power being consumed


from the BBU is excessive.
The current power
consumption (load) is
<field1> percent of the
BBU's full load capability.

Field1:up
s_load_in
_percent

Consumed load from the BBU


is lower than expected. The
cluster may still run normally if
another power source for the
Storage Controllers is stable.

Major

high_threshold_ups_load

1500105

BBU is overloaded. The


current power
consumption (load) is
<field1> percent of the
BBU's full load capability.

Field1:up
s_load_in
_percent

Consumed load from the BBU


is higher than expected.
Cluster may still run normally
if another power source for the
Storage Controllers is stable.

Major

ups_node_1_disconnected

1500203

Serial communication to
the BBU is disconnected
from Storage Controller 1,
but is connected from
Storage Controller 2.

The cluster is currently


communicating with the BBU
via a single connection.

Major

ups_node_2_disconnected

1500204

Serial communication to
the BBU is disconnected
from Storage Controller 2,
but is connected from
Storage Controller 1.

The cluster is currently


communicating with the BBU
via a single connection.

Major

ups_no_external_power

1500402

There is no external power


feed from grid <field1> to
the BBU. BBU may be
powered off or running on
battery.

No impact to the cluster


service is expected, as long as
the redundant power source is
stable and healthy.

Major

Description

Field

System Impact

Severity
Minor

Field1:po
wer_feed

Alerts Details

531

Alerts and Events Details

Alert Name

Alert
Code

ups_low_bat_failure_true

Description

Field

System Impact

Severity

1500502

BBU charge level is low:


<field1> percent. Power
input to the BBU is
present, but the battery is
insufficiently charged.

Field1:up
s_battery
_charge_i
n_percent

No impact to the cluster


service is expected, as long as
the redundant power source is
stable and healthy.

Major

ups_low_bat_no_input

1500602

BBU charge level is low:


<field1> percent. Power
input to the BBU is not
present.

Field1:up
s_battery
_charge_i
n_percent

No impact to the cluster


service is expected, as long as
the redundant power source is
stable and healthy.

Major

ups_low_bat_run_failure_true

1500702

Battery Backup Unit has


low runtime. Current
battery runtime value is:
<field1> seconds.

Field1:bat No impact to the cluster


tery_runti service is expected, as long as
me
the redundant power source is
stable and healthy.

Major

ups_overld_failure_true

1500802

BBU is overloaded. The


current power
consumption (load) is
<field1> percent of the
BBU's full load capability.

Field1:up
s_load_in
_percent

Consumed load from the BBU


is higher than expected. No
impact to the cluster service is
expected, as long as the
redundant power source is
stable and healthy.

Major

ups_bypass_active_failure_true

1501102

Battery Backup Unit


bypass mode is activated
(there is no protection
against power dips or
outages).

The Storage Controller is no


longer protected by the BBU. If
power loss occurs, data
integrity may be at risk. There
is no immediate impact on the
cluster, as long as all power
sources are healthy.

Major

ups_need_bat_replce_failure_tru 1501302
e

The cluster has detected


that the Battery Backup
Unit should be replaced.

Protection provided by this


BBU is marginal. No impact to
the cluster service is
expected, as long as the
redundant power source is
stable and healthy.

Major

ups_user_disabled

1501401

The Battery Backup Unit


has been manually
disabled by user request.

The Storage Controller may no


longer be protected by the
BBU.

Major

ups_system_disabled

1501403

Cluster has disabled the


Backup Battery Unit.

The Storage Controller may no


longer be protected by the
BBU.

Major

ups_fru_failed

1501503

BBU has failed

The associated Storage


Controller(s) is no longer
protected by the BBU.

Major

ups_fru_disconnected

1501504

BBU is disconnected from


the cluster.

The associated Storage


Controller(s) is no longer
protected by the BBU.

Major

ups_fru_uninitialized

1501505

BBU is not initialized.

The associated Storage


Controller(s) is no longer
protected by the BBU.

Minor

ups_fru_prepare_failed

1501506

FRU replacement has failed


for the BBU.

The associated Storage


Controller(s) is no longer
protected by the BBU.

Minor

ups_fw_upgrading

1501602

Firmware is in the process


of being upgraded.

532

EMC XtremIO Storage Array User Guide

Info.

Alerts and Events Details

Alert Name

Alert
Code

ups_fw_invalid

1501603

ups_fw_mismatch

Description

Field

System Impact

Severity

BBU firmware version is


incompatible.

The Storage Controller is not


protected by the BBU.

Major

1501604

BBU firmware version is


incorrect. The cluster will
try to use the BBU.

The Storage Controller may not


be protected by the BBU.

Minor

sas_sas1_port_down

1600202

DAE Controller SAS Port 1


is down.

Connectivity from the Storage


Controller to the DAE is down.

Major

jbodcontroller_user_disabled

1600402

The DAE Controller was


manually disabled by user
request.

jbodcontroller_system_disabled

1600403

The cluster has disabled


the DAE LCC. It will no
longer be in service.

jbodcontroller_fru_failed

1600503

The <field1> DAE Controller


has failed.

jbodcontroller_fru_disconnected

1600504

jbodcontroller_fru_uninitialized

Major

Cluster performance may be


impacted as the DAE
Controller is disabled.

Major

Field1:loc
ation

Cluster performance may be


impacted.

Major

The <field1> DAE Controller


is disconnected.

Field1:loc
ation

Cluster performance may be


impacted.

Major

1600505

The <field1> DAE Controller


is not initialized.

Field1:loc
ation

Cluster performance may be


impacted.

Minor

jbodcontroller_fru_prepare_faile
d

1600506

FRU replacement has failed


for the <field1> DAE
Controller.

Field1:loc
ation

Cluster performance may be


impacted.

Minor

jbodcontroller_fw_upgrading

1600602

Firmware is in the process


of being upgraded.

jbodcontroller_fw_invalid

1600603

Firmware version of the


<field1> Controller is
incorrect. The cluster will
try to use the DAE
Controller.

Field1:loc
ation

Cluster performance may be


impacted. The Cluster will
continue to serve I/Os as long
as the alternative DAE
Controller is healthy.

Major

jbodcontroller_fw_mismatch

1600604

Firmware version of the


DAEs <field1> DAE
Controller is incorrect. The
cluster will try to use the
DAE Controller.

Field1:loc
ation

If the DAE Controller is used,


there should be no impact on
the cluster. Otherwise, as long
as the alternative DAE
Controller is healthy, impact
on cluster is limited.

Minor

node_lcc_level_2_unknown

1600912

DAE Controller health


information is unavailable.
The cluster is unable to
read the information.

Overall cluster impact is


limited, as long as the other
DAE Controller is healthy.

Minor

node_lcc_level_3_warning

1600913

DAE Controller health


status is marginal.

Overall cluster impact is


limited, as long as the other
DAE Controller is healthy.

Minor

node_lcc_level_4_minor

1600914

DAE Controller health


status is limited.

Overall cluster impact is


limited, as long as the other
DAE Controller is healthy.

Minor

node_lcc_level_5_major

1600915

DAE Controller health


status is problematic.
Attention is required.

Overall cluster impact is


limited, as long as the other
DAE Controller is healthy.

Major

Info.

Alerts Details

533

Alerts and Events Details

Alert Name

Alert
Code

node_LCC_level_6_critical

1600916

lcc_sas2_port_down

Description

Field

System Impact

Severity

DAE Controller health


status is faulty. Immediate
attention is required.

Overall cluster impact is


limited, as long as the other
DAE Controller is healthy.

Major

1601102

DAE Controller SAS Port 2


is down.

Connectivity from the Storage


Controller SAS to the DAE is
down.

Minor

jbodpsu_user_disabled

1700202

The DAE PSU was manually


disabled by user request.

No impact on the cluster, as


long as the alternative power
source for the DAE is healthy.

Major

jbodpsu_system_disabled

1700203

The cluster has disabled


the DAE PSU. It will no
longer be in service.

No impact on the cluster, as


long as the alternative power
source for the DAE is healthy.

Major

jbodpsu_fru_failed

1700303

The <field1> DAE PSU has


failed.

Field1:loc
ation

No impact on the cluster, as


long as the alternative power
source for the DAE is healthy.

Major

jbodpsu_fru_disconnected

1700304

The <field1> DAE PSU is


disconnected.

Field1:loc
ation

No impact on the cluster, as


long as the alternative power
source for the DAE is healthy.

Major

jbodpsu_fru_uninitialized

1700305

The <field1> DAE PSU is not


initialized.

Field1:loc
ation

No impact on the cluster, as


long as the alternative power
source for the DAE is healthy.

Minor

jbodpsu_fru_prepare_failed

1700306

FRU replacement has failed


for the <field1> DAE PSU.

Field1:loc
ation

No impact on the cluster, as


long as the alternative power
source for the DAE is healthy.

Minor

jbodpsu_fw_upgrading

1700402

Firmware is in the process


of being upgraded.

jbodpsu_fw_invalid

1700403

Firmware version of the


<field1> DAE PSU is
incompatible. The PSU
cannot be used.

jbodpsu_fw_mismatch

1700404

dae_psu_ac_lost

Info.
No impact on the cluster, as
long as the alternative power
source for the DAE is healthy.

Major

Firmware version of the


<field1> DAE PSU is
incorrect. The cluster will
try to use the PSU.

If DAE PSU can be used, there


is no impact on cluster.
Otherwise, as long as the
alternative DAE PSU is healthy
there will be no impact on
cluster.

Minor

1700702

No AC feed to DAE PSU was


detected.

No impact on the cluster, as


long as the alternative power
source for the DAE is healthy.

Major

dae_psu_ac_out_of_range

1700703

DAE PSU AC is out of range.

No impact on the cluster, as


long as the alternative power
source for the DAE is healthy.

Major

dae_psu_ac_failed

1700704

DAE PSU AC failure was


detected.

No impact on the cluster, as


long as the alternative power
source for the DAE is healthy.

Major

ibswitchpsu_user_disabled

1700802

The InfiniBand Switch PSU


was manually disabled by
user request.

No impact on the cluster


service is expected, as long as
the alternative power source
for the InfiniBand switch is
healthy.

Major

534

EMC XtremIO Storage Array User Guide

Field1:loc
ation

Alerts and Events Details

Alert Name

Alert
Code

ibswitchpsu_system_disabled

1700803

The cluster has disabled


the InfiniBand Switch PSU.
It will no longer be in
service.

ibswitchpsu_fru_failed

1700903

The <field1> InfiniBand


Switch PSU has failed.

ibswitchpsu_fru_disconnected

1700904

ibswitchpsu_fru_uninitialized

Description

Field

System Impact

Severity

No impact on the cluster


service is expected, as long as
the alternative power source
for the InfiniBand switch is
healthy.

Major

Field1:loc
ation

No impact on the cluster


service is expected, as long as
the alternative power source
for the InfiniBand switch is
healthy.

Major

The <field1> InfiniBand


Switch PSU is
disconnected.

Field1:loc
ation

No impact on the cluster


service is expected, as long as
the alternative power source
for the InfiniBand switch is
healthy.

Major

1700905

The <field1> InfiniBand


Switch PSU is not
initialized.

Field1:loc
ation

No impact on the cluster


service is expected, as long as
the alternative power source
for the InfiniBand switch is
healthy.

Minor

ibswitchpsu_fru_prepare_failed

1700906

FRU replacement has failed


for the <field1> InfiniBand
Switch PSU.

Field1:loc
ation

No impact on the cluster


service is expected, as long as
the alternative power source
for the InfiniBand switch is
healthy.

Minor

ibswitchpsu_fw_upgrading

1701102

Firmware is in process of
being upgraded.

ibswitchpsu_fw_invalid

1701103

Firmware version of the


<field1> InfiniBand Switch
PSU is incompatible. The
PSU cannot be used.

Field1:loc
ation

No impact on the cluster


service is expected, as long as
the alternative power source
for the InfiniBand switch is
healthy.

Major

ibswitchpsu_fw_mismatch

1701104

Firmware version of the


<field1> InfiniBand Switch
PSU is incorrect. The
cluster will try to use the
PSU.

Field1:loc
ation

No impact on the cluster


service is expected, as long as
the alternative power source
for the InfiniBand switch is
healthy.

Minor

ibswitchpsu_no_external_power

1701502

Power input to the


InfiniBand Switch PSU has
failed.

There is no impact on the


cluster, as long as the
alternative power source for
the InfiniBand switch is
healthy.

Major

jbod_fru_failed

1800303

DAE has failed.

The cluster may not serve


I/Os.

Major

jbod_fru_disconnected

1800304

DAE is disconnected from


the cluster.

jbod_fru_uninitialized

1800305

DAE is not initialized.

The cluster may not serve I/Os


until DAE is initialized.

Minor

jbod_fru_prepare_failed

1800306

FRU replacement has failed


for the DAE.

The cluster may not serve I/Os


until DAE is initialized.

Minor

Info.

Major

Alerts Details

535

Alerts and Events Details

Alert Name

Alert
Code

snapshotgroup_add_pending

1900102

Volume Snapshot Group is


in an ambiguous state
after an add request.

Minor

snapshotgroup_modify_pending

1900103

Volume Snapshot Group is


in an ambiguous state
after a modification
request.

Minor

snapshotgroup_remove_pending 1900104

Volume Snapshot Group is


in an ambiguous state
after a remove request.

Minor

discovery_chap_initiators_missi
ng_credentials_true

1901102

CHAP is enabled. Add


discovery credentials to
initiators. Otherwise, a
failure will occur when an
initiator is disconnected
and then re-connected.

Major

xms_disk_low_free_space

2000002

Disk free space level is low.


<field1> Kbytes are
available.

Field1:fre
e_space

XMS operation may be


impacted. Cluster service
should not be impacted.

Major

xms_disk_no_free_space

2000003

Insufficient disk space:


<field1> Kbytes are
available.

Field1:fre
e_space

XMS operation may be


impacted. Cluster service
should not be impacted.

Critical

xms_disk_very_low_free_space

2000004

Disk space level is critically


low. <field1> Kbytes are
available.

Field1:fre
e_space

xms_memory_low

2000012

XMS memory level is low.


<field1> Kbytes are
available.

Field1:fre
e_memor
y

xms_memory_full

2000013

XMS has insufficient free


memory: only <field1>
Kbytes are available.

Field1:fre XMS operation may be


e_memeo impacted. Cluster service
ry
should not be impacted.

xms_wrong_cn_true

2000102

XMS certificate contains


wrong Common Name.

xms_disk_second_low_free_spa
ce

2000202

Disk space level of second


partition is low. <field1>
Kbytes are available.

Field1:fre
e_disk_s
pace_sec
ondary

XMS operation may be


impacted. Cluster service
should not be impacted.

Major

xms_disk_second_very_low_free 2000203
_space

Disk space level of second


partition is critically low.
<field1> Kbytes are
available.

Field1:fre
e_disk_s
pace_sec
ondary

XMS operation may be


impacted. Cluster service
should not be impacted.

Major

xms_disk_second_no_free_spac
e

2000204

Not enough disk space for


second partition. XMS will
block most operations.
only <field1> Kbytes are
available.

Field1:fre
e_disk_s
pace_sec
ondary

XMS operation may be


impacted. Cluster service
should not be impacted.

Critical

cg_add_pending

2200802

Consistency Group is in an
ambiguous state after an
add request.

536

EMC XtremIO Storage Array User Guide

Description

Field

System Impact

Severity

Major

XMS operation may be


impacted. Cluster service
should not be impacted.

Major

Critical

Major

Minor

Alerts and Events Details

Alert Name

Alert
Code

cg_modify_pending

2200803

Consistency Group is in an
ambiguous state after a
modification request.

Minor

cg_remove_pending

2200804

Consistency Group is in an
ambiguous state after a
remove request.

Minor

ig_add_pending

2300102

The Initiator Group add


request has not completed
successfully.

Minor

ig_modify_pending

2300103

The Initiator Group


modification request has
not completed
successfully.

Minor

ig_remove_pending

2300104

The Initiator Group remove


request has not completed
successfully.

Minor

initiator_add_pending

2400102

The initiator is in an
ambiguous state after an
add request.

Minor

initiator_modify_pending

2400103

The initiator is in an
ambiguous state after a
modification request.

Minor

initiator_remove_pending

2400104

The initiator is in an
ambiguous state after a
removal request.

Minor

scheduler_last_activation_failed

2500203

Last activation of
scheduler has failed.
Scheduler snapshot
creation and deletion has
been suspended.

New Snapshots will not be


created nor will old Snapshots
be deleted according to the
Scheduler retention policy.

Major

scheduler_last_activation_obj_n
ot_found

2500204

Last activation of
scheduler has failed.
Invalid source object of the
scheduler.

New Snapshots will not be


created nor will old Snapshots
be deleted according to the
Scheduler retention policy.

Major

scheduler_last_activation_vsg_
max_reached

2500205

The number of volumes in


a Volume Snapshot Group
has reached the limit.

Scheduler Snapshot creation


Major
has stopped. Snapshot
Scheduler will continue to
delete Snapshots according to
the retention policy. New
Snapshots will not be created.

scheduler_last_activation_cluste
r_volumes_max_reached

2500206

The number of volumes in


the cluster has reached the
limit.

Scheduler Snapshot creation


Major
has stopped. Snapshot
Scheduler will continue to
delete Snapshots according to
the retention policy. New
Snapshots will not be created.

Description

Field

System Impact

Severity

Alerts Details

537

Alerts and Events Details

Events Details

Event Name

Event
Code

SYSTEM_EXPANSION_IN_PROGRESS

02022

SYSTEM_SHAREDMEMORY_IN_USE_R 02010
ATIO_LEVEL

Field Value

Event
Category

Description

Field

Cluster expansion in
progress changed
from <field1> to
<field2>.

Field 1: old_value
no
Field 2:
yes
cluster_expansion_i
n_progress

State_
Change

Shared memory
space utilization is
<field1> percent of
the total shared
memory pool. The
shared memory
utilization state is
<field2>.

Field1:
shared_memory_in
_use_ratio

Integer: 0 - 100

Software

Field2:
shared_memory_in
_use_ratio_level

healthy
limited_free_space
very_limited_space
no_free_space

Software

NODE_ETH_LINK_LEVEL

04039

ETH management
link state was
changed from <field1>
to <field2>.

Field1:old_value
Field2:eth_link_hea
lth_level

level_1_clear
level_2_unknown
level_3_warining
level_4_minor
level_5_major
level_6_critical

Software

NODE_SAS2_PORT_RATE

04036

SAS port 2 rate


changed from <field1>
to <field2>.

Field1:old_value
Field2:sas2_port_ra
te

12gbps
6gbps
3gbps
down
unknown

Hardware

NODE_INTERNAL_SENSOR_HEALTH

04015

Storage Controller
internal processors
health state was
changed from <field1>
to <field2>.

Field1:old_value
Field2:internal_sen
sor_health_state

level_1_clear
level_2_unknown
level_3_warning
level_4_minor
level_5_major
level_6_critical

Hardware

LOCAL_DISK_ENABLED_STATE

05002

The enabled state for


the local disk was
changed from <field1>
to <field2>.

Field1:old_value
Field2:enabled_stat
e

enabled
user_disabled
system_disabled

State_Ch
ange

NODE_PSU_FRU_STATE

06003

Life cycle state of the


Storage Controller
PSU in <field1> was
changed from <field2>
to <field3>.

Field1:location

left
right

State_Ch
ange

538

EMC XtremIO Storage Array User Guide

Field2:old_value
healthy
Field3:fru_lifecycle_ initializing
state
failed
disconnected
uninitialized
prepare_failed

Alerts and Events Details

Event Name

Event
Code

SSD_LINK1_HEALTH

SSD_FRU_FW_VERSION_STATE

Event
Category

Description

Field

Field Value

09003

Link 1 state for SSD


was changed from
<field1> to <field2>.

Field1:old_value
level_1_clear
Field2:ssd_link1_he level_2_unknown
alth_state
level_3_warining
level_4_minor
level_5_major
level_6_critical

09008

Firmware version of
the SSD is <field1>.
Current firmware
version is <field2>.

Field1:fw_version_e no_error
Software
rror
upgrading
invalid_fw_version
mismatch_fw_version
Field2:fw_version

Assigned fw version
number

Software

IB_SWITCH_IB_PORT_PEER_GUID

14012

InfiniBand Switch
port peer guid for
port <field1> was
changed.

Field1:port_index

same
changed

State_Ch
ange

SYSTEM_HEALTH_STATE

02013

Cluster state was


changed from <field1>
to <field2>.

Field1:old_value
Field2:sys_health_s
tate

State_Ch
ange

SYSTEM_UD_SSD_SPACE_LEVEL

02003

Free physical
capacity is low. The
cluster has only
<field1> percent free
storage capacity.

Field1:
free_ud_ssd_space
_in_percent

healthy
Software
limited_free_space
very_limited_free_spa
ce
no_free_space

SYSTEM_STATE

02005

Cluster state was


changed from <field1>
to <field2>.

Field1:old_value
Field2:sys_state

start
configured
initializing
active
stopping
stopped
starting
failed
unknown
down
stop_failed

State_Ch
ange

SYSTEM_SYS_STOP_TYPE

02006

Cluster stop mode


was changed from
<field1> to <field2>
state.

Field1:old_value
Field2:sys_stop_typ
e

none
dae_stopped
stopped
failed_stop
unknown
stopping
dae_stopping

Software

healthy
partial_fault
degraded
failed

Events Details

539

Alerts and Events Details

Event Name

Event
Code

SYSTEM_SYS_STOPPED_REASON

02007

Description

Field

Field Value

Cluster has stopped


with the reason of
<field1>.

Field1:stopped_rea
son

SYSTEM_UPGRADE_STATE

02008

SYSTEM_MANAGER_CONNECTION_ST 02009
ATE

Cluster upgrade
process has changed
its state from <field1>
to <field2>. <field3>

Event
Category

none
Software
multiple_disk_failure
dae_inaccessible
user_deactivated
multiple_ups_failures
double_node_in_bric
k_failure
restart_failure
sw_failure
hw_failure
ha_failure
ups_protect_limited
disk_mount_failure
power_off_button_pre
ssed

Field1:old_value
no_upgrade_done
State_Ch
ange
Field2:upgrade_stat testing_validity
e
stopping_service
new_version_detecte
d
upgrade_succeeded
bringing_up_new_ver
sion
waiting_for_new_versi
on
preparing_system
upgrade_failed
rollback_in_progress
Field3:upgrade_fail
ure_reason

String

The XMS connection


to the Cluster
Manager has
changed to <field 1>.
Error reason is <field
2>.

Field 1:
sys_mgr_conn_stat
e

disconnected
connected
unknown

State_Ch
ange

Field 2:
no_route_to_host
sys_mgr_conn_error connection_reset_by_
_reason
peer
connection_refused

SYSTEM_FC_PORT_SPEED

04034

FC port speed for


targets changed from
<field1> to <field2>.

Field1:old_value
Field2:fc_port_spee
d

not_in_use
inconsistent
1gfc
8gfc
10gfc
16gfc

State_Ch
ange

SYSTEM_SCSI_PORT_SPEED

04035

iSCSI port speed for


targets changed from
<field1> to <field2>.

Field1:old_value
Field2:fc_port_spee
d

not_in_use
inconsistent
10mb
100mb
1gb
10gb
40gb

State_Ch
ange

540

EMC XtremIO Storage Array User Guide

Alerts and Events Details

Event Name

Event
Code

SYSTEM_CONSISTENCY_STATE

SYSTEM_TP_LIMIT_CROSSING

Event
Category

Description

Field

Field Value

02011

Cluster consistency
state was changed
from <field1> to
<field2>.

Field1:old_value
Field2:consistency_
state

healthy
error

Software

02021

The cluster VAAI thin


provisioning soft
limit state is <field1>.
The threshold is
<field2> percent.

Field1:vaai_tp_limit
_crossing

healthy
threshold_exceeded

Hardware

Field2:vaai_tp_limit

Integer: 0 - 100

SHDMEMORY_IN_USE_RECOVERABLE 02041
_LEVEL

The shared memory


utilization state
changed from <field1>
to <field2>. Shared
memory utilization is
<field3> percent of
the total shared
memory pool.

Field1:old_value
Field2:shared_mem
ory_in_use_recover
able_ratio_level
Field3:total_memor
y_in_use_in_percen
t

healthy
Software
limited_free_space
very_limited_free_spa
ce
no_free_space

BRICK_STATE

03001

X-Brick state was


changed from <field1>
to <field2>.

Field1:old_value
Field2:brick_state

in_sys
not_in_sys

Software

BRICK_SLOT_STATE

03002

X-Brick DAE Slot


<field1> state was
changed from <field2>
to <field3>.

Field1:ssd_slot_arr
ay[].slot_num

Integer: 1 - 25

Software

Field2:old_value
Field3:ssd_slot_arr
ay[].slot_state

empty
resident_ssd
unsupported_disk
uninitialized_ssd
foreign_xtremapp_ssd
error

NODE_ETH_PORT_RATE

04038

ETH management
port rate changed
from <field1> to
<field2>

Field1:old_value
Field2:sas1_port_ra
te

10mb
100mb
1gb
10gb
40gb

Hardware

NODE_HEALTH_STATE

04048

Storage Controller's
state was changed
from <field1> to
<field2>.

Field1:old_value
Field2:node_health
_state

healthy
partial_fault
degraded
failed

State_Ch
ange

NODE_STATE

04001

The Storage
Controller state was
changed from <field1>
to <field2>.

Field1:old_value
Field2:node_state

active
State_Ch
ange
not_in_sys
prepared_decoupled
stopping
stopped
starting
failed

SAS_HBA_DOWN

04002

State of the Storage


Controller SAS port 1
(connected to DAE)
was changed from
<field1> to <field2>.

Field1:old_value
Field2:sas1_port_st
ate

up
down
unknown
system_disabled

State_Ch
ange

Events Details

541

Alerts and Events Details

Event Name

Event
Code

SAS_HBA_DOWN2

Event
Category

Description

Field

Field Value

04003

State of the storage


Controller SAS HBA 2
(connected to DAE)
was changed from
<field1> to <field2>.

Field1:old_value
Field2:sas2_port_st
ate

up
down
unknown
system_disabled

Hardware

NODE_SAS1_PORT_RATE

04004

SAS port 1 rate


changed from <field1>
to <field2>.

Field1:old_value
Field2:sas1_port_ra
te

12gbps
6gbps
3gbps
down
unknown

Hardware

NODE_MGR_CONN_STATE

04005

XMS connection to
the Storage
Controller was
changed to <field1>.

Field1:node_mgr_c
onn_state

connected
State_Ch
controlled_disconnect ange
disconnected
unknown

NODE_JOURNAL_HEALTH_STATE

04007

Storage Controller
journal state was
changed from <field1>
to <field2>.

Field1:old_value
healthy
Field2:node_journal ready
ing_health_state
fault
dumping

Software

NODE_TEMPERATURE_HEALTH

04011

Storage Controller
IPMI temperature
health state changed
from <field1> to
<field2>.

Field1:old_value
level_1_clear
Field2:temperature_ level_2_unknown
health_state
level_3_warning
level_4_minor
level_5_major
level_6_critical

Hardware

NODE_FAN_HEALTH

04012

Storage Controller
fan health state was
changed from <field1>
to <field2>.

Field1:old_value
Field2:fan_health_s
tate

level_1_clear
level_2_unknown
level_3_warning
level_4_minor
level_5_major
level_6_critical

Hardware

NODE_VOLTAGE_HEALTH

04013

Storage Controller
IPMI voltage health
state was changed
from <field1> to
<field2>.

Field1:old_value
Field2:voltage_heal
th_state

level_1_clear
level_2_unknown
level_3_warning
level_4_minor
level_5_major
level_6_critical

Hardware

NODE_CURRENT_HEALTH

04014

Storage Controller
IPMI current health
state was changed
from <field1> to
<field2>.

Field1:old_value
level_1_clear
Field2:current_healt level_2_unknown
h_state
level_3_warning
level_4_minor
level_5_major
level_6_critical

Hardware

DIMM_HEALTH

04033

Storage Controller
memory card (DIMM)
health state has
changed from <field1>
to <field2>.

Field1:old_value
level_1_clear
Field2:dimm_health level_2_unknown
_state
level_3_warning
level_4_minor
level_5_major
level_6_critical

Hardware

542

EMC XtremIO Storage Array User Guide

Alerts and Events Details

Event Name

Event
Code

NODE_ETH_PORT_STATE

Event
Category

Description

Field

Field Value

04016

Storage Controller
management port
state was changed
from <field1> to
<field2>.

Field1:old_value
Field2:eth_port_sta
te

up
down
unknown

State_Ch
ange

NODE_IB1_LINK_LEVEL

04017

Storage Controller
link 1 InfiniBand
network state was
changed from <field1>
to <field2>.

Field1:old_value
Field2:ib1_link_hea
lth_level

State_Ch
ange

NODE_IB1_PORT_MISCONNECTION

04018

Storage Controller
InfiniBand port 1
connection state was
changed from <field1>
to <field2>.

Field1:old_value
healthy
Field2:ib1_port_mis wrong_port
connection
wrong_switch

Software

NODE_IB1_PORT_STATE

04019

Storage Controller
InfiniBand port 1
state was changed
from <field1> to
<field2>.

Field1:old_value
Field2:ib1_port_sta
te

up
down
unknown

State_Ch
ange

NODE_IB2_LINK_LEVEL

04021

Storage Controller
link 2 InfiniBand
network state was
changed from <field1>
to <field2>.

Field1:old_value
Field2:ib2_link_hea
lth_level

Software

NODE_IB2_PORT_MISCONNECTION

04022

Storage Controller
InfiniBand port 2
connection state was
changed from <field1>
to <field2>.

Field1:old_value
healthy
Field2:ib2_port_mis wrong_port
connection
wrong_switch

Software

NODE_IB2_PORT_STATE

04023

Storage Controller
InfiniBand port 2
state was changed
from <field1> to
<field2>.

Field1:old_value
Field2:ib2_port_sta
te

up
down
unknown

State_Ch
ange

NODE_SAS1_HBA_LINK_LEVEL

04041

Storage Controller
SAS port 1 state was
changed from <field1>
to <field2>.

Field1:old_value
Field2:sas1_hba_p
ort_health_level

level_1_clear
level_2_unknown
level_3_warning
level_4_minor
level_5_major
level_6_critical

Hardware

NODE_SAS2_HBA_LINK_LEVEL

04042

Storage Controller
SAS port 2 state was
changed from <field1>
to <field2>.

Field1:old_value
Field2:sas2_hba_p
ort_health_level

level_1_clear
level_2_unknown
level_3_warning
level_4_minor
level_5_major
level_6_critical

Hardware

level_1_clear
level_2_unknown
level_3_warning
level_4_minor
level_5_major
level_6_critical

level_1_clear
level_2_unknown
level_3_warning
level_4_minor
level_5_major
level_6_critical

Events Details

543

Alerts and Events Details

Event Name

Event
Code

NODE_UPGRADE_STATE

04024

NODE_STOP_TYPE

04025

Field

Storage Controller
upgrade state was
changed from <field1>
to <field2>. <field3>.

Field1:old_value
no_upgrade_done
State_Ch
Field2:upgrade_stat upgrade_succeeded ange
e
upgrade_in_progress
upgrade_failed

Storage Controller
stop type was
changed from <field1>
to <field2>: <field3>

Field Value

Event
Category

Description

Field3:upgrade_fail
ure_reason

String

Field1:old_value
Field2:node_stop_t
ype

Field3:node_stop_r
eason

lost_connectivity_with
_node
initiated_locally_by_n
ode
critical_process_died
xms_initiated_emerge
ncy_shutdown
pm_initiated_emerge
ncy_shutdown
user_deactivated
orderly_shutdown_fail
e
xms_initiated_orderly
_shutdown
fw_upgrade
node_initiated_emerg
ency_shutdown<
lost_connectivity_with
_ib_switch
lost_connectivity_with
_other_node
node_backend_storag
e_controller_state
enabled
user_disabled
system_disabled

none
dae_stopped
stopped
failed_stop
dae_stopping
stopping
replaced

Software

NODE_ENABLED_STATE

04026

The enabled state for


the Storage
Controller has
changed from <field1>
to <field2>.

Field1:old_value
Field2:enabled_stat
e

NODE_FRU_STATE

04027

Storage Controller life


cycle state was
changed from <field1>
to <field2>.

Field1:old_value
healthy
Field2:fru_lifecycle_ initializing
state
failed
disconnected
uninitialized
prepare_failed

NODE_FRU_FW_VERSION_STATE

04028

Storage Controller
software or firmware
version is <field1>.

Field1:fw_version_e no_error
Software
rror
upgrading
invalid_fw_version
mismatch_fw_version

544

EMC XtremIO Storage Array User Guide

State_Ch
ange

State_Ch
ange

Alerts and Events Details

Event Name

Event
Code

NODE_ACCESS_STATE_TO_DAE

LOCAL_DISK_DISK_FAILURE

LOCAL_DISK_FRU_STATE

Field

Field Value

04080

Access state to DAE


has changed from
<field1> to <field2>

Field1:old_value
Field2:sc_dae_acce
ss_state

balanced
State_Ch
unbalanced_no_failba ange
ck
unbalanced_failback

05001

Storage Controller
local disk in slot
<field1> was changed
from <field2> to
<field3>.

Field1:slot_num

Integer: 1 - 8

Field2:old_value
Field3:disk_failure

Life cycle state of the


Storage Controller
local disk has
changed from <field1>
to <field2>.

Field1:old_value
healthy
Field2:fru_lifecycle_ initializing
state
failed
disconnected
uninitialized
prepare_failed

Firmware version of
the Storage
Controller local disk
is <field1>. Current
firmware version is
<field2>.

Field1:fw_version_e no_error
Software
rror
upgrading
invalid_fw_version
mismatch_fw_version
Field2:fw_version

Assigned fw version
number

Storage Controller
PSU in <field1> has
<field2>.

Field1:location

left
right

Field2:power_failur
e

enabled
user_disabled
system_disabled

05003

LOCAL_DISK_FRU_FW_VERSION_STAT 05004
E

NODE_PSU_POWER_FAILURE

NODE_PSU_ENABLED_STATE

Event
Category

Description

06001

Hardware

ok
empty
unanticipated_disk
unsupported_disk
error
uninitialized
State_Ch
ange

Hardware

clear
unknown
warning
minor
major
critical

06002

The enabled state of


the Storage
Controller PSU has
changed from <field1>
to <field2>.

Field1:old_value
Field2:enabled_stat
e

NODE_PSU_FRU_FW_VERSION_STATE 06004

Storage Controller
PSU firmware version
is <field1>. Current
firmware version is
<field2>.

Field1:fw_version_e no_error
Software
rror
upgrading
invalid_fw_version
mismatch_fw_version
Field2:fw_version

State_Ch
ange

Assigned fw version
number

Events Details

545

Alerts and Events Details

Event Name

Event
Code

NODE_PSU_INPUT

06007

Description

Field

Field Value

Input State of the


Storage Controller
PSU in <field1> was
changed to <field2>.

Field1:location

left
right

Field2:input

uninitialized
off
on

Event
Category
Software

RG_PROTECTION_STATE

08001

DPG group protection


state was changed
from <field1> to
<field2>.

Field1:old_value
normal
Field2:protection_st degraded
ate
dual_failure
error
initializing
double_degraded

Software

RG_REBUILD_IN_PROGRESS

08002

DPG rebuild is in
progress. At least
<field1> percent
completed. User data
space in use=<field2>

Field1:rebuild_prog
ress

Software

Integer: 0 - 100

Field2:ud_ssd_spac done
e_in_use
0_to_20_percent_don
e
20_to_40_percent_do
ne
40_to_60_percent_do
ne
60_to_80_percent_do
ne
99_percent_done

RG_SSD_PREPARATION_IN_PROGRES
S

08003

DPG group is
preparing the SSD to
be introduced into
the DPG. <field1>
percent of the
process has been
completed.

Field1:ssd_preparat
ion_progress

done
Software
0_to_20_percent_don
e
20_to_40_percent_do
ne
40_to_60_percent_do
ne
60_to_80_percent_do
ne
99_percent_done

RG_AVAILABE_REBUILDS

08004

DPG number of
available rebuilds
was changed from
<field1> to <field2>.

Field1:old_value
Field2:available_re
builds

RG_UD_SSD_SPACE_LEVEL

08005

DPG group has low


free capacity. The
available free
capacity is <field1>
percent.

Field1:rg_ud_ssd_p
ercent_free_space

Integer: 0 - 100

546

EMC XtremIO Storage Array User Guide

0
1
2
3
4
5

Software

Software

Alerts and Events Details

Event Name

Event
Code

VOLUME_SMALL_IO_RATIO

08006

VOLUME_UNALIGNED_IO_RATIO

08007

Event
Category

Description

Field

Field Value

The volume small


block I/O ratio
changed from<field1>
to <field2>. The ratio
is <field3> percent.

Field1:old_value
Field2:small_io_rati
o_level

Field3:small_io_rati
o

Integer: 0 - 100

The unaligned block


I/O ratio changed
from <field1> to
<field2>.
The ratio is <field3>
percent.

Field1:old_value
Field2:unaligned_io
_ratio_level

Field3:unaligned_io
_ratio

Integer: 0 - 100

ok
low
medium
high

Software

ok
low
medium
high

Software

SSD_RG_STATE

09001

SSD state was


changed from <field1>
to <field2>.

Field1:old_value
Field2:ssd_state

in_rg
not_in_rg
failed_in_rg
eject_pending
assigning_to_rg

SSD_ENDURANCE_REMAINING

09012

SDD wear level


(Endurance) for SSD
was changed to
<field1>.

Field1:percent_end
urance_remaining_l
evel

Integer: 0 - 100

Hardware

SSD_DIAGNOSTIC_HEALTH

09002

SSD diagnostic state


was changed from
<field1> to <field2>.

Field1:old_value
Field2:diagnostic_h
ealth_state

Hardware

SSD_LINK2_HEALTH

09004

Link 2 state for SSD


was changed from
<field1> to <field2>.

Field1:old_value
level_1_clear
Field2:ssd_link2_he level_2_unknown
alth_state
level_3_warning
level_4_minor
level_5_major
level_6_critical

Software

SSD_ENABLED_STATE

09006

The enabled state for


the SSD has changed
from <field1> to
<field2>.

Field1:old_value
Field2:enabled_stat
e

State_Ch
ange

SSD_FRU_STATE

09007

SSD lifecycle state


was changed from
<field1> to <field2>.

Field1:old_value
healthy
Field2:fru_lifecycle_ initializing
state
failed
disconnected
uninitialized
prepare_failed
trigger_update

State_Ch
ange

TARGET_TAR_ERROR_REASON

11002

Target port error


<field1> was
detected.

Field1:error_reason

Software

level_1_clear
level_2_unknown
level_3_warning
level_4_minor
level_5_major
level_6_critical

enabled
user_disabled
system_disabled

none
not_found
fc_counters

Software

Events Details

547

Alerts and Events Details

Event Name

Event
Code

TARGET_PORT_STATE

Event
Category

Description

Field

Field Value

11003

Target port state was


changed from <field1>
to <field2>.

Field1:old_value
Field2:port_state

up
down
unknown

State_Ch
ange

TARGET_TAR_HEALTH_STATE

11004

Target health state


was changed from
<field1> to <field2>.

Field1:old_value
Field2:port_state

level_1_clear
level_2_unknown
level_3_warning
level_4_minor
level_5_major
level_6_critical

Software

XENV_STATE

12001

Xenv state was


changed from <field1>
to <field2>.

Field1:old_value
Field2:xenv_state

inactive
boot
init
active
failed
invalid
failover
failback

State_Ch
ange

MODULE_STATE

13001

Internal sub-process
(module) state was
changed from <field1>
to <field2>.

Field1:old_value
Field2:mdl_state

active
xenv_boot
init
inactive
failed
failover
failback

State_Ch
ange

IB_SWITCH_LINK_HEALTH_LEVEL

14001

InfiniBand Switch
link state for port
<field1> was changed
from <field2> to
<field3>.

Field1:port_index

Integer: 0 - 17

Software

Field2:old_value
Field3:ports[].ib_lin
k_health_level

level_1_clear
level_2_unknown
level_3_warning
level_4_minor
level_5_major
level_6_critical

IB_SWITCH_FAN_DRAWER_STATE

14007

InfiniBand Switch Fan


drawer state has
changed from <field1>
to <field2>.

Field1:old_value
healthy
Field2:fan_drawer_s one_fan_failed
tatus
failed
unknown

Hardware

IB_SWITCH_S2S_1_PORT_STATE

14008

InfiniBand Switch
port state for
InfiniBand
Switch-to-InfiniBand
Switch port 17 has
changed from <field1>
to <field2>.

Field1:old_value
down
Field2:inter_switch_ active
ib1_port_state
reconnecting
unknown

State_Ch
ange

IB_SWITCH_S2S_2_PORT_STATE

14009

InfiniBand Switch
port state for
InfiniBand
Switch-to-InfiniBand
Switch port 18 has
changed from <field1>
to <field2>.

Field1:old_value
down
Field2:inter_switch_ active
ib2_port_state
reconnecting
unknown

State_Ch
ange

548

EMC XtremIO Storage Array User Guide

Alerts and Events Details

Event Name

Event
Code

IB_SWITCH_IB_PORT_STATE

14002

Event
Category

Description

Field

Field Value

InfiniBand Switch
port state for port
<field1> was changed
from <field2> to
<field3>.

Field1:port_index

Integer: 0 - 17

Field2:old_value
Field3:ports[].port_
state

down
up
unknown
enabled
user_disabled
system_disabled

State_Ch
ange

IB_SWITCH_ENABLED_STATE

14003

InfiniBand Switch
state was changed
from <field1> to
<field2>.

Field1:old_value
Field2:enabled_stat
e

IB_SWITCH_FRU_STATE

14004

InfiniBand Switch
lifecycle state was
changed from <field1>
to <field2>.

Field1:old_value
healthy
Field2:fru_lifecycle_ initializing
state
failed
disconnected
uninitialized
prepare_failed

InfiniBand Switch
firmware version is
<field1>. Current
firmware version is
<field2>.

Field1:fw_version_e no_error
Software
rror
upgrading
invalid_fw_version
mismatch_fw_version

IB_SWITCH_FRU_FW_VERSION_STATE 14005

Field2:fw_version

Assigned fw version
number

State_Ch
ange

State_Ch
ange

UPS_LOAD_PERCENT

15001

BBU load state was


changed from <field1>
to <field2>.

Field1:old_value
Field2:ups_load_pe
rcent_level

ok
Hardware
no_load
no_threshold_crossed
med_threshold_cross
ed
high_threshold_cross
ed

UPS_CONN_STATE

15002

BBU connection state


was changed from
<field1> to <field2>.

Field1:old_value
Field2:ups_conn_st
ate

UPS_INPUT

15004

BBU external power


feed state has
changed from <field1>
to <field2>.

Field1:old_value
Field2:ups_input

on
off

Software

UPS_LOW_BATTERY_HAS_INPUT

15005

State of the Backup


Battery Unit (with
power input feed)
Low Battery Level
was changed from
<field1> to <field2>.
Current battery
charge level is
<field3>.

Field1:old_value
Field2:is_low_batte
ry_has_input

false
true
invalid_state

Software

Field3:is_low_batte
ry_has_input

Integer

connected
disconnected
sc_1_disconnected
sc_2_disconnected
n_r

State_Ch
ange

Events Details

549

Alerts and Events Details

Event Name

Event
Code

UPS_LOW_BATTERY_NO_INPUT

UPS_LOW_BATTERY_RUNTIME

Event
Category

Description

Field

Field Value

15006

State of the Battery


Backup Unit (without
power input feed)
Low Battery Level
was changed from
<field1> to <field2>.

Field1:old_value
Field2:is_low_batte
ry_no_input

false
true
invalid_state

Software

15007

Battery Backup Unit


low runtime state has
changed from <field1>
to <field2>. Current
battery runtime value
is: <field3> seconds.

Field1:old_value
Field2:is_low_batte
ry_runtime

false
true
invalid_state

Software

Field3:battery_runti
me

Integer

State of the Battery


Backup Unit input
overload has
changed from <field1>
to <field2>.
Current BBU load is:
<field3>

Field1:old_value
Field2:is_low_batte
ry_runtime

false
true
invalid_state

Field3:ups_load_in
_percent

Integer

15011

State of the Battery


Backup Unit bypass
mode was changed
from <field1> to
<field2>.

Field1:old_value
false
Field2:is_bypass_ac true
tive
invalid_state

Software

UPS_NEEDS_BATTERY_REPLACEMENT 15013

Battery Backup Unit


replacement
requirement state
has changed from
<field1> to <field2>.

Field1:old_value
Field2:ups_need_b
attery_replacement

false
true
invalid_state

Hardware

UPS_ENABLED_STATE

15014

The enabled state for


the Battery Backup
Unit has changed
from <field1> to
<field2>.

Field1:old_value
Field2:enabled_stat
e

user_disabled
enabled
system_disabled

State_Ch
ange

UPS_FRU_STATE

15015

Life cycle state of the


BBU was changed
from <field1> to
<field2>.

Field1:old_value
healthy
Field2:fru_lifecycle_ initializing
state
failed
disconnected
uninitialized
prepared_failed

UPS_FRU_FW_VERSION_STATE

15016

Firmware version of
the BBU is <field1>.
Current firmware
version is <field2>.

Field1:fw_version_e no_error
Software
rror
upgrading
invalid_fw_version
mismatch_fw_version

UPS_OVERLOAD

UPS_BYPASS_ACTIVE

JBOD_CONTROLLER_SAS1_PORT_STA
TE

550

15008

16002

EMC XtremIO Storage Array User Guide

DAE Controller SAS


Port 1 port state has
changed from
<field1>to <field2>.

Field2:fw_version

Assigned fw version
number

Field1:old_value
Field2:sas1_port_st
ate

up
down
unknown

Software

State_Ch
ange

State_Ch
ange

Alerts and Events Details

Event Name

Event
Code

Description

Field

Field Value

Event
Category

JBOD_CONTROLLER_SAS2_PORT_STA
TE

16011

DAE Controller SAS


Port 2 port state has
changed from
<field1>to <field2>.

Field1:old_value
Field2:sas2_port_st
ate

up
down
unknown

State_Ch
ange

JBOD_CONTROLLER_ENABLED_STATE

16004

State of the <field1>


DAE Controller was
changed from <field2>
to <field3>.

Field1:location

left
right
uninitialized (if the
system cannot
determine the DAE
Controller port)

State_Ch
ange

Field2:old_value
Field3:enabled_stat
e

enabled
user_disabled
system_disabled

Field1:location

left
right
uninitialized (if the
system cannot
determine the DAE
Controller port)

JBOD_CONTROLLER_FRU_STATE

16005

Life cycle state of the


<field1> DAE
Controller was
changed from <field2>
to <field3>.

State_Ch
ange

Field2:old_value
healthy
Field3:fru_lifecycle_ initializing
state
failed
disconnected
uninitialized
prepare_failed
JBOD_CONTROLLER_FRU_FW_VERSIO
N_STATE

16006

Firmware version of
the <field1> DAE
Controller is <field2>.
Current firmware
version is <field3>.

Field1:location

left
right
uninitialized (if the
system cannot
determine the DAE
Controller port)

Software

Field2:fw_version_e no_error
rror
upgrading
invalid_fw_version
mismatch_fw_version
Field3:fw_version
JBOD_CONTROLLER_HEALTH_LEVEL

16009

DAE Controller health


state was changed
from <field1> to
<field2>.

Assigned fw version
number

Field1:old_value
level_1_clear
Field2:lcc_health_le level_2_unknown
vel
level_3_warning
level_4_minor
level_5_major
level_6_critical

Hardware

Events Details

551

Alerts and Events Details

Event Name

Event
Code

JBOD_PSU_INPUT

17001

JBOD_PSU_POWER_FAILURE

JBOD_PSU_ENABLED_STATE

JBOD_PSU_FRU_STATE

17007

17002

17003

Description

Field

Field Value

Input state of the DAE


PSU in <field1> was
changed to <field2>.

Field1:location

Field2:input

off
on

Field1:location

top
bottom
left
right

Field2:power_failur
e

no_error
ac_lost
ac_out_of_range
failure_detected

Field1:location

top
bottom
left
right

Field2:old_value
Field3:enabled_stat
e

enabled
user_disabled
system_disabled

Field1:location

The <field1> DAE PSU


has <field2>.

State of the
<location> DAE PSU
was changed from
<field1> to <field2>.

Life cycle state of the


<field1> DAE PSU was
changed from <field2>
to <field3>.

top
bottom
left
right

top
bottom
left
right

Event
Category
Hardware

Hardware

State_Ch
ange

State_Ch
ange

Field2:old_value
healthy
Field3:fru_lifecycle_ initializing
state
failed
disconnected
uninitialized
prepare_failed
IB_SWITCH_PSU_FRU_FW_VERSION_
STATE

17011

Firmware version of
the <field1>
InfiniBand Switch
PSU is <field2>.
Current firmware
version is <field3>.

Field1:location
upgrading
Software
Field2:fw_version_e invalid_fw_version
rror
mismatch_fw_version
Field3:fw_version

IB_SWITCH_INPUT

17015

InfiniBand Switch
PSU input state was
changed from <field1>
to <field2>.

Field1:old_value
Field2:input

on
off

Software

IB_SWITCH_PSU_ENABLED_STATE

17008

InfiniBand Switch
PSU state was
changed from <field1>
to <field2>.

Field1:old_value
Field2:enabled_stat
e

enabled
user_disabled
system_disabled

State_Ch
ange

552

EMC XtremIO Storage Array User Guide

Alerts and Events Details

Event Name

Event
Code

IB_SWITCH_PSU_FRU_STATE

17009

JBOD_PSU_FRU_FW_VERSION_STATE

17004

Description

Field

Field Value

Event
Category

Lifecycle state of the


<field 1> InfiniBand
Switch PSU has
changed from <field
2> to <field 3>.

Field 1:location
Field 2:old_value

left
right

State_Ch
ange

Field 3:
fru_lifecycle_state

Firmware version of
the <field 1> DAE PSU
is <field 2>. Current
firmware version is
<field 3>.

Field 1: location

left
right

Field 2:
fw_version_error

Field 3: fw_version

Assigned fw version
number

healthy
initializing
failed
disconnected
uninitialized
prepared_failed
Software

no_error
upgrading
invalid_fw_version
mismatch_fw_version

JBOD_FRU_STATE

18003

DAE life cycle state


was changed from
<field1> to <field2>.

Field1:old_value
healthy
Field2:fru_lifecycle_ initializing
state
failed
disconnected
uninitialized
prepared_failed

SYSTEM_SYS_SC_PWR_BUTTONS

02026

Power button
pressed state
changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
sc_power_buttons

not_pressed
State_Ch
ange
shutdown_request
shutdown_not_availa
ble

SYS_SSD_HI_UTILIZATION_THLD_CRO 02037
SSING

Threshold crossing of
SSD high utilization
threshold: Value
changed to <field1>.
There are <field2> KB
remaining.

Field 1:
ssd_high_utilizatio
n_thld_crossing

healthy
exceeded

Field 2:
free_ud_ssd_space

Integer

Threshold crossing of
SSD very high
utilization: Value
changed to <field1>.
There are <field2> KB
remaining.

Field 1:
ssd_very_high_utili
zation_thld_crossin
g

healthy
exceeded

Field 2:
ud_free_ssd_space
_in_kb)

Integer

SYS_SSD_VERY_HI_UTILIZATION_THL
D_CROSSING

02038

State_Ch
ange

user_thre
shold

user_thre
shold

SYSTEM_ENCRYPT_SWITCH

02023

Cluster state was


changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
sys_health_state

none
during_switch
switch_incomplete
switch_failed

State_Ch
ange

CONSISTENCY_GROUP_CERTAINTY

08008

Consistency Group's
state was changed
from <field1> to
<field2>.

Field 1: old_value
Field 2:
certainty_state

ok
add_pending
modify_pending
remove_pending

Software

Events Details

553

Alerts and Events Details

Event Name

Event
Code

DIMM_HEALTH

Event
Category

Description

Field

Field Value

04033

Storage Controller
memory card (DIMM)
health state was
changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
dimm_health_state

DPG_PROACTIVE_METADATA_LOADIN
G

08010

State of the DPG


proactive metadata
loading in progress
changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
proactive_metadata
_loading

false
initial_state
final_state

Software

IB_SWITCH_WRONG_SC_CONNECTIO
N

14005

Incorrect connection
between Storage
Controller(s) and
InfiniBand Switch
found: <field1>.

Field 1:
wrong_sc_connecti
on_detected)

none
yes

Hardware

IG_CERTAINTY_STATE

23001

IG's state was


changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
certainty_state

ok
add_pending
modify_pending
remove_pending

Software

INITIATOR_CERTAINTY_STATE

24001

Initiator's state was


changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
certainty_state

ok
add_pending
modify_pending
remove_pending

Software

INITIATOR_CHAP_AUTHENTICATION

02025

State of the
Authentication CHAP,
some initiators
missing credentials
state was changed
from <field1> to
<field2>.

Field 1: old_value
Field 2:
authentication_cha
p_initiators_missin
g_credentials

false
true

State_Ch
ange

INITIATOR_CHAP_CLUSTER_AUTHENTI
CATION

02024

State of the discovery


CHAP some initiators
missing cluster
credentials was
changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
authentication_cha
p_initiators_missin
g_cluster_credentia
ls

false
true

State_Ch
ange

INITIATOR_CHAP_DISCOVERY

19011

State of the discovery


CHAP some initiators
missing credentials
was changed from
<field1> to <field2>.

Field 1: old_value
false
Field 2:
true
discovery_chap_init
iators_missing_cred
entials

Software

MODE_ISCSI_DAEMON_STATE

06008

Storage Controller
iSCSI daemon state
changed from <field1>
to <field2>.

Field 1: old_value
healthy
Field 2:
failed
iscsi_daemon_state

Software

NODE_DED_IPMI_LINK_STATE

04046

Dedicated ETH
management for IPMI
link state was
changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
dedicated_ipmi_lin
k_conn_state

Software

554

EMC XtremIO Storage Array User Guide

level_1_clear
level_2_unknown
level_3_warning
level_4_minor
level_5_major
level_6_critical

ok
invalid_wiring
disconnected

Hardware

Alerts and Events Details

Event Name

Event
Code

NODE_DED_IPMI_PORT_STATE

Event
Category

Description

Field

04049

Storage Controller
dedicated IPMI
management port
state was changed
from <field1> to
<field2>.

Field 1: old_value
up
Field 2:
down
dedicated_ipmi_por unknown
t_state

State_Ch
ange

NODE_DISCOVERY_BBU

04057

Cluster has found


new BBU. Replace
procedure is
required.

Field 1:
ups_discovery_nee
ded

false
true

Hardware

NODE_DISCOVERY_DAE

04050

Cluster has
discovered new DAE
hardware. Replace
procedure is
required.

Field 1: jbod_dn

false
true

Hardware

NODE_DISCOVERY_DAE_CTRL

04056

Cluster has found


new DAE Controller.
Replace procedure is
required.

Field 1:
jbod_lcc_discovery
_needed

false
true

Hardware

NODE_DISCOVERY_DAE_PSU

04051

Cluster has found


new DAE PSU.
Replace procedure is
required

Field 1:
jbod_psu_dn

false
true

Hardware

NODE_DISCOVERY_IBSW

04052

Cluster has found


new InB Switch.
Replace procedure is
required.

Field 1:
ib_switches_dn

false
true

Hardware

NODE_DISCOVERY_LOCALDISK

04053

Cluster has found


Local Disk. Replace
procedure is
required.

Field 1:
local_disk_dn

false
true

Hardware

NODE_DISCOVERY_SCPSU

04054

Cluster has found


Storage Controller
PSU. Replace
procedure is
required.

Field 1:
node_psu_dn

false
true

Hardware

Storage Controller
Disk space is <field 1>
Kbytes. The disk
space utilization
state is <field 2>.

Field 1:
free_disk_space

Integer

Software

Field 2:
disk_space_utilizati
on_level

healthy
limited_free_space
no_free_space

NODE_DISK_SPACE_UTILIZATION_LEV 04061
EL

Field Value

NODE_FP_TEMPERATURE_STATE

04045

Storage Controller
front panel
temperature sensor
was changed from
<field1> to <field2>.

Field 1: old_value
Field 2:
node_fp_temperatu
re_state

normal
warning
high
invalid

Hardware

NODE_HIGH_FILE_DESCRIPTORS

04029

Storage Controller
has high number of
file descriptors.

Field 1:
node_high_file_des
criptors

ok
Software
high_file_descriptors

Events Details

555

Alerts and Events Details

Event Name

Event
Code

NODE_JOURNAL_STATE

04047

NODE_MGM_PORT_DUPLEX_LEVEL

Event
Category

Description

Field

Field Value

Storage Controller
journal state was
changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
journal_state

Storage Controller
management port
duplex setting was
changed to <field 1>.

Field 1:
mgmt_port_duplex

full
half

Hardware

healthy
failed
failover
failback

Software

NODE_PWR_BUTTONS

04059

Power button
pressed state
changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
sc_power_buttons

not_pressed
short_press_2_sc
short_press_1_sc
long_press_1_sc

State_Ch
ange

NODE_SAS1_MISCONFIG

04041

Storage Controller
SAS port 1
(connected to DAE)
connectivity issue
was <field1> and is
now <field2>.

Field 1: old_value
Field 2:
sas1_port_misconfi
guration

none
wrong_lcc
wrong_lcc_port
unknown_dae

Hardware

NODE_SAS2_MISCONFIG

04055

Storage Controller
SAS port 2
(connected to DAE)
connectivity issue
was <field1> and is
now <field2>.

Field 1: old_value
Field 2:
sas2_port_misconfi
guration

none
wrong_lcc
wrong_lcc_port
unknown_dae

Hardware

NODE_TECH_TUNNEL

04070

State of Technician
Tunnel to XMS was
changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
tunnel_state

closed
opened

SCHEDULER_LAST_ACTIVATION_STAT
E

25002

Last activation state


of scheduler was
changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
last_activation_stat
us

SCHEDULER_STATE

25001

Scheduler state was


changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
scheduler_state

enabled
user_disabled

State_Ch
ange

SNAPSHOT_GROUP_CERTAINTY_STAT
E

19001

Volume Snapshot
Group's state was
changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
certainty_state

ok
add_pending
modify_pending
remove_pending

Software

SSD_CERTAINTY_STATE

09011

SSD state was


changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
certainty_state

ok
add_pending
modify_pending
remove_pending

Software

556

EMC XtremIO Storage Array User Guide

Software

successful
State_Ch
ange
never_run
failed
snapped_object_not_
found
max_volumes_in_vsg
_reached
max_volumes_in_clus
ter_reached

Alerts and Events Details

Event Name

Event
Code

SYS_SSD_HI_UTILIZATION_THLD_CRO 02037
SSING

SYS_SSD_VERY_HI_UTILIZATION_THL
D_CROSSING

02037

Description

Field

Field Value

Threshold crossing of
SSD high utilization
threshold: Value
changed to <field 1>.
There are <field 2>KB
remaining.

Field 1:
ssd_high_utilizatio
n_thld_crossing

Integer

Field 2:
ud_free_ssd_space
_in_kb

healthy
exceeded

Threshold crossing of
SSD very high
utilization threshold:
Value changed to
<field 1>. There are
<field 2>KB
remaining.

Field 1:
ssd_very_high_utili
zation_thld_crossin
g

Integer

Field 2:
ud_free_ssd_space
_in_kb

healthy
exceeded

Event
Category
user_thre
shold

user_thre
shold

SYSTEM_ENCRYPT_SWITCH

02023

Data at Rest
Encryption mode is
being changed from
<field1> to <field2>.

Field 1: old_value
Field 2:
mode_switch_statu
s

none
during_switch
switch_incomplete
switch_failed

State_Ch
ange

SYSTEM_HW_PKG_CONSISTENCY

02031

State of hardware
package ids was
changed from <field1>
to <field2>.

Field 1: old_value
inconsistent
Field 2:
consistent
hardware_package_
consistency

State_Ch
ange

SYSTEM_NOTIFIER

04062

Event notifiers
changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
under_maintenance

false
true

State_Ch
ange

SYSTEM_OS_UPGRADE

04058

Storage Controller's
OS upgrade is in
progress.

Field 1:
os_upgrade_in_pro
gress

false
true

State_Ch
ange

SYSTEM_SHAREDMEMORY_EFFICIEN
CY_LEVEL

02020

Shared memory
efficiency level
changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
shared_memory_eff
iciency_level

healthy
State_Ch
medium_inefficiency ange
high_inefficiency

SYSTEM_UD_SSD_SPACE_LEVEL

02003

Free physical
capacity is low. The
cluster has only <field
1> percent free
storage capacity.

Field 1:
free_ud_ssd_space
_level

Integer

Software

TARGET_CERTAINTY_STATE

11005

Target's state was


changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
certainty_state

ok
add_pending
modify_pending
remove_pending

Software

VOLUME_CERTAINTY_STATE

08008

Volume's state was


changed from <field1>
to <field2>.

Field 1: old_value
Field 2:
certainty_state

ok
add_pending
modify_pending
remove_pending

Software

Events Details

557

Alerts and Events Details

Description

Field

Field Value

Event
Category

XMS Disk space for


partition
/var/common is
<field 1> Kbytes. The
disk space utilization
state is <field 2>.

Field 1:
free_disk_space_se
condary

Integer

Software

XMS_DISK_SPACE_UTILIZATION_LEVE 20000
L

XMS Disk space is


<field 1> Kbytes. The
disk space utilization
state is <field 2>.

Field 1: free_space)

Integer

Field 2:
disk_space_utilizati
on_level

healthy
limited_free_space
very_limited_free_spa
ce
no_free_space

XMS_MEMORY_UTILIZATION_LEVEL

XMS memory is <field


1> Kbytes. The
memory utilization
state is <field 2>.

Field 1:
free_memory

Integer

Field 2:
memory_utilization
_level

healthy
limited_free_memory
no_free_memory

XMS certificate
contains wrong
Common Name (CN).

Field 1:
wrong_cn_in_csr

false
true

Event Name

Event
Code

XMS_DISK_SPACE_SECONDARY_UTILI 20002
ZATION_LEVEL

XMS_WRONG_CN

558

20000

20001

EMC XtremIO Storage Array User Guide

Field 2:
healthy
disk_space_second limited_free_space
ary_utilization_level very_limited_free_spa
ce
no_free_space
Software

Software

Software

APPENDIX B
Replacing the Default SSL Certificate
This section provides instructions for replacing the default SSL certificate for the XMS with
a certificate issued by a trusted third party (Certificate Authority).
This section includes the following topics:

Overview...............................................................................................................
Creating a CSR ......................................................................................................
Submitting the CSR ...............................................................................................
Converting the Certificate Format...........................................................................
Installing the Certificate ........................................................................................
Installing a Third Party Certificate that was Created without CSR ............................

Replacing the Default SSL Certificate

560
561
562
562
563
564

559

Replacing the Default SSL Certificate

Overview
It is recommended to generate a Certificate Signing Request (CSR) on the XMS and have it
signed by a trusted issuer/Certificate Authority to produce a valid certificate.
To replace the default SSL certificate, perform the following procedures:
1. Creating a CSR
2. Submitting the CSR (to sign the certificate request)
3. Converting the Certificate Format (to convert the PEM format to a single-line
according to the machine type - Linux or Windows)
4. Installing the Certificate

560

EMC XtremIO Storage Array User Guide

Replacing the Default SSL Certificate

Creating a CSR
To create a CSR:
1. Log in to the CLI as admin.
2. Run the following command to create a CSR. Provide your clusters hostname as the
Common Name:
create-server-certificate-signing-request
cert-common-name="cluster-hostname"
3. Provide additional optional information for the certificate:
Input Parameter

Description

Value

Mandatory

cert-common-name

Fully qualified
domain name

Domain name, e.g.


xms.example.com

No

cert-country

Certificate country
name

Two letter ISO_3166-1


country code, e.g. US

No

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
name

String

No

cert-state

State or province

String

No

server-key-size

Server key size

Integer between 2048 and


4096

No

server-key-string

Server private key

String

No

Note: If you provide the cert-ip parameter, it will be added to the SubjectAltName as
"DNS.1 <cert-ip>" and "IP: <cert-ip>".
Note: If you want to modify the SubjectAltName when signing the certificate in the
Certificate Authority (CA), do not provide the cert-ip parameter when you create the
CSR.

Creating a CSR

561

Replacing the Default SSL Certificate

Submitting the CSR


To submit the certificate request:
1. Copy the output beginning: -----BEGIN CERTIFICATE REQUEST----- and ending: -----END
CERTIFICATE REQUEST----- to a text file and submit it to your Certificate Authority for
signing.
2. Verify that the signed certificate is in one of the following formats:
Open SSL PEM
Base-64 encoded X.509
Note: The resulting signed certificate (usually with a .crt or .cer extension) should
start with:-----BEGIN CERTIFICATE-----

Converting the Certificate Format


Note: In the following procedures, if the issuer uses an intermediate/chain certificate,
repeat procedures 1-3 for the intermediate/chain certificate as well.
To convert the certificate format on a Linux machine:
1. Log in to your Linux/Unix host or a Windows host with Perl installed.
2. Copy the PEM encoded certificate to a temporary file and save it.
3. If the certificate file was created on a Windows machine, run the
dos2unix <certificate name> command.
4. Run the following command:
perl -pe s/\n/\\n/g cert.text >cert_modified.txt
5. Copy the file content from your host (if it is Linux/Unix).
6. Verify that:
Word wrapping is turned off (to enable a one line output). If there are lines ending
with \n, delete them.
The line begins with five hyphens.

562

EMC XtremIO Storage Array User Guide

Replacing the Default SSL Certificate

To convert the certificate format on a Linux machine:


1. Open the certificate file in Notepad++ (or a similar tool).
2. Run a replace command (Ctrl+H) to replace \r\n with \\n. Verify that the extended
search mode is selected.

Figure 242 Replace Dialog Box

Installing the Certificate


Run the following command to install the certificate:
modify-server-certificate
server-certificate-string="<one-line modified certificate
string>" chain-certificate-string="<optional intermediate
root certificate>"
Note: The chain-certificate-string argument must be included. if no
intermediate certificate is required, leave it as an empty string.
Note: The IP address of the XMS (which should be static) can be added to the Subject
Alternative Name field in the certificate itself, in addition to the DNS Name. In this case,
the browsers will not display warnings when the XMS is accessed by IP instead of the
hostname.

Installing the Certificate

563

Replacing the Default SSL Certificate

Installing a Third Party Certificate that was Created without CSR


It is possible to create a certificate at the Certificate Authority (CA) without issuing a CSR
from the XMS. In this case, the private key does not exist in the XMS and has to be
imported as well.
To install a third party certificate without CSR:
Note: Steps 1 to 3 are out of scope of this guide and depend on the CA in use.
1. Generate the certificate at the CA, using the XMSs full DNS name. You can add the
XMS IP address to the Subject Alternative Name field in the certificate itself, in
addition to the DNS Name.
2. Specify that the Private Key is not password protected.
3. Export the Certificate and Private Key:
Open SSL PEM
Base-64 encoded X.509
Note: The resulting signed certificate (usually with a .crt or .cer extension)
should start with:-----BEGIN CERTIFICATE----4. Convert the certificate and private key. See Converting the Certificate Format on
page 562.
5. Run the following command to install the certificate:
modify-server-certificate
server-certificate-string="<one-line modified certificate
string>" chain-certificate-string="<optional intermediate
root certificate>" server-key-string=< one-line modified
key string>

564

EMC XtremIO Storage Array User Guide

APPENDIX C
XtremIO WebUI (Web User Interface)
This section describes the XtremIO WebUI and provides instructions for accessing and
using it.
This section includes the following topics:

Overview............................................................................................................... 566
Enabling the WebUI............................................................................................... 566
Accessing the WebUI............................................................................................. 566

XtremIO WebUI (Web User Interface)

565

XtremIO WebUI (Web User Interface)

Overview
In addition to the Java-based Storage Management application, XtremIO provides a Web
User Interface that in future versions will replace the GUI.
The WebUI is currently provided as a tech preview release and is available as a read-only
version. You can access the WebUI and use it for monitoring clusters and generating
reports.

Enabling the WebUI


The WebUI is disabled by default. To enable it, run the following CLI command:
modify-webui enable
For details, see modify-webui on page 431.

Accessing the WebUI


To access the WebUI:
1. In your browser, enter the IP address or the host name of the XMS, received from your
system administrator, followed by "/webui", to display the XtremIO WebUI Login
screen.
Note: If you are already logged in, this step will result in launching the WebUI
application. Skip the rest of the procedure.

Figure 243 XtremIO WebUI Login Screen

2. Enter your username and password as provided to you by your system/storage


administrator.

566

EMC XtremIO Storage Array User Guide

XtremIO WebUI (Web User Interface)

3. Click Login; the system launches the XtremIO WebUI Application and displays the
WebUI Overview screen, as shown in Figure 244.

Figure 244 WebUI Overview Screen

The WebUI Overview screen displays performance data and statistics of a selected object.
To select an object:
1. Click the search window, located in the WebUI menu bar to view the list of objects.

Figure 245 Search Window - Object List

Accessing the WebUI

567

XtremIO WebUI (Web User Interface)

2. Click an object type to view the list of all objects defined in the cluster.

Figure 246 Object List with Clusters Selected

3. Click the object whose data you want to view.


You can select more than one object.
Click the

icon to select all defined objects.

Click a selected object to unselect it


4. Click apply to view the selected objects performance data in the WebUI Overview
window.

568

EMC XtremIO Storage Array User Guide

You might also like