Clients Health Report
The Clients Health Report shows the health status of the CTE clients available on the CipherTrust Manager.
Generating the Report
Use the get /v1/transparent-encryption/reports/clients/ API to generate the report. Columns in the report can be filtered using the request query parameters.
Syntax
curl -k '<IP>/api/v1/transparent-encryption/reports/clients/?sort=client_name&skip=0&limit=10' -H 'Authorization: Bearer AUTHTOKEN' --compressed
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authorization token. |
Request Query Parameters
| Parameter | Type | Description |
|---|---|---|
| client_name | string | (optional) Name of the client. If not specified, the report will contain records of all clients. |
| status | string | (optional) Status of the client. The options are: • UNREGISTERED• ERROR• WARNING• HEALTHY• EXPUNGED• WAITING FOR CONNECTION• NOT CONNECTEDIf not specified, the report will contain records of clients having any status. |
| os_type | string | (optional) Operating system running on the client - LINUX, WINDOWS, or UNKNOWN. If not specified, the report will contain records of clients running any OS. Specify UNKNOWN for the unregistered or manually added clients. |
| sort | string | Comma-delimited list of columns to sort the results. Multiple fields are sorted by multi-field sort. By default, the results are sorted in alphabetic ascending order. To change the sort order, precede the field by a - (minus) sign. |
| skip | integer | Number of records to skip. For example, if "skip":5 is specified, the first five records will not be displayed in the output. |
| limit | integer | Numbers of records to display. For example, if "limit":10 is specified, then the next 10 records (after skipping the number of records specified in the skip parameter) will be displayed in the output. |
Example Request
curl -k 'https://127.0.0.1/api/v1/transparent-encryption/reports/clients/?sort=client_name&skip=0&limit=10' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwNjZjMzJkZi1mZTMyLTRhZTctYThkYi1lMDZhZjYwMGQ4ZjAiLCJzdWIiOiJsb2NhbHxiNjA5ZjU3MC1hYjZmLTQzZDQtOWVjYi04ODVlNzRiZWYyODUiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiYmNlNTE1NzktMzk3NC00YWVjLTllZmItMTQ1MzA2NGNlYjA2Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImViOTM5YWVhLTBhNmQtNGM5My05MTFkLTg2YmNiMThlNjEyNSIsImlhdCI6MTYwNjI4MDAyMSwiZXhwIjoxNjA2MjgwMzIxfQ.AP0DFYeaYDFzKtIb_A_hFjtBH33aphPIwTElBDKDh34' --compressed
Example Response
{
"skip": 0,
"limit": 10,
"total": 1,
"resources": [
{
"client_name": "client_001",
"os_type": "LINUX",
"os_sub_type": "",
"os_kernel": "",
"client_version": "7.X.X.XXXX",
"status": "WARNING",
"total_gp": 2,
"enabled_gp": 2
}
]
}
The output shows details of the clients added to the CipherTrust Manager. You can download the report as a PDF or CSV document, as required. Refer to Downloading the Report.
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
Downloading the Report
Use the get /v1/transparent-encryption/reports/clients/download API to download the report as a PDF or CSV document.
Syntax
curl -k '<IP>/api/v1/transparent-encryption/reports/clients/download/?report_type=<report_type>' -H 'Authorization: Bearer AUTHTOKEN' --compressed
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authorization token. |
| report_type | string | (Mandatory) Format of the report to download. The options are pdf and csv. |
Request Query Parameters
Refer to Request Query Parameters. You can omit these fields from the downloaded report. Specify the fields to omit in the omit_fields parameter.
| Parameter | Type | Description |
|---|---|---|
| os_type | string | Operating system running on the client - LINUX, WINDOWS, or UNKNOWN. |
| os_sub_type | string | Variant of the OS running on the client, for example, RHEL. |
| os_kernel | string | Version of the kernel running on the client. |
| client_version | string | Version of the CTE Agent installed on the client, for example, 7.0.0.xxxx. |
| total_gp | integer | Total number of GuardPoints applied on the client. |
| enabled_gp | integer | Number of enabled/active GuardPoints on the client. |
Example Request
curl -k 'https://127.0.0.1/api/v1/transparent-encryption/reports/clients/download/?report_type=pdf&sort=client_name&skip=0&limit=10' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwNjZjMzJkZi1mZTMyLTRhZTctYThkYi1lMDZhZjYwMGQ4ZjAiLCJzdWIiOiJsb2NhbHxiNjA5ZjU3MC1hYjZmLTQzZDQtOWVjYi04ODVlNzRiZWYyODUiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiYmNlNTE1NzktMzk3NC00YWVjLTllZmItMTQ1MzA2NGNlYjA2Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImViOTM5YWVhLTBhNmQtNGM5My05MTFkLTg2YmNiMThlNjEyNSIsImlhdCI6MTYwNjI4MDAyMSwiZXhwIjoxNjA2MjgwMzIxfQ.AP0DFYeaYDFzKtIb_A_hFjtBH33aphPIwTElBDKDh34' --compressed
CSV
If you specified report_type as csv, the report is downloaded as a CSV document named, cte_client_health_<TIMESTAMP>.csv, for example, cte_client_health_2021-01-12T06_52_51Z.csv.
If you specified report_type as pdf, the report is downloaded as a PDF document named, cte_client_health_<TIMESTAMP>.pdf, for example, cte_client_health_2021-01-12T06_55_09Z.pdf.
The downloaded PDF document shows the Report Name as Clients Health Report and time the report is Generated At.
Viewing the Report
Based on the parameters specified during the API call, the downloaded report shows all or some of the following columns:
| Column | Description |
|---|---|
| Client Name | Name of the client on the CipherTrust Manager. |
| Status | Status of the client. |
| OS Type | Operating system running on the client - LINUX or WINDOWS. For unregistered or manually added clients, UNKNOWN is displayed. |
| OS SubType | Variant of the operating system running on the client, for example, RHEL. |
| OS Kernel | Version of the kernel running on the client. |
| Client Version | Version of the CTE Agent installed on the client, for example, 7.0.0.xxxx. |
| Total GP | Total number of GuardPoints applied on the client. |
| Enabled GP | Number of enabled/active GuardPoints on the client. |
