Agentless Host Configuration

The following API commands enable you to configure an Agentless Host:

config server:agentlesshost::add

The config server:agentlesshost::add command enables you to add an Agentless Host to a Control-M/Server and convert an Agent to an Agentless Host.

  • CLI

  • REST

ctm config server:agentlesshost::add <server> <agentlesshost> [port] [-f <configuration file>]

The following example shows the REST API syntax for the config server:agentlesshost::add command in cURL:

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

curl -H "$AuthHeader" -H "Content-Type: application/json" -X GET
"%endpoint%/config/server/$server/agentlesshost"

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

The following table describes the config server:agentlesshost::add command parameters.

Parameter

Description

server

Defines the Control-M/Server name.

agentlesshost

Defines the hostname or alias of the Agentless Host.

Values can be up to 85 characters.

port

(Optional) Defines the SSH port number.

Default: 22

configuration file

(Optional) Defines a pathname to a JSON file that contains additional parameters.

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.

The following table describes additional config server:agentlesshost::add parameters that you can use in the configuration file.

Parameter

Description

agents

Defines the Agents that manage the Agentless Host. If not defined, the Agent that is installed with Control-M/Server (<Local>) is used.

Default: local

port

Default: 22

encryptAlgorithm

Determines which algorithm encrypts the data that is exchanged between the Agent and Agentless Host.

Valid Values:

  • AES

  • 3DES (Deprecated)

Default: AES

compression

Determines whether to compress the encrypted communication, which increases data rates over slower networks.

Valid Values:

  • true

  • false

Default: false

authorize

Determines whether to add the machine to the SSH Agentless Host authorization list. If you type true, you are not prompted to connect at each attempted connection.

Valid Values:

  • true

  • false

Default: true

ConnectionType

Determines the connection type between the Agent and Agentless Host.

Valid Values:

  • SSH

  • WMI

Default: SSH

WMISysoutDirectory

Defines the WMI output directory for WMI-based connections.

tag

Defines the tagClosed A logical name that is used to label specific Agents in a group that has a specific authorization level..

convertExistingAgent

(Optional) Determines whether to convert an Agent to an Agentless Host.

Valid Values:

  • true

  • false

Default: false

config server:agentlesshost::authorize

The config server:agentlesshost::authorize command enables you to add an Agentless Host to the SSH Agentless Host authorization list if this was not done when it was added to the Control-M/Server.

  • CLI

  • REST

ctm config server:agentlesshost::authorize <server> <agentlesshost>

The following example shows the REST API syntax for the config server:agentlesshost::authorize command in cURL:

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

curl -H "$AuthHeader" -H "Content-Type: application/json" -X GET
"%endpoint%/config/server/$server/agentlesshost/$agentlesshost/authorize"

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

The following table describes the config server:agentlesshost::authorize command parameters.

Parameter

Description

server

Defines the Control-M/Server name.

agentlesshost

Defines the hostname or alias of the Agentless Host.

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 server:agentlesshost::delete

The config server:agentlesshost::delete command enables you to delete an Agentless Host from the Control-M/Server.

  • CLI

  • REST

ctm config server:agentlesshost::delete <server> <agentlesshost>

The following example shows the REST API syntax for the config server:agentlesshost::delete command in cURL:

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

curl -H "$AuthHeader" -H "Content-Type: application/json" -X DELETE
"%endpoint%/config/server/$server/agentlesshost/$agentlesshost"

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

The following table describes the config server:agentlesshost::delete command parameters.

Parameter

Description

server

Defines the Control-M/Server name.

agentlesshost

Defines the hostname or alias of the Agentless Host.

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 server:agentlesshosts::get

The config server:agentlesshosts::get command enables you to get a list of all Agentless Hosts registered on the Control-M/Server.

  • CLI

  • REST

ctm config server:agentlesshosts::get <server>

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

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

curl -H "$AuthHeader" -H "Content-Type: application/json" -X GET
"%endpoint%/config/server/$server/agentlesshosts"

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

where the server parameter defines the Control-M/Server name.

config server:agentlesshost::get

The config server:agentlesshost::get command enables you to get the Agentless Host configuration properties from the Control-M/Server.

  • CLI

  • REST

ctm config server:agentlesshost::get <server> <agentlesshost>

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

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

curl -H "$AuthHeader" -H "Content-Type: application/json" -X GET
"%endpoint%/config/server/$server/agentlesshost/$agentlesshost"

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

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

Parameter

Description

server

Defines the Control-M/Server name.

agentlesshost

Defines the hostname or alias of the Agentless Host.

config server:agentlesshost::update

The config server:agentlesshost::update command enables you to update the Default Agentless Host configuration properties and the Agentless Host properties for a specific Agentless Host on the Control-M/Server

  • CLI

  • REST

