.\" .\" Copyright 2004 Massachusetts Institute of Technology .\" .\" Permission to use, copy, modify, and distribute this software and .\" its documentation for any purpose and without fee is hereby .\" granted, provided that both the above copyright notice and this .\" permission notice appear in all copies, that both the above .\" copyright notice and this permission notice appear in all .\" supporting documentation, and that the name of M.I.T. not be used .\" in advertising or publicity pertaining to distribution of the .\" software without specific, written prior permission. M.I.T. makes .\" no representations about the suitability of this software for any .\" purpose. It is provided "as is" without express or implied .\" warranty. .\" .\" THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS .\" ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE, .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT .\" SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF .\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND .\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .Dd January 9, 2004 .Dt ENTITYMIB 1 .Os .Sh NAME .Nm entitymib .Nd "display hardware configuration of a network device" .Sh SYNOPSIS .Nm .Op Fl S .Op Fl c Ar community .Op Fl l Ar secLevel .Op Fl u Ar secName .Op Fl v Ar version .Ar hostname .Sh DESCRIPTION The .Nm utility retrieves the .Tn SNMP Entity .Tn MIB from the .Tn SNMP agent located on .Ar hostname , and displays a summary of its hardware configuration. The hardware information is displayed in the form of an outline, with the contents of container entities indented and numbered according to the hierarchy defined by the Entity .Tn MIB . If .Ar hostname is a Cisco Systems switch, .Nm will also retrieve Cisco-specific hardware information including environmental sensor values and extended software information. .Pp The .Nm utility requires only read access, and only the .Tn MIB modules listed below. .Tn SNMP versions 2c and 3 are supported. .Ss MIB Modules Required .Bl -tag -width indent .It Li ENTITY-MIB Vendor-independent tables representing physical components of a network device. The .Nm program uses only .Li entPhysicalTable from this .Tn MIB . .It Li CISCO-ENTITY-SENSOR-MIB Cisco Systems proprietary tables representing type, current values, and alarm configuration for built-in environmental sensors in recent Cisco switches and routers. .It Li CISCO-ASSET-ENTITY-MIB Cisco Systems proprietary tables mostly duplicating the contents of .Li entPhysicalTable . The .Nm program uses only the .Li ceAssetSoftwareID entry from this .Tn MIB . .It Li CISCO-ENTITY-EXT-MIB Cisco Systems proprietary tables extending .Li entPhysicalTable . The .Nm program uses this MIB to determine the installed complement of memory in a Cisco device. .El .Pp Most of the options are used to control the .Xr SNMP 3 library. The options are as follows: .Bl -tag -width ".Fl c Ar community" .It Fl c Ar community When using .Tn SNMPv2c , use .Ar community as the community string for authentication. .It Fl l Ar secLevel When using .Tn SNMPv3 , the security level to be used to protect communications with the .Tn SNMP agent, if different from the library default. Possible values are .Ql noAuthNoPriv , .Ql authNoPriv , and .Ql authPriv . .It Fl S Do not include physical entities of type .Li sensor in the output. By default, sensors are labeled, and if the agent is supplied by Cisco Systems and supports the .Li CISCO-ENTITY-SENSOR-MIB , current sensor values and alarm thresholds will be displayed. .It Fl u Ar secName When using .Tn SNMPv3 , the security name (i.e., user name) to be used to authenticate to the agent, if different from the library default. .It Fl v Ar version Use the specified version of the .Tn SNMP protocol, rather than the default. Either .Ql 2c or .Ql 3 . .El .Sh ENVIRONMENT The .Nm command does not implement any environment variables of its own, but inherits all of the environment processing of .Xr SNMP 3 . .Sh EXAMPLES The following is an abbreviated example of the output from a typical invocation of the .Nm command: .Pp .Bd -literal Physical entities of "my-favorite-switch.example.com": -1 Cisco Systems Catalyst 6500 9-slot Chassis System (FRU) Cisco Systems WS-C6509 HW 3.0 S/N SAL00000000 \&... 5 Cisco Systems Catalyst 6500 9-slot Physical Slot 1 WS-SUP720-BASE 2 ports Supervisor Engine 720 Rev. 2.3 (FRU) Running software s72033-pk9sv-mz.122-17a.SX1.bin Cisco Systems WS-SUP720-BASE HW 2.3, FW 7.7(1), SW 12.2(17a)SX1 S/N SAD00000000 1 CPU of Switching Processor Installed RAM: 469762048 bytes Installed NVRAM: 1964024 bytes (46323 used) 1 Gigabit Port Container 1 1000BaseLH (FRU) FINISAR CORP. FTRJ-1319-7D-CSC S/N XXXXXXX 1 MSFC Container 1 WS-SUP720 MSFC3 Daughterboard Rev. 1.5 (FRU) Cisco Systems WS-SUP720 HW 1.5 S/N SAD00000000 1 CPU of Routing Processor 1 RP 5 outlet temperature Sensor - 34 degC (updated every 30 s, last Mon Nov 29 02:56:19 2004) - Minor threshold: sensor value >= 50 degC (currently false) - Major threshold: sensor value >= 65 degC (currently false) 2 RP 5 inlet temperature Sensor - 36 degC (updated every 30 s, last Mon Nov 29 02:56:19 2004) - Minor threshold: sensor value >= 50 degC (currently false) - Major threshold: sensor value >= 65 degC (currently false) \&... 1 Supervisor module 5 power-output-fail Sensor true 2 Supervisor module 5 outlet temperature Sensor - 35 degC (updated every 30 s, last Mon Nov 29 02:56:19 2004) - Minor threshold: sensor value >= 50 degC (currently false) - Major threshold: sensor value >= 65 degC (currently false) 3 Supervisor module 5 inlet temperature Sensor - 26 degC (updated every 30 s, last Mon Nov 29 02:56:19 2004) - Minor threshold: sensor value >= 45 degC (currently false) - Major threshold: sensor value >= 60 degC (currently false) \&... .Ed .Sh DIAGNOSTICS Poor. .Sh COMPATIBILITY Not all .Tn SNMP agents implement the Entity .Tn MIB , or do so correctly. This utility has not been tested against such implementations. .Sh SEE ALSO .Xr SNMP 3 .Sh AUTHORS The .Nm program and documentation were written by .An Garrett Wollman Aq wollman@csail.mit.edu . .Sh BUGS Error-checking and handling is practically nonexistent.