Skip to main content

Exchange NSClient++ API

Overview​

The Monitoring Connector Exchange NSClient API works with the Centreon NSClient++ monitoring agent and its built-in web server to run Powershell code to check the health and performance of Microsoft Exchange Servers.

Pack assets​

Monitored objects​

  • From Exchange Server 2k10 to latest

Collected metrics​

Coming soon ...

Prerequisites​

NSClient++​

To monitor an Exchange Server through NSClient++ API, install the Centreon packaged version of the NSClient++ agent. Please follow our official documentation and make sure that the Webserver / RESTApi configuration is correct.

Powershell​

Powershell and the Microsoft.Exchange.Management.PowerShell snap-in must be installed on the target Server.

Installation​

  1. Install the Centreon NRPE Client package on every Poller expected to monitor Microsoft Exchange servers:
yum install centreon-plugin-Operatingsystems-Windows-Restapi
  1. On the Centreon Web interface, install the Centreon Monitoring Connector Exchange NSClient API from the Configuration > Monitoring Connector Manager page

Host configuration​

  • Log into Centreon and add a new Host through Configuration > Hosts.
  • Apply the App-Exchange-NRPE-custom template and configure all the mandatory Macros:
MandatoryNameDescription
XNSCPRESTAPIPORTNSClient++ RestAPI port (Default: '8443')
XNSCPRESTAPIPROTONSClient++ RestAPI protocol to use (Default: 'https')
NSCPRESTAPILEGACYPASSWORDPassword to authenticate against the API if relevant
NSCPRESTAPIEXTRAOPTIONSAny extra option you may want to add to the command (eg. a --verbose flag)

Important information​

  • The Queue monitoring Service only works on Exchange Server running with the hub/transport role
  • Use this format to define MAILBOX macro at the service level: DOMAIN\USER