1SNMP::Info::Layer3::FouUnsderry(C3opnmt)ributed Perl DocSuNmMePn:t:aItnifoon::Layer3::Foundry(3pm)
2
3
4

NAME

6       SNMP::Info::Layer3::Foundry - SNMP Interface to Brocade (Foundry)
7       Network Devices
8

AUTHOR

10       Max Baker
11

SYNOPSIS

13        # Let SNMP::Info determine the correct subclass for you.
14        my $foundry = new SNMP::Info(
15                                 AutoSpecify => 1,
16                                 Debug       => 1,
17                                 DestHost    => 'myswitch',
18                                 Community   => 'public',
19                                 Version     => 2
20                               )
21           or die "Can't connect to DestHost.\n";
22
23        my $class = $foundry->class();
24
25        print "SNMP::Info determined this device to fall under subclass : $class\n";
26

DESCRIPTION

28       Provides abstraction to information obtainable from Brocade (Foundry)
29       Networks devices through SNMP. See inherited classes' documentation for
30       inherited methods.
31
32   Inherited Classes
33       SNMP::Info::Layer3;
34       SNMP::Info::FDP;
35
36   Required MIBs
37       BROCADE-PRODUCTS-MIB
38       FOUNDRY-SN-ROOT-MIB
39       FOUNDRY-SN-AGENT-MIB
40       FOUNDRY-SN-SWITCH-GROUP-MIB
41       FOUNDRY-SN-STACKING-MIB
42       FOUNDRY-POE-MIB
43       Inherited Classes' MIBs
44           See "Required MIBs" in SNMP::Info::Layer3 for its own MIB
45           requirements.
46
47           See "Required MIBs" in SNMP::Info::FDP for its own MIB
48           requirements.
49

GLOBALS

51       These are methods that return scalar value from SNMP
52
53       $foundry->model()
54           Returns model type.  Checks $foundry->id() against the FOUNDRY-SN-
55           ROOT-MIB and removes '"sn"' and '"Switch"'.  EdgeIron models
56           determined through ENTITY-MIB.
57
58       $foundry->vendor()
59           Returns 'brocade'
60
61       $foundry->os()
62           Returns 'brocade'
63
64       $foundry->os_ver()
65           Returns the software version
66
67       $foundry->mac()
68           Returns MAC Address of root port.
69
70           ("ifPhysAddress.1")
71
72       $foundry->chassis()
73           Returns Chassis type.
74
75           ("entPhysicalDescr.1")
76
77       $foundry->serial()
78           Returns serial number of device.
79
80       $foundry->temp()
81           Returns the chassis temperature
82
83           ("snChasActualTemperature")
84
85       $foundry->ps1_type()
86           Returns the Description for the power supply
87
88           ("snChasPwrSupplyDescription.1")
89
90       $foundry->ps1_status()
91           Returns the status of the power supply.
92
93           ("snChasPwrSupplyOperStatus.1")
94
95       $foundry->fan()
96           Returns the status of the chassis fan.
97
98           ("snChasFanOperStatus.1")
99
100       $foundry->img_ver()
101           Returns device image version.
102
103           ("snAgImgVer.0")
104
105       $foundry->ch_serial()
106           Returns chassis serial number.
107
108           ("snChasSerNum.0")
109
110   Global Methods imported from SNMP::Info::Layer3
111       See documentation in "GLOBALS" in SNMP::Info::Layer3 for details.
112
113   Global Methods imported from SNMP::Info::FDP
114       See documentation in "GLOBALS" in SNMP::Info::FDP for details.
115

TABLE METHODS

