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

Update TROUBLESHOOTING.md

parent 5ee32ddc
No related branches found
No related tags found
No related merge requests found
......@@ -20,7 +20,9 @@ For issues with the HW/SW inventory, such as no or incomplete CDP/LLDP/IPv4 addr
- [CDP cache](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_cdp_cache/-/blob/master/CONTRIBUTING.md)
- [LLDP cache](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_lldp_cache/-/blob/master/CONTRIBUTING.md)
- [Inventory IPv4 addresses](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_ipv4_addresses/-/blob/master/CONTRIBUTING.md)
- [Inventory of IP addresses - SNMP based](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_ipv4_addresses/-/blob/master/CONTRIBUTING.md)
- [IP address inventory for Windows hosts](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_win_if_ip/-/blob/master/CONTRIBUTING.md)
- [Extended IP-Address inventory for Linux hosts](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_lnx_if_ip/-/blob/master/CONTRIBUTING.md)
- [Interface name](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_ifname/-/blob/master/CONTRIBUTING.md)
If you have no inventory at all, check your HW/SW-Inventory rule(s) (see the [HowTo](HOWTO.md#3-checkmk-rules)) or the offical Checkmk documentation [The HW/SW Inventory](https://docs.checkmk.com/latest/en/inventory.html?lquery=hw/sw)
......@@ -28,11 +30,11 @@ If you have no inventory at all, check your HW/SW-Inventory rule(s) (see the [Ho
<details><summary>The desired topology layer was not created</summary>
By default NVDCT will onyl create the CDP topology layer. To create any other layer use the option `-l`/`--layers` or configure the layers you want in the config file.
By default NVDCT will create no topology layer. To create a layer use the option `-l`/`--layers` or configure the layers you want in the config file.
```
[SETTINGS]
layers = ["LLDP", "CDP", "L3v4"]
layers = ["LLDP", "CDP", "L3v4", "STATIC"]
```
</details>
......@@ -64,11 +66,11 @@ There are two possible reasons for this
1. the topology was created on a different Checkmk instance than the one it should be displayed on
This can occur in distributed environments, e.g. if the topology was created on a remote site and sould be used on the central instance.
This can occur in distributed environments, e.g. if the topology was created on a remote site and sould be shown on the central instance.
**Solution**: Always create the topology on the central instance. NVDCT can also read the data from the remote sites.
**Workaround**: If the topology cannot be created on the instance on which it is used, the generated topology (data_XXXX.jscon) must be copied to the instance on which it is used. If you sync the topology data between sites, dont forget to create the symlink "default" (see above)
**Workaround**: If the topology cannot be created on the instance on which it is shown, the generated topology (data_XXXX.jscon) must be copied to the instance on which it is used. If you sync the topology data between sites, dont forget to create the symlink "default" (see above)
</details>
......@@ -76,14 +78,14 @@ There are two possible reasons for this
In a distributed environment there are two known issues
1. where to run NVDCT -> see above _NVDCT runs fine, but there is no Network topology icon in the GUI_
2. where to place the configuration file
1. where to place the configuration file
As stated in the HowTo, always work with a copy of the default configuration file `nvdct.toml`. By default, this file is located under `~/local/bin/nvdct/conf`. In distributed environments, everything under `~/local` is overwritten by the central instance during the configuration sync, including any existing configuration files for **NCDCT**. To avoid this, the config files can either be created on the central instance and synchronized to the remote system or they must be stored on the remote system outside of `~/local`. E.g. under `~/nvdct_conf`.
</details>
<details><summary>Topologies from different sources</summary>
If you use different sources to create topology layers, it is possible that not all layers will be adopted by the backend.
If you use different sources to create topology layers, it is possible that not all layers will be picked up by the backend.
The backend only picks up the layers that are available in the default topology directory.
......@@ -107,11 +109,11 @@ To solve this problem, add at least one seed device from each site to the config
This can happen if NVDCT cannot map the neighbor names from CDP/LLDP to host names in Checkmk.
The best way to solve such issues use the same name on the device and in Checkmk. If this not possible there are several options how NVDCT converts neighbor names to Checkmk names
The best way to solve such issues use the same name on the device and in Checkmk. If this is not possible there are several options how NVDCT converts neighbor names to Checkmk names.
1. You can remove the domain name from the neighbour name.
To use only the hostname part from the neighbour as chekmk host name, use the option `--remove-domain` or in the configuratin file set `remove_domain` under `[SETTINGS]` to `true`.
To use only the hostname part from the neighbour as Checkmk host name, use the option `--remove-domain` or in the configuratin file set `remove_domain` under `[SETTINGS]` to `true`.
```
[SETTINGS]
......@@ -120,7 +122,7 @@ The best way to solve such issues use the same name on the device and in Checkmk
1. NVDCT can convert all neighbor names to upper or lower case
NVDCT has the options '--case' LOWER | UPPER for this purpose.
NVDCT has the options `--case LOWER | UPPER` for this purpose.
```
[SETTINGS]
......@@ -129,14 +131,14 @@ The best way to solve such issues use the same name on the device and in Checkmk
3. NVDCT can add a prefix to all neighbor names
Use the pption '-p'/'--prefix' to add an prefix to all neighbor names. The prefix will be set after the --case option is applied.
Use the option `-p/--prefix` to add an prefix to all neighbor names. The prefix will be set after the `--case` option is applied.
```
[SETTINGS]
prefix = "yor-prefix-"
```
4. NVDCT can map neighbor names to Checkmk names via the L2_[HOST_MAP] section.
4. NVDCT can map neighbor names to Checkmk names via the `[L2_HOST_MAP]` section.
If all this options dont solve your nameig issues, there is as last option the [HOST_MAP] section in the settings file.
Here you can map neighbor names to Checkmk names.
......@@ -148,9 +150,9 @@ The best way to solve such issues use the same name on the device and in Checkmk
inventory_neighbour3 = "cmk_host3"
```
5. Use of L2_NEIGHBOUR_REPLACE_REGEX
5. Use of `L2_NEIGHBOUR_REPLACE_REGEX`
If you need ro replace more comlex parts of the neighbour name (ie. serial numbers) you can use the L2_NEIGHBOUR_REPLACE_REGEX
If you need ro replace more comlex parts of the neighbour name (ie. serial numbers) you can use the `L2_NEIGHBOUR_REPLACE_REGEX`
section in the config file. Ie. to replace the serial number at the end of some neighbour names use
```
......@@ -158,7 +160,7 @@ The best way to solve such issues use the same name on the device and in Checkmk
"\\([0-9a-zA-Z]+\\)$" = ""
```
You can also use this section to drop neighbour (Ie. MAC addresses).
You can also use this section to drop neighbours (Ie. MAC addresses).
```
[L2_NEIGHBOUR_REPLACE_REGEX]
"^(([0-9a-fA-F]){2}[:.-]?){5}([0-9a-fA-F]){2}$" = ""
......@@ -202,8 +204,8 @@ If `L2_DROP_HOST` is not sufficient, you can use `L2_NEIGHBOUR_REPLACE_REGEX`.
## Layer3 IPv4 Address Topologies
<details><summary>The Layer3 topology was not created</summary>
1. check whether the L3v4 layer is activated in the configuration file or whether the -l L3v4 option is used (see above _The desired topology layer was not created_)
1. Check whether the L3v4 layer is activated in the configuration file or whether the -l L3v4 option is used (see above _The desired topology layer was not created_)
1. The creation of the Layer3 topology is based on the host label `nvdct/routing_capable:yes`. This label is added by the `inv_ip_address` plugin to all hosts with more than one IP address. After the inventory has been run, you must rediscover the host labels in Checkmk. See the [HowTo](HOWTO.md#4-host-labels) or the Checkmk documentation about [Labels](https://docs.checkmk.com/latest/en/labels.html?lquery=host%20label)
1. The creation of the Layer3 topology is based on the host labels `nvdct/l3v4_topology:host` and `nvdct/l3v4_topology:route`. This labels are added by the IP-address inventory plugins to all hosts with more than one IP address. After the inventory has been run, you must rediscover the host labels in Checkmk. See the [HowTo](HOWTO.md#4-host-labels) or the Checkmk documentation about [Labels](https://docs.checkmk.com/latest/en/labels.html?lquery=host%20label)
</details>
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