User Guide for NetMaster R17A00

5.9.1.3 Generating Performance reports using a CLI command

Once NetMaster is collecting network-wide performance counters from devices,
you can generate various performance reports using the pmreport CLI command.
The report is generated as soon as the CLI command is given, and saved to the
specified location.
Note that report generation using the CLI command can be scheduled by using the
operating system (Windows Task Scheduler or Unix Crontab).
Note: Following a NetMaster server or client installation on a
Windows or Solaris machine, you must log off the operating
system and log on again for the pmreport command to work.

pmreport command syntax

The pmreport command can be called from any directory on the NetMaster client
or server machine. Its syntax is as follows:
pmreport [-IP <IP list>] [-NEType <IP-10|IP-20>]-OFN <file name> -
RT <report type> [-PM_TYPE <interface-type>] [-radio_type <radio-
interface>] [-SDAY |-SWEEK |-SMONTH] [-SD <date>] [–ED <date>] [-
DURATION <n>h|<n>d] [-LAST <n>h|<n>d] [-SERVERIP <IP>] -USER <user-
name> -PASSWORD <password> [-FILTER <minimum threshold> | -FFILTER
<logical expression>] [-Delta] [-Group <domain-name>][-noheaders]
[-timestamp|-timestamp D|-timestamp M]

where:

Page 307 of 630

Ceragon Proprietary and Confidential

 User Guide for NetMaster R17A00

Parameter Format Mandatory/ Description

Optional

IP -IP <IP> <IP> O, if omitted The IP addresses, separated by spaces, of the

Or the default target devices. For example:
parameter is -IP 172.24.30.100 172.24.30.101
-IP ALL
ALL For IP-20 devices, you can specify the IP
address in either IPv4 or IPv6 format. Use the
same format used to Discover the device..
When specifying an IPv6 address, you can use
any of the following representations:
· The full representation of 8 groups of 4
hexadecimal digits, separated by colons. For
example:
2001:0db8:85a3:0000:0000:8a2e:0370
:7334
· Omitting leading zeros in groups. In this case,
the above example address would be
entered as:
2001:db8:85a3:0:0:8a2e:370:7334
· If the address contains chains of consecutive
zero groups (a zero-group is a groups whose
4 digits are zero) Replacing a chain of zero-
groups with a double colon, with the
following stipulations:
· Only one double colon per address.
· The longest zero-groups chain is replaced
with a double colon.
· If there is more than one longest zero-
groups chain, the leftmost one is replaced
with a double colon.
Use –IP ALL to generate a report for all
devices in the database.
Note: When using ALL, it is recommended to
specify a limited time interval using –SD
and -ED. The data for the entire network can
reach a considerable size if not limited to a
specific time period.

NEType -NEType <IP-10|IP- O Enables you to limit the report to IP-10

20> elements only or IP-20 elements only. For
example:
-NEType IP10
Note : You can still provide a list of IPs. The
report will be generated for all the specified IPs
that match the device type.

Page 308 of 630

Ceragon Proprietary and Confidential

 User Guide for NetMaster R17A00

Parameter Format Mandatory/ Description

Optional

OFN -OFN M The output file name and path. If the extension
<filepath\name.ext> is .txt, the file will be saved in text format. If
the extension is .csv, the file will be saved in
CSV format.
If the filepath is not specified, the report will be
placed in the folder from which the command
pmreport was executed.
Note: Make sure you have full permissions to
the specified folder. Otherwise, no report is
created or saved.

RT -RT <report-type> M The report type. This can be set to any of the
following (including the quote marks):
"Interface Performance Report"
"Radio Performance Report"
"RMON Report"
"Trails Performance Report"
"Enhanced Radio Performance Report"
"Enhanced Radio Ethernet
Performance Report"

PM_TYPE -PM_TYPE O For which type of interface to generate an

<interface-type> Interface Performance report. The options are:
· E1
· T1
· STM1
· OC3
· ETHERNET_RADIO
Note that the interface type must be entered in
capital letters.
This parameter is relevant only for Interface
Performance reports.
If this parameter is not included in the CLI
command when the report type (RT) is set to
“Interface Performance Report”, a
report is generated for all interfaces (E1, DS1,
STM1, OC3, Radio Ethernet) that are present
on the devices included in the report.

radio_type -radio_type <radio- O Generate a separate Radio Performance Report

