Page tree

Versions Compared

Key

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

...

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

...