Aller au contenu principal

OpenStack RESTAPI

Dépendances du connecteur de supervision​

Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur OpenStack RESTAPI depuis la page Configuration > Connecteurs > Connecteurs de supervision :

Contenu du pack​

Modèles​

Le connecteur de supervision OpenStack RESTAPI apporte 2 modèles d'hôte :

  • Cloud-Openstack-RestAPI-Project-custom
  • Cloud-Openstack-RestAPI-Services-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 serviceDescriptionDécouverte
HypervisorCloud-Openstack-RestAPI-Project-Hypervisor-customContrôler un hyperviseur OpenstackX
InstanceCloud-Openstack-RestAPI-Project-Instance-customContrôler une VM OpenstackX
NetworkCloud-Openstack-RestAPI-Project-Network-customContrôler un réseau OpenstackX
PortCloud-Openstack-RestAPI-Project-Port-customContrôler un port OpenstackX
VolumeCloud-Openstack-RestAPI-Project-Volume-customContrôler un volume OpenstackX

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte Cloud-Openstack-RestAPI-Project-custom est utilisé.

Si la case Découverte est cochée, cela signifie qu'une règle de découverte de service existe pour ce service.

Règles de découverte​

Découverte d'hôtes​

Nom de la règleDescription
OpenStack HostDécouvre les hôtes en requêtant OpenStack via REST API
OpenStack ProjectDécouvre les projects en requêtant OpenStack via REST API
OpenStack ServicesDécouvre les services en requêtant OpenStack via REST API

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-Openstack-RestAPI-Project-HypervisorDécouvre et supervise les hyperviseurs d'un projet
Cloud-Openstack-RestAPI-Project-InstanceDécouvre et supervise les instances d'un projet
Cloud-Openstack-RestAPI-Project-LoadbalancerDécouvre et supervise les load balancers d'un projet
Cloud-Openstack-RestAPI-Project-NetworkDécouvre et supervise les réseaux d'un projet
Cloud-Openstack-RestAPI-Project-PortDécouvre et supervise les ports d'un projet
Cloud-Openstack-RestAPI-Project-VolumeDécouvre et supervise les volumes d'un projet
Cloud-Openstack-RestAPI-ServiceDécouvre les services et supervise leur utilisation système

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.

NomUnité
countN/A
statusN/A

Prérequis​

Ce connecteur vous permet de surveiller le fonctionnement des différents services OpenStack à l’aide de l’API REST.

Veuillez vous référer à la documentation OpenStack pour avoir plus d’informations sur la configuration de l’accès à l’API REST d’OpenStack.

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-openstack-restapi
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur OpenStack RESTAPI 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-OpenStack-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-Openstack-RestAPI-Project-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
USERDOMAINIDOpenStack user domain to use with authenticationdefault
USERNAMEOpenStack username
PASSWORDOpenStack password
AUTHENTBYENVSet to 1 to use OpenStack environment variables if they are defined. Used environment variables are OS_USERNAME, OS_PASSWORD, OS_PROJECT_DOMAIN, OS_USER_DOMAIN, OS_PROJECT_NAME, OS_AUTH_URL0
AUTHENTBYFILERead OpenStack environment variables from a file. Handled environment variables are OS_USERNAME, OS_PASSWORD, OS_PROJECT_DOMAIN, OS_USER_DOMAIN, OS_PROJECT_NAME, OS_AUTH_URL. Those variables must be defined using 'export VARIABLE="value"' syntax
DISCOMODESpecifies how OpenStack service endpoints are discovered. Can be 'auto', 'manual' or 'keystone'. With 'auto' mode services endpoints are retrieved from Keystone catalog except if a specific URL is provided with other options. With 'keystone' mode services endpoints are only retrieved from Keystone catalog. With 'manual' mode services endpoints are retrieved from command line optionsauto
EXCLUDEENDPOINTINTERFACE
IDENTITYURLSet the URL to use for the OpenStack Keystone (identity) service. A valid Keystone URL is required since it is the authentication service. The first part of the Keystone URL is also used to define the cache filename. Example: --identity-url="https://myopenstack.local:5000" This URL can also be construct with options (--identity-hostname, --identity-proto, --identity-port, --identity-endpoint)http://change\_me:5000
INCLUDEENDPOINTINTERFACE
PROJECTDOMAINIDOpenStack project domain id to use with authenticationdefault
PROJECTIDFilter by OpenStack project id (tenant id). This filter is applied before any other filters and requires admin rights. When unset volumes are filtered based on the project used during authentication
PROJECTNAMEOpenStack project name to use with authenticationdemo
TIMEOUTSet HTTP timeout in seconds. This timeout will only be used for other services if a more specific one is not already defined with other options10
  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
