Endpoints Commands

The endpoints command group manages Endpoints — the connection points for file transfer protocols (SFTP, FTP, AS2, cloud storage, and WTC) within a UDMG Domain.

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
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

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 endpoints create and endpoints update to target a specific protocol or storage provider.

Subcommand	Endpoint Type
local-filesystem	Local Filesystem
local-as2-server	Local AS2 Server
remote-as2-client	Remote AS2 Server
local-ftp-server	Local FTP Server
remote-ftp-server	Remote FTP Server
local-wtc-server	Local HTTPS Server (WTC)
local-sftp-server	Local SFTP Server
remote-sftp-server	Remote SFTP Server
cloud-s3	Remote Cloud Storage (Amazon S3)
cloud-azure-blob	Remote Cloud Storage (Azure Blob Storage)
cloud-azure-files	Remote Cloud Storage (Azure Files)
cloud-gcs	Remote Cloud Storage (Google Cloud Storage)

Commands Reference

list

Description

Returns all Endpoints.

Required role

• Any

Command line syntax

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

Command-specific options

Option	Description	Required	Default
--type	Filter by endpoint type (e.g. local:sftp:server).	No	(none)
--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 endpoints list --type local:sftp:server --enabled true --page 1 --page-size 10 --order asc

get

Description

Retrieves the full definition of an Endpoint identified by name.

Required role

• Any

Command line syntax

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

Arguments

Argument	Description
<name>	Endpoint 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 endpoints get my-sftp-server

delete

Description

Permanently deletes an Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

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

Arguments

Argument	Description
<name>	Endpoint 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 endpoints delete my-sftp-server

create

Description

Creates an Endpoint. A type subcommand must be specified to identify the protocol and direction of the Endpoint.

create local-filesystem

Description

Creates a local filesystem storage Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints create local-filesystem [command-specific options]

Command-specific options

Option	Description	Required	Default
--name	Endpoint name.	Yes	N/A
--path	Filesystem path.	Yes	N/A
--tmp-path	Temporary staging path. Required unless --skip-staging is set.	No	(none)
--enable-icap	Enable ICAP antivirus scanning. Only applies when --skip-staging is not set (staging mode).	No	false
--skip-staging	Skip the staging directory. Required unless --tmp-path is set.	No	false
--description	The description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint to.	No	(none)
--enabled	Whether the Endpoint is enabled on creation. Accepted values: true, false.	No	true

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 endpoints create local-filesystem --name local-fs --path /data --tmp-path /temp

create local-as2-server

Description

Creates a local AS2 server Endpoint hosted by UDMG.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints create local-as2-server [command-specific options]

Command-specific options

Option	Description	Required	Default
--name	Endpoint name.	Yes	N/A
--addr	Listener IP address.	Yes	N/A
--port	Listening port (1–65535).	Yes	N/A
--as2-id	Local AS2 identifier.	Yes	N/A
--credentials-signing-name	Signing certificate credentials name.	Yes	N/A
--login-methods	Authentication method (e.g. Partner Certificate Mapping).	No	(none)
--message-level-security	Message security level (e.g. Signed and Encrypted).	No	(none)
--retention-period	Message ID retention period in minutes for duplicate detection.	No	(none)
--max-connections	Maximum simultaneous connections (0 = unlimited).	No	(none)
--credentials-tls-name	TLS credentials name.	No	(none)
--log-level	Log level. Accepted values: debug, info, warn, error.	No	(none)
--description	The description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint to.	No	(none)
--enabled	Whether the Endpoint is enabled on creation. Accepted values: true, false.	No	true

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 endpoints create local-as2-server --name local-as2 --addr 0.0.0.0 --port 5080 --as2-id acme-as2 --credentials-signing-name my-signing-cert --login-methods password --message-level-security false --retention-period 30 --max-connections 10 --credentials-tls-name my-tls-cert --log-level info

create remote-as2-client

Description

Creates a connection to a remote AS2 server.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints create remote-as2-client [command-specific options]

Command-specific options

