CTL-SETUP Command Reference

From ControlTier

Revision as of 16:00, 22 February 2012 by Bogdan.iosif (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search



ctl-setup [-fv] -n nodename [-N hostname] [-s serverhostname] [ --key=value ]

Since CTL 1.0


The CTL-SETUP command is used to setup the CTL software after the distribution has been extracted into its installation directory.

The role of the ctl-setup command is to create a new instance of the CTL framework. CTL allows and encourages the splitting of the CTL software distribution (i.e., the executables that change from release to release), from the user specific configuration, data and module files.

During the first time installation or if the -f flag is set ctl-setup will create a new instance of the framework and generate all the configuration files found in $CTL_BASE/etc.

See also CTL-CHECK Command Reference to verify the configuration at any time.

General Options

Option alternate argument description
-h false displays the usage information presented above
-v false run verbose
-f false Force re-generation of configuration files
-n true The nodename
-N true The hostname
-key=value true default override

Key/value Options

Users can override the default values during the installation by specifying one or more -key=value combinations.

Environment variables

The following environment variables are assumed during the execution of ctl-setup:

key description
JAVA_HOME Java installation directory
CTL_HOME CTL installation directory
CTL_BASE CTL framework instance directory



ctl-setup -n adminhost

This executes the ctl-setup command defining the framework hostname as "adminhost"

ctl-setup -n user@targethost

Specifying the node name with a user@host format signifies the remote commands will be done as "user".

ctl-setup -n localhost --framework.workbench.integration.enabled=true

This executes the ctl-setup command defining the framework hostname as "localhost" and specifies Workbench configuration be set to "true".


The ctl-setup command generates a working configuration from a set of template files found in: $CTL_HOME/lib/templates/etc. Additionally, initial configuration default values are maintained in ctl-defaults.properties but these can be overwridden using --key=value flags.

See also

Personal tools