xref: /freebsd/usr.sbin/bsnmpd/modules/snmp_bridge/RSTP-MIB.txt (revision f126890ac5386406dadf7c4cfa9566cbb56537c5)
1--
2-- Copyright (C) The Internet Society (2005).
3--
4-- This document is subject to the rights, licenses and restrictions
5-- contained in BCP 78, and except as set forth therein, the authors
6-- retain all their rights.
7--
8-- This document and the information contained herein are provided on an
9-- "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
10-- OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
11-- ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
12-- INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
13-- INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
14-- WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
15--
16
17RSTP-MIB DEFINITIONS ::= BEGIN
18
19-- -------------------------------------------------------------
20-- MIB for IEEE 802.1w Rapid Spanning Tree Protocol
21-- -------------------------------------------------------------
22
23IMPORTS
24    MODULE-IDENTITY, OBJECT-TYPE, Integer32, mib-2
25        FROM SNMPv2-SMI
26    TruthValue
27        FROM SNMPv2-TC
28    MODULE-COMPLIANCE, OBJECT-GROUP
29        FROM SNMPv2-CONF
30    dot1dStp, dot1dStpPortEntry
31        FROM BRIDGE-MIB;
32
33rstpMIB MODULE-IDENTITY
34    LAST-UPDATED "200512070000Z"
35    ORGANIZATION "IETF Bridge MIB Working Group"
36    CONTACT-INFO
37        "Email: Bridge-mib@ietf.org"
38    DESCRIPTION
39        "The Bridge MIB Extension module for managing devices
40         that support the Rapid Spanning Tree Protocol defined
41         by IEEE 802.1w.
42
43         Copyright (C) The Internet Society (2005).  This version of
44         this MIB module is part of RFC 4318; See the RFC itself for
45         full legal notices."
46
47    REVISION     "200512070000Z"
48    DESCRIPTION
49         "The initial version of this MIB module as published in
50          RFC 4318."
51    ::= { mib-2 134 }
52
53-- ---------------------------------------------------------- --
54-- subtrees in the RSTP-MIB
55-- ---------------------------------------------------------- --
56
57rstpNotifications OBJECT IDENTIFIER ::= { rstpMIB 0 }
58rstpObjects       OBJECT IDENTIFIER ::= { rstpMIB 1 }
59rstpConformance   OBJECT IDENTIFIER ::= { rstpMIB 2 }
60
61-- -------------------------------------------------------------
62-- Addition to the dot1dStp group
63-- -------------------------------------------------------------
64
65dot1dStpVersion OBJECT-TYPE
66    SYNTAX      INTEGER {
67                    stpCompatible(0),
68                    rstp(2)
69                }
70    MAX-ACCESS  read-write
71    STATUS      current
72    DESCRIPTION
73        "The version of Spanning Tree Protocol the bridge is
74         currently running.  The value 'stpCompatible(0)'
75         indicates the Spanning Tree Protocol specified in
76         IEEE 802.1D-1998 and 'rstp(2)' indicates the Rapid
77         Spanning Tree Protocol specified in IEEE 802.1w and
78         clause 17 of 802.1D-2004.  The values are directly from
79         the IEEE standard.  New values may be defined as future
80         versions of the protocol become available.
81
82         The value of this object MUST be retained across
83         reinitializations of the management system."
84    REFERENCE
85        "IEEE 802.1w clause 14.8.1, 17.12, 17.16.1"
86    DEFVAL      { rstp }
87    ::= { dot1dStp 16 }
88
89dot1dStpTxHoldCount OBJECT-TYPE
90    SYNTAX      Integer32 (1..10)
91    MAX-ACCESS  read-write
92    STATUS      current
93    DESCRIPTION
94        "The value used by the Port Transmit state machine to limit
95         the maximum transmission rate.
96
97         The value of this object MUST be retained across
98         reinitializations of the management system."
99
100    REFERENCE
101        "IEEE 802.1w clause 17.16.6"
102    DEFVAL      { 3 }
103    ::= { dot1dStp 17 }
104
105--
106-- { dot1dStp 18 } was used to represent dot1dStpPathCostDefault
107-- in an earlier version of this MIB.  It has since been
108-- obsoleted, and should not be used.
109--
110
111dot1dStpExtPortTable OBJECT-TYPE
112    SYNTAX      SEQUENCE OF Dot1dStpExtPortEntry
113    MAX-ACCESS  not-accessible
114    STATUS      current
115    DESCRIPTION
116        "A table that contains port-specific Rapid Spanning Tree
117         information."
118    ::= { dot1dStp 19 }
119
120dot1dStpExtPortEntry OBJECT-TYPE
121    SYNTAX      Dot1dStpExtPortEntry
122    MAX-ACCESS  not-accessible
123    STATUS      current
124    DESCRIPTION
125        "A list of Rapid Spanning Tree information maintained by
126         each port."
127    AUGMENTS    { dot1dStpPortEntry }
128    ::= { dot1dStpExtPortTable 1 }
129
130Dot1dStpExtPortEntry ::=
131    SEQUENCE {
132        dot1dStpPortProtocolMigration
133            TruthValue,
134        dot1dStpPortAdminEdgePort
135            TruthValue,
136        dot1dStpPortOperEdgePort
137            TruthValue,
138        dot1dStpPortAdminPointToPoint
139            INTEGER,
140        dot1dStpPortOperPointToPoint
141            TruthValue,
142        dot1dStpPortAdminPathCost
143            Integer32
144    }
145
146dot1dStpPortProtocolMigration OBJECT-TYPE
147    SYNTAX      TruthValue
148    MAX-ACCESS  read-write
149    STATUS      current
150    DESCRIPTION
151        "When operating in RSTP (version 2) mode, writing true(1)
152         to this object forces this port to transmit RSTP BPDUs.
153         Any other operation on this object has no effect and
154         it always returns false(2) when read."
155    REFERENCE
156        "IEEE 802.1w clause 14.8.2.4, 17.18.10, 17.26"
157    ::= { dot1dStpExtPortEntry 1 }
158
159dot1dStpPortAdminEdgePort OBJECT-TYPE
160    SYNTAX      TruthValue
161    MAX-ACCESS  read-write
162    STATUS      current
163    DESCRIPTION
164        "The administrative value of the Edge Port parameter.  A
165         value of true(1) indicates that this port should be
166         assumed as an edge-port, and a value of false(2) indicates
167         that this port should be assumed as a non-edge-port.
168         Setting this object will also cause the corresponding
169         instance of dot1dStpPortOperEdgePort to change to the
170         same value.  Note that even when this object's value
171         is true, the value of the corresponding instance of
172         dot1dStpPortOperEdgePort can be false if a BPDU has
173         been received.
174
175         The value of this object MUST be retained across
176         reinitializations of the management system."
177
178    REFERENCE
179        "IEEE 802.1t clause 14.8.2, 18.3.3"
180    ::= { dot1dStpExtPortEntry 2 }
181
182dot1dStpPortOperEdgePort OBJECT-TYPE
183    SYNTAX      TruthValue
184    MAX-ACCESS  read-only
185    STATUS      current
186    DESCRIPTION
187        "The operational value of the Edge Port parameter.  The
188         object is initialized to the value of the corresponding
189         instance of dot1dStpPortAdminEdgePort.  When the
190         corresponding instance of dot1dStpPortAdminEdgePort is
191         set, this object will be changed as well.  This object
192         will also be changed to false on reception of a BPDU."
193
194    REFERENCE
195        "IEEE 802.1t clause 14.8.2, 18.3.4"
196    ::= { dot1dStpExtPortEntry 3 }
197
198dot1dStpPortAdminPointToPoint OBJECT-TYPE
199    SYNTAX      INTEGER {
200                    forceTrue(0),
201                    forceFalse(1),
202                    auto(2)
203                }
204    MAX-ACCESS  read-write
205    STATUS      current
206    DESCRIPTION
207        "The administrative point-to-point status of the LAN segment
208         attached to this port, using the enumeration values of the
209         IEEE 802.1w clause.  A value of forceTrue(0) indicates
210         that this port should always be treated as if it is
211         connected to a point-to-point link.  A value of
212         forceFalse(1) indicates that this port should be treated as
213         having a shared media connection.  A value of auto(2)
214         indicates that this port is considered to have a
215         point-to-point link if it is an Aggregator and all of its
216         members are aggregatable, or if the MAC entity
217         is configured for full duplex operation, either through
218         auto-negotiation or by management means.  Manipulating this
219         object changes the underlying adminPortToPortMAC.
220
221         The value of this object MUST be retained across
222         reinitializations of the management system."
223
224   REFERENCE
225       "IEEE 802.1w clause 6.4.3, 6.5, 14.8.2"
226   ::= { dot1dStpExtPortEntry 4 }
227
228dot1dStpPortOperPointToPoint OBJECT-TYPE
229    SYNTAX      TruthValue
230    MAX-ACCESS  read-only
231    STATUS      current
232    DESCRIPTION
233        "The operational point-to-point status of the LAN segment
234         attached to this port.  It indicates whether a port is
235         considered to have a point-to-point connection.
236         If adminPointToPointMAC is set to auto(2), then the value
237         of operPointToPointMAC is determined in accordance with the
238         specific procedures defined for the MAC entity concerned,
239         as defined in IEEE 802.1w, clause 6.5.  The value is
240         determined dynamically; that is, it is re-evaluated whenever
241         the value of adminPointToPointMAC changes, and whenever
242         the specific procedures defined for the MAC entity evaluate
243         a change in its point-to-point status."
244    REFERENCE
245        "IEEE 802.1w clause 6.4.3, 6.5, 14.8.2"
246    ::= { dot1dStpExtPortEntry 5 }
247
248dot1dStpPortAdminPathCost OBJECT-TYPE
249    SYNTAX      Integer32 (0..200000000)
250    MAX-ACCESS  read-write
251    STATUS      current
252    DESCRIPTION
253        "The administratively assigned value for the contribution
254         of this port to the path cost of paths toward the spanning
255         tree root.
256
257         Writing a value of '0' assigns the automatically calculated
258         default Path Cost value to the port.  If the default Path
259         Cost is being used, this object returns '0' when read.
260
261         This complements the object dot1dStpPortPathCost or
262         dot1dStpPortPathCost32, which returns the operational value
263         of the path cost.
264
265         The value of this object MUST be retained across
266         reinitializations of the management system."
267    REFERENCE
268        "IEEE 802.1D-1998: Section 8.5.5.3"
269    ::= { dot1dStpExtPortEntry 6 }
270
271-- -------------------------------------------------------------
272-- rstpMIB - Conformance Information
273-- -------------------------------------------------------------
274
275rstpGroups OBJECT IDENTIFIER ::= { rstpConformance 1 }
276
277rstpCompliances OBJECT IDENTIFIER ::= { rstpConformance 2 }
278
279-- -------------------------------------------------------------
280-- Units of conformance
281-- -------------------------------------------------------------
282
283rstpBridgeGroup OBJECT-GROUP
284    OBJECTS {
285        dot1dStpVersion,
286        dot1dStpTxHoldCount
287    }
288    STATUS      current
289    DESCRIPTION
290        "Rapid Spanning Tree information for the bridge."
291    ::= { rstpGroups 1 }
292
293rstpPortGroup OBJECT-GROUP
294    OBJECTS {
295        dot1dStpPortProtocolMigration,
296        dot1dStpPortAdminEdgePort,
297        dot1dStpPortOperEdgePort,
298        dot1dStpPortAdminPointToPoint,
299        dot1dStpPortOperPointToPoint,
300        dot1dStpPortAdminPathCost
301    }
302    STATUS      current
303    DESCRIPTION
304        "Rapid Spanning Tree information for individual ports."
305    ::= { rstpGroups 2 }
306
307-- -------------------------------------------------------------
308-- Compliance statements
309-- -------------------------------------------------------------
310
311rstpCompliance MODULE-COMPLIANCE
312    STATUS      current
313    DESCRIPTION
314        "The compliance statement for device support of Rapid
315         Spanning Tree Protocol (RSTP) bridging services."
316    MODULE
317        MANDATORY-GROUPS {
318            rstpBridgeGroup,
319            rstpPortGroup
320        }
321    ::= { rstpCompliances 1 }
322
323END
324