Aller au contenu principal

Zscaler Zero Trust Branch API

Dépendances du connecteur de supervision​

Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur Zscaler Zero Trust Branch API depuis la page Configuration > Connecteurs > Connecteurs de supervision :

Contenu du pack​

Modèles​

Le connecteur de supervision Zscaler Zero Trust Branch API apporte 2 modèles d'hôte :

  • Cloud-Zscaler-Ztb-Cluster-Restapi-custom
  • Cloud-Zscaler-Ztb-Gateway-Restapi-custom

Le connecteur apporte les modèles de service suivants (classés selon le modèle d'hôte auquel ils sont rattachés) :

AliasModèle de serviceDescription
Cluster-AppconnectorCloud-Zscaler-Ztb-Cluster-Appconnector-Restapi-customContrôle l'état et le nombre d'Appconnectors
Cluster-IpsecCloud-Zscaler-Ztb-Cluster-Ipsec-Restapi-customContrôle l'état des tunnels IPSec

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte Cloud-Zscaler-Ztb-Cluster-Restapi-custom est utilisé.

Règles de découverte​

Découverte d'hôtes​

Nom de la règleDescription
Zscaler ZTB GatewaysDécouvre les passerelles Zscaler Zero Trust Branch via l'API REST
Zscaler ZTB ClustersDécouvre les clusters Zscaler Zero Trust Branch via l'API REST

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique d'hôtes.

Découverte de services​

Nom de la règleDescription
Cloud-Zscaler-Ztb-Restapi-Gateway-Interfaces-NameDécouvre les interfaces réseau de la passerelle par leur nom et supervise leur statut et leur 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​

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

Aucune métrique n'est collectée : ce service crée uniquement le fichier de cache utilisé par les autres services.

Prérequis​

Client d'API Zscaler​

Le connecteur utilise l'API REST de Zero Trust Branch via Zscaler OneAPI. L'authentification repose sur le flux OAuth2 client credentials géré par ZIdentity.

  1. Dans le portail d'administration ZIdentity, allez à Administration > API Configuration > OneAPI > API Clients et ajoutez un client d'API utilisant la méthode d'authentification Client Secret.
  2. Attribuez à ce client d'API un rôle donnant un accès en lecture seule aux ressources de l'API Zero Trust Branch.
  3. Notez le Client ID et le Client Secret (le secret n'est affiché qu'une seule fois). Ils seront utilisés dans les macros d'hôte CLIENT_ID et CLIENT_SECRET.
  4. Identifiez les domaines suivants :
    • le domaine personnalisé (vanity domain) ZIdentity utilisé pour obtenir le jeton OAuth2 (par exemple mycompany.zslogin.net), à renseigner dans la macro LOGIN_DOMAIN,
    • le domaine de votre API ZTB (par exemple mycompany-api.goairgap.com), à renseigner dans la macro API_DOMAIN.

Flux réseaux​

Le collecteur doit pouvoir joindre le domaine d'authentification et le domaine de l'API en HTTPS (TCP/443).

Cache​

Pour limiter le nombre d'appels à l'API, les services de ce connecteur peuvent lire leurs données dans un fichier de cache au lieu d'interroger l'API. Pour cela :

  1. Créez un service utilisant le modèle de service Cache (il n'est pas créé automatiquement par les modèles d'hôte), avec un intervalle de contrôle inférieur à la durée de vie du cache (30 minutes par défaut, voir l'option --cache-lifetime).
  2. Ajoutez l'option --cache-use dans la macro EXTRA_OPTIONS des autres services.

Installer le connecteur de supervision​

Pack​

La procédure d'installation des connecteurs de supervision diffère légèrement suivant que votre licence est offline ou online.

  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 > Connecteurs > 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-cloud-zscaler-ztb-restapi
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Zscaler Zero Trust Branch API depuis l'interface web et le menu Configuration > Connecteurs > 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 :

dnf install centreon-plugin-Cloud-Zscaler-Ztb-Restapi

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 Cloud-Zscaler-Ztb-Cluster-Restapi-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.
MacroDescriptionValeur par défautObligatoire
PROTODefine https if neededhttps
PORTPort used443
API_DOMAINDefine the domain for ZTB API (example: mycompany-api.goairgap.com)X
CLIENT_IDDefine client IDX
CLIENT_SECRETDefine client secretX
CLUSTER_IDIdentifiant du cluster à superviser, sous forme d'expression régulière (exemple : ^<id>$). Renseigné automatiquement par la découverte d'hôtes. Si vide, tous les clusters sont supervisés
LOGIN_DOMAINDefine the domain for OAuth2 authentication (example: test.zslogin.net)X
API_EXTRA_OPTIONSAny extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées ici.
  1. 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.
MacroDescriptionValeur par défautObligatoire
EXTRA_OPTIONSAny extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.
  1. 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_zscaler_ztb_restapi.pl \
	--plugin=cloud::zscaler::ztb::restapi::plugin \
	--custommode=api \
	--mode=gateway-status \
	--login-domain='mycompany.zslogin.net' \
	--api-domain='mycompany-api.goairgap.com' \
	--client-id='XXXXXXXX' \
	--client-secret='XXXXXXXX' \
	--port='443' \
	--proto='https' \
	--include-gateway-id='^id8$' \
	--warning-gateways-detected='' \
	--critical-gateways-detected='' \
	--unknown-gateway-status='' \
	--warning-gateway-status='' \
	--critical-gateway-status='%{desiredState} ne %{operationalState}' \
	--unknown-running-version='' \
	--warning-running-version='' \
	--critical-running-version='' \
	--unknown-gateway-health='' \
	--warning-gateway-health='' \
	--critical-gateway-health='%{healthColor} !~ /green/' \
	--unknown-gateway-vrrp-status='' \
	--warning-gateway-vrrp-status='' \
	--critical-gateway-vrrp-status='%{vrrpState} =~ /fault/i' \
	--warning-last-update-time='' \
	--critical-last-update-time='' \
	--verbose

La commande devrait retourner un message de sortie similaire à :

OK: gateway 'LOCATION_501' operational state: active [desired state: active], running version: 8.0.8P3a, last update: 8m 9s - health color: green - VRRP state: master | 'gateways.detected.count'=1;;;0; 'LOCATION_501#gateway.update.time.last.seconds'=489s;;;0;

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_zscaler_ztb_restapi.pl \
	--plugin=cloud::zscaler::ztb::restapi::plugin \
	--list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
cache [code]Cloud-Zscaler-Ztb-Cache-Restapi-custom
cluster-appconnector [code]Cloud-Zscaler-Ztb-Cluster-Appconnector-Restapi-custom
cluster-ipsec [code]Cloud-Zscaler-Ztb-Cluster-Ipsec-Restapi-custom
discovery [code]Utilisé pour la découverte d'hôtes
gateway-containers [code]Cloud-Zscaler-Ztb-Gateway-Containers-Restapi-custom
gateway-cpu [code]Cloud-Zscaler-Ztb-Gateway-Cpu-Restapi-custom
gateway-disk [code]Cloud-Zscaler-Ztb-Gateway-Disk-Restapi-custom
gateway-interfaces [code]Cloud-Zscaler-Ztb-Gateway-Interfaces-Restapi-custom
gateway-memory [code]Cloud-Zscaler-Ztb-Gateway-Memory-Restapi-custom
gateway-status [code]Cloud-Zscaler-Ztb-Gateway-Status-Restapi-custom

Options disponibles​

Options génériques​

Les options génériques sont listées ci-dessous :

OptionDescription
--modeDefine the mode in which you want the plugin to be executed (see --list-mode).
--dyn-modeSpecify a mode with the module's path (advanced).
--list-modeList all available modes.
--mode-versionCheck minimal version of mode. If not, unknown error.
--versionReturn the version of the plugin.
--custommodeWhen a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option.
--list-custommodeList all available custom modes.
--multipleMultiple custom mode objects. This may be required by some specific modes (advanced).
--pass-managerDefine the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.
--verboseDisplay extended status information (long output).
--debugDisplay debug messages.
--show-passwordBy default, sensitive information in command lines is hidden in debug output and replaced with *** (however, debug logs may still display sensitive information). Using the --show-password option will display the passwords in plain text.
--filter-perfdataFilter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.
--filter-perfdata-advFilter 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-maxCreate 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-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage used perfdata into free: --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()'
--change-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage used perfdata into free: --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-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage used perfdata into free: --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-groupAdd 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,<names-of-new-metrics>,calculation[,[<new-unit-of-mesure>],[min],[max]] regex: regular expression <names-of-new-metrics>: 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 <new-unit-of-mesure> (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\
--change-short-output --change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=patternreplacementmodifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OKUpgi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-short-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=patternreplacementmodifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OKUpgi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=patternreplacementmodifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OKUpgi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-exitReplace 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.
--change-output-advReplace short output and exit code based on a "if" condition using the following variables: short_output, exit_code. Variables must be written either %{variable} or %(variable). Example: adding --change-output-adv='%(short_ouput) =~ /UNKNOWN: No daemon/,OK: No daemon,OK' will change the following specific UNKNOWN result to an OK result.
--range-perfdataRewrite 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-uomMask the units when they don't match the given regular expression.
--opt-exitReplace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.
--output-ignore-perfdataRemove all the metrics from the service. The service will still have a status and an output.
--output-ignore-labelRemove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...'
--output-xmlReturn the output in XML format (to send to an XML API).
--output-jsonReturn the output in JSON format (to send to a JSON API).
--output-openmetricsReturn the output in OpenMetrics format (to send to a tool expecting this format).
--output-fileWrite output in file (can be combined with JSON, XML and OpenMetrics options). Example: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
--disco-formatApplies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).
--disco-showApplies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.
--float-precisionDefine the float precision for thresholds (default: 8).
--source-encodingDefine the character encoding of the response sent by the monitored resource Default: 'UTF-8'.
--http-peer-addrSet the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution.
--proxyurlProxy URL. Example: http://my.proxy:3128
--proxypacProxy PAC file (can be a URL or a local file).
--insecureAccept insecure SSL connections.
--http-backendPerl library to use for HTTP transactions. Possible values are: lwp (default) and curl.
--memcachedMemcached server to use (only one server).
--redis-serverRedis server to use (only one server). Syntax: address[:port]
--redis-attributeSet Redis Options (--redis-attribute="cnx_timeout=5").
--redis-dbSet Redis database index.
--failback-fileFall back on a local file if Redis connection fails.
--memexpirationTime to keep data in seconds (default: 86400).
--statefile-dirDefine the cache directory (default: '/var/lib/centreon/centplugins').
--statefile-suffixDefine a suffix to customize the statefile name (default: '').
--statefile-concat-cwdIf 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-formatDefine the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default).
--statefile-keyDefine the key to encrypt/decrypt the cache.
--statefile-cipherDefine the cipher algorithm to encrypt the cache (default: 'AES').
--login-domainDefine the domain for OAuth2 authentication (example: test.zslogin.net)
--api-domainDefine the domain for ZTB API (example: mycompany-api.goairgap.com)
--client-idDefine client ID.
--client-secretDefine client secret.
--portPort used (default: 443)
--protoDefine https if needed (default: https)
--timeoutSet timeout in seconds (default: 50).
--api-pathDefine the base path of the API endpoints (default: /api).
--unknown-http-statusDefine the conditions to match on the HTTP status for the returned status to be UNKNOWN (default: %{http_code} < 200 or %{http_code} >= 300). You can use the following variables: %{http_code}
--warning-http-statusDefine the conditions to match on the HTTP status for the returned status to be WARNING. You can use the following variables: %{http_code}
--critical-http-statusDefine the conditions to match on the HTTP status for the returned status to be CRITICAL. You can use the following variables: %{http_code}
--cache-useUse the cache file (created with cache mode).
--cache-lifetimeDefine the cache lifetime before raising an error (default: 1800 seconds).

Options des modes​

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

OptionDescription
--include-cluster-nameInclude cluster names (regexp).
--exclude-cluster-nameExclude cluster names (regexp).
--include-appconnector-nameInclude App Connector names (regexp).
--exclude-appconnector-nameExclude App Connector names (regexp).
--include-cluster-idInclude cluster IDs (regexp).
--exclude-cluster-idExclude cluster IDs (regexp).
--custom-perfdata-instancesDefine perfdata instance (default: %(clusterName) %(appConnectorName)) You can use the following variables: %(clusterName), %(appConnectorName)
--unknown-appconnector-statusDefine the conditions to match for the status to be UNKNOWN. You can use the following variables: %{clusterName}, %{appConnectorName}, %{status}
--warning-appconnector-statusDefine the conditions to match for the status to be WARNING. You can use the following variables: %{clusterName}, %{appConnectorName}, %{status}
--critical-appconnector-statusDefine the conditions to match for the status to be CRITICAL (default: %{status} ne "connected"). You can use the following variables: %{clusterName}, %{appConnectorName}, %{status}
--warning-appconnectors-detectedThreshold.
--critical-appconnectors-detectedThreshold.
--warning-appconnector-runningThreshold.
--critical-appconnector-runningThreshold.

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_zscaler_ztb_restapi.pl \
	--plugin=cloud::zscaler::ztb::restapi::plugin \
	--custommode=api \
	--help