pem.statistics.getStatisticsReport

This method is supported by POA starting from version 5.0

This method returns resource usage reports. The table below provides a list of the available reports.

Report Name

Description

poaVersion

POA version

Example of the report:

  • name: poaVersion
  • value: 5.0

ADSync

Total amount of enabled 'Active Directory Synchronization' services.

Example of the report:

  • name: Active Directory Synchronization
  • value: 1000

totalDomains

Total number of active domains (domains are in the Enabled state in POA)

Example of the report:

  • name: totalDomains
  • value: 1000

parkedDomains

Total number of parked domains. Domain is included into the report when the following conditions are satisfied:

  • DNS Hosting only is installed on domain

OR

  • DNS Hosting and Domain Parking Hosting only are installed on domain

Example of the report:

  • name: parkedDomains
  • value: 1000

domainsLinux

Total number of domains with Linux-based Hostings. Domain is included into the report when the following conditions are satisfied:

  • Domain has one or more Linux-based Hostings installed

AND

  • Domain has no Windows-based Hostings installed

Example of the report:

  • name: domainsLinux
  • value: 1000

domainsWindows

Total number of domains with Windows-based Hostings. Domain is included into the report when the following conditions are satisfied:

  • Domain has one or more Windows-based Hostings installed

AND

  • Domain has no Linux-based Hostings installed

Example of the report:

  • name: domainsWindows
  • value: 1000

mailboxesLinux

Total number of CQMail Mailboxes

Example of the report:

  • name: mailboxesLinux
  • value: 1000

mailboxesWindows

Total number of Exchange Mailboxes

Example of the report:

  • name: mailboxesWindows
  • value: 1000

PPPServersLinux

Total number of Parallels Plesk Panel Servers on Linux (Parallels Plesk Panel is installed on Hardware Node or VPS)

Example of the report:

  • name: PPPServersLinux
  • value: 1000

PPPServersWindows

Total number of Parallels Plesk Panel Servers on Windows (Parallels Plesk Panel is installed on Hardware Node or VPS)

Example of the report:

  • name: PPPServersWindows
  • value: 1000

PVCServersLinux

Total number of Linux-based VPS Hardware Nodes

Example of the report:

  • name: PVCServersLinux
  • value: 1000

PVCServersWindows

Total number of Windows-based VPS Hardware Nodes

Example of the report:

  • name: PVCServersWindows
  • value: 1000

PVCContainersLinux

Total number of Linux-based VPSs (Shared or Dedicated)

Example of the report:

  • name: PVCContainersLinux
  • value: 1000

PVCContainersWindows

Total number of Windows-based VPSs (Shared or Dedicated)

Example of the report:

  • name: PVCContainersWindows
  • value: 1000

PSBSitesLinux

Total number of published Linux-based Parallels Plesk Sitebuilder Sites

Example of the report:

  • name: PSBSitesLinux
  • value: 1000

PSBSitesWindows

Total number of published Windows-base Parallels Plesk Sitebuilder Sites

Example of the report:

  • name: PSBSitesWindows
  • value: 1000

Resellers

Total number of active Reseller Accounts (accounts are in the Enabled state in POA)

Example of the report:

  • name: Resellers
  • value: 1000

ActiveAccounts

Total number of active Accounts (accounts are in the Enabled state in POA)

Example of the report:

  • name: Active accounts
  • value: 1000

ActiveSubscriptions

Total number of active Subscriptions (Subscriptions are in the Enabled state in POA)

Example of the report:

  • name: Active subscriptions
  • value: 1000

Domains

Total number of active domains (domains are in the Enabled state in POA)

Example of the report:

  • name: Domains
  • value: 1000

DomainsWithParkingHosting

Total number of parked domains. Domain is included into the report when the following conditions are satisfied:

  • Domain Parking Hosting only is installed on domain

OR

  • Domain Parking Hosting and Linux-based/Windows-based Hostings are installed on domain

Example of the report:

  • name: Parked domains
  • value: 1000

DomainsWithSH

Total number of domains with Linux-based Hostings. Domain is included into the report when the following conditions are satisfied:

  • Domain has one or more Linux-based Hostings installed

OR

  • Linux-based Hostings and Windows-based Hostings are installed on domain

Example of the report:

  • name: Domains (with shared hosting)
  • value: 1000

DomainsWithWSH

