Task Instances Commands
The task-instances command group queries Task Instances — the execution records created each time a Task runs in response to a transfer event. Task Instances are system-generated and read-only; they cannot be created, updated, or deleted through the CLI.
For command line syntax, see the UDMG Client CLI overview.
Commands Overview
| Command | Description | Required Role |
|---|---|---|
task-instances list | Returns all Task Instances. | Any |
task-instances get <uuid> | Retrieves the full details of a Task Instance identified by UUID. | Any |
task-instances get-output <uuid> | Returns the captured standard output and standard error from the Task execution. | Any |
task-instances get-context <uuid> | Returns the context variables available to the Task during execution, such as transfer metadata, file paths, and Pipeline details. | Any |
Authentication
Every udmg-client command authenticates to the UDMG Server using a UDMG username and password. Supply them with the --auth-username and --auth-password flags, or set the UDMG_CLI_AUTH_USERNAME and UDMG_CLI_AUTH_PASSWORD environment variables. For details and examples, see Authentication.
Commands Reference
list
Description
Returns all Task Instances.
Required role
- Any
Command line syntax
udmg-client [global options] task-instances list [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--task-name | Filter by Task name. | No | (none) |
--pipeline-name | Filter by Pipeline name. | No | (none) |
--transfer-uuid | Filter by Transfer UUID. | No | (none) |
--status | Filter by status. Accepted values: pending, running, completed, failed, aborted. | No | (none) |
--event-type | Filter by event type. Accepted values: on_send_complete, on_receive_complete, on_error, on_staged. | No | (none) |
--from-date | Filter by start date lower bound (RFC3339). | No | (none) |
--to-date | Filter by start date upper bound (RFC3339). | No | (none) |
--page | Page number. | No | (none) |
--page-size | Number of items per page. | No | (none) |
--order | Sort direction. Accepted values: asc, desc. | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client task-instances list --task-name my-task --pipeline-name daily-upload --transfer-uuid 550e8400-e29b-41d4-a716-446655440000 --status pending --event-type on_send_complete --from-date 2027-01-01T00:00:00Z --to-date 2027-12-31T23:59:59Z --page 1 --page-size 10 --order asc
get
Description
Retrieves the full details of a Task Instance identified by UUID.
Required role
- Any
Command line syntax
udmg-client [global options] task-instances get <uuid>
Arguments
| Argument | Description |
|---|---|
<uuid> | Task instance UUID. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client task-instances get 550e8400-e29b-41d4-a716-446655440000
get-output
Description
Returns the captured standard output and standard error from the Task execution.
Required role
- Any
Command line syntax
udmg-client [global options] task-instances get-output <uuid>
Arguments
| Argument | Description |
|---|---|
<uuid> | Task instance UUID. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client task-instances get-output 550e8400-e29b-41d4-a716-446655440000
get-context
Description
Returns the context variables available to the Task during execution, such as transfer metadata, file paths, and Pipeline details.
Required role
- Any
Command line syntax
udmg-client [global options] task-instances get-context <uuid>
Arguments
| Argument | Description |
|---|---|
<uuid> | Task instance UUID. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client task-instances get-context 550e8400-e29b-41d4-a716-446655440000