Docu62760 XtremIO 4.0.2 and 4.0.4 Storage Array User Guide
Docu62760 XtremIO 4.0.2 and 4.0.4 Storage Array User Guide
Docu62760 XtremIO 4.0.2 and 4.0.4 Storage Array User Guide
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).
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
32
33
34
39
44
46
48
49
51
52
56
59
62
64
66
68
76
94
Contents
Chapter 3
Chapter 4
Chapter 5
130
130
130
134
135
136
120
121
122
126
126
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
Chapter 6
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
280
280
280
284
285
285
289
Contents
Chapter 8
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
334
334
334
336
337
337
337
338
338
339
Contents
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 .........................................................
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
Appendix A
456
463
466
468
470
474
475
475
481
502
Appendix B
Appendix C
560
561
562
562
563
564
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:
Preface
Preface
10
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:
11
Note: For details on configuring hosts connected to the XtremIO storage, refer to the
XtremIO Host Configuration Guide.
12
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:
14
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
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
System Description
One X-Brick
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
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.
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
System Description
Equal data distribution, resulting in evenly balanced flash wear across the system
System Features
19
System Description
20
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
System Description
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
24
System Description
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
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
System Description
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.
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.
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
System Description
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
1. ICMP between the XMS and the Storage Controller is used for diagnostic purposes only.
29
System Description
30
CHAPTER 2
Using the Graphical User Interface (GUI)
This chapter includes the following topics:
31
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
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).
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).
33
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
35
7. In the Certificate Store screen, select the Place all certificates in the following store
option, and click Browse.
8. In the Select Certificate Store dialog box, select the Trusted Root Certification
Authorities folder and click OK.
36
9.
37
14. Wait for the application to load; the Login screen appears, as shown in Figure 13.
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
2. Click the Windows bundle link at the bottom of the splash screen.
39
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.
40
2. Click the Mac bundle link at the bottom of the splash screen.
41
4. Double-click the dmg file to open the XtremIO Management Application folder.
42
5. Double-click the icon in the XtremIO Management Application folder to launch the
XtremIO management application.
43
Dashboard Workspace
The Dashboard workspace, as shown in Figure 22, appears upon:
Storage
Performance
Alerts
44
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
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).
Via the Storage pane you can monitor the following parameters:
Overall Efficiency
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)
If a hardware component suffers from an alert, its color changes according to the alerts
severity:
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
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
Item Selector
Current
Total
Gauge
Time Period
Selector
History
Graph
48
Element
Description
Bandwidth Tab
IOPS Tab
Latency Tab
Displays the cluster performance with Latency as the unit of measure (s).
Displays the 7 most active Block Sizes, Initiator Groups or Volumes (as
selected in the Item Selector).
Read Color
Indicator
Write Color
Indicator
Current Total
Gauge
Indicates the aggregated transfer rate for all Volumes by MB/s or IOPS.
Description
History Graph
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.
The Alerts pane displays the current cluster alerts, which are color coded according to
severity:
Severity
Code
Entity
Entity Details
Description
Dashboard Workspace
49
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
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
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
Menu Bar
Object Details
Pane
Storage
Objects Tab
Related Objects
Pane
Summary Bar
Figure 28 Configuration Workspace
Configuration Workspace
51
Volumes View
To open the Volumes view, click Volumes in the entity list.
Figure 29 shows the Volumes view.
52
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
Consistency Groups
Snapshot Sets
Schedulers
Alerts
Configuration Workspace
53
54
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
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
The bottom pane provides separate tabs with details on the following
Consistency-Group-related elements:
Volumes
Snapshot Sets
Schedulers
Alerts
Configuration Workspace
57
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
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
Consistency Groups
Schedulers
Alerts
Configuration Workspace
59
60
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
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
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
Initiators View
To open the Initiators view, click Initiators in the entity list.
Figure 37 shows the Initiators view.
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
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
Schedulers View
To open the Schedulers view, click Schedulers in the entity list.
Figure Figure 39 shows the Schedulers view.
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.
66
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
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
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
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:
Figure 42 Hovering the Mouse Cursor over the Hardware Component to View its Status
Inventory Workspace
69
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
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
Identification LED
Identification LED
Possible States
Status LED
Storage Controller
Yes
Yes
Yes
Yes
Yes
Yes
No
N/A
Yes
DAE
Yes
Yes
DAE SSD
Yes
DAE Controller
Yes
Yes
No
N/A
Yes
No
N/A
Yes
InfiniBand Switch
No
N/A
Yes
No
N/A
Yes
No
N/A
Yes
Physical XMS
No
N/A
Yes
No
N/A
Yes
Inventory Workspace
71
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.
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
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.
Inventory Workspace
73
74
When the front or the back view are displayed, clicking Customize View enables you to
show the displayed hardware components fault LEDs.
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
Inventory Workspace
75
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.
Clusters View
To open the Clusters view, click Clusters in the Inventory List pane.
Figure 51 shows the Clusters view.
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).
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.
Inventory Workspace
77
Cluster Name
Cluster PSNT
Cluster State
Number of Volumes
Cluster Tags
Clicking the Show More Info icon (see Table 23) displays the following additional
information for each Cluster:
78
Encryption Supported
Encryption Mode
ODX Mode
Start Time
Deduplication
Activation Time
Compression
Upgrade State
OS Upgrade
Expansion
Overall Efficiency
Figure 52 shows the drop-down menu, which appears upon right-clicking an item in the
Clusters table.
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.
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
X-Bricks
Storage Controllers
InfiniBand Switches
SSDs
XEnvs
Alerts
X-Bricks View
To display the X-Bricks window, click X-Bricks in the Inventory List pane.
X-Brick name
X-Brick Tags
Figure 54 shows the drop-down menu, which appears upon right-clicking an item in the
X-Bricks table.
80
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.
Storage Controllers
DAE Controllers
Slots
SSDs
Alerts
Inventory Workspace
81
Management Address
Lifecycle State
Health State
Enabled State
Connection State
Stop Reason
Serial Number
Tags
Clicking the Show More Info icon (see Table 23) displays the following additional
information for each Storage Controller:
82
IB Address 1
SW Version
IB Address 2
SW Build
Upgrade State
OS Version
Date-Time + TZ
FW Version Error
Gateway Address
HW Model
Part Number
Figure 56 shows the drop-down menu, which appears upon right-clicking an item in the
Storage Controllers table.
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.
Local Disks
Targets
XEnvs
Alerts
Inventory Workspace
83
DGP Name
User Space
Tags
Clicking the Show More Info icon (see Table 23) displays the following additional
information for each Storage Controller:
84
Available Rebuilds
Figure 58 shows the drop-down menu, which appears upon right-clicking an item in the
Data Protection Group table.
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.
SSDs
Alerts
Inventory Workspace
85
DAEs View
To display the DAEs window, click DAEs in the Inventory List pane.
DAE Name
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
Figure 60 shows the drop-down menu, which appears upon right-clicking an item in the
DAEs table.
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.
DAE Controllers
Alerts
Inventory Workspace
87
SSDs View
To display the SSDs window, click SSDs in the Inventory List pane.
SSD Index
DPG State
Slot
Lifecycle State
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
Figure 62 shows the drop-down menu, which appears upon right-clicking an item in the
SSDs table.
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.
Inventory Workspace
89
Targets View
To display the Targets window, click Targets in the Inventory List pane.
Target Name
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
MTU
Error Reason
Figure 64 shows the drop-down menu, which appears upon right-clicking an item in the
Targets table.
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.
Portals
Alerts
Inventory Workspace
91
BBU Name
Input
Lifecycle State
Connection State
Power Feed
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
Figure 66 shows the drop-down menu, which appears upon right-clicking an item in the
BBUs table.
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.
Inventory Workspace
93
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:
VAAI TP Limit
Encryption
94
Inventory Workspace
95
96
Encryption Tab
Figure 72 shows the Encryption tab of the Configure Cluster window.
Inventory Workspace
97
98
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
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.
99
The Alerts pane displays the managed cluster alerts, which are color coded according to
severity:
Severity
Code
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
100
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.
101
Events Tab
Figure 76 shows the Events tab in the Alerts & Events Workspace.
Alerts Tab
Events Tab
Filters
Events Display
Display Info
Filters - Includes the filters you can use to determine which events are displayed.
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
Table 35 describes the parameters that are provided for each event.
Table 35 Event Parameters
Event Parameter
Description
Severity
Event Code
Category
Entity
Entity Details
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.
103
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
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
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
Administration Workspace
Figure 78 shows the Administration workspace.
To access the Administration workspace, click the Administration icon in the menu bar.
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:
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
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.
The Users Administration screen displays the defined users list. For each user, the
following details are listed:
User Name
Role
Is External
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
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.
108
The LDAP Configuration screen displays the LDAP server configuration data, including the
following details:
Bind DN
Search base
Search filter
Server URL
User to DN rule
Roles
Add, update and remove XMS role to Active Directory group mapping rules.
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
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.
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
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.
The SNMP Configuration screen enables you to send SNMP notification and configure the
following SNMP notification configuration data:
SNMP Version
Community
Trap Port
SNMP V3 Properties
Administration Workspace
111
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.
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
XMS Tab
Login Banner
Figure 85 shows the XMS Configuration screen.
To access the XMS Configuration screen, select the XMS tab.
The Login Banner screen enables you to configure the login banner text.
Administration Workspace
113
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
Paste the copied text into the command line by right-clicking the screen.
Support Window
Figure 87 shows the Support window.
To access the Support window, click the Support icon in the menu bar.
Online training
Community
Downloads
Live chat
Service center
Support Window
115
About Window
Figure Figure 88 shows the About window.
To access the About window, click the About icon in the menu bar.
Product name
Copyright statement
Build ID
116
Installation details (Clicking the Installation Details icon displays the Installation
Details window, as shown in Figure 89.)
About Window
117
118
CHAPTER 3
Managing Multiple Clusters
This chapter includes the following topics:
119
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 (graphical view) - can be viewed only in the scope of a single cluster
Support
The following menu bar options display XMS level information and are therefore not
affected by cluster scope:
120
Reports
Administration
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.
121
122
123
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.
124
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
Physical capacity
125
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:
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).
Description
add-cluster
remove-cluster
set-context
127
128
CHAPTER 4
Managing the Hardware
This chapter includes the following topics:
129
Valid characters:
Alphanumeric characters
Space character
The following characters: ~ ! @ # $ % ^ * _ + { } | : ? . -
130
Clusters
X-Bricks
Storage Controllers
DAEs
SSDs
Targets
131
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
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.
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.
133
134
Command
Description
show-tags
show-tag
create-tag
tag-object
untag-object
modify-tag
remove-tag
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)
Identification LED
Status LED
GUI
Physical
GUI
Physical
Storage Controller
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
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
No
No
No
Yes
No
No
No
Yes
No
No
No
No
Physical XMS
N/A
Yes
N/A
No
Virtual XMS
N/A
No
N/A
No
135
136
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.
137
138
CHAPTER 5
Monitoring the Cluster
This chapter includes the following topics:
140
142
144
158
169
170
139
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
140
Thin Provisioning Savings - used disk space compared to allocated disk space
Hovering the mouse pointer over the Volume Capacity bar displays a tool-tip with detailed
information.
Hovering the mouse pointer over the Physical capacity bar displays a tool-tip with detailed
information.
141
142
Description
show-most-active
show-most-active-initiator-groups
show-most-active-volumes
143
144
You can also monitor the cluster via the status bar of the GUI window.
Number of Clusters
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.
Description
show-clusters
show-clusters-info
show-clusters-upgrade
show-clusters-upgrade-progress
show-clusters-performance
show-clusters-performance-small
show-clusters-performance-unaligned
show-clusters-performance-latency
modify-clusters-parameters
show-clusters-savings
modify-cluster-thresholds
show-clusters-data-protection-propert
ies
145
146
Command
Description
show-bricks
show-clusters
show-storage-controllers
show-ssds
show-bbus
Description
show-storage-controllers
show-storage-controllers-info
show-storage-controllers-fw-versions
show-storage-controllers-psus
show-storage-controllers-sensors
test-xms-storage-controller-connectiv
ity
147
148
Command
Description
show-ssds
show-ssds-performance
show-slots
Description
show-infiniband-switches
show-infiniband-switches-p
orts
show-infiniband-switches-p
sus
Protection state
Process in progress
149
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
Description
show-data-protection-groups
151
152
Command
Description
show-local-disks
Description
show-bbus
153
154
Command
Description
show-daes
show-daes-psus
show-daes-controllers
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.
155
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
Description
show-targets
show-target-groups
show-targets-fc-error-counters
show-target-groups-fc-error-counters
show-targets-performance
show-targets-performance-small
show-targets-performance-unaligned
show-target-groups-performance
show-target-groups-performance-small
show-target-groups-performance-unaligned
157
Volume size - the quantity of disk space reserved for the Volume
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.
158
159
160
Command
Description
show-volume
show-volumes
show-volume-snapshot-groups
show-volumes-performance
show-volumes-performance-small
show-volumes-performance-unaligned
161
162
Command
Description
show-consistency-group
show-consistency-groups
163
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
164
Command
Description
show-initiators
show-initiators-performance
show-initiators-performance-small
show-initiators-performance-unaligned
show-initiators-connectivity
show-discovered-initiators-connectivity
165
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
166
Command
Description
show-initiator-group
show-initiator-groups
show-initiator-groups-performance
show-initiator-groups-performance-small
show-initiator-groups-performance-unaligned
167
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
168
Command
Description
show-snapshot-set
show-snapshot-sets
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.
Description
show-alerts
show-alert-definitions
169
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
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.
Double-click the reports you want to view and toggle between them by clicking the
reports tabs.
Right-click the report view and select Print from the drop-down list.
171
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
Display type - select the display type of your report. Available display types are:
Table
Bar Chart
Pie Chart
Line Chart
173
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.
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
9. Click Next.
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.
175
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
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.
177
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
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
Exporting a Report
To export a report:
1. Right-click the report from the Reports list and select Export Report Data from the
menu.
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.
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.
Description
show-report
show-reports
show-reports-data
179
180
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......................................................................................
182
183
190
222
236
249
260
263
272
181
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
Valid characters:
Alphanumeric characters
Space character
The following characters: ~ ! @ # $ % ^ * _ + { } | : ? . -
183
Volumes
Consistency Groups
Snapshot Sets
Initiator Groups
Initiators
Schedulers
184
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.
185
Creating Schedulers
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
3. If you want to create a new Tag for the object, perform steps 4 - 8. Otherwise, skip
these steps.
4. Click Create Tag.
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.
187
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.
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
Description
show-tags
show-tag
create-tag
tag-object
untag-object
modify-tag
remove-tag
189
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
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.
Note: Volumes and Snapshots access rights can be modified only via CLI (see
modify-volume on page 443).
190
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.
Snapshot of a Volume/Snapshot.
191
192
193
194
Volume Summary
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.
195
196
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.
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.
197
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.
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
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 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)
199
Viewing Volumes
Note: This procedure is used for Volumes and Snapshots.
To view Volumes and Snapshots:
1.
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
200
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
201
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.
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.
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
203
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
5. In the Create Consistency Group dialog box, type a unique name for the Consistency
Group.
205
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.
206
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
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.
207
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.
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.
208
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:
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).
209
The Volume table displays the Snapshots taken for the specified Volume or Snapshot.
210
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
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).
211
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:
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
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.
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
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.
213
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
Mapping
Consistency Groups
Snapshot Sets
Schedulers
Alerts
215
216
217
218
219
220
Description
add-volume
remove-volume
Removes a Volume.
modify-volume
show-volume
show-volumes
create-snapshot
create-snapshot-and-reassign
create-scheduler
show-snapshots
map-lun
221
222
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.
223
224
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
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.
225
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
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
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.
227
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.
228
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
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 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.
229
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
4. Confirm the deletion by clicking Yes; the Consistency Group is deleted from the
Consistency Group window.
231
Volumes
Snapshot Sets
Schedulers
Alerts
232
Select a Consistency Group and click the Mapping of Member Volumes tab.
233
234
Description
add-volume-to-consistencygroup
create-consistency-group
create-snapshot-and-reassi
gn
remove-consistency-group
remove-volume-from-consis
tency-group
show-consistency-group
show-consistency-groups
create-scheduler
235
236
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.
237
238
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.
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.
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
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
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
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
Note: You can select only one Snapshot Set from the list.
241
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.
242
Mapped volumes
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.
Click Yes if you want to delete the Snapshot Set and the contained Snapshots that
can be deleted.
243
If the Snapshot Set and it contained Snapshots can be deleted, the following
warning is displayed.
Click Yes to confirm; the Snapshot Set and its contained Snapshots are deleted.
244
Volumes
Schedulers
Alerts
245
Select a Consistency Group and click the Mapping of Member Volumes tab.
246
247
248
Command
Description
create-snapshot
create-snapshot-and-reassi
gn
show-snapshot-sets
show-snapshot-set
remove-snapshot-set
create-scheduler
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.
249
4. In the Create Initiator Group dialog box, type a name for the group.
250
5. Click Add to add Initiators to the new Initiator Group; the Add Initiator Dialog box
appears.
251
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.
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
6. If you wish to modify the properties of an Initiator within the group, select the Initiator
by clicking it and click Modify.
Note: The displayed dialog box is different for Fibre Channel and iSCSI Initiators.
253
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
4. In the Rename dialog box, enter the name for the Initiator Group.
5. Click OK.
255
Mapping
Initiators
Targets
Alerts
256
257
258
Description
add-initiator
add-initiator-group
modify-initiator
remove-initiator
Deletes an Initiator.
remove-initiator-group
show-initiators
show-initiator-group
show-initiator-groups
show-targets
show-target-groups
show-discovered-initiatorsconnectivity
show-initiators-connectivity
map-lun
259
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.
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
3. Right-click the Initiator you want to edit and select Configure CHAP from the
drop-down menu.
Managing Initiators
261
262
Command
Description
add-initiator
modify-initiator
remove-initiator
Deletes an Initiator.
show-initiators
rename
show-chap
modify-chap
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).
Managing Mapping
263
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.
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
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
6. Click Next.
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
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
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
7. Click Next.
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.
Managing Mapping
267
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.
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
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.
Managing Mapping
269
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.
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
The mapping table also displays mapping of a Volume across multiple Initiator
Groups.
Managing Mapping
271
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
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.
273
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.
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
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.
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.
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.
275
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.
276
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.
277
278
Command
Description
create-scheduler
modify-scheduler
remove-scheduler
show-scheduler
show-schedulers
suspend-scheduler
resume-scheduler
CHAPTER 7
Managing Alerts and Events
This chapter includes the following topics:
Overview............................................................................................................... 280
Managing the Alerts .............................................................................................. 280
Managing the Events............................................................................................. 285
279
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
280
281
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
283
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:
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.
user_physical_capacity_high
user_physical_capacity_very_high
State - disabled
Severity - minor
Managing Alerts
Use the following CLI commands for managing alerts:
284
Command
Description
acknowledge-alert
modify-alert-definition
show-alert-definitions
285
Filtering Events
You can filter events, using the filters in the Events tab of the Alerts & Events workspace.
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.
286
287
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
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.
Description
add-event-handler-definition
remove-event-handler-definition
modify-event-handler-definition
show-event-handler-definitions
289
290
CHAPTER 8
Cluster Administration and Configuration
This chapter includes the following topics:
292
298
300
302
303
305
307
308
312
322
324
327
330
332
291
292
6. In the iSCSI Portal Table, click Add; the Add iSCSI Portal dialog box appears.
293
294
295
296
Description
add-iscsi-portal
add-iscsi-route
remove-iscsi-portal
remove-iscsi-route
show-iscsi-portals
show-iscsi-routes
297
298
7. In the Configure Cluster dialog box, click the 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).
299
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
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.
301
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
Description
modify-cluster-thresholds
modify-alert-definition
303
6. In the Configure Cluster dialog box, click the 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).
304
Command
Description
modify-clusters-parameters
show-clusters-parameters
305
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
Description
modify-chap
show-chap
307
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.
308
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.
309
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.
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
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.
Description
add-user-account
remove-user-account
modify-user-account
modify-password
show-user-accounts
311
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
313
314
Description
Mandatory
Bind DN
Yes
Bind Password
Yes
Search Base
No
Search Filter
User to DN Rule
No
315
Parameter
Description
Mandatory
Timeout
No
Cache Expire
Yes
Server URLs
Yes
Active Directory
Groups
Yes
CA Certificate
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
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.
317
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
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.
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.
319
320
Description
add-ldap-config
modify-ldap-config
remove-ldap-config
show-ldap-configs
The following examples display the output of the show-ldap-configs command for
different environments:
321
322
Description
show-xms
modify-xms-parameters
323
324
325
326
Command
Description
modify-email-notifier
show-email-notifier
327
328
Description
modify-snmp-notifier
show-snmp-notifier
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.
329
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
Description
show-syslog-notifier
modify-syslog-notifier
331
332
Command
Description
modify-login-banner
CHAPTER 9
Cluster Operations
This chapter includes the following topics:
Cluster Operations
334
334
337
338
340
348
352
354
361
362
366
333
Cluster Operations
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.
6. Click OK to confirm.
334
Cluster Operations
7. If you want to cancel the stopping procedure, click Cancel on the progress bar.
When the cluster is stopped, the cluster icon changes and an alert appears in the
Alerts tab.
335
Cluster Operations
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
Conn-State
connected
...
...
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
Cluster Operations
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)>
Conn-State
connected
connected
...
...
...
Note: If the cluster is not active and connected, contact EMC Global Tech Support.
337
Cluster Operations
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
Cluster Operations
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):
339
Cluster Operations
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
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
341
Cluster Operations
If the front panel of the Battery Backup Unit is as shown in Figure 225, the Battery
Backup Unit is 5P 1550i R.
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
Cluster Operations
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
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).
343
Cluster Operations
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
Cluster Operations
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
345
Cluster Operations
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.
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
Cluster Operations
347
Cluster Operations
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
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.).
349
Cluster Operations
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
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.
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.
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).
351
Cluster Operations
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
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.
353
Cluster Operations
Note: Before changing the IP configurations, verify that the IP addresses are correct and
reachable in the new location scheme.
...
...
...
354
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
...
...
...
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
...
...
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.
356
Cluster Operations
Note: Before changing the IP configurations, verify that the IP addresses are correct and
reachable in the new location scheme.
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.
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
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
...
...
...
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.
359
Cluster Operations
360
Cluster Operations
361
Cluster Operations
362
Cluster Operations
5. Select Actions > All vCenter Actions > Deploy OVF Template.
6. On the 1a Select Source pane, click Local file and then click Browse.
7. Select the XMS OVA template and click Next.
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.
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
364
Cluster Operations
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.
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.
365
Cluster Operations
366
CHAPTER 10
CLI Guide
This chapter includes the following topics:
CLI Guide
368
370
371
372
380
382
411
415
440
475
367
CLI Guide
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)
368
CLI Guide
369
CLI Guide
Valid characters:
Alphanumeric characters
Space character
The following characters: ~ ! @ # $ % ^ * _ + { } | : ? . -
370
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
ok
invalid_command
invalid_input
system_communication_err
or
system_general_error
system_is_busy
system_timeout
no_sys_response_retrying
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
Completion Codes
371
CLI Guide
372
Command
Description
Page
acknowledge-alert
478
activate-storage-controller
388
add-cluster
382
add-event-handler-definition
475
add-initiator
460
add-initiator-group
456
add-iscsi-portal
470
add-iscsi-route
470
add-ldap-config
417
add-ssd
387
add-user-account
415
add-volume
442
453
assign-ssd
387
clear-volume-reservation
450
control-led
391
create-consistency-group
454
create-debug-info
413
modify-ip-addresses
438
create-scheduler
463
create-server-certificate-signi
ng-request
420
create-snapshot
447
create-snapshot-and-reassig
n
448
create-tag
440
deactivate-storage-controller
389
exit
380
export-performance-history
481
CLI Guide
Command
Description
Page
help
380
421
map-lun
468
modify-alert-definition
478
modify-chap
473
modify-consistency-group-vol
umes
455
modify-clusters-parameters
422
modify-cluster-thresholds
422
modify-datetime
430
modify-dns-servers
419
modify-email-notifier
432
modify-eth-port
412
modify-event-handler-definiti
on
475
modify-initiator
461
modify-ip-addresses
438
modify-iscsi-portal
470
modify-ldap-config
418
modify-login-banner
430
modify-password
416
modify-scheduler
464
modify-server-certificate
421
modify-server-name
430
modify-snmp-notifier
434
modify-ssh-firewall
425
modify-syr-notifier
436
modify-syslog-notifier
437
modify-tag
440
modify-target
466
modify-target-group
468
373
CLI Guide
374
Command
Description
Page
modify-technician-port-tunne
l
386
modify-user-account
415
modify-volume
443
modify-webui
431
modify-xms-parameters
429
power-off
392
power-on
392
quit
380
refresh-xms-ssh-key
427
remove-cluster
382
remove-consistency-group
454
remove-debug-info
413
475
remove-initiator
Deletes an Initiator.
460
remove-initiator-group
457
modify-ip-addresses
438
remove-iscsi-portal
471
remove-iscsi-route
471
remove-ldap-config
417
remove-scheduler
464
remove-snapshot-set
451
remove-ssd
387
remove-tag
440
remove-user-account
415
remove-volume
443
454
rename
381
restart-xms
393
resume-scheduler
464
send-email-notification
432
CLI Guide
Command
Description
Page
send-snmp-notification
434
send-syr-notification
436
set-context
425
show-alert-definitions
479
show-alerts
480
show-bbus
390
show-bricks
391
show-chap
472
show-clusters
383
show-clusters-data-protectio
n-properties
422
show-clusters-info
423
show-clusters-parameters
424
show-clusters-performance
482
482
show-clusters-performance-s
mall
483
show-clusters-performance-u
naligned
484
show-clusters-savings
424
show-clusters-thresholds
425
show-clusters-upgrade
384
show-clusters-upgrade-progr
ess
385
show-consistency-group
455
show-consistency-groups
456
show-daes
394
show-daes-controllers
395
show-daes-psus
396
375
CLI Guide
376
Command
Description
Page
show-data-protection-groups
474
501
show-datetime
429
show-debug-info
414
411
show-dns-servers
420
show-email-notifier
433
show-event-details
476
show-event-handler-definitio
ns
476
show-events
477
show-infiniband-switches
397
398
show-infiniband-switches-ps
us
399
show-initiator-group
457
show-initiator-groups
458
show-initiator-groups-perfor
mance
485
show-initiator-groups-perfor
mance-small
486
show-initiator-groups-perfor
mance-unaligned
487
show-initiators
462
show-initiators-connectivity
411
show-initiators-performance
488
show-initiators-performancesmall
489
show-initiators-performanceunaligned
490
show-ip-addresses
439
show-iscsi-portals
471
show-iscsi-routes
472
CLI Guide
Command
Description
Page
show-ldap-configs
419
show-leds
401
show-local-disks
400
show-lun-mappings
469
show-most-active
451
show-most-active-initiator-gr
oups
459
show-most-active-volumes
450
show-remote-servers-status
420
show-report
507
show-reports
507
show-reports-data
508
show-scheduler
465
show-schedulers
466
show-server-certificate
421
421
show-server-name
430
show-slots
402
show-snapshot-set
452
show-snapshot-sets
453
show-snapshots
449
show-snmp-notifier
435
show-ssds
403
show-ssd-sas-counters
502
show-ssds-performance
491
show-storage-controllers
404
405
377
CLI Guide
378
Command
Description
Page
show-storage-controllers-infi
niband-counters
503
show-storage-controllers-infi
niband-ports
406
show-storage-controllers-info
407
show-storage-controllers-psu
s
408
show-storage-controllers-sasports
409
show-storage-controllers-sen
sors
410
show-sw-image-details
385
show-sw-images
385
show-syr-notifier
437
show-syslog-notifier
438
show-tag
440
show-tags
441
show-target-groups
468
show-target-groups-fc-error-c
ounters
504
show-target-groups-performa
nce
492
show-target-groups-performa
nce-small
493
show-target-groups-performa
nce-unaligned
494
show-targets
467
show-targets-fc-error-counter
s
505
show-targets iscsi-counters
506
show-targets-performance
495
show-targets-performance-s
mall
496
show-targets-performance-un
aligned
497
show-technician-port-tunnels
386
show-timezones
429
CLI Guide
Command
Description
Page
show-user-accounts
416
show-volume
445
show-volumes
444
show-volume-snapshot-grou
ps
446
show-volumes-performance
498
499
show-volumes-performanceunaligned
500
show-xenvs
426
show-xms
427
show-xms-info
428
shutdown-xms
392
start-cluster
393
stop-cluster
393
suspend-scheduler
465
tag-object
441
test-ip-connectivity
412
412
test-xms-tcp-connectivity
412
unmap-lun
469
untag-object
441
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
CLI Guide
rename
The rename command renames a component of the XtremIO Storage Array.
Input Parameter
Description
Value
Mandatory
new-caption
New caption
String
new-name
New name
String
sc-id
Storage Controller ID
Name or index
cluster-id
Cluster ID
Name or index
xms-id
XMS ID
Name or index
vol-id
Volume ID
Name or Index
dpg-id
Name or index
tar-id
Target ID
Name or index
tag-id
Tag ID
Name or Index
storage-controller-psu-id
Name or Index
snapshot-set-id
Snapshot Set ID
Name or Index
dae-lcc-id
DAE LCC ID
Name or Index
tg-id
Target Group ID
Name or Index
dae-id
DAE ID
Name or Index
mdl-id
Module ID
Name or index
ib-switch-id
InfiniBand Switch ID
Name or Index
ssd-id
SSD ID
Name or index
xenv-id
XEnv ID
Name or index
ig-id
Initiator Group ID
Name or index
brick-id
Brick ID
Name or index
usr-id
User ID
Name or index
initiator-id
Initiator ID
Name or index
dae-psu-id
DAE PSU ID
Name or Index
volume-snapshot-group-id
SG ID
Name or Index
local-disk-id
LocalDisk ID
Name or Index
ib-switch-psu-id
Name or Index
cg-id
Consistency Group ID
Name or Index
*)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
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
Index
State
Gates-Open
Conn-State
Connection status:
Disconnected - XMS is currently disconnected from the cluster.
Connected - XMS is currently connected to the cluster.
Num-of-Vols
Num-of-Internal-Volumes
Vol-Size
The total amount of disk space defined for all Volumes in the
cluster
UD-SSD-Space
Logical-Space-In-Use
UD-SSD-Space-in-Use
Total-Writes
Total-Reads
Stop-Reason
Size-and-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
Index
State
Upgrade-State
Start-Time
Activation-Time
Storage-Controller-Name
Index
Mgr-Addr
SW-Version
SW-Build
OS-Version
The OS version
FW-State
Upgrade-Failures
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
Index
Cluster-Name
Index
Step-Number
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
Package-is-Valid
Version
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
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
Cluster-Name
Index
Storage-Controller-Name
Index
Tech-Tunnel-State
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
Yes
close
Close tunnel
N/A
open
Open tunnel
N/A
cluster-id
Cluster ID
No
386
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
No
N/A
No
is-encrypted-unreadab
le-ssd
is-foreign-xtremapp-ss
d
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
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
Index
Cluster-Name
Index
Brick-Name
Index
Slot #
Smart-Err-Asc
Smart-Err-Acsq
Last-IO-Err-Type
Last-IO-Err-Time
IO-Err-Sense
IO-Err-Asc
IO-Err-Ascq
IO-Err-Vendor-Specific
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
No
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
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
Index
Model
Serial-Number
Power-Feed
State
Connectivity-State
Enabled-State
Input
Battery-Charge
BBU-Load
Voltage
FW-Version
Part-Number
Brick-Name
Index
Cluster-Name
Index
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
Index
Cluster-Name
Index
State
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
Yes
led-mode
Yes
object-id-list
Object ID list
Yes
cluster-id
Cluster ID
No
inverse-mode
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
N/A
No
sc-id
Storage Controllers ID
Name or index
No
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
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
Index
Model
Serial-Number
State
FW-Version
Part-Number
Brick-Name
Index
Cluster-Name
Index
HW-Revision
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
Index
Model
Serial-Number
State
Enabled-State
HW-Revision
index-in-DAE
Location
FW-Version
Part-Number
DAE-Name
DAE-Index
Brick-Name
Index
Cluster-Name
Index
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
Index
Serial-Number
Location-Index
Power-Feed
State
Input
Location
HW-Revision
Part-Number
DAE-Name
DAE-Index
Brick-Name
Index
Cluster-Name
Index
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
Index
Cluster-Name
Index
Index-in-Cluster
Serial-Number
Part-Number
State
FW-Version
Firmware version
FW-Version-Error
FAN-Drawer-State
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
Peer-Type
Port-In-Peer-Index
Link-Rate-In Gbps
Port-State
IBSwitch-Name
IBSwitch-Index
Cluster-Name
Index
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
Index
Cluster-Name
Index
Index-In-Cluster
Location
Input-Power
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
vertical
Vertical layout
N/A
No
Output Parameter
Description
Name
Index
Serial-Number
Location-Index
State
Enabled-State
Enabled or disabled
FW-Version
Firmware version
Part-Number
UID
Unique ID
Disk-Type
Disk-Expected-Type
The disk type the cluster expects to have for the drive (SSD or
HDD)
Disk-Purpose
Storage-Controller-Name
Index
Brick-Name
X-Bricks name
Index
Cluster-Name
Clusters name
Index
Encryption-Status
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
Index
Entity
Name
Index
Identify-Beacon
Status-Beacon
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
Cluster-Name
Index
Brick-Name
Index
Slot #
State
Error-Reason
UID
Product-Model
SSD-Size
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
Index
Cluster-Name
Index
Brick-Name
Index
Slot #
Product-Model
FW-Version
FW-State
Part-Number
SSD-Size
DPG-Name
Index
SSD-XDP-State
State
Endurance-Remaining-%
Certainty-State
Encryption-Status
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
Index
Mgr-Addr
IB-Addr-1
IB-Addr-2
Brick-Name
Index
Cluster-Name
Index
State
Health-State
Enabled-State
Stop-Reason
Conn-State
Journal-State
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
Storage-Controller-Name
Index
PCI-Disk-Controller
IPMI-BMC
IPMI firmware
FC-HBA
FC Targets firmware
PCI-10GE-HBA
PCI-IB-HBA
BIOS
SDR
ME
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
Port-Index
Peer-Type
Port-In-Peer-Index
Link-Rate-In-Gbps
Port-State
Storage-Controller-Name
Index
Brick-Name
X-Bricks name
Index
Cluster-Name
Clusters name
Index
Health-Level
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
Index
Mgr-Addr
Brick-Name
Index
Cluster-Name
Index
State
Conn-State
SW-Version
SW-Build
HW-Model
OS-Version
Serial-Number
Part-Number
Sym-Storage-Controller
SC-Start-Timestamp
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
Serial-Number
Location-Index
Power-Feed
State
Enabled-State
Input
Location
HW-Revision
Part-Number
Storage-Controller-Name
Index
Brick-Name
X-Bricks name
Index
Cluster-Name
Clusters name
Index
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
Index
Storage-Controller-Name
Index
SAS1-Port-State
SAS1-Port-Rate
SAS1-Port-Health-Level
SAS1-Port-Wrong-Conn
SAS2-Port-State
SAS2-Port-Rate
SAS2-Port-Health-Level
SAS2-Port-Wrong-Conn
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
N/A
No
frequency
Monitor intervals
Seconds
No
sc-id
Storage Controller ID
Name or Index
No
sensor-type
'temperature',
'power_unit', 'current',
'fan', 'voltage',
'processor',
'power_supply'
No
Output Parameter
Description
Storage-Controller-Name
Index
Sensor-Type
Sensor-Name
Health-State
Value
Upper-Threshold
Lower-Threshold
Units
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
target-details
N/A
Output Parameter
Description
Cluster Name
Index
Port-type
Port-address
Num-of-conn-targets
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
No
target-details
N/A
No
Output Parameter
Description
Cluster Name
Index
Name
Index
Port-Type
Port-Address
Num-Of-Conn-Targets
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
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
mgmt-port-duplex
full, half
mgmt-port-speed
100MB, 1GB
cluster-id
Cluster ID
Name or Index
No
412
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
No
datetime
No
debug-info-name
No
debug-level
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
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
Index
Cluster-Name
Index
Debug-Level
The debug level of the log collection: tiny, small, medium, large, huge
Creation-Start-Time
Create-Time
Output-Url
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
public-key
public key
inactivity-timeout
Inactivity timeout in
minutes
Integer
No
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
password
User password
String
public-key
String
role
User role
read_only,
admin,
configuration,
technician
usr-name
User name
String
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
Index
Role
External-Account
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
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
No
search-base
Search Base
OU=<value>,DC=<value>,DC=<value> No
search-filter
Search Filter
sAMAccountName={username}
No
timeout
Connection Timeout
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
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
No
user-to-dn-rule
User to DN
substitution
{username}@example.com
No
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
Bind-DN
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
LDAP-Servers
User-to-DN-Rule
Role-Mapping
Timeout
Credentials-Expiration
CA-Cert-File
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
secondary
Secondary IP Address
IP Address
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
Secondary
show-remote-servers-status
The show-remote-servers-status command displays NTP, DNS, gateway servers
information.
Output Parameter
Description
Server-Type
Server-IP
Server-Status
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
No
cert-country
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
String
No
cert-state
State or province
String
No
server-key-size
No
server-key-string
String
No
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
No
cert-ip
IP Address
IP Address
No
server-certificate-signing
-request-string
String
No
server-key-string
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
String
Yes
server-key-string
String
No
chain-certificate-string
String
No
Administration
421
CLI Guide
Description
Value
Mandatory*
debug-create-timeout
iscsi-tcp-port
Integer
obfuscate-debug
enabled, disabled
odx-mode
ODX mode
enabled, disabled
cluster-id
The clusters ID
Name or Index
No
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
Index
Min-SSDs-Per-Healthy-DPG
Max-SSDs-Per-DPG
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
Index
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
PSNT
Encryption-Mode
Encryption-Supported
Encryption-Mode-State
Compression-Mode
SSH-Firewall-Mode
OS-Upgrade-Ongoing
Cluster-Expansion-In-Progress
Upgrade-State
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
Index
ODX-Mode
iSCSI-TCP--Port
Obfuscate-Debug-Info
Debug-Info-Creation-Timeout
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
Index
Data-Reduction-Ratio
Thin-Provisioning-Ratio
Dedup-Ratio
Compression-Factor
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
Index
Thin-Provisioning-Soft-Limit
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
cluster-id
Cluster ID
Name or Index
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
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
XEnv-Name
Index
Cluster-Name
Index
CPU (%)
CSID
State
Storage-Controller-Name
Index
Brick-Name
Index
CLI Guide
Description
Value
Mandatory
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
Name
Index
Xms-IP-Addr
Xms-Mgmt-Ifc
REST-API-Protocol-Version
IP-Version
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
Index
Avg-CPU
Total-RAM
Used-RAM
Curr-Logs-Size
Uptime
Disk Usage
428
Output Parameter
Description
Name
Disk name
Index
1k-Blocks
Available
Used
CLI Guide
Ethernet Interfaces
Output Parameter
Description
Name
Interface name
Index
IP
Interface IP address
MAC-Address
State
Received-Bytes
Received-Packets
Sent-Bytes
Sent-Packets
Dropped-Packets
modify-xms-parameters
The show-xms-parameters command modifies the XMSs user inactivity timeout.
Input Parameter
Description
Value
Mandatory
default-user-inactivitytimeout
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
NTP-Servers
Cluster-Time
Cluster-Time-Zone
UTC-Offset
DST
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
ntp-servers
timezone
Time zone
modify-login-banner
The modify-login-banner command allows customizing the login banner text.
Input Parameter
Description
Value
Mandatory
banner
CLI/GUI banner
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
enable-user-url
N/A
server-name
Server name
E.g. xms.example.com
430
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
enable
Enable WebUI
N/A
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
Host name or IP
address
No
company-name
Company name
No
contact-details
Contact details
No
disable
N/A
No
enable
N/A
No
mail-password
No
mail-relay-address
No
mail-user
No
proxy-address
No
proxy-password
No
proxy-port
No
proxy-user
No
recipient-list
List of recipients
No
remove-recipient
Host name or IP
address
No
reset-configuration
N/A
No
sender
Sender
No
transport
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
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
Transport
Sender
Recipients
Proxy-Address
Proxy-Port
Proxy-User
Mail-Relay-Address
Mail-User
Company-Name
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
Host name or IP
address
No
auth-key
String
No
auth-protocol
No
community
String
No
disable
N/A
No
enable
N/A
No
port
Port number
No
priv-key
String
No
priv-protocol
No
recipient-list
No
remove-recipient
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
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
Recipients
Notifications recipients
SNMP-Version
SNMP version
Trap-Port
Community
User-Name
SNMP v3 username
Auth-Key
Priv-Key
Auth-Protocol
Priv-Protocol
Engine-ID
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
One from
Group 1
disable
Disable
N/A
One from
Group 1
enable
Enable
N/A
One from
Group 1
frequency
frequency
One from
Group 1
reset-configuration
Reset configuration
N/A
One from
Group 1
site-name
Site name
One from
Group 1
No
email-password
Mail password
No
email-sender
Mail sender
Sender name
No
email-server
Mail server
No
email-user
Mail username
No
esrs-gw-host
Gateway host
No
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
N/A
No
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
Frequency
ConnectEMC-Config
Site Name
PSNT
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
No
remove-target
Remove target
No
targets
Target list
No
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
Targets
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
sc-ip-list
Storage Controllers IP
list
[sc-id=value sc-ip-sn=value
ipmi-ip-sn=value,...]
xms-gw-addr
IP address
xms-ip-sn
XMS IP/Subnet
IP address/Subnet
cluster-id
Cluster ID
Name or Index
No
rollback
Rollback changes in
case of failure
N/A
No
438
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
Storage-Controller-Name
Index
Cluster-Name
Cluster Name
Index
Cluster index
Mgr-Addr-Subnet
MGMT-GW-IP
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
Yes
modify-tag
The modify-tag command modifies a specified Tag caption.
Input Parameter
Description
Value
Mandatory
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
Index
Entity
Number-of-Items
Creation-Time
Object-List
List of all objects assigned with the specified Tag (name and index)
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
Index
Entity
Number-of-Items
Creation-Time
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
442
Input Parameter
Description
Value
Mandatory
vol-name
Volume name
Yes
vol-size
Volume size
Yes
alignment-offset
No
cluster-id
Cluster ID
No
lb-size
Block size
No
small-io-alerts
Enabled or Disabled
No
unaligned-io-alerts
Enabled or Disabled
No
vaai-tp-alerts
VAAI TP Alerts
Enabled or Disabled
No
tag-list
Tag ID list
No
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
Enabled or Disabled
unaligned-io-alerts
Enabled or Disabled
vaai-tp-alerts
VAAI TP alerts
Enabled or Disabled
vol-access
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
vol-size
Volume size
Integer suffixed by
[mgtpk]. Volume size
must be in multiples of
8K.
cluster-id
Cluster ID
Name or Index
No
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
No
Output Parameter
Description
Volume-Name
Index
Cluster-Name
Index
Vol-Size
LB-Size
VSG-Space-In-Use
The total user data space written to the Volume Snapshot Group
before deduplication and compression
Offset
Created-From-Volume
The Volume that was the Snapshot source for this Volume
VSG-Index
Small-IO-Alerts
Unaligned-IO-Alerts
VAAI-TP-Alerts
Total-Writes
Total-Reads
NAA-Identifier
The SCSI Network Address Authority (NAA) identifier for the Volume
Certainty-State
Created-By-Application
CLI Guide
Output Parameter
Description
Volume-Type
Creation-Time
Vol-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
Index
Vol-Size
LB-Size
VSG-Space-In-Use
The total user data space written to the Volume Snapshot Group
before deduplication and compression
Offset
Created-From-Volume
The Volume that was the Snapshot source for this volume
VSG-Index
Cluster-Name
Index
Small-IO-Alerts
Unaligned-IO-Alerts
VAAI-TP-Alerts
Total-Writes
Total-Reads
Created-By-Application
Volume-Type
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
Tags
Creation-Time
Vol-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
Index
Index
Num-of-Vols
Num-of-Internal-Volumes
Vol-Size
Thin-Provisioning-Ratio
Logical-Space-In-Use
Reached-Max-Snapshots
Removing-Snapshots-In-Progress
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
snapshot-set-id
Snapshot Set ID
Name or Index
tag-list
Tag ID list
volume-list
Volume list
cluster-id
Cluster ID
Name or Index
No
snap-suffix
String
No
snapshot-set-name
String
No
snapshot-type
Snapshot type
regular (default) or
readonly
No
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
from-snapshot-set-id
Name or Index
Name or Index
from-volume-id
Name or Index
to-consistency-group-i
d
ID of the target
Consistency Group
Name or Index
to-snapshot-set-id
ID of the target
Snapshot Set
Name or Index
to-snapshot-set-tag-id
Name or Index
to-volume-id
no-backup
N/A
No
snapshot-set-name
String
No
backup-snap-suffix
String
No
backup-snapshot-type
Snapshot type
readonly, regular
No
cluster-id
Cluster ID
Name or Index
No
448
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
No
Output Parameters
Description
Volume-Name
Index
Cluster-Name
Index
Vol-Size
LB-Size
VSG-Space-In-Use
The total user data space written to the Volume Snapshot Group
before deduplication and compression
Offset
Created-From-Volume
The Volume that was the Snapshot source for this Volume
VSG-Index
Small-IO-Alerts
disabled, enabled
Unaligned-IO-Alerts
disabled, enabled
VAAI-TP-Alerts
disabled, enabled
Total-Writes
Total-Reads
NAA-Identifier
Certainty-State
Created-By-Application
Provisioning
449
CLI Guide
Output Parameters
Description
Volume-Type
Creation-Time
Vol-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
Index
Write-BW (MB/s)
Read-BW (MB/s)
Write-IOPS
Read-IOPS
BW (MB/s)
IOPS
450
Cluster-Name
Index
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
Index
Write-BW (MB/s)
Read-BW (MB/s)
Write-IOPS
Read-IOPS
BW (MB/s)
IOPS
Cluster-Name
Index
Description
Value
Mandatory
ss-id
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
Index
Cluster-Name
Index
Consistency-Group-Name
CG-ID
Num-of-Vols
Creation-Time
Volume-List
Tags
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
No
vertical
Vertical layout
N/A
No
Output Parameters
Description
Name
Index
Cluster-Name
Index
Consistency-Group-Name
CG-ID
Num-of-Vols
Creation-Time
Volume-List
Created-By-Application
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
No
tag-list
Tag ID list
No
vol-list
Object ID list
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
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
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
Index
Cluster-Name
Index
Volume-List
Tags
Created-By-Application
Certainty-State
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
No
Output Parameters
Description
Name
Index
Cluster-Name
Index
Num-of-Vols
Created-By-Application
Certainty-State
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
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
No
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
IG-Name
Index
Num-of-Initiators
Num-of-Vols
Certainty-State
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
tag-list
Tag ID list
No
Output Parameter
Description
IG-Name
Index
Cluster-Name
Index
Num-of-Initiators
Num-of-Vols
Certainty-State
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
Index
Write-BW (MB/s)
Read-BW (MB/s)
Write-IOPS
Read-IOPS
BW (MB/s)
IOPS
Cluster-Name
Index
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
String
Yes
String
No
String
No
String
No
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
String
No
initiator-name
Initiator name
String
No
operating-system
Operating system
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
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
String
String
String
String
initiator-authenticatio
n-password
CHAP authentication
password
String
initiator-authenticatio
n-user-name
CHAP authentication
user name
String
initiator-discovery-pas
sword
CHAP discovery
password
String
initiator-discovery-use
r-name
String
initiator-name
Initiator name
String
operating-system
Operating system
port-address
Port address
String
N/A
remove-cluster-discov
ery-credentials
N/A
remove-initiator-authe
ntication-credentials
N/A
remove-initiator-disco
very-credentials
N/A
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
Index
Cluster-Name
Index
Port-Type
Port-Address
IG-Name
Index
Certainty-State
Chap-Authentication-Initiator-User-name
Chap-Discovery-Initiator-User-Name
Chap-Authentication-Cluster-User-Name
Chap-Discovery-Cluster-User-Name
Initiator-OS
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
String
Yes
time
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
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
String
No
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
snapshot-object-id
Snapped object ID
Name or Index
snapshot-object-type
Class
String
snapshot-type
Snapshot type
String
snapshots-to-keep-nu
mber
Number of Snapshots
to keep
Integer
suffix
String
time
String in [h:m:s]
format for interval
mode and [d:h:m] for
explicit mode
cluster-id
Cluster ID
Name or Index
No
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
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
Index
Snapped-Object-Name
Snapped-Object-Index
Snapped-Object-Type
Snapshot-Type
Suffix
Scheduler-Type
Schedule
Snapshots-To-Keep-Number
Snapshots-To-Keep-Time
Enabled-State
Last-Activation-Time
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
Index
Snapped-Object-Index
Snapped-Object-Type
Snapshot-Type
Suffix
Snapshots-To-Keep-Time
Snapshots-To-Keep-Number
Scheduler-Type
Schedule
Enabled-State
Last-Activation-Time
Last-Activation-Status
Target Management
modify-target
The modify-target command modifies a Target parameters.
466
Input Parameter
Description
Value
Mandatory
mtu
Integer
Yes
tar-id
Name or index
Yes
cluster-id
Cluster ID
Name or Index
No
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
vertical
Vertical layout
N/A
No
Output Parameter
Description
Name
Index
Cluster Name
Index
Port-Type
Port-Address
Mac-Addr
Port-Speed
Port-State
Health-Level
Storage-Controller-Name
Index
TG-Name
Index
MTU
Jumbo-Frames
Certainty-State
Relative-Id
Provisioning
467
CLI Guide
modify-target-group
The modify-target command modifies a Target Groups parameters.
Input Parameter
Description
Value
Mandatory
mtu
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
TG-Name
Index
Cluster-Name
Index
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
Integer
No
tg-id
Target group ID
Name or ID
No
cluster-id
Cluster ID
No
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
Index
Volume-Name
Index
IG-Name
Index
TG-Name
Index
LUN
Mapping-Index
Certainty-State
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
One from
Group 1
tg-id
Target Group ID
Name or index
No
cluster-id
Cluster ID
No
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
No
cluster-id
Cluster ID
No
add-iscsi-route
The add-iscsi-route command adds and configures iSCSI route parameters.
Input Parameter
Description
Value
Mandatory
Destination network/mask
Yes
gateway
Gateway IP Address
IP Address
Yes
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
vlan
VLAN ID
Integer
cluster-id
Cluster Index
number
Name or Index
No
470
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
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
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
Cluster-Name
Index
Portal-Index
Target-Name
Index
IP-Address
Port-Address
VLAN
Certainty-State
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
Name
Index
Cluster-Name
Index
Destination-Network-and-Mask
Gateway
Certainty-State
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
Index
Chap-Discovery-Mode
Chap-Authentication-Mode
CLI Guide
modify-chap
The modify-chap command modifies the CHAP configuration parameters.
Input Parameter
Description
Value
Mandatory*
chap-authenticationmode
CHAP Authentication
Mode
One from
Group 1
chap-discovery-mode
One from
Group 1
cluster-ID
Cluster Identification
Name or Index
No
Provisioning
473
CLI Guide
Description
Value
Mandatory
cluster-id
Cluster ID
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
vertical
Vertical layout
N/A
No
Output Parameter
Description
Name
Index
Cluster-Name
Index
State
Useful-SSD-Space
User-Space
The total SSD space available to the XtremIO Storage Array for user
data
User-Space-In-Use
User-Space-Percent-Free
Rebuild-Progress
Preparation-Progress
474
Rebuild-Prevention
Brick-Name
Index
CLI Guide
Description
Value
Mandatory
actions
Action list
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
No
severity
Severity level
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
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
No
severity
Severity level
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
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
category
Events category
Severity
Entity
Entity-Details
Entitys details
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
Date/Time
Event-Code
Event code
Related-Alert-Code
Category
Event category
Severity
Entity
Entity-Details
Entity details
Description
Event description
Related-Events
User
User-Location
The location (IP address) of the user that invoked the operation
User-Type
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
String
No
from-date-time
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
List of strings
No
severity
Severity level
No
to-date-time
date/time format:
"2013-11-23","2013-11-23
10:14:15" "2013-11-23
10:14:15.123"
No
vertical
vertical
(e.g. show-events vertical)
No
Output Parameter
Description
Event ID
Date/Time
Event Code
Event code
Category
Event category
477
CLI Guide
Output Parameter
Description
Severity
Cluster ID
Entity
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
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
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
One from
Group1
severity
Severity level
information, minor,
major, critical
One from
Group1
threshold
Threshold value
Range 0 - 100
One from
Group1
478
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
Short-Description
Activity-Mode
Clearance-Mode
Severity
Alert-Code
Send-To-Call-Home
Use-Modified
Threshold
Threshold-Type
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
Index
The alerts ID
Description
Severity
Raise-Time
Entity
Name
Index
Cluster-Name
Index
Alert-Type
State
Alert-Code
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
String
No
utc
N/A
No
Description
Date-Time
Write-BW (KB)
Read-BW (KB)
Write-IOPs
Read-IOPs
Write-Latency (usec)
Read-Latency (usec)
Avg-Latency (usec)
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
Index
Write-BW (MB/s)
Read-BW (MB/s)
Write-IOPS
Read-IOPS
BW (MB/s)
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
Index
Write-Latency
Read-Latency
Avg-Latency
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
Index
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
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
Index
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
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
IG-Name
Index
Cluster-Name
Index
Write-BW (MB/s)
Write-IOPS
Read-BW (MB/s)
Read-IOPS
BW (MB/s)
IOPS
Total-Write-IOs
Total-Read-IOs
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
IG-Name
Index
Cluster-Name
Index
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
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
IG-Name
Index
Cluster-Name
Index
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
487
CLI Guide
show-initiators-performance
The show-initiators-performance command displays Initiators performance
data.
Input Parameter
Description
Value
Mandatory
cluster-id
Cluster ID
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
Initiator-Name
Index
Write-BW (MB/s)
Write-IOPS
Read-BW (MB/s)
Read-IOPS
BW (MB/s)
IOPS
Total-Write-IOs
Total-Read-IOs
488
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
Initiator-Name
Index
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
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
Initiator-Name
Index
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
CLI Guide
show-ssds-performance
The show-ssds-performance command displays SSDs performance data.
Input Parameter
Description
Value
Mandatory
cluster-id
Cluster ID
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
Name
Index
Cluster-Name
Index
Write-BW (MB/s)
Read-BW (MB/s)
Write-IOPS
Read-IOPS
BW (MB/s)
IOPS
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
TG-Name
Index
Cluster-Name
Index
Write-BW (MB/s)
Read-BW (MB/s)
Write-IOPS
Read-IOPS
BW (MB/s)
IOPS
Total-Write-IOs
Total-Read-IOs
492
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
TG-Name
Index
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
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
TG-Name
Index
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
CLI Guide
show-targets-performance
The show-targets-performance command displays Targets performance data.
Input Parameter
Description
Value
Mandatory
active
N/A
No
cluster-id
Cluster ID
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
Name
Index
Cluster-Name
Index
Write-BW (MB/s)
Read-BW (MB/s)
Write-IOPS
Read-IOPS
BW (MB/s)
IOPS
Total-Write-IOs
Total-Read-IOs
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
N/A
No
cluster-id
Cluster ID
No
duration
Monitor duration.
Seconds
No
frequency
Monitor intervals.
Seconds
No
Output Parameter
Description
Name
Index
Cluster-Name
Index
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
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
N/A
No
cluster-id
Cluster ID
No
duration
Monitor duration.
Seconds
No
frequency
Monitor intervals.
Seconds
No
Output Parameter
Description
Name
Index
Cluster-Name
Index
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
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
Volume-Name
Index
Cluster-Name
Index
Write-BW (MB/s)
Read-BW (MB/s)
Write-IOPS
Read-IOPS
BW (MB/s)
IOPS
Total-Write-IOs
Total-Read-IOs
498
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
Volume-Name
Index
Cluster-Name
Index
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
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
Volume-Name
Index
Cluster-Name
Index
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
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
Name
Index
Cluster-Name
Index
Write-BW (MB/s)
Read-BW (MB/s)
Write-IOPS
Read-IOPS
BW (MB/s)
IOPS
501
CLI Guide
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
Index
Cluster-Name
Index
Port-Index
Invalid-Dwords
Disparity-Errors
Loss-Dword-Sync
Phy-Resets
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
Index
Port-Index
Symb-Errs
Symb-Errs-pm
Symb-Errs-pl
Recovers
Recovers-pm
Recovers-pl
Lnk-Downed
Lnk-Downed-pm
Lnk-Downed-pl
Rcv-Errs
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
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
TG-Name
Index
Cluster-Name
Index
Dumped-Frames
Sync-Loss
Signal-Loss
Invalid-Crc
Link-Failure
Prim-Seq-Err
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
No
duration
Monitor duration
Seconds
No
frequency
Monitor intervals
Seconds
No
Output Parameter
Description
Name
Index
Cluster-Name
Index
Dumped-Frames
Sync-Loss
Signal-Loss
Invalid-Crc
Link-Failure
Prim-Seq-Err
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
Index
Cluster-Name
Index
Port-Address
Port address
Num-PKTS-Rx
Total-KB-Rx
Num-PKTS-Tx
Total-KB-Tx
Num-Crc-Err
Num-NO-Buff-Err
Num-Tx-Err
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
Title
Reports title
Entity
Category
Reports category
Object-List
Property-List
Source-Definition
View-Type
Public
show-reports
The show-reports command displays the list of defined reports.
Output Parameter
Description
Name
Reports name
Index
Title
Reports title
Entity
Category
Reports category
Granularity
Reporting granularity
From-Time
To-Time
Time-Frame
Source-Definition
Reports source
Public
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
No
granularity
Data granularity
No
obj-list
Object ID list
No
time-frame
No
to-time
To Date/Time
No
vertical
Vertical layout
N/A
No
cluster-id
Cluster ID
Name or Index
No
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:
509
Alerts Details
Alert Name
Alert
Code
sys_ud_ssd_space_limited
0200302
sys_ud_ssd_space_very_limited
System Impact
Severity
Minor
0200303
Major
sys_ud_ssd_space_no_free
0200304
Critical
sys_stopping
0200505
Critical
sys_stopped
0200506
Critical
sys_starting
0200507
def_sys_in_failed_state
0200508
Critical
sys_state_unknown
0200509
Major
510
Description
Field
Minor
Alert Name
Alert
Code
Description
sys_state_down
0200511
sys_stop_failed
Field
System Impact
Severity
Critical
0200512
Critical
sys_failed_stop
0200604
Major
sys_unorderly_stopping
0200606
Major
sys_orderly_stopping
0200607
Major
system_upgrade_bring_up
0200806
Minor
system_upgrade_waiting_for_ver 0200807
sion
Minor
system_upgrade_preparing
0200808
Upgrade process is
preparing the cluster for
upgrade.
Minor
system_upgrade_failed
0200809
system_rollback_ongoing
0200811
disconnected_from_sys_mgr
0200901
Cluster manager is
running, but it is
disconnected from XMS
due to <field1>.
sys_sharedmemory_limited
0201002
Major
Major
Minor
Shared memory
consumption is high.
Threshold: more than 85
percent in use.
Minor
sys_sharedmemory_very_limited 0201003
Major
sys_sharedmemory_no_free
Critical
0201004
Field1:
upgrade_
failure_re
ason
Field1:
sys_mgr_
conn_erro
r_reason
Alerts Details
511
Alert Name
Alert
Code
data_consistency_error
0201102
active_cluster_memory_recovery
_true
0201403
Activate-clusters-memory-r
ecovery command is
active.
sys_sharedmem_inefficiency_m
edium
0202002
Major
sys_sharedmem_inefficiency_hi
gh
0202003
Critical
vaai_tp_limit_threshold_exceed
ed
0202102
Minor
sys_expansion_progress_yes
0202202
Cluster expansion is in
progress.
Minor
sys_encrypt_started
0202302
Info.
sys_encrypt_switch_incomplete
0202303
Major
sys_chap_init_missing_cluster_c
redentials
0202401
Minor
sys_chap_init_missing_credenti
als
0202502
Minor
sys_hw_pkg_inconsistent
0203101
Major
system_proactive_loading_true
0203104
System performing
proactive metadata
loading.
sys_shdmemory_limited_recover 0204102
able
512
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.
Minor
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.
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.
Criticla
failed_brick_state
0300102
Major
unsupported_disk_in_brick
0300203
Field1:
The SSD cannot be used by
ssd_slot_ the cluster.
array[].slo
t_num
Minor
uninitialized_ssd_in_brick
0300204
Field1:
The SSD device cannot be
ssd_slot_ used until it is initialized.
array[].slo
t_num
Minor
foreign_xtremapp_ssd_in_brick
0300205
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
Field1:
ssd_slot_
array[].slo
t_num
Field2:
ssd_slot_
array[].slo
t_error_re
ason
Major
sas1_port_down
0400202
Major
sas2_port_down
0400302
Major
node_sas1_3gbps_rate
0400403
Minor
disconnected_from_node_mgr
0400503
Storage Controller is
disconnected from the
XMS.
Major
Alerts Details
513
Alert Name
Alert
Code
journal_fault
0400703
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
node_temp_level_2_unknown
0401102
Storage Controller
temperature IPMI
information is unavailable.
node_temp_level_3_warning
0401103
Minor
node_temp_level_4_minor
0401104
Minor
node_temp_level_5_major
0401105
Major
node_temp_level_6_critical
0401106
Major
node_fan_level_2_unknown
0401202
Minor
node_fan_level_3_warning
0401203
Minor
node_fan_level_4_minor
0401204
Minor
node_fan_level_5_major
0401205
Major
node_fan_level_6_critical
0401206
Major
node_volt_level_2_unknown
0401302
Minor
node_volt_level_3_warning
0401303
Minor
514
Description
Field
System Impact
Severity
Major
Major
Major
Minor
Alert Name
Alert
Code
node_volt_level_4_minor
0401304
node_volt_level_5_major
0401305
Major
node_volt_level_6_critical
0401306
Major
node_curt_level_2_unknown
0401402
Minor
node_curt_level_3_warning
0401403
Minor
node_curt_level_4_minor
0401404
Minor
node_curt_level_5_major
0401405
Major
node_curt_level_6_critical
0401406
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
Minor
node_ib1_level_3_warning
0401703
Field1:
ib1_port_
state
Minor
node_ib1_level_4_minor
0401704
Field1:
ib1_port_
state
Minor
node_ib1_level_5_major
0401705
Field1:
ib1_port_
state
Major
Description
Field
System Impact
Severity
Minor
Major
Alerts Details
515
Alert Name
Alert
Code
node_ib1_level_6_critical
0401706
Description
Field
System Impact
Severity
Field1:
ib1_port_
state
Major
node_wrong_ib1_port_connectio 0401802
n
Storage Controller's
InfiniBand port 1 is
connected to the wrong
port on the infiniBand
Switch.
Major
node_wrong_ib1_switch_connec
ted
0401803
Storage Controller's
InfinBand port 1 is
connected to the wrong
InfiniBand Switch.
Major
node_ib1_port_down
0401902
Storage Controller
InfiniBand port 1 is down.
Major
node_ib1_port_unknown
0401903
Storage Controller
InfiniBand port 1 port state
cannot be determined.
node_ib2_level_2_unknown
0402102
node_ib2_level_3_warning
0402103
node_ib2_level_4_minor
0402104
node_ib2_level_5_major
node_ib2_level_6_critical
Major
Minor
Field1:
ib2_port_
state
Minor
Field1:
ib2_port_
state
Minor
0402105
Field:
ib2_port_
state
Major
0402106
Field
ib2_port_
state
Major
node_wrong_ib2_port_connectio 0402202
n
Storage Controller's
InfinBand port 2 is
connected to the wrong
port on the InfinBand
Switch.
Major
node_wrong_ib2_switch_connec
ted
0402203
Storage Controller's
InfinBand port 2 is
connected to the wrong
InfiniBand Switch.
Major
node_ib2_port_down
0402302
Storage Controller
InfiniBand port 2 is down.
Major
node_ib2_port_unknown
0402303
Storage Controller
InfiniBand port 2 is
unknown.
Major
516
Alert Name
Alert
Code
upgrade_failed
Description
Field
System Impact
Severity
0402403
Field1:
upgrade_
failure_re
ason
Field2:
sw_versio
n
Major
node_upgrade_in_progress
0402404
node_orderly_stop
0402502
Major
node_unorderly_stop
0402503
Major
node_failed_stop
0402504
Major
node_orderly_stopping
0402505
Major
node_unorderly_stopping
0402506
Major
node_user_disabled
0402602
Major
node_system_disabled
0402603
Major
Minor
Alerts Details
517
Alert Name
Alert
Code
Description
node_fru_failed
0402703
node_fru_disconnected
System Impact
Severity
Major
0402704
Major
node_fru_uninitialized
0402705
Minor
node_fru_prepare_failed
0402706
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.
Major
node_fw_mismatch
0402804
Unexpected Storage
Controller's OS or firmware
version has been detected.
Minor
node_free_ram_low
0402902
Sub-optimal Storage
Controller memory utilization
may result in performance
degradation.
Major
node_file_descriptors_high
0402912
mgmt_port_half_duplex
0403102
Storage Controller
management port is set to
half duplex.
node_dimm_level_2_unknown
0403302
Minor
node_dimm_level_3_warning
0403303
Minor
node_dimm_level_4_minor
0403304
Minor
518
Field
Major
This may result in connectivity
issues.
Major
Alert Name
Alert
Code
node_dimm_level_5_major
0403305
Major
node_dimm_level_6_critical
0403306
Major
inconsistent_fc_tar_speed
0403402
Minor
inconsistent_scsi_tar_speed
0403502
Minor
node_sas2_3gbps_rate
0403603
Minor
node_eth_10m_rate
0403801
Major
node_eth_100m_rate
0403802
Minor
node_ethport_level_2_unknown
0403902
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
Storage Controller
management port
communication is
sub-optimal.
Minor
node_ethport_level_4_minor
0403904
Storage Controller
management port
communication is
sub-optimal.
Minor
node_ethport_level_5_major
0403905
Storage Controller
management port
communication is
sub-optimal.
Major
node_ethport_level_6_critical
0403906
Major
node_sas1_conn_wrong_lcc
0404002
Major
node_sas1_conn_wrong_lcc_por
t
0404003
Major
Description
Field
System Impact
Severity
Alerts Details
519
Alert Name
Alert
Code
node_sas1_conn_unknown_dae
0404004
node_sas1_level_2_unknown
0404102
node_sas1_level_3_warning
0404103
Minor
node_sas1_level_4_minor
0404104
Minor
node_sas1_level_5_major
0404105
Major
node_sas1_level_6_critical
0404106
Major
node_sas2_level_2_unknown
0404202
node_sas2_level_3_warning
0404203
Minor
node_sas2_level_4_minor
0404204
Minor
node_sas2_level_5_major
0404205
Major
node_sas2_level_6_critical
0404206
Major
node_fp_temperature_warning
0404502
Storage Controller
temperature is high as
reported by front panel
sensor.
Major
node_fp_temperature_high
0404503
Storage Controller
temperature is critically
high as reported by front
panel sensor.
Critical
node_ipmiport_invalid_wiring
0404602
Major
journal_failjover
0404702
Major
520
Description
Field
System Impact
Severity
Major
Minor
Minor
Alert Name
Alert
Code
journal_failback
0404703
journal_failed
Description
Field
System Impact
Severity
Major
0404704
Minor
ded_ipmi_port_down
0404902
Storage Controller
dedicated IPMI port
connected to the peer
Storage Controller is down.
Major
node_discover_dae_true
0405002
Minor
node_discover_daepsu_true
0405102
Minor
node_discover_ibsw_true
0405202
Minor
node_discover_localdisk_true
0405302
Minor
node_discover_localdisk_true
0405402
Minor
node_sas2_conn_wrong_lcc
0405502
Major
node_sas2_conn_wrong_lcc_por
t
0405503
Major
node_sas2_conn_unknown_dae
0405504
Major
node_discover_dae_ctrl_true
0405602
Minor
node_discover_bbu_true
0405702
Minor
node_disk_limited_space
0406102
Minor
Alerts Details
521
Alert Name
Alert
Code
node_disk_no_free_space
Description
Field
0406103
Field1:fre
e_disk_s
pace
notifier_disabled
0406202
node_tech_tunnel_opened
0407002
node_unbalanced_failback_allo
wed
0408003
disk_empty
0500102
Field1:
slot_num
Field2:
local_dis
k_type
Field3:
local_dis
k_purpos
e
Major
disk_unanticipated_disk
0500103
Field1:slo
t_num
Major
disk_unsupported_disk
0500104
Field1:slo
t_num
Major
disk_uninitialized
0500106
Field1:slo
t_num
Major
localdisk_user_disabled
0500202
Major
localdisk_system_disabled
0500203
Major
localdisk_fru_failed
0500303
localdisk_fru_disconnected
0500304
localdisk_fru_uninitialized
0500305
localdisk_fru_prepare_failed
0500306
522
System Impact
Severity
Major
Syr/Syslog/Email/SNMP
notifications will not be sent
for this cluster.
Info.
Major
Minor
Alert Name
Alert
Code
localdisk_fw_upgrading
0500402
Firmware is being
upgraded.
localdisk_fw_invalid
0500403
localdisk_fw_mismatch
0500404
Minor
nodepsu_user_disabled
0600201
Major
nodepsu_system_disabled
0600203
Major
nodepsu_fru_failed
0600303
Major
nodepsu_fru_disconnected
0600304
Major
nodepsu_fru_uninitialized
0600305
Minor
nodepsu_fru_prepare_failed
0600306
Minor
nodepsu_fw_upgrading
0600402
nodepsu_fw_mismatch
0600404
Minor
nodepsu_no_input
0600701
Major
rg_degraded
0800102
Major
rg_dual_failure
0800103
Description
Field
System Impact
Severity
Info.
Informat
ion
Critical
Alerts Details
523
Alert Name
Alert
Code
rg_error
0800104
rg_double_degrade
System Impact
Severity
Critical
0800106
Critical
rebuild_0_to_20_done
0800211
Info.
rebuild_20_to_40_done
0800221
Info.
rebuild_40_to_60_done
0800231
Info.
rebuild_60_to_80_done
0800241
Info.
rebuild_99_done
0800251
Field1:reb
uild_prog
ress
Info.
prepare_0_to_20_done
0800321
Field1:
ssd_prep
aration_p
rogress
Info.
20_to_40_done
0800331
Field1:
ssd_prep
aration_p
rogress
Info.
prepare_40_to_60_done
0800341
Field1:
ssd_prep
aration_p
rogress
Info.
prepare_60_to_80_done
0800351
Field1:
ssd_prep
aration_p
rogress
Info.
prepare_99_done
0800361
Field1:
ssd_prep
aration_p
rogress
Info.
rg_no_available_rebuilds
0800402
524
Description
Field
Major
Alert Name
Alert
Code
rg_low_on_available_rebuilds
0800403
small_io_ratio_low
0800602
small_io_ratio_medium
0800603
small_io_ratio_high
Description
Field
System Impact
Severity
Minor
Field1:
small_io_
ratio
Minor
Field1:
small_io_
ratio
Minor
0800604
Field1:
small_io_
ratio
Major
unalign_io_ratio_low
0800702
Field1:
For optimal cluster
unaligned performance, unnecessary
_io_ratio unaligned I/O should be
avoided.
Minor
unalign_io_ratio_medium
0800703
Field1:
For optimal cluster
unaligned performance, unnecessary
_io_ratio unaligned I/O should be
avoided.
Minor
unalign_io_ratio_high
0800704
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
Info.
ssd_failed_in_rg
0900103
Major
ssd_eject_pending
0900105
SSD is waiting to be
ejected from its SSD slot.
Minor
Alerts Details
525
Alert Name
Alert
Code
ssd_assigning_to_rg
0900106
ssd_diag_level_2_unknown
System Impact
Severity
Minor
0900202
Minor
ssd_diag_level_4_minor
0900204
Diagnostics detected a
problem in the SSD.
Minor
ssd_diag_level_5_major
0900205
Diagnostics detected a
major problem in the SSD.
Major
ssd_diag_level_6_critical
0900206
Diagnostics detected a
critical problem in the SSD.
Major
ssd_link1_level_2_unknown
0900302
Minor
ssd_link1_level_3_warning
0900303
Cluster diagnostics
detected a minor problem
in link 1 of the SSD.
Minor
ssd_link1_level_4_minor
0900304
Cluster diagnostics
detected a problem in link
1 of the SSD.
Minor
ssd_link1_level_5_major
0900305
Cluster diagnostics
detected a major problem
in link 1 of the SSD.
Major
526
Description
Field
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.
Major
0900402
Minor
ssd_link2_level_3_warning
0900403
Cluster diagnostics
detected a minor problem
in link 2 of the SSD.
Minor
ssd_link2_level_4_minor
0900404
Cluster diagnostics
detected a problem in link
2 of the SSD.
Minor
ssd_link2_level_5_major
0900405
Cluster diagnostics
detected a major problem
in link 2 of the SSD.
Major
ssd_link2_level_6_critical
0900406
Cluster diagnostics
detected a critical problem
in link 2 of the SSD.
Major
ssd_user_disabled
0900602
Major
ssd_system_disabled
0900603
Major
ssd_fru_failed
0900703
Major
ssd_fru_disconnected
0900704
SSD is disconnected.
Major
ssd_fru_uninitialized
0900705
Minor
Alerts Details
527
Alert Name
Alert
Code
ssd_fru_prepare_failed
0900706
ssd_fw_upgrading
0900802
Firmware is in process of
being upgraded.
ssd_fw_invalid
0900803
Major
ssd_fw_mismatch
0900804
Minor
ssd_add_pending
0901102
Minor
ssd_modify_pending
0901103
Minor
ssd_remove_pending
0901104
Minor
ssd_limited_endurance
0901202
Minor
ssd_very_limited_endurance
0901203
Major
ssd_none_remaining_endurance
0901204
Critical
tar_not_found
1100202
Major
tar_fc_counter
1100203
Minor
target_level_2_unknown
1100402
Minor
target_level_3_warning
1100403
Minor
target_level_4_minor
1100404
Minor
528
Description
Field
System Impact
Severity
Minor
Info.
Alert Name
Alert
Code
target_level_5_major
1100405
target_level_6_critical
Description
Field
System Impact
Severity
Major
1100406
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.
Major
xenv_failback
1200108
Internal sub-process
(XEnv) state is performing
failback as part of process
recovery.
Info.
module_failover
1300106
Internal sub-process
(module) state is
performing fail-over.
Major
module_failback
1300107
Internal sub-process
(module) state is
performing fail-back as
part of process recovery.
Info.
ibswitch_level_2_unknown
1400102
Field1:po
rt_index
Minor
ibswitch_level_3_warning
1400103
Field1:po
rt_index
Minor
ibswitch_level_4_minor
1400104
Field1:po
rt_index
Major
ibswitch_level_5_major
1400105
Field1:po
rt_index
Major
Alerts Details
529
Alert Name
Alert
Code
ibswitch_level_6_critical
Description
Field
System Impact
Severity
1400106
Field1:po
rt_index
Major
ibswitch_user_disabled
1400302
Major
ibswitch_system_disabled
1400303
Major
ibswitch_fru_failed
1400403
Major
ibswitch_fru_disconnected
1400404
InfiniBand Switch is
disconnected.
Major
ibswitch_fru_uninitialized
1400405
Minor
ibswitch_fru_prepare_failed
1400406
Minor
ibswitch_fw_upgrading
1400502
Info.
ibswitch_fw_invalid
1400503
Major
ibswitch_fw_mismatch
1400504
Minor
ibswitch_unknown_model
1400505
Major
ibswitch_wrong_connection
1400602
Incorrect connection
between Storage
Controller(s) and
InfiniBand Switch was
detected.
530
Major
Alert Name
Alert
Code
ibswitch_one_fan_failed
1400702
ibswitch_fan_drawer_failed
1400703
Major
ibswitch_s2s_ib1_port_down
1400801
InfiniBand Switch to
InfiniBand Switch port 17
is down.
Minor
ibswitch_s2s_ib2_port_down
1400901
InfiniBand Switch to
InfiniBand Switch port 18
is down.
Minor
no_ups_load
1500102
Major
low_threshold_ups_load
1500103
Field1:up
s_load_in
_percent
Minor
med_threshold_ups_load
1500104
Field1:up
s_load_in
_percent
Major
high_threshold_ups_load
1500105
Field1:up
s_load_in
_percent
Major
ups_node_1_disconnected
1500203
Serial communication to
the BBU is disconnected
from Storage Controller 1,
but is connected from
Storage Controller 2.
Major
ups_node_2_disconnected
1500204
Serial communication to
the BBU is disconnected
from Storage Controller 2,
but is connected from
Storage Controller 1.
Major
ups_no_external_power
1500402
Major
Description
Field
System Impact
Severity
Minor
Field1:po
wer_feed
Alerts Details
531
Alert Name
Alert
Code
ups_low_bat_failure_true
Description
Field
System Impact
Severity
1500502
Field1:up
s_battery
_charge_i
n_percent
Major
ups_low_bat_no_input
1500602
Field1:up
s_battery
_charge_i
n_percent
Major
ups_low_bat_run_failure_true
1500702
Major
ups_overld_failure_true
1500802
Field1:up
s_load_in
_percent
Major
ups_bypass_active_failure_true
1501102
Major
ups_need_bat_replce_failure_tru 1501302
e
Major
ups_user_disabled
1501401
Major
ups_system_disabled
1501403
Major
ups_fru_failed
1501503
Major
ups_fru_disconnected
1501504
Major
ups_fru_uninitialized
1501505
Minor
ups_fru_prepare_failed
1501506
Minor
ups_fw_upgrading
1501602
532
Info.
Alert Name
Alert
Code
ups_fw_invalid
1501603
ups_fw_mismatch
Description
Field
System Impact
Severity
Major
1501604
Minor
sas_sas1_port_down
1600202
Major
jbodcontroller_user_disabled
1600402
jbodcontroller_system_disabled
1600403
jbodcontroller_fru_failed
1600503
jbodcontroller_fru_disconnected
1600504
jbodcontroller_fru_uninitialized
Major
Major
Field1:loc
ation
Major
Field1:loc
ation
Major
1600505
Field1:loc
ation
Minor
jbodcontroller_fru_prepare_faile
d
1600506
Field1:loc
ation
Minor
jbodcontroller_fw_upgrading
1600602
jbodcontroller_fw_invalid
1600603
Field1:loc
ation
Major
jbodcontroller_fw_mismatch
1600604
Field1:loc
ation
Minor
node_lcc_level_2_unknown
1600912
Minor
node_lcc_level_3_warning
1600913
Minor
node_lcc_level_4_minor
1600914
Minor
node_lcc_level_5_major
1600915
Major
Info.
Alerts Details
533
Alert Name
Alert
Code
node_LCC_level_6_critical
1600916
lcc_sas2_port_down
Description
Field
System Impact
Severity
Major
1601102
Minor
jbodpsu_user_disabled
1700202
Major
jbodpsu_system_disabled
1700203
Major
jbodpsu_fru_failed
1700303
Field1:loc
ation
Major
jbodpsu_fru_disconnected
1700304
Field1:loc
ation
Major
jbodpsu_fru_uninitialized
1700305
Field1:loc
ation
Minor
jbodpsu_fru_prepare_failed
1700306
Field1:loc
ation
Minor
jbodpsu_fw_upgrading
1700402
jbodpsu_fw_invalid
1700403
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
Minor
1700702
Major
dae_psu_ac_out_of_range
1700703
Major
dae_psu_ac_failed
1700704
Major
ibswitchpsu_user_disabled
1700802
Major
534
Field1:loc
ation
Alert Name
Alert
Code
ibswitchpsu_system_disabled
1700803
ibswitchpsu_fru_failed
1700903
ibswitchpsu_fru_disconnected
1700904
ibswitchpsu_fru_uninitialized
Description
Field
System Impact
Severity
Major
Field1:loc
ation
Major
Field1:loc
ation
Major
1700905
Field1:loc
ation
Minor
ibswitchpsu_fru_prepare_failed
1700906
Field1:loc
ation
Minor
ibswitchpsu_fw_upgrading
1701102
Firmware is in process of
being upgraded.
ibswitchpsu_fw_invalid
1701103
Field1:loc
ation
Major
ibswitchpsu_fw_mismatch
1701104
Field1:loc
ation
Minor
ibswitchpsu_no_external_power
1701502
Major
jbod_fru_failed
1800303
Major
jbod_fru_disconnected
1800304
jbod_fru_uninitialized
1800305
Minor
jbod_fru_prepare_failed
1800306
Minor
Info.
Major
Alerts Details
535
Alert Name
Alert
Code
snapshotgroup_add_pending
1900102
Minor
snapshotgroup_modify_pending
1900103
Minor
snapshotgroup_remove_pending 1900104
Minor
discovery_chap_initiators_missi
ng_credentials_true
1901102
Major
xms_disk_low_free_space
2000002
Field1:fre
e_space
Major
xms_disk_no_free_space
2000003
Field1:fre
e_space
Critical
xms_disk_very_low_free_space
2000004
Field1:fre
e_space
xms_memory_low
2000012
Field1:fre
e_memor
y
xms_memory_full
2000013
xms_wrong_cn_true
2000102
xms_disk_second_low_free_spa
ce
2000202
Field1:fre
e_disk_s
pace_sec
ondary
Major
xms_disk_second_very_low_free 2000203
_space
Field1:fre
e_disk_s
pace_sec
ondary
Major
xms_disk_second_no_free_spac
e
2000204
Field1:fre
e_disk_s
pace_sec
ondary
Critical
cg_add_pending
2200802
Consistency Group is in an
ambiguous state after an
add request.
536
Description
Field
System Impact
Severity
Major
Major
Critical
Major
Minor
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
Minor
ig_modify_pending
2300103
Minor
ig_remove_pending
2300104
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.
Major
scheduler_last_activation_obj_n
ot_found
2500204
Last activation of
scheduler has failed.
Invalid source object of the
scheduler.
Major
scheduler_last_activation_vsg_
max_reached
2500205
scheduler_last_activation_cluste
r_volumes_max_reached
2500206
Description
Field
System Impact
Severity
Alerts Details
537
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
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
Field1:old_value
Field2:enabled_stat
e
enabled
user_disabled
system_disabled
State_Ch
ange
NODE_PSU_FRU_STATE
06003
Field1:location
left
right
State_Ch
ange
538
Field2:old_value
healthy
Field3:fru_lifecycle_ initializing
state
failed
disconnected
uninitialized
prepare_failed
Event Name
Event
Code
SSD_LINK1_HEALTH
SSD_FRU_FW_VERSION_STATE
Event
Category
Description
Field
Field Value
09003
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
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
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
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
Event Name
Event
Code
SYSTEM_SYS_STOPPED_REASON
02007
Description
Field
Field Value
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
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
Field1:old_value
Field2:fc_port_spee
d
not_in_use
inconsistent
1gfc
8gfc
10gfc
16gfc
State_Ch
ange
SYSTEM_SCSI_PORT_SPEED
04035
Field1:old_value
Field2:fc_port_spee
d
not_in_use
inconsistent
10mb
100mb
1gb
10gb
40gb
State_Ch
ange
540
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
Field1:vaai_tp_limit
_crossing
healthy
threshold_exceeded
Hardware
Field2:vaai_tp_limit
Integer: 0 - 100
SHDMEMORY_IN_USE_RECOVERABLE 02041
_LEVEL
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
Field1:old_value
Field2:brick_state
in_sys
not_in_sys
Software
BRICK_SLOT_STATE
03002
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
Field1:old_value
Field2:sas1_port_st
ate
up
down
unknown
system_disabled
State_Ch
ange
Events Details
541
Event Name
Event
Code
SAS_HBA_DOWN2
Event
Category
Description
Field
Field Value
04003
Field1:old_value
Field2:sas2_port_st
ate
up
down
unknown
system_disabled
Hardware
NODE_SAS1_PORT_RATE
04004
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
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
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
Field1:old_value
Field2:enabled_stat
e
NODE_FRU_STATE
04027
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
State_Ch
ange
State_Ch
ange
Event Name
Event
Code
NODE_ACCESS_STATE_TO_DAE
LOCAL_DISK_DISK_FAILURE
LOCAL_DISK_FRU_STATE
Field
Field Value
04080
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
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
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
Event Name
Event
Code
NODE_PSU_INPUT
06007
Description
Field
Field Value
Field1:location
left
right
Field2:input
uninitialized
off
on
Event
Category
Software
RG_PROTECTION_STATE
08001
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
Field1:rg_ud_ssd_p
ercent_free_space
Integer: 0 - 100
546
0
1
2
3
4
5
Software
Software
Event Name
Event
Code
VOLUME_SMALL_IO_RATIO
08006
VOLUME_UNALIGNED_IO_RATIO
08007
Event
Category
Description
Field
Field Value
Field1:old_value
Field2:small_io_rati
o_level
Field3:small_io_rati
o
Integer: 0 - 100
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
Field1:old_value
Field2:ssd_state
in_rg
not_in_rg
failed_in_rg
eject_pending
assigning_to_rg
SSD_ENDURANCE_REMAINING
09012
Field1:percent_end
urance_remaining_l
evel
Integer: 0 - 100
Hardware
SSD_DIAGNOSTIC_HEALTH
09002
Field1:old_value
Field2:diagnostic_h
ealth_state
Hardware
SSD_LINK2_HEALTH
09004
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
Field1:old_value
Field2:enabled_stat
e
State_Ch
ange
SSD_FRU_STATE
09007
Field1:old_value
healthy
Field2:fru_lifecycle_ initializing
state
failed
disconnected
uninitialized
prepare_failed
trigger_update
State_Ch
ange
TARGET_TAR_ERROR_REASON
11002
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
Event Name
Event
Code
TARGET_PORT_STATE
Event
Category
Description
Field
Field Value
11003
Field1:old_value
Field2:port_state
up
down
unknown
State_Ch
ange
TARGET_TAR_HEALTH_STATE
11004
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
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
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
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
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
Field1:old_value
Field2:ups_conn_st
ate
UPS_INPUT
15004
Field1:old_value
Field2:ups_input
on
off
Software
UPS_LOW_BATTERY_HAS_INPUT
15005
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
Event Name
Event
Code
UPS_LOW_BATTERY_NO_INPUT
UPS_LOW_BATTERY_RUNTIME
Event
Category
Description
Field
Field Value
15006
Field1:old_value
Field2:is_low_batte
ry_no_input
false
true
invalid_state
Software
15007
Field1:old_value
Field2:is_low_batte
ry_runtime
false
true
invalid_state
Software
Field3:battery_runti
me
Integer
Field1:old_value
Field2:is_low_batte
ry_runtime
false
true
invalid_state
Field3:ups_load_in
_percent
Integer
15011
Field1:old_value
false
Field2:is_bypass_ac true
tive
invalid_state
Software
UPS_NEEDS_BATTERY_REPLACEMENT 15013
Field1:old_value
Field2:ups_need_b
attery_replacement
false
true
invalid_state
Hardware
UPS_ENABLED_STATE
15014
Field1:old_value
Field2:enabled_stat
e
user_disabled
enabled
system_disabled
State_Ch
ange
UPS_FRU_STATE
15015
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
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
Event Name
Event
Code
Description
Field
Field Value
Event
Category
JBOD_CONTROLLER_SAS2_PORT_STA
TE
16011
Field1:old_value
Field2:sas2_port_st
ate
up
down
unknown
State_Ch
ange
JBOD_CONTROLLER_ENABLED_STATE
16004
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
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
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
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
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
State of the
<location> DAE PSU
was changed from
<field1> to <field2>.
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
Event Name
Event
Code
IB_SWITCH_PSU_FRU_STATE
17009
JBOD_PSU_FRU_FW_VERSION_STATE
17004
Description
Field
Field Value
Event
Category
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
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
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
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
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
Field 1: old_value
Field 2:
certainty_state
ok
add_pending
modify_pending
remove_pending
Software
INITIATOR_CERTAINTY_STATE
24001
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
Field 1: old_value
Field 2:
authentication_cha
p_initiators_missin
g_cluster_credentia
ls
false
true
State_Ch
ange
INITIATOR_CHAP_DISCOVERY
19011
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
level_1_clear
level_2_unknown
level_3_warning
level_4_minor
level_5_major
level_6_critical
ok
invalid_wiring
disconnected
Hardware
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
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
Field 1:
jbod_lcc_discovery
_needed
false
true
Hardware
NODE_DISCOVERY_DAE_PSU
04051
Field 1:
jbod_psu_dn
false
true
Hardware
NODE_DISCOVERY_IBSW
04052
Field 1:
ib_switches_dn
false
true
Hardware
NODE_DISCOVERY_LOCALDISK
04053
Field 1:
local_disk_dn
false
true
Hardware
NODE_DISCOVERY_SCPSU
04054
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
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
Field 1: old_value
Field 2:
last_activation_stat
us
SCHEDULER_STATE
25001
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
Field 1: old_value
Field 2:
certainty_state
ok
add_pending
modify_pending
remove_pending
Software
556
Software
successful
State_Ch
ange
never_run
failed
snapped_object_not_
found
max_volumes_in_vsg
_reached
max_volumes_in_clus
ter_reached
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
Field 1: old_value
Field 2:
certainty_state
ok
add_pending
modify_pending
remove_pending
Software
VOLUME_CERTAINTY_STATE
08008
Field 1: old_value
Field 2:
certainty_state
ok
add_pending
modify_pending
remove_pending
Software
Events Details
557
Description
Field
Field Value
Event
Category
Field 1:
free_disk_space_se
condary
Integer
Software
XMS_DISK_SPACE_UTILIZATION_LEVE 20000
L
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
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
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 ............................
560
561
562
562
563
564
559
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
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
No
cert-country
Certificate country
name
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
No
server-key-string
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
562
563
564
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
565
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.
566
3. Click Login; the system launches the XtremIO WebUI Application and displays the
WebUI Overview screen, as shown in Figure 244.
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.
567
2. Click an object type to view the list of all objects defined in the cluster.
568