.\" 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_TTPROCLIST 8"
.TH TORRUS_TTPROCLIST 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"
ttproclist \- Process a template with a nodelist
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBtorrus ttproclist\fR \-\-tmpl=\fI\s-1TFILE\s0\fR \-\-out=\fI\s-1OFILE\s0\fR
\&\-\-nodes=\fI\s-1NFILE\s0\fR [\fIoptions...\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This command takes a Template-Toolkit template and a list of nodes
(usually \s-1SNMP\s0 devices) as input. The output file is a result of
template substitution, according to the specified options.
Command-line options \fB\-\-tmpl\fR, \fB\-\-out\fR and \fB\-\-nodes\fR are mandatory.
.PP
This utility can be used to generate the discovery instructions \s-1XML\s0 out of
a predefined template and a dynamically generated list of devices.
Alternatively, it can produce Torrus \s-1XML\s0 configuration for a given list
of objects, etc.
.PP
The following variables are predefined when the template is processed:
.IP "\(bu" 4
\&\f(CW\*(C`nodes\*(C'\fR
.Sp
Hash array of nodes. Hash keys are the node names. Values are symbolic
names. If symbolic names are not defined, values are the same as keys.
.IP "\(bu" 4
\&\f(CW\*(C`param\*(C'\fR
.Sp
Hash array of command-line parameters given in \fB\-\-param\fR option.
.IP "\(bu" 4
\&\f(CW\*(C`nodesfile\*(C'\fR, \f(CW\*(C`creator\*(C'\fR
.Sp
Informative variables. They can be used to produce the creation
note in the resulting files. \f(CW\*(C`nodesfile\*(C'\fR returns the file name of nodes,
and \f(CW\*(C`creator\*(C'\fR returns a detailed information how the file was generated,
with timestamp and command line options.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-\-tmpl\fR=\fI\s-1TFILE\s0\fR" 4
.IX Item "--tmpl=TFILE"
The file name of the input template. Relative names are looked in
the current directory and in \fI/etc/torrus/templates\fR. The file name may also be
an absolute path.
.IP "\fB\-\-out\fR=\fI\s-1OFILE\s0\fR" 4
.IX Item "--out=OFILE"
Output file name. If no absolute path given, the file is written in the current
directory.
.IP "\fB\-\-nodes\fR=\fI\s-1NFILE\s0\fR" 4
.IX Item "--nodes=NFILE"
The name of the nodes list. Nodes should be separated by space or tab
character or newline. Additional information, referred to as symbolic name,
can be supplied after a colon, of the form \s-1NODENAME:SYMBOLICNAME.\s0
.IP "\fB\-\-param\fR=\fI\s-1NAME:VALUE,NAME:VALUE...\s0\fR" 4
.IX Item "--param=NAME:VALUE,NAME:VALUE..."
List of optional parameters that may be used in the template.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
The following example gerenates \f(CW\*(C`devdiscover\*(C'\fR input file from a template.
The template is as follows:
.PP
.Vb 10
\&
\&
\& >>> usual DDX parameters here, like SNMP community and data\-dir
\&
\& >> This loop generates per\-host entries
\& [% FOREACH n = nodes.keys.sort %]
\&
\&
\&
\&
\&
\& [% END %]
\& >>> Generate the bundle file, so that you need only one
\& >>> entry in torrus\-site\-config.pl
\&
\&
.Ve
.PP
The following command would generate \fI\s-1MY\s0.ddx\fR from template file \fI\s-1MY\s0.ddtmpl\fR
as described above. The file \fI\s-1MY\s0.nodes\fR is a list of \s-1SNMP\s0 devices, one per
line. Then \f(CW\*(C`devdiscover\*(C'\fR is launched with \fI\s-1MY\s0.ddx\fR as input. Note also the
short form of the command line wrapper.
.PP
.Vb 4
\& torrus ttproclist \-\-tmpl=MY.ddtmpl \e
\& \-\-nodes=MY.nodes \e
\& \-\-out=/usr/local/etc/torrus/discovery/MY.ddx \e
\& \-\-param=BUNDLE:MYNODES
\&
\& torrus dd \-\-in=MY.ddx \-\-verbose
.Ve
.PP
In addition, you may put some common parameters in Template \s-1BLOCK\s0
statement in a separate file, and \s-1INCLUDE\s0 it in your templates. See the
Template-Toolkit documentation for more detail.
.SH "NOTES"
.IX Header "NOTES"
See more documentation at Torrus home page: http://torrus.org
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Template-Toolkit documentation: http://template\-toolkit.org/
.PP
\&\fItorrus\fR\|(8), \fItorrus_devdiscover\fR\|(8)
.SH "AUTHOR"
.IX Header "AUTHOR"
Stanislav Sinyagin