Versa Director Rest API
Connector dependencies​
The following monitoring connectors will be installed when you install the Versa Director Restapi connector through the Configuration > Monitoring Connector Manager menu:
Pack assets​
Templates​
The Monitoring Connector Versa Director Restapi brings a host template:
- Net-Versa-Director-Device-Restapi-custom
The connector brings the following service templates (sorted by the host template they are attached to):
- Net-Versa-Director-Device-Restapi-custom
- Not attached to a host template
Service Alias | Service Template | Service Description |
---|---|---|
Devices | Net-Versa-Director-Devices-Restapi-custom | Check device system statistics |
The services listed above are created automatically when the Net-Versa-Director-Device-Restapi-custom host template is used.
Service Alias | Service Template | Service Description | Discovery |
---|---|---|---|
Paths | Net-Versa-Director-Paths-Restapi-custom | Check paths | X |
The services listed above are not created automatically when a host template is applied. To use them, create a service manually, then apply the service template you want.
If Discovery is checked, it means a service discovery rule exists for this service template.
Discovery rules​
Host discovery​
Rule name | Description |
---|---|
Versa Networks devices (Director RestAPI) | Discover Versa Networks devices using Director Rest API |
More information about discovering hosts automatically is available on the dedicated page.
Service discovery​
Rule name | Description |
---|---|
Net-Versa-Director-Restapi-Path-LocalWanLink | Discover the paths and monitor their status |
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.
- Devices
- Paths
Name | Unit |
---|---|
devices.total.count | count |
status | N/A |
devices~memory.usage.bytes | B |
devices~memory.free.bytes | B |
devices~memory.usage.percentage | % |
devices~disk.usage.bytes | B |
devices~disk.free.bytes | B |
devices~disk.usage.percentage | % |
devices~alarms.critical.count | count |
devices~alarms.major.count | count |
devices~alarms.minor.count | count |
devices~alarms.warning.count | count |
devices~alarms.indeterminate.count | count |
devices~paths.up.count | count |
devices~paths.down.count | count |
devices~policy.violation.packets.dropped.novalidlink.count | count |
devices~policy.violation.packets.dropped.slaaction.count | count |
Name | Unit |
---|---|
paths.up.count | count |
paths.down.count | count |
grp1~paths.up.count | count |
grp1~paths.down.count | count |
grp1~grp21#paths.up.count | count |
grp1~grp22#paths.up.count | count |
grp1~grp21#paths.down.count | count |
grp1~grp22#paths.down.count | count |
Prerequisites​
Device Configuration​
The API must be enabled and running on the Versa Director device. Please refer to the manufacturer documentation to achieve this.
Network flows​
The Centreon Poller must be able to reach the TCP/9182 HTTPS port of the Versa Director device.
Installing the monitoring connector​
Pack​
- 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:
- Alma / RHEL / Oracle Linux 8
- Alma / RHEL / Oracle Linux 9
- Debian 11 & 12
- CentOS 7
dnf install centreon-pack-network-versa-director-restapi
dnf install centreon-pack-network-versa-director-restapi
apt install centreon-pack-network-versa-director-restapi
yum install centreon-pack-network-versa-director-restapi
- Whatever the license type (online or offline), install the Versa Director Restapi 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:
- Alma / RHEL / Oracle Linux 8
- Alma / RHEL / Oracle Linux 9
- Debian 11 & 12
- CentOS 7
dnf install centreon-plugin-Network-Versa-Director-Restapi
dnf install centreon-plugin-Network-Versa-Director-Restapi
apt install centreon-plugin-network-versa-director-restapi
yum install centreon-plugin-Network-Versa-Director-Restapi
Using the monitoring connector​
Using a host template provided by the connector​
- Log into Centreon and add a new host through Configuration > Hosts.
- Fill in the Name, Alias & IP Address/DNS fields according to your resource's settings.
- Apply the Net-Versa-Director-Device-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.
- Fill in the macros you want. Some macros are mandatory.
Macro | Description | Default value | Mandatory |
---|---|---|---|
DIRECTORAPIHOSTNAME | Director hostname | X | |
DIRECTORAPIUSERNAME | Versa Director API username | X | |
DIRECTORAPIPASSWORD | Versa Director API password | X | |
DIRECTORAPIPROTO | Specify https if needed | https | |
DIRECTORAPIPORT | Port used | 9182 | |
DIRECTORDEVICENAME | Filter device by name (can be a regexp) | ||
DIRECTORDEVICETYPE | Filter device by type (can be a regexp) | ||
DIRECTORORGANIZATION | Check device under an organization name | .* | |
DIRECTORORGNAME | Filter organizations by name (can be a regexp) | ||
PROXYURL | Proxy URL. Example: http://my.proxy:3128 | ||
DIRECTORAPIEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed here. |
- 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​
- 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.
- Fill in the macros you want (e.g. to change the thresholds for the alerts). Some macros are mandatory (see the table below).
- Devices
- Paths
Macro | Description | Default value | Mandatory |
---|---|---|---|
WARNINGALARMSCRITICAL | Threshold | ||
CRITICALALARMSCRITICAL | Threshold | ||
WARNINGALARMSWARNING | Threshold | ||
CRITICALALARMSWARNING | Threshold | ||
WARNINGALARMSINDETERMINATE | Threshold | ||
CRITICALALARMSINDETERMINATE | Threshold | ||
WARNINGALARMSMAJOR | Threshold | ||
CRITICALALARMSMAJOR | Threshold | ||
WARNINGALARMSMINOR | Threshold | ||
CRITICALALARMSMINOR | Threshold | ||
WARNINGBGPHEALTHDISABLED | Threshold | ||
CRITICALBGPHEALTHDISABLED | Threshold | ||
WARNINGBGPHEALTHDOWN | Threshold | ||
CRITICALBGPHEALTHDOWN | Threshold | ||
WARNINGBGPHEALTHUP | Threshold | ||
CRITICALBGPHEALTHUP | Threshold | ||
WARNINGCONFIGHEALTHDISABLED | Threshold | ||
CRITICALCONFIGHEALTHDISABLED | Threshold | ||
WARNINGCONFIGHEALTHDOWN | Threshold | ||
CRITICALCONFIGHEALTHDOWN | Threshold | ||
WARNINGCONFIGHEALTHUP | Threshold | ||
CRITICALCONFIGHEALTHUP | Threshold | ||
WARNINGDISKUSAGE | Threshold | ||
CRITICALDISKUSAGE | Threshold | ||
WARNINGDISKUSAGEFREE | Threshold | ||
CRITICALDISKUSAGEFREE | Threshold | ||
WARNINGDISKUSAGEPRCT | Threshold | ||
CRITICALDISKUSAGEPRCT | Threshold | ||
WARNINGIKEHEALTHDISABLED | Threshold | ||
CRITICALIKEHEALTHDISABLED | Threshold | ||
WARNINGIKEHEALTHDOWN | Threshold | ||
CRITICALIKEHEALTHDOWN | Threshold | ||
WARNINGIKEHEALTHUP | Threshold | ||
CRITICALIKEHEALTHUP | Threshold | ||
WARNINGINTERFACEHEALTHDISABLED | Threshold | ||
CRITICALINTERFACEHEALTHDISABLED | Threshold | ||
WARNINGINTERFACEHEALTHDOWN | Threshold | ||
CRITICALINTERFACEHEALTHDOWN | Threshold | ||
WARNINGINTERFACEHEALTHUP | Threshold | ||
CRITICALINTERFACEHEALTHUP | Threshold | ||
WARNINGMEMORYUSAGE | Threshold | ||
CRITICALMEMORYUSAGE | Threshold | ||
WARNINGMEMORYUSAGEFREE | Threshold | ||
CRITICALMEMORYUSAGEFREE | Threshold | ||
WARNINGMEMORYUSAGEPRCT | Threshold | ||
CRITICALMEMORYUSAGEPRCT | Threshold | ||
WARNINGPACKETSDROPPEDNOVALIDLINK | Threshold | ||
CRITICALPACKETSDROPPEDNOVALIDLINK | Threshold | ||
WARNINGPACKETSDROPPEDSLAACTION | Threshold | ||
CRITICALPACKETSDROPPEDSLAACTION | Threshold | ||
WARNINGPATHHEALTHDISABLED | Threshold | ||
CRITICALPATHHEALTHDISABLED | Threshold | ||
WARNINGPATHHEALTHDOWN | Threshold | ||
CRITICALPATHHEALTHDOWN | Threshold | ||
WARNINGPATHHEALTHUP | Threshold | ||
CRITICALPATHHEALTHUP | Threshold | ||
WARNINGPATHSDOWN | Threshold | ||
CRITICALPATHSDOWN | Threshold | ||
WARNINGPATHSUP | Threshold | ||
CRITICALPATHSUP | Threshold | ||
WARNINGPORTHEALTHDISABLED | Threshold | ||
CRITICALPORTHEALTHDISABLED | Threshold | ||
WARNINGPORTHEALTHDOWN | Threshold | ||
CRITICALPORTHEALTHDOWN | Threshold | ||
WARNINGPORTHEALTHUP | Threshold | ||
CRITICALPORTHEALTHUP | Threshold | ||
WARNINGREACHABILITYHEALTHDISABLED | Threshold | ||
CRITICALREACHABILITYHEALTHDISABLED | Threshold | ||
WARNINGREACHABILITYHEALTHDOWN | Threshold | ||
CRITICALREACHABILITYHEALTHDOWN | Threshold | ||
WARNINGREACHABILITYHEALTHUP | Threshold | ||
CRITICALREACHABILITYHEALTHUP | Threshold | ||
WARNINGSERVICEHEALTHDISABLED | Threshold | ||
CRITICALSERVICEHEALTHDISABLED | Threshold | ||
WARNINGSERVICEHEALTHDOWN | Threshold | ||
CRITICALSERVICEHEALTHDOWN | Threshold | ||
WARNINGSERVICEHEALTHUP | Threshold | ||
CRITICALSERVICEHEALTHUP | Threshold | ||
CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %{ping_status/}, %{services_status/}, %{sync_status/}, %{controller_status/}, %{path_status/}, %{display/} | %{ping_status/} ne "reachable" or %{services_status/} ne "good" | |
WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %{ping_status/}, %{service_sstatus/}, %{sync_status/}, %{controller_status/}, %{path_status/}, %{display/} | ||
WARNINGTOTAL | Threshold | ||
CRITICALTOTAL | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. | --verbose |
Macro | Description | Default value | Mandatory |
---|---|---|---|
GROUP | Choose dimensions to group paths up/down. | remoteSiteName | |
FILTERLOCALWANLINK | Filter paths by localWanLink (can be a regexp) | ||
FILTERREMOTEWANLINK | Filter paths by remoteWanLink (can be a regexp) | ||
FILTERREMOTESITENAME | Filter paths by remoteSiteName (can be a regexp) | ||
WARNINGGROUPPATHSDOWN | Threshold | ||
CRITICALGROUPPATHSDOWN | Threshold | ||
WARNINGGROUPPATHSUP | Threshold | ||
CRITICALGROUPPATHSUP | Threshold | ||
WARNINGSUBGROUPPATHSDOWN | Threshold | ||
CRITICALSUBGROUPPATHSDOWN | Threshold | ||
WARNINGSUBGROUPPATHSUP | Threshold | ||
CRITICALSUBGROUPPATHSUP | Threshold | ||
WARNINGTOTALPATHSDOWN | Threshold | ||
CRITICALTOTALPATHSDOWN | Threshold | ||
WARNINGTOTALPATHSUP | Threshold | ||
CRITICALTOTALPATHSUP | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. | --verbose |
- 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_versa_director_restapi.pl \
--plugin network::versa::director::restapi::plugin \
--mode=paths \
--hostname='10.0.0.1' \
--port='9182' \
--proto='https' \
--api-username='XXXX' \
--api-password='XXXX' \
--proxyurl='' \
--organization='.*' \
--filter-org-name='' \
--filter-device-name='^$$' \
--filter-device-type='' \
--filter-local-wan-link='' \
--filter-remote-wan-link='' \
--filter-remote-site-name='' \
--group='remoteSiteName' \
--warning-group-paths-up='' \
--critical-group-paths-up='' \
--warning-group-paths-down='' \
--critical-group-paths-down='' \
--warning-subgroup-paths-up='' \
--critical-subgroup-paths-up='' \
--warning-subgroup-paths-down='' \
--critical-subgroup-paths-down='' \
--warning-total-paths-up='' \
--critical-total-paths-up='' \
--warning-total-paths-down='' \
--critical-total-paths-down='' \
--verbose
The expected command output is shown below:
OK: up: 30634 down: 76298 up: 55523 down: 53572 sub-group paths are ok | 'paths.up.count'=30634;;;0; 'paths.down.count'=76298;;;0; 'grp1~paths.up.count'=55523;;;0; 'grp1~paths.down.count'=53572;;;0; 'grp1~grp21#paths.up.count'=47205;;;0; 'grp1~grp22#paths.up.count'=15660;;;0; 'grp1~grp21#paths.down.count'=31301;;;0; 'grp1~grp22#paths.down.count'=93423;;;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_versa_director_restapi.pl \
--plugin network::versa::director::restapi::plugin \
--list-mode
The plugin brings the following modes:
Mode | Linked service template |
---|---|
cache [code] | Not used in this Monitoring Connector |
devices [code] | Net-Versa-Director-Devices-Restapi-custom |
discovery [code] | Used for host discovery |
list-devices [code] | Not used in this Monitoring Connector |
list-paths [code] | Used for service discovery |
paths [code] | Net-Versa-Director-Paths-Restapi-custom |
Available options​
Generic options​
All generic options are listed here:
Option | Description |
---|---|
--mode | Define the mode in which you want the plugin to be executed (see --list-mode). |
--dyn-mode | Specify a mode with the module's path (advanced). |
--list-mode | List all available modes. |
--mode-version | Check minimal version of mode. If not, unknown error. |
--version | Return the version of the plugin. |
--custommode | When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option. |
--list-custommode | List all available custom modes. |
--multiple | Multiple custom mode objects. This may be required by some specific modes (advanced). |
--pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. |
--verbose | Display extended status information (long output). |
--debug | Display debug messages. |
--filter-perfdata | Filter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data. |
--filter-perfdata-adv | Filter 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-max | Create 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-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[max]] Common examples: =over 4 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()' =back |
--change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[max]] Common examples: =over 4 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()' =back |
--extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[max]] Common examples: =over 4 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()' =back |
--extend-perfdata-group | Add 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[,[newuom],[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: =over 4 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(traffic_(in|out)_$1)' =back |
--change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern |
--change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern |
--change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern |
--change-exit | Replace 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. |
--range-perfdata | Rewrite 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-uom | Mask the units when they don't match the given regular expression. |
--opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. |
--output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. |
--output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' |
--output-xml | Return the output in XML format (to send to an XML API). |
--output-json | Return the output in JSON format (to send to a JSON API). |
--output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). |
--output-file | Write 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. |
--disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). |
--disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. |
--float-precision | Define the float precision for thresholds (default: 8). |
--source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. =head1 DESCRIPTION B<output>. =cut |
--filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx|yyyy$' |
--http-peer-addr | Set the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution. |
--proxyurl | Proxy URL. Example: http://my.proxy:3128 |
--proxypac | Proxy pac file (can be a URL or a local file). |
--insecure | Accept insecure SSL connections. |
--http-backend | Perl library to use for HTTP transactions. Possible values are: lwp (default) and curl. |
--memcached | Memcached server to use (only one server). |
--redis-server | Redis server to use (only one server). Syntax: address[:port] |
--redis-attribute | Set Redis Options (--redis-attribute="cnx_timeout=5"). |
--redis-db | Set Redis database index. |
--failback-file | Fall back on a local file if Redis connection fails. |
--memexpiration | Time to keep data in seconds (default: 86400). |
--statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). |
--statefile-suffix | Define a suffix to customize the statefile name (default: ''). |
--statefile-concat-cwd | If 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-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). |
--statefile-key | Define the key to encrypt/decrypt the cache. |
--statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). |
--hostname | Director hostname (required) |
--port | Port used (default: 9182) |
--proto | Specify https if needed (default: 'https') |
--api-username | Versa Director API username. |
--api-password | Versa Director API password. |
--timeout | Set HTTP timeout |
--ignore-unknown-errors | Ignore unknown errors (404 status code). |
--cache-use | Use the cache file (created with cache mode). |
Modes options​
All available options for each service template are listed below:
- Devices
- Paths
Option | Description |
---|---|
--organization | Check device under an organization name. |
--filter-org-name | Filter organizations by name (can be a regexp). |
--filter-device-name | Filter device by name (can be a regexp). |
--filter-device-type | Filter device by type (can be a regexp). |
--add-paths | Add path statuses count. |
--unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %{ping_status/}, %{services_status/}, %{sync_status/}, %{controller_status/}, %{path_status/}, %{display/} |
--warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %{ping_status/}, %{service_sstatus/}, %{sync_status/}, %{controller_status/}, %{path_status/}, %{display/} |
--critical-status | Define the conditions to match for the status to be CRITICAL (default: '%{ping_status/} ne "reachable" or %{services_status/} ne "good"'). You can use the following variables: %{ping_status/}, %{services_status/}, %{sync_status/}, %{controller_status/}, %{path_status/}, %{display/} |
--warning-* --critical-* | Thresholds. Can be: 'total','memory-usage', 'memory-usage-free', 'memory-usage-prct', 'disk-usage', 'disk-usage-free', 'disk-usage-prct', 'alarms-critical', 'alarms-major', 'alarms-minor', 'alarms-warning', 'alarms-indeterminate', 'bgp-health-up' 'bgp-health-down' 'bgp-health-disabled' 'path-health-up' 'path-health-down' 'path-health-disabled' 'service-health-up' 'service-health-down' 'service-health-disabled' 'port-health-up' 'port-health-down' 'port-health-disabled' 'reachability-health-up' 'reachability-health-down' 'reachability-health-disabled' 'interface-health-up' 'interface-health-down' 'interface-health-disabled' 'ike-health-up' 'ike-health-down' 'ike-health-disabled' 'config-health-up' 'config-health-down' 'config-health-disabled' 'packets-dropped-novalidlink', 'packets dropped by sla action', 'paths-up', 'paths-down'. |
Option | Description |
---|---|
--group | Choose dimensions to group paths up/down. Default: --group='remoteSiteName' |
--organization | Check device under an organization name. |
--filter-org-name | Filter organizations by name (can be a regexp). |
--filter-device-name | Filter devices by name (can be a regexp). |
--filter-device-type | Filter devices by type (can be a regexp). |
--filter-local-wan-link | Filter paths by localWanLink (can be a regexp). |
--filter-remote-site-name | Filter paths by remoteSiteName (can be a regexp). |
--filter-remote-wan-link | Filter paths by remoteWanLink (can be a regexp). |
--warning-* --critical-* | Thresholds. Can be: 'total-paths-up', 'total-paths-down', 'group-paths-up', 'group-paths-down', 'subgroup-paths-up', 'subgroup-paths-down'. |
All available options for a given mode can be displayed by adding the
--help
parameter to the command:
/usr/lib/centreon/plugins/centreon_versa_director_restapi.pl \
--plugin network::versa::director::restapi::plugin \
--mode=paths \
--help