Users Guide

The list_reports command is used to list user defined reports. REPORT_GROUP is the name of a report

group. If no REPORT_GROUP is supplied, all reports are listed. Else, only those belonging to the specified

REPORT_GROUP are listed.

Each report is output in one row containing these fields: report_name, description, format,

report_group_name, created_by and status (running or not).

run_report

Usage:

ompc_cli run_report [-start_date <start_date>] [-end_date <end_date>] [-format

<CSV|XML>] [-file_name <file_name>] [-detail] REPORT_NAME

The run_report command is used to run a saved report and export the result to the console or to a file.

The REPORT_NAME is mandatory and specifies which saved report are run.

The options -start_date and -end_date are optional: When supplied, they are used to run the report

in precedence to the time range saved with the original report setting. If only -start_date is supplied,

the current time is used as the end of the time range. If only

-end_date is supplied, the earliest time of

monitoring data is used as the beginning of the time range.

If -file_name is not supplied, the result is displayed in the console in CSV format, ignoring whatever

format setting saved with the report or specified by the -format option.

If –file_name is supplied, the result is saved to the file in the format specified by the option –format. If

-format is not supplied, the format saved with the report is used.

The –detail option is only applied to a “Power HeadRoom” report for exporting the calculation details

of the stranded power.

After a report is run successfully, the report result is displayed in the console or saved to a file specified by

<file_name>. Else, an error message is displayed.

discover_device

Usage:

ompc_cli discover_device -profile <profile-name> [-ip <ip>] [-host_name

<host_name>] [-network_mask <network_mask>] [-end_ip <end_ip>]

The discover_device command is used to discover devices and automatically add the discovered

devices to OMPC. This command supports only HTTPS profile.

The -ip and -host_name options must be supplied.

When -ip is supplied, the -network_mask must be supplied. The -end_ip is only acceptable when -ip

is supplied.

If -end_ip is supplied, the discovery is performed for the IP range of <ip>-<end_ip>. Else, the

discovery is performed for the single address

<ip>.