-
Notifications
You must be signed in to change notification settings - Fork 21
ANC configuration
This is Adaptive Network Control configuration service. This is available in ISE 2.4
Name | Description | Example |
---|---|---|
restBaseUrl | https://ise-host1:8910/pxgrid/ise/config/anc | |
wsPubsubService | com.cisco.ise.pubsub | |
statusTopic | /topic/com.cisco.ise.config.anc.status |
Service | Operation | Description |
---|---|---|
com.cisco.ise.config.anc | gets | All get operations |
com.cisco.ise.config.anc | sets | All create/update/delete/apply/clear operations |
com.cisco.ise.pubsub | publish /topic/com.cisco.ise.config.anc.status | |
com.cisco.ise.pubsub | subscribe /topic/com.cisco.ise.config.anc.status |
These are the set of APIs to manipulate ANC policies, which can be then applied to endpoints.
This is used to get policies.
An empty json structure must be sent as the request.
If no policy is found, policies
will have an empty array.
{
}
{
"policies": [
array of policy object
]
}
If policy does not exist, HTTP status "204 No content" will be returned with empty body
{
"name": string (required)
}
{
policy object
}
There is no need to set the "id" field for the request policy object. After successful creation, the "id" field will be populated in the returned policy object
If the policy name is already used in an existing policy, HTTP status "409 Conflict" will be returned.
{
policy object
}
{
policy object
}
{
policy object
}
{
policy object
}
This is no response body for this query. If policy is deleted, HTTP status "200" will be returned. If policy does not exist, HTTP status "204 No content" will be returned.
{
"id": string (required)
}
(empty)
The Endpoint REST APIs provides the ability to assign policies to endpoints.
The terms "apply/clear" are used. They do more than just "create/delete". They look up endpoints and trigger Radius Disconnect if active.
Since Radius Disconnect involves remote calls and retries, the activity may take a while.
Thus, "apply/clear" endpoint calls are asynchronous.
When triggered, they return a status object with operation ID and status.
One can either subscribe to statusTopic for updates of operation status.
Or periodically query the operation with getOperationStatus
.
Operation will always finish and set status to success or failure. If it takes too long, it will timeout and set status to failure.
getOperationStatus
can query operations for up to an hour. Older operation status are purged from the system.
This is used to get endpoints with policies applied
An empty json structure must be sent as the request.
If no endpoint policy is found, endpointPolicies
will have an empty array.
{
}
{
"endpoints": [
array of endpoint object
]
}
If endpoint does not exist, HTTP status "204 No content" will be returned.
{
"macAddress": string (required)
}
{
endpoint object
}
Apply a policy to the endpoint using IP Address
{
"policyName": string (required),
"ipAddress": string (required)
}
{
status object
}
Apply a policy to the endpoint using MAC Address
{
"policyName": string (required),
"macAddress": string (required)
}
{
status object
}
{
"policyName": string (required),
"macAddress": string (required)
}
{
status object
}
If operation does not exist, HTTP status "204 No content" will be returned.
{
"operationId": string (required)
}
{
status object
}
{
status object
}
"operation" type one of the following strings:
- CREATE
- UPDATE
- DELETE
Name | Type | Description | ISE version |
---|---|---|---|
id | string | 2.4 | |
name | string | 2.4 | |
actions | array of action type | 2.4 |
Name | Type | Description | ISE version |
---|---|---|---|
id | string | 2.4 | |
policyName | string | 2.4 | |
macAddress | string | 2.4 |
"action" type can be on of the following strings:
- QUARANTINE
- SHUT_DOWN
- PORT_BOUNCE
Name | Type | Description | ISE version |
---|---|---|---|
operationId | string | 2.4 | |
macAddress | string | MAC address where operation is performed | 2.4 |
status | string | RUNNING, SUCCESS or FAILURE | 2.4 |
failureReason | string | The reason if it fails | 2.4 |
"policy" object
{
"id":"5caf94c4-1bf9-493c-8505-89cd0e36fbda",
"name":"p2",
"actions":["QUARANTINE"]
}
"status" object
{
"operationId":"pxgrid-001.cisco.com:2",
"status":"SUCCESS"
}
endpoints array
{
"endpoints": [{
"id": "0d1f7169-108a-44da-b407-5db1da722f6a",
"policyName": "p2",
"macAddress": "33:33:33:33:33:33"
}, {
"id": "2c46003d-a22f-4fee-8975-d93945a6552a",
"policyName": "p1",
"macAddress": "00:11:22:33:44:55"
}]
}