Expand Operators

Expand operators are command-line utilities that perform operations on resources provided by the Expand API. The operators can be used to integrate Expand with third-party software and to automate management of Expand. This chapter describes functionality assigned to each operator and provides instructions on how to use it.

To perform a certain operation, do the following:

Find the operator that supports the operation.
For the application scope of operators, refer to the tables below.
Run the operator from any directory:
# /usr/local/psa/bin/<utility name> [operation data]

Here, [operation data] stands for details of operations to be performed. These details are passed as a request packet or a request statement. For instructions on how to form them, refer to the How to Use This Reference section.

Note: A client can run an operator from remote by issuing a specific HTTP message to Expand endpoint. For details on how to do it, refer to the Using External Endpoint to Invoke Operations section of the Expand API Developer Guide.

Upon successful execution, operator returns the 0 code. If an error occurs, an operator returns code 1 and writes the description of the encountered problem to stderr.

The following tables outline operations supported by each operator.

Operations on Plesk objects

Operator	Full Name	Scope
`exp_plesk_backup`	Plesk Clients and Domains Backup	Managing and scheduling backups of Plesk clients, domains, and servers.
`exp_plesk_client`	Plesk Clients	Creating/Removing Plesk client accounts, updating client account settings, adding/removing IP addresses to/from clients' IP pools.
`exp_plesk_dictionary`	Plesk Dictionary	Retrieving information on limits, permissions and physical hosting services for any Plesk version and any supported operating system.
`exp_plesk_dns`	Plesk DNS Zones	Configuring DNS zones for domains registered in Expand.
`exp_plesk_domain`	Plesk Domains	Creating/Removing domains, managing domain settings.
`exp_plesk_domainalias`	Plesk Domain Aliases	Creating/Removing domain aliases and setting web services for them.
`exp_plesk_group`	Plesk Server Groups	Creating/Removing server groups, managing group settings (renaming groups, move servers from one group to another).
`exp_plesk_ip`	Plesk IP Ranges	Creating/Removing IP ranges, reserving IP addresses for Plesk clients, assigning IP addresses to domains, adding/removing exclusions to/from IP ranges.
`exp_plesk_server`	Plesk Servers	Registering Plesk servers in Expand, and controlling resources of all registered Plesk servers on the centralized basis.
`exp_plesk_session`	Plesk Sessions	Retrieving/Updating sessions list, terminating sessions.
`exp_plesk_siteapp`	Plesk Site Applications	Retrieving list of application packages installed on Plesk nodes registered in Expand. Adding/removing packages to/from a client's pool.
`exp_plesk_tmpl_srv_client`	Plesk Client Templates	Creating client templates, retrieving information on them, updating list of available client templates.
`exp_plesk_tmpl_srv_domain`	Plesk Domain Templates	Creating domain templates, retrieving information on them, updating list of available domain templates.

Operations on Expand objects

Operator	Full Name	Scope
`exp_expand_config`	Expand Configuration and Users Management	Managing Expand users, viewing and configuring action log, updating system variables, managing custom buttons, and adjusting GUI configuration.
`exp_expand_evconf`	Expand Event Handlers and Event Classes	Configuring event classes and their handlers.
`exp_expand_license`	Expand License	Updating Expand license, rolling back to the previous license.
`exp_plesk_auth`	Expand/Plesk User Identity	Verifying data provided by Expand or Plesk users, and retrieving users' personal data.
`exp_plesk_centralized_db`	Expand Database Servers	Registering, configuring and removing database servers. Assign/Unlink Plesk nodes to/from database servers.
`exp_plesk_centralized_dns`	Expand Central DNS Servers	Adding, configuring and removing central DNS servers. Managing DNS services on DNS serves.
`exp_plesk_centralized_dns_zone`	Expand Central DNS Zones	Synchronizing central DNS zones and ACLs, ignoring/unignoring central DNS zones and ACEs, Resolve conflicts of DNS zones and DNS recursions.
`exp_plesk_helpdesk`	Expand Central Help Desk	Registering and administering Central Help Desk server in Expand.
`exp_plesk_mail_server`	Expand Central Mail Servers	Adding, configuring and removing central mail servers; assigning/Unlinking Plesk nodes to/from central mail server; migrate mail content from a Plesk mail server to a central mail server, etc.
`exp_plesk_migration`	Expand Migrations	Migrating Plesk client and domain data from one to another Plesk node registered in Expand.
`exp_plesk_multi_client`	Expand Clients	Creating/Removing Expand client accounts, updating client account settings, adding/removing IP addresses to/from clients' IP pools, transforming a Plesk client account to Expand client account.
`exp_plesk_tmpl_client`	Expand Client Templates	Creating Expand client templates, updating/retrieving their settings, removing client templates.
`exp_plesk_tmpl_domain`	Expand Domain Templates	Creating Expand domain templates, updating/retrieving their settings, removing domain templates.

Operations on Virtuozzo objects

Operator	Full Name	Scope
`exp_vz_hn`	Virtuozzo HWNs	Registering/Unlinking Virtuozzo Hardware Node (VHN) in/from Expand, updating VHN settings.