Agent System Settings Configuration

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

config server:agent:params::get

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

  • REST

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

The following example shows the REST API syntax for the config server:agent:params::get command in cURL:

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

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

Parameter

Description

server

Defines the Control-M/Server name.

agent

Defines the Agent hostname or alias. This is the logical name of the Agent.

config server:agent:param::set

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

  • CLI

  • REST

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

The following example shows the REST API syntax for the config server:agent:param::set command in cURL:

Copy 
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"

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

Parameter

Description

server

Defines the Control-M/Server name.

agent

Defines the Agent hostname or alias. This is the logical name of the Agent.

name

Name of parameter.

value

Value of parameter.

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.