Overview of Command Line Interface (CLI) Calls

This section describes the various calls that you can use to create, edit, view, and delete resellers, sites, or users directly from the command line. It also describes the calls to export and import site information. The nine CLI calls located in the cli directory as executables are as follows:

• addobj.exe: Adds an object such as a reseller, a site or a user to the Parallels Pro Control Panel database.
• DeleteObj.exe: Deletes an object from the Parallels Pro Control Panel database.
• GetInfoObj.exe: Displays the configuration of an object.
• UpdateObj.exe: Updates the information for an object.
• SuspendObj.exe: Suspends the user access to the the control panel and its services
• ExportObj.exe: Exports the site information from the Parallels Pro Control Panel to a directory on the same server.
• ImportObj.exe: Imports the site information from its export directory to the Parallels Pro Control Panel.
• UpdateLicense.exe: Updates the Parallels Pro Control Panel license.
• SetConfig.exe: Allows the service provider to update the quota usage threshold

The syntax for running the above calls is similar, and is as follows:

• When the arguments are passed in the form of an XML file:

  <call_name> -t <org / reseller / user / usertemplate / updatelicense | mssqldb | dbtool | setconfig | suspendorg | suspendreseller> -f <location_of_XML_file> -u <parent_username> -p <parent_password> [-q]

  where, <parent_username> and <parent_password> refer to the login information of the parent administrator for that specific site, reseller, user, or user template. This login information is used by the parent administrator to log in to the Parallels Pro Control Panel. For example, if you want to create a site that belongs to a reseller, then the login information of that reseller should be specified in the command.

  Here, the -q option is for running the calls in quiet mode.

  While running the CLI call with the updatelicense parameters <parent_username> and <parent_password>, refer to the login information of the server administrator.

  To view the information of a reseller, run the following command using the "-f" option.

  GetInfoObj.exe -t reseller -f C:\wwpcli\xml\getresellerinfo.xml -u admin -p ensimpro

  where getresellerinfo.xml is an XML file containing all the parameters required to execute GetInfoObj.exe and located in the C:\wwpcli\xml directory.

• When the arguments are passed in the form of a string containing XML data:

  <call_name> -t <org / reseller / user / usertemplate / updatelicense | mssqldb | dbtool | setconfig | suspendorg | suspendreseller> -s <XML_data_as_a_string> -u <parent_username> -p <parent_password> [-q]

  Here, the -q option is for running the calls in quiet mode.

  To view the information for a reseller "res1.com", run the following command using the "-s" option.

  GetInfoObj.exe -t reseller -s "<?xml version='1.0' encoding='utf-8' ?><reseller><property name='Name'>res1.com</property><property name='ShortName'>res1sn</property></reseller>" -u admin -p ensimpro

  where the string <?xml version='1.0' encoding='utf-8' ?><reseller><property name='Name'>res1.com</property><property name='ShortName'>res1sn</property></reseller> contains all the parameters required to execute GetInfoObj.exe in XML format. Please note that the string is enclosed in double quotes (") and the tag values in single quotes (').