Collection of CheckMK checks (see https://checkmk.com/). All checks and plugins are provided as is. Absolutely no warranty. Send any comments to thl-cmk[at]outlook[dot]com

Skip to content
Snippets Groups Projects
Commit 06c033c9 authored by thl-cmk's avatar thl-cmk :flag_na:
Browse files

Update README.md

parent e73b4e91
No related branches found
No related tags found
No related merge requests found
......@@ -69,16 +69,15 @@ To use this tool:
**Note**: if you are using my CDP/LLDP/IPv4 plugins update at least to version
- 0.7.6-20240414 for CDP
- 0.9.7-20240414 for LLDP
- 0.0.5-20241209 for IPv4
- 0.0.4-20241210 for IPv4 (Linux)
- 0.0.6-20241210 for IPv4 (SNMP)
- 0.0.3-20241210 for IPv4 (Windows)
and let Checkmk run the HW/SW inventory for each device at least once
---
### Usage
Usage with CDP (this is the default):
```
~/local/bin/nvdct/nvdct.py -u ~/local/bin/conf/my_nvdct.toml -d
```
Usage with LLDP:
```
......@@ -106,7 +105,7 @@ CDP: https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_c
LLDP: https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_lldp_cache
L3v4: https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_ip_address
Version: 0.9.3-20241209 | Written by: thl-cmk
Version: 0.9.4-20241210 | Written by: thl-cmk
for more information see: https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/nvdct
options:
......@@ -126,12 +125,13 @@ options:
-p PREFIX, --prefix PREFIX
Prepends each host with the prefix. (Needs testing)
-l {CDP,CUSTOM,LLDP,STATIC,L3v4} [{CDP,CUSTOM,LLDP,STATIC,L3v4} ...], --layers {CDP,CUSTOM,LLDP,STATIC,L3v4} [{CDP,CUSTOM,LLDP,STATIC,L3v4} ...]
- CDP : needs inv_cdp_cache package at least in version 0.7.1-20240320
- LLDP : needs inv_lldp_cache package at least in version 0.9.3-20240320
- L3v4 : needs inv_ip_address package at least in version 0.0.5-2024120
adds, layer 3 topology fpr IPv4
- STATIC (deprecated)
- CUSTOM (deprecated)
- CDP : needs inv_cdp_cache package at least in version 0.7.1-20240320
- LLDP : needs inv_lldp_cache package at least in version 0.9.3-20240320
- L3v4 : needs inv_ip_address package at least in version 0.0.6-20241210 for SNMP based hosts
for Linux based hosts inv_lnx_ip_if in version 0.0.4-20241210
for Windows based hosts inv_win_ip_if in version 0.0.3-20241210
- STATIC: creates a topology base on the "STATIC_CONNECTIONS" in the toml file
- CUSTOM: (deprecated)
-u USER_DATA_FILE, --user-data-file USER_DATA_FILE
Set the name uf the user provided data file
Default is ~/local/bin/nvdct/conf/nvdct.toml
......@@ -315,14 +315,21 @@ Ie. to remove all neighbours advertised as MAC-address only use:
<details><summary>Not all connections are included in the inventory</summary>
\
If your inventory data does not contain all the required topology information, you can add static connections in the data file (by default `nvdct.toml`). This may be the case if not all of your devices use CDP/LLDP. The connections defined in **STATIC_CONNECTIONS** are added to the topology from host to neighbor and vice versa. I.e..
If your inventory data does not contain all the required topology information, you can add static connections in the data file (by default `nvdct.toml`). This may be the case if not all of your devices use CDP/LLDP.
```
# user defined static connections
# connections will be added from host to neighbour and in reverese
# [0-9-a-zA-Z\.\_\-]{1,253} -> host
STATIC_CONNECTIONS = [
["host1", "local-port1", "neighbour-port1", "neighbour1", "label"],
["host1", "local-port2", "neighbour-port2", "neighbour2", "label"],
# valid entry formats
# ["left_host", "left_service", "right_service", "right_host"],
# connection: "left_host"<->"left_service"<->"right_service"<->"right_host"
# ["left_host", "", "right_service", "right_host"],
# connection: "left_host"<->"right_service"<->"right_host"
# ["left_host", "left_service", "", "right_host"],
# connection: "left_host"<->"left_service"<->"right_host"
# ["left_host", "", "", "right_host"],
# connection: "left_host"<->"right_host"
]
```
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment