Overview

Plesk Command Line Interface (CLI) is designed for integration of Plesk Server Administrator with third-party applications. It can also be used for managing Plesk installations by administrators experienced in using Plesk. This feature provides the command line interface to the majority of management tasks that can be performed by Plesk administrator. The CLI provides the alternative means of control for various business objects in Plesk. Plesk command line utilities use the Plesk core functionality to create, manage, and delete clients, domains, services and other Plesk objects.

Plesk CL utilities may be used by the root user from the console or script. The utilities require "root" or "psaadm" privileges to operate.

Plesk CLI supports localized names of business objects in the same manner as Plesk does. Therefore, you can create clients with contact names using a locale of your choice. Use the LANG environment variable to set up a particular locale.

Plesk CLI does not require the Web interface of Plesk Server Administrator to run.

Plesk CLI is commonly included in the Plesk distribution kit and is also available as the separate plesk-api-cli package.

The table below presents the command utilities provided by the current version of Plesk (in alphabetical order).

Utility	Affected Object(s)
`admin`	Plesk administrator control panel interface preferences and personal information.
`ai_prefs`	Operating System update sources.
`anonftp`	Anonymous FTP access on domains with physical hosting on a Plesk server.
`autoresponder`	Mail autoresponders.
`certificate`	SSL certificates.
`cfsetting`	ColdFusion service on the Plesk server.
`client`	Client accounts.
`client_pref`	Client limits and permissions, IP pool, and Plesk interface preferences (for example, the default language and skin) for Plesk clients.
`client_template`	Client templates.
`custombutton`	Custom buttons.
`database`	Databases and database users.
`database-server`	Database servers.
`desktop`	Desktop presets.
`dns`	DNS zones on domains and domain aliases.
`domadmin`	Domain administrator accounts.
`domain`	Domain accounts.
`domain_pref`	Domain limits and preferences for applications, scripting support, e-mail, and other services.
`domain_template`	Domain templates.
`domalias`	Domain aliases.
`init_conf`	Initial configuration of the Plesk server; Plesk administrator personal info.
`interface_template`	Control panel interface templates.
`ipmanage`	IP addresses on Plesk server.
`mail`	Domain-level mail service, and mail names (e-mail accounts).
`maillist`	Mailing lists.
`mailserver`	Server-wide mail server settings.
`protdir`	Password protection of Web directories on domains.
`server_dns`	Server-wide DNS zone template.
`server_pref`	Plesk default interface preferences, and Plesk server system preferences.
`service`	Services on the Plesk server.
`siteapp`	Site applications on the level of Plesk client's Application pool.
`skeleton`	Site skeletons (directory structure).
`spamassassin`	Spamassassin spam filter.
`subdomain`	Subdomains.
`tomcat`	Tomcat service and the Java-based Web applications on domains.
`webstat`	Webalizer preferences.
`webuser`	Web users on domains.

The Plesk for Linux/Unix command line utilities must be run from the directory in which they are stored. For general instructions on executing command line utilities on Plesk server, consult the Getting Started with Command-Line Utilities section.