Brocade MIBs added
[public/netxms.git] / contrib / mibs / BD-MIB.txt
1 BD-MIB DEFINITIONS ::= BEGIN
2 IMPORTS
3
4 DisplayString, TEXTUAL-CONVENTION, TruthValue
5 FROM SNMPv2-TC
6
7 OBJECT-TYPE, OBJECT-IDENTITY,
8 MODULE-IDENTITY, NOTIFICATION-TYPE
9 FROM SNMPv2-SMI
10
11 SwPortIndex
12 FROM Brocade-TC
13
14 fcSwitch, bcsiModules
15 FROM Brocade-REG-MIB
16
17 swVfId
18 FROM SW-MIB;
19
20
21 bd MODULE-IDENTITY
22 LAST-UPDATED "201404101146Z" -- Apr 10, 2014 11:46am
23 ORGANIZATION "Brocade Communications Systems, Inc.,"
24 CONTACT-INFO "Customer Support Group
25 Brocade Communications Systems,
26 1745 Technology Drive,
27 San Jose, CA 95110 U.S.A
28 Tel: +1-408-392-6061
29 Fax: +1-408-392-6656
30 Email: support@Brocade.COM
31 WEB: www.brocade.com"
32
33 DESCRIPTION "The MIB module is for Brocade's Bottleneck detection feature.Copyright (c) 1996-2003 Brocade Communications Systems, Inc. All rights reserved."
34 REVISION "201404101146Z" -- Apr 10, 2014 11:46am
35 DESCRIPTION "Added slotPort object in bdStatsEntry and included it
36 in bdTrap and bdClearTrap."
37 ::= { fcSwitch 51 }
38
39 BdType ::= TEXTUAL-CONVENTION
40 STATUS current
41 DESCRIPTION "BD type"
42 SYNTAX INTEGER {
43 congestion (1),
44 latency (2)
45 }
46
47 bdTraps OBJECT-IDENTITY
48 STATUS current
49 DESCRIPTION "The OID represents the BD Traps."
50 ::= { bd 0 }
51
52 bdConfig OBJECT-IDENTITY
53 STATUS current
54 DESCRIPTION "The OID represents the BD config."
55 ::= { bd 1 }
56
57 bdStats OBJECT-IDENTITY
58 STATUS current
59 DESCRIPTION "This OID represents the BD stats."
60 ::= { bd 2 }
61
62 bdStatus OBJECT-TYPE
63 SYNTAX TruthValue
64 MAX-ACCESS read-only
65 STATUS current
66 DESCRIPTION "This object gives the status of bottleneck detection feature
67 if enabled in the switch. The value of this OID if true(1) or false(2)."
68 ::= { bdConfig 1 }
69
70
71 bdLThreshold OBJECT-TYPE
72 SYNTAX DisplayString(SIZE(1..5))
73 MAX-ACCESS read-only
74 STATUS current
75 DESCRIPTION "This object is the severity threshold for latency bottleneck.
76 This threshold indicates the percentage of one-second intervals
77 affected by latency conditions within a specified time window.
78 The value of this OID is between 0 and 1."
79 ::= { bdConfig 2 }
80
81 bdCThreshold OBJECT-TYPE
82 SYNTAX DisplayString(SIZE(1..5))
83 MAX-ACCESS read-only
84 STATUS current
85 DESCRIPTION "This object is the severity threshold for congestion bottleneck.
86 This threshold indicates the percentage of one-second intervals
87 affected by congestion conditions within a specified time window.
88 The value of this OID is between 0 and 1"
89 ::= { bdConfig 3 }
90
91 bdQTime OBJECT-TYPE
92 SYNTAX INTEGER(1..1000)
93 UNITS "seconds"
94 MAX-ACCESS read-only
95 STATUS current
96 DESCRIPTION "The minimum number of seconds between consecutive alerts.
97 The value assigned to this parameter applies to both latency and
98 congestion monitoring. In this duration, there will not be
99 any traps sent."
100 ::= { bdConfig 4 }
101
102 bdWinAvgTime OBJECT-TYPE
103 SYNTAX INTEGER (1..100)
104 UNITS "seconds"
105 MAX-ACCESS read-only
106 STATUS current
107 DESCRIPTION "The time window in seconds over which the percentage of seconds
108 affected by bottleneck conditions is computed and compared
109 with the threshold."
110 ::= { bdConfig 5 }
111
112 bdThreshold OBJECT-TYPE
113 SYNTAX DisplayString(SIZE(1..5))
114 MAX-ACCESS accessible-for-notify
115 STATUS current
116 DESCRIPTION "This is the severity threshold for latency or congestion
117 bottleneck. This is accessible only for traps. This object is
118 one of the variable binding in bdTrap and bdClearTrap."
119 ::= { bdConfig 6 }
120
121
122
123 nBdType OBJECT-TYPE
124 SYNTAX BdType
125 MAX-ACCESS accessible-for-notify
126 STATUS current
127 DESCRIPTION "This is the type of bottleneck.This is accessible only for
128 traps. This object is one of the variable binding in bdTrap and
129 bdClearTrap. This can have a value of congestion(1) or latency(2)."
130 ::= { bdConfig 7 }
131
132
133
134 bdNumOfEntries OBJECT-TYPE
135 SYNTAX Integer32
136 MAX-ACCESS read-only
137 STATUS current
138 DESCRIPTION "Number of rows in the stats table."
139 ::= { bdStats 1 }
140
141 bdStatsTable OBJECT-TYPE
142 SYNTAX SEQUENCE OF BdStatsEntry
143 MAX-ACCESS not-accessible
144 STATUS current
145 DESCRIPTION "The table of stats entries represents both types of bottleneck.
146 Each sample in the stats is taken every 10 seconds.The maximum
147 number of entries for each port, each type
148 [congestion/latency] is 30."
149 ::= { bdStats 2 }
150
151 bdStatsEntry OBJECT-TYPE
152 SYNTAX BdStatsEntry
153 MAX-ACCESS not-accessible
154 STATUS current
155 DESCRIPTION "An entry of BD stats information."
156 INDEX { userPortNumber, bdType, bdSampleTime}
157 ::= { bdStatsTable 1 }
158
159
160
161
162
163 BdStatsEntry ::= SEQUENCE {
164 userPortNumber SwPortIndex,
165 bdSampleTime Unsigned32,
166 bdType BdType,
167 bdStatsValue10SecsSample DisplayString,
168 bdStatsValue60SecsSample DisplayString,
169 bdStatsValue300SecsSample DisplayString,
170 slotPort DisplayString
171 }
172
173 userPortNumber OBJECT-TYPE
174 SYNTAX SwPortIndex
175 MAX-ACCESS read-only
176 STATUS current
177 DESCRIPTION "This object represents the user port indices of bottleneck
178 monitored ports like F-port, E-port, L-port, FCOE-port."
179 ::= { bdStatsEntry 1 }
180
181 bdSampleTime OBJECT-TYPE
182 SYNTAX Unsigned32
183 UNITS "seconds"
184 MAX-ACCESS read-only
185 STATUS current
186 DESCRIPTION "This object represents the sample time in Unix time format.
187 Ex:1265259069 The above Unix time is equal to
188 Thu, 04 Feb 2010 04:51:09 GMT ."
189 ::= { bdStatsEntry 2 }
190
191 bdType OBJECT-TYPE
192 SYNTAX BdType
193 MAX-ACCESS read-only
194 STATUS current
195 DESCRIPTION "This object represents the bottleneck type. The value of
196 this object can be congestion(1) or latency(2)."
197 ::= { bdStatsEntry 3 }
198
199 bdStatsValue10SecsSample OBJECT-TYPE
200 SYNTAX DisplayString(SIZE(1..5))
201 MAX-ACCESS read-only
202 STATUS current
203 DESCRIPTION "This sample is average of 10 samples collected every second.
204 If the sample has not been taken yet then bdStatsValue10SecsSample
205 return -1."
206 ::= { bdStatsEntry 4 }
207
208 bdStatsValue60SecsSample OBJECT-TYPE
209 SYNTAX DisplayString(SIZE(1..5))
210 MAX-ACCESS read-only
211 STATUS current
212 DESCRIPTION "This sample is average of 60 samples collected every second.
213 If the sample has not been taken yet then bdStatsValue60SecsSample
214 return -1."
215 ::= { bdStatsEntry 5 }
216
217 bdStatsValue300SecsSample OBJECT-TYPE
218 SYNTAX DisplayString(SIZE(1..5))
219 MAX-ACCESS read-only
220 STATUS current
221 DESCRIPTION "This sample is average of 300 samples collected every second.
222 If the sample has not been taken yet then bdStatsValue300SecsSample
223 return -1."
224 ::= { bdStatsEntry 6 }
225
226 slotPort OBJECT-TYPE
227 SYNTAX DisplayString
228 MAX-ACCESS accessible-for-notify
229 STATUS current
230 DESCRIPTION "This object represents the slot/port format of userPortNumber for bottleneck
231 monitored ports like F-port, E-port, L-port, FCOE-port."
232 ::= { bdStatsEntry 7 }
233
234 bdAggrStats OBJECT-TYPE
235 SYNTAX DisplayString(SIZE(1..12))
236 MAX-ACCESS accessible-for-notify
237 STATUS current
238 DESCRIPTION "This object represents the aggregrate stats value.
239 This value is the sum of all the samples divided by average
240 window and multiplied by 100.This is accessible only for traps.
241 This obejct is one of the variable binding in bdTrap and
242 bdClearTrap."
243 ::= { bdStats 3 }
244
245 bdAbsoluteValue OBJECT-TYPE
246 SYNTAX INTEGER (1..1000)
247 MAX-ACCESS accessible-for-notify
248 STATUS current
249 DESCRIPTION "This object represents the absolute value of bdAggrStats.
250 It is the number of affected seconds. This object is accessible
251 only for traps and it is one of the variable binding in
252 bdTrap and bdClearTrap."
253 ::= { bdStats 4 }
254
255 bdAvgFrameSize OBJECT-TYPE
256 SYNTAX Unsigned32
257 MAX-ACCESS accessible-for-notify
258 STATUS current
259 DESCRIPTION "This object represents the average size in bytes of all frames
260 that were transmitted on the ports during the averaging window.
261 This object is accessible only for traps and it is one of the
262 variable binding in bdTrap and bdClearTrap."
263 ::= { bdStats 5 }
264
265
266 bdTrap NOTIFICATION-TYPE
267 OBJECTS {
268 userPortNumber,
269 slotPort,
270 bdWinAvgTime,
271 nBdType,
272 bdThreshold,
273 bdAggrStats,
274 bdAbsoluteValue,
275 swVfId,
276 bdAvgFrameSize
277 }
278 STATUS current
279 DESCRIPTION "trap to be send for bottleneck detection."
280 ::= { bdTraps 1 }
281
282 bdClearTrap NOTIFICATION-TYPE
283 OBJECTS {
284 userPortNumber,
285 slotPort,
286 bdWinAvgTime,
287 nBdType,
288 bdThreshold,
289 bdAggrStats,
290 bdAbsoluteValue,
291 swVfId,
292 bdAvgFrameSize
293 }
294 STATUS current
295 DESCRIPTION "trap to be send for bottleneck clearance."
296 ::= { bdTraps 2 }
297 END
298