For the complete documentation index, see llms.txt. This page is also available as Markdown.

Administration: settings, licenses, and gateways

This page describes the devo admin commands that look after the workspace itself: system settings, authentication modes, and two-factor configuration, licenses, Devolutions Gateway, server caches, and privileged access (PAM) accounts and providers. Each command works with one workspace type only, Devolutions Cloud or Devolutions Server, as the Workspace line under it says. A command run on another workspace type stops with operationNotSupportedBySource and names the type you need.

For the list of all commands, see Commands. For related tasks, see Manage users, groups, and access. The options every command accepts, such as --context or --output json, are described in Global options and aren't repeated here.

Commands that change something refuse to run without --yes (aliases -y and --confirmed) and stop with confirmationRequired. Secret values, such as a license serial, are read from an environment variable or a file, never from the command line, and are hidden in the output.

devo admin settings get

Shows the system settings of the Devolutions Cloud organization, without secrets.

Workspace: Devolutions Cloud.

devo admin settings get

This command has no options of its own.

devo admin settings update

Changes system settings of the Devolutions Cloud organization. Settings you don't mention keep their value, and you must change at least one. Most settings come as a pair of options, one to turn the setting on and one to turn it off: passing both options of a pair stops the command with conflictingOptions.

Workspace: Devolutions Cloud.

devo admin settings update [options] --yes
OPTION
DEFAULT
WHAT IT DOES

--allow-devolutions-account-login

Off

Allows users to sign in with a Devolutions account. Opposite of --disable-devolutions-account-login.

--disable-devolutions-account-login

Off

Stops users from signing in with a Devolutions account.

--allow-sso-login

Off

Allows single sign-on (SSO). Opposite of --disable-sso-login. This change is applied after the other settings of the same command. If it fails after the other settings were saved, the error says so.

--disable-sso-login

Off

Turns off single sign-on (SSO). Applied after the other settings, like --allow-sso-login.

--force-sso-login

Off

Forces SSO for all users. If your SSO identity provider is down, users can't sign in to Devolutions Cloud. Opposite of --no-force-sso-login.

--no-force-sso-login

Off

Stops forcing SSO sign-in.

--force-two-factor-authentication (--force-two-factor)

Off

Makes two-factor authentication mandatory. Opposite of --no-force-two-factor-authentication.

--no-force-two-factor-authentication (--no-force-two-factor)

Off

Stops making two-factor authentication mandatory.

--allow-user-vault

Off

Allows access to user vaults. Opposite of --disable-user-vault.

--disable-user-vault

Off

Turns off access to user vaults.

--block-tor-traffic

Off

Blocks connections that come from the Tor network. Opposite of --allow-tor-traffic.

--allow-tor-traffic

Off

Allows connections that come from the Tor network.

--enable-gateway-recording

Off

Turns on Devolutions Gateway session recording. Opposite of --disable-gateway-recording.

--disable-gateway-recording

Off

Turns off Devolutions Gateway session recording.

--enable-devolutions-send

Off

Turns on Devolutions Send. Opposite of --disable-devolutions-send.

--disable-devolutions-send

Off

Turns off Devolutions Send.

--enable-encryption-service

Off

Turns on the encryption service setting. Opposite of --disable-encryption-service.

--disable-encryption-service

Off

Turns off the encryption service setting.

--enable-ip-allow-list

Off

Turns on the IP allowlist, which restricts access to the IP ranges it contains. Opposite of --disable-ip-allow-list. This option turns the list on or off; it doesn't change the ranges in it.

--disable-ip-allow-list

Off

Turns off the IP allow list.

--send-usage-data

Off

Turns on sending usage data. Opposite of --no-send-usage-data.

--no-send-usage-data

Off

Stops sending usage data.

--system-message <text>

New system message shown to users. Pass an empty value (--system-message "") to clear it.

--inactivity-logout-time <value>

New inactivity logout time. Devolutions Cloud offers Off, 5, 10, 15, 30, or 60 minutes, or 2, 4, 6, 8, 12, or 24 hours. Devolutions CLI sends the value as you type it, without checking it: write it in the form devo admin settings get shows. Spaces around the value are removed, and an empty value is refused.

--yes (-y, --confirmed)

Off

Confirms the change. Required.

devo admin settings auth-modes get

Shows which authentication modes are turned on in Devolutions Server.

Workspace: Devolutions Server.

This command has no options of its own.

devo admin settings auth-modes set

Turns the Azure AD, custom, or domain authentication mode of Devolutions Server on or off. Devolutions CLI reads the current modes first and changes only the ones you pass; the others keep their value. At least one primary authentication mode must stay on: a change that would turn them all off is refused with invalidOperation.

Workspace: Devolutions Server.

OPTION
DEFAULT
WHAT IT DOES

--azure-ad <true|false>

Turns Microsoft Entra ID (Azure AD) authentication on (true) or off (false).

--custom <true|false>

Turns custom Devolutions Server authentication on (true) or off (false).

--domain <true|false>

Turns domain (Active Directory) authentication on (true) or off (false).

--yes (-y, --confirmed)

Off

