10.5.14. tpm ini Command

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

tpm ini Usage

USAGE: tpm ini {subcommand} [args]

Where {subcommand} is one off:

Table 10.26. tpm ini Sub-Commands

OptionDescription
catLaunch cat /etc/tungsten/tungsten.ini
check, cCheck the INI configuration file for validity
x, e, exampleDisplay example template for a topology
list, lDisplay all possible tpm options and aliases
find, fLocate any INI files that tpm would see
upgradeAllow you to see what ini changes will be need for an upgrade
vi, vLaunch vi /etc/tungsten/tungsten.ini

Where [args] is one off:

Table 10.27. tpm ini Args

OptionDescription
--bridge, -bSame as --mode bridge
--caasame as --topology caa
--capsame as --topology cap
--daasame as --topology daa
--ddgsame as --topology ddg
--mode, -mSpecify the Connector mode, one of: bridge (default), proxy or smartscale
--noapiDisable the REST API (enabled by default)
--nosslDisable security (enabled by default)
--proxy, -pSame as --mode proxy
--roSet the Connector to Read-Only
--sites, --qtySpecify the number of clusters/sites
-s, --smartscaleSame as --mode smartscale
--stdsame as --topology std
--toplogy, --topSpecify the topology, one of: std, cap, caa, daa, ddg

Additional [args] when list is specified:

Table 10.28. tpm ini list Args

OptionDescription
-g, --grepUse to filter options
--shortOmit descriptions when listing INI options

Additional [args] when check is specified:

Table 10.29. tpm ini check Args

OptionDescription
--dryrun, -nDo not execute the commands, display only
--extra, -xDisplay additional information
--longDisplay other additional information when available
--shortDisplay 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)
--validAlso display valid INI options at the end

Additional [args] when upgrade is specified:

Table 10.30. tpm ini upgrade Args

OptionDescription
--fromSpecify the Tungsten version to check upgrading from
--iniSpecify the ini file to check
--toSpecify the Tungsten version to check upgrading to
--writeWrite 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.