INCLUDETYPEFilter by service type (can be a regexp and can be used multiple times or for comma separated values)volume
EXPECTEDDATAData that endpoint should return when it is normally working. When auto is set the connector automatically defines the value depending on the type of endpoint. When a non empty value is set it represents a value that must be present in the returned data. If this option is not set the check only verifies that the data is a valid JSON. The result of this check 1/0 is saved in %{valid_content} variableauto
ENDPOINTSUFFIXAppend a specific suffix to he endpoint URL URL for the heath check. When auto is set the connector automatically defines the suffix depending on the type of endpoint. When none is set no suffix is appendedauto
SERVICEURLDefine the endpoint URL to check (can be multiple). When using this option the service type and name are set to service and N/A if not already defined with --include-type and --include-name options. When this option is not set the endpoints to test are taken from the cached Keystone service list previously generated with 'discovery' and 'list-services' commands and filtered by --include-* and --exclude-* options below
EXCLUDETYPEExclude by service type (can be a regexp and can be used multiple times or for comma separated values)
INCLUDENAMEFilter by service name (can be a regexp and can be used multiple times or for comma separated values)
EXCLUDENAMEExclude by service name (can be a regexp and can be used multiple times or for comma separated values)
INCLUDEIDFilter by service id (can be a regexp and can be used multiple times or for comma separated values)
EXCLUDEIDExclude by service id (can be a regexp and can be used multiple times or for comma separated values)
INCLUDEREGIONFilter by service region (can be a regexp and can be used multiple times or for comma separated values)
EXCLUDEREGIONExclude by service region (can be a regexp and can be used multiple times or for comma separated values)
INCLUDEREGIONIDFilter by service region ID (can be a regexp and can be used multiple times or for comma separated values)
EXCLUDEREGIONIDExclude by service region ID (can be a regexp and can be used multiple times or for comma separated values)
INCLUDEINTERFACEFilter by service interface ID (can be a regexp and can be used multiple times or for comma separated values). OpenStack interfaces are 'public', 'internal', 'admin'
EXCLUDEINTERFACEExclude by service interface (can be a regexp and can be used multiple times or for comma separated values). OpenStack interfaces are 'public', 'internal', 'admin'
  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_openstack_restapi.pl \
	--plugin=cloud/openstack/restapi/plugin.pm \
	--mode=volume \
	--identity-url='http://change\_me:5000' \
	--timeout='10' \
	--username='username' \
	--password='password' \
	--user-domain-id='default' \
	--project-name='demo' \
	--project-domain-id='default' \
	--authent-by-env='0' \
	--authent-by-file='' \
	--disco-mode='' \
	--filter-project-id='' \
	--include-endpoint-interface='' \
	--exclude-endpoint-interface=''  \
	--include-name='' \
	--exclude-name='' \
	--include-status='' \
	--exclude-status='' \
	--include-description='' \
	--exclude-description='' \
	--include-bootable='' \
	--exclude-bootable='' \
	--include-encrypted='' \
	--exclude-encrypted='' \
	--include-zone='' \
	--exclude-zone='' \
	--include-id='' \
	--exclude-id='' \
	--include-type='' \
	--exclude-type='' \
	--warning-count='' \
	--critical-count='' \
	--warning-status='%\{status\} =~ /(restoring-backup|backing-up|deleting)/' \
	--critical-status='%\{status\} =~ /error/' \
	--warning-id='' \
	--critical-id='' \
	--warning-type='' \
	--critical-type='' \
	--warning-description='' \
	--critical-description='' \
	--warning-size='' \
	--critical-size='' \
	--warning-project-id='$_SERVICEWARNINGPROJECT_ID$' \
	--critical-project-id='$_SERVICECRITICALPROJECT_ID$' \
	--warning-bootable='' \
	--critical-bootable='' \
	--warning-encrypted='' \
	--critical-encrypted='' \
	--warning-zone='' \
	--critical-zone='' \
	--warning-attachments='' \
	--critical-attachments=''

