Agent System Settings Configuration

The following API commands enable you to configure Agent system parameters and system settings:

• config server:agent:params::get

• config server:agent:param::set

config server:agent:params::getLink copied to clipboard

The config server:agent:params::get command enables you to get a list of parameters for an Agent registered to a Control-M/Server. The command returns a list of Agent-related system parameters. Each entry is a pair that consists of a parameter name and value.

CLI Syntax

ctm config server:agent:params::get <server> <agent>

The following table describes the config server:agent:params::get command parameters.

REST API Syntax

server=IN01
agent=host
curl -H "x-api-key: $token" "$endpoint/config/server/$server/agent/$agent/params"

config server:agent:param::setLink copied to clipboard

The config server:agent:param::set command enables you to set the value of a specific Agent parameter.

CLI Syntax

ctm config server:agent:param::set <server> <agent> <name> <value>

The following table describes the config server:agent:params::set command parameters.

If annotation is enabled for the Configuration Management category in the Configuration domain, you must also provide an annotation to justify your action. For more information, see Annotation Input.

REST API Syntax

server=IN01
agent=quickstart
name=LIMIT_LOG_VERSIONS
value=10
curl -H "x-api-key: $token" -H "Content-Type: application/json" -X POST -d "{\"value\":\"$value\"}" "$endpoint/config/server/$server/agent/$agent/param/$name"