UDMG Client CLI

The UDMG Client CLI is a set of commands built into the udmg-client binary. It connects to a running UDMG Server over the network and manages resources (Endpoints, Transfers, Pipelines, etc.) through the UDMG REST API.

Unlike the UDMG Server CLI, which runs directly on the UDMG Server host and operates against the local configuration and database, udmg-client is a remote client: it authenticates as a UDMG User and communicates with the UDMG Server over HTTP. It does not require access to the UDMG Server's configuration file or database, and the UDMG Server must be running for any command to succeed.

udmg-client is designed to run from any machine with network access to the UDMG Server (a workstation, a CI/CD runner, a jump host, or any other host in the environment). It enables repeatable, scriptable, and pipeline-friendly management operations without requiring a browser or direct access to the UDMG Server host.

Installation

udmg-client ships bundled with udmg-server in the same package and installer directory. No separate installation is required on the server host.

Depending on the installation guide you followed, the binary is located at:

• Linux (Standard): /opt/udmg/bin/udmg-client (symlinked at /usr/local/bin/udmg-client)
• Linux (Custom): <udmg-install-dir>/udmg-client
• Windows: C:\Program Files\Stonebranch\UDMG Server\udmg-client.exe

To use udmg-client from a remote machine, copy the binary to that machine.

Authentication

Every UDMG Client CLI command authenticates to the UDMG Server with a UDMG username and password. These are the credentials of the UDMG User running the command, not the credentials of the resource being managed.

The Role of the authenticated User determines which commands are available (see the Required Role column in the Commands table). For a full description of each Role, see Roles.

info

There is no interactive authentication. The username and password must be supplied when starting the command, either as flags or environment variables.

The connection credentials can be supplied as flags or environment variables:

Credential	Flag	Environment Variable
Server URL	--server-url <url>	UDMG_CLI_SERVER_URL
Username	--auth-username <username>	UDMG_CLI_AUTH_USERNAME
Password	--auth-password <password>	UDMG_CLI_AUTH_PASSWORD
Domain	--domain <domain>	UDMG_CLI_DOMAIN

Using environment variables is recommended when scripting.

To set the environment variables, run the following commands:

Linux

$

export UDMG_CLI_SERVER_URL=<url>

$

export UDMG_CLI_AUTH_USERNAME=<username>

$

export UDMG_CLI_AUTH_PASSWORD=<password>

$

export UDMG_CLI_DOMAIN=<domain>

Windows (CMD)

C:\>

set UDMG_CLI_SERVER_URL=<url>

C:\>

set UDMG_CLI_AUTH_USERNAME=<username>

C:\>

set UDMG_CLI_AUTH_PASSWORD=<password>

C:\>

set UDMG_CLI_DOMAIN=<domain>

Once set, any udmg-client command run in the same terminal window will use those values automatically without needing the --server-url, --auth-username, --auth-password, and --domain flags. The variables are not permanent. They are lost when the terminal is closed or a new terminal is opened.

To make them permanent, run the following commands:

Linux

Append the exports to your shell profile, then reload it:

$

echo 'export UDMG_CLI_SERVER_URL=<url>' >> ~/.bashrc

$

echo 'export UDMG_CLI_AUTH_USERNAME=<username>' >> ~/.bashrc

$

echo 'export UDMG_CLI_AUTH_PASSWORD=<password>' >> ~/.bashrc

$

echo 'export UDMG_CLI_DOMAIN=<domain>' >> ~/.bashrc

$

source ~/.bashrc

Replace ~/.bashrc with ~/.zshrc if you use Zsh.

Windows (CMD)

Use setx to write the values to your user environment (takes effect in new terminal windows):

C:\>

setx UDMG_CLI_SERVER_URL "<url>"

C:\>

setx UDMG_CLI_AUTH_USERNAME "<username>"

C:\>

setx UDMG_CLI_AUTH_PASSWORD "<password>"

C:\>

setx UDMG_CLI_DOMAIN "<domain>"

Commands

UDMG Client CLI commands manage UDMG resources through the UDMG REST API.

The available commands are listed below, grouped by resource type:

