SSLO Per Device Summary¶
Overview¶
This BIG-IQ API can get a SSLO summary overview of a device provisioned with SSL Orchestrator (SSLO).
REST Endpoint: /mgmt/ap/query/v1/tenants/default/reports/SsloPerDeviceSummary¶
Requests¶
GET /mgmt/ap/query/v1/tenants/default/reports/SsloPerDeviceSummary¶
Query Parameters¶
The following parameters can be used as OData query options with this API.
| Name | Required | Description |
|---|---|---|
| $device | True | Specifies the name of the device |
Request Parameters¶
None
Response¶
HTTP/1.1 200 OK
The JSON in the response can include the following parameters.
| Name | Type | Description |
|---|---|---|
| activeAlerts | object | List of the device’s active alerts |
| id | string | Alert’s unique identifier |
| severity | string | Severity of the alert |
| timestamp | number | Time when the alert was updated |
| title | string | Short description of the alert |
| averageCpuUsage | object | Device’s average cpu usage |
| errorThreshold | number | Error threshold value for the average cpu usage. The “Critical” health threshold value can be specified using the dynamic device health rules. |
| value | number | Device’s average cpu usage |
| warningThreshold | number | Warning threshold value for the average cpu usage. The “Moderate” health threshold value can be specified using the dynamic device health rules. |
| averageMemoryUsage | object | Device’s average memory usage |
| errorThreshold | number | Error threshold value for the average memory usage. The “Critical” health threshold value can be specified using the dynamic device health rules. |
| value | number | Device’s average memory usage |
| warningThreshold | number | Warning threshold value for the average memory usage. The “Moderate” health threshold value can be specified using the dynamic device health rules. |
| decryptionStatus | object | Average decrypted traffic by status |
| Decrypted | number | Number of decrypted traffic objects with a status of “Decrypted” |
| Other | number | Number of decrypted traffic objects with a status of “Other” |
| PlainText | number | Number of decrypted traffic objects with a status of “PlainText” |
| Unencrypted | number | Number of decrypted traffic objects with a status of “Unencrypted” |
| health | string | The device’s health. Possible values are: “Good”, “Moderate”, “Critical”, or “Other”. |
| name | string | Device’s readable name |
| throughputStats | object | Current average number of throughput statistics |
| throughputIn | number | Average number of throughput statistics in |
| throughputOut | number | Average number of throughput statistics out |
| throughputStatsTs | object | List of the average number of throughput statistics over time. |
| <changing value fields> | object | Values calculated for the specific time sub-interval |
| count | number | Number of data samples collected in the time sub-interval |
| timeMillis | number | End time of time sub-interval |
| topClientCipher | object | List of client cipher names with their respective greatest number of SSLO transactions per second in the last five minutes |
| <client cipher name> | number | Greatest number of SSLO transactions per second in the last five minutes |
| topServerCipher | object | List of server cipher names with their respective greatest number of SSLO transactions per second in the last five minutes |
| <server cipher name> | number | Greatest SSLO transactions per second in the last five minutes |
Permissions¶
| Role | Allow |
|---|---|
| SSL Orchestrator Manager | Yes |
Examples¶
GET to retrieve a device summary¶
The following example can retrieve a SSL summary overview for the device named device-1.example.com.
GET mgmt/ap/query/v1/tenants/default/reports/SsloPerDeviceSummary?$device=device-1.example.com
Response¶
{
"kind": "ap:compose:Report",
"lastUpdateMicros": 186132468886,
"result": {
"name": "device-1.example.com",
"health": "Good",
"averageCpuUsage": {
"value": 14.07931235101488,
"errorThreshold": 80,
"warningThreshold": 65
},
"averageMemoryUsage": {
"value": 18,
"errorThreshold": 80,
"warningThreshold": 65
},
"decryptionStatus": {
"Decrypted": 0.9814814814814815,
"Unencrypted": 0,
"PlainText": 0,
"Other": 0
},
"topClientCipher": {
"ECDHE-RSA-AES128-GCM-SHA256": 0.9814814814814815
},
"topServerCipher": {
"ECDHE-RSA-AES128-GCM-SHA256": 0.9814814814814815
},
"throughputStats": {
"throughputIn": 4349.995238095238,
"throughputOut": 5405.861904761905
},
"throughputStatsTs": [{
"timeMillis": 1563273900000,
"count": 50,
"throughputIn": 4240.85,
"throughputOut": 4745.073333333334
},
{
"timeMillis": 1563274200000,
"count": 50,
"throughputIn": 4014.1266666666666,
"throughputOut": 3007.26
},
{
"timeMillis": 1563274500000,
"count": 50,
"throughputIn": 4156.386666666666,
"throughputOut": 3000.47
},
{
"timeMillis": 1563274800000,
"count": 50,
"throughputIn": 4014.2366666666667,
"throughputOut": 2967.7366666666667
},
{
"timeMillis": 1563275100000,
"count": 50,
"throughputIn": 4125.486666666667,
"throughputOut": 3048.4366666666665
},
{
"timeMillis": 1563275400000,
"count": 50,
"throughputIn": 4065.133333333333,
"throughputOut": 2919.2933333333335
},
{
"timeMillis": 1563275700000,
"count": 50,
"throughputIn": 4137.406666666667,
"throughputOut": 4537.9766666666665
},
{
"timeMillis": 1563276000000,
"count": 50,
"throughputIn": 4158.326666666667,
"throughputOut": 2959.68
},
{
"timeMillis": 1563276300000,
"count": 50,
"throughputIn": 4045.28,
"throughputOut": 2939.05
},
{
"timeMillis": 1563276600000,
"count": 50,
"throughputIn": 4025.766666666667,
"throughputOut": 2985.5
},
{
"timeMillis": 1563276900000,
"count": 50,
"throughputIn": 4115.88,
"throughputOut": 2906.53
},
{
"timeMillis": 1563277200000,
"count": 50,
"throughputIn": 4020.1133333333332,
"throughputOut": 2906.56
},
{
"timeMillis": 1563277410000,
"count": 35,
"throughputIn": 4349.995238095238,
"throughputOut": 5405.861904761905
}
],
"activeAlerts": []
},
"requestDurationInMillis": 279
}