Skip to content

Commit c6e85d7

Browse files
authored
chore: update device_discovery and network_discovery docs (#168)
1 parent c5d1b00 commit c6e85d7

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

docs/backends/device_discovery.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,13 @@ Config defines data for the whole scope and is optional overall.
4646
|:---------:|:----:|:--------:|:-----------:|
4747
| schedule | cron format | no | If defined, it will execute scope following cron schedule time. If not defined, it will execute scope only once |
4848
| defaults | map | no | key value pair that defines default values |
49+
| options | map | no | key value pair that defines config options |
50+
51+
#### Options
52+
Current supported options:
53+
| Key | Type | Description |
54+
|:-----:|:----:|:-------------:|
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) |
4956

5057
#### Defaults
5158
Current supported defaults:
@@ -67,7 +74,8 @@ Current supported defaults:
6774
|-------------|------|---------------------------------|
6875
| device | map | Device-specific defaults |
6976
| ├─ model | str | Device type model (overrides the model automatically retrieved from NAPALM) |
70-
| ├─ manufacturer | str | Device manufacturer (overrides the defined/discovered NAPALM driver name) |
77+
| ├─ manufacturer | str | Device manufacturer (overrides the vendor automatically retrieved from NAPALM) |
78+
| ├─ platform | str | Device platform (overrides the defined/discovered NAPALM driver name and OS version) |
7179
| ├─ description | str | Device description |
7280
| ├─ comments | str | Device comments |
7381
| ├─ tags | list | Device tags |

docs/backends/network_discovery.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,9 @@ The scope defines a list of targets to be scanned.
6464
| dns_servers | list | no | Specify alternate DNS servers for DNS resolution (--dns-servers). |
6565
| os_detection | bool | no | Enables NMAP OS detection (-O). |
6666
| use_target_masks | bool | no | When enabled (default: True), applies the most specific subnet mask from the defined targets to discovered IPs. Only affects targets defined as subnets (e.g., 192.168.1.0/24), not ranges or individual IPs. |
67+
| icmp_echo | bool | no | Enables ICMP Echo discovery (-PE). Sends ICMP Echo Request (ping) probes to detect live hosts. |
68+
| icmp_timestamp | bool | no | Enables ICMP Timestamp discovery (-PP). Uses ICMP Timestamp Requests to discover hosts that respond to this type of probe. |
69+
| icmp_netmask | bool | no | Enables ICMP Netmask discovery (-PM). Sends ICMP Address Mask Request packets to identify responsive hosts. |
6770

6871
### Sample
6972
A sample policy including all parameters supported by the network discovery backend.

0 commit comments

Comments
 (0)