...
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
Parameter | Description |
---|---|
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> | 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> | Node selection by name, either by regular expression or as a list of explicitely given node names |
node_intf_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 | 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|true | If set, more verbose debug logging and output is produced. Optional. |
util_threshold | Optional parameters that are specific to particular report types. Please see the Report Types page for details. |