The skeleton utility is used to manage site directory structure templates through CLI. By using this utility, you can perform the following tasks:

  • installing a template on a client account from a file

  • resetting a template on a client account to the Plesk default template

Usage 

skeleton <command> [
<option_1> [<param>]
[<option_2> [<param>]]
... [<option_N> [<param>]]
]

Example

The following command installs a virtual host template from the file /usr/local/skeletons/siteskeleton (in the ZIP format) for the client with the login name JDoe:

plesk bin skeleton --install JDoe -filename /usr/local/skeletons/siteskeleton -force-type zip

Commands

Command

Parameter

Description

Example

--install or -i

<client_login_name>

Installs a virtual host template from a file for a client account.

Requires the -filename option.

To install a template from the file /usr/local/skeletons/siteskeleton.zip for the client with the login name JDoe:

plesk bin skeleton --install JDoe -filename /usr/local/skeletons/siteskeleton -force-type zip

or

plesk bin skeleton -i JDoe -filename siteskeleton -force-type zip

--reset or -r

<client_login_name>

Installs the Plesk default template for a client account.

To install the default template for the client with the login name JDoe:

plesk bin skeleton --reset JDoe

or

plesk bin skeleton -r JDoe

--help or -h

Displays help on the use of the utility.

To view help on the use of the utility:

plesk bin skeleton --help

or

plesk bin skeleton -h 









Options








Option


Parameter


Description


Example








-filename


<file_path>



Specifies a path to a virtual host template file.


Used with the --install only.




To install a template from the file
/usr/local/skeletons/siteskeleton (in the ZIP format) for
the client with the login name JDoe:




plesk bin skeleton -i JDoe -filename /usr/local/skeletons/siteskeleton -force-type zip










-force-type


zip|tgz|tar.gz|tar



Forces specification of a virtual host template file format.


Used with the --install only.