Option	Description	Required	Default
--name	Endpoint name.	Yes	N/A
--url	Remote AS2 server URL.	Yes	N/A
--as2-id	Local AS2 identifier.	Yes	N/A
--partner-id	Partner AS2 identifier.	Yes	N/A
--mdn-disposition	MDN disposition. Accepted values: synchronous, asynchronous, none.	No	(none)
--signing-cert-name	Signing certificate credentials name.	No	(none)
--signing-public-cert-name	Signing public certificate credentials name.	No	(none)
--signing-cert-pair-name	Signing certificate pair credentials name.	No	(none)
--encryption-cert-name	Encryption certificate credentials name.	No	(none)
--encrypt-messages	Encrypt outgoing messages.	No	false
--sign-messages	Sign outgoing messages.	No	false
--compress	Compress messages.	No	false
--mdn-required	Require MDN receipt.	No	false
--mdn-sign-required	Require signed MDN.	No	false
--mdn-timeout	MDN timeout in seconds.	No	(none)
--validate-certs	Validate partner certificates.	No	false
--insecure-skip-verify	Skip TLS certificate verification.	No	false
--mic-digest	MIC digest algorithm. Accepted values: sha1, sha224, sha256, sha384, sha512.	No	(none)
--proxy-url	HTTP proxy URL.	No	(none)
--subject	AS2 message subject.	No	(none)
--header	Custom HTTP header in Key: Value format (repeatable).	No	(none)
--description	The description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint to.	No	(none)
--enabled	Whether the Endpoint is enabled on creation. Accepted values: true, false.	No	true

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 endpoints create remote-as2-client --name partner-as2 --url https://partner.example.com/as2 --as2-id acme-as2 --partner-id partner-as2-id --mdn-disposition synchronous --signing-cert-name my-signing-cert --signing-public-cert-name my-signing-pub-cert --signing-cert-pair-name my-signing-cert-pair --encryption-cert-name my-encryption-cert --encrypt-messages true --sign-messages true --compress false --mdn-required true --mdn-sign-required true --mdn-timeout 30 --validate-certs true --insecure-skip-verify false --mic-digest sha1 --proxy-url http://proxy.example.com:3128 --subject "AS2 Transfer" --header "X-Custom-Header: value"

create local-ftp-server

Description

Creates a local FTP/FTPS server Endpoint hosted by UDMG.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints create local-ftp-server [command-specific options]

Command-specific options

Option	Description	Required	Default
--name	Endpoint name.	Yes	N/A
--port	Listening port (1–65535).	Yes	N/A
--addr	Listener IP address.	Yes	N/A
--pasv-min-port	Passive mode minimum port.	Yes	N/A
--pasv-max-port	Passive mode maximum port.	Yes	N/A
--public-ip	Public IP address advertised in PASV responses.	Yes	N/A
--encrypt-mode	Encryption mode. Accepted values: None, Explicit, Implicit.	No	(none)
--credentials-tls-name	TLS credentials name.	No	(none)
--max-connections	Maximum simultaneous connections (0 = unlimited).	No	(none)
--welcome-message	FTP welcome message.	No	(none)
--tls-min-version	TLS minimum version. Accepted values: 1.0, 1.1, 1.2, 1.3.	No	(none)
--tls-max-version	TLS maximum version. Accepted values: 1.0, 1.1, 1.2, 1.3.	No	(none)
--tls-cipher-suites	TLS cipher suites (comma-separated).	No	(none)
--log-level	Log level. Accepted values: debug, info, warn, error.	No	(none)
--description	The description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint to.	No	(none)
--enabled	Whether the Endpoint is enabled on creation. Accepted values: true, false.	No	true

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 endpoints create local-ftp-server --name local-ftp --port 2121 --addr 0.0.0.0 --pasv-min-port 49152 --pasv-max-port 65535 --public-ip 203.0.113.1 --encrypt-mode None --credentials-tls-name my-tls-cert --max-connections 10 --welcome-message "Welcome to UDMG FTP Server" --tls-min-version 1.2 --tls-max-version 1.3 --tls-cipher-suites TLS_AES_128_GCM_SHA256,TLS_AES_256_GCM_SHA384 --log-level info