Category	Command	Description	Required Role
Account Groups	account-groups list	Returns all Account Groups.	Any
	account-groups get <name>	Retrieves the full definition of an Account Group identified by name.	Any
	account-groups create	Creates an Account Group.	System Administrator Domain Administrator Pipeline Management
	account-groups update <name>	Updates one or more properties of an existing Account Group. Only the flags explicitly provided are sent; omitted flags leave the corresponding fields unchanged.	System Administrator Domain Administrator Pipeline Management
	account-groups delete <name>	Permanently deletes an Account Group.	System Administrator Domain Administrator Pipeline Management
	account-groups list-accounts <name>	Returns all Accounts that belong to an Account Group.	Any
	account-groups allow-account <group> <account>	Grants an Account access to an Account Group.	System Administrator Domain Administrator Pipeline Management
	account-groups revoke-account <group> <account>	Revokes an Account's access from an Account Group.	System Administrator Domain Administrator Pipeline Management
	account-groups list-pipelines <name>	Returns all Pipelines that belong to an Account Group.	Any
	account-groups allow-pipeline <group> <pipeline>	Grants an Account Group access to a Pipeline.	System Administrator Domain Administrator Pipeline Management
	account-groups revoke-pipeline <group> <pipeline>	Revokes an Account Group's access to a Pipeline.	System Administrator Domain Administrator Pipeline Management
Accounts	accounts list	Returns all Accounts.	Any
	accounts get <name>	Retrieves the full definition of an Account identified by name.	Any
	accounts create	Creates an Account.	System Administrator Domain Administrator Pipeline Management
	accounts update <name>	Updates one or more properties of an existing Account. Only the flags explicitly provided are sent; omitted flags leave the corresponding fields unchanged.	System Administrator Domain Administrator Pipeline Management
	accounts delete <name>	Permanently deletes an Account.	System Administrator Domain Administrator Pipeline Management
	accounts enable <name>	Enables an Account.	System Administrator Domain Administrator Pipeline Management Operator
	accounts disable <name>	Disables an Account.	System Administrator Domain Administrator Pipeline Management Operator
	accounts set-password <name>	Administratively sets the password for an Account.	System Administrator Domain Administrator Pipeline Management
	accounts reset-2fa <name>	Clears the two-factor authentication configuration for an Account, requiring re-enrollment on next login.	System Administrator Domain Administrator Pipeline Management
	accounts auth-unlock <name>	Clears active authentication blocks for an Account, allowing it to connect again after exceeding the failed-login attempt limit.	System Administrator Domain Administrator Pipeline Management Operator
	accounts list-credentials <name>	Returns all Credentials assigned to an Account.	Any
	accounts allow-credential <account> <credential>	Grants a Credential to an Account.	System Administrator Domain Administrator Pipeline Management
	accounts revoke-credential <account> <credential>	Revokes a Credential from an Account.	System Administrator Domain Administrator Pipeline Management
	accounts list-pipelines <name>	Returns all Pipelines that the Account has access to.	Any
	accounts list-account-groups <name>	Returns all Account Groups that the Account belongs to.	Any
	accounts allow-account-group <account> <group>	Adds an Account to an Account Group.	System Administrator Domain Administrator Pipeline Management
	accounts revoke-account-group <account> <group>	Removes an Account from an Account Group.	System Administrator Domain Administrator Pipeline Management
	accounts get-quota <name>	Returns the quota policy configured for an Account.	Any
	accounts set-quota <name>	Creates or replaces the bytes-transferred quota policy for an Account.	System Administrator Domain Administrator Pipeline Management
	accounts delete-quota <name>	Removes the quota policy from an Account.	System Administrator Domain Administrator Pipeline Management
	accounts quota-history <name>	Returns paginated history of completed quota reset periods for an Account.	Any
	accounts quota-summary	Returns the quota utilization for every Account that has a quota policy configured.	Any
Adhoc	adhoc get <shareID>	Retrieves the details of an Adhoc Share identified by ID.	Any
	adhoc list	Returns all Adhoc Shares.	Any
	adhoc refresh <shareID>	Resets the download count for an Adhoc Share to zero.	System Administrator Domain Administrator
	adhoc revoke <shareID>	Disables an Adhoc Share, preventing further downloads.	System Administrator Domain Administrator
	adhoc unrevoke <shareID>	Re-enables a previously revoked Adhoc Share.	System Administrator Domain Administrator
