SNMP-exporter

Installation

Installation On RedHat and CentOS

1. Download SNMP-exporter

• Download snmp-exporter (linux package) from: Release 0.27.0 / 2025-01-03 · prometheus/snmp_exporter, e.g.: https://github.com/prometheus/snmp_exporter/releases/download/v0.27.0/snmp_exporter-0.27.0.linux-amd64.tar.gz

1. Extract downloaded file and change permission

• Now go to snmp-exporter downloaded location and extract it: tar -xvzf snmp_exporter-0.26.0.linux-amd64.tar.gz

• Change to the Extracted directory: cd snmp_exporter-0.26.0.linux-amd64

• Copy files to their location.

cp ./snmp_exporter /usr/local/bin/snmp_exporter
cp ./snmp.yml /usr/local/bin/snmp.yml

• Change the ownership to Prometheus user for the copied files.

chown prometheus:prometheus /usr/local/bin/snmp_exporter
chown prometheus:prometheus /usr/local/bin/snmp.yml

1. Configure snmp-exporter Systemd service

• Create a systemd service file for snmp-exporter to run as System Startup.

vi /etc/systemd/system/snmp-exporter.service

Add the following content to the file:

[Unit]
Description=Prometheus SNMP Exporter Service
After=network.target
[Service]
Type=simple
User=prometheus
ExecStart=/usr/local/bin/snmp_exporter --config.file="/usr/local/bin/snmp.yml"
[Install]
WantedBy=multi-user.target

• Restart the daemon services to load the snmp-exporter service: systemctl daemon-reload

• Start and enable the snmp-exporter service to automatically run after reboot: systemctl enable --now snmp-exporter.service

• To check if the snmp-exporter service is running, run the following command: systemctl status snmp-exporter.service

SNMP Generator

Run from docker

DOCKER_IMAGE_NAME ?= snmp-generator
DOCKER_IMAGE_TAG  ?= $(subst /,-,$(REPO_TAG))
DOCKER_REPO       ?= prom

SANITIZED_DOCKER_IMAGE_TAG := $(subst +,-,$(DOCKER_IMAGE_TAG))

SELINUX_ENABLED := $(shell cat /sys/fs/selinux/enforce 2> /dev/null || echo 0)

ifeq ($(SELINUX_ENABLED),1)
  DOCKER_VOL_OPTS ?= :z
endif

docker run -v "${PWD}:/opt$(DOCKER_VOL_OPTS)" "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):$(SANITIZED_DOCKER_IMAGE_TAG)" generate

• or: docker run -v "${PWD}:/opt" "prom/snmp-generator:main" generate: run to read generator.yaml and generate snmp.yml file

• copy snmp.yml to its location in snmp-exporter server, default is /usr/local/bin/snmp.yml, then restart snmp-exporter and prometheus services

Configure generator.yml

---
auths:
  public_v1:
    community: public
    security_level: noAuthNoPriv
    auth_protocol: MD5
    priv_protocol: DES
    version: 1
  public_v2:
    community: public
    security_level: noAuthNoPriv
    auth_protocol: MD5
    priv_protocol: DES
    version: 2
  cisco_v3:
    version: 3
    username: user
    password: AuthPassword
    auth_protocol: SHA
    priv_protocol: AES
    security_level: authPriv
    priv_password: PrivPassword

