NAME

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

AUTHOR

Max Baker (max@warped.org)

SYNOPSIS

 # Let SNMP::Info determine the correct subclass for you. 
 my $cat = new SNMP::Info(
                          AutoSpecify => 1,
                          Debug       => 1,
                          # These arguments are passed directly on to SNMP::Session
                          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 switches running CatOS.

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.

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::Layer2

Required MIBs

CISCO-STACK-MIB
CISCO-VTP-MIB
Inherited Classes' MIBs: See 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->broadcast(): (sysBroadcast)
$cat->fan(): (chassisFanStatus)
$cat->model(): (chassisModel)
$cat->netmask(): (sysNetMask)
$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->ps1_type(): (chassisPs1Type)
$cat->ps2_type(): (chassisPs2Type)
$cat->ps1_status(): (chassisPs1Status)
$cat->ps2_status(): (chassisPs2Status)
$cat->serial(): (chassisSerialNumberString)
$cat->slots(): (chassisNumSlots)
$cat->vendor(): Returns 'cisco'

Globals imported from SNMP::Info::Layer2

See documentation in SNMP::Info::Layer2 for details.

TABLE ENTRIES

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

Overrides

$cat->interfaces()

Crosses p_port() with i_index() to get physical names.

$cat->i_physical()

Returns a map to IID for ports that are physical ports, not vlans, etc.

$cat->i_type()

Crosses p_port() with p_type() and returns the results.

Overrides with ifType if p_type() isn't available.

$cat->i_name()

Crosses p_name with p_port and returns results.

$cat->i_duplex()

Crosses p_duplex with p_port and returns results.

$cat->i_duplex_admin()

Crosses p_duplex_admin with p_port.

Munges bit_string returned from p_duplex_admin to get duplex settings.

Module table

This table holds configuration information for each of the blades installed in the Catalyst device.

$cat->m_type()

(moduleType)

$cat->m_model()

(moduleModel)

$cat->m_serial()

(moduleSerialNumber)

$cat->m_status()

(moduleStatus)

$cat->m_name()

(moduleName)

$cat->m_ports()

(moduleNumPorts)

$cat->m_ports_status()

Returns a list of space separated status strings for the ports.

To see the status of port 4 :

    @ports_status = split(' ', $cat->m_ports_status() );
    $port4 = $ports_status[3];

(modulePortStatus)

$cat->m_ports_hwver()

(moduleHwVersion)

$cat->m_ports_fwver()

(moduleFwVersion)

$cat->m_ports_swver()

(moduleSwVersion)

$cat->m_ports_ip()

(moduleIPAddress)

$cat->m_ports_sub1()

(moduleSubType)

$cat->m_ports_sub2()

(moduleSubType2)

Modules - Router Blades

$cat->m_ip(): (moduleIPAddress)
$cat->m_sub1(): (moduleSubType)
$cat->m_sub2(): (moduleSubType2)

Port Entry Table (CISCO-STACK-MIB::portTable)

$cat->p_name(): (portName)
$cat->p_type(): (portType)
$cat->p_status(): (portOperStatus)
$cat->p_status2(): (portAdditionalStatus)
$cat->p_speed(): (portAdminSpeed)
$cat->p_duplex(): (portDuplex)
$cat->p_port(): (portIfIndex)

Port Capability Table (CISCO-STACK-MIB::portCpbTable)

$cat->p_speed_admin(): (portCpbSpeed)
$cat->p_duplex_admin(): (portCpbDuplex)

VLAN Entry Table

See ftp://ftp.cisco.com/pub/mibs/supportlists/wsc5000/wsc5000-communityIndexing.html for a good treaty of how to connect to the VLANs

$cat->v_state(): (vtpVlanState)
$cat->v_type(): (vtpVlanType)
$cat->v_name(): (vtpVlanName)
$cat->v_mtu(): (vtpVlanMtu)

Table Methods imported from SNMP::Info::Layer2