Pipelines Commands
The pipelines command group manages Pipelines — the transfer configurations that connect a source Endpoint to a destination Endpoint and define the virtual path, permissions, and optional task workflow.
For command line syntax, see the UDMG Client CLI overview.
Commands Overview
| Command | Description | Required Role |
|---|---|---|
pipelines list | Returns all Pipelines. | Any |
pipelines get <name> | Retrieves the full definition of a Pipeline identified by name. | Any |
pipelines create | Creates a Pipeline connecting a source Endpoint to a destination Endpoint and defining the virtual path, permissions, and optional task workflow. |
|
pipelines update <name> | Updates an existing Pipeline. The source and destination Endpoints, relative path, and virtual path are required and must match the current values — they cannot be changed. Only the optional flags explicitly provided are sent; omitted flags leave the corresponding fields unchanged. |
|
pipelines delete <name> | Permanently deletes a Pipeline. |
|
pipelines enable <name> | Enables a Pipeline. |
|
pipelines disable <name> | Disables a Pipeline. |
|
pipelines list-accounts <name> | Returns all Accounts that have access to the specified Pipeline. | Any |
pipelines list-account-groups <name> | Returns all Account Groups that have access to the specified Pipeline. | Any |
pipelines get-workflow <name> | Returns the task workflow configuration for a Pipeline (the Tasks assigned to run on each transfer event). | Any |
pipelines set-workflow <name> | Replaces the task workflow configuration for a Pipeline. Each event flag accepts a comma-separated list of Task UUIDs (or the flag can be repeated). Omitted event arrays are set to empty, clearing any existing Tasks for that event. |
|
pipelines list-versions <name> | Returns the version history of a Pipeline. | Any |
pipelines get-version <name> <version-id> | Retrieves a specific historical version of a Pipeline. | 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 Pipelines.
Required role
- Any
Command line syntax
udmg-client [global options] pipelines list [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--enabled | Filter by enabled state. Accepted values: true, false. | 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 pipelines list --enabled true --page 1 --page-size 10 --order asc
get
Description
Retrieves the full definition of a Pipeline identified by name.
Required role
- Any
Command line syntax
udmg-client [global options] pipelines get <name>
Arguments
| Argument | Description |
|---|---|
<name> | Pipeline 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 pipelines get acme-pipeline
create
Description
Creates a Pipeline connecting a source Endpoint to a destination Endpoint and defining the virtual path, permissions, and optional task workflow.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] pipelines create [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | Pipeline name. | Yes | N/A |
--endpoint-src | Source Endpoint name. | Yes | N/A |
--endpoint-dst | Destination Endpoint name. | Yes | N/A |
--relative-path | Relative path from the source/destination Endpoint root. | Yes | N/A |
--virtual-path | Virtual path name exposed to connecting Accounts. | Yes | N/A |
--description | The description of the Pipeline. | No | (none) |
--credential-src | Source Credential name. | No | (none) |
--credential-dst | Destination Credential name. | No | (none) |
--workflow-enabled | Enable task workflow execution for this Pipeline. | No | false |
--tag | Tag (comma-separated or repeatable). | No | (none) |
--business-service | Business Service name to assign this Pipeline to. | No | (none) |
--perm-write | Allow write operations. Boolean switch — include to enable. | No | false |
--perm-read | Allow read operations. Boolean switch — include to enable. | No | false |
--perm-delete | Allow delete operations. Boolean switch — include to enable. | No | false |
--perm-mkdir | Allow directory creation. Boolean switch — include to enable. | No | false |
--perm-rmdir | Allow directory removal. Boolean switch — include to enable. | No | false |
--perm-overwrite | Allow overwrite operations. Boolean switch — include to enable. | No | false |
--perm-rename | Allow rename operations. Boolean switch — include to enable. | No | false |
--perm-list | Allow directory listing. Boolean switch — include to enable. | No | false |
--perm-share | Allow sharing. Boolean switch — include to enable. | No | false |
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 pipelines create --name daily-upload --endpoint-src local-sftp --endpoint-dst my-s3 --relative-path /uploads --virtual-path /transfers --description "Daily file upload pipeline" --credential-src sftp-key --credential-dst aws-keys --workflow-enabled true --tag production --business-service my-service --perm-write --perm-read --perm-overwrite --perm-list
update
Description
Updates an existing Pipeline. The source and destination Endpoints, relative path, and virtual path are required and must match the current values — they cannot be changed. Only the optional flags explicitly provided are sent; omitted flags leave the corresponding fields unchanged.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] pipelines update <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Pipeline name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--endpoint-src | Source Endpoint name (must match current value). | Yes | N/A |
--endpoint-dst | Destination Endpoint name (must match current value). | Yes | N/A |
--relative-path | Relative path (must match current value). | Yes | N/A |
--virtual-path | Virtual path (must match current value). | Yes | N/A |
--name | New name for the Pipeline. | No | (none) |
--description | The new description of the Pipeline. | No | (none) |
--credential-src | Source Credential name. | No | (none) |
--credential-dst | Destination Credential name. | No | (none) |
--workflow-enabled | Enable task workflow execution for this Pipeline. | No | (none) |
--tag | Tag (comma-separated or repeatable). | No | (none) |
--business-service | Business Service name to assign this Pipeline to. | No | (none) |
--perm-write, --perm-read, --perm-delete, --perm-mkdir, --perm-rmdir, --perm-overwrite, --perm-rename, --perm-list, --perm-share | Permission flags. Boolean switches — include to enable, omit to leave unchanged. See pipelines create for individual descriptions. | 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 pipelines update daily-upload --endpoint-src local-sftp --endpoint-dst my-s3 --relative-path /uploads --virtual-path /transfers --name daily-upload-updated --description "Daily file upload pipeline" --credential-src sftp-key --credential-dst aws-keys --workflow-enabled true --tag production --business-service my-service --perm-write --perm-read --perm-overwrite --perm-list
delete
Description
Permanently deletes a Pipeline.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] pipelines delete <name>
Arguments
| Argument | Description |
|---|---|
<name> | Pipeline 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 pipelines delete acme-pipeline
enable
Description
Enables a Pipeline.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] pipelines enable <name>
Arguments
| Argument | Description |
|---|---|
<name> | Pipeline 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 pipelines enable acme-pipeline
disable
Description
Disables a Pipeline.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] pipelines disable <name>
Arguments
| Argument | Description |
|---|---|
<name> | Pipeline 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 pipelines disable acme-pipeline
list-accounts
Description
Returns all Accounts that have access to the specified Pipeline.
Required role
- Any
Command line syntax
udmg-client [global options] pipelines list-accounts <name>
Arguments
| Argument | Description |
|---|---|
<name> | Pipeline 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 pipelines list-accounts acme-pipeline
list-account-groups
Description
Returns all Account Groups that have access to the specified Pipeline.
Required role
- Any
Command line syntax
udmg-client [global options] pipelines list-account-groups <name>
Arguments
| Argument | Description |
|---|---|
<name> | Pipeline 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 pipelines list-account-groups acme-pipeline
get-workflow
Description
Returns the task workflow configuration for a Pipeline (the Tasks assigned to run on each transfer event).
Required role
- Any
Command line syntax
udmg-client [global options] pipelines get-workflow <name>
Arguments
| Argument | Description |
|---|---|
<name> | Pipeline 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 pipelines get-workflow acme-pipeline
set-workflow
Description
Replaces the task workflow configuration for a Pipeline. Each event flag accepts a comma-separated list of Task UUIDs (or the flag can be repeated). Omitted event arrays are set to empty, clearing any existing Tasks for that event.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] pipelines set-workflow <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Pipeline name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--on-send-complete | Task UUIDs to run after a send completes (comma-separated or repeatable). | No | (none) |
--on-receive-complete | Task UUIDs to run after a receive completes (comma-separated or repeatable). | No | (none) |
--on-error | Task UUIDs to run on transfer error (comma-separated or repeatable). | No | (none) |
--on-staged | Task UUIDs to run when a file is staged (comma-separated or repeatable). | 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 pipelines set-workflow daily-upload --on-send-complete a1b2c3d4-e5f6-7890-abcd-ef1234567890 --on-receive-complete b2c3d4e5-f6a7-8901-bcde-f12345678901
list-versions
Description
Returns the version history of a Pipeline.
Required role
- Any
Command line syntax
udmg-client [global options] pipelines list-versions <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Pipeline name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--page | Page number. | No | (none) |
--page-size | Number of items per page. | 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 pipelines list-versions daily-upload --page 1 --page-size 10
get-version
Description
Retrieves a specific historical version of a Pipeline.
Required role
- Any
Command line syntax
udmg-client [global options] pipelines get-version <name> <version-id>
Arguments
| Argument | Description |
|---|---|
<name> | Pipeline name. |
<version-uuid> | UUID of the version to retrieve. Obtain the UUID from `list-versions`. |
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 pipelines get-version acme-pipeline a1b2c3d4-e5f6-7890-abcd-ef1234567890