117       These are methods that return tables of information in the form of a
118       reference to a hash.
119
120   Overrides
121       $foundry->interfaces()
122           Returns reference to hash of interface names to iids.
123
124       $foundry->i_ignore()
125           Returns reference to hash of interfaces to be ignored.
126
127           Ignores interfaces with descriptions of  tunnel,loopback,null
128
129       $foundry->i_duplex()
130           Returns reference to hash of interface link duplex status.
131
132           Crosses $foundry->sw_duplex() with $foundry->sw_index()
133
134       $foundry->i_stp_state()
135           Returns the mapping of ("dot1dStpPortState") to the interface index
136           (iid).
137
138       $foundry->agg_ports()
139           Returns a HASH reference mapping from slave to master port for each
140           member of a port bundle on the device. Keys are ifIndex of the
141           slave ports, Values are ifIndex of the corresponding master ports.
142
143   ENTITY-MIB Information
144       ENTITY-MIB is supported on the Brocade NetIron XMR, NetIron MLX, MLXe,
145       NetIron CES, NetIron CER, and older EdgeIron series devices.  For other
146       devices which do not support it, these methods emulate Physical Table
147       methods using FOUNDRY-SN-AGENT-MIB.  See Pseudo ENTITY-MIB information
148       below for details on brcd_e_* methods.
149
150       $foundry->e_index()
151           If the device doesn't support "entPhysicalDescr", this will try
152           brcd_e_index().
153
154           Note that this is based on "entPhysicalDescr" due to implementation
155           details of SNMP::Info::Entity::e_index().
156
157       $foundry->e_class()
158           If the device doesn't support "entPhysicalClass", this will try
159           brcd_e_class().
160
161       $foundry->e_descr()
162           If the device doesn't support "entPhysicalDescr", this will try
163           brcd_e_descr().
164
165       $foundry->e_name()
166           If the device doesn't support "entPhysicalName", this will try
167           brcd_e_name().
168
169       $foundry->e_parent()
170           If the device doesn't support "entPhysicalContainedIn", this will
171           try brcd_e_parent().
172
173       $foundry->e_pos()
174           If the device doesn't support "entPhysicalParentRelPos", this will
175           try brcd_e_pos().
176
177       $foundry->e_serial()
178           If the device doesn't support "entPhysicalSerialNum", this will try
179           brcd_e_serial().
180
181       $foundry->e_type()
182           If the device doesn't support "entPhysicalVendorType", this will
183           try brcd_e_type().
184
185       $foundry->e_vendor()
186           If the device doesn't support "entPhysicalMfgName", this will try
187           brcd_e_vendor().
188
189   Pseudo ENTITY-MIB information
190       These methods emulate ENTITY-MIB Physical Table methods using FOUNDRY-
191       SN-AGENT-MIB.
192
193       $foundry->brcd_e_index()
194           Returns reference to hash.  Key: IID, Value: Integer, Indices are
195           combined into an integer, each index is two digits padded with
196           leading zero if required.
197
198       $foundry->brcd_e_class()
199           Returns reference to hash.  Key: IID, Value: General hardware type.
200
201           Returns 'stack' for the stack master in an active stack, 'chassis'
202           for base switches that contain modules, and 'module' for others.
203
204       $foundry->brcd_e_descr()
205           Returns reference to hash.  Key: IID, Value: Human friendly name
206
207           ("snAgentConfigModule2Description") or
208           ("snAgentConfigModuleDescription")
209
210       $foundry->brcd_e_name()
211           Returns reference to hash.  Key: IID, Value: Human friendly name
212
213       $foundry->brcd_e_vendor()
214           Returns reference to hash.  Key: IID, Value: brocade
215
216       $foundry->brcd_e_serial()
217           Returns reference to hash.  Key: IID, Value: Serial number
218
219           Serial number is $foundry->serial() for a stack master unit and
220           ("snAgentConfigModule2SerialNumber") or
221           ("snAgentConfigModuleSerialNumber") for all others.
222
223       $foundry->brcd_e_type()
224           Returns reference to hash.  Key: IID, Value: Type of
225           component/sub-component as defined under "snAgentConfigModule2Type"
226           or "snAgentConfigModule2Type" in FOUNDRY-SN-AGENT-MIB.
227
228       $foundry->brcd_e_pos()
229           Returns reference to hash.  Key: IID, Value: The relative position
230           among all entities sharing the same parent.
231
232           ("s5ChasComSubIndx")
233
234       $foundry->brcd_e_parent()
235           Returns reference to hash.  Key: IID, Value: The value of
236           brcd_e_index() for the entity which 'contains' this entity.  A
237           value of zero indicates this entity is not contained in any other
238           entity.
239
240   Foundry Switch Port Information Table ("snSwPortIfTable")
241       $foundry->sw_index()
242           Returns reference to hash.  Maps Table to Interface IID.
243
244           ("snSwPortIfIndex")
245
246       $foundry->sw_duplex()
247           Returns reference to hash.   Current duplex status for switch
248           ports.
249
250           ("snSwPortInfoChnMode")
251
252       $foundry->sw_type()
253           Returns reference to hash.  Current Port Type .
254
255           ("snSwPortInfoMediaType")
256
257       $foundry->sw_speed()
258           Returns reference to hash.  Current Port Speed.
259
260           ("snSwPortInfoSpeed")
261
262   Power Over Ethernet Port Table
263       These methods emulate the POWER-ETHERNET-MIB Power Source Entity (PSE)
264       Port Table "pethPsePortTable" methods using the FOUNDRY-POE-MIB Power
265       over Ethernet Port Table "snAgentPoePortTable".
266
267       $foundry->peth_port_ifindex()
268           Creates an index of module.port to align with the indexing of the
269           "pethPsePortTable" with a value of "ifIndex".  The module defaults
270           1 if otherwise unknown.
271
272       $foundry->peth_port_admin()
273           Administrative status: is this port permitted to deliver power?
274
275           "pethPsePortAdminEnable"
276
277       $foundry->peth_port_status()
278           Current status: is this port delivering power.
279
280       $foundry->peth_port_class()
281           Device class: if status is delivering power, this represents the
282           802.3af class of the device being powered.
283
284       $foundry->peth_port_neg_power()
285           The power, in milliwatts, that has been committed to this port.
286           This value is derived from the 802.3af class of the device being
287           powered.
288
289       $foundry->peth_port_power()
290           The power, in milliwatts, that the port is delivering.
291
292   Power Over Ethernet Module Table
293       These methods emulate the POWER-ETHERNET-MIB Main Power Source Entity
294       (PSE) Table "pethMainPseTable" methods using the FOUNDRY-POE-MIB Power
295       over Ethernet Port Table "snAgentPoeModuleTable ".
296
297       $foundry->peth_power_watts()
298           The power supply's capacity, in watts.
299
300       $foundry->peth_power_status()
301           The power supply's operational status.
302
303       $foundry->peth_power_consumption()
304           How much power, in watts, this power supply has been committed to
305           deliver.
306
307   Table Methods imported from SNMP::Info::Layer3
308       See documentation in "TABLE METHODS" in SNMP::Info::Layer3 for details.
309
310   Table Methods imported from SNMP::Info::FDP
311       See documentation in "TABLE METHODS" in SNMP::Info::FDP for details.
312

SET METHODS

314       These are methods that provide SNMP set functionality for overridden
315       methods or provide a simpler interface to complex set operations.  See
316       "SETTING DATA VIA SNMP" in SNMP::Info for general information on set
317       operations.
318
319       $foundry->set_i_vlan ( vlan, ifIndex )
320           Changes an access (untagged) port VLAN, must be supplied with the
321           numeric VLAN ID and port "ifIndex".  This method should only be
322           used on end station (non-trunk) ports.
323
324             Example:
325             my %if_map = reverse %{$foundry->interfaces()};
326             $foundry->set_i_vlan('2', $if_map{'FastEthernet0/1'})
327               or die "Couldn't change port VLAN. ",$foundry->error(1);
328
329
330
331perl v5.38.0                      2023-09-04  SNMP::Info::Layer3::Foundry(3pm)
Impressum