Synopsis

fcli config proxy add [-p[=<proxyPassword>]] [--name=<name>] [--priority=<priority>] [-u=<proxyUser>] [-m=<modules>[, <modules>…​]]…​ [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>] [--log-mask=<logMaskLevel>] [--debug]] ] [--style=<outputStyleElements>_[, <outputStyleElements>…​]]…​ ] [--to-file=<outputFile>_]] [-i=<includedHosts>[,<includedHosts>…​] [-i=<includedHosts>[,<includedHosts>…​]]…​ | -e=<excludedHosts>[,<excludedHosts>…​] [-e=<excludedHosts>[,<excludedHosts>…​]]…​] HOST:PORT

Description

Options

-e, --exclude-hosts=<excludedHosts>[,<excludedHosts>…​]

Comma-separated list of target host names on which not to apply this proxy configuration. Host names may include wildcard characters, like *.myintra.net.

-i, --include-hosts=<includedHosts>[,<includedHosts>…​]

Comma-separated list of target host names on which to apply this proxy configuration. Host names may include wildcard characters, like *.fortifyhosted.net.

-m, --modules=<modules>[,<modules>…​]

Comma-separated list of fcli modules / target systems (fod, sc-dast, sc-sast, ssc, debricked, tool) on which to apply this proxy configuration.

--name=<name>

Name for the proxy configuration to be added; defaults to <proxy host>:<proxy port>.

-p, --password[=<proxyPassword>]

Password used to authenticate with the proxy server.

--priority=<priority>

Priority of this proxy configuration. If multiple configuration match the target module & URL, the proxy configuration with highest priority is used.

-u, --user=<proxyUser>

Username used to authenticate with the proxy server.

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.

Arguments

HOST:PORT

Proxy host and port in the format <proxy host>:<proxy port>.