Transfers Commands
The transfers command group views and manages Transfers — file transfers in progress within the Domain.
For command line syntax, see the UDMG Client CLI overview.
Commands Overview
| Command | Description | Required Role |
|---|---|---|
transfers list | Returns all Transfers. | Any |
transfers get <id> | Retrieves the full details of a Transfer identified by ID. | Any |
transfers stop <id> | Sends a stop signal to the specified in-progress Transfer. |
|
transfers cancel <id> | Cancels the specified in-progress Transfer. |
|
transfers cancel-all | Cancels all active Transfers. |
|
transfers total | Returns aggregate Transfer counts grouped by status. | 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 Transfers.
Required role
- Any
Command line syntax
udmg-client [global options] transfers list [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--status | Filter by status. Accepted values: Started, Running, Processing, Uploading, Completed, Failed, Cancelled, Stopped, active. | No | (none) |
--time-range | Filter by time range. Accepted values: 5m, 15m, 30m, 1h, 12h, 24h, 48h, 1w, 2w, 1mo, 3mo, 6mo, 1y. | No | (none) |
--schedule-id | Filter by schedule ID. | 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 transfers list --status Started --time-range 5m --schedule-id 1 --page 1 --page-size 10 --order asc
get
Description
Retrieves the full details of a Transfer identified by ID.
Required role
- Any
Command line syntax
udmg-client [global options] transfers get <id>
Arguments
| Argument | Description |
|---|---|
<id> | Transfer 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 transfers get 12345
stop
Description
Sends a stop signal to the specified in-progress Transfer.
Required role
- System Administrator
- Domain Administrator
Command line syntax
udmg-client [global options] transfers stop <id> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<id> | Transfer ID. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--reason | Optional reason for stopping the transfer. | 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 transfers stop 1 --reason "Manual cancellation"
cancel
Description
Cancels the specified in-progress Transfer.
Required role
- System Administrator
- Domain Administrator
Command line syntax
udmg-client [global options] transfers cancel <id> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<id> | Transfer ID. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--reason | Optional reason for cancelling the transfer. | 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 transfers cancel 1 --reason "Manual cancellation"
cancel-all
Description
Cancels all active Transfers.
Required role
- System Administrator
- Domain Administrator
Command line syntax
udmg-client [global options] transfers 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 transfers cancel-all --reason "Manual cancellation"
total
Description
Returns aggregate Transfer counts grouped by status.
Required role
- Any
Command line syntax
udmg-client [global options] transfers total
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 transfers total