Skip to main content

Azure VPN Gateway

Pack Assets


The Centreon Monitoring Connector Azure VPN Gateway brings a host template:

  • Cloud-Azure-Network-VpnGateway-custom

It brings the following service templates:

Service AliasService TemplateService DescriptionDefault
HealthCloud-Azure-Network-VpnGateway-Health-ApiCheck VPN gateway stateX
Site-TrafficCloud-Azure-Network-VpnGateway-Site-Traffic-ApiCheck inbound and outbound site trafficX
Tunnel-TrafficCloud-Azure-Network-VpnGateway-Tunnel-Traffic-ApiCheck inbound and outbound tunnel trafficX
Vpn-Gateway-StatusCloud-Azure-Network-VpnGateway-Vpn-Gateway-Status-ApiCheck VPN gateway provisionning statusX

Discovery rules

The Centreon Monitoring Connector Azure VPN Gateway includes a Host Discovery provider to automatically discover the Azure instances of a given subscription and add them to the Centreon configuration. This provider is named Microsoft Azure VPN Gateway:


This discovery feature is only compatible with the api custom mode. azcli is not supported.

More information about discovering hosts automatically is available on the dedicated page.

Collected metrics & status

Status NameDescription
statusCurrent operational status
summaryLast related status message


Please find all the prerequisites needed for Centreon to get information from Azure on the dedicated page.


  1. Install the package on every Centreon poller expected to monitor Azure VPN Gateway resources:
yum install centreon-plugin-Cloud-Azure-Network-VpnGateway-Api
  1. On the Centreon web interface, on page Configuration > Monitoring Connector Manager, install the Azure VPN Gateway Centreon Monitoring Connector.



  • Log into Centreon and add a new host through Configuration > Hosts.
  • In the IP Address/DNS field, set the following IP address:
  • Aplly the Cloud-Azure-Network-VpnGateway-custom template to the host.
  • Once the template is applied, fill in the corresponding macros. Some macros are mandatory. These mandatory macros differ depending on the custom mode used.

Two methods can be used to set the macros:

  • Full ID of the Resource (/subscriptions/<subscription_id>/resourceGroups/<resourcegroup_id>/providers/XXXXX/XXXXX/<resource_name>) in AZURERESOURCE
  • Resource name in the AZURERESOURCE macro, and resource group name in the AZURERESOURCEGROUP macro.
xAZURERESOURCEID or name of the Azure VPN Gateway resource
AZURERESOURCEGROUPResource group name if resource name is used

How to check in the CLI that the configuration is OK and what are the main options for?

Once the plugin is installed, log into your Centreon poller's CLI using the centreon-engine user account (su - centreon-engine) and test the plugin by running the following command:

/usr/lib/centreon/plugins// \
--plugin=cloud::azure::network::vpngateway::plugin \
--mode=health \
--custommode='api' \
--resource='' \
--resource-group='' \
--subscription='' \
--tenant='' \
--client-id='' \
--client-secret='' \
--proxyurl='' \
--ok-status='%{status} =~ /^Available$/' \
--warning-status='' \
--critical-status='%{status} =~ /^Unavailable$/' \
--unknown-status='%{status} =~ /^Unknown$/' \

The expected command output is shown below:

OK: VPN Gateway '%s' Provisioning State '%s' [Gateway type: '%s'] [VPN type: '%s'] | 

All available options for a given mode can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins// \
--plugin=cloud::azure::network::vpngateway::plugin \
--mode=site-traffic \

All available modes can be displayed by adding the --list-mode parameter to the command:

/usr/lib/centreon/plugins// \
--plugin=cloud::azure::network::vpngateway::plugin \


Please find the troubleshooting documentation for the API-based plugins in this chapter.