xscmd ユーティリティー・リファレンス

xscmd ユーティリティーを使用する場合、次のコマンドのリストをリファレンスとして使用できます。

汎用コマンド・パラメーター

xscmd ユーティリティー・コマンドの一般的な形式は次のとおりです。オプション・パラメーターは、大括弧 [ ] で囲まれています。
注意:
WebSphere® DataPower® XC10 アプライアンス 環境では、次のコマンドは使用しないでください。
  • -c releaseShard
  • -c reserveShard
  • -c swapShardWithPrimary
  • -c suspendBalancing
  • -c resumeBalancing
  • -c teardown
  • -c triggerPlacement
  • -c showinfo
Usage: xscmd -c <cmdName> | -h <cmdName> | -lc [<cmdGroupName>] | -lcg
             [-cgc <className>] [-ca <support>] [-sp
             <profileName>] [-ks <filePath>] [-ts <filePath>] [-trf
             <filePath>] [-prot <protocol>] [-cxpv <provider>] [-trs
             <traceSpec>] [-al <alias>] [-pwd <password>] [-tsp <password>]
             [-cep <endpoints>] [-ksp <password>] [-arc <integer>] [-tt
             <type>] [-tst <type>] [-ssp <profileName>] [-kst <type>] [-cgp
             <property>] [-user <username>]

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>[:<liste
                                       nerPort>]]. 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.

  -h,--help <cmdName>                  Invokes general command-line help

  -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

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

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

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

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

  -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
usage: xscmd -c <cmdName> | -h <cmdName> | -lc [<cmdGroupName>] | -lcg
             [-cgc <className>] [-ca <support>] [-sp <profileName>] [-ks
             <filePath>] [-ts <filePath>] [-trf <filePath>] [-prot <protocol>]
             [-cxpv <provider>] [-trs <traceSpec>] [-al <alias>] [-pwd
             <password>] [-tsp <password>] [-cep <endpoints>] [-ksp <password>]
             [-arc <integer>] [-tt <type>] [-tst <type>] [-ssp <profileName>]
             [-kst <type>] [-cgp <property>] [-user <username>]
Options:
 -al,--alias <alias>                    Alias name in the key store.
 -arc,--authRetryCount <integer>        The retry count for authentication if
                                        the credential is expired. If the value
                                        is set to 0, there will not be any
                                        authentication retry.
 -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>[:<listen
                                        erPort>]]. 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.
 -h,--help <cmdName>                    Invokes general command-line help
 -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
 -prot,--protocol <protocol>            Protocol.  Examples: SSL, SSLv2, SSLv3,
                                        TLS, TLSv1.
 -pwd,--password <password>             eXtreme Scale password security
                                        credential
 -sp,--secProfile <profileName>         Specifies a profile name.
 -ssp,--saveSecProfile <profileName>    Save security parameter values in
                                        security profile.
 -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

すべてのコマンド

次に、xscmd ユーティリティー・コマンドをすべてリストします。特定のコマンドの詳細およびパラメーターを表示するには、xscmd -h command_name を実行してください。
Command Name           Description
------------           -----------
balanceShardTypes      Attempt shard redistribution so that the ratio of
                       primaries and replicas within each container server
                       are within one shard.

balanceStatus          Check the balance status of the data grid for the
                       ObjectGrid and map set specified.

clearGrid              Clears data from the data grid.

dismissLink            Disconnects from the specified catalog service domain.

establishLink          Connects to the specified catalog service domain with
                       the specified catalog service endpoints.

findByKey              Finds matching keys in a map.

getCatTraceSpec        Retrieves the trace specification for all the catalog
                       servers that are known by this process.

getStatsSpec           Retrieves the statistics specification.

getTraceSpec           Retrieves the trace specification.

listAllJMXAddresses    Displays all JMX MBean server addresses.

listCoreGroups         List all core groups.

listHosts              Lists all hosts.

listObjectGridNames    Lists all known ObjectGrid instances and map sets.

listProfiles           Lists profiles.

osgiAll                Show all available OSGi service rankings. Use the -sn
                       option to display a single service.

osgiCheck              Check whether specified OSGi service rankings are
                       available

osgiCurrent            Show all OSGi service rankings currently in use. 用途
                       the -sn option to display a single service.

osgiUpdate             Update the OSGi services to the specified rankings

