Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

ping overlay

 

Syntax

Release Information

Command introduced in Junos OS Release 14.1X53-D30 for QFX Series switches.

Command introduced in Junos OS Release 16.1 for EX Series switches.

Command introduced in Junos OS Release 16.2 for MX Series routers.

Description

Verify the presence of the Virtual Extensible LAN (VXLAN) tunnel endpoints (VTEPs), which can originate and terminate VXLAN tunnels, and service connectivity within the context of the overlay VXLAN segment. Use ping overlay as a fault detection tool to determine failure within an overlay VXLAN tunnel. Type Ctrl+c to interrupt a ping overlay command.

Note

The ping overlay command is not supported for IPv6.

Note

The ping overlay command is not supported when there are multiple virtual-switch routing instances.

Options

tunnel-type(Optional) Specify the overlay tunnel type used in a virtualized environment such as: VXLAN, Network Virtualization using Generic Routing Encapsulation (NVGRE), MPLS over User Datagram Protocol (UDP), and MPLS over General Routing Encapsulation (GRE) tunnels.
Note

Only VXLAN overlay tunnel types are supported.

vni vniSpecify the VNI of the VXLAN overlay segment.
tunnel-src ip-source-addressSpecify the IP address of the source entity at the end of the tunnel, such as the source VTEP.
tunnel-dst ip-destination-addressSpecify the IP address of the destination entity at the end of the tunnel, such as a remote VTEP.
mac mac-address(Optional) Include the physical or hardware address on the end host system you are trying to reach.
count requests(Optional) Number of ping requests to send.

For QFX and EX9200 switches, the range of values is 1 through 65,535. The default value is 10.

For MX Series routers, the range of values is 1 through 2,000,000,000. The default value is 5.

ttl value(Optional) Time-to-live (TTL) value to include in the ping request.

For QFX and EX9200 switches, the range of values is 1 through 255. The default value is 255.

For MX Series routers, the range of values is 0 through 255. The default value is 255.

hash-source-mac source-mac-address(Optional) Specify the MAC address of the source end host system.
Note

The hash parameters provide values that correspond to a particular data flow that the ping overlay command debugs. Based on the values that you specify, the system calculates a VXLAN UDP header source port hash, which is included in the VXLAN UDP header of the overlay ping and traceroute packets. Including the calculated hash in the VXLAN header enables the overlay ping and traceroute packets to emulate data packets in the flow that you are troubleshooting.

When using the hash parameters, we recommend that you specify a value for each parameter. The exception to this guideline is the hash-vlan parameter, which you do not have to use if the source endpoint is not a member of a VLAN. This practice ensures that the overlay ping and traceroute processes are successful and that the output for each command is accurate. If you do not specify a value for one or more of the hash parameters, the system sends an OAM request that might include incorrect hash values and generates a warning message.

Hash computation supports TCP and UDP protocols only.

hash-destination-mac destination-mac-address(Optional) Specify the MAC address of the destination end host system.
hash-source-address source-IP-address(Optional) Specify the IP address of the source end host system.
hash-destination-address destination-IP-address(Optional) Specify the IP address of the destination end host system.
hash-vlan vlan-id(Optional, QFX switches only) Specify the VLAN ID of the end host system.
hash-input-interface input-interface(Optional, QFX switches only) Specify the ingress interface of the flow on the Juniper Networks device.
hash-protocol protocol-id(Optional) Specify the TCP/UDP IP protocol ID. The range of values is 1 through 255.
hash-source-port source-layer4-port(Optional) Specify the Layer 4 source port. The range of values is 1 through 65,535.
hash-destination-port destination-layer4-port(Optional) Specify the Layer 4 destination port. The range of values is 1 through 65,535.

Required Privilege Level

network

List of Sample Output

run ping overlay

Output Fields

When you enter this command, you are provided feedback on the status of your request. An exclamation point (!) indicates that an echo reply was received. A period (.) indicates that an echo reply was not received within the timeout period. An x indicates that an echo reply was received with an error code. These packets are not counted in the received packets count. They are accounted for separately.

Table 1 lists the output fields for the ping overlay command. Output fields are listed in the approximate order in which they appear.

Table 1: ping overlay Output Fields

Field Name

Field Description

vni

The VNI of the VXLAN overlay segment.

tunnel src ip

The IP address of the source end of the tunnel.

tunnel dst ip

The IP address of the destination end of the tunnel.

mac address

The physical or hardware address on the end host system you are trying to reach.

count

Number of ping requests sent.

ttl

TTL value for maximum number of pings.

hash-parameters

The hash parameters provide the input-interface, source MAC address, destination MAC address, source IP address, destination IP address, and the VLAN of the two end hosts within an overlay segment. Hash parameters enable platform-specific hash computation to use as the source port in the outer UDP header.

Request/Response for seq x to/from address at timestamp

Number of ping request and response counts for determining overlay segments in tunnel.

Sample Output

run ping overlay

user@host> ping overlay tunnel-type vxlan vni 100 tunnel-src 192.0.2.10 tunnel-dst 192.0.2.20 mac 00:00:5E:00:53:cc count 5 hash-source-mac 00:00:5E:00:53:aa hash-destination-mac 00:00:5E:00:53:cc hash-source-address 198.51.100.1 hash-destination-address 198.51.100.3 hash-vlan 150 hash-input-interface xe-0/0/2 hash-protocol 17 hash-source-port 4456 hash-destination-port 4540