.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "TORRUS_DEVDISCOVER 8" .TH TORRUS_DEVDISCOVER 8 "2018-08-11" "torrus 3.00" "torrus" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" devdiscover \- Performs SNMP discovery and generates Torrus XML configuration file. .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBtorrus devdiscover\fR [\-\-in=\fI\s-1XMLFILE\s0\fR] [\fIoptions...\fR] [\fI\s-1XMLFILES\s0\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBdevdiscover\fR performs \s-1SNMP\s0 discovery using the \fI\s-1XMLFILE\s0\fR for the discovery instructions. It generates a corresponding Torrus \s-1XML\s0 configuration file. See \fBTorrus \s-1SNMP\s0 Discovery User Guide\fR for details. .PP The generic input file, or device discovery \s-1XML\s0 (\s-1DDX\s0), may be generated by the \fBgenddx\fR utility, and then edited and maintained manually. Multiple input files may be specified by several instances of \fI\-\-in\fR option, or simply as arguments. .PP Input file name is searched in the current directory, and then in \&\fI/etc/torrus/discovery/\fR. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-\-mkdir\fR" 4 .IX Item "--mkdir" Creates \f(CW\*(C`data\-dir\*(C'\fR directories. .IP "\fB\-\-limit\fR=\fI\s-1REGEXP\s0\fR" 4 .IX Item "--limit=REGEXP" Limits the discovery to the output files matching the regular expression \&\fI\s-1REGEXP\s0\fR. If multiple \fB\-\-limit\fR options are given, the output file must match at least one of them to be processed. Bundle files will be written if all their member \s-1XML\s0 files are available. .IP "\fB\-\-forcebundle\fR" 4 .IX Item "--forcebundle" With this option enabled, \f(CW\*(C`devdiscover\*(C'\fR will write the bundle file even if some of the bundle members were not created because of errors. .IP "\fB\-\-fallback\fR=\fI\s-1INTEGER\s0\fR" 4 .IX Item "--fallback=INTEGER" Requires \fB\-\-forcebundle\fR. In case if an \s-1SNMP\s0 device is not available, the bundle file will include an older version of the \s-1XML\s0 output file, provided that it exists and it is not older than the specified number of days. .IP "\fB\-\-threads\fR=\fI\s-1INTEGER\s0\fR" 4 .IX Item "--threads=INTEGER" If the threads are enabled in the local Perl, this option determines how many parallel discovery threads are to be executed. The discovery jobs are distributed per output files, thus it makes sence to use threads only when there are many output files defined in a single \s-1DDX\s0 file. .IP "\fB\-\-verbose\fR" 4 .IX Item "--verbose" Prints extra information. .IP "\fB\-\-debug\fR" 4 .IX Item "--debug" Prints debugging information. .IP "\fB\-\-snmpdebug\fR" 4 .IX Item "--snmpdebug" Prints \s-1SNMP\s0 protocol details .SH "FILES" .IX Header "FILES" .IP "\fI/etc/torrus/conf/devdiscover\-siteconfig.pl\fR" 4 .IX Item "/etc/torrus/conf/devdiscover-siteconfig.pl" \&\fBdevdiscover\fR site configuration file. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fItorrus\fR\|(8), torrus_genddx(8) .SH "NOTES" .IX Header "NOTES" See \fITorrus \s-1SNMP\s0 Discovery User Guide\fR for more details at Torrus home page: http://torrus.org .SH "AUTHOR" .IX Header "AUTHOR" Stanislav Sinyagin