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

GLOBALS

47       none.
48

TABLE METHODS

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