User Tools

Site Tools


guides:user:compliance:reports

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
guides:user:compliance:reports [2020/05/14 13:46]
pgels
guides:user:compliance:reports [2020/05/14 13:47] (current)
pgels [API]
Line 1: Line 1:
 +{{indexmenu_n>​3}}
 +
 +===== Compliance Reports =====
 +
 +The second tab in the Operate->​Compliance form is to show all reports. ​
 +
 +{{:​menu:​operate:​compliance:​compliance_report_empty.png|}}
 +
 +You'll first be shown a selection window. You can only submit this form if you choose a Report type: either nodes or policies. Policy reports can be filtered on policy name:
 +
 +{{:​internal:​designs:​cmpl_reports_selection.png?​nolink|}}
 +
 +And node reports can be filered on node name, vendor, domain, fqdn, polling group. And node model (the model as denoted by its config):
 +
 +{{:​menu:​operate:​compliance:​reports.png|}}
 +
 +You can also filter based on whether a policy or a node is compliant or not, and you can save these reports for future use. A report can be public, meaning that other people can use it too, or not, meaning that only you get to see it. 
 +
 +When you click on Show report, you'll get to see all policies or nodes that match your queries. Note that any node that has no policy, or any policy that has no node, is automatically non-compliant. Also a policy that has never been run is non-compliant,​ same for a node. If there are also nodes that don't fit in your license, they also will not show up in these reports.
 +
 +{{:​menu:​operate:​compliance:​report_show.png|}}
 +
 +You are brought to a form with two grids. The first shows all nodes or policies that match your filters, and whether they are compliant or not. A node is compliant only if all its policies are compliant, and in the same way a policy is only compliant if all its nodes are compliant. When you click on a node, you will see a list with all its policies, when you click on a policy, you will see a list with all its nodes. For each instance you will see the last time it was checked for compliancy, and the last time it changed from compliant to non-compliant,​ or the reverse.
 +
 +Compliance rules all have a severity. The node or policy reports take all applicable non-compliant rules, and show their maximum severity (or simply a '​-'​ if the node is compliant);
 +
 +Both grids have a 'Show report'​-button. This shows a detailed report of the last compliance check. You can see a detailed report for both a node, policy or policy-node combination. In the first two cases, it will combine all known records into one report. ​
 +
 +{{:​menu:​operate:​compliance:​compliance_report.png|}}
 +
 +In case the policy on this node is compliant you will see a simple confirmation that it is compliant. In case the policy is not, you will see a detailed breakdown of what is wrong. You can download this report and save it to your system. ​
 +
 +In the case of reports on entire nodes and policies, these reports have the potential to grow quite big. The detail level allows you to specify how much detail you want to see in your overall report, based on indentation. 0 shows as little as possible, 3 shows everything. When you click on the download button, it will download what you see on screen.
 +
 +===== Dashboard =====
 +
 +If you want to have a more global overview of compliance, there is the dashboard.
 +
 +{{:​menu:​operate:​compliance:​dashboard.png|}}
 +
 +The compliance dashboard allows you a global overview of the compliance across your whole environment. The dashboard consists out of three sections.
 +
 +The top two bars show you an overview of the ratios of compliance for your policies and nodes. The right green part represents all compliant nodes and policies, and the other sections the non-compliant ones by severity. You can see the actual percentages when you hover your mouse over the bars. 
 +
 +The two right grids contain the exact information,​ but in grid form. The percentages can also be found here, including the exact amount of policies and nodes that have that status, under the '#'​-column.
 +
 +Since in a healthy environment most of the nodes and policies are compliant, the "​Failed only"​-checkbox hides these results from the bars and the grid, allowing you a more detailed look at the non-compliant nodes and policies. ​
 +
 +Note that only licensed nodes are counted when compiling the summaries for this dashboard.
 +
 +The compliance per policy grid gives a quick overview of all of your active policies. Any policy that does not have any licensed node is not shown. The middle column shows the number of nodes in this policy that are not compliant. The right column shows the amount that are. You can filter the middle column on severity to have it only show one particular severity (for example if you want to only see the policies that nave high risk issues).
 +
 +===== API =====
 +
 +There are two different types of API requests to get reports:
 +
 +  * **[[guides:​reference:​compliance:​cmpl_xch#​requesting_reports|cmpl_report]]:​** returns a compact hierarchical report based on a policy, node or policy on a node. 
 +  * **[[guides:​reference:​compliance:​cmpl_xch#​requesting_raw_reports|cmpl_report_raw]]:​** returns a report data dump, more like the reports form, allowing you all of its way to select and filter as well.
 +
  
guides/user/compliance/reports.txt ยท Last modified: 2020/05/14 13:47 by pgels