From 7841cae17a92624322f73c93009ef9bdda25676e Mon Sep 17 00:00:00 2001
From: thl-cmk <thl-cmk@outlook.com>
Date: Fri, 27 Sep 2024 11:29:17 +0000
Subject: [PATCH] Update README.md
---
README.md | 42 ++++++++++++++++++++++++------------------
1 file changed, 24 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
index e77139d..aac3031 100644
--- a/README.md
+++ b/README.md
@@ -39,7 +39,9 @@ For first steps on howto use the Network Visualization Data Creation Tool (NVDCT
* [Download latest mkp file][PACKAGE]
**Note**: before updating to a newer version check the [CHANGELOG](/CHANGELOG "CHANGELOG"). There could be always incompatible changes.
-
+
+**Note**: NVDCT version 0.9.0 has dropped support for the CMK 2.2.0 Network Visualization data format.
+
---
### Installation
@@ -87,11 +89,16 @@ Usage with LLDP and STATIC:
```
OMD[build]:~$ ~/local/bin/nvdct/nvdct.py -h
-usage: nvdct.py [-h] [-b {FILESYSTEM,LIVESTATUS,MULTISITE,RESTAPI}] [-d] [-o OUTPUT_DIRECTORY] [-s SEED_DEVICES [SEED_DEVICES ...]] [-p PREFIX]
- [-l {CDP,CUSTOM,LLDP,STATIC,L3v4} [{CDP,CUSTOM,LLDP,STATIC,L3v4} ...]] [-u USER_DATA_FILE] [-v] [--api-port API_PORT]
- [--check-user-data-only] [--log-file LOG_FILE] [--log-level {CRITICAL,FATAL,ERROR,WARNING,INFO,DEBUG,OFF}] [--log-to-stdout]
- [--dont-compare] [--keep-domain] [--keep KEEP] [--lowercase] [--min-age MIN_AGE] [--new-format] [--pre-fetch] [--quiet]
- [--skip-l3-if] [--skip-l3-ip] [--time-format TIME_FORMAT] [--uppercase]
+usage: nvdct.py [-h] [-b {LIVESTATUS,MULTISITE,RESTAPI}] [-d] [-o OUTPUT_DIRECTORY]
+ [-s SEED_DEVICES [SEED_DEVICES ...]] [-p PREFIX]
+ [-l {CDP,CUSTOM,LLDP,STATIC,L3v4} [{CDP,CUSTOM,LLDP,STATIC,L3v4} ...]]
+ [-u USER_DATA_FILE] [-v] [--api-port API_PORT] [--case {LOWER,UPPER}]
+ [--check-user-data-only] [--log-file LOG_FILE]
+ [--log-level {CRITICAL,FATAL,ERROR,WARNING,INFO,DEBUG,OFF}] [--log-to-stdout]
+ [--dont-compare] [--filter-customers {INCLUDE,EXCLUDE}]
+ [--filter-sites {INCLUDE,EXCLUDE}] [--keep-domain] [--keep KEEP]
+ [--min-age MIN_AGE] [--pre-fetch] [--quiet] [--skip-l3-if] [--skip-l3-ip]
+ [--time-format TIME_FORMAT]
This script creates the topology data file needed for the Checkmk "network_visualization"
plugin by Andreas Boesl and schnetz. For more information see
@@ -103,14 +110,13 @@ CDP: https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_c
LLDP: https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_lldp_cache
L3v4: https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_ipv4_addresses
-Version: 0.8.12-20240618 | Written by: thl-cmk
+Version: 0.9.0-20240923 | Written by: thl-cmk
for more information see: https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/nvdct
options:
-h, --help show this help message and exit
- -b {FILESYSTEM,LIVESTATUS,MULTISITE,RESTAPI}, --backend {FILESYSTEM,LIVESTATUS,MULTISITE,RESTAPI}
+ -b {LIVESTATUS,MULTISITE,RESTAPI}, --backend {LIVESTATUS,MULTISITE,RESTAPI}
Backend used to retrieve the topology data
- - FILESYSTEM : fetches the data directly form the inventory files (deprecatred)
- LIVESTATUS : fetches data via local Livestatus (local site only)
- MULTISITE : like LIVESTATUS but for distributed environments (default)
- RESTAPI : uses the CMK REST API.
@@ -120,26 +126,24 @@ options:
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/" (CMK2.2.0)
- For CMK 2.3.0 the path is under "~/var/check_mk/topology/data/".
+ NOTE: the directory is a sub directory under "~/var/check_mk/topology/data/"
-s SEED_DEVICES [SEED_DEVICES ...], --seed-devices SEED_DEVICES [SEED_DEVICES ...]
List of devices to start the topology discovery from.
I.e. Core01 Core02
-p PREFIX, --prefix PREFIX
Prepends each host with the prefix. (Needs testing)
-l {CDP,CUSTOM,LLDP,STATIC,L3v4} [{CDP,CUSTOM,LLDP,STATIC,L3v4} ...], --layers {CDP,CUSTOM,LLDP,STATIC,L3v4} [{CDP,CUSTOM,LLDP,STATIC,L3v4} ...]
- Layers with least significant layer first. Listed layers
- will be merged automatically (CMK2.2 only).
- CDP : needs inv_cdp_cache package at least in version 0.7.1-20240320
- LLDP : needs inv_lldp_cache package at least in version 0.9.3-20240320
- L3v4 : needs inv_ipv4_addresses package at least in version 0.0.3-20240320
- adds, layer 3 topology fpr IPv4 (CMK 2.3.0 only)
+ adds, layer 3 topology fpr IPv4
-u USER_DATA_FILE, --user-data-file USER_DATA_FILE
Set the name uf the user provided data file
Default is ~/local/bin/nvdct/conf/conf/nvdct.toml
-v, --version Print version of this script and exit
--api-port API_PORT TCP Port to access the REST API. Default is 80. NVDCT will try to automatically
detect the site apache port.
+ --case {LOWER,UPPER} Change neighbour name to all lower/upper case
--check-user-data-only
Only tries to read/parse the user data from nvdct.toml and exits.
--log-file LOG_FILE Set the log file. Default is ~/var/log/nvdct.log
@@ -151,14 +155,17 @@ options:
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".
+ --filter-customers {INCLUDE,EXCLUDE}
+ INCLUDE/EXCLUDE customer list from config file.
+ Note: MULTISITE backend only.
+ --filter-sites {INCLUDE,EXCLUDE}
+ INCLUDE/EXCLUDE site list from config file.
+ Note: MULTISITE backend only.
--keep-domain Do not remove the domain name from the neighbor name
--keep KEEP Number of topologies to keep. The oldest topologies above keep
max will be deleted.
NOTE: The default topologies will be always kept.
- --lowercase Change neighbour names to all lower case
--min-age MIN_AGE The minimum number of days before a topology is deleted by "--keep".
- --new-format Save data in new format. Use for CMK 2.3.x
- NVDCT will try to automatically detect the correct format. (deprecated)
--pre-fetch Try to fetch host data, with less API calls. Can improve RESTAPI backend
performance
--quiet Suppress output to stdtout
@@ -166,7 +173,6 @@ options:
--skip-l3-ip Skip ip-address in layer 3 topology
--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
Exit codes:
0 - No error
--
GitLab