...
| Code Block |
|---|
./bin/opreports-cli.pl -?
opReports Version 3.1.8
...
usage: ./opreports-cli.pl type=<report type> days=<N> from=<HH> to=<HH>
start_date=<date_time> end_date=<date_time>
nodesnode_group=<NMIS_GROUP>|All|Each
group_regexp=<regexp>
node_regexp=<regexp>
node_intf_regexp=<regexp>
node=NAME1 [node=NAME2 node=NAME3...]
node_intf_list=<listfile>
node_list=<listfile>
node_intf_type_list=<listfile>
email=user@domain.com [email=user2@domain.com...]
output_file_<html|csv|xlsx>=<path>...
output_dir=<path> format=<html|csv|xlsx> [format=...]
actual_name=<report file name>
target_audience_group=NMIS_GROUP
options.<optname>=<value>...
type: the report to create,
(availability|avgcpu|buffer|capacity|config|freemem|groupedav|groupedcap|health|jcos|mempool|node
|qos|response|snapshot|summary|unicastpacket|uptime|usage|util|wan|wan_util_dist,wan_util_dist_sum)
node_regexp: a regular expression for matching the node name (not with group)
nodesnode_group: group of devices to report on, either NMIS group name,
"All", "Each" or nothing
"All" (or nothing) means all nodes in all groups will produce a report containing all devices in all groups
"Each" produces a separate report for each group.
email: send report to the listed email addresses (comma separated list)
days: Number of days to report
start_date: The starting date and time e.g. "1-Apr-2012 14:35:00"
end_date: The end date and time e.g. "5-Apr-2012 17:00:00"
from: Business hours reporting, the daily start time in hours
to: Business hours reporting, the daily end time in hours
target_audience_group: limits viewing in the GUI to members of this group
|
...
| 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/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> | 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 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 | 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. |
| 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. 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. |
| 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. |
| 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. |
...