Topology
Get a Topology
Resource Name
/topology
Description
Enables to get a topology
https Method
GET
URL
https://<dcnm-ip>/fm/fmrest/topology
Parameter
| Parameter | Type | Description |
|---|---|---|
| NA | NA | NA |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| Topology | O | Topology Object |
Get a Vpc Topology
Resource Name
/topology/vpc
Description
Enables to get a VPC topology
https Method
GET
URL
https://<dcnm-ip>/fm/fmrest/topology/vpc
Parameter
| Parameter | Type | Description |
|---|---|---|
| vpcDbId | long @QueryParam | VPC database identifier |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| Topology | O | Topology Object |
Override Switch Role
Resource Name
topology/role/{ethSwitchId}
Description
Switch override is used by the topology so that you can specify which position to render a node at. This API is used to change the role or override the role of the Switch. It has a default value of -1.
https Method
PUT
URL
https://<dcnm-ip>/fm/fmrest/topology/role/
Parameter
| Parameter | Type | Description |
|---|---|---|
| ethSwitchId | long | Switch ID |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| NA | NA | NA |
Revert Switch Role
Resource Name
/topology/role/{ethSwitchId}
Description
Reverts the role of the switch to its default role.
https Method
DELETE
URL
https://<dcnm-ip>/fm/fmrest/topology/role/
Parameter
| Parameter | Type | Description |
|---|---|---|
| ethSwitchId | long @PathParam | Switch ID |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| NA | NA | NA |
Get Topology Tags
Resource Name
/topology/tags/{definedType}
Description
Enables you to get all topology tags
https Method
GET
URL
https://<dcnm-ip>/fm/fmrest/topology/{definedType}
Parameter
| Parameter | Type | Description |
|---|---|---|
| definedType | S @PathParam | Enums (USER or SYSTEM) |
| idsToFetch | O | IntegerList of ids to fetch |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| tags | A | A set of all requested tags |
Fetch Tag
Resource Name
/topology/tags/{id}
Description
Enables you to fetch a tag
https Method
GET
URL
https://<dcnm-ip>/fm/fmrest/topology/tags/{id}
Parameter
| Parameter | Type | Description |
|---|---|---|
| definedType | S @PathParam | Enums (USER or SYSTEM) |
| type | S @QueryParam | Enums (SWITCH or LINK) |
| id | int @PathParam | ID to fetch |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| tags | O | Requested tag |
Create Tag
Resource Name
/topology/tags
Description
Enables to create a tag
https Method
POST
URL
https://<dcnm-ip>/fm/fmrest/topology/tags
Parameter
| Parameter | Type | Description |
|---|---|---|
| tag | O | Tag object |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
Delete Tags
Resource Name
/topology/tags
Description
Enables to delete tags
https Method
DELETE
URL
https://<dcnm-ip>/fm/fmrest/topology/tags
Parameter
| Parameter | Type | Description |
|---|---|---|
| definedType | S @QueryParam | Enums (USER or SYSTEM) |
| type | S @QueryParam | Enums (SWITCH or LINK) |
| id | int @QueryParam | ID to fetch |
| tagName | S @QueryParam | Tag to delete |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
VLAN Search
Resource Name
/topology/l2vlanstp/islsondemand
Description
Enables you to search for VLAN information in a group
https Method
GET
URL
https://<dcnm-ip>/fm/fmrest/topology/l2vlanstp/islsondemand
Parameter
| Parameter | Type | Description |
|---|---|---|
| group-id | String @QueryParam | DCNM Group ID |
| range | String @QueryParam | Vlan range to be searched. Example: 1-10,120-150 |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| L2TopologyOnDemand | O | Contains ISL and Switches for the searched VLAN range |
OTV Topology
Resource Name
/rest/topology/switches/otv
Description
Enables to fetch OTV overlay networks.
https Method
GET
URL
https://<dcnm-ip>/rest/topology/switches/otv
Parameter
| Parameter | Type | Description |
|---|---|---|
| session-id | String @QueryParam | Token |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| Overlays | O | Contains list of OTV overlays |
OTV Vlans
Resource Name
/rest/topology/switches/otv/vlans
Description
Enables you to fetch OTV active and inactive extended vlans for OTV edges
https Method
GET
URL
https://<dcnm-ip>/rest/topology/switches/otv/vlans
Parameter
| Parameter | Type | Description |
|---|---|---|
| session-id | String @QueryParam | Token |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| OtvVlans | A | Contains list of active and inactive extended VLANs. |
VxLan VTEPs
Resource Name
/rest/topology/switches/vxlan/vteps
Description
Enables you to fetch all VxLan VTEPs
https Method
GET
URL
https://<dcnm-ip>/rest/topology/switches/vxlan/vteps
Parameter
| Parameter | Type | Description |
|---|---|---|
| session-id | String @QueryParam | Token |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| vteps | A | Contains list of VxLan VTEPs |
VxLan VNIs
Resource Name
/rest/topology/switches/vxlan
Description
Enables you to search vteps on VNIs
https Method
GET
URL
https://<dcnm-ip>/rest/topology/switches/vxlan
Parameter
| Parameter | Type | Description |
|---|---|---|
| vni | String @QueryParam | vni |
| session-id | String @QueryParam | Token |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| vteps | A | Contains list of VxLAN VTEPs |
VxLan Multicast
Resource Name
/rest/topology/switches/vxlan
Description
Enables you to search vteps on multicast address
https Method
GET
URL
https://<dcnm-ip>/rest/topology/switches/vxlan
Parameter
| Parameter | Type | Description |
|---|---|---|
| multicast-address | String @QueryParam | Multicast address |
| session-id | String @QueryParam | Token |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| vteps | A | Contains list of VxLAN VTEPs |
Switch VxLan Details
Resource Name
/rest/topology/switches/vxlan
Description
Enables you to search vteps on multicast address
https Method
GET
URL
https://<dcnm-ip>/rest/topology/switches/vxlan
Parameter
| Parameter | Type | Description |
|---|---|---|
| switch-id | String @QueryParam | Switch Database ID |
| session-id | String @QueryParam | Token |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| VxLanData | A | Contains list of VNIs and associated parameters for switch |
Get STP information
Resource Name
/topology/l2vlanstp/stpsearch
Description
Enables to get STP information for VLAN in a group.
https Method
POST
URL
https://<dcnm-ip>/fm/rest/topology/l2vlanstp/stpsearch
Parameter
| Parameter | Type | Description |
|---|---|---|
| L2TopologyOnDemand | object | Response from the previous API. |
Return Value
Format: JSON
Type: Object
| Attribute Name | Type | Description |
|---|---|---|
| L2TopologyOnDemand | O | Contains ISL and Switches for the searched VLAN range |