Aller au contenu principal

Tosca Rest API

Contenu du pack​

Modèles​

Le connecteur de supervision Tosca Rest API apporte un modèle d'hôte :

  • App-Tosca-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) :

Par défaut, aucun service n'est créé automatiquement en appliquant ce modèle.

Métriques & statuts collectés​

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

MétriqueUnité
entries.passed.countcount
entries.failed.countcount
entries.not_executed.countcount
entries.unknown.countcount

Prérequis​

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

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 :
dnf install centreon-pack-applications-tosca-restapi
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Tosca Rest 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 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-Applications-Tosca-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 App-Tosca-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
TOSCAAPIUSERNAMEAPI usernameX
TOSCAAPIPASSWORDAPI passwordX
TOSCAAPIPORTPort used80
TOSCAAPIPROTOCOLSpecify HTTPS if neededhttp
TOSCAEXTRAOPTIONSAny extra option you may want to add to every command (E.g. a --verbose flag). All options are listed here--insecure
  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
WORKSPACEWorkspace name of the provided execution list
EXECUTIONLISTIDExecution list unique ID
WARNINGENTRIESFAILEDThresholds
CRITICALENTRIESFAILEDThresholds
WARNINGENTRIESNOTEXECUTEDThresholds
CRITICALENTRIESNOTEXECUTEDThresholds
WARNINGENTRIESPASSEDThresholds
CRITICALENTRIESPASSEDThresholds
WARNINGENTRIESUNKNOWNThresholds
CRITICALENTRIESUNKNOWNThresholds
EXTRAOPTIONSAny extra option you may want to add to the command (E.g. a --verbose flag). 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 un serveur en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

/usr/lib/centreon/plugins/centreon_tosca_restapi.pl \
	--plugin=apps::tosca::restapi::plugin \
	--mode=execution-list-status \
	--hostname='10.0.0.1' \
	--port='80' \
	--proto='http' \
	--api-username='myuser' \
	--api-password='*****'  \
	--workspace='MyWorkspace' \
    --execution-list-id='24c429d8-a6d7-46a7-a057-ac08c391d76f'

La commande devrait retourner un message de sortie similaire à :

OK: Execution list 'Centreon' entries passed: 1, failed: 0, not executed: 0, unknown: 0 | 'entries.passed.count'=1;;;0; 'entries.failed.count'=0;;0:0;0; 'entries.not_executed.count'=0;;;0; 'entries.unknown.count'=0;;;0;

Diagnostic des erreurs communes​

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

Modes disponibles​

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

/usr/lib/centreon/plugins/centreon_tosca_restapi.pl \
	--plugin=apps::tosca::restapi::plugin \
    --list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
execution-list-statusApp-Tosca-Restapi-Execution-List-Status
scenario-statusApp-Tosca-Restapi-Scenario-Status

Options disponibles​

Options génériques​

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

OptionDescriptionType
--modeDefine the mode in which you want the plugin to be executed (see--list-mode).Global
--dyn-modeSpecify a mode with the module's path (advanced).Global
--list-modeList all available modes.Global
--mode-versionCheck minimal version of mode. If not, unknown error.Global
--versionReturn the version of the plugin.Global
--custommodeWhen a plugin offers several ways (CLI, library, etc.) to get the an information the desired one must be defined with this option.Global
--list-custommodeList all available custom modes.Global
--multipleMultiple custom mode objects. This may be required by some specific modes (advanced).Global
--pass-managerDefine the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.Global
--verboseDisplay extended status information (long output).Output
--debugDisplay debug messages.Output
--filter-perfdataFilter perfdata that match the regexp. Eg: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.Output
--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). Eg: 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.Output
--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). Eg: 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%;;;;Output
--change-perfdata --extend-perfdataChange 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()Output
--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,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)'Output
--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). Eg: adding --change-short-output='OKUpgi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'Output
--change-exitReplace an exit code with one of your choice. Eg: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.Output
--range-perfdataChange perfdata range thresholds display: 1 = start value equals to '0' is removed, 2 = threshold range is not display.Output
--filter-uomMasks the units when they don't match the given regular expression.Output
--opt-exitReplace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.Output
--output-ignore-perfdataRemove all the metrics from the service. The service will still have a status and an output.Output
--output-ignore-labelRemove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Eg: 'OK: Ram Total:...' will become 'Ram Total:...'Output
--output-xmlReturn the output in XML format (to send to an XML API).Output
--output-jsonReturn the output in JSON format (to send to a JSON API).Output
--output-openmetricsReturn the output in OpenMetrics format (to send to a tool expecting this format).Output
--output-fileWrite 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.Output
--disco-formatApplies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).Output
--disco-showApplies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.Output
--float-precisionDefine the float precision for thresholds (default: 8).Output
--source-encodingDefine the character encoding of the response sent by the monitored resource Default: 'UTF-8'. Tosca Commander REST Webservice (TCRS)Output
--hostnameTosca hostname.Api
--portPort used (Default: 80)Api
--protoSpecify https if needed (Default: 'http')Api
--api-usernameTosca Commander API username.Api
--api-passwordTosca Commander API password.Api
--url-pathAPI base url path (Default: '/rest/toscacommander').Api
--timeoutSet timeout in seconds (Default: 10).Api
--http-peer-addrSet the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution.Http global
--proxyurlProxy URL. Eg: http://my.proxy:3128Http global
--proxypacProxy pac file (can be a URL or a local file).Http global
--insecureAccept insecure SSL connections.Http global
--http-backendPerl library to use for HTTP transactions. Possible values are: lwp (default) and curl.Http global
--ssl-optSet SSL Options (--ssl-opt="SSL_version => TLSv1" --ssl-opt="SSL_verify_mode => SSL_VERIFY_NONE").Backend lwp
--curl-optSet CURL Options (--curl-opt="CURLOPT_SSL_VERIFYPEER => 0" --curl-opt="CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_1" ).Backend curl

Options des modes​

Les options spécifiques aux modes sont listées ci-dessous :

OptionDescriptionType
--workspaceWorkspace name of the provided execution list.Mode
--execution-list-idExecution list unique ID.Mode
--warning-entries-* --critical-entries-*Thresholds. Can be: 'passed', 'failed', 'not-executed', 'unknown'.Mode

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_tosca_restapi.pl \
	--plugin=apps::tosca::restapi::plugin \
	--mode=execution-list-status \
    --help