.\" 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_CONFIGSNAPSHOT 8" .TH TORRUS_CONFIGSNAPSHOT 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" configsnapshot \- Generates a configuration snapshot for a Torrus tree. .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBtorrus configsnapshot\fR \-\-tree=\fI\s-1TREENAME\s0\fR [\fIoptions...\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" This command generates a configuration snapshot from current datasources for tree \fI\s-1TREENAME\s0\fR. The output is an \s-1XML\s0 file, ready for compilation, representing all datasources, monitors and tokensets of a given tree. The snapshot does not include view definitions. Templates and file patterns are expanded inside the file. It does not require any other \s-1XML\s0 configuration files, except for \fIdefaults.xml\fR and your custom view definitions. .PP \&\fBWarning:\fR \f(CW\*(C`configsnapshot\*(C'\fR from \s-1RRFW\s0 release 0.1.5 will not work correctly with databases from previous releases. Use \s-1RRFW\s0 release \&\f(CW\*(C`0.1.4bf2\*(C'\fR instead. \f(CW\*(C`configsnapshot\*(C'\fR utility from \s-1RRFW\s0 release 0.1.4bf2 does not preserve aliases. .PP This utility is useful in Torrus upgrade process. In case when \s-1RRD\s0 files structure is changing in Torrus default templates, and user(s) demand to preserve the historical data, the following steps could be done: .IP "\(bu" 4 Stop the collector and monitor processes. .IP "\(bu" 4 Install newest Torrus software and do not run \f(CW\*(C`compilexml\*(C'\fR immediately. .IP "\(bu" 4 Create snapshots of the trees that you want to preserve for historical reasons: .Sp .Vb 2 \& torrus configsnapshot \-\-tree=myrouters \e \& \-\-out=/etc/torrus/xmlconfig/myrouters\-snapshot.xml .Ve .IP "\(bu" 4 If needed, move the existing \s-1RRD\s0 files into different directory. Then change the \f(CW\*(C`data\-dir\*(C'\fR parameters in the snapshot \s-1XML\s0 accordingly. .IP "\(bu" 4 Create a new tree with only the snapshot file in it. Compile the tree. .IP "\(bu" 4 At this stage, it is up to the user to decide wether to continue running the collector and monitor daemons for this new tree. The old data may be preserved for historical reference, and collector may be run with the newest tree structure and definitions. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-\-tree\fR=\fI\s-1TREE\s0\fR" 4 .IX Item "--tree=TREE" Mandatory parameter specifying the tree name. .IP "\fB\-\-out\fR=\fI\s-1FILE\s0\fR" 4 .IX Item "--out=FILE" Sets the output file to \fI\s-1FILE\s0\fR. Default is \fIsnapshot.xml\fR. .IP "\fB\-\-param\fR=\fI\s-1PARAM\s0\fR \fB\-\-value\fR=\fI\s-1VALUE\s0\fR" 4 .IX Item "--param=PARAM --value=VALUE" Sets the filter on datasource leaves that have to be included in the snapshot. \&\fI\s-1PARAM\s0\fR specifies the name of the datasource parameter, and \fI\s-1VALUE\s0\fR sets the matching value. By default the numeric comparison is performed. .IP "\fB\-\-op\fR=\fI\s-1OPERATOR\s0\fR" 4 .IX Item "--op=OPERATOR" Sets the fiter comparison operator. Accepted values: \fB=\fR (numeric), \&\fBeq\fR (text string comparison), and \fBre\fR (regular expression match). Default is numeric comparison. .IP "\fB\-\-verbose\fR" 4 .IX Item "--verbose" Displays some extra information. .IP "\fB\-\-help\fR" 4 .IX Item "--help" Displays a help message. .SH "FILES" .IX Header "FILES" .IP "\fI/usr/share/torrus/xmlconfig/defaults.xml\fR" 4 .IX Item "/usr/share/torrus/xmlconfig/defaults.xml" \&\s-1XML\s0 configuration file with default settings for the datasources and tokensets, as well as default view definitions. .IP "\fIsnapshot.xml\fR" 4 .IX Item "snapshot.xml" Default \fBconfigsnapshot\fR output file. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fItorrus\fR\|(8), \fItorrus_compilexml\fR\|(8) .SH "NOTES" .IX Header "NOTES" See more documentation at Torrus home page: http://torrus.org .SH "AUTHOR" .IX Header "AUTHOR" Stanislav Sinyagin