subscription.exe: Subscriptions

The subscription.exe utility is used for managing subscriptions through CLI.

 

Location

%plesk_cli%

Usage
subscription.exe <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 webspace:

subscription.exe --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.

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 webspace:

subscription.exe --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:

subscription.exe --update example.com -hard_quota 200M

or

subscription.exe -u example.com -hard_quota 200M

--remove or -r

<subscription_name>

Removes a subscription.

To remove the subscription example.com:

subscription.exe --remove example.com

or

subscription.exe -r example.com

--list or -l

 

Displays the list of domains.

To display the list of domains:

subscription.exe --list

or

subscription.exe -l

--info or -i

<subscription_name>

Displays information about subscription settings.

To view information about the subscription example.com:

subscription.exe --info example.com

or

subscription.exe -i example.com

--change-owner

<subscription_name>

Changes an owner of a subscription.

Requires the -owner options.

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:

subscription.exe --change-owner example.com -owner JDoe

--webspace-on

<subscription_name>

Activates a subscription.

To activate the subscription example.com:

subscription.exe --webspace-on example.com

--webspace-off

<subscription_name>

Suspends a subscription.

To suspend the subscription example.com:

subscription.exe --webspace-off example.com

--lock-subscription

<subscription_name>

Locks the subscription for syncing.

To lock the subscription example.com for syncing:

subscription.exe --lock-subscription example.com

--unlock-subscription

<subscription_name>

Unlocks the subscription for syncing.

To unlock the subscription example.com for syncing:

subscription.exe --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:

subscription.exe --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:

subscription.exe --switch-subscription example.com -service-plan megaplan

--sync-subscription

<subscription_name>

Synchronizes subscription with the associated plan.

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

subscription.exe --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:

subscription.exe --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:

subscription.exe --remove-subscription example.com -service-plan sample-addon

--set-iis-app-pool-settings

<subscription_name>

Sets IIS application pool settings for the specified subscription.

The following settings can be specified:

-iis-app-pool-turned-on

This turns IIS application pool on or off.

-cpu-usage-state

This turns on or off monitoring of CPU usage by IIS application pool.

-cpu-usage-value

This sets the maximum allowed CPU usage rate for IIS application pool.

-cpu-usage-action

This sets the action that IIS takes when worker processes exceed the CPU usage limit.

-cpu-usage-interval

This sets the reset interval - the period of time when the CPU monitoring data is reset.

To switch on IIS application pool for the subscription example.com and limit CPU usage to 5 percent:

subscription.exe --set-iis-app-pool-settings example.com -iis-app-pool-turned-on true -cpu-usage-state true -cpu-usage-value 5

--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:

subscription.exe --enable-aps-filter example.com

 

subscription.exe --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:

subscription.exe --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:

subscription.exe --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:

subscription.exe --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:

subscription.exe --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 > Offer Additional Services.

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

subscription.exe --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:

subscription.exe --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:

subscription.exe --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:

subscription.exe --show-custom-plan-items example.com

--update-php-settings

<subscription_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):

subscription.exe --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):

subscription.exe --update-php-settings example.com -additional-settings my_file_add

--show-php-settings

<subscription_name>

Displays information about current PHP configuration of a website.

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

subscription.exe --show-php-settings example.com

--update-web-server-settings

<subscription_name>

Updates the web server settings.

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

subscription.exe --update-web-server-settings example.com -ip-deny 192.168.1.0/16 -ip-allow 192.168.1.11

--show-web-server-settings

<subscription_name>

Shows the current web server settings.

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

subscription.exe --show-web-server-settings example.com

--update-web-app-firewall

<subscription_name>

Updates settings for web application firewall (ModSecurity).

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

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

--show-web-app-firewall

<subscription_name>

Shows settings for web application firewall (ModSecurity).

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

subscription.exe --show-web-app-firewall example.com

--suspend

<subscription_name>

Suspends the specified domain.

To suspend the website example.com:

subscription.exe --suspend example.com

--help or -h

 

Displays help on the use of the utility.

To output the help info on the use of this utility:

subscription.exe --help

or

subscription.exe -h

 

Options
Option Parameter Description Example

-new_name

<domain>

Renames a specified domain.

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

subscription.exe --update example.com -new_name sample.com

-dns

true|false

Enables/Disables DNS zone.

By default, settings from the current server-wide DNS template are used.

To enable the DNS zone for example.com:

subscription.exe -u example.com -dns true

-www

true|false

