Server Configuration

The following API commands enable you to configure a Server:

config servers::get

The config servers::get command enables you to get a list of Server.

CLI Syntax

Copy 
ctm config servers::get

REST API Syntax

The following example describes the REST API syntax in cURL:

Copy 
curl -H "x-api-key: $token" "$endpoint/config/servers"

Response

The following example shows the config servers::get response parameters when the operational state of the Server up and connected.

Copy 
{
   "name": "IN01",
   "host": "myhost",
   "state": "Up",
   "message": "Connected",
   "version": "9.0.21.080"
}

The following table describes the config servers::get command parameters that are shown in the above response.

Parameter

Description

name

Defines the name of the Server, which enables you to assign it a descriptive name.

host

Defines the Server hostname.

state

Determines the state of the Server.

Valid Values:

  • Up

  • Down

message

Describes the server status message.

Valid Values:

  • Connected

  • Disconnected

  • An error message.

  • "": No message to display.

version

Defines the Server version.

config server:notification:list::setactive

The config server:notification:list::setactive command enables you to activate a notification destination list.

CLI Syntax

Copy 
ctm config server:notification:list::setactive <server> <listname>

The following table describes the config server:notification:list::setactive command parameters.

Parameter

Description

server

Defines the name of the Server, which enables you to assign it a descriptive name.

listname

Defines the name of the notification destination list to activate.

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

REST API Syntax

The following example describes the REST API syntax in cURL:

Copy 
server=IN01
listname=myList
curl -X POST -H "x-api-key: $token" "$endpoint/config/server/$server/notification/list/$listname/setactive"