Info::Layer2::Catalyst(3)

NAME
SNMP::Info::Layer2::Catalyst - SNMP Interface to Cisco Catalyst devices running Catalyst OS.

AUTHOR
Max Baker

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

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

DESCRIPTION
SNMP::Info subclass to provide information for Cisco Catalyst series switches running CatOS.

This class includes the Catalyst 2920, 4000, 5000, 6000 (hybrid mode) families.

This subclass is not for all devices that have the name Catalyst. Note that some Catalyst switches run IOS, like the 2900 and 3550 families. Cisco Catalyst 1900 switches use their own MIB and have a separate subclass. Use the method above to have SNMP::Info determine the appropriate subclass before using this class directly.

See SNMP::Info::device_type() for specifics.

Note: Some older Catalyst switches will only talk SNMP version 1. Some newer ones will not return all their data if connected via Version 1.

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

 my $cat = new SNMP::Info::Layer2::Catalyst(...);

  Inherited Classes

SNMP::Info::CiscoStack
SNMP::Info::CiscoVTP
SNMP::Info::CDP
SNMP::Info::CiscoStats
SNMP::Info::CiscoPortSecurity
SNMP::Info::Layer2

  Required MIBs

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

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

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

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

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

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

These MIBs are found in the standard v2 MIBs from Cisco.

GLOBALS
These are methods that return scalar value from SNMP

$cat->os()
    Returns 'catalyst'

$cat->os_ver()
    Tries to use the value from SNMP::Info::CiscoStats->os_ver() and if it fails it grabs $cat->m_swver()->{1} and uses that.

$cat->vendor()
    Returns 'cisco'

$cat->cisco_comm_indexing()
    Returns 1. Use vlan indexing.

  Global Methods imported from SNMP::Info::CiscoStack
See documentation in "GLOBALS" in SNMP::Info::CiscoStack for details.

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

  Global Methods imported from SNMP::Info::CDP
See documentation in "GLOBALS" in SNMP::Info::CDP for details.

  Global Methods imported from SNMP::Info::CiscoStats
See documentation in "GLOBALS" in SNMP::Info::CiscoStats for details.

  Global Methods imported from SNMP::Info::CiscoPortSecurity
See documentation in "GLOBALS" in SNMP::Info::CiscoPortSecurity for details.

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

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

  Overrides

$cat->interfaces()
    Returns the map between SNMP Interface Identifier (iid) and physical port name.

$cat->i_name()
    Returns reference to hash of iid to human set name.

    "portName"

$cat->i_physical()
    Returns a map to IID for ports that are physical ports, not vlans, etc.

$cat->bp_index()
    Returns reference to hash of bridge port table entries map back to interface identifier (iid)

    Crosses ("portCrossIndex") to ("portIfIndex") since some devices seem to have problems with BRIDGE-MIB

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

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

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

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

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

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