list-database-configurations

Description

Gets a list of database insight configurations based on the query parameters specified. Either compartmentId or databaseInsightId query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of database insight configurations in that compartment and in all sub-compartments will be returned.

Usage

oci opsi database-insights list-database-configurations [OPTIONS]

Optional Parameters

--all

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

--cdb-name [text]

Filter by one or more cdb name.

--compartment-id, -c [text]

The OCID of the compartment.

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

A flag to search all resources within a given compartment and all sub-compartments.

--database-id [text]

Optional list of database OCIDs of the associated DBaaS entity.

--database-type [text]

Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.

Accepted values are:

ADW-D, ADW-S, ATP-D, ATP-S, COMANAGED-BM-CDB, COMANAGED-BM-NONCDB, COMANAGED-BM-PDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-NONCDB, COMANAGED-EXACS-PDB, COMANAGED-VM-CDB, COMANAGED-VM-NONCDB, COMANAGED-VM-PDB, EXTERNAL-NONCDB, EXTERNAL-PDB
--defined-tag-equals [text]

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”.

--defined-tag-exists [text]

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”.

--em-bridge-id [text]

OPSI Enterprise Manager Bridge OCID

--exadata-insight-id [text]

Optional list of exadata insight resource OCIDs.

--freeform-tag-equals [text]

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”.

--freeform-tag-exists [text]

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”.

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

--host-name [text]

Filter by one or more hostname.

--id [text]

Optional list of database insight resource OCIDs.

--limit [integer]

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

--page [text]

For list pagination. The value of the opc-next-page response header from the previous “List” call. For important 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]

Database configuration list sort options. If fields parameter is selected, the sortBy parameter must be one of the fields specified.

Accepted values are:

databaseDisplayName, databaseName, databaseType
--sort-order [text]

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

Accepted values are:

ASC, DESC
--vmcluster-name [text]

Optional list of Exadata Insight VM cluster name.

Examples

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.

    oci opsi database-insights list-database-configurations