Total number of domains with Windows-based Hostings. Domain is included into the report when the following conditions are satisfied:

  • Domain has one or more Windows-based Hostings installed

OR

  • Domain has Windows-based Hostings and Linux-based Hostings installed

Example of the report:

  • name: Domains (Windows Shared)
  • value: 1000

ExchangeMailboxes

Total number of Exchange Mailboxes

Example of the report:

  • name: Mailboxes (Hosted Exchange)
  • value: 1000

QmailMailboxes

Total number of CQMail Mailboxes

Example of the report:

  • name: Mailboxes (Qmail)
  • value: 1000

WSSUsers

Total number of SharePoint users

Example of the report:

  • name: SharePoint Users
  • value: 1000

SBPublishedSites

Total number of published Parallels Plesk Sitebuilder sites

Example of the report:

  • name: SiteBuilder (Published Sites)
  • value: 1000

ServersWeb

Total number of web servers (VPSs and Hardware Nodes). Server is included into the report when the following conditions are satisfied:

  • IIS service is installed on server and there are more than 5 IIS Web Hostings provided by this service

OR

  • WinFileManager service is installed on server and there is one or more webspaces served by this service

OR

  • Apache service is installed on server and there are more than 5 Apache Web Hostings provided by this service

OR

  • AWStats service is installed on server

OR

  • Urchin service is installed on server

Note: If one or more different (by type) services are installed on the same server, it is included into the report only once.

Example of the report:

  • name: Servers (Web)
  • value: 1000

ServersMail

Total number of mail servers (VPSs and Hardware Nodes). Server is included into the report when the following conditions are satisfied:

  • clustered-qmail service is installed on server

OR

  • DrWeb daemon service is installed on server

OR

  • SpamAssassin service is installed on server and there is one or more Mailboxes protected by this service

Notes:

1. If one or more different (by type) services are installed on the same server, it is included into the report only once.

2. If QMail is deployed in the cluster mode, each cluster node is included into the report.

Example of the report:

  • name: Servers (Qmail)
  • value: 1000

ServersDB

Total number of database servers (VPSs and Hardware Nodes). Server is included into the report when the following conditions are satisfied:

  • MySQL service is installed on server and there is one or more customer databases hosted by this service

OR

  • PgSQL service is installed on server and there is one or more customer databases hosted by this service

OR

  • MS SQL service is installed on server and there is one or more customer databases hosted by this service

Note:

If one or more different (by type) services are installed on the same server, it is included into the report only once.

Example of the report:

  • name: Servers (databases)
  • value: 1000

ExchangeLight

Total number of Exchange Mailboxes where the MAPI protocol is in the disabled state (Outlook access is in the disabled state in CCP).

Example of the report:

  • name: Exchange Light
  • value: 1000

ExchangeFull

Total number of Exchange Mailboxes where the MAPI protocol is in the enabled state (Outlook access is in the enabled state in CCP).

Example of the report:

  • name: Exchange Full
  • value: 1000

VPSDistribution

This report provides information how VPSs are distributed on VPS Hardware Nodes according to specified thresholds.

Thresholds are defined in the following format: number1,...,numberN

There are the following intervals: [0,number1], (number1,number2],...,(numberN,infinity).

For example: when 5 and 10 thresholds are defined, there are the following intervals: [0,5], (5,10], (10,infinity).

Example of the report for 5 and 10 thresholds:

  • name: 10 VZ VPS
  • value: 13 - the total number of VPSs distributed among VPS Hardware Nodes of Total VZ servers with up to 10 VZ VPS class

 

  • name: 5 VZ VPS
  • value: 9 - the total number of VPSs distributed among VPS Hardware Nodes of Total VZ servers with up to 5 VZ VPS class

 

  • name: >10 VZ VPS
  • value: 35 - the total number of VPSs distributed among VPS Hardware Nodes of Total VZ servers with more than 10 VZ VPS class

 

  • name: Total VZ servers with more than 10 VZ VPS
  • value: 1 - total number of VPS Hardware Nodes where a number of VPSs > 10

 

  • name: Total VZ servers with up to 10 VZ VPS
  • value: 2 - total number of VPS Hardware Nodes where a number of VPSs > 5 and number of VPSs <= 10

 

  • name: Total VZ servers with up to 5 VZ VPS
  • value: 7 - total number of VPS Hardware Nodes where a number of VPSs <= 5

 

