Synopsis

fcli fod mast-scan start [--validate-entitlement] --assessment-type=<mobileAssessmentType> [--delim=<delimiter>] [--entitlement-id=<entitlementId>] -f=<file> [--framework=<mobileFramework>] --frequency=<entitlementFrequencyType> [--notes=<notes>] [--platform=<mobilePlatform>] [--progress=<type>] --rel=id|app[:ms]:rel [--remediation=<remediationScanPreferenceType>] [--start-date=<startDate>] [--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

This command currently supports scanning of 'Mobile Assessment' type only. To correctly start a scan you will need to provide the Id or Name of the assessment type using the '--assessment-type' option. This will usually be "Mobile Assessment" but since assessment types can potentially be configured differently for each tenant, you can find the correct name using the 'fod release lsat' command for the release. If you know the Id of an entitlement that you want to use then you can supply it to the '--entitlement-id' option. If not, and you supply both the '--assessment-type' and '--entitlement-frequency' options the command will try to find an appropriate entitlement.

Options

--assessment-type=<mobileAssessmentType>

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

--delim=<delimiter>

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

--entitlement-id=<entitlementId>

The Id of the entitlement to use for the scan.

-f, --file=<file>

Absolute path of the mobile application file to upload, for example .apk or .ipa file. See FoD documentation for supported file types and packaging instructions.

--framework=<mobileFramework>

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

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

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

--notes=<notes>

Scan notes.

--platform=<mobilePlatform>

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

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

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

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

--start-date=<startDate>

Date to start the scan (in MM/dd/yyyy HH:mm format).

--timezone=<timezone>

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

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