Host Policy Management for Flow data
The following are the Host Policy Management for Flow data 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/hostpolicies/
Description
Method to Get the host instances created. No duplicate policies allowed for Host+hostRole+multiCastIp combination.
URL
https://dcnm-ip/rest/pmn/hostpolicies/
Parameter
|
|
|
policyName |
String |
Mandatory - Policy name for this host |
Host |
String |
Mandatory - Id of the host instance that this policy needs to be applied on. |
hostRole |
Enum |
Mandatory - Sender or Receiver |
permit |
Enum |
Mandatory - Yes or No |
multiCastIpRange |
String |
Mandatory - * - for all multicast Groups, or specific unique multicast IP address. |
Return Value
Format: JSON
Type: Object
|
|
|
hostPolicyId |
String |
Instance id of the hostpolicy defined. |
Resource Name
/rest/pmn/hostpolicies/import
Description
Creates a new host instance.
URL
https://dcnm-ip/rest/pmn/hostpolicies/import
Parameter
|
|
|
String payload of CSV File |
String |
CSV data |
Return Value
Format: JSON
Type: Long
|
|
|
hostid |
String |
Unique id for the created Host policy instances |
Resource Name
/rest/pmn/hostpolicies?detail=true
Description
Get a listing of all hostpolicies or specific hostpolicy, given the id.
URL
https://dcnm-ip/rest/pmn/hostpolicies/ - Get all hostPolicies
https://dcnm-ip/rest/pmn/hostpolicies/{hostpolicyid} - Get all information about specific hostpolicy
Parameter
|
|
|
hostpolicyid |
String |
Optional id parameter, when querying for a specific id. |
Return Value
Format: JSON
Type: Long
|
|
|
Hostpolicy Object |
String |
Host Policy object created. |
Resource Name
/rest/pmn/host/
Description
Get the host instances created.
URL
https://dcnm-ip/rest/pmn/host/ -- get all Hosts
https://dcnm-ip/rest/pmn/host/{host_id} -- get Host with specific hostid
Parameter
|
|
|
none |
String |
All hosts created |
hostid |
String |
Request about a particular Host ID |
Return Value
Format: JSON
Type: Long
|
|
|
id |
String |
Unique id for the Host Instance |
name |
String |
Name of the Host Instance |
ipAddress |
String |
IP Address of the Host Instance |
macAddress |
String |
Mac Address of the Host Instance |
ethswitchId |
String |
Unique id of the device the host is connected to |
interfaceId |
String |
Unique id of the interface instance of the device the host is connected to. |
Resource Name
/rest/pmn/host/
Description
Deletes the host instances created.
URL
https://dcnm-ip/rest/pmn/host/<hostid>
Return Value
Format: JSON
Type: Long
Resource Name
/rest/pmn/host/
Description
Delete the host instances created.
URL
https://dcnm-ip/rest/pmn/host/<hostid>
Return Value
Format: JSON
Type: Long