Operational Management
The following are the Static Flow Stitching 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 |
Get Flow_id for a given MulticastIP
Resource Name
/rest/pmn/getflowid/mcastIp/{mcastIp}
Description
Get a listing of all the Current Flows in the network.
URL
https://dcnm-ip/rest/pmn/getflowid/mcastIp/{mcastIp}- Get Flowid for particular flow.
https://dcnm-ip/rest/pmn/getflowid/mcastIp/{mcastIp}/source/{host_id} - Get listing of specific flow in the network for given mcastIp+sender (host_id) combination(IGMPV3).
Parameter
|
|
|
Flow-id |
String |
Integer number indicating each flow. |
Return Value
Format: JSON
Type: Object
Get Listing of all Active/Current Flows
Resource Name
/rest/pmn/flowstatus
Description
Get a listing of all the Current Flows in the network.
URL
https://dcnm-ip/rest/pmn/flowstatus - Get listing of all Flows in the network.
https://dcnm-ip/rest/pmn/flowstatus/{flow-id} -Get listing about all senders and receivers information about a specific flow.
https://dcnm-ip/rest/pmn/flow/{flowID}/{senderHostId}/{receiverHostId} - Get all information about the specific flow between a selected sender and a receiver.
Note A Flow id is a unique instance of the multicast flow, with bandwidth and dscp bit allocations. Every sender/receiver pair forms an instance of this particular Flow id. Therefore, for a given flow, with one sender and 2 receivers, there will be 2 entries in the flowstatus response.
Parameter
|
|
|
Flow-id |
String |
Integer number indicating each flow. |
Return Value
Format: JSON
Type: Long
Get Listing of all Flows that a selected host participates in
Resource Name
/rest/pmn/topology/host/{hostId}/flows-participating-in
Description
Get a listing of all the flows that a selected host participates in.
URL
https://dcnm-ip/rest/pmn/topology/host/{hostID}/flows-participating-in
Parameter
|
|
|
hostId |
String |
Unique identifier of the host (sender/receiver) |
Return Value
Format: JSON
Type: Long
Get Listing of all Flows that a particular switch participates in.
Resource Name
/rest/pmn/topology/switch/{switchId}/flows-passing-through
Description
Get a listing of all the flows that a selected switch participates in.
URL
https://dcnm-ip/rest/pmn/topology/switch/{switchId}/flows-passing-through
Parameter
|
|
|
switchId |
String |
Unique identifier of the switch |
Return Value
Format: JSON
Type: Long
Topology and Inventory APIs
Resource Name
/fm/fmrest/inventory/switches
/fm/fmrest/san/getDetailsBySwitch/?switchDbID={switchDbId}
/fm/fmrest/inventory/getInterfacesBySwitch/?switchDbID={switchDbId}&network=LAN
Description
Get Inventory information and Query information about the inventory, such as, Switch IP, modules, interfaces, mgmt. interface etc.
URL
https://dcnm-ip/fm/fmrest/inventory/switches - Get listing of all Switch instances with details
https://dcnm-ip/fm/fmrest/san/getDetailsBySwitch/?switchDbID={switchDbId} - Get details about a particular switch.
https://dcnm-ip/fm/fmrest/inventory/getInterfacesBySwitch/?switchDbID={switchDbId} - Get interface specific information about a particular switch.
Note The interface level API, will expose interface ids, that will also be obtained in the flow API and can be mapped to instances participating in a flow.
Parameter
|
|
|
switchDbId |
String |
Unique identifier of the switch |
Return Value
Format: JSON
Type: Long
|
|
|
Access denied |
|
DCNM session is invalid, need to get new session token. |
String value |
|
String value indicating Success/Failure of the new flow being deleted. |
Delete/Leave Receiver for a Flow
Resource Name
/rest/pmn/events
Description
Get a listing of all the events that occurred in DCNM.
URL
https://dcnm-ip/rest/pmn/events/ -- Get listing of all events
https://dcnm-ip/rest/pmn/events/start/{startTime} - Get listing of all events posted after a particular time.
https://dcnm-ip/rest/pmn/events/start/{startTime}/severity/{severitylevel} - Get listing of events of a particular severity after a particular start time.
Parameter
|
|
|
startTime |
String |
Start time in format yyyy-MM-dd'T'HH:mm:ss |
severitylevel |
String |
INFO/DEBUG/ERROR/CRITICAL |
Return Value
Format: JSON
Type: Long