Clients GuardPoint Status Report
The Clients GuardPoint Status Report shows the status of GuardPoints applied to the CTE clients available on the CipherTrust Manager.
Generating the Report
Use the get /v1/transparent-encryption/reports/clients-guard-status 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-guard-status/?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 status of GuardPoints applied to all clients. |
| policy_name | string | (optional) Name of the policy applied to the client. If not specified, the report will contain all policies applied to the specified clients. |
| guard_point_state | string | (optional) State of GuardPoints applied to the client. The options are: • ACTIVE• INACTIVE• UNKNOWN• DISABLEDIf not specified, the report will contain all GuardPoints. |
| guard_enabled | string | (optional) Whether the GuardPoint is enabled - true or false. If not specified, the report will contain records of all GuardPoints whether they are enabled or not. |
| guard_path | string | (Optional) Path where the GuardPoint is applied. If not specified, the report will contain records of all GuardPaths. |
| 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-guard-status/?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",
"guard_path": "/usr/bin",
"guard_enabled": true,
"policy_name": "hr_policy",
"guard_point_state": "ACTIVE",
"rekey_status": "",
"est_rekey_time": "",
"rekey_start_time": "",
"rekey_end_time": "",
"total_file": 0,
"file_rekeyed": 0,
"file_deleted": 0,
"file_skipped": 0,
"total_size": 0,
"byte_rekeyed": 0
}
]
}
The output shows the mapping of clients with the GuardPoints applied to them, and the states of the GuardPoints and whether they are enabled or not. 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-guard-status/download API to download the report as a PDF or CSV document.
Syntax
curl -k '<IP>/api/v1/transparent-encryption/reports/clients-guard-status/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. Additionally, you can display three more fields in the downloaded report. These query parameters applicable to the LDT GuardPoints. Specify the desired fields in the addon_fields parameter. Specify the maximum of three fields from:
| Parameter | Type | Description |
|---|---|---|
| rekey_status | string | Rekey status of the GuardPoint. |
| est_rekey_time | string | Estimated rekeyed time. |
| rekey_start_time | string | Rekey start time. |
| rekey_end_time | string | Rekey end time. |
| total_file | integer | Number of files to be rekeyed. |
| file_rekeyed | integer | Number of rekeyed files. |
| file_deleted | integer | Number of deleted files. |
| file_skipped | integer | Number of skipped files. |
| total_size | integer | Total size of rekeyed files. |
| byte_rekeyed | integer | Number of rekeyed bytes. |
Example Request
curl -k 'https://127.0.0.1/api/v1/transparent-encryption/reports/clients-guard-status/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 comma-separated response is displayed. For example:
"Client Name,Guard Path,Policy Name,Guard State
client_001,/usr/bin/,hr_policy,ACTIVE"
The CSV file is downloaded with the name cte_clients_gp_status_<timestamp>.csv, for example, cte_clients_gp_status_2020-11-30T13_29_25Z.csv.
If you specified report_type as pdf, the report is downloaded in a PDF document named, cte_clients_gp_status_<TIMESTAMP>.pdf, for example, cte_clients_gp_status2021-01-12T07_18_55Z.pdf.
The downloaded PDF document shows the Report Name as Clients GuardPoint Status 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. |
| Guard Path | Path where the GuardPoint is applied. |
| Policy Name | Name of the applied policy. |
| Guard State | State of the GuardPoint. |
