Devolutions Server Console command line interface

The Devolutions Server Console Command Line Interface (CLI) is a Companion tool which allows administrators to interact with Devolutions Server instances, the Scheduler, the Recording Server or the Gateway with create, configure or delete operations. It is automatically available with the installation of the Devolutions Server Console. The DPS.Console.CLI.exe file is located in the Devolutions Server Console application installation folder. The /help switch will list all available commands and parameters.

Devolutions Server Console CLI commands list
Devolutions Server Console CLI commands list

The /help switch can be used to list command's parameters.

CLI command parameters
CLI command parameters

The following sample command launch the upgrade process from a zip file available in C:\temp folder.

.\DPS.Console.CLI.exe server upgrade --dps "Default Web Site/dps" --zip "C:\temp\DVLS.2020.3.17.0.zip" --accept-eula -quiet -verbose.

The following command will create a new Devolutions Server instance from a JSON response file (see below) that contains the required parameters. It can be used with any of the main commands of the CLI.

CLI with JSON file
CLI with JSON file

Sample of a JSON response file for creating a new Devolutions Server instance.

{
  "acceptEula": true,
  "adminEmail": "admin@mydomain.org",
  "adminPassword": "AdminPassword",
  "adminUsername": "admin",
  "appPoolIdentityType": "Network Service",
  "appPoolIdentityPassword": null,
  "appPoolIdentityUsername": null,
  "command": "server install",
  "consolepwd": "MyConsolePassword",
  "databaseHost": "SQLServer\SQL2017",
  "databaseIntegratedSecurity": false,
  "databaseName": "DVLS",
  "databaseConsolePassword": "MyPassword",
  "databaseConsoleUsername": "VaultDBOwner",
  "databaseSchedulerPassword": "MyPassword",
  "databaseSchedulerUsername": "VaultDBScheduler",
  "databaseVaultPassword": "MyPassword",
  "databaseVaultUsername": "VaultDBRunner",
  "debug": false,
  "disableEncryptConfig": false,
  "disableHttps": false,
  "disablePassword": false,
  "dpsPath": "C:\\inetpub\\wwwroot\\dvls",
  "dpsWebsiteName": "Default Web Site",
  "installZip": null,
  "keysPath": "C:\\temp\\DVLS_EncryptionKeys.bin",
  "keysPassword": "MyKeysPassword",
  "quiet": false,
  "scheduler": true,
  "serial": "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "serverName": "Devolutions Server",
  "serviceAccount": "LocalSystem",
  "servicePassword": null,
  "serviceUser": null,
  "webApplicationName": "/dvls",
  "verbose": false
}