You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/backends/device_discovery.md
+29-1Lines changed: 29 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,6 +57,8 @@ Current supported options:
57
57
| port_scan_timeout | float | TCP port probe timeout in seconds (defaults to 0.5) |
58
58
| capture_running_config | bool | If True, collects the running configuration from the device and ingests it as a DeviceConfig entity (defaults to 'False' if not specified) |
59
59
| capture_startup_config | bool | If True, collects the startup/saved configuration from the device and ingests it as a DeviceConfig entity (defaults to 'False' if not specified) |
60
+
| sanitize_config | bool | If False, captured configuration is stored as-is without redacting sensitive values such as passwords and pre-shared keys (defaults to 'True' if not specified) |
61
+
| discovery_drivers | list | Restrict auto-discovery to this ordered list of driver names (e.g. `[panos, huawei_vrp]`). Only used when a scope entry has no `driver` set. If not specified, only standard NAPALM drivers are tried. Custom drivers (`panos`, `panos_ssh`, `huawei_vrp`) must be listed explicitly to be used in auto-discovery. |
60
62
61
63
#### Defaults
62
64
Current supported defaults:
@@ -123,7 +125,7 @@ The scope defines a list of devices that can be accessed and pulled data.
123
125
| hostname | string | yes | Device hostname. It also supports subnets (e.g. 192.168.1.0/28) and IP ranges in the format 192.168.0.1-192.168.0.10 or 192.168.0.1-10. |
| driver | string | no |If defined, try to connect to device using the specified NAPALM driver. If not, it will try all the current installed drivers|
128
+
| driver | string | no | If defined, connect using the specified NAPALM driver. If not set, all installed drivers are tried (or the `discovery_drivers` list if configured).|
127
129
| optional_args | map | no | NAPALM optional arguments defined [here](https://napalm.readthedocs.io/en/latest/support/#list-of-supported-optional-arguments). Commonly used: `ssh_config_file` for jumphost support (see [SSH Configuration guide](./device_discovery_ssh.md)), `canonical_int` for interface naming, `timeout` for slow connections. |
128
130
| override_defaults | map | no | Allows overriding of any defaults for a specific device in the scope |
129
131
@@ -206,6 +208,32 @@ orb:
206
208
location: Row B
207
209
```
208
210
211
+
### Custom Driver Discovery Example
212
+
213
+
Use `discovery_drivers` to limit auto-discovery to a specific set of drivers. This is useful when you know the device type in advance or when using custom NAPALM drivers shipped with device-discovery (`panos`, `panos_ssh`, `huawei_vrp`).
214
+
215
+
```yaml
216
+
orb:
217
+
...
218
+
policies:
219
+
device_discovery:
220
+
panos_discovery:
221
+
config:
222
+
schedule: "0 * * * *"
223
+
options:
224
+
discovery_drivers:
225
+
- panos
226
+
- panos_ssh
227
+
defaults:
228
+
site: DC1
229
+
scope:
230
+
- hostname: 192.168.10.20
231
+
username: admin
232
+
password: ${PANOS_PASS}
233
+
```
234
+
235
+
In this example, only the `panos` and `panos_ssh` drivers are tried during auto-discovery for devices in this policy. If you set `driver` explicitly on a scope entry, `discovery_drivers` is ignored for that entry.
236
+
209
237
### Advanced Sample
210
238
211
239
You can reuse credentials across multiple devices in the `scope` section by using YAML anchors (`&`) and aliases (`<<`). This reduces redundancy and simplifies configuration management.
0 commit comments