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

Update HOWTO.md

parent 13e9f43b
No related branches found
No related tags found
No related merge requests found
......@@ -25,8 +25,11 @@
- [Network visualization plugin](https://exchange.checkmk.com/p/network-visualization)
1. Rules
Enable the HW/SW inventory for all your (network) devices that you want to include in the topology.
You should add two rules:
- Enable the HW/SW inventory for all your (network) devices that you want to include in the topology.
![](img/hw_sw_inventory_rule.png "HW/SW inventory rule")
- Normal check interval for the HW/SW inventory check
![](img/hw_sw_inventory_check_interval.png "Check interval for HW/SW inventory")
1. Host labels
......@@ -35,22 +38,54 @@
- `nvdct/has_cdp_neighbours:yes` for the `--pre-fetch` option
- `nvdct/has_lldp_neighbours:yes` for the `--pre-fetch` option
After installing the HW/SW inventory plugins, you must therefore perform a new search for host labels (_**Bulk discovery**_ -> _**Only discover new host labels**_).
After installing the HW/SW inventory plugins, you must therefore perform a new search for host labels.
![_**Bulk discovery**_ -> _**Only discover new host labels**_](img/bulk-discovery.png "Bulk discovery -> Only discover new host labels")
Depending on the host data, the host labels should then be found on the host.
![](img/host_labels.png)
1. Check the HW/SW inventory
Run the HW/SW inventory at least once for each host and then check whether the required data has been found. If so, proceed to the next step.
Run the HW/SW inventory at least once for each host and then check whether the required data has been found. If so, proceed to the next step. If your device has CDP neighbors, you should see a table like the table for LLDP.
![](img/hw_sw_inventory.png)
1. Modify the user settings for NVDCT
Before you create the topology data, take a look at _**nvdct.toml**_. Here you can fine tune some aspects of the topology creation. If you want/need to do this, please create a copy of the nvdct.toml file (e.g. my_nvdct.toml) and only change the copy. By not changing the nvdct.toml file, you ensure that your changes will survive the next update.
Before you create the topology data, take a look at `~/local/bin/nvdct/nvdct.toml`. Here you can fine tune some aspects of the topology creation. If you want/need to do this, please create a copy of the nvdct.toml file (e.g. my_nvdct.toml) and only change the copy. By working with a copy of the `nvdct.toml` file, you ensure that your changes will survive the next update of the NVDCT MKP. For the CDP/LLDP topologies add at least your seed devices - from where NVDCT will start to create the topology - to the `SEED_DEVICES` section.
```
# list of (additional to -s/--seed-devices) seed devices
SEED_DEVICES = [
"DEVICE01",
"DEVICE02",
"DEVICE03",
]
```
1. Create the topology data
```
~/local/bin/nvdct/nvdct.py -u ~/local/bin/nvdct/my_nvdct.toml
```
```
~/local/bin/nvdct/nvdct.py -u ~/local/bin/nvdct/my_nvdct.toml
```
For CMK 2.2.0 you should find the created data under
`~/var/topology_data/`. There should be also a symbolic link to the default topology.
```
~$ ls -ls ~/var/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/
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/topology_data/2024-04-30T14:25:17.04/
```
For CMK 2.3.0 you will find those data under `~/var/check_mk/topology/data`
1. Go to CMK and show the network topology
Now you can show the Network topology ![](img/show_topology.png)
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