1SNMP::Info::Entity(3) User Contributed Perl DocumentationSNMP::Info::Entity(3)
2
3
4

NAME

6       SNMP::Info::Entity - SNMP Interface to data stored in ENTITY-MIB. RFC
7       2737
8

AUTHOR

10       Max Baker
11

SYNOPSIS

13        # Let SNMP::Info determine the correct subclass for you.
14        my $entity = 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      = $entity->class();
24        print "SNMP::Info determined this device to fall under subclass : $class\n";
25

DESCRIPTION

27       ENTITY-MIB is used by Layer 2 devices from Brocade, Cisco, HP, and
28       more.
29
30       See RFC 2737 for full details.
31
32       Create or use a device subclass that inherit this class.  Do not use
33       directly.
34
35       For debugging purposes you can call this class directly as you would
36       SNMP::Info
37
38        my $entity = new SNMP::Info::Entity (...);
39
40   Inherited Classes
41       none.
42
43   Required MIBs
44       ENTITY-MIB
45
46       MIBs can be found at ftp://ftp.cisco.com/pub/mibs/v2/v2.tar.gz
47

GLOBALS

49       none.
50

TABLE METHODS

52       These are methods that return tables of information in the form of a
53       reference to a hash.
54
55       $entity->entity_derived_serial()
56           Tries to determine the device serial number from the ENTITY-MIB.
57           Only considers serial numbers for entries without a parent, or if
58           they are of type chassis. Looks at "entPhysicalSerialNum" and then
59           "entPhysicalDescr" for serial number.
60
61       $entity->entity_derived_os_ver()
62           Tries to determine the device OS version from the ENTITY-MIB. Only
63           considers serial numbers for entries without a parent, or if they
64           are of type chassis. Looks at "entPhysicalSoftwareRev" for the
65           version.
66
67   Entity Table
68       $entity->e_index()
69           Index
70
71           ("entPhysicalIndex")
72
73       $entity->e_alias()
74           Human entered, not usually used.
75
76           ("entPhysicalAlias")
77
78       $entity->e_class()
79           Stack, Module, Container, Port ...
80
81           ("entPhysicalClass")
82
83       $entity->e_descr()
84           Human Friendly
85
86           ("entPhysicalClass")
87
88       $entity->e_fwver()
89           ("entPhysicalFirmwareRev")
90
91       $entity->e_fru()
92           BOOLEAN. Is a Field Replaceable unit?
93
94           ("entPhysicalFRU")
95
96       $entity->e_hwver()
97           ("entPhysicalHardwareRev")
98
99       $entity->e_id()
100           This is human entered and not normally used.
101
102           ("entPhysicalAssetID")
103
104       $entity->e_map()
105           See MIB.
106
107           ("entAliasMappingIdentifier")
108
109       $entity->e_model()
110           Model Name of Entity.
111
112           ("entPhysicalModelName")
113
114       $entity->e_name()
115           More computer friendly name of entity.  Parse me.
116
117           ("entPhysicalName")
118
119       $entity->e_parent()
120           0 if root.
121
122           ("entPhysicalContainedIn")
123
124       $entity->e_port()
125           Maps Entity Table entries to the Interface Table ("IfTable") using
126           $entity->e_map()
127
128       $entity->e_pos()
129           The relative position among all entities sharing the same parent.
130
131           ("entPhysicalParentRelPos")
132
133       $entity->e_serial()
134           ("entPhysicalSerialNum")
135
136       $entity->e_swver()
137           ("entPhysicalSoftwareRev")
138
139       $entity->e_type()
140           This is an OID, which gets munged into the object name if the right
141           MIB is loaded.
142
143           ("entPhysicalVendorType")
144
145       $entity->e_vendor()
146           Vendor of Module.
147
148           ("entPhysicalMfgName")
149
150
151
152perl v5.28.1                      2019-04-04             SNMP::Info::Entity(3)