Synopsis

fcli fod sast-scan start [--validate-entitlement] [--delim=<delimiter>] -f=<file> [--notes=<notes>] --rel=id|app[:ms]:rel [--remediation=<remediationScanPreferenceType>] [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] [[--fod-session=<sessionName>]] ] [--style=<outputStyleElements>_[, <outputStyleElements>…​]]…​ ] [--to-file=<outputFile>_]]

Description

The scan will need to have been previously setup using the FoD UI or the 'fod sast-scan setup' command.

Options

--delim=<delimiter>

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

-f, --file=<file>

Absolute path of the ScanCentral package (.Zip) file to upload.

--notes=<notes>

Scan notes.

--rel, --release=id|app[:ms]:rel

Release id or <application>[:<microservice>]:<release> name.

--remediation, --remediation-preference=<remediationScanPreferenceType>

The remediation preference to use. Valid values: RemediationScanIfAvailable, RemediationScanOnly, NonRemediationScanOnly.

--validate-entitlement

Validate if an entitlement has been set and is still valid.

FoD session name options

--fod-session=<sessionName>

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

Output options

-o, --output=type[=<args>]

Specify output type and optional type arguments. Available output formats: csv, table, expr, json, xml, yaml. 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.

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

--style=<outputStyleElements>[,<outputStyleElements>…​]

Comma-separated list of style elements to apply to the selected output format. Allowed values: header, no-header, pretty, no-pretty, flat, no-flat, array, single, border, no-border, md-border.

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