API Guide

● -a — (Optional) Audible ping.
● -A — (Optional) Adaptive ping. An inter-packet interval adapts to the round-trip time so that one (or
more, if you set the preload option) unanswered probe is present in the network. The minimum interval
is 200 msec for a non-super user, which corresponds to Flood mode on a network with a low round-
trip time.
● -b — (Optional) Pings a broadcast address.
● -B — (Optional) Does not allow ping to change the source address of probes. The source address is
bound to the address used when the ping starts.
● -c count — (Optional) Stops the ping after sending the specified number of ECHO_REQUEST
packets until the timeout expires.
● -d — (Optional) Sets the SO_DEBUG option on the socket being used.
● -D — (Optional) Prints the timestamp before each line.
● -h — (Optional) Displays help for this command.
● -i interval — (Optional) Enter the interval in seconds to wait between sending each packet, the
default is 1 second.
● -I interface-name or interface-ip-address — (Optional) Enter the source interface
name without spaces or the interface IP address:
○ For a physical Ethernet interface, enter ethernetnode/slot/port; for example,
ethernet1/1/1.
○ For a VLAN interface, enter vlanvlan-id; for example, vlan10.
○ For a Loopback interface, enter loopbackid; for example, loopback1.
○ For a port-channel interface, enter port-channelchannel-id; for example, port-channel.
● -l preload — (Optional) Enter the number of packets that ping sends before waiting for a reply.
Only a super user may preload more than three.
● -L — (Optional) Suppress the Loopback of multicast packets for a multicast target address.
● -m mark — (Optional) Tags the packets sent to ping a remote device. Use this option with policy
routing.
● -M pmtudisc_option — (Optional) Enter the path MTU (PMTU) discovery strategy:
○ do prevents fragmentation, including local.
○ want performs PMTU discovery and fragments large packets locally.
○ dont does not set the Don’t Fragment (DF) flag.
● -p pattern — (Optional) Enter a maximum of 16 pad bytes to fill out the packet you send to
diagnose data-related problems in the network; for example, -p ff fills the sent packet with all 1’s.
● -Q tos — (Optional) Enter a maximum of 1500 bytes in decimal or hex datagrams to set quality of
service (QoS)-related bits.
● -s packetsize — (Optional) Enter the number of data bytes to send, from 1 to 65468, default 56.
● -S sndbuf — (Optional) Set the sndbuf socket. By default, the sndbuf socket buffers one packet
maximum.
● -t ttl — (Optional) Enter the IPv4 time-to-live (TTL) value in seconds.
● -T timestamp option — (Optional) Set special IP timestamp options. Valid values for timestamp
option — tsonly (only timestamps), tsandaddr (timestamps and addresses), or tsprespec
host1 [host2 [host3 [host4]]] (timestamp pre-specified hops).
● -v — (Optional) Verbose output.
● -V — (Optional) Display the version and exit.
● -w deadline — (Optional) Enter the time-out value in seconds before the ping exits regardless of
how many packets send or receive.
● -W timeout — (Optional) Enter the time to wait for a response in seconds. This setting affects the
time-out only if there is no response, otherwise ping waits for two round-trip times (RTTs).
● hop1 ... (Optional) Enter the IPv4 addresses of the pre-specified hops for the ping packet to take.
● destination — Enter the IP address you are testing connectivity on.
Default
Not configured
Command Mode EXEC
Usage
Information
This command uses an ICMP ECHO_REQUEST datagram to receive an ICMP ECHO_RESPONSE from a
network host or gateway. Each ping packet has an IPv4 and ICMP header, then a time value and a
78 CLI Basics