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.
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
|Do not display confirmation prompts or stop the configure process for errors|
|Displays help message|
|Display info, notice, warning and error messages|
|Display notice, warning and error messages|
|Displays the help message and preview the effect of the command line options|
|Sets name of config file|
|Only display warning and error messages|
|Display debug, info, notice, warning and error messages|
Forces the deployment process to complete even if there are warning or error messages that would normally cause the process the to fail. Forcing the installation also ignores all confirmation prompts during installation and always attempts to complete the process.
Displays the help message for tpm showing the current options, commands and version information.
Changes the reporting level to include information, notice,
warning and error messages. Information level messages include
annotations of the current process and stage in the deployment,
such as configuration or generating files and configurations.
This shows slightly more information than the default, but less
than the full debug level offered by
Sets the output level to include notice, warning, and error messages. Notice level messages include information about further steps or actions that should be taken, or things that should be noted without indicating a failure or error with the configuration options select.
Specify the name of the configuration file to be used. This can be useful if you are performing multiple configurations or deployments from the same staging directory. The entire configuration and deployment information is stored in the file before installation is started. By specifying a different file you can have multiple deployments and configurations without requiring separate staging directories.
Changes the error reporting level so that only warning and error messages are displayed. This mode can be useful in automated deployments as it provides output only when a warning or error exists. All other messages, including informational ones, are suppressed.
Displays a much more detailed output of the status and progress of the deployment. In verbose mode, tpm annotates the entire process describing both what it is doing and all debug, warning and other messages in the output.
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:
--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
--connectors arguments should be used
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
|configure||Configure a data service within the global configuration|
|connector||Open a connection to the configured connector using mysql|
|diag||Obtain diagnostic information|
|fetch||Fetch configuration information from a running service|
|firewall||Display firewall information for the configured services|
|help||Show command help information|
|install||Install a data service based on the existing and runtime parameters|
|mysql||Open a connection to the configured MySQL server|
|promote||Make a previously configured and prepared directory and make it the active|
|promote-connector||Restart the connectors in the active configuration|
|query||Query the active configuration for information|
|reset||Reset the cluster on each host|
|reset-thl||Reset the THL for a host|
|restart||Restart the services on specified or added hosts|
|ssh-copy-cert||Executes the commands required to generate authorized SSH certificate and keys required for tpm|
|start||Start services on specified or added hosts|
|stop||Stop services on specified or added hosts|
|upgrade, update||Update an existing configuration or software version|
|validate||Validate the current configuration|
|validate-update||Validate the current configuration and update|