RESTAPI Manual
Virtualization
VXLAN
17 min
urls summary 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 examples show vxlan remotemac show vxlan remotemac post https //{switch ip}/rest/v1/rpc/show vxlan remotemac { "ip" "10 0 1 1" } show vxlan tunnel show vxlan tunnel post https //{switch ip}/rest/v1/rpc/show vxlan tunnel get vxlan configurations get vxlan configurations get https //{switch ip}/rest/v1/running/vxlan create a vxlan local vtep 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 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 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 properties descriptions vxlan global 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 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 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 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 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 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
