Command Line adapter module
The Command Line process invokes the command line program on a peer. The following table describes the process inputs for the Command Line process.
Input | Description | Required |
|---|---|---|
<adapter name> | Specifies the name of the adapter to use for this process | No |
<command> | Specifies an XML document that contains the commands in the request | No |
<commands> | Specifies the string that specifies the commands and any arguments for the request
| No |
<mask-command-string> | Specifies whether to mask the command strings in the adapter response. If true, data in the <command> element in the response XML is masked. Valid values: true, false (default) | No |
<working directory> | Specifies the directory in which to execute the command | No |
<command directory> | Specifies the directory where the command is located | No |
<command encryption type> | Specifies the method of encryption used for the command value provided | No |
<command timeout> | Specifies the time, in seconds, allotted to complete the execution of the command | No |
<environment variables> | Specifies an XML document that contains the environment variables to set or clear before executing a command | No |
<run-as> | Specifies a boolean value to execute the command as a different user | No |
<user-name> | Specifies the name of an existing user using which the command is executed | Conditional; required if the run-as attribute is set to true |
<password> | Specifies the password for the user account specified in user-name | Conditional; required if the run-as attribute is set to true |
<wait-for-command-output> | Specifies whether to wait for the process or command output or until the adapter times-out; is an attribute of the <command> element, not an element itself
| No |
<krb-authentication> | Specifies a boolean value to execute the command as a different user using Kerberos authentication | No |
<krb-command> | Specifies the command used by the adapter to support run-as with Kerberos authentication | No |
<krb-options> | Specifies the krb-options for the krb-command | No |
<continue-on-failure> | Specifies whether to execute a subsequent command when a command fails; is an attribute of the <command> element, not an element itself | No |
<ignore-exit-code> | Specifies whether to ignore an exit that the response returned; is an attribute of the <command> element, not an element itself | No |
<disable-line-termination> | Specifies menu commands that need to be sent as a single character without any line termination; is an attribute of the <command> element, not an element itself | No |
<is-special-character> | Defines a command for Escape (ESC), Line Feed (LF), or Carriage Return (CR) when set to true; is an attribute of the <command> element, not an element itself. | No |
The following table describes the process output parameter for the Command Line process.
Process output | Description |
|---|---|
adapter response | Specifies the Command Line adapter's response |