1SNMP::Info::Bridge(3) User Contributed Perl DocumentationSNMP::Info::Bridge(3)
2
6 SNMP::Info::Bridge - SNMP Interface to SNMP data available through the
7 BRIDGE-MIB (RFC1493)
8
10 Max Baker
11
13 my $bridge = new SNMP::Info (
14 AutoSpecify => 1,
15 Debug => 1,
16 DestHost => 'switch',
17 Community => 'public',
18 Version => 2
19 );
20 my $class = $bridge->class();
22 print " Using device sub class : $class\n";
23 # Grab Forwarding Tables
25 my $interfaces = $bridge->interfaces();
26 my $fw_mac = $bridge->fw_mac();
27 my $fw_port = $bridge->fw_port();
28 my $bp_index = $bridge->bp_index();
29 foreach my $fw_index (keys %$fw_mac){
31 my $mac = $fw_mac->{$fw_index};
32 my $bp_id = $fw_port->{$fw_index};
33 my $iid = $bp_index->{$bp_id};
34 my $port = $interfaces->{$iid};
35 print "Port:$port forwarding to $mac\n";
37 }
38
40 BRIDGE-MIB is used by most Layer 2 devices, and holds information like
41 the MAC Forwarding Table and Spanning Tree Protocol info.
42 Q-BRIDGE-MIB holds 802.1q information -- VLANs and Trunking. Cisco
44 tends not to use this MIB, but some proprietary ones. HP and some
45 nicer vendors use this. This is from "RFC2674_q".
46 Create or use a subclass of SNMP::Info that inherits this class. Do
48 not use directly.
49 For debugging you can call new() directly as you would in SNMP::Info
51 my $bridge = new SNMP::Info::Bridge(...);
53 Inherited Classes
55 None.
56 Required MIBs
58 BRIDGE-MIB
59 Q-BRIDGE-MIB
60 RSTP-MIB
61
63 These are methods that return scalar values from SNMP
64 $bridge->b_mac()
66 Returns the MAC Address of the root bridge port
67 ("dot1dBaseBridgeAddress")
69 $bridge->b_ports()
71 Returns the number of ports in device
72 ("dot1dBaseNumPorts")
74 $bridge->b_type()
76 Returns the type of bridging this bridge can perform, transparent
77 and/or source route.
78 ("dot1dBaseType")
80 $bridge->stp_ver()
82 Returns what version of STP the device is running.
83 ("dot1dStpProtocolSpecification")
85 $bridge->stp_time()
87 Returns time since last topology change detected. (100ths/second)
88 ("dot1dStpTimeSinceTopologyChange")
90 $bridge->stp_root()
92 Returns root of STP.
93 ("dot1dStpDesignatedRoot")
95 $bridge->qb_vlans_max()
97 Maximum number of VLANS supported on this device.
98 ("dot1qMaxSupportedVlans")
100 $bridge->qb_vlans()
102 Current number of VLANs that are configured in this device.
103 ("dot1qNumVlans")
105 $bridge->qb_next_vlan_index()
107 The next available value for "dot1qVlanIndex" of a local VLAN entry
108 in "dot1qVlanStaticTable"
109 ("dot1qNextFreeLocalVlanIndex")
111
113 These are methods that return tables of information in the form of a
114 reference to a hash.
115 $bridge->i_vlan()
117 Returns a mapping between "ifIndex" and the PVID or default VLAN.
118 $vtp->i_untagged()
120 An alias for "i_vlan".
121 $bridge->i_vlan_membership()
123 Returns reference to hash of arrays: key = "ifIndex", value = array
124 of VLAN IDs. These are the VLANs which are members of the egress
125 list for the port.
126 Example:
128 my $interfaces = $bridge->interfaces();
129 my $vlans = $bridge->i_vlan_membership();
130 foreach my $iid (sort keys %$interfaces) {
132 my $port = $interfaces->{$iid};
133 my $vlan = join(',', sort(@{$vlans->{$iid}}));
134 print "Port: $port VLAN: $vlan\n";
135 }
136 $bridge->i_vlan_membership_untagged()
138 Returns reference to hash of arrays: key = "ifIndex", value = array
139 of VLAN IDs. These are the VLANs which are members of the untagged
140 egress list for the port.
141 $bridge->qb_i_vlan_t()
143 Returns reference to hash: key = "dot1dBasePort", value = either
144 'trunk' for tagged ports or the VLAN ID.
145 $bridge->qb_fdb_index()
147 Returns reference to hash: key = FDB ID, value = VLAN ID.
148 $bridge->v_index()
150 Returns VLAN IDs
151 Forwarding Table ("dot1dTpFdbEntry")
153 $bridge->fw_mac()
154 Returns reference to hash of forwarding table MAC Addresses
155 ("dot1dTpFdbAddress")
157 $bridge->fw_port()
159 Returns reference to hash of forwarding table entries port
160 interface identifier (iid)
161 ("dot1dTpFdbPort")
163 $bridge->fw_status()
165 Returns reference to hash of forwarding table entries status
166 ("dot1dTpFdbStatus")
168 Bridge Port Table ("dot1dBasePortEntry")
170 $bridge->bp_index()
171 Returns reference to hash of bridge port table entries map back to
172 interface identifier (iid)
173 ("dot1dBasePortIfIndex")
175 $bridge->bp_port()
177 Returns reference to hash of bridge port table entries for a port
178 which (potentially) has the same value of "dot1dBasePortIfIndex" as
179 another port on the same bridge, this object contains the name of
180 an object instance unique to this port.
181 ("dot1dBasePortCircuit")
183 Spanning Tree Instance Globals
185 These are not part of a table, but return a hash reference to ease API
186 compatibility with MST and PVST implementations indexed by a spanning
187 tree instance id.
188 $bridge->stp_i_time()
190 Returns time since last topology change detected. (100ths/second)
191 ("dot1dStpTimeSinceTopologyChange")
193 $bridge->stp_i_time()
195 Returns the total number of topology changes detected.
196 ("dot1dStpTopChanges")
198 $bridge->stp_i_root()
200 Returns root of STP.
201 ("dot1dStpDesignatedRoot")
203 $bridge->stp_i_root_port()
205 Returns the port number of the port that offers the lowest cost
206 path to the root bridge.
207 ("dot1dStpRootPort")
209 $bridge->stp_i_priority()
211 Returns the port number of the port that offers the lowest cost
212 path to the root bridge.
213 ("dot1dStpPriority")
215 Spanning Tree Protocol Table ("dot1dStpPortTable")
217 Descriptions are straight from BRIDGE-MIB.my
218 $bridge->stp_p_id()
220 "The port number of the port for which this entry contains Spanning
221 Tree Protocol management information."
222 ("dot1dStpPort")
224 $bridge->stp_p_priority()
226 "The value of the priority field which is contained in the first
227 (in network byte order) octet of the (2 octet long) Port ID. The
228 other octet of the Port ID is given by the value of
229 "dot1dStpPort"."
230 ("dot1dStpPortPriority")
232 $bridge->stp_p_state()
234 "The port's current state as defined by application of the Spanning
235 Tree Protocol. This state controls what action a port takes on
236 reception of a frame. If the bridge has detected a port that is
237 malfunctioning it will place that port into the broken(6) state.
238 For ports which are disabled (see "dot1dStpPortEnable"), this
239 object will have a value of disabled(1)."
240 disabled(1)
242 blocking(2)
243 listening(3)
244 learning(4)
245 forwarding(5)
246 broken(6)
247 ("dot1dStpPortState")
249 $bridge->stp_p_cost()
251 "The contribution of this port to the path cost of paths towards
252 the spanning tree root which include this port. 802.1D-1990
253 recommends that the default value of this parameter be in inverse
254 proportion to the speed of the attached LAN."
255 ("dot1dStpPortPathCost")
257 $bridge->stp_p_root()
259 "The unique Bridge Identifier of the Bridge recorded as the Root in
260 the Configuration BPDUs transmitted by the Designated Bridge for
261 the segment to which the port is attached."
262 ("dot1dStpPortDesignatedRoot")
264 $bridge->stp_p_bridge()
266 "The Bridge Identifier of the bridge which this port considers to
267 be the Designated Bridge for this port's segment."
268 ("dot1dStpPortDesignatedBridge")
270 $bridge->stp_p_port()
272 ("dot1dStpPortDesignatedPort")
273 "The Port Identifier of the port on the Designated Bridge for this
275 port's segment."
276 $bridge->i_stp_port()
278 Returns the mapping of ("dot1dStpPortDesignatedPort") to the
279 interface index (iid).
280 $bridge->i_stp_state()
282 Returns the mapping of ("dot1dStpPortState") to the interface index
283 (iid).
284 $bridge->i_stp_id()
286 Returns the mapping of ("dot1dStpPort") to the interface index
287 (iid).
288 $bridge->i_stp_bridge()
290 Returns the mapping of ("dot1dStpPortDesignatedBridge") to the
291 interface index (iid).
292 Q-BRIDGE Port VLAN Table ("dot1qPortVlanTable")
294 $bridge->qb_i_vlan()
295 The PVID, the VLAN ID assigned to untagged frames or Priority-
296 Tagged frames received on this port.
297 ("dot1qPvid")
299 $bridge->qb_i_vlan_type()
301 Either "admitAll" or "admitOnlyVlanTagged". This is a good spot to
302 find trunk ports.
303 ("dot1qPortAcceptableFrameTypes")
305 $bridge->qb_i_vlan_in_flt()
307 When this is "true" the device will discard incoming frames for
308 VLANs which do not include this Port in its Member set. When
309 "false", the port will accept all incoming frames.
310 ("dot1qPortIngressFiltering")
312 Q-BRIDGE VLAN Current Table ("dot1qVlanCurrentTable")
314 $bridge->qb_cv_egress()
315 The set of ports which are assigned to the egress list for this
316 VLAN.
317 ("dot1qVlanCurrentEgressPorts")
319 $bridge->qb_cv_untagged()
321 The set of ports which should transmit egress packets for this VLAN
322 as untagged.
323 ("dot1qVlanCurrentUntaggedPorts")
325 $bridge->qb_cv_stat()
327 Status of the VLAN, other, permanent, or dynamicGvrp.
328 ("dot1qVlanStatus")
330 Q-BRIDGE VLAN Static Table ("dot1qVlanStaticTable")
332 $bridge->qb_v_name()
333 Human-entered name for vlans.
334 ("dot1qVlanStaticName")
336 $bridge->qb_v_egress()
338 The set of ports which are assigned to the egress list for this
339 VLAN.
340 ("dot1qVlanStaticEgressPorts")
342 $bridge->qb_v_fbdn_egress()
344 The set of ports which are prohibited from being included in the
345 egress list for this VLAN.
346 ("dot1qVlanForbiddenEgressPorts")
348 $bridge->qb_v_untagged()
350 The set of ports which should transmit egress packets for this VLAN
351 as untagged.
352 ("dot1qVlanStaticUntaggedPorts")
354 $bridge->qb_v_stat()
356 "active" !
357 ("dot1qVlanStaticRowStatus")
359 Q-BRIDGE Filtering Database Table ("dot1qFdbTable")
361 $bridge->qb_fw_mac()
362 Returns reference to hash of forwarding table MAC Addresses
363 ("dot1qTpFdbAddress")
365 $bridge->qb_fw_port()
367 Returns reference to hash of forwarding table entries port
368 interface identifier (iid)
369 ("dot1qTpFdbPort")
371 $bridge->qb_fw_vlan()
373 Returns reference to hash of forwarding table entries VLAN ID
374 $bridge->qb_fw_status()
376 Returns reference to hash of forwarding table entries status
377 ("dot1qTpFdbStatus")
379
381 These are methods that provide SNMP set functionality for overridden
382 methods or provide a simpler interface to complex set operations. See
383 "SETTING DATA VIA SNMP" in SNMP::Info for general information on set
384 operations.
385 $bridge->set_i_vlan(vlan, ifIndex)
387 Currently unsupported. Throws an error and returns.
388 $bridge->set_i_untagged(vlan, ifIndex)
390 An alias for "set_i_vlan".
391 $bridge->set_i_pvid(pvid, ifIndex)
393 Currently unsupported. Throws an error and returns.
394 $bridge->set_add_i_vlan_tagged(vlan, ifIndex)
396 Currently unsupported. Throws an error and returns.
397 $bridge->set_remove_i_vlan_tagged(vlan, ifIndex)
399 Currently unsupported. Throws an error and returns.
400perl v5.36.1 2023-07-17 SNMP::Info::Bridge(3)