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 bd0166e3 authored by thl-cmk's avatar thl-cmk :flag_na:
Browse files

Update README.md

parent d3baad35
No related branches found
No related tags found
No related merge requests found
......@@ -11,14 +11,15 @@ For more information see [Checkmk forum Network Visualization](https://forum.che
- Read connection data from the checkmk HW/SW inventory.
- Works in standalone and distributed monitoring environments
- Add custom connections (STATIC) for connections that are not in the inventory
- Optimized for my [CDP](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_cdp_cache/), [LLDP](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_lldp_cache/) and [IPv4](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_ipv4_addresses) inventory plugins
- Optimized for my [CDP](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_cdp_cache/), [LLDP](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_lldp_cache/) and [IP](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_ip_addresses) inventory plugins
- Can also be used with custom inventory plugins (deprecated)
The necessary HW/SW inventory data can be created with my CDP/LLDP/IPv4 inventory plugins.
- [CDP inventory plugin](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_cdp_cache/)
- [LLDP inventory plugin](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_lldp_cache/)
- [IPv4 inventory plugin](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_ipv4_addresses)
- [Extended IP-Address inventory for Linux hosts plugin](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_lnx_if_ip)
- [IP inventory plugin (SNMP)](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_ip_addresses)
- [IP inventory plugin (Windows)](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_win_if_ip)
- [IP inventory plugin (Linux)](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_lnx_if_ip)
- [Interface name inventory plugin (optional but recommended)](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_ifname)
---
......@@ -35,8 +36,6 @@ For first steps on howto use the Network Visualization Data Creation Tool (NVDCT
---
### Download
**Note**: this is sill work in progress, so **before** updating read the [CHANGELOG](/CHANGELOG "CHANGELOG") please.
* [Download latest mkp file][PACKAGE]
**Note**: before updating to a newer version check the [CHANGELOG](/CHANGELOG "CHANGELOG"). There could be always incompatible changes.
......@@ -70,20 +69,20 @@ 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.4-20240407 for IPv4
- 0.0.5-20241209 for IPv4
and let Checkmk run the HW/SW inventory for each device at least once
---
### Usage
Usage with CDP and STATIC (this is the default):
Usage with CDP (this is the default):
```
~/local/bin/nvdct/nvdct.py -u ~/local/bin/conf/my_nvdct.toml -d
```
Usage with LLDP and STATIC:
Usage with LLDP:
```
~/local/bin/nvdct/nvdct.py -u ~/local/bin/conf/my_nvdct.toml -d -l LLDP STATIC
~/local/bin/nvdct/nvdct.py -u ~/local/bin/conf/my_nvdct.toml -d -l LLDP
```
<details><summary>Help output from nvdct.py --help</summary>
......@@ -178,7 +177,7 @@ Exit codes:
4 - Automation secret not found
Usage:
~/local/bin/nvdct/nvdct.py -u ~/local/bin/nvdct/conf/nvdct.toml
~/local/bin/nvdct/nvdct.py -u ~/local/bin/nvdct/conf/my_nvdct.toml
OMD[build]:~$
```
......@@ -332,6 +331,9 @@ STATIC_CONNECTIONS = [
<details><summary>Can I use the tool with other inventory data plugins</summary>
\
**This option is decrepated und will be removed soon.**
Yes. If you don\`t use my plugins you can still use this tool to create your topology data, for this you need the path to your topology data in the inventory. For example for my CDP plugin this is _Networking_ -> _CDP Cache_ -> _CDP neighbours_ internally known as `networking` -> `cdp_cache` -> `neighbours`. The data must form a table in the inventory that contains at least the three columns for the neighbor name, neighbor port, and local port. For these columns you need the internal names. I.e. for my CDP plugin the columns _Neighbor name_, _Neighbor port_ and _Local port_ are known internally as `neighbour_name`, `local_port` and `neighbour_port`. With this information, you can edit the CUSTOM_LAYERS section in the user data file like this
```
# optional custom layers use option -l/--layers CUSTOM to include this layers
......@@ -380,7 +382,6 @@ see https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/nvdct
Start time....: 2024-11-17T17:20:54.11
Source lldp...: Devices/Objects/Connections added 8/18/15
Source cdp....: Devices/Objects/Connections added 28/144/174
Source static.: Devices/Objects/Connections added 29/85/84
Source l3v4...: Devices/Objects/Connections added 2/141/140
Time taken....: 13.360647338/s
End time......: 2024-11-17T17:21:08.11
......
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