Sessions Commands
The sessions command group views and manages active user sessions on Endpoints.
For command line syntax, see the UDMG Client CLI overview.
Commands Overview
| Command | Description | Required Role |
|---|---|---|
sessions list <endpoint> | Returns all active sessions for an Endpoint. | Any |
sessions stop-all <endpoint> | Stops all active sessions for an Endpoint. |
|
sessions stop-by-ip <endpoint> | Stops all active sessions for an Endpoint matching a source IP address. |
|
sessions stop-by-uuid <endpoint> | Stops a single session identified by its UUID. |
|
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 active sessions for an Endpoint.
Required role
- Any
Command line syntax
udmg-client [global options] sessions list <endpoint>
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 sessions list my-sftp-server
stop-all
Description
Stops all active sessions for an Endpoint.
Required role
- System Administrator
- Domain Administrator
Command line syntax
udmg-client [global options] sessions stop-all <endpoint>
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 sessions stop-all my-sftp-server
stop-by-ip
Description
Stops all active sessions for an Endpoint matching a source IP address.
Required role
- System Administrator
- Domain Administrator
Command line syntax
udmg-client [global options] sessions stop-by-ip <endpoint> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Endpoint name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--ip | Source IP address of the sessions to stop. | 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 sessions stop-by-ip my-sftp-server --ip 192.168.1.100
stop-by-uuid
Description
Stops a single session identified by its UUID.
Required role
- System Administrator
- Domain Administrator
Command line syntax
udmg-client [global options] sessions stop-by-uuid <endpoint> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Endpoint name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--uuid | UUID of the session to stop. | 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 sessions stop-by-uuid my-sftp-server --uuid 550e8400-e29b-41d4-a716-446655440000