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

Update HOWTO.md

parent 1caac730
No related branches found
No related tags found
No related merge requests found
......@@ -13,20 +13,22 @@ For the OSI layer 2 topology
- [LLDP cache HW/SW inventory plugin](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_lldp_cache)
For the OSI layer 3 topology
- [IPv4 address HW/SW inventory plugin](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_ipv4_addresses)
- [IPv4 address HW/SW inventory plugin (Linux)](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_lnx_if_ip)
- [IPv4 address HW/SW inventory plugin (SNMP)](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_ipv4_addresses)
- [IPv4 address HW/SW inventory plugin (Windows)](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_win_if_ip)
For the name to service matching (optional, but recommended)
For the name to service matching
- [INV_IFNAME HW/SW inventory plugin](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_ifname)
For the topology data creation
- [NVDCT (NetworkVisualizationDataCreationTool) plugin](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/nvdct)
- [Network Visualization Data Creation Tool (NVDCT) plugin](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/nvdct)
**Note**: [Here](https://thl-cmk.hopto.org/gitlab/explore/projects/topics/Network%20Visualization) you can find all plugins from this page at one place.
If you are done with the package installation your package repository should look like this
![](img/installed_packages.png "Installed extensions")
Here you will find help on [Checkmk extension packages (MKPs)](https://docs.checkmk.com/latest/en/mkps.html).
Here you will find help on [managing Checkmk extension packages (MKPs)](https://docs.checkmk.com/latest/en/mkps.html).
## 3. Checkmk Rules
......@@ -41,7 +43,7 @@ Here you will find help on CMKs [HW/SW Inventory](https://docs.checkmk.com/lates
## 4. Host labels
Some parts of the NVDCT are dependent on the presence of certain host labels:
- `nvdct/routing_capable:yes` for the IPv4 topology and `--pre-fetch` option
- `nvdct/l3v4_topology:host`and `nvdct/l3v4_topology:router` for the IPv4 topology and `--pre-fetch` option
- `nvdct/has_cdp_neighbours:yes` for the `--pre-fetch` option
- `nvdct/has_lldp_neighbours:yes` for the `--pre-fetch` option
......@@ -72,7 +74,7 @@ L2_SEED_DEVICES = [
"DEVICE03",
]
```
In the [SETTINGS] section enable the layers you want to create. By default NVDCT will onyl create the CDP layer.
In the [SETTINGS] section enable the layers you want to create. **Note**: By default NVDCT will create no layer.
```
# settings equivalent to CLI options
[SETTINGS]
......@@ -86,15 +88,11 @@ layers = ["LLDP", "L3v4"]
~/local/bin/nvdct/nvdct.py -u ~/local/bin/nvdct/conf/my_nvdct.toml -d
```
For CMK 2.3.0 you should find the created data under `~/var/check_mk/topology/data`. There should be also a symbolic link to the default topology.
You should find the created data under `~/var/check_mk/topology/data`. There should be also a symbolic link to the default topology.
```
~$ ls -ls ~/var/check_mk/topology/data
total 20
4 drwx------ 2 build build 4096 Apr 30 13:54 2024-04-30T13:54:51.04/
4 drwx------ 2 build build 4096 Apr 30 14:17 2024-04-30T14:17:05.04/
4 drwx------ 2 build build 4096 Apr 30 14:20 2024-04-30T14:20:07.04/
total 4
4 drwx------ 2 build build 4096 Apr 30 14:25 2024-04-30T14:25:17.04/
4 drwx------ 2 build build 4096 May 1 13:15 2024-05-01T13:15:51.05/
0 lrwxrwxrwx 1 build build 57 Apr 30 14:25 default -> /omd/sites/build/var/check_mk/topology/data/2024-04-30T14:25:17.04/
```
......
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