3 Copyright (C) 2003 Roman Hochuli, Stanislav Sinyagin
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.
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.
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.
19 $Id: cisco.ios.docsis.xml,v 1.1 2010-12-27 00:04:27 ivan Exp $
20 Stanislav Sinyagin <ssinyagin@yahoo.com>
22 DOCSIS interface, Cisco specific
24 CISCO-DOCS-EXT-MIB:cdxCmtsMacExtTable
25 CISCO-DOCS-EXT-MIB:cdxIfUpstreamChannelExtTable
32 <!-- CISCO-DOCS-EXT-MIB::cdxCmtsMacExtTable -->
33 <def name="cdxCmtsCmTotal" value="1.3.6.1.4.1.9.9.116.1.3.3.1.4"/>
34 <def name="cdxCmtsCmActive" value="1.3.6.1.4.1.9.9.116.1.3.3.1.5"/>
35 <def name="cdxCmtsCmRegistered" value="1.3.6.1.4.1.9.9.116.1.3.3.1.6"/>
37 <!-- CISCO-DOCS-EXT-MIB:cdxIfUpstreamChannelExtTable -->
38 <def name="cdxIfUpChannelCmTotal" value="1.3.6.1.4.1.9.9.116.1.4.1.1.3"/>
39 <def name="cdxIfUpChannelCmActive" value="1.3.6.1.4.1.9.9.116.1.4.1.1.4"/>
40 <def name="cdxIfUpChannelCmRegistered"
41 value="1.3.6.1.4.1.9.9.116.1.4.1.1.5"/>
42 <def name="cdxIfUpChannelAvgUtil" value="1.3.6.1.4.1.9.9.116.1.4.1.1.7"/>
43 <def name="cdxIfUpChannelAvgContSlots"
44 value="1.3.6.1.4.1.9.9.116.1.4.1.1.8"/>
45 <def name="cdxIfUpChannelMaxUGSLastFiveMins"
46 value="1.3.6.1.4.1.9.9.116.1.4.1.1.14"/>
51 <template name="cisco-docsis-mac-subtree">
52 <param name="precedence" value="-500" />
53 <param name="comment" value="DOCSIS MAC layer utilization" />
54 <param name="data-file">
55 %system-id%_%interface-nick%_cdx_mac.rrd
57 <param name="collector-timeoffset-hashstring"
58 value="%system-id%:%interface-nick%" />
59 <param name="descriptive-nickname" value="%system-id%:%interface-name%"/>
60 <param name="graph-title" value="%descriptive-nickname%" />
62 <param name="has-overview-shortcuts" value="yes"/>
63 <param name="overview-shortcuts" value="modems"/>
64 <param name="overview-subleave-name-modems" value="Modems"/>
65 <param name="overview-direct-link-modems" value="yes"/>
66 <param name="overview-direct-link-view-modems" value="expanded-dir-html"/>
67 <param name="overview-shortcut-text-modems"
69 <param name="overview-shortcut-title-modems"
70 value="Show modem quantities in one page"/>
71 <param name="overview-page-title-modems"
72 value="Modem quantities"/>
74 <param name="rrd-hwpredict" value="disabled" />
76 <!-- nodeid-docsif is overwritten by devdiscover at the
77 interface level. This definition is here for backward compatibility
78 with older discovery results or for systems which do not use
80 <param name="nodeid-docsif"
81 value="docs//%nodeid-device%//%interface-nick%//"/>
84 <template name="cisco-docsis-modem-quantity">
86 <param name="ds-type" value="rrd-multigraph" />
87 <param name="ds-names" value="total,active,registered" />
88 <param name="nodeid" value="%nodeid-docsif%//modems"/>
90 <param name="graph-lower-limit" value="0" />
91 <param name="precedence" value="950" />
93 value="Active and Total modems on the interface" />
94 <param name="vertical-label" value="Modems" />
96 <param name="ds-expr-total">{Modems_Total}</param>
97 <param name="graph-legend-total" value="Total" />
98 <param name="line-style-total" value="##totalresource" />
99 <param name="line-color-total" value="##totalresource" />
100 <param name="line-order-total" value="1" />
102 <param name="ds-expr-active">{Modems_Active}</param>
103 <param name="graph-legend-active" value="Active" />
104 <param name="line-style-active" value="##resourcepartusage" />
105 <param name="line-color-active" value="##resourcepartusage" />
106 <param name="line-order-active" value="2" />
108 <param name="ds-expr-registered">{Modems_Registered}</param>
109 <param name="graph-legend-registered" value="Registered" />
110 <param name="line-style-registered" value="##resourceusage" />
111 <param name="line-color-registered" value="##resourceusage" />
112 <param name="line-order-registered" value="3" />
115 <leaf name="Modems_Total">
116 <param name="snmp-object"
117 value="%cisco-docsis-cmtotal%.%ifindex-map%"/>
118 <param name="rrd-ds" value="Total" />
119 <param name="hidden" value="yes"/>
120 <param name="comment"
121 value="Total number of modems on the interface since boot"/>
122 <param name="graph-legend" value="Total modems" />
123 <param name="precedence" value="900" />
124 <param name="rrd-create-dstype" value="GAUGE" />
125 <param name="vertical-label" value="Modems" />
126 <param name="graph-lower-limit" value="0" />
129 <leaf name="Modems_Active">
130 <param name="snmp-object"
131 value="%cisco-docsis-cmactive%.%ifindex-map%"/>
132 <param name="rrd-ds" value="Active" />
133 <param name="hidden" value="yes"/>
134 <param name="comment"
135 value="Number of active modems on the interface"/>
136 <param name="graph-legend" value="Active modems" />
137 <param name="precedence" value="800" />
138 <param name="rrd-create-dstype" value="GAUGE" />
139 <param name="vertical-label" value="Modems" />
140 <param name="graph-lower-limit" value="0" />
141 <param name="monitor-action-target" value="Modems"/>
144 <leaf name="Modems_Registered">
145 <param name="snmp-object"
146 value="%cisco-docsis-cmregistered%.%ifindex-map%"/>
147 <param name="rrd-ds" value="Registered" />
148 <param name="hidden" value="yes"/>
149 <param name="comment"
150 value="Number of registered modems on the interface"/>
151 <param name="graph-legend" value="Registered modems" />
152 <param name="precedence" value="700" />
153 <param name="rrd-create-dstype" value="GAUGE" />
154 <param name="vertical-label" value="Modems" />
155 <param name="graph-lower-limit" value="0" />
156 <param name="monitor-action-target" value="Modems"/>
162 <template name="cisco-docsis-mac-util">
163 <apply-template name="cisco-docsis-modem-quantity"/>
164 <param name="cisco-docsis-cmtotal" value="$cdxCmtsCmTotal"/>
165 <param name="cisco-docsis-cmactive" value="$cdxCmtsCmActive"/>
166 <param name="cisco-docsis-cmregistered" value="$cdxCmtsCmRegistered"/>
170 <template name="cisco-docsis-upstream-util">
171 <apply-template name="cisco-docsis-modem-quantity"/>
172 <param name="cisco-docsis-cmtotal" value="$cdxIfUpChannelCmTotal"/>
173 <param name="cisco-docsis-cmactive" value="$cdxIfUpChannelCmActive"/>
174 <param name="cisco-docsis-cmregistered"
175 value="$cdxIfUpChannelCmRegistered"/>
177 <leaf name="Util_Summary">
178 <param name="ds-type" value="rrd-multigraph" />
179 <param name="ds-names" value="util,cont" />
180 <param name="nodeid" value="%nodeid-docsif%//util"/>
181 <param name="graph-lower-limit" value="0" />
182 <param name="graph-upper-limit" value="100" />
184 <param name="precedence" value="950" />
185 <param name="comment"
186 value="Upstream channel utilization and free contention mini-slots" />
187 <param name="vertical-label" value="Percent" />
189 <param name="ds-expr-util" value="{Util}"/>
190 <param name="graph-legend-util" value="Utilization" />
191 <param name="line-style-util" value="##resourceusage" />
192 <param name="line-color-util" value="##resourceusage" />
193 <param name="line-order-util" value="1" />
195 <param name="ds-expr-cont" value="{ContSlots}"/>
196 <param name="graph-legend-cont" value="Free contention slots" />
197 <param name="line-style-cont" value="##SingleGraph" />
198 <param name="line-color-cont" value="##green" />
199 <param name="line-order-cont" value="2" />
203 <param name="snmp-object"
204 value="$cdxIfUpChannelAvgUtil.%ifindex-map%"/>
205 <param name="rrd-ds" value="Util" />
206 <param name="hidden" value="yes"/>
207 <param name="comment"
208 value="The average percentage of upstream channel utilization"/>
209 <param name="graph-legend" value="Channel Utilization" />
210 <param name="precedence" value="700" />
211 <param name="rrd-create-dstype" value="GAUGE" />
212 <param name="vertical-label" value="Percent" />
213 <param name="graph-lower-limit" value="0" />
214 <param name="graph-upper-limit" value="100" />
215 <param name="upper-limit" value="90" />
216 <param name="monitor-action-target" value="Util_Summary"/>
219 <leaf name="ContSlots">
220 <param name="snmp-object"
221 value="$cdxIfUpChannelAvgContSlots.%ifindex-map%"/>
222 <param name="rrd-ds" value="ContSlots" />
223 <param name="hidden" value="yes"/>
224 <param name="comment"
225 value="The average percentage of contention mini-slots"/>
226 <param name="graph-legend" value="Cintention mini-slots" />
227 <param name="precedence" value="600" />
228 <param name="rrd-create-dstype" value="GAUGE" />
229 <param name="vertical-label" value="Percent" />
230 <param name="graph-lower-limit" value="0" />
231 <param name="graph-upper-limit" value="100" />
232 <param name="lower-limit" value="10" />
233 <param name="monitor-action-target" value="Util_Summary"/>
236 <iftrue var="CiscoIOS_Docsis::ugs-supported">
237 <leaf name="Active_UGS">
238 <param name="snmp-object"
239 value="$cdxIfUpChannelMaxUGSLastFiveMins.%ifindex-map%"/>
240 <param name="rrd-ds" value="ActiveUGS" />
241 <param name="comment"
242 value="the number of active Unsolicited Grant Services"/>
243 <param name="graph-legend" value="Active UGS" />
244 <param name="precedence" value="600" />
245 <param name="rrd-create-dstype" value="GAUGE" />
246 <param name="vertical-label" value="UGS" />
247 <param name="graph-lower-limit" value="0" />