create remote-ftp-server

Description

Creates a connection to a remote FTP/FTPS server.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints create remote-ftp-server [command-specific options]

Command-specific options

Option	Description	Required	Default
--name	Endpoint name.	Yes	N/A
--port	Remote FTP port (1–65535).	Yes	N/A
--addr	Remote FTP address (IP or hostname).	Yes	N/A
--credentials-name	Credentials name for authentication.	No	(none)
--encrypt-mode	Encryption mode. Accepted values: None, Explicit, Implicit.	No	(none)
--disable-tls13	Disable TLS 1.3.	No	false
--skip-verify-tls-cert	Skip TLS certificate verification.	No	false
--disable-epsv	Disable EPSV mode.	No	false
--disable-mlsd	Disable MLSD command.	No	false
--disable-utf8	Disable UTF-8 encoding.	No	false
--writing-mdtm	Use MDTM to set file modification time after upload.	No	false
--no-check-upload	Disable upload size verification.	No	false
--use-forward-proxy	Route the connection through the forward proxy.	No	false
--description	The description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint to.	No	(none)
--enabled	Whether the Endpoint is enabled on creation. Accepted values: true, false.	No	true

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 endpoints create remote-ftp-server --name ftp.example.com --port 21 --addr 0.0.0.0 --credentials-name my-credential --encrypt-mode None --disable-tls13 false --skip-verify-tls-cert false --disable-epsv false --disable-mlsd false --disable-utf8 false --writing-mdtm false --no-check-upload false --use-forward-proxy false

create local-wtc-server

Description

Creates a Web Transfer Client (WTC) HTTPS server Endpoint. Only one WTC server Endpoint can exist per Domain.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints create local-wtc-server [command-specific options]

Command-specific options

Option	Description	Required	Default
--name	Endpoint name.	Yes	N/A
--allow-change-password	Allow users to change their password via WTC.	No	true
--checksum-algo	File checksum algorithm. Accepted values: md5, sha1, sha256, sha384, sha512.	No	(none)
--sys-disclaimer-label	System disclaimer text displayed at login.	No	(none)
--sys-version-label	System version label.	No	(none)
--sys-identifier-label	System identifier banner.	No	(none)
--wtc-logo	Base64-encoded logo image (max 200 KB).	No	(none)
--description	The description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint to.	No	(none)
--enabled	Whether the Endpoint is enabled on creation. Accepted values: true, false.	No	true

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 endpoints create local-wtc-server --name local-wtc-server --allow-change-password true --checksum-algo md5 --sys-disclaimer-label "Authorized users only" --sys-version-label "1.0" --sys-identifier-label "UDMG" --wtc-logo data:image/png;base64,iVBORw0KGgo=

create local-sftp-server

Description

Creates a local SFTP server Endpoint hosted by UDMG.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints create local-sftp-server [command-specific options]

Command-specific options

Option	Description	Required	Default
--name	Endpoint name.	Yes	N/A
--port	Listening port (1–65535).	Yes	N/A
--addr	Listener IP address.	Yes	N/A
--credentials-name	SSH host key credentials name.	Yes	N/A
--login-methods	Authentication method. Accepted values: password, publicKey, passwordOrPubKey, passwordAndPubKey.	No	(none)
--max-connections	Maximum simultaneous connections (0 = unlimited).	No	(none)
--ciphers	Allowed SSH ciphers (comma-separated).	No	(none)
--key-exchanges	Allowed key exchange algorithms (comma-separated).	No	(none)
--macs	Allowed MAC algorithms (comma-separated).	No	(none)
--log-level	Log level. Accepted values: debug, info, warn, error.	No	(none)
--description	The description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint to.	No	(none)
--enabled	Whether the Endpoint is enabled on creation. Accepted values: true, false.	No	true

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 endpoints create local-sftp-server --name local-sftp --port 2222 --addr 0.0.0.0 --credentials-name my-credential --login-methods password --max-connections 10 --ciphers aes128-ctr,aes256-ctr --key-exchanges ecdh-sha2-nistp256,diffie-hellman-group14-sha256 --macs hmac-sha2-256,hmac-sha2-512 --log-level info

