Skip to main content

OpenStack RESTAPI

Connector dependencies​

The following monitoring connectors will be installed when you install the OpenStack RESTAPI connector through the Configuration > Connectors > Monitoring Connectors menu:

Pack assets​

Templates​

The Monitoring Connector OpenStack RESTAPI brings 2 host templates:

  • Cloud-Openstack-RestAPI-Project-custom
  • Cloud-Openstack-RestAPI-Services-custom

The connector brings the following service templates (sorted by the host template they are attached to):

Service AliasService TemplateService DescriptionDiscovery
HypervisorCloud-Openstack-RestAPI-Project-Hypervisor-customCheck an Openstack hypervisorX
InstanceCloud-Openstack-RestAPI-Project-Instance-customCheck an Openstack VMX
NetworkCloud-Openstack-RestAPI-Project-Network-customCheck an Openstack networkX
PortCloud-Openstack-RestAPI-Project-Port-customCheck an Openstack portX
VolumeCloud-Openstack-RestAPI-Project-Volume-customCheck an Openstack volumeX

The services listed above are created automatically when the Cloud-Openstack-RestAPI-Project-custom host template is used.

If Discovery is checked, it means a service discovery rule exists for this service template.

Discovery rules​

Host discovery​

Rule nameDescription
OpenStack HostDiscover hosts by requesting OpenStack using REST API
OpenStack ProjectDiscover OpenStack projects using REST API
OpenStack ServicesDiscover OpenStack services using REST API

More information about discovering hosts automatically is available on the dedicated page.

Service discovery​

Rule nameDescription
Cloud-Openstack-RestAPI-Project-HypervisorDiscover and monitor the hypervisors of a project
Cloud-Openstack-RestAPI-Project-InstanceDiscover and monitor the instances of a project
Cloud-Openstack-RestAPI-Project-LoadbalancerDiscover and monitor the load balancers of a project
Cloud-Openstack-RestAPI-Project-NetworkDiscover and monitor the networks of a project
Cloud-Openstack-RestAPI-Project-PortDiscover and monitor the ports of a project
Cloud-Openstack-RestAPI-Project-VolumeDiscover and monitor the volumes of a project
Cloud-Openstack-RestAPI-ServiceDiscover services and monitor their system usage

More information about discovering services automatically is available on the dedicated page and in the following chapter.

Collected metrics & status​

Here is the list of services for this connector, detailing all metrics and statuses linked to each service.

NameUnit
countN/A
statusN/A

Prerequisites​

This connector allows you to monitor the operation of the various OpenStack services using REST API.

Please refer to the OpenStack documentation for more information on how to set up access to the OpenStack REST API.

Installing the monitoring connector​

Pack​

The installation procedures for monitoring connectors are slightly different depending on whether your license is offline or online.

  1. If the platform uses an online license, you can skip the package installation instruction below as it is not required to have the connector displayed within the Configuration > Connectors > Monitoring Connectors menu. If the platform uses an offline license, install the package on the central server with the command corresponding to the operating system's package manager:
dnf install centreon-pack-cloud-openstack-restapi
  1. Whatever the license type (online or offline), install the OpenStack RESTAPI connector through the Configuration > Connectors > Monitoring Connectors menu.

Plugin​

Since Centreon 22.04, you can benefit from the 'Automatic plugin installation' feature. When this feature is enabled, you can skip the installation part below.

You still have to manually install the plugin on the poller(s) when:

  • Automatic plugin installation is turned off
  • You want to run a discovery job from a poller that doesn't monitor any resource of this kind yet

More information in the Installing the plugin section.

Use the commands below according to your operating system's package manager:

dnf install centreon-plugin-Cloud-OpenStack-Restapi

Using the monitoring connector​

Using a host template provided by the connector​

  1. Log into Centreon and add a new host through Configuration > Hosts.
  2. Fill in the Name, Alias & IP Address/DNS fields according to your resource's settings.
  3. Apply the Cloud-Openstack-RestAPI-Project-custom template to the host. A list of macros appears. Macros allow you to define how the connector will connect to the resource, and to customize the connector's behavior.
  4. Fill in the macros you want. Some macros are mandatory.
MacroDescriptionDefault valueMandatory
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. Deploy the configuration. The host appears in the list of hosts, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the host: it shows the values of the macros.

Using a service template provided by the connector​

  1. If you have used a host template and checked Create Services linked to the Template too, the services linked to the template have been created automatically, using the corresponding service templates. Otherwise, create manually the services you want and apply a service template to them.
  2. Fill in the macros you want (e.g. to change the thresholds for the alerts). Some macros are mandatory (see the table below).
MacroDescriptionDefault valueMandatory
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. Deploy the configuration. The service appears in the list of services, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the service: it shows the values of the macros.

How to check in the CLI that the configuration is OK and what are the main options for?​

Once the plugin is installed, log into your Centreon poller's CLI using the centreon-engine user account (su - centreon-engine). Test that the connector is able to monitor a resource using a command like this one (replace the sample values by yours):

/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=''

The expected command output is shown below:

OK: Volume count: 35574 All volumes are ok | 'volume.count'=35574;;;0;

Troubleshooting​

Please find the troubleshooting documentation for the API-based plugins in this chapter.

Available modes​

In most cases, a mode corresponds to a service template. The mode appears in the execution command for the connector. In the Centreon interface, you don't need to specify a mode explicitly: its use is implied when you apply a service template. However, you will need to specify the correct mode for the template if you want to test the execution command for the connector in your terminal.

All available modes can be displayed by adding the --list-mode parameter to the command:

/usr/lib/centreon/plugins/centreon_openstack_restapi.pl \
	--plugin=cloud/openstack/restapi/plugin.pm \
	--list-mode

The plugin brings the following modes:

ModeLinked service template
discovery [code]Used for host discovery
hypervisor [code]Cloud-Openstack-RestAPI-Project-Hypervisor-custom
instance [code]Cloud-Openstack-RestAPI-Project-Instance-custom
list-services [code]Used for service discovery
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]Not used in this Monitoring Connector
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

Available options​

Generic options​

All generic options are listed here:

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.

Modes options​

All available options for each service template are listed below:

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.

All available options for a given mode can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins/centreon_openstack_restapi.pl \
	--plugin=cloud/openstack/restapi/plugin.pm \
	--mode=volume \
	--help