SNMP Device
SNMP Device connects Banalytics to one SNMP v2c or SNMPv3 endpoint for identification, scalar reads, subtree walks, controlled writes, polling and network tracking.
Start read-only and add security deliberately
Create the device manually or from Network Device Discovery. Confirm the host, UDP port and SNMP version, then add the community or SNMPv3 credentials. Use Secret Manager references instead of repeating credential values in component configuration.
Test reachability
Use Test connection to read system uptime and see latency or a classified timeout, authentication, authorization, malformed-response or transport error.
Identify the endpoint
Use Identify to read system name, description, object identifier and uptime before configuring production polling.
Read before writing
Browse individual OIDs or walk a bounded subtree. Keep writes disabled until the required OIDs and device-side controls are understood.
Configuration parameters
| Parameter | Required | Description | Default |
|---|---|---|---|
MAC | Managed | MAC address maintained by network tracking when available. | Empty |
Title | Yes | Display name for the endpoint. | None |
Host | Yes | Device hostname or IP address. | None |
Port | Yes | SNMP request port. | 161 |
Version | Yes | V2C or V3. | V2C |
Community | V2c | SNMP v2c community. Supports ${secret:alias}. | public |
Username | V3 | SNMPv3 security name. Supports a Secret Manager reference. | None |
Security level | V3 | NO_AUTH_NO_PRIV, AUTH_NO_PRIV or AUTH_PRIV. | AUTH_PRIV |
Auth protocol / password | Conditional | MD5 or SHA-family authentication and its password. The password supports Secret Manager references. | SHA1 |
Privacy protocol / password | Conditional | DES, 3DES or AES privacy and its password. The password supports Secret Manager references. | AES128 |
Context name | Optional | Optional SNMPv3 context. | Empty |
Timeout | Yes | Request timeout from 100 to 60000 milliseconds. | 2000 ms |
Retries | Yes | Retry count after timeout, from 0 to 10. | 1 |
Write enabled | Yes | Enables SET only for OIDs allowed below. | Disabled |
Write allowlist | Conditional | Comma- or newline-separated OID prefixes allowed for SET. Empty means deny all even when writes are enabled. | Empty |
Read, walk and control explicitly
readTestConnection
Returns success, version, latency and uptime, or a classified failure.
readIdentify
Reads standard system identity OIDs.
readOids
Reads one or more scalar OIDs.
readWalkDevice
Walks a subtree with a bounded row count.
updateOid
Applies one typed value, reads it back and emits an audit event.
SET supports integer, string, gauge, counter, timeticks, IP address and OID values. A write outside the allowlist is rejected before it reaches the device.
Apply least privilege
Use separate device accounts or communities where the endpoint supports them. Treat read access as sensitive because system descriptions, interface names and topology data can reveal infrastructure details. Review every SnmpValueSetEvent and protect update permissions.