tpm ini

Applies to: Tungsten Clustering for MySQL

Version availability

Available in 7.2.0 and later.

The tpm ini command automates the creation of ini files from templates and also checks validity of existing ini files

Usage

tpm ini [subcommand] [args]

Where [subcommand] is one of:

Option	Description	Version
backup	Create a backup of /etc/tungsten/tungsten.ini. File will be created in /etc/tungsten/history.	7.2.1
cat	Launch cat /etc/tungsten/tungsten.ini.
check Aliases: c	Check the INI configuration file for validity.
defaults	List any tpm option that actually has a default value defined in the tools/tpm_options_db.txt file, along with the default value.	7.2.1
diff	Compare current /etc/tungsten/tungsten.ini with the latest history file.	7.2.1
example Aliases: ex	Display example template for a topology
find Aliases: f	Locate any INI files that tpm would see.
list Aliases: l	Display all possible tpm options and aliases.
upgrade	Allow you to see what ini changes will be need for an upgrade.	7.2.1
vi Aliases: v	Launch vi /etc/tungsten/tungsten.ini

Where [args] is one of:

Option	Description	Version
--bridge Aliases: -b	The same as issuing --mode bridge
--caa	The same as issuing --topology caa
--cap	The same as issuing --topology cap
--daa	The same as issuing --topology daa
--ddg	The same as issuing --topology ddg
--mode Aliases: -m	Specify the Connector mode. Default: bridge | Valid: bridge, proxy, smartscale
--noapi	Disable the REST API (enabled by default).
--nossl	Disable security (enabled by default)
--proxy Aliases: -p	The same as issuing --mode proxy
--ro	Set the Connector to Read-Only.
--sites Aliases: --qty	Specify the number of clusters/sites.
--smart Aliases: -s	The same as issuing --mode smart
--std	The same as issuing --topology std
--topology Aliases: -top	Specify the topology. Valid: std, cap, caa, daa, ddg

Additional [args] when list is specified:

Option	Description	Version
--grep Aliases: -g	Use to filter options.
--short	Omit descriptions when listing INI options.

Additional [args] when check is specified:

Option	Description	Version
--dryrun Aliases: -n	Do not execute the commands, display only.
--extra Aliases: -x	Display additional information.
--long	Display other additional information when available.
--short	Display only broken options with no extra text. If --valid is also specified, then add tags at start of line to identify the option type (VALID/BROKEN)
--valid	Also display valid INI options at the end.

Additional [args] when upgrade is specified:

Option	Description	Version
--from	Specify the Tungsten version to check upgrading from.
--ini	Specify the ini file to check.
--to	Specify the Tungsten version to check upgrading to.
--write	Write the upgrade changes to the specified INI (default: no write)

Examples:

Check validity of existing ini file:

shell> tpm ini check

Show example ini for a Standard 3-node cluster:

shell> tpm ini example --qty 3 --topology std

Show example ini for a Composite Active/Passive cluster with SSL and API disabled:

shell> tpm ini example --qty 3 --cap --nossl --noapi

Check ini changes required when upgrading:

shell> tpm ini upgrade --ini /etc/tungsten/tungsten.ini --from 6.1.19 --to 8.0.1

note

tpm ini upgrade was introduced in v7.2.1 and v8.0.1.