SNMP::Info::CDP - SNMP Interface to Cisco Discovery Protocol (CDP) using SNMP
Max Baker
my $cdp = new SNMP::Info ( AutoSpecify => 1, Debug => 1, DestHost => 'router', Community => 'public', Version => 2 ); my $class = $cdp->class(); print " Using device sub class : $class\n"; $hascdp = $cdp->hasCDP() ? 'yes' : 'no'; # Print out a map of device ports with CDP neighbors: my $interfaces = $cdp->interfaces(); my $cdp_if = $cdp->cdp_if(); my $cdp_ip = $cdp->cdp_ip(); my $cdp_port = $cdp->cdp_port(); foreach my $cdp_key (keys %$cdp_ip){ my $iid = $cdp_if->{$cdp_key}; my $port = $interfaces->{$iid}; my $neighbor = $cdp_ip->{$cdp_key}; my $neighbor_port = $cdp_port->{$cdp_key}; print "Port : $port connected to $neighbor / $neighbor_port\n"; }
SNMP::Info::CDP is a subclass of SNMP::Info that provides an object oriented interface to CDP information through SNMP.
CDP is a Layer 2 protocol that supplies topology information of devices that also speak CDP, mostly switches and routers. CDP is implemented in Cisco and some HP devices.
Create or use a device subclass that inherits this class. Do not use directly.
Each device implements a subset of the global and cache entries. Check the return value to see if that data is held by the device.
None.
MIBs can be found at ftp://ftp.cisco.com/pub/mibs/v2/v2.tar.gz
These are methods that return scalar values from SNMP
Is CDP is active in this device?
Accounts for SNMP version 1 devices which may have CDP but not cdp_run()
Is CDP enabled on this device? Note that a lot of Cisco devices that implement CDP don't implement this value. @#%$!
(cdpGlobalRun)
cdpGlobalRun
Interval in seconds at which CDP messages are generated.
(cdpGlobalMessageInterval)
cdpGlobalMessageInterval
Time in seconds that CDP messages are kept.
(cdpGlobalHoldTime)
cdpGlobalHoldTime
Returns CDP device ID.
This is the device id broadcast via CDP to other devices, and is what is retrieved from remote devices with $cdp->id().
(cdpGlobalDeviceId)
cdpGlobalDeviceId
These are methods that return tables of information in the form of a reference to a hash.
Returns Device Functional Capabilities. Results are munged into an ascii binary string, MSB. Each digit represents a bit from the table below from the CDP Capabilities Mapping to Smartport Type table within the Cisco Small Business 200 Series Smart Switch Administration Guide, http://www.cisco.com/c/en/us/support/switches/small-business-200-series-smart-switches/products-maintenance-guides-list.html:
(Bit) - Description
Thanks to Martin Lorensen for a pointer to the original information and CPAN user Alex for updates.
(cdpCacheCapabilities)
cdpCacheCapabilities
Returns remote VTP Management Domain as defined in CISCO-VTP-MIB::managementDomainName
CISCO-VTP-MIB::managementDomainName
(cdpCacheVTPMgmtDomain)
cdpCacheVTPMgmtDomain
Returns the port duplex status from remote devices.
(cdpCacheDuplex)
cdpCacheDuplex
Returns remote device id string
(cdpCacheDeviceId)
cdpCacheDeviceId
Returns the mapping to the SNMP Interface Table.
Note that a lot devices don't implement $cdp->cdp_index(), So if it isn't around, we fake it.
In order to map the cdp table entry back to the interfaces() entry, we truncate the last number off of it :
# it exists, yay. my $cdp_index = $device->cdp_index(); return $cdp_index if defined $cdp_index; # if not, let's fake it my $cdp_ip = $device->cdp_ip(); my %cdp_if foreach my $key (keys %$cdp_ip){ $iid = $key; ## Truncate off .1 from cdp response $iid =~ s/\.\d+$//; $cdp_if{$key} = $iid; } return \%cdp_if;
Returns the mapping to the SNMP2 Interface table for CDP Cache Entries.
Most devices don't implement this, so you probably want to use $cdp->cdp_if() instead.
See cdp_if() entry.
(cdpCacheIfIndex)
cdpCacheIfIndex
If $cdp->cdp_proto() is supported, returns remote IPV4 address only. Otherwise it will return all addresses.
(cdpCacheAddress)
cdpCacheAddress
Returns remote address
Returns remote platform id
(cdpCachePlatform)
cdpCachePlatform
Returns remote port ID
(cdpDevicePort)
cdpDevicePort
Returns remote address type received. Usually IP.
(cdpCacheAddressType)
cdpCacheAddressType
Returns remote hardware version
(cdpCacheVersion)
cdpCacheVersion
Returns the remote interface native VLAN.
(cdpCacheNativeVLAN)
cdpCacheNativeVLAN
Returns the amount of power consumed by remote device in milliwatts munged for decimal placement.
(cdpCachePowerConsumption)
cdpCachePowerConsumption
Returns hash of arrays with each array containing the system capabilities supported by the remote system. Possible elements in the array are Router, Trans-Bridge, Source-Route-Bridge, Switch, Host, IGMP, Repeater, VoIP-Phone, Remotely-Managed-Device, Supports-STP-Dispute, and Two-port Mac Relay.
Router
Trans-Bridge
Source-Route-Bridge
Switch
Host
IGMP
Repeater
VoIP-Phone
Remotely-Managed-Device
Supports-STP-Dispute
Two-port Mac Relay
Inserts a decimal at the proper location.
To install SNMP::Info, copy and paste the appropriate command in to your terminal.
cpanm
cpanm SNMP::Info
CPAN shell
perl -MCPAN -e shell install SNMP::Info
For more information on module installation, please visit the detailed CPAN module installation guide.