tc Runtime and Group Control Commands: Reference

This section documents the tcsadmin commands that you use to control tc Runtime instances and groups. See also General Syntax of the tcsadmin Command-Line Interface.

Each section describes the command, provides the list of available options, and provides usage examples.

Note

Every time you run the tcsadmin script, provide connection parameters that specify the HQ Server to which the script connects. Specify these connection parameters at the command-line or in a user.home/.hq/client.properties file, where user.home refers to your home directory. In this section of the documentation, it is assumed that you have created a client.properties file, so that examples are not cluttered with the same connection parameters and are thus easier to read. See Connection Parameters for detailed information about specifying the connection parameters at the command-line or in a file.

start

Start a tc Runtime instance or all the members of a tc Runtime group.

Exit codes: Returns 0 if completely successful. If you execute the command against a single tc Runtime instance, the command returns an exit code of 1 if it failed to start the server. If you execute the command against a group of tc Runtime instances, the command returns 1 for a general blanket failure. If the command fails for some tc Runtime group members but succeeds for others, it returns an exit code of the number of failures and outputs to stdout one line for each failure, along with the reason.

Table 29. Options of the start Command

OptionDescriptionRequired?
--servernameName of the tc Runtime instance that you want to start.

Use list-servers to get the names of the tc Runtime instances in the HQ inventory.

When starting a single tc Runtime instance, specify --servername or --serverid, but not both.
--serveridID of the tc Runtime instance that you want to start.

Use list-servers to get the IDs of the tc Runtime instances in the HQ inventory.

When starting a single tc Runtime instance, specify --servername or --serverid, but not both.
--groupnameName of the tc Runtime group that you want to start. When you specify a tc Runtime group for this command, all its members are started.

Use list-groups to get the names and IDs of the tc Runtime groups in the HQ inventory.

When starting the servers in a tc Runtime group, specify --groupname or --groupid, but not both.
--groupidID of the tc Runtime group that you want to start. When you specify a tc Runtime group for this command, all its members are started.

Use list-groups to get the names and IDs of the tc Runtime groups in the HQ inventory.

When starting the servers in a tc Runtime group, specify --groupname or --groupid, but not both.

The example starts the tc Runtime instance named example_server.

prompt$ ./tcsadmin start --servername="example_server" 

stop

Stop a tc Runtime instance or all the members of a tc Runtime group.

Exit codes: Returns 0 if completely successful. If you execute the command against a single tc Runtime instance, the command returns an exit code of 1 if it failed to start the server. If you execute the command against a group of tc Runtime instances, the command returns 1 for a general blanket failure. If the command fails for some tc Runtime group members but succeeds for others, it returns an exit code of the number of failures and outputs to stdout one line for each failure, along with the reason.

Table 30. Options of the stop Command

OptionDescriptionRequired?
--servernameName of the tc Runtime instance that you want to stop.

Use list-servers to get the names of the tc Runtime instances in the HQ inventory.

When stopping a single tc Runtime instance, specify --servername or --serverid, but not both.
--serveridID of the tc Runtime instance that you want to stop.

Use list-servers to get the IDs of the tc Runtime instances in the HQ inventory.

When stopping a single tc Runtime instance, specify--servername or --serverid, but not both.
--groupnameName of the tc Runtime group that you want to stop. When you specify a tc Runtime group for this command, all its members are stopped.

Use list-groups to get the names and IDs of the tc Runtime groups in the HQ inventory.

When stopping the servers in a tc Runtime group, specify --groupname or --groupid, but not both.
--groupidID of the tc Runtime group that you want to stop. When you specify a tc Runtime group for this command, all its members are stopped.

Use list-groups to get the names and IDs of the tc Runtime groups in the HQ inventory.

When stopping the servers in a tc Runtime group, specify--groupname or --groupid, but not both.

The following example shows how to stop the tc Runtime instance named example_server.

prompt$ ./tcsadmin stop --servername="example_server" 

restart

Restart a tc Runtime instance or all the members of a tc Runtime group.

A restart is a shorthand way of stopping and starting the server or group.

Exit codes: Returns 0 if completely successful. If you execute the command against a single tc Runtime instance, the command returns an exit code of 1 if it failed to start the server. If you execute the command against a group of tc Runtime instances, the command returns 1 for a general blanket failure. If the command fails for some tc Runtime group members but succeeds for others, it returns an exit code of the number of failures and outputs to stdout one line for each failure, along with the reason.

The following table lists the options you can specify with this command.

Table 31. Options of the restart Command

OptionDescriptionRequired?
--servernameName of the tc Runtime instance that you want to restart.

Use list-servers to get the names of the tc Runtime instances in the HQ inventory.

When restarting a single tc Runtime instance, specify --servername or --serverid, but not both.
--serveridID of the tc Runtime instance that you want to restart.

Use list-servers to get the IDs of the tc Runtime instances in the HQ inventory.

When restarting a single tc Runtime instance, specify --servername or --serverid, but not both.
--groupnameName of the tc Runtime group that you want to restart. When you specify a tc Runtime group for this command, all its members are restarted.

Use list-groups to get the names and IDs of the tc Runtime groups in the HQ inventory.

When restarting the servers in a tc Runtime group, specify --groupname or --groupid, but not both.
--groupidID of the tc Runtime group that you want to restart. When you specify a tc Runtime group for this command, all its members are restarted.

Use list-groups to get the names and IDs of the tc Runtime groups in the HQ inventory.

When restarting the servers in a tc Runtime group, specify --groupname or --groupid, but not both.

The example shows how to restart the tc Runtime instance named example_server:

prompt$ ./tcsadmin restart --servername="example_server"