Synopsis

fcli fod mast-scan start --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=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] [[--session=<sessionName>]] ] [--store=_variableName[:<propertyNames>]] [--to-file=<outputFile>]]

Description

This command is not fully implemented and is intended for preview only. 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 the 'fod mast-scan setup' command. To correctly start a scan you will need to provide the name of the assessment type using the '--assessment-type=xxx' option. Since assessment types can potentially be configured differently for each tenant, you can find the correct name using the 'fod rest lookup AssessmentTypes' command. The scan will need to have been previously setup using the FoD UI or the 'fod dast-scan setup' command. If you know the Id of an entitlement that you want to use then you can supply it to the '--entitlement-id=xxx' option. If not, you can supply both '--assessment-type' and '--entitlement-frequency' options and the command will try to find an appropriate entitlement.

Options

--assessment-type=<mobileAssessmentType>

The type of MAST assessment to carry out. Use 'fod rest lookup AssessmentTypes' 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.

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

--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 - default is UTC. Use 'fod rest lookup TimeZones' to see the values.

Session options

--session=<sessionName>

Name of the FoD session to use for executing this command. Default value: default.

Output options

-o, --output=format[=<options>]

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

--store=variableName[:<propertyNames>]

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

--to-file=<outputFile>

Write command output to the specified file instead of stdout.

Generic fcli options

--env-prefix=<envPrefix>

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

-h, --help

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

--log-file=<logFile>

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

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