Business Services	business-services list	Returns all Business Services.	Any
	business-services list-accessible	Returns only the Business Services that the authenticated User is permitted to access.	Any
	business-services get <name>	Retrieves the full definition of a Business Service identified by name.	Any
	business-services create	Creates a Business Service.	System Administrator Domain Administrator Pipeline Management
	business-services update <name>	Updates one or more properties of an existing Business Service. Only the flags explicitly provided are sent; omitted flags leave the corresponding fields unchanged.	System Administrator Domain Administrator Pipeline Management
	business-services delete <name>	Permanently deletes a Business Service.	System Administrator Domain Administrator Pipeline Management
	business-services list-users <name>	Returns all Users assigned to the specified Business Service.	Any
	business-services list-entities <name>	Returns all entities (Accounts, Pipelines, Endpoints, and other resources) assigned to the specified Business Service.	Any
Credentials	credentials list	Returns all Credentials.	Any
	credentials get <name>	Retrieves the full definition of a Credential identified by name.	Any
	credentials delete <name>	Permanently deletes a Credential.	System Administrator Domain Administrator Pipeline Management
	credentials create	Creates a Credential. A type subcommand must be specified to identify the kind of secret being stored.
	credentials create auth-password	Creates an auth-password Credential storing a username/password pair.	System Administrator Domain Administrator Pipeline Management
	credentials create auth-key	Creates an auth-key Credential storing a username with an SSH private key.	System Administrator Domain Administrator Pipeline Management
	credentials create auth-password-key	Creates an auth-password-key Credential storing a username, password, and SSH private key.	System Administrator Domain Administrator Pipeline Management
	credentials create key-pair	Creates a key-pair Credential storing a symmetric key/value pair.	System Administrator Domain Administrator Pipeline Management
	credentials create ssh-private-key	Creates an ssh-private-key Credential storing an SSH private key.	System Administrator Domain Administrator Pipeline Management
	credentials create ssh-public-key	Creates an ssh-public-key Credential storing an SSH public key.	System Administrator Domain Administrator Pipeline Management
	credentials create pgp-private-key	Creates a pgp-private-key Credential storing a PGP private key.	System Administrator Domain Administrator Pipeline Management
	credentials create pgp-public-key	Creates a pgp-public-key Credential storing a PGP public key.	System Administrator Domain Administrator Pipeline Management
	credentials create x509-cert	Creates an x509-cert Credential storing an X.509 certificate.	System Administrator Domain Administrator Pipeline Management
	credentials create x509-private-key	Creates an x509-private-key Credential storing an X.509 private key.	System Administrator Domain Administrator Pipeline Management
	credentials create x509-cert-key	Creates an x509-cert-key Credential storing an X.509 certificate with its matching private key.	System Administrator Domain Administrator Pipeline Management
	credentials update	Updates a Credential. A type subcommand must be specified, followed by the name of the Credential to update.
	credentials update auth-password <name>	Updates an auth-password Credential.	System Administrator Domain Administrator Pipeline Management
	credentials update auth-key <name>	Updates an auth-key Credential.	System Administrator Domain Administrator Pipeline Management
	credentials update auth-password-key <name>	Updates an auth-password-key Credential.	System Administrator Domain Administrator Pipeline Management
	credentials update key-pair <name>	Updates a key-pair Credential.	System Administrator Domain Administrator Pipeline Management
	credentials update ssh-private-key <name>	Updates an ssh-private-key Credential.	System Administrator Domain Administrator Pipeline Management
	credentials update ssh-public-key <name>	Updates an ssh-public-key Credential.	System Administrator Domain Administrator Pipeline Management
	credentials update pgp-private-key <name>	Updates a pgp-private-key Credential.	System Administrator Domain Administrator Pipeline Management
	credentials update pgp-public-key <name>	Updates a pgp-public-key Credential.	System Administrator Domain Administrator Pipeline Management
	credentials update x509-cert <name>	Updates an x509-cert Credential.	System Administrator Domain Administrator Pipeline Management
	credentials update x509-private-key <name>	Updates an x509-private-key Credential.	System Administrator Domain Administrator Pipeline Management
	credentials update x509-cert-key <name>	Updates an x509-cert-key Credential.	System Administrator Domain Administrator Pipeline Management
	credentials enable <name>	Enables a Credential.	System Administrator Domain Administrator Pipeline Management Operator
	credentials disable <name>	Disables a Credential.	System Administrator Domain Administrator Pipeline Management Operator
	credentials details <name>	Returns parsed details of the specified Credential, such as key fingerprints, certificate subject and expiry, and algorithm information, without returning the raw secret value.	Any
	credentials reveal <name>	Returns the decrypted secret value of the specified Credential. The response contains the plaintext secret.	System Administrator Domain Administrator Pipeline Management
	credentials assignments <name>	Returns all resources (Accounts, Endpoints, Pipelines, Tasks, and Domains) that currently reference the specified Credential.	Any
