Control-M/Server System Settings Configuration

The following API commands enable you to configure Control-M/Server system parameters and system settings:

config server:params::get (deprecated)

The config server:params::get command enables you to get a list of parameters of a Control-M/Server. The following fields are returned:

  • name

  • value

  • defaultValue

Deprecated as of version 9.0.21.100. Replaced by config systemsettings:server::get.

  • CLI

  • REST

ctm config server:params::get <server>

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

Copy 
server=controlm
AuthHeader="x-api-key: $token"
# AuthHeader="Authorization: Bearer $token"  #for a session token

curl -H "$AuthHeader" "$endpoint/config/server/$server/params"

To determine the correct AuthHeader value—"Authorization: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.

where server defines the Control-M/Server name.

config systemsettings:server::get

The config systemsettings:server::get command enables you to get a list of server-related system settings for a particular Control-M/Server. The following fields are returned for each parameter:

  • name

  • value

  • defaultValue

For more information about this group of settings, see Configuring Control-M/Server System Parameters.

  • CLI

  • REST

ctm config systemsettings:server::get [<server>]

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

Copy 
serverName=controlm
AuthHeader="x-api-key: $token"
# AuthHeader="Authorization: Bearer $token"  #for a session token

curl -H "$AuthHeader" $endpoint/config/systemsettings/server?server=$serverName

To determine the correct AuthHeader value—"Authorization: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.

where server defines the Control-M/Server name.

config systemsettings:server::set

The config systemsettings:server::set command enables you to set a value for a Server-related system setting on a particular Control-M/Server.

For lists of settings that you can set, see Configuring Control-M/Server System Parameters.

After you set new values for system settings, ensure that the new values are applied by using the config systemsettings:server::refresh command to refresh the Control-M/Server.

  • CLI

  • REST

ctm config systemsettings:server::set <name> <value> [<server>]

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

Copy 
serverName=controlm
name="CYCLIC_RERUN"
value="OK"
AuthHeader="x-api-key: $token"
# AuthHeader="Authorization: Bearer $token"  #for a session token

curl -H "$AuthHeader" -X POST $endpoint/config/systemsettings/server/$name/$value/set?server=$serverName

To determine the correct AuthHeader value—"Authorization: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.

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

Parameter

Description

name

Defines the name of the parameter in the server-related system settings.

For lists of settings that you can set, see Configuring Control-M/Server System Parameters.

value

Defines a value to assign to the parameter.

server

Defines the name of the Control-M/Server.

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

config systemsettings:server::refresh

The config systemsettings:server::refresh command enables you to refresh the Control-M/Server after you set new values for system settings, so that the new values are applied.

  • CLI

  • REST

ctm config systemsettings:server::refresh <server>

The following example shows the REST API syntax for the config systemsettings:server::refresh command in cURL:

Copy 
serverName=controlm
AuthHeader="x-api-key: $token"
# AuthHeader="Authorization: Bearer $token"  #for a session token

curl -H "$AuthHeader" -X POST "$endpoint/config/systemsettings/server/$serverName/refresh"

To determine the correct AuthHeader value—"Authorization: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.

where server defines the Control-M/Server name.

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