From ee46290bd26222cb8e8a4fcab053cec29d305ba9 Mon Sep 17 00:00:00 2001 From: thl-cmk <thl-cmk@outlook.com> Date: Thu, 19 Oct 2023 17:27:59 +0000 Subject: [PATCH] Update README.md --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7f9f733..f39c929 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ [PACKAGE]: ../../raw/master/create_topology_data-0.0.7-20231019.mkp "create_topology_data-0.0.7-20231019.mkp" -# PoC for creating topology_data.json from inventory data +# PoC for Network Visualization data creation from inventory data This script creates the topology data file needed for the [Checkmk Exchange Network visualization](https://forum.checkmk.com/u/schnetz) plugin by Andreas Boesl and [schnetz](https://exchange.checkmk.com/u/schnetz). For more information see [Checkmk forum Network Visualization](https://forum.checkmk.com/t/network-visualization/41680). Features: -- Reading connection data from the Checkmk inventory +- Reading connection data from the Checkmk HW/SW inventory - handling differences between inventory neighbor names and checkmk hostnames - Adding user defined connections for connections not included in the inventory - optimized for my [CDP](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_cdp_cache/) (default) and [LLDP](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_lldp_cache/) cache plugins - can also be used with custom inventory plugins - clean up old topologies -The network topology data is read from the Checkmk HW/SW inventory. The necessary inventory data can be created with my CDP/LLDP inventory plugins. +The necessary HW/SW inventory data can be created with my CDP/LLDP inventory plugins. CDP: [CDP inventory plugin](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_cdp_cache/)\ CDP path-in-inventory: `"networking,cdp_cache"`\ @@ -21,8 +21,6 @@ LLDP: [LLDP inventory plugin](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-in LLDP path-in-inventory: `"networking,lldp_cache"`\ LLDP inventory-columns: `"system_name,local_port_num,port_id"` - - --- ### Acknowledgements @@ -56,7 +54,7 @@ To use this tool: - your Checkmk Site must be running at least CMK version 2.2.0p1 - the HW/SW inventory must be enabled - you need to install/enable an inventory plugin to collect the connection data I.e. my [CDP cache](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_cdp_cache/) plugin -- the [Network visualization](https://exchange.checkmk.com/p/network-visualization) must be installed +- the [Network visualization plugin](https://exchange.checkmk.com/p/network-visualization) must be installed **Note**: if you are using my CDP/LLDP plugins update at least to version: - 0.6.1-20231013 for CDP @@ -212,7 +210,7 @@ OMD[build]:~/etc/cron.d$ crontab -l | grep -A 3 -B 1 create_topoloky_data </details> -<details><summary>Can I limit the number of topology changes saved</summary> +<details><summary>Can I limit the number of topology saved changes</summary> \ Yes. If you use the option --keep <number of topologies to keep> the tool will delete all topologies over this number. I.e. @@ -228,6 +226,7 @@ will delete the oldest topologies until there only 10 topologies left. <details><summary>I will not delete topologies from the last X days</summary> +\ No problem. Just use the option `--min-age` togeher with `--keep`. I.e. ``` $ ~/local/bin/topology_data/create_topology_data.py -s Core01 --keep 10 --min-age 30 @@ -262,7 +261,7 @@ inventory_neighbour3 = "cmk_host3" </details> -<details><summary>In my the inventory are invalid neighbor names</summary> +<details><summary>In my inventory are invalid neighbor names</summary> \ If you have invalid neighbor names in the inventory (i.e. "not advertised"), you can drop them by adding them to the **DROP_HOSTS** list in the data file (by default `create_topology_data.toml`). I.e.. -- GitLab