Policy Service (3.5.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.

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

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

PrefixList

getPrefixList

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

Authorizations:

bearerAuth

query Parameters

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

Responses

Response samples

Content type

application/json

{"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"
}
]
}
]
}

createPrefixList

Authorizations:

bearerAuth

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
	Array of objects (PrefixListRule) unique rules to be added to prefix list

Responses

Request samples

Payload

Content type

application/json

{"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

{"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

Authorizations:

bearerAuth

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
	Array of objects (PrefixListRule) unique rules to be added to prefix list

Responses

Request samples

Payload

Content type

application/json

{"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

{"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",
"rollback_reason": null
}
}

deletePrefixList

Delete an existing prefix list by type and name

Authorizations:

bearerAuth

query Parameters

name required	string Name of the prefix-list to be deleted
type required	string Enum: "ipv4" "ipv6" Type of the prefix-list to be deleted
oob	boolean Default: false Option to allow deletion of oob entries

Responses

Response samples

Content type

application/json

{"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",
"rollback_reason": null
}
}

RouteMap

getRouteMap

Get routemap details for given device IP address list

Authorizations:

bearerAuth

query Parameters

device_ips	Array of strings >= 0 items unique IP addresses of the devices
routemap_name	Array of strings >= 0 items unique Route Map name
detail	boolean Default: false Incude OOB details for route-map configuration

Responses

Response samples

Content type

application/json

{"items": [{"key-info": {"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": {"match": [{"match-type": "matchIPv4PrefixList",
"match-value": "prefixlist_v41"
},
{"match-type": "matchCommunityList",
"match-value": "commlist_1"
}
]
},
"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": [{"match-type": "matchIPv6PrefixList",
"match-value": "prefixlist_v6"
},
{"match-type": "matchCommunityList",
"match-value": "commlist_2"
}
]
},
"device_states": [{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
}
]
}

createRouteMap

Authorizations:

bearerAuth

Request Body schema: application/json

Create a route map

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"routemap_result": {"key-info": {"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": {"match": [{"match-type": "matchIPv4PrefixList",
"match-value": "prefixlist_v41"
},
{"match-type": "matchCommunityList",
"match-value": "commlist_1"
}
]
},
"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",
"rollback_reason": null
}
}

updateRouteMap

Authorizations:

bearerAuth

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

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"routemap_result": {"key-info": {"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": {"match": [{"match-type": "matchIPv4PrefixList",
"match-value": "prefixlist_v41"
},
{"match-type": "matchCommunityList",
"match-value": "commlist_1"
}
]
},
"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",
"rollback_reason": null
}
}

deleteRouteMap

Delete an existing route map by name and sequence numbers

Authorizations:

bearerAuth

query Parameters

name required	string Name of the route map to be deleted
sequence_numbers required	Array of strings non-empty unique sequence numbers of the route map to be deleted
oob	boolean Default: false Option to allow deletion of oob entries

Responses

Response samples

Content type

application/json

{"routemap_result": {"key-info": {"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": {"match": [{"match-type": "matchIPv4PrefixList",
"match-value": "prefixlist_v41"
},
{"match-type": "matchCommunityList",
"match-value": "commlist_1"
}
]
},
"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",
"rollback_reason": null
}
}

RouteMapMatch

createRouteMapMatch

Authorizations:

bearerAuth

Request Body schema: application/json

Add one or more match criteria under a route map

required	object (RouteMapKeyInfo)
required	object (RouteMapMatches) Route map match criterias

Responses

Request samples

Payload

Content type

application/json

{"key-info": {"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": {"match": [{"match-type": "matchIPv6PrefixList",
"match-value": "prefixlist_v6"
},
{"match-type": "matchCommunityList",
"match-value": "commlist_1"
}
]
}
}

Response samples

Content type

application/json

{"routemap_result": {"key-info": {"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": {"match": [{"match-type": "matchIPv4PrefixList",
"match-value": "prefixlist_v41"
},
{"match-type": "matchCommunityList",
"match-value": "commlist_1"
}
]
},
"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",
"rollback_reason": null
}
}

deleteRouteMapMatch

Delete one or more match criteria under a route map

Authorizations:

bearerAuth

Request Body schema: application/json

Delete one or more match criteria under a route map

	object (RouteMapKeyInfo)
	object (RouteMapMatches) Route map match criterias

Responses

Request samples

Payload

Content type

application/json

{"key-info": {"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": {"match": [{"match-type": "matchIPv6PrefixList",
"match-value": "prefixlist_v6"
},
{"match-type": "matchCommunityList",
"match-value": "commlist_1"
}
]
}
}

Response samples

Content type

application/json

{"routemap_result": {"key-info": {"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": {"match": [{"match-type": "matchIPv4PrefixList",
"match-value": "prefixlist_v41"
},
{"match-type": "matchCommunityList",
"match-value": "commlist_1"
}
]
},
"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",
"rollback_reason": null
}
}

RouteMapSet

createRouteMapSet

Authorizations:

bearerAuth

Request Body schema: application/json

Add one or more set criteria under a route map

required	object (RouteMapKeyInfo)
required	object (RouteMapSets) Route map set criterias

Responses

Request samples

Payload

Content type

application/json

{"key-info": {"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"sets": {"set": {"set": [{"list-type": "setCommunityValue",
"list-value": "<1-4294967295>|AA:NN where AA and NN in <0-65535>|internet|local-as|no-export|no-advertise|additive"
},
{"list-type": "setExtCommunitySiteOfOrigin",
"list-value": "only one soo allowed in ASN:NN where ASN and NN in <0-65535> or IpAddress:NN"
},
{"list-type": "setExtCommunityRouteTarget",
"list-value": "one or more route targets in ASN:NN where ASN and NN in <0-65535> or IpAddress:NN with an optional additive string"
},
{"list-type": "setCommunityList",
"list-value": "communityList name"
}
]
}
}
}

Response samples

Content type

application/json

{"routemap_result": {"key-info": {"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": {"match": [{"match-type": "matchIPv4PrefixList",
"match-value": "prefixlist_v41"
},
{"match-type": "matchCommunityList",
"match-value": "commlist_1"
}
]
},
"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",
"rollback_reason": null
}
}

deleteRouteMapSet

Delete one or more set criteria from a route map

Authorizations:

bearerAuth

Request Body schema: application/json

Delete set criteria from a route map

	object (RouteMapKeyInfo)
	object (RouteMapSets) Route map set criterias

Responses

Request samples

Payload

Content type

application/json

{"key-info": {"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"sets": {"set": {"set": [{"list-type": "setCommunityValue",
"list-value": "<1-4294967295>|AA:NN where AA and NN in <0-65535>|internet|local-as|no-export|no-advertise|additive"
},
{"list-type": "setExtCommunitySiteOfOrigin",
"list-value": "only one soo allowed in ASN:NN where ASN and NN in <0-65535> or IpAddress:NN"
},
{"list-type": "setExtCommunityRouteTarget",
"list-value": "one or more route targets in ASN:NN where ASN and NN in <0-65535> or IpAddress:NN with an optional additive string"
},
{"list-type": "setCommunityList",
"list-value": "communityList name"
}
]
}
}
}

Response samples

Content type

application/json

{"routemap_result": {"key-info": {"name": "routemap_1",
"seq": 10,
"action": "permit"
},
"matches": {"match": [{"match-type": "matchIPv4PrefixList",
"match-value": "prefixlist_v41"
},
{"match-type": "matchCommunityList",
"match-value": "commlist_1"
}
]
},
"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",
"rollback_reason": null
}
}

Debug

DebugDeviceConfigDrift

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.

Authorizations:

bearerAuth

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

Response samples

Content type

application/json

{"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": "policyListName.",
"type": "route-map prefix-list extcommunity-list community-list large-community-list as-path qos-map qos-profile.",
"subtype": "ipv4 ipv6 standard extended pcp-tc dscp-tc tc-pcp tc-dscp depends on the list type specified",
"seq": 10,
"bind-name": "Ethernet 0/3",
"app_state": "cfg-refreshed",
"app_state_detail": [{"property_name": "Prefix list rule",
"property_app_state": "cfg-refreshed"
}
]
}
],
"RouteMapConfig": [{"name": "policyListName.",
"type": "route-map prefix-list extcommunity-list community-list large-community-list as-path qos-map qos-profile.",
"subtype": "ipv4 ipv6 standard extended pcp-tc dscp-tc tc-pcp tc-dscp depends on the list type specified",
"seq": 10,
"bind-name": "Ethernet 0/3",
"app_state": "cfg-refreshed",
"app_state_detail": [{"property_name": "Prefix list rule",
"property_app_state": "cfg-refreshed"
}
]
}
],
"CommunityListConfig": [{"name": "policyListName.",
"type": "route-map prefix-list extcommunity-list community-list large-community-list as-path qos-map qos-profile.",
"subtype": "ipv4 ipv6 standard extended pcp-tc dscp-tc tc-pcp tc-dscp depends on the list type specified",
"seq": 10,
"bind-name": "Ethernet 0/3",
"app_state": "cfg-refreshed",
"app_state_detail": [{"property_name": "Prefix list rule",
"property_app_state": "cfg-refreshed"
}
]
}
],
"ExtCommunityListConfig": [{"name": "policyListName.",
"type": "route-map prefix-list extcommunity-list community-list large-community-list as-path qos-map qos-profile.",
"subtype": "ipv4 ipv6 standard extended pcp-tc dscp-tc tc-pcp tc-dscp depends on the list type specified",
"seq": 10,
"bind-name": "Ethernet 0/3",
"app_state": "cfg-refreshed",
"app_state_detail": [{"property_name": "Prefix list rule",
"property_app_state": "cfg-refreshed"
}
]
}
],
"LargeCommunityListConfig": [{"name": "policyListName.",
"type": "route-map prefix-list extcommunity-list community-list large-community-list as-path qos-map qos-profile.",
"subtype": "ipv4 ipv6 standard extended pcp-tc dscp-tc tc-pcp tc-dscp depends on the list type specified",
"seq": 10,
"bind-name": "Ethernet 0/3",
"app_state": "cfg-refreshed",
"app_state_detail": [{"property_name": "Prefix list rule",
"property_app_state": "cfg-refreshed"
}
]
}
],
"QosMapConfig": [{"name": "policyListName.",
"type": "route-map prefix-list extcommunity-list community-list large-community-list as-path qos-map qos-profile.",
"subtype": "ipv4 ipv6 standard extended pcp-tc dscp-tc tc-pcp tc-dscp depends on the list type specified",
"seq": 10,
"bind-name": "Ethernet 0/3",
"app_state": "cfg-refreshed",
"app_state_detail": [{"property_name": "Prefix list rule",
"property_app_state": "cfg-refreshed"
}
]
}
],
"QosServicePolicyMapConfig": [{"name": "policyListName.",
"type": "route-map prefix-list extcommunity-list community-list large-community-list as-path qos-map qos-profile.",
"subtype": "ipv4 ipv6 standard extended pcp-tc dscp-tc tc-pcp tc-dscp depends on the list type specified",
"seq": 10,
"bind-name": "Ethernet 0/3",
"app_state": "cfg-refreshed",
"app_state_detail": [{"property_name": "Prefix list rule",
"property_app_state": "cfg-refreshed"
}
]
}
],
"QosProfileConfig": [{"name": "policyListName.",
"type": "route-map prefix-list extcommunity-list community-list large-community-list as-path qos-map qos-profile.",
"subtype": "ipv4 ipv6 standard extended pcp-tc dscp-tc tc-pcp tc-dscp depends on the list type specified",
"seq": 10,
"bind-name": "Ethernet 0/3",
"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

Authorizations:

bearerAuth

Responses

Response samples

200
401
500
default

Content type

application/json

{"items": ["string"
]
}

getExecutionList

Get the list of all the previous executions

Authorizations:

bearerAuth

query Parameters

limit required	integer Default: 10 Limit the number of executions that will be sent in the response. Default is 10
status	string Default: "all" Filter the executions based on the status(failed/succeeded/all)

Responses

Response samples

Content type

application/json

{"items": [{"start_time": "2000-01-23T04:56:07.000+00:00",
"end_time": "2000-01-23T04:56:07.000+00:00",
"id": "id",
"command": "configure add",
"status": "configure add"
},
{"start_time": "2000-01-23T04:56:07.000+00:00",
"end_time": "2000-01-23T04:56:07.000+00:00",
"id": "id",
"command": "configure add",
"status": "configure add"
}
]
}

CommunityList

getCommunityList

Get community-list details for given name, type and device IP address list

Authorizations:

bearerAuth

query Parameters

name	string Name of community list.
type	string Type of community list. Valid types are standard and extended
device_ips	Array of strings >= 0 items unique IP addresses of the devices

Responses

Response samples

Content type

application/json

{"items": [{"key-info": {"name": "commlist_1",
"seq": 10,
"type": "standard",
"action": "permit",
"std-value": "0:3435 0:65535 local-as internet no-advertise no-export"
},
"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": "extcommlist_2",
"seq": 20,
"type": "extended",
"action": "deny",
"ext-value": "^65000:.*_"
},
"device_states": [{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
}
]
}

createCommunityList

Authorizations:

bearerAuth

Request Body schema: application/json

Create a community list

name required	string Name of the community list
type required	string Enum: "standard" "extended" Type of the community list
required	Array of objects (CommunityListRule) non-empty unique Rule information of community list - sequence number, action, std-value (or) ext-value

Responses

Request samples

Payload

Content type

application/json

{"name": "commlist_1",
"type": "standard",
"rules": {"rules": [{"seq": 10,
"action": "permit",
"std-value": "6550:125 local-as internet no-advertise"
},
{"seq": 20,
"action": "deny",
"std-value": "65536 internet no-export no-advertise"
},
{"seq": 30,
"action": "permit",
"ext-value": "^65000:.*_"
}
]
}
}

Response samples

Content type

application/json

{"communitylist_result": {"key-info": {"name": "commlist_1",
"seq": 10,
"type": "standard",
"action": "permit",
"std-value": "1:234 local-as no-advertise no-export"
},
"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": "Rollback failed",
"reason": null,
"rollback_reason": "Connection to device failed"
}
}

updateCommunityList

Authorizations:

bearerAuth

Request Body schema: application/json

Update an existing community list

name	string Name of the community list
type	string Enum: "standard" "extended" Type of the community list
	Array of objects (CommunityListRule) non-empty unique Rule information for community list - contains sequence number, action, std-value (or) ext-value
operation	string Enum: "add-device" "remove-device" "update-rule" Update operation to be performed on community list
device-ips	Array of strings IP addresses of the devices

Responses

Request samples

Payload

Content type

application/json

{"name": "commlist_1",
"type": "extended",
"rules": {"rules": [{"seq": 10,
"action": "permit",
"std-value": "6550:124 local-as internet no-advertise"
},
{"seq": 20,
"action": "deny",
"std-value": "65525 internet no-export no-advertise"
},
{"seq": 30,
"action": "permit",
"ext-value": "^65000:.*_"
}
]
},
"operation": "add-device",
"device-ips": "10.20.246.1"
}

Response samples

Content type

application/json

{"communitylist_result": {"key-info": {"name": "commlist_1",
"seq": 10,
"type": "standard",
"action": "permit",
"std-value": "1:234 local-as no-advertise no-export"
},
"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": "Rollback failed",
"reason": null,
"rollback_reason": "Connection to device failed"
}
}

deleteCommunityList

Delete an existing community list by name, type and sequence numbers

Authorizations:

bearerAuth

query Parameters

name required	string Name of the community list to be deleted
type required	string Type of community list. Valid types are standard and extended
seq required	Array of strings non-empty unique sequence numbers of the community list to be deleted
oob	boolean Default: false Option to allow deletion of oob entries

Responses

Response samples

Content type

application/json

{"communitylist_result": {"key-info": {"name": "commlist_1",
"seq": 10,
"type": "standard",
"action": "permit",
"std-value": "1:234 local-as no-advertise no-export"
},
"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": "Rollback failed",
"reason": null,
"rollback_reason": "Connection to device failed"
}
}

ExtCommunityList

getExtCommunityList

Get extended community-list details for given name, type and device IP address list

Authorizations:

bearerAuth

query Parameters

name	string Name of extended community list.
type	string Type of extended community list. Valid types are standard and extended
device_ips	Array of strings >= 0 items unique IP addresses of the devices

Responses

Response samples

Content type

application/json

{"items": [{"key-info": {"name": "extcommlist_1",
"seq": 10,
"type": "standard",
"action": "permit",
"rt": "2:300 1:112 34:132 12.12.13.33:24",
"soo": "12.12.12.0:24 12:123"
},
"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": "extcommlist_2",
"seq": 20,
"type": "extended",
"action": "deny",
"ext-value": "^65535:.*_"
},
"device_states": [{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
}
]
}

createExtCommunityList

Authorizations:

bearerAuth

Request Body schema: application/json

Create an extended community list

name required	string Name of the extended community list
type required	string Enum: "standard" "extended" Type of the community list
required	Array of objects (ExtCommunityListRule) non-empty unique Rule information of extended community list - sequence number, action and list of rt and soo values in ASN:nn (or) IpAddress:nn format or community-list expression

Responses

Request samples

Payload

Content type

application/json

{"name": "extcommlist_1",
"type": "standard",
"rules": {"rules": [{"seq": 10,
"action": "permit",
"rt": "2:300 12.12.13.33:24",
"soo": "12.12.12.0:24 32:124"
},
{"seq": 20,
"action": "deny",
"rt": "2:300",
"soo": "12.12.12.0:24"
},
{"seq": 30,
"action": "permit",
"ext-value": "^65000:.*_"
}
]
}
}

Response samples

Content type

application/json

{"communitylist_result": {"key-info": {"name": "extcommlist_1",
"seq": 10,
"type": "standard",
"action": "permit",
"rt": "2:300",
"soo": "12.12.12.0:24"
},
"device_states": [{"device_ip": "10.20.246.20",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.29",
"app_state": "cfg-refreshed"
}
]
},
"device_result": {"ip_address": "10.25.25.10",
"result": "Failed",
"reason": "Connection to device failed",
"rollback_reason": null
}
}

updateExtCommunityList

Authorizations:

bearerAuth

Request Body schema: application/json

Update an extended community list

name	string Name of the extended community list
type	string Enum: "standard" "extended" Type of the extended community list
	Array of objects (ExtCommunityListRule) non-empty unique Rule information of extended community list - sequence number, action and list of rt and soo values in ASN:nn (or) IpAddress:nn format or community-list expression
operation	string Enum: "add-device" "remove-device" "update-rule" Update operation to be performed on extended community list
device-ips	Array of strings IP addresses of the devices

Responses

Request samples

Payload

Content type

application/json

{"name": "extcommlist_1",
"type": "standard",
"rules": {"rules": [{"seq": 10,
"action": "permit",
"rt": "2:300",
"soo": "12.12.12.0:24"
},
{"seq": 20,
"action": "deny",
"rt": "2:300",
"soo": "12.12.12.0:24"
},
{"seq": 30,
"action": "permit",
"ext-value": "^65000:.*_"
}
]
},
"operation": "add-device",
"device-ips": "10.20.246.1"
}

Response samples

Content type

application/json

{"communitylist_result": {"key-info": {"name": "extcommlist_1",
"seq": 10,
"type": "standard",
"action": "permit",
"rt": "2:300",
"soo": "12.12.12.0:24"
},
"device_states": [{"device_ip": "10.20.246.20",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.29",
"app_state": "cfg-refreshed"
}
]
},
"device_result": {"ip_address": "10.25.25.10",
"result": "Failed",
"reason": "Connection to device failed",
"rollback_reason": null
}
}

deleteExtCommunityList

Delete an existing community list by name and sequence numbers

Authorizations:

bearerAuth

query Parameters

name required	string Name of the extended community list to be deleted
type required	string Type of extended community list. Valid types are standard and extended
seq required	Array of strings non-empty unique Sequence numbers of the extended community list to be deleted
oob	boolean Default: false Option to allow deletion of oob entries

Responses

Response samples

Content type

application/json

{"communitylist_result": {"key-info": {"name": "extcommlist_1",
"seq": 10,
"type": "standard",
"action": "permit",
"rt": "2:300",
"soo": "12.12.12.0:24"
},
"device_states": [{"device_ip": "10.20.246.20",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.29",
"app_state": "cfg-refreshed"
}
]
},
"device_result": {"ip_address": "10.25.25.10",
"result": "Failed",
"reason": "Connection to device failed",
"rollback_reason": null
}
}

LargeCommunityList

getLargeCommunityList

Get large community-list details for given name, type and device IP address list

Authorizations:

bearerAuth

query Parameters

name	string Name of large community list.
type	string Type of large community list. Valid types are standard and extended
device_ips	Array of strings >= 0 items unique IP addresses of the devices

Responses

Response samples

Content type

application/json

{"items": [{"key-info": {"name": "lgcommlist_1",
"seq": 10,
"type": "standard",
"action": "permit",
"std-value": "10:10:10 20:20:20"
},
"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": "lgcommlist_2",
"seq": 20,
"type": "extended",
"action": "deny",
"ext-value": "^65000:.*_"
},
"device_states": [{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
}
]
}

createLargeCommunityList

Authorizations:

bearerAuth

Request Body schema: application/json

Create a large community list

name required	string Name of the large community list
type required	string Enum: "standard" "extended" Type of the large community list
required	Array of objects (LargeCommunityListRule) non-empty unique Rule information of large community list - sequence number, action, std-value (or) ext-value

Responses

Request samples

Payload

Content type

application/json

{"name": "lgcommlist_1",
"type": "standard",
"rules": {"rules": [{"seq": 10,
"action": "permit",
"std-value": "10:10:10 20:20:20"
},
{"seq": 20,
"action": "deny",
"std-value": "30:30:30"
}
]
}
}

Response samples

Content type

application/json

{"communitylist_result": {"key-info": {"name": "lgcommlist_1",
"seq": 10,
"type": "standard",
"action": "permit",
"std-value": "10:10:10 20:20:20"
},
"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": "Rollback failed",
"reason": null,
"rollback_reason": "Connection to device failed"
}
}

updateLargeCommunityList

Authorizations:

bearerAuth

Request Body schema: application/json

Update an existing large community list

name	string Name of the large community list
type	string Enum: "standard" "extended" Type of the large community list
operation	string Enum: "add-device" "remove-device" Update operation to be performed on large community list
device-ips	Array of strings IP addresses of the devices

Responses

Request samples

Payload

Content type

application/json

{"name": "lgcommlist_1",
"type": "extended",
"operation": "add-device",
"device-ips": "10.20.246.1"
}

Response samples

Content type

application/json

{"communitylist_result": {"key-info": {"name": "lgcommlist_1",
"seq": 10,
"type": "standard",
"action": "permit",
"std-value": "10:10:10 20:20:20"
},
"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": "Rollback failed",
"reason": null,
"rollback_reason": "Connection to device failed"
}
}

deleteLargeCommunityList

Delete an existing large community list by name, type and sequence numbers

Authorizations:

bearerAuth

query Parameters

name required	string Name of the large community list to be deleted
type required	string Type of large community list. Valid types are standard and extended
seq required	Array of strings non-empty unique sequence numbers of the large community list to be deleted
oob	boolean Default: false Option to allow deletion of oob entries

Responses

Response samples

Content type

application/json

{"communitylist_result": {"key-info": {"name": "lgcommlist_1",
"seq": 10,
"type": "standard",
"action": "permit",
"std-value": "10:10:10 20:20:20"
},
"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": "Rollback failed",
"reason": null,
"rollback_reason": "Connection to device failed"
}
}

Policy

getPolicy

Get Policy details for given name, type, subtype and device IP address list

Authorizations:

bearerAuth

query Parameters

name	string Name of Policy list.
type required	string Type of Policy. Valid types are route-map prefix-list extcommunity-list community-list large-community-list as-path
subtype	string SubType of Policy. Valid types are standard extended ip or ipv6
device_ips	Array of strings >= 0 items unique IP addresses of the devices

Responses

Response samples

Content type

application/json

{"items": [{"key-info": {"name": "lgcommlist_1",
"type": "large-community-list",
"subtype": "standard",
"seq": 10,
"action": "permit",
"matches": {"match-type": "matchLargeCommunityStdValue",
"match-value": "{\"Value\":\"10:10:10\"}"
},
"sets": null
},
"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": "lgcommlist_2",
"type": "large-community-list",
"subtype": "standard",
"seq": 20,
"action": "deny",
"matches": {"match-type": "matchLargeCommunityExtValue",
"match-value": "{\"Value\":\"^123\"}"
},
"sets": null
},
"device_states": [{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
}
]
}

createPolicy

Authorizations:

bearerAuth

Request Body schema: application/json

Create a policy list

name required	string Name of the Policy
type required	string Enum: "route-map" "prefix-list" "community-list" "extcommunity-list" "large-community-list" "as-path" Type of the Policy
subtype required	string Enum: "standard" "extended" "ip" "ipv6" null subType of the Policy
remove	boolean Default: false Only used for route-map object to remove an existing match or set directive
required	Array of objects (PolicyRule) non-empty unique Rule information of policy - sequence number, action, and array of matches and sets

Responses

Request samples

Payload

Content type

application/json

{"name": "lgcommlist_1",
"type": "route-map",
"subtype": "standard",
"remove": false,
"rules": {"rules": [{"seq": 10,
"action": "permit",
"matches": {"match-type": "matchLargeCommunityStdValue",
"match-value": "{\"Value\":\"10:10:10\"}"
},
"sets": null
},
{"seq": 20,
"action": "deny",
"matches": {"match-type": "matchLargeCommunityStdValue",
"match-value": "{\"Value\":\"20:20:20\"}"
},
"sets": null
}
]
}
}

Response samples

Content type

application/json

{"policy_result": {"key-info": {"name": "lgcommlist_2",
"type": "large-community-list",
"subtype": "standard",
"seq": 20,
"action": "deny",
"matches": {"match-type": "matchLargeCommunityExtValue",
"match-value": "{\"Value\":\"^123\"}"
},
"sets": null
},
"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": "Rollback failed",
"reason": null,
"rollback_reason": "Connection to device failed"
}
}

updatePolicy

Authorizations:

bearerAuth

Request Body schema: application/json

Update an existing Policy

name	string Name of the Policy
type	string Enum: "route-map" "prefix-list" "community-list" "extcommunity-list" "large-community-list" "as-path" Type of the Policy
subtype	string Enum: "standard" "extended" "ip" "ipv6" null subType of the Policy
operation	string Enum: "add-device" "remove-device" Update operation to be performed on Policy
	Array of objects (PolicyRule) non-empty unique Rule information of policy - sequence number, action, and array of matches and sets
device-ips	Array of strings IP addresses of the devices

Responses

Request samples

Payload

Content type

application/json

{"name": "lgcommlist_1",
"type": "route-map",
"subtype": "standard",
"operation": "add-device",
"rules": {"rules": [{"seq": 10,
"action": "permit",
"matches": {"match-type": "matchLargeCommunityStdValue",
"match-value": "{\"Value\":\"10:10:10\"}"
},
"sets": null
},
{"seq": 20,
"action": "deny",
"matches": {"match-type": "matchLargeCommunityStdValue",
"match-value": "{\"Value\":\"20:20:20\"}"
},
"sets": null
}
]
},
"device-ips": "10.20.246.1"
}

Response samples

Content type

application/json

{"policy_result": {"key-info": {"name": "lgcommlist_2",
"type": "large-community-list",
"subtype": "standard",
"seq": 20,
"action": "deny",
"matches": {"match-type": "matchLargeCommunityExtValue",
"match-value": "{\"Value\":\"^123\"}"
},
"sets": null
},
"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": "Rollback failed",
"reason": null,
"rollback_reason": "Connection to device failed"
}
}

deletePolicy

Delete an existing Policy by name, type, subtype and sequence numbers

Authorizations:

bearerAuth

query Parameters

name required	string Name of the Policy to be deleted
type required	string Type of Policy. Valid types are route-map prefix-list extcommunity-list community-list large-community-list as-path
subtype required	string SubType of Policy. Valid types are standard extended ip ipv6 " "
seq required	Array of strings non-empty unique sequence numbers of the Policy to be deleted

Responses

Response samples

Content type

application/json

{"policy_result": {"key-info": {"name": "lgcommlist_2",
"type": "large-community-list",
"subtype": "standard",
"seq": 20,
"action": "deny",
"matches": {"match-type": "matchLargeCommunityExtValue",
"match-value": "{\"Value\":\"^123\"}"
},
"sets": null
},
"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": "Rollback failed",
"reason": null,
"rollback_reason": "Connection to device failed"
}
}

QosMap

getQosMap

Get QoS map details for given name, type and device IP address list

Authorizations:

bearerAuth

query Parameters

name	string Name of QoS map.
type	string Type of QoS map. Valid types are pcp-tc-map, dscp-tc-map, tc-pcp-map, tc-dscp-map
device_ips	Array of strings >= 0 items unique IP addresses of the devices

Responses

Response samples

Content type

application/json

{"items": [{"key-info": {"name": "pcp2tc_1",
"type": "pcp-tc-map",
"pcp": 3,
"tc": 1,
"dp": 0
},
"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": "pcp2tc_1",
"type": "pcp-tc-map",
"pcp": 4,
"tc": 2,
"dp": 1
},
"device_states": [{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
}
]
}

createQosMap

Authorizations:

bearerAuth

Request Body schema: application/json

Create a QoS map

name required	string Name of the QoS map
type required	string Enum: "pcp-tc-map" "dscp-tc-map" "tc-pcp-map" "tc-dscp-map" Type of the QoS map
required	Array of objects (QosMapRule) non-empty unique Rule information of QoS map - dscp, pcp, tc, dp

Responses

Request samples

Payload

Content type

application/json

{"name": "pcp2tc_1",
"type": "pcp-tc-map",
"rules": {"rules": [{"dscp": "6,10-15,30",
"tc": 2,
"dp": 1
},
{"pcp": "3-5",
"tc": 1,
"dp": 0
},
{"tc": "2-4",
"dp": 1,
"pcp": 2
}
]
}
}

Response samples

Content type

application/json

{"qosmap_result": {"key-info": {"name": "pcp2tc_1",
"type": "pcp-tc-map",
"pcp": 3,
"tc": 1,
"dp": 0
},
"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": "Rollback failed",
"reason": null,
"rollback_reason": "Connection to device failed"
}
}

updateQosMap

Authorizations:

bearerAuth

Request Body schema: application/json

Update an existing QoS map

name required	string Name of the QoS map
type required	string Enum: "pcp-tc-map" "dscp-tc-map" "tc-pcp-map" "tc-dscp-map" Type of the QoS map
required	Array of objects (QosMapRule) non-empty unique Rule information of QoS map - dscp, pcp, tc, dp

Responses

Request samples

Payload

Content type

application/json

{"name": "pcp2tc_1",
"type": "pcp-tc-map",
"rules": {"rules": [{"dscp": "6,10-15,30",
"tc": 2,
"dp": 1
},
{"pcp": "3-5",
"tc": 1,
"dp": 0
},
{"tc": "2-4",
"dp": 1,
"pcp": 2
}
]
}
}

Response samples

Content type

application/json

{"qosmap_result": {"key-info": {"name": "pcp2tc_1",
"type": "pcp-tc-map",
"pcp": 3,
"tc": 1,
"dp": 0
},
"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": "Rollback failed",
"reason": null,
"rollback_reason": "Connection to device failed"
}
}

deleteQosMap

Delete an existing QoS map by name, type and map from values

Authorizations:

bearerAuth

query Parameters

name required	string Name of the QoS map to be deleted
type required	string Type of QoS map. Valid types are pcp-tc-map, dscp-tc-map, tc-pcp-map or tc-dscp-map
dscp	Array of strings non-empty unique dscp values of the QoS map to be deleted if map type is dscp-tc-map
pcp	Array of strings non-empty unique pcp values of the QoS map to be deleted if map type is pcp-tc-map
tc	Array of strings non-empty unique tc values of the QoS map to be deleted if map type is tc-pcp-map or tc-dscp-map
dp	Array of strings non-empty unique dp value of the QoS map to be deleted if map type is tc-pcp-map or tc-dscp-map
oob	boolean Default: false Option to allow deletion of oob entries

Responses

Response samples

Content type

application/json

{"qosmap_result": {"key-info": {"name": "pcp2tc_1",
"type": "pcp-tc-map",
"pcp": 3,
"tc": 1,
"dp": 0
},
"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": "Rollback failed",
"reason": null,
"rollback_reason": "Connection to device failed"
}
}

QosServicePolicyMap

getQosServicePolicyMap

Get QoS service policy map details for given name and device IP address list

Authorizations:

bearerAuth

query Parameters

name	string Name of QoS service policy map.
device_ips	Array of strings >= 0 items unique IP addresses of the devices

Responses

Response samples

Content type

application/json

{"items": [{"key-info": {"name": "qosPolicyMap_1",
"strict-priority": 4,
"dwrr": "25,25,25,25",
"class-map": "default"
},
"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": "qosPolicyMap_2",
"strict-priority": 3,
"dwrr": "20,20,20,20,20",
"class-map": "classMap_2"
},
"device_states": [{"device_ip": "10.20.246.1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"app_state": "cfg-refreshed"
}
]
}
]
}

createQosServicePolicyMap

Authorizations:

bearerAuth

Request Body schema: application/json

Create a QoS service policy map

name required	string Name of the QoS service policy map
required	Array of objects (QosServicePolicyMapRule) non-empty unique Rule information of QoS service policy map - strict-priority, DWRR

Responses

Request samples

Payload

Content type

application/json

{"name": "qosPolicyMap_1",
"rules": {"rules": [{"strict-priority": 4,
"dwrr": "25,25,25,25",
"class-map": "default"
},
{"strict-priority": 6,
"dwrr": "50,50",
"class-map": "classMap_1"
},
{"strict-priority": 7,
"dwrr": 100,
"class-map": "classMap_2"
}
]
}
}

Response samples

Content type

application/json

{"qosservicepolicymap_result": {"key-info": {"name": "qosPolicyMap_2",
"strict-priority": 4,
"dwrr": "25,25,25,25",
"class-map": "default"
},
"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.20.245.5",
"result": "Rollback failed",
"reason": null
}
}

updateQosServicePolicyMap

Authorizations:

bearerAuth

Request Body schema: application/json

Update an existing QoS service policy map

name required	string Name of the QoS service policy map
required	Array of objects (QosServicePolicyMapRule) non-empty unique Rule information of QoS service policy map - strict-priority, DWRR

Responses

Request samples

Payload

Content type

application/json

{"name": "qosPolicyMap_1",
"rules": {"rules": [{"strict-priority": 4,
"dwrr": "25,25,25,25",
"class-map": "default"
},
{"strict-priority": 6,
"dwrr": "50,50",
"class-map": "classMap_1"
},
{"strict-priority": 7,
"dwrr": 100,
"class-map": "classMap_2"
}
]
}
}

Response samples

Content type

application/json

{"qosservicepolicymap_result": {"key-info": {"name": "qosPolicyMap_2",
"strict-priority": 4,
"dwrr": "25,25,25,25",
"class-map": "default"
},
"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.20.245.5",
"result": "Rollback failed",
"reason": null
}
}

deleteQosServicePolicyMap

Delete an existing QoS service policy map by name

Authorizations:

bearerAuth

query Parameters

name required	string Name of the QoS service policy map to be deleted
oob	boolean Default: false Option to allow deletion of oob entries

Responses

Response samples

Content type

application/json

{"qosservicepolicymap_result": {"key-info": {"name": "qosPolicyMap_2",
"strict-priority": 4,
"dwrr": "25,25,25,25",
"class-map": "default"
},
"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.20.245.5",
"result": "Rollback failed",
"reason": null
}
}

QosProfile

getQosProfile

Get QoS profile details for given device IP address list, interfaces

Authorizations:

bearerAuth

query Parameters

name	string Name of QoS profile.
device_ips	Array of strings >= 0 items unique IP addresses of the devices
interface_names	Array of strings >= 0 items unique Example: interface_names=Ethernet 0/3 Interface names on a device

Responses

Response samples

Content type

application/json

{"items": [{"key-info": {"name": "qosprofile_1",
"trust": "dscp",
"pcp_tc": "pcp2tc_1",
"dscp_tc": "dscp2tc_1",
"tc_pcp": "tc2pcp_1",
"tc_dscp": "tc2dscp_1",
"service_policy": {"name": "servicePolicy_1",
"dir": "out"
}
},
"device_states": [{"device_ip": "10.20.246.1",
"interface_name": "ethernet 0/2",
"bind_type": "tenant",
"bind_name": "tenant1",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"interface_name": "ethernet 0/2",
"app_state": "cfg-refreshed"
}
]
},
{"key-info": {"name": "qosprofile_2",
"trust": "auto",
"pcp_tc": "pcp2tc_2",
"dscp_tc": "dscp2tc_2",
"tc_pcp": "tc2pcp_2",
"tc_dscp": "tc2dscp_2",
"service_policy": {"name": "servicePolicy_2",
"dir": "out"
}
},
"device_states": [{"device_ip": "10.20.246.1",
"interface_name": "ethernet 0/12",
"bind_type": "fabric",
"bind_name": "fab2",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"interface_name": "ethernet 0/12",
"app_state": "cfg-refreshed"
}
]
}
]
}

createQosProfile

Authorizations:

bearerAuth

Request Body schema: application/json

Create a QoS profile

name required	string Name of the QoS profile
trust	string Enum: "auto" "dscp" Selecting auto will trust PCP for switched traffic and DSCP for routed traffic. Default is auto.
pcp_tc	string Name of the pcp-tc QoS map
dscp_tc	string Name of the dscp-tc QoS map
tc_pcp	string Name of the tc-pcp QoS map
tc_dscp	string Name of the tc-dscp QoS map
	object Name of the QoS service policy map along with direction of application of map

Responses

Request samples

Payload

Content type

application/json

{"name": "qosprofile_1",
"trust": "dscp",
"pcp_tc": "pcp2tc_1",
"dscp_tc": "dscp2tc_1",
"tc_pcp": "tc2pcp_1",
"tc_dscp": "tc2dscp_1",
"service_policy": {"name": "servicePolicy_1",
"dir": "out"
}
}

Response samples

Content type

application/json

{"qosprofile_result": {"key-info": {"name": "qosprofile_1",
"trust": "dscp",
"pcp_tc": "pcp2tc_1",
"dscp_tc": "dscp2tc_1",
"tc_pcp": "tc2pcp_1",
"tc_dscp": "tc2dscp_1",
"service_policy": {"name": "servicePolicy_1",
"dir": "out"
}
},
"device_states": [{"device_ip": "10.20.246.1",
"interface_name": "ethernet 0/2",
"bind_type": "fabric",
"bind_name": "fab2",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"interface_name": "ethernet 0/2",
"bind_type": "fabric",
"bind_name": "fab2",
"app_state": "cfg-refreshed"
}
]
},
"device_result": {"ip_address": "10.25.25.100",
"result": "Failed",
"reason": "Connection to device failed",
"rollback_reason": null
}
}

updateQosProfile

Authorizations:

bearerAuth

Request Body schema: application/json

Update an existing QoS profile

name	string Name of the QoS profile
trust	string Enum: "auto" "dscp" Selecting auto will trust PCP for switched traffic and DSCP for routed traffic. Default is auto.
pcp-tc	string Name of the pcp-tc QoS map
dscp-tc	string Name of the dscp-tc QoS map
tc-pcp	string Name of the tc-pcp QoS map
tc-dscp	string Name of the tc-dscp QoS map
	object Name of the QoS service policy map along with direction of application of map
operation	string Enum: "bind" "unbind" "update-rule" Update operation to be performed on QoS profile
bind_type	string Enum: "fabric" "tenant" object type which QoS profile binds to
bind_name	string object name which QoS profile binds which is a fabric or tenant
	object
port-channel	Array of strings List of Port channels

Responses

Request samples

Payload

Content type

application/json

{"name": "qosprofile_1",
"trust": "dscp",
"pcp-tc": "pcp2tc_1",
"dscp-tc": "dscp2tc_1",
"tc-pcp": "tc2pcp_1",
"tc-dscp": "tc2dscp_1",
"service_policy": {"name": "servicePolicy_1",
"dir": "out"
},
"operation": "add-device",
"bind_type": "fabric",
"bind_name": "fabric_1",
"port-list": {"port-type": "fabric-internal",
"physical-port": [{"device-ip": "10.25.25.100",
"port": "0/1,0/2,0/3:1"
}
]
},
"port-channel": "po1, po2, po3"
}

Response samples

Content type

application/json

{"qosprofile_result": {"key-info": {"name": "qosprofile_1",
"trust": "dscp",
"pcp_tc": "pcp2tc_1",
"dscp_tc": "dscp2tc_1",
"tc_pcp": "tc2pcp_1",
"tc_dscp": "tc2dscp_1",
"service_policy": {"name": "servicePolicy_1",
"dir": "out"
}
},
"device_states": [{"device_ip": "10.20.246.1",
"interface_name": "ethernet 0/2",
"bind_type": "fabric",
"bind_name": "fab2",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"interface_name": "ethernet 0/2",
"bind_type": "fabric",
"bind_name": "fab2",
"app_state": "cfg-refreshed"
}
]
},
"device_result": {"ip_address": "10.25.25.100",
"result": "Failed",
"reason": "Connection to device failed",
"rollback_reason": null
}
}

deleteQosProfile

Delete an existing QoS profile by name

Authorizations:

bearerAuth

query Parameters

name required	string Name of the QoS profile to be deleted
trust	string Enum: "auto" "dscp" Selecting auto will trust PCP for switched traffic and DSCP for routed traffic. Default is auto.
pcp-tc	string Name of the pcp-tc QoS map to be deleted
dscp-tc	string Name of the dscp-tc QoS map to be deleted
tc-pcp	string Name of the tc-pcp QoS map to be deleted
tc-dscp	string Name of the tc-dscp QoS map to be deleted
service-policy	string Name of the QoS service policy map to be deleted

Responses

Response samples

Content type

application/json

{"qosprofile_result": {"key-info": {"name": "qosprofile_1",
"trust": "dscp",
"pcp_tc": "pcp2tc_1",
"dscp_tc": "dscp2tc_1",
"tc_pcp": "tc2pcp_1",
"tc_dscp": "tc2dscp_1",
"service_policy": {"name": "servicePolicy_1",
"dir": "out"
}
},
"device_states": [{"device_ip": "10.20.246.1",
"interface_name": "ethernet 0/2",
"bind_type": "fabric",
"bind_name": "fab2",
"app_state": "cfg-in-sync"
},
{"device_ip": "10.20.246.2",
"interface_name": "ethernet 0/2",
"bind_type": "fabric",
"bind_name": "fab2",
"app_state": "cfg-refreshed"
}
]
},
"device_result": {"ip_address": "10.25.25.100",
"result": "Failed",
"reason": "Connection to device failed",
"rollback_reason": null
}
}