create remote-sftp-server

Description

Creates a connection to a remote SFTP server.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints create remote-sftp-server [command-specific options]

Command-specific options

Option	Description	Required	Default
--name	Endpoint name.	Yes	N/A
--port	Remote SFTP port (1–65535).	Yes	N/A
--addr	Remote SFTP address (IP or hostname).	Yes	N/A
--credentials-name	Credentials name for authentication.	No	(none)
--ciphers	Allowed SSH ciphers (comma-separated).	No	(none)
--key-exchanges	Allowed key exchange algorithms (comma-separated).	No	(none)
--macs	Allowed MAC algorithms (comma-separated).	No	(none)
--use-forward-proxy	Route the connection through the forward proxy.	No	false
--description	The description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint to.	No	(none)
--enabled	Whether the Endpoint is enabled on creation. Accepted values: true, false.	No	true

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 endpoints create remote-sftp-server --name sftp.example.com --port 22 --addr 0.0.0.0 --credentials-name my-credential --ciphers aes128-ctr,aes256-ctr --key-exchanges ecdh-sha2-nistp256,diffie-hellman-group14-sha256 --macs hmac-sha2-256,hmac-sha2-512 --use-forward-proxy false

create cloud-s3

Description

Creates an Amazon S3 or compatible cloud storage Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints create cloud-s3 [command-specific options]

Command-specific options

Option	Description	Required	Default
--name	Endpoint name.	Yes	N/A
--provider	S3 provider (e.g. AWS, Minio).	Yes	N/A
--region	S3 region.	No	(none)
--path	Root path prefix within the bucket.	No	(none)
--use-forward-proxy	Route the connection through the forward proxy.	No	false
--configuration	Full rclone configuration JSON (merged with individual flags).	No	(none)
--description	The description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint to.	No	(none)
--enabled	Whether the Endpoint is enabled on creation. Accepted values: true, false.	No	true

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 endpoints create cloud-s3 --name my-s3 --provider aws --region us-east-1 --path transfers --use-forward-proxy false --configuration default

create cloud-azure-blob

Description

Creates an Azure Blob Storage Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints create cloud-azure-blob [command-specific options]

Command-specific options

Option	Description	Required	Default
--name	Endpoint name.	Yes	N/A
--account	Azure storage account name.	Yes	N/A
--path	Root path prefix within the container.	No	(none)
--use-forward-proxy	Route the connection through the forward proxy.	No	false
--configuration	Full rclone configuration JSON.	No	(none)
--description	The description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint to.	No	(none)
--enabled	Whether the Endpoint is enabled on creation. Accepted values: true, false.	No	true

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 endpoints create cloud-azure-blob --name my-azure-blob --account udmgblob --path transfers --use-forward-proxy false --configuration default

create cloud-azure-files

Description

Creates an Azure Files storage Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints create cloud-azure-files [command-specific options]

Command-specific options

Option	Description	Required	Default
--name	Endpoint name.	Yes	N/A
--account	Azure storage account name.	Yes	N/A
--path	Root path prefix within the share.	No	(none)
--use-forward-proxy	Route the connection through the forward proxy.	No	false
--configuration	Full rclone configuration JSON.	No	(none)
--description	The description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint to.	No	(none)
--enabled	Whether the Endpoint is enabled on creation. Accepted values: true, false.	No	true

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 endpoints create cloud-azure-files --name my-azure-files --account udmgfiles --path transfers --use-forward-proxy false --configuration default

create cloud-gcs

Description

Creates a Google Cloud Storage Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints create cloud-gcs [command-specific options]

Command-specific options

