Appendix: Plesk Auto-installer Utility Command Line Options

Option

Description and possible arguments

--source-type <local | network | plesk>

Specify the location of Plesk packages: type 'local' for local file system, 'plesk' for the official Plesk update server (the URL is hardcoded in the auto-installer binary), and 'network' for any network server (ftp, http and https protocols are supported).

--source <path | url>

When retrieving Plesk packages from a local file system, specify the '--source' option to point to the file that contains the information on the Plesk build you want to install.

When retrieving Plesk packages from a network server, specify the '--source <URL>' option to point to the directory where the mirror of Plesk update server resides.

--add-source <type, priority, url, username, environment variable with password>

To retrieve updates for server's operating system from vendor sites, specify this option with the arguments: --add-source="<type>, <priority>, <url>, <username>, <environment variable with password>"

Replace <type> with repomd value, priority with a number from 1 to 999 (999 is the highest priority), and <url> with a URL of the vendor updates source. The values <username> and <environment variable with password> are required only if your vendor's site requires authentication. For security reasons, you cannot specify the password in plain text; you can only assign the password to an environment variable and then specify this variable name as password.

Example:

export PASSWORD="my password"

--add-source repomd, 100, http://download.fedora.redhat.com/fedora/linux/core/updates/2/i386, username, PASSWORD

--target

By default, the auto-installer saves the retrieved files in the directory /<current user name>/psa. For instance, if auto-installer was executed by user root, the /root/psa directory will be created and used. If you want to use a custom directory for storing the retrieved files, use the '--target' option.
Example: --target /opt/storage/psa

--proxy-host <network address>

When using a proxy server or firewall, use this option to specify proxy server domain name or IP address.

Example: --proxy-host proxy.mydomain.org

--proxy-port <port number>

Default port for connecting to proxy server is 3128. If your proxy server uses different port number, you should specify it using this option.

Example: --proxy-port 5741

Proxy authentication options:
--proxy-user <user name>
--proxy-password <password>

If your proxy server requires authentication, you should use these options to authenticate auto-installer at the proxy server.

Example: --proxy-user smith --proxy-password f1sZ9AnQ4EnO52

--show-releases


Specify this option to retrieve a list of available releases for the operating system where the auto-installer is executed. You will be given a list of release identifiers and release descriptions. The release identifiers are what you will need to deal with.

--show-all-releases

This option shows all releases available from the Plesk updates server.

--select-release-id <release id>

Use this option to specify a release version that you want to install or view properties of.

--select-release-latest

Use this option to select the latest release available for your operating system.

--show-components


Specify this to obtain the information on the components available for the selected release. Components' descriptions and names will be displayed.
The component names are what you need to specify when selecting additional components to install.

--install-component <component name>

Use this option to specify the components that you wish to install. If you want to install two or more components at once, repeat this option for each component.

--install-everything

Use this option to install all components of the selected release.

--allow-kernel-install


Use this option if you want to allow kernel upgrade. By default, the auto-installer does not make any kernel upgrades.

Note that auto-installer installs new kernels to the system, leaving the older kernel aside so that you can revert to it at any time.

--show-os-list

Use this option to find out what operating systems are supported by the Plesk version you selected.

--mirror-os <OS name from OS list>

This option activates the mirroring feature in auto-installer. If you want to mirror releases for different operating systems, you should specify this option per each operating system.

--notify-email <e-mail address>

Use this option to have the auto-installer send you status reports by email. A successful completion report includes a list of installed/upgraded packages with a detailed log.

--enable-xml-output


This option is designed for communicating with the Plesk control panel, and it may be used for interaction with other applications.

When you specify this option, all output of auto-installer is XML-wrapped. Note that this option disallows auto-installer to report errors by exit code. Exit code is always zero and all errors are reported inside XML output.

--query-status


Because RPM database does not allow multiple accesses, auto-installer makes a lock on its functionality. Run this option to find out if auto-installer is active. This will check for a lock, and will return either an exit code (0 - auto-installer is idle, 1 - auto-installer is running and busy), or XML-formatted output.

--check-updates

Specify this option to check the updates server for updates applicable to your Plesk version.

A list of releases that you can update or upgrade to will be shown.