From 968da5aef97d45f3ad71d2ff78e77577fc7f21e2 Mon Sep 17 00:00:00 2001
From: thl-cmk <thl-cmk@outlook.com>
Date: Thu, 12 Oct 2023 14:57:13 +0000
Subject: [PATCH] Update README.md
---
README.md | 27 +++++++++++++++++++++++++++
1 file changed, 27 insertions(+)
diff --git a/README.md b/README.md
index 05a35ff..374dc8f 100644
--- a/README.md
+++ b/README.md
@@ -43,6 +43,33 @@ In the Enterprise/Free/Cloud edition of CheckMK you can use the GUI to install t
Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contributing")
+---
+### Limitations
+
+- neighbour names in CD/LLDP data have to match the host names in Checkmk
+- local/neighbour interface names have to match the service names in Checkmk
+
+If neighbour names in CD/LLDP data and Checkmk host names don't match, you can configure a mapping in the `create_topology_data.py`. I.e.:
+
+```
+# map inventory host name to CMK host name
+HOST_MAP = {
+ 'inventory-host': 'cmkhost',
+ 'nexus01': 'NX01',
+ 'nexus02': 'NX02',
+ 'nexus03': 'NX03',
+}
+```
+**NOTE**: the script will automatically remove the domain name form the neighbour names.
+
+At the same place you can exclude invalid hosts from the topology data
+```
+# drop hosts with invalid names
+DROP_HOSTS = [
+ 'not advertised',
+]
+```
+
---
### Sample Output
--
GitLab