Aller au contenu principal

Stormshield API

Contenu du Pack​

Modèles​

Le Plugin Centreon Stormshield API apporte un modèle d'hôte :

  • Net-Stormshield-Api-custom

Il apporte les modèles de service suivants :

AliasModèle de serviceDescriptionDéfautDécouverte
CpuNet-Stormshield-Cpu-ApiContrôle du taux d'utilisation du CPU de la machineX
HaNet-Stormshield-Ha-ApiContrôle la haute disponibilité
HardwareNet-Stormshield-Hardware-ApiContrôle le matérielX
HealthNet-Stormshield-Health-ApiContrôle l'état de santéX
InterfacesNet-Stormshield-Interfaces-ApiContrôle les interfacesX
MemoryNet-Stormshield-Memory-ApiContrôle la mémoireX
UptimeNet-Stormshield-Uptime-ApiContrôle l'uptimeX

Règles de découverte​

Nom de la règleDescription
Net-Stormshield-Api-Interface-UsernameDécouvre les interfaces réseaux et supervise le statut et l'utilisation

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique de services et sa planification.

Métriques & statuts collectés​

MétriqueUnité
cpu.utilization.percentage%
cpu_num#core.cpu.utilization.percentage%

Prérequis​

Pour la supervision, un utilisateur avec des droits de lecture sur l'API est nécessaire.

Installation​

Pack de supervision​

Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le pack dans le menu Configuration > Gestionnaire de connecteurs de supervision.

Au contraire, si la plateforme utilise une licence offline, installez le paquet sur le serveur central via la commande correspondant au gestionnaire de paquets associé à sa distribution :

dnf install centreon-pack-network-stormshield-api

Quel que soit le type de la licence (online ou offline), installez le Pack Stormshield API depuis l'interface web et le menu Configuration > Gestionnaire de connecteurs de supervision.

Plugin​

À partir de Centreon 22.04, il est possible de demander le déploiement automatique du plugin lors de l'utilisation d'un pack. Si cette fonctionnalité est activée, et que vous ne souhaitez pas découvrir des éléments pour la première fois, alors cette étape n'est pas requise.

Plus d'informations dans la section Installer le plugin.

Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :

dnf install centreon-plugin-Network-Stormshield-Api

Configuration​

Hôte​

  • Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
  • Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre serveur Stormshield.
  • Appliquez le modèle d'hôte Net-Stormshield-Api-custom.
  • Une fois le modèle appliqué, les macros ci-dessous indiquées comme requises (Obligatoire) doivent être renseignées.
ObligatoireMacroDescription
STORMSHIELDAPIEXTRAOPTIONS--insecure
XSTORMSHIELDAPIPASSWORD
STORMSHIELDAPIPORT
STORMSHIELDAPIPROTO
XSTORMSHIELDAPIUSERNAME

Comment puis-je tester le plugin et que signifient les options des commandes ?​

Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne de commande depuis votre collecteur Centreon en vous connectant avec l'utilisateur centreon-engine (su - centreon-engine) :

/usr/lib/centreon/plugins/centreon_stormshield_api.pl \
--plugin=network::stormshield::api::plugin \
--mode=uptime \
--hostname='10.0.0.1' \
--api-username='my-username' \
--api-password='my-password'

La commande devrait retourner un message de sortie similaire à :

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

La liste de toutes les options complémentaires et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

/usr/lib/centreon/plugins//centreon_stormshield_api.pl \
--plugin=network::stormshield::api::plugin \
--mode=uptime \
--help

Tous les modes disponibles peuvent être affichés en ajoutant le paramètre --list-mode à la commande :

/usr/lib/centreon/plugins//centreon_stormshield_api.pl \
--plugin=network::stormshield::api::plugin \
--list-mode

Diagnostic des erreurs communes​

Rendez-vous sur la documentation dédiée des plugins basés sur HTTP/API.