0% found this document useful (0 votes)

39 views304 pages

c2723397-IBM Tivoli Storage Productivity Center-Command-Line Interface Reference

Uploaded by

wayne wang

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

39 views304 pages

c2723397-IBM Tivoli Storage Productivity Center-Command-Line Interface Reference

Uploaded by

wayne wang

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 304

IBM Tivoli Storage Productivity Center

Version 4.2.2.2

Command-Line Interface Reference

SC27-2339-07
IBM Tivoli Storage Productivity Center
Version 4.2.2.2

Command-Line Interface Reference

SC27-2339-07
Note:
Before using this information and the product it supports, read the information in “Notices” on page 275.

This edition applies to V4.2.2, Fix Pack 2 of IBM Tivoli Storage Productivity Center (product numbers 5608-WB1,
5608-WC0, 5608-WC3, 5608-WC4, 5725-A01, 5725-E18, 5608-WB2, and 5608-WB3) and to all subsequent releases and
modifications until otherwise indicated in new editions.
This edition replaces SC27-2339-06.
© Copyright IBM Corporation 2005, 2012.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Tables . . . . . . . . . . . . . . . v commit . . . . . . . . . . . . . . . 31
deactzs . . . . . . . . . . . . . . . 31
Preface . . . . . . . . . . . . . . vii encrypt . . . . . . . . . . . . . . . 32
getdscfg . . . . . . . . . . . . . . 32
Who should read this guide . . . . . . . . . vii
getdslogopt . . . . . . . . . . . . . 34
Publications . . . . . . . . . . . . . . vii
getrpt . . . . . . . . . . . . . . . 34
Accessing publications online . . . . . . . vii
lsarray . . . . . . . . . . . . . . . 36
IBM Redbooks . . . . . . . . . . . . ix
lsbackenddisktypes . . . . . . . . . . . 39
Translation . . . . . . . . . . . . . . ix
lsbackendraidtypes . . . . . . . . . . . 40
Ordering publications . . . . . . . . . . ix
lsbackendtypes . . . . . . . . . . . . 42
Providing feedback about publications. . . . . x
lscluster . . . . . . . . . . . . . . 43
Contacting the IBM Support Center. . . . . . . x
lscomp . . . . . . . . . . . . . . . 45
Reporting a problem. . . . . . . . . . . . x
lscounters . . . . . . . . . . . . . . 46
lsdev . . . . . . . . . . . . . . . 48
Command-line interface . . . . . . . . 1 lsdevp . . . . . . . . . . . . . . . 50
CLI requirements . . . . . . . . . . . . . 1 lsdisk . . . . . . . . . . . . . . . 52
Command modes. . . . . . . . . . . . . 1 lsexport. . . . . . . . . . . . . . . 53
Conventions used in this guide . . . . . . . . 2 lsextent . . . . . . . . . . . . . . . 55
Syntax diagram conventions . . . . . . . . 2 lsfcpath. . . . . . . . . . . . . . . 57
Common agent commands . . . . . . . . . 4 lsfs . . . . . . . . . . . . . . . . 58
agentcli deployer install . . . . . . . . . 4 lsfset . . . . . . . . . . . . . . . 60
agentcli deployer list bundles . . . . . . . . 4 lshtype . . . . . . . . . . . . . . . 62
agentcli deployer list bundles state . . . . . . 5 lsmetrics . . . . . . . . . . . . . . 63
agentcli deployer list services . . . . . . . . 5 lsnode . . . . . . . . . . . . . . . 65
agentcli deployer list services inuse . . . . . . 5 lsnsd . . . . . . . . . . . . . . . 67
agentcli deployer refresh . . . . . . . . . 6 lspool . . . . . . . . . . . . . . . 69
agentcli deployer start . . . . . . . . . . 6 lsport . . . . . . . . . . . . . . . 71
agentcli deployer state . . . . . . . . . . 6 lsquota . . . . . . . . . . . . . . . 72
agentcli deployer stop . . . . . . . . . . 7 lssrg . . . . . . . . . . . . . . . . 75
agentcli deployer uninstall . . . . . . . . . 7 lssrgmembers. . . . . . . . . . . . . 76
agentcli deployer update . . . . . . . . . 7 lssvr . . . . . . . . . . . . . . . . 77
agentcli TPCData stop . . . . . . . . . . 8 lssvrdisk . . . . . . . . . . . . . . 78
agentcli TPCFabric ConfigService lsswitch . . . . . . . . . . . . . . 80
setauthenticationpw . . . . . . . . . . . 8 lstapedrive . . . . . . . . . . . . . 81
agentcli TPCFabric help. . . . . . . . . . 9 lstapelib . . . . . . . . . . . . . . 82
agentcli TPCFabric log get . . . . . . . . . 9 lstapemc . . . . . . . . . . . . . . 83
agentcli TPCFabric log set . . . . . . . . 10 lstime . . . . . . . . . . . . . . . 84
agentcli TPCFabric ServiceManager get status . . 11 lstype . . . . . . . . . . . . . . . 85
agentcli TPCFabric ConfigService lsvmdisk . . . . . . . . . . . . . . 86
setauthenticationpw . . . . . . . . . . 11 lsvol . . . . . . . . . . . . . . . . 87
agentcli TPCFabric help . . . . . . . . . 11 lszone . . . . . . . . . . . . . . . 89
agentcli TPCFabric log get . . . . . . . . 12 lszs . . . . . . . . . . . . . . . . 90
agentcli TPCFabric log set . . . . . . . . 13 mksrg . . . . . . . . . . . . . . . 92
agentcli TPCFabric ServiceManager get status . . 13 mkvol . . . . . . . . . . . . . . . 93
Bundle states . . . . . . . . . . . . . 14 mkzone. . . . . . . . . . . . . . . 95
tpctool command . . . . . . . . . . . . 14 mkzs . . . . . . . . . . . . . . . 96
actzs. . . . . . . . . . . . . . . . 17 modifysrg . . . . . . . . . . . . . . 97
addza . . . . . . . . . . . . . . . 18 rmbackenddisktype. . . . . . . . . . . 99
addzaports . . . . . . . . . . . . . 19 rmbackendraidtype . . . . . . . . . . 100
addzone . . . . . . . . . . . . . . 20 rmbackendtype . . . . . . . . . . . . 102
addzoneports . . . . . . . . . . . . . 21 rmsrg . . . . . . . . . . . . . . . 103
assignvol . . . . . . . . . . . . . . 22 rmvol . . . . . . . . . . . . . . . 104
autosetarray . . . . . . . . . . . . . 23 rmza . . . . . . . . . . . . . . . 106
catdscfg . . . . . . . . . . . . . . 28 rmzaports . . . . . . . . . . . . . 106
ckzone . . . . . . . . . . . . . . . 29 rmzone . . . . . . . . . . . . . . 107
ckzs . . . . . . . . . . . . . . . . 30 rmzoneports. . . . . . . . . . . . . 108

© Copyright IBM Corp. 2005, 2012 iii

rmzs . . . . . . . . . . . . . . . 109 Appendix A. Accessibility features for
rollback . . . . . . . . . . . . . . 110 Tivoli Storage Productivity Center . . 269
setarray . . . . . . . . . . . . . . 111
setbackenddisktype . . . . . . . . . . 113
setbackendraidtype . . . . . . . . . . 115
Appendix B. Accessibility features for
setbackendtype . . . . . . . . . . . . 117 Tivoli Storage Productivity Center for
setdscfg . . . . . . . . . . . . . . 120 Replication . . . . . . . . . . . . 271
setdslogopt . . . . . . . . . . . . . 121
start . . . . . . . . . . . . . . . 122 Notices . . . . . . . . . . . . . . 275
unassignvol . . . . . . . . . . . . . 122 Trademarks . . . . . . . . . . . . . . 276
updatesrg . . . . . . . . . . . . . 124 Terms and conditions. . . . . . . . . . . 277
csmcli command . . . . . . . . . . . . 125
Command-line interface conventions . . . . 127
Glossary . . . . . . . . . . . . . 279
Customizing the command-line interface . . . 137
csmcli command descriptions . . . . . . . 138
Command aliases . . . . . . . . . . . . 266 Index . . . . . . . . . . . . . . . 285
Parameter aliases . . . . . . . . . . . . 267

iv IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Tables
1. Locations of publications for Tivoli Storage 2. Bundle states . . . . . . . . . . . . 14
Productivity Center and related products . . viii 3. Exit codes for CLI commands . . . . . . 134

© Copyright IBM Corp. 2005, 2012 v

vi IBM Tivoli Storage Productivity Center: Command-Line Interface Reference
Preface
IBM® Tivoli® Storage Productivity Center is a storage infrastructure management
software product that can centralize, automate, and simplify the management of
complex and heterogeneous storage environments.

Who should read this guide

This publication is intended for administrators or users who use the IBM
command-line interface (CLI). It contains reference information for the commands
associated with IBM Tivoli Storage Productivity Center.

Users of this guide should be familiar with the following topics:

v General procedures for installing software on Microsoft Windows, IBM AIX®,
Linux, HP-UX, and Solaris.
v Storage Area Network (SAN) concepts
v IBM Tivoli Storage Productivity Center concepts
v IBM Tivoli Storage Productivity Center for Replication concepts
v IBM DB2® Database for Linux, UNIX, and Windows
v Simple Network Management Protocol (SNMP) concepts
v IBM Tivoli Enterprise Console

Publications
This section lists publications in the IBM Tivoli Storage Productivity Center library
and other related publications. It also describes how to access publications online,
how to order publications, and how to submit comments on publications.

The publications are available from the IBM Publications Center at

http://www.ibm.com/e-business/linkweb/publications/servlet/pbi.wss.

Accessing publications online

Publications for this product and other related products are available online.

Information about installing, configuring, upgrading, and uninstalling IBM Tivoli

Storage Productivity Center and related products is available online. Use Table 1 on
page viii to view and download these publications. Translated documents are
available for some products.

© Copyright IBM Corp. 2005, 2012 vii

Table 1. Locations of publications for Tivoli Storage Productivity Center and related products
Product Online location (see Note)
IBM Tivoli Storage http://publib.boulder.ibm.com/infocenter/tivihelp/v4r1/
Productivity Center index.jsp. In the left navigation pane, click IBM Tivoli
and Storage Productivity Center.
IBM Tivoli Storage
Productivity Center for To obtain PDF documents, click IBM Tivoli Storage
Replication Productivity Center > Printable documentation.

To view previous versions of the IBM Tivoli Storage

Productivity Center Information Center, in the left
navigation pane click Previous Versions and click the
version that you want to view (for example, 4.1.1, 4.1, or
3.4.1).
IBM Tivoli Storage http://publib.boulder.ibm.com/infocenter/tivihelp/v4r1/
Productivity Center for index.jsp. In the left navigation pane, click IBM Tivoli
Replication for System z® Storage Productivity Center for Replication for System z.

To obtain PDF documents, click IBM Tivoli Storage

Productivity Center for Replication for System z >
Printable documentation.

To view previous versions of the IBM Tivoli Storage

Productivity Center for Replication Information Center, in
the left navigation pane click Previous Versions and click
the version that you want to view (for example, 4.1.1, 4.1,
or 3.4.1).
IBM WebSphere® Application http://publib.boulder.ibm.com/infocenter/wasinfo/v6r1/
Server index.jsp
IBM System Storage® http://publib.boulder.ibm.com/infocenter/tivihelp/v4r1/
Productivity Center index.jsp. In the left navigation pane, click System Storage
Productivity Center.

To obtain PDF documents, click System Storage

Productivity Center > Printable documentation.

To view previous versions of the IBM System Storage

Productivity Center Information Center, in the left
navigation pane, click Previous Versions and click the
version that you want to view (for example, 1.3.2, 1.3.1, or
1.3).
IBM System Storage DS3000, http://www.ibm.com/support/entry/portal/
IBM System Storage DS4000®,
or IBM System Storage
DS5000
IBM System Storage DS6000™ http://publib.boulder.ibm.com/infocenter/dsichelp/
ds6000ic/index.jsp
IBM System Storage DS8000® http://publib.boulder.ibm.com/infocenter/dsichelp/
ds8000ic/index.jsp
IBM System Storage DS® http://www.ibm.com/support/entry/portal/
Open Application Troubleshooting/Hardware/System_Storage/
Programming Interface Storage_software/Other_software_products/
publications CIM_Agent_for_DS_Open_(API)/

Use these publications for information about how to install,

configure, and use the CIM agent.

viii IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Table 1. Locations of publications for Tivoli Storage Productivity Center and related
products (continued)
Product Online location (see Note)
IBM System Storage SAN http://publib.boulder.ibm.com/infocenter/svc/ic/index.jsp
Volume Controller
IBM Storwize® V7000 http://publib.boulder.ibm.com/infocenter/storwize/ic/
index.jsp
IBM Storwize V7000 Unified http://publib.boulder.ibm.com/infocenter/storwize/
unified_ic/index.jsp
IBM XIV® Storage System http://publib.boulder.ibm.com/infocenter/ibmxiv/r2/
index.jsp
IBM DB2 Database for Linux, http://publib.boulder.ibm.com/infocenter/db2luw/v9r7/
UNIX, and Windows index.jsp
IBM System Storage N series http://www.ibm.com/systems/storage/network/
redbooks.html

For more information about IBM System Storage N series,

see http://www.ibm.com/systems/storage/network/
software/.
Note: If you print PDF documents on other than letter-sized paper, in the Print window
select Fit to Printable Area in the Page Scaling field. This option is available when you
click File > Print. Fit to Printable Area ensures that the full dimensions of a letter-sized
page print on the paper that you are using.

IBM Redbooks
The IBM Redbooks® are books on specialized topics.

You can order publications through your IBM representative or the IBM branch
office serving your locality. You can also search for and order books of interest to
you by visiting the IBM Redbooks home page at http://www.redbooks.ibm.com/
redbooks.

Translation
Translated publications are available from the information center which is available
in certain translated languages. It is displayed in the language that is appropriate
for the browser locale setting.

When a locale does not have a translated version, the information center is
displayed in English, which is the default language. Translations of the PDFs are
available when the information center is translated.

Contact your service representative for more information about the translated
publications and whether translations are available in your language.

Ordering publications
Information is provided for the ordering of IBM publications on the Internet or by
telephone.

You can order many IBM publications online at http://www.ibm.com/e-business/

linkweb/publications/servlet/pbi.wss.

Preface ix
You can also order by telephone. In the United States and Canada, call
800-879-2755. In other countries, contact your IBM service representative.

Providing feedback about publications

Your feedback is important to help IBM provide the highest quality information.
You can provide comments or suggestions about the documentation from the IBM
Tivoli Storage Productivity Center Information Center.

Go to the information center at http://publib.boulder.ibm.com/infocenter/

tivihelp/v4r1/index.jsp and click the Feedback link at the bottom of the
information center Welcome page or topic pages.

Contacting the IBM Support Center

You can find support information for IBM products from various sources.

For support for IBM Tivoli Storage Productivity Center, you can contact the IBM
Support Center in one of the following ways:
v Go to the IBM Tivoli Storage Productivity Center technical support website at
http://www.ibm.com/support/entry/portal/Overview/Software/Tivoli/
Tivoli_Storage_Productivity_Center_Standard_Edition.
To receive future support notifications, sign in under Notifications. You are
required to enter your IBM ID and password. After you are authenticated, you
can configure your subscription for Tivoli Storage Productivity Center technical
support website updates.
v Customers in the United States can call 1-800-IBM-SERV (1-800-426-7378).
v For international customers, go to the Tivoli Storage Productivity Center
technical support website for customer support telephone numbers.

You can also review the IBM Software Support Handbook, which is available on our
website at http://www14.software.ibm.com/webapp/set2/sas/f/handbook/
home.html.

The support website offers extensive information, including a guide to support

services; frequently asked questions (FAQs); and documentation for all IBM
Software products, including Redbooks and white papers. Translated documents
are also available for some products.

When you contact the IBM Support Center, be prepared to provide identification
information for your company so that support personnel can readily assist you.
Company identification information might also be needed to access various online
services available on the website. See “Reporting a problem.”

Reporting a problem
This topic provides a list of what information you should have ready when you
encounter a problem.

Have the following information ready when you report a problem:

v The IBM Tivoli Storage Productivity Center version, release, modification, and
service level number.
v The communication protocol (for example, TCP/IP), version, and release number
that you are using.

x IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

v The activity that you were doing when the problem occurred, listing the steps
that you followed before the problem occurred.
v The exact text of any error messages.

Preface xi
xii IBM Tivoli Storage Productivity Center: Command-Line Interface Reference
Command-line interface
This section describes the IBM Tivoli Storage Productivity Center command-line
interface (CLI).

This section includes the following topics:

v CLI requirements
v Command modes
v Syntax diagram conventions
v agentcli commands
v tpctool commands
v Command aliases
v Parameter aliases

CLI requirements
Verify the requirements for running the command-line interpreter and using the
command-line interface.
v Verify that the installer checks for and installs the correct version of Java, and
configures the CLI to use the installed Java.
v Verify that IBM Tivoli Storage Productivity Center is installed and running, and
that storage devices have been discovered.
v Verify that the CLI is connected to an IBM Tivoli Storage Productivity Center
Device server before using all commands. The encrypt command is the only
exception that does not require the connection.
v Verify that you have a valid user ID, password, and URL before using all
commands, except for the encrypt command.
.

Command modes
You can use the CLI to run one command or a series of commands, either
interactively or from a script.
Single-shot mode
To run a single command, specify the CLI program and that command at
the shell prompt, for example:
shell> tpctool lsdev -user me -password mypass -url myhost:myport -l -subsys
Interactive mode
Interactive mode is entered by entering the tpctool command with no
command line options. In the following example, the string "shell>"
represents the shell prompt and "tpctool>" represents the prompt from the
CLI while in interactive mode. At the CLI prompt, any valid CLI command
can be entered.
shell> tpctool
tpctool> lsdev -user me -password mypass -url myhost:myport -l -subsys
Script mode
To run a set of commands that you defined in a file, start the CLI program
and specify a file that contains the commands, for example:

© Copyright IBM Corp. 2005, 2012 1

shell> tpctool –script ~/bin/containersetup
shell>

Conventions used in this guide

This section provides information about the conventions used in this publication.

This publication uses several conventions for special terms and actions, and
operating system-dependent commands and paths.

The following typeface conventions are used in this publication:

Bold
v Lower-case and mixed-case commands that appear with text
v Command options that appear with text
v Flags that appear with text
v Graphical user interface (GUI) elements (except for titles of windows
and dialogs)
v Names of keys
Italic
v Variables
v Values you must provide
v New terms
v Words and phrases that are emphasized
v Titles of documents
monospace
v Commands and command options in examples
v Flags that appear on a separate line
v Code examples and output
v Message text
v Names of files and directories
v Text strings you must type, when they appear within text
v Names of Java methods and classes
v HTML and XML tags also appear like this, in monospace type

For syntax notation, these conventions are used:

v # is the prompt for the root user on UNIX platforms.
v Uppercase and lowercase characters do matter for UNIX and Linux. Type in
commands exactly as shown.

Syntax diagram conventions

A syntax diagram uses symbols to represent the elements of a command and to
specify the rules for using these elements.

Syntax diagrams use position to indicate required, optional, and default values for
keywords, variables, and operands.

A key word represents the name of a command, flag, parameter, or argument.

Required key words Indicate the parameters or arguments that must be specified
for the command.

2 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

To read syntax diagrams, follow the path of the line. Read the diagrams from
left-to-right, top-to-bottom, following the main path line.

Main path line

The main path line begins on the left with double arrowheads (>>) and ends on
the right with two arrowheads facing each other (><). If a diagram is longer than
one line, each line to be continued ends with a single arrowhead (>) and the next
line begins with a single arrowhead. The -->< symbol indicates the end of the
syntax diagram.

Required keywords

Required keywords appear on the main path line. Mutually exclusive required
keywords are stacked vertically. In the following example, you must choose A, B,
and C.

A B C

Optional keywords

Optional keywords indicate parameters or arguments that you might choose to

specify for the command. Optional keywords appear below the main path line.
Mutually exclusive optional keywords are stacked vertically. In the following
example, you must choose A, B, or C.

A
B
C

When an optional item appears above the main line, the item above the line is the
default value when no optional item is specified in the command. In the following
example, the user has the same choices as above (A, B, C, or nothing at all), but if
nothing is selected, the default value will be A.

A

B
C

Repeatable items

A stack of items followed by an arrow returning to the left means that you can
select more than one item or, in some cases, repeat a single item. For example:

An arrow returning to the left means you can repeat the item.

repeat

Command-line interface 3
If one or more characters appear in the arrow's line, those characters are required
as a delimiter to separate repeated items.

repeat

If you can choose from two or more items, they are displayed vertically in a stack.
A stack of items followed by an arrow returning to the left means that you can
select more than one item or, in some cases, repeat a single item. In the following
example, you can choose any combination of A, B, or C.

A
B
C

Variables

Italicized, lowercase elements denote variables. In the following example, you must
specify a variable value when you enter the keyword command:

keyword variable

Common agent commands

The agentcli command is the command line interface into the Common agent.

agentcli deployer install

Use the agentcli deployer install command to install a bundle from the specified
URL. The specified URL becomes the bundle location for the installed bundle.

Syntax
agentcli deployer install url

Parameters
url
The specified URL becomes the bundle location for the installed bundle.

Examples
agentcli deployer install url

agentcli deployer list bundles

Use the agentcli deployer list bundles command to list all installed bundles.

Syntax

4 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

agentcli deployer list bundles

Examples
agentcli deployer list bundles

agentcli deployer list bundles state

Use the agentcli deployer list bundles state command to return a list all installed
bundles and their states.

See “Bundle states” on page 14 for descriptions of the states.

Syntax
agentcli deployer list bundles state

Examples
agentcli deployer list bundles state

agentcli deployer list services

Use the agentcli deployer list services command to list either all registered
services or a single registered service for the specified bundle.

Syntax
agentcli deployer list services
bundle_location

Parameters
bundle_location
The URL that was used to install the bundle. To determine this value run the
agentcli deployer list bundles command. In addition to the URL, you can
specify the bundle location for the Data bundle as "TPCData" and for the
Fabric bundle as "TPCFabric".

Examples
agentcli deployer list services

agentcli deployer list services url

agentcli deployer list services inuse

Use the agentcli deployer list services inuse command to list services used by a
specified bundle.

Syntax
agentcli deployer list services inuse bundle_location

Command-line interface 5
Parameters
bundle_location
The URL that was used to install the bundle. To determine this value, run the
agentcli deployer list bundles command. In addition to the URL, you can
specify the bundle location for the Data bundle as "TPCData" and for the
Fabric bundle as "TPCFabric".

Examples
agentcli deployer list services inuse url

agentcli deployer refresh

Use the agentcli deployer refresh command to refresh bundle dependencies and
attempt garbage collection.

Syntax
agentcli deployer refresh

Examples
agentcli deployer refresh

agentcli deployer start

Use the agentcli deployer start command to start the specified bundle.

Syntax
agentcli deployer start bundle_location

Parameters
bundle_location
The URL that was used to install the bundle. To determine this value, run the
agentcli deployer list bundles command. In addition to the URL, you can
specify the bundle location for the Data bundle as "TPCData" and for the
Fabric bundle as "TPCFabric".

Examples
agentcli deployer start url

agentcli deployer state

Use the agentcli deployer state command to return the state of the specified
bundle.

See “Bundle states” on page 14 for descriptions of the states.

Syntax
agentcli deployer state bundle_location

6 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Examples
agentcli deployer list bundles state url

agentcli deployer stop

Use the agentcli deployer stop command to stop the specified bundle.

Syntax
agentcli deployer update bundle_location

Examples
agentcli deployer stop url

agentcli deployer uninstall

Use the agentcli deployer uninstall command to uninstall the specified bundle.

Syntax
agentcli deployer uninstall bundle_location

Examples
agentcli deployer uninstall url

agentcli deployer update

Use the agentcli deployer update command to update the specified bundle.

Syntax

Command-line interface 7
agentcli deployer update bundle_location

Examples
agentcli deployer update url

agentcli TPCData stop

Use the agentcli TPCData stop command to stop with the specified mode, which
is either abort or normal.

Format
agentcli TPCData stop abort
normal

Parameters
abort
Stops the Data agent immediately.
normal
Stops the Data agent after the current operation completes.

Examples
agentcli TPCData stop normal

agentcli TPCData stop abort

agentcli TPCFabric ConfigService setauthenticationpw

Use the agentcli TPCFabric ConfigService setauthenticationpw command to
change the host authentication password for the managed hosts. The host
authentication password is created when Fabric Manager is installed.

Format

agentcli TPCFabric ConfigService setAuthenticationPw new_host_password

Parameters
new_host_password
This changes the host authentication password that was created when Fabric
Manager was installed.

8 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Examples

Change the host authentication password to hostpass2.

Command: agentcli TPCFabric ConfigService setauthenticationpw hostpass2

agentcli TPCFabric help

Use the agentcli TPCFabric help command to return a list of Fabric services that
you can invoke commands on and can also provide help for specific Fabric
services.

Format
agentcli TPCFabric help
service_name

Parameters
service_name
A valid Fabric service name, such as ConfigService.

Examples

Display help for the ConfigService.

Command:
agentcli TPCFabric help ConfigService

agentcli TPCFabric log get

Use the agentcli TPCFabric log get command to display the current properties of
the message log file. If you do not specify a parameter for this command, a syntax
error message is displayed.

Format
agentcli TPCFabric log get -filterkey
-maxfiles
-maxfilesize
-format
-locale

Parameters
-filterkey
Displays the current types of messages that are logged in the message log file.
-maxfiles
Displays the current maximum number of log files to be created.
-maxfilesize
Displays the current maximum file size (in kilobytes) of the log before a new
log file is created.
-format
Displays the current format in which messages are saved in the message log
file. Messages can be saved in either plain text or XML format.
Command-line interface 9
-locale
Displays the current language locale setting in which messages are displayed
in the message log file.

Examples

Display the current types of messages that are logged in the message log file.

Command:
agentcli TPCFabric log get -filterkey

agentcli TPCFabric log set

Use the agentcli TPCFabric log set command to define the properties of the
message log file. If you do not specify a parameter for this command, a syntax
error message is displayed.

Format
agentcli TPCFabric log set –defaults
–filterkey INFO
ERROR
WARN
–maxfiles max_files
–maxfilesize max_file_size
–format plain_text
pdxml

Parameters
-defaults
Resets all the logging settings to their default settings.
-filterkey {INFO|ERROR|WARN}
Specifies the types of messages that will be logged in the message log file.
These values are case sensitive. The types are as follows:
INFO Displays informational, warning, and error messages.
ERROR
Displays error messages.
WARN
Displays warning and error messages.
-maxfiles max_files
Sets the maximum number of log files to be created. You should specify more
than one log file to be created if you want to save older log entries. If you
specify only one log file, and that log file becomes full, the old entries in the
log file are deleted, and new entries are added.
-maxfilesize max_file_size
Sets the maximum file size (in kilobytes) of the log before a new log file is
created.
-format {plain_text|pdxml}
The values are as follows:
plain_text
The messages are saved in plain text format.

10 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

pdxml The messages are saved in XML format.

Examples

Reset the message flags to their default settings

agentcli TPCFabric log set -defaults

agentcli TPCFabric ServiceManager get status

Use the agentcli TPCFabric ServiceManager get status to return a list of Agent
Manager services and their status.

Format
agentcli TPCFabric ServiceManager get status

Parameters

None

Examples

Command: agentcli TPCFabric ServiceManager get status

agentcli TPCFabric ConfigService setauthenticationpw

Format

agentcli TPCFabric ConfigService setAuthenticationPw new_host_password

Parameters
new_host_password
This changes the host authentication password that was created when Fabric
Manager was installed.

Examples

Change the host authentication password to hostpass2.

Command: agentcli TPCFabric ConfigService setauthenticationpw hostpass2

agentcli TPCFabric help

Use the agentcli TPCFabric help command to return a list of Fabric services that
you can invoke commands on and can also provide help for specific Fabric
services.

Format

Command-line interface 11
agentcli TPCFabric help
service_name

Parameters
service_name
A valid Fabric service name, such as ConfigService.

Examples

Display help for the ConfigService.

Command:
agentcli TPCFabric help ConfigService

agentcli TPCFabric log get

Use the agentcli TPCFabric log get command to display the current properties of
the message log file. If you do not specify a parameter for this command, a syntax
error message is displayed.

Format
agentcli TPCFabric log get -filterkey
-maxfiles
-maxfilesize
-format
-locale

Parameters
-filterkey
Displays the current types of messages that are logged in the message log file.
-maxfiles
Displays the current maximum number of log files to be created.
-maxfilesize
Displays the current maximum file size (in kilobytes) of the log before a new
log file is created.
-format
Displays the current format in which messages are saved in the message log
file. Messages can be saved in either plain text or XML format.
-locale
Displays the current language locale setting in which messages are displayed
in the message log file.

Examples

Display the current types of messages that are logged in the message log file.

Command:
agentcli TPCFabric log get -filterkey

12 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

agentcli TPCFabric log set
Use the agentcli TPCFabric log set command to define the properties of the
message log file. If you do not specify a parameter for this command, a syntax
error message is displayed.

Format
agentcli TPCFabric log set –defaults
–filterkey INFO
ERROR
WARN
–maxfiles max_files
–maxfilesize max_file_size
–format plain_text
pdxml

Examples

Reset the message flags to their default settings

agentcli TPCFabric log set -defaults

agentcli TPCFabric ServiceManager get status

Use the agentcli TPCFabric ServiceManager get status to return a list of Agent
Manager services and their status.

Command-line interface 13
Format
agentcli TPCFabric ServiceManager get status

Parameters

None

Examples

Command: agentcli TPCFabric ServiceManager get status

Bundle states
The state of a bundle is returned by the "agentcli deployer list bundles state"
command and the "agentcli deployer state" command.

See “agentcli deployer list bundles state” on page 5 and “agentcli deployer state”
on page 6 for more information.
Table 2. Bundle states
State Description
Installed The bundle is installed but not resolved, and it cannot run. This state is visible if the code
dependencies of the bundle are not resolved. The Framework might attempt to resolve the code
dependencies and move the bundle to the Resolved state.
Resolved The code dependencies of the bundle are resolved and the bundle can be started. These
dependencies include:
v The class path of the bundle from its Constants.BUNDLE_CLASSPATH Manifest header.
v The package dependencies of the bundle from its Constants.EXPORT_PACKAGE and
Constants.IMPORT_PACKAGE Manifest headers.
v The required bundle dependencies of the bundle from its Constants.REQUIRE_BUNDLE
Manifest header.
v The host dependency of a fragment bundle from its Constants.FRAGMENT_HOST Manifest
header.
The bundle is not active yet and must be put in the Resolved state before it can be started. The
Framework might attempt to resolve a bundle at any time.
Starting The start() method is active and the bundle is starting. A bundle must be in this state when the
bundle's BundleActivator.start(org.osgi.framework.BundleContext) is called. If this method
completes without exception, then the bundle has started and must move to the Active state.
Stopping The stop() method is active and the bundle is stopping. A bundle must be in this state when the
bundle's BundleActivator.stop(org.osgi.framework.BundleContext) method is called. When this
method completes the bundle is stopped and must move to the Resolved state.
Active The bundle has been successfully started and is running.

tpctool command
The tpctool command is the Tivoli Storage Productivity Center command line
interpreter (CLI) program. The command can be used either on its own, using the
associated options and arguments, or interactively by invoking tpctool with no
options or arguments to start an interactive session.

Syntax

14 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

tpctool command connection-options formatting-options command-options

command-arguments

Parameters
command
Either one of the commands (generic, disk, fabric, or reporting) or a command
alias.
connection-options
Options used to connect to Tivoli Storage Productivity Center. These options
include:
v -user
v -pwd
v -url
These options are described in detail below.
formatting-options
Options used to format output for some of the commands.
command-options
Options associated with commands that define command behavior.
command-arguments
Generally, values used to define command options. They can be defined as lists
of string values separated by commas or spaces.

The following arguments and options are valid for tpctool:

Command aliasing

Tivoli Storage Productivity Center provides the capability for command aliasing
using the command configuration file. The default configuration file is c:\program
files\ibm\tpc\cli\libs\tpccli.conf. With aliasing, you define a name for the alias
followed by a value that is the name of a command and any options associated
with command. The aliased command string is replaced by the defined value and
the entire line is reparsed. Passwords used in aliased commands must first be
encrypted using the encrypt command.

For example, to shorten a frequently used command you can define the following
alias:

Command-line interface 15
tpctool>lsperf = lsdev -user dsadmin
-pwd 1ac75d82784ce0a327d45289604ae7b227
-url 9.44.33.126:8990 -fabric -perf

After the alias is defined, you can run the lsperf command to run the aliased lsdev
command shown above.

You can provide a short form command targeting different device servers, as
follows:
tpctool>lsperfd1 = lsdev -user dsadmin
-pwd 1ac75d82784ce0a327d45289604ae7b227
-url hostOne:9161 -perf

tpctool>lsperfd2 = lsdev -user dsadmin

-pwd 1ac75d82784ce0a327d45289604ae7b227
-url hostTwo:9161 -perf

You can specify additional options and arguments for an aliased command:
tpctool>lsperfd2 -fabric -ctype port

Which would expand to:

tpctool>lsdev -user dsadmin
-pwd 1ac75d82784ce0a327d45289604ae7b227
-url hostTwo:9161
-perf -fabric -ctype port

You can also nest aliases:

tpctool>lsperf = lsdev -user dsadmin
-pwd 1ac75d82784ce0a327d45289604ae7b227
-url hostTwo:9161 -perf -fabric

tpctool>lsperfd1 = lsdev -user dsadmin

-pwd 1ac75d82784ce0a327d45289604ae7b227
-url hostOne:9161

tpctool>lsperfd2 = lsdev -user dsadmin

-pwd 1ac75d82784ce0a327d45289604ae7b227
-url hostTwo:9161

To unset an alias, type the name of the command alias followed by the '=' sign:
lsperf =

When you use an alias with a key and value pair in the tpccli.conf file, note that
there is special handling of the value part for back slashes. You must specify four
back slashes for each back slash.

For example, this value:

ABCDE1 = CLARiiON\+ABC01234567890+0

Should be specified as:

ABCDE1 = CLARiiON\\\\+ABC01234567890+0

Examples

To start an interactive session for Tivoli Storage Productivity Center:

The following command starts an interactive session. After the session starts, you
can use other CLI commands in the session:

16 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

tpctool

To start an interactive session with credentials:

The following command starts an interactive session and specifies the user ID,
password, and destination:
tpctool -user adminpass
-pwd adminpw1
-url 9.43.124.255:8080

Return codes

The following table contains the codes returned by the tpctool command.

Code Description
0 The command completed successfully.
1 The command was unknown to tpctool and
was not resolved as an alias.
2 A required option was not provided.
3 An option was unknown to tpctool or was
not applicable to the command.
4 An option was missing a required
parameter.
5 The format of a parameter for the option
was not valid.
6 The format of an argument was not valid.
7 An extraneous argument or argument list
was provided.
8 The tpctool client could not connect with the
Device server.
9 The tpctool client could not log in to the
Device server using the specified credentials.
10 The specified credentials are not authorized
to perform the requested action.
11 A required component (such as Disk
Manager or Fabric Manager) is not installed
and enabled.
12 The command might have started, but the
connection with the Device server was lost.
The command might not be completed
successfully.
13 Some operations were completed partially
before the Device server returned a failure.
14 The command failed.

actzs
Use the actzs command to activate changes to the zone set in the fabric. This
command must be run within a transaction. You must have Fabric Administrator
authority to use this command.

Syntax

Command-line interface 17
tpctool actzs -user user -pwd password -url url -fabric WWN

zone_set
-help -silent

Parameters and arguments

Examples

Activating a zone set

The following commands activate the PARIS zone set:

tpctool> -user me -pwd mypass -url myhost:myport
tpctool> start -fabric 100000051E34F6A8
tpctool> actzs -fabric 100000051E34F6A8 PARIS
tpctool> commit -fabric 100000051E34F6A8

addza
Use the addza command to add a zone alias to a zone. You must have Fabric
administrator authority to use this command.

Syntax
tpctool addza -user user -pwd password -url url -fabric WWN

-zone zone alias

-help -silent

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.

18 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-fabric WWN
Specifies the fabric. The WWN variable is the World Wide Name (WWN).
-help | -h | -?
Lists help information for the command.
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
-zone zone
Specifies the name of the zone where you want to add a zone alias.
alias
Specifies the name of the zone alias to be added to the zone.

Examples

Adding a zone alias

The following commands add the PARIS zone alias to the EUROPE zone:
tpctool -user me -pwd mypass -url myhost:myport
tpctool> start -fabric 100000051E34F6A8
tpctool> addza -fabric 100000051E34F6A8 -zone EUROPE PARIS
tpctool> commit -fabric 100000051E34F6A8

addzaports
Use the addzaports command to add ports to a zone alias. You must have Fabric
administrator authority to use this command.

Syntax
tpctool addzaports -user user -pwd password -url url -fabric WWN

-za zone_alias port

-help -silent

Parameters and arguments

Command-line interface 19
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
-za zone_alias
Specifies the name of the zone alias where the port is to be added.
port
Specifies the name of the port to be added to the zone alias.

Examples

Adding a port to a zone alias

The following commands add a port to the PARIS zone alias:

tpctool -user me -pwd mypass -url myhost:myport
tpctool> start -fabric 100000051E34F6A8
tpctool> addzaports -fabric 100000051E34F6A8 -za PARIS 210000E08B0B4C2G
tpctool> commit -fabric 100000051E34F6A8

addzone
Use the addzone command to add a zone to a zone set. This command must be
run as a transaction. See the start command for more information. You must have
Fabric Administrator authority to use this command.

Syntax
tpctool addzone -user user -pwd password -url url -fabric WWN

-zs zone_set zone

-help -silent

Parameters and arguments

20 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Examples

Adding a zone to a zone set

The following commands add the WINDOWSNT zone to the PARIS zone set:
tpctool> start -user me -pwd mypass -url myhost:myport -fabric 100000051E34F6A8
tpctool> addzone -fabric 100000051E34F6A8 -zs PARIS WINDOWSNT
tpctool> commit -fabric 100000051E34F6A8

addzoneports
Use the addzoneports command to add switch ports to a zone. This command
must be run as a transaction. You must have Fabric Administrator authority to use
this command.

Syntax
tpctool addzoneports -user user -pwd password -url url -fabric WWN

-zone zone ports

-help -silent -

Parameters and arguments

Examples

Adding a switch port to a zone set

The following commands add several switch ports to the WINDOWSNT zone. The
list of WWPNs is read from standard input:

Command-line interface 21
tpctool> start -user me -pwd mypass -url myhost:myport -fabric 100000051E34F6A8
tpctool> addzoneports -fabric 100000051E34F6A8 -zone WINDOWSNT -
tpctool> commit -fabric 100000051E34F6A8

assignvol
Use the assignvol command to assign host ports to volumes. You must have Disk
Administrator authority to use this command.

Syntax
tpctool assignvol -user user -pwd password -url url -dev subsystem

-hp host_port
-hn host_name -ht host_type -lun LUN_ID

-sp subsystem_port -fs character -header -help

volume id
-qs character -silent -

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-dev subsystem
Specifies the globally unique identifier (GUID) of a storage subsystem such as
that obtained by running the lsdev -subsys command.
-hp host_port
Specifies the host ports. The host_port variable is a comma-separated list of
worldwide port numbers (WWPNs), such as that obtained by running the
lsport command.
-hn host_name
Specifies the names of the host machines for the ports. The host_name variable
is a comma-separated list of host machine names. There must be one name for
each port in the list of host ports.
-ht host_type
Specifies the type of host machine on which the fiber channel port is located.
The host_type variable is a comma-separated list of host machine types, such as
that obtained by running the lshtype command.
-lun LUN_ID
Specifies the logical-unit number (LUN ID) that the hosts map to the volumes.
The LUN_ID variable is a comma-separated list of LUN IDs. There must be
one LUN ID for each volume in the argument list.
-sp subsystem_ port
Specifies the worldwide port numbers (WWPNs) that the hosts use to access

22 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

the volume. The subsystem_port variable is a comma-separated list of WWPNs,
such as that obtained by running the lsdevp command. If you omit this
parameter, the default ports are used.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
volume id | -
Specifies the volumes. The volume_ID variable is a comma-separated list of
volume IDs, such as that obtained by running the lsvol command. If a single
dash (-) is issued, the volume IDs are read from standard input.

Examples

Assigning a host port to a volume

The following command assigns a host port to a volume:

tpctool assignvol -user me -pwd mypass -url myhost:myport -dev 2105.22232+0
-hp 5005076300C79470 -lun a3

autosetarray
Use the autosetarray command to extract and save information about storage
pools.

You can save information about a storage pool such as the type of back-end
storage system, type of RAID, and type of disk. To do this you use a default
pattern or create a pattern that matches the names of pools in a subsystem. If the
match is successful, the information about the pool is extracted and saved. This
command is available for Storwize V7000 and SAN Volume Controller storage
systems. You must have Disk Administrator authority to use this command.

Syntax
tpctool autosetarray -user user -pwd password -url url

-subsysid subsystem_id
-pattern conversion_pattern

-backenddiskcount disk_count -test -fs character

Command-line interface 23

-header -help -qs character -silent -grouping

Pool names and pattern matching

The names of pools must contain the following information:

v A character that represents a valid type of back-end storage system
v A number or character that represents a valid type of back-end RAID
v A series of characters that represent a valid type of back-end disk

Tip: To obtain a list of valid types of back-end storage system, types of disk, and
types of RAID, run the following commands: lsbackendtypes,
lsbackenddisktypes, and lsbackendraidtypes. If the types of back-end storage
system, types of disk, and types of RAID that are used in the pool names are not
listed, you can add them to the list. See the descriptions of the following
commands: setbackendtype, setbackenddisktype, and setbackendraidtype.

The default pattern is structured as shown in the following table.

Position in pattern Pattern

1 B
2 x
3 x
4 x
5 x
6 x
7 x
8 D
9 R
10 D
11 D
12 x*

You can use the default pattern or create patterns to match the names of pools in a
storage subsystem. A list of the characters that are used to create patterns are
provided in the following table.

Character Represents
B The character that is used to represent the type of back-end storage
system. The matching character:
v Must be in the position specified by the pattern
v Must be of the same length
v Must be a valid type of storage system
In the default pattern, one character is used to represent the type of
back-end storage system.
x The character that is used to represent insignificant characters. In the
default pattern, the second, third, fourth, fifth, sixth, and seventh
characters in a matching pool name are ignored.

24 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Character Represents
D The characters that are used to represent the type of back-end disk.
Matching characters:
v Must be in the position specified by the pattern
v Must be of the same length
v Must be a valid type of disk
In the default pattern, three characters are used to represent the type of
back-end disk.
R The number or character that is used to represent the type of back-end
RAID such as 1, or X. The matching character:
v Must be in the position specified by the pattern
v Must be of the same length
v Must be a valid type of RAID
In the default pattern, one character is used to represent the type of
back-end RAID.
x* The character followed by an asterisk that is used to represent zero or
any number of insignificant characters that occur at the end of a pool
name. In the default pattern, the 12th character and all subsequent
characters in a matching pool name are ignored.
C The characters that are used to represent the number of disks. In the
default pattern, the number of disks is not specified. To specify the
number of disks, use the -backenddiskcount parameter. The default
value is 1. You can create a custom pattern to extract the number of
disks value from the name of the MDisk group. Matching characters:
v Must be in the position specified by the pattern
v Must use numeric values such as 0 - 9
v Must be of the same length
– C represents 0 - 9
– CC represents 00 - 99

Sample: Using the default pattern

You issue the autosetarray command and the default pattern is used to extract
information about the pool CFG1xGGA1071. In the table, each character in the
default pattern is matched against the corresponding character in the pool name.

Default pattern Pool name Description

B C The type of back-end storage
system
x F The character is ignored
x G The character is ignored
x 1 The character is ignored
x x The character is ignored
x G The character is ignored
x G The character is ignored
D A The first character of three
characters that are used to
represent the type of
back-end disk

Command-line interface 25
Default pattern Pool name Description
R 1 The type of back-end RAID
D 0 The second character of three
characters that are used to
represent the type of in the
back-end disk
D 7 The third character of three
characters that are used to
represent the type of
back-end disk
x* 1 This character and all
subsequent characters are
ignored

The information about the pool is extracted and saved.

Information Extracted values Description

Type of back-end storage system C EMC Clariion
Type of back-end disk A07 SATA - 7,500 rpm
Type of back-end RAID 1 RAID 1
Number of disks 1 1

Parameters and arguments

26 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
-grouping
Enables the grouping of numeric values. For example, in English the value
12000 would display as 12,000. The grouping character is determined by the
system locale.

Examples

Using patterns to extract and save information about pools

The following command extracts information about pools in the specified storage
subsystem that match the default pattern. If a pool name does not match the
pattern, an information message is displayed.
tpctool> autosetarray -subsysid 00000200A0C0005C+0

The following information messages and output are displayed:

[AAJ002013E] The pool name mdiskgroup0 is too short to be matched
against the pattern BxxxxxxxDRDDx*.
[AAJ002013E] The pool name Cognos is too short to be matched
against the pattern BxxxxxxxDRDDx*.
[AAJ002013E] The pool name mdiskgrp1 is too short to be matched
against the pattern BxxxxxxxDRDDx*.
[AAJ002013E] The pool name mdiskgrp2 is too short to be matched
against the pattern BxxxxxxxDRDDx*.

Name of Array Back-end Type Back-end RAID Type Back-end Disk Type
=================================================================
mdiskgroup0 - - -
Cognos - - -
mdiskgrp1 - - -
mdiskgrp2 - - -
Cpool3GA60713 C 6 A07
Cpool2GA607 C 6 A07
Dpool1GA607F D 6 A07

Back-end Disk Count Status

==============================
- No Match
- No Match
- No Match
- No Match
1 Successful
1 Successful
1 Successful

Command-line interface 27
catdscfg
Use the catdscfg command to list the contents of the property files for the Device
server and to check the status of the Device server. You must have IBM Tivoli
Storage Productivity Center administrator authority to use this command.

Syntax
tpctool catdscfg -user user -pwd password -url url

-fs character -header -help -qs character

-silent

Parameters and arguments

Examples

Listing the contents of the property file

The following command lists the contents of the property file:

tpctool> catdscfg -url localhost:9550 -user ***** -pwd *****

The following output is returned:

Property Context Value
=======================================================================
AgentManager.Registration AM YES

28 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Fabric.Manager.Password AM *****
Fabric.Manager.Username AM manager
Registration.Server.Host AM tivoli12
Registration.Server.Port AM 9511
Registration.Server.PW AM *****
TPCData.Password AM *****
TPCData.UserName AM manager
default.authorization.enabled CIM true
default.credential CIM default
default.principal CIM default
FabricCIMTransactionTimeout CIM 600
FabricCIMZoneDBChecksumUsage CIM true
FabricCIMZSetActivationRetryInterval CIM 20000
FabricCIMZSetActivationRetryMaxCount CIM 9

Note: This is a partial sample of the actual output.

ckzone
Use the ckzone command to verify that a fabric contains a zone. You must have
Fabric Administrator authority to use this command.

Syntax
tpctool ckzone -user user -pwd password -url url -fabric WWN

zone
-help -silent

Parameters and arguments

Examples

Verifying that a fabric contains a zone

The following command checks whether the fabric contains the SUNSOLARIS
zone:

Command-line interface 29
tpctool> ckzone -user me -pwd mypass -url myhost:myport
-fabric 100000051E34F6A8 SUNSOLARIS

If the fabric contains the zone, the following text is returned:

Zone SUNSOLARIS found in fabric 100000051E34F6A8

ckzs
Use the ckzs command to verify that a fabric contains a zone set. You must have
Fabric Administrator authority to use this command.

Syntax
tpctool ckzs -user user -pwd password -url url -fabric WWN

zone_set
-help -silent

Parameters and arguments

Examples

Verifying that a fabric contains a zone set

The following command determines whether the fabric contains the PARIS zone
set:
tpctool> ckzs -user me -pwd mypass -url myhost:myport -fabric 100000051E34F6A8 PARIS

If the fabric contains the zone set, the following text is returned:
Zoneset PARIS found in fabric 100000051E34F6A8

30 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

commit
Use the commit command to commit a transaction. When you commit a
transaction, all the commands issued after you started the transaction are enacted.
You must have Fabric Administrator authority to use this command.

Syntax
tpctool commit -user user -pwd password -url url -fabric WWN

-help

Parameters and arguments

Examples

Committing a transaction

The following command commits a transaction. The user has previously specified
connection options, started a transaction, and issued a fabric-control command:
tpctool> commit -fabric 100000051E34F6A8

deactzs
Use the deactzs command to deactivate the active zone set. This command must be
run as a transaction. You must have Fabric Administrator authority to use this
command.

Syntax
tpctool deactzs -user user -pwd password -url url -fabric WWN

-help -silent

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.

Command-line interface 31
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-fabric WWN
Specifies the fabric. The WWN variable is the World Wide Name (WWN).
-help | -h | -?
Lists help information for the command.
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Examples

Deactivating the active zone set

The following commands deactivate the active zone set:

tpctool> start -user me -pwd mypass -url myhost:myport -fabric 100000051E34F6A8
tpctool> deactzs -fabric 100000051E34F6A8
tpctool> commit -fabric 100000051E34F6A8

encrypt
Use the encrypt command to generate an encrypted password for use in the
configuration file. This command takes text from standard input and generates
7-bit ASCII-equivalent characters (uuencode).

Syntax
tpctool encrypt password

password
Specifies the password to be encrypted.

Examples

Encrypting a password

The following command encrypts the specified password:

tpctool encrypt myverylongpassword

getdscfg
Use the getdscfg command to list the current value of a property from the
property file for the Device server. You must have IBM Tivoli Storage Productivity
Center administrator authority to use this command.

Syntax
tpctool getdscfg -user user -pwd password -url url

32 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-property property_key -context context -fs character

-header -help -qs character -silent

This parameter applies to the Tivoli Storage Productivity Center device server
only.
-context PerformanceManager

This parameter applies to the Tivoli Storage Productivity Center performance

manager only.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Examples

Listing a property value

The following command lists the value of the SnmpRetryCount property:

tpctool> getdscfg -url localhost:9550 -user ***** -pwd ***** -property
SnmpRetryCount -context DeviceServer

Command-line interface 33
The following output is returned:
Property Context Value
=================================
SnmpRetryCount DeviceServer 3

getdslogopt
Use the getdslogopt command to list the properties for the log file associated with
the Device server. You must have IBM Tivoli Storage Productivity Center
administrator authority to use this command.

Syntax
tpctool getdslogopt -user user -pwd password -url url
-help

-silent

Parameters and arguments

Examples

Listing log file properties

The following command lists the properties of the log file used by the Device
server:
tpctool> getdslogopt -user me -pwd mypass -url myhost:myport

The following output is returned:

Filterkey Maxfiles Maxfilesize Locale Format
================================================
INFO 10 20000 KB en_US plain_text

getrpt
Use the getrpt command to list a performance report for a specified storage
subsystem. You must have Fabric Operator or Disk Operator authority to use this
command.

Syntax
34 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference
tpctool getrpt -user user -pwd password -url url

-fabric fabric -columns column_list level sample

-subsys subsystem hourly
daily

-ctype comp_type -start date/time

-comps component_list

-duration duration_seconds
-fs character -header -help

-qs character -silent

-grouping -colname

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-fabric fabric
Specifies the name of a switch, such as one returned by the lsdev command.
-subsys subsystem
Specifies the name of a storage subsystem, such as one returned by lsdev. The
name of the storage subsystem is the globally unique identifier (GUID) of that
storage subsystem.
-columns column_list
Specifies what columns will appear in the report. The columns are obtained
from the lscounters and lsmetrics commands.
-level sample | hourly | daily
Specifies the level for which the performance metrics should be summarized.
You can specify a sample summary, an hourly summary, or a daily summary.
-ctype comp_type
Specifies that the output should include only components of the specified type.
See the lstype command for more information about the comp_type variable.
-comps component_list
Specifies the component list. The component_list variable specifies the
components, such as returned by lscomp.
-start date/time
Specifies the date and time to start the sampling period. The date and time are
formatted as:
yyyy.MM dd:HH:mm:ss

Command-line interface 35
All time zones are relative to the Device server. See the lstime command for
more information.
-duration duration_seconds
Specifies the duration of the sampling period, in seconds. The duration_seconds
variable is an integer.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
-grouping
Enables the grouping of numeric values. For example, in English the value
12000 would display as 12,000. The grouping character is determined by the
system locale.
-colname
Displays the name of the counter or metric in the column header. By default,
an integer indicating the column or metric type is displayed in the column
header.

Examples

Listing performance metrics

The following command lists a report of performance metrics:

tpctool> getrpt -user me -pwd mypass -url myhost:myport
-fabric 100005668 -subsys 2105.22232+0 -level daily

Note: If you have multiple volumes in your subsystems, use the -fs character
option with a comma as a field separator.
tpctool> getrpt -subsys 2107.1302541+0 -columns 1,2,4,5,10,11,13,14,22,23,28,29,31,
32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,5,
9,828,829,830,831,832,833,801,802,803,804,805,806,807,808,809,810,811,812,813,814,
815,816,817,818,819,820,821,822,823 -ctype vol -level sample -start 2007.06.27:19:
01:40 -duration 3600 -fs

lsarray
Use the lsarray command to display information about arrays and back-end
storage subsystems.

You must have Disk Administrator authority to use this command. You use the
setarray command or autosetarray command to provide information about

36 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

back-end storage subsystems. You can also enter information about back-end
storage subsystems on the MDisk Group Details page in the Tivoli Storage
Productivity Center GUI.

Syntax
tpctool lsarray -user user -pwd password -url url -dev system

-l -fs character -header -help -qs character

-silent -grouping

Parameters and arguments

Column label Details

Array The ID of the array.
Label The name of the managed disk (MDisk) group.
Total Size (GB) The total amount of storage space.
Free Size (GB) The total amount of available storage space.
Status The operational status of the MDisk group that hosts the array.
Types of Disk The types of disk that host the arrays such as:
v Solid State for solid-state disks
v Non-Solid State for hard disks
v Mixed for solid-state disks and hard disks
Encrypted Shows whether arrays are hosted on encrypted disks.
Read I/O Capability Shows the read I/O capability in seconds of storage arrays. The
calculation of read I/O capability is based on:
v The type of storage system
v The type of RAID
v The type of disk
v The number of disks

Command-line interface 37
Column label Details
Back-end Type The type of back-end storage system that manages disk group
storage.
Back-end RAID Type The type of Random Access Independent Disk (RAID) that the
back-end storage system uses.
Back-end Disk Type The type of disk that the back-end storage system uses.
Back-end Disk Count The total number of disks.

Tip: To find out how to set values for back-end storage subsystems, see the
description of the setarray command.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
-grouping
Enables the grouping of numeric values. For example, in English the value
12000 would display as 12,000. The grouping character is determined by the
system locale.

Examples

Listing array information

The following command lists IDs for the arrays on the specified system:
tpctool> lsarray -user me -pwd mypass -url myhost:9550 -dev 2107.75DG000+0

The following output is returned:

Array
===========================================
IBMTSDS:IBM.2107-75DG000-P17+2107.75DG000+0
IBMTSDS:IBM.2107-75DG000-P16+2107.75DG000+0
IBMTSDS:IBM.2107-75DG000-P15+2107.75DG000+0
IBMTSDS:IBM.2107-75DG000-P14+2107.75DG000+0
IBMTSDS:IBM.2107-75DG000-P1+2107.75DG000+0
IBMTSDS:IBM.2107-75DG000-P0+2107.75DG000+0

Listing detailed information about an array

The following command provides detailed information about the array on the
specified system:

38 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

tpctool> lsarray -dev 0000020064405BA0+0 -l

The following output is returned:

Array Label Total Size (GB) Free Size (GB)
==============================================================================
0000020064405BA0:0+0000020064405BA0+0 mdisk_grp 407.38 310.25

Status Types of Disk Encrypted Read I/O Capability Back-end Type

=============================================================================
NORMAL Non-Solid State No 0 D

Back-end RAID Type Back-end Disk Type Back-end Disk Count

===========================================================
5 F10 160

lsbackenddisktypes
Use the lsbackenddisktypes command to list the types of back-end disks and their
average input/output.

This command applies only to Storwize V7000 and SAN Volume Controller disks.
You must have Disk Administrator authority to use this command.

Syntax
tpctool lsbackenddisktypes -user user -pwd password -url url

-fs character -header -help -qs character

-silent -grouping

Parameters and arguments

When you issue the lsbackenddisktypes command, the following information is

displayed:

Column label Details

Backend Disk Type The type of back-end disk. For example: A07 "Sata - 7500 rpm"
Description A description of the type of back-end disk
IOPS Input/output (I/O) per second. The average number of
input/output operations per second for the disk.

Tip: Use the setbackenddisktype command to set or update the type of a

back-end disk.
-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.

Command-line interface 39
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
-grouping
Enables the grouping of numeric values. For example, in English the value
12000 would display as 12,000. The grouping character is determined by the
system locale.

Examples

Listing back-end disk types

The following command lists the types of back-end disks:

tpctool> lsbackenddisktypes

If the command is successful, a list of the types of back-end disks is displayed:

Back-end Disk Type Description IOPS
====================================================================
A07 "Sata - 7 500 rpm" 40
F10 "Fiber - 10 000 rpm" 120
F15 "Fiber - 15 000 rpm" 150
DEFAULT "DEFAULT TYPE FOR UNCONFIGURED DEVICES" 0

lsbackendraidtypes
Use the lsbackendraidtypes command to list the types of back-end RAID arrays
available for Storwize V7000 and SAN Volume Controller managed disk groups.

This command applies only to Storwize V7000 and SAN Volume Controller disks.
You must have Disk Administrator authority to use this command.

Syntax
tpctool lsbackendraidtypes -user user -pwd password -url url

-fs character -header -help -qs character

-silent -grouping

40 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Parameters and arguments

When you issue the lsbackendraidtypes command, the following information is

displayed:

Column label Details

Backend RAID Type The type of back-end RAID array. Possible values are DEFAULT, 1,
5, 6, X, or an array type that has been set with the
setbackendraidtype command.
Weighted IO The weighted input/output of the RAID type.

Tip: Use the setbackendraidtype command to set or update the type of a back-end
RAID array.
-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
-grouping
Enables the grouping of numeric values. For example, in English the value
12000 would display as 12,000. The grouping character is determined by the
system locale.

Examples

Listing back-end RAID types

The following command lists the available types of back-end RAIDs:

tpctool> lsbackendraidtypes

If the command is successful, a list of the available types of back-end RAIDs is

displayed:

Command-line interface 41
Back-end RAID Type Weighted IO
====================================================================
X 1
6 6
5 4
1 2
DEFAULT 1

lsbackendtypes
Use the lsbackendtypes command to list the types of back-end storage systems.

Additional information, such as the name, description, and cache hit ratio of the
back-end type of the storage system is also provided. This command is available
for Storwize V7000 and SAN Volume Controller storage systems. You must have
Disk Administrator authority to use this command.

Syntax
tpctool lsbackendtypes -user user -pwd password -url url

-fs character -header -help -qs character

-silent -grouping

Parameters and arguments

When you issue the lsbackendtypes command, the following information is

displayed:

Column label Details

Back-end Type The type of back-end storage system such as D
Name The name associated with the type of back-end storage system.
For example, the name DS8000 is associated with type D
Cache Hit Ratio Estimated read cache hit ratio
Description A description of the type of back-end storage system

Tip: Use the setbackendtype command to set or update the type of back-end
storage system.
-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.

42 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Examples

Displaying a list of types of back-end storage systems

The following command provides a list of the types of back-end storage systems:
tpctool> lsbackendtypes

A list of the types of back-end storage subsystem is displayed:

Back-end Type Name Cache Hit Ratio
=================================================
Fake F800 100
X XIV 70
D DS8000 50
V DS4000 50
S "EMC Symmetrix" 50
C "EMC Clariion" 50
DEFAULT DEFAULT 0

Description
========================================
"Theoretical All Cache subsystem"
"IBM XIV"
"DS8K Disk Controller"
"DS5K Disk Controller"
"DMX BE Cache Hit Ratio"
"CX BE Cache Hit Ratio"
"DEFAULT TYPE FOR UNCONFIGURED DEVICES"

lscluster
Use the lscluster command to list all clusters or specified clusters that are on a
Storwize V7000 Unified storage system. You must have Data Operator authority to
use this command.

Syntax
tpctool lscluster -user user -pwd password -url url

Command-line interface 43
-dev device_id
-l -fs character -header

-cluster cluster_id

-help -qs character -silent

Parameters and arguments

If you omit this parameter, only the ID is returned.

44 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Examples

Listing all clusters that are on a storage system

The following command generates a list of all clusters that are on the specified
Storwize V7000 Unified storage system:
tpctool> lscluster -dev 00000200A0E0005C+0 -l

The following output is returned:

ID Cluster
====================================================================================
tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 tpcsonas2.storage.tucson.ibm.com
Cluster ID Type
======================================
12402779238946656959 interface,storage

lscomp
Use the lscomp command to list the components for which performance data has
been collected. You must have Fabric operator or Disk operator authority to use
this command.

Syntax
tpctool lscomp -user user -pwd password -url url

-fabric WWN level sample

-subsys subsystem hourly -ctype comp_type
daily

-start date/time -duration duration_seconds -help -silent

Parameters and arguments

Command-line interface 45
-level sample | hourly | daily
Specifies the level for which the performance metrics of the components
should be summarized. You can specify a sample summary, an hourly
summary, or a daily summary.
-ctype comp_type
Specifies that the output should include only components of the specified type.
See the lstype command for more information about the comp_type variable.
-start date/time
Specifies the date and time to start the sampling period. The date and time are
formatted as:
yyyy.MM dd:HH:mm:ss

All time zones are relative to the Device server. See the lstime command for
more information.
-duration duration_seconds
Specifies the duration of the sampling period, in seconds. The duration_seconds
variable is an integer.
-help | -h | -?
Lists help information for the command.
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Examples
Listing components with performance date.

The following command generates a list of components on a storage subsystem for

which performance data has been collected:
tpctool> lscomp -user me -pwd mypass -url myhost:myport
-subsys 2105.22232+0 -ctype vol -level sample -start
2005.09.19:00:00:00 -duration 86400

The following output is returned:

Component
===============================================
00000000000000000000000000001223+6+2105.22232+0
00000000000000000000000000001222+6+2105.22232+0
00000000000000000000000000001202+6+2105.22232+0
00000000000000000000000000001206+6+2105.22232+0
0000000000000000000000000000121D+6+2105.22232+0
00000000000000000000000000001217+6+2105.22232+0
00000000000000000000000000001227+6+2105.22232+0
00000000000000000000000000001216+6+2105.22232+0
0000000000000000000000000000121A+6+2105.22232+0

lscounters
Use the lscounters command to list available performance counters. You must have
Fabric operator or Disk operator authority to use this command.

Syntax

46 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

tpctool lscounters -user user -pwd password -url url

-fabric WWN -ctype comp_type level sample

-subsys subsystem hourly
daily

-fs character -header -help -qs character

-silent

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-fabric WWN
Specifies the fabric. The WWN variable is the World Wide Name (WWN).
-subsys subsystem
Specifies the storage subsystem. The subsystem variable is the GUID of the
storage subsystem. You can use the lsdev command to return information,
including the GUID, for all storage subsystems that are discovered by IBM
Tivoli Storage Productivity Center.
-ctype comp_type
Specifies that the output should include only components of the specified type.
See the lstype command for more information about the comp_type variable.
-level sample | hourly | daily
Specifies the level for which the performance counters should be summarized.
You can specify a sample summary, an hourly summary, or a daily summary.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Command-line interface 47
Examples

Listing performance counters

The following command generates a list of performance counters for volumes on

the specified storage subsystem:
tpctool> lscounters -user me -pwd mypass -url myhost:myport
-subsys 2105.22232+0 -ctype vol -level sample

The following output is returned.

Counter Value
============================================
Read I/O Count (normal) 1
Read I/O Count (sequential) 2
Write I/O Count (normal) 4
Write I/O Count (sequential) 5
Read Cache Hit Count (normal) 10
Read Cache Hit Count (sequential) 11
Write Cache Hit Count (normal) 13
Write Cache Hit Count (sequential) 14
Read Data Count 22
Write Data Count 23
Read Service Periods 28
Write Service Periods 29
Disk to Cache Transfers (normal) 31
Disk to Cache Transfers (sequential) 32
Cache to Disk Transfers 33
NVS Allocation Count 34
DFW I/O Count (normal) 35
DFW I/O Count (sequential) 36
NVS Delayed I/O Count 37
Cache Delayed I/O Count 38
Record-Mode-Read I/O Count 39
Record-Mode-Read Cache Hit Count 40
Quick Write Promote Count 41

lsdev
Use the lsdev command to list information about storage subsystems, fabrics, and
switches. This information includes the globally-unique identifier (GUID) or
world-wide name (WWN) for fabric, user-defined name, device type, status, and
the time that the status was updated. You must have Disk Administrator authority
to use this command.

Syntax
tpctool lsdev -user user -pwd password -url url
-perf

level sample
hourly -fabric -subsys -l -fs character
daily

-header -help -qs character -silent

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.

48 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-perf
Specifies that the devices for which performance data is collected should be
listed. You must have the applicable authority to view the devices.
-level sample | hourly | daily
Specifies the level for which the information should be summarized. You can
specify a sample summary, an hourly summary, or a daily summary.
-fabric
Specifies that only fabric devices should be listed. You must have Fabric
administrator authority to use this option and Fabric Manager must be
enabled.
-subsys
Specifies that only storage subsystems should be listed. Disk Manager must be
enabled.
-l
Specifies that the long version should be listed:
v GUID or WWN
v User-defined name
v Device type
v Status
v Time that the status was updated
If you omit this parameter, only the GUID or WWN is listed.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Command Aliases

You can run the following lsdev command aliases that have been predefined by
IBM.

Command-line interface 49
Name Value
lsfabric lsdev -fabric
lsperf lsdev -perf
lssubsys lsdev -subsys
lstape lsdev -tape

Examples

Listing all devices

The following command lists the GUIDs for all storage subsystems in the Tivoli
Storage Productivity Center environment:
tpctool> lsdev -user me -pwd mypass -url myhost:myport -subsys

The following output is returned:

GUID
==============================
9.47.97.159:0000020065400048+0
9.47.97.161:0000020060C0002A+0
1750.13AAW2A+0
1750.13AB1WA+0
2107.1302541+0
2107.1301901+0
2105.22232+0
2105.20870+0

Listing the long version of information

The following command lists the long version of information for fabric devices.
tpctool> lsdev -user me -pwd mypass -url myhost:myport -fabric -l

The following output is returned:

GUID Name Type Status Timestamp
==================================================================
100000051E34F6A8 100000051E34F6A8 - UNKNOWN 2004.12.31:00:00:00
10000060695130FD 1000006069514262 - UNKNOWN 2004.12.31:00:00:00
1000006069514262 10000060695130FD - UNKNOWN 2004.12.31:00:00:00

lsdevp
Use the lsdevp command to list world-wide port names (WWPNs) for a
subsystem. You must have Disk Administrator authority to use this command.

Syntax
tpctool lsdevp -user user -pwd password -url url -dev subsystem

-l -fs character -header -help -qs character

-silent

50 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Parameters and arguments
-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-dev subsystem
Specifies the globally unique identifier (GUID) of the storage subsystem. You
can use the lsdev command to return information, including the GUID, for all
storage subsystems that are discovered by Tivoli Storage Productivity Center.
-l Specifies that the long version of the information should be listed.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Examples

Listing worldwide port names

The following command lists the WWPNs for the specified subsystem:
tpctool> lsdevp -user me -pwd mypass -url myhost:myport -dev 2105.22232+0

The following output is returned:

WWPN
================
5005076300C79470
5005076300D09470
5005076300CB9470
5005076300CC9470
5005076300C29470
5005076300CF9470
5005076300C89470
5005076300C39470

Command-line interface 51
lsdisk
Use the lsdisk command to list all the physical disks on a specified storage
subsystem.You must have Fabric Operator or Disk Operator authority to use this
command.

Syntax
tpctool lsdisk -user user -pwd password -url url -subsys subsystem

-l -fs character -header -help -qs character

-silent

Parameters and arguments

52 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Examples

To display a list of physical disks on a storage subsystem

The following command generates a list of physical disks on a specified storage

subsystem:
lsdisk -subsys 2107-1300361+0 -l

The following output is returned:

Key Label Vendor Model
=========================================================================
8000350BFC0D00D+IBM.2107-1300361 U2107.D01.Q000004-P1-D14 Seagate S0AE146

Serial Number Capacity Speed Encrypted Solid State

=======================================================
8000350BFC0D00D 146.0 - No No

lsexport
Use the lsexport command to list all exports or specified exports that are
associated with a cluster that is on a Storwize V7000 Unified storage system. You
can also list exports by file system. You must have Data Operator authority to use
this command.

Syntax
tpctool lsexport -user user -pwd password -url url

-cluster cluster_id
-l -fs character -header

-filesystem file_system_id

-export export_id

-help -qs character -silent

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.

Command-line interface 53
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-cluster cluster_id | -filesystem file_system_id... | -export export_id...
The -cluster parameter specifies that information is displayed for the for all
exports that are associated with a cluster. You can use the lscluster command
to return information, including the cluster IDs, for all clusters that were
discovered.
The -filesystem parameter specifies that information is displayed only for
exports that are associated with specific file systems. You can enter one or
multiple file system IDs. Use a comma to separate multiple IDs. You can use
the lsfs command to return information, including the file system IDs, for all
file systems that have been discovered.
The -export parameter specifies that information is displayed only for specific
exports. You can enter one or multiple export IDs. Use a comma to separate
multiple IDs.
-l
Specifies that the following information is listed:
ID An ID for the cluster that is composed of the export name, storage
system name, and storage system format.
Export The name of the export.
Path The path on the computer where the export is located.
Protocol
The protocol for the export can be one of following values: HTTP, FTP,
SCP, CIFS, or NFS.
Active Indicates whether the export is active or inactive in the cluster. The
value can be true or false. If an export is inactive, it is included in the
list of exports, but the data that is associated with the export cannot be
accessed.
Options
The configuration options that were set for the export. This column
contains information only if the protocol is CIFS or NFS.

If you omit this parameter, only the ID is returned.

54 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Examples

Listing all nodes that are on a cluster

The following command generates a list of all exports that are on the specified
Storwize V7000 Unified cluster:
tpctool> lsexport -cluster tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 -l

The following output is returned:

ID Export
=================================================================================
RandomExport1+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 RandomExport1
RandomExport1+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 RandomExport1
RandomExport1+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 RandomExport1
testadd+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 testadd
testadd+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 testadd
smcho2+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 smcho2
smcho2+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 smcho2
smcho2+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 smcho2
smcho2+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 smcho2
Path Active Protocol Options
=============================================================================
/ibm/gpfs0/randomexport1 false NFS tbl435 (rw,no_wdelay)
/ibm/gpfs0/randomexport1 false CIFS access control=Everyone:ALLOWED:FULL
/ibm/gpfs0/randomexport1 false HTTP
/ibm/testadd true NFS tbl435 (rw,no_wdelay)
/ibm/testadd true CIFS read only;access control=Everyone:ALLOWED:FULL
/ibm/gpfs0/smcho true CIFS access control=Everyone:ALLOWED:FULL
/ibm/gpfs0/smcho true HTTP
/ibm/gpfs0/smcho true FTP
/ibm/gpfs0/smcho true SCP

lsextent
Use the lsextent command to display a list of all the storage extents on a specified
storage subsystem. An example of a storage extent is an MDisk on a SAN Volume
Controller.You must have Fabric Operator or Disk Operator authority to use this
command.

Syntax
tpctool lsextent -user user -pwd password -url url

-subsys subsystem
-l

Parameters and arguments

Command-line interface 55
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-subsys subsystem
Specifies the GUID of the storage subsystem. You can use the lsdev command
to return information, including the GUID, for all storage subsystems that have
been discovered.
-l
Specifies that long information is listed. This includes the following
information:
v Key
v Label
v Total Capacity
v Free Space
v Virtual
If this parameter is not issued, only the host name is returned.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Examples

To display a list of storage extents on a storage subsystem

The following command generates a list of storage extents on a specified storage

subsystem:
tpctool> lsextent -subsys 2107-1300361+0 -l

The following output is returned:

Key Label Total Capacity
=====================================================================
IBM.2107-1300361-R8+2107-1300361+0 IBM.2107-1300361-R8 581.0
IBM.2107-1300361-R7+2107-1300361+0 IBM.2107-1300361-R7 1688.0
IBM.2107-1300361-R6+2107-1300361+0 IBM.2107-1300361-R6 519.0

Free Space Virtual

==================
0.0 No
0.0 No
0.0 No

56 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

lsfcpath
Use the lsfcpath command to list the paths for data transmission between a system
with a fibre-channel host bus adapter (HBA) and a storage subsystem. You must
have Fabric Administrator authority to use this command.

Syntax
tpctool lsfcpath -user user -pwd password -url url -svr server

-dev GUID
-fs character -header -help -qs character

-silent

Parameters and arguments

Examples

Listing data paths

Command-line interface 57
The following command lists the paths on which data can be transmitted between
MARKETING and the storage subsystem 2105.20870+0:
tpctool> lsfcpath -user me -pwd mypass -url myhost:myport -svr
MARKETING -dev 2105.20870+0

The following output is returned:

ServerPort SubsystemPort
=================================
210000E08B1Co9E 710000E08W1Co8F

lsfs
Use the lsfs command to list all file systems or specified file systems that are
associated with a cluster that is on a Storwize V7000 Unified storage system. You
can also list file systems by pool or Network Shared Disk (NSD). You must have
Data Operator authority to use this command.

Syntax
tpctool lsfs -user user -pwd password -url url

-cluster cluster_id
-l -fs character -header

-pool pool_id

-nsd nsd_id

-filesystem file_system_id

-help -qs character -silent -grouping

Parameters and arguments

58 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

The -nsd parameter specifies that information is displayed only for file systems
that are associated with specific NSDs. You can enter one or multiple NSD IDs.
Use a comma to separate multiple IDs. You can use the lsnsd command to
return information, including the NSD IDs, for all NSDs that were discovered.
The -filesystem parameter specifies that information is displayed only for
specific file systems. You can enter one or multiple file system IDs. Use a
comma to separate multiple IDs.
-l
Specifies that the following information is listed:
ID An ID for the cluster that is composed of the file system name, cluster
name, storage system name, and storage system format.
File System
The name of the file system.
Mount Point
The name or mount point (UNIX/Linux) of the file system (for
example, c:\, d;\, /opt, or /export/home).
Cluster
The name of the cluster that is associated with the file system.
Capacity (GB)
The capacity of the file system.
Used Space (GB)
Amount of used storage space in the file system.
Available Space (GB)
The amount of unused storage space in the file system.
Maximum File Count
Total number of files in a file system. This value does not include files
on file systems that were not scanned.
Used I-Nodes
The number of used inodes in the file system.
Free I-Nodes
The number of unused inodes in the file system.

If you omit this parameter, only the ID is returned.

Command-line interface 59
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
-grouping
Enables the grouping of numeric values. For example, in English, the value
12000 would display as 12,000. The grouping character is determined by the
system locale.

Examples

Listing all file systems that are on a cluster.

The following command generates a list of all file systems that are on the specified
Storwize V7000 Unified cluster:
tpctool> lsfs -cluster tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 -l

The following output is returned:

ID File System
========================================================================
gpfs0+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 gpfs0
testadd+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 testadd
gpfs1+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 gpfs1
ma_19037+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 ma_19037
Cluster Mount Point Capacity (GB) Used Space (GB)
============================================================================
tpcsonas2.storage.tucson.ibm.com /ibm/gpfs0 4280 1135.91
tpcsonas2.storage.tucson.ibm.com /ibm/testadd 8560 151.58
tpcsonas2.storage.tucson.ibm.com /ibm/scantest 4280 1.54
tpcsonas2.storage.tucson.ibm.com /ibm/gpfs0/ma 4280 1.54
Available Space (GB) Maximum File Count Used I-Nodes Free I-Nodes
=================================================================
3144.09 4382726 537458 3845268
8408.42 4383232 5107 4378125
4278.46 4382726 4044 4378682
4278.46 4382726 4043 4378683

lsfset
Use the lsfset command to list all files sets or specified files sets that are associated
with a file system on a Storwize V7000 Unified storage system. You must have
Data Operator authority to use this command.

Syntax
tpctool lsfset -user user -pwd password -url url

-filesystem file_system_id
-l -fs character -header

-fileset file_set_id

-help -qs character -silent -grouping

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.

60 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-filesystem file_system_id | -fileset file_set_id...
The -filesystem parameter specifies that information is displayed for all file
sets that are on a file system. This parameter requires the ID for the file
system. You can use the lsfs command to return information, including the file
system IDs, for all file systems that were discovered.
The -fileset parameter specifies that information is displayed only for specific
file sets. You can enter one or multiple file set IDs. Use a comma to separate
multiple IDs.
-l
Specifies that information is listed. This includes the following information:
ID An ID for the file set that is composed of the file set name, file system
name, cluster name, storage system name, and storage system format.
File Set
The name of the file set.
Path The path for the file set. The path is displayed only if linked is
displayed in the Status column.
File System
The name of the file system that is associated with the file set.
Status The status of the file set can be one of the following values: linked or
unlinked.
Used Space (GB)
The amount of space that is used by the file set.
Used I-Nodes
The number of used inodes in the file set.

If you omit this parameter, only the ID is returned.

-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Command-line interface 61
-grouping
Enables the grouping of numeric values. For example, in English, the value
12000 would display as 12,000. The grouping character is determined by the
system locale.

Examples

Listing all file sets that are on a specified file system

The following command generates a list of all file sets that are on a specified file
system:
tpctool> lsfset -filesystem
testadd+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 -l

The following output is returned:

ID File Set
============================================================================
root+testadd+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 root
smcho+testadd+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 smcho
testset+testadd+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 testset
Path Status Used Space (GB) Used I-Nodes
===========================================================
/ibm/testadd linked 0 0
/ibm/testadd/smcho linked 0 0
-- unlinked 0 0

lshtype
Use the lshtype command to list host types. You must have Disk Administrator
authority to use this command.

Syntax
tpctool lshtype -user user -pwd password -url url -dev subsystem

-fs character -header -help -qs character

-silent

Parameters and arguments

62 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Examples

Listing host types

The following command lists the host types associated with the specified
subsystem:
tpctool> lshtype -user me -pwd mypass -url myhost:myport -dev 2105.22232+0

The following output is returned:

HostType HostFlag
===============================================================================
StorageClientSettingData for IBM pSeries, RS/6000 and RS/6000 SP Servers (AIX)9
StorageClientSettingData for Cisco iSCSI Gateway 13
StorageClientSettingData for DGUX 10
StorageClientSettingData for IBM NUMA-Q Servers (DYNIX/ptx) 11
StorageClientSettingData for HP Servers (HP-UX) 4
StorageClientSettingData for SGI Origin Servers (IRIX) 12
StorageClientSettingData for Intel-based Servers (Linux) 14
StorageClientSettingData for IBM zSeries Servers (Linux) 14
StorageClientSettingData for IBM iSeries/pSeries Servers (Linux) 14
StorageClientSettingData for Intel-based Servers (Microsoft Windows NT4) 15
StorageClientSettingData for Intel-based Servers (Novell Netware) 7
StorageClientSettingData for HP AlphaServer (OpenVMS) 5
StorageClientSettingData for IBM AS/400 (V3R7 to V5R2) 16
StorageClientSettingData for IBM AS/400 (V5R3 or higher) 16
StorageClientSettingData for IBM SAN File System (AIX MDS) 9
StorageClientSettingData for IBM SAN File System (Linux MDS) 14
StorageClientSettingData for IBM SAN Volume Controller 3277 0
StorageClientSettingData for Solaris 2.51 3
StorageClientSettingData for Sun Servers (Solaris 2.6 or higher) 3
StorageClientSettingData for Sun Clustering using MPxIO 3279 0
StorageClientSettingData for HP AlphaServer (Tru64 UNIX) 6
StorageClientSettingData for VMware ESX 3278 0
tpctool>

lsmetrics
Use the lsmetrics command to list available performance metrics.You must have
Fabric operator or Disk operator authority to use this command.

Syntax

Command-line interface 63
tpctool lsmetrics -user user -pwd password -url url

-fabric WWN -ctype comp-type level sample

-subsys subsystem hourly
daily

-fs character -header -help -qs character

-silent

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-fabric WWN
Specifies the fabric. The WWN variable is the World Wide Name (WWN).
-subsys subsystem
Specifies the storage subsystem. The subsystem variable is the GUID of the
storage subsystem. You can use the lsdev command to return information,
including the GUID, for all storage subsystems that are discovered by Tivoli
Storage Productivity Center.
-ctype comp_type
Specifies that the output should include only components of the specified type.
See the lstype command for more information about the comp_type variable.
-level sample | hourly | daily
Specifies the level for which the performance metrics should be summarized.
You can specify a sample summary, an hourly summary, or a daily summary.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

64 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Examples

Listing performance metrics

The following command generates a list of performance metrics for switch ports on
the specified fabric:
tpctool lsmetrics -user me -pwd mypass -url myhost:myport
-fabric 100000051E34F6A8 -ctype switch_port -level sample

The following output is returned:

Metric Value
=================================
Port Send Packet Rate 855
Port Receive Packet Rate 856
Total Port Packet Rate 857
Port Send Data Rate 858
Port Receive Data Rate 859
Total Port Data Rate 860
Port Peak Send Data Rate 861
Port Peak Receive Data Rate 862
Port Send Packet Size 869
Port Receive Packet Size 870
Overall Port Packet Size 871
Error Frame Rate 872
Dumped Frame Rate 873
Link Failure Rate 874

lsnode
Use the lsnode command to list all nodes or specified nodes that are associated
with a cluster that is on a Storwize V7000 Unified storage system. You must have
Data Operator authority to use this command.

Syntax
tpctool lsnode -user user -pwd password -url url

-cluster cluster_id
-l -fs character -header -help

-node node_id

-qs character -silent

Parameters and arguments

Command-line interface 65
that are on a cluster. This parameter requires the ID for the cluster. You can use
the lscluster command to return information, including the cluster IDs, for all
clusters that were discovered.
The -node parameter specifies that information is displayed only for specific
nodes. You can enter one or multiple node IDs. Use a comma to separate
multiple IDs.
-l
Specifies that the following information is listed:
ID An ID for the node that is composed of the node name, cluster name,
storage system name, and storage system format.
Node The name of the node.
Description
The description of the node.
IP Address
The IP address for the node.
Role One or more of the following roles: interface, management, or storage.
Status One of the following values: NORMAL, CRITICAL, or WARNING.

If you omit this parameter, only the ID is returned.

Examples

Listing all nodes that are on a cluster

The following command generates a list of all nodes that are on the specified
Storwize V7000 Unified cluster:
tpctool> lsnode -cluster tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 -l

The following output is returned:

ID Node
=============================================================================
int001st001+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 int001st001
strg002st001+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 strg002st001

66 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

strg001st001+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 strg001st001
mgmt001st001+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 mgmt001st001
int002st001+tpcsonas2.storage.tucson.ibm.com+00000200A0E0005C+0 int002st001
Description IP Address Role Status
=========================================================
int001st001 9.11.123.208,9.11.123.209 interface NORMAL
strg002st001 172.31.134.2 storage NORMAL
strg001st001 172.31.134.1 storage NORMAL
mgmt001st001 172.31.136.2 management NORMAL
int002st001 172.31.132.2 interface WARNING

lsnsd
Use the lsnsd command to list all Network Shared Disks (NSDs) or specified NSDs
that are on a Storwize V7000 Unified storage system. You can also list NSDs by file
system, pool, or both. You must have Data Operator authority to use this
command.

Syntax
tpctool lsnsd -user user -pwd password -url url

-dev device_id
-l -fs character -header

-pool pool_id

-filesystem file_system_id

-nsd nsd_id

-help -qs character -silent -grouping

Parameters and arguments

Command-line interface 67
a comma to separate multiple IDs. You can use the lspool command to return
information, including the pool IDs, for all pools that were discovered.
The -filesystem parameter specifies that information is displayed only for
NSDs that are associated with specific file systems. You can enter one or
multiple file system IDs. Use a comma to separate multiple IDs. You can use
the lsfs command to return information, including the file system IDs, for all
file systems that were discovered.
The -nsd parameter specifies that information is displayed only for specific
NSDs. You can enter one or multiple NSD IDs. Use a comma to separate
multiple IDs.
-l
Specifies that the following information is listed:
ID An ID for the NSD that composed of the NSD name, storage system
name, and storage system format.
NSD NSD: The name of the NSD.
Cluster ID
The ID for the cluster that is associated with the NSD as defined by
the Storwize V7000 Unified file module.
Failover Group
The failure group that the NSD belongs to.
Type One or more of the following types: dataAndMetadata, dataOnly,
metadataOnly.
Pool The pool that the NSD is associated with.
Status One of the following values: NORMAL, CRITICAL, WARNING, or
UNREACHABLE.
Disk Space (GB)
The total disk space for the NSD.
Available Space (GB)
The amount of unused disk space for the NSD.
File System
The file system that the NSD is associated with.

If you omit this parameter, only the ID is returned.

68 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
-grouping
Enables the grouping of numeric values. For example, in English, the value
12000 would display as 12,000. The grouping character is determined by the
system locale.

Examples

Listing all NSDs that are on a storage system

The following command generates a list of all NSDs that are on the specified
Storwize V7000 Unified storage system:
tpctool> lsnsd -dev 00000200A0E0005C+0 -l

The following output is returned:

ID NSD
========================================================================================
array0_sas_60001ff07996c0089b00000+00000200A0E0005C+0 array0_sas_60001ff07996c0089b00000
array0_sas_60001ff07996c0289b20002+00000200A0E0005C+0 array0_sas_60001ff07996c0289b20002
array1_sas_60001ff07996c0389b30003+00000200A0E0005C+0 array1_sas_60001ff07996c0389b30003
array1_sas_60001ff07996c0189b10001+00000200A0E0005C+0 array1_sas_60001ff07996c0189b10001
array0_sas_60001ff07996c0489b40004+00000200A0E0005C+0 array0_sas_60001ff07996c0489b40004
Cluster ID Failover Group Type Pool Status
===================================================================
12402779238946656959 1 dataAndMetadata system NORMAL
12402779238946656959 1 dataAndMetadata system NORMAL
12402779238946656959 4005 dataAndMetadata system NORMAL
12402779238946656959 1 dataAndMetadata system NORMAL
12402779238946656959 4002 dataAndMetadata system NORMAL
Disk Space (GB) Available Space (GB) File System
================================================
4280 3144 gpfs0
4280 4278.46 gpfs1
4280 4278.46 ma_19037
4280 4128.4 testadd
4280 4280 testadd

lspool
Use the lspool command to list all storage pools that are on a specified Storwize
V7000 Unified storage system. You can also list pools by file system. You must
have Data Operator authority to use this command.

Syntax
tpctool lspool -user user -pwd password -url url

-dev device_id
-l -fs character -header

-filesystem file_system_id

-pool pool_id

Command-line interface 69
pool_id...
-help -qs character -silent -grouping -

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-dev dev_id | -filesystem file_system_id... | -pool pool_id...
The -dev parameter specifies that information is displayed for all pools that are
associated with a storage system. This parameter requires the globally unique
identifier (GUID) of the storage system. You can use the lsdev command to
return information, including the GUID, for all storage systems that were
discovered.
The -filesystem parameter specifies that information is displayed only for
pools that are associated with specific file systems. You can enter one or
multiple file system IDs. Use a comma to separate multiple IDs. You can use
the lsfs command to return information, including the file system IDs, for all
file systems that were discovered.
The -pool parameter specifies that information is displayed only for specific
pools. You can enter one or multiple pool IDs. Use a comma to separate
multiple IDs.
-l
Specifies that the following information is listed:
ID An ID for the pool that is composed of the pool name, storage system
name, and storage system format.
Pool The name of the pool.
Capacity (GB)
The capacity of the pool.
Available Space (GB)
The amount of unused space that is in the pool.

If you omit this parameter, only the ID is returned.

70 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
-grouping
Enables the grouping of numeric values. For example, in English, the value
12000 would display as 12,000. The grouping character is determined by the
system locale.

Examples

Listing all pools that are on a storage system

The following command generates a list of all pools that are on the specified
Storwize V7000 Unified storage system:
tpctool> lspool -dev 00000200A0E0005C+0 -l

The following output is returned:

ID Pool Capacity (GB) Available Space (GB)
===================================================================
system+00000200A0E0005C+0 system 21400 20109.43

lsport
Use the lsport command to list the ports located on a fibre-channel host bus
adapter (HBA). You must have Fabric Administrator authority to use this
command.

Syntax
tpctool lsport -user user -pwd password -url url -svr server

-l -fs character -header -help -qs character

-silent

Parameters and arguments

Command-line interface 71
-l
Specifies that the long version of the information should be listed:
v World wide port name (WWPN)
v Name
v Status
If you omit this parameter, only the WWPN is returned.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Examples

Listing port information

The following command lists the long version of information about the ports
associated with the fibre-channel HBA:
tpctool> lsport -user me -pwd mypass -url myhost:myport -svr <server> -l

The following output is returned:

WWPN Name Status
==================================
210000E08B1Co9E Marketing Active

lsquota
Use the lsquota command to list all quotas or specified quotas that are on a
Storwize V7000 Unified storage system. You can also list quotas by file system. You
must have Data Operator authority to use this command.

Syntax
tpctool lsquota -user user -pwd password -url url

72 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-dev device_id
-l -fs character -header

-filesystem file_system_id

-quota quota_id

-help -qs character -silent -grouping

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-dev dev_id | -filesystem file_system_id... | -quota quota_id...
The -dev parameter specifies that information is displayed for all quotas that
are associated with a storage system. This parameter requires the globally
unique identifier (GUID) of the storage system. You can use the lsdev
command to return information, including the GUID, for all storage systems
that were discovered.
The -filesystem parameter specifies that information is displayed only for
quotas that are associated with specific file systems. You can enter one or
multiple file system IDs. Use a comma to separate multiple IDs. You can use
the lsfs command to return information, including the file system IDs, for all
file systems that were discovered.
The -quota parameter specifies that information is displayed only for specific
quotas. You can enter one or multiple quota IDs. Use a comma to separate
multiple IDs.
-l
Specifies that the following information is listed:
ID: The identifier for the quota.
Name: The name of the user, group, or file set that the quota is
associated with.
File System: The file system that the quota is associated with.
Type: The type of quota can be on of the following values: user, fileset,
or group.
SL Usage (GB): The soft limit for storage space usage.
HL Usage (GB): The hard limit for storage space usage.
Used Space (GB): The amount of used storage space.
SL I-Nodes: The soft limit for inode usage.
HL I-Nodes: The hard limit for inode usage.

Command-line interface 73
Used I-Nodes: The number of used inodes.
Gracetime Usage (sec.): The timeframe in which storage space usage
must be brought below the quota.
Gracetime I-Nodes (sec.): The timeframe in which inode usage must be
brought below the quota.
In Doubt (KB): The amount of data for which the quota was not
updated.

If you omit this parameter, only the ID is returned.

Examples

Display a list of all quotas that are on a storage system.

The following command generates a list of all quotas on the specified Storwize
V7000 Unified storage system:
tpctool> lsquota -dev 00000200A0E0005C+0 -l

The following output is returned:

ID Name
==============================================================
4572_U_10000000+00000200A0E0005C+0 10000000
4572_F_Adrian+00000200A0E0005C+0 Adrian
4578_U_SRM\administrator+00000200A0E0005C+0 SRM\administrator
4574_U_SRM\administrator+00000200A0E0005C+0 SRM\administrator
4572_U_SRM\administrator+00000200A0E0005C+0 SRM\administrator
File System Type SL Usage (GB) HL Usage (GB) Used Space (GB)
===============================================================
gpfs0 user 0 0 0
gpfs0 fileset 0 0 0
testadd user 0 0 0
gpfs1 user 0 0 0.02
gpfs0 user 0 0 579654.05

74 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

SL I-Nodes HL I-Nodes Used I-Nodes
==================================
0 0 1
0 0 1
512 512 0
0 0 4
0 0 533268
Gracetime Usage (sec.) Gracetime I-Nodes (sec.) In Doubt
========================================================
0 0 0
0 0 0
0 0 0
0 0 0
0 0 0

lssrg
Use the lssrg command to display a list of Storage Resource Groups known to
Tivoli Storage Productivity Center.You must have Fabric Operator or Disk Operator
authority to use this command.

Syntax
tpctool lssrg -user user -pwd password -url url
-l

Parameters and arguments

Command-line interface 75
v User Defined Property 1
v User Defined Property 2
v User Defined Property 3
If this parameter is not issued, only the host name is returned.

Examples

To display a list of Storage Resource Groups

The following command generates a list of Storage Resource Groups known to

Tivoli Storage Productivity Center:
tpctool>lssrg -l

The following output is returned:

Name Description UDP1 UDP2 UDP3
==============================================================
administrator.my-example-srg

lssrgmembers
Use the lssrgmembers command to list of members of a specified Storage Resource
Group.You must have Fabric Operator or Disk Operator authority to use this
command.

Syntax
tpctool lssrgmembers -user user -pwd password -url url -name

Parameters and arguments

76 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-nameSRGname
The unique name of a Storage Resource Group. The output includes the
following information:
v Member Key
v Member Type

Examples

To display a list of the members of a Storage Resource Group

The following command generates a list of the members of a specified Storage

Resource Group:
tpctool> lssrgmembers -name administrator.my-example-srg

The following output is returned:

Member Key Member Type
========================================
1000080088E32D2D Switch
100000051E0405C5 Switch
2107-1300361+0 Subsystem

lssvr
Use the lssvr command to list all systems discovered by Fabric Manager. You must
have Fabric Administrator authority to use this command.

Syntax
tpctool lssvr -user user -pwd password -url url
-l -help

-fs character -qs character -silent -header

Parameters and arguments

Command-line interface 77
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Examples

Listing long information for all systems discovered by Fabric Manager

The following commands list long information for all systems that are discovered
by Fabric Manager:
tpctool
tpctool> lssvr -l

The following output is returned:

Name OS IP Status
============================================
Marketing Windows 9.32.245.164 NORMAL

Key
========================================================
bfcf0e0192a111dc9ac60011258d9a29+tb142-wi+9.47.97.149+++

lssvrdisk
Use the lssvrdisk command to list all the physical disks known to a specified
server.

Syntax
tpctool lssvrdisk -user user -pwd password -url url

-srv servername
-l -help -fs character -qs character

-silent -header

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.

78 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-svrservername
Specifies the key of a server that has a Tivoli Storage Productivity Centeragent
deployed to it. Use the lssvr -l command to retrieve a list of servers and the
associated keys.
-l
Specifies that long information is listed. This includes the following
information:
v Key - a combination of the GUID, the hostname, and the IP address
v Driver
v Vendor
v Model
v Serial Number
v Capacity
v Path
If this parameter is not issued, only the host name is returned.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Examples

Listing long information for all physical disks known to a specified server

The following commands list long information for all physical disks that are
known to a specified server::
tpctool
tpctool> lssvrdisk -svr bfcf0e0192a111dc9ac60011258d9a29+tb142-wi.beaverton.
ibm.com+9.47.97.149+++ -l

The following output is returned:

Key Driver Vendor Model
=============================================================================
3HX30J0X000075154506 Adaptec AIC-7902B - Ultra320 SCSI IBM-ESXS ST336753LC FN

Serial Number Capacity Path

=======================================
3HX30J0X000075154506 36401479680 Disk 0

Command-line interface 79
lsswitch
Use the lsswitch command to display a list of all switches in a specified fabric. .
You must have Fabric Administrator authority to use this command.

Syntax
tpctool lsswitch -user user -pwd password -url url -fabric fabric

-l -help -fs character -qs character -silent

-header

Parameters and arguments

80 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Examples

Listing long information for all switches on a specified fabric.

The following command lists long information for all switches in the specified
fabric:
tpctool
tpctool> lsswitch -fabric 10000800880476F0 -l

The following output is returned:

WWN Label Type Vendor Model Status
============================================================
100000051E34AEE1 tb500_sw Physical Unknown 26.2 UNREACHABLE

lstapedrive
Use the lstapedrive command to display a list of all tape drives in the specified
tape library.

Syntax
tpctool lstapedrive -user user -pwd password -url url

-tapelibrary tapelibrary

Parameters and arguments

-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
-tapelibrarytapelibrary
The unique tape library key for which you would like to retrieve the tape
drives. Tape library keys can be obtained from the command lstapelib.
-l Specifies that long information is listed. If this parameter is not issued, only
the host name is returned.

Command-line interface 81
lstapelib
Use the lstapelib command to list all tape libraries known to the Tape Manager.
You must have Fabric Administrator authority to use this command.

Syntax
tpctool lstapelib -user user -pwd password -url url
-l

-help -fs character -qs character -silent

-header

Parameters and arguments

82 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Examples

Listing long information for all tape libraries known to Tape Manager

The following command lists long information for all tape libraries that are know
to Tape Manager:
tpctool
tpctool> lstapelib -l

The following output is returned:

Key Label Vendor Model Status
=============================================================================
9.47.98.17:IBM \+3584 \+1311051+16 Tape-3584-1311051-IBM IBM 3584 NORMAL

lstapemc
Use the lstapemc command to display a list of all tape media changers in the
specified tape library.

Syntax
tpctool lstapemc -user user -pwd password -url url

-tapelibrary tapelibrary

Parameters and arguments

-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
-tapelibrarytapelibrary
The unique tape library key for which you'd like to retrieve the tape media
changers. Tape library keys can be obtained from the command lstapelib.
-l Specifies that long information is listed. If this parameter is not issued, only
the host name is returned.

Command-line interface 83
lstime
Use the lstime command to print a list of time ranges for which performance data
is available.You must have Fabric operator or Disk operator authority to use this
command.

Syntax
tpctool lstime -user user -pwd password -url url

-fabric WWN
-subsys subsystem -ctype comp_type -comps component_list

level sample
hourly -fs character -header -help
daily

-qs character -silent

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-fabric WWN
Specifies the fabric. The WWN variable is the World Wide Name (WWN).
-subsys subsystem
Specifies the storage subsystem. The subsystem variable is the GUID of the
storage subsystem. You can use the lsdev command to return information,
including the GUID, for all storage subsystems that are discovered by Tivoli
Storage Productivity Center.
-level sample | hourly | daily
Specifies the level for which the time ranges for performance data that is
available should be summarized. You can specify a sample summary, an
hourly summary, or a daily summary.
-ctype comp_type
Specifies that the output should include only components of the specified type.
See the lstype command for more information about the comp_type variable.
-comps component_list
Specifies the component list. The component_list variable specifies the
components, such as returned by lscomp.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.

84 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Examples

Displaying a list of time ranges

The following command generates a list of time ranges for performance data:
tpctool> lstime -user me -pwd mypass -url myhost:myport
-fabric 100000051E34F6A8 -ctype switch_port -level sample

lstype
Use the lstype command to list the components that are recognized by IBM Tivoli
Storage Productivity Center. No authorization is required to run this command.

Syntax
tpctool lstype
-fs character -header -help

-qs character -silent

Parameters and arguments

Command-line interface 85
Examples

Listing all component types:

The following command lists the component types that are recognized by Tivoli
Storage Productivity Center:
tpctool> lstype

The following output is returned:

Name Type
================
all -1
unknown 0
subsystem 1
subsys_port 2
controller 3
stor_pool 4
svc_iogrp 5
ds_rio 6
svc_mdgrp 7
da 8
ds_rank 9
array 10
svc_mdisk 11
vol 12
switch 13
switch_port 14

lsvmdisk
Use the lsvmdisk command to list all the VMWare Virtual Machine Disks known
to the given virtual machine or hypervisor. You must have Fabric Administrator
authority to use this command.

Syntax
tpctool lsvmdisk -user user -pwd password -url url
-l

-help -fs character -qs character -silent

-header

Parameters and arguments

86 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-svr servername
A server key that represents either a virtual machine or hypervisor. Server keys
can be obtained using the lssvr -l command.
-l
Specifies that long information is listed. If this parameter is not issued, only
the host name is returned.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

lsvol
Use the lsvol command to list all volumes on a system, list a specific volume or
volumes, or list volumes on a specific array. You must have Disk administrator
authority to use this command.

Syntax
tpctool lsvol -user user -pwd password -url url -dev GUID

array array -l -fs character -header -help

-qs character -silent volume id
-

Parameters and arguments

Command-line interface 87
array array
Specifies the array. The array variable is the array ID. You can use the lsarray
command to return information, including array IDs, about the arrays on a
specific storage subsystem.
-l Specifies that long information is listed. In addition to the volume ID, the
volume size and FlashCopy relationship information are also listed.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
volume id | -
Specifies the volumes. The volume_ID variable is a comma-separated list of
volume IDs, such as that obtained by running the lsvol command. If a single
dash (-) is issued, the volume IDs are read from standard input.

Examples

Listing the volumes on a subsystem

The following commands list all volumes on a specified subsystem. The -dev
option specifies your system. Additional information for the volumes can be
displayed as specified with the -l option.
tpctool> lsvol -user me -pwd mypass -url myhost:9550 -dev 2107.75DG000+0 -l
FlashCopy
Indicates if the volume is in a FlashCopy (FC) relationship and whether it
is an FC source or FC target. Volumes that are not in an FC relationship are
displayed with a None value whether or not the volume is on a system
that supports FC.

Note:
v This value is available for volumes of the following systems only: IBM
TotalStorage Enterprise Storage Server® (ESS), IBM System Storage
DS6000, IBM System Storage DS8000, and IBM System Storage SAN
Volume Controller.
v TotalStorage Enterprise Storage Server systems must have at least the
following microcode levels: ess800mincodelevel = 2.4.3.56,
essf20mincodelevel = 2.3.3.89. Tivoli Storage Productivity Center does
not report FlashCopy information if the TotalStorage Enterprise Storage
Server systems do not meet this requirement.

88 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Real Used
The amount of space, in gigabytes, that a volume is actually using. Tivoli
Storage Productivity Center allocates the entire space for regular volumes
when they are created. For thin provisioned volumes, it does not. This
column displays the space that is actually being used.

Note:
v If a system is new and there is no data in the volumes, the value is zero.
For example, the Size field might show 16 GB but the Real Used is 0.
v For non-thin provisioned volumes, the Real Used value always matches
the Size value.
v Thin provisioned volumes always have an asterisk in front of their name
(Label).
v Thin provisioned volumes of other storage systems are not supported by
Tivoli Storage Productivity Center. The Real Used value is displayed as
N/A.
Encrypted
Indicates if the volumes are on encrypted disks (Yes or No).

lszone
Use the lszone command to list the zones in a zone set. You must have Fabric
Administrator authority to use this command.

Syntax
tpctool lszone -user user -pwd password -url url -fabric WWN

-active -fs character -header -help -qs character

zone_set
-silent

Parameters and arguments

Command-line interface 89
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
zone_set
Specifies the zone set. The zone_set variable is the name of the zone set.

Examples
Listing all zones

The following command lists the names of all zones in the PARIS zone set:
tpctool> lszone -user me -pwd mypass -url myhost:myport
-fabric 100000051E34F6A8 PARIS

The following output is returned:

Name
==========
WINDOWSNT
SUNSOLARIS
TEST
...

Listing only the active zones

The following command lists the active zones:

tpctool> lszone -user me -pwd mypass -url myhost:myport
-fabric 100000051E34F6A8 -active PARIS

The following output is returned:

Name
==========
SUNSOLARIS

lszs
Use the lszs command to list information about zone sets. This information
includes the zone-set name and status. You must have Fabric Administrator
authority to use this command.

Syntax
tpctool lszs -user user -pwd password -url url -fabric WWN

90 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-active -l -fs character -header -help

-qs character -silent

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-fabric WWN
Specifies the fabric. The WWN variable is the World Wide Name (WWN).
-active
Specifies that only information about the active zone set should be listed. If
you omit this option, information about all zone sets is listed.
-l Specifies that the long version of the information should be listed:
v Name
v Status: active or inactive
If you omit this option, only the name of the zone is listed.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Examples

Listing the long version of information for all zone sets

The following command lists the long version of information for all zone sets:
tpctool> lszs -user me -pwd mypass -url myhost:myport
-fabric 100000051E34F6A8 -l

The following output is returned:

Command-line interface 91
Name Status
=================
PARIS ACTIVE
LONDON INACTIVE

Listing the active zone set

The following command lists the name of the active zone set:
tpctool> lszs -user me -pwd mypass -url myhost:myport
-fabric 100000051E34F6A8 -active

The following output is returned:

Name
=====
PARIS

mksrg
Use this command to create a Storage Resource Group with a specific name,
description, and user-defined properties.

Syntax
tpctool mksrg -user user -pwd password -url url name SRGname

udp1 SRGUDP1 udp2 SRGUDP2 udp3 SRGUDP1

description SRGDescription

-fs character -header -help -qs character

-silent

Parameters and arguments

92 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

udp1SRGUDP1
(optional) A user-defined property that may contain anything of significance to
the Storage Resource Group administrator. The UDP can contain any
alphanumeric character, and must be less than 255 characters long.
udp2SRGUDP2
(optional) A user-defined property that may contain anything of significance to
the Storage Resource Group administrator. The UDP can contain any
alphanumeric character, and must be less than 255 characters long.
udp3SRGUDP3
(optional) A user-defined property that may contain anything of significance to
the Storage Resource Group administrator. The UDP can contain any
alphanumeric character, and must be less than 255 characters long.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Examples

To create a Storage Resource Group

The following command creates a Storage Resource Group with the specified
attributes:
tpctool
tpctool> mksrg -name testsrg -description Test-SRG-Description
-udp1 myudp1 -udp2 myudp2 -udp3 myudp3

The following output is returned:

Name Status
=============================
Administrator.testsrg SUCCESS

mkvol
Use the mkvol command to create volumes. You must have Disk Administrator
authority to use this command.

Syntax
tpctool mkvol -user user -pwd password -url url -array array

Command-line interface 93
-size size -lss lss
-count count -fs character -header

-help -qs character -silent

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-array array
Specifies the array. The array variable is the array ID. You can use the lsarray
command to return information, including array IDs, about the arrays on a
specific storage subsystem. The array must not be a count, key, or data (CKD)
format array.
-size size
Specifies the volume size. The size variable is the volume size.
-lss lss
Specifies the LSS in which to create the volumes. The lss variable is the LSS
identifier. If the pool specified is not defined within the specified LSS then an
error will be generated stating that there is not enough space on the specified
pool.
-count count
Specifies the number of volumes. The count variable is an integer.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

94 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Examples

Creating volumes

The following commands create four volumes:

tpctool
tpctool> mkvol -array 2105.22232+2105.22232+0 -size 20 -count 4 -lss 01

The following output is returned:

Volume PoolID Status
==================================================================
000000000000000000001223+6+2105.22232+0 P0 SUCCESS
000000000000000000001223+6+2105.22232+1 P1 SUCCESS
000000000000000000001223+6+2105.22232+2 P2 SUCCESS
000000000000000000001223+6+2105.22232+3 P3 SUCCESS

mkzone
Use the mkzone command to create a zone. This command must be run within a
transaction. You must have Fabric Administrator authority to use this command.

Syntax
tpctool mkzone -user user -pwd password -url url -fabric WWN

-zone zone ports

-help -silent -

Parameters and arguments

Command-line interface 95
Examples

Creating a zone

Important:
v An orphan zone is one that does not belong to a zone set. If the zone that you
are creating is an orphan zone and the switch and Data Source that you are
using support orphan zones, use only the mkzone command to create the zone.
However, if the switch and Data Source that you are using do not support
orphan zones, you must use the addzone command within the same transaction
to add the zone to a zone set. Specify the addzone command after you create the
zone using the mkzone command. For details about adding a zone to a zone set,
see the addzone command.
v To activate your changes to a zone set, use the actzs command. For details, see
the actzs command.

The switch that you are using does not support orphan zones. To create the
SUNSOLARIS zone, add the zone to a zone set, and activate the zone set, enter the
following commands. Specify all zoning changes within one transaction, from start
to commit, and then activate the zone set using the actzs command. The list of
WWPNs is read from standard input.
tpctool> start -user me -pwd mypass -url myhost:myport -fabric 100000051E34F6A8
tpctool> mkzone -fabric 100000051E34F6A8 -zone SUNSOLARIS -
tpctool> addzone -fabric 100000051E34F6A8 -zs PARIS SUNSOLARIS
tpctool> commit -fabric 100000051E34F6A8
tpctool> actzs -fabric 100000051E34F6A8 PARIS

mkzs
Use the mkzs command to create a zone set. This command must be run as a
transaction. You must have Fabric Administrator authority to use this command.

Syntax
tpctool mkzs -user user -pwd password -url url -fabric WWN

zone_set
-help -silent

Parameters and arguments

96 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
zone_set
Specifies the zone set. The zone_set variable is the name of the zone set.

Tip: To create a zone set, you must include at least one zone.

Examples

Creating a zone set

The following commands create the PARIS zone set, which includes the
SUNSOLARIS zone:
tpctool> start -user me -pwd mypass -url myhost:myport -fabric 100000051E34F6A8
tpctool> mkzone -fabric 100000051E34F6A8 -zone SUNSOLARIS -
tpctool> mkzs -fabric 100000051E34F6A8 PARIS
tpctool> addzone -fabric 100000051E34F6A8 -zs PARIS SUNSOLARIS
tpctool> commit -fabric 100000051E34F6A8

modifysrg
Use the modifysrg to modify an existing Storage Resource Group. You can add
and remove members by specifying the member type, such as switch or volume,
and the key for the member you want to add or remove.

Syntax
tpctool modifysrg -user user -pwd password -url url -add -remove

-name SRGName -type srg -key memberKey

fabric -help
switch
server
subsystem
pool
tapelibrary
tapedrive
tapemediachanger
volume
hostdisk
vmdisk
mdisk
disk

-fs character -qs character -silent -header

Parameters and arguments

Command-line interface 97
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-add
Adds a new member to the specified Storage Resource Group, designated by
the specified member type and key.
-remove
Removes an existing member from the specified Storage Resource Group,
designated by the specified member type and key. Use the lssrgmembers
-name SRGNameto see a list of members and member keys for a specified
Storage Resource Group.
-name SRGName
Indicates the unique Storage Resource Group to take action on. See the output
of lssrg.
-type srg | fabric | switch | server | subsystem | pool | tapelibrary |
tapedrive |
tapemediachanger | volume | hostdisk | vmdisk | mdisk | disk
Denotes the type of element that corresponds to the unique key in the key
parameter of this function.
-key memberKey
The unique key that corresponds to the member and member type specified in
the type parameter.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Examples

To add or remove members of a Storage Resource Group

The following command allows you to add or remove members of a specified

Storage Resource Group:
tpctool
tpctool> modifysrg -remove -name test.srg -type srg
-key IBM.2107-1300361-R8+2107-1300361+0

The following output is returned:

Name Status
========================================
Administrator.my-new-example-srg SUCCESS

98 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

rmbackenddisktype
Use the rmbackenddisktype command to remove a back-end type of disk.

This command is available for Storwize V7000 and SAN Volume Controller storage
systems. You must have Disk Administrator authority to use this command.

When you issue the rmbackenddisktype command to remove a back-end type of

disk:
v The type is removed from the set of back-end types of disk.
v The type is reset to DEFAULT in back-end storage subsystems that are set to the
type of disk that is removed.

Tip: You can use the following commands to set the back-end type of disk:
v setarray
v setbackenddisktype
You can also set the back-end type of disk for storage systems on the MDisk
Group Details page in the Tivoli Storage Productivity Center graphical user
interface.

Syntax
tpctool rmbackenddisktype -type disk_type

-user user -pwd password -url url

-fs character -header

-help -qs character -silent -grouping

Parameters and arguments

-type disk_type
Specifies the back-end type of disk. Specify a back-end type of disk or enter
one of the following values:

Value Description
A07 Sata - 7,500 rpm
F10 Fiber - 10,000 rpm
F15 Fiber - 15,000 rpm
DEFAULT Default value

Command-line interface 99
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
-grouping
Enables the grouping of numeric values. For example, in English the value
12000 would display as 12,000. The grouping character is determined by the
system locale.

Examples

Removing a back-end type of disk

The following command removes a back-end type of disk:

tpctool> rmbackenddisktype -type A07

The back-end type of disk that has been removed is displayed:

Back-end Disk Type Status
============================
A07 Succeeded

rmbackendraidtype
Use the rmbackendraidtype command to remove a back-end RAID array type
from the set of RAID array types available for Storwize V7000 and SAN Volume
Controller managed disk groups.

This command applies only to Storwize V7000 and SAN Volume Controller RAID
arrays.You must have Disk Administrator authority to use this command.

Syntax
tpctool rmbackendraidtype -type raid_type

-user user -pwd password -url url

-fs character -header

-help -qs character -silent -grouping

Parameters and arguments

-type raid_type
Specifies the type of the back-end RAID array to remove. You can specify a
value that you have set or one of the following values:

100 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Tip: Use the lsbackendraidtypes command to list the types of back-end RAIDs
.

Value Description
DEFAULT The default RAID type.
1 RAID 1
5 RAID 5
6 RAID 6
X The RAID type used by IBM XIV Storage System.

Examples

Removing a type of back-end RAID

The following command removes a type of back-end RAID array:

tpctool> rmbackendraidtype -type testing

If the command is successful, a list of the types of back-end RAIDs that have been
removed is displayed:
Back-end Type Status
=======================
testing Succeeded

Command-line interface 101

rmbackendtype
Use the rmbackendtype command to remove a type of back-end storage system.

This command is available for Storwize V7000 and SAN Volume Controller storage
systems. You must have Disk Administrator authority to use this command.

When you issue the rmbackendtype command to remove a type of back-end

storage system, the following actions occur:
v The type is removed from the set of back-end types.
v The type is reset to DEFAULT in back-end storage systems that are set to the
back-end type that is removed.

Tip: You can use the following commands to set the type of back-end storage
system:
v setarray
v setbackendtype
You can also set the type of back-end storage system on the MDisk Group Details
page in the Tivoli Storage Productivity Center graphical user interface.

Syntax
tpctool rmbackendtype -type storage_system_type

-user user -pwd password -url url

-fs character -header

-help -qs character -silent -grouping

Parameters and arguments

-type storage_system_type
Specifies the type of back-end storage system that manages most of the storage
pool resources. Specify a type of back-end storage system or enter one of the
following values:

Tip: Use the lsbackendtypes command to show a list of back-end storage

systems.

Value Description
C EMC Clariion
D IBM System Storage DS8000
S EMC Symmetrix
X IBM XIV Storage System
V IBM System Storage DS4000
DEFAULT Default value

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.

102 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
-grouping
Enables the grouping of numeric values. For example, in English the value
12000 would display as 12,000. The grouping character is determined by the
system locale.

Examples

Removing a type of back-end storage system

The following command removes the specified type of back-end storage system:
tpctool> rmbackendtype -type L

The type of back-end storage system that is removed is displayed:

Back-end Type Status
========================
L Succeeded

rmsrg
Use the rmsrg command to delete the specified Storage Resource Group.

Syntax
tpctool rmsrg -user user -pwd password -url url name SRGname

-fs character -header -help -qs character

-silent

Command-line interface 103

Parameters and arguments
-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-nameSRGname
The name of the Storage Resource Group to be deleted.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Examples

To delete a Storage Resource Group

The following command deletes a specified Storage Resource Group:

tpctool
tpctool> rmsrg -name Administrator.testsrg

The following output is returned:

Name Status
=============================
Administrator.testsrg SUCCESS

rmvol
Use the rmvol command to remove volumes. You must have Disk Administrator
authority to use this command.

Syntax
tpctool rmvol -user user -pwd password -url url
-f

104 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-fs character -header -help -qs character

volume_id
-silent -

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-f Turns off the confirmation message that is displayed before the volumes are
removed.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
volume_id | -
Specifies the volumes. The volume_ID variable is a comma-separated list of
volume IDs, such as that obtained by running the lsvol command. If a single
dash (-) is issued, the volume IDs are read from standard input.

Examples

Removing volumes from an array

The following command removes volumes from the specified array. Because the -f
option is specified, you are not prompted to confirm the removal:
tpctool> rmvol -f 000000000001107+6+2107.7597621+0

The following output is returned:

VolumeId PoolId Status
===================================================================
0000001107+6+2107.7597621+0 2107.7597621-vs1+2107.7597621+0 SUCCESS

Command-line interface 105

rmza
Use the rmza command to remove a zone alias or aliases from a zone. You must
have Fabric Administrator authority to use this command.

Syntax
tpctool rmza -user user -pwd password -url url -fabric WWN

-zone zone zone_alias

-help -silent

Parameters and arguments

Examples

Removing zone aliases from a zone

The following commands remove the PARIS zone alias from the EUROPE zone:
tpctool -user me -pwd mypass -url myhost:myport
tpctool> start -fabric 100000051E34F6A8
tpctool> rmza -fabric 100000051E34F6A8 -zone EUROPE PARIS
tpctool> commit -fabric 100000051E34F6A8

rmzaports
Use the rmzaports command to remove a port or ports from a zone alias. You
must have Fabric Administrator authority to use this command.

Syntax

106 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

tpctool rmzaports -user user -pwd password -url url -fabric WWN

-za zone_alias port

-help -silent

Parameters and arguments

Examples

Removing a port from a zone alias

The following commands remove a port from the PARIS zone alias:
tpctool> -user me -pwd mypass -url myhost:myport
tpctool> start -fabric 100000051E34F6A8
tpctool> rmzaports -fabric 100000051E34F6A8 -za PARIS 210000E08B0B4C2G
tpctool> commit -fabric 100000051E34F6A8

rmzone
Use the rmzone command to delete a zone or remove a zone from a zone set. If
you remove or delete the last zone in a zone set, the zone set is also deleted. This
command must be run as a transaction. You must have Fabric Administrator
authority to use this command.

Syntax
tpctool rmzone -user user -pwd password -url url -fabric WWN

-zone zone
-zs zone_set -help -silent

Command-line interface 107

Parameters and arguments
-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-fabric WWN
Specifies the fabric. The WWN variable is the World Wide Name (WWN).
-zone zone
Specifies the zone. The zone variable is the name of the zone. If the last zone in
the zone set is removed or deleted, the zone set also is deleted.
-zs zone_set
Specifies that zone is removed from the zone set. The zone_set variable is the
name of the zone set. If this option is not issued, the zone is deleted.
-help | -h | -?
Lists help information for the command.
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

| Tip: To delete a zone from a zone set, the zone must be included in another zone
| set.

Examples

Deleting a zone

The following commands delete the WINDOWSNT zone:

tpctool> start -user me -pwd mypass -url myhost:myport -fabric 100000051E34F6A8
tpctool> rmzone -fabric 100000051E34F6A8 -zone WINDOWSNT
tpctool> commit -fabric 100000051E34F6A8

Removing a zone from a zone set

The following commands remove the WINDOWSNT zone from the PARIS zone
set:
tpctool> start -user me -pwd mypass -url myhost:myport -fabric 100000051E34F6A8
tpctool> rmzone -fabric 100000051E34F6A8 -zone WINDOWSNT -zs PARIS
tpctool> commit -fabric 100000051E34F6A8

rmzoneports
Use the rmzoneports command to remove switch ports from a zone. This
command must be run as a transaction. You must have Fabric Administrator
authority to use this command.

Syntax

108 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

tpctool rmzoneports -user user -pwd password -url url -fabric WWN

-zone zone ports

-help -silent -

Parameters and arguments

Examples

Removing switch ports from a zone set

The following commands remove several switch ports from the SUNSOLARIS
zone. The list of WWPNs is read from standard input:
tpctool> start -user me -pwd mypass -url myhost:myport -fabric 100000051E34F6A8
tpctool> rmzoneports -fabric 100000051E34F6A8 -zone SUNSOLARIS -
tpctool> commit -fabric 100000051E34F6A8

rmzs
Use the rmzs command to delete a zone set. This command must be run as a
transaction. You must have Fabric Administrator authority to use this command.

Syntax
tpctool rmzs -user user -pwd password -url url -fabric WWN

zone_set
-help -silent

Command-line interface 109

Tip: To delete a zone set, it must be inactive. If you attempt to delete a zone set
that is empty, the zone set is not deleted and no error message is given.

Examples

Deleting a zone set

The following commands delete the PARIS zone set:

tpctool> start -user me -pwd mypass -url myhost:myport -fabric 100000051E34F6A8
tpctool> rmzs -fabric 100000051E34F6A8 PARIS
tpctool> commit -fabric 100000051E34F6A8

rollback
Use the rollback command to erase any commands that were issued since you
started the transaction. You must have Fabric Administrator authority to use this
command.

Syntax
tpctool rollback -user user -pwd password -url url -fabric WWN

-help

Parameters and arguments

110 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-fabric WWN
Specifies the fabric. The WWN variable is the World Wide Name (WWN).
-help | -h | -?
Lists help information for the command.

Examples

Rolling back a transaction

The following command rolls back a transaction. The user has previously issued
connection options, started a transaction, and issued a fabric-control command:
tcptool> rollback -fabric 100000051E34F6A8

setarray
Use the setarray command to set the type of back-end storage system, type of
Redundant Array of Independent Disks (RAID), type of disk, and number of disks
for an array.

This command is available for Storwize V7000 and SAN Volume Controller storage
systems. You must have Disk Administrator authority to use this command.

Syntax
tpctool setarray -user user -pwd password -url url -array array_id

-backendtype
storage_system_type -fs character -header -help
-backendraid
raid_type
-backenddisk
disk_type
-backenddiskcount
disk_count

-qs character -silent -grouping

Parameters and arguments

When you issue the setarray command, you must enter a value for the array
parameter and at least one of the following parameters:
v -backendtype
v -backendraid
v -backenddisk
v -backenddiskcount
The default value is used for the parameters that you do not set.

Tip: You can set the values for back-end storage systems on the MDisk Group
Details page in the Tivoli Storage Productivity Center graphical user interface.

Command-line interface 111

Tip: Use the lsbackendtypes command to provide a list of existing back-end

types of storage systems and use the setbackendtype command to add new
back-end types of storage systems.

Value Name
C EMC Clariion
D DS8000
S EMC Symmetrix
X XIV
V DS4000
DEFAULT Default value

-backendraid raid_type
Specifies the type of RAID associated with the back-end storage system. You
can enter a type that you added or use one of the following values.

Tip: Use the lsbackendraidtypes command to provide a list of existing

back-end types of RAID and use the setbackendraidtype command to add
new back-end types of RAID.

Value Description
1 RAID 1
5 RAID 5
6 RAID 6
X RAID X
DEFAULT Default value

-backenddisk disk_type
Specifies the type of disk. You can enter a type that you added or use one of
the following values.

Tip: Use the lsbackenddisktypes command to provide a list of existing

back-end types of disk and use the setbackenddisktype command to add new
back-end types of disk.

112 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Value Description
A07 Sata - 7,500 rpm
F10 Fiber - 10,000 rpm
F15 Fiber - 15,000 rpm
DEFAULT Default value

-backenddiskcount disk_count
Specifies the number of disks.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
-grouping
Enables the grouping of numeric values. For example, in English the value
12000 would display as 12,000. The grouping character is determined by the
system locale.

Examples

Setting back-end storage subsystem values

The following command sets the back-end storage system, type of RAID, type of
disk, and the number of disks for the specified array:
tpctool> setarray -array 0000020064405BA0:0+0000020064405BA0+0 -backendtype D
-backendraidtype 5 -backenddisktype F10 -backenddiskcount 160

The array ID and the status of the message is displayed:

Array List Status
================================================
0000020064405BA0:0+0000020064405BA0+0 Succeeded.

setbackenddisktype
Use the setbackenddisktype command to set or update the type of back-end disk.

This command applies only to Storwize V7000 and SAN Volume ControllerYou
must have Disk Administrator authority to use this command.

Syntax for setting and updating back-end disk types

Use this syntax to set a new type of back-end disk:

Command-line interface 113

tpctool setbackenddisktype -user user -pwd password -url url

-type disk_type -iops disk_iops -description description

-fs character -header -help -qs character

-silent -grouping

Use this syntax to update the type of a back-end disk:

tpctool setbackenddisktype -user user -pwd password -url url

-type disk_type -iops disk_iops

-description description

-fs character -header -help -qs character

-silent -grouping

Parameters and arguments

Value Description
A07 Sata - 7 500 rpm
F10 Fiber - 10 000 rpm
F15 Fiber - 15 000 rpm
DEFAULT Default type for unconfigured devices

-iops disk_iops
The average number of input/output operations per second for the disk. You
can specify a value or use one of the following values:

IOPS Value Back-end Disk Type

40 A07
120 F10
150 F15

114 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

IOPS Value Back-end Disk Type
0 Default value for unconfigured devices

-description description
Provides additional information about the type of back-end disk. The
maximum number of characters that you can enter is 256.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
-grouping
Enables the grouping of numeric values. For example, in English the value
12000 would display as 12,000. The grouping character is determined by the
system locale.

Examples
Setting a back-end disk type

The following command sets the type of back-end disk for a back-end disk pool:
tpctool> setbackenddisktype -type testing -description testing -iops 99

If the command is successful, the following message is displayed:

Back-end Disk Type Status
=======================
testing Succeeded.

setbackendraidtype
Use the setbackendraidtype command to set the types of back-end RAID arrays
for Storwize V7000 and SAN Volume Controller managed disk groups.

This command applies only to Storwize V7000 and SAN Volume ControllerYou
must have Disk Administrator authority to use this command.

Syntax
tpctool setbackendraidtype -user user -pwd password -url url

Command-line interface 115

-type raid_type -weightedio weighted_io
-fs character -header

-help -qs character -silent -grouping

Parameters and arguments

-type raid_type
Specifies the type of the back-end RAID array. You can specify a back-end
RAID type or use one of the following values:

Value Description
DEFAULT The default RAID type.
1 RAID 1
5 RAID 5
6 RAID 6
X The RAID type used by IBM XIV Storage System.

Tip: Use the lsbackendraidtypes command to list the available types of

back-end RAIDs .
-weightedio weighted_io
The weighted input/output of the RAID type.
-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

116 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-grouping
Enables the grouping of numeric values. For example, in English the value
12000 would display as 12,000. The grouping character is determined by the
system locale.

Examples

Setting back-end RAID types

The following command sets a type of back-end RAID:

tpctool> setbackendraidtype -type testing -weightedio 15

If the command is successful, the following message displays:

Back-end RAID Type Weighted IO
=======================
testing Succeeded.

setbackendtype
Use the setbackendtype command to set or update the type of back-end storage
system.

This command is available for Storwize V7000 and SAN Volume Controller storage
systems. You must have Disk Administrator authority to use this command.

Syntax for setting and updating back-end types of storage

systems

Use this syntax to set a new type of back-end storage system:

tpctool setbackendtype -user user -pwd password -url url

-type storage_system_type -name storage_system_name

-cachehit cache_hit_ratio -description description

-fs character

-header -help -qs character -silent -grouping

Use this syntax to update a type of back-end storage system:

tpctool setbackendtype -user user -pwd password -url url

-type storage_system_type
-name storage_system_name

-cachehit cache_hit_ratio -description description

-fs character -header -help -qs character

-silent -grouping

Command-line interface 117

Value Name of storage system

C EMC Clariion
D DS8000
S EMC Symmetrix
X XIV
V DS4000
DEFAULT Default value

-name storage_system_name
Specifies the name of the back-end type of storage system. The maximum
number of characters that you can enter is 256. The name of the type of storage
system is displayed on the MDisk Group Details page in the Tivoli Storage
Productivity Center graphical user interface. You can enter a name or use one
of the following values.

Tip: If you enter a value for the -name or -description parameter that contains
spaces, you must enclose the value in double quotation marks such as "My
Description".

Description value Associated type value

"EMC Clariion" C
DS8000 D
"EMC Symmetrix" S
XIV X
DS4000 V
DEFAULT DEFAULT

-cachehit cache_hit_ratio
Specifies the ratio of cache hits for read operations. The maximum number of
characters that you can enter is 4. You can specify a value or use one of the
following values:

Value Back-end storage system

50 EMC Clariion
50 DS8000

118 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Value Back-end storage system
70 EMC Symmetrix
50 DS4000
50 XIV
0 Default value

-description description
Provides additional information about the type of back-end storage system.
The maximum number of characters that you can enter is 256. You can enter a
description or use one of the following values:

Value Description
"CX BE Cache Hit Ratio" EMC Clariion
"DS8K Disk Controller" DS8000
"DMX BE Cache Hit Ratio" EMC Symmetrix
"IBM XIV" XIV
"DS5K Disk Controller" DS4000
"DEFAULT TYPE FOR UNCONFIGURED 0 (default value)
DEVICES"

Examples

Setting a new type of back-end storage system

The following command sets a new type of back-end storage system:

setbackendtype -type L -name test3 -cachehit 90 -description test_3

The following message is displayed:

Command-line interface 119

Back-end Type Status
========================
L Succeeded.

setdscfg
Use the setdscfg command to set the value of a property in the property file for
the Device server. You must have IBM Tivoli Storage Productivity Center
administrator authority to use this command.

Syntax
tpctool setdscfg -user user -pwd password -url url
-help

-property property_key value

-silent -context context

Parameters and arguments

This parameter applies to the Tivoli Storage Productivity Center device server
only.
-context PerformanceManager

This parameter applies to the Tivoli Storage Productivity Center performance

manager only.

Examples

Setting a property value

The following command sets the value of the SnmpRetryCount property to 3:

120 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

tpctool setdscfg -url localhost:9550 -user ***** -pwd ***** -property
SnmpRetryCount -context DeviceServer 3

setdslogopt
Use the setdslogopt command to set options for the log file used by the Device
server. You must have IBM Tivoli Storage Productivity Center administrator
authority to use this command.

Syntax
tpctool setdslogopt -user user -pwd password -url url

-filterkey INFO -maxfiles number -maxfilesize size

ERROR
WARN

-format plain_text
pdxml -help -silent

Parameters and arguments

Command-line interface 121

Examples

Setting log file options

The following command sets options for the log file used by the Device server:
tpctool> setdslogopt -user me -pwd mypass -url myhost:myport -filterkey character
-maxfiles 4 -maxfilesizes 10 -format plain_text

start
Use the start command to start a transaction. You must have Fabric Administrator
authority to use this command.

Syntax
tpctool start -user user -pwd password -url url -fabric WWN

-help

Parameters and arguments

Examples

Starting a transaction

The following command starts a transaction:

tpctool> start -user me -pwd mypass -url myhost:myport -fabric 100000051E34F6A8

unassignvol
Use the unassignvol command to remove the host ports from the assignment list
for a volume. You must have Disk Administrator authority to use this command.

Syntax
tpctool unassignvol -user user -pwd password -url url

122 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-hp host_port -dev GUID
-f -fs character -header

volume_id
-help -qs character -silent -

Parameters and arguments

-user user
Specifies a valid Tivoli Storage Productivity Center user ID.
-pwd password
Specifies the password for the Tivoli Storage Productivity Center user ID.
-url url
Specifies the Device server. The format of url is: system:port_number where
system represents either the host name or IP address, and port_number
represents a valid port number for the HTTP service of the Device server.
-hp host_port
Specifies the host ports. The host_port variable is a comma-separated list of
worldwide port numbers (WWPNs).
-f Turns off the confirmation message that is displayed before the ports are
removed from the assignment list.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-dev GUID
Specifies the storage subsystem. The GUID variable is the globally unique
identifier (GUID) of the storage subsystem as returned by the lsdev -subsys
command.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.
volume_id | -
Specifies the volumes. The volume_ID variable is a comma-separated list of
volume IDs, such as that obtained by running the lsvol command. If a single
dash (-) is issued, the volume IDs are read from standard input.

Examples

Removing host ports

Command-line interface 123

The following command removes three host ports from the assignment list for the
indicated volume:
tpctool> unassignvol -user me -pwd mypass -url myhost:myport
-hp 5005076300C79470,5005076300D09470,5005076300CB9470 2105.22232

The following output is returned:

Volume ID PoolID Status
===========================================
2105.22232 P0 SUCCESS
2105.22232 P1 SUCCESS
2105.22232 P2 SUCCESS

updatesrg
This command updates the attributes of the specified Storage Resource Group with
a new name, description, or user-defined properties.

Syntax
tpctool updatesrg -user user -pwd password -url url

currentname currentSRGName newname newSRGName

newudp1 user-defined-property1
-newdescription newdescription

newudp2 user-defined-property2 newudp3 user-defined-property3

-fs character -header -help -qs character

-silent

Parameters and arguments

currentname currentSRGName
The currentSRGName must be a unique name already in use, less than 60
characters long, and may not contain any of the following characters:
\/:*?"<>|. The currentSRGName should be prepended with the username of
its creator, such as that returned by lssrg -l
newname newSRGName
A unique name not already in use, less than 60 characters long. It can not
contain any of the following characters:
\ / : * ? " < >|

. The username of the user creating the Storage Resource Group will be added
to the beginning of the Storage Resource Group name, followed by the name
specified in the name variable.
-newdescription newdescription
The description can contain any alphanumeric characters, and must be less
than 255 characters long.
newudp1 user-defined-property1
(optional) A user-defined property that may contain anything of significance to
the Storage Resource Group administrator. The UDP can contain any
alphanumeric character, and must be less than 255 characters long.

124 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

newudp2 user-defined-property2
(optional) A user-defined property that may contain anything of significance to
the Storage Resource Group administrator. The UDP can contain any
alphanumeric character, and must be less than 255 characters long.
newudp3 user-defined-property3
(optional) A user-defined property that may contain anything of significance to
the Storage Resource Group administrator. The UDP can contain any
alphanumeric character, and must be less than 255 characters long.
-fs character
Specifies the 7-bit character that separates the fields in the output. If you omit
this parameter, the fields are separated by spaces.
-header
Suppresses the column headers in the output. If you omit this parameter, the
column headers are enabled.
-help | -h | -?
Lists help information for the command.
-qs character
Specifies the 7-bit character that surrounds strings and date stamps in the
output. If you omit this parameter, strings and date stamps are enclosed by
double quotation marks (").
-silent
Suppresses all output for the command. If you omit this parameter, output is
enabled.

Examples

To update the attributes of a Storage Resource Group

The following command updates a Storage Resource Group with the specified
attributes:
tpctool
tpctool> updatesrg -name testsrg -description Test-SRG-Description
-udp1 myudp1 -udp2 myudp2 -udp3 myudp3

The following output is returned:

Name Status
========================================
Administrator.my-new-example-srg SUCCESS

csmcli command
The csmcli command is the IBM Tivoli Storage Productivity Center for Replication
command line interpreter (CLI) program. This command can be used either on its
own, using the associated options and arguments, or interactively by invoking
csmcli with no parameters or arguments to start an interactive session.

Syntax

Command-line interface 125

csmcli
-help
-h command_name
-?
-overview
-noinfo
-username user_name -password password
-server domain_name
ip_address
-port port
-script file_name

Parameters
-help | -h | -? [command_name]
Displays help for the specified command. If you do not specify a command
name, this option displays help for the csmcli command. If you specify
additional parameters and arguments other than a command name, those
parameters and arguments are ignored.
-overview
Displays overview information about using the CLI program.
-noinfo
Removes the copyright, version, and build information when you start the
csmcli.
-username user_name
Specifies the IBM Tivoli Storage Productivity Center for Replication user name
with which you want to log in.
-password password
Specifies the password for the IBM Tivoli Storage Productivity Center for
Replication user name with which you want to log in.

Important: When you specify this option, the password is displayed as plain
text. Using this form of authentication could cause a security exposure.
If you specify a user name but not a password, and IBM Tivoli Storage
Productivity Center for Replication does not find the password in an
authentication file, you are prompted for the password. If prompted for the
password, the password does not display in plain text.
-server {domain_name | ip_address}
Sets the domain name or IP address of the IBM Tivoli Storage Productivity
Center for Replication server to which you want to connect.

Note: The server domain name or IP address is used only during this CLI
session.
-portport
Sets the port number to be used by the CLI program to connect to the IBM
Tivoli Storage Productivity Center for Replication server. The default value is
5110.

Note: The port number is used only during this CLI session.
-script file_name
Runs the set of command strings in the specified file outside of an interactive
CLI session. If you specify this parameter, you must specify a file name.

126 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

The format options specified using the setoutput command apply to all
commands in the script.
command_string
Runs the specified command string outside of an CLI session.

Description

You can run csmcli commands locally from the management server or remotely by
accessing the management server using a remote-access utility, such as secure shell
(SSH) or Telnet.

Invoking the csmcli command without any parameters, except the user name and
password, starts a interactive CLI session.

Note: You can also go to the installation directory and double-click the csmcli.bat
or csmcli.sh file to start a csmcli session in interactive mode. For example, on a
Windows system, the csmcli.bat file is located in C:\Program Files\IBM\
replication.

Note: On Linux systems, you must enter the CLI program name (csmcli) lower
case. Command input can be either lowercase, uppercase, or mixed case, unless
specific command parameters require case sensitivity.

Each CLI command issues a return value and message. Warning and informational
messages are written to the standard output stream (stdout). Error messages are
written to stderr. If a syntax error occurs while one of the commands in the script
is running, the script exits at the point of failure and returns to the system prompt.

Example
1. Start an interactive CLI session
This example illustrates how to start an CLI session if you have not set up an
authentication configuration file.
shell> cmscli -username admin -password admin
csmcli>
2. Set the server and port for the management server
This example illustrates how to set the server domain name to localhost and
port number to 5110 for the local management server.
shell> cmscli -server localhost -port 5110
3. Run several commands using a script file
This example illustrates how to run several commands using a script file name
cli_script.txt.
shell> cmscli -script cli_script.txt

Command-line interface conventions

This topic provides information about using the CLI program for IBM Tivoli
Storage Productivity Center for Replication. It includes information about
command conventions and modes, command format requirements, and other
usage information.

Presentation of command information

This topic describes how information is presented in the command descriptions.

Command-line interface 127

A syntax diagram uses symbols to represent the elements of a command and to
specify the rules for using these elements. A keyword represents the name of a
command, flag, parameter, or argument. Required key words indicate the
parameters or arguments that must be specified for the command.

Syntax diagrams conventions

To read syntax diagrams, follow the path of the line. Read the diagrams from
left-to-right, top-to-bottom, following the main path line:
v Required keywords are displayed on the main path line. Mutually exclusive
required keywords are stacked vertically. Optional key words indicate the
parameters or arguments you can choose to specify for the command. Optional
keywords appear below the main path line. Mutually exclusive optional
keywords are stacked vertically.
v The main path line begins on the left with double arrowheads (>>) and ends on
the right with two arrowheads facing each other (><). If a diagram is longer
than one line, each line to be continued ends with a single arrowhead (>) and
the next line begins with a single arrowhead. The -->< symbol indicates the end
of the syntax diagram.
v A dash (-) indicates that you must supply parameters from the stdin file rather
than entering parameters.
v An arrow returning to the left means you can repeat the item. A character or
space within the arrow means you must separate repeated items with that
character or space.
v A stack of items followed by an arrow returning to the left means that you can
select more than one item or, in some cases, repeat a single item.
v When a group of parameters is lengthy or a section is used more than once in a
command, it is shown as a separate fragment following the main diagram.

Syntax diagrams use position to indicate required, optional, and default values for
keywords, variables, and operands:
v If an element is shown on the line, the element is required. If an element is
shown below the line, the element is optional. If an element is shown above the
line, the element is the default.
v If an operand has a default value, the operand is shown both above and below
the main line. A value below the main line indicates that the operand must be
specified. You must specify the default value or one of the other valid values
that are shown. If an operand is not specified, the default value above the main
line is used.
v When one or more items are shown below the main line, all of the items are
optional.

Command emphasis

The following typefaces are used to show command emphasis:

boldface
Text in boldface represents command names.
italics Text in italics is used for variables for which you supply actual values, such
as a default directory or the name of a cluster.
monospace
Text in monospace identifies the data or commands that you type, samples

128 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

of command output, examples of program code or messages from the
system, or names of command flags, parameters, arguments, and
name-value pairs.

Special characters

The following special characters are used in the command descriptions:

minus sign (-)
Flags are prefixed with a minus sign (-). Flags define the action of a
command or modify the operation of a command. You can use multiple
flags, followed by parameters, when you issue a command. This character
cannot be used as the first character of an object name.
vertical bar ( |)
A vertical bar signifies that you choose only one value.
For example, [ a | b ] indicates that you can choose a, b, or nothing.
Similarly, { a | b } indicates that you must choose either a or b.
quotation marks (" ")
Quotation marks around a string indicate that the value can include
spaces, for example, "my session name."
brackets ([ ])
Brackets indicate optional options, parameters, and arguments.
braces ({ })
Braces indicate a required choice between two or more options or
arguments.
ellipsis (...)
Ellipses indicate repetition or multiple values or arguments.

Command entry
This topic describes how to enter commands in a valid format.

Order of parameters

Parameters can be entered in any order, with the following exceptions:

v The first argument following the command name must be the action that is to be
performed.
v If you are performing an action on a specific object, the object ID or name must
be the last argument in the line.

Multiple values

For any commands that accept multiple input values of the same type, delimit the
values with a comma with no spaces in the input string (for example, -vol
3,5,8,9).

For any commands that require multiple value types in one string, delimit the
value types with a period. For example, if a volume requires a device number and
a volume number, you might specify -vol FCA86.3,FCA78.5,FCA96.8. When input
values are of different types but specified in the same flag, use a colon. For
example, to specify a minimum and maximum value in the same flag, you would
type –size min:max.

Command-line interface 129

Multiple arguments

IBM Tivoli Storage Productivity Center for Replication supports multiple

arguments for the commands chauth, chsess, lsdevice, lssess, lssessactions, lsvol,
and rmsess. If you invoke a command with multiple arguments, the command will
be applied for each of the arguments. For example, you might issue the following
command to remove session_a, session_b, and session_c.
#rmsess session_a session_b session_c

When a command runs on more than one argument, the CLI program establishes a
single security session to run the command on each of the multiple arguments.

Volumes and locations

The following volume values are valid:

ESS devices
Valid volume values include the device type, component type, device ID,
subsystem ID, logical subsystem ID, and volume ID, with each separated
by a period or colon. For example:
ESS single volume
ESS:2105.65312:VOL:202F (ESS:ELEMENTTYPE.DEVICEID:VOL:LSSVOLNUM)

User-defined objects

These are the requirements for valid user-defined object names:

v User-defined object names can be 250 characters or fewer, unless otherwise
noted.
v Valid characters are A-Z, a-z, 0 - 9, dash (-), underscore (_), period (.), and colon
(:).
v Object names must start with an alphanumeric character.
v Most object names cannot contain any blank spaces. However, you can include
blanks in session names and location names.
v Do not translate user-defined objects or otherwise modify them from the user's
entry (they should remain case-sensitive).

User-defined descriptions

These are the requirements for valid user-defined descriptions:

v If a description contains spaces, it must be enclosed in matching double
quotation marks or single quotation marks.
v If a description that is already enclosed in matching quotation marks includes an
asterisk, the asterisk must be preceded by an escape character, for example,
-desc "This is the \* pool".
v If a description that is already enclosed in matching quotation marks includes
quotation marks or single quotation marks within the actual text string, these
characters must be escaped. For example, -desc "This is Hanna\’s description"
or –desc "This is the pool I call \"Foo\".’
v User-defined descriptions can be 250 characters or fewer. They cannot contain
any leading blank spaces.
v User-defined descriptions should not be translated or otherwise modified from
the user's entry, (that is they should remain case-sensitive).

130 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

v The CLI is sensitive to case when interpreting user-defined object names given
as input. For example, object FOO is different than object foo.

Command modes
You can use the command line interface (CLI) to run a single command or a series
of commands, either interactively or from a script.
Single-shot mode
If you want to run only a single command, specify the csmcli program and
the command that you want to run from the shell prompt, for example:
shell> csmcli lslocation
Location Details
=================
1 Boulder
3 Marana
2 Tucson
shell>
Interactive mode
If you want to run several commands, start an CLI session using the
csmcli program with no parameters or arguments, and then enter each
command at the csmcli> shell prompt, for example:
shell> csmcli
csmcli> rmsess exmp_session
Are you sure that you want to remove session exmp_session? [y/n]:y
Session exmp_session removed
csmcli> exit
shell>
Script mode
If you want to run a set of commands that you defined in a file, use the
csmcli program with the -script parameter, for example:
shell> tpctool -script ~/bin/containersetup
shell>

You can add comments to the script file by placing a pound sign (#) in the
first column, for example:
# This script file lists the default storage pool.
lspool -l -type default
The CLI program recognizes these built-in commands in interactive mode:
setoutput
Specifies various command-output format options. All settings
specified with setoutput remain in effect for the duration of the
interactive command session unless reset either with a command
option or with setoutput. With no options, setoutput displays the
current settings in the default output format. Settings from the
setoutput command do not apply to help pages; help pages are
shown in text output only.
Syntax

setoutput
default -p on
-fmt xml off
delimchar
stanza

Command-line interface 131

-hdr on -r number -v on
off off

Parameters and arguments:

132 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

on Enable verbose mode.
off Disable verbose mode. This is the default value.
help Displays a list of commands available from the CLI session.
exit Exits from the CLI session.
quit Exits from the CLI session.

User assistance for commands

You can get user assistance for the any csmcli command using the help command.

Syntax

help
-l command_name
-s

Parameters
-l Displays a list of all available commands and syntax for each if no other
options are specified. If a command name is also specified, this option displays
syntax for that command.
-s Displays a list of all available commands and a brief description of each if no
other options are specified. If a command name is also specified, this option
displays a brief description for that command.
command_name
Displays detailed help for the specified command

Description

If this command is invoked without any parameters, it displays a list of all

available commands.

You can use the command-help parameters (-help, -h, or -?) that are supported by
each command to display a detailed description of the specified command. For
more information about the command-help parameters, see the description for
each command.

Output from command processing

This topic describes command output and how to specify the output format.

Confirmation prompts

When commands might cause an irrecoverable operation, loss of data, memory

drain, or a long-running task, or might have an impact on concurrent operations,
you receive an interactive confirmation prompt that asks if you are sure that you
want to continue with the specific action, such as:
Are you sure you want to xxx? Y/N

All confirmation prompts accept the following input:

YES, yes, Y, y
Confirm action and continue.

Command-line interface 133

NO, no, N, n
Cancel action.

Messages

Messages are returned in the format of IWNCxxxxy, IWNRxxxxy, IWNHxxxxy, or

IWNExxxxy, where xxxx is the number of the message and y indicates that the
message type is I (information), W (warning), or E (error).

Each CLI command issues a return value and message. These messages are output
as follows:
v Warning and informational messages are written to stdout.
v Error messages are written to stderr.
v Messages include an explanation of the problem, if one exists.

Suppression of confirmation prompts and messages

You can use these flags to modify command input:

v To force destructive action, such as making a volume even if the LUN already
has a label, use the -f flag. This flag suppresses confirmation and error messages.
v To suppress confirmation prompts and messages, use the -quiet flag. This flag
answers yes to all confirmation prompts.

Exit codes

The following exit codes apply to all commands that you enter using the CLI
program.
Table 3. Exit codes for CLI commands
Code Category Description
0 Success The command was successful.
2 Syntax error The syntax of the command was not correct.
3 Connection error A connectivity error or protocol error
occurred.
4 Server error An error occurred during a function call to
the application server.
5 Authentication error An error was detected during authentication
checking.
6 Application error An error occurred during processing that is
performed by the MetaProvider client
application.

Notes:
v In single-shot mode, an exit code is provided after each command.
v In interactive and script mode, an exit code is not provided after each command.
Instead, output is echoed to stdout for status information.
v In single-shot and interactive mode, with commands that act on more than one
argument if one or more operations fail, the CLI will:
– Complete execution of all operations that it can continue executing
– Report on all successful completions
– Report on any failures

134 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

v In script mode, the CLI will operate the same way. However, if one or more
operations fail in the file specified, the CLI issues a failure exit code and
automatically exits from the script mode after the failed command.

Options for setting the output format of listings

The standard format parameters set the output format of the listing (ls) commands
in the CLI program. These parameters can be used either in one of the listing
commands or in the setoutput command. The format settings remain in effect for
the duration of the session or until you reset the parameters either by specifying
these parameters in a listing command (commands that start with ls) or using the
setoutput command.
v -p specifies whether to display one page of text at a time or all text at once.
v off displays all text at one time. This is the default value when the csmcli
command is run in single-shot mode.
v on displays one page of text at time. Pressing any key displays the next page.
This is the default value when the command is run in interactive mode.
v -r number specifies the number of rows per page to display when the -p
parameter is on. The default value is 24. You can specify a value of 1 - 100.
v -fmt specifies the format of the output. You can specify one of the following
values:
– default specifies that output be displayed in a tabular format using spaces as
the delimiter between the columns. This is the default value.
– delim character specifies that output be displayed in a tabular format using
the specified character to separate the columns. If you use a shell
metacharacter as the delimiting character, enclose the character in quotation
marks or single quotation marks. A blank space is not a valid character.
– xml specifies that output using XML format.
– -hdr specifies whether to display the table header. Use the default value of on
to display the table header. This is the default value. Use off to hide the table
header.
v -v specifies whether to enable verbose mode. Use the default value of off to
disable verbose mode. This is the default value. Use on to enable verbose mode.

These standard listing options modify command output in any CLI mode:
v lsobject-s lists only the objects without other columns of information. For
example, lssess –s lists only the name header and the session names.
v lsobject-l lists all the objects with all defined columns, including the description.

Example of using the setoutput command to define output formats

You can set output formats using the setoutput command in interactive or script
modes or using the corresponding standard command options in single-shot mode.
setoutput with no options
When you issue setoutput with no options, the CLI always displays the
current output settings in the default format (space-separated plain-text
table), regardless of the values of the output settings. For example, enter
the following command:
csmcli> setoutput
Paging Rows Format Header Verbose
===========================================
off - default on off

Command-line interface 135

setoutput –fmt delim char
To obtain long output in comma-separated format for the default storage
pool only, enter the following commands:
csmcli> setoutput –fmt delim ,
csmcli> lssess –l –type default

The following output is then returned:

Name,Status,State,Copy Type,
Recoverable,Copying,Copy Sets,Error
===============================================================
session1,Inactive,Defined,Global Mirror Failover/Failback w/ Practice,
No,No,8,No
session2,Inactive,Defined,Global Mirror Failover/Failback,
No,No,0,No

To turn off headers, enter the command as shown in the following

example:
csmcli> setoutput –fmt delim , -hdr off
csmcli> lssess –l –type default

The output would then be returned as follows:

session1,Inactive,Defined,Global Mirror Failover/Failback w/ Practice,
No,No,8,No
session2,Inactive,Defined,Global Mirror Failover/Failback,
No,No,0,No
setoutput –fmt xml
To obtain the long output in XML format for the default storage pool only,
enter the following command:
csmcli> setoutput –fmt xml
csmcli> lssess –l –type default

The output is then returned in XML format as shown in the following

example:
<IRETURNVALUE>
<INSTANCE CLASSNAME="STC_StoragePool"><PROPERTY NAME="Name" TYPE="string">
<VALUE>DEFAULT_POOL</VALUE></PROPERTY><PROPERTY NAME="PoolType" TYPE="uint32">
<VALUE>1</VALUE></PROPERTY><PROPERTY NAME="PartitionSize" TYPE="uint64">
<VALUE>16</VALUE></PROPERTY>
<PROPERTY NAME="AlertPercentage" TYPE="uint16"><VALUE>80</VALUE></PROPERTY>
<PROPERTY NAME="Size" TYPE="uint64"><VALUE>0</VALUE></PROPERTY>
<PROPERTY NAME="SizeAllocated" TYPE="uint64">
<VALUE>0</VALUE></PROPERTY><PROPERTY NAME="SizeAllocatedPercentage" TYPE="uint16">
<VALUE>0</VALUE></PROPERTY>
<PROPERTY NAME="NumberOfVolumes" TYPE="uint32"><VALUE>0</VALUE></PROPERTY>
<PROPERTY NAME="Description" TYPE="string"><VALUE>Default storage pool</VALUE>
</PROPERTY></INSTANCE>
</IRETURNVALUE>

setoutput –fmt default

To return the output format to the default (space-separated columns), enter
the command as follows:
csmcli> setoutput –fmt default
csmcli> lssess –l type default

The output is then returned as follows:

Name Type Size(GB) Used(GB) Used(%) Alert(%) Volumes
=================================================================
DEFAULT Default 10000 2500 25 80 10
Partition Size(MB) Description
=========================================
64 Default Storage Pool

136 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

setoutput –fmt stanza
When columns are wide, output can be difficult to visually align. However,
the stanza format option eliminates this problem. To obtain long output in
stanza format for the default storage pool only, enter the command as
follows:
csmcli> setoutput -fmt stanza
csmcli> lssess –l –type default

The output is then returned in the following format:

Name DEFAULT
Type Default
Size (GB) 10000
Used (GB) 2500
Used (%) 25
Alert (%) 80
Volumes 10
Partition Size (MB) 64
Description Default storage pool

Name Personnel
Type System
Size (GB) 10000
Used (GB) 2500
Used (%) 25
Alert (%) 80
Volumes 20
Partition Size (MB) 64
Description Personnel data

Customizing the command-line interface

This information describes how to customize the command-line interface.

Configuring the command-line interface

This information describes how to modify the properties files to configure the
command-line interface.

There are three properties files that are used to configure the command-line
interface:
repcli.properties
Contains the server and port information used to communicate with the
IBM Tivoli Storage Productivity Center for Replication server and the
command-line interface.
rmserver.properties
Contains configuration information about logging.
tpcrcli-auth.properties
Contains authorization information for signing on to the CLI automatically
without entering your user name and password.

Setting up automatic login to the CLI

You can set up the command line interface to automatically log you in without
specifying your user name or password each time you issue a csmcli command or
enter the csmcli shell. Use the tpcrcli-auth.properties file to create a persistent copy
of the user name and encrypted password used for automatic authentication and
authorization.

Perform these steps to set up automatic login authentication:

Command-line interface 137

1. Locate the tpcrcli-auth.properties template file in the install_root\CLI
directory. The template is located in the following directories by default, based
on the operating system running on the management server.

Operating system Default directory

Windows C:\Program Files\IBM\replication\CLI
AIX and Linux /opt/IBM/replication/CLI
®
z/OS /var/Tivoli/RM/CLI

2. Copy the template to the tpcr-cli directory in your home directory (for
example, C:\Documents and Settings\joe\tpcr-cli\ on Windows.)
3. Edit the file, and add your user name and password.
4. Issue a csmcli command or enter the csmcli shell to encrypt the password in
the tpcrcli-auth.properties file.

csmcli command descriptions

The following table provides a brief description and authorization role for each
command in the command-line interface.

Sessions and copy sets

Command Description Roles
“chsess” on page Use the chsess command to change the description Administrator
152 or options set of an existing session. To change the Operator
session type, you must delete the session and create
a new one.
“cmdsess” on Use the cmdsess command to run a specific action Administrator
page 161 against a session. Operator
“exportcsv” on Use the exportcsv command to export the copy sets Administrator
page 167 in a session to a comma-separated values (CSV) file Operator
or to the console. You are prompted to overwrite the Monitor
CSV file if it exists.
“importcsv” on Use the importcsv command to parse a Administrator
page 170 comma-separated values (CSV) file to create copy
sets for a session.
“lscpset” on page Use the lscpset command to list the IDs of copy sets Administrator
175 in a session. Operator
Monitor
“lscptypes” on Use the lscptypes command to display all the Administrator
page 178 supported session (copy) types that you can use Operator
with the mksess command. Monitor
“lspair” on page Use the lspair command to list the copy pairs for a Administrator
194 specified role pair or to list the copy pairs for a Operator
specified copy set. Monitor
“lsparameter” on Use the lsparameter command to list Metro Mirror Administrator
page 198 heartbeat setting. Operator
Monitor
“lsrolepairs” on Use the lsrolepairs command to display role pairs in Administrator
page 205 a session. Operator
Monitor

138 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Command Description Roles
“lsrolescpset” on Use the lsrolescpset command to list the volume Administrator
page 208 roles in the specified session. Operator
Monitor
“lssess” on page Use the lssess command to display sessions and Administrator
210 their status. Operator
Monitor
“lssessactions” Use the lssessactions command to list all the session Administrator
on page 213 actions (commands) that can be run for a session. Operator
Monitor
“lssessdetails” on Use the lssessdetails command to display the details Administrator
page 215 of a session. Operator
Monitor
“mkcpset” on Use the mkcpset command to create copy sets. Administrator
page 232 Operator
“mksess” on Use the mksess command to create a session. Administrator
page 236 Operator
“rmcpset” on Use the rmcpset command to remove a copy set. Administrator
page 243 Operator
“rmsess” on page Use the rmsess command to remove a session. Administrator
248 Operator
“setparameter” Use the setparameter command to set the system Administrator
on page 252 parameters.
“showcpset” on Use the showcpset command to display properties Administrator
page 254 for a copy set. Operator
Monitor
“showsess” on Use the showsess command to display properties for Administrator
page 262 a selected session, including name, description, Operator
group managed, and copy type. Monitor

Storage systems and connections

Command Description Roles
“adddevice” on Use the adddevice command to add a storage Administrator
page 142 system.
“addmc” on page Use the addmc command to add a management Administrator
144 console connection and all the storage systems that
are managed by that management console.
“addstorsys” on Use the addstorsys command to add a specific Administrator
page 145 storage system and its volumes that are attached to
the IBM Tivoli Storage Productivity Center for
Replication server to the IBM Tivoli Storage
Productivity Center for Replication configuration
through a z/OS connection.
“chdevice” on Use the chdevice command to change user names Administrator
page 148 and passwords for accessing storage systems.
“chlocation” on Use the chlocation command to change the location Administrator
page 150 associated with the specified storage systems.
“chmc” on page Use the chmc command to set or change the Administrator
151 hardware credentials for the hardware management
console (HMC).

Command-line interface 139

Command Description Roles
“chvol” on page Use the chvol command to change the protection Administrator
160 setting associated with a volume.
“lsavailports” on Use the lsavailports command to display the port Administrator
page 174 configuration types for a specific path. Operator
Monitor
“lsdevice” on Use the lsdevice command to list storage systems Administrator
page 180 and properties. Operator
Monitor
“lslocation” on Use the lslocation command to list all defined Administrator
page 188 locations. Operator
Monitor
“lslss” on page Use the lslss command to list the logical subsystems Administrator
190 (LSSes) for the specified DS or ESS storage system. Operator
You can use this output with the mkpath command. Monitor
“lsmc” on page Use the lsmc command to display a summary of Administrator
192 management consoles and settings. Operator
Monitor
“lspath” on page Use the lspath command to display paths between Administrator
200 ESS and DS devices. You can then use this Operator
information for a remote copy. Monitor
“lspool” on page Use the lspool to list pools that are on XIV systems. Administrator
202 Operator
Monitor
“lsstorcandidate” Use the lsstorcandidate command to list the storage Administrator
on page 225 systems that can be discovered through an IBM Operator
z/OS connection. This command does not list Monitor
storage systems that are already added to the IBM
Tivoli Storage Productivity Center for Replication
configuration.
“lsvol” on page Use the lsvol command to display detailed Administrator
227 information about volumes. Operator
Monitor
“mkpath” on Use the mkpath command to create a Fibre Channel Administrator
page 235 path or paths between a source logical subsystem Operator
(LSS) and a target LSS.
“rmdevice” on Use the rmdevice command to remove a direct Administrator
page 245 connection to a storage system.
“rmmc” on page Use the rmmc command to remove a management Administrator
247 console.
“rmpath” on Use the rmpath command to remove a path or paths Administrator
page 247 between a source logical subsystem (LSS) and a Operator
target LSS.
“rmstorsys” on Use the rmstorsys command to remove a specific Administrator
page 250 storage system and its volumes that are attached to
the IBM Tivoli Storage Productivity Center for
Replication server from the IBM Tivoli Storage
Productivity Center for Replication configuration
through a z/OS connection.
“showdevice” on Use the showdevice command to display storage Administrator
page 255 system properties.
“showmc” on Use the showmc command to display the properties Administrator
page 261 of a management console.

140 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Management servers
Command Description Roles
“hareconnect” on Use the hareconnect command to reconnect the Administrator
page 169 active and standby servers for high availability
(HA).
“hatakeover” on Use the hatakeover command to change the standby Administrator
page 169 server to the active server.
“lshaservers” on Use the lshaservers command to show the status of Administrator
page 184 each active and standby management server. Operator
Monitor
“lssnmp” on Use the lssnmp command to list the SNMP Administrator
page 224 managers to which IBM Tivoli Storage Productivity Operator
Center for Replication is configured to send SNMP Monitor
alerts.
“mkbackup” on Use the mkbackup command to create a backup of Administrator
page 231 IBM Tivoli Storage Productivity Center for
Replication configuration data (including storage
systems, sessions, and copy set) in the
zero-administration embedded repository.
“mklogpkg” on Use the mklogpkg command to create a log Administrator
page 235 package. The log package is written to the file that is
specified in the properties file.
“mksnmp” on Use the mksnmp command to add a specified Administrator
page 240 manager to the list of servers to which SNMP traps
are sent. SNMP traps are not specific to any
particular session. All traps for any session are sent
to each server.
“rmactive” on Use the rmactive command to remove an active Administrator
page 241 management server.
“rmsnmp” on You can use the rmsnmp command to remove the Administrator
page 249 specified manager from the list of servers to which
SNMP traps are sent.
“rmstdby” on Use the rmstdby command to remove a standby Administrator
page 249 management server.
“setasstdby” on Use the setasstdby command to set a management Administrator
page 251 server to be the standby management server of
another active management server.
“setstdby” on Use the setstdby command to set the standby Administrator
page 253 management server for an active management
server.
“showha” on Use the showha command to display the Administrator
page 260 high-availability status. Operator
Monitor
“ver” on page Use the ver command to display the current version Administrator
265 of IBM Tivoli Storage Productivity Center for Operator
Replication. Monitor

Command-line interface 141

Security
Command Description Roles
“chauth” on page Use the chauth command to change the Administrator
146 authorization level of a user.
“lsauth” on page Use the lsauth command to lists the name, Administrator
172 authorization level, and session permission for each Operator
user or user group. Monitor
“mkauth” on Use the mkauth command to grant monitor, Administrator
page 230 administrator, or operator authorization to a user.
“rmauth” on Use the rmauth command to remove monitor, Administrator
page 243 administrator, or operator authorization from a user
or user group.
“whoami” on Use the whoami command to display the name of Administrator
page 266 the user that is currently logged in. Operator
Monitor

adddevice
Use the adddevice command to add a storage system.

To add a storage system that is attached through an IBM z/OS connection, use the
addstorsys command.

To change the location of a storage system, use the chlocation command.

Syntax

adddevice -devtype ds
-help ess
-h storwize-v7000
-? svc
xiv

-ip ip_address -username user_name

; ip_address

-port port
; port

142 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-ip ip_address[;ip_address]
Specifies the IP address or host name of the clusters or nodes that are used by
the storage system.
The following storage systems use two clusters. You must specify the IP
address or host name for each cluster using a semicolon between the addresses
(for example, 192.0.2.0;192.0.2.1):
v TotalStorage Enterprise Storage Server Model 800
v System Storage DS8000
v System Storage DS6000
The following storage systems use one node and require only one address or
host name:
v System Storage SAN Volume Controller
v Storwize V7000
v Storwize V7000 Unified
XIV system uses multiple nodes. Specify the IP address or host name for one
node and the remaining nodes are discovered automatically.
-username user_name[;user_name]
Specifies the user name for the clusters or nodes.
For the following storage systems, you can provide one user name, which is
used for both clusters, or you can specify two user names. If you have separate
user names, include a semicolon between the user name for cluster 0 and
cluster 1.
v TotalStorage Enterprise Storage Server Model 800
v System Storage DS8000
v System Storage DS6000
For the following storage systems, provide one user name:
v System Storage SAN Volume Controller
v Storwize V7000
v Storwize V7000 Unified
v XIV system

Important: After you enter the parameters for the adddevice command, you
are prompted to enter the password for this user name. The password is not
displayed in the command window.
-port port[;port]
Specifies the port to use for accessing the clusters or nodes.
For the following storage systems, you can provide one port number, which is
used for both clusters, or you can provide two port numbers. If you have
separate port numbers, include a semicolon between the port for cluster 0 and
cluster 1. The default port number is 2433.
v TotalStorage Enterprise Storage Server Model 800
v System Storage DS8000
v System Storage DS6000
For XIV system, provide one port number, which is used for all nodes. The
default port number is 7778.
The following storage systems do not require this parameter.
v System Storage SAN Volume Controller

Command-line interface 143

v Storwize V7000
v Storwize V7000 Unified

Examples

Adding a TotalStorage Enterprise Storage Server Model 800 storage system

The following command adds a TotalStorage Enterprise Storage Server Model 800
storage system to Tivoli Storage Productivity Center for Replication.
csmcli> adddevice -devtype ess -ip sts596c0;sts596c1 -username admin

The following output is returned:

Please enter a password for the device cluster 0 userid of admin:
IWNH1612I The connection sts596c0:sts596c1 was successfully added.

addhost
Use the addhost command to add host system connections to the IBM Tivoli
Storage Productivity Center for Replication server.

Syntax

addhost IP_Address
-help -port port -
-h
-?

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-port port
This is an optional parameter that specifies the port to use to access the host
system. If a port is not specified, the default port 9930 is used.
IP_Address | -
Specifies the IP address or host name of the host system.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Example
v Adding host systems
The following command shows how to add a host system with IP address
9.11.223.43. In this example, you could omit the -port parameter because port
9930 is the default.
csmcli> addhost -port 9930 9.11.223.43

addmc
Use the addmc command to add a management console connection and all the
storage systems that are managed by that management console.

Syntax

144 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

addmc
-help -devtype ds
-h ds8000
-?

-ip ip_address -username user_name

; ip_address

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-devtype { ds | ds8000 }
Specifies the type of hardware device. You can specify either ds or ds8000.
-ip ip_address[;ip_address]
Specifies the IP addresses of the management consoles to be added. For
dual-management console configurations, both IP addresses must be specified
with a semicolon in between (for example, 192.0.2.0;192.0.2.1).
-username user_name
Specifies the user name for the management console. For dual management
console configurations, the management consoles must have the same user
name.

Important: After you enter the parameters for the addmc command, you are
prompted to enter the password for this user name. For security, the password
is not displayed in the command window.

Example

Adding a management console

The following command adds a management console to IBM Tivoli Storage

Productivity Center for Replication.
csmcli> addmc -devtype ds -ip 127.0.0.1 -username admin

The following output is returned:

Please enter a password for the device userid of admin:
IWNH1612I The connection HMC:127.0.0.1 was successfully added.

addstorsys
Use the addstorsys command to add a specific storage system and its volumes that
are attached to the IBM Tivoli Storage Productivity Center for Replication server to
the IBM Tivoli Storage Productivity Center for Replication configuration through a
z/OS connection.

Syntax

addstorsys -conntype zos -dev device_id

-help
-h
-?

Command-line interface 145

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-conntype zos
Specifies the type of connection that the storage system uses. Currently, you
can specify only zos for a z/SO connection.
-dev device_id
Specifies the ID of the DS or ESS storage system that is to be added to the IBM
Tivoli Storage Productivity Center for Replication configuration.

Tip: Use the lsdevice command to display a list of valid storage system IDs.

Description

Important:
v You must have Administrator privileges to run this command.
v You can run this command only from the IBM Tivoli Storage Productivity Center
for Replication server that is installed on a system running z/OS.
v You can use this command to add only DS and ESS type storage systems.

If the storage system has been previously added through another connection type,
then z/OS is added to the storage system's connection types.

To add a storage system that is attached through a direct connection, use the
adddevice command. To add a storage system that is attached through a
hardware-management-console (HMC) connection, use the addmc command.

To change the location of the storage system, use the chlocation command.

Example
1. Adding an ESS storage system
This example illustrates how to add the storage system with ID
ESS:BOX:2105.12345 to the IBM Tivoli Storage Productivity Center for
Replication configuration through the z/OS connection.
csmcli> addstorsys -dev ESS:BOX:2105.12345 -conntype zos
The following output is returned:
IWNH1612I The connection ESS:BOX:2105.12345 was successfully added.
2. Adding an DS8000 storage system
This example illustrates how to add the storage system with ID
DS8000:BOX:2107.MV492 to the IBM Tivoli Storage Productivity Center for
Replication configuration through the z/OS connection.
csmcli> addstorsys -dev DS8000:BOX:2107.MV492 -conntype zos
The following output is returned:
IWNH1619I The storage device 2107.MV492 at ZOS was successfully added.

chauth
Use the chauth command to change the authorization level of a user.

Syntax

146 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

chauth -authlevel admin -name name
-help -quiet operator
-h monitor
-?

-type group
user

session_name
-

Example
1. Changing user authorization to administrator
The following command changes the authorization level for the user csmuser to
operator privileges with permission to manage session session1.
csmcli> chauth -name csmuser -type user -authlevel operator session1
The following output is returned:
Are you sure you want to change access for user csmuser? [y/n]:y
IWNR4016I Successfully granted the session operator role to csmuser.

IWNR4026I Successfully granted permission for session session1 for

user Guest.
2. Changing user authorization to monitor
The following command changes the authorization level for the user Guest to
monitor privileges.
csmcli> chauth -name Guest -type user -authlevel monitor

Command-line interface 147

The following output is returned:
Are you sure you want to change access for user Guest? [y/n]:y
IWNR4017I Successfully granted the monitor role to Guest.

chdevice
Use the chdevice command to change user names and passwords for accessing
storage systems.

Tip: To change the location of storage systems, use the chlocation command.

Syntax

chdevice -devtype ds
-help ess -ip ip_address
-h storwize-v7000
-? svc
xiv

-username user_name
-password password

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-devtype { ds | ess | storwize-v7000 | svc | xiv }
Specifies the type of storage system. Supported devices are:
v ds: IBM System Storage DS8000 or System Storage DS6000
v ess: IBM TotalStorage Enterprise Storage Server Model 800
v storwize-v7000: IBM Storwize V7000 and IBM Storwize V7000 Unified
v svc: IBM System Storage SAN Volume Controller
v xiv: IBM XIV Storage System
-ip ip_address [;ip_address]
Specifies the IP address or host name of the clusters or nodes that are used by
the storage system.
The following storage systems use two clusters. You must specify the IP
address or host name for each cluster using a semicolon between the addresses
(for example, 192.0.2.0;192.0.2.1):
v TotalStorage Enterprise Storage Server Model 800
v System Storage DS8000
v System Storage DS6000
The following storage systems use one node and require only one address or
host name:
v System Storage SAN Volume Controller
v Storwize V7000
v Storwize V7000 Unified
XIV system uses multiple nodes. Specify the IP address or host name for one
node and the remaining nodes are discovered automatically.

148 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Tip: To list the IP address of storage system clusters or nodes, use the lsdevice
command.
-username user_name [;user_name]
Specifies the user name for the clusters or nodes that are used by the storage
system. Enter the user name or user names that you want to change. If you
want to change passwords associated with user names (but not the user
names), enter the currently valid user names.
For the following storage systems, you can provide one user name, which is
used for both clusters, or you can specify two user names. If you have separate
user names, include a semicolon between the user name for cluster 0 and
cluster 1.
v TotalStorage Enterprise Storage Server Model 800
v System Storage DS8000
v System Storage DS6000
For the following storage systems, provide one user name:
v System Storage SAN Volume Controller
v Storwize V7000
v Storwize V7000 Unified
v XIV system
-password password [;password]
If you want to change passwords, enter the new passwords for the user names
that you specified. If you want to change user names, but not the passwords
associated with the user names, enter the currently valid passwords. If you do
not enter a password, you are prompted to do so.

Examples

Changing user names and passwords

The following command changes the user name and password for a DS storage
system.
csmcli> chdevice -devtype DS -ip ds8kboxc0.domain.company.com;ds8kboxc1.domain.company.com
-username admin

The following output is returned:

Please enter a password for the device cluster 0 userid of admin:
IWNH1613I User profile information for the storage device at
ds8kboxc0.domain.company.com;ds8kboxc1.domain.company.com was successfully updated.

chhost
Use the chhost command to change credentials for host systems that are connected
to the IBM Tivoli Storage Productivity Center for Replication server.

Syntax

chhost
-help -quiet -oldport port -newip IP_Address
-h
-?

Command-line interface 149

IP_Address
-newport port -

Example

Changing host system credentials

The following command shows how to change the IP address or host name and
port number for a host system connection.
csmcli> chhost -oldport 9930 -newip 9.11.224.23 -newport 9931 9.11.223.43

chlocation
Use the chlocation command to change the location associated with the specified
storage systems.

Syntax

chlocation -location location device_id

-help -
-h
-?

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.

150 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-location location
Specifies the location to associate with the specified storage systems. The
location can be up to 32 alphanumeric characters.
device_id... | -
Specifies the ID of one or more storage systems whose location is to be
changed, separated by a space.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Tip: Use the lsdevice command to list the valid storage system IDs.

Description

Important: You must have Administrator privileges to run this command.

To list the locations that have already been associated with storage systems, use the
lslocation command.

Example

Changing the location of multiple storage systems

The following command changes the location of multiple storage systems to

Tucson.
csmcli> chlocation -location Tucson ESS:BOX:2105.18596 DS8000:BOX:2107.NK791

The following output is returned:

IWNH1222I The site location for storage system ESS:BOX:2105.18596 was successfully
changed to Tucson.

IWNH1222I The site location for storage system DS8000:BOX:2107.NK791 was

successfully changed to Tucson.

chmc
Use the chmc command to set or change the hardware credentials for the hardware
management console (HMC).

Syntax

chmc
-help -devtype ds
-h ds8000
-?

-ip ip_address -username user_name

; ip_address -password

id
-

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.

Command-line interface 151

-devtype ds | ds8000
Specifies the hardware type.
-ip ip_address[;ip_address]
Specifies the IP addresses of the primary and secondary management consoles.
For single HMC configurations only one IP address is necessary. For dual
HMC configurations, two IP addresses must be specified separated with a
semicolon (;).
-username user_name
Specifies the user names of the management console.
-password
Prompts you for a new password for the device.
id | -
Specifies the ID of the management console to change.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Tip: Use the lsmc command to list the management console IDs.

Description

To change the location of a storage system behind a HMC connection, use the
chlocation command.

Example

Changing hardware credentials

The following command change the user name and password for the HMC with
ID HMC:127.0.0.1 and IP address 9.11.222.33.
csmcli> chmc -devtype ds -ip 127.0.0.1 -username admin -password HMC:127.0.0.1

The following output is returned:

Please enter a password for the device userid of admin: ******
IWNH1613I The storage device at HMC:127.0.0.1 successfully updated.

chsess
Use the chsess command to change the description or options set of an existing
session. To change the session type, you must delete the session and create a new
one.

Syntax

chsess
-help -quiet -desc description
-h
-?

152 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-maxdrain max_drain_time -maxdrain_h1j2 max_drain_time

-maxdrain_h1j3 max_drain_time -maxdrain_h2j3 max_drain_time

-maxdrain_h2j1 value -coordint coordination_interval_time

-coordint_h1j2 coordination_interval_time

-coordint_h1j3 coordination_interval_time -coordint_h2j3 value

-coordint_h2j1 value -rpo rpo_value -schedule schedule

-rpo_h1j2 rpo_value -rpo_h1j3 rpo_value -rpo_h2j1 rpo_value

-rpo_h2j3 rpo_value -dsinc yes -dspers yes
no no

-dsnocpy yes -dspmir no -dstgtpprc true
no preferred false
required

-reflash yes -svccopyrate svc_background_copy_rate
no

-svccopyrate_h2i2 svc_background_copy_rate -svcinc yes
no

Command-line interface 153

-site1loc location -site2loc location -site3loc location

-manageH1H2withHyperSwap yes -disableHS yes
no no

-onConfigErrorHS disable -onPlannedErrorHS disable
partition partition

-onUnplannedErrorHS disable
partition

-manageH1H2withOpenHyperSwap yes -disableOHS yes
no no

-rmreserves yes -failIfTgtOnline yes
no no

session_name
-aftersuspend hold -
release

Parameters

Restriction: Parameters that begin with ds, such as -dsinc, apply only to
TotalStorage Enterprise Storage Server Model 800, System Storage DS8000, and
System Storage DS6000. For practice sessions, the -dspers parameter is available
only for System Storage DS8000 version 4.2, or later.

Parameters that begin with svc, such as -svcinc, apply only to System Storage SAN
Volume Controller, Storwize V7000, and Storwize V7000 Unified.
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-quiet
Suppresses the confirmation prompt for this command. This flag answers yes
to all confirmation prompts.

154 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-desc description
Specifies the new description for the session. This description can have up to
250 alphanumeric characters. If the description contains white space, enclose it
in single quotation marks.
-maxdrain max_drain_time
Specifies the new maximum drain time for Global Mirror type sessions. This
parameter is meant to be used by advanced users.
If you specify -maxdrain 0, the DS storage system uses its default value
instead of zero. Any other positive integer in the valid range is accepted by the
DS storage system. However, when a zero is sent to the DS storage system, this
instructs the DS storage system to set the value back to its default value.
The -maxdrain parameter is related to the DS -drain parameter. The default
value for the -drain parameter is 30 seconds; the maximum value for the
-maxdrain parameter is 65 535 seconds. For more information, see the mkgmir
command in the IBM TotalStorage DS8000 Command-Line Interface User's Guide.
The -maxdrain_h1j3 and -maxdrain_h2j3 parameters relate to a Metro Global
Mirror session. The -maxdrain_h1j3 parameter refers to the Global Mirror
portion of a Metro Global Mirror session when the session is running from site
1 to site 3 and the -maxdrain_h2j3 parameter refers to the Global Mirror
portion of a Metro Global Mirror session that is running between site 2 and
site 3.-maxdrain_h2j1 relate to a Global Mirror session. The -maxdrain_h2j1
parameter refers to the Global Mirror portion of a Metro Global Mirror session
when the session is running between site 2 and site 1.
-coordint coordination_interval_time
Specifies the new coordination interval time for Global Mirror type sessions.
This parameter is meant to be used by advanced users. -coordint_h1j3,
-coordint_h2j1, and -coordint_h2j3 relate to the role pair.
-rpo rpo_value
For TotalStorage Enterprise Storage Server Model 800, System Storage DS8000,
or System Storage DS6000, this value specifies the new consistency group
interval time in seconds for the XX-XX role pair. The value of data exposure for
the session will trend toward this value. This parameter applies only to Global
Mirror session types and copy types where the Recovery Point Objective (RPO)
is mapped. A value of 0 specifies that the storage system continuously attempt
to form consistency groups. Parameters -rpo_h1j2, -rpo_h1j3, -rpo_h2j1, and
-rpo_h2j3 relate to the role pair.
For the XIV system, this value specifies the RPO threshold for the session in
seconds. The –rpo parameter works with the –schedule parameter to
determine the following:
v How often the XIV system attempts to form a consistency group.
v Whether the RPO value has exceeded the threshold.
If the RPO on the storage system exceeds the RPO threshold for the session,
the session changes to the Severe state and an alert is generated. The possible
range of values is 30-86400. The default is 30.
-schedule schedule
For an XIV system Global Mirror session, this option specifies how often the
XIV system should form a consistency group to ensure consistency on the
secondary side and achieve the RPO that is set by the -rpo option.
The following are the possible values for –schedule: {never | min_interval |
00:00:30 | 00:00:40 | 00:00:50 | 00:01:00 | 00:01:10 | 00:01:20 |

Command-line interface 155

00:01:30 | 00:01:40 | 00:01:50 | 00:02:00 | 00:05:00 | 00:10:00 |
00:15:00 | 00:30:00 | 01:00:00 | 02:00:00 | 03:00:00 | 04:00:00 |
06:00:00 | 08:00:00 | 12:00:00}
The default is min_interval, which is 20 seconds.
-dsinc { yes | no }
For a point-in-time session, specifies whether the FlashCopy® relationship is
incremental for the next Flash or Start command. Valid values are yes or no.
-dspers { yes | no }
Specifies whether the next FlashCopy relationship for this session will be
persistent. Valid values are yes or no.
-dsnocpy { yes | no }
For a point-in-time session, specifies whether the FlashCopy relationship is
established with a background copy for the next Flash or Start command. Valid
values are yes or no.
-dspmir { no | preferred | required }
Specifies the Preserve Mirror option for storage systems. You must specify no,
preferred, or required. If this option is not specified, the default is no preserve
mirror options.
-dstgtpprc { true | false }
Allows the FlashCopy target volume to be a remote mirror and copy source
volume if the option is set to true. This parameter must be set to true for the
dspmir parameter to take effect. The default option for this parameter is false.
-reflash { yes | no }
Allows FlashCopy replication to be created between the I2 and J2 volumes
after the recovery of a Global Mirror session. Valid values are yes or no. If you
enter no, a FlashCopy replication is created only between the I2 and H2
volumes.
-svccopyrate svc_background_copy_rate
Specifies the copy rate that the following storage systems use to perform the
background copy of the FlashCopy relationships. Specify a percentage between
0 and 100; the default is 50.
v System Storage SAN Volume Controller
v Storwize V7000
v Storwize V7000 Unified
When you specify 0, you are specifying the equivalent of the no-copy option
for a TotalStorage Enterprise Storage Server or System Storage DS series
FlashCopy session. If the session is performing a background copy when you
change the option, Tivoli Storage Productivity Center for Replication
immediately modifies the background copy rate of the consistency group on
the storage system.
The consistency group immediately uses the new rate to complete the
background copy that it is performing.
-svccopyrate_h2i2 svc_background_copy_rate
Specifies the copy rate that the following storage systems use to perform the
background copy of the FlashCopy role pair. Specify a percentage between 0
and 100; the default is 50.
v System Storage SAN Volume Controller
v Storwize V7000
v Storwize V7000 Unified

156 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

When you specify 0, this is the equivalent of specifying the no-copy option for
a TotalStorage Enterprise Storage Server or System Storage DS series
FlashCopy session. If the session is performing a background copy when you
change the option, Tivoli Storage Productivity Center for Replication
immediately modifies the background copy rate of the consistency group on
the storage system. The consistency group immediately uses the rate to
complete the background copy that it is performing.
-svcinc {yes | no }
For a point-in-time session, specifies whether the FlashCopy relationship for
the following storage systems is incremental for the next Flash or Start
command. Valid values are yes or no.
-site1loc location
Specifies a location to associate with the site 1 volume role.
-site2loc location
Specifies a location to associate with the site 2 volume role.
-site3loc location
Specifies a location to associate with the site 3 volume role.
-manageH1H2withHyperSwap { yes | no }
Enables Basic HyperSwap® support for Metro Mirror Failover/Failback and
Metro Global Mirror sessions.
yes
The following HyperSwap options are supported for the Metro Mirror
Failover/Failback or Metro Global Mirror session:
v -disableHS yes | no
v -onConfigErrorHS disable | partition
v -onPlannedErrorHS disable | partition
v -onUnplannedErrorHS disable | partition
no HyperSwap options are not supported. All Metro Mirror Failover/Failback
and Metro Global Mirror functions are still supported.
-disableHS { yes | no }
Disables HyperSwap in Basic HyperSwap, Metro Mirror Failover/Failback
with HyperSwap, and Metro Global Mirror with HyperSwap sessions. If
HyperSwap detects a triggering event while it is disabled, it does not perform
a swap.
Issuing the -disableHS no parameter resets the disable command (-disableHS
yes), but does not necessarily mean that HyperSwap is enabled. It might mean
only that HyperSwap is no longer disabled for operator reasons. This would be
the case, for example if the HyperSwap address spaces were not started, a new
member was in the process of joining the sysplex, or there was a HyperSwap
in progress.
To determine the reasons that HyperSwap might be disabled, see the Session
Messages panel by selecting the View Messages from the Actions list on the
Sessions panel.
This parameter is applicable only if the manageH1H2withHyperSwap parameter is
set to yes.
-onConfigErrorHS { disable | partition }
Specifies the policy for the action to be taken for a configuration error. Valid
policies are:

Command-line interface 157

disable
HyperSwap is disabled.
partition
New member is not allowed to join the sysplex and is partitioned out.
All members of a z/OS sysplex must be able to access all devices in a Basic
HyperSwap, Metro Mirror Failover/Failback with HyperSwap, or Metro Global
Mirror with HyperSwap session. If a new member joining the sysplex cannot
access all devices, it fails validation and it must be partitioned out of the
sysplex, or HyperSwap must be disabled until the problem is resolved.
Similarly, all members of the sysplex must be able to perform HyperSwap
commands. If the HyperSwap API address space is unavailable on one system,
that system must either be partitioned out of the sysplex, or HyperSwap must
be disabled until the problem is resolved.
-onPlannedErrorHS { disable | partition }
This optional parameter specifies the policy for the action to be taken when an
error occurs during a planned HyperSwap: partition or disable. Valid policies
are:
disable
HyperSwap processing is stopped and backed up, and HyperSwap is
disabled.
partition
Systems that cannot perform the swap are partitioned out of the
sysplex, and the HyperSwap continues with the remaining members of
the sysplex. This is the default value.
-onUnplannedErrorHS { disable | partition }
Specifies the policy for the action to be taken when an error occurs during an
unplanned HyperSwap. Valid policies are:
disable
HyperSwap processing is stopped and backed up, HyperSwap is
disabled, and a permanent I/O error is returned to any users of the
failing device.
partition
Systems that cannot perform the swap are partitioned out of the
sysplex, and the HyperSwap continues with the remaining members of
the sysplex. This is the default value.
-manageH1H2withOpenHyperSwap { yes | no }
Enables Open HyperSwap support for Metro Mirror Failover/Failback
sessions.
yes
The following Open HyperSwap option is supported for the Metro Mirror
Failover/Failback session:
v -disableOHS{ yes | no }
no Open HyperSwap options are not supported. All Metro Mirror
Failover/Failback functions are still supported. If no is specified and the
session had previously loaded a configuration on the hosts and one of the
volumes is OPEN, the manageH1H2withOpenHyperSwap option remains yes.
-disableOHS { yes | no }
Disables Open HyperSwap in Metro Mirror Failover/Failback sessions. This

158 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

parameter is applicable only if the manageH1H2withOpenHyperSwap parameter is
set to yes. The default option for this parameter is no.
-rmreserves { yes | no }
Removes the persistent reserve on the target volume to allow the establishment
of a Metro Mirror session. Once set on, the setting for the -rmreserves
parameter continues to persist for a session, and the setting remains until you
remove it. However, warnings are displayed to indicate that the value is set
when you attempt to start the session.
-failIfTgtOnline { yes | no }
Determines whether the Start command fails if the target is online. If the
parameter is set to yes, the target is determined to be online to a host, and
Start command will fail.

Notes:
v Tivoli Storage Productivity Center for Replication cannot determine with
absolute certainty whether the target is online to a host.
v This parameter affects only count key data (CKD) volumes.
v Online means that path groups are present. A path group is necessary, but is
not enough to indicate that the volume is online. For example, an LPAR that
is not part of a sysplex can be taken down (for example, through a
power-off without a shutdown) and path groups will display as present, but
no LPAR will have the volume online. That is, the path groups are present,
but z/OS software might think the volumes are offline.
-aftersuspend{ hold | release }
(Metro Mirror sessions) Specifies the session operation after a suspend occurs.
Valid policies are:
hold Does not allow any updates to the primary volume after a suspend.
release
allow updates to the primary volume after a suspend.
session_name... | -
Specifies the name of the session that is to be modified.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Examples

Changing the description of a session

The following command changes the description of the session session1 to MGM
session.
csmcli> chsess -desc "MGM session" session1

The following output is returned:

Are you sure you want to change session session1? [y/n]:y

IWNR1124I The description for session session1 was modified successfully.

The new description is MGM session.

Changing the session site locations

The following command changes location of each site in Metro Global Mirror
session session1.

Command-line interface 159

csmcli> chsess -site1loc Boulder -site2loc Tucson -site3loc Marana session1

The following output is returned:

IWNR1096I The locations for sessions session1 and Site 3 were set successfully.

Disabling HyperSwap

The following command disables HyperSwap for session session1.

csmcli> chsess -disableHS yes session1

The following output is returned:

IWNR5411E Basic HyperSwap is disabled by operator for session session1.

chvol
Use the chvol command to change the protection setting associated with a volume.

Syntax

chvol -protected volume_id

-help -quiet -unprotected -
-h
-?

Example
1. Protecting volumes
The following command marks the volume with ID ESS:2107.fca64:VOL:1234
as protected.
csmcli> chvol -protected DS8000:2107.04131:VOL:0001
The following output is returned:

160 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Are you sure you want to change volume DS8000:2107.04131:VOL:0001? [y/n]:y
IWNE9300I The set protection command completed without any errors. There
were 1 element(s) protected and 0 element(s) unprotected.

IWNE9302I The element DS8000:2107.04131:VOL:0001 has been protected.

2. Unprotecting volumes
The following command marks the volume with ID ESS:2107.fca64:VOL:1234
as unprotected.
csmcli> chvol -unprotected ESS:2107.fca64:VOL:1234
The following output is returned:
Are you sure you want to change volume DS8000:2107.04131:VOL:0001? [y/n]:y
IWNE9300I The set protection command completed without any errors. There
were 0 element(s) protected and 1 element(s) unprotected.

IWNE9303I The element DS8000:2107.04131:VOL:0001 has been unprotected.

cmdsess
Use the cmdsess command to run a specific action against a session.

Tip: To list all of the session actions that can be run for a session, use the
lssessactions command.

Syntax

cmdsess -action create_snapshot

-help -quiet enable_copy_to_site_1
-h enable_copy_to_site_2
-? flash
hyperswap
initiatebackgroundcopy
recover
recoverh1
recoverh2
recoverh3
re-enable_copy_to_site_1
re-enable_copy_to_site_2
re-enable_copy_to_site_3
release_i/o
restore
start
start_h1:h2:h3
start_h1:h2
start_h1:h3
start_h2:h1
start_h2:h1:h3
start_h2:h3
start_h3:h1:h2
startgc
startgc_h1:h2
startgc_h2:h1
stop
suspend
suspendh1h3
suspendh2h3
terminate

Command-line interface 161

-restorefrom snapshot_group_name -priority 1
2
3
4

session_name
-newname snapshot_group_name -

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-quiet
Suppresses the confirmation prompt for this command. This flag answers yes
to all confirmation prompts.
-action action_type
Specifies the action type (command) depending on the state and type of
session. The possible action types are displayed in the syntax diagram and are
described in the IBM Tivoli Storage Productivity Center User's Guide and IBM
Tivoli Storage Productivity Center for Replication for System z User's Guide.
-restorefrom snapshot_group_name
Specifies the name of the snapshot group that you want to use to restore the
data in the H1 volumes for the session. The snapshot group must be in the
session.
This parameter is required if the -action parameter value is restore.
-priority { 1 | 2 | 3 | 4}
Specifies the priority in which the snapshot group will be deleted from the
session. The value is the number 1 - 4. A value of 1 specifies that the snapshot
group is deleted last. A value of 4 specifies that the snapshot group is deleted
first.
This parameter is optional and only used if the -action parameter value is
create_snapshot.
-newname snapshot_group_name
Specifies the new name for the snapshot group.
This parameter is optional and only used if the -action parameter value is
create_snapshot.
session_name | -
Specifies the name of the session that the action will run against.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Examples

Starting a session

The following command runs the Start H1->H2->H3 action on session session1:
csmcli> cmdsess -action start_h1:h2:h3 session1

162 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

The following output is returned:
IWNR1813W This command will initiate the copying of data from Site 1 to
Site 2 and Site 3 for session session1, overwriting any data on Site 2 and
Site 3 for any inactive copy sets. For ESS/DS devices, exactly one path will
be established between each LSS pair without existing paths. Do you want to
continue? [y/n]:y

IWNR1027I The command Start H1->H2->H3 in session session1 has completed

successfully.

Reversing the direction of replication

The following command runs the Enable Copy to Site 1 action on session
session1 without prompting for confirmation:
csmcli> cmdsess -quiet -action enable_copy_to_site_1 session1

The following output is returned:

IWNR1027I The command Enable Copy to Site 1 in session session1 has
completed successfully.

Creating a snapshot group in an XIV system Snapshot session

The following command creates a snapshot group in session snap1:

csmcli> cmdsess -action create_snapshot snap1

The following output is returned:

IWNR1855W This command will create a new snapshot group containing snapshots of the
source volumes in session snap1. Do you want to continue? [y/n]:y
IWNR1026I The Create Snapshot command in session snap1 has completed.

cmdsnapgrp
Use the cmdsnapgrp command to run a specific action against a snapshot group
that is in an IBM XIV Storage System Snapshot session.

A snapshot group is a grouping of snapshots of individual volumes in a

consistency group at a specific point in time.

Syntax

cmdsnapgrp -action delete

-help -quiet disband
-h duplicate
-? lock
overwrite
rename
restore
set_priority
unlock

-group snapshot_group_name
-restorefrom snapshot_group_name

Command-line interface 163

session_name
-priority 1 -newname snapshot_group_name -
2
3
4

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-quiet
Suppresses the confirmation prompt for this command. This flag answers yes
to all confirmation prompts.
-action action_type
Specifies the action that you want to complete for a snapshot group in a
session. The valid values are:
delete Deletes the snapshot group and all the individual snapshots that are in
the group from the session and from XIV system.
If the deleted snapshot group is the last snapshot group that is
associated with the session, the session returns to the Defined state.
disband
Disbands the snapshot group. When a snapshot group is disbanded,
the snapshot group no longer exists. All snapshots in the snapshot
group become individual snapshots that are no longer associated to the
consistency group or the session.
After a snapshot group is disbanded, it is no longer shown in or
managed by IBM Tivoli Storage Productivity Center for Replication. If
the disbanded snapshot group is the last snapshot group that is
associated with the session, the session returns to the Defined state.
duplicate
Duplicates the snapshot group. When a snapshot group is duplicated, a
new snapshot group is created with new snapshots for all volumes that
are in the duplicated group. A name for the duplicated snapshot group
is generated automatically by XIV system.
lock Locks a snapshot group. If the snapshot group is locked, write
operations to the snapshots within the snapshot group are prevented.
By default, a snapshot group is locked when it is created.
This action is valid only if the snapshot group is unlocked.
overwrite
Overwrites the snapshot group to reflect the data that is on the master
volume.
rename
Renames the snapshot group.
To specify the new name, use the -newname parameter.
restore
Restores the contents of a snapshot group using another snapshot
group in the session. Both of the snapshot groups must contain the
same subset of volumes.

164 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

To specify the snapshot group from which you want to restore, use the
-restorefrom parameter.
set_priority
Sets the priority in which a snapshot group is deleted. The value is the
number 1 - 4. A value of 1 specifies that the snapshot group is deleted
last. A value of 4 specifies that the snapshot group is deleted first.
To set the deletion priority, use the -priority parameter.
unlock
Unlocks a snapshot group. If the snapshot group is unlocked, write
operations to the snapshots within the snapshot group are enabled and
the snapshot group is shown as modified if you run the lssnapgrp
command.
This action is valid only if the snapshot group is locked.
-group snapshot_group_name
Specifies the name of the snapshot group that you want to run the action
against.
-restorefrom snapshot_group_name
Specifies the name of the snapshot group that you want to use to restore the
snapshot group that is defined by the -group parameter.
This parameter is required if the -action parameter value is restore.
-priority { 1 | 2 | 3 | 4}
Specifies the priority in which the snapshot group will be deleted from the
session. The value is the number 1 - 4. A value of 1 specifies that the snapshot
group is deleted last. A value of 4 specifies that the snapshot group is deleted
first.
This parameter is required if the -action parameter value is set_prioirity.
-newname snapshot_group_name
Specifies the new name for the snapshot group.
This parameter is required if the -action parameter value is rename.
session_name | -
Specifies the name of the session that contains the snapshot group.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Examples

Deleting a snapshot group

The following command deletes the snapshot group snap1_002.snap_group_00018

in the session snap1.
csmcli> cmdsnapgrp -group snap1_002.snap_group_00018 -action delete -quiet snap1

The following output is returned:

IWNR1322I The Delete command has completed for snapshot groups
snap1_002.snap_group_00018 in session snap1.

Disbanding a snapshot group

Command-line interface 165

The following command disbands the snapshot group snap1_002.snap_group_00017
in the session snap1.
csmcli> cmdsnapgrp -group snap1_002.snap_group_00017 -action disband -quiet snap1

The following output is returned:

IWNR1322I The Disband command has completed for snapshot groups
snap1_002.snap_group_00017 in session snap1.

Duplicating a snapshot group

The following command duplicates the snapshot group

snap1_002.snap_group_0001 in the session snap1.
csmcli> cmdsnapgrp -group snap1_002.snap_group_0001 -action duplicate -quiet snap1

The following output is returned:

IWNR1322I The Duplicate command has completed for snapshot groups
snap1_002.snap_group_0001 in session snap1.

Locking a snapshot group

The following command locks the snapshot group snap1_002.snap_group_0001 in

the session snap1.
csmcli> cmdsnapgrp -group snap1_002.snap_group_0001 -action lock -quiet snap1

The following output is returned:

IWNR1322I The Lock command has completed for snapshot groups
snap1_002.snap_group_0001 in session snap1.

Overwriting a snapshot group

The following command overwrites the snapshot group

snap1_002.snap_group_0001 in the session snap1.
csmcli> cmdsnapgrp -group snap1_002.snap_group_0001 -action overwrite -quiet snap1

The following output is returned:

IWNR1322I The Overwrite command has completed for snapshot groups
snap1_002.snap_group_0001 in session snap1.

Renaming a snapshot group

The following command renames the snapshot group snap1_002.snap_group_00016

to snapgroup1 in the session snap1.
csmcli> cmdsnapgrp -group snap1_002.snap_group_00016 -action rename
-newname snapgroup1 -quiet snap1

The following output is returned:

IWNR1326I The snapshot group snap1_002.snap_group_00016 in session snap1 was renamed
to snapgroup1.

Restoring a snapshot group

The following command restores the snapshot group snap1_002.snap_group_0001

from snap1_002.snap_group_00017 in the session snap1.
csmcli> cmdsnapgrp -group snap1_002.snap_group_0001 -action restore
-restorefrom snap1_002.snap_group_00017 -quiet snap1

166 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

The following output is returned:
IWNR1325I The snapshot group snap1_002.snap_group_0001 in session snap1 was
restored from snapshot group snap1_002.snap_group_00017.

Setting the deletion priority for a snapshot group

The following command sets a deletion priority of 4 for the snapshot group
snap1_002.snap_group_0001 in the session snap1.
csmcli> cmdsnapgrp -group snap1_002.snap_group_0001 -action set_priority -priority 4
-quiet snap1

The following output is returned:

IWNR1324I The deletion priority for snapshot groups snap1_002.snap_group_0001
in session snap1 was set to 4.

Unlocking a snapshot group

The following command unlocks the snapshot group snap1_002.snap_group_0001

in the session snap1.
csmcli> cmdsnapgrp -group snap1_002.snap_group_0001 -action unlock -quiet snap1

The following output is returned:

IWNR1322I The Unlock command has completed for snapshot groups
snap1_002.snap_group_0001 in session snap1.

exportcsv
Use the exportcsv command to export the copy sets in a session to a
comma-separated values (CSV) file or to the console. You are prompted to
overwrite the CSV file if it exists.

Syntax

exportcsv -help session_name

-h -file file_name -
-?

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-file file_name
Specifies the name and path of the CSV file. If you do not specify this
parameter, the CSV output is displayed on the command-line interface.
session_name | -
Specifies the name of the session from which you are exporting the copy sets.

Examples

Exporting copy sets to a file

The following command exports the copy sets in session session1 to the file
c:\session1.csv.
csmcli> exportcsv -file c:\session1.csv session1

Command-line interface 167

The following output is returned:
Exporting...
IWNC6506I The export copy set command for session session1 succeeded. The
file was exported to the path: c:\session1.csv.

Exporting copy sets to standard out

The following command exports the copy sets in session session1 to standard
output.
csmcli> exportcsv session1

The following output is returned:

Exporting...
#203
#Metro Global Mirror w/ Practice
#Aug 25 1:44:16 PM

H1,H2,H3,I3,J3
DS8000:2107.NK791:VOL:1500,DS8000:2107.MW931:VOL:1500,
DS8000:2107.04131:VOL:1500,DS8000:2107.04131:VOL:1505,
DS8000:2107.04131:VOL:150A
DS8000:2107.NK791:VOL:1501,DS8000:2107.MW931:VOL:1501,
DS8000:2107.04131:VOL:1501,DS8000:2107.04131:VOL:1506,
DS8000:2107.04131:VOL:150B
DS8000:2107.NK791:VOL:1502,DS8000:2107.MW931:VOL:1502,
DS8000:2107.04131:VOL:1502,DS8000:2107.04131:VOL:1507,
DS8000:2107.04131:VOL:150C
DS8000:2107.NK791:VOL:1503,DS8000:2107.MW931:VOL:1503,
DS8000:2107.04131:VOL:1503,DS8000:2107.04131:VOL:1508,
DS8000:2107.04131:VOL:150D
DS8000:2107.NK791:VOL:1504,DS8000:2107.MW931:VOL:1504,
DS8000:2107.04131:VOL:1504,DS8000:2107.04131:VOL:1509,
DS8000:2107.04131:VOL:150E
ESS:2105.FCA57:VOL:1500,DS8000:2107.NF111:VOL:1505,
DS8000:2107.04131:VOL:1600,DS8000:2107.04131:VOL:1605,
DS8000:2107.04131:VOL:160A
ESS:2105.FCA57:VOL:1501,DS8000:2107.NF111:VOL:1506,
DS8000:2107.04131:VOL:1601,DS8000:2107.04131:VOL:1606,
DS8000:2107.04131:VOL:160B
ESS:2105.FCA57:VOL:1502,DS8000:2107.NF111:VOL:1507,
DS8000:2107.04131:VOL:1602,DS8000:2107.04131:VOL:1607,
DS8000:2107.04131:VOL:160C
ESS:2105.FCA57:VOL:1503,DS8000:2107.NF111:VOL:1508,
DS8000:2107.04131:VOL:1603,DS8000:2107.04131:VOL:1608,
DS8000:2107.04131:VOL:160D
ESS:2105.FCA57:VOL:1504,DS8000:2107.NF111:VOL:1509,
DS8000:2107.04131:VOL:1604,DS8000:2107.04131:VOL:1609,
DS8000:2107.04131:VOL:160E

IWNR1301I The export of a copy set for session session1 succeeded.

Exporting copy sets to standard out (XIV system sessions)

The following command exports the copy sets in the XIV system Global Mirror
Failover/Failback session xiv_gm_1 to standard output.
csmcli> exportcsv xiv_gm_1

The following output is returned. For all XIV system session types, the volume
nickname rather than the volume ID is provided in the output. In the following
out example, myvolume is the volume nickname for both the H1 and H2 volumes.

168 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Exporting...
#xiv_gm_1
#Global Mirror Failover/Failback
##Aug 25 9:48:26 AM

H1,H2
XIV:VOL:7803448:myvolume,XIV:VOL:7804988:myvolume

IWNR1301I The export of a copy set for session xiv_gm_1 succeeded.

hareconnect
Use the hareconnect command to reconnect the active and standby servers for
high availability (HA).

Syntax

hareconnect
-help -quiet
-h
-?

Example

Reconnecting the active and standby management servers

The following command reconnect the active and standby management servers.
csmcli> hareconnect

The following output is returned:

IWNR3052I Successfully reconnected with the high availability server
tpc1.storage.tucson.ibm.com from the server tpc2.storage.tucson.ibm.com

hatakeover
Use the hatakeover command to change the standby server to the active server.

Syntax

hatakeover
-help -quiet
-h
-?

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.

Command-line interface 169

-quiet
Suppresses the confirmation prompt for this command. This flag answers yes
to all confirmation prompts.

Description

Note: For the several commands that implement high-availability with the
definition of a standby server, the standby server must be at the same level of IBM
Tivoli Storage Productivity Center for Replication code as the active server.

Example

Changing the standby server to the active server

The following command changes the standby server to the active server.
csmcli> hatakeover

The following output is returned:

IWNR3063I Successfully issued the takeover to the standby server
tpc2.storage.tucson.ibm.com with the active HA server
tpc1.storage.tucson.ibm.com.

importcsv
Use the importcsv command to parse a comma-separated values (CSV) file to
create copy sets for a session.

The CSV file is parsed and copy sets are created from the data in the file. The CSV
file must contain data for all the necessary roles in the session for which the copy
sets are being created.

The following is an example CSV file for storage systems other than XIV system.
#Session1,
#FlashCopy,
#Oct 2 10:03:18 AM

H1,T1
DS8000:2107.FRLL1:VOL:1004,DS8000:2107.FRLL1:VOL:1104
DS8000:2107.FRLL1:VOL:1011,DS8000:2107.FRLL1:VOL:1101
DS8000:2107.FRLL1:VOL:1005,DS8000:2107.FRLL1:VOL:1105

Each line represents source and target volumes for the copy sets. The values for
the volumes consist of the following information delimited by a colon:
v The storage system type
v The numeric value for the storage system type (this is not included for all
storage system types)
v The serial number
v The volume ID preceded by VOL:.

The following is an example CSV file for an XIV system.

#xiv_gm_1
#Global Mirror Failover/Failback
##Aug 25 9:48:26 AM

H1,H2
XIV:VOL:7803448:myvolume,XIV:VOL:7804988:myvolume

170 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

The values for the volumes consist of the following information delimited by a
colon:
v The storage system type
v The serial number preceded by VOL:.
v The volume ID or volume nickname. In the preceding example, the volume
nickname myvolume is provided.

Commented lines in a CSV file must start with #.

Syntax

importcsv -file file_name session_name

-help -quiet -
-h
-?

Examples

Importing a CSV file for a System Storage DS8000 session

The following command imports the file name exportcsvtest.csv into session
session1 without prompting for a confirmation.
csmcli> importcsv -quiet -file exportcsvtest.csv session1

The following output is returned:

IWNR2001I The pair was successfully created in session session1 for copy set
DS8000:2107.FRLL1:VOL:1004 with source DS8000:2107.FRLL1:VOL:1004 and target
DS8000:2107.FRLL1:VOL:1104.

IWNR2001I The pair was successfully created in session session1 for copy set
DS8000:2107.FRLL1:VOL:1011 with source DS8000:2107.FRLL1:VOL:1011 and target
DS8000:2107.FRLL1:VOL:1101.

IWNR2001I The pair was successfully created in session session1 for copy set
DS8000:2107.FRLL1:VOL:1005 with source DS8000:2107.FRLL1:VOL:1005 and target
DS8000:2107.FRLL1:VOL:1105.

Importing a CSV file for a XIV system session

Command-line interface 171

The following command imports the file name xiv_gm_1.csv into session xiv_gm_1
without prompting for a confirmation.
csmcli> importcsv -quiet -file importcsv xiv_gm_1.csv

The following output is returned:

IWNR2001I The pair was successfully created in session xiv_gm_1 for copy set
XIV:VOL:7803448:myvolume with source XIV:VOL:7803448:myvolume and target
XIV:VOL:7804988:myvolume.

lsauth
Use the lsauth command to lists the name, authorization level, and session
permission for each user or user group.

Syntax

-s
lsauth
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s Displays default information about each user and user group, including the
name, classification, and role.
-l Displays detailed information for each user and user group, including:

Column label Details

User name The user name for each authorization and session
that the user has permission to manage.
Classification The type: user or group.
Role The role: Administrator, Operator, or Monitor
Session The session name if the role is Operator, or a dash (-)
if the role is Administrator or Monitor.

-fmt { default | xml | delim | stanza }

Specifies the format of the output. You can specify one of these values:
default
Specifies that the output is displayed in tabular format using spaces as
delimiters between columns. This is the default value.
xml Specifies that the output is displayed in XML format.
delim Specifies that output is displayed in a tabular format using commas as
delimiters between columns.
172 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference
To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.

Example
1. Listing all users and user groups
The following command lists all currently defined users and user groups.
csmcli> lsauth
The following output is returned:
Name Classification Role
====================================
csmuser User Administrator
2. Listing detailed authorization information
The following command lists detailed information about the user csmuser.
csmcli> lsauth -l
The following output is returned:
Name Classification Role Session
============================================
csmuser User Administrator -

Command-line interface 173

lsavailports
Use the lsavailports command to display the port configuration types for a specific
path.

Syntax

-s
lsavailports
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

-src source_lss -tgt target_lss

Column label Details

Source Origin of the path; for ESS, an LSS.
Target Target of the path; for ESS, an LSS.
Type The configuration of the port (such as Enterprise
Systems Connection [ESCON®] or Fibre Channel).

-fmt { default | xml | delim | stanza }

174 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
-src source_lss
Specifies the source LSS (for example, ESS:2105.FCA57:LSS:21).
-tgt target_lss
Specifies the target LSS (for example, ESS:2105.FCA57:LSS:21).

Example

Listing port configuration for paths

The following command lists the port configuration used for each path with source
LSS DS8000:2107.04131:LSS:15 and target LSS ESS:2105.FCA57:LSS:15.
csmcli> lsavailports -src DS8000:2107.04131:LSS:15 -tgt ESS:2105.FCA57:LSS:15

The following output is returned:

Source Target Type
============================================================================
DS8000:2107.04131:LSS:15.0x0330 ESS:2105.FCA57:LSS:15.0x008C Fibre Channel
DS8000:2107.04131:LSS:15.0x0110 ESS:2105.FCA57:LSS:15.0x000C Fibre Channel
DS8000:2107.04131:LSS:15.0x0110 ESS:2105.FCA57:LSS:15.0x008C Fibre Channel
DS8000:2107.04131:LSS:15.0x0110 ESS:2105.FCA57:LSS:15.0x0088 Fibre Channel
DS8000:2107.04131:LSS:15.0x0110 ESS:2105.FCA57:LSS:15.0x0028 Fibre Channel

lscpset
Use the lscpset command to list the IDs of copy sets in a session.

Command-line interface 175

Tip: Use the showcpset command to list the volumes in a copy set and use the
lsvol command to display the status of volumes in a copy set.

Syntax

-s
lscpset
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

session_name
-h1 h1_volume_id -

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s | -l
Displays the following information:

Column Label Details

H1 Volume ID The ID of the volume at host site 1 which is used to identify copy sets
in a session
Session The name of the session that contains the copy sets
Volumes The number of volumes associated with the copy set

-fmt { default | xml | delim | stanza }

176 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
-h1 h1_volume_id
Specifies the volume ID at host site 1.
session_name | -
Specifies the name of the session that contains the copy sets.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Examples

Listing the IDs of copy sets in a session

The following command lists copy set IDs and the number of volumes that are
associated with the copy sets in a session called session1:
csmcli> lscpset session1

The following output is returned:

H1 Volume ID Session Volumes
================================================
DS8000:2107.NK791:VOL:1500 session1 5
DS8000:2107.NK791:VOL:1501 session1 5
DS8000:2107.NK791:VOL:1502 session1 5
DS8000:2107.NK791:VOL:1503 session1 5
DS8000:2107.NK791:VOL:1504 session1 5
ESS:2105.FCA57:VOL:1500 session1 5
ESS:2105.FCA57:VOL:1501 session1 5
ESS:2105.FCA57:VOL:1502 session1 5
ESS:2105.FCA57:VOL:1503 session1 5
ESS:2105.FCA57:VOL:1504 session1 5

Command-line interface 177

lscptypes
Use the lscptypes command to display all the supported session (copy) types that
you can use with the mksess command.

Syntax

-s
lscptypes
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

-devtype ds
ds6000
ds8000
ess
svc
storwize-v7000
xiv

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s
Lists default information about the session types being used, including the full
name and description.
-l
Displays detailed information for each session types, including:

Column label Details

Copy Type The abbreviated name of the session type that you
can specify with the mksess command (for example,
mgm).
Full Name The full name of the session type (for example, Metro
Global Mirror).
Device Types The device types that are supported by the session
type. The device type values are: DS, DS6000, DS8000,
ESS, SAN Volume Controller, and STORWIZE-V7000,
XIV.

-fmt { default | xml | delim | stanza }

Specifies the format of the output. You can specify one of these values:

178 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

default
Specifies that the output is displayed in tabular format using spaces as
delimiters between columns. This is the default value.
xml Specifies that the output is displayed in XML format.
delim Specifies that output is displayed in a tabular format using commas as
delimiters between columns.
To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
-devtype { ds | ds6000 | ds8000 | ess | svc | storwize-v7000 | xiv }
Specifies the session types supported by hardware device.

Example

Listing all session types for a System Storage DS8000 or System Storage DS6000
session

The following command lists all the session types that you can use.
csmcli> lscptypes

The following output is returned:

Command-line interface 179

Copy Type Full Name Device Types
======================================================================================================
fc FlashCopy DS8000, DS6000, ESS, SVC, STORWIZE-V7000
snap Snapshot XIV
mmsd Metro Mirror Single Direction DS8000, DS6000, ESS, SVC, STORWIZE-V7000
mmfofb Metro Mirror Failover/Failback DS8000, DS6000, ESS, SVC, STORWIZE-V7000
mmfofbxiv Metro Mirror Failover/Failback XIV
pmm Metro Mirror Failover/Failback w/ Practice DS8000, DS6000, ESS
pmmsvc Metro Mirror Failover/Failback w/ Practice SVC, STORWIZE-V7000
gmsd Global Mirror Single Direction DS8000, DS6000, ESS
gmsdsvc Global Mirror Single Direction SVC, STORWIZE-V7000
gmfofb Global Mirror Failover/Failback DS8000, DS6000, ESS
gmfofbsvc Global Mirror Failover/Failback SVC, STORWIZE-V7000
gmfofbxiv Global Mirror Failover/Failback XIV
pgm Global Mirror Failover/Failback w/ Practice DS8000, DS6000, ESS
pgmsvc Global Mirror Failover/Failback w/ Practice SVC, STORWIZE-V7000
pgm2s Global Mirror Either Direction w/ Two Site Practice DS8000, DS6000, ESS
mgm Metro Global Mirror DS8000, ESS
pmgm Metro Global Mirror w/ Practice DS8000, ESS

Listing session types supported for System Storage DS8000 and System Storage
DS6000 storage systems
csmcli> lscptypes -devtype ds

The following output is returned:

Listing session types supported for an XIV system

csmcli> lscptypes -devtype xiv

The following output is returned:

Copy Type Full Name Device Types
======================================================================================================
snap Snapshot XIV
mmfofbxiv Metro Mirror Failover/Failback XIV
gmfofbxiv Global Mirror Failover/Failback XIV

lsdevice
Use the lsdevice command to list storage systems and properties.

Tip: To list storage systems that can be discovered through an IBM z/OS
connection, use the lsstorcandidate command.

Syntax

-s
lsdevice
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

180 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

on on -r number off
-p off -hdr off -v on

-devtype ds
ds6000 -mcid mc_id
ds8000
ess device_id
storwize-v7000 -
svc
xiv

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s
Specifies that default information for each storage system is displayed. This
information includes the device ID, connection type, device type, and local
server connection status.
-l
Specifies that detailed information for each storage system is displayed,
including:

Column Label Details

Device ID The name, nickname, or model-serial-manufacturer of
the storage system.
Connection Type The connection type: Direct, HMC, or z/OS.
Device Type The storage system type: DS6000, DS8000, ESS, SAN
Volume Controller, STORWIZE-V7000, or XIV.
Device IP Address The IP address or host name for the nodes or clusters
that are used by the storage system. If there are
multiple nodes or clusters, the values in this column
are delimited by a semicolon (for example,
ip_address;ip_address).
Local Server Connection The state of the direct connections to the local
management server. If there are multiple servers, the
values in this column are delimited by a semicolon
(for example, cluster0_status;cluster1_status).
Remote Server Connection The state of the direct connections to the remote
management server. If there are multiple servers, the
values in this column are delimited by a semicolon
(for example, cluster0_status;cluster1_status).
Management Console ID The ID of the Hardware Management Console
(HMC). This parameter applies only to System
Storage DS8000 storage systems that are using HMCs
to connect.
Location The location of the storage system.
Manufacturer The manufacturer of the storage system.
Device Name The user-defined name of the storage system.

Command-line interface 181

-fmt { default | xml | delim | stanza }
Specifies the format of the output. You can specify one of these values:
default
Specifies that the output is displayed in tabular format using spaces as
delimiters between columns. This is the default value.
xml Specifies that the output is displayed in XML format.
delim Specifies that output is displayed in a tabular format using commas as
delimiters between columns.
To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
-devtype { ess | ds | ds6000 | ds8000 | storwize-v7000 | svc | xiv}
Specifies the type of storage system. Supported storage systems are:
v ds: IBM System Storage DS8000 or System Storage DS6000
v ds6000: System Storage DS6000
v ds8000: IBM System Storage DS8000
v ess: IBM TotalStorage Enterprise Storage Server Model 800
v storwize-v7000: IBM Storwize V7000 and IBM Storwize V7000 Unified
v svc: IBM System Storage SAN Volume Controller
v xiv: IBM XIV Storage System
182 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference
-mcid mc_id
Specifies storage systems that are connected through a specific management
console.
device_id... | -
Specifies one or more storage systems by ID. The storage system ID is in the
element ID format (for example, ess:box:2105.fca57). Separate multiple
storage system IDs with a space.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Examples

Listing all System Storage DS8000 and System Storage DS6000 storage systems

The following command lists information for all System Storage DS8000 and
System Storage DS6000 series storage systems.
csmcli> lsdevice -devtype ds
Device ID Connection Type Device Type Local Server Connection
=========================================================================
DS8000:BOX:2107.04131 Direct DS8000 Connected;Connected
DS8000:BOX:2107.MW931 Direct DS8000 Connected;Connected
DS8000:BOX:2107.NF111 Direct DS8000 Connected;Connected
DS8000:BOX:2107.NK791 Direct DS8000 Connected;Connected
DS6000:BOX:1750.AAXYA Direct DS6000 Connected;Connected

Listing detailed attributes for a storage system

The following command lists detailed information for the storage system
DS8000:BOX:2107.04131.
csmcli> lsdevice -devtype ds -l -fmt stanza DS8000:BOX:2107.04131

The following output is returned:

Device ID DS8000:BOX:2107.04131
Connection Type Direct
Device Type DS8000
Device IP Address stg8k05c0;stg8k05c1
Local Server Connection Connected;Connected
Remote Server Connection -
Management Console ID -
Location Boulder
Manufacturer IBM

Listing all XIV systems

The following command lists information for a all XIV systems.

csmcli> lsdevice -devtype XIV

The following output is returned:

Device ID Connection Type Device Type Local Server Connection
=========================================================================
XIV:BOX:7803441 Direct XIV Connected;Connected;Connected
XIV:BOX:7803448 Direct XIV Connected;Connected;Connected

Listing detailed attributes for all XIV systems

The following command lists detailed information for all XIV systems.
csmcli> lsdevice -devtype XIV -l

Command-line interface 183

The following output is returned:
Device ID Connection Type Device Type Device IP Address
=============================================================================
XIV:BOX:7803441 Direct XIV tpcr_xiva2.storage.tucson.ibm.com
XIV:BOX:7803448 Direct XIV tpcr_xivb2.storage.tucson.ibm.com
Local Server Connection Remote Server Connection Management Console ID
======================================================================
Disconnected - -
Disconnected - -
Location Manufacturer Device Name
=================================
Tucson IBM XIV_A
Phoenix IBM XIV_B

lshaservers
Use the lshaservers command to show the status of each active and standby
management server.

Syntax

-s
lshaservers
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-l | -s
Displays detailed information for each management server, including:

Column label Details

Server The domain or IP address of the management server
Role The role of management server: Active or Standby
Status The status of the relationship
Port The standby management server port number. This
port is used for communication between the active
and standby management server.

This port number is initially set at installation time.

Important: The standby management server port
number must be the same on both management
servers in a high-availability relationship. If you
change the port number on one management server,
you must also change it on the other.

184 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Example

Listing management server status

The following command lists the status of the active and standby management
servers.
csmcli> lshaservers

The following output is returned:

Command-line interface 185

Server Role Status Port
========================================================
tpc1.storage.tucson.ibm.com ACTIVE Synchronized 5120
tpc2.storage.tucson.ibm.com STANDBY Synchronized 5120

lshost
Use the lshost command to view host systems that have been added to IBM Tivoli
Storage Productivity Center for Replication.

Syntax

-s
lshost
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

IP_Address ...
-

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s Specifies that default information for each host system is displayed.
-l Specifies that detailed information for each host system is displayed, including:

Column Label Details

Host System The IP address or host name of the host system.
Port The port number for the connection to the host
system.
Type The type of host system.
Local Status The status of the connection between the Tivoli
Storage Productivity Center for Replication server
and the host system.
Remote Status In high availability environments that have an active
and standby management server, the status of the
connection between the remote Tivoli Storage
Productivity Center for Replication server and the
host system. If you are running the lshost command
on the active server, the remote server is the standby
server. If you are running the command on the
standby server, the remote server is the active server.
Sessions The sessions that are associated with the host system.

186 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-fmt { default | xml | delim | stanza }
Specifies the format of the output. You can specify one of these values:
default
Specifies that the output is displayed in tabular format using spaces as
delimiters between columns. This is the default value.
xml Specifies that the output is displayed in XML format.
delim Specifies that output is displayed in a tabular format using commas as
delimiters between columns.
To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
IP_Address ... | -
If you want to view specific host systems only, specifies the IP address or host
name of the host system that you want to view. You can enter multiple IP
addresses or host names.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Example
v Listing all host systems

Command-line interface 187

The following command lists information about all host systems that have been
added to Tivoli Storage Productivity Center for Replication.
csmcli> lshost
The following output is returned:
Host System Port Type Local Status Sessions
======================================================
9.11.223.43 9930 AIX Connected MyMMSession
9.11.223.85 9990 Unknown Disconnected -
v Listing detailed information for host systems
The following command lists detailed information about the host systems.
csmcli> lshost -l
The following output is returned:
Host System Port Type Local Status Remote Status Sessions
============================================================
9.11.223.43 9930 AIX Connected Connected -
9.11.223.85 9990 Unknown Disconnected Disconnected -

lslocation
Use the lslocation command to list all defined locations.

Syntax

-s
lslocation
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

Column label Details

Location An integer representing the location.
Details The alphanumeric text string that was given to the
location. The string can be descriptive of the location.

-fmt { default | xml | delim | stanza }

188 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

xml Specifies that the output is displayed in XML format.
delim Specifies that output is displayed in a tabular format using commas as
delimiters between columns.
To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.

Example

Listing locations

The following command lists all locations.

csmcli> lslocation

The following output is returned:

Location Details
=================
1 Boulder
3 Marana
2 Tucson

Command-line interface 189

lslss
Use the lslss command to list the logical subsystems (LSSes) for the specified DS
or ESS storage system. You can use this output with the mkpath command.

Syntax

-s
lslss
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

-dev device_id

Column label Details

Device Storage system of the LSSs
LSS ID LSS identifier

-fmt { default | xml | delim | stanza }

190 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
-dev device_id
Lists information for the specified DS or ESS storage system.

Example

Listing LSS for a storage system

The following command lists all available LSSs associated with the storage system
DS8000:BOX:2107.04131.
csmcli> lslss -dev DS8000:BOX:2107.04131

The following output is returned:

Device LSS
==============================================
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:00
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:01
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:02
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:03
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:04
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:05
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:06
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:07
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:08
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:09
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:0A
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:0B
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:0C
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:0D
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:0E
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:0F
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:10
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:11
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:12
DS8000:BOX:2107.04131 DS8000:2107.04131:LSS:14

Command-line interface 191

lsmc
Use the lsmc command to display a summary of management consoles and
settings.

Syntax

-s
lsmc
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

-devtype
ds
ds8000 id
-

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s
Displays default information for each management console, including the ID
and local server connection.
-l Displays detailed information for each management console, including:

Column label Details

Management console ID The ID of the management console.
Management console IP The cluster 0 IP address or domain.
Local Server Connection The connection status of the management console to
the local server.
Location The associated location of the management console or
None.

-fmt { default | xml | delim | stanza }

192 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
-devtype ds | ds8000
Displays information for the specified device type. You can specify one of these
values:
ds - any DS device
ds8000 - only DS8000 devices
id... | -
Displays only the threshold settings for one or more specified management
console IDs. The management console ID is in the element ID format (for
example, HMC:9.11.222.333). Separate multiple IDs with a blank space.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Example

Listing management consoles

The following command lists the management consoles and settings for all DS
storage systems.
csmcli> lsmc -devtype ds -l

Command-line interface 193

The following output is returned:
MC ID HMC:2002:90B:E006:222:9:11:223:2
MC IP address 2002:90b:e006:222:9:11:223:2
Local Server Connection Connected
Location tucson

lspair
Use the lspair command to list the copy pairs for a specified role pair or to list the
copy pairs for a specified copy set.

Important: The lspair command is not used for IBM XIV Storage System Snapshot
sessions because copy pairs do not exist in this session type.

Syntax

-s
lspair
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

-rolepair role_pair_name session_name

-cpset source_vol_id -state state -

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s Specifies that default information for each copy pair is displayed. The default
information is the source and target volumes in the pair and the role pair.
-l Displays detailed information for each copy pair, including:

Column Label Details

Source Volume The ID of the source volume in the copy pair.
Target Volume The ID of the target volume in the copy pair.
Role Pair The associated role pair for the copy pair. See the
-rolepair for sample role pair values.
State The state of the copy pair. The valid values include:
Defined
Preparing
Prepared
TargetAvailable
Suspended
SuspendedInconsistent
Recoverable Specifies Yes or No to indicate if the copy pair is
recoverable.

194 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Column Label Details
Copying Specifies Yes or No to indicate if the copy pair is in
the process of copying data.
Progress The overall copy progress that is associated with the
copy pair (if applicable).
New Specifies Yes or No to indicate if the copy pair is a
new pair.
Copy Set The host site 1 volume ID of the copy set with which
the copy pair is associated.
Timestamp The date and time that the copy pair was suspended
(if applicable).
Last Result The last message that was issued for the copy pair. If
message ends in E or W, the copy pair is an exception
pair.

-fmt { default | xml | delim | stanza }

Specifies the format of the output. You can specify one of these values:
default
Specifies that the output is displayed in tabular format using spaces as
delimiters between columns. This is the default value.
xml Specifies that the output is displayed in XML format.
delim Specifies that output is displayed in a tabular format using commas as
delimiters between columns.
To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.

Command-line interface 195

-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
-rolepair role_pair_name
Specifies that only copy pairs that are associated with the specified role pair
name are displayed. Role pair names are defined by the lsrolepairs command.
The following list provides sample role-pair names:
v h1-h2
v h1-h3
v h1-i1
v h1-i2
v h1-i3
v h1-j2
v h1-t1
v h2-i1
v h2-i2
v h2-i3
v h2-j1
v h2-j3
v h3-i3
v i1-j1
v i2-j2
v i3-j3
This parameter is mutually exclusive with the -cpset parameter.
-cpset source_vol_id
Specifies that only copy pairs that are associated with the specified source
volume ID of a copy set are displayed.
This parameter is mutually exclusive with the -rolepair parameter.
-state state
Specifies that only copy pairs in a specified state are displayed. You can specify
one of these states:
v Defined
v Preparing
v Prepared
v TargetAvailable
v Suspended
v SuspendedInconsistent
session_name | -
Specifies that only copy pairs for the specified session are displayed.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Examples

Listing all copy pairs for a specific role pair

196 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

The following command lists the copy pairs that are associated with role pair
h1-h2 in the session session1:
csmcli> lspair -rolepair h1-h2 session1

The following output is returned:

Source Volume Target Volume Role Pair
================================================================
DS8000:2107.NK791:VOL:1500 DS8000:2107.MW931:VOL:1500 H1-H2
DS8000:2107.NK791:VOL:1501 DS8000:2107.MW931:VOL:1501 H1-H2
DS8000:2107.NK791:VOL:1502 DS8000:2107.MW931:VOL:1502 H1-H2
DS8000:2107.NK791:VOL:1503 DS8000:2107.MW931:VOL:1503 H1-H2
DS8000:2107.NK791:VOL:1504 DS8000:2107.MW931:VOL:1504 H1-H2
ESS:2105.FCA57:VOL:1500 DS8000:2107.NF111:VOL:1505 H1-H2
ESS:2105.FCA57:VOL:1501 DS8000:2107.NF111:VOL:1506 H1-H2
ESS:2105.FCA57:VOL:1502 DS8000:2107.NF111:VOL:1507 H1-H2
ESS:2105.FCA57:VOL:1503 DS8000:2107.NF111:VOL:1508 H1-H2
ESS:2105.FCA57:VOL:1504 DS8000:2107.NF111:VOL:1509 H1-H2

Listing all copy pairs in a specific state

The following command lists the copy pairs that are associated with role pair
h2-i3 in the session session1 and are in the Suspended state:
csmcli> lspair -rolepair h2-i3 -state Suspended session1

The following output is returned:

Source Volume Target Volume Role Pair
==============================================================
DS8000:2107.MW931:VOL:1500 DS8000:2107.04131:VOL:1505 H2-I3
DS8000:2107.MW931:VOL:1501 DS8000:2107.04131:VOL:1506 H2-I3
DS8000:2107.MW931:VOL:1502 DS8000:2107.04131:VOL:1507 H2-I3
DS8000:2107.MW931:VOL:1503 DS8000:2107.04131:VOL:1508 H2-I3
DS8000:2107.MW931:VOL:1504 DS8000:2107.04131:VOL:1509 H2-I3
DS8000:2107.NF111:VOL:1505 DS8000:2107.04131:VOL:1605 H2-I3
DS8000:2107.NF111:VOL:1506 DS8000:2107.04131:VOL:1606 H2-I3
DS8000:2107.NF111:VOL:1507 DS8000:2107.04131:VOL:1607 H2-I3
DS8000:2107.NF111:VOL:1508 DS8000:2107.04131:VOL:1608 H2-I3
DS8000:2107.NF111:VOL:1509 DS8000:2107.04131:VOL:1609 H2-I3

Listing detailed information for all copy pairs for a specific copy set

The following command lists detailed information about the copy pairs that are
associated with the copy set DS8000:2107.NK791:VOL:1500 in the session session1.
The -fmt stanza parameter specifies that the output is displayed as one
keyword-value pair per line.
csmcli> lspair -l -fmt stanza -cpset DS8000:2107.NK791:VOL:1500 session1

The following output is returned:

Source Volume DS8000:2107.04131:VOL:1500
Target Volume DS8000:2107.04131:VOL:1505
Role Pair H3-I3
State Defined
Recoverable No
Copying No
Progress -
New Yes
Copy Set DS8000:2107.NK791:VOL:1500
Timestamp n/a
Last Result IWNR2024I

Source Volume DS8000:2107.04131:VOL:1505

Target Volume DS8000:2107.04131:VOL:150A

Command-line interface 197

Role Pair I3-J3
State Defined
Recoverable No
Copying No
Progress -
New Yes
Copy Set DS8000:2107.NK791:VOL:1500
Timestamp n/a
Press Enter To Continue...

Last Result IWNR2013I

Source Volume DS8000:2107.MW931:VOL:1500

Target Volume DS8000:2107.04131:VOL:150A
Role Pair H2-J3
State Defined
Recoverable No
Copying No
Progress -
New Yes
Copy Set DS8000:2107.NK791:VOL:1500
Timestamp n/a
Last Result IWNR2024I

...

lsparameter
Use the lsparameter command to list Metro Mirror heartbeat setting.

Syntax

-s
lsparameter
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

-parmname consistencyheartbeat

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s Displays default information for each system parameter, including the
parameter name and value.
-l Displays detailed information for each system parameter, including:

Column label Details

Parameter Name Value of the system parameter

198 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Column label Details
Value The value of the system parameter (for example, Yes
or No).
Parm Name Name of the system parameter

-fmt { default | xml | delim | stanza }

Specifies the format of the output. You can specify one of these values:
default
Specifies that the output is displayed in tabular format using spaces as
delimiters between columns. This is the default value.
xml Specifies that the output is displayed in XML format.
delim Specifies that output is displayed in a tabular format using commas as
delimiters between columns.
To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
-parmname consistencyheartbeat
Displays whether the Metro Mirror heartbeat is enabled (on) or disabled (off).

Command-line interface 199

Example
1. Listing all parameters
The following command lists detailed information about all parameters.

Note: Only the heartbeat setting is currently supported and returned by this
command.
csmcli> lsparameter -l
The following output is returned:
Parameter Name Value Parm Name
=========================================================
The heartbeat function is set on consistencyheartbeat
2. Displaying the Metro Mirror heartbeat setting
The following command displays the current setting for the Metro Mirror
heartbeat.
csmcli> lsparameter -parmname consistencyheartbeat
The following output is returned:
Parameter Name Value
====================================
The heartbeat function is set on

lspath
Use the lspath command to display paths between ESS and DS devices. You can
then use this information for a remote copy.

Syntax

-s
lspath
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

-src source_lss
-tgt target_lss

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s Displays default information for each path, including the source and target
LSS, path type, status, and whether the path was auto-generated.
-l Displays detailed information for each path, including:

200 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Column label Details
Source Origin of the path. For ESS, this is an LSS. See the
mkpath command for the format of this field.
Target Target of the path. For ESS this is an LSS. See the
mkpath command for the format of this field.
Type ESCON (ESS or DS only) or Fibre Channel.
Status Whether the path is currently established or not.
Auto-Generated Yes, if the path was generated by the IBM Tivoli
Storage Productivity Center for Replication
component. No, if you specified the path.

-fmt { default | xml | delim | stanza }

Specifies the format of the output. You can specify one of these values:
default
Specifies that the output is displayed in tabular format using spaces as
delimiters between columns. This is the default value.
xml Specifies that the output is displayed in XML format.
delim Specifies that output is displayed in a tabular format using commas as
delimiters between columns.
To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:

Command-line interface 201

on Enable verbose mode.
off Disable verbose mode. This is the default value.
-src source_lss
Specifies the source LSS. This must be specified in the format
type.serial.lss(hex).port(hex) (for example, ESS:2105.FCA18:LSS:10.00FF).
-tgt target_lss
Specifies the target LSS. This must be specified in the format
type.serial.lss(hex).port(hex) (for example, ESS:2105.FCA18:LSS:10.00FF).

Example
1. Listing all paths with the same source LSS
The following command lists all paths that use source LSS
DS8000:2107.04131:LSS:15.
csmcli> lspath -src DS8000:2107.04131:LSS:15
The following output is returned:
Source Target Type
=============================================================================
DS8000:2107.04131:LSS:15.0x0330 DS8000:2107.NF111:LSS:15.0x0030 Fibre Channel
DS8000:2107.04131:LSS:15.0x0110 ESS:2105.FCA57:LSS:15.0x000C Fibre Channel
DS8000:2107.04131:LSS:15.0x0110 DS8000:2107.NK791:LSS:15.0x0032 Fibre Channel

Status Auto-Generated
==========================
Established Yes
Established Yes
Established Yes
2. Listing information about a specific path
The following command lists information about the path with source LSS
DS8000:2107.04131:LSS:15.
csmcli> lspath -src DS8000:2107.04131:LSS:15 -tgt ESS:2105.FCA57:LSS:15
The following output is returned:
Source Target Type
==========================================================================
DS8000:2107.04131:LSS:15.0x0110 ESS:2105.FCA57:LSS:15.0x000C Fibre Channel

Status Auto-Generated
==========================
Established Yes

lspool
Use the lspool to list pools that are on XIV systems.

Syntax

-s
lspool
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

202 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

on on -r number off
-p off -hdr off -v on

-dev device_ID
-devicename device_name

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s | -l
Displays the following information:

Column Label Details

Device Name The name of the XIV system that contains the pools.
Device ID The ID of the XIV system that contains the pools.
Pool Name The name of the pool.
Pool ID The ID for the pool.

-fmt { default | xml | delim | stanza }

Command-line interface 203

-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
-dev device_ID and -devicename device_name
Both of these parameters specify that only pools on a specific storage system
are displayed. The -dev parameter specifies that the storage system is
determined by the ID for the system. The -devicename parameter specifies that
the storage system is determined by the name of the storage system.
The -dev and -devicename parameters are mutually exclusive.
If the -dev or -devicename parameter is not provided, the output shows the
pools for all XIV systems.

Examples

Listing pools on all XIV systems

The following command lists the pools that are on all XIV systems.
csmcli> lspool -l

The following output is returned:

Device Name Device ID Pool Name Pool ID
=================================================================================
XIV 1300202 Troy XIV:BOX:1300202 mysnappool1 XIV:POOL:1300202:100929
XIV 1300202 Troy XIV:BOX:1300202 mysnappool2 XIV:POOL:1300202:100930
XIV 1300202 Troy XIV:BOX:1300202 mysnappool3 XIV:POOL:1300202:100931
XIV 1300202 Troy XIV:BOX:1300202 mysnappool4 XIV:POOL:1300202:112412
XIV_B XIV:BOX:1566078 healthcare XIV:POOL:1566078:436473
XIV_B XIV:BOX:1566078 mysnappool1 XIV:POOL:1566078:436474
XIV_B XIV:BOX:1566078 yogapool XIV:POOL:1566078:436475

Listing pools on a specific XIV system by storage system ID

The following command lists the pools that are on the XIV system with the ID
XIV:BOX:1300202.
csmcli> lspool -dev XIV:BOX:1300202 -l

The following output is returned:

204 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Listing pools on a specific XIV system by storage system name

The following command lists the pools that are on the XIV system that is named
XIV:BOX:1300202 Troy.
csmcli> lspool -devicename ’XIV:BOX:1300202 Troy’

The following output is returned:

lsrolepairs
Use the lsrolepairs command to display role pairs in a session.

Syntax

-s
lsrolepairs
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

session_name
-

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s Displays default information for each role pair, including the role name,
session (copy) type, and whether the role pair is recovery, has errors, and is in
processes of copying data.
-l Displays detailed information for each role pair, including:

Column label Details

Name System-generated text string used to identify a role
pair. The value listed here is what is to be entered on
the lspair command.
Recoverable An indicator of whether the role pair is recoverable.
Value values are Yes or No.
Error An indicator of whether the role pair has errors.
Value values are Yes or No.

Command-line interface 205

Column label Details
Copying An indicator of the role pair is in process of copying
data. Value values are Yes or No.
Progress The overall copy progress associated with the role
pair.
Copy Type The current session (copy) type of the role pair.
Error Volumes Total number of volumes in an exception state.
Recoverable pairs Number of recoverable pairs
Copying Pairs Number of copying pairs
Total Pairs Total number of pairs
Recovery Time An indicator of the time to which the session is
recoverable. Includes both date and time. For
point-in-time copy, this is the time that the copy was
taken. For continuous synchronous remote copy, this
is the time at which the Freeze and Run commands
were issued. This field is blank if Recoverable is set
to No.

-fmt { default | xml | delim | stanza }

Specifies the format of the output. You can specify one of these values:
default
Specifies that the output is displayed in tabular format using spaces as
delimiters between columns. This is the default value.
xml Specifies that the output is displayed in XML format.
delim Specifies that output is displayed in a tabular format using commas as
delimiters between columns.
To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.

206 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
session_name | -
Specifies the session name for which you display the role pairs.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Description

To see volumes in a copy set, use the showcpset command.

To see status of volumes in a copy set, use the lsvol command.

Example
1. Listing role pairs in a session
The following command lists information about the role pairs in the session
session1.
csmcli> lsrolepairs session1
The following output is returned:
Name Recoverable Error Copying Copy Type
=========================================
H1-H2 No Yes Yes MM
H2-J3 No No No GM
H1-I3 No No No GC
I3-J3 No No No FC
H1-J3 No No No GM
H3-I3 No No No FC
H2-I3 No No Yes GC
H1-H3 No No No GC

Listing detailed information for the role pairs in a session

The following command lists detailed information about the role pairs in the
session session1.
csmcli> lsrolepairs -fmt stanza -l session1
The following output is returned:
Name H1-H2
Recoverable No
Error Yes
Copying Yes
Copy Type MM
Progress 66
Error volumes 5
Recoverable pairs 5
Copying pairs 5
Total pairs 10
Recovery time n/a

Name H2-J3
Recoverable No

Command-line interface 207

Error No
Copying No
Copy Type GM
Progress -
Error volumes 0
Recoverable pairs 0
Copying pairs 0
Total pairs 10
Recovery time n/a

Name H1-I3
Recoverable No
Error No
Copying No
Copy Type GC
Progress -
Error volumes 0
Recoverable pairs 0
Copying pairs 0
Total pairs 10
Recovery time n/a

...

lsrolescpset
Use the lsrolescpset command to list the volume roles in the specified session.

Syntax

-s
lsrolescpset
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

session_name
-

Column Label Details

Name Short name for the role.
Description Description of the role.

208 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-fmt { default | xml | delim | stanza }
Specifies the format of the output. You can specify one of these values:
default
Specifies that the output is displayed in tabular format using spaces as
delimiters between columns. This is the default value.
xml Specifies that the output is displayed in XML format.
delim Specifies that output is displayed in a tabular format using commas as
delimiters between columns.
To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
session_name | -
Specifies the session name for which you are going to list the roles of the copy
set.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Command-line interface 209

Example

Listing copy set roles

The following command lists the volume roles in session session1.

csmcli> lsrolescpset session1

The following output is returned:

Name Description
==========================
H1 Host on Site1
H2 Host on Site2
H3 Host on Site3
I3 Intermediate on Site3
J3 Journal on Site3

lssess
Use the lssess command to display sessions and their status.

Syntax

-s
lssess
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

-cptype copy_type -status normal
warning
severe session_name
unknown -

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s Displays default information for each session, including the session name,
status, state, and session (copy) type.
-l
Displays detailed information for each session, including:

Column Label Details

Name User-defined name of the session.
Status Status levels. The status level values are Normal,
Warning, Severe, or Unknown.

210 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Column Label Details
State Session state. The session state values are Defined,
Preparing, Prepared, Suspended, TargetAvailable, or
SuspendedInconsistent.
Copy Type Session (copy) type. See the -cptype parameter for a
list of values.
Recoverable Specifies whether a session is recoverable. Valid
values are yes or no.
Copying Specifies whether a copying operation is taking place.
Valid values are yes or no.
Copy Sets Number of copy sets in the session.
Error Specifies whether a session has errors. Valid values
are yes or no.

-fmt { default | xml | delim | stanza }

Specifies the format of the output. You can specify one of these values:
default
Specifies that the output is displayed in tabular format using spaces as
delimiters between columns. This is the default value.
xml Specifies that the output is displayed in XML format.
delim Specifies that output is displayed in a tabular format using commas as
delimiters between columns.
To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.

Command-line interface 211

-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
-cptype copy_type
Specifies the copy session type. You can specify one of these types:
v fc: FlashCopy for IBM TotalStorage Enterprise Storage Server Model 800,
IBM System Storage DS8000, System Storage DS6000, IBM System Storage
SAN Volume Controller, or IBM Storwize V7000.
v mmsd: Metro Mirror Single Direction for TotalStorage Enterprise Storage
Server Model 800, System Storage DS8000, System Storage DS6000, System
Storage SAN Volume Controller, or Storwize V7000.
v mmfofb: Metro Mirror Failover/Failback for TotalStorage Enterprise Storage
Server Model 800, System Storage DS8000, System Storage DS6000, System
Storage SAN Volume Controller, or Storwize V7000.
v pmm: Practice Session for Metro Mirror Failover/Failback for TotalStorage
Enterprise Storage Server Model 800, System Storage DS8000, or System
Storage DS6000.
v pmmsvc: Metro Mirror Failover/Failback with Practice for System Storage
SAN Volume Controller or Storwize V7000.
v gmsd: Global Mirror Single Direction for TotalStorage Enterprise Storage
Server Model 800,System Storage DS8000, or System Storage DS6000.
v gmsdsvc: Global Mirror Single Direction for System Storage SAN Volume
Controller or Storwize V7000.
v gmfofb: Global Mirror Failover/Failback for TotalStorage Enterprise Storage
Server Model 800, System Storage DS8000, or System Storage DS6000.
v gmfofbsvc: Global Mirror Failover/Failback for System Storage SAN Volume
Controller or Storwize V7000.
v hs: Basic HyperSwap for TotalStorage Enterprise Storage Server Model 800,
System Storage DS8000, or System Storage DS6000.
v pgm: Global Mirror Failover/Failback with Practice for TotalStorage
Enterprise Storage Server Model 800, System Storage DS8000, or System
Storage DS6000.
v pgmsvc: Global Mirror Failover/Failback with Practice for System Storage
SAN Volume Controller or Storwize V7000.
v pgm2s: Global Mirror Either Direction with Two Site Practice for TotalStorage
Enterprise Storage Server Model 800, System Storage DS8000, or System
Storage DS6000.
v mgm: Metro Global Mirror for TotalStorage Enterprise Storage Server Model
800 or System Storage DS8000.
v pmgm: Metro Global Mirror with Practice for TotalStorage Enterprise Storage
Server Model 800 or System Storage DS8000.
v snap: XIV snapshot sessions for IBM XIV Storage System.
-status normal | warning | severe | unknown
Specifies that only sessions with the specified status of normal, warning,
severe, or unknown are displayed.
session_name... | -
Specifies that only sessions with a specified session name are displayed.
Separate multiple session names with a space between each name. All sessions
are displayed by default.
Alternatively, use a dash (-) to specify that input for this parameter comes from
an input stream (stdin). The dash is supported only in single-shot mode.

212 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Examples
1. Listing all sessions
The following command lists information about all defined sessions.
csmcli> lssess
The following output is returned:
Name Status State Copy Type
====================================================================
session1 Normal Target Available Metro Global Mirror w/ Practice
2. Listing sessions with errors
The following command lists detailed information about a session named
session1.
csmcli> lssess -status severe session1
The following output is returned:
Name Status State Copy Type
============================================================
session1 Severe Preparing Metro Global Mirror w/ Practice

lssessactions
Use the lssessactions command to list all the session actions (commands) that can
be run for a session.

Tip: To run an action for a session, use the cmdsess command.

Syntax

-s
lssessactions
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

session_name
-

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s | -l
Specifies that the following information is displayed for each session:

Command-line interface 213

Column Label Details
Action Name of the session action (command) that can be
run on the session.
Description The description of the command.

-fmt { default | xml | delim | stanza }

Specifies the format of the output. You can specify one of these values:
default
Specifies that the output is displayed in tabular format using spaces as
delimiters between columns. This is the default value.
xml Specifies that the output is displayed in XML format.
delim Specifies that output is displayed in a tabular format using commas as
delimiters between columns.
To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
session_name... | -

214 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Specifies that only valid actions for the specified session name or names are
displayed. Separate multiple session names with a space between each name. If
you provide more than one session name, all commands that are valid for the
combined sessions are listed.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Example

Listing available actions for a session

The following command lists all actions that can be run for the session named
session1:
csmcli> lssessactions session1

The following output is returned:

Action Description
====================================================
start_h1:h3 Start host1 to host3 copying
suspend Suspend session
start_h1:h2:h3 Start host1 to host2 to host3 copying
terminate Terminate session

lssessdetails
Use the lssessdetails command to display the details of a session.

Syntax

-s
lssessdetails
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

session_name
-

Command-line interface 215

Column label Details
Option Name Name of the option that has been set for this session.
Value Value of the detail that has been set for this session.
Description Description of the session option

-fmt { default | xml | delim | stanza }

Specifies the format of the output. You can specify one of these values:
default
Specifies that the output is displayed in tabular format using spaces as
delimiters between columns. This is the default value.
xml Specifies that the output is displayed in XML format.
delim Specifies that output is displayed in a tabular format using commas as
delimiters between columns.
To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
session_name | -
Lists the details that are relevant to the specified session.

216 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Example

Listing detailed information about a session

The following command lists detailed information about a Metro Global Mirror
with Practice session named session1.
csmcli> lssessdetails -l session1

The following output is returned:

Option name Value Description
=================================================================================
maxdrain_h1j3 30 Maximum Consistency Group Drain Time for the
H1-J3 role pair
coordint_h2j3 50 XDC Coordination Interval for the H2-J3 role
pair
rmreserves No Remove secondary reserves
failIfTgtOnline No Fail MM/GC if the target is online (CKD only)
aftersuspend Release Policy for I/O after suspend
coordint_h1j3 50 XDC Coordination Interval for the H1-J3 role
pair
rpo_h2j3 0 Consistency group interval time (sec) for the
H2-J3 role pair
rpo_h1j3 0 Consistency group interval time (sec) for the
H1-J3 role pair
maxdrain_h2j3 30 Maximum Consistency Group Drain Time for the
H2-J3 role pair

lssnapgrp
Use the lssnapgrp command to view snapshot groups that are in an IBM XIV
Storage System Snapshot session.

A snapshot group is a grouping of snapshots of individual volumes in a

consistency group at a specific point in time.

Syntax

-s
lssnapgrp
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

session_name
-

Command-line interface 217

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s
Specifies that default information for each snapshot group is displayed. The
default information is the name of the snapshot group and the date and time
that the group was created.
-l
Specifies that detailed information for each snapshot group is displayed,
including:

Column Label Details

Name The name of the snapshot group.
Timestamp The date and time that the snapshot group was
created.
Deletion Priority The priority in which the snapshot group will be
deleted from the session. The value is the number 1 -
4. A value of 1 specifies that the snapshot group is
deleted last. A value of 4 specifies that the snapshot
group is deleted first.

Multiple snapshot groups might exist until XIV

system identifies that there is not enough space in the
storage pool to keep all of the snapshots.
Restore Master Specifies whether the snapshot group listed can be
used to restore the master volumes of the session.
Values for this are Yes and No.
Locked Specifies whether the snapshot group is currently
locked. If the snapshot group is locked, write
operations to the snapshots within the snapshot
group are prevented.
Modified Specifies whether the snapshot group has been
modified. A snapshot group is marked as modified
when it is unlocked for the first time.

-fmt { default | xml | delim | stanza }

218 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
session_name | -
Specifies the name of the Snapshot session.
Alternatively, use a dash (-) to specify that input for this parameter comes from
an input stream (stdin). The dash is supported only in single-shot mode.

Example

Listing all snapshot groups that are in a session

The following command lists all snapshot groups that are in the session snap6:
csmcli> lssnapgrp snap6

The following output is returned:

Name Timestamp
===================================================
snap6.snap_group_00001 2011-04-01 00:04:49.000-0500

Listing detailed information about the snapshot groups that are in a session

The following command lists detailed information about the snapshot groups that
are in the session snap6:
csmcli> lssnapgrp -l snap6

The following output is returned:

Command-line interface 219

Name Timestamp Deletion Priority Restore Master
====================================================================================
snap6.snap_group_00001 2011-07-18 15:22:14.000-0700 1 No
snap6.snap_group_00002 2011-07-18 15:22:41.000-0700 1 Yes
Locked Modified
===============
Yes No
Yes No

lssnapgrpactions
Use the lssnapgrpactions command to specify the session and snapshot group
name that you want to view available actions for.

Syntax

-s
lssnapgrpactions
-help -l
-h
-?

default on on
-fmt xml -p off -hdr off
delim
-delim char
stanza

-group snapshot_group_name session_name

-r number off
-v on

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s | -l
-s Specifies the default output which is action name and description.
-l Specifies the detailed output. In this case, specifies the same output as
the -s parameter.
-fmt { default | xml | delim | stanza }
Specifies the format of the output. You can specify one of these values:
default
Specifies that the output is displayed in tabular format using spaces as
delimiters between columns. This is the default value.
xml Specifies that the output is displayed in XML format.
delim Specifies that output is displayed in a tabular format using commas as
delimiters between columns.
To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want

220 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
-group snapshot_group_name
Specifies the name of the snapshot group to list snapshot group actions for.
session_name | -
Specifies the session for which the properties are to be displayed.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Example

Specifying the session and snapshot group name

The following command specifies the session and snapshot group name that you
want to view available actions for.
csmcli> lssnapgrpactions -group MySnapSession.snap_group_0001 MySnapSession

The following output is returned:

Action Description
==============================================================
delete Deletes a snapshot group
disband Disbands a snapshot group
duplicate Duplicates a snapshot group

Command-line interface 221

lock Locks a snapshot group
restore Restores a snapshot group from another snapshot group
set_priority Sets the deletion priority for a snapshot group

lssnapshots
Use the lssnapshots command to view snapshots that are in a snapshot group in a
IBM XIV Storage System Snapshot session.

Syntax

-s
lssnapshots
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

-group snapshot_group_name session_name

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s
Specifies that default information for each snapshot in the snapshot group is
displayed. The default information is the name of the snapshot.
-l
Specifies that detailed information for each snapshot in the snapshot group is
displayed, including:

Column Label Details

Name The name of the snapshot.
H1 Volume ID The ID of the H1 volume that is associated with the
snapshot.
Size The size of the H1 volume at the time that the
snapshot was created.
Size Unit The unit of measure for the size of the H1 volume at
the time that the snapshot was created.

-fmt { default | xml | delim | stanza }

222 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

delim Specifies that output is displayed in a tabular format using commas as
delimiters between columns.
To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
-group snapshot_group_name
Specifies the name of the snapshot group that contains the snapshots.
session_name | -
Specifies the name of the Snapshot session that contains the snapshot group.
Alternatively, use a dash (-) to specify that input for this parameter comes from
an input stream (stdin). The dash is supported only in single-shot mode.

Examples

Listing all snapshots that are in a snapshot group in a session

The following command lists all snapshots that are in the snapshot group
snap6.snap_group_00001 for session snap6:
csmcli> lssnapshots -group snap6.snap_group_00001 snap6

The following output is returned:

Command-line interface 223

Name
===================================================
snap6.snap_group_00001_vol1
snap6.snap_group_00001_vol2

Listing detailed information about the snapshots that are in a snapshot group in
a session

The following command lists detailed information about the snapshots that are in
snapshot group in the session snap6:
csmcli> lssnapshots -group snap6.snap_group_00001 -l snap6

The following output is returned:

Name H1 Volume ID Size Size Unit
=======================================================================
snap6.snap_group_00001_vol1 XIV:VOL:7803307:115017 17.000 GiB
snap6.snap_group_00001_vol2 XIV:VOL:7803307:115018 17.000 GiB

lssnmp
Use the lssnmp command to list the SNMP managers to which IBM Tivoli Storage
Productivity Center for Replication is configured to send SNMP alerts.

Syntax

lssnmp
-help
-h
-?

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.

Description

The information displayed is either the domain name or the IP address of the
server, depending on how you specified it.

SNMP traps are not specific to any particular session. All traps for any session are
sent to each server.

For each SNMP manager, the following information is displayed:

Column label Details

SNMP Manager Domain name or IP address of the management
server to which SNMP traps are sent
Port The specific UDP port to which SNMP traps are sent

Example

Listing SNMP managers

The following command list the SNMP managers.

224 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

csmcli> lssnmp

The following output is returned:

SNMP Manager Port
=================
9.11.10.1 162
127.0.0.1 163

lsstorcandidate
Use the lsstorcandidate command to list the storage systems that can be
discovered through an IBM z/OS connection. This command does not list storage
systems that are already added to the IBM Tivoli Storage Productivity Center for
Replication configuration.

To list storage systems that are already in the Tivoli Storage Productivity Center for
Replication configuration, use the lsdevice command.

You can run the lsstorcandidate command only from a Tivoli Storage Productivity
Center for Replication server that is installed on a system that is running z/OS.

Syntax

-s
lsstorcandidate
-help -l
-h
-?

default on on
-fmt xml -p off -hdr off
delim
-delim char
stanza

-conntype zos
-r number off
-v on

Column Label Details

Device ID The storage system ID.
Manufacturer The manufacturer of the storage system.

-fmt { default | xml | delim | stanza }

Specifies the format of the output. You can specify one of these values:

Command-line interface 225

default
Specifies that the output is displayed in tabular format using spaces as
delimiters between columns. This is the default value.
xml Specifies that the output is displayed in XML format.
delim Specifies that output is displayed in a tabular format using commas as
delimiters between columns.
To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
-conntype zos
Specifies the type of connection that the storage systems use. Currently, you
can specify only zos for a z/OS connection.

Example

Listing candidate storage systems

The following command lists candidate storage systems:

csmcli> lsstorcandidate -conntype zos

The following output is returned:

226 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Device ID Manufacturer
===================================
ESS:BOX:2105.12345 IBM

lsvol
Use the lsvol command to display detailed information about volumes.

You can use the lsvol command to:

v Choose available volumes for copy sets
v View properties of volumes (such as capacity, type, and whether a volume is
space efficient or protected)

Important: If you issue the lsvol command without adding parameters, a list of all
the volumes for all storage systems is displayed. The processing of the command
can take minutes or hours depending on the size of your environment. You press
Enter to continue listing the output or press Ctrl+C to discontinue listing the
output.

Syntax

-s
lsvol
-help -l default
-h -fmt xml
-? delim
-delim char
stanza

on on -r number off
-p off -hdr off -v on

-devtype ds -dev dev_id -protected
ess -unprotected
storwize-v7000
svc
xiv

volume_id
-

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-s Displays default information for each volume, including the name, ID, device,
manufacturer, volume type, and whether the volume is protected and space
efficient.
-l Displays detailed information for each volume, including:
Command-line interface 227
Column Label Details
Name Volume name
ID Volume ID
Device The ID of the storage system
Manufacturer The manufacturer of the storage system. Currently,
only IBM storage systems are supported.
Type The values CKD or FB. The value is always FB for
the following storage systems:
v IBM System Storage SAN Volume Controller
v IBM Storwize V7000
v Storwize V7000 Unified
v IBM XIV Storage System
Protected Yes if the volume is protected; No if the volume is not
protected.
Space Efficient Yes, if the volume is a space efficient volume. No, if
the volume is not a space efficient volume.
Format Volume format
LSS/IO Group/Pool For the following storage system volumes, this
column displays the logical subsystem (LSS):
v IBM TotalStorage Enterprise Storage Server Model
800
v IBM System Storage DS8000
v System Storage DS6000
For the following storage system volumes, this
column displays the IO group:
v SAN Volume Controller
v Storwize V7000
v Storwize V7000 Unified
For XIV system volumes, this column displays the
pool.
Size Volume size
Size Unit The unit of measure that the capacity is given in,
either gigabytes or cylinders.
Is Z Attached Identifies whether the volumes are connected through
an IBM z/OS connection.
Locked Indicates whether the volume is locked. Applies only
to XIV system.

-fmt { default | xml | delim | stanza }

228 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

To use a character other than a comma as the delimiter, specify -fmt
delim -delim char , where char represents the character that you want
to use as the delimiter. For example, if you want to use a colon (:) as
the delimiter, use the following -fmt parameter:
-fmt delim -delim :
If you use a shell metacharacter as the delimiting character, enclose the
character in quotation marks or single quotation marks. A blank space
is not a valid character.
stanza Specifies that the output is displayed as one keyword-value pair per
line.
-p { on | off }
Specifies whether to display one page of text at a time or all text at once.
on Displays one page of text at a time. Pressing any key displays the next
page. This is the default value when the command is run in interactive
mode.
off Displays all text at once. This is the default value when the command
is run in single-shot mode.
-hdr { on | off }
Specifies whether to display the table header. You can specify one of these
values:
on Displays the table header. This is the default value.
off Hides the table header.
-r number
Specifies the number of rows per page to display when the -p parameter is
specified. You can specify a value of 1 - 100. The default value is 22.
-v { on | off }
Specifies whether to enable verbose mode. You can specify one of these values:
on Enable verbose mode.
off Disable verbose mode. This is the default value.
-devtype { ds | ess | storwize-v7000 | svc | xiv }
Specifies volumes by storage system type. Supported storage systems are:
v ds: DS series storage systems
v ess: TotalStorage Enterprise Storage Server
v storwize-v7000: Storwize V7000 and IBM Storwize V7000 Unified
v svc: SAN Volume Controller
v xiv: XIV system
-dev dev_ id
Specifies volumes by storage system ID.
-protected
Specifies that only protected volumes, or volumes that cannot be used in an
add copy set action, are shown.
-unprotected
Specifies that only unprotected volumes, or volumes that can be used in an
add copy set action, are shown.

Command-line interface 229

volume_id... | -
Specifies the volume ID for a volume. Volume data is listed for this volume.
The same volume can reside in multiple groups but not multiple pools.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Examples
v Listing volumes for a storage system
The following command lists information about all volumes in the storage
system with ID DS8000:BOX:2107.02191.
csmcli> lsvol -devtype ds -dev DS8000:BOX:2107.02191
The following output is returned:
Name ID Device Manufacturer Type Protected Space Efficient
=============================================================================================
8K410F DS8000:2107.02191:VOL:010F 2107-02191 IBM CKD No No
8K410E DS8000:2107.02191:VOL:010E 2107-02191 IBM CKD No No
8K410D DS8000:2107.02191:VOL:010D 2107-02191 IBM CKD No No
v Listing protected volumes
The following command lists information about all protected volumes.
csmcli> lsvol -protected
The following output is returned:
Name ID Device Manufacturer Type Protected Space Efficient
================================================================================================
8K9005 DS8000:2107.LT742:VOL:0005 2107-LT742 IBM CKD Yes No
8K9004 DS8000:2107.LT742:VOL:0004 2107-LT742 IBM CKD Yes No
8K9003 DS8000:2107.LT742:VOL:0003 2107-LT742 IBM CKD Yes No

mkauth
Use the mkauth command to grant monitor, administrator, or operator
authorization to a user.

Syntax

mkauth -name name -type group

-help user
-h
-?

-authlevel authorization_level
session_name
-

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-name name
Specifies a user ID or group name to which you grant authorization.
-type group | user
Specifies whether the name is of a group or user.
-authlevel authorization_level
Specifies the authorization level: admin, operator, or monitor.

230 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

session_name | -
Use this optional parameter when you are assigning operator authorization to
a user and want to specify one or more sessions to which the operator has
access. This parameter does not apply to monitors or administrators.
If no session name is specified, all sessions are used by default, unless another
filter is used. If you specify -authlevel operator but do not specify a session
name, the user is not granted operator status to any of the existing sessions but
is granted permission to create new sessions.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). You can specify multiple session names from
stdin when the dash (-) is specified. The dash is supported only in single-shot
mode.

Example
1. Adding a group with monitor privileges
The following command grants administrator authorization to the user named
MDMSUID.
csmcli> mkauth -name Guests -type group -authlevel monitor
The following output is returned:
IWNR4018I Successfully granted the monitor role to Guests.
2. Adding a user with operator privileges
The following command grants administrator authorization to the user named
MDMSUID.
csmcli> mkauth -name csmuser -type user -authlevel operator session1
The following output is returned:
IWNR4016I Successfully granted the session operator role to csmuser.
3. Adding the Superuser group
The following command adds the IBM Tivoli Storage Productivity Center
Superuser group to the Administrator role.
csmcli> mkauth -name Superuser -type group -authlevel admin
The following output is returned:
IWNR4017I Successfully granted the administrator role to Superuser.

mkbackup
Use the mkbackup command to create a backup of IBM Tivoli Storage
Productivity Center for Replication configuration data (including storage systems,
sessions, and copy set) in the zero-administration embedded repository.

Syntax

mkbackup
-help
-h
-?

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.

Command-line interface 231

Description

Prerequisites:
v You must have Administrator privileges to run this command.
v This procedure applies to only the zero-administration embedded repository.
This procedure is not applicable when DB2 is being used as the persistent
datastore for the IBM Tivoli Storage Productivity Center for Replication
database. For information about restoring your DB2 environment, refer to your
DB2 documentation.
v The user ID that was used to create the backup file must exist on the
management server that is being restored.

By default, the backup file is stored in the install_root/eWAS/profiles/CSM/

database/backup directory. You can change the default location by editing the
db.backup.location property in rmserver.properties file, which is located in the
websphere_home/AppServer/profiles/websphere_profile/properties directory.

You can use the backup file to restore the zero-administration embedded repository
on the same management server or on another management server running on the
same operating system platform. You cannot use the backup file to restore the
zero-administration embedded repository on a management server running a
different operating system platform or a management server that uses the DB2
database.

Example

Back up configuration data

This example backs up the IBM Tivoli Storage Productivity Center for Replication
configuration data:
csmcli> mkbackup

The following output is returned:

IWNR1905I Backup of internal data store completed successfully. The following file
was created: C:\Program Files\IBM\replication\eWAS\profiles\CSM\database\backup\
tpcrBackup_20090825_120138984.zip

mkcpset
Use the mkcpset command to create copy sets.

When you run the mkcpset command for all sessions, except for IBM XIV Storage
System Snapshot sessions, you can specify both the source volume and target
volume for the copy sets. In XIV system Snapshot sessions, you must specify only
the source volume for the copy sets.

Tip: To display the status of volumes in a copy set, use the lsvol command.

Syntax

mkcpset -h1 h1_volume_id

-help -quiet xiv_h1_volume_nickname
-h
-?

232 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-h2 h2_volume_id -h3 h3_volume_id
xiv_h2_volume_nickname

-t1 t1_volume_id -j1 j1_volume_id -j2 j2_volume_id

-j3 j3_volume_id -i1 i1_volume_id -i2 i2_volume_id

session_name
-i3 i3_volume_id -

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-quiet
Suppresses the confirmation prompt for this command. This flag answers yes
to all confirmation prompts.
-h1 {h1_volume_id | xiv_h1_volume_nickname}
For storage systems other than an XIV system, the volume ID is the only value
that can be provided for this parameter. This value specifies the volume ID of
the copy set at host site 1.
For XIV system sessions of any type, you can provide the user-defined
nickname for the volume or the volume ID. The nickname for the volume is
specified by using the XIV system user interface.
-h2 {h2_volume_id | xiv_h2_volume_nickname}
Specifies the volume ID or nickname of the copy set at host site 2, if required.
-h3 h3_volume_id
Specifies the volume ID of the copy set at host site 3, if required.
-t1 t1_volume_id
Specifies the target volume of the copy set at site 1, if required.
-j1 j1_volume_id
Specifies the volume ID of the journal for site 1 if required by the session type.
-j2 j2_volume_id
Specifies the volume ID of the journal for site 2 if required by the session type.
-j3 j3_volume_id
Specifies the volume ID of the journal for site 3 if required by the session type.
-i1 i1_volume_id
Specifies the intermediate volume ID of the copy set at site 1.
-i2 i2_volume_id
Specifies the intermediate volume ID of the copy set at site 2.
-i3 i3_volume_id
Specifies the intermediate volume ID of the copy set at site 3.
session_name | -
Specifies the name of the session that contains the copy sets.

Command-line interface 233

Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

When you run Metro Global Mirror on the OMVS command line, the parameters
for the mkcpset command can exceed the character limit set by the OMVS prompt.
To overcome this limitation, use a script to add the copy set. You create a script file
called mgm_mkcpset.txt that contains the command that you want to run such as:
csmcli> mkcpset -h1 DS8000:2107.12345:VOL:0000 -h2 DS8000:2107.67890:VOL:0000
-h3 DS8000:2107.02468:VOL:0000 -J3 DS8000:2107.01934:VOL:0000 myMGMSess

To run the script, you must ensure that you are in the IBM Tivoli Storage
Productivity Center for Replication CLI directory and have the appropriate paths
exported. You then run the script from the command line using the following
sample code:
csmcli.sh -script mgm_mkcpset.txt

Examples

Creating copy sets

The following command creates a copy set for a session named session1. The
volume ID of the copy set at host site 1 is DS8000:2107.04131:VOL:0A05 and the
target volume ID is DS8000:2107.04131:VOL:0A06.
csmcli> mkcpset -h1 DS8000:2107.04131:VOL:0A05
-t1 DS8000:2107.04131:VOL:0A06 session1

The following output is returned:

IWNR1000I Copy sets were successfully created for the session
named session1.

IWNR2001I The pair, the ID of the source volume and the ID of the target volume,
was created in the session named session1 for the copy set with a
volume ID of DS8000:2107.04131:VOL:0A05, a source volume ID of
DS8000:2107.04131:VOL:0A05, and a target volume ID of DS8000:2107.04131:VOL:0A06.

Creating a copy set for an XIV system Snapshot session by using the volume ID

The following command creates a copy set for an XIV system Snapshot session
named snap2 by using volume XIV:VOL:6000646:110789, where 110789 is the
volume ID.
csmcli> mkcpset -h1 XIV:VOL:6000646:110789 snap2

The following output is returned:

IWNR1000I Copy sets were created for the session named snap2.

Creating a copy set for an XIV system Snapshot session by using the volume
nickname

The following command creates a copy set for an XIV system Snapshot session
named snap2 by using volume XIV:VOL:6000646:myvolume, where myvolume is the
volume nickname.
csmcli> mkcpset -h1 XIV:VOL:6000646:myvolume snap2

The following output is returned:

IWNR1000I Copy sets were created for the session named snap2.

234 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

mklogpkg
Use the mklogpkg command to create a log package. The log package is written to
the file that is specified in the properties file.

Syntax

mklogpkg
-help
-h
-?

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.

Example

Creating a log package

The following command creates a log package in the C:\Program

Files\IBM\replication\eWAS\profiles\CSM\diagnostics directory.
csmcli> mklogpkg

The following output is returned:

IWNR1198I Log packages were successfully created and placed at location
C:\Program Files\IBM\replication\eWAS\profiles\CSM\diagnostics\
TPC_RM-latte_2009-8-27_11-45-26.jar

mkpath
Use the mkpath command to create a Fibre Channel path or paths between a
source logical subsystem (LSS) and a target LSS.

Syntax

mkpath -src source -tgt target

-help
-h
-?

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-src source
Specifies the source LSS and port (ESS and DS series storage servers). This
must be specified in the format type.serial.lss(hex).port(hex) (for example,
ESS:2105.FCA18:LSS:10.00FF).
-tgt target
Specifies the target LSS and port (ESS and DS series storage servers). This must
be specified in the format type.serial.lss(hex).port(hex) (for example,
ESS:2105.FCA18:LSS:10.00FF).

Command-line interface 235

Description

The mkpath command uses the information from the lslss command to create a
path or paths between the source LSS and the target LSS. You can specify a
number of paths to create between 1 and 8.

Notes:
v This command creates new paths in addition to paths that already exist between
the two specified LSSs.
v Only Fibre Channel paths are supported for ESS and DS series storage servers.
v You must verify the ports that are to be used in the path.
v For DS series storage servers, the plant of manufacturer must be added to the
beginning of the serial number, making the serial number a seven-digit number.
v If you specify a number of paths greater than the number of available paths,
existing paths are overwritten.

Example

Creating Fibre Channel paths

The following command creates a Fibre Channel path between the source LSS
ESS:2105.20870:12.1 and target LSS ESS:2105.20870:14.2.
csmcli> mkpath –src ESS:2105.20870:12.1 –tgt ESS:2105.20870:14.2

The following output is returned:

Path successfully created.

mksess
Use the mksess command to create a session.

Syntax

mksess -cptype copy_type

-help -desc description
-h
-?

-site1loc site1_location -site2loc site2_location

session_name
-site3loc site3_location -

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-cptype copy_type
Specifies the copy session type. The following are the valid values for this
parameter. The values are grouped by session type.
FlashCopy
fc: FlashCopy for:
v IBM TotalStorage Enterprise Storage Server Model 800

236 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

v IBM System Storage DS8000
v System Storage DS6000
v IBM System Storage SAN Volume Controller
v IBM Storwize V7000
v IBM Storwize V7000 Unified
Metro Mirror Single Direction
mmsd: Metro Mirror Single Direction for:
v TotalStorage Enterprise Storage Server Model 800
v System Storage DS8000
v System Storage DS6000
v SAN Volume Controller
v Storwize V7000
v Storwize V7000 Unified
Metro Mirror Failover/Failback
mmfofb: Metro Mirror Failover/Failback for:
v TotalStorage Enterprise Storage Server Model 800
v System Storage DS8000
v System Storage DS6000
v SAN Volume Controller
v Storwize V7000
v Storwize V7000 Unified
mmfofbxiv: Metro Mirror Failover/Failback for:
v IBM XIV Storage System
Metro Mirror Failover/Failback with Practice
pmm: Practice Session for Metro Mirror Failover/Failback for:
v TotalStorage Enterprise Storage Server Model 800
v System Storage DS8000
v System Storage DS6000
pmmsvc: Metro Mirror Failover/Failback with Practice for:
v SAN Volume Controller
v Storwize V7000
v Storwize V7000 Unified
Global Mirror Single Direction
gmsd: Global Mirror Single Direction for:
v TotalStorage Enterprise Storage Server Model 800
v System Storage DS8000
v System Storage DS6000
gmsdsvc: Global Mirror Single Direction for:
v SAN Volume Controller
v Storwize V7000
v Storwize V7000 Unified
Global Mirror Failover/Failback
gmfofb: Global Mirror Failover/Failback for:
v TotalStorage Enterprise Storage Server Model 800
v System Storage DS8000
v System Storage DS6000
gmfofbsvc: Global Mirror Failover/Failback for:
v SAN Volume Controller
v Storwize V7000
v Storwize V7000 Unified
gmfofbxiv: Global Mirror Failover/Failback for:
v XIV system

Command-line interface 237

Global Mirror Failover/Failback with Practice
pgm: Global Mirror Failover/Failback with Practice for:
v TotalStorage Enterprise Storage Server Model 800
v System Storage DS8000
v System Storage DS6000
pgmsvc: Global Mirror Failover/Failback with Practice for:
v SAN Volume Controller
v Storwize V7000
v Storwize V7000 Unified
Global Mirror Either Direction with Two Site Practice
pgm2s: Global Mirror Either Direction with Two Site Practice for:
v TotalStorage Enterprise Storage Server Model 800
v System Storage DS8000
v System Storage DS6000
Metro Global Mirror
mgm: Metro Global Mirror for:
v TotalStorage Enterprise Storage Server Model 800
v System Storage DS8000
Metro Global Mirror with Practice
pmgm: Metro Global Mirror with Practice for:
v TotalStorage Enterprise Storage Server Model 800
v System Storage DS8000
Snapshot
snap: Snapshot for:
v XIV system
Basic HyperSwap
hs: Basic HyperSwap for:
v TotalStorage Enterprise Storage Server Model 800
v System Storage DS8000
v System Storage DS6000
-desc description
Specifies a description for the session. The description can have up to 250
alphanumeric characters.
-site1loc
Specifies a location to associate with the site 1 volume role.
-site2loc
Specifies a location to associate with the site 2 volume role.
-site3loc
Specifies a location to associate with the site 3 volume role.
session_name | -
Specifies a name for the session. For sessions that contain an XIV system, the
session name can have up to 58 alphanumeric characters. For sessions that
contain other storage system types, the session name can have up to 250
alphanumeric characters. Session names must be unique.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Examples

Creating a FlashCopy session

238 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

The following command creates a FlashCopy session named session1. The location
of the site 1 volume role is Boulder.
csmcli> mksess -cptype fc -site1loc Boulder session1

The following output is returned:

IWNR1021I Session session1 was successfully created.
IWNR1096I The locations for sessions session1 and Site 1 were set successfully.

Creating a Global Mirror with Practice session for System Storage DS8000

The following command creates a System Storage DS8000 Global Mirror with
Practice session named session1.
csmcli> mksess -cptype pgm -desc "DS8000 Global Mirror with Practice" session1

The following output is returned:

IWNR1021I Session session1 was successfully created.

Creating a Global Mirror with Practice session for System Storage SAN Volume
Controller

The following command creates a System Storage SAN Volume Controller Global
Mirror with Practice session named session1.
csmcli> mksess -cptype pgmsvc -desc "SVC Global Mirror with Practice" session1

The following output is returned:

IWNR1021I Session session1 was successfully created.

Creating a Metro Global Mirror session

The following command creates a Metro Global Mirror session named session1.
csmcli> mksess -cptype mgm -desc "Metro Global Mirror" session1

The following output is returned:

IWNR1021I Session session1 was successfully created.

Creating a Metro Mirror Failover/Failback session

The following command creates a Metro Mirror Failover/Failback session named

session1.
csmcli> mksess -cptype mmfofb -desc "Metro Mirror" session1

The following output is returned:

IWNR1021I Session session1 was successfully created.

Creating a Metro Mirror Failover/Failback session for an XIV system

The following command creates a Metro Mirror Failover/Failback session named

session1. The location of the site 1 volume role is Tucson and the location of the
site 2 volume role is Chicago.
csmcli> mksess -cptype mmfofbxiv -desc "session1 on xiv" -site1loc Tucson
-site2loc Chicago session1

The following output is returned:

IWNR1021I Session session1 was successfully created.

Command-line interface 239

mksnmp
Use the mksnmp command to add a specified manager to the list of servers to
which SNMP traps are sent. SNMP traps are not specific to any particular session.
All traps for any session are sent to each server.

Syntax

mksnmp -server server

-help -port port
-h
-?

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-server server
Specifies the IP address or domain name of the management server that is to
receive SNMP traps.
-port port
Specifies a port number to use for receiving SNMP traps. If not specified, the
default port is 162.

Example

Sending SNMP traps to a specific management server

The following command sends SNMP traps to the management server with ID
9.11.207.17 and port 2626.
csmcli> mksnmp -server 9.11.207.17 -port 2626

The following output is returned:

IWNR1701I Host 9.11.207.17:2626 was added to the SNMP listeners list.

refreshdevice
Use the refreshdevice command refresh the volumes and configuration elements of
a storage device.

You must have Administrator privileges to run this command.

Syntax

refreshdevice device_id
-help -nowait -
-h
-?

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.

240 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-nowait
Specifies that the command response is returned when the command has been
submitted and accepted by the server. The command response does not require
that the command is completed.
device_id | -
Specifies the ID of the storage system that you want to refresh.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Tip: To list the valid storage system IDs, use the lsdevice command.

Examples

Refreshing a System Storage DS8000 (includes the -nowait parameter)

The following command refreshes the storage system DS8000:BOX:2107.02341

before the command has completed.
csmcli> refreshdevice -nowait DS8000:BOX:2107.02341

The following output is returned when command has been submitted and accepted
by the server:
IWNH1611I A refresh of the storage configuration has completed
for the storage device DS8000:BOX:2107.02341.

rmactive
Use the rmactive command to remove an active management server.

Syntax

rmactive
-help -quiet
-h
-?

Description

You can run the rmactive command only from the standby management server
and only when the active and standby management servers are in a
non-synchronized state (such as when they are first connecting).

When a standby and active management servers are synchronized, use the
hatakeover command.

Command-line interface 241

The rmactive command corresponds to the Remove Active action in the GUI.
Unless the -quiet parameter is used, you are prompted to confirm this action.

Example

Removing the active management server

The following command removes the active management server with IP address
127.0.0.1.
csmcli> rmactive -server 127.0.0.1

rmassoc
Use the rmassoc command to remove a session association from the host system.
This command removes a session associated with a host system but does not
remove the connection to the host system.

Syntax

rmassoc -session_name session_name

-help -quiet
-h
-?

IP_Address
-port port -

Example
v Removing a session from a host system
The following command shows how to remove the session MyMMsession from the
host system with IP address 9.11.223.43. In this example, you could omit the
-port parameter because port 9930 is the default.
csmcli> rmassoc -session_name MyMMsession –port 9930 9.11.223.43

242 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

rmauth
Use the rmauth command to remove monitor, administrator, or operator
authorization from a user or user group.

Syntax

rmauth -name name -type group

-help user
-h
-?

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-name name
Specifies a user ID or group name from which you remove authorization.
-type group | user
Specifies whether the name is of a user group or user.

Example
1. Removing authorization for a group
The following command remove authorization from the user named MDMSUID.
csmcli> rmauth -name Guests -type group
The following output is returned:
Are you sure you want to remove access for user Guests? [y/n]:y

IWNR4013I Successfully revoked access from Guests.

2. Removing authorization for a user
The following command remove authorization from the user named MDMSUID.
csmcli> rmauth -name csmuser -type user
The following output is returned:
Are you sure you want to remove access for user Guest? [y/n]:y

IWNR4013I Successfully revoked access from Guest.

rmcpset
Use the rmcpset command to remove a copy set.

Syntax

rmcpset
-help -quiet -force -keeponhw
-h
-?

-h1 source_volume_id session_name

xiv_source_volume_nickname -

Command-line interface 243

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-quiet
Suppresses the confirmation prompt for this command. This flag answers yes
to all confirmation prompts.
-force
Forces the removal of the copy set despite any errors that occur when
removing the copy set relationships from the storage system. When a forced
removal is complete, any relationships that remain on the storage system for
that copy set must be removed manually using the storage system interface.
-keeponhw
Specifies that all of the base relationships (Metro Mirror, Global Copy,
Snapshot, and FlashCopy) on the storage system are kept even though the
copy set is removed from the session. The relationships are removed from any
consistency groups that are defined on the storage system.
-h1 {source_volume_id | xiv_source_volume_id }
For storage systems other than an XIV system, the volume ID is the only value
that can be provided for this parameter. This value specifies the source volume
ID of the copy set to be removed.
For XIV system sessions of any type, you can provide the user-defined
nickname for the volume or the volume ID. The nickname for the volume is
specified by using the XIV system user interface.
session_name | -
Specifies the name of the session name from which the copy set is being
removed.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Examples

Removing a copy set

The following command removes the copy set with source volume
DS8000:2107.04131:VOL:0A05 in session session1 without prompting for
confirmation.
csmcli> rmcpset -quiet -h1 DS8000:2107.04131:VOL:0A05 session1

The following output is returned:

IWNR1058I The copy sets for session session1 were deleted.

IWNR2002I The pair was successfully deleted in session session1 for copy set
DS8000:2107.04131:VOL:0A05 with source DS8000:2107.04131:VOL:0A05 and target
DS8000:2107.04131:VOL:0A06.

IWNR1095I Copy set DS8000:2107.04131:VOL:0A05 in session session1 was

successfully deleted.

Removing a copy set from an XIV system Snapshot session by using the volume
nickname

244 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

The following command creates the copy set for an XIV system Snapshot session
named snap2 by using volume XIV:VOL:6000646:myvolume, where myvolume is the
volume nickname.
csmcli> rmcpset -h1 XIV:VOL:6000646:myvolume snap2

The following output is returned:

IWNR1058I The copy sets for session snap2 were deleted.

IWNR2005I The volume with a volume ID of XIV:VOL:6000646:110789 (snap2) was

successfully removed from the copy set with a source volume ID
of XIV:VOL:6000646:110789 from the session named snap2.

IWNR1095I Copy set XIV:VOL:6000646:myvolume in session snap2 was

successfully deleted.

rmdevice
Use the rmdevice command to remove a direct connection to a storage system.

To remove a storage system that is attached through a Hardware Management

Console (HMC) connection, use the rmmc command.

To remove a storage system that is attached through an IBM z/OS connection, use
the rmstorsys command.

Syntax

rmdevice
-help -quiet -port port_number
-h
-?

id
-ip ip_address -

Examples
v Removing an IBM TotalStorage Enterprise Storage Server Model 800
The following command removes the TotalStorage Enterprise Storage Server
Model 800 with ID ESS:BOX:2105.18596 without prompting for confirmation.
csmcli> rmdevice -quiet ESS:BOX:2105.18596
The following output is returned:
IWNH1614I The connection at sts596c0:sts596c1 was successfully removed.
v Removing a SAN Volume Controller
The following command removes the SAN Volume Controller with ID
SVC:CLUSTER:RMSVC02 and IP address 127.0.0.1 without prompting for
confirmation.
csmcli> rmdevice -quiet -ip 127.0.0.1 SVC:CLUSTER:RMSVC02
The following output is returned:
IWNH1614I The storage device at 127.0.0.1 was successfully removed.
v Removing an IBM XIV Storage System
The following command removes the XIV system with ID XIV:BOX:6000646
without prompting for confirmation.
csmcli> rmdevice -quiet XIV:BOX:6000646
The following output is returned:
IWNH1624I The storage system XIV:BOX:6000646 was successfully removed.

rmhost
Use the rmhost command to remove a connection to a host system from the IBM
Tivoli Storage Productivity Center for Replication server.

Syntax

rmhost IP_Address
-help -quiet -port port -
-h
-?

246 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Example
v Removing host systems
The following command shows how to remove a host system with IP address
9.11.223.43. In this example, you could omit the -port parameter because port
9930 is the default.
csmcli> rmhost -port 9930 9.11.223.43

rmmc
Use the rmmc command to remove a management console.

Syntax

rmmc id
-help -quiet -
-h
-?

Example

Removing a management console

The following command removes a Hardware Management Console with ID

HMC:127.0.0.1 without prompting for confirmation.
csmcli> rmmc -quiet HMC:127.0.0.1

The following output is returned:

IWNH1614I The storage device at HMC:127.0.0.1 was successfully removed.

rmpath
Use the rmpath command to remove a path or paths between a source logical
subsystem (LSS) and a target LSS.

Syntax

rmpath -src source_lss -tgt target_lss

-help -quiet
-h
-?

Command-line interface 247

Description

Notes:
v Removing a path removes only the path and ports specified and will not remove
any additional paths.
v Only Fibre Channel paths are supported for ESS800, DS6000, and DS8000.

Example

Removing paths:

The following command removes the paths between the source LSS
ess:2015.23884:11.4 and a target LSS ess:2105.23005:11.3.
csmcli> rmpath -src ess:2015.23884:11.4 -tgt ess:2105.23005:11.3

The following output is returned:

Path successfully removed.

rmsess
Use the rmsess command to remove a session.

Important: You can remove only those sessions that are in the Defined state.

Syntax

rmsess session_name
-help -quiet -
-h
-?

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.

248 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

-quiet
Suppresses the confirmation prompt for this command. This flag answers yes
to all confirmation prompts.
session_name... | -
Specifies the name of the session to be removed. Separate multiple session
names using a blank space.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Example

Removing a session

The following command removes the session named session1.

csmcli> rmsess -quiet session1

The following output is returned:

IWNR1022I Session session1 was successfully deleted.

rmsnmp
You can use the rmsnmp command to remove the specified manager from the list
of servers to which SNMP traps are sent.

Syntax

rmsnmp -server server

-help
-h
-?

Example

Removing a server from receiving SNMP traps

The following command removes the management server with IP address

127.0.0.1 from receiving SNMP traps.
csmcli> rmsnmp -server 127.0.0.1

The following output is returned:

IWNR1702I Host 127.0.0.1 was removed from the SNMP listeners list.

rmstdby
Use the rmstdby command to remove a standby management server.

Syntax
Command-line interface 249
rmstdby
-help -quiet -server standby_server
-h
-?

Example

Removing a standby management server

The following command removes the standby management server with IP address
127.0.0.1.
csmcli> rmstdby -server 127.0.0.1

rmstorsys
Use the rmstorsys command to remove a specific storage system and its volumes
that are attached to the IBM Tivoli Storage Productivity Center for Replication
server from the IBM Tivoli Storage Productivity Center for Replication
configuration through a z/OS connection.

Syntax

rmstorsys -conntype zos -dev device_id

-help -quiet
-h
-?

Tip: Use the lsdevice command to display a list of valid storage system IDs.

250 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Description

Important:
v You must have Administrator privileges to run this command.
v You can run this command only from the IBM Tivoli Storage Productivity Center
for Replication server that is installed on a system running z/OS.
v This command removes only the z/OS connection to the specified storage
system. To remove other connection types to the same storage system, use the
rmdevice or rmmccommand.

If Tivoli Storage Productivity Center for Replication has multiple connections to a

specific storage system, the order in which you remove the connections produces
different results:
v If you remove all direct and HMC connections first, the fixed block and
non-attached ECKD™ volumes are removed from the Tivoli Storage Productivity
Center for Replication configuration. The remaining ECKD volumes that are
attached through the z/OS connection remain in the Tivoli Storage Productivity
Center for Replication configuration until the z/OS connection is removed.
Removing the TCP/IP connection also disables the Metro Mirror heartbeat.
v If you remove the z/OS connection first and if there is an HMC or direct
connection to volumes, those volumes are not removed from the Tivoli Storage
Productivity Center for Replication configuration.
v HyperSwap can run provided that volumes are attached and available to z/OS
storage, even if you are using a TCP/IP connection to storage.

To remove a storage system that is attached through a direct connection, use the
rmdevice command. To remove a storage system that is attached through an
hardware-management-console (HMC) connection, use the rmmc command.

Example

Removing the z/OS connection

This example illustrates how to remove the z/OS connection to the storage system
with ID ESS:BOX:2105.12345.
csmcli> rmstorsys -dev ESS:BOX:2105.12345 -conntype zos

The following output is returned:

IWNH1614I The storage device at ESS:BOX:2105.12345 was successfully removed.

setasstdby
Use the setasstdby command to set a management server to be the standby
management server of another active management server.

Syntax

setasstdby -server active_server_ip

-help -quiet
-h
-?

Command-line interface 251

Example

Creating a standby management server

The following command sets the local server as a standby management server for
the active management server with IP address 127.0.0.1.
csmcli> setasstdby -server 127.0.0.1

The following output is returned:

IWNR3020I Connection to the active high-availability server at
tpc1.storage.tucson.example.com making the server
tpc2.storage.tucson.example.com a standby was successful.

setparameter
Use the setparameter command to set the system parameters.

Syntax

setparameter -parm lsheartbeat

-help -quiet chheartbeat on
-h off
-? -

252 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Example
1. Listing the Metro Mirror heartbeat status
The following command displays whether the Metro Mirror heartbeat is
enabled or disabled.
csmcli> setparameter -parm lsheartbeat
The following output is returned:
The heartbeat function is set on.

IWNR1208I The heartbeat was retrieved successfully.

2. Enabling the Metro Mirror heartbeat
The following command turns on the Metro Mirror heartbeat.
csmcli> setparameter -parm chheartbeat on
The following output is returned:
IWNR1204I The heartbeat has been successfully turned on with the hardware.

setstdby
Use the setstdby command to set the standby management server for an active
management server.

Syntax

setstdby -server standby_server_ip

-help -quiet
-h
-?

-username user_name
-password password

Description

Notes:
v If a standby management server is already defined for the active management
server, the previously defined standby management server is replaced by the
server specified by this command.

Command-line interface 253

v Only the hatakeover command can change a backup server to the active server.
High availability (HA) must be active before setting an HA role.

Example

Setting the standby management server

The following command sets the server with IP address 127.0.0.1 as the standby
management server for active management server on which this command run
without prompting for confirmation.
csmcli> setstdby -quiet -server 127.0.0.1 -username csmuser

The following output is returned:

IWNR3020I Connection to the active high-availability server at
tpc1.storage.tucson.example.com making the server
tpc2.storage.tucson.example.com a standby was successful.

showcpset
Use the showcpset command to display properties for a copy set.

Syntax

showcpset -h1 h1_volume_id session_name

-help -
-h
-?

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
-h1 h1_volume_id
Specifies the name of the source volume ID. The properties for this volume ID
are displayed.
session_name | -
Specifies the session name to which the copy set belongs.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

The following information is listed for the copy set:

Column Label Details

H1 Volume The source volume name.
Session The session name.
Volumes The volumes that are associated with the copy set.
Output is formatted to show the role and the volume
ID for that role in the copy set.
Last Result The last message that was issued.

254 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Examples

Listing copy set properties

The following command lists the properties for the copy set with the source host
ID DS8000:2107.NK791:VOL:1500 in the session session1.
csmcli> showcpset -h1 DS8000:2107.NK791:VOL:1500 session1

The following output is returned:

H1 Volume DS8000:2107.NK791:VOL:1500
Session session1
Volumes H1-DS8000:2107.NK791:VOL:1500, H2-DS8000:2107.MW931:VOL:1500,
H3-DS8000:2107.04131:VOL:1500, I3-DS8000:2107.04131:VOL:1505,
J3-DS8000:2107.04131:VOL:150A
Last result None

IWNR1500I Session information about session session1 was successfully obtained.

showdevice
Use the showdevice command to display storage system properties.

Syntax

showdevice device_id
-help -
-h
-?

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
device_id | -
Displays a unique identifier for each storage system in IBM Tivoli Storage
Productivity Center. The element ID format, for example ESS:BOX:2105.FCA57,
is used to display storage system IDs.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

For each storage system, the following information is listed. The Direct Connect
Information properties are listed for storage systems that have a direct connection.
The Management Console properties are listed for storage systems that are
connected through a Hardware Management Console (HMC).
General

Column Label Details

Device ID The storage system ID.
Device Name The user-defined name of the storage system.
Device Type The type of storage system: DS6000, DS8000, ESS,
STORWIZE-V7000, SVC, or XIV.
Manufacturer The manufacturer of the storage system.

Command-line interface 255

Column Label Details
Location The user-defined location associated with the storage
system or None.

Direct Connect Information

Column Label Details

Device IP Address The IP address or host name of the clusters or nodes
that are used by the storage system.

IBM TotalStorage Enterprise Storage Server Model

800, IBM System Storage DS8000, and System Storage
DS6000 use two clusters. Each cluster address is
separated by a semicolon. IBM XIV Storage System
uses three nodes. Each node address is separated by
a semicolon.
User name The user name for the clusters or nodes that are used
by the storage system.

For TotalStorage Enterprise Storage Server Model 800,

System Storage DS8000, System Storage DS6000, and
XIV system, user names are separated by a
semicolon.
Port The port number of the clusters or nodes that are
used by the storage system.

For TotalStorage Enterprise Storage Server Model 800,

System Storage DS8000, and System Storage DS6000,
the port number of each cluster is separated by a
semicolon. For XIV system, the port number of each
node is separated by a semicolon. For example,
node1_port;node2_port;node3_port.
Local Server Connection The state of direct connections to a local management
server. For TotalStorage Enterprise Storage Server
Model 800, System Storage DS8000, and System
Storage DS6000, this value shows status of the
connection to each cluster separated by a semicolon.
For example, cluster0_status:cluster1_status.

For XIV system, this value shows the status of each

node separated by a semicolon. For example,
node1_status;node2_status;node3_status.
Remote Server Connection The state of direct connections to a remote
management server. For TotalStorage Enterprise
Storage Server Model 800, System Storage DS8000,
and System Storage DS6000, this value shows the
connection status of each cluster separated by a
semicolon. For example
cluster0_status:cluster1_status.

For XIV system, this value shows the connection

status of each node separated by a semicolon. For
example node1_status;node2_status;node3_status.

Management Console Information

256 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Column Label Details
Management Console Local Server The state of the HMC connections to the local
Connection management server.
Management Console Remote The state of the HMC connections to the remote
Server Connection management server.
Management Console IDs The ID of the HMC. If there a dual HMCs, the ID for
each HMC is separated by a semicolon.

z/OS Connection Information

Column Label Details

z/OS Local Server Connection The state of the z/OS connections to the local
management server.
z/OS Remote Server Connection The state of the z/OS connections to the remote
management server.

Example

Listing device properties

The following command lists the properties of a System Storage DS8000 with ID
DS8000:BOX:2107.04131. This device is connected directly and not through an
HMC.
csmcli> showdevice DS8000:BOX:2107.04131

The following output is returned:

Device ID DS8000:BOX:2107.04131
Device Name -
Device Type DS8000
Manufacturer IBM
Location Boulder
Direct Connect Information --------------------------
Device IP Address stg8k05c0;stg8k05c1
User Name root;root
Port 2433;2433
Local Server Connection Connected;Connected
Remote Server Connection -
Management Console Information --------------------------
Management Console Local Server Connection -
Management Console Remote Server Connection -
Management Console IDs -
z/OS Connection Information --------------------------
z/OS Local Server Connection -
z/OS Remote Server Connection -

IWNC4103I The showdevice command completed successfully.

Listing device properties

The following command lists the properties of an XIV Storage System with ID
XIV:BOX:7803448 and a user-defined name XIV_B.
csmcli> showdevice XIV:BOX:7803448

The following output is returned:

Command-line interface 257

Device ID XIV:BOX:7803448
Device Name XIV_B
Device Type XIV
Manufacturer IBM
Location xiv_west
Direct Connect Information --------------------------
Device IP Address tpcr_xivb1.storage.tucson.ibm.com;
tpcr_xivb2.storage.tucson.ibm.com;
tpcr_xivb3.storage.tucson.ibm.com
User Name admin
Port 7778;7778;7778
Local Server Connection Connected;Connected;Connected
Remote Server Connection -
Management Console Information --------------------------
Management Console Local Server Connection -
Management Console Remote Server Connection -
Management Console IDs -
z/OS Connection Information --------------------------
z/OS Local Server Connection -
z/OS Remote Server Connection -

IWNC4103I The showdevice command completed successfully.

showgmdetails
Use the showgmdetails command to display detailed status information for a
Global Mirror session. Use this command for only TotalStorage Enterprise Storage
Server Model 800, System Storage DS8000, and System Storage DS6000 storage
systems only.

Syntax

-s
showgmdetails session_name
-help -l
-h
-?

Column label Details

Session ID The Global Mirror session ID.
Master LSS The name of the storage system acting as the Global
Mirror master. Includes storage system ID and
subsystem ID.
Copy State Options are:
v Running
v Paused
v Fatal
v Pause in Progress
Fatal Reason Fatal reason code of the Global Mirror session.

258 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Column label Details
CG Time The time of the last consistency group formation
according to the Master Storage system. The format is
MM/DD/YYYY HH:MM:SS in 24 hour time. The
time is based on a 24-hour clock.
Query Time The time of the query according to the Master
Storage system. The format is MM/DD/YYYY
HH:MM:SS in 24 hour time. The time is based on a
24-hour clock.
Data Exposure The average exposure to data loss, in seconds, over
the query interval.
Total Failed CGs The total number of failed consistency group
formation attempts since the Global Mirror session
has been in Running state.
Total Successful CGs The total number of successful consistency group
formations since the Global Mirror session has been
in Running state.
Failed CG Attempts since last The number of failed consistency group formation
success attempts since the last successful consistency group
was formed.
Successful CG Percentage The total percentage since the Global Mirror session
has been in Running state.
CG Interval Time The interval time between attempts to form a
consistency group.
Max Coordination Interval Extended distance consistency maximum
coordination interval.
Max CG Drain Time The maximum time the consistent set of data is
allowed to drain at the remote site before failing
consistency group formation.
Last Failure LSS Name of the storage system for the most recent
failure of the consistency group formation. Includes
storage system ID and subsystem ID.
Last Failure Reason The reason code for the most recent failure of the
consistency group formation.
Last Failure Master State The master state for the most recent failure of the
consistency group formation.
Previous Failure LSS Name of the storage system for the previous failure
of the consistency group formation. Includes storage
system ID and subsystem ID.
Previous Failure Reason Reason code for the previous failure of the
consistency group formation.
Previous Failure Master State Master state for the second most recent consistency
group formation failure.
Subordinate Count The number of subordinates for this Global Mirror
session.
Subordinate Associations The subordinate boxes for the master Global Mirror
box.

session_name
Specifies the Global Mirror session for which the properties are to be
displayed.

Command-line interface 259

Example

Displaying management console properties

The following command displays detailed information for the Global Mirror
session gmme.
csmcli> showgmdetails -l gmme

The following output is returned:

Session ID 0x2

Master LSS DS8000:2107.FX102:LSS:71

Copy State Running

Fatal Reason 0x00 Global Mirror Not Fatal

CG Time 2010/04/16 23:32:58 EDT

Query Time 2010/04/16 23:32:58 EDT

Data Exposure 1.00 s

Total Failed CGs 1

Total Successful CGs 725

Failed CG Attempts since last success 0

Successful CG Percentage 99

CG Interval Time 0 s

Max Coordination Interval 50 ms

Max CG Drain Time 30 s

Last Failure LSS DS8000:2107.FX102:LSS:71

Last Failure Reason 0x0FCC XDC starting increment with wrong state
Last Failure Master State 0x4 Global Mirror Start Increment In Progress
Previous Failure LSS -

Previous Failure Reason -

Previous Failure Master State -

Subordinate Count 0

Subordinate Associations -

showha
Use the showha command to display the high-availability status.

Syntax

showha
-help
-h
-?

260 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.

Description

This command displays the following information:

Column label Details

Status High availability status.
Error Error message, if applicable

Example

Listing high-availability status

The following command lists the high-availability status.

csmcli> showha

The following output is returned:

Status Synchronized
Error None

IWNR3048I The high availability status from server tpc1.storage.tucson.ibm.com

was successfully queried.

showmc
Use the showmc command to display the properties of a management console.

Syntax

showmc id
-help -
-h
-?

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
id | -
Specifies the management console ID in the element ID format (for example,
HMC:127.0.0.1).
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Command-line interface 261

Description

The following information is listed for the management console:

Column label Details

Management console ID The management console ID in the element ID
format.
MC IP address The IP address or domain name of the management
console. For dual management console configurations
the IP addresses or domain names are separated by
semicolon; for example 192.0.2.0;192.0.2.1.
Device Type Device Type (HMC)
Location User-defined location associated with the
management console, or None.
User name The user name for the management console.
Local Connection Status The state of the connection to the local management
server.
Remote Connection Status The state of the connection to the remote
management server.
Attached Devices The devices that are attached to this management
console.

Example

Displaying management console properties

The following command displays the properties of the management console with
ID HMC:127.0.0.1.
csmcli> showmc HMC:127.0.0.1

The following output is returned:

Management Console ID HMC:127.0.0.1
MC ID address 127.0.0.1
Device Type HMC
Location tucson
User name admin
Local Connection Status Connected
Remote Connection Status -
Attached Devices DS8000:BOX:2107.BRXXX,DS8000:BOX:2107.BRXXX,
DS8000:BOX:2107.FNXXX

showsess
Use the showsess command to display properties for a selected session, including
name, description, group managed, and copy type.

Syntax

showsess session_name
-help -
-h
-?

262 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.
session_name | -
Specifies the session for which the properties are to be displayed.
Alternatively, use the dash (-) to specify that input for this parameter comes
from an input stream (stdin). The dash is supported only in single-shot mode.

Description

For each session, the following information is listed:

Column Label Details

Name Session name.
Type Session type. Values include:
FlashCopy
Global Mirror Either Direction with Two Site
Practice
Global Mirror Failover/Failback
Global Mirror Practice
Global Mirror Single Direction
Basic HyperSwap
Metro Global Mirror
Metro Global Mirror with Practice
Metro Mirror Failover/Failback
Metro Mirror Practice
Metro Mirror Single Direction
Snapshot
State Session state. Values include:
Defined
Flashing
Preparing
Prepared
Recovering
Suspended
SuspendedH2H3
SuspendedH1H3
Suspending
TargetAvailable
Terminating
Status Session status. Values include:
Unknown
Normal
Warning
Error
Inactive
Locations A list of the locations associated with the session.
Copy sets The number of copy sets that the session is
managing.
Copying An indicator of whether a copying operation is
occurring. Values are Yes or No.
Recoverable An indicator of whether the session is recoverable.
Values are Yes or No.

Command-line interface 263

Column Label Details
Active host Name of the active host.
Error Count Number of errors for all roles.
Description Session description that you define.

Example

Listing session properties

The following command lists properties for the session named session1.
csmcli> showsess session1

The following output is returned:

Name session1
Type Metro Global Mirror w/ Practice
State Defined
Status Inactive
Locations Site1, Site2, Site3
Copy sets 10
Copying No
Recoverable No
Active Host H1
Error count 0
Description -
Transitioning No
Detailed Status -

IWNR1500I Session information about session session1 was successfully obtained.

Listing session properties for an XIV system Snapshot session

The following command lists properties for the session named session1.
csmcli> showsess session1

The following output is returned:

Name session1
Type Snapshot
State Target Available
Status Active
Locations Site1
Copy sets 10
Copying No
Recoverable Yes
Active Host H1
Error count 0
Description -
Transitioning No
H1 Pool XIV:POOL:12345:67890
H1 Consistency Group session1
Detailed Status -

IWNR1500I Session information about session session1 was successfully obtained.

Listing session properties for an XIV system Metro Mirror session

The following command lists properties for the session named session1.
csmcli> showsess session1

264 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

The following output is returned:
Name session1
Type Metro Mirror Failover/Failback
State Prepared
Status Active
Locations Site1, Site2
Copy sets 10
Copying Yes
Recoverable Yes
Active Host H1
Error count 0
Description -
Transitioning No
H1 Pool XIV:POOL:12345:67890
H2 Pool XIV:POOL:12345:67890
H1 Consistency Group session1
H2 Consistency Group session1
Detailed Status -

IWNR1500I Session information about session session1 was successfully obtained.

Listing session properties for an XIV system Global Mirror session

The following command lists properties for the session named session1.
csmcli> showsess session1

The following output is returned:

Name session1
Type Global Mirror Failover/Failback
State Prepared
Status Active
Locations Site1, Site2
Copy sets 10
Copying Yes
Recoverable Yes
Active Host H1
Error count 0
Description -
Transitioning No
H1 Pool XIV:POOL:12345:67890
H2 Pool XIV:POOL:12345:67890
H1 Consistency Group session1
H2 Consistency Group session1
Detailed Status -
WNR2750E Recovery Point Objective for session session1 has passed the threshold
of 30 seconds.

IWNR1500I Session information about session session1 was successfully obtained.

ver
Use the ver command to display the current version of IBM Tivoli Storage
Productivity Center for Replication.

Syntax

ver
-help
-h
-?

Command-line interface 265

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.

Example

Displaying the current version:

The following command displays the current version of IBM Tivoli Storage
Productivity Center for Replication that is running on the local system.
csmcli> ver

The following output is returned:

Tivoli Storage Productivity Center for Replication Command Line Interface (CLI)
Copyright 2009 IBM Corporation
Version: 4.1.1
Build: g100-090804

whoami
Use the whoami command to display the name of the user that is currently logged
in.

Syntax

whoami
-help
-h
-?

Parameters
-help | -h | -?
Lists help for the command. If you specify additional parameters and
arguments, those parameters and arguments are ignored.

Example

Displaying the current user name

The following command displays the name of the current user.

csmcli> whoami

The following output is returned:

Currently logged in as administrator
Server: server1
Port: 5110
Authentication file: null

Command aliases
This topic discusses command aliasing.

266 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

With aliasing, you define a name for the alias followed by a value that is the name
of a command and any options associated with command. The aliased command
string is replaced by the defined value and the entire line is reparsed. Passwords
used in aliased commands must first be encrypted using the encrypt command.

Aliased commands are saved in the command configuration file. The default
configuration file is c:\program files\ibm\tpc\cli\libs\tpccli.conf.

For example, to shorten a frequently used command, you can define the following
alias:
tpctool>lsperf = lsdev -user dsadmin -pwd 1ac75d82784ce0a327d45289604ae7b227
-url 9.44.33.126:8990 -fabric -perf

After the alias is defined, you can run the lsperf command to run the aliased lsdev
command previously displayed.

You can provide a short form command targeting different device servers, as
follows:
tpctool>lsperfd1 = lsdev -user dsadmin -pwd 1ac75d82784ce0a327d45289604ae7b227
-url hostOne:9161 -perf

tpctool>lsperfd2 = lsdev -user dsadmin -pwd 1ac75d82784ce0a327d45289604ae7b227

-url hostTwo:9161 -perf

You can specify additional options and arguments for an aliased command:
tpctool>lsperfd2 -fabric -ctype port

The command is expanded as follows:

tpctool>lsdev -user dsadmin -pwd 1ac75d82784ce0a327d45289604ae7b227
-url hostTwo:9161 -perf -fabric -ctype port

You can also nest aliases:

tpctool>lsperf = lsdev -user dsadmin -pwd 1ac75d82784ce0a327d45289604ae7b227
-url hostTwo:9161 -perf -fabric

tpctool>lsperfd1 = lsdev -user dsadmin -pwd 1ac75d82784ce0a327d45289604ae7b227

-url hostOne:9161

tpctool>lsperfd2 = lsdev -user dsadmin -pwd 1ac75d82784ce0a327d45289604ae7b227

-url hostTwo:9161

To unset an alias, type the name of the command alias followed by the '=' sign:
lsperf =

Parameter aliases
This topic lists common parameters and their aliases.

The following table shows parameters and their corresponding aliases.

Command line parameter Alias name

Command-line interface 267

-pwd password

The password is automatically encrypted

using the same encryption algorithm as the
password command before being stored in
the config file. In conjunction with the
interactive mode, this enables secure
password encryption (plain text passwords
will not appear in a command line).
-url url
-fs field-separator
-silent suppress-output
-header show-header
-l long
-dev subsystem
-fabric fabric
-svr server

268 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Appendix A. Accessibility features for Tivoli Storage
Productivity Center
Accessibility features help users who have a disability, such as restricted mobility
or limited vision, to use information technology products successfully.

Accessibility features

The following list includes the major accessibility features in IBM Tivoli Storage
Productivity Center:
v Tivoli Storage Productivity Center functions are available using the keyboard for
navigation instead of the mouse. You can use keys or key combinations to
perform operations that can also be done using a mouse. However, you must
use the mouse to navigate the Topology Viewer and report graphs. Standard
operating system keystrokes are used for standard operating system operations.
v You can use screen readers to read the user interface.
v The user interface communicates all information independently of color.
v The IBM Tivoli Storage Productivity Center Information Center, and its related
publications are accessibility-enabled and include the following accessibility
features:
– The information center is provided in XHTML 1.0 format, which is viewable
in most Web browsers. XHTML allows you to view documentation according
to the display preferences set in your browser. With XHTML, you can use
screen readers and other assistive technologies.
– All documentation for Tivoli Storage Productivity Center is available in
Adobe Portable Document Format (PDF) using the Adobe Acrobat Reader.
You can access the PDFs from the Printable PDFs topic in the information
center at http://publib.boulder.ibm.com/infocenter/tivihelp/v4r1/index.jsp.
– All images are provided with alternative text, so that users with vision
impairments can understand the contents of the images.

Keyboard navigation

This product uses standard Microsoft Windows navigation keys.

Displaying the interface

Click Preferences > Look and Feel to select how to display the Tivoli Storage
Productivity Center user interface. To do so, complete the following steps:
1. Start the Tivoli Storage Productivity Center user interface.
2. Click Preferences > Look and Feel to change the visual appearance of the user
interface to best suit your visual needs:
v Windows Classic
v Windows
v CDE/Motif
v Metal

Limitations for sight-impaired users on IBM Tivoli Storage
Productivity Center for Replication

There some limitations in the product graphical user interface (GUI) that requires
special attention before you start using Tivoli Storage Productivity Center for
Replication with a screen reader:
Dojo components are not read by all screen readers.
The JAWS screen reader does not read some Dojo components on Internet
Explorer 7. Use the command-line interface instead of the GUI with JAWS
on Internet Explorer 7.

IBM and accessibility

See the IBM Human Ability and Accessibility Center Web site for more information
about the commitment that IBM has to accessibility.

270 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Appendix B. Accessibility features for Tivoli Storage
Productivity Center for Replication
Accessibility features help users who have a disability, such as restricted mobility
or limited vision, to use information technology products successfully.

The following list includes the major accessibility features in Tivoli Storage
Productivity Center for Replication:
v Keyboard-only operation
v Interfaces that are commonly used by screen readers
v Keys that are discernible by touch but do not activate just by touching them
v Industry-standard devices for ports and connectors
v The attachment of alternative input and output devices

See the IBM Human Ability and Accessibility Center website at

www.ibm.com/able for more information about the commitment that IBM has for
accessibility.

Accessibility and keyboard shortcuts in the information center

Accessibility features help users with physical disabilities, such as restricted

mobility or limited vision, to use software products successfully. Using the major
accessibility features in this product, users can perform these tasks:
v Use assistive technologies, such as screen-reader software and digital speech
synthesizer, to hear what is displayed on the screen. Consult the product
documentation of the assistive technology for details on using those technologies
with this product.
v Operate specific or equivalent features by using only the keyboard.
v Magnify what is displayed on the screen.

In addition, the documentation was modified to include the following features to

aid accessibility:
v All documentation is available in HTML formats to give the maximum
opportunity for users to apply screen-reader software technology.
v All images in the documentation are provided with alternative text so that users
with vision impairments can understand the contents of the images.

Use the following key combinations to navigate the interface by keyboard:

v To go directly to the Topic pane (the right side), press Alt+K, and then press Tab.
v In the Topic pane, to go to the next link, press Tab.
v To go directly to the Search Results view in the left side, press Alt+R, and then
press Enter or Up Arrow to enter the view.
v To go directly to the Navigation (Table of Contents) view in the left side, press
Alt+C, and then press Enter or Up Arrow to enter the view.
v To expand and collapse a node in the navigation tree, press the Right and Left
Arrow.
v To move to the next topic node, press the Down Arrow or Tab.
v To move to the previous topic node, press the Up Arrow or Shift+Tab.

v To go to the next link, button, or topic node from inside on of the views, press
Tab.
v To scroll all the way up or down in a pane, press Home or End.
v To go back, press Alt+Left Arrow; to go forward, press Alt+Right Arrow.
v To go to the next pane, press F6.
v To move to the previous pane, press Shift+F6.
v To print the active pane, press Ctrl+P.

Related accessibility information for sight-impaired users

The following list contains hints and tips that can help you more fully use the
graphical user interface:
Drop-down lists are positioned directly above or before the radio button that
activates it.
If you use a screen reader, you should be aware that there are radio
buttons to activate drop-down lists for several GUI pages. The way to
activate the drop-down list is by selecting the associated radio button. The
drop-down list is positioned directly above or before the radio button that
activates it. When you use a screen reader that processes the fields and
controls of a page sequentially, you might select the radio button, but not
know that the associated drop-down list has been activated. The screen
reader processes inactive drop-down lists first, and then processes the next
radio button. The drop-down list is activated if you select the radio button.
On the following pages, keep in mind that radio buttons activate a
drop-down list:
v Administration
v ESS/DS Paths
v Sessions
v Session Details
v Storage Systems
Tables are best understood by reviewing the surrounding text and the table row
and column number of the table.
On some graphical user pages, tables use the header or row ID attributes
when reading a single cell. The screen reader reads the table row and
column number, along with cell data. Therefore, you can infer the column
header and row ID.
Experiment with and fine-tune the way your screen reader pronounces some of
the product abbreviations.
Your screen reader might pronounce abbreviations as if they were words.
For example, the common abbreviation for Enterprise Storage Server is
ESS. Your screen reader might read ESS as the word "ess". With some
screen readers you can hear alternate pronunciations. If you frequently use
the software you might prefer to fine-tune such associations in your
settings. When an association is created, the screen reader can recognize
the abbreviation as a word. If you can add dictionary words with your
screen reader, replace the capitalized character sequence with the sequence
E space S space S.
Typically, this abbreviation is used in the combination form of ESS/DS.
This term refers to the Enterprise Storage Server 800, the DS6000, or the
DS8000.

272 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Some decorative artifacts might persist if the cascading style sheet is disabled.
Enable cascading style sheets when possible; otherwise, some decorative
elements might persist in the Firefox and Internet Explorer GUIs. These
artifacts do not affect performance. If they become too distracting, consider
using the command-line interface instead.
For efficiency, confirmation dialogs place initial focus on the Yes button.
When a confirmation dialog box is displayed, focus is given to the Yes
button. Therefore, the screen reader reads “Yes” but does not read the
confirmation text. The software processes the information in this way when
you do the following types of tasks:
v Perform an action on a session
v Remove a connection to a storage system
v Click the About link
v Create a high-availability connection
To read the confirmation text before clicking the Yes, No, or OK button,
view the previous heading before the button.
Dojo components are not read by all screen readers.
The Job Access for Windows and Speech (JAWS) screen reader does not
read some Dojo components on Internet Explorer 7. Use the command-line
interface instead of the GUI with JAWS on Internet Explorer 7.
Firefox is the preferred browser for use with a screen reader.
Use Firefox as the screen reader because other browsers might not fully
expose assistive technology content to the screen reader.

Appendix B. Accessibility features for Tivoli Storage Productivity Center for Replication 273
274 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference
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 local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing

IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.

For license inquiries regarding double-byte character set (DBCS) information,

contact the IBM Intellectual Property Department in your country or send
inquiries, in writing, to:

Intellectual Property Licensing

Legal and Intellectual Property Law
IBM Japan, Ltd.
1623-14, Shimotsuruma, Yamato-shi
Kanagawa 242-8502 Japan

The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or
implied warranties in certain transactions, therefore, this statement may not apply
to you.

This information could include technical inaccuracies or typographical errors.

Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.

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 for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:

IBM Corporation
2Z4A/101
11400 Burnet Road
Austin, TX 78758
U.S.A

Such information may be available, subject to appropriate terms and conditions,

including in some cases, payment of a fee.

The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.

Information concerning non-IBM products was obtained from the suppliers of

those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.

This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.

If you are viewing this information softcopy, the photographs and color
illustrations may not appear.

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 might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Web at "Copyright and
trademark information" at http://www.ibm.com/legal/copytrade.shtml.s

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 might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Web at “Copyright and
trademark information” at http://www.ibm.com/legal/copytrade.shtml.

Adobe and PostScript are either registered trademarks or trademarks of Adobe

Systems Incorporated in the United States, and/or other countries.

276 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Intel is a registered trademark of Intel Corporation or its subsidiaries in the United
States and other countries.

Java and all Java-based trademarks and logos are trademarks or registered
trademarks of Oracle and/or its affiliates.

Linux is a registered trademark of Linus Torvalds in the United States, other

countries, or both.

Microsoft, Windows, and Windows NT are trademarks of Microsoft Corporation in

the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other
countries.

Other company, product, and service names may be trademarks or service marks
of others.

Terms and conditions

Permissions for the use of these publications is granted subject to the following
terms and conditions.

Personal Use: You may reproduce these Publications for your personal, non
commercial use provided that all proprietary notices are preserved. You may not
distribute, display or make derivative work of these Publications, or any portion
thereof, without the express consent of IBM.

Commercial Use: You may reproduce, distribute and display these Publications
solely within your enterprise provided that all proprietary notices are preserved.
You may not make derivative works of these Publications, or reproduce, distribute
or display these Publications or any portion thereof outside your enterprise,
without the express consent of IBM.

Except as expressly granted in this permission, no other permissions, licenses or

rights are granted, either express or implied, to the Publications or any
information, data, software or other intellectual property contained therein.

IBM reserves the right to withdraw the permissions granted herein whenever, in its
discretion, the use of the Publications is detrimental to its interest or, as
determined by IBM, the above instructions are not being properly followed.

You may not download, export or re-export this information except in full
compliance with all applicable laws and regulations, including all United States
export laws and regulations.

IBM MAKES NO GUARANTEE ABOUT THE CONTENT OF THESE

PUBLICATIONS. THE PUBLICATIONS ARE PROVIDED “AS-IS” AND WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING
BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE.

Notices 277
278 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference
Glossary
This glossary includes terms and definitions for IBM Tivoli Storage Productivity Center.

The following cross-references are used in this network management information. The
glossary: Distributed Management Task Force
v See refers the reader from a term to a preferred (DMTF) develops and maintains CIM
synonym, or from an acronym or abbreviation specifications.
to the defined full form. community name
v See also refers the reader to a related or The part of a Simple Network
contrasting term. Management Protocol (SNMP) message
that represents a password-like name and
To view glossaries for other IBM products, go to: that is used to authenticate the SNMP
http://www.ibm.com/software/globalization/ message.
terminology/.
consistency group
active management server A group of copy relationships between
A management server from which the virtual volumes or data sets that are
storage environment can be monitored maintained with the same time reference
and managed. The active management so that all copies are consistent in time.
server replicates its database to the
copy set
standby server.
The source and target volumes in a
business continuity session that contain copies of the same
The capability of a business to withstand data. A session can contain one or more
outages and to operate mission-critical copy sets.
services normally and without
count key data (CKD)
interruption in accordance with
In mainframe computing, a data-record
predefined service-level agreements.
format employing self-defining record
CIM See Common Information Model. formats in which each record is
represented by up to three fields: a count
CIM agent
field identifying the record and specifying
The code that consists of common
its format, an optional key field that can
building blocks that can be used instead
be used to identify the data area contents,
of proprietary software or device-specific
and an optional data field that typically
programming interfaces to manage
contains the user data.
devices that are compliant with the
Common Information Model (CIM). data collection
The process of obtaining performance and
CKD See count key data.
availability monitoring data and
cluster providing that data to a metric evaluator.
1. In SAN Volume Controller or Storwize Examples of data collectors include
V7000, a pair of nodes that provides a Domain Name System (DNS) probes, web
single configuration and service interface. page analyzers, or database analyzers. See
2. In IBM System Storage™ DS8000®, a also discovery.
partition capable of performing all
discovery
DS8000 series functions. With two clusters
The process of finding resources within
in the DS8000 storage unit, any
an enterprise, including finding the new
operational cluster can take over the
location of monitored resources that were
processing of a failing cluster.
moved. See also schedule.
Common Information Model (CIM)
enterprise repository
An implementation-neutral,
A component of the Data server that
object-oriented schema for describing

records and stores all information about grain size
the monitored computers' storage assets The unit size for allocating space on
and their usage over time. The repository thin-provisioned volumes, such as 32, 64,
is organized into relational database 128, and 256 kibibyte. The grain size is
tables and is accessed by Data server defined when a volume is created.
using Java Database Connectivity (JDBC).
GUID See Globally Unique Identifier.
extended count key data (ECKD)
Hardware Management Console (HMC)
An extension of the count key data (CKD)
In a system storage environment, a
architecture.
system that acts as the focal point for
FlashCopy configuration, management of Copy
In storage systems, a feature that creates a Services functions, and maintenance.
point-in-time copy of a volume or set of
heat map
volumes on a specified target volume.
A color-coded data chart where colors are
flush-through mode used to differentiate values in a data set.
A process in which data is written to a
high availability
storage device at the same time as the
Pertaining to a clustered system that is
data is cached.
reconfigured when node or daemon
freeze An operation in which a storage system failures occur, so that workloads can be
blocks I/O from the host system to the redistributed to the remaining nodes in
affected volumes on the primary site. A the cluster.
freeze operation stops mirroring between
high-availability solution
the primary and secondary volumes to
A combination of hardware, software, and
ensure data consistency at the secondary
services that fully automates the recovery
site. See also thaw.
process and does not disrupt user activity.
GiB See gibibyte. High-availability solutions must provide
an immediate recovery point with a fast
gibibyte (GiB)
recovery time.
A base-2 unit of measurement that is
equal to 1,073,741,824 bytes (2 to the 30th HMC See Hardware Management Console.
power). See also gigabyte.
host volume
gigabyte (GB) A volume that represents the volume
In decimal notation, 1,073,741,824 bytes, functional role from an application point
when referring to memory capacity; in all of view. The host volume can be
other cases, it is defined as 1,000,000,000. connected to a host or server. It receives
read, write, and update application I/O,
Global Copy
depending on the site to which the
A non-synchronous long-distance copy
application is writing.
option for data migration and backup. See
also remote mirror and copy and Metro in-band discovery
Mirror. The process of discovering information
about the storage area network (SAN),
Global Mirror
including topology and attribute data,
An optional capability of the remote
through the Fibre Channel data paths.
mirror and copy feature that provides a
Contrast with out-of-band discovery.
two-site extended-distance remote copy.
Data that is written by the host to the job A unit of work that monitors, manages, or
storage unit at the local site is collects data about a storage resource.
automatically maintained at the remote
job scheduler
site. See also Metro Mirror and remote
A component of the Data server that
mirror and copy.
deploys all monitoring activities.
Globally Unique Identifier (GUID)
journal volume
An algorithmically determined number
A volume that holds a consistent copy of
that uniquely identifies an entity within a
data until a new consistent copy is
system.

280 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

formed. The journal volume restores the match changes that are made to a source
last consistent point during a recovery. volume. See also remote mirror and copy
and Global Copy.
KiB See kibibyte.
Metro Global Mirror
kibibyte (KiB)
A three-site, high-availability, disaster
A base-2 unit of measurement that is
recovery solution. Metro Global Mirror
equal to 1,024 bytes (2 to the 10th power).
uses synchronous replication to mirror
See also kilobyte.
data between a local site and an
kilobyte intermediate site, and asynchronous
For processor storage, real and virtual replication to mirror data from an
storage, and channel volume, 2 to the intermediate site to a remote site.
power of 10 or 1,024 bytes. For disk
MiB See mebibyte.
storage capacity and communications
volume, 1,000 bytes. MIB See Management Information Base.
logical unit number (LUN) native interface
In the Small Computer System Interface An interface that is specific to a system or
(SCSI) standard, a unique identifier that is subsystem.
used to differentiate devices, each of
out-of-band discovery
which is a logical unit (LU).
The process of discovering storage area
LUN See logical unit number. network (SAN) information, including
topology and device data, without using
Management Information Base (MIB)
the fibre-channel data paths. A common
In the Simple Network Management
mechanism for out-of-band discovery is
Protocol (SNMP), a database of objects
the use of Simple Network Management
that can be queried or set by a network
Protocol (SNMP) Management
management system.
Information Base (MIB) queries, which are
management server invoked over an IP network. Contrast
A system that provides a central point of with in-band discovery.
control for managing data replication.
ping A job that tracks the availability of assets
management server relationship and that is performed by an agent.
A connection between two replication Several ping jobs can be used to monitor
servers, where one server acts as the the availability of any computer or subset
active server and replicates the data that of computers in the network. See also
is necessary for the standby server to take schedule.
control of the replication environment.
pool A storage pool or pool is a grouping of
mebibyte (MiB) storage space that consists of volumes,
A base-2 unit of measurement that is logical unit numbers (LUNs), or addresses
equal to 1,048,576 bytes (2 to the 20th that share a common set of administrative
power). See also megabyte. characteristics.
megabyte (MB)
For processor storage, real and virtual
practice volume
storage, and channel volume, 2 to the
A volume that can be used to test
20th power or 1,048,576 bytes. For disk
disaster-recovery actions while
storage capacity and communications
maintaining disaster-recovery capability.
volume, 1,000,000 bytes.
primordial pool
Metro Mirror
Storage capacity that is deallocated on a
A method of synchronous remote
storage device. Storage pools are created
replication that operates over distances up
by allocating storage capacity from
to 300 kilometers. This method constantly
primordial pools.
updates a secondary copy of a volume to
probe A job that itemizes and creates an
inventory of assets, such as computers,

Glossary 281
controllers, disk drives, file systems, and site awareness
logical units. See also schedule. The association of a location with each
storage system in a session. Site
recovery point objective
awareness ensures that a volume can only
The maximum amount of data loss that
be selected for a session if it matches the
can be tolerated during a service
location of the site. Site awareness helps
interruption.
to prevent both reversing a hardware
remote mirror and copy relationship and selecting volumes at the
A feature of a storage server that wrong location.
constantly updates a secondary copy of a
SMI-S See Storage Management Initiative
logical volume to match changes made to
Specification.
a primary logical volume. The primary
and secondary volumes can be on the standby management server
same storage server or on separate A management server that is a backup for
storage servers. See also Metro Mirror and the active server. The replication
Global Mirror. environment cannot be monitored or
managed from the standby server.
resource
In a storage environment, an entity that is Storage Management Initiative Specification
monitored. Resources can include fabrics, (SMI-S)
switches, computers, storage systems, and A design specification developed by the
tape libraries. Storage Networking Industry Association
(SNIA) that specifies a secure and reliable
role A job function that identifies the tasks
interface with which storage management
that a user can perform and the resources
systems (SMSs) can identify, classify,
to which a user has access. A user can be
monitor, and control physical and logical
assigned one or more roles.
resources in a storage area network
role pair (SAN). The interface integrates the
The association of two volume roles in a various devices to be managed in a SAN
session that take part in a copy and the tools used to manage them.
relationship. For example, in a Metro
storage pod
Mirror session, the role pair can be the
A logical entity of components of a
association between host volumes at the
system that consists of two storage nodes,
primary site and host volumes at the
and one or two storage subsystems
secondary site (H1-H2).
directly connected with these storage
scan job nodes.
A job that monitors the usage and
storage resource group
consumption of storage. See also schedule.
A named collection of logically related
schedule resources that are monitored by Tivoli
A monitoring task that collects data about Storage Productivity Center. Monitored
storage resources. Monitoring tasks resources can include fabrics, switches,
include scans, probes, pings, discovery, computers, storage systems, tape libraries,
and performance monitors. For example, and other storage resource groups.
define a probe schedule to collect data
target volume
about storage systems; define a scan
A volume that receives data from a host
schedule to collect file-level information
volume or another intermediate volume.
about hosts.
thaw An operation in which a storage system
session
releases the block of the I/O from the
A collection of source and target volumes
host system to the affected volumes on
that are managed to create consistent
the primary site. A thaw operation can
copies of data. The type of data
occur after a freeze operation ends and
replication that is associated with the
consistency is formed on the secondary
session determines the actions that can be
site. See also freeze.
conducted for the volumes.

282 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

track space-efficient (TSE) volume
A volume in which storage space is
allocated on an as-needed basis by using
space on the target volume only when
tracks are copied from the source volume
to the target volume.
virtualization
The substitution of virtual resources for
actual resources, where the virtual
resources have the same functions and
external interfaces as their counterparts,
but differ in attributes, such as size,
performance, and cost. Virtualization is
commonly applied to physical hardware
resources by combining multiple physical
resources into shared pools from which
users receive virtual resources.
virtual storage area network (VSAN)
A fabric within the storage area network
(SAN).
VSAN See virtual storage area network.
zone A logical grouping of switches, switch
ports, and their attached devices in a
fabric.
zone alias
A name that is given to a collection of one
or more zone members that you want to
manage together.
zone set
A group of zones that function together
on a fabric.

Glossary 283
284 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference
Index
A back-end storage systems
showing a list of types of storage
commands (continued)
lspair 194
about this document x systems 42 lsparameter 198
accessibility features bundle states 14 lspath 200
for Tivoli Storage Productivity lspool 69, 202
Center 269 lsquota 72
accessibility features for users with
disabilities 271 C lsrolepairs 205
lsrolescpset 208
actzs 17 catdscfg 28
lssess 210
adddevice command 142 chauth command 146
lssessactions 213
addhost command 144 chdevice command
lssessdetails 215
addmc command 144 changing passwords 148
lssnapgrp
addstorsys command 145 changing user names 148
listing snapshot groups in a
addza 18 chhost command 149
session 217
addzaports 19 chlocation command 150
lssnapgrpactions 220
addzone 20 chmc command 151
lssnapshots
addzoneports 21 chsess command 152
listing snapshots in a sessions 222
agentcli deployer chvol command 160
lssnmp 224
install 4 ckzone 29
lsstorcandidate 225
list bundles 4 ckzs 30
lsvol
list bundles state 5 cmdsess command 161, 163
choosing volumes for copy
list services 5 command line interface
sets 227
list services inuse 5 automatic login authentication 137
displaying information about
refresh 6 command modes 131, 133
volumes 227
start 6 command-line interface
viewing volume properties 227
state 6 configuring 137
mkauth 230
stop 7 customizing 137
mkbackup 231
uninstall 7 commands 1
mkcpset
update 7 adddevice 142
creating copy sets 232
agentcli TPCData stop 8 addhost 144
mklogpkg 235
agentcli TPCFabric addmc 144
mkpath 235
ConfigService setauthenticationpw 8, addstorsys 145
mksess
11 chauth 146
creating sessions 236
help 9, 11 chdevice
mksnmp 240
log get 9, 12 changing passwords 148
refreshdevice 240
log set 10, 13 changing user names 148
rmactive 241
ServiceManager get status 11, 14 chhost 149
rmassoc 242
arrays chlocation 150
rmauth 243
listing 87 chmc 151
rmcpset 243
removing volumes 104 chsess 152
rmdevice 245
storage volumes chvol 160
rmhost 246
creating 93 cmdsess 161, 163
rmmc 247
viewing information 37 exit codes 134
rmpath 247
assignvol 22 exportcsv 167
rmsess 248
autosetarray hareconnect 169
rmsnmp 249
extracting back-end subsystem hatakeover 169
rmstdby 249
values 23 importcsv 170
rmstorsys 250
saving back-end system values 23 lsauth 172
setasstdby 251
lsavailports 174
setoutput 135
lscluster 43, 58
setparameter 252
B lscpset
listing copy set IDs 176
setstdby 253
back-end disks showcpset 254
lscptypes 178
listing types 39 showdevice
lsdevice 180
back-end RAID viewing device properties 255
lsexport 53
listing types 40 showgmdetails 258
lsfset 60
setting types 115 showha 260
lshost 186
back-end storage subsystems showmc 261
lslocation 188
removing the type of disk 99 showsess 262
lslss 184, 190
using the setarray command 111 ver 265
lsmc 192
whoami 266
lsnode 65
comments, sending x
lsnsd 67

commit 31
common agent
H lssnapgrp command
listing snapshot groups in a
commands 4 hareconnect command 169 sessions 217
component types hatakeover command 169 lssnapgrpactions command 220
listing 85 host ports lssnapshots command
components assigning to volumes 22 listing snapshots in a sessions 222
performance data 45 removing from volumes 122 lssnmp 224
reports 46, 63 host types, listing 62 lssrg 75
configuration files lssrgmembers 76
tpcrcli-auth.properties 137 lsstorcandidate command 225
configuring the command-line I lssvr 77
interface 137 importcsv command 170 lssvrdisk 78
confirmation prompts 133, 134 informational messages 134 lsswitch 80
copy sets lstapedrive 81
listing copy set IDs 176 lstapelib 82
create
Storage Resource Group 92
L lstapemc 83
lstime 84
customizing the command-line legal lstype 85
interface 137 terms and conditions 277 lsvmdisk 86
logfile, options, displaying 34 lsvol 87
logfile, options, setting 121 lsvol command
lsarray
D viewing information about arrays 37
choosing volumes for copy sets 227
displaying information about
data paths, listing 57 viewing information about back-end volumes 227
deactzs 31 storage systems 37 viewing volume properties 227
device server lsauth command 172 lszone 89
property lsavailports command 174 lszs 90
displaying current value 32 lsbackenddisktypes
Device server listing back-end disk types 39
checking status 28 lsbackendraidtypes
property listing back-end RAID types 40 M
setting the current value 120 lsbackendtypes messages 134
property files showing a list of types of storage mkauth command 230
displaying contents 28 systems 42 mkbackup command 231
devices lscluster 43, 58 mkcpset command
displaying performance data 45 lscomp 45 creating copy sets 232
listing 48 lscounters 46 mklogpkg command 235
reports 46, 63 lscpset mkpath command 235
disabilities, accessibility features for users listing copy set IDs 176 mksess commandcreating sessions 236
with 271 lscptypes command 178 mksnmp 240
drop-down lists, limitations of to the lsdev 48 mksrg 92
sight-impaired 271 lsdevice command 180 mkvol 93
lsdevp 50 mkzone 95
lsdisk 52 mkzs 96
E lsexport 53 modify
Storage Resource Group 97
encrypt 32 lsextent 55
lsfcpath 57 modifysrg 97
error messages 134
exit codes 134 lsfset 60
exportcsv command 167 lshost command 186
lshtype 62 O
lslocation command 188 options for output format 135
lslss command 184, 190
F lsmc command 192
output 134, 135
fabrics lsmetrics 63
listing 48 lsnode 65
flags 134 lsnsd 67 P
format of output 135 lspair command 194 password, encrypting 32
lsparameter command 198 passwords
lspath command 200 changing 148
G lspool 69 performance data
components 45
getdscfg 32 lspool command 202
lsport 71 time ranges 84
getdslogopt 34
lsquota 72 performance metrics
getrpt 34
lsrolepairs 205 reports 34
glossary 279
lsrolescpset command 208 physical disks 52
lssess command 210 listing 78
lssessactions command 213
lssessdetails command 215

286 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

pools
extracting values from MDisk group
setbackendtype
setting types of back-end storage
T
names 23 systems 117 tape libraries
ports, listing information 50, 71 updating types of back-end storage listing 82
property systems 117 time ranges for performance data 84
displaying current value 32 setdscfg 120 tpcrcli-auth.properties 137
setting the current value 120 setdslogopt 121 tpctool command 14
property file setoutput 135 trademarks 276
checking status 28 setparameter command 252 transactions
displaying contents 28 setstdby command 253 committing 31
setting output format 135 rolling back 110
setting up starting 122
translations
R automatic login authentication 137
showcpset command 254 browser locale requirement ix
reader feedback, sending x
showdevice command
refreshdevice command 240
viewing device properties 255
reports
components 46, 63
showgmdetails command 258 U
showha command 260 unassignvol 122
devices 46, 63
showmc command 261 updatesrg 124
performance metrics 34
showsess command 262 user names
rmactive command 241
sight-impaired 271 changing 148
rmassoc command 242
special characters in syntax user profiles
rmauth command 243
diagrams 128 changing passwords 148
rmbackenddisktype
start 122 changing user names 148
removing the type of disk 99
storage extents
rmbackendraidtype
listing 55, 81, 83
removing back-end RAID arrays 100
rmbackendtype
Storage Resource Group
create 92
V
removing types of storage ver command 265
delete 103
systems 102 volumes
listing 75
resetting types of storage host ports
member listing 76
systems 102 assigning 22
members 76
rmcpset command 243 removing 122
modifying 97
rmdevice command 245 listing 87
update 124
rmhost command 246 removing 104
Storage Resource Groups 75
rmmc command 247
storage subsystem
rmpath command 247
physical disks 52
rmsess command 248
rmsnmp 249
storage extents 55, 81, 83 W
storage volumes warning messages 134
rmsrg 103
creating 93 whoami command 266
rmstdby command 249
subsystems world-wide port names, listing 50
rmstorsys command 250
arrays
rmvol 104
listing 87
rmza 106
rmzaports 106
fabric
component types 85
Z
rmzone 107 zone alias ports
host types
rmzoneports 108 deleting 106
listing 62
rmzs 109 zone aliases
listing 48
rollback 110 adding 18
storage
component types 85 adding ports 19
volumes deleting 106
S listing 87 zone sets
SAN Volume Controller world wide port names activating 17
publications vii listing 50 creating 96
sending comments x suppressing confirmation prompts and deactivating 31
sessions messages 134 deleting 109
listing copy set IDs 176 switch ports listing information 90
setarray adding to zones 21 verifying 30
setting back-end storage subsystem removing from zones 108 zones
values 111 switches, listing 48 adding 20
setasstdby command 251 syntax diagrams listing information 89
setbackenddisktype command emphasis 128 removing 107
setting back-end disk types 113 how to read 128 zones
updating back-end disk types 113 special characters 128 adding to zone sets 20
setbackendraidtype systems, listing information 77, 80, 86 creating 95
setting back-end RAID types 115 deleting 107
listing information 89

Index 287
zones (continued)
switch ports
adding 21
removing 108
verifying 29

288 IBM Tivoli Storage Productivity Center: Command-Line Interface Reference

Product Number: 5608-WB1, 5608-WC0, 5608-WC3, 5608-WC4, 5725-E18,

5725-A01
5608-WB2, 5608-WB3

Printed in USA

SC27-2339-07

Linux Format - April 2024 UK
100% (1)
Linux Format - April 2024 UK
100 pages
Ihe Pub Nl410 Drive Replacement Guide
No ratings yet
Ihe Pub Nl410 Drive Replacement Guide
10 pages
HPE FOS 8.2.3c1 RN v2
No ratings yet
HPE FOS 8.2.3c1 RN v2
11 pages
Failing Function Codes, Failing Items, and Symbolic Frus: Power Systems
No ratings yet
Failing Function Codes, Failing Items, and Symbolic Frus: Power Systems
336 pages
SG 245946
No ratings yet
SG 245946
418 pages
Citrix 1912
No ratings yet
Citrix 1912
929 pages
Mastering Python Applications - From Web Development To AI - A Comprehensive Guide For Beginners and Intermediate Developers
No ratings yet
Mastering Python Applications - From Web Development To AI - A Comprehensive Guide For Beginners and Intermediate Developers
4 pages
P3am 7742 EN
No ratings yet
P3am 7742 EN
80 pages
Fujitsu Dx410 s2 Dx440 s2 User Manual
No ratings yet
Fujitsu Dx410 s2 Dx440 s2 User Manual
1,066 pages
English A Paper 02 May-June Csec 2024 PDF
No ratings yet
English A Paper 02 May-June Csec 2024 PDF
1 page
Laboratory Activity #1 Java Fundamentals: NCP 3106 (Software Design Laboratory)
No ratings yet
Laboratory Activity #1 Java Fundamentals: NCP 3106 (Software Design Laboratory)
18 pages
B Ba Guide Unx LNX
No ratings yet
B Ba Guide Unx LNX
778 pages
Crash 2024 12 09 16 13 56 671
No ratings yet
Crash 2024 12 09 16 13 56 671
11 pages
Intrusion Detection Honeypots
From Everand
Intrusion Detection Honeypots
Chris Sanders
3/5 (2)
Eternus Ab Series
No ratings yet
Eternus Ab Series
107 pages
TSPC For Replication RedBook
No ratings yet
TSPC For Replication RedBook
428 pages
Storwize V7000 Unified Authentication HOWTO V1 1
No ratings yet
Storwize V7000 Unified Authentication HOWTO V1 1
72 pages
TS3310CLI Instructions
No ratings yet
TS3310CLI Instructions
6 pages
SG 246648
No ratings yet
SG 246648
728 pages
229 - ClassX - Data-Entry-Operation - NIOS
No ratings yet
229 - ClassX - Data-Entry-Operation - NIOS
283 pages
CS373 2024 Part3 0 - Introduction
No ratings yet
CS373 2024 Part3 0 - Introduction
26 pages
A Backend-Agnostic, Quantum-Classical Framework For Simulations of Chemistry in C++
No ratings yet
A Backend-Agnostic, Quantum-Classical Framework For Simulations of Chemistry in C++
17 pages
Dashrath Nandan MAD (Complete) Notes
No ratings yet
Dashrath Nandan MAD (Complete) Notes
54 pages
Double Column Research Paper Format
No ratings yet
Double Column Research Paper Format
2 pages
P9eai src1
No ratings yet
P9eai src1
1,138 pages
SC 27890203
No ratings yet
SC 27890203
158 pages
RN 11 1 0 B XIV
No ratings yet
RN 11 1 0 B XIV
8 pages
B FCM Win Guide-Tdp
No ratings yet
B FCM Win Guide-Tdp
378 pages
CM 2 Ed
No ratings yet
CM 2 Ed
11 pages
Introduction To ICT - Lab COSC-1205
No ratings yet
Introduction To ICT - Lab COSC-1205
2 pages
IBM TPC 5.2.7.1 Download List From Passport Advantage - Feb 2016
No ratings yet
IBM TPC 5.2.7.1 Download List From Passport Advantage - Feb 2016
10 pages
A Detailed Lesson Plan in ICT
No ratings yet
A Detailed Lesson Plan in ICT
10 pages
The Interaction
No ratings yet
The Interaction
20 pages
1.1 Course Content
No ratings yet
1.1 Course Content
6 pages
IBM Tivoli Monitoring Problem Determination Guide
No ratings yet
IBM Tivoli Monitoring Problem Determination Guide
262 pages
HAP - 6 - 2 - NOTES Updated
No ratings yet
HAP - 6 - 2 - NOTES Updated
71 pages
From Waiter To Tech Titan The Rise of Jensen Huang
No ratings yet
From Waiter To Tech Titan The Rise of Jensen Huang
10 pages
JacintoCJNicole Laboratoryexercise1
No ratings yet
JacintoCJNicole Laboratoryexercise1
13 pages
IBM Tivoli Monitoring For Network Performance Messages and Troubleshooting
No ratings yet
IBM Tivoli Monitoring For Network Performance Messages and Troubleshooting
119 pages
IBM Tivoli Monitoring Administrator's Guide
No ratings yet
IBM Tivoli Monitoring Administrator's Guide
236 pages
Arbortext Command Language - ACL DESIGN
No ratings yet
Arbortext Command Language - ACL DESIGN
176 pages
E-Card Lock Manual in English (9.3)
No ratings yet
E-Card Lock Manual in English (9.3)
22 pages
13 - Guided Lab 1 - Breaking A Monolithic Node - Js Application Into Microservices
No ratings yet
13 - Guided Lab 1 - Breaking A Monolithic Node - Js Application Into Microservices
25 pages
Tivoli Storage Productivity Center
No ratings yet
Tivoli Storage Productivity Center
734 pages
FastMM4 Readme
No ratings yet
FastMM4 Readme
4 pages
B Ba Guide Unx LNX PDF
No ratings yet
B Ba Guide Unx LNX PDF
728 pages
Tivoli Storage Productivity Center Users Guide PDF
No ratings yet
Tivoli Storage Productivity Center Users Guide PDF
880 pages
YSoft SafeQ User and Cost Management Datasheet
No ratings yet
YSoft SafeQ User and Cost Management Datasheet
4 pages
Mensagem de Erros Spectrum Protect
No ratings yet
Mensagem de Erros Spectrum Protect
368 pages
AutoPIPE V8i Fundamentals TRN012310 1 0006
No ratings yet
AutoPIPE V8i Fundamentals TRN012310 1 0006
258 pages
How To Download PDFs - 13 Steps (With Pictures) - Wikihow
No ratings yet
How To Download PDFs - 13 Steps (With Pictures) - Wikihow
5 pages
8051 Programming in C: The 8051 Microcontroller and Embedded Systems: Using Assembly and C
100% (1)
8051 Programming in C: The 8051 Microcontroller and Embedded Systems: Using Assembly and C
34 pages
Ec8791 Erts QB
No ratings yet
Ec8791 Erts QB
8 pages
Client Installation and User'S Guide: Ibm Tivoli Storage Manager Fastback For Workstations 6.1.2.0
No ratings yet
Client Installation and User'S Guide: Ibm Tivoli Storage Manager Fastback For Workstations 6.1.2.0
122 pages
Micro Focus Fortify Static Code Analyzer: Installation Guide
No ratings yet
Micro Focus Fortify Static Code Analyzer: Installation Guide
23 pages
SSPC Inst Usr Guide-V11
No ratings yet
SSPC Inst Usr Guide-V11
104 pages
Multi-Dimensional Vision System CV-X/XG-X Series
No ratings yet
Multi-Dimensional Vision System CV-X/XG-X Series
20 pages
Installation and User's Guide: IBM Tivoli Storage Manager For Windows Backup-Archive Clients
No ratings yet
Installation and User's Guide: IBM Tivoli Storage Manager For Windows Backup-Archive Clients
800 pages
TPC For System Z
No ratings yet
TPC For System Z
588 pages
TPC 4.1 Usersguide v41
No ratings yet
TPC 4.1 Usersguide v41
880 pages
IBM TSM For AIX
No ratings yet
IBM TSM For AIX
135 pages
TSM V5.3 Technical Guide
No ratings yet
TSM V5.3 Technical Guide
456 pages
Guide BaClient Win TSM 7.1
No ratings yet
Guide BaClient Win TSM 7.1
800 pages
B Ba Guide Unx LNX
No ratings yet
B Ba Guide Unx LNX
728 pages
IBM Tivoli Storage Manager For AIX Installation Guide 6.2
No ratings yet
IBM Tivoli Storage Manager For AIX Installation Guide 6.2
132 pages
STG Agent Guide Aix
No ratings yet
STG Agent Guide Aix
146 pages
ChatGPT for Business: Strategies for Success
From Everand
ChatGPT for Business: Strategies for Success
Matthew C. Smith
1/5 (1)
TSM Linux BA Client Trouble Shooting Issues
No ratings yet
TSM Linux BA Client Trouble Shooting Issues
750 pages
TSM Technical Guide Sg246638
No ratings yet
TSM Technical Guide Sg246638
456 pages
Storage Productivity Center: Quick Start Guide
No ratings yet
Storage Productivity Center: Quick Start Guide
2 pages
B SRV Install Guide Linux 718
No ratings yet
B SRV Install Guide Linux 718
198 pages
B SRV Install Guide Windows PDF
No ratings yet
B SRV Install Guide Windows PDF
200 pages
B SRV Install Guide Aix 718
No ratings yet
B SRV Install Guide Aix 718
198 pages
Tivoli Storage Manager - Version 4.2
No ratings yet
Tivoli Storage Manager - Version 4.2
350 pages
SG 248236
No ratings yet
SG 248236
394 pages
Flash Copy Manager For Unix Admin Guide
No ratings yet
Flash Copy Manager For Unix Admin Guide
272 pages
TSM 6.1 Technical Guide Draft
No ratings yet
TSM 6.1 Technical Guide Draft
674 pages
Back in the Real World (Stone Angel #2)
From Everand
Back in the Real World (Stone Angel #2)
Marvin H. Albert
4.5/5 (2)
B FCM Unx Guide
No ratings yet
B FCM Unx Guide
194 pages
Tivoli Enterprise Console - Guia Do Usuário
No ratings yet
Tivoli Enterprise Console - Guia Do Usuário
132 pages
Itm Ux Agent
No ratings yet
Itm Ux Agent
270 pages
Implementing IBM Tivoli Workload Scheduler V 8.2 Extended Agent For IBM Tivoli Storage Manager Sg246696
100% (1)
Implementing IBM Tivoli Workload Scheduler V 8.2 Extended Agent For IBM Tivoli Storage Manager Sg246696
124 pages
Tivoli Storage Productivity Center V4.2 Release Guide Sg247894
No ratings yet
Tivoli Storage Productivity Center V4.2 Release Guide Sg247894
694 pages
SG 246554
No ratings yet
SG 246554
372 pages
B Ba Guide Unx LNX
No ratings yet
B Ba Guide Unx LNX
628 pages
TWS Command Line Interface (CLI) Reference: IBM Tivoli Support Technical Exchange Web Seminar
No ratings yet
TWS Command Line Interface (CLI) Reference: IBM Tivoli Support Technical Exchange Web Seminar
43 pages
B Ba Guide Win
No ratings yet
B Ba Guide Win
722 pages
IBM Tivoli Business Service Manager V4.1 Redp4288
No ratings yet
IBM Tivoli Business Service Manager V4.1 Redp4288
96 pages
Client Messages and API Return Codes
No ratings yet
Client Messages and API Return Codes
368 pages
TSM NDMP Config
No ratings yet
TSM NDMP Config
971 pages
Gray Hat Hacking the Ethical Hacker's
From Everand
Gray Hat Hacking the Ethical Hacker's
Çağatay Şanlı
5/5 (1)
B PDG Master
No ratings yet
B PDG Master
323 pages
622 Programming Interface Codes - Msgs - Client
No ratings yet
622 Programming Interface Codes - Msgs - Client
328 pages
B SRV Fbint Guide
No ratings yet
B SRV Fbint Guide
82 pages
B Perf Tuning Guide
No ratings yet
B Perf Tuning Guide
92 pages
IBM Tivoli Storage Manager For UNIX and Linux Backup-Archive Client Installation and User's Guide Version 5.5 - Ans50000
No ratings yet
IBM Tivoli Storage Manager For UNIX and Linux Backup-Archive Client Installation and User's Guide Version 5.5 - Ans50000
627 pages
Tivoli: Storage Manager For AIX
No ratings yet
Tivoli: Storage Manager For AIX
104 pages
TSM ClientConsiderations
No ratings yet
TSM ClientConsiderations
50 pages
TSM 5.4 BA Client - Unix Linux
No ratings yet
TSM 5.4 BA Client - Unix Linux
591 pages
Dynamic Workload Console Installation Guide
100% (1)
Dynamic Workload Console Installation Guide
245 pages
Integrating IBM Tivoli Workload Scheduler With Tivoli Products Sg246648
0% (1)
Integrating IBM Tivoli Workload Scheduler With Tivoli Products Sg246648
728 pages
Tivoli Workloud Scheduler Guide
No ratings yet
Tivoli Workloud Scheduler Guide
420 pages