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 | Use the chsess command to change the description or properties for an existing session. If you want to change the session type, you must delete the session and create another session. | Administrator
Operator |
| cmdsess | Use the cmdsess command to run a specific action against a session. | Administrator
Operator |
| csmcli | The csmcli command is the Copy Services Manager command-line interface (CLI) program. This command can be used either on its own, using the associated options and arguments, or interactively by starting csmcli with no parameters or arguments to start an interactive session. | Administrator
Operator Monitor |
| dcrequestaction | Use the dcrequestaction command to run a specified
scheduled task. Tip: To list all of the Dual Control requests, use the lsdcrequests command. |
Administrator
Operator Monitor |
| 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. | Administrator
Operator Monitor |
| importcsv | Use the importcsv command to parse a comma-separated values (CSV) file to create copy sets for a session. | Administrator |
| lsbackups | Use the lsbackups command to display the backups for a specified session and role. | Administrator
Operator Monitor |
| lsbackupvols | Use the lsbackupvols command to display the volumes included in a given backup for the specified session and role. | Administrator
Operator Monitor |
| lscpset | Use the lscpset command to list the IDs and number of volumes for the copy sets that are in a session. | Administrator
Operator Monitor |
| lscptypes | Use the lscptypes command to display the session types and the storage systems that you can use with the session types. | Administrator
Operator Monitor |
| lsdcrequests | Use the lsdcrequests command to display all Dual Control requests created by or requiring approval from the current user. | Administrator
Operator Monitor |
| 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. | Administrator
Operator Monitor |
| lsparameter | Use the lsparameter command to list Metro Mirror heartbeat setting. | Administrator
Operator Monitor |
| lsrolepairs | Use the lsrolepairs command to display role pairs in a session. | Administrator
Operator Monitor |
| lsrolescpset | Use the lsrolescpset command to list the volume roles in the specified session. | Administrator
Operator Monitor |
| lssess | Use the lssess command to display sessions and their status. | Administrator
Operator Monitor |
| lssessactions | Use the lssessactions command to list all the session actions (commands) that can be run for a session. | Administrator
Operator Monitor |
| lssessdetails | Use the lssessdetails command to display the details of a session. | Administrator
Operator Monitor |
| mkcpset | Use the mkcpset command to create copy sets. | Administrator
Operator |
| mksess | Use the mksess command to create a session. | Administrator
Operator |
| rmcpset | Use the rmcpset command to remove a copy set. | Administrator
Operator |
| rmsess | Use the rmsess command to remove a session. | Administrator
Operator |
| setparameter | Use the setparameter command to set the system parameters. | Administrator |
| setrolepaircg | Use the setrolepaircg command to assign a specific user defined consistency group name to a role pair. | Administrator
Operator |
| showcpset | Use the showcpset command to display properties for a copy set. | Administrator
Operator Monitor |
| showsess | Use the showsess command to display properties for a selected session, including name, description, group managed, and copy type. | Administrator
Operator Monitor |
Storage systems and connections
| Command | Description | Roles |
|---|---|---|
| adddevice | Use the adddevice command to add a storage system. | Administrator |
| addemailalert | Use the addemailalert command to add e-mail addresses to the list of e-mail addresses to receive e-mail alerts. | Administrator |
| addemailserver | Use the addemailserver command to add or change the SMTP server configuration used to send e-mail alerts. | Administrator |
| addmc | Use the addmc command to add a management console connection and all the storage systems that are managed by that management console. | Administrator |
| addstorsys | Use the addstorsys command to add a specific storage system and its volumes that are attached through a z/OS connection to the copy services management server configuration | Administrator |
| chdevice | Use the chdevice command to change user names and passwords for storage systems. | Administrator |
| chlocation | Use the chlocation command to change the location associated with the specified storage systems. | Administrator |
| chmc | Use the chmc command to set or change the hardware credentials for the hardware management console (HMC). | Administrator |
| chsystem | Use the chsystem command to make changes to system settings files for the server. The server may need to be restarted for changes to take effect. Note: This command can only be issued by a user with Administrator authority. | Administrator |
| chvol | Use the chvol command to change the protection setting for a volume. You cannot change the protection setting for a volume that is in a session. | Administrator |
| lsavailports | Use the lsavailports command to display the port configuration types for a specific path. | Administrator
Operator Monitor |
| lsdevice | Use the lsdevice command to list storage systems and properties. | Administrator
Operator Monitor |
| lslocation | Use the lslocation command to list all defined locations. | Administrator
Operator Monitor |
| 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. | Administrator
Operator Monitor |
| lsmc | Use the lsmc command to display a summary of management consoles and settings. | Administrator
Operator Monitor |
| lspath | Use the lspath command to display paths between ESS and DS devices. You can then use this information for a remote copy. | Administrator
Operator Monitor |
| lspool | Use the lspool command to list pools that are on FlashSystems/IBM Spectrum Accelerate. | Administrator
Operator Monitor |
| 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 copy services management server configuration. | Administrator
Operator Monitor |
| lsvol | Use the lsvol command to display detailed information about volumes. | Administrator
Operator Monitor |
| mkdevicedump | Use the mkdevicedump command to collect diagnostic information on a storage device. The only storage devices currently supported by this command are DS8000 devices using an HMC connection. Users with administrator authority who have administrator or service authorization on the HMC can issue mkdevicedump through the HMC connection. | Administrator |
| mkpath | Use the mkpath command to create a Fibre Channel path or paths between a source logical subsystem (LSS) and a target LSS. | Administrator
Operator |
| rmdevice | Use the rmdevice command to remove a direct connection to a storage system. | Administrator |
| rmmc | Use the rmmc command to remove a management console. | Administrator |
| rmpath | Use the rmpath command to remove a path or paths between a source logical subsystem (LSS) and a target LSS. | Administrator
Operator |
| rmstorsys | Use the rmstorsys command to remove a specific storage system and its volumes connected through a z/OS connection to the copy services management server configuration. | Administrator |
| showdevice | Use the showdevice command to display storage system properties. | Administrator |
| showmc | Use the showmc command to display the properties of a management console. | Administrator |
Management servers
| Command | Description | Roles |
|---|---|---|
| hareconnect | Use the hareconnect command to reconnect the active and standby servers for high availability (HA). | Administrator |
| hatakeover | Use the hatakeover command to change the standby server to the active server. | Administrator |
| lshaservers | Use the lshaservers command to show the status of each active and standby management server. | Administrator
Operator Monitor |
| lssnmp | Use the lssnmp command to list the SNMP managers to which the copy services management server is configured to send SNMP alerts. | Administrator
Operator Monitor |
| lstasks | Use the lstasks command to display a list of scheduled tasks. | Administrator |
| mkbackup | Use the mkbackup command to create a backup of the configuration data (including storage systems, sessions, and copy sets) in the zero-administration embedded repository. | Administrator |
| mklogpkg | Use the mklogpkg command to create a log package. The log package is written to the file that is specified in the csm_install_directory\wlp\usr\servers\csmServer\properties\Diagnostics.properties file. | Administrator |
| 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. | Administrator |
| rmactive | Use the rmactive command to remove an active management server. | Administrator |
| rmsnmp | Use the rmsnmp command to remove the specified manager from the list of servers to which SNMP traps are sent. | Administrator |
| rmstdby | Use the rmstdby command to remove a standby management server. | Administrator |
| runtask | Use the runtask command to run a specified scheduled task. | Administrator |
| setasstdby | Use the setasstdby command to set a management server to be the standby management server of another active management server. | Administrator |
| setstdby | Use the setstdby command to set the standby management server for an active management server. | Administrator |
| showha | Use the showha command to display the high-availability status. | Administrator
Operator Monitor |
| ver | Use the ver command to display the current version of IBM Copy Services Manager. | Administrator
Operator Monitor |
Security
| Command | Description | Roles |
|---|---|---|
| chauth | Use the chauth command to change the authorization level of a user. | Administrator |
| chuser | Use the chuser command to change the password for a user in the basic user registry. | Operator |
| lsauth | Use the lsauth command to list the name, authorization level, and session permission for each user or user group. | Administrator
Operator Monitor |
| lsauthcfg | Use the lsauthcfg command to show the configuration being used for server base authentication, if any. | Administrator |
| mkadcfg | Use the mkadcfg command to configure the Active Directory server-based authentication. | Administrator |
| mkauth | Use the mkauth command to grant monitor, administrator, user administrator, or operator authorization to a user. (This command will not remove authorization for an existing user.) | Administrator |
| mkldapcfg | Use the mkldapcfg command to configure an LDAP server based authentication. | Administrator |
| mkuser | Use the mkuser command to create a user in the basic user registry. | Administrator |
| rmauth | Use the rmauth command to remove monitor, administrator, or operator authorization from an LDAP user or user group. Note: The rmuath command is only for LDAP users and groups. To remove users from the basic user registry, you must use rmuser. | Administrator |
| rmauthcfg | Use the rmauthcfg command to remove the LDAP configuration from being used from user authentication. | Administrator |
| rmuser | Use the rmuser command to remove a user from the basic user registry. | Administrator |
| syncauthservice | Use the syncauthservice command to synchronize certificates from the authentication service to the authentication service of another server. For change to take effect, csmAuth needs to be restarted on the destination server. | Administrator |
| whoami | Use the whoami command to show the name of the user that is logged on. | Administrator
Operator Monitor |