Skip to main content

Aruba Clearpass

Plugin: go.d.plugin Module: snmp

Overview

Monitor Aruba Clearpass (clearpass) with Netdata over SNMP. Netdata recognizes the device automatically by its sysObjectID (recognized across 1 device identifiers) and collects the metrics this profile declares — on top of the generic SNMP baseline — with no manual OID configuration.

Netdata's SNMP collector matches the device to the aruba-clearpass.yaml profile via sysObjectID/sysDescr, then polls the OIDs it declares.

This integration is supported on all platforms.

This integration supports multiple instances configured side-by-side.

Default Behavior

Auto-Detection

Auto-detected as Aruba Clearpass via sysObjectID/sysDescr.

Limits

The default configuration for this integration does not impose any limits.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

You can configure the snmp collector in two ways:

MethodBest forHow to
UIFast setup without editing filesGo to Nodes → Configure this node → Collectors → Jobs, search for snmp, then click + to add a job.
FileIf you prefer configuring via file, or need to automate deployments (e.g., with Ansible)Edit go.d/snmp.conf and add a job.
important

UI configuration requires paid Netdata Cloud plan.

Prerequisites

SNMP access

SNMP must be enabled on the device and reachable from the Netdata Agent acting as the site's SNMP hub.

Configuration

Options

Configure the SNMP collector with the device hostname and SNMP credentials. See the SNMP collector reference for all options.

via UI

Configure the snmp collector from the Netdata web interface:

  1. Go to Nodes.
  2. Select the node where you want the snmp data-collection job to run and click the (Configure this node). That node will run the data collection.
  3. The Collectors → Jobs view opens by default.
  4. In the Search box, type snmp (or scroll the list) to locate the snmp collector.
  5. Click the + next to the snmp collector to add a new job.
  6. Fill in the job fields, then click Test to verify the configuration and Submit to save.
    • Test runs the job with the provided settings and shows whether data can be collected.
    • If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.

via File

The configuration file name for this integration is go.d/snmp.conf.

The file format is YAML. Generally, the structure is:

update_every: 1
autodetection_retry: 0
jobs:
- name: some_name1
- name: some_name2

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/snmp.conf
Examples

There are no configuration examples.

Alerts

There are no alerts configured by default for this integration.

Metrics

On top of the generic SNMP baseline (the Generic SNMP Device integration — interfaces, system, IP/TCP/UDP, host resources), this Aruba Clearpass profile adds the metrics below. Each is collected only where the device exposes the matching OID — inclusion means the profile requests it; availability depends on the device model and software.

78 metrics in 11 groups; each row is a chart context usable in alerts.

GroupMetrics
Network / Interface4
Network / RADIUS9
Network / Routing10
Network / TACACS11
Network / Traffic1
Security / Policy23
System / CPU1
System / Disk2
System / Memory4
System / Uptime1
Uncategorized12

Network / Interface

Metric (chart context)UnitScopeDescription
snmp.device_prof_ifAdminStatus{status}per interface, interfaceCurrent administrative state of the interface
snmp.device_prof_ifHighSpeedbit/sper interface, interfaceEstimate of the interface's current bandwidth
snmp.device_prof_ifNumber{interface}deviceNumber of network interfaces regardless of their current state present on this system
snmp.device_prof_ifOperStatus{status}per interface, interfaceCurrent operational state of the interface

Network / RADIUS

Metric (chart context)UnitScopeDescription
snmp.device_prof_radAuthCounterCount{authentication}/sper rad_auth_source_nameTotal number of RADIUS authentications
snmp.device_prof_radAuthCounterFailure{authentication}/sper rad_auth_source_nameTotal number of failed RADIUS authentications
snmp.device_prof_radAuthCounterSuccess{authentication}/sper rad_auth_source_nameTotal number of successful RADIUS authentications
snmp.device_prof_radAuthCounterTimemsper rad_auth_source_nameTime taken to authenticate against an authentication source in milliseconds
snmp.device_prof_radAuthRequestTimemsper cppm_system_hostnameTotal time taken for RADIUS request end-to-end in milliseconds
snmp.device_prof_radPolicyEvalTimemsper cppm_system_hostnameTotal time taken for policy evaluation from RADIUS server perspective in milliseconds
snmp.device_prof_radServerCounterCount{request}/sper cppm_system_hostnameTotal RADIUS request count
snmp.device_prof_radServerCounterFailure{request}/sper cppm_system_hostnameFailed RADIUS request count
snmp.device_prof_radServerCounterSuccess{request}/sper cppm_system_hostnameSuccessful RADIUS request count

