From a6cdba550a93b3b5f2b3373e8f2eeaccd37d1dd0 Mon Sep 17 00:00:00 2001
From: thl-cmk <thl-cmk@outlook.com>
Date: Tue, 17 Dec 2024 16:13:19 +0000
Subject: [PATCH] Update README.md - added NVDCT

---
 README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)

diff --git a/README.md b/README.md
index 20dce74..f67a414 100644
--- a/README.md
+++ b/README.md
@@ -289,3 +289,61 @@ In the Enterprise/Free/Cloud edition of CheckMK you can use the GUI to install t
 ### Want to Contribute?
 
 Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contributing")
+
+---
+### Use the extnded Cisco Meraki cloud agent with CMKs Network Visualization
+
+To do this you need at least
+
+- Checkmk 2.3.x
+- the extended Cisco Meraki cloud agent version 1.4.0-20241217
+- the [Network Visualization Data Creation Tool version 0.9.2-20241117](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/nvdct)
+
+![Cisco Meraki LLDP topology](img/meraki.png "Cisco Meraki LLDP topology")
+
+<details><summary>Here is a basic how to</summary>
+
+- enable HW/SW inventory in checkmk
+- install and configure the extended Cisco Meraki cloud agent
+- configure the dynamic host management to add your Cisco Meraki devices to checkmk, let the DCD do it’s magic
+- wait until the HW/SW inventory was running and has found the LLDP neighbours
+- configure and run NVDCT
+- enjoy your LLDP network topology
+
+</details>
+
+<details><summary>How to configure NVDCT for use with Cisco Meraki</summary>
+
+- create a copy of ~/local/bin/conf/nvdct.toml
+- in **your copy** of the config file
+  - in `[L2_SEED_DEVICES]` add your Cisco Meraki seed devices (from where to discover the LLDP topology)
+    Note: The names have to be exactly like the are in checkmk
+  - in `[L2_NEIGHBOUR_REPLACE_REGEX]`
+    - uncomment `# "^Meraki.*\\s-\\s" = ""`
+    - if you have Meraki devices with spaces in the host name add `"\s" = "_"`
+  - in `[SETTINGS]`
+    - uncomment layers and change it to: `layers = ["LLDP"]`
+    - set the output directory (optional), i.e:     `output_directory = 'meraki'`
+    - make the topology the default (optional): `default = true`
+</details>
+
+<details><summary>run NVDCT</summary>
+
+```
+OMD[build]:~$ ~/local/bin/nvdct/nvdct.py -u ~/local/bin/nvdct/conf/your_meraki.toml
+
+Network Visualisation Data Creation Tool (NVDCT)
+by thl-cmk[at]outlook[dot]com, version 0.9.2-20241117
+see https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/nvdct
+
+Start time....: 2024-11-24T12:51:58.11
+Source lldp...: Devices/Objects/Connections added 306/1061/1136
+Time taken....: 27.457535817/s
+End time......: 2024-11-24T12:52:25.11
+
+OMD[build]:~$
+```
+
+</details>
+
+
-- 
GitLab