Synopsis

fcli aviator ssc audit [--app=<appName>] --av=<appVersionNameOrId> [--delim=<delimiter>] [--progress=<type>] [--tag-mapping=<tagMapping>] [[-h] [--env-prefix=<prefix>] [--log-file=<logFile>] [--log-level=<logLevel>] [--log-mask=<level>] [--debug]] [[--ssc-session=<sessionName>]] [[-o=<type+args>] [--style*=<style>,…​]…​ ] [--to-file=<outputFile>_]] [[--av-session=<sessionName>]]

Description

Downloads the FPR from an SSC application version, audits it with SAST Aviator, and uploads the result back to SSC. This command requires an active user session. Use 'fcli aviator session login' to create a session. This command doesn’t wait for SSC to finish processing the audited FPR file; please use the 'fcli ssc artifact wait-for' command to wait until the audited FPR file has been processed by SSC.

Options

--app=<appName>

SAST Aviator application name to associate with the audit. If not provided, the SAST/FPR Build ID of the ssc application is used.

--av, --appversion=<appVersionNameOrId>

Application version id or <application>:<version> name.

--delim=<delimiter>

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

--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.

--tag-mapping=<tagMapping>

Custom tag mapping for audit results.

SSC session name options

--ssc-session=<sessionName>

Name of the SSC session to use for executing this command. Default value: default.

Aviator user session name options

--av-session, --aviator-session=<sessionName>

Name of the Aviator user session to use for executing this command. Default value: default.

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.