La commande devrait retourner un message de sortie similaire à :

OK: Volume count: 35574 All volumes are ok | 'volume.count'=35574;;;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_openstack_restapi.pl \
	--plugin=cloud/openstack/restapi/plugin.pm \
	--list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
discovery [code]Utilisé pour la découverte d'hôtes
hypervisor [code]Cloud-Openstack-RestAPI-Project-Hypervisor-custom
instance [code]Cloud-Openstack-RestAPI-Project-Instance-custom
list-services [code]Utilisé pour la découverte de services
loadbalancer [code]Cloud-Openstack-RestAPI-Project-LoadBalancer-custom
network [code]Cloud-Openstack-RestAPI-Project-Network-custom
port [code]Cloud-Openstack-RestAPI-Project-Port-custom
project-discovery [code]Non utilisé dans ce connecteur de supervision
service [code]Cloud-Openstack-RestAPI-Service-Cinder-custom
Cloud-Openstack-RestAPI-Service-Glance-custom
Cloud-Openstack-RestAPI-Service-Horizon-custom
Cloud-Openstack-RestAPI-Service-Keystone-custom
Cloud-Openstack-RestAPI-Service-Neutron-custom
Cloud-Openstack-RestAPI-Service-Nova-custom
Cloud-Openstack-RestAPI-Service-Octavia-custom
Cloud-Openstack-RestAPI-Service-Generic-custom
volume [code]Cloud-Openstack-RestAPI-Project-Volume-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.
--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: onvert 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()' =back
--change-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: onvert 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()' =back
--extend-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: onvert 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()' =back
--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: um 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(traffic_(in|out)_$1)' =back
--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'. <output>.
--filter-countersOnly display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx|yyyy$'
--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).
--insecureAllow insecure TLS connection (default: '0'). This value will only be used for other services if a more specific one is not already defined with other options.
--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').
--usernameOpenStack username.
--passwordOpenStack password.
--user-domain-idOpenStack user domain to use with authentication (default: 'default').
--project-nameOpenStack project name to use with authentication (default: 'demo').
--project-domain-idOpenStack project domain id to use with authentication (default: 'default').
--timeoutSet HTTP timeout in seconds (default: '10'). This timeout will only be used for other services if a more specific one is not already defined with other options.
--authent-by-envSet to 1 to use OpenStack environment variables if they are defined (default: 0). Used environment variables are OS_USERNAME, OS_PASSWORD, OS_PROJECT_DOMAIN, OS_USER_DOMAIN, OS_PROJECT_NAME, OS_AUTH_URL.
--authent-by-fileRead OpenStack environment variables from a file. Handled environment variables are OS_USERNAME, OS_PASSWORD, OS_PROJECT_DOMAIN, OS_USER_DOMAIN, OS_PROJECT_NAME, OS_AUTH_URL. Those variables must be defined using 'export VARIABLE="value"' syntax.
--hostnameSet default OpenStack service hostname. This hostname will only be used for other services if a more specific one is not already defined with other options.
--protoSet default protocol to use (default: 'https'). This protocol will only be used for other services if a more specific one is not already defined with other options.
--disco-modeSpecifies how OpenStack service endpoints are discovered. Can be 'auto' (default), 'manual' or 'keystone'. With 'auto' mode services endpoints are retrieved from Keystone catalog except if a specific URL is provided with other options. With 'keystone' mode services endpoints are only retrieved from Keystone catalog. With 'manual' mode services endpoints are retrieved from command line options.
--identity-urlSet the URL to use for the OpenStack Keystone (identity) service. A valid Keystone URL is required since it is the authentication service. The first part of the Keystone URL is also used to define the cache filename. Example: --identity-url="https://myopenstack.local:5000" This URL can also be construct with options (--identity-hostname, --identity-proto, --identity-port, --identity-endpoint).
--identity-hostnameSet the hostname part of the Keystone service URL.
--identity-protoSet the protocol to use in the Keystone service URL (default: 'https').
--identity-portSet the port to use in the Keystone service URL (default: 5000).
--identity-endpointSet the endpoint to use in the Keystone service URL (default: '/v3').
--identity-insecureAllow insecure TLS connection (default: '0'). When set to 0 the default insecure value passed with --insecure is used.
--identity-timeoutSet HTTP timeout in seconds (default: '0'). When set to 0 the default timeout value passed with --timeout is used.
--compute-urlSet the URL to use for the OpenStack Nova (compute) service. A valid Nova URL is required since it is a mandatory service. Nova URL is retrieved from Keystone catalog unless disco-mode is set to 'manual' or a specific URL is provided with this option. Example: --compute-url="https://myopenstack.local:8774" This URL can also be construct with options (--compute-hostname, --compute-proto, --compute-port, --compute-endpoint).
--compute-hostnameSet the hostname part of the Nova service URL.
--compute-protoSet the protocol to use in the Nova service URL (default: 'https').
--compute-portSet the port to use in the Nova service URL (default: 8774).
--compute-endpointSet the endpoint to use in the Nova service URL (default: '/v2.1').
--compute-insecureAllow insecure TLS connection (default: '0'). When set to 0 the default insecure value passed with --insecure is used.
--compute-timeoutSet HTTP timeout in seconds (default: '0'). When set to 0 the default timeout value passed with --timeout is used.
--image-urlSet the URL to use for the OpenStack Glance (image) service. A valid Glance URL is required since it is a mandatory service. Glance URL is retrieved from Keystone catalog unless disco-mode is set to 'manual' or a specific URL is provided with this option. Example: --image-url="https://myopenstack.local:9292" This URL can also be construct with options (--image-hostname, --image-proto, --image-port, --image-endpoint).
--image-hostnameSet the hostname part of the Glance service URL.
--image-protoSet the protocol to use in the Glance service URL (default: 'https').
--image-portSet the port to use in the Glance service URL (default: 9292).
--image-endpointSet the endpoint to use in the Glance service URL (default: '/v2').
--image-insecureAllow insecure TLS connection (default: '0'). When set to 0 the default insecure value passed with --insecure is used.
--volume-urlSet the URL to use for the OpenStack Cinder (volume) service. A valid Cinder URL is required since it is a mandatory service. Cinder URL is retrieved from Keystone catalog unless disco-mode is set to 'manual' or a specific URL is provided with this option. Example: --volume-url="https://myopenstack.local:8776" This URL can also be construct with options (--volume-hostname, --volume-proto, --volume-port, --volume-endpoint).
--volume-hostnameSet the hostname part of the Cinder service URL.
--volume-protoSet the protocol to use in the Cinder service URL (default: 'https').
--volume-portSet the port to use in the Cinder service URL (default: 8776).
--volume-endpointSet the endpoint to use in the Cinder service URL.
--volume-insecureAllow insecure TLS connection (default: '0'). When set to 0 the default insecure value passed with --insecure is used.
--volume-timeoutSet HTTP timeout in seconds (default: '0'). When set to 0 the default timeout value passed with --timeout is used.
--network-urlSet the URL to use for the OpenStack Neutron (network) service. A valid Neutron URL is required since it is a mandatory service. Neutron URL is retrieved from Keystone catalog unless disco-mode is set to 'manual' or a specific URL is provided with this option. Example: --network-url="https://myopenstack.local:9696" This URL can also be construct with options (--network-hostname, --network-proto, --network-port, --network-endpoint).
--network-hostnameSet the hostname part of the Neutron service URL.
--network-protoSet the protocol to use in the Neutron service URL (default: 'https').
--network-portSet the port to use in the Neutron service URL (default: 9696).
--network-endpointSet the endpoint to use in the Neutron service URL.
--network-insecureAllow insecure TLS connection (default: '0'). When set to 0 the default insecure value passed with --insecure is used.
--network-timeoutSet HTTP timeout in seconds (default: '0'). When set to 0 the default timeout value passed with --timeout is used.
--loadbalancer-urlSet the URL to use for the OpenStack Octavia (loadbalancer) service. Octavia URL is retrieved from Keystone catalog unless disco-mode is set to 'manual' or a specific URL is provided with this option. Example: --loadbalancer-url="https://myopenstack.local:9876" This URL can also be construct with options (--loadbalancer-hostname, --loadbalancer-proto, --loadbalancer-port, --loadbalancer-endpoint).
--loadbalancer-hostnameSet the hostname part of the Ovtabia service URL.
--loadbalancer-protoSet the protocol to use in the Octavia service URL (default: 'https').
--loadbalancer-portSet the port to use in the Octavia service URL (default: 9876).
--loadbalancer-endpointSet the endpoint to use in the Octavia service URL.
--loadbalancer-insecureAllow insecure TLS connection (default: '0'). When set to 0 the default insecure value passed with --insecure is used.
--loadbalancer-timeoutSet HTTP timeout in seconds (default: '0'). When set to 0 the default timeout value passed with --timeout is used.

