Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: added overview of opreports-cli parameters

...

In version 3.0.7 and newer, the opReport scheduler logs the actual command line arguments that it uses for generating reports, which should provide a good example of how the parameters line up.

Overview of opreports-cli parameters

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>

Business-hour reporting. Optional.

 nodes_group=<groupname>|All|Each

Node selection by group name. All means one combined report, Each means one report per group.

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

Node selection by name, either by regular expression or as a list of explicitely given node names

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 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,...>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.

util_threshold
util_threshold_mincount
show_threshold
show_only_util
exceptions
report_wan_level

Optional parameters that are specific to particular report types.
Please see the Report Types page for details.