Synopsis

fcli fod mast-scan setup [--skip-if-exists] --assessment-type=<assessmentType> [--audit-preference=<auditPreferenceType>] [--delim=<delimiter>] [--entitlement-id=<entitlementId>] [--framework=<mobileFramework>] --frequency=<entitlementFrequencyType> [--platform=<mobilePlatform>] [--progress=<type>] --rel=id|app[:ms]:rel [--timezone=<timezone>] [[-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

Options

--assessment-type=<assessmentType>

The assessment type to use, this can be the Id or the Name. Use 'fod release lsat' to find valid values.

--audit-preference=<auditPreferenceType>

Audit preference, e.g. Manual or Automated. Note: Automated is only applicable to Mobile Assessments. Default value: Automated.

--delim=<delimiter>

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

--entitlement-id=<entitlementId>

Entitlement Id to use. If not specified Frequency and Assessment Type will be used to find one.

--framework=<mobileFramework>

The Mobile Framework to use. Valid values: iOS, Android. Default value: Android.

--frequency, --entitlement-frequency=<entitlementFrequencyType>

The entitlement frequency type to use. Valid values: SingleScan, Subscription.

--platform=<mobilePlatform>

The Mobile Platform to use. Valid values: Phone, Tablet, Both. Default value: Phone.

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

--skip-if-exists

Skip setup if a scan has already been set up. If not specified, any existing scan setup will be replaced based on the given setup options.

--timezone=<timezone>

The timezone to use for starting the scan. Use 'fod rest lookup TimeZones' to see the values. Default value: UTC.

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.