Generating a CLI report 1/3

Reports : CLI reports : Generating a CLI report

Generating a CLI report

You must specify all mandatory parameter-value pairs in the command line. If you do
not provide a mandatory parameter-value pairs, an error message or command
usage message displays. If the parameter-value contains a space or special
character, it must use double quotes (such as --t “1 Hour”).

1. Open a command prompt

2. Navigate to <Install_Home>/bin.

3. Enter one of the following options:

• On Windows systems, report-cli –-report-type <Report Name> <parameter-
name> <parameter-value> <parameter-name> <parameter-value>… --
username <user>
• On Linux systems, sh report-cli.sh -–report-type <Report Name> <parameter-
name> <parameter-value> <parameter-name> <parameter-value>… --
username <user>

NOTE: You must use the exact syntax for generating the reports (for example,
you must provide the correct parameter options and the values must be entered
with double quotes). If you enter incorrect parameters and values, the report
generation fails.

CLI parameter Description

n The network scope of the report.

Select “All” to choose all available network scope at the time you run the report.

t The time scope of the report. Choose one of the following options:
• 30 Minutes
• 1 Hour
• 6 Hours
• 12 Hours
• 1 Day
• 3 Days
• 1 Week
• 1 Month

st The start time when the time scope is applied to the report.
The format is mm:dd:yyyy hh:mm.

et The end time when the time scope is applied to the report.
The format is mm:dd:yyyy hh:mm.

ps The port scope to be considered for the reporting. Choose one of the following options: All
Ports, ISL Ports, Initiator Ports, or Target Ports. The default is All Ports.

o The output directory path where the generated report is saved.

The format is <platform specific absolute path>.
The default is <Install_Home>\data\reports\<Report Type>-<Date and Time in MM-DD-
YYYY-HH:MM:SS>
In Linux, the following folder structure report is not created (/root path and sub folders). If
 Generating a CLI report 2/3

In Linux, the following folder structure report is not created (/root path and sub folders). If
this path is required, you must provide 777 access to all folder levels in the specified path.
This parameter is applicable to all reports.

fab The fabric name for summary report.

The format is <fabricname;IP>.

s The identification information of the switch(es) for which the report is generated.
The format is <WWN>.

tun The input tunnel information for the report.

The format is <Tunnel ID>;<Local Switch WWN>, <Tunnel ID>;<Local Switch WWN>.

m The measure(s) for the report.

FCIP Port measures include Cumulative Compression Ratio, Latency, Dropped Packets,
Link Retransmits, Time Out Retransmits, Fast Retransmits, Duplicate Ack Received,
Window Size RTT, TCP Out Of Order Segments, Slow Start Status Errors, or Current
Compression Ratio.
SFP Port measures include SFP Power, SFP Voltage, SFP Current, and SFP
Temperature.
Product Performance measures include Memory Utilization Percentage, CPU Utilization
Percentage, Temperature, Fan Speed, System Up Time, and Ports Not in Use.

p The port WWN(s) for the report.

The format is <WWN>,<WWN>.

Example Detailed Port Report

(Windows) report-cli --report-type "Detailed Port Report" --n “All” --
t “1 Hour” --et “11:10:2016 00:00” --username “administrator”
(Linux) sh report-cli.sh --report-type "Detailed Port Report" --n “All”
--t “1 Hour” --et “11:10:2016 00:00” --username “administrator”
Example Fabric Summary Report
(Windows) report-cli --report-type "Fabric Summary Report" --fab
“fabric1;10.24.42.22”–-username“administrator”
(Linux) sh report-cli.sh --report-type "Fabric Summary Report" --fab
“fabric1;10.24.42.22”–-username“administrator”
The --fab parameter is required.

Example Host Adapter Inventory Report

(Windows) report-cli --report-type "Host Adapter Inventory Report" --
usernameadministrator
(Linux) sh report-cli.sh --report-type "Host Adapter Inventory Report"
--usernameadministrator
Example Host Adapter Unsupported and Faulty SFP Report
(Windows) report-cli --report-type "Host Adapter Unsupported and
Faulty SFP Report" --username administrator
(Linux) sh report-cli.sh --report-type "Host Adapter Unsupported and
Faulty SFP Report" --username administrator
Example Port FCIP Time Series Performance Report
(Windows) report-cli --report-type "Port FCIP Time Series Performance
Report" –-n “All” --s “10:00:00:27:F8:D8:8B:73” --tun “tunnel1”
–-m “Latency” –-st “11:01:2016 00:00” --et “11:10:2016 00:00”
(Linux) sh report-cli.sh --report-type "Port FCIP Time Series
Performance Report" –-n “All” --s “10:00:00:27:F8:D8:8B:73” --
tun “tunnel1” –-m “Latency” –-st “11:01:2016 00:00” --et “11:10:
2016 00:00”
 Generating a CLI report 3/3

Example Port SFP Time Series Performance Report

(Windows) report-cli --report-type " Port SFP Time Series Performance
Report" –-n “All” –-s “10:00:00:27:F8:D8:8B:73” –-p “10:00:10:34:
F8:D8:8B:73” --ps “All Ports” --m “SFP Power” --username
administrator
(Linux) sh report-cli.sh --report-type " Port SFP Time Series
Performance Report" –-n “All” –-s “10:00:00:27:F8:D8:8B:73” –-p
“10:00:10:34:F8:D8:8B:73” --ps “All Ports” --m “SFP Power” --
usernameadministrator
The --m (SFP port measures), --st, and --et parameters are required.

Example Port SFP Performance Report

(Windows) report-cli --report-type " Port SFP Performance Report" --t
“1 Hour” –-ps “All Ports” –-et “11:10:2016 00:00” --username
administrator
(Linux) sh report-cli.sh --report-type " Port SFP Performance Report" --
t “1 Hour” –-ps “All Ports” –-et “11:10:2016 00:00” --username
administrator
The --m (FCIP measures), --st, and --et parameters are required.

Example Product Time Series Performance Report

(Windows) report-cli --report-type " Product Time Series Performance
Report" --n “All” --s “10:00:00:43:F5:T7:G5:D4” –-m “Fan Speed”
–-st “11:10:2016 00:00” --et “11:20:2016 00:00” --username
administrator
(Linux) sh report-cli.sh --report-type " Product Time Series
Performance Report" --n “All” --s “10:00:00:43:F5:T7:G5:D4” –-m
“Fan Speed” –-st “11:10:2016 00:00” --et “11:20:2016 00:00” --
username administrator
The --m (Product Performance measures), --st, and --et parameters are
required.

Example Switch Report

(Windows) report-cli --report-type " Switch Report" –-s “10:00:00:43:
F5:T7:G5:D4”--usernameadministrator
(Linux) sh report-cli.sh --report-type " Switch Report" –-s “10:00:00:
43:F5:T7:G5:D4”--usernameadministrator
The --s parameter is required.

Example Zone Summary Report

(Windows) report-cli --report-type " Zone Summary Report" –-fab
“fabricname1”--usernameadministrator
(Linux) sh report-cli.sh --report-type " Zone Summary Report" –-fab
“fabricname1”--usernameadministrator
The --fab parameter is required.