Option	Description	Required	Default
--name	Endpoint name.	Yes	N/A
--project	GCS project ID.	Yes	N/A
--path	Root path prefix within the bucket.	No	(none)
--use-forward-proxy	Route the connection through the forward proxy.	No	false
--configuration	Full rclone configuration JSON.	No	(none)
--description	The description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint to.	No	(none)
--enabled	Whether the Endpoint is enabled on creation. Accepted values: true, false.	No	true

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 endpoints create cloud-gcs --name my-gcs --project my-gcp-project --path transfers --use-forward-proxy false --configuration default

update

Description

Updates an Endpoint. A type subcommand must be specified, followed by the name of the Endpoint to update.

Type-specific flags match those listed under endpoints create for the corresponding type, but are all optional.

update local-filesystem

Description

Updates a local filesystem Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints update local-filesystem <name> [command-specific options]

Arguments

Argument	Description
<name>	Endpoint name.

Command-specific options

Option	Description	Required	Default
--name	New name for the Endpoint.	No	(none)
--description	The new description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint 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 endpoints update local-filesystem local-storage --path /data/new-transfers

update local-as2-server

Description

Updates a local AS2 server Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints update local-as2-server <name> [command-specific options]

Arguments

Argument	Description
<name>	Endpoint name.

Command-specific options

Option	Description	Required	Default
--name	New name for the Endpoint.	No	(none)
--description	The new description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint 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 endpoints update local-as2-server my-as2-server --retention-period 1440

update remote-as2-client

Description

Updates a remote AS2 client Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints update remote-as2-client <name> [command-specific options]

Arguments

Argument	Description
<name>	Endpoint name.

Command-specific options

Option	Description	Required	Default
--name	New name for the Endpoint.	No	(none)
--description	The new description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint 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 endpoints update remote-as2-client partner-as2 --mdn-timeout 30

update local-ftp-server

Description

Updates a local FTP/FTPS server Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints update local-ftp-server <name> [command-specific options]

Arguments

Argument	Description
<name>	Endpoint name.

Command-specific options

Option	Description	Required	Default
--name	New name for the Endpoint.	No	(none)
--description	The new description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint 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 endpoints update local-ftp-server my-ftp-server --welcome-message "Welcome to UDMG FTP"

update remote-ftp-server

Description

Updates a remote FTP/FTPS server Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints update remote-ftp-server <name> [command-specific options]

Arguments

Argument	Description
<name>	Endpoint name.

Command-specific options

Option	Description	Required	Default
--name	New name for the Endpoint.	No	(none)
--description	The new description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint 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 endpoints update remote-ftp-server partner-ftp --encrypt-mode Implicit

update local-wtc-server

Description

Updates a local WTC server Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints update local-wtc-server <name> [command-specific options]

Arguments

Argument	Description
<name>	Endpoint name.

Command-specific options

Option	Description	Required	Default
--name	New name for the Endpoint.	No	(none)
--description	The new description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint 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 endpoints update local-wtc-server wtc-server --sys-disclaimer-label "Authorized use only"

update local-sftp-server

Description

Updates a local SFTP server Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints update local-sftp-server <name> [command-specific options]

Arguments

Argument	Description
<name>	Endpoint name.

Command-specific options

Option	Description	Required	Default
--name	New name for the Endpoint.	No	(none)
--description	The new description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint 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 endpoints update local-sftp-server my-endpoint --name my-endpoint-updated --description "Managed endpoint" --business-service my-service

update remote-sftp-server

Description

Updates a remote SFTP server Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints update remote-sftp-server <name> [command-specific options]

Arguments

Argument	Description
<name>	Endpoint name.

Command-specific options

Option	Description	Required	Default
--name	New name for the Endpoint.	No	(none)
--description	The new description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint 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 endpoints update remote-sftp-server partner-sftp --addr sftp-new.partner.example.com

update cloud-s3

Description

Updates an Amazon S3 or compatible cloud storage Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints update cloud-s3 <name> [command-specific options]

Arguments

Argument	Description
<name>	Endpoint name.

Command-specific options

