10.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 10.1. tpm Core Options

OptionDescription
--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
--profileSets name of config file
--quiet, -qOnly display warning and error messages
--verbose, -vDisplay debug, info, notice, warning and error messages

--force

Forces the deployment process to complete even if there are warning or error messages that would normally cause the process to fail. Forcing the installation also ignores all confirmation prompts during installation and always attempts to complete the process.

--help

Displays the help message for tpm showing the current options, commands and version information.

--info

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 --verbose.

--notice

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.

--preview

Displays the help message and preview the effect of the command line options.

--profile

Specify the name of the configuration file to be used, e.g. tpm profile /tmp/config.sh. 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.

--quiet

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.

--verbose

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 all operations from installation to updates and upgrades, and also provides a number of useful post-installation commands that can be used to simplify common administration operations.

The installation process starts in a staging directory. This is different from the installation directory where Tungsten Cluster 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.2, “Staging Host Configuration” for instructions on selecting a staging directory.

Table 10.2. tpm Commands

OptionDescription
askAsk tpm to provide values from the common configuration
configureConfigure a data service within the global configuration
connectorOpen a connection to the configured connector using mysql
copyAutomates the act of copying the shared SSL keys generated during installation to other cluster nodes as part of the post-installation workflow.
delete-serviceDelete a replication service or a composite datasource
diagObtain diagnostic information
fetchFetch configuration information from a running service
find-seqnoAssists with locating event information in the THL and producing a dsctl set command as output.
firewallDisplay firewall information for the configured services
generate-haproxy-for-apiGenerates a correctly formatted haproxy configuration block for use with Tungsten Dashboard v1
helpShow command help information
installInstall a data service based on the existing and runtime parameters
mysqlOpen a connection to the configured MySQL server
policyDisplay and optionally set the cluster policy.
post-processReset the THL for a host
promote-connectorRestart the connectors in the active configuration
purge-thlReset the THL for a host
queryQuery the active configuration for information
reportGenerate a security report for all available communication channels on a per-node basis
reverseShow you the commands required to rebuild the configuration for the current directory.
uninstallUninstall software from host(s)
updateUpdate an existing configuration or software version
validateValidate the current configuration
validate-updateValidate the current configuration and update