Ask the Community
Groups
How to generate and modify the Retention Compliance Details report - Connect IT Community | Kaseya
<main> <article class="userContent"> <h2 data-id="summary"><strong>SUMMARY</strong></h2> <p>This article describes how to generate and modify the Retention Compliance Details report.</p> <h2 data-id="issue"><strong>ISSUE</strong></h2> <p>The Retention Compliance Details report provides a comprehensive view of asset compliance with long term retention policies. By default, this report is generated monthly. </p> <h2 data-id="resolution"><strong>RESOLUTION</strong></h2> <p>To generate and view the Retention Compliance Details report: <br><br><b>Step 1:</b> Log in to your Unitrends appliance via SSH.<br>Note: A terminal emulator such as PuTTY can be used to establish an SSH connection from a Windows system. <br><br><b>Step 2:</b> Run the command ltr_compliance_report.php -t <report_type> [options..]<br><br>Usage instructions for the ltr.compliance_report.php script:<br><br> -t <report_type> report type (required); <br>valid values: singleSource, multipleSources, allAssets<br> -s <sources> comma-separated list of source names (optional);<br>applicable only on target system and when report_type is 'singleSource' or 'multipleSources'<br> -f <use_html> report format - use HTML (optional); <br>specify 1 for true, 0 for false<br> -l <report_location> path of location to store the generated report (optional)<br>If any of the optional arguments aren't passed in, the corresponding settings in 'RetentionComplianceReport' section of master.ini are used.<br><br><b>Step 3:</b> Retrieve the Retention Compliance Details report. By default, the report can be found in /usr/bp/reports.dir titled with the following naming scheme: <source_name>_retention_details_report. <br>Note: To access the report more easily from a Windows system, use the mv command to move the report to /backups/samba, where it can be accessed at \\<appliance IP>\samba via your file browser. <br><br><br> </p> <h2 data-id="notes"><strong>NOTES</strong></h2> <p>The Retention Compliance Details report can also be modified via the master.ini variables detailed in the following table:<br><br>These master.ini variables can be accessed by logging into the Unitrends web UI and selecting <b>Configure > Appliances > (select appliance) > Edit > Advanced > General Configuration</b>.<br> </p> <table border="1"><tbody><tr><td colspan="1" rowspan="1"><b>Section</b></td> <td colspan="1" rowspan="1"><b>Name</b></td> <td colspan="1" rowspan="1"><b>Accepted Values</b></td> </tr><tr><td colspan="1" rowspan="1">RetentionComplianceReport</td> <td colspan="1" rowspan="1">EnableReport</td> <td colspan="1" rowspan="1">Enter "Yes" to enable the report. Enter "No" to disable the report. </td> </tr><tr><td colspan="1" rowspan="1">RetentionComplianceReport</td> <td colspan="1" rowspan="1">ReportType</td> <td colspan="1" rowspan="1">Enter "allAssets" to include all assets in the report.<br> Enter "singleSource" to only include a single source's assets in the report. <br> Enter "multipleSources" to only include specified source's assets in the report. <br><b>Note: </b>Sources are specified in the "Sources" variable. </td> </tr><tr><td colspan="1" rowspan="1">RetentionComplianceReport</td> <td colspan="1" rowspan="1">Sources</td> <td colspan="1" rowspan="1">Enter a comma-separated list of all sources whose assets you wish to wish to display in the report. <br><b>Note: </b>Not applicable if ReportType = allAssets.</td> </tr><tr><td colspan="1" rowspan="1">RetentionComplianceReport</td> <td colspan="1" rowspan="1">Frequency</td> <td colspan="1" rowspan="1">Enter "monthly" to generate the report every month. Enter "weekly" to generate the report every week. </td> </tr><tr><td colspan="1" rowspan="1">RetentionComplianceReport</td> <td colspan="1" rowspan="1">DayOfMonth</td> <td colspan="1" rowspan="1">Enter a value of "1" to "31" to specify the day of the month on which the report generates.<br><b>Note: </b>Not applicable if Frequency = weekly.</td> </tr><tr><td colspan="1" rowspan="1">RetentionComplianceReport</td> <td colspan="1" rowspan="1">DayOfWeek</td> <td colspan="1" rowspan="1">Enter a value of "1" to "7" to specify the day of the week on which the report generates.<br> 1 = Sunday<br> 7 = Saturday <br><b>Note: </b>Not applicable if Frequency = monthly.</td> </tr><tr><td colspan="1" rowspan="1">RetentionComplianceReport</td> <td colspan="1" rowspan="1">ReportUseHtml</td> <td colspan="1" rowspan="1">Enter "Yes" to generate the report as an .html file. Enter "No" to generate the report as a .pdf document. </td> </tr><tr><td colspan="1" rowspan="1">RetentionComplianceReport</td> <td colspan="1" rowspan="1">ReportLocation</td> <td colspan="1" rowspan="1">Enter a file pathway representing a location on the appliance. The report is generated in this location. </td> </tr></tbody></table> </article> </main>