VxLAN
The following are the VxLAN REST APIs:
Status
The following table details the API Response code, status and, the HTTPS methods.
|
|
|
200 |
OK |
GET |
202 |
Accepted |
POST PUT DELETE |
400 |
Bad Request |
GET POST PUT DELETE |
401 |
Unauthorized |
GET POST PUT DELETE |
403 |
Forbidden |
GET POST PUT DELETE |
404 |
Not Found |
GET POST PUT DELETE |
405 |
Method Not Allowed |
GET POST PUT DELETE |
500 |
Internal Server Error |
GET POST PUT DELETE |
Resource Name
/topology/switches/vxlan/vteps
Description
List of all the VTEPs.
URL
https://dcnm-ip/rest/topology/switches/vxlan/vteps
Return Value
Format: JSON
Type: Object
|
|
|
VTEPs |
A |
List of VTEPs including attributes VTEP IP, NVE Interface and Switch ID. |
Resource Name
/topology/switches/vxlan?vni=<vni>
Description
Get the VTEPs which have this VNI configured on them.
URL
https://dcnm-ip/rest/topology/switches/vxlan?vni=<vni>
Parameter
|
|
|
vni |
S |
VxLAN Network Identifier. |
Return Value
Format: JSON
Type: Object
|
|
|
VTEPs |
A |
List of VTEPs configured with VNI, including attributes, multicast address, VNI status, VLAN, NVE interface, switch name and switch ID. |
Get VTEPs with Multicast address
Resource Name
/topology/switches/vxlan?multicast-address=<multicast-address>
Description
Get VTEPs which have this multicast address configured on them.
URL
https://dcnm-ip/rest/topology/switches/vxlan?multicast-address=<multicast-address>
Parameter
|
|
|
multicast-address |
S |
Multicast address configured in VxLAN. |
Return Value
Format: JSON
Type: Object
|
|
|
VTEPs |
A |
List of VTEPs configured with multicast address, including attributes, VNI, multicast address, VNI status, VLAN, NVE interface, switch name and switch ID. |
Get VNI details for a VTEP
Resource Name
/topology/switches/vxlan?switch-id=<switch-id>
Description
Get all the VNIs configured on a VTEP with all the associated attributes.
URL
https://dcnm-ip/rest/topology/switches/vxlan?switch-id=<switch-id>
Parameter
|
|
|
switch-id |
S |
VTEP switch ID, obtained by the API https://dcnm-ip/rest/topology/switches/vxlan/vteps. |
Return Value
Format: JSON
Type: Object
|
|
|
VNI Details |
A |
List of all VNIs on a VTEP, with the associated Multicast Address, VNI Status, VLAN, NVE Interface, Switch Name and Switch ID. |
Get active peers for a VTEP for a given VNI
Resource Name
/topology/switches/vxlan/peers?switch-id=<switch-id>&vni=<vni>
Description
Get the active peers for a VTEP for a given VNI.
URL
https://dcnm-ip/rest/topology/switches/vxlan/peers?switch-id=<switch-id>&vni=<vni>
Parameter
|
|
|
switch-id |
S |
VTEP switch ID, obtained by the API https://dcnm-ip/rest/topology/switches/vxlan/vteps |
vni |
S |
VxLAN Network Identifier |
Return Value
Format: JSON
Type: Object
|
|
|
VTEP peers |
A |
List of VTEP active peers for given VNI. |