Agentless Host Configuration
The following API commands enable you to configure an Agentless Host:
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 Syntax
ctm config server:remotehost::add <server> <remotehost> [port] [-f <configuration file>]
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. |
port |
(Optional) SSH port number. Default: 22 |
configuration file |
(Optional) JSON file that contains 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 is a list of the additional parameters that can be used in the configuration file:
{
"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:
Default: BLOWFISH |
compression |
Valid Values:
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:
Default: true |
REST API Syntax
cURL:
server=controlm
remotehost=myhost
agent=realAgent
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: 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—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.
config server:agentlesshost::add
The config server:agentlesshost::add command enables you to add an Agentless Host to a Control-M/Server.
CLI Syntax
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 Control-M/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 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:
Default: AES |
compression |
Determines whether to compress the encrypted communication, which increases data rates over slower networks. Valid Values:
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:
Default: true |
ConnectionType |
Determines the connection type between the Agent and Agentless Host. Valid Values:
Default: SSH |
WMISysoutDirectory |
Defines the WMI directory for WMI-based connections. |
tag |
Defines the tag |
converExistingAgent |
(Optional) Determines whether to convert an Agent to an Agentless Host. Valid Values:
Default: false |
REST API Syntax
cURL:
server=controlm
agentlesshost=myhost
agent=realAgent
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: 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—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.
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::authorize.
CLI Syntax
ctm config server:remotehost::authorize <server> <remotehost>
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 Control-M, you must also provide an annotation to justify your action. For more information, see Annotation Input.
REST API Syntax
cURL:
server=controlm
remotehost=myhost
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: 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—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.
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 Control-M/Server.
CLI Syntax
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 Control-M/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:
server=controlm
agentlesshost=myhost
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: 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—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.
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 Syntax
ctm config server:remotehost::delete <server> <remotehost>
The following table describes the config server:remotehost::delete 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 Control-M, you must also provide an annotation to justify your action. For more information, see Annotation Input.
REST API Syntax
cURL:
server=controlm
remotehost=myhost
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: Bearer $token" #for a session token
curl -H "$AuthHeader" -X DELETE "$endpoint/config/server/$server/remotehost/$remotehost"
To determine the correct AuthHeader value—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.
config server:agentlesshost::delete
The config server:agentlesshost::delete command enables you to delete an Agentless Host from the Control-M/Server.
CLI Syntax
ctm config server:agentlesshost::delete <server> <agentlesshost>
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 Control-M, you must also provide an annotation to justify your action. For more information, see Annotation Input.
REST API Syntax
cURL:
server=controlm
agentlesshost=myhost
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: 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—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.
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 Syntax
ctm config server:remotehosts::get <server>
Where server
is the name of the Control-M/Server.
REST API Syntax
cURL:
server=controlm
remotehosts=myhost
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: Bearer $token" #for a session token
curl -H "$AuthHeader" "$endpoint/config/server/$server/remotehosts"
To determine the correct AuthHeader value—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.
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 Syntax
ctm config server:agentlesshosts::get <server>
Where server
defines the Control-M/Server name.
REST API Syntax
cURL:
server=controlm
agentlesshosts=myhost
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: 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—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.
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 Syntax
ctm config server:remotehost::get <server> <remotehost>
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. |
REST API Syntax
cURL:
server=controlm
remotehost=myhost
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: Bearer $token" #for a session token
curl -H "$AuthHeader" "$endpoint/config/server/$server/remotehost/$remotehost"
To determine the correct AuthHeader value—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.
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 Syntax
ctm config server:agentlesshost::get <server> <agentlesshost>
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. |
REST API Syntax
cURL:
server=controlm
agentlesshost=myhost
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: 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—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.
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 Syntax
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 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 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 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:
Default: AES |
compression |
Determines whether to compress the encrypted communication, which increases data rates over slower networks. Valid Values:
Default: false |
ConnectionType |
Determines the connection type between the Agent and Agentless Host. Valid Values:
Default: SSH |
WMISysoutDirectory |
Defines the WMI directory for WMI-based connections. |
tag |
Defines the tag |
REST API Syntax
cURL:
server=controlm
agentlesshost=myhost
agent=realAgent
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: 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—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.
config server:agentlesshost:test::test
The config server:agentlesshost:test::test command enables you to test the Agentless Host on the Control-M/Server.
CLI Syntax
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 Control-M/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 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:
Default: AES |
compression |
Determines whether to compress the encrypted communication, which increases data rates over slower networks. Valid Values:
Default: false |
ConnectionType |
Determines the connection type between the Agent and Agentless Host. Valid Values:
Default: SSH |
WMISysoutDirectory |
Defines the WMI directory for WMI-based connections. |
tag |
Defines the tag |
REST API Syntax
cURL:
server=controlm
agentlesshost=myhost
agent=realAgent
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: 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—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.
config server:agentlesshost:disable::disable
The config server:agentlesshost:disable::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 Syntax
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 Control-M/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:
server=controlm
agentlesshost=myhost
agent=realAgent
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: 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—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.
config server:agentlesshost:enable::enable
The config server:agentlesshost:enable::enable command enables you to enable an Agentless Host on the Control-M/Server.
CLI Syntax
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 Control-M/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:
server=controlm
agentlesshost=myhost
agent=realAgent
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: 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—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.
config server:agentlesshost:ping::ping
The config server:agentlesshost:ping::ping command enables you to check if the Agentless Host is available.
CLI Syntax
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 Control-M/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:
server=controlm
agentlesshost=myhost
agent=realAgent
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: 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—"Authentication: Bearer $token" or "x-api-key: $token"—see Authentication Tokens.