With the xscmd utility,
you can complete administrative tasks in the environment.
Before you begin
You must have a client installation.
- The appliance must be started.
- You must have the IP address and
port number for an active catalog server. In the user interface, click . Select a collective member. The IP and port number
for the catalog server is displayed.
- Verify that the JAVA_HOME environment
variable is set to use the runtime environment that installed with
the product. If you are using the trial version of the product, you
must set the JAVA_HOME environment variable.
Procedure
- If you are
running the xscmd utility from a client installation: Download
the active truststore for the appliance to the client. From
the appliance user interface, click . The
default truststore file is the xsatruststore.jks file.
The default password for this file is: xc10pass.
- Optional: If client authentication
is enabled: On the client installation, open a command-line window. On the command
line, set appropriate environment variables.
- Connect the xscmd utility
to the appliance.
From the
bin directory
in the client installation, run the following command:
xscmd.bat|sh -ts xsatruststore.jks -tst jks -tsp xc10pass -user xcadmin -pwd xcadmin
-cep myxc10.mycompany.com -prot TLS -cxpv IBMJSSE2 -tt TCP/IP [additional parameters]
- Display help for the various xscmd options.
- To display the general help, run the following command:
./xscmd.sh -h
xscmd.bat -h
- To display a list of all of the commands, run the following
command:
./xscmd.sh -lc
xscmd.bat -lc
- To display the help for a specific command, run the following
command:
./xscmd.sh -h command_name
xscmd.bat -h command_name
- To display a list of the command groups, run the following
command:
./xscmd.sh -lcg
xscmd.bat -lcg
- To display a list of the commands within a command group,
run the following command:
./xscmd.sh -lc command_group_name
xscmd.bat -lc command_group_name
- Run commands that connect to specific catalog servers. You
must provide one or more catalog server IP address and port combinations
to retrieve information about the data grids that are running on the
appliance.
- Provide a list of catalog
servers to connect:
./xscmd.sh -c <command_name>
-cep hostname:port(,hostname:port)
xscmd.bat -c <command_name>
-cep hostname:port(,hostname:port)
In the previous commands, command_name is
the name of the command that you are running. The hostname:port value
is the catalog server host name and listener port.
CAUTION:
Do not use the following commands in a
WebSphere® DataPower® XC10 Appliance environment:
- -c releaseShard
- -c reserveShard
- -c swapShardWithPrimary
- -c suspendBalancing
- -c resumeBalancing
- -c teardown
- -c triggerPlacement