Site Application Items: siteapp-item Utility

The siteapp-item utility is used to manage application items - Plesk business logic objects which are created in Plesk server application vault and then added to clients' application pools. An application item consists of an application package and a license which is represented by a set of limits on using this application package by clients. For different groups of clients, the Plesk administrator can create several application items based on one application package, but with different limitations.

By using this utility, the following tasks can be performed:

creating application items
adding/removing site application items to/from client account's application pool

Note: The utility is available since Plesk 8.3.

Usage

siteapp-item <command> [

<option_1> [<param>]

[<option_2> [<param>]]

… [<option_N> [<param>]]

Example

The following command adds apstest application item version 1.0.2 to the application pool of a client with the login name JDoe:

# ./siteapp-item --add-to-pool JDoe -sapp-name apstest -sapp-version 1.0.2 -license-type 3062dba0502117d4a04a48ec1eed42e0

Commands

Command	Parameter	Description	Example
`--create` or `-c`		Creates an application item. Requires `-sapp-name`, `-sapp-version` and -`license-type` options.	To create the application item apstest v. 1.0.2 with the license type 3062dba0502117d4a04a48ec1eed42e0: # ./siteapp-item --create -sapp-name apstest -sapp-version 1.0.2 -license-type 3062dba0502117d4a04a48ec1eed42e0
`--list`		Displays a list of application items available on server.	To view the list of application items available on server: # ./siteapp-item --list
`--add-to-pool` or `-ap`	`<client_login_name>`	Adds an application item to a client application pool. Requires `-sapp-name`, `-sapp-version` and `-license-type` options.	To add the new application item apstest v. 1.0.2 with the license type 3062dba0502117d4a04a48ec1eed42e0 to JDoe application pool: # ./siteapp-item -ap JDoe -sapp-name apstest -sapp-version 1.0.2 -license-type 3062dba0502117d4a04a48ec1eed42e0
`--remove-from-pool` or `-rp`	`<client_login_name>`	Removes an application item from a client application pool. Requires `-sapp-name`, `-sapp-version` and `-license-type` options.	To remove the application item apstest v. 1.0.2 with the license type 3062dba0502117d4a04a48ec1eed42e0 from JDoe application pool: # ./siteapp-item -rp JDoe -sapp-name apstest -sapp-version 1.0.2 -license-type 3062dba0502117d4a04a48ec1eed42e
`--help`		Displays help on the utility usage.	# ./siteapp-item --help

Options

Option	Parameter	Description	Example
`-sapp-name`	`<string>`	Specifies site application package name. Required with all commands except for `--help`.	To add the new application item apstest v. 1.0.2 with the license type 3062dba0502117d4a04a48ec1eed42e0 to JDoe application pool: # ./siteapp-item -ap JDoe -sapp-name apstest -sapp-version 1.0.2 -license-type 3062dba0502117d4a04a48ec1eed42e0
`-sapp-version`	`<number>`	Specifies site application version number. Required with all commands except for `--help`.
`-license-type`	`<string>`	Specifies site application license type. To view the list of all available license types use `--list` command of `siteapp-license` utility. Required with all commands except for `--help`.
`-release`	`<number>`	Specifies site application release number. Deprecated since Plesk 8.3.	To remove the application item apstest v. 1.0.2 release 3.1 with the license type 3062dba0502117d4a04a48ec1eed42e0 from JDoe application pool: # ./siteapp-item -rp JDoe -sapp-name apstest -sapp-version 1.0.2 -license-type 3062dba0502117d4a04a48ec1eed42e -release 3.1
`-instances-limit`	`<number>`	Limits the number of available application installations on domains. Unlimited if set to `-1`.	To add the new application item apstest v. 1.0.2 with the license type 3062dba0502117d4a04a48ec1eed42e0 to JDoe application pool and to allow JDoe to install the application on 10 domains: # ./siteapp-item -ap JDoe -sapp-name apstest -sapp-version 1.0.2 -license-type 3062dba0502117d4a04a48ec1eed42e -instances-limit 10
`-shared`	`true\|false`	Allows/Prohibits unlimited installation on domains of a specified application for all clients. Used with the `--create` command.	To create the new application item apstest v. 1.0.2 with the license type 3062dba0502117d4a04a48ec1eed42e0 and to allow unlimited application installation for all clients: # ./siteapp-item --create -sapp-name apstest -sapp-version 1.0.2 -license-type 3062dba0502117d4a04a48ec1eed42e0 -shared true
`-enabled`	`true\|false`	Allows/Prohibits adding application item to clients' application pools. Used with the `--create` command.	To create the new application item apstest v. 1.0.2 with the license type 3062dba0502117d4a04a48ec1eed42e0 and to allow adding the application item to clients' application pools: # ./siteapp-item --create -sapp-name apstest -sapp-version 1.0.2 -license-type 3062dba0502117d4a04a48ec1eed42e0 -enabled true