Allows/Prohibits accessing the domain using URL with the www prefix.

Is true by default.

To remove the www prefix from example.com:

subscription.exe --update example.com -www false

-hosting

true|false

Enables/Disables hosting.

Is false by default.

To enable hosting -ip, -login options are required.

To enable hosting for the domain example.com:

subscription.exe --update example.com -hosting true -ip 192.0.2.54 -login john -passwd sample

-hst_type

phys|std|frm

Sets up the type of hosting.

Here, phys means physical hosting, std standard forwarding hosting, and frm frame forwarding hosting.

Default value is phys.

The -ip option is required.

To set up standard forwarding hosting on the domain example.com:

subscription.exe --update example.com -hst_type std -login john

-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:

subscription.exe -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:

subscription.exe -u example.com -seo-redirect www

-target_url

<URL>

Sets the target URL for forwarding hosting types.

Required if the -hst_type option is set to std or frm.

To set up standard forwarding to the target URL sample.com for the domain example.com:

subscription.exe --update example.com -hst_type std -target_url www.sample.com

-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:

subscription.exe --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:

subscription.exe -c example.com -owner JDoe -service-plan megaplan -force

-force-lock

 

Forces 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:

subscription.exe -c example.com -owner JDoe -service-plan megaplan -force-lock

-www-root

<path>

Specifies website home directory (relative to the webspace root).

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

subscription.exe -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:

subscription.exe -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:

subscription.exe -c test.example.com -parent-domain-name example.com

 

-domain or -d

-subdomains or -s

<<subdomain[...]>

Use for specifying the subdomains to be removed or to retrieve subdomain information (--remove and --info commands respectively). By default the --info command outputs information on all existing subdomains

To remove subdomains test1.example.com and test2.example.com:

subscription.exe -r -s test1.example.com,test2.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:

subscription.exe -c example.com -owner JDoe -service-plan megaplan -vendor reseller1

-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 2009-12-30:

subscription.exe -c example.com -owner JDoe -creation-date 2008-12-30

-maillist_service

true|false

Enables/Disables the mailing list service.

Is false by default.

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

subscription.exe -u example.com -maillist_service true

-max-connections

<number>

Limits the number of available connections.

Unlimited is set to -1.

To limit the maximum number of connections available for the domain example.com to 10:

subscription.exe -u example.com -max-connections 10

-traffic-bandwidth

<number>

Limits the network use.

Unlimited is set to -1.

To limit the maximum network use on the domain example.com to 500 KB/S:

subscription.exe -u example.com -traffic-bandwidth 500

-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:

subscription.exe --change-owner example.com -owner JaneDoe -map_ip 192.0.2.87

-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 associate IPv4 address 192.0.2.33 with example.com configured for physical hosting:

subscription.exe --create example.com -hosting true -ip 192.0.2.33

To associate IPv4 address 192.0.2.33 and IPv6 address 2001:db8:85a3:0:0:8a2e:370:7334 with example.com configured for physical hosting:

subscription.exe --create example.com -hosting true -ip 192.0.2.33, 2001:db8:85a3:0:0:8a2e:370:7334

-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:

subscription.exe -u example.com -mail-service-ip 192.168.1.2

-login

<login_name>

Specifies FTP user name for access to the webspace.

To create the FTP user’s login for the example.com user, provided that the domain is configured to use physical hosting:

subscription.exe --update example.com -ip 192.0.2.33 -login new_ftp_user

-passwd

<password>

Specifies the FTP user password for access to the webspace.

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

subscription.exe --update example.com -passwd sample

-shell

"Login Disabled"|"Login Enabled"

Enables/Disables access to the system via remote desktop panel (RDP).

Is "Login Disabled" by default.

To enable access to the system via RDP:

subscription.exe --update example.com -shell "Login Enabled"

-hard_quota

<number>[B|K|M|G|T]

Sets the maximum amount of disk space available for the domain files.

Unlimited if set to 0.

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

subscription.exe --update example.com -hard_quota 100M

-publish-sb-site

true|false

Enables/Disables the creation and publishing of an empty site by Presence Builder when creating a new domain for the client with SB support.

Is true by default.

Not to create and publish an empty site when updating example.com:

subscription.exe -u example.com -publish-sb-site false

-ssi

true|false

Enables/Disables SSI support.

Is false by default.

To enable SSI support on example.com:

subscription.exe --update example.com -ssi true

-ssi_html

true|false

Enables/Disables SSI support for HTML and HTM files.

