torrus/xmlconfig/generic/rfc2670.docsis-if.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.xml,v 1.1 2010-12-27 00:04:30 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::docsIfUpstreamChannelTable -->
  37   <def name="docsIfUpChannelFrequency"  value="1.3.6.1.2.1.10.127.1.1.2.1.2"/>
  38
  39   <!-- DOCS-IF-MIB::docsIfCmtsDownChannelCounterTable -->
  40   <def name="docsIfCmtsDownChnlCtrExtTotalBytes"
  41                                 value="1.3.6.1.2.1.10.127.1.3.10.1.4"/>
  42   <def name="docsIfCmtsDownChnlCtrExtUsedBytes"
  43                                 value="1.3.6.1.2.1.10.127.1.3.10.1.5"/>
  44 </definitions>
  45
  46 <datasources>
  47
  48   <template name="docsis-subtree-common">
  49     <!-- nodeid-docsif is overwritten by devdiscover at the
  50          interface level. This definition is here for backward compatibility
  51          with older discovery results or for systems which do not use
  52          devdiscover -->
  53     <param name="nodeid-docsif"
  54       value="docs//%nodeid-device%//%interface-nick%//"/>
  55   </template>
  56
  57
  58   <template name="docsis-upstream-subtree">
  59     <apply-template name="docsis-subtree-common"/>
  60     <param name="precedence"           value="-500" />
  61     <param name="comment"        value="DOCSIS upstream channel statistics" />
  62     <param name="data-file">
  63        %system-id%_%interface-nick%_docsis_upstream.rrd
  64     </param>
  65     <param name="collector-timeoffset-hashstring"
  66                                        value="%system-id%:%interface-nick%" />
  67     <param name="descriptive-nickname" value="%system-id%:%interface-name%"/>
  68     <param name="graph-title"          value="%descriptive-nickname%" />
  69
  70     <param name="has-overview-shortcuts" value="yes"/>
  71     <param name="overview-shortcuts" value="snr,fec,freq"/>
  72
  73     <param name="overview-subleave-name-snr" value="SNR"/>
  74     <param name="overview-direct-link-snr"      value="yes"/>
  75     <param name="overview-direct-link-view-snr" value="expanded-dir-html"/>
  76     <param name="overview-shortcut-text-snr"
  77            value="All SNR"/>
  78     <param name="overview-shortcut-title-snr"
  79            value="Show signal quality graphs for all upstreams in one page"/>
  80     <param name="overview-page-title-snr"
  81            value="SNR Graphs"/>
  82
  83     <param name="overview-subleave-name-fec" value="FEC_Summary"/>
  84     <param name="overview-direct-link-fec"      value="yes"/>
  85     <param name="overview-direct-link-view-fec" value="expanded-dir-html"/>
  86     <param name="overview-shortcut-text-fec"
  87            value="All FEC"/>
  88     <param name="overview-shortcut-title-fec"
  89            value="Show FEC statistics for all upstreams in one page"/>
  90     <param name="overview-page-title-fec"
  91            value="FEC Graphs"/>
  92
  93     <param name="overview-subleave-name-freq" value="Frequency"/>
  94     <param name="overview-direct-link-freq"      value="yes"/>
  95     <param name="overview-direct-link-view-freq" value="expanded-dir-html"/>
  96     <param name="overview-shortcut-text-freq"
  97            value="All Frequency"/>
  98     <param name="overview-shortcut-title-freq"
  99            value="Show all upstream frequenciesin one page"/>
 100     <param name="overview-page-title-freq"
 101            value="Upstream frequency Graphs"/>
 102
 103     <param name="rrd-hwpredict"     value="disabled" />
 104   </template>
 105
 106   <template name="docsis-signal-quality-codewords">
 107     <param name="rrd-create-dstype"   value="COUNTER" />
 108     <param name="vertical-label"      value="Codewords/s" />
 109     <param name="graph-lower-limit"   value="0" />
 110   </template>
 111
 112   <template name="docsis-upstream-stats">
 113     <leaf name="SNR">
 114       <param name="snmp-object"  value="$docsIfSigQSignalNoise.%ifindex-map%"/>
 115
 116       <param name="rrd-create-dstype"   value="GAUGE" />
 117       <param name="rrd-ds"              value="SNR" />
 118       <param name="collector-scale"     value="10,/" />
 119
 120       <param name="comment"             value="Signal/Noise Ratio" />
 121       <param name="graph-legend"        value="Signal/Noise Ratio" />
 122       <param name="vertical-label"      value="dB" />
 123
 124       <param name="normal-level"        value="25" />
 125       <param name="lower-limit"         value="18" />
 126       <param name="graph-lower-limit"   value="10" />
 127       <param name="graph-upper-limit"   value="30" />
 128
 129       <param name="precedence"          value="1000" />
 130
 131       <!-- This monitor may be redefined by
 132            DocsisUpSNRMonitor selector action -->
 133       <param name="monitor"             value="docsis-snr-lower-20db" />
 134
 135       <param name="nodeid"            value="%nodeid-docsif%//snr"/>
 136     </leaf>
 137
 138
 139     <leaf name="FEC_Summary">
 140       <param name="ds-type"           value="rrd-multigraph" />
 141       <param name="ds-names"          value="corr,uncorr" />
 142       <param name="nodeid"            value="%nodeid-docsif%//fec"/>
 143
 144       <param name="graph-lower-limit"       value="0.01" />
 145       <param name="graph-upper-limit"       value="100" />
 146       <param name="graph-logarithmic"       value="yes" />
 147       <param name="graph-rigid-boundaries"  value="yes" />
 148
 149       <param name="precedence"        value="950" />
 150       <param name="comment"
 151               value="Reed-Solomon forward error correction (FEC) summary" />
 152       <param name="vertical-label"    value="Percent" />
 153
 154       <param name="ds-expr-corr">
 155       {Correctable},{Error-Free},{Correctable},{Uncorrectable},+,+,/,100,*
 156       </param>
 157       <param name="graph-legend-corr"  value="Correctable Codewords" />
 158       <param name="line-style-corr"      value="##SingleGraph" />
 159       <param name="line-color-corr"      value="##green" />
 160       <param name="line-order-corr"      value="1" />
 161
 162       <param name="ds-expr-uncorr">
 163       {Uncorrectable},{Error-Free},{Correctable},{Uncorrectable},+,+,/,100,*
 164       </param>
 165       <param name="graph-legend-uncorr"  value="Uncorrectable Codewords" />
 166       <param name="line-style-uncorr"    value="##SingleGraph" />
 167       <param name="line-color-uncorr"    value="##red" />
 168       <param name="line-order-uncorr"    value="2" />
 169     </leaf>
 170
 171     <leaf name="Error-Free">
 172       <apply-template name="docsis-signal-quality-codewords"/>
 173       <param name="snmp-object"  value="$docsIfSigQUnerroreds.%ifindex-map%"/>
 174       <param name="rrd-ds"       value="Unerroreds" />
 175       <param name="hidden"       value="yes"/>
 176       <param name="comment"
 177           value="FEC codewords received on this channel without error"/>
 178       <param name="graph-legend" value="Error-free Codewords" />
 179       <param name="precedence"   value="900" />
 180       <param name="graph-lower-limit"       value="0.01" />
 181       <param name="graph-upper-limit"       value="100" />
 182       <param name="graph-logarithmic"       value="yes" />
 183       <param name="graph-rigid-boundaries"  value="yes" />
 184     </leaf>
 185
 186     <leaf name="Correctable">
 187       <apply-template name="docsis-signal-quality-codewords"/>
 188       <param name="snmp-object"  value="$docsIfSigQCorrecteds.%ifindex-map%"/>
 189       <param name="rrd-ds"       value="Correcteds" />
 190       <param name="hidden"       value="yes"/>
 191       <param name="comment"
 192           value="FEC codewords received on this channel correctable errors"/>
 193       <param name="graph-legend" value="Correctable Codewords" />
 194       <param name="precedence"   value="800" />
 195       <param name="monitor-action-target"  value="FEC_Summary"/>
 196       <param name="graph-lower-limit"       value="0.01" />
 197       <param name="graph-upper-limit"       value="100" />
 198       <param name="graph-logarithmic"       value="yes" />
 199       <param name="graph-rigid-boundaries"  value="yes" />
 200     </leaf>
 201
 202     <leaf name="Uncorrectable">
 203       <apply-template name="docsis-signal-quality-codewords"/>
 204       <param name="snmp-object"
 205                         value="$docsIfSigQUncorrectables.%ifindex-map%"/>
 206       <param name="rrd-ds"       value="Uncorrectables" />
 207       <param name="hidden"       value="yes"/>
 208       <param name="comment"
 209           value="FEC codewords received on this channel uncorrectable errors"/>
 210       <param name="graph-legend" value="Uncorrectable Codewords" />
 211       <param name="precedence"   value="700" />
 212       <param name="monitor-action-target"  value="FEC_Summary"/>
 213       <param name="graph-lower-limit"       value="0.01" />
 214       <param name="graph-upper-limit"       value="100" />
 215       <param name="graph-logarithmic"       value="yes" />
 216       <param name="graph-rigid-boundaries"  value="yes" />
 217     </leaf>
 218
 219     <leaf name="Frequency">
 220       <param name="snmp-object"
 221                         value="$docsIfUpChannelFrequency.%ifindex-map%"/>
 222       <param name="rrd-ds"       value="Frequency" />
 223       <param name="rrd-create-dstype"   value="GAUGE" />
 224       <param name="vertical-label"      value="Hz" />
 225       <param name="comment"
 226           value="Upstream frequency"/>
 227       <param name="graph-legend" value="Frequency" />
 228       <param name="precedence"   value="600" />
 229       <param name="nodeid"            value="%nodeid-docsif%//frequency"/>
 230     </leaf>
 231   </template>
 232
 233
 234
 235   <template name="docsis-downstream-subtree">
 236     <apply-template name="docsis-subtree-common"/>
 237     <param name="precedence"           value="-500" />
 238     <param name="comment"        value="DOCSIS downstream statistics" />
 239     <param name="data-file">
 240        %system-id%_%interface-nick%_docsis_downstream.rrd
 241     </param>
 242     <param name="collector-timeoffset-hashstring"
 243                                        value="%system-id%:%interface-nick%" />
 244     <param name="descriptive-nickname" value="%system-id%:%interface-name%"/>
 245     <param name="graph-title"          value="%descriptive-nickname%" />
 246
 247     <param name="has-overview-shortcuts" value="yes"/>
 248     <param name="overview-shortcuts" value="util"/>
 249     <param name="overview-subleave-name-util" value="Utilization"/>
 250     <param name="overview-direct-link-util"      value="yes"/>
 251     <param name="overview-direct-link-view-util" value="expanded-dir-html"/>
 252     <param name="overview-shortcut-text-util"
 253            value="All Utilization"/>
 254     <param name="overview-shortcut-title-util"
 255            value="Show utilization graphs for all downstreams in one page"/>
 256     <param name="overview-page-title-util"
 257            value="Downstream Utilization Graphs"/>
 258     <param name="rrd-hwpredict"     value="disabled" />
 259   </template>
 260
 261
 262   <template name="docsis-downstream-util">
 263     <leaf name="Utilization">
 264       <param name="ds-type"           value="rrd-multigraph" />
 265       <param name="ds-names"          value="util" />
 266       <param name="nodeid"            value="%nodeid-docsif%//util"/>
 267
 268       <param name="graph-lower-limit"  value="0" />
 269       <param name="graph-upper-limit"  value="100" />
 270
 271       <param name="precedence"        value="950" />
 272       <param name="comment"
 273               value="Downstream channel utilization" />
 274       <param name="vertical-label"    value="Percent" />
 275
 276       <param name="ds-expr-util">
 277         {UsedBytes},{TotalBytes},/,100,*
 278       </param>
 279       <param name="graph-legend-util"  value="Utilization" />
 280       <param name="line-style-util"      value="##resourceusage" />
 281       <param name="line-color-util"      value="##resourceusage" />
 282       <param name="line-order-util"      value="1" />
 283     </leaf>
 284
 285     <leaf name="TotalBytes">
 286       <param name="rrd-create-dstype"   value="COUNTER" />
 287       <param name="snmp-object-type"    value="COUNTER64" />
 288       <param name="vertical-label"      value="Bytes/s" />
 289       <param name="graph-lower-limit"   value="0" />
 290       <param name="snmp-object"
 291                value="$docsIfCmtsDownChnlCtrExtTotalBytes.%ifindex-map%"/>
 292       <param name="rrd-ds"       value="TotalBytes" />
 293       <param name="hidden"       value="yes"/>
 294       <param name="comment">
 295         The total number of bytes in the Payload portion
 296       </param>
 297       <param name="graph-legend" value="Total Bytes" />
 298       <param name="precedence"   value="800" />
 299     </leaf>
 300
 301     <leaf name="UsedBytes">
 302       <param name="rrd-create-dstype"   value="COUNTER" />
 303       <param name="snmp-object-type"    value="COUNTER64" />
 304       <param name="vertical-label"      value="Bytes/s" />
 305       <param name="graph-lower-limit"   value="0" />
 306       <param name="snmp-object"
 307                value="$docsIfCmtsDownChnlCtrExtUsedBytes.%ifindex-map%"/>
 308       <param name="rrd-ds"       value="UsedBytes" />
 309       <param name="hidden"       value="yes"/>
 310       <param name="comment">
 311        The total number of DOCSIS data bytes transported by this downstream
 312        channel
 313       </param>
 314       <param name="graph-legend" value="Used Bytes" />
 315       <param name="precedence"   value="800" />
 316       <param name="monitor-action-target"  value="Utilization"/>
 317     </leaf>
 318   </template>
 319
 320 </datasources>
 321
 322 <monitors>
 323
 324     <monitor name="docsis-snr-lower-20db">
 325       <param name="monitor-type"  value="expression" />
 326       <param name="rpn-expr"      value="DUP,0,GT,EXC,20,LT,AND" />
 327       <param name="action"        value="docsis-snr-lower-20" />
 328       <param name="expires"       value="3600" />
 329       <param name="comment">
 330         Signal/Noise-Ratio was lower than 20dB
 331       </param>
 332     </monitor>
 333
 334     <action name="docsis-snr-lower-20">
 335       <param name="action-type"     value="tset" />
 336       <param name="tset-name"       value="docsis-snr-lower-20" />
 337     </action>
 338
 339 </monitors>
 340
 341 <token-sets>
 342     <token-set name="docsis-snr-lower-20">
 343       <param name="comment" value="S/N Ratio less than 20dB" />
 344     </token-set>
 345 </token-sets>
 346
 347 </configuration>