list-crypto-assessment-tde-objects

Description

Lists TDE object encryption summaries across targets in a compartment. Use assessmentId to narrow results to one crypto assessment, and objectType to return either tablespace-level or column-level TDE observations.

Usage

oci data-safe crypto-assessment list-crypto-assessment-tde-objects [OPTIONS]

Required Parameters

--compartment-id, -c [text]

A filter to return only resources that match the specified compartment OCID.

--object-type [text]

A required filter to return only TDE objects of the specified type.

Accepted values are:

COLUMN, TABLESPACE

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.

--assessment-id [text]

A filter to return only resources associated with the specified crypto assessment OCID.

--assessment-type [text]

A filter to return targets from assessments of the specified type.

Accepted values are:

LATEST, SAVED

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

--encryption-observed [text]

Filters TDE object summary rows by any of the specified observed encryption algorithms.

--encryption-status [text]

Filters TDE object summary rows by derived encryption status. NOT_SUPPORTED maps to rows where encryptionObserved is NOT_SUPPORTED, UNENCRYPTED maps to rows where encryptionObserved is null or NONE, and ENCRYPTED maps to rows where the observed encryption algorithm is any other value.

Accepted values are:

ENCRYPTED, NOT_SUPPORTED, UNENCRYPTED

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

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

--quantum-readiness [text]

Filters TDE object summary rows by quantum-readiness category.

Accepted values are:

NOT_APPLICABLE, NOT_AVAILABLE, NOT_RESISTANT, NOT_SUPPORTED, RESISTANT

--sort-by [text]

The field used to sort TDE object summary results.

Accepted values are:

columnName, quantumReadiness, tablespaceName

--sort-order [text]

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

Accepted values are:

ASC, DESC

--target-id [text]

A filter to return only inventory rows associated with the specified target OCID.

--target-ids [text]

A filter to return only resources associated with any of the specified target OCIDs.

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --connection-timeout, --debug, --defaults-file, --enable-dual-stack, --enable-propagation, --endpoint, --federation-endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --proxy, --query, --raw-output, --read-timeout, --realm-specific-endpoint, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

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/crypto-assessment/list-crypto-assessment-tde-objects.html#cmdoption-compartment-id
    export object_type=<substitute-value-of-object_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-safe/crypto-assessment/list-crypto-assessment-tde-objects.html#cmdoption-object-type

    oci data-safe crypto-assessment list-crypto-assessment-tde-objects --compartment-id $compartment_id --object-type $object_type