Terracotta Ehcache 10.7 | Terracotta Server Administration Guide | Config Tool | Introduction
 
Introduction
Config tool is a command-line utility that allows administrators of the Terracotta Server Array to perform a variety of cluster management tasks. For example, the config tool can be used to:
*Activate a cluster
*Update license on a cluster
*Make configuration changes on the nodes of a cluster
*Make topology changes in the cluster
The config tool script is located in tools/bin under the product installation directory as config-tool.bat for Windows platforms, and as config-tool.sh for Unix/Linux.
The config tool has several options and commands, which we will detail below.
Please see the section Configuration Terms and Concepts, which will give you a valuable overview for better understanding what the config tool commands do, and why and when you would use them.
List of settings
Legend:
*Visibility: whether the setting change is visible at RUNTIME or after a RESTART. READ ONLY means that the setting, once defined, cannot be changed.
*Applicability: whether a setting can be changed on a particular NODE, on all nodes of a STRIPE, or on all the nodes of a CLUSTER.
*Requirement: whether a setting can be changed if ALL NODES are up or only if at least all ACTIVES (1 active per stripe) are up.
Setting Name
Visibility
Applicability
Requirement
name
READ ONLY
N/A
N/A
hostname
READ ONLY
N/A
N/A
port
READ ONLY
N/A
N/A
group-port
READ ONLY
N/A
N/A
bind-address
READ ONLY
N/A
N/A
group-bind-address
READ ONLY
N/A
N/A
stripe-name
READ ONLY
N/A
N/A
config-dir
READ ONLY
N/A
N/A
metadata-dir
READ ONLY
N/A
N/A
public-hostname
RUNTIME
NODE, STRIPE, CLUSTER
ALL NODES up
public-port
RUNTIME
NODE, STRIPE, CLUSTER
ALL NODES up
backup-dir
RUNTIME
NODE, STRIPE, CLUSTER
ALL NODES up
data-dirs
RUNTIME
NODE, STRIPE, CLUSTER
ALL NODES up
logger-overrides.<logger-name>
RUNTIME
NODE, STRIPE, CLUSTER
TARGETED NODES up
log-dir
RESTART
NODE, STRIPE, CLUSTER
TARGETED NODES up
client-reconnect-window
RUNTIME
CLUSTER
ACTIVES up
client-lease-duration
RUNTIME
CLUSTER
ACTIVES up
offheap-resources
RUNTIME
CLUSTER
ACTIVES up
license-file
RUNTIME
CLUSTER
ALL NODES up
cluster-name
RUNTIME
CLUSTER
ALL NODES up
failover-priority
RESTART
CLUSTER
ALL NODES up
security-dir
RESTART
CLUSTER
ALL NODES up
audit-log-dir
RESTART
CLUSTER
ALL NODES up
authc
RESTART
CLUSTER
ALL NODES up
ssl-tls
RESTART
CLUSTER
ALL NODES up
whitelist
RESTART
CLUSTER
ALL NODES up
Common options
1. -v (long option --verbose)
This option gives you a verbose output, and is useful to debug error conditions. Default: false
2. -srd (long option --security-root-directory)
This option can be used to communicate with a server which has TLS/SSL-based security configured. For more details on setting up security in a Terracotta cluster, see Security Core Concepts.
3. -t (long option --connection-timeout)
This option lets you specify a custom timeout value for connections to be established. Default: 10s
4. -r (long option --request-timeout)
This option lets you specify a request timeout value for operations. Default: 10s