Synopsis

fcli fod sast-scan setup [--include-third-party-libs] [--oss] [--skip-if-exists] [--use-aviator] [--use-source-control] --assessment-type=<staticAssessmentType> --audit-preference=<auditPreferenceType> [--delim=<delimiter>] [--entitlement-id=<entitlementId>] --frequency=<entitlementFrequencyType> [--language-level=<languageLevel>] [--progress=<type>] --rel=id|app[:ms]:rel [--technology-stack=<technologyStack>] [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>] [--log-mask=<logMaskLevel>] [--debug]] [[--fod-session=<sessionName>]] ] [--style=<outputStyleElements>_[, <outputStyleElements>…​]]…​ ] [--to-file=<outputFile>_]]

Description

To correctly setup a scan you will need to provide the assessment type Id or Name using the '--assessment-type' option. Since assessment types can potentially be configured differently for each tenant, you can find the correct Id and Name using the 'fod release lsat' command. 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. If you do not specify a '--technology-stack' and '--language-level' (if appropriate) the default value of 'AutoDetect' will be used. However, if you wish to specify them you can use the 'fod rest lookup' command to find the values. For example, to list all the technology stacks you can use 'fod rest lookup TechnologyTypes' and then for the language levels (if appropriate) you can use the 'Value' field returned in 'fod rest lookup LanguageLevels'. For example, for Java which is typically value '7', you would use 'fod rest lookup LanguageLevels -q "group=='7'".

Options

--assessment-type=<staticAssessmentType>

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

--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 Entitlement Frequency and Assessment Type will be used to find one.

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

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

--include-third-party-libs

(LEGACY) Indicates if third party libraries should be included.

--language-level=<languageLevel>

The language level of the technology stack (if needed).

--oss

Perform Open Source Analysis scan.

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

--technology-stack=<technologyStack>

The technology stack of the application. Default value: Auto Detect.

--use-aviator

Use Fortify Aviator to audit results and provide enhanced remediation guidance.

--use-source-control

(LEGACY) Indicates if source control should be used.

FoD session name options

--fod-session=<sessionName>

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

Output options

-o, --output=type[=<args>]

Specify output type and optional type arguments. Available output formats: csv, table, expr, json, xml, yaml. 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.

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

--style=<outputStyleElements>[,<outputStyleElements>…​]

Comma-separated list of style elements to apply to the selected output format. Allowed values: header, no-header, pretty, no-pretty, flat, no-flat, array, single, border, no-border, md-border.

--to-file=<outputFile>

Write command output to the specified file instead of stdout.

Generic fcli options

--debug

Enable both fcli trace logging and collection of extra debugging data on applicable fcli actions and commands, for example enabling debug logging on tools invoked through fcli tool run commands, or enabling server-side debug log generation.

--env-prefix=<envPrefix>

Environment variable prefix for resolving default option and parameter values. Default value: 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, NONE.

--log-mask=<logMaskLevel>

Masking level to apply to logging data. Allowed values: high, medium, low, none. Default value: medium. Note that this is on a best-effort basis; you should always check log contents for sensitive data before sharing or publishing logs.