diff --git a/HOWTO.md b/HOWTO.md index 9f3bf46fa9ed4b35b558907465cc7a610a7c6060..fd64ab877c516fd0e15fa001dd5e7334d5ad9aa8 100644 --- a/HOWTO.md +++ b/HOWTO.md @@ -4,7 +4,7 @@ You need at least CMK 2.2.0 or CMK 2.3.0 to use the Network visualization -1. installed packages +1. Installed packages For the Network visualization to work you need to install some additional plugins (MKPs). @@ -24,14 +24,15 @@ For topology visualization (only CMK 2.2.0x, CMK 2.3.0 has this built-in) - [Network visualization plugin](https://exchange.checkmk.com/p/network-visualization) - **Note**: [Here](https://thl-cmk.hopto.org/gitlab/explore/projects/topics/Network%20Visualization) you can find all plugins from this page at a glance. + **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 repositor shouls look like this -  + If you are done with the package installation your package repository should look like this +  -1. Rules - You should add two rules: +1. Checkmk Rules + + You should have two rules: - Enable the HW/SW inventory for all your (network) devices that you want to include in the topology.  - Normal check interval for the HW/SW inventory check @@ -44,7 +45,7 @@ - `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. + After installing the HW/SW inventory plugins, you must therefore perform rediscovery of host labels.  @@ -59,7 +60,7 @@ 1. Modify the user settings for NVDCT - 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. + 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. Before you 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 - in the `SEED_DEVICES` section. ``` # list of (additional to -s/--seed-devices) seed devices @@ -69,9 +70,7 @@ "DEVICE03", ] ``` - In the [SETTINGS] section enable the layers you want to create. By default NVDCT will onyl create the CDP layer. - ``` # settings equivalent to CLI options [SETTINGS] @@ -100,7 +99,7 @@ 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` + For CMK 2.3.0 you will find those files under `~/var/check_mk/topology/data` 1. Go to CMK and show the network topology