The subscription utility is used for managing subscriptions through CLI.

Usage 

subscription <command> <subscription name> [
<option_1> [<param>]
[<option_2> [<param>]]
... [<option_N> [<param>]]

Example

To create a subscription for the administrator’s customer with the username jdoe based on the hosting plan “Default Domain”, set up a site for the domain example.com, assign IP address 192.168.1.100 to the subscription, and set the username jdoe and password userpass for access to the subscription:

plesk bin subscription --create example.com -owner admin -service-plan "Default Domain" -ip 192.168.1.100 -login jdoe -passwd "userpass"

Commands

Command Parameter Description Example
--create or -c <subscription_name>

Creates a new subscription.

Note: If SELinux is enabled on your operating system, the create command might not work. In that case, switch off SELinux as described in the Deployment Guide > Migrating from Other Panels > Preparing for Migration.

To create a subscription for the administrator’s customer with the username jdoe based on the hosting plan “Default Domain”, set up a site for the domain example.com, assign IP address 192.168.1.100 to the subscription, and set the username Jdoe and password userpass for access to the subscription:

plesk bin subscription --create example.com -owner admin -service-plan "Default Domain" -ip 192.168.1.100 -login jdoe -passwd "userpass"

--update or -u <subscription_name> Changes settings of an existing subscription.

To limit the amount of disk space that example.com can occupy to 200 MB:

plesk bin subscription --update example.com -hard_quota 200M

or

plesk bin subscription -u example.com -hard_quota 200M

--merge <subscription_name>

Moves a main domain to an existing subscription.

Note:

A main domain moved to an existing subscription becomes an add-on domain of this subscription while the source subscription is removed.

To move the example.com domain to the target.com subscription:

plesk bin subscription --merge example.com -webspace-name target.com

--remove or -r <subscription_name> Removes a subscription.

To remove the subscription example.com:

plesk bin subscription --remove example.com

or

plesk bin subscription -r example.com

--list or -l   Displays the list of subscriptions.

To display the list of subscriptions:

plesk bin subscription --list

or

plesk bin subscription -l

--info or -i <subscription_name> Displays information about subscription settings.

To view information about the subscription example.com:

plesk bin subscription --info example.com

or

plesk bin subscription -i example.com

--webspace-on <subscription_name> Activates a subscription.

To activate the subscription example.com:

plesk bin subscription --webspace-on example.com

--webspace-off <subscription_name> Suspends a subscription.

To suspend the subscription example.com:

plesk bin subscription --webspace-off example.com

--lock-subscription <subscription_name> Locks the subscription for syncing.

To lock the subscription example.com for syncing:

plesk bin subscription --lock-subscription example.com

--unlock-subscription <subscription_name> Unlocks the subscription for syncing.

To unlock the subscription example.com for syncing:

plesk bin subscription --unlock-subscription example.com

--no-subscription <subscription_name> Unbinds the subscription from the associated service plans and makes it custom.

To unbind the subscription example.com from service plan:

plesk bin subscription --no-subscription example.com

--switch-subscription <subscription_name> Associates the subscription with the specified service plan.

To associate the subscription example.com with the service plan megaplan:

plesk bin subscription --switch-subscription example.com -service-plan megaplan

--sync-subscription <subscription_name> Synchronizes subscription with the associated plan.

To synchronize the subscription example.com with its associated service plan:

plesk bin subscription --sync-subscription example.com

--add-subscription <subscription_name> Associates the subscription with the specified add-on plan.

To associate the subscription example.com with an add-on plan super-add-on:

plesk bin subscription --add-subscription example.com -service-plan super-add-on

--remove-subscription <subscription_name> Removes the subscription association with the specified add-on plan.

To unsubscribe example.com from the add-on plan Sample-addon:

plesk bin subscription --remove-subscription example.com -service-plan sample-addon

--change-owner <subscription_name>

Changes the owner of a subscription.

Requires the -owner option.

If the IP address assigned to the subscription is not shared between previous and new owner, you must specify it explicitly using the -map_ip option.

To make jdoe the owner of the subscription example.com :

plesk bin subscription --change-owner example.com -owner jdoe

--enable-aps-filter <subscription_name>

Enables the APS applications filter for the specified hosting plan or subscription. A filter restricts the number of applications available for installation on websites.

If an applications filter is not enabled (configured), then the subscription owner can install all applications available from the Application Catalog + those that were uploaded to the server by the administrator and marked as available for installation.

You can learn more about restricting access to applications in Administrator’s Guide > Web Applications.

To switch on the application filter and restricts the number of applications available for installation under subscription example.com to a single application named WordPress, use the following two commands:

plesk bin subscription --enable-aps-filter example.com plesk bin subscription --add-aps-filter-item example.com -aps-filter-item-name name -aps-filter-item-value "wordpress"

--add-aps-filter-item <subscription_name>

Adds an application to the list of applications allowed for installation on websites under the specified subscription.

This command can be used with the following options:

-aps-filter-item-name

-aps-filter-item-value

To add an application AdvancedPoll identified by the system by a name “advancedpoll” to the list of applications allowed for installation under the subscription example.com:

plesk bin subscription --add-aps-filter-item example.com -aps-filter-item-name name -aps-filter-item-value "advancedpoll"

--remove-aps-filter-item <subscription_name> Removes an APS application from the list of applications available for installation.

To remove the application named “advancedpoll” from the list of applications available for installation under the subscription example.com:

plesk bin subscription --remove-aps-filter-item example.com -aps-filter-item-name name -aps-filter-item-value "advancedpoll"

--disable-aps-filter <subscription_name> Disables the APS applications filter and removes all its items.

To let the owner of the subscription example.com to install all available applications without restrictions:

plesk bin subscription --disable-aps-filter example.com

--show-aps-filter-info <subscription_name> Shows information on the active APS applications filter. If an applications filter is disabled, then the subscription owner can install all applications available from the Application Catalog + those that were uploaded to the server by the administrator and marked as available for installation.

To check if application filtering is enabled for the subscription example.com:

plesk bin subscription --show-aps-filter-info example.com

--add-custom-plan-item <subscription_name>

Adds a record about an additional service provided to the subscription or included into hosting plan. Before you assign a custom plan item to a subscription or a plan, you need to configure the plan item in Plesk. This can be done by means of the user interface, API or the custom_plan_items command-line utility.

You can read about custom plan items in Administrator’s Guide at http://docs.plesk.com/current/administrator-guide/70726.htm.

To grant the owner of the subscription example.com with access to a custom application named “appname”:

plesk bin subscription --add-custom-plan-item example.com -custom-plan-item-name "appname"

--remove-custom-plan-item <subscription_name> Removes a record about provided additional service from the plan or subscription.

To revoke access to the application “appname” from the owner of the subscription example.com:

plesk bin subscription --remove-custom-plan-item example.com -custom-plan-item-name "appname"

--remove-all-custom-plan-items <subscription_name> Removes all service plan items provided as additional services.

To prohibit the owner of the subscription example.com to access all applications that were added as custom items:

plesk bin subscription --remove-all-custom-plan-items example.com

--show-custom-plan-items <subscription_name> Shows a list of service plan items.

To view all custom plan items provided to the subscription example.com:

plesk bin subscription --show-custom-plan-items example.com

--shells or -s <subscription_name> Displays the list of available shells under a subscription.

To view the list of available shells:

plesk bin subscription --shells

--update-php-settings <domain_name> Updates custom PHP configuration for a website. Use the utility to set values for 16 most often used PHP settings (exposed to Plesk GUI) or to add any additional PHP directive.

To set one of 16 general PHP settings, prepare the file with the settings you want to change.

Note: File syntax should be the same with php.ini (<parameter>=<value>). To set the default value to the parameter, do not use any value: <parameter>=

Then apply the settings to the site (example.com):

plesk bin subscription --update-php-settings example.com -settings my_file

If you cannot find a certain PHP parameter among 16 general settings, add it as an additional directive to a file and apply the changes to the site (example.com):

plesk bin subscription --update-php-settings example.com -additional-settings my_file_add

--show-php-settings <domain_name> Displays information about current PHP configuration of a website.

To view the PHP configuration information for the website example.com:

plesk bin subscription --show-php-settings example.com

--update-web-server-settings <domain_name> Updates the web server settings.

To update web server settings for the domain example.com:

plesk bin subscription --update-web-server-settings example.com -apache-mime-types "image/jpeg .jpg" -apache-handlers "php-script .html" -ip-deny 192.168.1.0/16 -ip-allow 192.168.1.11 -apache-directory-index index.swf -nginx-serve-static true -nginx-static-extensions avi

--show-web-server-settings <domain_name> Shows the current web server settings.

To view the current web server settings for the website example.com:

plesk bin subscription --show-web-server-settings example.com

--suspend <domain_name> Suspends the specified domain.

To suspend the website example.com:

plesk bin subscription --suspend example.com

--update-web-app-firewall <domain_name> Updates settings for web application firewall (ModSecurity).

To turn on the web application firewall settings for the website example.com:

plesk bin subscription --show-web-app-firewall example.com -waf-rule-engine on

--show-web-app-firewall <domain_name> Shows settings for web application firewall (ModSecurity).

To view the current web application firewall settings for the website example.com:

plesk bin subscription --show-web-app-firewall example.com

--help or -h   Displays help on the use of the utility.

To view help on the use of the domain utility:

plesk bin subscription --help

or

plesk bin subscription -h

Options

Option Parameter Description Example
-new_name <domain_name>

Renames a domain.

Used with the --update only.

To rename the domain example.com to sample.net:

plesk bin subscription -u example.com -new_name sample.net

-dns true|false Enables/Disables DNS zone for a domain.

To enable DNS zone for the domain example.com:

plesk bin subscription -u example.com -dns true

To disable a DNS zone for the domain example.com:

plesk bin subscription -u example.com -dns false

-www true|false

Enables/Disables the www prefix for a domain.

Is true by default.

To disable the www prefix for the domain example.com:

plesk bin subscription -u example.com -www false

-hosting true|false

Enables/Disables hosting for a domain.

Is false by default.

Requires -ip, -login, -passwd options.

To enable hosting for the domain example.com with the IP address 192.0.2.87:

plesk bin subscription -u example.com -login jdoe -passwd sample -hosting true -ip 192.0.2.87

-hst_type phys|std|frm

Sets the type of hosting on a domain.

The following types are available: physical hosting (phys), standard forwarding (std) , and frame forwarding (frm) .

Is phys by default.

Requires -ip, -login, -passwd options.

Requires the -target_url option, when the std or frm parameters are specified.

To set up the standard forwarding hosting (with forwarding to sample.org) for the existing domain example.com:

plesk bin subscription -u example.com -login jdoe -passwd sample -hosting true -ip 192.0.2.87 -hst_type std -target_url sample.org -http_code 301

-target_url <URL>

Sets a target URL for the Standard forwarding and Frame forwarding types of hosting.

Required with -hst_type option when the std or frm parameters are specified.

To set up a target URL for the domain example.com with the standard forwarding hosting (forwarding to sample.org):

plesk bin subscription -u example.com -target_url sample.org -hst_type std

-http_code 301|302 Specifies the HTTP response status code to be used for standard forwarding.

To use the 302 code for forwarding on the domain example.com, which has the standard forwarding type of hosting:

plesk bin subscription -u example.com -http_code 302

-seo-redirect non-www|www|none Turns on the search engine friendly HTTP 301 redirection. Use ‘non-www’ to redirect from www.domain to domain, ‘www’ to redirect from domain to www.domain, and ‘none’ to turn off the redirection (default: non-www).

To turn on redirection for the domain example.com to www.example.com:

plesk bin subscription -u example.com -seo-redirect www

-service-plan <plan name>

Specifies service plan for

subscription creation and other operations. This option can be used only with the following commands:

--create

--add-subscription

--switch-subscription

--remove-subscription

To associate the subscription example.com with an add-on plan super-add-on:

plesk bin subscription --add-subscription example.com -service-plan super-add-on

-force   Forces creating subscription associated with the specified service plan even if the sufficient amount of resources cannot be currently provided.

To create the subscription example.com for the customer with the username jdoe:

plesk bin subscription -c example.com -owner jdoe -service-plan megaplan -force

-force-lock   Force creating the subscription even if the sufficient amount of resources cannot be currently provided. This will create the subscription and lock it for syncing.

To create the subscription example.com for the customer with the username jdoe and lock for syncing:

plesk bin subscription -c example.com -owner jdoe -service-plan megaplan -force-lock

-www-root <path> Specifies website home directory (relative to the subscription root).

To set up a website example.com within the directory site2 in the subscription directory:

plesk bin subscription -c example.com -owner jdoe -service-plan megaplan -www-root site2

-webspace-name <subscription_name> Specifies the name of the target subscription.

To add a domain named example2.com to the existing subscription example.com:

plesk bin subscription -c example2.com -webspace-name example.com

-parent-domain-name <parent_domain_name> Specifies the parent domain name when creating a subdomain.

To add a subdomain named test to the existing subscription example.com:

plesk bin subscription -c test.example.com -parent-domain-name example.com

-vendor <username> Specifies the username of an existing user whose resources will be used (default: domain owner).

To set up a website example.com and specify that it should use resources of the user reseller1:

plesk bin subscription -c example.com -owner jdoe -service-plan megaplan -vendor reseller1

-ip <ip_address> [, <ip_address>]

Specifies the IP addresses of a domain that is created or updated. May be used twice to specify both IPv4 and IPv6 addresses for a subscription.

Note: subscriptions in Plesk 10.2 can have only one IPv4 and one IPv6 address.

For subscriptions with physical hosting, the option also specifies the IP address at which domain content is hosted.

Required with -hosting option and with -hst_type option when phys parameter is specified.

To specify an IPv4 address for subscription example.com when creating it to 192.0.2.87:

plesk bin subscription -c example.com -owner jdoe -ip 192.0.2.87

To specify IPv4 and IPv6 addresses for subscription example.com when creating it to 192.0.2.87 and 2001:db8:85a3:0:0:8a2e:370:7334:

plesk bin subscription -c example.com -owner jdoe -ip 192.0.2.87, 2001:db8:85a3:0:0:8a2e:370:7334

To indicate IP address of the subscription example.com, where physical hosting configured:

PLESK BIN subscription -u example.com -hst_type phys -login jdoe -passwd sample -hosting true -ip 192.0.2.1

-mail-service-ip <ip_address> [, <ip_address>] Specifies the IP addresses tor he domain’s mail service.

To assign the mail service for the domain example.com the IP address 192.168.1.2:

PLESK BIN subscription -u example.com -mail-service-ip 192.168.1.2

-login <login_name> Specifies FTP user name for access to the subscription files.

To create FTP user with the login name john and password sample when creating domain example.com with physical hosting for the client jdoe:

plesk bin subscription -c example.com -hosting true -hst_type phys -ip 192.0.2.1 -owner jdoe -login john -passwd sample

To change the FTP user login name to jane on domain example.com with physical hosting:

plesk bin subscription -u example.com -login jane

-passwd <password> Specifies the FTP user password for access to the subscription files.

To change the FTP user password on the subscription example.com to sample:

plesk bin subscription --update example.com -passwd sample

-passwd_type plain|encrypted

Specifies the type of the FTP user password.

Requires -passwd option.

Is plain by default.

To set the FTP user on example.com password to qweqwe and password type to encrypted:

plesk bin subscription -u example.com -passwd '$1$3KWwrPxB$b6GLpDPpQVsljMRgAlQZG/' -passwd_type encrypted

-shell <shell_name>|false Enables/Disables shell access for FTP user, and sets the OS system shell for FTP user access.

To enable shell access for FTP user on the domain example.com, and to set the shell to /bin/sh:

plesk bin subscription -u example.com -shell /bin/sh

-hard_quota <number>[K|M|G]

Limits the FTP user hard disk quota.

Unlimited if set to 0.

A number without a letter is interpreted as the number of bytes.

To set a 100 MB hard disk quota for the domain example.com:

plesk bin subscription -u example.com -hard_quota 100M

-creation-date <YYYY-MM-DD>

Sets the domain creation date.

Used with the --create only.

To set the creation date for domain example.com to 2008-12-30:

plesk bin subscription -c example.com -owner jdoe -creation-date 2008-12-30

-ssi true|false

Enables/Disables SSI support.

Is false by default.

To enable SSI support on the domain example.com:

plesk bin subscription -u example.com -ssi true

-php true|false

Enables/Disables PHP support.

Is false by default.

To enable PHP support on the domain example.com:

plesk bin subscription -u example.com -php true

-php_handler_id module|cgi|fastcgi Associates a PHP handler with the site. Specify the handler’s identifier (default: cgi).

To set PHP handler on the domain to FastCGI:

plesk bin subscription -u example.com -php_handler_id fastcgi

-php_safe_mode true|false

Enables/Disables safe mode for PHP support.

Is true by default.

To disable safe mode for PHP support on the domain example.com:

plesk bin subscription -u example.com -php true -php_safe_mode false

-cgi true|false

Enables/Disables CGI support.

Is false by default.

To enable CGI support on the domain example.com:

plesk bin subscription -u example.com -cgi true

-cgi-mode webspace|www-root Sets the location of the cgi-bin directory.

To place the cgi-bin directory in the www-root:

plesk bin subscription -u example.com -cgi-mode www-root

-perl true|false

Enables/Disables Perl support.

Is false by default.

To enable Perl support on the domain example.com:

plesk bin subscription -u example.com -perl true

-asp true|false

Enables/Disables Apache ASP support.

Is false by default.

To enable Apache ASP support on the domain example.com:

plesk bin subscription -u example.com -asp true

-python true|false

Enables/Disables Python support.

Is false by default.

To enable Python support on the domain example.com:

plesk bin subscription -u example.com -python true

-fastcgi true|false

Enables/Disables FastCGI support.

Is false by default.

To enable FastCGI support on the domain example.com:

plesk bin subscription -u example.com -fastcgi true

-ssl true|false

Enables/Disables SSL/TLS support.

Is true by default.

To disable SSL/TLS support on the domain example.com:

plesk bin subscription -u example.com -ssl false

-certificate-name <certificate_name>

Specifies the name of SSL/TLS certificate for a subscription if SNi is supported.

SNI is supported on the following operating systems:

  • OpenSuSe 11.3 or later
  • Ubuntu 10.4 or later
  • Debian 7.0 or later
  • RedHat 6 or later

To assign the SSL/TLS certificate named Site Certificate to the domain example.com:

plesk bin subscription -u example.com -certificate-name "Site Certificate"

-ssl-redirect true|false

Enables/Disables SEO-safe 301 redirection from HTTP to HTTPS.

Is true by default.

To disable redirection from HTTP to HTTPS on the domain example.com:

plesk bin subscription -u example.com -ssl-redirect false

-webstat none|awstats|webalizer

Enables/Disables Web statistic support; selects Web statistics application (Awstats or Webalizer).

Is none by default.

To enable Webalizer support on the domain example.com:

plesk bin subscription -u example.com -webstat webalizer

-webstat-protdir-access true|false

Enables/Disables access to web statistics data through password- protected directory /plesk-stat.

Is false by default.

To enable access to web statistics data through password- protected directory /plesk-stat on the domain example.com:

plesk bin subscription -u example.com -webstat-protdir-access true

-err_docs true|false

Enables/Disables custom server error messages.

Is false by default.

To enable custom error messages support on the domain example.com:

plesk bin subscription -u example.com -err_docs true

-log-rotate true|false

Enables/Disables log rotation.

Is false by default.

To enable log rotation on the domain example.com:

plesk bin subscription -u example.com -log-rotate true

-log-bysize <number>[B|K|M|G|T] Enables/Disables log rotation based on the current log file size.

To enable log rotation on the domain example.com once the current log file reaches the 200 KB size:

plesk bin subscription -u example.com -log-bysize 200

-log-bytime daily|weekly|monthly

Enables/Disables log rotation by time.

Is daily by default.

To enable weekly log rotation on the domain example.com:

plesk bin subscription -u example.com -log-bytime weekly

-log-max-num-files <number>

Limits the number of log files parameter.

Is 3 by default.

To restrict the maximum number of log files (current and rotated) on the domain example.com to 10:

plesk bin subscription -u example.com -log-max-num-files 10

-log-compress true|false

Enables/Disables log file compression.

Is true by default.

To disable log file compression on the domain example.com:

plesk bin subscription -u example.com -log-compress false

-log-email <email> Enables/Disables automatic sending of rotated log files to the specified email address.

To enable automatic sending of rotated log files on the domain example.com to email address admin@example.com:

plesk bin subscription -u example.com -log-email admin@example.com

-mail_service true|false

Enables/Disables mail service.

Is true by default.

To disable mail service on the domain example.com:

plesk bin subscription -u example.com -mail_service false

-mail_service_node_ip <IP address>|local Specifies the service node which will provide mail services for the subscription.

To set the local Plesk mail server as the mail service provider for the subscription example.com:

plesk bin subscription -u example.com -mail_service_node_ip local

-maillist_service true|false

Enables/Disables the mailing list service.

Is false by default.

To enable mailing list service on the domain example.com:

plesk bin subscription -u example.com -maillist_service true

-map_ip <IP_address>

Sets a new IP address for a domain.

Used with --change-owner only.

Required with --change-owner.

To set the IP address 192.0.2.87 for the domain example.com when changing the owner of the domain to Plesk client with the login name JaneDoe:

plesk bin subscription --change-owner example.com -owner JaneDoe -map_ip 192.0.2.87

-publish-sb-site true|false

Allows/Prohibits publishing site with Presence Builder.

Is false by default.

To allow publishing site with Presence Builder on the domain example.com:

plesk bin subscription -u example.com -publish-sb-site true

-notify true|false

Allows/Prohibits standard email notifications on a domain creation (Plesk domain administrators and clients).

Used with --create only.

To prevent email notifications about domain creation:

plesk bin subscription --create example.com -owner jdoe -notify false

-owner <login_name> Specifies the username of the subscription owner.

To assign ownership of the subscription example.com to a user with the login name jdoe, and assign the 192.0.2.78 IP address to the subscription:

plesk bin subscription --change-owner example.com -owner jdoe -map_ip 192.0.2.78

-aps-filter-item-name <name|URL>

Specifies identifier of APS applications filter item: whether the filtered app is identified in Plesk by name or URL.

The option to identify an application by URL is reserved for future uses and is not currently available.

To add an application AdvancedPoll identified by the system by a name “advancedpoll” to the list of applications allowed for installation under the subscription example.com:

plesk bin subscription --add-aps-filter-item example.com -aps-filter-item-name name -aps-filter-item-value "advancedpoll"

-aps-filter-item-value <value> Specifies the actual name or URL of the filtered APS app.  
-custom-plan-item-name <value> Service plan item name.

To grant the owner of the subscription example.com with access to a custom application named “appname”:

plesk bin subscription --add-custom-plan-item example.com -custom-plan-item-name "appname"

-settings <filename>

Sets the file containing custom PHP settings for a site. The file can include only 16 general PHP settings exposed to the Plesk GUI.

Used with --update-php-settings only.

To set custom PHP configuration from the file my_file to the site example.com:

plesk bin subscription --update-php-settings example.com -settings my_file

-additional-settings <filename>

Sets the file containing custom PHP settings for a site. The file can include any PHP directive except 16 general PHP settings exposed to the Plesk GUI.

Used with --update-php-settings only.

To add directives to custom PHP configuration from the file my_file_add (example.com):

plesk bin subscription --update-php-settings example.com -additional-settings my_file_add

-apache-mime-types <mime types>

Sets MIME types for the specified website. For example: ‘text/plain .txt image/jpeg .jpeg’.

Used with --update-web-server-settings.

To update web server settings for example.com:

plesk bin subscription --update-web-server-settings example.com -apache-mime-types "image/jpeg .jpg" -apache-handlers "php-script .html" -ip-deny 192.168.1.0/16 -ip-allow 192.168.1.11 -apache-directory-index index.swf -nginx-serve-static true -nginx-static-extensions avi -web-server-expires 36000 -web-server-expires-static-only true -web-server-headers "Cache-Control: public"

-apache-handlers <handlers>

Sets Apache handlers for the specified website. For example: ‘php-script .html cgi-script .cgi’.

Used with --update-web-server-settings.

  
-ip-deny <ip deny list>

Sets a list of IP addresses that will be denied access to the specified website. Use spaces to separate IP addresses. For example: ‘10.1.0.0/16 192.168.1.110’.

Used with --update-web-server-settings.

  
-ip-allow <ip allow list>

Sets a list of IP addresses that will be allowed to access the specified website. Use spaces to separate IP addresses. For example: ‘192.168.0.0/16 10.1.1.21’.

Used with --update-web-server-settings.

  
-apache-directory-index <directory index>

Sets index pages for the specified website. For example: ‘index.html index.htm index.text /cgi-bin/index.pl’.

Used with --update-web-server-settings.

  
-web-server-expires <number of seconds> Adds the “Expires” header and sets the cache expiration period in seconds. Used with --update-web-server-settings.  
web-server-expires-static-only true|false Turns on/off the “response with Expires headers for static files only” option. Used with --update-web-server-settings.  
-web-server-headers <HTTP response header> Adds additional HTTP response headers, for example "X-Frame-Options: DENY". Used with --update-web-server-settings.  
-nginx-proxy-mode true|false

Turns on/off the proxy mode for the nginx reverse proxy server.

Turn off to use nginx for processing all HTTP requests for websites’ content (without Apache participating in this processing).

To turn off the proxy mode for the website example.com:

plesk bin subscription --update-web-server-settings example.com -nginx-proxy-mode false

-nginx-transparent-mode true|false Turns on/off the transparent mode for the nginx reverse proxy server. In this mode, Apache handles both static and dynamic content, while nginx only passes HTTP requests and responses without modification. The default value is false.

To update web server settings for example.com to make nginx serve .php files:

plesk bin subscription --update-web-server-settings example.com -nginx-serve-php true

-nginx-serve-static true|false Turns on/off serving static content by the nginx reverse proxy server. The default value is false.

To update web server settings for example.com to make nginx serve the .avi files:

plesk bin subscription --update-web-server-settings example.com -nginx-serve-static true -nginx-static-extensions avi

-nginx-static-extensions <extensions>

Sets static files extensions that should be served directly by nginx. If you specify an empty value, the static files extensions from the default nginx configuration (/var/www/vhosts/domain1.tld/.plesk/conf/last_nginx.conf) will be used.

Used with the -nginx-serve-static option.

  
-nginx-serve-php true|false

Turns on/off processing PHP files by the nginx reverse proxy server. The default value is false.

This feature requires that one of the ‘atomic’ or ‘remi’ repositories must be enabled on the server.

To update web server settings for example.com to make nginx serve .php files:

plesk bin subscription --update-web-server-settings example.com -nginx-serve-php true

-description <string> Specifies a description of the subscription to be displayed an Plesk for anyone who has access to this subscription.  
-nginx-cache-enabled true|false Turns on/off nginx caching. The default value is false.

plesk bin subscription --update-web-server-settings example.com -nginx-cache-enabled true -nginx-cache-size 67108864 -nginx-cache-timeout 5 -nginx-cache-key '$scheme$request_method$host$request_uri' -nginx-cache-cookies 'wordpress_test_cookie' -nginx-cache-bypass-locations '/wp-admin/' -nginx-cache-bypass-header-nocache true -nginx-cache-bypass-header-auth true -nginx-cache-bypass-get-nocache false -nginx-cache-use-stale-5xx false -nginx-cache-use-stale-4xx false -nginx-cache-use-stale-updating true

-nginx-cache-size <bytes> Sets the nginx cache size in bytes. The default value is 67108864 (64 MB).  
-nginx-cache-timeout <seconds> Sets the nginx cache valid time. The default value is 5 seconds.  
-nginx-cache-key <cache key> Defines a key for caching. The default value is $scheme$request_method$host$request_uri  
-nginx-cache-cookies <cookies> Configures nginx to cache HTTP requests containing certain cookies.  
-nginx-cache-bypass-locations <$request_uri> Configures nginx not to cache certain web content.  
-nginx-cache-bypass-header-nocache true|false If true, the HTTP response will not be taken from the nginx cache if HTTP no-cache headers are received in request. The default value is true.  
-nginx-cache-bypass-header-auth true|false If true, the HTTP response will not be taken from the nginx cache if HTTP authorization headers are received in request. The default value is true.  
-nginx-cache-bypass-get-nocache true|false If true, the HTTP response will not be taken from the nginx cache if GET nocache parameter is received in request. The default value is true.  
-nginx-cache-use-stale-5xx true|false If true, a stale cached response will be used if the upstream returns 5xx server error. The default value is true.  
-nginx-cache-use-stale-4xx true|false If true, a stale cached response will be used if the upstream returns 4xx server error. The default value is false.  
-nginx-cache-use-stale-updating true|false If true, a stale cached response will be used if the nginx cache is being updated. The default value is true.  
-admin-description <string> Specifies a description of the subscription for the administrator. It is displayed in Plesk only to the administrator.

To create a description of the subscription example.com that will be visible for the administrator only:

plesk bin subscription -u example.com -admin-description "Admin's notes about this subscription"

-reseller-description <string> Specifies a description of the subscription. It is displayed in Plesk to the reseller and administrator.

To create a description of the subscription example.com that will be visible to the reseller and administrator:

plesk bin subscription -u example.com -reseller-description "Reseller's notes about this subscription"

-unpaid-website-status disabled|suspended|active

Sets the status that all websites in the specified subscription will receive when the subscription becomes suspended.

The default value is suspended.

To make websites receive the disabled status when the subscription example.com becomes suspended:

plesk bin subscription -u example.com -unpaid-website-status disabled

-waf-rule-engine on|off|detection-only

Specifies the web application firewall (ModSecurity) mode.

Used with the --update-web-app-firewall command.

To turn on the web application firewall settings for the website example.com:

plesk bin subscription --show-web-app-firewall example.com -waf-rule-engine on

-waf-rule-set tortix |crs Sets the web application firewall (ModeSecurity) rule set.

To turn on the web application firewall settings for the website example.com and specify the Atomic Basic ModSecurity rules set:

plesk bin subscription --show-web-app-firewall example.com -waf-rule-engine on -waf-rule-set tortix

-empty-document-root true|false Creates a subscription with empty document root directory (skip promo pages creation).

To create a subscription with empty document root:

plesk bin subscription -c example.com -empty-document-root true

-apache-restrict-follow-sym-links true|false Restricts Apache from following symbolic links. The default value is false.

To restricts Apache from following symbolic links on the domain example.com:

plesk bin subscription --update-web-server-settings example.com -apache-restrict-follow-sym-links true