Endpoints	endpoints list	Returns all Endpoints.	Any
	endpoints get <name>	Retrieves the full definition of an Endpoint identified by name.	Any
	endpoints delete <name>	Permanently deletes an Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints create	Creates an Endpoint. A type subcommand must be specified to identify the protocol and direction of the Endpoint.
	endpoints create local-sftp-server	Creates a local SFTP server Endpoint hosted by UDMG.	System Administrator Domain Administrator Pipeline Management
	endpoints create remote-sftp-server	Creates a connection to a remote SFTP server.	System Administrator Domain Administrator Pipeline Management
	endpoints create local-filesystem	Creates a local filesystem storage Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints create cloud-s3	Creates an Amazon S3 or compatible cloud storage Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints create cloud-azure-blob	Creates an Azure Blob Storage Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints create cloud-azure-files	Creates an Azure Files storage Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints create cloud-gcs	Creates a Google Cloud Storage Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints create local-ftp-server	Creates a local FTP/FTPS server Endpoint hosted by UDMG.	System Administrator Domain Administrator Pipeline Management
	endpoints create remote-ftp-server	Creates a connection to a remote FTP/FTPS server.	System Administrator Domain Administrator Pipeline Management
	endpoints create local-as2-server	Creates a local AS2 server Endpoint hosted by UDMG.	System Administrator Domain Administrator Pipeline Management
	endpoints create remote-as2-client	Creates a connection to a remote AS2 server.	System Administrator Domain Administrator Pipeline Management
	endpoints create local-wtc-server	Creates a Web Transfer Client (WTC) HTTPS server Endpoint. Only one WTC server Endpoint can exist per Domain.	System Administrator Domain Administrator Pipeline Management
	endpoints update	Updates an Endpoint. A type subcommand must be specified, followed by the name of the Endpoint to update.
	endpoints update local-sftp-server <name>	Updates a local SFTP server Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints update remote-sftp-server <name>	Updates a remote SFTP server Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints update local-filesystem <name>	Updates a local filesystem Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints update cloud-s3 <name>	Updates an Amazon S3 or compatible cloud storage Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints update cloud-azure-blob <name>	Updates an Azure Blob Storage Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints update cloud-azure-files <name>	Updates an Azure Files storage Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints update cloud-gcs <name>	Updates a Google Cloud Storage Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints update local-ftp-server <name>	Updates a local FTP/FTPS server Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints update remote-ftp-server <name>	Updates a remote FTP/FTPS server Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints update local-as2-server <name>	Updates a local AS2 server Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints update remote-as2-client <name>	Updates a remote AS2 client Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints update local-wtc-server <name>	Updates a local WTC server Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints enable <name>	Enables an Endpoint.	System Administrator Domain Administrator Pipeline Management Operator
	endpoints disable <name>	Disables an Endpoint.	System Administrator Domain Administrator Pipeline Management Operator
	endpoints start <name>	Starts a previously stopped Endpoint. Only applies to Local SFTP Server, Local FTP Server, Local AS2 Server, and Local HTTPS Server (WTC) Endpoints. Returns an error on all other Endpoint types.	System Administrator Domain Administrator Pipeline Management Operator
	endpoints stop <name>	Stops a running Endpoint without deleting it. Only applies to Local SFTP Server, Local FTP Server, Local AS2 Server, and Local HTTPS Server (WTC) Endpoints. Returns an error on all other Endpoint types.	System Administrator Domain Administrator Pipeline Management Operator
	endpoints restart <name>	Stops and restarts a running Endpoint. Only applies to Local SFTP Server, Local FTP Server, Local AS2 Server, and Local HTTPS Server (WTC) Endpoints. Returns an error on all other Endpoint types.	System Administrator Domain Administrator Pipeline Management Operator
	endpoints set-log-level <name>	Changes the log level for an Endpoint at runtime without restarting it. Only applies to Local SFTP Server, Local FTP Server, Local AS2 Server, and Local HTTPS Server (WTC) Endpoints. Returns an error on all other Endpoint types.	System Administrator Domain Administrator Pipeline Management
	endpoints list-pipelines <name>	Returns all Pipelines that use the specified Endpoint as source or destination.	Any
	endpoints test <name>	Runs a connectivity test for the specified Endpoint.	System Administrator Domain Administrator Pipeline Management
	endpoints list-versions <name>	Returns the version history of an Endpoint.	Any
	endpoints get-version <name> <version-id>	Retrieves a specific historical version of an Endpoint.	Any
