TORRUS_GENDDX(8)

💖 TORRUS_GENDDX(8) 💖

okay bestie, gather round, because this is the page for torrus genddx — the section 8 manual for the torrus genddx command. yes it's giving sysadmin, yes it's giving SNMP, and yes we're gonna make it make sense. no cap. 🦋

---

✨ NAME ✨

genddx — generates the SNMP discovery instructions file for devdiscover

---

🌸 SYNOPSIS 🌸

torrus genddx --host=HOSTNAME | --hostfile=HOSTFILENAME \ [options...]

---

💅 DESCRIPTION 💅

so genddx generates the SNMP discovery instructions file, right? and that file can later be used as input for the devdiscover utility, which then produces the corresponding Torrus XML configuration file. it's giving pipeline. it's giving workflow. 🔥

you gotta tell it which router(s) to include in the SNMP discovery, and you do that with either:

• --host — for a single router
• --hostfile — for a whole list of them

if you go the --hostfile route, the file HOSTFILENAME must contain a space-separated list of router hostnames. and plot twist: hostnames may have the form "host:devname" where "devname" is a symbolic device name. 💖

ngl this utility is designed to be used only once, to generate the discovery XML canvas for further manual editing. it generates only a basic set of parameters, and there are so many more of those that you may use to customize the discovery process. it's a starter pack, not the whole closet. 🎀

if you want something more flexible and complex, go look at torrus_ttproclist(8) for a more flexible and complex DDX generator. main character energy, honestly.

more info lives in the Torrus SNMP Discovery User Guide. iykyk. ✨

---

🎀 OPTIONS 🎀

• --out=OUTFILENAME — sets the output file to OUTFILENAME. default is routers.ddx. without an absolute path, the file will be placed in /etc/torrus/discovery. 💅
• --discout=FILENAME — sets the discovery output file to FILENAME. this will be the filename of the Torrus XML configuration file once the output file of genddx is processed by the devdiscover utility. default value is routers.xml. without an absolute path, the file would be resided in /etc/torrus/xmlconfig.
• --domain=DOMAIN — sets the DNS domain name to DOMAIN. 🌐
• --version=SNMPVERSION — sets discovery SNMP version to SNMPVERSION. default value is "2c".
• --community=COMMUNITY — sets discovery SNMP read community value to string COMMUNITY. default is "public".
• --port=PORT — sets SNMP port to PORT. default is 161.
• --retries=NUMRETRIES — sets number of retries to NUMRETRIES. default value is 2.
• --timeout=TIMEOUT — sets SNMP timeout to TIMEOUT seconds. default value is 10.
• --subtree=SUBTREE — sets the subtree name to SUBTREE. default is "/Routers". 🌲
• --datadir=DATADIR — sets the path of the directory where SNMP data is collected to DATADIR. default value is /var/lib/torrus/collector_rrd.
• --holtwinters — enables Holt-Winters analysis. 📈

---

🦋 FILES 🦋

• /etc/torrus/discovery/routers.ddx — the default output file of genddx. 💖
• /etc/torrus/xmlconfig/routers.xml — the default Torrus XML configuration file which will be written once the genddx output file is processed with the devdiscover utility.

---

🌈 SEE ALSO 🌈

torrus(8), torrus_devdiscover(8), torrus_ttproclist(8)

---

💜 NOTES 💜

see more documentation at Torrus home page: http://torrus.org ✨

---

👑 AUTHOR 👑

Stanislav Sinyagin <ssinyagin@k-open.com>

---

and that's the whole page, bestie!! 💖✨🎀 this was torrus 3.00, dated 2023-05-02, and it's the TORRUS_GENDDX(8) manual — so go forth, discover some SNMP, and slay. periodt. 💅🫶