NVE

NVE (Network Virtualization Edge) interfaces serve as the VXLAN tunnel endpoint (VTEP) on NX-OS devices, encapsulating and decapsulating overlay traffic for data center fabric deployments with configurable source interface, host reachability protocol, and multicast group assignments. They support advanced VXLAN features including advertise virtual RMAC, anycast bundled interface for vPC VTEP redundancy, multisite border gateway interface and virtual RMAC for DCI (Data Center Interconnect), ARP/ND suppression, and MAC route suppression for optimized overlay control plane behavior. Per-VNI configuration controls associate-VRF mapping for L3VNI, multicast group assignment, ingress replication protocol (BGP/static), multisite ingress replication, and spine anycast gateway for flexible overlay network design.

Diagram

Classes

interfaces (nxos.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
nve	Class	`[nve]`	No

nve (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory
shutdown	Boolean	`true`, `false`	No
advertise_virtual_rmac	Boolean	`true`, `false`	No
anycast_source_interface_type	Choice	`ethernet`, `loopback`, `mgmt`, `port-channel`, `vlan`, `vni`	No
anycast_source_interface_id	Any	String or Integer[min: `0`]	No
description	String		No
fabric_ready_time	Integer	min: `0`, max: `1200`	No
source_interface_hold_down_time	Integer	min: `1`, max: `1500`	No
host_reachability_protocol	Choice	`flood-and-learn`, `bgp`, `controller`, `openflow`, `openflow-ir`	No
global_ingress_replication_protocol_bgp	Boolean	`true`, `false`	No
global_mcast_group_l2	IP		No
global_mcast_group_l3	IP		No
multicast_routing_source_interface_type	Choice	`ethernet`, `loopback`, `mgmt`, `port-channel`, `vlan`, `vni`	No
multicast_routing_source_interface_id	Any	String or Integer[min: `0`]	No
multisite_border_gateway_interface_type	Choice	`ethernet`, `loopback`, `mgmt`, `port-channel`, `vlan`, `vni`	No
multisite_border_gateway_interface_id	Any	String or Integer[min: `0`]	No
multisite_virtual_rmac	String		No
source_interface_type	Choice	`ethernet`, `loopback`, `mgmt`, `port-channel`, `vlan`, `vni`	No
source_interface_id	Any	String or Integer[min: `0`]	No
global_suppress_arp	Boolean	`true`, `false`	No
suppress_mac_route	Boolean	`true`, `false`	No
suppress_nd	Boolean	`true`, `false`	No
virtual_rmac	String		No
vnis	List	`[vnis]`	No

nve (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory
shutdown	Boolean	`true`, `false`	No
advertise_virtual_rmac	Boolean	`true`, `false`	No
anycast_bundled_interface_type	Choice	`ethernet`, `loopback`, `mgmt`, `port-channel`, `vlan`, `vni`	No
anycast_bundled_interface_id	String		No
configuration_source	Choice	`unknown`, `cli`, `controller`	No
controller_id	Integer	min: `0`, max: `4294967295`	No
description	String		No
encapsulation_type	Choice	`unknown`, `vxlan`, `vxlan-tun-ctrl-frame`, `vxlan-tun-ctrl-frame-lacp`, `vxlan-tun-ctrl-frame-stp`, `dot1q`, `dot1q-tun-ctrl-frame`, `dot1q-tun-ctrl-frame-lacp`, `dot1q-tun-ctrl-frame-stp`	No
fabric_convergence_delay	Integer	min: `0`, max: `1200`	No
source_interface_hold_down_time	Integer	min: `1`, max: `1500`	No
host_reachability_protocol	Choice	`flood-and-learn`, `bgp`, `controller`, `openflow`, `openflow-ir`	No
global_ingress_replication_protocol_bgp	Boolean	`true`, `false`	No
global_mcast_group_l2	IP		No
global_mcast_group_l3	IP		No
multicast_routing_source_interface_type	Choice	`ethernet`, `loopback`, `mgmt`, `port-channel`, `vlan`, `vni`	No
multicast_routing_source_interface_id	String		No
multisite_border_gateway_interface_type	Choice	`ethernet`, `loopback`, `mgmt`, `port-channel`, `vlan`, `vni`	No
multisite_border_gateway_interface_id	String		No
multisite_virtual_rmac	String		No
source_interface_type	Choice	`ethernet`, `loopback`, `mgmt`, `port-channel`, `vlan`, `vni`	No
source_interface_id	String		No
global_suppress_arp	Boolean	`true`, `false`	No
suppress_mac_route	Boolean	`true`, `false`	No
suppress_nd	Boolean	`true`, `false`	No
virtual_rmac	String		No
vnis	List	`[vnis]`	No

vnis (nxos.devices.configuration.interfaces.nve)

Name	Type	Constraint	Mandatory
vni	Integer	min: `1`, max: `16777215`	Yes
associate_vrf	Boolean	`true`, `false`	No
mcast_group	IP		No
multisite_ingress_replication	Choice	`enable`, `disable`, `optimized`	No
multisite_mcast_group	IP		No
spine_anycast_gateway	Boolean	`true`, `false`	No
suppress_arp	Boolean	`true`, `false`	No
ingress_replication_protocol	Choice	`bgp`, `static`, `unknown`	No

vnis (nxos.devices.configuration.interfaces.nve)

Name	Type	Constraint	Mandatory
vni	Integer		Yes
associate_vrf	Boolean	`true`, `false`	No
mcast_group	IP		No
multisite_ingress_replication	Choice	`enable`, `disable`, `enableOptimized`	No
multisite_mcast_group	IP		No
spine_anycast_gateway	Boolean	`true`, `false`	No
suppress_arp	Boolean	`true`, `false`	No
ingress_replication_protocol	Choice	`bgp`, `static`, `unknown`	No

Examples

Example 1: Basic NVE interface with BGP host reachability for a VXLAN leaf

nxos:
  devices:
    - name: LEAF1
      configuration:
        interfaces:
          nve:
            shutdown: false
            advertise_virtual_rmac: true
            host_reachability_protocol: bgp
            source_interface_type: loopback
            source_interface_id: "1"

Example 2: NVE with L2 VNI (ingress replication) and L3 VNI (associate VRF) mappings

nxos:
  devices:
    - name: LEAF1
      configuration:
        interfaces:
          nve:
            shutdown: false
            advertise_virtual_rmac: true
            host_reachability_protocol: bgp
            source_interface_type: loopback
            source_interface_id: "1"
            vnis:
              - vni: 10101
                ingress_replication_protocol: bgp
              - vni: 10102
                ingress_replication_protocol: bgp
              - vni: 11010
                associate_vrf: true
              - vni: 11020
                associate_vrf: true

Example 3: NVE with multicast groups, ARP suppression, and multisite DCI

nxos:
  devices:
    - name: BORDER-LEAF1
      configuration:
        interfaces:
          nve:
            shutdown: false
            advertise_virtual_rmac: true
            host_reachability_protocol: bgp
            source_interface_type: loopback
            source_interface_id: "1"
            global_suppress_arp: true
            multisite_border_gateway_interface_type: loopback
            multisite_border_gateway_interface_id: "100"
            multisite_virtual_rmac: 00:00:0c:aa:bb:cc
            vnis:
              - vni: 10101
                mcast_group: 239.1.1.1
                multisite_ingress_replication: enableOptimized
              - vni: 10102
                mcast_group: 239.1.1.2
                multisite_ingress_replication: enableOptimized
              - vni: 11010
                associate_vrf: true