Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If you don't select a report name (under advanced options), then the report name will be generated from report type, date and a few other properties. If a name clash is detected, then newer reports will be named <originalname>.1.2 and so on. This de-clashing also applies to your custom report name!

...

Ageing

Old one-off reports are pruned based on the configuration setting default_report_keep_for, subsection one-off (in opCommon.nmis) by default that is set to 42 days.

...

ParameterDescription
act=<report_type>

What report to generate. Required.

days=<N>
start_date=<date>
end_date=<date>
The period the report should span.
End date defaults to now, days defaults to 7.

from=<HH>
to=<HH>
exclude=<DAY1>-<DAY2>

Business-hour/Business-week reporting. Optional.
Business week selection is supported in opReports version 3.0.8 and above.

 nodes_group=<groupname>|All|Each

Node selection by group name. All means one combined report, Each means one report per group.
group_regexp=<regexp>Group selection by regular expression.
node_regexp=<regexp> AND node_intf_regexp=<regexp> are also required when group_regexp=<regexp> is provided.

node_regexp=<regexp>
nodes=NAME1 nodes=NAME2 nodes=NAME3...

Node selection by name, either by regular expression or as a list of explicitly given node names.
node_intf_regexp=<regexp>Interface selection by regular expression. node_regexp=<regexp> is also required when node_intf_regexp=<regexp> is provided.

node_intf_list=<listfile>
node_list=<listfile>
node_intf_type_list=<listfile>

Node selection by list file.
See How to select Nodes (and Interfaces) for reporting in opReports 3 for file formats and details.

format_1=HTML|CSV|XLSX
output_file_1=<path>
format_2=... output_file_2=...

What formats to generate and where to store the resulting files.
At least one format must be selected.
email=<adress<address,address,...>Optional recipients of the report. Only the selected output formats are emailed out.
target_audience_group=<group>If set, only members of this NMIS group can see the report in the GUI. Optional.
actual_name=<report file name>The base name shared by all output files for this report instance. Required for GUI visibility.
actual_uuid=<uuid>The globally unique identifier for this report instance. Required for GUI visibility.
uuid=<uuid of a report schedule>The unique identifier of the report schedule this report should be marked as belonging to. Optional.
keep_for=<N>How many days to keep this report instance. Optional.
title=<text>Custom report title. Optional.
description=<text>Custom report description. Optional.
homelink=<html text>Custom report header for HTML output. Optional.
debug=N|verbose|trueIf set, more verbose debug logging and output is produced. Optional. N can take values 1 to 9.

util_threshold
util_threshold_mincount
show_threshold
show_only_util
exceptions     (Applicable to Health Report)
uptime_exceptions     (Applicable to Uptime Report)
report_wan_level
embedgraphs

Optional parameters that are specific to particular report types.
Please see the Report Types page for details.
node_naming=<propname>

If set to an NMIS property name, the node's value for this property will be used for displaying the node's name. Optional.
The standard property to use would be display_name (and only this property is offered as a choice in the opReports GUI), but any NMIS node property should work.

If the option is not set or if the given property is not present for a particular node, the node's plain name is shown.
This feature is supported in opReports 3.0.8 and NMIS 8.6.0 onward.

interface_naming=<propname>

If set to an NMIS interface property name, that interface's value for this property is used for displaying the interface name. Optional.
The default property is Description, i.e. the interface's ifDescr or ifAlias property (depending on the node's model).
If the option is not set, the interface's ifDescr property is show.
This feature is supported in opReports 3.0.10 and NMIS 8.6.0 onward.

pages.*=<value>Page definition for Traffic Snapshot report (in opReports 3.0.14 and up).
These parameters describe a deep structure, serialised in dot-notation. Please check the Report Types page for details.

...