Cisco ESA XMLAPI

Contenu du pack

Modèles

Le connecteur de supervision Cisco ESA XMLAPI apporte un modèle d'hôte :

• Net-Cisco-Esa-Xmlapi-custom

Le connecteur apporte le modèle de service suivant (classé selon le modèle d'hôte auquel il est rattaché) :

Net-Cisco-Esa-Xmlapi-custom

Alias	Modèle de service	Description
System-Usage	Net-Cisco-Esa-Sytem-Usage-Xmlapi-custom	Contrôle l'utilisation du système

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte Net-Cisco-Esa-Xmlapi-custom est utilisé.

Métriques & statuts collectés

Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service.

System-Usage

Métrique	Unité
system-status	N/A
system.memory.usage.percentage	%
system.cpu.total.utilization.percentage	%
system.disk.io.usage.percentage	%
system.logging.disk.usage.percentage	%
system.resource.conservation.current.count	count
system.connections.inbound.current.count	count
system.connections.outbound.current.count	count
system.queue.recipients.active.current.count	count
system.queue.messages.quarantine.current.count	count
system.queue.messages.workqueue.current.count	count
system.queue.messages.received.persecond	/s
system.queue.disk.usage.percentage	%

Prérequis

Veillez à disposer des informations suivantes :

• Informations d'authentification auprès de l'API XML (accès en lecture seule)
• Adresse IP de l'équipement.

Installer le connecteur de supervision

Pack

1. Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur 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 :

Alma / RHEL / Oracle Linux 8

dnf install centreon-pack-network-cisco-esa-xmlapi

Alma / RHEL / Oracle Linux 9

dnf install centreon-pack-network-cisco-esa-xmlapi

Debian 11 & 12

apt install centreon-pack-network-cisco-esa-xmlapi

CentOS 7

yum install centreon-pack-network-cisco-esa-xmlapi

2. Quel que soit le type de la licence (online ou offline), installez le connecteur Cisco ESA XMLAPI 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 connecteur. 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 :

Alma / RHEL / Oracle Linux 8

dnf install centreon-plugin-Network-Cisco-Esa-Xmlapi

Alma / RHEL / Oracle Linux 9

dnf install centreon-plugin-Network-Cisco-Esa-Xmlapi

Debian 11 & 12

apt install centreon-plugin-network-cisco-esa-xmlapi

CentOS 7

yum install centreon-plugin-Network-Cisco-Esa-Xmlapi

Utiliser le connecteur de supervision

Utiliser un modèle d'hôte issu du connecteur

1. Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
2. Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
3. Appliquez le modèle d'hôte Net-Cisco-Esa-Xmlapi-custom. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur.
4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires.

Macro	Description	Valeur par défaut	Obligatoire
XMLAPIUSERNAME	Specify the username for authentication		X
XMLAPIPASSWORD	Specify the password for authentication		X
XMLAPIPROTO	Protocol used http or https (default: https)
XMLAPIURLPATH	Set path to get server-status page in auto mode (default: '/xml/status')
XMLAPIEXTRAOPTIONS	Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées ici.

5. Déployez la configuration. L'hôte apparaît dans la liste des hôtes supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros.

Utiliser un modèle de service issu du connecteur

1. Si vous avez utilisé un modèle d'hôte et coché la case Créer aussi les services liés aux modèles, les services associés au modèle ont été créés automatiquement, avec les modèles de services correspondants. Sinon, créez les services désirés manuellement et appliquez-leur un modèle de service.
2. Renseignez les macros désirées (par exemple, ajustez les seuils d'alerte). Les macros indiquées ci-dessous comme requises (Obligatoire) doivent être renseignées.

System-Usage

Macro	Description	Valeur par défaut	Obligatoire
UNKNOWNHTTPSTATUS	Threshold unknown for http response code (default: '%{http_code} < 200 or %{http_code} >= 300')
WARNINGCONNECTIONSIN	Warning threshold for 'connections-in'
CRITICALCONNECTIONSIN	Critical threshold for 'connections-in'
WARNINGCONNECTIONSOUT	Warning threshold for 'connections-out'
CRITICALCONNECTIONSOUT	Critical threshold for 'connections-out'
WARNINGCPUTOTAL	Warning threshold for 'cpu-total' (%)
CRITICALCPUTOTAL	Critical threshold for 'cpu-total' (%)
WARNINGDISKIO	Warning threshold for 'diskio' (%)
CRITICALDISKIO	Critical threshold for 'diskio' (%)
WARNINGHTTPSTATUS	Warning threshold for http response code
CRITICALHTTPSTATUS	Critical threshold for http response code
WARNINGLOG	Warning threshold for 'log' (%)
CRITICALLOG	Critical threshold for 'log' (%)
WARNINGMEMORY	Warning threshold for 'memory' (%)
CRITICALMEMORY	Critical threshold for 'memory' (%)
WARNINGMESSAGESQUARANTINE	Warning threshold for 'messages-quarantine'
CRITICALMESSAGESQUARANTINE	Critical threshold for 'messages-quarantine'
WARNINGMESSAGESRECEIVED	Warning threshold for 'messages-received'
CRITICALMESSAGESRECEIVED	Critical threshold for 'messages-received'
WARNINGMESSAGESWORKQUEUE	Warning threshold for 'messages-workqueue'
CRITICALMESSAGESWORKQUEUE	Critical threshold for 'messages-workqueue'
WARNINGQUEUEACTIVERECIPIENTS	Warning threshold for 'queue-active-recipients'
CRITICALQUEUEACTIVERECIPIENTS	Critical threshold for 'queue-active-recipients'
WARNINGQUEUEDISK	Warning threshold for 'queuedisk' (%)
CRITICALQUEUEDISK	Critical threshold for 'queuedisk' (%)
WARNINGRESOURCECONSERVATION	Warning threshold for 'resource-conservation'
CRITICALRESOURCECONSERVATION	Critical threshold for 'resource-conservation'
CRITICALSYSTEMSTATUS	Define the conditions to match for the status to be CRITICAL. You can use the following variables: %{system_status}	%{system_status} !~ /online/i
WARNINGSYSTEMSTATUS	Define the conditions to match for the status to be WARNING. You can use the following variables: %{system_status}
EXTRAOPTIONS	Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.

3. Déployez la configuration. Le service apparaît dans la liste des services supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails du service : celle-ci montre les valeurs des macros.

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). Vous pouvez tester que le connecteur arrive bien à superviser une ressource en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

/usr/lib/centreon/plugins/centreon_cisco_esa_xmlapi.pl \
    --plugin=network::cisco::esa::xmlapi::plugin \
    --mode=system-usage \
    --hostname=10.0.0.1 \
    --proto='' \
    --urlpath='' \
    --username='' \
    --password=''  \
    --unknown-http-status='' \
    --warning-http-status='' \
    --critical-http-status='' \
    --warning-system-status='' \
    --critical-system-status='%{system_status} !~ /online/i' \
    --warning-memory='' \
    --critical-memory='' \
    --warning-cpu-total='' \
    --critical-cpu-total='' \
    --warning-diskio='' \
    --critical-diskio='' \
    --warning-log='' \
    --critical-log='' \
    --warning-queue-active-recipients='' \
    --critical-queue-active-recipients='' \
    --warning-messages-quarantine='' \
    --critical-messages-quarantine='' \
    --warning-messages-workqueue='' \
    --critical-messages-workqueue='' \
    --warning-messages-received='' \
    --critical-messages-received='' \
    --warning-queuedisk='' \
    --critical-queuedisk='' \
    --warning-connections-in='' \
    --critical-connections-in='' \
    --warning-connections-out='' \
    --critical-connections-out='' \
    --warning-resource-conservation='' \
    --critical-resource-conservation='' 

La commande devrait retourner un message de sortie similaire à :

OK: memory usage: 36 % total cpu usage: 46 % disk i/o usage: 1 % logging disk usage: 23 % resource conservation mode: 46 current inbound connections: 97 current outbound connections: 0 queue active recipients: 25 messages in quarantine: 35 messages in work queue: 42 messages received: 2/s queue disk usage: 8 % | 'system-status'=90;;;;'system.memory.usage.percentage'=36%;;;0;100'system.cpu.total.utilization.percentage'=46%;;;0;100'system.disk.io.usage.percentage'=1%;;;0;100'system.logging.disk.usage.percentage'=23%;;;0;100'system.resource.conservation.current.count'=46;;;0;'system.connections.inbound.current.count'=97;;;0;'system.connections.outbound.current.count'=0;;;0;'system.queue.recipients.active.current.count'=25;;;0;'system.queue.messages.quarantine.current.count'=35;;;0;'system.queue.messages.workqueue.current.count'=42;;;0;'system.queue.messages.received.persecond'=2/s;;;0;'system.queue.disk.usage.percentage'=8%;;;0;100

Diagnostic des erreurs communes

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

Modes disponibles

Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal.

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

/usr/lib/centreon/plugins/centreon_cisco_esa_xmlapi.pl \
    --plugin=network::cisco::esa::xmlapi::plugin \
    --list-mode

Le plugin apporte les modes suivants :

Mode	Modèle de service associé
system-usage [code]	Net-Cisco-Esa-Sytem-Usage-Xmlapi-custom

Options disponibles

Options des modes

Les options disponibles pour chaque modèle de services sont listées ci-dessous :

System-Usage

Option	Description
--mode	Define the mode in which you want the plugin to be executed (see--list-mode).
--dyn-mode	Specify a mode with the module's path (advanced).
--list-mode	List all available modes.
--mode-version	Check minimal version of mode. If not, unknown error.
--version	Return the version of the plugin.
--pass-manager	Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.
--verbose	Display extended status information (long output).
--debug	Display debug messages.
--filter-perfdata	Filter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.
--filter-perfdata-adv	Filter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value.
--explode-perfdata-max	Create a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '_max' suffix). Example: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;;
--change-perfdata --extend-perfdata	Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[m ax]] Common examples: Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic_in,,percent()'
--extend-perfdata-group	Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[ne wuom],[min],[max]] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard |error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traf fic_(in|out)_$1)'
--change-short-output --change-long-output	Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-exit	Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.
--range-perfdata	Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata.
--filter-uom	Mask the units when they don't match the given regular expression.
--opt-exit	Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.
--output-ignore-perfdata	Remove all the metrics from the service. The service will still have a status and an output.
--output-ignore-label	Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...'
--output-xml	Return the output in XML format (to send to an XML API).
--output-json	Return the output in JSON format (to send to a JSON API).
--output-openmetrics	Return the output in OpenMetrics format (to send to a tool expecting this format).
--output-file	Write output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
--disco-format	Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).
--disco-show	Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.
--float-precision	Define the float precision for thresholds (default: 8).
--source-encoding	Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'.
--memcached	Memcached server to use (only one server).
--redis-server	Redis server to use (only one server). Syntax: address[:port]
--redis-attribute	Set Redis Options (--redis-attribute="cnx_timeout=5").
--redis-db	Set Redis database index.
--failback-file	Failback on a local file if Redis connection fails.
--memexpiration	Time to keep data in seconds (default: 86400).
--statefile-dir	Define the cache directory (default: '/var/lib/centreon/centplugins').
--statefile-suffix	Define a suffix to customize the statefile name (default: '').
--statefile-concat-cwd	If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux.
--statefile-format	Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default).
--statefile-key	Define the key to encrypt/decrypt the cache.
--statefile-cipher	Define the cipher algorithm to encrypt the cache (default: 'AES').
--http-peer-addr	Set the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution.
--proxyurl	Proxy URL. Example: http://my.proxy:3128
--proxypac	Proxy pac file (can be a URL or a local file).
--insecure	Accept insecure SSL connections.
--http-backend	Perl library to use for HTTP transactions. Possible values are: lwp (default) and curl.
--ssl-opt	Set SSL Options (--ssl-opt="SSL_version => TLSv1" --ssl-opt="SSL_verify_mode => SSL_VERIFY_NONE").
--curl-opt	Set CURL Options (--curl-opt="CURLOPT_SSL_VERIFYPEER => 0" --curl-opt="CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_1" ).
--hostname	IP Address or FQDN of the web server host
--port	Port used.
--proto	Protocol used http or https (default: https)
--urlpath	Set path to get server-status page in auto mode (default: '/xml/status')
--username	Specify the username for authentication
--password	Specify the password for authentication
--timeout	Threshold for HTTP timeout
--unknown-http-status	Threshold unknown for http response code (default: '%{http_code} \< 200 or %{http_code} >= 300')
--warning-http-status	Warning threshold for http response code
--critical-http-status	Critical threshold for http response code
--warning-system-status	Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %{system_status}
--critical-system-status	Define the conditions to match for the status to be CRITICAL (default: '%{system_status} !~ /online/i'). You can use the following variables: %{system_status}
--warning- --critical-	Warning threshold. Can be: 'memory' (%), 'cpu-total' (%), 'diskio' (%), 'log' (%), 'resource-conservation', 'connections-in', 'connections-out', 'queue-active-recipients', 'messages-quarantine', 'messages-workqueue', 'queuedisk' (%), 'messages-received'.

Pour un mode, la liste de toutes les options disponibles et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

/usr/lib/centreon/plugins/centreon_cisco_esa_xmlapi.pl \
    --plugin=network::cisco::esa::xmlapi::plugin \
    --mode=system-usage \
    --help