Michael Vincent
and 1 contributors

NAME

Cisco::SNMP::ProxyPing - Proxy Ping Interface for Cisco Management

SYNOPSIS

  use Cisco::SNMP::ProxyPing;

DESCRIPTION

Proxy Ping

The following methods are for proxy ping. These methods implement the CISCO-PING-MIB.

METHODS

new() - create a new Cisco::SNMP::ProxyPing object

  my $cm = Cisco::SNMP::ProxyPing->new([OPTIONS]);

Create a new Cisco::SNMP::ProxyPing object with OPTIONS as optional parameters. See Cisco::SNMP for options.

proxy_ping() - execute proxy ping

  my $ping = $cm->proxy_ping([OPTIONS]);

Send proxy ping from the object defined in $cm to the provided destination. Called with no options, sends the proxy ping to the localhost. Called with one argument, interpreted as the destination to proxy ping. Valid options are:

  Option     Description                            Default
  ------     -----------                            -------
  -count     Number of pings to send                1
  -family    Address family IPv4/IPv6               [Inherit from new()]
               Valid values for IPv4:
                 4, v4, ip4, ipv4, AF_INET (constant)
               Valid values for IPv6:
                 6, v6, ip6, ipv6, AF_INET6 (constant)
  -host      Destination to send proxy ping to      (localhost)
  -size      Size of the ping packets in bytes      64
  -vrf       VRF name to source pings from          [none]
  -wait      Time to wait for replies in seconds    1

A hostname value for host will be resolved to IPv4/v6 based on family. Family is inherited from the value set in new() but can be overriden. Providing a numeric address will also self-determine the IPv4/v6 address.

Allows the following accessors to be called.

ppSent() - return number of pings sent

  $ping->ppSent();

Return the number of pings sent in the current proxy ping execution.

ppReceived() - return number of pings received

  $ping->ppReceived();

Return the number of pings received in the current proxy ping execution.

ppMinimum() - return minimum round trip time

  $ping->ppMinimum();

Return the minimum round trip time in milliseconds of pings sent and received in the current proxy ping execution.

ppAverage() - return average round trip time

  $ping->ppAverage();

Return the average round trip time in milliseconds of pings sent and received in the current proxy ping execution.

ppMaximum() - return maximum round trip time

  $ping->ppMaximum();

Return the maximum round trip time in milliseconds of pings sent and received in the current proxy ping execution.

INHERITED METHODS

The following are inherited methods. See Cisco::SNMP for more information.

close
error
session

EXPORT

None by default.

EXAMPLES

This distribution comes with several scripts (installed to the default bin install directory) that not only demonstrate example uses but also provide functional execution.

LICENSE

This software is released under the same terms as Perl itself. If you don't know what that means visit http://perl.com/.

AUTHOR

Copyright (C) Michael Vincent 2015

http://www.VinsWorld.com

All rights reserved