Regenerate integrations docs (#22243)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Apr 22, 2026 at 08:29 UTC
83596b17f22e29aca805c062ec1e4c1e1fdff09e
1 file changed
+51
-4
src/go/plugin/go.d/collector/snmp/integrations/snmp_devices.md
+51
-4
@@ -142,10 +142,7 @@ Before configuring the collector:
142
143
#### Options
144
145
-The following options can be defined globally: `update_every`, `autodetection_retry`.
146
-
147
-There is no module-wide `topology:` block in `snmp.conf`.
148
-SNMP topology discovery is handled by the separate `snmp_topology` collector using devices registered by SNMP jobs.
145
+The following options can be defined globally: update_every, autodetection_retry.
146
147
148
<details open><summary>Config options</summary>
@@ -444,6 +441,53 @@ Network interface metrics from cached SNMP data, including traffic rates, packet
441
| Multicast In | float | packets/s | hidden | Rate of multicast packets (destined for a group) received per second. Common in video streaming, multicast applications, and routing protocols. |
442
| Multicast Out | float | packets/s | hidden | Rate of multicast packets transmitted per second. |
443
444
+### Network Topology
445
+
446
+Provides the agent-wide SNMP topology view built from all currently running topology-enabled SNMP jobs.
447
+
448
+This function reads cached LLDP/CDP data collected by the independent topology refresh loop and returns a topology schema (devices, links, and stats). No additional SNMP requests are triggered when calling this function.
449
+
450
+Use cases:
451
+- Discover Layer 2 neighbors and link mapping
452
+- Validate cabling and port connections
453
+- Identify adjacent devices that are discovered but not monitored
454
+
455
+
456
+| Aspect | Description |
457
+|:-------|:------------|
458
+| Name | `Snmp:topology` |
459
+| Require Cloud | no |
460
+| Performance | Uses cached SNMP data only, no additional SNMP requests are triggered:<br/>• Responses are instantaneous from memory cache<br/>• Large devices with many discovered neighbors may return many rows |
461
+| Security | Exposes discovered device identifiers, interface/port identifiers, and management addresses only:<br/>• No packet payloads or authentication credentials are exposed<br/>• No device configuration details are exposed |
462
+| Availability | Available when:<br/>• The collector has completed at least one successful topology refresh cycle<br/>• LLDP/CDP topology data is present in cache from the last successful topology refresh<br/>• Returns HTTP 503 if topology cache is not ready yet |
463
+
464
+#### Prerequisites
465
+
466
+No additional configuration is required.
467
+
468
+#### Parameters
469
+
470
+| Parameter | Type | Description | Required | Default | Options |
471
+|:---------|:-----|:------------|:--------:|:--------|:--------|
472
+| Nodes Identity | select | Choose actor identity strategy. `ip` collapses nodes by management IP and removes non-IP inferred actors. `mac` keeps MAC-oriented identities. | yes | ip | IP (default), MAC |
473
+| Map | select | Select the topology map mode. Defaults to the managed-device LLDP/CDP view. Other modes progressively include inferred devices and lower-confidence links. | yes | lldp_cdp_managed | LLDP/CDP/Managed Devices Map (default), High Confidence Inferred Map, All Devices (Low Confidence) |
474
+| Infer Strategy | select | Select the inference algorithm used for FDB/STP/CDP correlation. | yes | fdb_minimum_knowledge | FDB Minimum-Knowledge (Baseline) (default), STP Parent Tree, FDB Pairwise Minimum-Knowledge, STP + FDB Correlated, CDP + FDB Hybrid |
475
+| Focus On | multiselect | Limit depth filtering to selected managed SNMP roots. The static default is `all_devices`; additional `ip:<address>` options are supplied dynamically from the current managed SNMP jobs. | yes | all_devices | All Devices (default) |
476
+| Focus Depth | select | Limit topology expansion hops from the focus roots. `all` disables depth filtering. | yes | all | All (default), 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 |
477
+
478
+#### Returns
479
+
480
+Agent-wide topology data in a JSON schema suitable for cross-agent aggregation.
481
+
482
+| Column | Type | Unit | Visibility | Description |
483
+|:-------|:-----|:-----|:-----------|:------------|
484
+| schema_version | integer | | | Topology schema version. |
485
+| agent_id | string | | | Netdata Agent or vnode identifier that collected the data. |
486
+| collected_at | string | | | Collection timestamp in RFC 3339 format. |
487
+| devices | array | | | List of devices (local and discovered). |
488
+| links | array | | | List of discovered links (LLDP/CDP). |
489
+| stats | object | | | Summary stats (device/link counts). |
490
+
491
492
493
## Troubleshooting
@@ -561,3 +605,6 @@ Table metrics are usually the slowest and often determine the total collection t
605
1. Do logs show “skipping data collection”?
606
2. Does *Internal → Stats* show collection time > `update_every`?
607
3. Increase `update_every` until skips disappear.
608
+
609
+
610
+