Page Comparison

Scenario:

Execution of an ls command.

Task instance success or failure depends on the exit code of the command

being executed. If the command is executed with exit code = 0, the

task instance completes with Success status. Otherwise, the task instance status is Failed with exit code = 1.

This example shows the execution of

an ls command, including outputs for both success and failure cases.

{
	"exit_code": 0,
	"status_description": "Task executed successfully",
	"invocation": {
		"extension": "ue-cmd",
		"version": "1.0.0",
		"fields": { ... }
	},
	"result": {
		"metadata": {
			"runtime_directory": "/tmp",
			"command": "ls existing_file.txt",
			"exit_code": 0
		},
		"command_json_output": "existing_file.txt"
	}
}

{
	"exit_code": 1,
	"status_description": "Execution returned exit code other than 0",
	"invocation": {
		"extension": "ue-cmd",
		"version": "1.0.0",
		"fields": { ... }
	},
	"result": {
		"metadata": {
			"runtime_directory": "/tmp",
			"command": "ls non_existent.txt",
			"exit_code": 2
		},
		"command_json_output": null
	}
}

Scenario: Command execution that produces a valid JSON result:.

This example shows a command that produces JSON output on STDOUT. In such a case, the output is also visible in the task instance EXTENSION output.

{
	"exit_code": 0,
	"status_description": "Task executed successfully",
	"invocation": {
		"extension": "ue-cmd",
		"version": "1.0.0",
		"fields": {
			"action": "Run Command",
			"command": "echo '{\"name\": \"John\", \"age\": 30, \"city\": \"Athens\"}'",
			"additional_file": null
		}
	},
	"result": {
		"metadata": {
			"runtime_directory": "/tmp",
			"command": "echo '{\"name\": \"John\", \"age\": 30, \"city\": \"Athens\"}'",
			"exit_code": 0
		},
		"command_json_output": {
			"name": "John",
			"age": 30,
			"city": "Athens"
		}
	}
}

Scenario: Execution of a shell script stored in the Controller.

The example shows execution of script.sh. Environment variable ${UE_CMD_ADDFILE} points to the script full path referenced from Optional Additional File field.

Note: In this example, the reference to the environmental variable UE_CMD_ADDFILE is surrounded by quotes. This was done because the path to this variable contains spaces, so it must be quoted in order for the shell to resolve it correctly.

Scenario: Redirection of output.

In this example, the contents of the current directory are listed in long format using ls -l, and then redirected to the output.log file. Afterwards, the contents are displayed through the cat command.

Scenario: PowerShell script execution.

The example shows execution of a PowerShell script provided by the Optional Additional File field referenced through the UE_CMD_ADDFILE environment variable.

Scenario: Execution of a batch file.

The example shows execution of a batch file provided by the Optional Additional File field referenced through the UE_CMD_ADDFILE environment variable.