interface> for different radio interfaces. The options are:
RADIO Radio port
RUAS Radio channels
This parameter is relevant only for Radio
Performance reports.

Page 309 of 630

Ceragon Proprietary and Confidential

 User Guide for NetMaster R17A00

Parameter Format Mandatory/ Description

Optional

SDAY -SDAY O Generate a summarized daily report.

If neither SDAY nor SWEEK nor SMONTH is
specified, a 15-minute-interval counters report
is produced.
This option is not relevant for RMON counter
reports.

SWEEK -SWEEK O Generate a summarized weekly report.

If neither SDAY nor SWEEK nor SMONTH is
specified, a 15-minute-interval counters report
is produced.
This option is not relevant for RMON counter
reports.

SMONTH -SMONTH O Generate a summarized monthly report.

If neither SDAY nor SWEEK nor SMONTH is
specified, a 15-minute-interval counters report
is produced.
This option is not relevant for RMON counter
reports.

SD -SD MM O Start date and time for the report.

HH For example:
-SD “17/05/15 12:00”

ED -ED MM O End date and time for the report.

HH For example:
-ED “18/05/15 23:59“

DURATION -DURATION O As an alternative to setting the start date and

<n>h|<n>d end date of the report, you can define to
include in the report only the PMs from a
specific numbers of hours or days prior to the
time of command execution. For example:
-DURATION 12h
In this case, the report will include the PMs
from the 12 hours prior to command
execution.

Page 310 of 630

Ceragon Proprietary and Confidential

 User Guide for NetMaster R17A00

Parameter Format Mandatory/ Description

Optional

LAST -LAST [<n>h|<n>d] O As an alternative to setting the start date and

end date of the report, you can define to
include in the report only the PMs from a
specific number of FULL hours or days prior to
the time of command execution. For example:
-LAST 1d
The report will include the PMs from the last 1
day - from 00:01 to 24:00.
-LAST 3h
The report will include the PMs from the last 3
hours. If the command is executed at 10:59 the
report will include PMs from 07:15 to 10:00.

SERVERIP -SERVERIP <IP> O, if omitted The NetMaster server IP address, which must
the default be provided if you are generating a report from
value is the NetMaster client rather than the
NetMaster server machine.
If not provided, –SERVERIP LOCALHOST is the
default setting.

USER -USER M The name of the user with read access to the
target devices. Make sure to specify an active
user with a valid password.

PASSWORD -PASSWORD M The password of the user with read access to

the target devices.

FILTER -FILTER <minimum O Filter the report by a minimum threshold.

threshold> Only fields that exceed the specified value are
presented.
For example: -FILTER 0 specifies not to show
zero value fields.
Note:
· You cannot use both FILTER and
FFILTER in the same command.
· FILTER can be used only once in a
command.
· if you employ filtering and no counter
values match the filter, the report will
display empty tables.

Page 311 of 630

Ceragon Proprietary and Confidential

 User Guide for NetMaster R17A00

Parameter Format Mandatory/ Description

Optional

FFILTER -FFILTER O Filter the report by a logical expression.

- Each part of the expression is composed of:
name><operator><va
· < field name> - a field name as it appears
lue>
in the column header: For example,
<boolean-op>
“Frame Error Rate
<field-
Note that field names which include
name><operator><va
spaces must be enclosed in quotes.
lue>
<boolean op> · <operator> - any of the following: > >=
<field- < <= = <>
name><operator><va · <value> - a number
lue> While:
--- <Boolean op> - one of the following boolean
operators between two parts of the
expression.
· Use: | for OR,
· Use: & for AND
Syntax considerations:
· Replace any spaces in column names with
underscores.
· For IP-10 devices, to filter fields that have
values in Mbps units you must provide
values in bps units.
Note:
· You cannot use both FILTER and
FFILTER in the same command.
· FFILTER can be used only once in a
command.
· The filtering instructions are performed in
the order in which they are listed, from left
to right.
· Percentage fields cannot be filtered.
· If the same field name appears in both IP-
10 and IP-20 reports but the units differ,
then filtering cannot work for both. In this
case, filter IP-10 devices separately from
IP-20 devices.
· if you employ filtering and no counter
values match the filter, the report will
display empty tables.

Delta -DELTA O Display the difference between counter

readings in the report, rather than the actual
counter value.
This option is available for RMON counter
reports only.

Page 312 of 630

Ceragon Proprietary and Confidential

 User Guide for NetMaster R17A00

