Clients Health Report
The Clients Health Report shows the health status of the CTE clients available on the CipherTrust Manager. You can download the report as a PDF or CSV document, as required. Refer to Downloading the Report.
Use the "Search by" box to search for records in the report by Client Name or Domain. When searching for records by domain names, specify the complete and exact domain name including case-sensitivity. For example, searching for "test", "test-domain", and "Test-Domain" will return different search results.
Viewing the Report
To view the Clients Health Report:
Open the Transparent Encryption application.
In the left pane, click Reports. The Reports page is displayed.
Click the Clients tab.
The report shows all or some of the following columns:
| Column | Description |
|---|---|
| Domain | Name of the CipherTrust Manager domain to which the record belongs. If the Domain Sharing Data toggle is turned ON, the report displays all the domains where the resource is shared. |
| Client Name | Name of the client on the CipherTrust Manager. |
| Status | Status of the client. The status can be: • Unregistered • Error • Warning • Healthy • Expunged Refer to Client States for details. |
| Client Type | Type of the client: • FS: CTE client • CSI: CTE for Kubernetes client • CTE-U: CTE UserSpace client |
| OS Type | Operating system running on the client - AIX, LINUX, WINDOWS, UNKNOWN, FREEBSD.UNKNOWN is displayed for unregistered or manually added clients. FREEBSD is supported by CTE UserSpace. |
| Details | Versions of the platform and kernel installed on the client, for example, RHEL7.8 - 3.10.0-1127.el7.x86_64. For Windows clients and unregistered or manually added clients, the field is empty. The Details column shows hyphen-separated ( -) combination of these fields:• Details-OS Sub Type: Variant of the operating system running on the client, for example, RHEL7.8. • Details-OS Kernel: Version of the kernel running on the client, for example, 3.10.0-1127.el7.x86_64. To view/hide their values, click the custom view icon (  ), select/clear the desired column, and click OK. |
| Client Version | Version of the CTE Agent installed on the client, for example, 7.2.0.xxxx. For unregistered or manually added clients, the field is empty. |
| Client Description | Description of the client. |
| Total GuardPoints | Total number of GuardPoints applied on the client. |
| Enabled GuardPoints | Number of enabled/active GuardPoints on the client. |
Downloading the Report
Download the report as a PDF or CSV document. Based on the displayed columns and applied filters, the downloaded report shows all or some of the columns listed in Viewing the Report.
Reports provide an easy and quick method to answer queries such as:
How many clients are registered with the CipherTrust Manager?
What is the health status of clients?
How many keys are used for protecting data?
What keys and policies are linked?
How many GuardPoints are applied on a client?
What key is used to protect a specific GuardPoint?
What CTE resources belong to a specific CipherTrust Manager domain?
Use the Domain Sharing Data toggle button to include/exclude information about CTE resources shared across domains.
Dashboard
The dashboard on the Reports page shows the following information:
TOTAL CLIENTS: Shows the total count of registered and unregistered clients on the CipherTrust Manager.
CTE LICENSES USED: Shows the count of consumed CipherTrust Transparent Encryption licenses out of available licenses.
CTE-U LICENSES USED: Shows the count of consumed CipherTrust Transparent Encryption for UserSpace licenses out of available licenses.
K8S LICENSES USED: Shows the count of consumed CipherTrust Transparent Encryption for Kubernetes licenses out of available licenses.
TOTAL GUARDPOINTS: Shows the total count of GuardPoints configured on the registered and unregistered clients on the CipherTrust Manager.
ACTIVE GUARDPOINTS: Shows the count of active GuardPoints on the CipherTrust Manager.
INACTIVE GUARDPOINTS: Shows the count of inactive GuardPoints on the CipherTrust Manager.
Download Formats
View the latest CTE reports and download them as PDF and CSV documents on your local machines. The PDF and CSV formats present reports in easy-to-understand tabular forms.
Important Note on CSV Reports
If the names of CTE resources include special characters like equals (=), plus (+), minus (-), at (@), tab (0x09), and carriage return (0x0D), the resources are renamed in the downloaded CSV reports by applying the following rules:
Every cell is wrapped in double quotes
Every cell is prepended with a single quote
Every double quote is escaped using an additional double quote
For example, a resource named =A+B'" ;,=C+D is renamed as "'=A+B'"" ;,=C+D" in the downloaded CSV report.
To download the report:
Open the Transparent Encryption application.
In the left pane, click Reports. The Reports page is displayed.
Click the Clients tab.
Download the report:
Click Download CSV to download the report as a CSV file. The file is named
cte_client_health_<TIMESTAMP>.csv, for example, cte_client_health_2021-01-12T06_52_51Z.csv.Click Download PDF to download the report as a PDF file. The file is 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.
