Skip to main content

Keysight NVOS Rest API

Pack assets​

Templates​

The Monitoring Connector Keysight NVOS Rest API brings a host template:

  • Net-Keysight-Nvos-Restapi-custom

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

Service AliasService TemplateService Description
HardwareNet-Keysight-Nvos-Hardware-RestapiCheck hardware
TimeNet-Keysight-Nvos-Time-RestapiCheck time offset
UptimeNet-Keysight-Nvos-Uptime-RestapiTime since the equipment has been working and available

The services listed above are created automatically when the Net-Keysight-Nvos-Restapi host template is used.

Discovery rules​

Service discovery​

Rule NameDescription
Net-Keysight-Nvos-Restapi-Dynamic-Filter-NameDiscover dynamic filters and monitor utilization
Net-Keysight-Nvos-Restapi-Port-NameDiscover ports and monitor status and utilization

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 linked to each service.

Metric nameUnit
df~dynamic_filter.traffic.pass.bytespersecondB/s
df~dynamic_filter.traffic.insp.bytespersecondB/s
df~dynamic_filter.packets.denied.countcount
df~dynamic_filter.packets.pass.countcount
df~dynamic_filter.packets.insp.countcount

Prerequisites​

To monitor, a user with read privileges on the Control-M Automation 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 Connectors 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-network-keysight-nvos-restapi
  1. Whatever the license type (online or offline), install the Keysight NVOS Rest API connector through the Configuration > Monitoring Connectors 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-Network-Keysight-Nvos-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 settings.
  3. Apply the Net-Keysight-Nvos-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
KEYSIGHTNVOSAPIPASSWORDAPI password
KEYSIGHTNVOSAPIPORTPort used8000
KEYSIGHTNVOSAPIPROTOSpecify https if neededhttps
KEYSIGHTNVOSAPIUSERNAMEAPI username
KEYSIGHTNVOSAPIEXTRAOPTIONSAny extra option you may want to add to every command (E.g. a --verbose flag). All options are listed here
  1. Deploy the configuration. The host appears in the list of hosts, and on page Resources Status. 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
FILTERNAMEFilter dynamic filters by name (can be a regexp)
WARNINGPACKETSDENIED
CRITICALPACKETSDENIED
WARNINGPACKETSINSPThresholds
CRITICALPACKETSINSPThresholds
WARNINGPACKETSPASSThresholds
CRITICALPACKETSPASSThresholds
WARNINGTRAFFICINSP
CRITICALTRAFFICINSP
WARNINGTRAFFICPASS
CRITICALTRAFFICPASS
EXTRAOPTIONSAny extra option you may want to add to the command (E.g. a --verbose flag). All options are listed here--verbose
  1. Deploy the configuration. The service appears in the list of service, and on page Resources Status. 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_keysight_nvos_restapi.pl \
--plugin=network::keysight::nvos::restapi::plugin \
--mode=dynamic-filters \
--hostname='10.0.0.1' \
--proto='https' \
--port='8000' \
--api-username='' \
--api-password='' \
--filter-name='' \
--warning-packets-denied='' \
--critical-packets-denied='' \
--warning-packets-pass='' \
--critical-packets-pass='' \
--warning-packets-insp='' \
--critical-packets-insp='' \
--warning-traffic-pass='' \
--critical-traffic-pass='' \
--warning-traffic-insp='' \
--critical-traffic-insp='' \
--verbose\

The expected command output is shown below:

OK:      | 'dynamic_filter.traffic.pass.bytespersecond'=31B/s;;;0; 'dynamic_filter.traffic.insp.bytespersecond'=2B/s;;;0; 'dynamic_filter.packets.denied.count'=90;;;0; 'dynamic_filter.packets.pass.count'=3;;;0; 'dynamic_filter.packets.insp.count'=21;;;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_keysight_nvos_restapi.pl \
--plugin=network::keysight::nvos::restapi::plugin \
--list-mode

The plugin brings the following modes:

ModeLinked service template
dynamic-filtersNet-Keysight-Nvos-Dynamic-Filters-Restapi
hardwareNet-Keysight-Nvos-Hardware-Restapi
list-dynamic-filtersUsed for service discovery
list-portsUsed for service discovery
portsNet-Keysight-Nvos-Ports-Restapi
timeNet-Keysight-Nvos-Time-Restapi
uptimeNet-Keysight-Nvos-Uptime-Restapi

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
--versionDisplay the plugin's version.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: Change storage free perfdata in used: --change-perfdata=free,used,invert() Change storage free perfdata in used: --change-perfdata=used,free,invert() Scale traffic values automaticaly: --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-groupExtend perfdata from multiple perfdatas (methods in target are: min, max, average, sum) Syntax: --extend-perfdata-group=searchlabel,newlabel,target[,[newuom],[m in],[max]] 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 from the beginning of the output. Eg: 'OK: Ram Total:...' will become 'Ram Total:...'Output
--output-xmlDisplay output in XML format.Output
--output-jsonDisplay output in JSON format.Output
--output-openmetricsDisplay metrics in OpenMetrics format.Output
--output-fileWrite output in file (can be used with json and xml options)Output
--disco-formatDisplay discovery arguments (if the mode manages it).Output
--disco-showDisplay discovery values (if the mode manages it).Output
--float-precisionSet the float precision for thresholds (default: 8).Output
--source-encodingSet encoding of monitoring sources (in some cases. Default: 'UTF-8'). Keysight NVOS APIOutput
--hostnameSet hostname.Api
--portPort used (Default: 8000)Api
--protoSpecify https if needed (Default: 'https')Api
--api-usernameAPI username.Api
--api-passwordAPI password.Api
--timeoutSet timeout in seconds (Default: 50).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 URLHttp global
--proxypacProxy pac file (can be a URL or local file)Http global
--insecureInsecure SSL connections.Http global
--http-backendSet the backend used (Default: 'lwp') For curl: --http-backend=curlHttp 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
--memcachedMemcached server to use (only one server).Retention
--redis-serverRedis server to use (only one server). Syntax: address[:port]Retention
--redis-attributeSet Redis Options (--redis-attribute="cnx_timeout=5").Retention
--redis-dbSet Redis database index.Retention
--failback-fileFailback on a local file if redis connection failed.Retention
--memexpirationTime to keep data in seconds (Default: 86400).Retention
--statefile-dirDirectory for statefile (Default: '/var/lib/centreon/centplugins').Retention
--statefile-suffixAdd a suffix for the statefile name (Default: '').Retention
--statefile-concat-cwdConcat current working directory with option '--statefile-dir'. Useful on Windows when plugin is compiled.Retention
--statefile-formatFormat used to store cache (can be: 'dumper', 'storable', 'json').Retention
--statefile-keyKey to encrypt/decrypt cache.Retention
--statefile-cipherCipher to encrypt cache (Default: 'AES').Retention
--filter-nameFilter dynamic filters by name (can be a regexp).Mode
--warning- --critical-Thresholds. Can be: 'traffic-out-prct', 'traffic-out', 'packets-out', 'packets-dropped', 'packets-pass', 'packets-insp'.Mode

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

/usr/lib/centreon/plugins//centreon_keysight_nvos_restapi.pl \
--plugin=network::keysight::nvos::restapi::plugin \
--mode=dynamic-filters \
--help