Synopsis

fcli license msp-report create [-y] [-c=<configFile>] -e=<reportingEndDate> [--progress=<type>] -s=<reportingStartDate> [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] (-z=<reportZipName> | -d=<reportDirName>) ] [--store=_variableName[: _ <propertyNames>]] [--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

-o, --output=format[=<options>]

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

--store=variableName[:<propertyNames>]

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

--to-file=<outputFile>

Write command output to the specified file instead of stdout.

Generic fcli options

--env-prefix=<envPrefix>

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

-h, --help

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

--log-file=<logFile>

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

--log-level=<logLevel>

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.