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
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,6 +53,8 @@ Current supported options:
53
53
| Key | Type | Description |
54
54
|:-----:|:----:|:-------------:|
55
55
| platform_omit_version | bool | If True, only the driver name will be used as the NetBox platform name (defaults to 'False' if not specified) |
56
+
| port_scan_ports | list | TCP ports to probe before discovery if hostname is a IP Range or a Subnet (defaults to [22,23,80,443,830,57400]) |
57
+
| port_scan_timeout | float | TCP port probe timeout in seconds (defaults to 0.5) |
56
58
57
59
#### Defaults
58
60
Current supported defaults:
@@ -114,7 +116,7 @@ The scope defines a list of devices that can be accessed and pulled data.
114
116
115
117
| Parameter | Type | Required | Description |
116
118
|:---------:|:----:|:--------:|:-----------:|
117
-
| hostname | string | yes | Device hostname |
119
+
| 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 |
| ipaddress | map | IP address-specific defaults |
61
+
| ├─ role | string | IP address role |
62
+
| ├─ vrf | string | IP address vrf |
63
+
| ├─ tenant | string | IP address tenant |
64
+
| ├─ description | string | IP address description |
65
+
66
+
### Scope Section
57
67
| Parameter | Type | Required | Description |
58
68
|:---------:|:----:|:--------:|:-----------:|
59
-
| description | string | no | Description for discovered IP addresses |
60
-
| role | string | no | Role for discovered IP addresses (e.g. "management") |
61
-
| tenant | string | no | Tenant name for discovered IP addresses |
62
-
| vrf | string | no | VRF name for discovered IP addresses |
63
-
64
-
#### Interface Defaults Parameters
65
-
| Parameter | Type | Required | Description |
66
-
|:---------:|:----:|:--------:|:-----------:|
67
-
| description | string | no | Description for discovered interfaces |
68
-
| if_type | string | no | Interface type (e.g. "ethernet", "virtual") |
69
-
70
-
#### Device Defaults Parameters
71
-
| Parameter | Type | Required | Description |
72
-
|:---------:|:----:|:--------:|:-----------:|
73
-
| description | string | no | Description for discovered devices |
74
-
| comments | string | no | Comments for discovered devices |
75
-
76
-
#### Scope Section
77
-
| Parameter | Type | Required | Description |
78
-
|:---------:|:----:|:--------:|:-----------:|
79
-
| targets | list | yes | List of SNMP targets to discover |
69
+
| targets | list | yes | List of SNMP targets to discover. 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. |
0 commit comments