Options des modes​

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

OptionDescription
--filter-countersOnly display some counters (regexp can be used). Example: --filter-counters='^count$'
--service-urlDefine the endpoint URL to check (can be multiple). When using this option the service type and name are set to service and N/A if not already defined with --include-type and --include-name options. When this option is not set the endpoints to test are taken from the cached Keystone service list previously generated with 'discovery' and 'list-services' commands and filtered by --include-* and --exclude-* options below.
--include-service-typeFilter by service type (can be a regexp and can be used multiple times or for comma separated values).
--exclude-service-typeExclude by service type (can be a regexp and can be used multiple times or for comma separated values).
--include-service-nameFilter by service name (can be a regexp and can be used multiple times or for comma separated values).
--exclude-service-nameExclude by service name (can be a regexp and can be used multiple times or for comma separated values).
--include-service-idFilter by service id (can be a regexp and can be used multiple times or for comma separated values).
--exclude-service-idExclude by service id (can be a regexp and can be used multiple times or for comma separated values).
--include-endpoint-regionFilter by service region (can be a regexp and can be used multiple times or for comma separated values).
--exclude-endpoint-regionExclude by service region (can be a regexp and can be used multiple times or for comma separated values).
--include-endpoint-region-idFilter by service region ID (can be a regexp and can be used multiple times or for comma separated values).
--exclude-endpoint-region-idExclude by service region ID (can be a regexp and can be used multiple times or for comma separated values).
--include-endpoint-interfaceFilter by service interface ID (can be a regexp and can be used multiple times or for comma separated values). OpenStack interfaces are 'public', 'internal', 'admin'.
--exclude-endpoint-interfaceExclude by service interface (can be a regexp and can be used multiple times or for comma separated values). OpenStack interfaces are 'public', 'internal', 'admin'.
--expected-dataData that endpoint should return when it is normally working (default value: auto). When auto is set the connector automatically defines the value depending on the type of endpoint. When a non empty value is set it represents a value that must be present in the returned data. If this option is not set the check only verifies that the data is a valid JSON. The result of this check 1/0 is saved in %{valid_content} variable.
--endpoint-suffixAppend a specific suffix to he endpoint URL URL for the heath check (default value: auto). When auto is set the connector automatically defines the suffix depending on the type of endpoint. When none is set no suffix is appended.

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_openstack_restapi.pl \
	--plugin=cloud/openstack/restapi/plugin.pm \
	--mode=volume \
	--help