list

Description

Obtain a list of Database Infrastructures.

Usage

oci datacc infrastructure list [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The OCID of the compartment. For list operations, you may provide the tenant OCID in this field. When a tenant OCID is provided, it will be validated against the caller’s tenant and then treated as tenant scope (compartmentId filtering is not applied).

Optional Parameters

--all

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

--display-name [text]

A filter to return resources that match the entire display name given. The match is case sensitive.

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

--lifecycle-state [text]

A filter to return resources that match the specified lifecycle state.

Accepted values are:

ACTIVATING, ACTIVATION_FAILED, ACTIVE, CREATING, DELETED, DELETING, DISCONNECTED, FAILED, MAINTENANCE_IN_PROGRESS, REQUIRES_ACTIVATION, REQUIRES_VALIDATION, UPDATING, VALIDATING, VALIDATION_FAILED
--limit [integer]

The maximum number of items to return in a page.

--page [text]

The page token representing the page at which you want to start retrieving results. This token is usually retrieved from a previous list call.

--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 by which you want to sort. You can provide only one type of sort order. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. When listing software images within the same version, using sortBy=buildIdentifier is recommended. buildIdentifier is a monotonically increasing, time-ordered string marker (yyyy-mm-dd-hh:mm:ss) stored with the image.

Accepted values are:

buildIdentifier, displayName, timeCreated
--sort-order [text]

The sort order that you want to use, which is either ASC or DESC.

Accepted values are:

ASC, DESC

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/datacc/infrastructure/list.html#cmdoption-compartment-id

    oci datacc infrastructure list --compartment-id $compartment_id