Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field

Type

Description

Version Information

Action

Choice

The action performed upon the task execution. Available options:

  • Run Command

Introduced in 1.0.0

Optional Additional File

Script

A An optional field to include a file used either as a parameter in the command or as a script to be executed with an interpreter. This file can be referenced in the command line using the UE_CMD_ADDFILE environment variable. This field is particularly useful when the required files are not present on the agent’s filesystem, allowing the Controller to serve as the source for these files.

Introduced in 1.0.0

Command

Large Text

The Command Line to be executed. It should be provided as a single line. Any additional lines will be ignored.

Environment variable UC_CMD_ADDFILE can be used here to reference the additional file provided.

Required when Action is “Run Command”



Introduced in 1.0.0

Runtime Directory

Text

The Runtime Directory just before the execution of the command. While the Runtime Directory field is not mandatory, it is highly recommended to be configured. This ensures clarity about the directory from which the command is executed

Introduced in 1.0.0

...

Exit Code

Status

Status Description

Meaning

0

Success

“Task executed successfully. “

Exit code for successful executionIf the executed command succeeds, it returns an exit code of 0. The task will reflect this success by also returning exit code = 0.

1

Failure

““Execution Failed: <<Error Description>>”

Exit code for failed executionThis indicates that the executed command failed, or the task itself failed for some other reason.

20

Failure

“Data Validation Error: <<Error Description>> “

Input fields validation error.

...