Kwdistadmin
The kwdistadmin command manages sessions on the Distributed Analysis Server, stops the Distributed Analysis Server and agents, and retrieves agent statistics from the Distributed Analysis Server. kwdistadmin is run on the Distributed Analysis Server Host (where kwdist runs).
kwdistadmin is installed as part of the Distributed Analysis package.
kwdistadmin usage
kwdistadmin <options> [<subcommand>]
where:
- <options> are any of the options from the list below
- <subcommand> is one of the kwdistadmin subcommands, explained in subsequent topics. The --help and --version options do not require a subcommand.
Example
kwdistadmin --host serverXYZ.acme.com list-agents
Common options
Name | Short name | Description |
---|---|---|
--help | display this help | |
--version | display version information | |
--verbose | -v | print verbose information about program execution, which can help to troubleshoot errors |
--host <host> | -h | specify the host name of the machine where the Distributed Analysis Server (kwdist) is running. Default: localhost |
--port <port> | -p | specify the port number on which the Distributed Analysis Server (kwdist) is running. Default: 3440 |
kwdistadmin list-agents
kwdistadmin list-agents is used to print a list of Distributed Analysis agents. A full list of agents with their IDs is printed. Agent IDs are required for kwdistadmin stop-agent.
Example
kwdistadmin --host serverXYZ.acme.com list-agents
Options
See Common options.
kwdistadmin stat
kwdistadmin stat is used to print statistics on total compilation time for all requests processed by each agent.
Example
kwdistadmin --host serverXYZ.acme.com stat
Options
See Common options.
kwdistadmin result
kwdistadmin result is used to print compilation results for all sessions: status, number of total requests, number of requests processed successfully, number of failed requests, number of requests to be processed, and compilation errors. The command outputs a list of session IDs. Session IDs are integers, starting at 1.
Example
kwdistadmin --host serverXYZ.acme.com result
Options
See Common options.
kwdistadmin stop-agent
kwdistadmin stop-agent is used to stop a specific agent on a remote machine. The agent ID can be retrieved with kwdistadmin list-agents. It is not necessary to specify host and port information, because the Distributed Analysis Server stores this information for each agent ID. Note that an agent can only be stopped by the user who started it.
kwdistadmin stop-agent <ID>
where:
- <ID> is one of the Analysis Agent IDs returned by the kwdistadmin list-agents command
Example
kwdistadmin stop-agent 3
Options
None
kwdistadmin stop-server
kwdistadmin stop-server is used to stop the Distributed Analysis Server. Normally the Distributed Analysis Server and agents run continually. Stopping the Distributed Analysis Server also stops all agents. Use the --host and --port options if the Distributed Analysis Server is running on a non-default host and port (localhost and 3440).
Example
kwdistadmin --host serverXYZ.acme.com stop-server
Options
See Common options.