Update README.md

README.md

@@ -60,8 +60,8 @@ To use this tool:
 
 ```
 OMD[build]:~$ ~/local/bin/topology_data/create_topology_data.py -h
-usage: create_topology_data.py [-h] [-c INVENTORY_COLUMNS] [-d DATA_SOURCE] [-m] [-o OUTPUT_DIRECTORY] [-p PATH_IN_INVENTORY] [-s SEED_DEVICES [SEED_DEVICES ...]] [-v] [--debug] [--dont-compare] [--keep-domain] [--keep-max KEEP_MAX] [--lldp] [--lowercase] [--min-age MIN_AGE] [--time-format TIME_FORMAT]
-                               [--uppercase]
+usage: create_topology_data.py [-h] [-m] [-o OUTPUT_DIRECTORY] [-s SEED_DEVICES [SEED_DEVICES ...]] [-v] [--data-source DATA_SOURCE] [--debug] [--dont-compare] [--inventory-columns INVENTORY_COLUMNS] [--keep-domain] [--keep-max KEEP_MAX] [--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 https://forum.checkmk.com/t/network-visualization/41680 and https://exchange.checkmk.com/p/network-visualization
@@ -70,35 +70,35 @@ The inventory data could 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.5-202310116 | Written by: thl-cmk, for more information see: https://thl-cmk.hopto.org
+Version: 0.0.5-202310117 | Written by: thl-cmk, for more information see: https://thl-cmk.hopto.org
 
 options:
   -h, --help            show this help message and exit
-  -c INVENTORY_COLUMNS, --inventory-columns INVENTORY_COLUMNS
-                        Columns used from the inventory data. I.e. "device_id,local_port,device_port"
-                        NOTE: the columns must be in the order: neighbour, local_port, neighbour_port
-  -d DATA_SOURCE, --data-source DATA_SOURCE
-                        The source from which the topology data originates. I.e. inv_CDP for CDP data from the inventory. NOTE: right now this only an unused label.
   -m, --make-default    Set the created topology data as default
   -o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY
                         Directory name where to save the topology data. I.e.: my_topology. Default is the actual date/time in "--time-format" format.
                         NOTE: the directory is a sub directory under "~/var/topology_data/"
-  -p PATH_IN_INVENTORY, --path-in-inventory PATH_IN_INVENTORY
-                        Checkmk inventory path to the topology data. I.e. "networking,cdp_cache"
   -s SEED_DEVICES [SEED_DEVICES ...], --seed-devices SEED_DEVICES [SEED_DEVICES ...]
                         List of devices to start the topology discovery from. I.e. Core01 Core02
   -v, --version         Print version of this script and exit
+  --data-source DATA_SOURCE
+                        The source from which the topology data originates. I.e. inv_CDP for CDP data from the inventory. NOTE: right now this only an unused label.
   --debug               Print debug information
   --dont-compare        Do not compare the actual topology data with the default topology data. By default, the actual
                         topology is compared with the default topology. If the data matches, the actual topology is not saved.
                         So, if you run this tool in a cron job, a new topology will be created only if there was a change,
                         unless you use "--dont-compare".
+  --inventory-columns INVENTORY_COLUMNS
+                        Columns used from the inventory data. I.e. "device_id,local_port,device_port"
+                        NOTE: the columns must be in the order: neighbour, local_port, neighbour_port
   --keep-domain         Do not remove the domain name from the neighbor name
   --keep-max KEEP_MAX   Number of topologies to keep. The oldest topologies above keep max will be deleted.
                         The default topologies will be always kept. The minimum value for --keep-max is 1.
   --lldp                Set data source to inv_LLDP, inventory path to "networking,lldp_cache" and columns to "system_name,local_port_num,port_id"
   --lowercase           Change neighbour names to all lower case
   --min-age MIN_AGE     The minimum number of days before a topology is deleted by "--keep-max". Topologies that are not older than 1 days are always kept.
+  --path-in-inventory PATH_IN_INVENTORY
+                        Checkmk inventory path to the topology data. I.e. "networking,cdp_cache"
   --time-format TIME_FORMAT
                         Format string to render the time. (default: %Y-%m-%dT%H:%M:%S.%m)
   --uppercase           Change neighbour names to all upper case
@@ -106,15 +106,9 @@ options:
 Usage:
 for CDP (the default):
 ~/local/bin/network-topology/create_topology_data.py -s Core01 Core02 -m
-or
-~/local/bin/network-topology/create_topology_data.py -s Core01 Core02 -m -p "networking,cdp_cache" -c "device_id,local_port,device_port" -d inv_CDP
-
 for LLDP:
 ~/local/bin/network-topology/create_topology_data.py -s Core01 Core02 -m --lldp
-or
-~/local/bin/network-topology/create_topology_data.py -s Core01 Core02 -m -p "networking,lldp_cache" -c "system_name,local_port_num,port_id" -d inv_LLDP
 OMD[build]:~$ 
-
 ```
 
 </details>
@@ -262,10 +256,10 @@ STATIC_CONNECTIONS = [
 Yes. If you don\`t use my plugins you can still use this tool to create your topology data, for this you need the path to your topology data in the inventory. For example for my CDP plugin this is _Networking_ -> _CDP Cache_ internally known as `networking` -> `cdp_cache`. The data must form a table in the inventory that contains at least the three columns for the neighbor name, neighbor port, and local port. For these columns you need the internal names. I.e. for my CDP plugin the columns _Neighbor device_, _Neighbor port_ and _Local port_ are known internally as `device_id`, `local_port` and `device_port`. With this information, you can run the tool like this
 
 ```
-~/local/bin/network-topology/create_topology_data.py -s Core01 -p "networking,cdp_cache" -c "device_id,local_port,device_port"
+~/local/bin/network-topology/create_topology_data.py -s Core01 --path-in-inventory "networking,cdp_cache" --inventory-columns "device_id,local_port,device_port"
 ```
 
-Wehre `-p` is the path to your inventory data and `-c` are the columns used in the order _neighbor_, _local port_, _neighbor port_.
+Wehre `--path-in-inventory` is the path to your inventory data and `--inventory-columns` are the columns used in the order _neighbor_, _local port_, _neighbor port_.
 
 </details>