Note: Thresholds are mandatory report's parameters.

VPSLinuxNoPlesk

Total number of Linux-based VPSs without Parallels Plesk Panel

Example of the report:

  • name: Active Linux VPSes without Plesk
  • value: 1000

VPSWindowsNoPlesk

Total number of Windows-based VPSs without Parallels Plesk Panel

Example of the report:

  • name: Active Windows VPSes without Plesk
  • value: 1000

VPSLinuxPlesk

Total number of Linux-based VPSs with Parallels Plesk Panel

Example of the report:

  • name: Active Linux VPSes with Plesk
  • value: 1000

VPSWindowsPlesk

Total number of Windows-based VPSs with Parallels Plesk Panel

Example of the report:

  • name: Active Windows VPSes with Plesk
  • value: 1000

SPLA

Exchange SPLA report (at the beginning of the current month)

Example of the report:

  • name: Hosted Exchange Basic SAL
  • value: 10

 

  • name: Hosted Exchange Enterprise Plus SAL
  • value: 20

 

  • name: Hosted Exchange Enterprise SAL
  • value: 30

 

  • name: Hosted Exchange Standard Plus SAL
  • value: 40

 

  • name: Hosted Exchange Standard SAL
  • value: 50

Blackberry

Total usage of Blackberry resource

Example of the report:

  • name: Blackberry
  • value: 1000

Goodlink

Total usage of Good Mobile Messaging resource

Example of the report:

  • name: GoodLink
  • value: 1000

MessageLabs

Total usage of MessageLabs resource

Example of the report:

  • name: MessageLabs
  • value: 1000

GlobalRelay

Total usage of Global Relay Archiving resource

Example of the report:

  • name: GlobalRelay
  • value: 1000

OCS

Total number of OCS organizations in enabled subscriptions (active OCS organizations).

Example of the report:

  • name: Office Communications: Organizations
  • value: 1000
  • OCS-Phones

Total number of OCS phones attached to active OCS organizations.

Example of the report:

  • name: Office Communications: Phone Numbers
  • value: 1000

OCS-LocationProfiles

Total number of location profiles in active OCS organizations.

Example of the report:

  • name: Office Communications: Location Profiles
  • value: 1000

OCS-Users

Total number of enabled OCS Users in active OCS organizations.

Example of the report:

  • name: Office Communications: Users
  • value: 1000

Note: OCS Users is a sum of the Standard OCS Users, Enterprise OCS Users, and Enterprise OCS Users with Voice Access.

OCS-UsersStandard

Total number of enabled Standard OCS Users in active OCS organizations.

Standard OCS Users: the IP A/V, Web Conferencing, and Telephony features are disabled.

Example of the report:

  • name: Office Communications: Standard Users
  • value: 1000

OCS-UsersEnterprise

Total number of enabled Enterprise OCS Users in active OCS organizations.

Enterprise OCS Users: the IP A/V or Web Conferencing feature is enabled (or both features are enabled); the Telephony feature is disabled;

Example of the report:

  • name: Office Communications: Enterprise Users
  • value: 1000

OCS-UsersEnterpriseVA

Total number of enabled Enterprise OCS Users with Voice Access of any type in active OCS organizations.

Enterprise OCS Users with Voice Access: the IP A/V or Web Conferencing feature is enabled (or both features are enabled); the Telephony feature is enabled;

Example of the report:

  • name: Office Communications: Enterprise Users with Voice
  • value: 1000

Notes:

1. Resource usage is returned for active Subscriptions only (Subscriptions are in the Enabled state in POA).

2. There are the following Linux-based Hostings: Apache Web Hosting and CQMail Hosting.

3. There are the following Windows-based Hostings: IIS Web Hosting, Exchange Hosting, and SharePoint Services Hosting.

4. Each POA Hosting Module provides a set of reports. When a report is requested for not-installed Hosting Module, POA returns empty result for this report.

5. The ability to request several reports with equal names is not supported.

The method has the following input parameters:

Name

Type

Short Description

reports

array of struct

List of reports to produce
  • name

string

Name of report
  • value

string

Report's parameters, which can be specified in the following formats:

  • ParameterName1=Value1, ParameterName2=Value2, etc.
  • ParameterValue1, ParameterValue2, etc.

Note: The list of parameters depends on report.

The method returns the array of the following structures:

Name

Type

Short Description

name

string

Name of report

value

string

Resource usage