xscmd utility reference

You can use the following list of commands as a reference when you are using the xscmd utility.

The xscmd command output is logged to the SystemOut and SystemErr streams. Most xscmd data is listed in a table format and sent to the SystemOut stream. Additional messages, including the timestamp at the start and end of the xscmd request and type of command run, are logged to the SystemErr stream. The xscmd command output can change as improvements are made to various commands. The order and type of the columns does not change and new columns or types of data are added to the end of the table. Additional messages can be added to provide more information about the result of the command.

General command parameters

The general format of xscmd utility commands follows. The optional parameters are in square brackets [ ].


Usage: xscmd -c <cmdName> | -h <cmdName> | -lc [<cmdGroupName>] | -lcg
             [-tt <type>] [-fips] [-ksp <password>] [-user <username>] [-kst
             <type>] [-cgp <property>] [-cep <endpoints>] [-ssp <profileName>]
             [-tsp <password>] [-arc <integer>] [-tst <type>] [-sp
             <profileName>] [-jvmArgs <JVMArguments>] [-ca <support>] [-prot
             <protocol>] [-ks <filePath>] [-trf <filePath>] [-al <alias>]
             [-trs <traceSpec>] [-cxpv <provider>] [-sp800 <type>] [-to
             <serverTimeout>] [-pwd <password>] [-ro <filename>] [-cgc
             <className>] [-ts <filePath>]

Options:
  -al,--alias <alias>                  Alias name in the keystore.

  -arc,--authRetryCount <integer>      The retry count for authentication if
                                       the credential is expired. If the
                                       value is set to 0, then authentication
                                       retries do not occur.

  -c,--command <cmdName>               Specifies the name of the command to
                                       execute

  -ca,--credAuth <support>             Set the client credential
                                       authentication support [Never,
                                       Supported, Required].

  -cep,--catalogEndPoints <endpoints>  Specifies one or more catalog service
                                       endpoints in the format
                                       <host>[:<listenerPort>][,<host>[:
                                       <listenerPort>]]. Default endpoint:
                                       localhost:2809

  -cgc,--credGenClass <className>      Specifies the name of the class that
                                       implements the CredentialGenerator
                                       interface. This class is used to get
                                       credentials for clients.

  -cgp,--credGenProps <property>       Specifies the properties for the
                                       CredentialGenerator implementation
                                       class. The properties are set to the
                                       object with the setProperties(String)
                                       method.

  -cxpv,--contextProvider <provider>   Context provider.  Examples: IBMJSSE2,
                                       IBMJSSE, IBMJSSEFIPS.

 -fips                                 Specifies that xscmd runs in FIPS mode so 
                                       that the the cryptography used within xscmd 
                                       for SSL encryption is FIPS compliant.
 
  -h,--help <cmdName>                  Invokes general command-line help
  -jvmArgs,--jvmArgs <JVMArguments>    -jvmArgs,--jvmArgs <JVMArguments>    
                                        Specifies a set of JVM arguments.
                                        Each option specified after the -jvmArgs option
                                        starts the xscmd Java virtual machine (JVM). When the
                                        -jvmArgs parameter is specified, ensure
                                        that it is the last optional script    
                                        argument specified.
  -ks,--keyStore <filePath>            Absolute path to keystore. Example:
                                       /etc/test/security/server.public

  -ksp,--keyStorePassword <password>   Specifies the password to the keystore.

  -kst,--keyStoreType <type>           Keystore type. Example: JKS, JCEK,
                                       PKCS12.

  -lc,--listCommands <cmdGroupName>    List all commands for a command group

  -lcg,--listCommandGroups             List all command groups

  -lpc,--listPrivateCommands           List all private commands.

  -prot,--protocol <protocol>          Protocol.  Examples: SSL, SSLv2,
                                       SSLv3, TLS, TLSv1, TLSv1.2.

  -pwd,--password <password>           eXtreme Scale password security
                                       credential

  -sp,--secProfile <profileName>       Specifies a profile name.

  -sp800_131 strict                    Specifies that xscmd runs in SP800-131a strict mode 
                                       so that TLS connections with the server must comply 
                                       with the NIST SP800-131a strict standard.

  -sp800_131 transition                Specifies that xscmd runs in SP800-131a 
                                       transition mode so that TLS connections with the 
                                       server must comply with the NIST SP800-131a 
                                       transition standard.

  -ssp,--saveSecProfile <profileName>  Save security parameter values in
                                       security profile.

  -to,--timeout <serverTimeout>        Server connection timeout in seconds

  -trf,--traceFile <filePath>          Specifies the absolute path to the
                                       generated trace file for xscmd command
                                       output

  -trs,--traceSpec <traceSpec>         Specifies the trace specification for
                                       xscmd command output

  -ts,--trustStore <filePath>          Absolute path to truststore. Example:
                                       /etc/test/security/server.public

  -tsp,--trustStorePassword <password> Truststore password

  -tst,--trustStoreType <type>         Truststore type. Examples: JKS, JCEK,
                                       PKCS12.

  -tt,--transportType <type>           Transport layer security configuration
                                       type.  Examples: TCP/IP,
                                       SSL-Supported, SSL-Required.

  -user,--username <username>          eXtreme Scale user name security
                                       credential

Restriction: You can use FIPS data encryption with the TLSv1 protocol only.

All commands

The full list of xscmd utility commands follows.

Note: Column names may change (except for a column type and position), and new columns may be added to the end of a table if a command is enhanced as appropriate.

For further help and parameters for a specific command run xscmd -h command_name. If you plan on developing a customized script with these commands, then you should redirect the standard error path to a null device by running the following:

./xscmd.sh
-c commandName -Options 2> /dev/null

Examples

The following examples demonstrate how to run a command from the xscmd utility:

./xscmd.sh -lc * This command lists all available commands

./xscmd.sh
-h showMapSizes * This command lists help for the showMapSizes command

Important: The output and usage of the following commands are subject to change in the future. If a command is marked with an asterisk (*) it means that only the output of the command is subject to change:

listHosts
showPlacement
placementServiceStatus
showDomainReplicationState
showReplicationState
*osgiAll
*osgiCheck
*osgiCurrent
*osgiUpdate
*showLinkedPrimaries
*triggerPlacement