How to manage data from the protected virtual machines report and how to download it
Latest update: December 24, 2019
ID: 15307
A table is created on the Integration Server containing information about enabling and disabling protection for client virtual machines. By default, the records are not added to the table. The records are stored for 3 months.
The administrator can choose whether the table will be filled with new records, adjust record storage time and download the tables to CSV files.
How to enable or disable data recording
- Open the configuration file of Integration Server in edit mode. To do so, run the following command:
- For 64-bit operating systems:
notepad "%ProgramFiles(x86)%\Kaspersky Lab\Kaspersky VIIS\viislaservice.exe.config"
- For 32-bit operating systems:
notepad "%ProgramFiles%\Kaspersky Lab\Kaspersky VIIS\viislaservice.exe.config"
- For 64-bit operating systems:
- Find the <add key="IsProtectionPeriodsSavingEnabled" value="false" /> parameter.
- Change "value":
- true — to enable recording data to the table
- false — to disable recording data to the table
- Save the Integration Server configuration file.
- Restart the VIIS service.
Depending on the edited parameter, the table will either be filled with new records or remain unchanged.
How to edit record storage time
- Open the configuration file of Integration Server in edit mode. To do so, run the following command:
- For 64-bit operating systems:
notepad "%ProgramFiles(x86)%\Kaspersky Lab\Kaspersky VIIS\viislaservice.exe.config"
- For 32-bit operating systems:
notepad "%ProgramFiles%\Kaspersky Lab\Kaspersky VIIS\viislaservice.exe.config"
- For 64-bit operating systems:
- Find the <add key="MaxProtectionPeriodRecordAgeSeconds" value="7776000" /> parameter.
- Specify required "value" in seconds.
- Save the Integration Server configuration file.
- Restart the VIIS service.
The storage time for the table data will be changed.
How to download the report
To download data from the table to a report with specified parameters, run an HTTP request:
GET <login>:<password> https://<IP address>:<port>/api/1.0/reports/protectionPeriods?[infraId=<Infrastructure ID>&tenantId=<Correspondence ID>&periodStart=<Starting date>&periodEnd=<Ending date>]
Where the parameters stand for:
- Login and password — login and password of the administrator account. Specified in case the Integration Server is located outside the domain.
- IP address and port — IP address and port that are used to connect to the Integration Server Console.
- infraId — an optional parameter used to receive a report on the virtual machines with the specified infrastructure. Requires the ID of the specific infrastructure.
To get a full list of infrastructures, run the following command:GET /api/1.0/im/vsphere
The infrastructure ID will be specified as an "id" attribute of the infrastructure elements. - tenantId — an optional parameter used to receive a report on the virtual machines with the specified correspondence. A specific correspondence ID or "none" parameter needs to be specified (the latter used for the virtual machines that do not fall under any correspondence).
To get a full list of correspondences, run the following command:GET /api/1.0/mt/tenants
The correspondence ID will be specified as an "id" attribute of the tenant elements (vKSC id). - periodStart — an optional parameter used to receive a report on the virtual machines starting from the specified date Date format: YYYY-MM-DDThh:mm:ssZ.
- periodEnd — an optional parameter used to receive a report on the virtual machines until the specified date Date format: YYYY-MM-DDThh:mm:ssZ.
An example of a curl command operation:
curl -i -S -s -o - --noproxy '*' --insecure -u admin:1 -X GET https://192.168.77.7:7271/api/1.0/reports/protectionPeriods?infraId=19e47e17-e7b9-4819-9495-284af29e86f7&tenantId=VSRV9e1a72ee-6b78-4f3d-a7d4-1025f1c18016
A report example
