Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Windows command invocation mechanism


With an <invocation–mechanism> value of 'windows–command', the <adapter–name> element is used to designate a Windows Command Actor Adapter that has been configured in Grid Manager. If an <adapter–name> value is not defined, the default value of 'WindowsCommandAdapter' will be used.

All the connection information required by the Adapter can be retrieved from the Adapter configuration. In the case of a Windows Command Adapter that contains multiple configuration nodes, the default node will be used.

To designate a configuration node other than the default node, define a static value for the <target> element. This value should correspond with the name attribute of the <config> element in the Adapter configuration.

To configure this activity to communicate with a host that is not defined in the Adapter configuration, a dynamic target can be designated by assigning values for the <hostname>, <username>, and <password>elements.

The <timeout> element can be used to designate the length of time, in seconds, that the system should wait for the executed command to complete. If the executed command is not completed before the timeout period elapses, an error message will be returned in the Adapter response.

The remaining elements are not used with a defined <invocation–mechanism> value of 'windows–command'.

 

Element 

Use with Windows command mechanism 

Description

target 

Optional

 |

The name of the target defined in the Adapter configuration in Grid Manager. 

hostname

Conditional.

The hostname or IP address of the remote host. 

username

Conditional.

A valid username with which to log on to the remote server. 

password

Conditional.

The corresponding password for the username provided.

timeout

Optional. Default value is '60' (in seconds).

Time, in whole seconds, allotted to complete the execution of a command.

 

Related topics

Operations-Actions-utilities

Using-the-common-object-to-provide-the-information-required-to-create-the-adapter-request

Elements-for-the-ConnectionDetails-common-object

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*