Skip to main content

Stormshield API

Pack Assets​


The Centreon Pack Stormshield API brings a host template:

  • Net-Stormshield-Api-custom

It brings the following service templates:

Service AliasService TemplateService DescriptionDefaultDiscovery
CpuNet-Stormshield-Cpu-ApiCheck the rate of utilization of CPU for the machineX
HaNet-Stormshield-Ha-ApiCheck high availability
HardwareNet-Stormshield-Hardware-ApiCheck hardwareX
HealthNet-Stormshield-Health-ApiCheck healthX
InterfacesNet-Stormshield-Interfaces-ApiCheck interfacesX
MemoryNet-Stormshield-Memory-ApiCheck memoryX
UptimeNet-Stormshield-Uptime-ApiCheck uptimeX

Discovery rules​

Rule NameDescription
Net-Stormshield-Api-Interface-UsernameDiscover network interfaces and monitor bandwidth utilization

More information about discovering services automatically is available on the dedicated page and in the following chapter.

Collected metrics & status​

Metric NameUnit


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


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 > Monitoring Connectors 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-network-stormshield-api

Whatever the license type (online or offline), install the Stormshield API Pack through the Configuration > Monitoring Connectors Manager menu.


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-Network-Stormshield-Api



  • Log into Centreon and add a new host through Configuration > Hosts.
  • Fill in the Name, Alias & IP Address/DNS fields according to your Stormshield server settings.
  • Apply the Net-Stormshield-Api-custom template to the host.
  • Once the template is applied, fill in the corresponding macros. Some macros are mandatory.

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=network::stormshield::api::plugin \
--mode=uptime \
--hostname='' \
--api-username='my-username' \

The expected command output is shown below:

OK: uptime is: 6d 7h 33m 46s | 'system.uptime.seconds'=545626s;;;0;

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

/usr/lib/centreon/plugins// \
--plugin=network::stormshield::api::plugin \
--mode=uptime \

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

/usr/lib/centreon/plugins// \
--plugin=network::stormshield::api::plugin \


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