Pipelines	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.	System Administrator Domain Administrator Pipeline Management
	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.	System Administrator Domain Administrator Pipeline Management
	pipelines delete <name>	Permanently deletes a Pipeline.	System Administrator Domain Administrator Pipeline Management
	pipelines enable <name>	Enables a Pipeline.	System Administrator Domain Administrator Pipeline Management
	pipelines disable <name>	Disables a Pipeline.	System Administrator Domain Administrator Pipeline Management
	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.	System Administrator Domain Administrator Pipeline Management
	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
Profile	profile get	Retrieves the profile of the currently authenticated User.	Any
	profile get-scopes	Returns the permission scopes assigned to the currently authenticated User.	Any
	profile list-tokens	Returns all API tokens belonging to the currently authenticated User.	Any
	profile create-token	Creates a Personal Access Token for the currently authenticated User. The token value is returned only at creation — it cannot be retrieved afterwards.	Any
	profile delete-token <token>	Permanently deletes a Personal Access Token belonging to the currently authenticated User.	Any
	profile set-password	Changes the password of the currently authenticated User.	Any
Sessions	sessions list <endpoint>	Returns all active sessions for an Endpoint.	Any
	sessions stop-all <endpoint>	Stops all active sessions for an Endpoint.	System Administrator Domain Administrator
	sessions stop-by-ip <endpoint>	Stops all active sessions for an Endpoint matching a source IP address.	System Administrator Domain Administrator
	sessions stop-by-uuid <endpoint>	Stops a single session identified by its UUID.	System Administrator Domain Administrator
Task Instances	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
Tasks	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
Transfer Schedules	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.	System Administrator Domain Administrator Pipeline Management
	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.	System Administrator Domain Administrator Pipeline Management
	transfer-schedules cancel-all	Cancels all pending scheduled Transfers.	System Administrator Domain Administrator Pipeline Management
Transfers	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.	System Administrator Domain Administrator
	transfers cancel <id>	Cancels the specified in-progress Transfer.	System Administrator Domain Administrator
	transfers cancel-all	Cancels all active Transfers.	System Administrator Domain Administrator
	transfers total	Returns aggregate Transfer counts grouped by status.	Any
Users	users list	Returns all Users.	Any
	users get <name>	Retrieves the full definition of a User identified by username.	Any
	users create	Creates a User.	System Administrator Domain Administrator
	users update <name>	Updates one or more properties of an existing User. Only the flags explicitly provided are sent; omitted flags leave the corresponding fields unchanged.	System Administrator Domain Administrator
	users delete <name>	Permanently deletes a User.	System Administrator Domain Administrator
	users enable <name>	Enables a User.	System Administrator Domain Administrator
	users disable <name>	Disables a User.	System Administrator Domain Administrator
	users set-password <name>	Administratively sets the password for a User without requiring the User's current password.	System Administrator Domain Administrator
	users reset-2fa <name>	Clears the two-factor authentication configuration for a User, requiring them to re-enroll on next login.	System Administrator Domain Administrator
	users auth-unlock <name>	Clears active authentication blocks for a User, allowing them to log in again after exceeding the failed-login attempt limit.	System Administrator Domain Administrator
	users get-roles <name>	Returns all Roles and their permissions assigned to a User.	Any
	users list-tokens <name>	Returns all API tokens belonging to a User.	Any
	users create-token <name>	Creates a new API token for a User.	System Administrator Domain Administrator
	users delete-token <name> <token>	Permanently deletes an API token from a User.	System Administrator Domain Administrator

Command Line Syntax

info

All example commands on this page are cross-shell, they run identically on Linux and Windows CMD/PowerShell.

The following command line syntax is used for issuing CLI commands with the udmg-client binary:

udmg-client [global options] <command-group> <command> [<subcommand>] [<arguments>] [command-specific options]

