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 |
|---|---|---|---|
|
|
Changes type of an existing desktop preset to the Administrator's desktop preset type. Requires concomitant use of the |
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 |
|
|
Updates properties of a desktop preset. Requires concomitant use of the |
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 |
|
|
Displays the list of existing desktop presets. |
To display the list of available desktops: # ./desktop --preset-lists or # ./desktop -pl |
|
|
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
|
|
|
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 |
|
|
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 |
|---|---|---|---|
|
<preset name> |
Sets desktop preset |
To set existing desktop preset named AdminDesktop as an administrator's desktop preset: # ./desktop -sa -desktop-preset AdminDesktop |
|
|
Renders desktop preset the default preset for the Plesk users category specified by the |
To set desktop preset AdminDesktop as the default administrator's desktop preset: # ./desktop -up AdminDesktop -default true -type admin |
|
|
Allows overwriting of a desktop preset with another desktop with the same name. Used only with the |
To add a desktop preset AdminDesktop to the administrator's repository of desktop presets from desktop preset file # ./desktop -ap /usr/local/presets/AdminDesktop.xml -overwrite true |
|
|
Sets desktop preset type:
|
To change the type of desktop preset named AdminDesktop to Domain owner's desktop preset: # ./desktop -up -desktop-preset AdminDesktop -type domain |