17.1. Overlay Commands

Command Purpose

Use this command to set VLAN overlay enable/disable.

Prerequisites

Command Syntax

vlan VLAN_ID overlay (enable|disable)

Command Mode

VLAN Configuration

Default

Disable

Usage

Make Sure that overlay of VLAN is enabled before configure overlay VLAN and VNI mapping.

Examples

The following example shows how to set overlay of VLAN 2 to enable:

Switch# configure terminal
Switch(config)# vlan database
Switch(config-vlan)# vlan 2
Switch(config-vlan)# vlan 2 overlay enable

Related Commands

None

Command Purpose

Use this command to enter overlay configure mode.

To return the configure mode, use the exit command.

Prerequisites

Command Syntax

Overlay

Command Mode

Global Config

Default

None

Usage

None

Examples

The following example shows how to enter into overlay configure mode:

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)#

Related Commands

None

Command Purpose

Use this command to mapping VLAN ID with overlay VNI.

Prerequisites

Command Syntax

vlan VLAN_ID vni VNI

no vlan VLAN_ID vni

Command Mode

OVERLAY Configuration

Default

None

Usage

The overlay mapping command is used to bind the VLAN ID with overlay VNI. That means the VLAN is now can work as one overlay bridge domain and all the port belong this VLAN will also be in the overlay bridge domain.

Examples

The following example set the overlay mapping:

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)# vlan 20 vni 20000

The following example unset the overlay mapping:

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)# no vlan 20 vni

Related Commands

None

Command Purpose

Use this command to disable horizon split per VNI. Use the no form of this command to enable horizon split per VNI.

Prerequisites

Command Syntax

vni VNI split-horizon-disable

no vni VNI split-horizon-disable

Command Mode

OVERLAY Configuration

Default

Horizon split is enabled.

Usage

None

Examples

The following example shows how to disable horizon split per VNI:

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)# vni 20000 split-horizon-disable

The following example shows how to enable horizon split per VNI:

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)# no vni 20000 split-horizon-disable

Related Commands

None

Command Purpose

Use this command to set the overlay source VTEP IP address.

To remove the source VTEP IP address, use the no form of this command.

Prerequisites

Command Syntax

AQ-N3000, AQ-N5000

source IP_ADDR

no source

AQ-N6000

source (IP_ADDR|IPv6_ADDR)

no (ipv6| ) source

Command Mode

OVERLAY Configuration

Default

None

Usage

Overlay source VTEP IP address is used to encap and decap overlay packets. It is recommended that the source VTEP IP address is the same with some loopback interface address so that IP routing can be reachable.

Examples

The following example sets the source VTEP IP address of overlay:

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)# source 1.1.1.1

The following example removes the source VTEP IP address of overlay:

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)# no source

Related Commands

None

Command Purpose

Use the overlay Remote VTEP command to specify the peer IP address and type of overlay entry. Use the no form of this command to remove the peer IP address and type of overlay entry.

Prerequisites

Command Syntax

remote-vtep INDEX ip-address IP_ADDR_VTEP type (vxlan|nvgre|geneve) ({src-ip IP_ADDR|split-horizon-disable|keep-vlan-tag}| )

remote-vtep INDEX ipv6-address IPv6_ADDR_VTEP type (vxlan|nvgre|geneve) ({src-ipv6 IPv6_ADDR|split-horizon-disable|keep-vlan-tag}| )

no remote-vtep INDEX

Command Mode

OVERLAY Configuration

Default

None

Usage

This command is used to specify overlay VTEP peer address and type on remote device, administrator must know all the peer addresses and types on the network and make sure that they can route between each other.

Examples

The following example sets the overlay VXLAN VTEP peer address 2.2.2.2 with source IP address 1.1.1.1:

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)# remote-vtep 20 ip-address 2.2.2.2 type vxlan src-ip 1.1.1.1

The following example removes Remote VTEP:

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)# no remote-vtep 20

Related Commands

None

Command Purpose

Use the overlay Remote VTEP command to configure the outer IP DSCP gaining mode.

Prerequisites

Command Syntax

remote-vtep INDEX encapsulation-dscp-strategy (dscp-copy|priority-map|custom-assign VALUE)

Command Mode

OVERLAY Configuration

Default

DSCP-copy

Usage

When DSCP-strategy is set priority-map, please configure QOS priority by MQC.

Examples

The following example sets overlay DSCP-strategy as custom-assign :

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)# remote-vtep 20 dscp-strategy custom-assign 63

Related Commands

None

Command Purpose

