Knowledge Base

custom_plan_items: Custom Plan Options

The custom_plan_items utility is used for adding custom plan options
through CLI.

You can read about these options in the Administrator’s
Guide.

Usage

custom_plan_items <command> [<option name>] [
<option 1> <param> [<option 2> <param>] ... [<option N> <param>]
]

Example

To create a plan option that, when included into a plan as an
additional service, will add a link to company.example.com to the
subscribers’ Control Panels:

plesk bin custom_plan_items --add "Our website" -uuid "5a2d0766-3154-49ed-93a0-05a84ae601bd" -visible true -label "Visit our website" -url "http://company.example.com" -tooltip "Visit our website."

Commands

Command	Parameter	Description	Example
`--add` or `-a`	`<option_name>`	Adds a hosting plan item for an additional service. When adding a plan item through the command line, you must specify a globally unique identifier (GUID). You can generate a GUID by using, for example, http://www.guidgenerator.com.	You are running an online support service at http://premium-support.example.com, and want to include the support option into service plans. The following command will create a custom plan option named Premium support which will add a hyperlink to your online service into Control Panel of each user whose plan includes that option: plesk bin custom_plan_items --add "Premium support" -uuid "5a2d0766-3154-49ed-93a0-05a84ae601bd" -visible true -label "Premium support" -url "http://premium-support.example.com" -tooltip "Contact our support service for assistance" -image-file "/usr/local/…