Option	Description	Required	Default
--name	New name for the Endpoint.	No	(none)
--description	The new description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint 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 endpoints update cloud-s3 s3-archive --region eu-west-1

update cloud-azure-blob

Description

Updates an Azure Blob Storage Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints update cloud-azure-blob <name> [command-specific options]

Arguments

Argument	Description
<name>	Endpoint name.

Command-specific options

Option	Description	Required	Default
--name	New name for the Endpoint.	No	(none)
--description	The new description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint 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 endpoints update cloud-azure-blob azure-storage --name azure-storage-v2

update cloud-azure-files

Description

Updates an Azure Files storage Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints update cloud-azure-files <name> [command-specific options]

Arguments

Argument	Description
<name>	Endpoint name.

Command-specific options

Option	Description	Required	Default
--name	New name for the Endpoint.	No	(none)
--description	The new description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint 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 endpoints update cloud-azure-files azure-files --description "Updated Azure Files endpoint"

update cloud-gcs

Description

Updates a Google Cloud Storage Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints update cloud-gcs <name> [command-specific options]

Arguments

Argument	Description
<name>	Endpoint name.

Command-specific options

Option	Description	Required	Default
--name	New name for the Endpoint.	No	(none)
--description	The new description of the Endpoint.	No	(none)
--business-service	Business Service name to assign this Endpoint 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 endpoints update cloud-gcs gcs-archive --path new-prefix

enable

Description

Enables an Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management
• Operator

Command line syntax

udmg-client [global options] endpoints enable <name>

Arguments

Argument	Description
<name>	Endpoint 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 endpoints enable my-sftp-server

disable

Description

Disables an Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management
• Operator

Command line syntax

udmg-client [global options] endpoints disable <name>

Arguments

Argument	Description
<name>	Endpoint 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 endpoints disable my-sftp-server

start

Description

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.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management
• Operator

Command line syntax

udmg-client [global options] endpoints start <name>

Arguments

Argument	Description
<name>	Endpoint 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 endpoints start my-sftp-server

stop

Description

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.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management
• Operator

Command line syntax

udmg-client [global options] endpoints stop <name>

Arguments

Argument	Description
<name>	Endpoint 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 endpoints stop my-sftp-server

restart

Description

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.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management
• Operator

Command line syntax

udmg-client [global options] endpoints restart <name>

Arguments

Argument	Description
<name>	Endpoint 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 endpoints restart my-sftp-server

set-log-level

Description

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.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints set-log-level <name> [command-specific options]

Arguments

Argument	Description
<name>	Endpoint name.

Command-specific options

Option	Description	Required	Default
--level	Log level. Accepted values: debug, info, warn, error.	Yes	N/A

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 endpoints set-log-level my-endpoint --level info

list-pipelines

Description

Returns all Pipelines that use the specified Endpoint as source or destination.

Required role

• Any

Command line syntax

udmg-client [global options] endpoints list-pipelines <name>

Arguments

Argument	Description
<name>	Endpoint 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 endpoints list-pipelines my-sftp-server

test

Description

Runs a connectivity test for the specified Endpoint.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] endpoints test <name> [command-specific options]

Arguments

Argument	Description
<name>	Endpoint name.

Command-specific options

Option	Description	Required	Default
--credentials-name	Credentials name to use for the test. Required for cloud storage endpoints.	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 endpoints test my-endpoint --credentials-name my-credential

list-versions

Description

Returns the version history of an Endpoint.

Required role

• Any

Command line syntax

udmg-client [global options] endpoints list-versions <name> [command-specific options]

Arguments

Argument	Description
<name>	Endpoint 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 endpoints list-versions my-endpoint --page 1 --page-size 10

get-version

Description

Retrieves a specific historical version of an Endpoint.

Required role

• Any

Command line syntax

udmg-client [global options] endpoints get-version <name> <version-id>

Arguments

Argument	Description
<name>	Endpoint 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 endpoints get-version my-sftp-server a1b2c3d4-e5f6-7890-abcd-ef1234567890