modules:
  # Default IF-MIB interfaces table with ifIndex.
  cisco_iosxe:
    walk: #[sysUpTime, interfaces, ifXTable]
      - 1.3.6.1.2.1.1.3                
      - 1.3.6.1.2.1.1.3                
      - 1.3.6.1.2.1.1.1                
      - 1.3.6.1.2.1.1.5
      - 1.3.6.1.2.1.1.6.0
      - 1.3.6.1.2.1.2.2.1.1           
      - 1.3.6.1.2.1.2.2.1.14           
      - 1.3.6.1.2.1.2.2.1.20           
      - 1.3.6.1.2.1.31.1.1.1.6         
      - 1.3.6.1.2.1.31.1.1.1.10         
      - 1.3.6.1.2.1.2.2.1.8            
      - 1.3.6.1.2.1.2.2.1.7            
      - 1.3.6.1.2.1.2.2.1.9            
      - 1.3.6.1.2.1.2.2.1.6            
      - 1.3.6.1.4.1.9.9.48.1.1.1.5     
      - 1.3.6.1.2.1.15.3.1             
      - 1.3.6.1.4.1.9.9.109.1.1.1.1    
      - 1.3.6.1.4.1.9.9.715.1.1.6.1.14 
      - 1.3.6.1.4.1.9.9.48.1.1.1.6
      - 1.3.6.1.4.1.9.9.48.1.1.1.5     
      - 1.3.6.1.2.1.47.1.1.1.1.13      
      - 1.3.6.1.4.1.9.9.91.1.1.1.1
      - 1.3.6.1.2.1.4.22.1.2           
      - 1.3.6.1.2.1.4.20.1             

    lookups:
      - source_indexes: [ifIndex]
        lookup: ifAlias
      - source_indexes: [ifIndex]
        # Uis OID to avoid conflict with PaloAlto PAN-COMMON-MIB.
        lookup: 1.3.6.1.2.1.2.2.1.2 # ifDescr
      - source_indexes: [ifIndex]
        # Use OID to avoid conflict with Netscaler NS-ROOT-MIB.
        lookup: 1.3.6.1.2.1.31.1.1.1.1 # ifName
    overrides:
      ifAlias:
        ignore: true # Lookup metric
      ifDescr:
        ignore: true # Lookup metric
      ifName:
        ignore: true # Lookup metric
      ifType:
        type: EnumAsInfo

SNMP OID on Cisco IOS-XE

1.3.6.1.2.1.1.3                             # sysUpTime
1.3.6.1.2.1.1.3                             # sysLocation
1.3.6.1.2.1.1.1                             # sysDescr
1.3.6.1.2.1.1.5                             # sysName
1.3.6.1.2.1.1.6.0                           # sysLocation
1.3.6.1.2.1.2.2.1.14                        # ifInError
1.3.6.1.2.1.2.2.1.20                        # ifOutErrors
1.3.6.1.2.1..2.1.10                         # ifInOctets
1.3.6.1.2.1.31.1.1.1.6                      # ifHCInOctets
1.3.6.1.2.1.2.2.1.16                        # ifOutOctets
1.3.6.1.2.1.31.1.1.1.10                     # ifHCOutOctets
1.3.6.1.2.1.2.2.1.8                         # ifOperStatus
1.3.6.1.2.1.2.2.1.7                         # ifAdminStatus
1.3.6.1.2.1.2.2.1.9                         # ifLastChange
1.3.6.1.2.1.2.2.1.6                         # ifPhysAddress
1.3.6.1.2.1.2.2.1.1                         # ifIndex
1.3.6.1.4.1.9.9.48.1.1.1.5                  # ifMtu
1.3.6.1.2.1.15.3.1                          # BGP Neighbor
1.3.6.1.4.1.9.9.109.1.1.1.1                 # CPU Usage
1.3.6.1.4.1.9.9.715.1.1.6.1.14              # ceqfpUtilProcessingLoad
1.3.6.1.4.1.9.9.48.1.1.1.6                  # ciscoMemoryPoolFree
1.3.6.1.4.1.9.9.48.1.1.1.5                  # ciscoMemoryPoolUsed
1.3.6.1.2.1.47.1.1.1.1.13                   # entPhysicalModelName
1.3.6.1.4.1.9.9.91.1.1.1.1.5                # entSensorStatus 
1.3.6.1.4.1.9.9.91.1.1.1.1.4                # entSensorValue
1.3.6.1.2.1.4.22.1.2                        # ipNetToMediaPhysAddress (Arp table)
1.3.6.1.2.1.4.20.1                          # ipAdEntAddr and other info (show ip int brief)

Verification

• curl "http://localhost:9116/snmp?target=10.10.10.10.10&auth=cisco_v3&module=cisco_iosxe"

Reference

• Install SNMP Exporter

• Prometheus SNMP Exporter: Network Monitoring Tutorial!