NAME

       SNMP::Info::Layer3::BayRS - SNMP Interface to Avaya/Nortel routers running BayRS.

AUTHOR

       Eric Miller

SYNOPSIS

        # Let SNMP::Info determine the correct subclass for you.
        my $bayrs = new SNMP::Info(
                                 AutoSpecify => 1,
                                 Debug       => 1,
                                 DestHost    => 'myswitch',
                                 Community   => 'public',
                                 Version     => 2
                               )
           or die "Can't connect to DestHost.\n";

        my $class      = $bayrs->class();
        print "SNMP::Info determined this device to fall under subclass : $class\n";

DESCRIPTION

       Abstraction subclass for routers running Avaya/Nortel BayRS.

       For speed or debugging purposes you can call the subclass directly, but not after
       determining a more specific class using the method above.

        my $bayrs = new SNMP::Info::Layer3::BayRS(...);

   Inherited Classes
       SNMP::Info
       SNMP::Info::Bridge
       SNMP::Info::Layer3

   Required MIBs
       Wellfleet-HARDWARE-MIB
       Wellfleet-MODULE-MIB
       Wellfleet-OSPF-MIB
       Wellfleet-DOT1QTAG-CONFIG-MIB
       Wellfleet-CSMACD-MIB

   Inherited MIBs
       See "Required MIBs" in SNMP::Info for its own MIB requirements.

       See "Required MIBs" in SNMP::Info::Bridge for its own MIB requirements.

       See "Required MIBs" in SNMP::Info::Layer3 for its own MIB requirements.

GLOBALS

       These are methods that return scalar value from SNMP

       $bayrs->model()
           Returns the model of the BayRS router.  Will translate between the MIB model and the
           common model with this map :

               C<%MODEL_MAP = (
                   'acefn'     => 'FN',
                   'aceln'     => 'LN',
                   'acecn'     => 'CN',
                   'afn'       => 'AFN',
                   'in'        => 'IN',
                   'an'        => 'AN',
                   'arn'       => 'ARN',
                   'sys5000'   => '5000',
                   'freln'     => 'BLN',
                   'frecn'     => 'BCN',
                   'frerbln'   => 'BLN-2',
                   'asn'       => 'ASN',
                   'asnzcable' => 'ASN-Z',
                   'asnbcable' => 'ASN-B',
                   );>

       $bayrs->vendor()
           Returns 'avaya'

       $bayrs->os()
           Returns 'bayrs'

       $bayrs->os_ver()
           Returns the software version extracted from "sysDescr"

       $bayrs->serial()
           Returns ("wfHwBpSerialNumber") after conversion to ASCII decimal

       $bayrs->root_ip()
           Returns the primary IP used to communicate with the router.

           Returns the first found:  CLIP (CircuitLess IP), ("wfOspfRouterId"), or undefined.

   Globals imported from SNMP::Info
       See documentation in "GLOBALS" in SNMP::Info for details.

   Globals imported from SNMP::Info::Bridge
       See documentation in "GLOBALS" in SNMP::Info::Bridge for details.

   Globals imported from SNMP::Info::Layer3
       See documentation in "GLOBALS" in SNMP::Info::Layer3 for details.

TABLE METHODS

       These are methods that return tables of information in the form of a reference to a hash.

       Note:  These methods do not support partial table fetches, a partial can be passed but the
       entire table will be returned.

   Overrides
       $bayrs->interfaces()
           Returns reference to the map between IID and physical Port.

           The physical port name is stripped to letter and numbers to signify port type and slot
           port (S11) if the default platform naming was maintained.  Otherwise the port is the
           interface description.

       $bayrs->i_name()
           Returns ("ifDescr") along with VLAN name ("wfDot1qTagCfgVlanName") for VLAN
           interfaces.

       $bayrs->i_duplex()
           Returns reference to hash.  Maps port operational duplexes to IIDs for Ethernet
           interfaces.

       $bayrs->i_duplex_admin()
           Returns reference to hash.  Maps port admin duplexes to IIDs for Ethernet interfaces.

       $bayrs->i_vlan()
           Returns reference to hash.  Maps port VLAN ID to IIDs.

   Pseudo ENTITY-MIB information
       These methods emulate ENTITY-MIB Physical Table methods using Wellfleet-HARDWARE-MIB and
       Wellfleet-MODULE-MIB.

       $bayrs->e_index()
           Returns reference to hash.  Key and Value: Integer. The index is created by combining
           the slot, module, and position into a five or six digit integer.  Slot can be either
           one or two digits while the module and position are each two digits padded with
           leading zero if required.

       $bayrs->e_class()
           Returns reference to hash.  Key: IID, Value: General hardware type.  This class only
           returns container and module types.

       $bayrs->e_descr()
           Returns reference to hash.  Key: IID, Value: Human friendly name.

       $bayrs->e_name()
           Returns reference to hash.  Key: IID, Value: Human friendly name.

       $bayrs->e_hwver()
           Returns reference to hash.  Key: IID, Value: Hardware version.

       $bayrs->e_vendor()
           Returns reference to hash.  Key: IID, Value: avaya.

       $bayrs->e_serial()
           Returns reference to hash.  Key: IID, Value: Serial number.

       $bayrs->e_pos()
           Returns reference to hash.  Key: IID, Value: The relative position among all entities
           sharing the same parent.

       $bayrs->e_type()
           Returns reference to hash.  Key: IID, Value: Type of component/sub-component as
           defined in Wellfleet-HARDWARE-MIB for processors and link modules or Wellfleet-MODULE-
           MIB for hardware modules.

       $bayrs->e_fwver()
           Returns reference to hash.  Key: IID, Value: Firmware revision.  Only available on
           processors.

       $bayrs->e_swver()
           Returns reference to hash.  Key: IID, Value: Software revision.  Only available on
           processors.

       $bayrs->e_parent()
           Returns reference to hash.  Key: IID, Value: The value of e_index() for the entity
           which 'contains' this entity.  A value of zero indicates   this entity is not
           contained in any other entity.

   Table Methods imported from SNMP::Info
       See documentation in "TABLE METHODS" in SNMP::Info for details.

   Table Methods imported from SNMP::Info::Bridge
       See documentation in "TABLE METHODS" in SNMP::Info::Bridge for details.

   Table Methods imported from SNMP::Info::Layer3
       See documentation in "TABLE METHODS" in SNMP::Info::Layer3 for details.

Data Munging Callback Subroutines

       $bayrs->munge_hw_rev()
           Converts octets to a decimal major.minor string.

       $bayrs->munge_wf_serial()
           Coverts octets to a decimal string.