With the xscmd utility,
you can complete administrative tasks in the environment such as: establishing multi-master replication
links, overriding quorum, and stopping groups of servers with the
teardown command.
Before you begin
- Your catalog servers and container servers must be started. If
your catalog servers are in a catalog service domain, at least two
catalog servers must be started.
- 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.
About this task
The xscmd utility
replaces the xsadmin sample utility as a fully
supported monitoring and administration tool. You could complete similar
operations with the xsadmin tool, but this tool
is not supported. The xsadmin sample provides a
method for parsing and discovering current deployment data, and can
be used as a foundation for writing custom utilities. If you were
previously using the xsadmin tool for monitoring
and administration, consider updating your scripts to use the xscmd utility.
For information about mapping xsadmin commands
to the new xscmd commands, see xsadmin tool to xscmd tool migration.
Procedure
- Optional: If client authentication
is enabled: Open a command-line window. On the command
line, set appropriate environment variables.
- Go to the wxs_home/bin directory.
cd wxs_home/bin
- 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. By default, xscmd connects
to the catalog server on the local host, using the host name and port
of localhost:2809. You can also provide a list
of host names and ports to the command so that you can connect to
catalog servers on other hosts. From the list, the xscmd utility
connects to a random host. The list of hosts that you provide must
be within the same catalog service domain.