branding_theme.exe: Plesk Branding
The branding_theme.exe
utility is used for working with custom
themes that enable you to change appearance and branding settings for
Plesk installations. For detailed information about working with custom
themes, refer to the Administrator’s Guide > Using Custom
Skins.
Location
%plesk_cli%
Usage
branding_theme.exe <command> <option 1> <param>
Example
The following command retrieves the Plesk theme package named custom and saves it in a ZIP archive:
plesk bin branding_theme.exe -p -name custom -destination c:\tmp\custom_theme.zip
Commands
Command | Parameter | Description | Example |
---|---|---|---|
or
|
and
|
Retrieves the specified Plesk theme package and saves it in a ZIP archive. |
To retrieve the default Plesk theme package and save it to the file theme.zip: plesk bin branding_theme.exe --pack -name default -destination c:\tmp\theme.zip
|
or
|
-source <path\filename.zip> |
Installs a custom Plesk theme from the specified location. If you do not specify the When you install the theme, it is automatically applied to UI.
To apply another theme that was installed previously, use the
|
To install the theme that should be available for the server administrator: plesk bin branding_theme.exe --install -vendor admin -source c:\tmp\custom_theme.zip To install the theme that should be available for the reseller with username JDoe: plesk bin branding_theme.exe --install -vendor "JDoe" -source c:\tmp\custom_theme.zip |
or
|
-name <theme name> |
Removes a specified custom Plesk theme. The name < |
To remove a theme named green: plesk bin branding_theme.exe -u -name green |
or
|
-name <theme name> |
Activates one of the installed Plesk themes: The specified theme will be applied to Plesk UI. This theme should have been installed and has the name
< If you do not specify the |
To apply the theme green to the Plesk UI for the reseller with username JDoe: plesk bin branding_theme --set -name green -vendor "JDoe" |
or
|
Displays the list of all installed Plesk themes. |
To view the list of all installed themes: plesk bin branding_theme.exe --list |
|
--help or -h
|
Displays a help reference for the utility. |
To see the help info on the use of this utility: plesk bin branding_theme.exe --help or plesk bin branding_theme.exe -h |
Options
Option | Parameter | Description | Example |
---|---|---|---|
-name |
<theme name> |
Specifies the name of a custom theme. This is the name
specified in Required with the |
To install the theme with the name mytheme that should be available for the server administrator form the file custom_theme.zip: plesk bin branding_theme --install -name mytheme -vendor admin -source c:\tmp\custom_theme.zip |
|
<path\filename.zip> |
Specifies the path to a ZIP file with a custom theme. Required with the |
|
-vendor |
<username> |
Specifies whether the theme is related to the server administrator or a reseller. Used optionally with the |
|
-destination |
<path\filename.zip> |
Specifies the path and file name for saving the theme. Required with the |
To retrieve the Plesk theme package named green and save it to the file greentheme.zip: plesk bin branding_theme.exe --pack -name green -destination c:\tmp\greentheme.zip |