Confirms the change. Required.

Pass at least one of --azure-ad, --custom, and --domain. Any value other than true or false is refused.

devo admin settings two-factor get

Shows the two-factor authentication configuration of Devolutions Server: the methods users can choose, the default method, and related settings.

Workspace: Devolutions Server.

This command has no options of its own.

devo admin license list

Lists the licenses of Devolutions Server, with their serial numbers partly hidden. Alias: devo admin license ls.

Workspace: Devolutions Server.

This command has no options of its own.

devo admin license register

Registers a license on Devolutions Server, from a license serial or a license token read from an environment variable or a file.

Workspace: Devolutions Server.

OPTION
DEFAULT
WHAT IT DOES

--serial-env <variable> (--license-jwt-env)

Name of the environment variable that holds the license serial or license token. Pass this option or --serial-file: one of them is required, not both. Spaces and line breaks around the value are removed, and an empty value is refused.

--serial-file <path> (--license-jwt-file)

File that holds the license serial or license token.

--auto-assign <true|false>

false

Whether licenses that support it are assigned automatically to new users. Any other value is refused.

--replace

Off

Removes the existing licenses before saving the new one.

--specific-serial-env <variable>

When the license token holds several licenses: name of the environment variable that holds the one serial to save. Use this option or --specific-serial-file, not both.

--specific-serial-file <path>

When the license token holds several licenses: file that holds the one serial to save.

--yes (-y, --confirmed)

Off

Confirms the registration. Required.

devo admin license trial start

Starts a trial license on Devolutions Server.

Workspace: Devolutions Server.

OPTION
DEFAULT
WHAT IT DOES

--requester-email <email>

Email address of the person who requests the trial. Sent only when you pass it; pass it when the server asks for one.

--yes (-y, --confirmed)

Off

Confirms the trial start. Required.

devo admin license users list

Lists the users assigned to one Devolutions Server license. Alias: devo admin license users ls.

Workspace: Devolutions Server.

OPTION
DEFAULT
WHAT IT DOES

--serial-env <variable>

Name of the environment variable that holds the license serial. Pass this option or --serial-file: one of them is required, not both. An empty serial is refused.

--serial-file <path>

File that holds the license serial.

devo admin gateway list

Lists the Devolutions Gateway instances of the Devolutions Cloud organization, without their secrets. Alias: devo admin gateway ls.

Workspace: Devolutions Cloud.

This command has no options of its own.

devo admin gateway get

Shows one Devolutions Gateway instance, without its secrets.

Workspace: Devolutions Cloud.

OPTION
DEFAULT
WHAT IT DOES

--gateway-id <id> (--id)

Required. ID of the gateway, as a GUID. Get it from devo admin gateway list.

devo admin gateway delete

Deletes a Devolutions Gateway instance from the Devolutions Cloud organization. Alias: devo admin gateway rm.

Workspace: Devolutions Cloud.

OPTION
DEFAULT
WHAT IT DOES

--gateway-id <id> (--id)

Required. ID of the gateway, as a GUID.

--yes (-y, --confirmed)

Off

Confirms the deletion. Required.

devo admin gateway settings get

Shows the Devolutions Gateway settings of the Devolutions Cloud organization, without secrets.

Workspace: Devolutions Cloud.

This command has no options of its own.

devo admin gateway revocation-list publish

Publishes the revocation list of one Devolutions Gateway, or of every gateway, from Devolutions Server.

Workspace: Devolutions Server.

OPTION
DEFAULT
WHAT IT DOES

--gateway-id <id>

All gateways

ID of the gateway, as a GUID. Leave it out to publish the revocation lists of all gateways.

--yes (-y, --confirmed)

Off

Confirms the publication. Required.

devo admin cache reset

Clears selected caches of Devolutions Server, so it reloads the data.

Workspace: Devolutions Server.

OPTION
DEFAULT
WHAT IT DOES

--element <element> (-e)

Cache to clear. Repeat the option to clear several. At least one is needed. Values, without case sensitivity: all, connections, domain, repositories (or vaults), roles (or groups), office365 (or office-365), and users. An unknown value is refused.

--yes (-y, --confirmed)

Off

Confirms the reset. Required.

devo admin pam account list

Lists privileged accounts of Devolutions Server, without their secrets. Alias: devo admin pam account ls.

Workspace: Devolutions Server.

OPTION
DEFAULT
WHAT IT DOES

--vault-id <id> (--folder-id)

All

Lists only the accounts of this privileged access vault or folder. The ID is a GUID.

--page <number>

1

Page to fetch, starting at 1.

--page-size <size>

100

Number of accounts per page, from 1 to 500.

devo admin pam provider list

Lists the privileged access providers of Devolutions Server, without their secrets. Alias: devo admin pam provider ls.

Workspace: Devolutions Server.

This command has no options of its own.

devo admin pam provider get

Shows one privileged access provider, without its secrets.

Workspace: Devolutions Server.

OPTION
DEFAULT
WHAT IT DOES

--provider-id <id>

Required. ID of the provider, as a GUID. Get it from devo admin pam provider list.

Last updated

Was this helpful?