diff --git a/README.md b/README.md index 730cedfff72e34056d6858885f5f50bb0f83c724..417b6a010bdb4fdcae9ad492c9db6162839aab1e 100644 --- a/README.md +++ b/README.md @@ -59,12 +59,12 @@ To use this tool: <details><summary>Help output from create_topology_data.py -h</summary> ``` -OMD[build]:~$ ~/local/bin/topology_data/create_topology_data.py -h -usage: create_topology_data.py [-h] [-m] [-o OUTPUT_DIRECTORY] [-s SEED_DEVICES [SEED_DEVICES ...]] [-v] - [--check-user-data-only] [--data-source DATA_SOURCE] [--debug] [--dont-compare] - [--inventory-columns INVENTORY_COLUMNS] [--keep-domain] [--keep KEEP] [--lldp] - [--lowercase] [--min-age MIN_AGE] [--path-in-inventory PATH_IN_INVENTORY] - [--time-format TIME_FORMAT] [--uppercase] +OMD[build]:~$ ~/local/bin/topology_data/create_topology_data.py -h +usage: create_topology_data.py [-h] [-m] [-o OUTPUT_DIRECTORY] [-s SEED_DEVICES [SEED_DEVICES ...]] + [-u USER_DATA_FILE] [-v] [--check-user-data-only] [--data-source DATA_SOURCE] + [--debug] [--dont-compare] [--inventory-columns INVENTORY_COLUMNS] [--keep-domain] + [--keep KEEP] [--lldp] [--lowercase] [--min-age MIN_AGE] + [--path-in-inventory PATH_IN_INVENTORY] [--time-format TIME_FORMAT] [--uppercase] This script creates the topology data file needed for the Checkmk "network_visualization" plugin by Andreas Boesl and schnetz. For more information see @@ -75,7 +75,7 @@ The required inventory data can be created with my inventory plugins: CDP: https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_cdp_cache LLDP: https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_lldp_cache -Version: 0.0.6-202310117 | Written by: thl-cmk +Version: 0.0.7-202310118 | Written by: thl-cmk for more information see: https://thl-cmk.hopto.org options: @@ -89,6 +89,9 @@ options: -s SEED_DEVICES [SEED_DEVICES ...], --seed-devices SEED_DEVICES [SEED_DEVICES ...] List of devices to start the topology discovery from. I.e. Core01 Core02 + -u USER_DATA_FILE, --user-data-file USER_DATA_FILE + Set the name uf the user provided data file + Default is ~local/bin/topology_data/create_topology_data.toml -v, --version Print version of this script and exit --check-user-data-only Only tries to read/parse the user data from create_topology_data.toml and exits. @@ -130,7 +133,7 @@ for CDP (the default): ~/local/bin/network-topology/create_topology_data.py -s Core01 Core02 -m for LLDP: ~/local/bin/network-topology/create_topology_data.py -s Core01 Core02 -m --lldp -OMD[build]:~$ +OMD[build]:~$ ``` </details> @@ -218,7 +221,7 @@ will only delete a topology if it older than 30 days. <details><summary>Can the topology data creation be customized</summary> \ -Yes. You can customize the topology data creation by modifying the `~/local/bin/topology_data/create_topology_data.toml` file. Use `~/local/bin/topology_data/create_topology_data.toml_clean` as a template. +Yes. You can customize the topology data creation by modifying the `~/local/bin/topology_data/create_topology_data.toml` file. Or provide your own data file (see Option -u, --user-data-file) **Note**: This file uses [Tom's Obvious Minimal Language](https://toml.io/en/) @@ -227,7 +230,7 @@ Yes. You can customize the topology data creation by modifying the `~/local/bin <details><summary>My Neighbor names from the inventory and checkmk host names do not match</summary> \ -If the neighbor names from the inventory and the checkmk host names do not match, the topology does not work. To fix this, add a mapping between the neighbor name and the checkmk host name to the **HOST_MAP** in the `create_topology_data.toml` file. I.e. +If the neighbor names from the inventory and the checkmk host names do not match, the topology does not work. To fix this, add a mapping between the neighbor name and the checkmk host name to the **HOST_MAP** in the data file (by default `create_topology_data.toml`). I.e. ``` # map inventory neighbour name to Checkmk host name @@ -243,7 +246,7 @@ inventory_neighbour3 = "cmk_host3" <details><summary>In my the 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 `create_topology_data.toml` file. I.e.. +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.. ``` # drop neighbours with invalid names @@ -259,7 +262,7 @@ DROP_HOSTS = [ <details><summary>Not all connections are included in the inventory</summary> \ -If your inventory data does not contain all the required topology information, you can add static connections in the `create_topology_data.toml` file. This may be the case if not all of your devices use CDP/LLDP. The connections defined in **STATIC_CONNECTIONS** are added to the topology from host to neighbor and vice versa. I.e.. +If your inventory data does not contain all the required topology information, you can add static connections in the data file (by default `create_topology_data.toml`). This may be the case if not all of your devices use CDP/LLDP. The connections defined in **STATIC_CONNECTIONS** are added to the topology from host to neighbor and vice versa. I.e.. ``` # user defined static connections