The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Net-CDP-0.09
River stage zero No dependents
++
/ Net::CDP::Packet

NAME

Net::CDP::Packet - Cisco Discovery Protocol (CDP) packet

SYNOPSIS

  use Net::CDP::Packet qw(:caps);
  
  # Constructors
  $packet = new Net::CDP::Packet;
  $packet = new Net::CDP::Packet($cdp);
  $cloned = clone $packet;
  
  # Object methods
  $version                     = $packet->version;
  $ttl                         = $packet->ttl;
  $checksum                    = $packet->checksum;
  $device                      = $packet->device;
  @addresses                   = $packet->addresses;
  $port                        = $packet->port;
  $capabilities                = $packet->capabilities;
  $ios_version                 = $packet->ios_version;
  $platform                    = $packet->platform;
  @ip_prefixes                 = $packet->ip_prefixes;
  $vtp_management_domain       = $packet->vtp_management_domain;
  $native_vlan                 = $packet->native_vlan;
  $duplex                      = $packet->duplex;
  ($voice_vlan, $appliance_id) = $packet->voice_vlan;
  $power_consumption           = $packet->power_consumption;
  $mtu                         = $packet->mtu;
  $trusted                     = $packet->trusted;
  $untrusted_cos               = $packet->untrusted_cos
  @management_addresses        = $packet->management_addresses;

DESCRIPTION

A Net::CDP::Packet object represents a single CDP packet.

CONSTRUCTORS

new
    $packet = new Net::CDP::Packet()
    $packet = new Net::CDP::Packet($cdp)

Returns a new Net::CDP::Packet object.

The returned object will have the following fields set:

    Version: 1
    TTL: 180
    Device ID: `hostname`
    Capabilities: CDP_CAP_HOST
    IOS Version: `uname -a`
    Platform: `uname -s`

If supplied, $cdp must be a Net::CDP object. new will use this to generate the following fields:

    Port ID: $cdp->port()
    Addresses: $cdp->addresses()
    Duplex: $cdp->duplex()
clone
    $cloned = clone $packet;

Returns a deep copy of the supplied Net::CDP::Packet object.

OBJECT METHODS

version
    $version = $packet->version()

Returns this packet's Version field. For packets generated by "new", this is always 1.

ttl
    $ttl = $packet->ttl()
    $ttl = $packet->ttl($new_ttl)

Returns this packet's Time-to-live field. If $new_ttl is supplied and positive, the field will be updated first.

The Time-to-live field specifies how long a receiving CDP implementation may cache the data in this packet.

checksum
    $checksum = $packet->checksum()

Returns this packet's Checksum field. This checksum will be automatically updated when other fields are modified.

device
    $device = $packet->device()
    $device = $packet->device($new_device)

Returns this packet's Device ID field if present, undef otherwise. If $new_device is supplied, the field will be updated first. If $new_device is undefined, the Device ID field is removed from the packet.

For packets received from other devices, the Device ID field specifies the name of the device that generated the packet.

addresses
    @addresses = $packet->addresses()
    @addresses = $packet->addresses($new_addresses)

Returns this packet's Addresses field as a list of Net::CDP::Address objects. In scalar context, the number of addresses is returned, or undef if no Addresses field is present.

If $new_addresses is supplied, the field will be updated first. If $new_addresses is undef, the Addresses field is removed from the packet. Otherwise $new_addresses must be a reference to an array of Net::CDP::Address objects. The array may be empty.

For packets received from other devices, the Addresses field specifies the addresses of the network port upon which the packet was sent.

port
    $port = $packet->port()
    $port = $packet->port($new_port)

Returns this packet's Port ID field if present, undef otherwise. If $new_port is supplied, the field will be updated first. If $new_device is undefined, the Port ID field is removed from the packet.

For packets received from other devices, the Port ID field specifies the network port upon which the packet was sent.

capabilities
    $capabilities = $packet->capabilities()
    $capabilities = $packet->capabilities($new_capabilities)

Returns this packet's Capabilities field if present, undef otherwise. If $new_capabilities is supplied, the field will be updated first. If $new_capabilities is undefined, the Capabilities field is removed from the packet.

The Capabilities field is a bitmask specifying one or more of the following constants:

    CDP_CAP_ROUTER
    CDP_CAP_TRANSPARENT_BRIDGE
    CDP_CAP_SOURCE_BRIDGE
    CDP_CAP_SWITCH
    CDP_CAP_HOST
    CDP_CAP_IGMP
    CDP_CAP_REPEATER

These constants can be exported using the tag :caps. See Exporter.

ios_version
    $ios_version = $packet->ios_version()
    $ios_version = $packet->ios_version($new_ios_version)

Returns this packet's IOS Version field if present, undef otherwise. If $new_ios_version is supplied, the field will be updated first. If $new_ios_version is undefined, the IOS Version field is removed from the packet.

platform
    $platform = $packet->platform()
    $platform = $packet->platform($new_platform)

Returns this packet's Platform field if present, undef otherwise. If $new_platform is supplied, the field will be updated first. If $new_platform is undefined, the Platform field is removed from the packet.

ip_prefixes
    @ip_prefixes = $packet->ip_prefixes()
    @ip_prefixes = $packet->ip_prefixes($new_ip_prefixes)

