PowerShellCommandAction Class Reference

Runs a Windows PowerShell command (script). More...

Inherits IntegrationAction.

Properties
DataTarget	Command [get, set]
	Specifies the PowerShell command script to run. For more information, see DataTarget. More...
string	BatchParameters [get, set]
	Specifies the parameters to use when the command is run as a batch. Available only when the source of Command is a file and the value of RunAsBatch is true. The default value is "". More...
bool	RunAsBatch [get, set]
	Specifies whether to run as a batch when allowed. Available only when the source of Command is a file. The default value is false. More...
bool	Asynchronous [get, set]
	Specifies whether the PowerShell commands should be run without waiting for a response. The default value is false. More...
bool	LogCommandOutput [get, set]
	Specifies whether the PowerShell command output is logged to the message log. The default value is true. More...
int	ExecuteTimeout [get, set]
	Specifies the amount of time, in milliseconds, in which the PowerShell command scripts can run before the action times out and exits. The default value is 300000. More...
string	CommandOutputVariable [get, set]
	Specifies the variable to which to save the standard output and any error messages that are generated when the command runs. The default value is "ShellCommandOutput". More...
string	CommandErrorVariable [get, set]
	Specifies the variable to which to save standard error messages that are generated when the command runs. The default value is "ShellCommandErrors". More...
string	CommandExceptionVariable [get, set]
	Specifies the variable to which to save exception messages that are generated when the command runs. The default value is "ShellCommandExceptions". 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 Windows PowerShell command (script).

For common action properties, see IntegrationAction.
Example:

Actions:   
- PowerShellCommandAction:
    Command:
      File: C:\MyScriptFolder\script1.ps
    BatchParameters: param1 param2
    RunAsBatch: true
    LogCommandOutput: false
    Name: Power Shell Command
    # And more common action properties
    ...

Property Documentation

Command

DataTarget Command

getset

Specifies the PowerShell command script to run.
For more information, see DataTarget.

BatchParameters

string BatchParameters

getset

Specifies the parameters to use when the command is run as a batch. Available only when the source of Command is a file and the value of RunAsBatch is true. The default value is "".

RunAsBatch

bool RunAsBatch

getset

Specifies whether to run as a batch when allowed. Available only when the source of Command is a file. The default value is false.

Asynchronous

bool Asynchronous

getset

Specifies whether the PowerShell commands should be run without waiting for a response. The default value is false.

LogCommandOutput

bool LogCommandOutput

getset

Specifies whether the PowerShell command output is logged to the message log. The default value is true.

ExecuteTimeout

int ExecuteTimeout

getset

Specifies the amount of time, in milliseconds, in which the PowerShell command scripts can run before the action times out and exits. The default value is 300000.

CommandOutputVariable

string CommandOutputVariable

getset

Specifies the variable to which to save the standard output and any error messages that are generated when the command runs. The default value is "ShellCommandOutput".

CommandErrorVariable

string CommandErrorVariable

getset

Specifies the variable to which to save standard error messages that are generated when the command runs. The default value is "ShellCommandErrors".

CommandExceptionVariable

string CommandExceptionVariable

getset

Specifies the variable to which to save exception messages that are generated when the command runs. The default value is "ShellCommandExceptions".

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:

• PowerShellCommandAction.Properties.cs