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 Server.

CLI Syntax

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

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

Parameter

Description

server

Defines the Server name.

agentlesshost

Defines the hostname or alias of the Agentless Host.

port

(Optional) Defines the SSH port number.

Default: 22

configuration file

(Optional) Defines a JSON file with additional parameters.

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.

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 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 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..

converExistingAgent

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

Valid Values:

  • true

  • false

Default: false

REST API Syntax

cURL:

Copy 
server=IN01
agentlesshost=myhost
agent=realAgent

curl -H "x-api-key: $token" -H "Content-Type: application/json" -X GET
"%endpoint%/config/server/$server/agentlesshost"

config server:agentlesshost:authorize::authorize

The config server:agentlesshost:authorize::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 Server.

CLI Syntax

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

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

Parameter

Description

server

Defines the Server name.

agentlesshost

Defines the hostname or alias of the Agentless Host.

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

cURL:

Copy 
server=IN01
agentlesshost=myhost

curl -H "x-api-key: $token" -H "Content-Type: application/json" -X GET
"%endpoint%/config/server/$server/agentlesshost/$agentlesshost/authorize"

config server:agentlesshost::delete

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

CLI Syntax

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

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

Parameter

Description

server

Defines the Server name.

agentlesshost

Defines the hostname or alias of the Agentless Host.

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

cURL:

Copy 
server=IN01
agentlesshost=myhost

curl -H "x-api-key: $token" -H "Content-Type: application/json" -X DELETE
"%endpoint%/config/server/$server/agentlesshost/$agentlesshost"

config server:agentlesshosts::get

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

CLI Syntax

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

Where server defines the Server name.

REST API Syntax

cURL:

Copy 
server=IN01
agentlesshosts=myhost

curl -H "x-api-key: $token" -H "Content-Type: application/json" -X GET
"%endpoint%/config/server/$server/agentlesshosts"

config server:agentlesshost::get

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

CLI Syntax

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

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

Parameter

Description

server

Defines the Server name.

agentlesshost

Defines the hostname or alias of the Agentless Host.

REST API Syntax

cURL:

Copy 
server=IN01
agentlesshost=myhost

curl -H "x-api-key: $token" -H "Content-Type: application/json" -X GET
"%endpoint%/config/server/$server/agentlesshost/$agentlesshost"

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 Server.

CLI Syntax

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

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

Parameter

Description

server

Defines the 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 JSON file with 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 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..

REST API Syntax

cURL:

Copy 
server=IN01
agentlesshost=myhost
agent=realAgent

curl -H "x-api-key: $token" -H "Content-Type: application/json" -X POST
"%endpoint%/config/server/$server/agentlesshost/$agentlesshost/update"

config server:agentlesshost:test::test

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

CLI Syntax

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

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

Parameter

Description

server

Defines the Server name.

agentlesshost

Defines the hostname or alias of the Agentless Host.

configuration file

(Optional) Defines a JSON file with additional parameters.

The following table describes additional config server:agentlesshost:test::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 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..

REST API Syntax

cURL:

Copy 
server=IN01
agentlesshost=myhost
agent=realAgent

curl -H "x-api-key: $token" -H "Content-Type: application/json" -X POST
"%endpoint%/config/server/$server/agentlesshost/$agentlesshost/test"

config server:agentlesshost:disable::disable

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

CLI Syntax

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

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

Parameter

Description

server

Defines the Server name.

agentlesshost

Defines the hostname or alias of the Agentless Host.

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

cURL:

Copy 
server=IN01
agentlesshost=myhost
agent=realAgent

curl -H "x-api-key: $token" -H "Content-Type: application/json" -X POST
"%endpoint%/config/server/$server/agentlesshost/$agentlesshost/disable"

config server:agentlesshost:enable::enable

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

CLI Syntax

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

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

Parameter

Description

server

Defines the Server name.

agentlesshost

Defines the hostname or alias of the Agentless Host.

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

cURL:

Copy 
server=IN01
agentlesshost=myhost
agent=realAgent

curl -H "x-api-key: $token" -H "Content-Type: application/json" -X POST
"%endpoint%/config/server/$server/agentlesshost/$agentlesshost/enable"

config server:agentlesshost:ping::ping

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

CLI Syntax

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

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

Parameter

Description

server

Defines the Server name.

agentlesshost

Defines the hostname or alias of the Agentless Host.

configuration file

(Optional) Defines a JSON file with additional parameters.

REST API Syntax

cURL:

Copy 
server=IN01
agentlesshost=myhost
agent=realAgent

curl -H "x-api-key: $token" -H "Content-Type: application/json" -X POST
"%endpoint%/config/server/$server/agentlesshost/$agentlesshost/ping"