SNMP Agent Extension -- Implementing the INTEL(R)-LAN-ADAPTERS MIB              
==================================================================

February 2002


Contents
========

- Overview
- Prerequisites
- Installation
- Functionality
- License


Overview
========

The SNMP agent extension extends the UCD-SNMP agent for Linux* via the SNMP 
"pass-through" protocol. It provides information on the Intel(R) PRO LAN 
adapters (10/100/1000) through the adapter drivers (e100, e1000). It also 
provides information about advanced features, including teaming and VLANs, 
through the Advanced Networking Services (ANS) module.


Prerequisites
==============

The SNMP agent package works best when the Intel PRO LAN adapter drivers 
(e100, e1000) and/or the Intel ANS module (ians) are installed and loaded on 
the system. However, the package works with any combination of the three 
modules mentioned above.

In addition, an SNMP agent which supports the "pass-through" protocol should 
be installed on the system. The extension was tested on Red Hat* 7.0 with 
ucd-snmp-4.1.2 SNMP agent installed and on Red Hat 7.1 with ucd-snmp-4.2 
SNMP agent installed.


Installation
============

1. Copy the application executable file, 'inic_extension', to any public
   directory, such as '/usr/local/sbin'.

2. Configure your pre-installed SNMP agent so that it runs the above 
   executable with any access to the Intel MIB subtree 
   (.1.3.6.1.4.1.343.2.7.2). With the UCD-SNMP (NET-SNMP) SNMP agent, this is
   done by editing the '/etc/snmp/snmpd.conf' file and adding the following 
   line:

    pass .1.3.6.1.4.1.343.2.7.2 /usr/local/sbin/inic_extension

   Your SNMP agent is now ready to run.


3. Install the clients. Copy the MIB files (INTEL-Common-MIB.txt,
   INTEL-LAN-ADAPTERS-MIB.txt) to every management station, placing them in 
   the relevant MIBS directory. This varies according to the SNMP MIB 
   browser/application you are using.
 
For more information concerning the UCD-SNMP (NET-SNMP) package, go to 
http://net-SNMP.sourceforge.net.


Functionality
============

The SNMP extension implements the following MIB branch. The branch is 
located under the Intel branch at:

	.intel.products.nic-products.intel-lan-adapters

Full OID: .1.3.6.1.4.1.343.2.7.2

