Synopsis

fcli fod dast-scan start [--validate-entitlement] [--delim=<delimiter>] [--in-progress=<inProgressScanActionType>] [--max-attempts=<maxAttempts>] [--progress=<type>] --rel=id|app[:ms]:rel [--wait-interval=<waitInterval>] [[-h] [--env-prefix=<prefix>] [--log-file=<logFile>] [--log-level=<logLevel>] [--log-mask=<level>] [--debug]] [[--fod-session=<sessionName>]] [[-o=<type+args>] [--style*=<style>,…​]…​ ] [--to-file=<outputFile>_]]

Description

This command is intended for DAST Automated scanning. Please note: DAST Automated scanning is still in technical preview and therefore, command name, options and behavior may change at any time, even between patch or minor releases, potentially affecting any workflows in which this command is being used. The scan will need to have been previously setup using the FoD UI or one of the 'fod dast-scan setup-xxx' commands.

Options

--delim=<delimiter>

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

--in-progress, --in-progress-action=<inProgressScanActionType>

The action to use if a scan is already in progress. Valid values: DoNotStartScan, CancelScanInProgress, Queue.

--max-attempts=<maxAttempts>

Maximum number of status checks before giving up. Default is 30.

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

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

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

--validate-entitlement

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

--wait-interval=<waitInterval>

Interval (in seconds) between status checks. Default is 10 seconds.

FoD session name options

--fod-session=<sessionName>

Name of the FoD 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.