The custombutton
utility is used to create custom buttons and manage
their properties (interface location, button names, URLs, context help
messages, and other parameters) through CLI.
Custom buttons of the following types can be created and managed by
using this utility:
- custom buttons pointing to a URL
- custom buttons linked to site applications or Plesk extensions
Usage
custombutton <command> [
<option_1> [<param>]
[<option_2> [<param>]]
... [<option_N> [<param>]]
]
Example 1
The following command creates the custom button Statistics that opens
URL http://example.com/site-statistics, places the custom button on
domain administration pages, includes domain ID#, domain name, and
client ID# in browser requests generated by clicking on the button, sets
the context help message for the button as Click to go to
site-statistics, and makes the button available in control panels of
all domain users.
plesk bin custombutton --create -text Statistics -url http://example.com/site-statistics -place domain -url_comp dom_id,dom_name,cl_id -conhelp "Click to go site-statistics" -public true
Example 2
The following command creates custom button named osCom linked to site
application osCommerce installed on domain example.com, and
accessible at URL http://example.com/osCommerce, and sets the context
help message for the button as Click to open osCommerce.
plesk bin custombutton --create -text osCom -url http://example.com/osCommerce -siteapp-link -siteapp-domain example.com -siteapp-name osCommerce -conhelp "Click to open osCommerce"