RunExecutable

RunExecutable

SYNOPSIS

Executes application executable file.

SYNTAX

  - ActionType: RunExecutable
    ActionDescription: 
    Executable: 
    Arguments: 
    Credentials:
    WorkingDirectory: 
    OutBuffer: 
    ErrBuffer:
    ExactVariableCheck:
    CheckArgumentsForVariables:

EXAMPLES

EXAMPLE 1

  - ActionType: RunExecutable
    ActionDescription: Executes specified executable
    Executable: D:\myapp\bin\app.exe
    Arguments: [ "some argument 1", "some argument 2" ]
    Credentials: [ "domain.lan", "login", "password" ]
    WorkingDirectory: C:\Windows\System32
    OutBuffer: $var1
    ErrBuffer: $var2
    ExactVariableCheck: false
    CheckArgumentsForVariables: false

EXAMPLE 2

  - ActionType: RunExecutable
    Executable: D:\myapp\bin\app.exe

EXAMPLE 3

  - ActionType: RunExecutable
    ActionDescription: Executes specified executable
    Executable: D:\myapp\bin\app.exe
    Arguments: [ "some argument 1", "some argument 2" ]
    OutBuffer: $var1
    ErrBuffer: $var2

EXAMPLE 4

  - ActionType: RunExecutable
    ActionDescription: Executes specified executable
    Executable: $myappExecutablePath
    Arguments: [ $arg1, $arg2 ]
    Credentials: [ "domain.lan", "login", "password" ]
    WorkingDirectory: $myapLocationPath
    OutBuffer: $var1
    ErrBuffer: $var2

PARAMETERS

ActionType

This parameter specifies action name. RunExecutable value is required for this action to be executed.

Required: true
Default Value: RunExecutable
Accepted Value: RunExecutable
Accepted Value Type: string
Accepts Variables: false

ActionDescription

This parameter specifies description of the action.

Required: false
Default Value: none
Accepted Value: any
Accepted Value Type: string
Accepts Variables: false

Executable

This parameter specifies absolute path to executable file which should be executed.

Required: true
Default Value: none
Accepted Value: any
Accepted Value Type: string
Accepts Variables: true

Arguments

This parameter specifies arguments which should be sent to executable file.

Required: false
Default Value: empty
Accepted Value: array of strings
Accepted Value Type: array of strings
Accepts Variables: if CheckArgumentsForVariables value is true

Credentials

This parameter specifies Credentials using which start executable file.

Required: false
Default Value: empty
Accepted Value: Array of parameters: [ "domain.lan", "login", "password" ]
Accepted Value Type: Array of parameters
Accepts Variables: false

WorkingDirectory

This parameter specifies executable working directory.

Required: false
Default Value: %OS_DRIVE%:\Windows\System32
Accepted Value: string path
Accepted Value Type: string
Accepts Variables: true

OutBuffer

This parameter gets output buffer of the executable execution. Can be used to set output value to variable.

Required: false
Default Value: none
Accepted Value: variable
Accepted Value Type: string
Accepts Variables: true

ErrBuffer

This parameter gets output error buffer of the executable execution. Can be used to set output value to variable.

Required: false
Default Value: none
Accepted Value: variable
Accepted Value Type: string
Accepts Variables: true

ExactVariableCheck

This parameter specifies how to check YAML file variables specified in other parameters. If value is:

• true - variable value will be set when it is a separated word. Example: $var1$var2 will not be considered as $var1 and $var2.
• false - variable value will be set even if it is not separated word . Example: $var1$var2 will be considered as $var1 and $var2.

Required: false
Default Value: none
Accepted Value: true\false
Accepted Value Type: boolean
Accepts Variables: false

CheckArgumentsForVariables

This parameter specifies how to check YAML file variables specified in the Arguments parameter. If value is:

• true - variable value will be set when it is a separated word. Example: $var1$var2 will not be considered as $var1 and $var2.
• false - variable value will be set even if it is not separated word . Example: $var1$var2 will be considered as $var1 and $var2.

Required: false
Default Value: none
Accepted Value: true\false
Accepted Value Type: boolean
Accepts Variables: false

NOTES