IBM XCLI Utility User's Guide and Reference Manual
Summary
This essential technical guide provides comprehensive instructions on utilizing the XCLI command-line utility for managing IBM XIV Storage Systems. It is designed specifically for system administrators responsible for system maintenance and configuration. The manual thoroughly covers everything from understanding complex command syntax to running commands in interactive or batch modes via platforms like Windows, Linux, AIX, and HP-UX. Use this resource to master XCLI settings, define configurations, troubleshoot utilities, and efficiently manage your IBM XIV environment.
Page 1 Text Content
IBM XIV Storage System
XCLI Utility User Manual Version 10.2.1
GA32-0638-03
Page Summary Contents For IBM XCLI Utility User's Guide and Reference Manual
Page 1
IBM XIV Storage System XCLI Utility User Manual Version 10.2.1 GA32-0638-03
Page 3
IBM XIV Storage System XCLI Utility User Manual Version 10.2.1 GA32-0638-03
Page 4
Note Before using this information and the product it supports, read the information in “Notices” on page 15. This edition applies to version 10, release modification 1, of IBM XIV Storage System, and...
Page 5
Contents Figures Understanding the command syntax Command syntax quick reference Syntax example About this guide vii Who should use this guide vii Chapter 3. Using the XCLI Conventions used in this gu...
Page 6
iv IBM XCLI User Manual
Page 7
Figures 1. XCLI commands running on the IBM XIV 2. XCLI prompt on Windows Storage System. Copyright IBM Corp. 2009,
Page 8
vi IBM XCLI User Manual
Page 9
About this guide This document describes how to use the IBM® XIV® Storage System command-line interface (XCLI) to invoke XCLI utility and system commands. Who should use this guide This publication is...
Page 10
Publications Information that is available in the information center is also available in set of publications, in PDF format. IBM XIV Storage System IBM XIV Storage System Product Overview (publib.bou...
Page 11
IBM XIV Storage System XCLI User Manual (publib.boulder.ibm.com/infocenter/ibmxiv/r2/topic/ com.ibm.help.xiv.doc/docs/GA32-0638-03.pdf), GA32-0638 This document describes how to use the IBM XIV comman...
Page 12
IBM XIV Storage System Management Console for VMware v Center User's Guide (publib.boulder.ibm.com/infocenter/ibmxiv/r2/topic/ com.ibm.help.xiv.doc/docs/ IBM_XIV_MNG_Console_2.0.0_for_VMware_v Center_...
Page 13
Use this website to learn about the XIV system, including features and hardware summary. This website also has links to white papers, Redbooks publications, and product documentation. IBM Support Port...
Page 14
detailed description of any information that should be changed xii IBM XCLI User Manual
Page 15
Chapter 1. Overview of the IBM XIV Storage System command-line interface The IBM XIV Storage System command-line interface (XCLI) provides mechanism for issuing commands to manage and maintain the XIV...
Page 16
Interactive and basic modes You can use the IBM XIV Storage System command-line interface (XCLI) in two modes: interactive and basic. The differences between these two modes are as follows: Basic mode...
Page 17
Chapter 2. Getting started with XCLI This information gets you started with the IBM XIV Storage System command-line interface (XCLI), including how to install and start the XCLI. It also provides info...
Page 18
Starting the XCLI You start the XCLI in different ways depending on the hosting operating system and operational mode. This information describes how to start the XCLI on Windows and Linux hosts in bo...
Page 19
3. Run any XCLI command, including the XCLI identification parameters, for example: xcli -u user -p -m 127.0.0.1 vol_list Starting the XCLI on Linux system You can start the XCLI on Linux system in ei...
Page 20
version_get vol_by_id vol_copy vol_create vol_delete vol_format vol_list vol_lock vol_mapping_list vol_move vol_rename vol_resize vol_unlock vpd_config_get vpd_config_set This example lists all comman...
Page 21
Options Values -f Specifies the name of configuration file that lists the XIV system -c Specifies the XIV system on which the command is to be run -m Specifies the IP address of the XIV system on whic...
Page 22
IBM XCLI User Manual
Page 23
Chapter 3. Using the XCLI This information describes each XCLI command parameter. Using identification parameters This information describes parameters used to set the user, password, and XIV system. ...
Page 24
Configuration parameters Most XCLI commands are directed to specific XIV system using the IP address. You must provide at least one address and up to three addresses per XIV system. To provide the XIV...
Page 25
Listing the available XIV systems In the following example, the configuration information is read from default file location or from the file that is specified with [-f file]. xcli [-f file] -L Adding...
Page 26
XIV system The XIV system is specified by either its IP address or name of the XIV system as listed in the configuration file. See “Configuration parameters” on page for more information. -m Specifies...
Page 27
vol_list Specifies the command to be run. For more information about running commands, see“Interactive mode features” on page 5. Viewing the available columns You can view all of the available table's...
Page 28
-m Specifies the IP address of the XIV system to which this command is directed. -c Specifies the name of the XIV system to which this command is directed, as it is defined in the configuration file (...
Page 29
Notices This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your...
Page 30
IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it ...
Page 31
Trademarks IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names ...
Page 32
IBM XCLI User Manual
Page 33
Glossary This glossary includes terms and definitions for IBM XIV Storage System. This glossary includes selected terms and definitions from: basic mode The American National Standard Dictionary for m...
Page 34
IBM XCLI User Manual
Page 35
Index list XCLI (continued) display option overview about this document user and password parameters 9, sending comments xi XCLI options display XCLI parameters notices configuration legal basic mode ...
Page 36
IBM XCLI User Manual
Page 38
Printed in USA GA32-0638-03
Manual Details
| Brand | IBM |
|---|---|
| Pages | 38 |
| File Size | 365.10 KB |
| Published | May 23, 2026 |
114 views
Enter the captcha to get the download link:
Frequently Asked Questions
Who should use this XCLI guide?
This publication is intended for personnel that are responsible for administering IBM XIV Storage Systems.
How can I start an XCLI session?
Separate instructions are provided in the manual for starting XCLI on both Windows and Linux systems.
What types of operational modes does XCLI support?
The XCLI supports running commands in both interactive mode and basic mode.
Where can I find overall product documentation for IBM XIV?
You can browse all product documentation available at the dedicated Information Center website.