Use the overlay virtual mac command to specify the virtual route mac address of Remote VTEP. Use the no form of this command to remove the virtual mac address of Remote VTEP.

Prerequisites

Command Syntax

remote-vtep INDEX virtual-mac MAC

no remote-vtep index virtual-mac

Command Mode

OVERLAY Configuration

Default

None

Usage

The virtual mac address will be used as the inner mac address of DVR routes which don’t specify the inner mac address.

Examples

The following example sets the overlay Remote VTEP with the virtual MAC a.a.a:

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)# remote-vtep 20 virtual-mac a.a.a

The following example removes Remote VTEP virtual MAC address:

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)# no remote-vtep virtual-mac

Related Commands

None

Command Purpose

Use the overlay peer command to specify the peer IP address and type of overlay VLAN entry. Use the no form of this command to remove the peer IP address and type of overlay VLAN entry.

Prerequisites

Command Syntax

vlan VLAN_ID remote-vtep INDEX (tunnel-aware inner| )

no vlan VLAN_ID remote-vtep INDEX

Command Mode

OVERLAY Configuration

Default

None

Usage

Make sure the Remote VTEP is already created when setting VLAN with Remote VTEP index.

Examples

The following example sets the overlay VLAN 20 with Remote VTEP 2 :

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)# vlan 20 remote-vtep 2

The following example removes Remote VTEP 3 from VLAN 20:

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)# no vlan 20 remote-vtep 3

Related Commands

None

Command Purpose

Use the overlay uplink command to enable or disable overlay uplink port capability.

Prerequisites

Command Syntax

overlay uplink (enable|disable)

Command Mode

Interface Configuration

Default

Disable

Usage

The command is allow setting on ether type port. When the port is routed port or routed link agg port, it can work both on normal ECMP mode and advanced ECMP mode. When the port belongs to VLAN interface, it can only work on normal ECMP mode.

Examples

This example shows how to enable overlay uplink on interface:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# overlay uplink enable

This example shows how to disable overlay uplink on interface:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# overlay uplink disable

Related Commands

None

Command Purpose

Use the VXLAN uplink command to enable or disable VXLAN uplink port capability.

Prerequisites

Command Syntax

vxlan uplink (enable|disable)

Command Mode

Interface Configuration

Default

Disable

Usage

The command is allow setting on ether type port. This command is used to decapsulated the VXLAN packet for L2 VNI and L3 VNI.

Examples

This example shows how to enable VXLAN uplink on interface:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# vxlan uplink enable

Related Commands

None

Command Purpose

Use the NVGRE uplink command to enable or disable NVGRE uplink port capability.

Prerequisites

Command Syntax

nvgre uplink (enable|disable)

Command Mode

Interface Configuration

Default

Disable

Usage

The command is allow setting on ether type port. This command is used to decapsulated the NVGRE packet for L2 VNI and L3 VNI.

Examples

This example shows how to enable NVGRE uplink on interface:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# nvgre uplink enable

Command Purpose

Use the overlay static FDB command to add or delete overlay static FDB.

Prerequisites

Command Syntax

mac-address-table MAC_ADDR forward remote-vtep INDEX vlan VLAN_ID

no mac-address-table mac-addr forward remote-vtep index vlan VLAN_ID

Command Mode

Global Config

Default

None

Usage

None

Examples

This example shows how to add a static overlay FDB with remote-VTEP 3 and VLAN 2:

Switch# configure terminal
Switch(config)# mac-address-table 1.1.1 forward remote-vtep 3 vlan 2

This example shows how to delete a static overlay FDB with remote-VTEP 3 and VLAN 2:

Switch# configure terminal
Switch(config)# no mac-address-table 1.1.1 forward remote-vtep 3 vlan 2

Related Commands

None

Command Purpose

Use the overlay gateway command to add or delete overlay gateway MAC address.

Prerequisites

Command Syntax

vlan VLAN_ID gateway-mac mac-addr

no vlan VLAN_ID gateway-mac mac-addr

Command Mode

OVERLAY Configuration

Default

None

Usage

The downlink port should be in trunk mode.

Examples

This example shows how to add an overlay gateway with VLAN 2:

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)# vlan 2 gateway-mac 2.2.2

This example shows how to delete an static overlay FDB with NVGRE VTEP peer 2.2.2.2 and VLAN 2:

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)# no vlan 2 gateway-mac 2.2.2

Related Commands

None

Command Purpose

Use the overlay route command to add or delete overlay static routes.

Prerequisites

Command Syntax

ip route vrf VRF_NAME (ADDRESS WILDCARD-MASK|ADDRESS/PREFIX-LENGTH) remote-vtep INDEX vni VNI ( |inner-macda mac-addr)

