Please enable JavaScript to view this site.

Command Line Interface

Description

A Command Line Interface (CLI) is a Companion Tool which allows DVLS users to access credentials with the command line.

Listed below are the available command line:

Config

Parameters:

-v        --vault

The default vault id to use for the other commands: 0000000-0000-0000-0000-000000000000

 

-s        --server

The address of the server to connect to.

If you call config without parameters, it will return the current settings.

Options:

-j        --json

The command output will be formatted in JSON format.

Examples:

Devolutions Server CLI examples

Devolutions Server CLI examples

Get

Returns the credentials of an entry based on its id.

Parameters:

The entry's id can be found in its advance property or in the last part of its URL.

KB4351

Options:

-j        --json

The command output will be formatted in JSON format.

 

-d        --domain

Only returns the domain.

 

-u        --username

Only returns the username.

 

-p        --password

Only returns the password.

Examples:

DPS> get 4574725f-0d24-4cbc-a116-a5270179e251

domain:   dddd

username: asdf

password: 12345

 

DPS> get 4574725f-0d24-4cbc-a116-a5270179e251 --json

{

 "domain": "dddd",

 "username": "asdf",

 "password": "12345"

}

DPS> get 4574725f-0d24-4cbc-a116-a5270179e251 -u

asdf

DPS> get 4574725f-0d24-4cbc-a116-a5270179e251 -p

12345

KB4352

Login

Parameters:

First parameter: the username (the key, if the user is of the type application)

Second parameter: the password (the secret, if the user is of the type application)

KB4353

The user/application must have the right to use the CLI

KB4354

Options:

-j        --json

The command output will be formatted in JSON format.

Examples:

DPS> login dsavard 12345

KB4355

Logout

Logout the current user.

KB4356

Set

Update the credentials of an entry.

Parameters:

The entry's id can be found in its advance property or in the last part of its URL.

KB4357

Options:

-j        --json

The command output will be formatted in JSON format.

 

-d        --domain new-value

Update the domain.

 

-u        --username new-value

Update the username.

 

-p        --password new-value

Update the password.

Examples:

DPS> set 4574725f-0d24-4cbc-a116-a5270179e251 --domain newdomain

Entry has been successfully updated

KB4358