Is false by default.

To enable SSI support for HTML and HTM files on example.com:

subscription.exe -u example.com -ssi_html true

-php

true|false

Enables/Disables PHP support.

Is false by default.

To enable PHP support on example.com:

subscription.exe --update example.com -php true

-php_handler_id

cgi-5|cgi-5.3|cgi-5.4|

fastcgi-5|fastcgi-5.3|fastcgi-5.4|

isapi-5

Associates the specified PHP handler with the subscription. Specify the handler's identifier (default: fastcgi-5).

To enable running PHP of version5 as ISAPI extension on example.com:

subscription.exe -u example.com -php_handler_id isapi-5

-cgi

true|false

Enables/Disables CGI support.

Is false by default.

To enable CGI support on example.com:

subscription.exe --update 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:

subscription.exe -u example.com -cgi-mode www-root

-perl

true|false

Enables/Disables Perl support.

Is false by default.

To enable Perl support on example.com:

subscription.exe --update example.com -perl true

-asp

true|false

Enables/Disables ASP support.

Is false by default.

To enable ASP support on example.com:

subscription.exe --update example.com -asp true

-python

true|false

Enables/Disables Python support.

Is false by default.

To enable Python support on example.com:

subscription.exe --update example.com -python true

-miva

true|false

Enables/Disables Miva support.

Is false by default.

To enable Miva support on example.com:

subscription.exe --update example.com -miva true

-ssl

true|false

Enables/Disables accessing a domain via SSL.

Is false by default.

To enable SSL support on example.com:

subscription.exe --update example.com -ssl true

-webstat

none|webalizer|

awstats|smarterstats

Sets up which web statistics tool should be used on a domain.

Is none by default.

To set Webalizer used on example.com:

subscription.exe --update 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:

subscription.exe -u example.com -webstat-protdir-access true

-err_docs

true|false

Allows/Prohibits using custom HTTP error messages on a domain.

Is false by default (meaning standard error messages).

To allow custom error documents on example.com:

subscription.exe --update 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:

subscription.exe -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:

subscription.exe -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:

subscription.exe -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:

subscription.exe -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:

subscription.exe -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:

subscription.exe -u example.com -log-email admin@example.com

-write_modify

true|false

Allows or prohibits granting the Plesk IIS user and IIS application pool user the full access permission for the domain’s httpdocs/ and httpsdocs/ files and subfolders. Is false by default.

This permission might be required for correct functioning of web applications. Note that this permission, when granted, might seriously compromise website security.

 

Is false by default.

 

To allow the Plesk IIS User and IIS application pool user to write and modify files and subfolders in httpdocs/ and httpsdocs/ folders of example.com:

subscription.exe --update example.com -write_modify true

-webdeploy

true|false

Allows or prohibits web deploy publishing.

Is false by default.

To enable web deploy publishing for example.com:

subscription.exe --update example.com -webdeploy true

-iis_app_pool

true|false

Allows/Prohibits using dedicated IIS application pool for a domain. Is used with the --update command.

Is false by default.

To allow using dedicated IIS application pool on example.com:

subscription.exe --update example.com -iis_app_pool true

-cpu_usage

<integer>

Defines the maximum CPU usage by domain (in %).

Is used with the --update command.

To limit the maximum CPU usage by example.com to 3%:

subscription.exe -u example.com -cpu_usage 3

-cpu-usage-state

true|false

Switches IIS application pool CPU usage monitoring on or off.

To set up the following CPU usage settings for the IIS application pool of the subscription example.com:

  • limit the maximum CPU usage by worker processes to 3%,
  • shut down the IIS application pool for the rest of the reset interval if the processes have exceeded the limit,
  • reset monitoring data every 5 minutes:

     

    subscription.exe --set-iis-app-pool-settings example.com -iis-app-pool-turned-on true -cpu-usage-state true -cpu-usage-value 3 -cpu-usage-action KillW3wp -cpu-usage-interval 5 -max-worker-processes 3 -idle-timeout 5 -managed-pipeline-mode Integrated -recycling-by-time 60 -recycling-by-requests 1000 -recycling-by-virtual-memory 5120 -recycling-by-private-memory 10240

     

-cpu-usage-value

<integer number>

Specifies the maximum percentage of CPU time that worker processes in an application pool are allowed to consume over a period of time specified by the -cpu-usage-interval option.

If the limit is exceeded, the event is written to the event log and an optional set of events can be triggered. These optional events are determined by the -cpu-usage-action option.