Network / Routing

Metric (chart context)UnitScopeDescription
snmp.device_prof_ospfIfLsaCount{advertisement}/sper ospf_ip_addr, neighbor_idThe total number of link-local link state advertisements in this interface's link-local link state database
snmp.device_prof_ospfIfState{status}per ospf_ip_addr, neighbor_idThe OSPF Interface State
snmp.device_prof_ospfNbrEvents{event}/sper neighbor_id, neighbor_ipThe number of times this neighbor relationship has changed state or an error has occurred
snmp.device_prof_ospfNbrLsRetransQLen{message}per neighbor_id, neighbor_ipThe current length of the retransmission queue
snmp.device_prof_ospfNbrState{status}per neighbor_id, neighbor_ipThe state of the relationship with this neighbor
snmp.device_prof_ospfVirtIfLsaCount{advertisement}/sper neighbor_idThe total number of link-local link state advertisements in this virtual interface's link-local link state database
snmp.device_prof_ospfVirtIfState{status}per neighbor_idOSPF virtual interface states
snmp.device_prof_ospfVirtNbrEvents{change}/sper neighbor_id, neighbor_ipThe number of times this virtual link has changed its state or an error has occurred
snmp.device_prof_ospfVirtNbrLsRetransQLen{message}per neighbor_id, neighbor_ipThe current length of the retransmission queue
snmp.device_prof_ospfVirtNbrState{status}per neighbor_id, neighbor_ipThe state of the virtual neighbor relationship

Network / TACACS

Metric (chart context)UnitScopeDescription
snmp.device_prof_tacAuthCounterAuthTimemsper cppm_system_hostnameTime taken for TACACS+ authentications in milliseconds
snmp.device_prof_tacAuthCounterCount{authentication}/sper cppm_system_hostnameTotal number of TACACS+ authentications
snmp.device_prof_tacAuthCounterFailure{authentication}/sper cppm_system_hostnameTotal number of failed TACACS+ authentications
snmp.device_prof_tacAuthCounterSuccess{authentication}/sper cppm_system_hostnameTotal number of successful TACACS+ authentications
snmp.device_prof_tacAuthCounterTimemsper cppm_system_hostnameTotal time taken to perform TACACS+ authentications end-to-end in milliseconds
snmp.device_prof_tacAutzCounterCount{authorization}/sper cppm_system_hostnameTotal number of TACACS+ authorizations
snmp.device_prof_tacAutzCounterFailure{authorization}/sper cppm_system_hostnameTotal number of failed TACACS+ authorizations
snmp.device_prof_tacAutzCounterSuccess{authorization}/sper cppm_system_hostnameTotal number of successful TACACS+ authorizations
snmp.device_prof_tacAutzCounterTimemsper cppm_system_hostnameTotal time taken to perform TACACS+ authorization end-to-end in milliseconds
snmp.device_prof_tacPolicyEvalTimemsper cppm_system_hostnameTime taken for TACACS+ policy evaluation in milliseconds
snmp.device_prof_tacServicePolicyEvalTimemsper cppm_system_hostnameTime taken for TACACS+ service policy evaluation in milliseconds

Network / Traffic

Metric (chart context)UnitScopeDescription
snmp.device_prof_nwTrafficTotalBy/sper nw_app_name, nw_app_port_numberTotal network traffic in bytes

Security / Policy