ctm config server:agentlesshost::update <server> <agentlesshost> [-f <configuration file>]

The following example shows the REST API syntax for the config server:agentlesshost::update command in cURL:

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

curl -H "$AuthHeader" -H "Content-Type: application/json" -X POST
"%endpoint%/config/server/$server/agentlesshost/$agentlesshost/update"

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

The following table describes the config server:agentlesshost::update command parameters.

Parameter

Description

server

Defines the Control-M/Server name.

agentlesshost

Defines the hostname or alias of the specific Agentless Host.

To define the default Agentless Host Settings, type <Default>.

configuration file

(Optional) Defines a pathname to a JSON file that contains additional parameters.

The following table describes additional config server:agentlesshost::update parameters to use in the configuration file.

Parameter

Description

agents

Defines the Agents that manage the Agentless Host. If not defined, the Agent that is installed with Control-M/Server (<Local>) is used.

Default: local

port

Default: 22

encryptAlgorithm

Determines which algorithm encrypts the data that is exchanged between the Agent and Agentless Host.

Valid Values:

  • AES

  • 3DES (Deprecated)

Default: AES

compression

Determines whether to compress the encrypted communication, which increases data rates over slower networks.

Valid Values:

  • true

  • false

Default: false

ConnectionType

Determines the connection type between the Agent and Agentless Host.

Valid Values:

  • SSH

  • WMI

Default: SSH

WMISysoutDirectory

Defines the WMI output directory for WMI-based connections.

tag

Defines the tagClosed A logical name that is used to label specific Agents in a group that has a specific authorization level..

config server:agentlesshost::test

The config server:agentlesshost::test command enables you to test the Agentless Host on the Control-M/Server.

  • CLI

  • REST

ctm config server:agentlesshost::test <server> <agentlesshost> [-f <configuration file>]

The following example shows the REST API syntax for the config server:agentlesshost::test command in cURL:

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

curl -H "$AuthHeader" -H "Content-Type: application/json" -X POST
"%endpoint%/config/server/$server/agentlesshost/$agentlesshost/test"

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

The following table describes the config server:agentlesshost::test command parameters.

Parameter

Description

server

Defines the Control-M/Server name.

agentlesshost

Defines the hostname or alias of the Agentless Host.

configuration file

(Optional) Defines a pathname to a JSON file that contains additional parameters.

The following table describes additional config server:agentlesshost::test command parameters to use in the configuration file.

Parameter

Description

agents

Defines the Agents that manage the Agentless Host. If not defined, the Agent that is installed with Control-M/Server (<Local>) is used.

Default: local

port

Default: 22

encryptAlgorithm

Determines which algorithm encrypts the data that is exchanged between the Agent and Agentless Host.

Valid Values:

  • AES

  • 3DES (Deprecated)

Default: AES

compression

Determines whether to compress the encrypted communication, which increases data rates over slower networks.

Valid Values:

  • true

  • false

Default: false

ConnectionType

Determines the connection type between the Agent and Agentless Host.

Valid Values:

  • SSH

  • WMI

Default: SSH

WMISysoutDirectory

Defines the WMI directory for WMI-based connections.

tag

Defines the tagClosed A logical name that is used to label specific Agents in a group that has a specific authorization level..

config server:agentlesshost::disable

The config server:agentlesshost::disable command enables you to disable an Agentless Host on the Control-M/Server, which prevents new jobs from running on the Agentless Host.

  • CLI

  • REST

ctm config server:agentlesshost::disable <server> <agentlesshost>

The following example shows the REST API syntax for the config server:agentlesshost::disable command in cURL:

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

curl -H "$AuthHeader" -H "Content-Type: application/json" -X POST
"%endpoint%/config/server/$server/agentlesshost/$agentlesshost/disable"

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

The following table describes the config server:agentlesshost::disable command parameters.

Parameter

Description

server

Defines the Control-M/Server name.

agentlesshost

Defines the hostname or alias of the Agentless Host.

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 server:agentlesshost::enable

The config server:agentlesshost::enable command enables you to enable an Agentless Host on the Control-M/Server.

  • CLI

  • REST

ctm config server:agentlesshost::enable <server> <agentlesshost>

The following example shows the REST API syntax for the config server:agentlesshost::enable command in cURL:

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

curl -H "$AuthHeader" -H "Content-Type: application/json" -X POST
"%endpoint%/config/server/$server/agentlesshost/$agentlesshost/enable"

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

The following table describes the config server:agentlesshost::enable command parameters.

Parameter

Description

server

Defines the Control-M/Server name.

agentlesshost

Defines the hostname or alias of the Agentless Host.

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 server:agentlesshost::ping

The config server:agentlesshost::ping command enables you to check if the Agentless Host is available.

  • CLI

  • REST