overrideQuorum         Notify the catalog server to override quorum.

placementServiceStatus Displays the ObjectGrid placement operation status.

releaseShard           Releases the specified primary shard from the
                       specified container server.

removeProfile          Remove profile from file system.

reserveShard           Reserves the specified primary shard on the specified
                       container server.

resumeBalancing        Attempts to balance and allow future balancing
                       attempts for the specified ObjectGrid instance and map
                       set.

revisions              Displays all known revision history.

routetable             Displays the current routing table.

setCatTraceSpec        Sets the trace specification for all the catalog
                       servers known by this process.

setStatsSpec           Sets the statistics specification.

setTraceSpec           Trace specification in the form:
                       traceType1=traceLevel1=traceState1[:traceTypeN=traceLev
                       elN=traceStateN]*

showCoreGroupMembers   Shows all core group members.

showInfo               Retrieves the environment specifications including
                       installed versions and JVM information.

showLinkedPrimaries    Displays the primary shards and all of their foreign
                       or domestic linked primary shards

showMapSizes           Displays all map sizes.

showPlacement          Lists all container servers and their shards.

showProfile            Show the details of the specified profile.

showQuorumStatus       Displays catalog server quorum status.

suspendBalancing       Prevents future attempts to balance the specified
                       ObjectGrid instance and map set.

swapShardWithPrimary   Swaps the specified replica shard for the specified
                       container server with its primary shard.

teardown               Stops a list of catalog and container servers.

triggerPlacement       Triggers a placement operation for the specified
                       ObjectGrid instance and map set. The
                       numInitialContainers value is ignored.
Command Name           Description
------------           -----------
balanceShardTypes      Attempt shard redistribution so that the ratio of
                       primaries/replicas within each container are to within
                       one shard.

balanceStatus          Check the balance status of the grid for the ObjectGrid
                       and MapSet specified

clearGrid              Clears data from the data grid.

dismissLink            Disconnects from the specified catalog service domain.

establishLink          Connects to the specified catalog service domain with
                       the specified catalog service endpoints.

getCatTraceSpec        Retrieves the trace specification for all the catalog
                       servers that are known by this process.

getStatsSpec           Retrieves the statistics specification.

getTraceSpec           Retrieves the trace specification.

listAllJMXAddresses    Displays all JMX MBean server addresses.

listCoreGroups         List all core groups.

listHosts              Lists all hosts.

listObjectGridNames    Lists all known ObjectGrid instances and map sets.

listProfiles           Lists profiles.

osgiAll                Show all available OSGi service rankings. Use the -sn
                       option to display a single service.

osgiCheck              Check whether specified OSGi service rankings are
                       available

osgiCurrent            Show all OSGi service rankings currently in use. Use the
                       -sn option to display a single service.

osgiUpdate             Update the OSGi services to the the specified rankings

overrideQuorum         Notify the catalog server to override quorum.

placementServiceStatus Displays the ObjectGrid placement operation status.

releaseShard           Releases the specified primary shard from the specified
                       container server.

removeProfile          Remove profile from file system.

reserveShard           Reserves the specified primary shard on the specified
                       container server.

resumeBalancing        Attempts to balance and allow future balancing attempts
                       for the specified ObjectGrid instance and map set.

revisions              Displays all known revision history.

routetable             Displays the current routing table.

setCatTraceSpec        Sets the trace specification for all the catalog servers
                       known by this process.

setStatsSpec           Sets the statistics specification.

setTraceSpec           Trace specification in the form:
                       traceType1=traceLevel1=traceState1[:traceTypeN=traceLevelN=traceStateN]*

showCoreGroupMembers   Shows all core group members.

showLinkedPrimaries    Displays the primary shards and all of their foreign or
                       domestic linked primary shards

showMapSizes           Displays all map sizes.

showPlacement          Lists all container servers and their shards.

showProfile            show the details of the specified profile.

showQuorumStatus       Displays catalog server quorum status.

suspendBalancing       Prevents future attempts to balance the specified
                       ObjectGrid instance and map set.

swapShardWithPrimary   Swaps the specified replica shard for the specified
                       container server with its primary shard.

teardown               Stops a list of catalog and container servers.

triggerPlacement       Triggers a placement operation for the specified
                       ObjectGrid instance and map set. The
                       numInitialContainers value is ignored.