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 Syntax

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

Where server is the name of the Control-M/Server.

REST API Syntax

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"

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 Control-M/Server parameters.

CLI Syntax

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

Where server defines the name of the Control-M/Server.

REST API Syntax

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.

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 Control-M/Server parameters.

CLI Syntax

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

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 Control-M/Server parameters.

value

Defines a value to assign to the parameter.

server

Defines the name of the Control-M/Server.

REST API Syntax

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.