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.

Usage

tpm command [sub command] [tpm options] [command options]

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

Option	Description
--force Aliases: -f	Do not display confirmation prompts or stop the configure process for errors.
--help Aliases: -h	Displays the help message
--info Aliases: -i	Display info, notice, warning and error messages
--notice Aliases: -n	Display notice, warning and error messages
--preview Aliases: -p	Displays the help message and preview the effect of the command line options
--profile	Sets name of config file
--quiet Aliases: -q	Only display warning and error messages
--verbose Aliases: -v	Display debug, info, notice, warning and error messages

--force

Aliases	-f

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

Aliases	-h

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

--info

Aliases	-i

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

Aliases	-n

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

Aliases	-p

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

Aliases	-q

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

Aliases	-v

Displays a much more detailed output of the status and progress of the deployment. In verbose mode, tpmannotates 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 will ultimately be placed but may be a sub-directory. In most cases we will install to /opt/continuent and use /opt/continuent/software as a staging directory. The release package should be unpacked in the staging directory before proceeding.

See the Section "Directory Locations and Configuration" for instructions on selecting a staging directory.

The following tpm commands are available:

Option	Description	Version	Product
ask	Ask tpm to provide values from the common configuration.	7.0.0	CTTR
cert	Provides a wide variety of security administration tools.	7.1.0	CTTR
check	Check and validate various installation options.	7.1.3	CTTR
configure	Configure a data service within the global configuration.		CTTR
connector	Open a connection to the mysql database via the configured connector.		CT
copy	Automates the act of copying the shared SSL keys generated during installation to other cluster nodes as part of the post-installation workflow.	7.0.3	CT
delete-service	Delete a replication service or a composite datasource.	7.0.0	CTTR
diag	Obtain diagnostic information.		CTTR
fetch	Fetch configuration information from a running service.		CTTR
find-seqno	Assists with locating event information in the THL and producing adsctl set command as output.		CTTR
firewall	Display firewall information for the configured services.		CTTR
generate-haproxy-for-api	Generates a correctly formatted haproxy configuration block for use with Tungsten Dashboard v1.	6.1.8	CT
help	Show command help information.		CTTR
ini	Automates the creation of ini files from templates and also checks validity of existing ini files.	7.2.0	CT
install	Install a data service based on the existing and runtime parameters.		CTTR
keep	Designed to streamline saving the current Tungsten Replicator position for each service in a variety of formats.	7.1.0	CT
mysql	Open a connection to the local MySQL server.		CTTR
policy	Display and optionally set the cluster policy.	6.1.20	CT
ports	Display all needed network ports.	7.1.0	CTTR
post-process	Assists with the graceful maintenance of the static cross-site replicator configuration files on disk	7.0.0	CT
promote-connector	Restart the connectors in the active configuration.		CTTR
purge-thl	Reset the THL for a host.	7.0.0	CTTR
query	Query the active configuration for information.		CTTR
report	Generate a security report for all available communication channels on a per-node basis.	7.0.1	CTTR
reverse	Show you the commands required to rebuild the configuration for the current directory.		CTTR
uninstall	Uninstall software from host(s)		CTTR
update	Update an existing configuration or software version.		CTTR
validate	Validate the current configuration.		CTTR
validate-update	Validate the current configuration from the perspective of an update.		CTTR