ctm config server:agentlesshost::ping <server> <agentlesshost> [-f <configuration file>]

The following example shows the REST API syntax for the config server:agentlesshost::ping command in cURL:

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

curl -H "$AuthHeader" -H "Content-Type: application/json" -X POST
"%endpoint%/config/server/$server/agentlesshost/$agentlesshost/ping"

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

The following table describes the config server:agentlesshost::ping command parameters.

Parameter

Description

server

Defines the Control-M/Server name.

agentlesshost

Defines the hostname or alias of the Agentless Host.

configuration file

(Optional) Defines a pathname to a JSON file that contains additional parameters.

config server:remotehost::add

The config server:remotehost::add command enables you to add an Agentless Host to a Control-M/Server.

For the most up-to-date version of this API, see config server:agentlesshost::add.

  • CLI

  • REST

ctm config server:remotehost::add <server> <remotehost> [port] [-f <configuration file>]

The following example shows the REST API syntax for the config server:remotehost::add command in cURL:

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

curl -H "$AuthHeader" -H "Content-Type: application/json" -X POST
-d "{\"agents\": [ \"$agent\" ], \"compression\": true, \"encryptAlgorithm\": \"BLOWFISH\"}"
"$endpoint/config/server/$server/remotehost/$remotehost?port=22"

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

The following table describes the config server:remotehost::add command parameters.

Parameter

Description

server

Defines the name of the Control-M/Server.

remotehost

Defines the name of host or alias of the Agentless Host.

Values can be up to 85 characters.

port

(Optional) SSH port number.

Default: 22

configuration file

(Optional) Defines a JSON file pathname that contains additional parameters.

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.

The following is a list of the additional parameters that can be used in the configuration file:

Copy 
{
   "remotehost" : "xx",
   "port" : 22,
   "agents": ["<local>"],
   "encryptAlgorithm": "BLOWFISH",
   "compression": "false",
   "authorize": "true"
}

The following table describes the additional config server:remotehost::add command parameters.

Parameter

Description

agents

Defines the Agents that manage the Agentless Host. If not defined, the Agent that is installed with Control-M/Server (<Local>) is used.

Default: local

port

Default: 22

encryptAlgorithm

Determines one of the following types of encryption algorithms that encrypts the data that is sent between the Agent and Agentless Host:

  • BLOWFISH

  • AES

  • DES

  • 3DES (Deprecated)

Default: BLOWFISH

compression

Valid Values:

  • true

  • false

Default: false

authorize

Determines whether the machine is added to the SSH Agentless Host authorization list. If true, you will not be prompted to connect at each attempted connection.

Valid Values:

  • true

  • false

Default: true

config server:remotehost::authorize

The config server:remotehost::authorize command enables you to add the machine to the SSH Agentless Host authorization list (if this was not already done when the machine was added to the Control-M/Server).

For the most up-to-date version of this API, see config server:agentlesshost::authorize.

  • CLI

  • REST

ctm config server:remotehost::authorize <server> <remotehost>

The following example shows the REST API syntax for the config server:remotehost::authorize command in cURL:

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

curl -H "$AuthHeader" -H "Content-Type: application/json" -X POST
"%endpoint%/config/server/$server/remotehost/$remotehost/authorize"

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

The following table describes the config server:remotehost::authorize command parameters.

Parameter

Description

server

Name of the Control-M/Server.

remotehost

Name of host or alias of the Agentless Host.

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 server:remotehost::delete

The config server:remotehost::delete command enables you to delete a Agentless Host from the Control-M/Server.

For the most up-to-date version of this API, see config server:agentlesshost::delete.

  • CLI

  • REST

ctm config server:remotehost::delete <server> <remotehost>

The following example shows the REST API syntax for the config server:remotehost::delete command in cURL:

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

curl -H "$AuthHeader" -X DELETE "$endpoint/config/server/$server/remotehost/$remotehost"

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

The following table describes the config server:remotehost::delete command parameters.

Parameter

Description

server

Defines the Control-M/Server name.

remotehost

Defines the Agentless Host hostname or alias.

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 server:remotehosts::get

The config server:remotehosts::get command enables you to get a list of all Agentless Host registered on the Control-M/Server.

For the most up-to-date version of this API, see config server:agentlesshosts::get.

  • CLI

  • REST

ctm config server:remotehosts::get <server>

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

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

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

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

where the server parameter defines the Control-M/Server name.

config server:remotehost::get

The config server:remotehost::get command enables you to get the Agentless Host configuration properties from the Control-M/Server.

For the most up-to-date version of this API, see config server:agentlesshost::get.

  • CLI

  • REST

ctm config server:remotehost::get <server> <remotehost>

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

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

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

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

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

Parameter

Description

server

Name of the Control-M/Server.

remotehost

Name of host or alias of the Agentless Host.