list-checks

Description

Lists all the security checks in the specified compartment for security assessment of type TEMPLATE.

Usage

oci data-safe security-assessment list-checks [OPTIONS]

Required Parameters

--security-assessment-id [text]

The OCID of the security assessment.

Optional Parameters

--access-level [text]

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

Accepted values are:

ACCESSIBLE, RESTRICTED
--all

Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.

--compartment-id-in-subtree [boolean]

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.

--contains-references [text]

An optional filter to return only findings that match the specified references. Use containsReferences param if need to filter by multiple references.

Accepted values are:

CIS, GDPR, STIG
--contains-severity [text]

A filter to return only findings that match the specified risk level(s). Use containsSeverity parameter if need to filter by multiple risk levels.

Accepted values are:

ADVISORY, DEFERRED, EVALUATE, HIGH, LOW, MEDIUM, PASS
--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--key [text]

Each check in security assessment has an associated key (think of key as a check’s name). For a given check, the key will be the same across targets. The user can use these keys to filter the checks.

--limit [integer]

For list pagination. The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

--page [text]

For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

--page-size [integer]

When fetching results, the number of results to fetch per call. Only valid when used with --all or --limit, and ignored otherwise.

--sort-by [text]

The field to sort by. You can specify only one sort order(sortOrder). The default order for title is ascending.

Accepted values are:

category, title
--sort-order [text]

The sort order to use, either ascending (ASC) or descending (DESC).

Accepted values are:

ASC, DESC
--suggested-severity [text]

A filter to return only checks of a particular risk level.

Accepted values are:

ADVISORY, DEFERRED, EVALUATE, HIGH, LOW, MEDIUM, PASS

Example using required parameter

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-safe/security-assessment/create.html#cmdoption-compartment-id

    security_assessment_id=$(oci data-safe security-assessment create --compartment-id $compartment_id --query data.id --raw-output)

    oci data-safe security-assessment list-checks --security-assessment-id $security_assessment_id