Policy Service (2.6.0)

Download OpenAPI specification:Download

Extreme Networks: support@extremenetworks.com URL: https://www.extremenetworks.com License: Apache license

This is the spec that defines the APIs provided by the Policy Service to configure Prefix-list, route-maps data

Health

getHealth

Get the health of the policy service.

Responses

200

get/health

http://gopolicy-service:80/v1/policy/health

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"Service": "string",
"MessageBus": "string"
}

PrefixList

getPrefixList

Get prefix list details by type for given device IP address list

query Parameters

type required	string Enum: "ipv4" "ipv6" Type of the prefix lists to retrieve
device_ips	Array of strings >= 0 items IP addresses of the devices

Responses

200

400

Bad Request.

401

Authorization information is missing or invalid.

404

A device with the specified IP address was not found.

500

Unexpected error.

default

Unexpected error

get/prefix-list

http://gopolicy-service:80/v1/policy/prefix-list

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"name": "prefixlist_1",
"type": "ipv4",
"rules": 
[
{"seq": 10,
"action": "permit",
"prefix": "10.0.0.0/8",
"ge": 16,
"le": 24
},
{"seq": 20,
"action": "deny",
"prefix": "50.0.0.0/8"
}
],
"device_states": 
[
{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
},
{"name": "prefixlist_2",
"type": "ipv4",
"rules": 
[
{"seq": 100,
"action": "permit",
"prefix": "100.0.0.0/8",
"ge": 16,
"le": 24
},
{"seq": 200,
"action": "deny",
"prefix": "500.0.0.0/8"
}
],
"device_states": 
[
{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
}
]
}

Prefix-List

createPrefixList

Request Body schema: application/json

Create a prefix list

prefix-list-name	string Name of the prefix list
prefix-list-type	string Enum: "ipv4" "ipv6" Type of the prefix lists to create
prefix-list-rules	Array of objects (PrefixListRule) rules to be added to prefix list

Responses

200

400

Bad Request.

401

Authorization information is missing or invalid.

409

A prefix-list with the specified name already exists.

500

Unexpected error.

default

Unexpected error

post/prefix-list

http://gopolicy-service:80/v1/policy/prefix-list

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"prefix-list-name": "prefixlist_1",
"prefix-list-type": "ipv4",
"prefix-list-rules": 
[
{"prefix-list-name": "prefixlist_1",
"prefix-list-type": "ipv4",
"prefix-list-rules": 
[
{"seq": 10,
"action": "permit",
"prefix": "10.0.0.0/8",
"ge": 16,
"le": 24
},
{"seq": 20,
"action": "deny",
"prefix": "50.0.0.0/8"
}
]
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"name": "prefixlist_v4",
"type": "ipv4",
"rules": 
[
{"rule-info": 
{"seq": 10,
"action": "permit",
"prefix": "10.0.0.0/8",
"ge": 16,
"le": 24
},
"device_state": 
{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
}
},
{"rule-info": 
{"seq": 20,
"action": "permit",
"prefix": "11.1.0.0/8",
"ge": 16,
"le": 24
},
"device_states": 
[
{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
}
]
}

updatePrefixList

Request Body schema: application/json

Update an existing prefix list

prefix-list-name	string Name of the prefix list
prefix-list-type	string Enum: "ipv4" "ipv6" Type of the prefix lists to create
operation	string Enum: "add-rule" "remove-rule" "add-device" "remove-device" Update operation to be performed on prefix list
device-ips	Array of strings IP addresses of the devices
prefix-list-rules	Array of objects (PrefixListRule) rules to be added to prefix list

Responses

200

400

Bad Request.

401

Authorization information is missing or invalid.

404

Not Found.

500

Unexpected error.

default

Unexpected error

put/prefix-list

http://gopolicy-service:80/v1/policy/prefix-list

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"prefix-list-name": "prefixlist_1",
"prefix-list-type": "ipv4",
"operation": "add-device",
"device-ips": "10.20.246.1",
"prefix-list-rules": 
[
{"prefix-list-name": "prefixlist_1",
"prefix-list-type": "ipv4",
"operation": "add-device",
"device_ips": "10.20.246.1"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"prefixlist_result": 
{"name": "prefixlist_v4",
"type": "ipv4",
"rules": 
[
{"seq": 10,
"action": "permit",
"prefix": "10.0.0.0/8",
"ge": 16,
"le": 24
},
{"seq": 20,
"action": "deny",
"prefix": "50.0.0.0/8"
}
],
"device_states": 
[
{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
},
"device_result": 
{"ip_address": "10.25.25.100",
"result": "Failed",
"reason": "Connection to device failed"
}
}

deletePrefixList

Delete an existing prefix list by type and name

query Parameters

name required	string Name of the prefix-list to be deleted
type	string Enum: "ipv4" "ipv6" Type of the prefix-list to be deleted

Responses

200

400

Bad Request.

401

Authorization information is missing or invalid.

404

A prefix-list with the specified name and type was not found.

409

Conflict Request.

500

Unexpected error.

default

Unexpected error

delete/prefix-list

http://gopolicy-service:80/v1/policy/prefix-list

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"name": "prefixlist_v4",
"type": "ipv4",
"rules": 
[
{"rule-info": 
{"seq": 10,
"action": "permit",
"prefix": "10.0.0.0/8",
"ge": 16,
"le": 24
},
"device_state": 
{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
}
},
{"rule-info": 
{"seq": 20,
"action": "permit",
"prefix": "11.1.0.0/8",
"ge": 16,
"le": 24
},
"device_states": 
[
{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
}
]
}

RouteMap

getRouteMap

Get routemap details for given device IP address list

query Parameters

device_ips

Array of strings >= 0 items

IP addresses of the devices

Responses

200

400

Bad Request.

401

Authorization information is missing or invalid.

404

A device with the specified IP address was not found.

500

Unexpected error.

default

Unexpected error

get/route-map

http://gopolicy-service:80/v1/policy/route-map

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"key-info": 
{"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": 
{"match-ip-prefix-list": 
{"prefix-list-name": "prefixlist_v4"
}
},
"device_states": 
[
{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
},
{"key-info": 
{"name": "routemap_2",
"seq": 20,
"action": "deny"
},
"matches": 
{"match-ip-prefix-list": 
{"prefix-list-name": "prefixlist_v4"
}
},
"device_states": 
[
{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
}
]
}

createRouteMap

Request Body schema: application/json

Create a route map

name required	string Name of the route map
rules required	Array of objects (RouteMapRule) non-empty Rule information of route map - contains sequence number and action

Responses

200

400

Bad Request.

401

Authorization information is missing or invalid.

409

A route-map with the specified name, action and sequence number already exists.

500

Unexpected error.

default

Unexpected error

post/route-map

http://gopolicy-service:80/v1/policy/route-map

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "routemap_1",
"rules": 
{"rules": 
[
{"seq": 10,
"action": "permit"
},
{"seq": 20,
"action": "deny"
}
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"key-info": 
{"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": 
{"match-ip-prefix-list": 
{"prefix-list-name": "prefixlist_v4"
}
},
"device_states": 
[
{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
},
{"key-info": 
{"name": "routemap_2",
"seq": 20,
"action": "deny"
},
"matches": 
{"match-ip-prefix-list": 
{"prefix-list-name": "prefixlist_v4"
}
},
"device_states": 
[
{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
}
]
}

updateRouteMap

Request Body schema: application/json

Update an existing route map

name	string Name of the route map
seq	integer sequence number of route map
operation	string Enum: "add-device" "remove-device" "update-action" Update operation to be performed on route map
action	string Enum: "permit" "deny" Action of the route map
device-ips	Array of strings IP addresses of the devices

Responses

200

400

Bad Request.

401

Authorization information is missing or invalid.

404

Not Found.

500

Unexpected error.

default

Unexpected error

put/route-map

http://gopolicy-service:80/v1/policy/route-map

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "routemap_1",
"seq": 10,
"operation": "add-device",
"action": "permit",
"device-ips": "10.20.246.1"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"routemap_result": 
{"key-info": 
{"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": 
{"match-ip-prefix-list": 
{"prefix-list-name": "prefixlist_v4"
}
},
"device_states": 
[
{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
},
"device_result": 
{"ip_address": "10.25.25.100",
"result": "Failed",
"reason": "Connection to device failed"
}
}

deleteRouteMap

Delete an existing route map by name and sequence numbers

query Parameters

name required	string Name of the route map to be deleted
sequence_numbers	Array of integers >= 0 items sequence numbers of the route map to be deleted

Responses

200

400

Bad Request.

401

Authorization information is missing or invalid.

404

A route map with the specified name, action and sequence number was not found.

409

Conflict Request.

500

Unexpected error.

default

Unexpected error

delete/route-map

http://gopolicy-service:80/v1/policy/route-map

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"routemap_result": 
{"key-info": 
{"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": 
{"match-ip-prefix-list": 
{"prefix-list-name": "prefixlist_v4"
}
},
"device_states": 
[
{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
},
"device_result": 
{"ip_address": "10.25.25.100",
"result": "Failed",
"reason": "Connection to device failed"
}
}

RouteMapMatch

createRouteMapMatch

Request Body schema: application/json

Add a match criteria under a route map

key-info required	object (RouteMapKeyInfo)
matches required	object (RouteMapMatches) Route map match criterias

Responses

200

400

Bad Request.

401

Authorization information is missing or invalid.

409

A route-map match already exists.

500

Unexpected error.

default

Unexpected error

post/route-map-match

http://gopolicy-service:80/v1/policy/route-map-match

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"key-info": 
{"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": 
{"match-ip-prefix-list": 
{"prefix-list-name": "prefixlist_v4"
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"routemap_result": 
{"key-info": 
{"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": 
{"match-ip-prefix-list": 
{"prefix-list-name": "prefixlist_v4"
}
},
"device_states": 
[
{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
},
"device_result": 
{"ip_address": "10.25.25.100",
"result": "Failed",
"reason": "Connection to device failed"
}
}

deleteRouteMapMatch

Delete an existing route map match

Request Body schema: application/json

Delete a match criteria under a route map

key-info	object (RouteMapKeyInfo)
matches	object (RouteMapMatches) Route map match criterias

Responses

200

400

Bad Request.

401

Authorization information is missing or invalid.

404

A route map with the specified name, action and sequence number was not found.

409

Conflict Request.

500

Unexpected error.

default

Unexpected error

delete/route-map-match

http://gopolicy-service:80/v1/policy/route-map-match

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"key-info": 
{"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": 
{"match-ip-prefix-list": 
{"prefix-list-name": "prefixlist_v4"
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"routemap_result": 
{"key-info": 
{"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": 
{"match-ip-prefix-list": 
{"prefix-list-name": "prefixlist_v4"
}
},
"device_states": 
[
{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
},
"device_result": 
{"ip_address": "10.25.25.100",
"result": "Failed",
"reason": "Connection to device failed"
}
}

Debug

deviceConfigDriftReconcile

This API helps user to generate the config-drift between efa intended and device configuration. If reconcile flag is set then drifted configuration will be reconciled on the device.

query Parameters

ip_address required	string IP Addresses of the device for which config drift will be generated.
reconcile required	boolean Default: false Value true implies efa drift with devices will be reconciled

Responses

200

401

Authorization information is missing or invalid.

404

A device with the specified IP was not found.

409

A drift and reconcile operation is already in progress for the device.

500

Unexpected error.

default

Unexpected error

post/debug/device/config/drift

http://gopolicy-service:80/v1/policy/debug/device/config/drift

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"mgmt-ip": "10.10.10.10",
"reconciliation-status": 
[
{"config-type": "PrefixListConfig",
"status": "Success",
"error-list": 
[
{"message": "Specified prefix list does not exist",
"code": 101
}
]
}
],
"config-drift": 
{"PrefixListConfig": 
[
{"name": "ipprefixlist_v4",
"type": "ipv4",
"seq": 10,
"app_state": "cfg-refreshed",
"app_state_detail": 
[
{"property_name": "Prefix list rule",
"property_app_state": "cfg-refreshed"
}
]
}
],
"RouteMapConfig": 
[
{"key-info": 
{"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"app_state": "cfg-refreshed",
"app_state_detail": 
[
{"property_name": "Prefix list rule",
"property_app_state": "cfg-refreshed"
}
]
}
]
}
}

Trouble Shooting

GetRunningConfig

Get the list of all CLIs in Running Config

Responses

200

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error

get/runningConfig

http://gopolicy-service:80/v1/policy/runningConfig

Response samples

200
401
500
default

Content type

application/json

Copy

Expand all Collapse all


{"items": 
["string"
]
}