...
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?
Join Paul McClendon, an Opmantek Support Engineer, as he demonstrates quickly and easily you can generate reports using opReports.
...
| 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. |
| Node Availability | all, 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 | all interfaces ignored before 3.1.4 | Before version 3.1.4 the WAN report ignored interface selections. It operates on all active or any selected interfaces of the selected nodes whose net type is "wan". |
| WAN Utilisation Distribution and WAN Utilisation Distribution Summary | all new in opReports 3.1.8 | 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 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. |
| 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 Capacity | all | |
| Grouped Interface Capacity | all | |
| 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. |
| 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. |
| Monitored Services | 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.
If you use the opReports schedule editing GUI then this property will be managed on your behalf.
The Simplest Choice: Everything
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 interfaces).
In the GUI this choice is shown as "All Active Nodes".
Nodes that belong to a specific group
In NMIS every node belongs to precisely one group, and this concept therefore applies to opReports as well.
...
- 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 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.
...
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.
...
All three regular expressions are evaluated at report creation time.
Groups, Nodes and Interfaces whose names/descriptions match regular expressions for separate report for each group
This feature was added to opReports in version 3.1.8.
...
All three regular expressions are evaluated at report creation time.
Explicitly listed Nodes
In the GUI this choice is called "Pick from Node List".
...
| Code Block |
|---|
"nodes" : [ "ASGARD", "midgard" ], |
Nodes listed in a file
opReports expects a node list file to contain one node name per line. Whitespace before or after the node name is removed.
...
| Code Block |
|---|
"node_list" : "/tmp/my_list_of_lotsa_nodes.txt" |
Nodes and specific Interfaces, listed in a file
Certain reports allow a more precise selection of nodes and just some of their interfaces. This is implemented using a list file.
...
For both JSON and Plain Text formats, interfaces can be identified by the numeric SNMP interface index, or by the SNMP ifDescr property.
Nodes, specific Interfaces and Types, listed in a file
| 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. |
...
The relevant GUI choice is called "from Node, Interfaces and Type List File (Upload)", for opreports-cli the parameter is node_intf_type_list=<path to listfile>, and in a report schedule the controlling property is node_intf_type_list (value again the path to the list file).
Plain Text Format
Please note: as of version 3.0.16 it's recommended that you use CSV as a safer alternative to this format.
...
The "type" will be used to group all nodes and interfaces with the same type value into a group for summary reporting.
CSV Format (3.0.16 and newer)
opReports now also supports CSV (with comma as the separator character) for this kind of input.
The lines in your file must contain at least the following four columns, in the following order:
...
| Code Block |
|---|
# comment, ignored. columns: nodename,interface index,interface description,type name "some node","1","FastEthernet0/0","categoryA" "not_the_greatest_name","10","Dialer1","catB" "pleasefindme",,"Dialer1194","categoryA" "iknowtheindex",12,,"catB" |
Nodes and Interfaces that are part of an opCharts Business Service
If you have opReports version 3.0.14 and newer and opCharts is installed on the same system, then you can make use of Business Services to declare nodes and interfaces for reporting.
Configuration
The following three configuration options (in conf/opCommon.nmis) are vital for opReports accessing opCharts:
...
If you've changed the password for the default nmis user (or disabled it altogether), then these configuration items need to be adjusted accordingly.
Once that's done you need to restart the OMK webserver (using sudo service omkd restart) to activate the changed configuration.
Usage
In the GUI you will be presented with a list of known Business Service names, which supports multiple selections.
...