TORRUS_DEVDISCOVER(8)

πŸ“¦
version 3.00 Β· 3 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu questing

πŸ’– TORRUS_DEVDISCOVER πŸ’–

okay bestie, welcome to devdiscover β€” it's one of the torrus family (that's the manual, section 8, system admin girlies 🫢) and it's literally the SNMP discovery bestie you never knew you needed.


✨ NAME ✨

devdiscover β€” does SNMP discovery and then generates a Torrus XML configuration file. no cap, that's the whole job. πŸ’…


🌸 SYNOPSIS 🌸

torrus devdiscover [--in=XMLFILE] [options...] [XMLFILES]

πŸ¦‹ DESCRIPTION πŸ¦‹

So here's the tea: devdiscover does SNMP discovery using XMLFILE for the discovery instructions, and then it spits out a matching Torrus XML configuration file. that's it, that's the vibe. ✨ for the full lore, go read the Torrus SNMP Discovery User Guide.

The generic input file β€” also known as the device discovery XML, or DDX if you're on nickname terms β€” can be generated by the genddx utility, and then edited and maintained by hand, like a little craft project πŸŽ€. You can pass multiple input files by giving several instances of the --in option, or honestly just throw them in as plain arguments. both work, we don't gatekeep.

When it's looking for an input file name, it checks the current directory first, and then it checks /etc/torrus/discovery/. in that order. periodt.


πŸ‘‘ OPTIONS πŸ‘‘

  • --mkdir β€” creates "data-dir" directories. yes queen, make the folders. πŸ“
  • --limit=REGEXP β€” limits the discovery to only the output files that match the regular expression REGEXP. if you give multiple --limit options, an output file only needs to match at least one of them to get processed (so it's an OR situation, not an AND situation, bestie πŸ’œ). bundle files get written if all of their member XML files are available.
  • --forcebundle β€” turn this on and "devdiscover" will write the bundle file even if some of the bundle members weren't created because of errors. chaotic but valid. πŸ”₯
  • --fallback=INTEGER β€” heads up, this one requires --forcebundle. if an SNMP device isn't available, the bundle file will include an older version of the XML output file β€” but only if that file exists and it's not older than the specified number of days. so INTEGER = how many days back you're willing to accept. ⭐
  • --threads=INTEGER β€” if threads are enabled in your local Perl, this decides how many parallel discovery threads get executed. the discovery jobs are distributed per output file, so it only really makes sense to use threads when there are many output files defined in a single DDX file. one DDX, lots of files, that's the moment. 🌈
  • --verbose β€” prints extra information. more words, more better. πŸ“
  • --debug β€” prints debugging information. for when you need to know why, not just what. 😭
  • --snmpdebug β€” prints SNMP protocol details

πŸŽ€ FILES πŸŽ€

  • /etc/torrus/conf/devdiscover-siteconfig.pl β€” the devdiscover site configuration file. that's where the site-level settings live. πŸ’–

πŸ’œ SEE ALSO πŸ’œ


🧚 NOTES 🧚

for more details, see the Torrus SNMP Discovery User Guide over at the Torrus home page: http://torrus.org β€” go read it, iykyk. 🌸

⭐ AUTHOR ⭐

Stanislav Sinyagin <ssinyagin@k-open.com> β€” the icon, the legend, the moment. πŸ‘‘


and that's the whole page, bestie!! this is torrus 3.00, dated 2023-05-02 β€” mwah, slay, go discover some SNMP πŸ’…βœ¨πŸ¦‹

πŸ“¦ where this page comes from