Skip to main content

Tosca Rest API

Pack assets​

Templates​

The Monitoring Connector Tosca Rest API brings a host template:

  • App-Tosca-Restapi-custom

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

By default, no services are created automatically using this template.

Collected metrics & status​

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

Metric nameUnit
entries.passed.countcount
entries.failed.countcount
entries.not_executed.countcount
entries.unknown.countcount

Prerequisites​

To monitor this type of resource, a user with read privileges on the Tosca Commander REST Webservice API is required.

Installing the monitoring connector​

Pack​

  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 > Monitoring Connector Manager 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-applications-tosca-restapi
  1. Whatever the license type (online or offline), install the Tosca Rest API connector through the Configuration > Monitoring Connector Manager 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-Applications-Tosca-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 the Name, Alias & IP Address/DNS fields according to your ressource's settings.
  3. Apply the App-Tosca-Restapi-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
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. 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
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). All options are listed here
  1. Deploy the configuration. The service appears in the list of services, and on 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 server using a command like this one (replace the sample values by yours):

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

The expected command output is shown below:

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;

Troubleshooting​

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

Available modes​

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

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

The plugin brings the following modes:

ModeLinked service template
execution-list-statusApp-Tosca-Restapi-Execution-List-Status
scenario-statusApp-Tosca-Restapi-Scenario-Status

Available options​

Generic options​

All generic options are listed here:

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=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Eg: adding --change-short-output='OK~Up~gi' 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

Modes options​

All modes specific options are listed here:

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

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

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