Desktop Presets: desktop Utility

The desktop utility enables managing desktop presets through CLI. By using this utility, you can perform the following tasks:

Syntax

desktop <command> [

<option_1> [<param>]

[<option_2> [<param>]]

…[<option_N> [<param>]]

]

Example

The following command line adds desktop preset AdminDesktop to the administrator's repository of desktop presets and allows overwriting of the preexisting desktop with the same name.

# ./desktop --add-preset /usr/local/presets/AdminDesktop.xml -overwrite true

Commands

Command

Parameter

Description

Example

--set-admin or -sa

 

Changes type of an existing desktop preset to the Administrator's desktop preset type.

Requires concomitant use of the -desktop-preset option.

To set existing desktop preset named AdminDesktop as an administrator's desktop preset:

# ./desktop --set-admin -desktop-preset AdminDesktop

or

# ./desktop -sa -desktop-preset AdminDesktop

--update-preset or -up **

<preset name>

Updates properties of a desktop preset.

Requires concomitant use of the -type option.

To change the type of desktop preset named AdminDesktop to Domain owner's desktop preset:

# ./desktop --update-preset -desktop-preset AdminDesktop -type domain

or

# ./desktop -up AdminDesktop -type domain

--preset-lists or -pl

 

Displays the list of existing desktop presets.

To display the list of available desktops:

# ./desktop --preset-lists

or

# ./desktop -pl

--add-preset or -ap

<file name>

Adds a preset to administrator's repository of desktop presets.

To add a desktop preset AdminDesktop to the administrator's repository of desktop presets from a desktop preset file AdminDesktop.xml:

# ./desktop --add-preset /usr/local/presets/AdminDesktop.xml

or

# ./desktop -ap /usr/local/presets/AdminDesktop.xml

 

--remove-preset or -rp

<preset name>

Deletes a desktop preset from administrator's repository of desktop presets.

To add a desktop preset to the administrator's repository of desktop presets from a desktop preset file AdminDesktop.xml:

# ./desktop --remove-preset AdminDesktop

or

# ./desktop -rp AdminDesktop

--help or -h

 

Displays help on the use of the utility.

To view help on the use of the utility:

# ./desktop --help

or

# ./desktop -h

Options

Option

Parameter

Description

Example

-desktop-preset

<preset name>

Sets desktop preset

To set existing desktop preset named AdminDesktop as an administrator's desktop preset:

# ./desktop -sa -desktop-preset AdminDesktop

-default

true|false

Renders desktop preset the default preset for the Plesk users category specified by the -type option.

To set desktop preset AdminDesktop as the default administrator's desktop preset:

# ./desktop -up AdminDesktop -default true -type admin

-overwrite

true|false

Allows overwriting of a desktop preset with another desktop with the same name.

Used only with the --add-preset command.

To add a desktop preset AdminDesktop to the administrator's repository of desktop presets from desktop preset file /usr/local/presets/AdminDesktop.xml and replace existing desktop with the same name in Plesk:

# ./desktop -ap /usr/local/presets/AdminDesktop.xml -overwrite true

-type

admin|client|domain

Sets desktop preset type:

admin - Default Administrator's desktop, domain - Default domain owner desktop, client - Default client desktop.

To change the type of desktop preset named AdminDesktop to Domain owner's desktop preset:

# ./desktop -up -desktop-preset AdminDesktop -type domain