...
This page describes what mechanisms are available, and how to control them in the GUI, with opreports-cli and for report schedules.
| Table of Contents |
|---|
Which selection mechanisms are supported by what report types?
Certain reports do have specific requirements which are shown in the table below.
In general, however, providing more precision than necessary is allowed: For example, you can use a node and interfaces (and even types) list file for all reports; for reports where interfaces are not relevant, the extra information will simply be discarded and just the listed nodes will be used. Reports that don't need the summary type will simply use the nodes (and possibly the interfaces).
On the other hand, providing insufficiently precise information to reports that require it will result in an error message (e.g. trying to run a summary report with just group=X).
| Report Type | Selection Mechanisms | Notes |
|---|---|---|
| Node | single node only | The node report supports a single node only. If your selection contains more nodes, then the report is created for the first listed node. |
| (Node) Health | all, interfaces irrelevant | Interface selections are not relevant for this report. |
| WAN | all, interfaces ignored | As of version 3.0.4 the WAN report ignores interface selections; It operates on any of the selected nodes whose net type is "wan". |
| QoS | all, interfaces ignored | As of version 3.0.4 the QoS report ignores interface selections; It operates on the selected nodes' active interfaces that have QoS configured. |
| Uptime | all, interfaces irrelevant | Interface selections are not relevant for this report. |
| Response Time | all, interfaces irrelevant | Interface selections are not relevant for this report. |
| Interface Utilisation | all | Interface selections are honored but the "type" component (in selections by node+interface+type) are ignored as not relevant. |
| CPU | all, interfaces irrelevant | Interface selections are not relevant for this report. |
| Free Memory | all, interfaces irrelevant | Interface selections are not relevant for this report. |
| Memory Pool | all, interfaces irrelevant | Interface selections are not relevant for this report. |
| Memory Buffer | all, interfaces irrelevant | Interface selections are not relevant for this report. |
| Traffic Usage | all | Interface selections are honored but the "type" component (in selections by node+interface+type) are ignored as not relevant. |
| Traffic Summary | node+interface+type | This report strictly requires this specific selection format. |
Choosing the selection mechanism for scheduled reports
...
If you do not make an explicit selection, then opReports will work on all active nodes (and all their active interfaces, for report types that handle interfacedinterfaces).
In the GUI this choice is shown as "All Active Nodes".
...
The "type" will be used to group all nodes and interfaces with the same type value into a group for summary reporting.
Providing more precision than necessary is allowed
You can use a node and interfaces (and even types) list file for all reports; for reports where interfaces are not relevant, the extra information will simply be discarded and the listed nodes will be used. Reports that don't need the summary type will simply use the nodes (and possibly the interfaces).
Providing insufficiently precise information to reports that require it will result in an error message (e.g. trying to run a summary report with just group=X).