Metric (chart context)UnitScopeDescription
snmp.device_prof_dailyFailedAuthCount{authentication}/sper cppm_system_hostnameTotal number of failed authentications computed over 24 hours
snmp.device_prof_dailySuccessAuthCount{authentication}/sper cppm_system_hostnameTotal number of successful authentications computed over 24 hours
snmp.device_prof_dailyTotalAuthCount{authentication}/sper cppm_system_hostnameTotal number of authentications computed over 24 hours
snmp.device_prof_psAuditPolicyEvalCount{policy}/sper cppm_system_hostnameTotal number of audit policies evaluated
snmp.device_prof_psAuditPolicyEvalTimemsper cppm_system_hostnameTime taken for the evaluation of audit policies in milliseconds
snmp.device_prof_psAuthCounterFailure{authentication}/sper cppm_system_hostnameTotal number of failed authentications computed on the Policy Server
snmp.device_prof_psAuthCounterSuccess{authentication}/sper cppm_system_hostnameTotal number of successful authentications computed on the Policy Server
snmp.device_prof_psAuthCounterTotal{authentication}/sper cppm_system_hostnameTotal number of authentications computed on the Policy Server
snmp.device_prof_psAutzCounterCount{authorization}/sper ps_autz_source_nameTotal number of Policy authorizations
snmp.device_prof_psAutzCounterFailure{authorization}/sper ps_autz_source_nameTotal number of failed Policy authorizations
snmp.device_prof_psAutzCounterSuccess{authorization}/sper ps_autz_source_nameTotal number of successful Policy authorizations
snmp.device_prof_psAutzCounterTimemsper ps_autz_source_nameTime taken for Policy authorizations in milliseconds
snmp.device_prof_psEnforcementPolicyEvalCount{policy}/sper cppm_system_hostnameTotal number of enforcement policies evaluated
snmp.device_prof_psEnforcementPolicyEvalTimemsper cppm_system_hostnameTime taken for the evaluation of enforcement policies in milliseconds
snmp.device_prof_psPosturePolicyEvalCount{policy}/sper cppm_system_hostnameTotal number of posture policies evaluated
snmp.device_prof_psPosturePolicyEvalTimemsper cppm_system_hostnameTime taken for the evaluation of posture policies in milliseconds
snmp.device_prof_psRestrictionPolicyEvalCount{policy}/sper cppm_system_hostnameTotal number of restriction policies evaluated
snmp.device_prof_psRestrictionPolicyEvalTimemsper cppm_system_hostnameTime taken for the evaluation of restriction policies in milliseconds
snmp.device_prof_psRolemappingPolicyEvalCount{policy}/sper cppm_system_hostnameTotal number of role mapping policies evaluated
snmp.device_prof_psRolemappingPolicyEvalTimemsper cppm_system_hostnameTime taken for the evaluation of role mapping policies in milliseconds
snmp.device_prof_psServicePolicyEvalCount{policy}/sper cppm_system_hostnameTotal number of service policies evaluated
snmp.device_prof_psServicePolicyEvalTimemsper cppm_system_hostnameTime taken for the evaluation of service policies in milliseconds
snmp.device_prof_psSessionlogTimemsper cppm_system_hostnameTime taken for session logging in milliseconds

System / CPU

Metric (chart context)UnitScopeDescription
snmp.device_prof_cpu_usage%deviceThe current CPU utilization

System / Disk

Metric (chart context)UnitScopeDescription
snmp.device_prof_cppmSystemDiskSpaceFreeByper cppm_system_hostnameAmount of free disk space in bytes in the ClearPass server
snmp.device_prof_cppmSystemDiskSpaceTotalByper cppm_system_hostnameTotal amount of disk space available in bytes in the ClearPass server

System / Memory

Metric (chart context)UnitScopeDescription
snmp.device_prof_cppmSystemMemoryFreeByper cppm_system_hostnameAmount of free memory in bytes in the ClearPass server
snmp.device_prof_cppmSystemMemoryTotalByper cppm_system_hostnameTotal amount of memory available in bytes in the ClearPass server
snmp.device_prof_memAvailRealBydeviceAmount of real physical memory currently unused or available
snmp.device_prof_memTotalRealBydeviceTotal amount of real physical memory installed on this host

System / Uptime

Metric (chart context)UnitScopeDescription
snmp.device_prof_systemUptimesdeviceTime since the system was last rebooted or powered on.

Uncategorized

Metric (chart context)UnitScopeDescription
snmp.device_prof_lldpStatsRemTablesAgeoutsdevice
snmp.device_prof_lldpStatsRemTablesDeletesdevice
snmp.device_prof_lldpStatsRemTablesDropsdevice
snmp.device_prof_lldpStatsRemTablesInsertsdevice
snmp.device_prof_lldpStatsRemTablesLastChangeTimedevice
snmp.device_prof_lldpStatsRxPortAgeoutsTotalper lldp_loc_port_num
snmp.device_prof_lldpStatsRxPortFramesDiscardedTotalper lldp_loc_port_num
snmp.device_prof_lldpStatsRxPortFramesErrorsper lldp_loc_port_num
snmp.device_prof_lldpStatsRxPortFramesTotalper lldp_loc_port_num
snmp.device_prof_lldpStatsRxPortTLVsDiscardedTotalper lldp_loc_port_num
snmp.device_prof_lldpStatsRxPortTLVsUnrecognizedTotalper lldp_loc_port_num
snmp.device_prof_lldpStatsTxPortFramesTotalper lldp_loc_port_num

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.