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