Skip to main content

Thales Mistral VS9 Rest API

Pack Assets

Templates

The Centreon Pack Thales Mistral VS9 brings 2 different host templates:

  • App-Thales-Mistral-Vs9-Host-Restapi-custom
  • App-Thales-Mistral-Vs9-Mmc-Restapi-custom

It brings the following service templates:

Service AliasService TemplateService DescriptionDefault
CertificatesApp-Thales-Mistral-Vs9-Host-Device-Certificates-RestapiCheck certificatesX
Connection-StatusApp-Thales-Mistral-Vs9-Host-Device-Connection-Status-RestapiCheck MMC connectionX
InterfacesApp-Thales-Mistral-Vs9-Host-Device-Interfaces-RestapiCheck interfacesX
MistralApp-Thales-Mistral-Vs9-Host-Device-Mistral-RestapiCheck Mistral equipmentX
SystemApp-Thales-Mistral-Vs9-Host-Device-System-RestapiCheck systemX
TunnelsApp-Thales-Mistral-Vs9-Host-Device-Tunnels-RestapiCheck vpn tunnelsX

Discovery rules

Rule NameDescription
Thales Mistral VS9 DevicesDiscover devices from Thales Mistral MMC inventory

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

Collected metrics & status

Metric NameUnit
clusters.detected.count
cluster status
member status
cluster_name~member_name#member.contact.last.time.secondss

Prerequisites

To monitor, a user with read privileges on MMC API is required.

Setup

Monitoring Pack

If the platform uses an online license, you can skip the package installation instruction below as it is not required to have the pack displayed within the Configuration > Plugin Packs > Manager menu. If the platform uses an offline license, install the package on the central server with the command corresponding to the operating system's package manager:

dnf install centreon-pack-applications-thales-mistral-vs9-restapi

Whatever the license type (online or offline), install the Thales Mistral VS9 Rest API Pack through the Configuration > Plugin Packs > Manager menu.

Plugin

Since Centreon 22.04, you can benefit from the 'Automatic plugin installation' feature. When this feature is enabled, you can skip the installation part below.

You still have to manually install the plugin on the poller(s) when:

  • Automatic plugin installation is turned off
  • You want to run a discovery job from a poller that doesn't monitor any resource of this kind yet

More information in the Installing the plugin section.

Use the commands below according to your operating system's package manager:

dnf install centreon-plugin-Applications-Thales-Mistral-Vs9-Restapi

Configuration

Host

Mistral device

  • Log into Centreon and add a new host through Configuration > Hosts.
  • Fill the Name, Alias & IP Address/DNS fields according to your Thales Mistral VS9 Host server settings.
  • Apply the App-Thales-Mistral-Vs9-Host-Restapi-custom template to the host.
  • Once the template is applied, fill in the corresponding macros. Some macros are mandatory.
MandatoryMacroDescription
XDEVICEID
XDEVICESN
XMMCAPIHOSTNAME
XMMCAPIUSERNAME
XMMCAPIPASSWORD
MMCAPIPORT(Défaut : '5572')
MMCAPIPROTO(Défaut : 'https')
MMCAPIEXTRAOPTIONS--insecure

Mistral MMC

  • Log into Centreon and add a new host through Configuration > Hosts.
  • Fill the Name, Alias & IP Address/DNS fields according to your Thales Mistral VS9 MMC server settings.
  • Apply the App-Thales-Mistral-Vs9-MMC-Restapi-custom template to the host.
  • Once the template is applied, fill in the corresponding macros. Some macros are mandatory.
MandatoryMacroDescription
XMMCAPIUSERNAME
XMMCAPIPASSWORD
MMCAPIPORT(Défaut : '5572')
MMCAPIPROTO(Défaut : 'https')
MMCAPIEXTRAOPTIONS--insecure

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//centreon_thales_mistral_vs9_restapi.pl \
--plugin=apps::thales::mistral::vs9::restapi::plugin \
--mode=mmc-cluster \
--hostname='10.0.0.1' \
--port='5572' \
--proto='https' \
--api-username='my-username' \
--api-password='my-password' \
--verbose

The expected command output is shown below:

OK: cluster enabled: yes, replication status: synchronized - all nodes are ok | 'cluster.synchronization.done.percentage'=0%;;;0;100
node 'mmc-1.local' status: true
node 'mmc-2.local' status: true

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

/usr/lib/centreon/plugins//centreon_thales_mistral_vs9_restapi.pl \
--plugin=apps::thales::mistral::vs9::restapi::plugin \
--mode=mmc-cluster \
--help

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

/usr/lib/centreon/plugins//centreon_thales_mistral_vs9_restapi.pl \
--plugin=apps::thales::mistral::vs9::restapi::plugin \
--list-mode

Troubleshooting

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