Returns this packet's IP Prefixes field as a list of Net::CDP::IPPrefix objects. In scalar context, the number of prefixes is returned, or undef if no IP Prefixes field is present.

If $new_ip_prefix is supplied, the field will be updated first. If $new_ip_prefix is undef, the IP Prefixes field is removed from the packet. Otherwise $new_ip_prefix must be a reference to an array of Net::CDP::IPPrefix objects. The array may be empty.

vtp_management_domain
    $vtp_management_domain = $packet->vtp_management_domain()
    $vtp_management_domain =
        $packet->vtp_management_domain($new_vtp_management_domain)

Returns this packet's VTP Management Domain field if present, undef otherwise. If $new_vtp_management_domain is supplied, the field will be updated first. If $new_vtp_management_domain is undefined, the VTP ManagementDomain field is removed from the packet.

native_vlan
    $native_vlan = $packet->native_vlan()
    $native_vlan = $packet->native_vlan($new_native_vlan)

Returns this packet's Native VLAN field if present, undef otherwise. If $new_native_vlan is supplied, the field will be updated first. If $new_native_vlan is undefined, the Native VLAN field is removed from the packet.

duplex
    $duplex = $packet->duplex()
    $duplex = $packet->duplex($new_duplex)

Returns this packet's Duplex field if present, undef otherwise. If $new_duplex is supplied, the field will be updated first. If $new_duplex is undefined, the Duplex field is removed from the packet.

The Duplex field contains a boolean value. If it is true, the port supplied in the Port ID field supports full-duplex communication. Otherwise, only half-duplex communication is supported.

voice_vlan
    $voice_vlan                  = $packet->voice_vlan()
    ($voice_vlan, $appliance_id) = $packet->voice_vlan()
    ($voice_vlan, $appliance_id)
        = $packet->voice_vlan($new_voice_vlan)
    ($voice_vlan, $appliance_id)
        = $packet->voice_vlan($new_voice_vlan, $new_appliance_id)

Returns the Voice VLAN from this packet's Appliance VLAN-ID field if present, undef otherwise. In list context, the Appliance ID is also returned.

If $new_voice_vlan or $new_appliance_id is supplied, the field will be updated first:

$packet->voice_vlan($new_voice_vlan)

Updates the Voice VLAN only. If no Appliance VLAN-ID field currently exists in the packet, the Appliance ID is set to 1.

$packet->voice_vlan(undef, $new_appliance_id)

Updates the Appliance ID only. If no Appliance VLAN-ID field currently exists in the packet, the method croaks.

$packet->voice_vlan($new_voice_vlan, $new_appliance_id)

Updates both the Voice VLAN and the Appliance ID.

$packet->voice_vlan(undef) or $packet->voice_vlan(undef, undef)

Removes the Appliance VLAN-ID field completely.

power_consumption
    $power_consumption = $packet->power_consumption()
    $power_consumption = $packet->power_consumption($new_power_consumption)

Returns this packet's Power Consumption field if present, undef otherwise. If $new_power_consumption is supplied, the field will be updated first. If $new_power_consumption is undefined, the Power Consumption field is removed from the packet.

The Power Consumption field contains the number of milliwatts (mW) the device requires using Power over Ethernet.

mtu
    $mtu = $packet->mtu()
    $mtu = $packet->mtu($new_mtu)

Returns this packet's MTU field if present, undef otherwise. If $new_mtu is supplied, the field will be updated first. If $new_mtu is undefined, the MTU field is removed from the packet.

trusted
    $trusted = $packet->trusted()
    $trusted = $packet->trusted($new_trusted)

Returns this packet's Extended Trust field if present, undef otherwise. If $new_trusted is supplied, the field will be updated first. If $new_trusted is undefined, the Extended Trust field is removed from the packet.

The Extended Trust field contains a boolean value. If it is true, the port trusts the CoS (Class of Service) values in incoming packets. Otherwise, the port will assign its own CoS value to the traffic. See also the "untrusted_cos" method.

untrusted_cos
    $untrusted_cos = $packet->untrusted_cos()
    $untrusted_cos = $packet->untrusted_cos($new_untrusted_cos)

Returns this packet's CoS for Untrusted Ports field if present, undef otherwise. If $new_untrusted_cos is supplied, the field will be updated first. If $new_untrusted_cos is undefined, the field is removed from the packet.

The CoS for Untrusted Ports field contains the CoS (Class of Service) that will be applied when the port does not trust the CoS of incoming packets. See also the "trusted" method.

management_addresses
    @management_addresses = $packet->management_addresses()
    @management_addresses
        = $packet->management_addresses($new_addresses)

Returns this packet's Management Addresses field as a list of Net::CDP::Address objects. In scalar context, the number of addresses is returned, or undef if no Addresses field is present.

If $new_addresses is supplied, the field will be updated first. If $new_addresses is undef, the Management Addresses field is removed from the packet. Otherwise $new_addresses must be a reference to an array of Net::CDP::Address objects. The array may be empty.

SEE ALSO

Net::CDP, Net::CDP::Address, Net::CDP::IPPrefix

AUTHOR

Michael Chapman, <cpan@very.puzzling.org>

COPYRIGHT AND LICENSE

Copyright (C) 2005 by Michael Chapman

libcdp is released under the terms and conditions of the GNU Library General Public License version 2. Net::CDP may be redistributed and/or modified under the same terms as Perl itself.