Command Line Entry	Description
udmg-client	The UDMG Client binary, which executes all CLI commands.
global options	Connection, authentication, and output options for all commands. Can appear anywhere in the command line.
command-group	The top-level command group: users, accounts, account-groups, adhoc, business-services, credentials, endpoints, pipelines, profile, sessions, tasks, task-instances, transfers, or transfer-schedules.
command	The operation to perform within the command group (for example, list, get, create, update, delete).
subcommand	An optional type specifier for commands that dispatch to subtypes (for example, credentials create auth-key or endpoints create local-sftp-server).
arguments	Positional arguments required by some commands, such as a resource name or identifier (for example, <name> or <uuid>).
command-specific options	Options specific to the subcommand.

info

The examples use the bare udmg-client command, which assumes the binary is on your PATH. If it is not, run it with its full path. By default the binary is at /opt/udmg/bin/udmg-client on Linux and C:\Program Files\Stonebranch\UDMG Server\udmg-client.exe on Windows.

Global Options

Global options apply to all commands and can appear anywhere in the command line:

• Server URL, Username, Password, and Domain: required for every command. Can be supplied as environment variables (see Authentication).
• CA Bundle and No Verify SSL: optional TLS options. Can be supplied as environment variables.
• Help: available everywhere.
• Version: used directly on the binary (udmg-client --version).
• Output: available everywhere.

Server URL

Description	URL of the UDMG Server to connect to.
Command Line Switch	--server-url
Environment Variable	UDMG_CLI_SERVER_URL
Required	Yes
Default	(none)
Example	--server-url https://udmg.example.com

Username

Description	UDMG username used to authenticate the connection.
Command Line Switch	--auth-username
Environment Variable	UDMG_CLI_AUTH_USERNAME
Required	Yes
Default	(none)
Example	--auth-username udmg.sys-admin

Password

Description	UDMG password used to authenticate the connection.
Command Line Switch	--auth-password
Environment Variable	UDMG_CLI_AUTH_PASSWORD
Required	Yes
Default	(none)
Example	--auth-password mypassword

Domain

Description	UDMG Domain to operate in.
Command Line Switch	--domain
Environment Variable	UDMG_CLI_DOMAIN
Required	Yes
Default	(none)
Example	--domain primary

CA Bundle

Description	Path to a PEM CA bundle used to validate the UDMG Server certificate. If not provided, the system certificate pool is used.
Command Line Switch	--ca-bundle
Environment Variable	UDMG_CLI_CA_BUNDLE
Required	No
Default	(none)
Example	Linux: --ca-bundle /etc/ssl/certs/ca.pem Windows: --ca-bundle "C:\certs\ca.pem"

No Verify SSL

Description	Disables TLS certificate verification. Insecure; use only in trusted environments.
Command Line Switch	--no-verify-ssl
Environment Variable	UDMG_CLI_NO_VERIFY_SSL
Required	No
Default	false
Example	--no-verify-ssl UDMG_CLI_NO_VERIFY_SSL=true UDMG_CLI_NO_VERIFY_SSL=1

Help

Description	Provides help information for the CLI or for a specific command.
Command Line Switch	-h | --help
Environment Variable	N/A
Required	No
Default	(none)
Example	udmg-client users list --help

Version

Description	Displays version information for udmg-client. Must be used without a command group, for example, udmg-client --version.
Command Line Switch	-v | --version
Environment Variable	N/A
Required	No
Default	(none)
Example	udmg-client --version

Output

Description	Output format for command results. Accepted values: json, yaml, table.
Command Line Switch	--output
Environment Variable	N/A
Required	No
Default	table
Example	--output json

Command Reference

Detailed command syntax, options, and examples are documented on individual pages, one page per command group:

• Account Groups Commands
• Accounts Commands
• Adhoc Commands
• Business Services Commands
• Credentials Commands
• Endpoints Commands
• Pipelines Commands
• Profile Commands
• Sessions Commands
• Task Instances Commands
• Tasks Commands
• Transfer Schedules Commands
• Transfers Commands
• Users Commands

Exit Codes

The following exit codes can be returned by a command:

Exit Code	Description
0	Completed successfully.
1	Command failed due to a network error or an unexpected server response. The error message is written to standard error. If the server returned a response body, it is written to standard output.
2	Invalid usage (for example, an unrecognized flag or a missing required argument). The error message is written to standard error.
3	Authentication or authorization failure (HTTP 401 or 403). The error message is written to standard error. The server response body is written to standard output.