.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" 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 turned on, 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 .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" 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_GENDDX 8" .TH TORRUS_GENDDX 8 "2015-07-14" "torrus 2.08" "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" genddx \- Generates SNMP discovery instructions file for devdiscover .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBtorrus genddx\fR \-\-host=\fI\s-1HOSTNAME\s0\fR | \-\-hostfile=\fI\s-1HOSTFILENAME\s0\fR \e [\fIoptions...\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBgenddx\fR generates the \s-1SNMP\s0 discovery instructions file, which may be later used as input for the \fBdevdiscover\fR utility to produce the corresponding Torrus \s-1XML\s0 configuration file. The hostname(s) of router(s) to be included in \s-1SNMP\s0 discovery must be specified either using the \&\fB\-\-host\fR (for a single router) or \fB\-\-hostfile\fR option. In the latter case the file \fI\s-1HOSTFILENAME\s0\fR must contain a space-separated list of router hostnames. Hostnames may have the form \f(CW\*(C`host:devname\*(C'\fR where \f(CW\*(C`devname\*(C'\fR is a symbolic device name. .PP This utility is designed to be used only once, in order to generate the discovery \s-1XML\s0 canvas, for futher manual editing. It generates only basic set of parameters, and there are much more of those that you may use to customize the discovery process. .PP See \fItorrus_ttproclist\fR\|(8) for a more flexible and complex \s-1DDX\s0 generator. .PP More information is available in \fBTorrus \s-1SNMP\s0 Discovery User Guide\fR. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-\-out\fR=\fI\s-1OUTFILENAME\s0\fR" 4 .IX Item "--out=OUTFILENAME" Sets the output file to \fI\s-1OUTFILENAME\s0\fR. Default is \fIrouters.ddx\fR. Without absolute path, the file will be placed in \fI/etc/torrus/discovery\fR. .IP "\fB\-\-discout\fR=\fI\s-1FILENAME\s0\fR" 4 .IX Item "--discout=FILENAME" Sets the discovery output file to \fI\s-1FILENAME\s0\fR. This will be the filename of the Torrus \s-1XML\s0 configuration file once the output file of the \fBgenddx\fR is processed by the \fBdevdiscover\fR utility. Default value is \&\fIrouters.xml\fR. Without absolute path, the file would be resided in \&\fI/etc/torrus/xmlconfig\fR. .IP "\fB\-\-domain\fR=\fI\s-1DOMAIN\s0\fR" 4 .IX Item "--domain=DOMAIN" Sets the \s-1DNS\s0 domain name to \fI\s-1DOMAIN\s0\fR. .IP "\fB\-\-version\fR=\fI\s-1SNMPVERSION\s0\fR" 4 .IX Item "--version=SNMPVERSION" Sets discovery \s-1SNMP\s0 version to \s-1SNMPVERSION.\s0 Default value is \f(CW\*(C`2c\*(C'\fR. .IP "\fB\-\-community\fR=\fI\s-1COMMUNITY\s0\fR" 4 .IX Item "--community=COMMUNITY" Sets discovery \s-1SNMP\s0 read community value to string \fI\s-1COMMUNITY\s0\fR. Default is \f(CW\*(C`public\*(C'\fR. .IP "\fB\-\-port\fR=\fI\s-1PORT\s0\fR" 4 .IX Item "--port=PORT" Sets \s-1SNMP\s0 port to \fI\s-1PORT\s0\fR. Default is 161. .IP "\fB\-\-retries\fR=\fI\s-1NUMRETRIES\s0\fR" 4 .IX Item "--retries=NUMRETRIES" Sets number of retries to \fI\s-1NUMRETRIES\s0\fR. Default value is 2. .IP "\fB\-\-timeout\fR=\fI\s-1TIMEOUT\s0\fR" 4 .IX Item "--timeout=TIMEOUT" Sets \s-1SNMP\s0 timeout to \fI\s-1TIMEOUT\s0\fR seconds. Default value is 10. .IP "\fB\-\-subtree\fR=\fI\s-1SUBTREE\s0\fR" 4 .IX Item "--subtree=SUBTREE" Sets the subtree name to \fI\s-1SUBTREE\s0\fR. Default is \f(CW\*(C`/Routers\*(C'\fR. .IP "\fB\-\-datadir\fR=\fI\s-1DATADIR\s0\fR" 4 .IX Item "--datadir=DATADIR" Sets the path of the directory where \s-1SNMP\s0 data is collected to \fI\s-1DATADIR\s0\fR. Default value is \fI/var/lib/torrus/collector_rrd\fR. .IP "\fB\-\-holtwinters\fR" 4 .IX Item "--holtwinters" Enables Holt-Winters analysis. .SH "FILES" .IX Header "FILES" .IP "\fI/etc/torrus/discovery/routers.ddx\fR" 4 .IX Item "/etc/torrus/discovery/routers.ddx" Default output file of genddx. .IP "\fI/etc/torrus/xmlconfig/routers.xml\fR" 4 .IX Item "/etc/torrus/xmlconfig/routers.xml" Default Torrus \s-1XML\s0 configuration file which will be written once the genddx output file is processed with devdiscover utility. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fItorrus\fR\|(8), \fItorrus_devdiscover\fR\|(8), \&\fItorrus_ttproclist\fR\|(8) .SH "NOTES" .IX Header "NOTES" See more documentation at Torrus home page: http://torrus.org .SH "AUTHOR" .IX Header "AUTHOR" Stanislav Sinyagin