⚠️ Development Version — You are viewing documentation for a development version (dev_feat.v3.x.create-pr-fcli-action). This version may be unstable or incomplete. — View stable version (v3.x)

Synopsis

fcli sc-sast sensor list [--latest-only] [--av=<appVersionNameOrId>] [--delim=<delimiter>] [--pool=<sensorPoolNameOrUuid>] [-q=<SpEL expression>] [[-h] [--env-prefix=<prefix>] [--log-file=<logFile>] [--log-level=<logLevel>] [--log-mask=<level>] [--debug]] [[--ssc-session=<sessionName>]] [[-o=<type+args>] [--style*=<style>,…​]…​ ] [--to-file=<outputFile>_]]

Description

This command lists sensor information for all available ScanCentral SAST sensors. It calls the SSC API and as such requires an active SSC session. Use --pool or --appversion to filter sensors by pool, and --latest-only to show only sensors running the latest compatible ScanCentral Client version. Output always includes full sensor details along with the compatible client version derived from the sensor’s SCA version.

Options

--av, --appversion=<appVersionNameOrId>

Application version id or <application>:<version> name.

--delim=<delimiter>

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

--latest-only

Show only sensors running the latest compatible client version.

--pool, --sensor-pool=<sensorPoolNameOrUuid>

Sensor pool Uuid or Name.

-q, --query=<SpEL expression>

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

SSC session name options

--ssc-session=<sessionName>

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

-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, wrap, no-wrap, fast-output, no-fast-output, envelope, no-envelope.

--to-file=<outputFile>

Write output to the specified file.

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