Flow Policy Management
The following are the Flow Policy Management 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
/rest/pmn/flowpolicies/
Description
Get the host instances created.
URL
https://dcnm-ip/rest/pmn/flowpolicies/
Parameter
|
|
|
policyName |
String |
Mandatory - Policy name for this host |
bandwidth |
String |
Bandwidth of this Flow in GB |
DSCP |
String |
Decimal mapping of the DSCP bit based on the standard. |
Return Value
Format: JSON
Type: Object
|
|
|
hostPolicyId |
String |
Instance id of the hostpolicy defined. |
policyName |
String |
Name of the Policy object |
obj.multiCastIpRange |
String |
MultiCast IP address that this policy is applied on or * if it applies to all multicast groups. |
Bandwidth |
String |
Populate with 3, 1.5 or any other custom number. Provide the unit with the number as Mbps or Gbps.
|
dscp |
String |
Integer values in range 0-46 mapping to DSCP values indicated below. |
Resource Name
/rest/pmn/flowpolicies/import
Description
Create a new flow instance.
URL
https://dcnm-ip/rest/pmn/flowpolicies/import
Parameter
|
|
|
String payload of CSV File |
String |
CSV data |
Return Value
Format: JSON
Type: Long
|
|
|
flowpolicyid |
String |
Unique id for the created Flow policy instances |
Resource Name
/rest/pmn/flowpolicies?detail=true
Description
Get a listing of all flow policies or specific flow policy, given the id.
URL
https://dcnm-ip/rest/pmn/flowpolicies/
Parameter
|
|
|
flowpolicyid |
String |
Optional id parameter, when querying for a specific id. |
Return Value
Format: JSON
Type: Long
|
|
|
flowpolicyid |
String |
Unique id for the created Host policy instances |
Resource Name
/rest/pmn/flowpolicies/
Description
Delete the Flow policy instances created.
URL
https://dcnm-ip/rest/pmn/flowpolicies/<flowpolicyid>
Return Value
Format: JSON
Type: Long