Parameter Format Mandatory/ Description

Optional

Group -Group <domain- O Generate a report only for the devices in the
name> specified domain and its subdomains.

noheaders noheaders O Generate Interface Performance reports in a

single table, without titles. This facilitates
parsing of the Interface Performance report.
The titles are replaced by the following
columns which are added to the table:
· IP
· System Name
· Slot Number
· Interface
This option is available only for Interface
Performance reports, and only if you use
the -pm_type parameter to specify a single
interface.

timestamp -timestamp O Add a timestamp to the report filename.

or · If you specify –timestamp
-timestamp D or -timestamp D, then the filename will
have the following format:
or
<filename>_DDMMYYYY_HH_MM_SS.<ext
-timestamp M ension>
· If you specify –timestamp M , then the
filename will have the following format:
<filename>_MMDDYYYY_HH_MM_SS.<ext
ension>

Note: The parameters are not case sensitive, except where noted
otherwise.

pmreport CLI command - examples

The following are examples of commands for generating Ethernet Radio Interface
Performance reports:
pmreport –IP 172.24.30.100 172.24.30.101 –OFN C:\Temp\report\test1 –RT
“Interface Performance Report” -pm_type ETHERNET_RADIO -SD “17/05/15
12:00” -ED “18/05/15 23:59” –USER admin –PASSWORD NmsSystem1 –FILTER 0
pmreport –IP 2001:db8:85a3:0:0:8a2e:370:7334 –OFN C:\Temp\report\test1 –RT
“Interface Performance Report” -pm_type ETHERNET_RADIO -SD “17/05/15
12:00” -ED “18/05/15 23:59” –USER admin –PASSWORD NmsSystem1 –FILTER 0

pmreport –IP ALL –OFN C:\Temp\report\test2 –RT “Interface Performance

Report” -pm_type ETHERNET_RADIO –SMONTH -SD “17/05/15 12:00” -ED “18/05/15
23:59” –SERVERIP 172.24.30.1 –USER admin –PASSWORD NmsSystem1 –FFILTER
“Peak_Capacity>10&Average_Throughput>30|Average_Capacity>25”

Page 313 of 630

Ceragon Proprietary and Confidential

User Guide for NetMaster R17A00

The following is an example of a command for generating an Interface

Performance report with no headers:
pmreport -CLI –IP all -OFN “C:\noheadersPMReport.csv” -RT "Interface
Performance Report" -USER admin -PASSWORD NmsSystem1 -pm_type ETHERNET_RADIO
-noheaders

The following is an example of a command for generating an OC3 Interface

Performance report:
pmreport -IP 10.10.68.107 -OFN output.csv -RT "Interface Performance Report"
-pm_type OC3 -USER admin -PASSWORD NmsSystem1

The following is an example of a command for generating an 3200T XC Carrier

Interface Performance report. The IP address is the address of the shelf with the
XC card:
pmreport -OFN C:\Reports\3200TXC_i.txt -USER root -PASSWORD pw -IP
10.10.67.202 -RT "Interface Performance Report”

The following is an example of a command for generating a RMON Performance

report that will display the difference between counter readings in the report,
rather than the actual counter value:
pmreport -IP 10.10.68.107 -OFN output.csv -RT "RMON Report" -user admin -
password NmsSystem1 -DELTA

The following is an example of a command for generating a Trails Performance

report:
pmreport -IP 10.10.68.107 -OFN output.csv -RT "Trails Performance Report" -
user admin -password NmsSystem1

The following are examples of commands for generating a Radio Performance

report:
pmreport –IP 172.24.30.100 172.24.30.101 –OFN C:\Temp\report\test1 –RT
“Radio Performance Report” -SD “17/05/15 12:00” -ED “18/05/15 23:59” –USER
admin –PASSWORD NmsSystem1 –FILTER 0

pmreport –IP ALL –OFN C:\Temp\report\test2 –RT “Radio Performance Report” –

SMONTH -SD “17/05/15 12:00” -ED “18/05/15 23:59” –SERVERIP 172.24.30.1 –
USER admin –PASSWORD NmsSystem1 –FFILTER “Min_RSL>10&Max_RSL>30”

pmreport -OFN output.csv -IP 10.10.68.107 -user admin -password NmsSystem1

-RT "Radio Performance Report" -radio_type RUAS

Page 314 of 630

Ceragon Proprietary and Confidential