Actions YAML Reference
Properties | List of all members
ShellCommandAction Class Reference

Runs a shell command that can be used to run operating system commands or third-party utilities. More...

Inherits IntegrationAction.

Properties

DataTarget Command [get, set]
 Specifies the commands to run.
Example: More...
 
string BatchParameters [get, set]
 Specifies the parameters for the batch command if the value of RunAsBatch is true. More...
 
bool RunAsBatch [get, set]
 Runs the command as a batch when the Command source is a file. More...
 
bool WaitForComplete [get, set]
 Specifies that the commands are not run until after a response is received. More...
 
int ExecuteTimeout [get, set]
 Specifies the amount of time, in milliseconds, that the action waits for the command to run before the action times out and exits.
Default: 300000 More...
 
bool StopIfFails [get, set]
 Specifies that the action stops running if a command fails. More...
 
bool LogCommandOutput [get, set]
 Logs the shell command output to the message log. The default value is true. More...
 
string CommandOutputVariable [get, set]
 Specifies the name of the variable to save the Standard output messages to. The default value is ShellCommandOutput. More...
 
string CommandErrorVariable [get, set]
 Specifies the name of the variable to save the Standard error messages to. The default value is ShellCommandErrors. More...
 
CommonActionProperties

Describes the common action properties for Actions and ActionGroups.

string Name [get, set]
 Specifies the name. This property cannot be empty and must be unique in the YAML script. More...
 
string Description [get, set]
 Specifies the description. The default value is "". More...
 
ActionRunType RunType [get, set]
 Runs the action by using one of the following types: More...
 
bool IgnoreErrors [get, set]
 Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false. More...
 
int FailureRetries [get, set]
 Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0. More...
 
int RetryInterval [get, set]
 Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000. More...
 

Detailed Description

Runs a shell command that can be used to run operating system commands or third-party utilities.

For common action properties, see IntegrationAction.
Example:

Actions:
- ShellCommandAction:
File: C:\MySecretFolder\command.bat
BatchParameters: parameter1 parameter2
RunAsBatch: true
Name: Shell Command
# And more common action properties
...
bool RunAsBatch
Runs the command as a batch when the Command source is a file.
Definition: ShellCommandAction.Properties.cs:94
DataTarget Command
Specifies the commands to run. Example:
Definition: ShellCommandAction.Properties.cs:80
string BatchParameters
Specifies the parameters for the batch command if the value of RunAsBatch is true.
Definition: ShellCommandAction.Properties.cs:87
string Name
Specifies the name. This property cannot be empty and must be unique in the YAML script.
Definition: IntegrationAction.Properties.cs:87

Property Documentation

◆ Command

DataTarget Command
getset

Specifies the commands to run.
Example:

Command: %EventData%

Example:

Command: ping 127.0.0.1

Example:

File: C:\MySecretFolder\command.bat
BatchParameters: parameter1 parameter2

◆ BatchParameters

string BatchParameters
getset

Specifies the parameters for the batch command if the value of RunAsBatch is true.

◆ RunAsBatch

bool RunAsBatch
getset

Runs the command as a batch when the Command source is a file.

◆ WaitForComplete

bool WaitForComplete
getset

Specifies that the commands are not run until after a response is received.

◆ ExecuteTimeout

int ExecuteTimeout
getset

Specifies the amount of time, in milliseconds, that the action waits for the command to run before the action times out and exits.
Default: 300000

◆ StopIfFails

bool StopIfFails
getset

Specifies that the action stops running if a command fails.

◆ LogCommandOutput

bool LogCommandOutput
getset

Logs the shell command output to the message log. The default value is true.

◆ CommandOutputVariable

string CommandOutputVariable
getset

Specifies the name of the variable to save the Standard output messages to. The default value is ShellCommandOutput.

◆ CommandErrorVariable

string CommandErrorVariable
getset

Specifies the name of the variable to save the Standard error messages to. The default value is ShellCommandErrors.

◆ Name

string Name
getsetinherited

Specifies the name. This property cannot be empty and must be unique in the YAML script.

◆ Description

string Description
getsetinherited

Specifies the description. The default value is "".

◆ RunType

ActionRunType RunType
getsetinherited

Runs the action by using one of the following types:

  • Always (default)
  • Never

◆ IgnoreErrors

bool IgnoreErrors
getsetinherited

Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.

◆ FailureRetries

int FailureRetries
getsetinherited

Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.

◆ RetryInterval

int RetryInterval
getsetinherited

Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000.


The documentation for this class was generated from the following file: