SSLO Services List¶

Overview¶

This BIG-IQ API can get a list of SSL Orchestrator (SSLO) services.

REST Endpoint: /mgmt/ap/query/v1/tenants/default/reports/SsloServicesList¶

Requests¶

GET /mgmt/ap/query/v1/tenants/default/reports/SsloServicesList¶

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 page
items	object	Items that returned by results
concurrentConnections	number	Average number of concurrent connections
downAction	string	Action taken when service is down
health	object	The service’s health status. Possible values: “Critical”, “Moderate”, “Good” or “Other”.
isFullyDeployed	boolean	True if all services are deployed
kind	string	Service’s kind
location	string	Logical location tag of the device on which the service is deployed
name	string	Service’s readable name
numDevices	number	Number of devices on which the service is deployed
numPoolMembersDown	number	Number of pool members associated with this service which are offline
numPoolMembersTotal	number	Number of pool members associated with this service
selfLink	string	Service’s url
serviceId	string	Service’s unique identifier
strictness	boolean	True if there strictness of the service
throughputIn	number	Average throughput in to the service
throughputOut	number	Average throughput out to the service
type	string	Service’s type
itemsPerPage	number	Number of items per page
pageIndex	number	Page index number for result. Page index numbers are chronological.
startIndex	number	Item index number for which results start. Item index numbers are chronological.
totalItems	number	Total number of result items
totalPages	number	Number of pages in the query result.

Permissions¶

Role	Allow
SSL Orchestrator Manager	Yes

Examples¶

GET to retrieve a list of the existing services¶

The following example returns the top 50 services ordered by the health state in descending order.

GET /mgmt/ap/query/v1/tenants/default/reports/SsloServicesList?%24orderby=health%20desc&%24skip=0&%24top=50

Response¶

{
    "kind": "ap:compose:Report",
    "lastUpdateMicros": 1046482627669,
    "result": {
            "totalItems": 1,
            "items": [{
                    "name": "ssloS_clustericap",
                    "selfLink": "https://localhost/mgmt/cm/sslo/staging-config/blocks/service/99f9618e-6647-46f9-a261-a22f522ff7d6",
                    "kind": "cm:sslo:staging-config:blocks:service:servicestate",
                    "serviceId": "99f9618e-6647-46f9-a261-a22f522ff7d6",
                    "type": "icap",
                    "strictness": true,
                    "isFullyDeployed": false,
                    "downAction": "ignore",
                    "numDevices": 1,
                    "location": "Tel Aviv",
                    "health": "Critical",
                    "concurrentConnections": 0,
                    "throughputIn": 0,
                    "throughputOut": 0,
                    "numPoolMembersTotal": 2,
                    "numPoolMembersDown": 2
            }],
            "itemsPerPage": 50,
            "startIndex": 0,
            "totalPages": 1,
            "pageIndex": 0,
            "currentItemCount": 1
    },
    "requestDurationInMillis": 51

}

Previous Next