VXLAN
List all VTEPs
Resource Name
/topology/switches/vxlan/vteps
Description
List of all the VTEPs.
https Method
GET
URL
https://<dcnm-ip>/rest/topology/switches/vxlan/vteps
Parameter
| Parameter | Type | Description |
|---|---|---|
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| VTEPs | A | List of VTEPs including attributes VTEP IP, NVE Interface and Switch ID. |
Get VTEPs with VNI
Resource Name
/topology/switches/vxlan?vni=<vni>
Description
Get the VTEPs which have this VNI configured on them.
https Method
GET
URL
https://<dcnm-ip>/rest/topology/switches/vxlan?vni=<vni>
Parameter
| Parameter | Type | Description |
|---|---|---|
| vni | S | VXLAN Network Identifier. |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| 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.
https Method
GET
URL
https://<dcnm-ip>/rest/topology/switches/vxlan?multicast-address=<multicast-address>
Parameter
| Parameter | Type | Description |
|---|---|---|
| multicast-address | S | Multicast address configured in VXLAN. |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| 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.
https Method
GET
URL
https://<dcnm-ip>/rest/topology/switches/vxlan?switch-id=<switch-id>
Parameter
| Parameter | Type | Description |
|---|---|---|
| switch-id | S | VTEP switch ID, obtained by the API https://<dcnm-ip>/rest/topology/switches/vxlan/vteps. |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| 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.
https Method
GET
URL
https://<dcnm-ip>/rest/topology/switches/vxlan/peers?switch-id=switch-id>&vni=<vni>
Parameter
| Parameter | Type | Description |
|---|---|---|
| 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
| Attribute Name | Type | Description |
|---|---|---|
| VTEP peers | A | List of VTEP active peers for given VNI. |