Synopsis
fcli sc-dast scan wait-for [--no-progress] [-i=<intervalPeriod>] [--on-failure-state=<onFailureState>] [--on-timeout=<onTimeout>] [--on-unknown-state=<onUnknownState>] [--on-unknown-state-requested=<onUnknownStateRequeste _ d>_] [-t=<timeoutPeriod>] [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] ] [--store=_variableName[=<propertyNames>]] [--output-to-file=<outputFile>]] [--while-all=<state1>[|<state2>]… | -w=<state1> _ [|<state2>]…_ | -u=<state1>[|<state2>]… | --until-any=<state1>[|<state2>]…] [--session=<sessionName>] scan-id’s…
Description
Although this command offers a lot of options to cover many different use cases, to just wait for completion of a single scan that was started using the "--store '?'" option, you can simply run "fcli sc-dast scan wait-for '?'".
If none of the --while or --until options are specified, this command will by default wait until the scan has completed. If any error state or unknown state is detected, an exception will be thrown.
The following states are currently known by fcli: See fcli help output
Options
- --on-unknown-state-requested=<onUnknownStateRequested>
-
Action to take when an unknown state is passed in any of the --while or --until options: ignore, fail
- --on-failure-state=<onFailureState>
-
Action to take when a failure state is returned for any of the records: wait, terminate, fail
- --on-unknown-state=<onUnknownState>
-
Action to take when an unknown state is returned for any of the records: wait, terminate, fail
- --on-timeout=<onTimeout>
-
Action to take when timeout occurs: terminate, fail
- -i, --interval=<intervalPeriod>
-
Polling interval, for example 5s (5 seconds) or 1m (1 minute)
- -t, --timeout=<timeoutPeriod>
-
Time-out, for example 30s (30 seconds), 5m (5 minutes), 1h (1 hour)
- --while-all=<state1>[|<state2>]…
-
Wait while all records match any of the given states
- -w, --while, --while-any=<state1>[|<state2>]…
-
Wait while any records match any of the given states
- -u, --until, --until-all=<state1>[|<state2>]…
-
Wait until all records match any of the given states
- --until-any=<state1>[|<state2>]…
-
Wait until any of the records match any of the given states
- --no-progress
-
Don’t show progress information
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