VxLAN

URLs Summary

URL	GET	POST	PATCH	PUT	DELETE
/rest/v1/rpc/show-vxlan-remotemac	N	Y	N	N	N
/rest/v1/rpc/show-vxlan-tunnel	N	Y	N	N	N
/rest/v1/running/vxlan	Y	N	Y	N	N
/rest/v1/running/vxlan/local-vtep/{id}	Y	Y	Y	N	Y
/rest/v1/running/vxlan/map/{vni}	Y	Y	N	N	Y
/rest/v1/running/vxlan/remote-vtep/{vni}/{ip}	Y	Y	Y	N	Y

Examples

Show vxlan remotemac

POST HTTPS://{switch IP}/rest/v1/rpc/show-vxlan-remotemac
{
    "ip": "10.0.1.1"
}

Show vxlan tunnel

POST HTTPS://{switch IP}/rest/v1/rpc/show-vxlan-tunnel

Get vxlan configurations.

GET HTTPS://{switch IP}/rest/v1/running/vxlan

Create a VXLAN local vtep.

POST HTTPS://{switch IP}/rest/v1/running/vxlan/local-vtep/8
{
    "ip": "2.2.2.2"
}

Create a VXLAN remote vtep.

POST HTTPS://{switch IP}/rest/v1/running/vxlan/remote-vtep
{
    "vni": 500,
    "ip": "1.1.1.1"
}

Create a VXLAN map.

POST  HTTPS://{switch IP}/rest/v1/running/vxlan/map
{
    "vni": 999,
    "vtep-id": 6,
    "map-type": "l3",
    "vrf": "default"
}

Properties Descriptions

VXLAN global

Tree Diagrams

  +--rw vxlan
     +--rw udp-port?
     +--rw centralized-gateway?

Table of Properties

Name	Required	Type/Range	Description
vxlan	M		Path-only node, has no configurable value. Configuration for the VXLAN
udp-port	O	1..65535	(sub-property of vxlan) The port used to encapsulate VXLAN packets Default value: 4789
centralized-gateway	O	”true""false”	(sub-property of vxlan) Configure VXLAN mode centralized Default value: “false”

VXLAN local vteps

Tree Diagrams

  +--rw vxlan
     +--rw local-vtep* [id]
     |  +--rw id
     |  +--rw ip

Table of Properties

Name	Required	Type/Range	Description
vxlan	M		Path-only node, has no configurable value. Configuration for the VXLAN
local-vtep	M		(sub-property of vxlan) Path-only node, has no configurable value. List of Multi-vtep that is supported for VXLAN on some platforms
id	M	0..9	(sub-property of local-vtep) ID of local VTEP
ip	M	A.B.C.D	(sub-property of local-vtep) Local IP of tunnel

VXLAN remote vteps

Tree Diagrams

  +--rw vxlan
     +--rw remote-vtep* [vni ip]
     |  +--rw vni
     |  +--rw ip
     |  +--rw router-mac?
     |  +--ro local-vtep-id?

Table of Properties

Name	Required	Type/Range	Description
vxlan	M		Path-only node, has no configurable value. Configuration for the VXLAN
remote-vtep	M		(sub-property of vxlan) Path-only node, has no configurable value. List of static L2 VXLAN tunnel
vni	M	1..16777215	(sub-property of remote-vtep) VNI of l2 VXLAN tunnel
ip	M	A.B.C.D	(sub-property of remote-vtep) Remote VTEP IP
router-mac	O	A:B:C:D:E:F	(sub-property of remote-vtep) Router-mac of remote VTEP
local-vtep-id	RO	0..9	(sub-property of remote-vtep) Leaf that help to config Default value: 0

VXLAN maps

Tree Diagrams

  +--rw vxlan
     +--rw map* [vni]
        +--rw vni
        +--rw vtep-id?
        +--rw map-type
        +--rw vlan-id
        +--rw vrf

Table of Properties

Name	Required	Type/Range	Description
vxlan	M		Path-only node, has no configurable value. Configuration for the VXLAN
map	M		(sub-property of vxlan) Path-only node, has no configurable value. List of VXLAN map
vni	M	1..16777215	(sub-property of map) VNI of VXLAN map
vtep-id	O	0..9	(sub-property of map) ID of the VXLAN tunnel Default value: 0
map-type	M	”l2""l3”	(sub-property of map) VXLAN map type choice
vlan-id	CM	1..4094	(sub-property of map) Only applicable when map-type = “l2”. VLAN id of l2 map
vrf	CM	”default” vrf name	(sub-property of map) Only applicable when map-type =“l3”. VRF name of l3 map

Show-vxlan-tunnel

Tree Diagrams

    +---x show-vxlan-tunnel
    |  +--ro output
    |     +--ro tunnel* [remote-ip vni]
    |        +--ro remote-ip
    |        +--ro vni
    |        +--ro vlan-or-vrf?

Table of Properties

Name	Required	Type/Range	Description
show-vxlan-tunnel	M		Path-only node, has no configurable value. Show VXLAN tunnel
tunnel	RO		(sub-property of output) Path-only node, has no configurable value. List of established VXLAN tunnels
remote-ip	RO	A.B.C.D	(sub-property of tunnel) IP address of remote VTEP
vni	RO	1..16777215	(sub-property of tunnel) VNI of tunnel
vlan-or-vrf	RO	1..4094”default”vrf name”	(sub-property of tunnel) VLAN or VRF mapped to the VNI

Show-vxlan-remotemac

Tree Diagrams

    +---x show-vxlan-remotemac
       +---w input
       |  +---w ip?
       +--ro output
          +--ro fdb* [vlan-id mac]
             +--ro vlan-id
             +--ro mac
             +--ro vni?
             +--ro remote-ip*
             +--ro type?

Table of Properties

Name	Required	Type/Range	Description
show-vxlan-remotemac	M		Path-only node, has no configurable value. Show VXLAN remotemac
ip	O	A.B.C.D	(sub-property of input) Display VXLAN remotemac of specific remote ip or remotemac of all
fdb	RO		(sub-property of output) Path-only node, has no configurable value. List of fdb entry learned from VXLAN tunnel
vlan-id	RO	1..4094	(sub-property of fdb) VLAN ID
mac	RO	A:B:C:D:E:F	(sub-property of fdb) MAC address
vni	RO	1..16777215	(sub-property of fdb) VNI of the VXLAN tunnel
remote-ip	RO	A.B.C.D	(sub-property of fdb) IP address of remote VTEP
type	RO	”static""dynamic”	(sub-property of fdb) Type of fdb