Interface Templates: interface_template Utility

The interface_template utility is used to manage Plesk interface templates through CLI. By using this utility, you can perform the following tasks:

Syntax

interface_template <command> <template name>[

<option_1> [<param>]

[<option_2> [<param>]]

…[<option_N> [<param>]]

]

Example

The following command line hides buttons that forward users to certificate retailer's or domain registration sites:

# ./interface_template --preferences -domain_registration true -p -cert_purchasing true

Commands

Command

Parameter

Description

Example

--export or -e

<template name>

Exports interface template as a file or to the standard output (STDOUT).

 

To export interface template InterfaceTemplate form Plesk to file /usr/local/templates/intemp:

# ./interface_template --export InterfaceTemplate /usr/local/templates/intemp

or

# ./interface_template -e InterfaceTemplate /usr/local/templates/intemp

--import or -i

<template name>

Import interface template from a file or the standard input (STDIN).

To import interface template InterfaceTemplate to Plesk from file /usr/local/templates/intemp:

# ./interface_template --import InterfaceTemplate /usr/local/templates/intemp

or

/interface_template -i InterfaceTemplate /usr/local/templates/intemp

-preferences or -p

 

Updates Plesk server interface preferences (Server > Interface Management > Interface templates >Preferences).

To enable hiding limit management controls that are not allowed to be managed by users for interface template InterfaceTemplate:

# ./interface_template --preferences -hide_disabled

or

# ./interface_template -p -hide_disabled

--help or -h

 

Displays help on the use of the utility.

To view help on the use of the utility:

# ./interface_template --help

or

# ./interface_template -h

Options

Option

Parameter

Description

Example

-file

<file path>

Specifies the path to a file to export an interface template tot or to import an interface template from.

Used with the --export and --import commands.

To export interface template InterfaceTemplate form Plesk to file /usr/local/templates/intemp:

# ./interface_template -e InterfaceTemplate /usr/local/templates/intemp

-from-stdin

 

Specifies the standard input in the XML format as the source to import an interface template from.

Used only with the --import command.

To import interface template InterfaceTemplate from the standard input in the XML format:

# ./interface_template -i InterfaceTemplate -from-stdin

-to-stdin

 

Specifies the standard output in the XML format as the export destination of an interface template.

Used only with the --export command.

To export interface template InterfaceTemplate to standard output in the XML format:

# ./interface_template -e InterfaceTemplate -from-stdin

-hide_disabled

true|false

Enables or disables hiding all buttons in the Plesk control panel that are displayed as unavailable (the Hide all grayed out buttons by default parameter).

Used only with the --preferences command.

To enable hiding all unavailable buttons in the Plesk control panel for interface template InterfaceTemplate:

# ./interface_template -p -hide_disabled true

-hide_unavailable_limits

true|false

Enables or disables hiding limit management controls that are not allowed to be managed by users (the Hide from users the limit management controls they are not allowed to operate parameter).

Used only with the --preferences command.

To enable hiding limit management controls that are not allowed to be managed by users for interface template InterfaceTemplate:

# ./interface_template -p -hide_unavailable_limits true

-hide_unavailable_permissions

true|false

Enables or disables hiding l control elements for resource limits that are not allowed to be managed by users (the Hide from users the limit management controls they are not allowed to operate parameter).

Used only with the --preferences command.

To enable hiding control elements for resource limits that are not allowed to be managed by users:

# ./interface_template -p -hide_unavailable_permissions true

-domain_registration

true|false

Enables or disables hiding buttons forwarding to a domain registration site. (the Hide buttons for domain registration parameter).

Used only with the --preferences command.

To enable hiding buttons forwarding to a domain registration site:

# ./interface_template -p -domain_registration true

-cert_purchasing

true|false

Enables or disables hiding buttons forwarding to a certificate retailer's site (the Hide buttons for certificate purchasing parameter).

Used only with the --preferences command.

To enable hiding buttons forwarding to a certificate retailer's site:

# ./interface_template -p -cert_purchasing true

-extras

true|false

Enables or disables hiding buttons for extra services (the Hide buttons for extra services parameter).

Used only with the --preferences command.

To enable hiding buttons for extra services:

# ./interface_template -p -extras true

-mail_bounce

true|false

Enables or disables hiding the bounce with message option for the Mail to nonexistent user

parameter (the Hide controls for bounce messages for non-existent mail addresses parameter).

Used only with the --preferences command.

To enable hiding the bounce with message option for the Mail to nonexistent user parameter:

# ./interface_template -p -mail_bounce true