.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Info::Entity 3pm"
.TH Info::Entity 3pm "2016-12-21" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
SNMP::Info::Entity \- SNMP Interface to data stored in ENTITY\-MIB. RFC 2737
.SH "AUTHOR"
.IX Header "AUTHOR"
Max Baker
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 9
\& # Let SNMP::Info determine the correct subclass for you. 
\& my $entity = new SNMP::Info(
\&                          AutoSpecify => 1,
\&                          Debug       => 1,
\&                          DestHost    => \*(Aqmyswitch\*(Aq,
\&                          Community   => \*(Aqpublic\*(Aq,
\&                          Version     => 2
\&                        ) 
\&    or die "Can\*(Aqt connect to DestHost.\en";
\&
\& my $class      = $entity\->class();
\& print "SNMP::Info determined this device to fall under subclass : $class\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fIENTITY-MIB\fR is used by Layer 2 devices from Brocade, Cisco, \s-1HP,\s0
and more.
.PP
See \s-1RFC 2737\s0 for full details.
.PP
Create or use a device subclass that inherit this class.  Do not use directly.
.PP
For debugging purposes you can call this class directly as you would
SNMP::Info
.PP
.Vb 1
\& my $entity = new SNMP::Info::Entity (...);
.Ve
.SS "Inherited Classes"
.IX Subsection "Inherited Classes"
none.
.SS "Required MIBs"
.IX Subsection "Required MIBs"
.IP "\fIENTITY-MIB\fR" 4
.IX Item "ENTITY-MIB"
.PP
MIBs can be found at ftp://ftp.cisco.com/pub/mibs/v2/v2.tar.gz
.SH "GLOBALS"
.IX Header "GLOBALS"
none.
.SH "TABLE METHODS"
.IX Header "TABLE METHODS"
These are methods that return tables of information in the form of a reference
to a hash.
.SS "Entity Table"
.IX Subsection "Entity Table"
.ie n .IP "$entity\->\fIe_index()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_index()\fR" 4
.IX Item "$entity->e_index()"
Index
.Sp
(\f(CW\*(C`entPhysicalIndex\*(C'\fR)
.ie n .IP "$entity\->\fIe_alias()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_alias()\fR" 4
.IX Item "$entity->e_alias()"
Human entered, not usually used.
.Sp
(\f(CW\*(C`entPhysicalAlias\*(C'\fR)
.ie n .IP "$entity\->\fIe_class()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_class()\fR" 4
.IX Item "$entity->e_class()"
Stack, Module, Container, Port ...
.Sp
(\f(CW\*(C`entPhysicalClass\*(C'\fR)
.ie n .IP "$entity\->\fIe_descr()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_descr()\fR" 4
.IX Item "$entity->e_descr()"
Human Friendly
.Sp
(\f(CW\*(C`entPhysicalClass\*(C'\fR)
.ie n .IP "$entity\->\fIe_fwver()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_fwver()\fR" 4
.IX Item "$entity->e_fwver()"
(\f(CW\*(C`entPhysicalFirmwareRev\*(C'\fR)
.ie n .IP "$entity\->\fIe_fru()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_fru()\fR" 4
.IX Item "$entity->e_fru()"
\&\s-1BOOLEAN.\s0 Is a Field Replaceable unit?
.Sp
(\f(CW\*(C`entPhysicalFRU\*(C'\fR)
.ie n .IP "$entity\->\fIe_hwver()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_hwver()\fR" 4
.IX Item "$entity->e_hwver()"
(\f(CW\*(C`entPhysicalHardwareRev\*(C'\fR)
.ie n .IP "$entity\->\fIe_id()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_id()\fR" 4
.IX Item "$entity->e_id()"
This is human entered and not normally used.
.Sp
(\f(CW\*(C`entPhysicalAssetID\*(C'\fR)
.ie n .IP "$entity\->\fIe_map()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_map()\fR" 4
.IX Item "$entity->e_map()"
See \s-1MIB.\s0
.Sp
(\f(CW\*(C`entAliasMappingIdentifier\*(C'\fR)
.ie n .IP "$entity\->\fIe_model()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_model()\fR" 4
.IX Item "$entity->e_model()"
Model Name of Entity.
.Sp
(\f(CW\*(C`entPhysicalModelName\*(C'\fR)
.ie n .IP "$entity\->\fIe_name()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_name()\fR" 4
.IX Item "$entity->e_name()"
More computer friendly name of entity.  Parse me.
.Sp
(\f(CW\*(C`entPhysicalName\*(C'\fR)
.ie n .IP "$entity\->\fIe_parent()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_parent()\fR" 4
.IX Item "$entity->e_parent()"
0 if root.
.Sp
(\f(CW\*(C`entPhysicalContainedIn\*(C'\fR)
.ie n .IP "$entity\->\fIe_port()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_port()\fR" 4
.IX Item "$entity->e_port()"
Maps Entity Table entries to the Interface Table (\f(CW\*(C`IfTable\*(C'\fR) using
\&\f(CW$entity\fR\->\fIe_map()\fR
.ie n .IP "$entity\->\fIe_pos()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_pos()\fR" 4
.IX Item "$entity->e_pos()"
The relative position among all entities sharing the same parent.
.Sp
(\f(CW\*(C`entPhysicalParentRelPos\*(C'\fR)
.ie n .IP "$entity\->\fIe_serial()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_serial()\fR" 4
.IX Item "$entity->e_serial()"
(\f(CW\*(C`entPhysicalSerialNum\*(C'\fR)
.ie n .IP "$entity\->\fIe_swver()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_swver()\fR" 4
.IX Item "$entity->e_swver()"
(\f(CW\*(C`entPhysicalSoftwareRev\*(C'\fR)
.ie n .IP "$entity\->\fIe_type()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_type()\fR" 4
.IX Item "$entity->e_type()"
This is an \s-1OID,\s0 which gets munged into the object name if the right
\&\s-1MIB\s0 is loaded.
.Sp
(\f(CW\*(C`entPhysicalVendorType\*(C'\fR)
.ie n .IP "$entity\->\fIe_vendor()\fR" 4
.el .IP "\f(CW$entity\fR\->\fIe_vendor()\fR" 4
.IX Item "$entity->e_vendor()"
Vendor of Module.
.Sp
(\f(CW\*(C`entPhysicalMfgName\*(C'\fR)