Generating tenant protection reports
January 10, 2024
ID 199635
The report generation procedure is automated by means of the Integration Server REST API.
You can pass the following report generation parameters in the request to the REST API:
- Identifier of the tenant for which want to generate the protection report.
- Start date and time of the period for which you want to generate a report.
- End date and time of the period for which you want to generate a report.
If the tenant identifier is not specified in the request, the report will include data on all virtual machines that were protected during the specified period. Including the data on virtual machines that do not belong to the tenants.
If the report generation period is not specified in the request, the report will include data stored in the Integration Server database from the earliest date up to the current moment.
To obtain reliable information in the reports, it is recommended to follow these rules when specifying the reporting period:
- Specify the reporting period accurate to a day.
- Set the end of the reporting period not less than 60 minutes from the current moment.
As a result of the report generation procedure, the report identifier is returned. The report is generated in the protected service folder %ProgramData%\Kaspersky Lab\VIISLA\protectionPeriodsReports. By default the report is stored within 24 hours from the moment of generation. To get the report, use the report identifier in the request to the REST API to upload the report.
You can configure the report retention period using the TenantsProtectionReportsLifetimeHours parameter in the Integration Server configuration file: %ProgramFiles(x86)%\Kaspersky Lab\Kaspersky VIISLA\viislaservice.exe.config.
The data in the report is presented line by line. Each line contains information about one virtual machine protection period in the following format:
{tenant ID};{tenant name};{virtual machine ID};{virtual machine name};{date and time when protection was enabled};{date and time when protection was disabled}
where:
{tenant ID}– identifier of the tenant to which the virtual machine belongs. If the virtual machine does not belong to any tenant, nothing is displayed in this field.{tenant name}– tenant name specified when the tenant was created. If the virtual machine does not belong to any tenant, nothing is displayed in this field.{virtual machine ID}– identifier of the virtual machine that was protected by the application.{virtual machine name}– name of the virtual machine that was protected by the application.{date and time when protection was enabled}– start date and time of the virtual machine protection period.{date and time when protection was disabled}– end date and time of the virtual machine protection period.
If during the reporting period the virtual machine was protected by the application several times (protection was enabled and disabled), the report displays each virtual machine protection period.
