Transfer Schedules Commands
The transfer-schedules command group manages scheduled Transfers — Transfer jobs submitted to run at a specified time via a Pipeline.
For command line syntax, see the UDMG Client CLI overview.
Commands Overview
| Command | Description | Required Role |
|---|---|---|
transfer-schedules list | Returns all Transfer Schedules. | Any |
transfer-schedules get <id> | Retrieves the full definition of a Transfer Schedule identified by its ID. | Any |
transfer-schedules create | Submits a new scheduled Transfer job. |
|
transfer-schedules dry-run | Lists the files that match the transfer criteria without executing the transfer. Use to preview what a scheduled transfer would send. | Any |
transfer-schedules cancel <id> | Cancels a pending scheduled Transfer before it executes. |
|
transfer-schedules cancel-all | Cancels all pending scheduled Transfers. |
|
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 Transfer Schedules.
Required role
- Any
Command line syntax
udmg-client [global options] transfer-schedules list [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--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 transfer-schedules list --page 1 --page-size 10 --order asc
get
Description
Retrieves the full definition of a Transfer Schedule identified by its ID.
Required role
- Any
Command line syntax
udmg-client [global options] transfer-schedules get <id>
Arguments
| Argument | Description |
|---|---|
<id> | Transfer schedule ID. |
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 transfer-schedules get 42
create
Description
Submits a new scheduled Transfer job.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] transfer-schedules create [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--pipeline | Pipeline name. | Yes | N/A |
--scheduled | Schedule time in RFC3339 format (e.g. 2026-09-01T08:00:00Z). | Yes | N/A |
--source | Source file path. Path resolution depends on the Pipeline type — see the Pipeline documentation. | Yes | N/A |
--destination | Destination path. | No | (none) |
--include-filter | Wildcard include filter (e.g. *.csv). | No | (none) |
--move | Delete the source file after a successful transfer. | 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 transfer-schedules create --pipeline daily-upload --scheduled true --source /local/uploads --destination /remote/received --include-filter "*.csv" --move false
dry-run
Description
Lists the files that match the transfer criteria without executing the transfer. Use to preview what a scheduled transfer would send.
Required role
- Any
Command line syntax
udmg-client [global options] transfer-schedules dry-run [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--pipeline | Pipeline name. | Yes | N/A |
--source | Source file path or wildcard pattern. Path resolution depends on the Pipeline type — see the Pipeline documentation. | Yes | N/A |
--scheduled | Optional schedule time (RFC3339). | No | (none) |
--destination | Destination path. | No | (none) |
--include-filter | Wildcard include filter (e.g. *.csv). | 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 transfer-schedules dry-run --pipeline daily-upload --source /local/uploads --scheduled true --destination /remote/received --include-filter "*.csv"
cancel
Description
Cancels a pending scheduled Transfer before it executes.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] transfer-schedules cancel <id> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<id> | Transfer schedule ID. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--reason | Optional reason for cancelling. | 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 transfer-schedules cancel 1 --reason "Manual cancellation"
cancel-all
Description
Cancels all pending scheduled Transfers.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] transfer-schedules cancel-all [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--reason | Optional reason for cancelling. | 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 transfer-schedules cancel-all --reason "Manual cancellation"