SSLO Topologies List¶
Overview¶
This BIG-IQ API can get a list of SSL Orchestrator (SSLO) topologies.
REST Endpoint: /mgmt/ap/query/v1/tenants/default/reports/SsloTopologiesList¶
Requests¶
GET /mgmt/ap/query/v1/tenants/default/reports/SsloTopologiesList¶
Query Parameters¶
The following parameters can be used as OData query options with this API.
Name | Type | Required | Description |
---|---|---|---|
$filter | string | False | Specifies a string or integer used to filter the results. You can filter based on one or more parameters. |
$from | string | False | Specifies time to start results. The default uses the values of “-5m” for from and “now” for to, which starts from 5 minutes before the current time and ends at the current time. |
$orderby | string | False | Specifies the sorting parameter and order to apply to results. You can sort by health, name, type, sslConfiguration, securityPolicy, numDevices, numServices or encryptionCount. The sort order can be ascending (asc) or descending (desc). The default value is “name asc”, which sorts by name in ascending order. |
$skip | number | False | Specifies the number of results in the ordered list to skip. The default value of skip is 0, meaning none are skipped and the results range from 1 to the top value. |
$to | string | False | Specifies time to end results. The default uses the values of “-5m” for from and “now” for to, which starts from 5 minutes before the current time and ends at the current time. |
$top | number | False | Specifies the maximum number of results in the ordered list. The default value is 10. |
Request Parameters¶
None
Response¶
HTTP/1.1 200 OK
The JSON in the response can include the following parameters.
Name | Type | Description |
---|---|---|
currentItemCount | number | Number of items returned for this specific page. |
items | object | Items in the results |
encryptionCount | number | Average decrypted traffic over the time interval |
health | string | The topology’s health status. Possible values are: “Critical”, “Moderate”, “Good” or “Other” |
isFullyDeployed | boolean | True if all services are deployed |
kind | string | The application’s kind |
name | string | The topology’s readable name |
numDevices | number | Number of devices on which the topology is deployed |
numServices | number | Number of services associated with the topology |
securityPolicy | string | Name of the security policy attached to the topology |
selfLink | string | The topology’s url |
sslConfiguration | string | Name of the SSL configuration attached to the topology |
strictness | boolean | True if there is strictness of the service |
topologyId | string | The topology’s unique identifier |
type | string | The topology’s type |
itemsPerPage | number | Number of items per page |
pageIndex | number | Page index number for which results start. Page index numbers are chronological. |
startIndex | number | Item index number for which results start. Item index numbers are chronological. |
totalItems | number | Total number of items in results |
totalPages | number | Total number of pages in the result. |
Permissions¶
Role | Allow |
---|---|
SSL Orchestrator Manager | Yes |
Examples¶
GET to retrieve a list of the existing topologies¶
The following example show a result for the the top 50 topologies ordered by ascending health state.
GET /mgmt/ap/query/v1/tenants/default/reports/SsloTopologiesList?%24orderby=health%20desc&%24skip=0&%24top=50
Response¶
{
"kind": "ap:compose:Report",
"lastUpdateMicros": 1044107918442,
"result": {
"totalItems": 2,
"items": [{
"name": "sslo_topology1",
"topologyId": "9eb082b9-89f3-43af-9846-0b32f7d99e6d",
"selfLink": "https://localhost/mgmt/cm/sslo/staging-config/blocks/orchestrator/9eb082b9-89f3-43af-9846-0b32f7d99e6d",
"kind": "cm:sslo:staging-config:blocks:orchestrator:orchestratorstate",
"type": "topology_l3_outbound",
"securityPolicy": "ssloP_topology1",
"sslConfiguration": "ssloT_topology1",
"numDevices": 2,
"strictness": true,
"isFullyDeployed": false,
"numServices": 1,
"health": "Other"
},
{
"name": "sslo_topology2",
"topologyId": "d55ec4c9-ab55-4c58-bb41-15caec89f1c3",
"selfLink": "https://localhost/mgmt/cm/sslo/staging-config/blocks/topology/d55ec4c9-ab55-4c58-bb41-15caec89f1c3",
"kind": "cm:sslo:staging-config:blocks:topology:topologystate",
"type": "topology_l3_outbound",
"securityPolicy": "ssloP_topology2",
"sslConfiguration": "ssloT_topology2",
"numDevices": 2,
"strictness": true,
"isFullyDeployed": false,
"numServices": 1,
"health": "Critical"
}
],
"itemsPerPage": 50,
"startIndex": 0,
"totalPages": 1,
"pageIndex": 0,
"currentItemCount": 2
},
"requestDurationInMillis": 60
}