SSLO Overview Summary¶

Overview¶

This BIG-IQ API can get an overview and summary of the SSL Orchestrator (SSLO) environment.

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

Requests¶

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

Query Parameters¶

The following parameters can be used as OData query options with this API.

Name	Type	Required	Description
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.
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.

Request Parameters¶

None

Response¶

HTTP/1.1 200 OK

The JSON in the response can include the following parameters.

Name	Type	Description
clientCipherNames	object	List of client cipher names with their respective greatest rate of SSLO transactions per second
<client cipher name>	number	Greatest rate of SSLO transactions per second during the time interval
countriesSummary	object	List of countries with their respective greatest rate of SSLO transactions per second
<country>	number	Greatest SSLO transactions per second
decryptionStatus	object	Decrypted traffic, from all topologies, by status
Decrypted	number	Number of objects with a status of “Decrypted”
Other	number	Number of objects with a status of “Other”
PlainText	number	Number of objects with a status of “PlainText”
Unencrypted	number	Number of objects with a status of “Unencrypted”
devicesHealth	object	Number of devices by health status. Device health can be controlled by dynamic device health rules.
critical	number	Number of devices with a health of “Critical”
moderate	number	Number of devices with a health of “Moderate”
good	number	Number of devices with a health of “Good”
other	number	Number of devices with a health of “Other”
devicesTopMemUsages	object	List of devices with their respective memory usage
<device name>	number	Greatest memory usage
devicesTopCPUUsage	object	List of devices with their respective greatest CPU usage
<device name>	number	Greatest CPU usage
ipReputations	object	List of ipReputations with their respective greatest rate of SSLO transactions per second
<ipReputations>	number	Greatest rate of SSLO transactions per second
serverCipherNames	object	List of server cipher names with their respective greatest rate of SSLO transactions per second
<server cipher name>	number	Greatest rate of SSLO transactions per second
servicesHealth	object	Number of services by health status. Service health can be controlled by dynamic service health rules.
critical	number	Number of services with a health of “Critical”
moderate	number	Number of services with a health of “Moderate”
good	number	Number of services with a health of “Good”
other	number	Number of services with a health of “Other”
servingApplications	object	List of servingApplications with their respective greatest rate of SSLO transactions per second
<servingApplications>	number	Greatest rate of SSLO transactions per second
topologiesHealth	object	Number of topologies by health status. Topology health can be controlled by dynamic topology health rules.
critical	number	Number of topologies with a health status of “Critical”
good	number	Number of topologies with a health status of “Good”
moderate	number	Number of topologies with a health status of “Moderate”
other	number	Number of topologies with a health status of “Other”
totalDevices	number	Number of BIG-IPs provisioned with SSLO
totalServices	number	Number of all SSLO services
totalTopologies	number	Number of all SSLO topologies
urlCategories	object	List of url categories with their respective rate of SSLO transactions per second
<url category>	number	Greatest rate of SSLO transactions per second

Permissions¶

Role	Allow
SSL Orchestrator Manager	Yes

Examples¶

GET to retrieve a summary of all SSLO devices¶

GET /mgmt/ap/query/v1/tenants/default/reports/SsloOverviewSummary

Response¶

{
    "kind": "ap:compose:Report",
    "lastUpdateMicros": 185753881097,
    "result": {
            "totalTopologies": 3,
            "topologiesHealth": {
                    "Critical": 0,
                    "Moderate": 0,
                    "Good": 2,
                    "Other": 1
            },
            "decryptionStatus": {
                    "Decrypted": 0.9833333333333333,
                    "Unencrypted": 0,
                    "PlainText": 0,
                    "Other": 0
            },
            "countriesSummary": {
                    "US": 0.9833333333333333
            },
            "urlCategories": {
                    "Uncategorized": 0.9833333333333333
            },
            "clientCipherNames": {
                    "ECDHE-RSA-AES128-GCM-SHA256": 0.9833333333333333
            },
            "serverCipherNames": {
                    "ECDHE-RSA-AES128-GCM-SHA256": 0.9833333333333333
            },
            "ipReputations": {
                    "None": 0.9833333333333333
            },
            "servingApplications": {
                    "Aggregated": 0.9833333333333333
            },
            "totalDevices": 1,
            "devicesHealth": {
                    "Critical": 0,
                    "Moderate": 0,
                    "Good": 1,
                    "Other": 0
            },
            "devicesTopCPUUsage": {
                    "Automation-07-sslo-Tier1-1.example.com": 13.754166197776794
            },
            "totalServices": 4,
            "servicesHealth": {
                    "Critical": 3,
                    "Moderate": 0,
                    "Good": 1,
                    "Other": 0
            },
            "devicesTopMemUsages": {
                    "Automation-07-sslo-Tier1-1.example.com": 18
            }
    },
    "requestDurationInMillis": 434
}

Previous Next