Skip to main content

​
Description

The snmp_check probe polls OID values from SNMP-enabled devices. Supports SNMPv2c (community string) and SNMPv3 (username + auth/privacy). Credentials are resolved via secret references — never logged. Build tag vms_heavy.

​
Config fields

FieldTypeRequiredDefaultDescription
typestringYes—Must be "snmp_check"
hoststringYes—SNMP target host/IP
portintNo161SNMP port
versionstringYes—"v2c" or "v3"
communitySecretRefstringNo"public" (v2c)Secret ref for community string
usernameSecretRefstringv3: Yes—Secret ref for SNMPv3 username
authProtocolstringNo—Auth protocol: md5, sha, sha224, sha256, sha384, sha512
authPasswordSecretRefstringWhen authProtocol set—Secret ref for auth passphrase
privacyProtocolstringNo—Privacy protocol: des, aes, aes192, aes256
privPasswordSecretRefstringWhen privacyProtocol set—Secret ref for privacy passphrase
oidsstring[]Yes—OIDs to GET. At least one required

​
Metrics

MetricTypeLabelsDescription
vms.snmp.statusstatus—up or down
vms.snmp.valuegaugeoidNumeric OID value. Non-numeric OIDs skipped

​
Example config

{
  "type": "snmp_check",
  "host": "10.0.0.20",
  "port": 161,
  "version": "v2c",
  "communitySecretRef": "SNMP_COMMUNITY_CORE",
  "oids": ["1.3.6.1.2.1.1.3.0"]
}

​
Notes

  • Secret refs resolve via environment variables at construction. Unset ref → probe is skipped.
  • Only numeric values are emitted as metrics. Non-numeric OID values are skipped.
  • Build tag vms_heavy — not in default agent package.