Synopsis
fcli sc-sast scan start [--[no-]upload] [--appversion=<appVersionNameOrId>] [--delim=<delimiter>] [--notify=<email>] [--ssc-ci-token=<ciToken>] [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] [--session=<sessionName>] (-m=<mbsFile> | (-v=<sensorVersion> -p=<packageFile>)) ] [--store=_variableName _ ] [--output-to-file=<outputFile>_]]
Options
- --notify=<email>
-
Email address to which to send a scan completion notification
- --delim=<delimiter>
-
Change the default delimiter character when using options that accepts "application:version" as an argument or parameter.
- --appversion=<appVersionNameOrId>
-
Application version id or <application>:<version> name.
- --[no-]upload
-
By default, scan results will be automatically uploaded to SSC, unless the --no-upload option is provided
- --ssc-ci-token=<ciToken>
-
SSC CIToken in either encoded or decoded format
Environment variables:
FCLI_DEFAULT_SSC_CI_TOKEN: Shared with SSC/SC DAST
FCLI_DEFAULT_SC_SAST_SSC_CI_TOKEN: Only SC SAST commands
Options for scanning a package file:
- -v, --sensor-version=<sensorVersion>
-
Version of the sensor on which the package should be scanned. Officially, you should select the same sensor version as the version of the ScanCentral Client used to create the package.
- -p, --package-file=<packageFile>
-
Package file to scan
Output options:
- -o, --output=format[=<options>]
-
Output format: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'json-properties' format ignores any options. The 'expr' output format takes a string containing '{<propertyPath>}' placeholders, other output formats take an optional, comma-separated list of property paths. Use '-o json-properties' on the current command to see available '<prop>' values.
- --store=variableName[=<propertyNames>]
-
Store the JSON results of this command in a variable. Variables can be managed through the 'fcli config variable' command, and can be referenced using {?variableName:property} on any subsequent command. Most commands that return a single record (get, start, create, …) also support '?' to store the record identifier in a predefined variable, which can later be referenced using '?' on options/parameters that take the id of such records as input.
- --output-to-file=<outputFile>
-
Write results to the specified files in the given output format. By default, results will be written to stdout
Generic fcli options:
- -h, --help
-
Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.
- --env-prefix=<envPrefix>
-
Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.
- --log-file=<logFile>
-
File where logging data will be written. If not specified, no logging data will be written.
- --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