Skip to main content

Cambium CnPilot SNMP

Pack assets​

Templates​

The Monitoring Connector Cambium cnPilot SNMP brings a host template:

  • Net-Cambium-cnPilot-SNMP

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

Service AliasService TemplateService Description
Connection statusNet-Cambium-Cnpilot-Connection-status-SNMPCheck connection status
CpuNet-Cambium-Cnpilot-Cpu-SNMPCheck CPU hardware
MemoryNet-Cambium-Cnpilot-Memory-SNMPCheck memory hardware

The services listed above are created automatically when the Net-Cambium-cnPilot-SNMP host template is used.

Discovery rules​

Service discovery​

Rule nameDescription
Net-Cambium-Cnpilot-SNMP-Interfaces-NameDiscover network interfaces and monitor bandwidth utilization
Net-Cambium-Cnpilot-SNMP-Radios-NameDiscover radios

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
connection#connection-statusN/A

Prerequisites​

SNMP Configuration​

To use this pack, the SNMP service must be properly configured on your ressource. Please refer to the official documentation from XXX:\

Network flow​

The target server must be reachable from the Centreon poller on the UDP/161 SNMP port.

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-network-cambium-cnpilot-snmp
  1. Whatever the license type (online or offline), install the Cambium cnPilot SNMP 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-Network-Cambium-cnPilot-Snmp

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-Cambium-cnPilot-SNMP-custom template to the host.

When using SNMP v3, use the SNMPEXTRAOPTIONS macro to add specific authentication parameters. More information in the Troubleshooting SNMP section.

MacroDescriptionDefault valueMandatory
SNMPEXTRAOPTIONSAny 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
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 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_cambium_cnpilot.pl \
	--plugin=network::cambium::cnpilot::snmp::plugin \
	--mode=interfaces \
	--hostname='10.0.0.1' \
	--snmp-version='2c' \
	--snmp-community='my-snmp-community'  \
	--interface='' \
	--name \
	--add-status \
	--add-traffic \
	--add-errors \
	--warning-status='' \
	--critical-status='%\{admstatus\} eq "up" and %\{opstatus\} !~ /up|dormant/' \
	--warning-in-traffic='' \
	--critical-in-traffic='' \
	--warning-out-traffic='' \
	--critical-out-traffic='' \
	--warning-in-discard='' \
	--critical-in-discard='' \
	--warning-out-discard='' \
	--critical-out-discard='' \
	--warning-in-error='' \
	--critical-in-error='' \
	--warning-out-error='' \
	--critical-out-error='' \
	--oid-filter='ifname' \
	--oid-display='ifname' \

The expected command output is shown below:

OK: Traffic In : 321.02b/s (-) Traffic Out : 382.02b/s (-) | 'interface.traffic.in.bitspersecond'=59b/s;;;0; 'interface.traffic.out.bitspersecond'=18b/s;;;0;

Troubleshooting​

Please find the troubleshooting documentation for Centreon Plugins typical issues.

Available modes​

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

/usr/lib/centreon/plugins//centreon_cambium_cnpilot.pl \
	--plugin=network::cambium::cnpilot::snmp::plugin \
    --list-mode

The plugin brings the following modes:

ModeLinked service template
connection-statusNet-Cambium-Cnpilot-Connection-status-SNMP
cpuNet-Cambium-Cnpilot-Cpu-SNMP
interfacesNet-Cambium-Cnpilot-Interfaces-SNMP
list-interfacesUsed for service discovery
list-radiosUsed for service discovery
memoryNet-Cambium-Cnpilot-Memory-SNMP
radiosNet-Cambium-Cnpilot-Radios-SNMP

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
--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=patternreplacementmodifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Eg: adding --change-short-output='OKUpgi' 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').Output
--hostnameHostname to query (required).SNMP
--snmp-communityRead community (defaults to public).SNMP
--snmp-versionVersion: 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3.SNMP
--snmp-portPort (default: 161).SNMP
--snmp-timeoutTimeout in secondes (default: 1) before retries.SNMP
--snmp-retriesSet the number of retries (default: 5) before failure.SNMP
--maxrepetitionsMax repetitions value (default: 50) (only for SNMP v2 and v3).SNMP
--subsetleefHow many oid values per SNMP request (default: 50) (for get_leef method. Be cautious when you set it. Prefer to let the default value).SNMP
--snmp-autoreduceAuto reduce SNMP request size in case of SNMP errors (By default, the divisor is 2).SNMP
--snmp-force-getnextUse snmp getnext function (even in snmp v2c and v3).SNMP
--snmp-usernameSecurity name (only for SNMP v3).SNMP
--authpassphraseAuthentication protocol pass phrase.SNMP
--authprotocolAuthentication protocol: MD5|SHA. Since net-snmp 5.9.1: SHA224|SHA256|SHA384|SHA512.SNMP
--privpassphrasePrivacy protocol pass phraseSNMP
--privprotocolPrivacy protocol: DES|AES. Since net-snmp 5.9.1: AES192|AES192C|AES256|AES256C.SNMP
--contextnameContext nameSNMP
--contextengineidContext engine IDSNMP
--securityengineidSecurity engine IDSNMP
--snmp-errors-exitExit code for SNMP Errors (default: unknown)SNMP
--snmp-tls-transportTLS Transport communication used (can be: 'dtlsudp', 'tlstcp').SNMP
--snmp-tls-our-identityOur X.509 identity to use, which should either be a fingerprint or the filename that holds the certificate.SNMP
--snmp-tls-their-identityThe remote server's identity to connect to, specified as either a fingerprint or a file name. Either this must be specified, or the hostname below along with a trust anchor.SNMP
--snmp-tls-their-hostnameThe remote server's hostname that is expected. If their certificate was signed by a CA then their hostname presented in the certificate must match this value or the connection fails to be established (to avoid man-in-the-middle attacks).SNMP
--snmp-tls-trust-certA trusted certificate to use as trust anchor (like a CA certificate) for verifying a remote server's certificate. If a CA certificate is used to validate a certificate then the TheirHostname parameter must also be specified to ensure their presented hostname in the certificate matches.SNMP

Modes options​

All modes specific options are listed here:

OptionDescriptionType
--filter-apFilter on one or several AP.Mode
--warning-connection-statusSet warning threshold for status. Can used special variables like: %{status}, %{name}Mode
--critical-connection-statusSet critical threshold for status. Can used special variables like: %{status}, %{name}Mode

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

/usr/lib/centreon/plugins//centreon_cambium_cnpilot.pl \
	--plugin=network::cambium::cnpilot::snmp::plugin \
	--mode=interfaces \
    --help