Topology
The following are the Topology 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 |
Description
Enables to get a topology
URL
https://dcnm-ip/fm/fmrest/topology
Return Value
Format: JSON
Type: Object
|
|
|
|
Topology |
O |
Topology Object |
Resource Name
/topology/vpc
Description
Enables to get a VPC topology
URL
https://dcnm-ip/fm/fmrest/topology/vpc
Parameter
|
|
|
|
vpcDbId |
long @QueryParam |
VPC database identifier |
Return Value
Format: JSON
Type: Object
|
|
|
|
Topology |
O |
Topology Object |
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.
URL
https://dcnm-ip/fm/fmrest/topology/role/
Parameter
|
|
|
|
ethSwitchId |
long |
Switch ID |
Return Value
Format: JSON
Type: Object
Resource Name
/topology/role/{ethSwitchId}
Description
Reverts the role of the switch to its default role.
URL
https://dcnm-ip/fm/fmrest/topology/role/
Parameter
|
|
|
|
ethSwitchId |
long @PathParam |
Switch ID |
Return Value
Format: JSON
Type: Object
Resource Name
/topology/tags/{definedType}
Description
Enables you to get all topology tags
URL
https://dcnm-ip/fm/fmrest/topology/{definedType}
Parameter
|
|
|
|
definedType |
S @PathParam |
Enums (USER or SYSTEM) |
idsToFetch |
O |
IntegerList of ids to fetch |
Return Value
Format: JSON
Type: Object
|
|
|
|
tags |
A |
A set of all requested tags |
Resource Name
/topology/tags/{id}
Description
Enables you to fetch a tag
URL
https://dcnm-ip/fm/fmrest/topology/tags/{id}
Parameter
|
|
|
|
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
Resource Name
/topology/tags
Description
Enables to create a tag
URL
https://dcnm-ip/fm/fmrest/topology/tags
Parameter
|
|
|
|
id |
S |
ID to fetch |
type |
S |
Enums (SWITCH or LINK) |
definedType |
S |
Enums (USER or SYSTEM) |
value |
S |
Tag name |
tag |
O |
Tag object |
Return Value
Format: JSON
Type: Object
Resource Name
/topology/tags
Description
Enables to delete tags
URL
https://dcnm-ip/fm/fmrest/topology/tags
Parameter
|
|
|
|
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
Resource Name
/topology/l2vlanstp/islsondemand
Description
Enables you to search for VLAN information in a group
URL
https://dcnm-ip/fm/fmrest/topology/l2vlanstp/islsondemand
Parameter
|
|
|
|
group-id |
String @QueryParam |
DCNM Group ID |
range |
String @QueryParam |
Vlan range to be searched.
|
Return Value
Format: JSON
Type: Object
|
|
|
|
L2TopologyOnDemand |
O |
Contains ISL and Switches for the searched VLAN range |
Resource Name
/rest/topology/switches/otv
Description
Enables to fetch OTV overlay networks
URL
https://dcnm-ip/rest/topology/switches/otv
Parameter
|
|
|
|
session-id |
String @QueryParam |
Token |
Return Value
Format: JSON
Type: Object
|
|
|
|
Overlays |
O |
Contains list of OTV overlays |
Resource Name
/rest/topology/switches/otv/vlans
Description
Enables you to fetch OTV active and inactive extended vlans for OTV edges
URL
https://dcnm-ip/rest/topology/switches/otv/vlans-<<Edit the URL>>
Parameter
|
|
|
|
session-id |
String @QueryParam |
Token |
Return Value
Format: JSON
Type: Object
|
|
|
|
OtvVlans |
A |
Contains list of active and inactive extended VLANs. |
Resource Name
/rest/topology/switches/vxlan/vteps
Description
Enables you to fetch all VxLan VTEPs
URL
https://dcnm-ip/rest/topology/switches/vxlan/vteps
Parameter
|
|
|
|
session-id |
String @QueryParam |
Token |
Return Value
Format: JSON
Type: Object
|
|
|
|
vteps |
A |
Contains list of VxLan VTEPs |
Resource Name
/rest/topology/switches/vxlan
Description
Enables you to search vteps on VNIs
URL
https://dcnm-ip/rest/topology/switches/vxlan
Parameter
|
|
|
|
vni |
String @QueryParam |
vni |
session-id |
String @QueryParam |
Token |
Return Value
Format: JSON
Type: Object
|
|
|
|
vteps |
A |
Contains list of VxLAN VTEPs |
Resource Name
/rest/topology/switches/vxlan
Description
Enables you to search vteps on multicast address
URL
https://dcnm-ip/rest/topology/switches/vxlan
Parameter
|
|
|
|
multicast-address |
String @QueryParam |
Multicast address |
session-id |
String @QueryParam |
Token |
Return Value
Format: JSON
Type: Object
|
|
|
|
vteps |
A |
Contains list of VxLAN VTEPs |
Resource Name
/rest/topology/switches/vxlan
Description
Enables you to search vteps on multicast address
URL
https://dcnm-ip/rest/topology/switches/vxlan
Parameter
|
|
|
|
switch-id |
String @QueryParam |
Switch Database ID |
session-id |
String @QueryParam |
Token |
Return Value
Format: JSON
Type: Object
|
|
|
|
VxLanData |
A |
Contains list of VNIs and associated parameters for switch |
Feedback