Synopsis

fcli license msp-report create [-y] [-c=<configFile>] -e=<reportingEndDate> [--progress=<type>] -s=<reportingStartDate> [[-h] [--env-prefix=<prefix>] [--log-file=<logFile>] [--log-level=<logLevel>] [--log-mask=<level>] [--debug]] (-z=<reportZipName> | -d=<reportDirName>) [[-o=<type+args>] [--style*=<style>,…​]…​ ] [--to-file=<outputFile>_]]

Description

This command generates a 'Managed Service Provider' (MSP) report based on configuration settings defined in a configuration file. A sample configuration file can be generated using the 'fcli license msp-report create-config' command.

The configuration file includes settings for specifying one or more SSC instances from which to load MSP reporting data, and for specifying MSP (contract) information.

The generated report consists of multiple files, written to either a directory or zip-file. The primary output file is 'summary.txt' that contains various statistics, including the number of application and scan entitlements consumed during the reporting period. Various CSV files providing proof, like the number of entitlements consumed per application, what artifacts were processed, and which artifacts contributed to the entitlement consumption, are generated in the details directory of the report.

The generated 'checksums.sha256' file can be used to verify integrity of all generated files, using a command like 'sha256sum -c checksums.sha256'.

This command requires the following SSC application version attributes to be configured in SSC: - MSP_License_Type: Required, Single-Select List, Values: Application, Scan, Demo - MSP_End_Customer_Name - Optional (for demo applications), Single Line Text - MSP_End_Customer_Location - Optional (for demo applications), Single Line Text

Note that all versions within a single application should provide the same values for these attributes.

Options

-c, --config=<configFile>

Configuration file; sample can be generated using the 'create-config' command.

-d, --report-dir=<reportDirName>

Write report output to the given directory.

-e, --end-date=<reportingEndDate>

Reporting period start date. Format: yyyy-MM-dd, for example 2023-03-31.

--progress=<type>

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

-s, --start-date=<reportingStartDate>

Reporting period start date. Format: yyyy-MM-dd, for example 2023-01-01.

-y, --confirm

Confirm delete of existing report output location.

-z, --report-zip=<reportZipName>

Write report output to the given zip-file.

Output options (also see documentation link below)

-o, --output=<type+args>

Select output type (csv, table, expr, json, xml, yaml) and optional type arguments.

--store=<var>[:<prop>]

Store JSON results in an fcli variable for later reference.

*--style*=<style>,…​

Select output style: header, no-header, pretty, no-pretty, flat, no-flat, array, single, border, no-border, md-border.

--to-file=<outputFile>

Write output to the specified file.

Generic fcli options (also see documentation link below)

--debug

Enable collection of debug logs.

--env-prefix=<prefix>

Prefix for resolving default option values. Default value: FCLI_DEFAULT.

-h, --help

Use 'fcli [command] -h' to display help for fcli (sub-)commands.

--log-file=<logFile>

Write log output to file. Default: ./fcli.log if logging is enabled.

--log-level=<logLevel>

Set logging level: TRACE, DEBUG, INFO, WARN, ERROR, NONE.

--log-mask=<level>

Log mask level: high, medium, low, none. Default: medium. Masking is done on a best-effort basis; no guarantee that all sensitive data will be masked.