...
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. | |||
| WANNode Availability | all interfaces ignored before 3.1.4Before version , interfaces irrelevant | Interface selections are not relevant for this report. | |||
| Grouped (Node) Availability | all, interfaces irrelevant new in opReports 3.1.4 | Interface selections are not relevant for this report. | |||
| WAN the WAN report ignored interface selections. It operates on all active or any selected interfaces of the selected nodes whose net type is "wan".QoS | all interfaces ignored before 3.1.4 | Before version 3.1.4 the QoS WAN report ignored interface selections. It operates on all active or any selected interfaces of the selected nodes ', if QoS is configured for the interface.whose net type is "wan". | |||
| WAN Utilisation Distribution and WAN Utilisation Distribution Summary | all new in opReports 3.1.8 | It operates on | CoS | all | For each selected node this report covers all active or any selected interfaces that have Class of Service configured. |
| Uptime | all, interfaces irrelevant | Interface selections are not relevant for this report. | |||
| of the selected nodes whose net type is "wan". | |||||
| QoS | all interfaces ignored before 3.1.4 | Before version 3.1.4 the QoS report ignored interface selections. It operates on all active or any selected interfaces of the selected nodes', if QoS is configured for the interface. | |||
| CoS | all | For each selected node this report covers all active or any selected interfaces that have Class of Service configured. | |||
| UptimeResponse Time | 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 Capacity | all | ||||
| Grouped Interface Capacity | all new in opReports 3.1.8 | ||||
| Interface Utilisation | all | Interface selections are honored but the "type" component (in selections by node+interface+type) are ignored as not relevant. | |||
| Interface Unicast Packets | 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 | 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. | |||
| Traffic Snapshot | opCharts Business Services, selected per page | This report type strictly requires lists of Business Services for each of its (multiple) page definitions. | |||
| Configuration Summary | all, interfaces irrelevant | Interface selections are not relevant for this report |
...
Choosing the selection mechanism for scheduled reports
For scheduled reports your schedule must contain a property named sources, with one of the following values: "everything", "group_each_regexp", "group_regexp", "node_regexp", "node_group", "nodes", "node_list", "node_intf_list", "node_intf_type_list", or "business_services" (in 3.0.14 an newer). Those mechanisms are described below.
...
- Group "All" is equivalent to the default choice, all active nodes. This wildcard should not be used as we will likely retire it in a future version of opReports.
- Group "Each" is available for scheduled reports only, excluding 'once only' scheduled reports, and causes the generation of a separate report for each of the known groups.
Nodes whose name matches a regular expression
In the GUI this choice is called "by Regular Expression", opreports-cli uses the command line argument node_regexp=<regular expression>, and for scheduled reports you'd specify this with the property node_regexp.
The node regular expression is evaluated at report creation time.
The regular expression syntax is Perl's standard, described in detail in this Perl Regexp Tutorial.
- , and causes the generation of a separate report for each of the known groups.
Nodes whose name matches a regular expression
In the GUI this choice is called "by Regular Expression for Nodes", opreports-cli uses the command line argument node_regexp=<regular expression>, and for scheduled reports you'd specify this with the property node_regexp.
The node regular expression is evaluated at report creation time.
The regular expression syntax is Perl's standard, described in detail in this Perl Regexp Tutorial.
Nodes and Interfaces whose names/descriptions match regular expressions
This feature was added to opReports in version 3.1.4.
Nodes must match the regular expression given for the node name, but interface descriptions must also match a separate regular expression.
Only those interfaces are selected where both regular expressions match. For reports where interfaces are not relevant this option behaves just like the previous selection type.
The regular expression for interfaces is applied to both the interface's ifDescr and Description properties in parallel, and a match for either or both selects the interface.
(The NMIS GUI presents ifDescr as "Name" or "Name (ifDescr)". Depending on the device and its modelling ifDescr may or may not be adjustable, but Description can be set easily within NMIS.)
In the GUI this option is called "by Regular Expression for Nodes and Interfaces".
opreports-cli requires that you supply both node_regexp=<regular expression> and node_intf_regexp=<regular expression> arguments.
The report schedules use the same property names as the opreports-cli parameters.
Both regular expressions are evaluated at report creation time.
Groups, Nodes and Interfaces whose names/descriptions match regular expressions
This feature was added to opReports in version 3.1.8.
Groups must match the regular expression given for the group name AND
Nodes must match the regular expression given for the node name AND
Interface descriptions must also match a separate regular expression.
Only those interfaces are selected where all three regular expressions match. However, for reports where interfaces are not relevant, interfaces are disregarded.
The regular expression for interfaces is applied to both the interface's ifDescr and Description properties in parallel, and a match for either or both selects the interface.
(The NMIS GUI presents ifDescr as "Name" or "Name (ifDescr)". Depending on the device and its modelling ifDescr may or may not be adjustable, but Description can be set easily within NMIS.)
In the GUI this option is called "by Regular Expression for Groups Nodes and Interfaces".
opreports-cli requires that you supply group_regexp=<regular expression> AND node_regexp=<regular expression> AND node_intf_regexp=<regular expression> arguments.
The report schedules use the same property names as the opreports-cli parameters.
All three regular expressions are evaluated at report creation time.
Groups, Nodes and Interfaces whose names/descriptions match regular expressions for Report per Group
This feature was added to opReports in version 3.1.4.8.
Groups must match the regular expression given for the group name AND
Nodes must match the regular expression given for the node name , but interface AND
Interface descriptions must also match a separate regular expression.
Only those interfaces are selected where both all three regular expressions match. For However, for reports where interfaces are not relevant this option behaves just like the previous selection type, interfaces are disregarded.
Thie The regular expression for interfaces is applied to both the interface's ifDescr and Description properties in parallel, and a match for either or both selects the interface.
(The NMIS GUI presents ifDescr as "Name" or "Name (ifDescr)". Depending on the device and its modelling ifDescr may or may not be adjustable, but Description can be set easily within NMIS.)
In the GUI this option is called "by Regular Expression for a Nodes and Interfaces Report per Group".
opreports-cli requires does not support this option.
The report schedules requires that you supply both group_each_regexp=<regular expression> AND node_regexp=<regular expression> and AND node_intf_regexp=<regular expression> arguments. The report schedules use the same property names as the opreports-cli parameters.
All three Both regular expressions are evaluated at report creation time.
...
JSON: it must be a valid JSON document, consisting of a hash of the node name as key, and the value being a list of the interfaces in question.
Code Block { "testnode": [ "eth0" ], "othernode" : [ 1, 2, "Tunnel20" ] }
...
| Note |
|---|
Careful not to confuse this option with 'Nodes and specific Interfaces, listed in a file' described above. If the 'Type' option is not necessary this is not the appropriate feature. |
Certain reports offer a refinement of the above, with the added notion of a "Type" for grouping of Node+Interface into particular reporting classes.
| Info |
|---|
"Type" is completely arbitrary. This value can be anything the user would like. This value is not referenced anywhere else in opReports or any other OMK application. |
...
This is implemented again using a list file, but with a very specific format - which has a few inherent limitations; Starting with version 3.0.16, opReports also supports CSV as format for this type of input.
...