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 Syntax
ctm config server:agent:params::get <server> <agent>
The following table describes the config server:agent:params::get command parameters.
Parameter |
Description |
---|---|
server |
Name of Control-M/Server. |
agent |
Host name or alias of the Agent. This is the logical name of the Agent. |
REST API Syntax
cURL:
server=controlm
agent=host
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: Bearer $token" #for a session token
curl -H "$AuthHeader" "$endpoint/config/server/$server/agent/$agent/params"
To determine the correct AuthHeader value—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.
config server:agent:param::set
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.
Parameter |
Description |
---|---|
server |
Name of Control-M/Server. |
agent |
Host name or alias of the Agent. 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
REST API Syntax
cURL:
server=controlm
agent=quickstart
name=LIMIT_LOG_VERSIONS
value=10
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: Bearer $token" #for a session token
curl -H "$AuthHeader" -H "Content-Type: application/json" -X POST -d "{\"value\":\"$value\"}" "$endpoint/config/server/$server/agent/$agent/param/$name"
To determine the correct AuthHeader value—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.