Tasks Commands

The tasks command group manages Tasks — scripts and automation steps that run automatically in response to transfer events on a Pipeline (send complete, receive complete, error, staged).

For command line syntax, see the UDMG Client CLI overview.

The create and update commands each dispatch to a type-specific subcommand.

Commands Overview

Command	Description	Required Role
tasks list	Returns all Tasks.	Any
tasks get <name>	Retrieves the full definition of a Task identified by name.	Any
tasks delete <name>	Permanently deletes a Task.	System Administrator Domain Administrator Pipeline Management
tasks create	Creates a Task. A type subcommand must be specified to identify the kind of Task being created.
tasks create command	Creates a Task that runs a shell command on the UDMG Server host when triggered by a transfer event.	System Administrator Domain Administrator Pipeline Management
tasks create uac-publish-event	Creates a Task that publishes an event to Universal Automation Center (UAC) when triggered by a transfer event.	System Administrator Domain Administrator Pipeline Management
tasks update	Updates a Task. A type subcommand must be specified, followed by the name of the Task to update. Only the flags explicitly provided are sent; omitted flags leave the corresponding fields unchanged.
tasks update command <name>	Updates a command Task.	System Administrator Domain Administrator Pipeline Management
tasks update uac-publish-event <name>	Updates a uac-publish-event Task.	System Administrator Domain Administrator Pipeline Management

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.

Subcommands

Use the following type subcommands with tasks create and tasks update to target a specific task type.

Subcommand	Task Type
command	Command
uac-publish-event	Publish Event

Commands Reference

list

Description

Returns all Tasks.

Required role

• Any

Command line syntax

udmg-client [global options] tasks list [command-specific options]

Command-specific options

Option	Description	Required	Default
--type	Filter by task type. Accepted values: command, uac_publish_event.	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 tasks list --type command --page 1 --page-size 10 --order asc

get

Description

Retrieves the full definition of a Task identified by name.

Required role

• Any

Command line syntax

udmg-client [global options] tasks get <name>

Arguments

Argument	Description
<name>	Task name.

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 tasks get post-transfer-script

delete

Description

Permanently deletes a Task.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] tasks delete <name>

Arguments

Argument	Description
<name>	Task name.

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 tasks delete post-transfer-script

create

Description

Creates a Task. A type subcommand must be specified to identify the kind of Task being created.

create command

Description

Creates a Task that runs a shell command on the UDMG Server host when triggered by a transfer event.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] tasks create command [command-specific options]

Command-specific options

Option	Description	Required	Default
--name	Task name.	Yes	N/A
--command	Shell command to execute.	Yes	N/A
--timeout	Execution timeout in seconds (1–86400).	Yes	N/A
--working-dir	Working directory (absolute path).	No	(none)
--description	The description of the Task.	No	(none)
--business-service	Business Service name to assign this Task to.	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 tasks create command --name my-command-task --command "/bin/bash -c 'echo hello'" --timeout 60 --working-dir /var/udmg --description "Automated task" --business-service my-service

create uac-publish-event

Description

Creates a Task that publishes an event to Universal Automation Center (UAC) when triggered by a transfer event.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] tasks create uac-publish-event [command-specific options]

Command-specific options

Option	Description	Required	Default
--name	Task name.	Yes	N/A
--timeout	Execution timeout in seconds (1–86400).	Yes	N/A
--event-name	UAC event name to publish.	No	(none)
--credentials-name	Credentials name for UAC authentication.	No	(none)
--business-services	Comma-separated Business Service names to include in the event payload.	No	(none)
--description	The description of the Task.	No	(none)
--business-service	Business Service name to assign this Task to.	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 tasks create uac-publish-event --name my-event-task --timeout 60 --event-name file-arrival --credentials-name my-credential --business-services my-service --description "Automated task" --business-service my-service

update

Description

Updates a Task. A type subcommand must be specified, followed by the name of the Task to update. Only the flags explicitly provided are sent; omitted flags leave the corresponding fields unchanged.

update command

Description

Updates a command Task.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] tasks update command <name> [command-specific options]

Arguments

Argument	Description
<name>	Task name.

Command-specific options

Option	Description	Required	Default
--name	New name for the Task.	No	(none)
--command	Shell command to execute.	No	(none)
--timeout	Execution timeout in seconds (1–86400).	No	(none)
--working-dir	Working directory (absolute path).	No	(none)
--description	The new description of the Task.	No	(none)
--business-service	Business Service name to assign this Task to.	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 tasks update command my-command-task --name my-command-task-updated --command "/bin/bash -c 'echo hello'" --timeout 60 --working-dir /var/udmg --description "Automated task" --business-service my-service

update uac-publish-event

Description

Updates a uac-publish-event Task.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] tasks update uac-publish-event <name> [command-specific options]

Arguments

Argument	Description
<name>	Task name.

Command-specific options

Option	Description	Required	Default
--name	New name for the Task.	No	(none)
--timeout	Execution timeout in seconds (1–86400).	No	(none)
--event-name	UAC event name to publish.	No	(none)
--credentials-name	Credentials name for UAC authentication.	No	(none)
--business-services	Comma-separated Business Service names to include in the event payload.	No	(none)
--description	The new description of the Task.	No	(none)
--business-service	Business Service name to assign this Task to.	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 tasks update uac-publish-event my-event-task --name my-event-task-updated --timeout 60 --event-name file-arrival --credentials-name my-credential --business-services my-service --description "Automated task" --business-service my-service