9.5. tpm Commands

All calls to tpm will follow a similar structure, made up of the command, which defines the type of operation, and one or more options.

shell> tpm command [sub command] [tpm options] [command options]

The command options will vary for each command. The core tpm options are:

Table 9.2. tpm Core Options

--force, -fDo not display confirmation prompts or stop the configure process for errors
--help, -hDisplays help message
--info, -iDisplay info, notice, warning and error messages
--notice, -nDisplay notice, warning and error messages
--preview, -pDisplays the help message and preview the effect of the command line options
--profile fileSets name of config file
--quiet, -qOnly display warning and error messages
--verbose, -vDisplay debug, info, notice, warning and error messages

The tpm utility handles operations across all hosts in the dataservice. This is true for simple and composite dataservices as well as complex multi-master replication services. The coordination requires SSH connections between the hosts according to the Appendix B, Prerequisites. There are two exceptions for this:

  1. When the --hosts argument is provided to a command; that command will only be carried out on the hosts listed. Multiple hosts may be given as a comma-separated list. The names used in the --members, --slaves, --master, --connectors arguments should be used when calling --hosts.

  2. When you are using an INI configuration file (see Section 9.4, “tpm INI File Configuration”) all calls to tpm will only affect the current host.

The installation process starts in a staging directory. This is different from the installation directory where Continuent Tungsten will ultimately be placed but may be a sub-directory. In most cases we will install to /opt/continuent but use /opt/continuent/software as a staging directory. The release package should be unpacked in the staging directory before proceeding. See the Section B.1, “Staging Host Configuration” for instructions on selecting a staging directory.

Table 9.3. tpm Commands

configureConfigure a data service within the global configuration
connectorOpen a connection to the configured connector using mysql
diagObtain diagnostic information
fetchFetch configuration information from a running service
firewallDisplay firewall information for the configured services
helpShow command help information
installInstall a data service based on the existing and runtime parameters
mysqlOpen a connection to the configured MySQL server
promoteMake a previously configured and prepared directory and make it the active
promote-connectorRestart the connectors in the active configuration
queryQuery the active configuration for information
resetReset the cluster on each host
reset-thlReset the THL for a host
restartRestart the services on specified or added hosts
ssh-copy-certExecutes the commands required to generate authorized SSH certificate and keys required for tpm
startStart services on specified or added hosts
stopStop services on specified or added hosts
upgrade, updateUpdate an existing configuration or software version
validateValidate the current configuration
validate-updateValidate the current configuration and update