overlay-gateway

Creates a VXLAN overlay gateway instance and enables VXLAN overlay gateway configuration mode.

Syntax

overlay-gateway name

no overlay-gateway name

Parameters

name: Specifies a name for the VXLAN overlay gateway. Only one gateway instance can be configured. The name is an alphanumeric, 32-character-maximum string that can also contain hyphens and underscores.

Modes

Global configuration mode

Usage Guidelines

Use this command to create a VXLAN overlay gateway instance with the given name. An overlay network is a virtual network that is built on top of existing network Layer 2 and Layer 3 technologies. Setting up a gateway consists of the following:

Configuring the source IP address
Configuring the VLAN or bridge domain
Mapping a bridge domain to a VNI
Configuring MAC addresses to export to the VXLAN domain
Enabling statistics collection for VLAN domains
Enabling SPAN

One you create the gateway instance, you enter VXLAN overlay gateway configuration mode, where you can configure other properties for this gateway. The key commands available in this mode are summarized below:

Table 1. Key commands available in VXLAN overlay gateway configuration mode
Command	Description
activate	Activates a VXLAN overlay gateway instance.
ip interface loopback	Sets the loopback port number for the overlay gateway instance.
map bridge-domain	In a VXLAN overlay gateway configuration that uses the Layer 2 extension, maps a bridge domain with VXLAN Network Identifiers (VNIs).
map vlan	In a VXLAN overlay gateway configuration that uses Layer 2 extension, associates VLANs with VXLAN Network Identifiers (VNIs).
sflow	Enables sFlow monitoring of the tunnel endpoints for a VXLAN overlay gateway.
site	Configures a remote Layer 2 extension site in a VXLAN overlay gateway context.
type layer2-extension	Specifies that a VXLAN overlay gateway uses Layer 2 extension.

Only one VXLAN overlay gateway instance can be configured.

Use the no overlay-gateway command to delete the VXLAN overlay gateway instance from the cluster. All tunnels for the gateway are also deleted. There are no other no forms of this command.

By default, a VXLAN overlay gateway instance is inactive. To activate an instance, first configure its other properties (such as which devices it attaches to), and then enter the activate command.

Examples

The following example creates a VXLAN overlay gateway instance named gateway1 and accesses VXLAN overlay gateway configuration mode.

device# configure terminal
device(config)# overlay-gateway gateway1 
device(config-overlay-gw-gateway1)#