no ip route vrf VRF_NAME (ADDRESS WILDCARD-MASK|ADDRESS/PREFIX-LENGTH) remote-vtep INDEX vni VNI ( |inner-macda mac-addr)

Command Mode

Global Config

Default

None

Usage

If the inner mac destination address is not specified, it will use the Remote VTEP’s virtual mac address as the inner mac destination address.

Examples

This example shows how to add an overlay route:

Switch# configure terminal
Switch(config)# ip route vrf tenant1 3.3.3.3/32 remote-vtep 3 vni 50000 inner-macda a.a.a
Switch(config)# ip route vrf tenant1 4.4.4.4/32 remote-vtep 3 vni 50000

This example shows how to delete an overlay route:

Switch# configure terminal
Switch(config)# no ip route vrf tenant1 3.3.3.3/32 nvgre-peer 5.5.5.5 vni 50000 inner-macda a.a.a
Switch(config)# no ip route vrf tenant1 4.4.4.4/32 nvgre-peer 5.5.5.5 vni 50000

Related Commands

None

Command Purpose

Use the command to enable or disable overlay distributed gateway.

Prerequisites

Command Syntax

overlay distributed-gateway (enable|disable)

Command Mode

Interface Configuration

Default

None

Usage

None

Examples

This example shows how to enable overlay distributed gateway:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# overlay distributed-gateway enable

Related Commands

None

Command Purpose

Use the command to configure the VLAN edit mode of selective QinQ port in overlay.

Prerequisites

Command Syntax

selective qinq overlay mode (mapping|stripping)

Command Mode

Global Config

Default

strip VLAN

Usage

None

Examples

This example shows how to configure selective QinQ VLAN edit mode:

Switch# configure terminal
Switch(config)# selective qinq overlay mode mapping

Related Commands

None

Command Purpose

Use the command to config VXLAN UDP destport value.

Prerequisites

Command Syntax

vxlan udp-dest-port PORT

no vxlan udp-dest-port

Command Mode

OVERLAY Configuration

Default

4789

Usage

When use this function, should make two switch config the same value

Examples

This example shows how to config VXLAN UDP destport value:

Switch# configure terminal
Switch(config)# overlay
Switch(config-overlay)# vxlan udp-dest-port 8888

Related Commands

None

Command Purpose

Use inner packet information to process packet (eg ACL, Flow tracing processing). This command is used for overlay packets without tunnel decapsulation processing.

Prerequisites

Command Syntax

(no| ) qos tunnel-aware inner

Command Mode

Interface Configuration

Default

Disable

Usage

This command is used to force inner packet header process for overlay packets without tunnel decapsulation.

Examples

This example shows how to enable force inner parse on interface:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# qos tunnel-aware inner

Related Commands

None

Command Purpose

Use inner and outer packet information to process packet (eg ACL, Flow tracing processing).

Prerequisites

Command Syntax

(no| ) inner-outer merge enable

Command Mode

Interface Configuration

Default

Disable

Usage

This command is used to force inner and packet header information process for overlay packets.

Examples

This example shows how to enable inner and outer parse on interface:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# qos tunnel-aware inner-outer-merge

Related Commands

None

Command Purpose

Use the show overlay command to show related overlay information.

Prerequisites

Command Syntax

show overlay (vlan VLAN_ID)

Command Mode

Privileged EXEC

Default

None

Usage

None

Examples

This example shows all the overlay information:

Switch# show overlay



-------------------------------------------------------------------------------
ECMP Mode        : Normal
Source VTEP      : 20.1.1.1

Vlan Vni     Type   Remote-vtep IP-Address       Src-Address      Split-Horizon 
-------------------------------------------------------------------------------
10   10000   VxLAN  1           2.2.2.2          1.1.1.1          Enable        

This example shows the overlay information of VLAN 2:

Switch# show overlay vlan 2

---------------------------------------------------------------
ECMP Mode        : Normal
Source VTEP      : 1.1.1.1
Remote VTEP Index: 1, Ip address: 2.2.2.2, Type: VxLAN
Remote VTEP Index: 2, Ip address: 3.3.3.3, Type: VxLAN
---------------------------------------------------------------
VLAN ID        : 2
VNI            : 20000
Remote VTEP NUM: 2
          Index: 1, Ip address: 2.2.2.2,  Type: VxLAN
          Index: 2, Ip address: 3.3.3.3,  Type: VxLAN
DVR Gateway NUM: 0
---------------------------------------------------------------

Related Commands

None