+--intel-lan-adapters(2)
   |
   +--component-description(1)
   |  |
   |  +-- -R-- String    company(1)
   |  |        Textual Convention: DisplayString
   |  |        Size: 0..255
   |  +-- -R-- String    description(2)
   |  |        Textual Convention: DisplayString
   |  |        Size: 0..255
   |  +-- -R-- String    operatingSystem(3)
   |  |        Textual Convention: DisplayString
   |  |        Size: 0..255
   |  +-- -R-- String    mibVersion1-0-0(4)
   |  |        Textual Convention: DisplayString
   |  |        Size: 0..255
   |  +-- -R-- String    mibVersionSupported(5)
   |  |        Textual Convention: DisplayString
   |  |        Size: 0..255
   |  +-- -R-- String    agentExtensionVersion(6)
   |  |        Textual Convention: DisplayString
   |  |        Size: 0..255
   |  +-- -R-- EnumVal   status(7)
   |           Values: baseDriverNotLoadedAnsNotLoaded(0), 
   |                   baseDriverLoadedAnsNotLoaded(1), 
   |                   baseDriverNotLoadedAnsLoaded(2), 
   |                   baseDriverLoadedAnsLoaded(3)
   |
   +--adapterTables(2)
   |  |
   |  +--genericAdapterAttrTables(1)
   |  |  |
   |  |  +--genericAdapterAttrTable(1)
   |  |  |  |
   |  |  |  +--genericAdapterAttrEntry(1)
   |  |  |     |
   |  |  |     +-- -R-- Integer   adapterIndex(1)
   |  |  |     |        Textual Convention: InterfaceIndex
   |  |  |     |        Range: 1..2147483647
   |  |  |     +-- -R-- String    adapterName(2)
   |  |  |     |        Textual Convention: DisplayString
   |  |  |     |        Size: 0..255
   |  |  |     +-- -R-- EnumVal   adapterType(3)
   |  |  |              Values: standAlone(0), teamMember(1), virtual(2)
   |  |  |
   |  |  +--genericAdapterAttrDriversTable(2)
   |  |  |  |
   |  |  |  +--genericAdapterAttrDriversEntry(1)
   |  |  |     |
   |  |  |     +-- -R-- String    adapterDriverName(1)
   |  |  |     |        Textual Convention: DisplayString
   |  |  |     |        Size: 0..255
   |  |  |     +-- -R-- String    adapterDriverInfo(2)
   |  |  |     |        Textual Convention: DisplayString
   |  |  |     |        Size: 0..255
   |  |  |     +-- -R-- String    adapterDriverVersion(3)
   |  |  |     |        Textual Convention: DisplayString
   |  |  |     |        Size: 0..255
   |  |  |     +-- -R-- String    adapterDriverPath(4)
   |  |  |     |        Textual Convention: DisplayString
   |  |  |     |        Size: 0..255
   |  |  |     +-- -R-- String    adapterDriverDate(5)
   |  |  |     |        Textual Convention: DisplayString
   |  |  |     |        Size: 0..255
   |  |  |     +-- -R-- String    adapterDriverSize(6)
   |  |  |              Textual Convention: DisplayString
   |  |  |              Size: 0..255
   |  |  |
   |  |  +--genericAdapterAttrTrafficStatsTable(3)
   |  |     |
   |  |     +--genericAdapterAttrTrafficStatsEntry(1)
   |  |        |
   |  |        +-- -R-- Counter   adapterRxPackets(1)
   |  |        +-- -R-- Counter   adapterTxPackets(2)
   |  |        +-- -R-- Counter   adapterRxBytes(3)
   |  |        +-- -R-- Counter   adapterTxBytes(4)
   |  |        +-- -R-- Counter   adapterRxErrors(5)
   |  |        +-- -R-- Counter   adapterTxErrors(6)
   |  |        +-- -R-- Counter   adapterRxDropped(7)
   |  |        +-- -R-- Counter   adapterTxDropped(8)
   |  |        +-- -R-- Counter   adapterRxMulticast(9)
   |  |        +-- -R-- Counter   adapterCollisions(10)
   |  |
   |  +--physicalAdapterAttrTables(2)
   |  |  |
   |  |  +--physicalAdapterAttrTable(1)
   |  |  |  |
   |  |  |  +--physicalAdapterAttrEntry(1)
   |  |  |     |
   |  |  |     +-- -R-- Integer   physicalAdapterIndex(1)
   |  |  |     |        Textual Convention: InterfaceIndex
   |  |  |     |        Range: 1..2147483647
   |  |  |     +-- -R-- EnumVal   physicalAdapterLinkStatus(2)
   |  |  |     |        Values: link-up(0), link-down(1)
   |  |  |     +-- -RW- Counter   physicalAdapterLinkStatusChangesCounter(3)
   |  |  |     +-- -R-- Gauge     physicalAdapterSpeed(4)
   |  |  |     +-- -R-- EnumVal   physicalAdapterDplxMode(5)
   |  |  |     |        Values: not-available(0), half(1), full(2)
   |  |  |     +-- -R-- EnumVal   physicalAdapterAutoNegotiation(6)
   |  |  |     |        Values: on(0), off(1)
   |  |  |     +-- -R-- Integer   physicalAdapterPciBus(7)
   |  |  |     +-- -R-- Integer   physicalAdapterPciSlot(8)
   |  |  |     +-- -R-- Integer   physicalAdapterIrq(9)
   |  |  |     +-- -R-- String    physicalAdapterCurrentNA(10)
   |  |  |     |        Textual Convention: PhysAddress
   |  |  |     +-- -R-- String    physicalAdapterPermanentNA(11)
   |  |  |              Textual Convention: PhysAddress
   |  |  |
   |  |  +--physicalAdapterAttrChecksumOffloadTable(2)
   |  |     |
   |  |     +--physicalAdapterAttrChecksumOffloadEntry(1)
   |  |        |
   |  |        +-- -R-- EnumVal   physicalAdapterTcpRxChecksumOffLoadEnable(1)
   |  |        |        Values: enabled(0), disabled(1)
   |  |        +-- -R-- Counter   physicalAdapterTcpRxChecksumBad(2)
   |  |        +-- -R-- EnumVal   physicalAdapterTcpTxChecksumOffLoadEnable(3)
   |  |                 Values: enabled(0), disabled(1)
   |  |
   |  +--virtualAdapterAttrTables(3)
   |  |  |
   |  |  +--virtualAdapterAttrTable(1)
   |  |  |  |
   |  |  |  +--virtualAdapterAttrEntry(1)
   |  |  |     |
   |  |  |     +-- -R-- Integer   virtualAdapterIndex(1)
   |  |  |     |        Textual Convention: InterfaceIndex
   |  |  |     |        Range: 1..2147483647
   |  |  |     +-- -R-- Integer   virtualAdapterTeamId(2)
   |  |  |
   |  |  +--virtualAdapterAttrVlanTable(2)
   |  |     |
   |  |     +--virtualAdapterAttrVlanEntry(1)
   |  |        |
   |  |        +-- -R-- EnumVal   virtualAdapterVlanId(1)
   |  |                 Values: none(0)
   |  |
   |  +--teamAttrTables(4)
   |  |  |
   |  |  +--teamAttrTable(1)
   |  |  |  |
   |  |  |  +--teamAttrEntry(1)
   |  |  |     |
   |  |  |     +-- -R-- Integer   teamId(1)
   |  |  |     +-- -R-- Integer   teamNumberOfMembers(2)
   |  |  |     +-- -R-- Integer   teamNumberOfVirtualAdapters(3)
   |  |  |
   |  |  +--teamAttrVlanTable(2)
   |  |  |  |
   |  |  |  +--teamAttrVlanEntry(1)
   |  |  |     |
   |  |  |     +-- -R-- EnumVal   teamVlanTaggingType(1)
   |  |  |     |        Values: none(0), tag-802-1Q(1), tag-802-1P(2), 
   |  |  |     |                tag-802-3AC(3), tag-iSL(4)
   |  |  |     +-- -R-- EnumVal   teamVlanGvrpSupport(2)
   |  |  |              Values: enabled(0), disabled(1)
   |  |  |
   |  |  +--teamAttrAdapterTeamingTable(3)
   |  |     |
   |  |     +--teamAttrAdapterTeamingEntry(1)
   |  |        |
   |  |        +-- -R-- String    teamAdapterTeamingTeamName(1)
   |  |        |        Textual Convention: DisplayString
   |  |        |        Size: 0..255
   |  |        +-- -R-- EnumVal   teamAdapterTeamingMode(2)
   |  |        |        Values: none(0), team-aft(1), team-alb(2), 
   |  |        |                team-fec(3), team-gec(4), team-802-3ad(5)
   |  |        +-- -R-- EnumVal   teamAdapterTeamingLinkState(3)
   |  |        |        Values: up(0), down(1)
   |  |        +-- -R-- Gauge     teamAdapterTeamingSpeed(4)
   |  |        +-- -R-- EnumVal   teamAdapterTeamingProbesState(5)
   |  |        |        Values: probes-enabled(0), probes-disabled(1)
   |  |        +-- -R-- EnumVal   teamAdapterTeamingProbesMode(6)
   |  |        |        Values: broadcast(0), multicast(1), not-available(2)
   |  |        +-- -R-- EnumVal   teamAdapterTeamingLoadBalanceRefresh(7)
   |  |        |        Values: not-available(0)
   |  |        +-- -R-- EnumVal   teamAdapterTeamingProbesSendTime(8)
   |  |        |        Values: not-available(0)
   |  |        +-- -R-- EnumVal   teamAdapterTeamingPreferredPrimaryIndex(9)
   |  |        |        Values: not-available(0)
   |  |        +-- -R-- EnumVal   teamAdapterTeamingCurrentPrimaryIndex(10)
   |  |        |        Values: not-available(0)
   |  |        +-- -R-- EnumVal   teamAdapterTeamingPreviousPrimaryIndex(11)
   |  |        |        Values: not-available(0)
   |  |        +-- -RW- Counter   teamAdapterTeamingFailoverCounter(12)
   |  |
   |  +--teamMemberAttrTables(5)
   |     |
   |     +--teamMemberAttrTable(1)
   |     |  |
   |     |  +--teamMemberAttrEntry(1)
   |     |     |
   |     |     +-- -R-- Integer   teamMemberIndex(1)
   |     |     |        Textual Convention: InterfaceIndex
   |     |     |        Range: 1..2147483647
   |     |     +-- -R-- Integer   teamMemberTeamId(2)
   |     |
   |     +--teamMemberAttrAdapterTeamingTable(2)
   |        |
   |        +--teamMemberAttrAdapterTeamingEntry(1)
   |           |
   |           +-- -R-- EnumVal   teamMemberAdapterTeamingState(1)
   |           |        Values: active(0), disabled(1), standby(2), 
   |           |                active-secondary(3)
   |           +-- -RW- Counter   teamMemberAdapterTeamingFailureCounter(2)
   |           +-- -R-- EnumVal   teamMemberAdapterTeamingPriority(3)
   |                    Values: none(0), primary(1), secondary(2)
   |
   +--events(3)
      |
      +--physicalAdapterEvents(1)
      |  |
      |  +--physicalAdapterTraps(1)
      |  |  |
      |  |  +--physicalAdapterLinkUpTrap(1)
      |  |  |
      |  |  +--physicalAdapterLinkDownTrap(2)
      |  |  |
      |  |  +--physicalAdapterAddedTrap(3)
      |  |  |
      |  |  +--physicalAdapterRemovedTrap(4)
      |  |
      |  +-- -RW- EnumVal   physicalAdapterLinkUpDownTrapEnable(2)
      |  |        Values: disabled(0), enabled(1)
      |  +-- -RW- EnumVal   physicalAdapterAddedRemovedTrapEnable(3)
      |           Values: disabled(0), enabled(1)
      |
      +--virtualAdapterEvents(2)
      |  |
      |  +--virtualAdapterTraps(1)
      |  |  |
      |  |  +--virtualAdapterAddedTrap(1)
      |  |  |
      |  |  +--virtualAdapterRemovedTrap(2)
      |  |
      |  +-- -RW- EnumVal   virutalAdapterTrapEnable(2)
      |           Values: disabled(0), enabled(1)
      |
      +--teamEvents(3)
      |  |
      |  +--teamTraps(1)
      |  |  |
      |  |  +--teamAdapterTeamingFailoverTrap(1)
      |  |  |
      |  |  +--teamAddedTrap(2)
      |  |  |
      |  |  +--teamRemovedTrap(3)
      |  |
      |  +-- -RW- EnumVal   teamTrapEnable(2)
      |           Values: disabled(0), enabled(1)
      |
      +--teamMemberEvents(4)
         |
         +--teamMemberTraps(1)
         |  |
         |  +--teamMemberAddedTrap(1)
         |  |
         |  +--teamMemberRemovedTrap(2)
         |
         +-- -RW- EnumVal   teamMemberTrapEnable(2)
                  Values: disabled(0), enabled(1)

* This tree is the output from the UCD SNMPtranslate utility.


License
=======

This software program is released under the terms of a license agreement 
between you ('Licensee') and Intel. Do not use or load this software or any 
associated materials (collectively, the 'Software') until you have carefully 
read the full terms and conditions of the LICENSE located in this software 
package. By loading or using the Software, you agree to the terms of this 
Agreement. If you do not agree with the terms of this Agreement, do not 
install or use the Software.

* Other names and brands may be claimed as the property of others.