Reporting Command-Line Parameters

{Hyperlink}Table {Default ¹ Font} shows the command-line parameters available for the report command. Parameters that must be set are marked as Required.

Command-line reporting does not check for conflicting parameters; the last parameter takes precedence. For example, if your report has both –out –usage_summary parameters, the resulting report will be Usage Summary.

The syntax for running a report from the command line (from the FlexNet Manager for Engineering Applications Admin directory) is:

flexnet report

FlexNet Manager for Engineering Applications Reporting Command-Line Parameters
Parameter	Description
–help	Help for the report command that lists command-line parameter usage.
–barchart <metric>	Specifies barchart output for Summary Barchart and Usage Efficiency reports. <metric> values are num_used, %_used, and hrs_used, max_used.
–bgcolor <color>	Set the background color of a graphical report. Select from: white, black, red, green, blue, cyan, magenta, yellow. The default color is white. You can also specify colors in hexadecimal RGB format. See Customizing Appearance of Graphical Report Output
–breakdown <category>	Specify a breakdown category.
–config <config_filename>	Read report parameters from a report configuration file. The file must have the file extension .config.
–datacolor <color[,color]>	Set the colors of data lines or bars in a graphical report. Select from: white, black, red, green, blue, cyan, magenta, yellow. For Usage Over Time or High Water Mark reports, two colors can be specified: the first for the usage line (default: blue) and the second for the available line (default: red). For barcharts, the specified colors are assigned to subsets of data in the order that each appears in the report. You can also specify colors in hexadecimal RGB format. See Customizing Appearance of Graphical Report Output
–datastyle <n[,n]>	Set the style of lines of data. Select from -1 (solid), 0 (dashed), 1 (dotted), or 2 (dotted-dashed). Default: -1.
–delim <delimiter>	Specify a RIF-format field delimiter. <delimiter> can be an arbitrary string. The default delimiter is a tab. Any fields that contain the delimiter are quoted with double quotes. Do not use double quotes (“), single quotes (‘), or a backslash (\) as a RIF delimiter.
–elim_false_denials <interval>	Request the elimination of “false” denials occurring within an interval of given number of seconds. If not explicitly specified, interval is 10 seconds.
–encoding <charset>	Use the specified character set encoding to produce textual output files. The machine on which the output file is viewed must have a font that can display the specified character set.
–event_type <type>	Specify for each event type to include in report. Available event types are used, denied, queued, exception, and checkout. If event_type is not specified, all event types except checkout are reported.
–enddate <date>	Set the ending date for report output.
–feat_uniq <ID>	Distinguish features using one of these IDs. Available values for ID are name, name_ver, name_key, name_asset.
–field “field_name [,col_width] [,col_justification]”	Include a field with these specifications in a Raw report. Field names are listed in later table. For example, –field “even, 10, left”
–filter <category> <operator> <value>	Specify filtering expression. Filter categories are listed in a later table.
–filterperiod "start" "end"	Specify a time period during the week to include in report output. The start and end time formats are d.hh:mm:ss, where d is 1–7 (Day 1 = Sunday, Day 7 = Saturday). Designating days and seconds is optional. Surround start and end with double quotes.
–fontbold	Use bold font for the labels, title, and legend of the graph. Must also set –fontface and –fontsize.
–fontface <font>	Set the font face for the labels, title, and legend of the graph. Select from the fonts available to the JVM on the machine. Must also set -fontsize.
–fontitalic	Use italic font for the labels, title, and legend of the graph. Must also set –fontface and –fontsize.
–fontsize <points>	Set the font size in points for the labels, title, and legend of the graph. Must also set -fontface.
–gap_threshold <seconds>	Specify the minimum duration of a gap in license service that is reported in a Server Coverage report.
–graphical_template <template>	Specify a template to use for the graphical configuration, with a value between 1 and 6.
–host <host>	Specify the host name. Required.
–html	Request report output in HTML format.
–input input_filename1 [input_filename2...]	Specify the list of report log(s) to read. The -input parameter can be used once followed by several report logs. Required (or -input_single)
–input_single <"file_name">	Specify a single report log for input. Useful for specifying a file name containing white space on Windows. Surround file name with double quotes.
–interval <period>	Specify Usage Over Time or High Water Mark summary period. Available values for summary period are none, minute, hour, day, week, month. Not valid for Usage Efficiency or Raw reports.
–jpeg [<width> <height>]	Request graphical report output in JPEG/HTML format. Optionally, set the dimensions of the JPEG images in pixels. Default: 600 x 600.
–license_server	Specify a license server name. This results in a report that uses report log data from the specified license server(s). If this parameter is not used, the report is run using report log data from all available license servers. To specify multiple license servers, use the parameter multiple times—for example: –license_server ls1 –license_server ls2
–linewidth <width>	Set the thickness of lines in the graph in pixels. Affects both data and axes. Default: 1.
–no_auto_reduce	Used to circumvent automatic data reduction on Usage Over Time and High Water Mark graphs. Not recommended.
–orderby <category>	Sort categories are f (feature) and b (breakdown). More than one sort category can be specified at a time. For example, -orderby fb sorts first by feature, then by breakdown category.
–output <output_filename_base>	Specify the output file name, without a file extension. Required for Text, HTML, RIF, JPEG/HTML, and PNG/HTML output.
–output_dir <directory>	Specify the output directory. Required.
–password <password>	Specify the password to use. Required.
–periodic	Calculate Summary Barchart or Usage Summary for time periods. Use in conjunction with -interval period.
–png [<width> <height>]	Request graphical report output in PNG/HTML format. Optionally, set the dimensions of the PNG images in pixels. Default: 600 x 600.
–rif	Request report output in Report Interchange Format (RIF).
–showzero	Include entries for features with no usage. This parameter is available for Usage Over Time, High Water Mark, and Usage Summary reports.
–startdate <date>	Set the beginning date for report output.
–text	Request report output in plain text format.
–textcolor <color>	Set the text color of a the axes, labels, title, and legend of a graphical report. Select from: white, black, red, green, blue, cyan, magenta, yellow. Default: black. Specify colors in hexadecimal RGB format. See Customizing Appearance of Graphical Report Output
–timeval_seconds	Show time value in RIF files as UNIX seconds since 00:00:00 January 1, 1970 GMT. This parameter is available for Raw, Usage Efficiency, and Usage Over Time reports.
–title <title>	Set the title on a graphical report.
–user <user>	Specify the user name. Required.
–vendor_daemon	Specify a vendor daemon name. This results in a report that uses report log data from the specified vendor daemon(s). If this parameter is not used, the report is run using report log data from all available vendor daemons. To specify multiple vendor daemons, use the parameter multiple times—for example: –vendor_daemon vd1 –vendor_daemon vd2
–xml	Request report output in XML document.

Some parameters are specific to particular report types. See {Hyperlink}Figure {Default ¹ Font} for more details.

Note:No parameter is shown for Raw reports. If you generate a Raw report from the command line, you can choose which fields to display. See Raw Report Fields for information.

Report Type parameters

Report Type Parameter

Description

Calculate Server Coverage data.

Syntax: report Server –coverage

–hwmot [na]

Calculate High Water Mark data. Use the na option to omit displaying in the report the line that shows available licenses.

Syntax: report Summary –hwmot

–pud [na]

Generates Peak Usage and Denial data, showing the number of peak usage licenses within a specified summary period, and the number or denials - if any - within the same period. Use the na option to omit displaying in the report the line that shows available licenses.

Syntax: report Summary –pud

–uot [na] [pct]

Calculate Usage Over Time or High Water Mark data.

•

Use the na option to omit displaying in the report the line that shows available licenses.

•

Use the pct option to display usage in percentages of available licenses instead of count.