> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/server/knowledge-base/knowledge-base-articles/devolutions-server-console-command-line-interface.md).

# 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 a 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.

### Using the CLI

The ***/help*** switch will list all available commands and parameters.

<figure><img src="https://cdnweb.devolutions.net/docs/docs_en_kb_KB8032.png" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://cdnweb.devolutions.net/docs/docs_en_kb_KB8033.png" alt=""><figcaption></figcaption></figure>

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.20XX.X.X.X.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.

<figure><img src="https://cdnweb.devolutions.net/docs/docs_en_kb_KB8034.png" alt=""><figcaption></figcaption></figure>

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

```json
{
  "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": "DSERVER",
  "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
}
```

#### Emergency procedure

A break glass account is often used as a last-resort mechanism to ensure that essential IT operations or security functions can continue in the event of an outage, system failure, or security incident. With the Devolutions Server console command line interface, we can disable the custom authentication and enable it on demand if the main Identity Provider is out of service. The administrator custom account must have already been created in the Devolutions Server instance.

{% hint style="info" %}
Please note that you should replace `dvls` (after ...`\wwwroot\`) with your own custom ***Devolutions Server*** IIS Application name.
{% endhint %}

**Enabling custom authentication**

In the CLI enter either:

```powershell
server instance --instance=C:\inetpub\wwwroot\dvls --enable-custom-authentication=true
```

or

```powershell
server instance --instance=C:\inetpub\wwwroot\dvls --custom-auth=true
```

**Disabling custom authentication**

When done with the necessary operations:

```powershell
server instance --instance=C:\inetpub\wwwroot\dvls --enable-custom-authentication=false
```

or

```powershell
server instance --instance=C:\inetpub\wwwroot\dvls --custom-auth=false
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.devolutions.net/server/knowledge-base/knowledge-base-articles/devolutions-server-console-command-line-interface.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.