New: the AI firewall watches every module and explains each incident in plain words. See how it works

SNMP templates reference

Every key of the four built-in SNMP templates – MIB-II with IF-MIB, HOST-RESOURCES-MIB, UPS-MIB (RFC 1628) and Printer-MIB – with OIDs and units.

Hermetry ships four SNMP templates for standard MIBs. Each is a complete SNMP mapping for a device profile with the SNMP transport: the OIDs to read, the keys they are stored as, units, scales and enumerations. All OIDs are numeric, so no MIB file is needed.

Using a template

A template is a platform profile. A copy of it in your workspace is your own profile: you can edit it, and a newer template version never changes your copy. There is no button that copies a template into your workspace yet; ask Hermetry support for a copy, or enter the rows below yourself on your profile’s SNMP tab (see Polling devices over SNMP).

A copied profile shows “Copied from the platform template …. Editing makes it this profile’s own mapping; a newer template version never changes it.”

TemplateForPoll interval
SNMP — MIB-II system + IF-MIB interfacesSwitches, routers and other network gear60 s
SNMP — HOST-RESOURCES-MIBServers and appliances60 s
SNMP — UPS-MIB (RFC 1628)UPSs with a standard network card60 s
SNMP — Printer-MIB (RFC 3805)Network printers300 s

System group (all four templates)

KeyOIDStored asNotes
sys.descr1.3.6.1.2.1.1.1.0Attribute
sys.object_id1.3.6.1.2.1.1.2.0Attribute
sys.contact1.3.6.1.2.1.1.4.0Attribute
sys.name1.3.6.1.2.1.1.5.0Attribute
sys.location1.3.6.1.2.1.1.6.0Attribute
uptime1.3.6.1.2.1.1.3.0TelemetryTimeTicks, seconds; “Agent uptime”

MIB-II system + IF-MIB interfaces

Per interface, named by ifName: status, traffic in and out in bit/s from the 64-bit counters, and input errors.

KeyOIDNotes
if.count1.3.6.1.2.1.2.1.0Number of interfaces
if.oper.<ifName>1.3.6.1.2.1.2.2.1.8Enumeration: up, down, testing, unknown, dormant, notPresent, lowerLayerDown
if.in_bps.<ifName>1.3.6.1.2.1.31.1.1.1.6Rate × 8, bit/s
if.out_bps.<ifName>1.3.6.1.2.1.31.1.1.1.10Rate × 8, bit/s
if.in_errors.<ifName>1.3.6.1.2.1.2.2.1.14Rate, 1/s

The interface table reads at most 48 rows. Rates need two polls: the first poll after a start stores no rate.

HOST-RESOURCES-MIB

KeyOIDNotes
host.uptime1.3.6.1.2.1.25.1.1.0Seconds; “Host uptime”
host.users1.3.6.1.2.1.25.1.5.0“Users”
host.processes1.3.6.1.2.1.25.1.6.0“Processes”
host.memory_kb1.3.6.1.2.1.25.2.2.0Attribute, KiB
storage.unit_bytes.<descr>1.3.6.1.2.1.25.2.3.1.4Allocation unit, bytes
storage.size.<descr>1.3.6.1.2.1.25.2.3.1.5In allocation units
storage.used.<descr>1.3.6.1.2.1.25.2.3.1.6In allocation units
cpu.load.<index>1.3.6.1.2.1.25.3.3.1.2%, per processor

Storage rows are named by the volume’s description (hrStorageDescr), at most 24 rows. Processor rows are named by their index, at most 64. Size and used are in allocation units: multiply by storage.unit_bytes for bytes, for example in a derived value.

UPS-MIB (RFC 1628)

Identity (all attributes): ups.manufacturer, ups.model, ups.software_version, ups.agent_version, ups.name (OIDs 1.3.6.1.2.1.33.1.1.1.0 to .1.5.0).

KeyOID (1.3.6.1.2.1.33.1. …)Notes
battery.status2.1.0unknown, normal, low, depleted
battery.seconds_on_battery2.2.0s
battery.minutes_remaining2.3.0min
battery.charge2.4.0%
battery.voltage2.5.0× 0.1, V
battery.current2.6.0× 0.1, A
battery.temperature2.7.0°C
input.line_bads3.1.0Counter: input out of tolerance
output.source4.1.0other, none, normal, bypass, battery, booster, reducer
output.frequency4.2.0× 0.1, Hz
bypass.frequency5.1.0× 0.1, Hz
alarms.present6.1.0Number of active UPS alarms
test.result7.3.0donePass, doneWarning, doneError, aborted, inProgress, noTestsInitiated

Per line (rows named by index, at most 3 each):

KeysUnits
input.frequency.<n>, input.voltage.<n>, input.current.<n>, input.power.<n>Hz (× 0.1), V, A (× 0.1), W
output.voltage.<n>, output.current.<n>, output.power.<n>, output.load.<n>V, A (× 0.1), W, %
bypass.voltage.<n>, bypass.current.<n>, bypass.power.<n>V, A (× 0.1), W

Rated values (attributes): rated.input_voltage, rated.input_frequency, rated.output_voltage, rated.output_frequency, rated.output_va, rated.output_power, rated.low_battery_minutes, rated.low_transfer_voltage, rated.high_transfer_voltage.

Useful alarm conditions: output.source == "battery" (on battery), battery.status == "low", alarms.present > 0, test.result == "doneError". See Alarm rules on device profiles.

Printer-MIB (RFC 3805)

KeyOIDNotes
printer.description1.3.6.1.2.1.25.3.2.1.3.1Attribute
printer.status1.3.6.1.2.1.25.3.5.1.1.1other, unknown, idle, printing, warmup
printer.device_status1.3.6.1.2.1.25.3.2.1.5.1unknown, running, warning, testing, down
printer.pages1.3.6.1.2.1.43.10.2.1.4.1.1Lifetime page count
supply.capacity.<descr>1.3.6.1.2.1.43.11.1.1.8.1Per supply
supply.level.<descr>1.3.6.1.2.1.43.11.1.1.9.1Per supply

Supplies (toner, drum, waste) are named by their description, at most 16 rows. Divide level by capacity for a percentage; some printers report negative values for “unknown” or “some remaining”.

Key names in tables

When rows are named by a column’s value, the value is made safe for a key name: every run of characters other than letters, digits, _ and - becomes one _, leading and trailing _ are removed, and the name is cut at 48 characters. So eth0 stays eth0, and GigabitEthernet0/1 becomes GigabitEthernet0_1. Run a test poll to see the exact keys before you build alarm rules or dashboards on them.