This commit was generated by cvs2svn to compensate for changes in r12472,
[freeside.git] / torrus / xmlconfig / old / rfc2670.docsis-if.old.1.0.4.xml
1 <?xml version="1.0"?>
2 <!--
3    Copyright (C) 2003  Roman Hochuli, Stanislav Sinyagin
4
5    This program is free software; you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation; either version 2 of the License, or
8    (at your option) any later version.
9
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software
17    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
18
19   $Id: rfc2670.docsis-if.old.1.0.4.xml,v 1.1 2010-12-27 00:04:27 ivan Exp $
20   Roman Hochuli <roman@hochu.li>
21   Stanislav Sinyagin <ssinyagin@yahoo.com>
22
23   SEE ALSO: xmlconfig/examples/docsis-monitors.xml
24   
25 -->
26
27 <configuration>
28
29 <definitions>
30   <!-- DOCS-IF-MIB::docsIfSignalQualityTable -->
31   <def name="docsIfSigQUnerroreds"      value="1.3.6.1.2.1.10.127.1.1.4.1.2"/>
32   <def name="docsIfSigQCorrecteds"      value="1.3.6.1.2.1.10.127.1.1.4.1.3"/>
33   <def name="docsIfSigQUncorrectables"  value="1.3.6.1.2.1.10.127.1.1.4.1.4"/>
34   <def name="docsIfSigQSignalNoise"     value="1.3.6.1.2.1.10.127.1.1.4.1.5"/>
35   
36   <!-- DOCS-IF-MIB::docsIfCmtsDownChannelCounterTable -->
37   <def name="docsIfCmtsDownChnlCtrExtTotalBytes"
38                                 value="1.3.6.1.2.1.10.127.1.3.10.1.4"/>
39   <def name="docsIfCmtsDownChnlCtrExtUsedBytes"
40                                 value="1.3.6.1.2.1.10.127.1.3.10.1.5"/>
41 </definitions>
42
43 <datasources>
44
45   <template name="docsis-upstream-subtree">
46     <param name="precedence"           value="-500" />
47     <param name="comment"        value="DOCSIS upstream channel statistics" />
48     <param name="data-file">
49        %system-id%_%interface-nick%_docsis_upstream.rrd
50     </param>
51     <param name="collector-timeoffset-hashstring"
52                                        value="%system-id%:%interface-nick%" />
53     <param name="descriptive-nickname" value="%system-id%:%interface-name%"/>
54     <param name="graph-title"          value="%descriptive-nickname%" />
55
56     <param name="has-overview-shortcuts" value="yes"/>
57     <param name="overview-shortcuts" value="snr,fec"/>
58     
59     <param name="overview-subleave-name-snr" value="SNR"/>
60     <param name="overview-direct-link-snr"      value="yes"/>
61     <param name="overview-direct-link-view-snr" value="expanded-dir-html"/>
62     <param name="overview-shortcut-text-snr"
63            value="All SNR"/>
64     <param name="overview-shortcut-title-snr"
65            value="Show signal quality graphs for all upstreams in one page"/>
66     <param name="overview-page-title-snr"
67            value="SNR Graphs"/>
68
69     <param name="overview-subleave-name-fec" value="FEC_Summary"/>
70     <param name="overview-direct-link-fec"      value="yes"/>
71     <param name="overview-direct-link-view-fec" value="expanded-dir-html"/>
72     <param name="overview-shortcut-text-fec"
73            value="All FEC"/>
74     <param name="overview-shortcut-title-fec"
75            value="Show FEC statistics for all upstreams in one page"/>
76     <param name="overview-page-title-fec"
77            value="FEC Graphs"/>
78                       
79     <param name="rrd-hwpredict"     value="disabled" />
80   </template>
81   
82   <template name="docsis-signal-quality-codewords">
83     <param name="rrd-create-dstype"   value="COUNTER" />
84     <param name="vertical-label"      value="Codewords/s" />
85     <param name="graph-lower-limit"   value="0" />
86   </template>
87
88   <template name="docsis-upstream-signal-quality">
89     <leaf name="SNR">
90       <param name="snmp-object"  value="$docsIfSigQSignalNoise.%ifindex-map%"/>
91
92       <param name="rrd-create-dstype"   value="GAUGE" />
93       <param name="rrd-ds"              value="SNR" />
94       <param name="collector-scale"     value="10,/" />
95
96       <param name="comment"             value="Signal/Noise Ratio" />
97       <param name="graph-legend"        value="Signal/Noise Ratio" />
98       <param name="vertical-label"      value="dB" />
99
100       <param name="normal-level"        value="25" />
101       <param name="lower-limit"         value="18" />
102       <param name="graph-lower-limit"   value="10" />
103       <param name="graph-upper-limit"   value="30" />
104
105       <param name="precedence"          value="1000" />
106
107       <!-- This monitor may be redefined by
108            DocsisUpSNRMonitor selector action -->
109       <param name="monitor"             value="docsis-snr-lower-20db" />
110     </leaf>
111
112     <leaf name="FEC_Summary">
113       <param name="ds-type"           value="rrd-multigraph" />
114       <param name="ds-names"          value="corr,uncorr" />
115
116       <param name="graph-lower-limit"       value="0.01" />
117       <param name="graph-upper-limit"       value="100" />
118       <param name="graph-logarithmic"       value="yes" />
119       <param name="graph-rigid-boundaries"  value="yes" />
120       
121       <param name="precedence"        value="950" />
122       <param name="comment"
123               value="Reed-Solomon forward error correction (FEC) summary" />
124       <param name="vertical-label"    value="Percent" />
125
126       <param name="ds-expr-corr">
127       {Correctable},{Error-Free},{Correctable},{Uncorrectable},+,+,/,100,*
128       </param>
129       <param name="graph-legend-corr"  value="Correctable Codewords" />
130       <param name="line-style-corr"      value="##SingleGraph" />
131       <param name="line-color-corr"      value="##green" />
132       <param name="line-order-corr"      value="1" />
133
134       <param name="ds-expr-uncorr">
135       {Uncorrectable},{Error-Free},{Correctable},{Uncorrectable},+,+,/,100,*
136       </param>
137       <param name="graph-legend-uncorr"  value="Uncorrectable Codewords" />
138       <param name="line-style-uncorr"    value="##SingleGraph" />
139       <param name="line-color-uncorr"    value="##red" />
140       <param name="line-order-uncorr"    value="2" />
141     </leaf>
142
143     <leaf name="Error-Free">
144       <apply-template name="docsis-signal-quality-codewords"/>
145       <param name="snmp-object"  value="$docsIfSigQUnerroreds.%ifindex-map%"/>
146       <param name="rrd-ds"       value="Unerroreds" />
147       <param name="hidden"       value="yes"/>
148       <param name="comment"
149           value="FEC codewords received on this channel without error"/>
150       <param name="graph-legend" value="Error-free Codewords" />
151       <param name="precedence"   value="900" />
152       <param name="graph-lower-limit"       value="0.01" />
153       <param name="graph-upper-limit"       value="100" />
154       <param name="graph-logarithmic"       value="yes" />
155       <param name="graph-rigid-boundaries"  value="yes" />
156     </leaf>
157
158     <leaf name="Correctable">
159       <apply-template name="docsis-signal-quality-codewords"/>
160       <param name="snmp-object"  value="$docsIfSigQCorrecteds.%ifindex-map%"/>
161       <param name="rrd-ds"       value="Correcteds" />
162       <param name="hidden"       value="yes"/>
163       <param name="comment"
164           value="FEC codewords received on this channel correctable errors"/>
165       <param name="graph-legend" value="Correctable Codewords" />
166       <param name="precedence"   value="800" />
167       <param name="monitor-action-target"  value="FEC_Summary"/>
168       <param name="graph-lower-limit"       value="0.01" />
169       <param name="graph-upper-limit"       value="100" />
170       <param name="graph-logarithmic"       value="yes" />
171       <param name="graph-rigid-boundaries"  value="yes" />
172     </leaf>
173
174     <leaf name="Uncorrectable">
175       <apply-template name="docsis-signal-quality-codewords"/>
176       <param name="snmp-object"
177                         value="$docsIfSigQUncorrectables.%ifindex-map%"/>
178       <param name="rrd-ds"       value="Uncorrectables" />
179       <param name="hidden"       value="yes"/>
180       <param name="comment"
181           value="FEC codewords received on this channel uncorrectable errors"/>
182       <param name="graph-legend" value="Uncorrectable Codewords" />
183       <param name="precedence"   value="700" />
184       <param name="monitor-action-target"  value="FEC_Summary"/>
185       <param name="graph-lower-limit"       value="0.01" />
186       <param name="graph-upper-limit"       value="100" />
187       <param name="graph-logarithmic"       value="yes" />
188       <param name="graph-rigid-boundaries"  value="yes" />
189     </leaf>
190   </template>
191
192
193
194   <template name="docsis-downstream-subtree">
195     <param name="precedence"           value="-500" />
196     <param name="comment"        value="DOCSIS downstream statistics" />
197     <param name="data-file">
198        %system-id%_%interface-nick%_docsis_downstream.rrd
199     </param>
200     <param name="collector-timeoffset-hashstring"
201                                        value="%system-id%:%interface-nick%" />
202     <param name="descriptive-nickname" value="%system-id%:%interface-name%"/>
203     <param name="graph-title"          value="%descriptive-nickname%" />
204
205     <param name="has-overview-shortcuts" value="yes"/>
206     <param name="overview-shortcuts" value="util"/>
207     <param name="overview-subleave-name-util" value="Utilization"/>
208     <param name="overview-direct-link-util"      value="yes"/>
209     <param name="overview-direct-link-view-util" value="expanded-dir-html"/>
210     <param name="overview-shortcut-text-util"
211            value="All Utilization"/>
212     <param name="overview-shortcut-title-util"
213            value="Show utilization graphs for all downstreams in one page"/>
214     <param name="overview-page-title-util"
215            value="Downstream Utilization Graphs"/>
216     <param name="rrd-hwpredict"     value="disabled" />
217   </template>
218
219   
220   <template name="docsis-downstream-util">  
221     <leaf name="Utilization">
222       <param name="ds-type"           value="rrd-multigraph" />
223       <param name="ds-names"          value="util" />
224       <param name="graph-lower-limit"  value="0" />
225       <param name="graph-upper-limit"  value="100" />
226
227       <param name="precedence"        value="950" />
228       <param name="comment"
229               value="Downstream channel utilization" />
230       <param name="vertical-label"    value="Percent" />
231
232       <param name="ds-expr-util">
233         {UsedBytes},{TotalBytes},/,100,*
234       </param>
235       <param name="graph-legend-util"  value="Utilization" />
236       <param name="line-style-util"      value="##resourceusage" />
237       <param name="line-color-util"      value="##resourceusage" />
238       <param name="line-order-util"      value="1" />
239     </leaf>
240     
241     <leaf name="TotalBytes">
242       <param name="rrd-create-dstype"   value="COUNTER" />
243       <param name="snmp-object-type"    value="COUNTER64" />
244       <param name="vertical-label"      value="Bytes/s" />
245       <param name="graph-lower-limit"   value="0" />
246       <param name="snmp-object"
247                value="$docsIfCmtsDownChnlCtrExtTotalBytes.%ifindex-map%"/>
248       <param name="rrd-ds"       value="TotalBytes" />
249       <param name="hidden"       value="yes"/>
250       <param name="comment">
251         The total number of bytes in the Payload portion
252       </param>
253       <param name="graph-legend" value="Total Bytes" />
254       <param name="precedence"   value="800" />
255     </leaf>
256     
257     <leaf name="UsedBytes">
258       <param name="rrd-create-dstype"   value="COUNTER" />
259       <param name="snmp-object-type"    value="COUNTER64" />
260       <param name="vertical-label"      value="Bytes/s" />
261       <param name="graph-lower-limit"   value="0" />
262       <param name="snmp-object"
263                value="$docsIfCmtsDownChnlCtrExtUsedBytes.%ifindex-map%"/>
264       <param name="rrd-ds"       value="UsedBytes" />
265       <param name="hidden"       value="yes"/>
266       <param name="comment">
267        The total number of DOCSIS data bytes transported by this downstream
268        channel
269       </param>
270       <param name="graph-legend" value="Used Bytes" />
271       <param name="precedence"   value="800" />
272       <param name="monitor-action-target"  value="Utilization"/>
273     </leaf>  
274   </template>  
275   
276 </datasources>
277
278 <monitors>
279
280     <monitor name="docsis-snr-lower-20db">
281       <param name="monitor-type"  value="expression" />
282       <param name="rpn-expr"      value="DUP,0,GT,EXC,20,LT,AND" />
283       <param name="action"        value="docsis-snr-lower-20" />
284       <param name="expires"       value="3600" />
285       <param name="comment">
286         Signal/Noise-Ratio was lower than 20dB
287       </param>
288     </monitor>
289
290     <action name="docsis-snr-lower-20">
291       <param name="action-type"     value="tset" />
292       <param name="tset-name"       value="docsis-snr-lower-20" />
293     </action>
294
295 </monitors>
296
297 <token-sets>
298     <token-set name="docsis-snr-lower-20">
299       <param name="comment" value="S/N Ratio less than 20dB" />
300     </token-set>
301 </token-sets>
302
303 </configuration>