Skip to content

Commit 2418e40

Browse files
authored
fix: corrects SNMP discovery sample configuration (#243)
1 parent 0080645 commit 2418e40

File tree

1 file changed

+56
-55
lines changed

1 file changed

+56
-55
lines changed

docs/config_samples.md

Lines changed: 56 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -174,60 +174,61 @@ orb:
174174
agent_name: agent01
175175
snmp_discovery:
176176
policies:
177-
snmp_network_1:
178-
config:
179-
schedule: "0 */6 * * *" # Cron expression - every 6 hours
180-
timeout: 300 # Timeout for policy in seconds (default 2 minutes)
181-
snmp_timeout: 10 # Timeout for SNMP operations in seconds (default 5 seconds)
182-
retries: 3 # Number of retries
183-
defaults:
184-
tags: ["snmp-discovery", "orb"]
185-
site: "datacenter-01"
186-
location: "rack-42"
187-
role: "network"
188-
ip_address:
189-
description: "SNMP discovered IP"
190-
role: "management"
191-
tenant: "network-ops"
192-
vrf: "management"
193-
interface:
194-
description: "Auto-discovered interface"
195-
if_type: "ethernet"
196-
device:
197-
description: "SNMP discovered device"
198-
comments: "Automatically discovered via SNMP"
199-
# lookup_extensions_dir: "/opt/orb/snmp-extensions" # Specifies a directory containing additional device data yaml files (see below)
200-
scope:
201-
targets:
202-
- host: "192.168.1.1"
203-
- host: "192.168.1.254"
204-
- host: "10.0.0.1"
205-
port: 162 # Non-standard SNMP port
206-
authentication:
207-
protocol_version: "SNMPv2c"
208-
community: "public" # Also supports resolving values from environment variables eg ${SNMP_COMMUNITY}
209-
# For SNMPv3, use these fields instead:
210-
# security_level: "authPriv"
211-
# username: "snmp-user" # Also supports resolving values from environment variables eg ${SNMP_USERNAME}
212-
# auth_protocol: "SHA"
213-
# auth_passphrase: "auth-password" # Also supports resolving values from environment variables eg ${SNMP_AUTH_PASSPHRASE}
214-
# priv_protocol: "AES"
215-
# priv_passphrase: "priv-password"# Also supports resolving values from environment variables eg ${SNMP_PRIV_PASSPHRASE}
216-
discover_once: # will run only once
217-
scope:
218-
targets:
219-
- host: "core-switch.example.com"
220-
port: 161
221-
- host: "192.168.100.50"
222-
port: 161
223-
authentication:
224-
protocol_version: "SNMPv3"
225-
security_level: "authPriv"
226-
username: "monitoring"
227-
auth_protocol: "SHA"
228-
auth_passphrase: "secure-auth-pass"
229-
priv_protocol: "AES"
230-
priv_passphrase: "secure-priv-pass"
177+
snmp_discovery:
178+
snmp_network_1:
179+
config:
180+
schedule: "0 */6 * * *" # Cron expression - every 6 hours
181+
timeout: 300 # Timeout for policy in seconds (default 2 minutes)
182+
snmp_timeout: 10 # Timeout for SNMP operations in seconds (default 5 seconds)
183+
retries: 3 # Number of retries
184+
defaults:
185+
tags: ["snmp-discovery", "orb"]
186+
site: "datacenter-01"
187+
location: "rack-42"
188+
role: "network"
189+
ip_address:
190+
description: "SNMP discovered IP"
191+
role: "management"
192+
tenant: "network-ops"
193+
vrf: "management"
194+
interface:
195+
description: "Auto-discovered interface"
196+
if_type: "ethernet"
197+
device:
198+
description: "SNMP discovered device"
199+
comments: "Automatically discovered via SNMP"
200+
# lookup_extensions_dir: "/opt/orb/snmp-extensions" # Specifies a directory containing additional device data yaml files (see below)
201+
scope:
202+
targets:
203+
- host: "192.168.1.1"
204+
- host: "192.168.1.254"
205+
- host: "10.0.0.1"
206+
port: 162 # Non-standard SNMP port
207+
authentication:
208+
protocol_version: "SNMPv2c"
209+
community: "public" # Also supports resolving values from environment variables eg ${SNMP_COMMUNITY}
210+
# For SNMPv3, use these fields instead:
211+
# security_level: "authPriv"
212+
# username: "snmp-user" # Also supports resolving values from environment variables eg ${SNMP_USERNAME}
213+
# auth_protocol: "SHA"
214+
# auth_passphrase: "auth-password" # Also supports resolving values from environment variables eg ${SNMP_AUTH_PASSPHRASE}
215+
# priv_protocol: "AES"
216+
# priv_passphrase: "priv-password"# Also supports resolving values from environment variables eg ${SNMP_PRIV_PASSPHRASE}
217+
discover_once: # will run only once
218+
scope:
219+
targets:
220+
- host: "core-switch.example.com"
221+
port: 161
222+
- host: "192.168.100.50"
223+
port: 161
224+
authentication:
225+
protocol_version: "SNMPv3"
226+
security_level: "authPriv"
227+
username: "monitoring"
228+
auth_protocol: "SHA"
229+
auth_passphrase: "secure-auth-pass"
230+
priv_protocol: "AES"
231+
priv_passphrase: "secure-priv-pass"
231232
```
232233

233234
**Note:** The following authentication fields support environment variable substitution using the `${VARNAME}` syntax:
@@ -363,4 +364,4 @@ orb:
363364
timeout: 5
364365
scope:
365366
targets: [192.168.1.0, 192.168.1.1]
366-
```
367+
```

0 commit comments

Comments
 (0)