Collection of CheckMK checks (see https://checkmk.com/). All checks and plugins are provided as is. Absolutely no warranty. Send any comments to thl-cmk[at]outlook[dot]com

Skip to content
Snippets Groups Projects
Commit 5c6171de authored by thl-cmk's avatar thl-cmk :flag_na:
Browse files

Update README.md

parent a4bcab76
No related branches found
No related tags found
No related merge requests found
......@@ -89,14 +89,11 @@ 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 {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]
This script creates the topology data file needed for the Checkmk "network_visualization"
plugin by Andreas Boesl and schnetz. For more information see
......@@ -108,7 +105,7 @@ 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.7-20240430 | Written by: thl-cmk
Version: 0.8.12-20240618 | Written by: thl-cmk
for more information see: https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/nvdct
options:
......@@ -141,7 +138,7 @@ options:
adds, layer 3 topology fpr IPv4 (CMK 2.3.0 only)
-u USER_DATA_FILE, --user-data-file USER_DATA_FILE
Set the name uf the user provided data file
Default is ~/local/bin/nvdct/nvdct.toml
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.
......@@ -182,7 +179,6 @@ Exit codes:
Usage:
~/local/bin/nvdct/nvdct.py -s Core01 Core02 -d
OMD[build]:~$
```
......@@ -269,12 +265,12 @@ will only delete a topology if it is 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/nvdct/nvdct.toml` file. Or provide your own data file (see Option -u, --user-data-file)
Yes. You can customize the topology data creation by modifying the `~/local/bin/nvdct/conf/nvdct.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/)
```
~/local/bin/topology_data/nvdct.py -u ~/local/bin/topology_data/my.toml
~/local/bin/nvdct/nvdct.py -u ~/local/bin/nvdct/conf/my.toml
```
</details>
......@@ -369,7 +365,7 @@ First check your HW/SW inventory if it not contains the data needed to create th
Sample output of NVDCT.
```
OMD[build]:~$ ~/local/bin/nvdct/nvdct.py -u ~/local/bin/nvdct/nvdct.toml
OMD[build]:~$ ~/local/bin/nvdct/nvdct.py -u ~/local/bin/nvdct/conf/my.toml
Network Visualisation Data Creation Tool (NVDCT)
by thl-cmk[at]outlook[dot]com, version 0.8.7-20240430
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment