1SNMP::Info::Layer3::FouUnsderry(C3o)ntributed Perl DocumSeNnMtPa:t:iIonnfo::Layer3::Foundry(3)
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     => 1
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       Abstraction subclass for Brocade (Foundry) Networks devices.
29
30       For speed or debugging purposes you can call the subclass directly, but
31       not after determining a more specific class using the method above.
32
33        my $foundry = new SNMP::Info::Layer3::Foundry(...);
34
35   Inherited Classes
36       SNMP::Info::Layer3;
37       SNMP::Info::FDP;
38       SNMP::Info::LLDP;
39
40   Required MIBs
41       FOUNDRY-SN-ROOT-MIB
42       FOUNDRY-SN-AGENT-MIB
43       FOUNDRY-SN-SWITCH-GROUP-MIB
44       FOUNDRY-SN-STACKING-MIB
45       FOUNDRY-POE-MIB
46       FOUNDRY-SN-SWITCH-GROUP-MIB
47       Inherited Classes' MIBs
48           See "Required MIBs" in SNMP::Info::Layer3 for its own MIB
49           requirements.
50
51           See "Required MIBs" in SNMP::Info::FDP for its own MIB
52           requirements.
53
54           See "Required MIBs" in SNMP::Info::LLDP for its own MIB
55           requirements.
56

GLOBALS

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

TABLE METHODS

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