-cpu-usage-action

NoAction|KillW3wp

Specifies the action that IIS takes when worker processes exceed the limit on CPU time usage.

  • NoAction - no action is taken when the CPU limit is exceeded. A warning is written to the event log.
  • KillW3wp - processes that exceed their CPU limit will be forced to shut down.

-cpu-usage-interval

<minutes>

Specifies the reset interval for monitoring of CPU usage by worker processes.

-iis-app-pool-turned-on

true|false

Turns IIS application pool for a site on or off.

-max-worker-processes

<number>

The maximum number of worker processes permitted to service requests for IIS application pool.

-idle-timeout

<minutes>

The amount of time a worker process will remain idle before it shuts down.

-managed-pipeline-mode

Integrated|Classic

Configures ASP.NET to run in classic mode as an ISAPI extension or in integrated mode where managed code is integrated into the request-processing pipeline.

-recycling-by-time

<minutes>

The period of time after which IIS application pool recycles.

-recycling-by-requests

<number>

The maximum number of requests IIS application pool can process before it recycles.

-recycling-by-virtual-memory

<KB>

The maximum amount of virtual memory a worker process can consume before causing the IIS application pool to recycle.

-recycling-by-private-memory

<KB>

The maximum amount of private memory a worker process can consume before causing the IIS application pool to recycle.

-log_rotate

true|false

Enables/Disables log rotation.

Is true by default.

To disable log rotation on example.com:

subscription.exe --update example.com -log_rotate false

-log_bysize

<number>[B|K|M|G|T]

Enables/Disables the processing of log files by size (the processing starts once the specified size is achieved).

To enable the processing of example.com log files when their size comes up to 200 KB:

subscription.exe --update sampledomain.com -log_bysize 200K

-log_bytime

daily|weekly

|monthly

Enables the processing of log files by time.

Is daily by default.

To set up weekly log rotation on example.com:

subscription.exe --update example.com -log_bytime weekly

-log_max_num

<number>

Specifies the maximum number of stored log files.

Is 3 by default.

To set the maximum number of log files on example.com to 5:

subscription.exe --update example.com -log_max_num 5

-log_compress

true|false

Enables/Disables log file compression.

Is true by default.

To disable log file compression on example.com:

subscription.exe --update example.com -log_compress false

-log_email

<email>

Enables sending log files to the specified email address.

To enable sending the log file of example.com to JohnDoe@example.com:

subscription.exe --update example.com -log_email JohnDoe@example.com

-mail_service

true|false

Enables/Disables running mail service.

Is false by default.

To disable mail service on example.com:

subscription.exe --update 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:

subscription.exe -u example.com -mail_service_node_ip local

-notify

true|false

Enables/Disables sending the ‘domain created’ notification to Plesk administrator.

Is true by default.

To disable sending the notification:

subscription.exe --create example.com -notify false

-asp.net

true|false

Enables/Disables supporting Microsoft ASP.NET framework.

Is false by default.

To enable Microsoft ASP.NET framework support on example.com:

subscription.exe -u example.com -asp.net true

-asp.net_version

1.1|2.0|4.0

Sets the default version of Microsoft ASP.NET framework.

Is 2.0 by default.

 

To make .NET v.4.0.x default on example.com:

subscription.exe -u example.com -asp.net_version 4.0

-certificate-name

<certificate_name>

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

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

subscription.exe -u example.com -certificate-name "Site Certificate"

 

-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:

subscription.exe -u 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:

subscription.exe --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":

subscription.exe --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:

subscription.exe --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):

subscription.exe --update-php-settings example.com -additional-settings my_file_add

-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'.

To forbid the IP address 192.168.1.2 access to the site example.com:

subscription.exe -u example.com -ip-deny 192.168.1.2

-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'.

To allow the IP address 192.168.1.2 access to the site example.com:

subscription.exe -u example.com -ip-allow 192.168.1.2

-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:

subscription.exe -u example.com -unpaid-website-status disabled

-description

<string>

Specifies a description of the subscription to be displayed in Plesk for anyone who has access to this subscription.

To create a description of the subscription example.com:

subscription.exe -u example.com -description "Notes about this site"

-admin-description

<string>

Specifies an administrator's description of the subscription. It is displayed in Plesk only to the administrator.

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

subscription.exe -u example.com -admin-description "Admin's notes about this site"

-reseller-description

<string>

Specifies a reseller's 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:

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

 

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.