oracle.oci.oci_opsi_database_insights_facts – Fetches details about one or multiple DatabaseInsights resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.13.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_opsi_database_insights_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple DatabaseInsights resources in Oracle Cloud Infrastructure

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

  • If database_insight_id is specified, the details of a single DatabaseInsights will be returned.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
The OCID of the compartment.
compartment_id_in_subtree
boolean
    Choices:
  • no
  • yes
A flag to search all resources within a given compartment and all sub-compartments.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
database_id
list / elements=string
Optional list of database OCIDs of the associated DBaaS entity.
database_insight_id
string
Unique database insight identifier
Required to get a specific database_insights.

aliases: id
database_type
list / elements=string
    Choices:
  • ADW-S
  • ATP-S
  • ADW-D
  • ATP-D
  • EXTERNAL-PDB
  • EXTERNAL-NONCDB
  • COMANAGED-VM-CDB
  • COMANAGED-VM-PDB
  • COMANAGED-VM-NONCDB
  • COMANAGED-BM-CDB
  • COMANAGED-BM-PDB
  • COMANAGED-BM-NONCDB
  • COMANAGED-EXACS-CDB
  • COMANAGED-EXACS-PDB
  • COMANAGED-EXACS-NONCDB
Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.
enterprise_manager_bridge_id
string
Unique Enterprise Manager bridge identifier
exadata_insight_id
string
OCID of exadata insight resource.
fields
list / elements=string
    Choices:
  • compartmentId
  • databaseName
  • databaseDisplayName
  • databaseType
  • databaseVersion
  • databaseHostNames
  • freeformTags
  • definedTags
Specifies the fields to return in a database summary response. By default all fields are returned if omitted.
lifecycle_state
list / elements=string
    Choices:
  • CREATING
  • UPDATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
  • NEEDS_ATTENTION
Lifecycle states
opsi_private_endpoint_id
string
Unique Operations Insights PrivateEndpoint identifier
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
sort_by
string
    Choices:
  • databaseName
  • databaseDisplayName
  • databaseType
Database insight list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`DESC`).
status
list / elements=string
    Choices:
  • DISABLED
  • ENABLED
  • TERMINATED
Resource Status
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Examples

- name: Get a specific database_insights
  oci_opsi_database_insights_facts:
    # required
    database_insight_id: "ocid1.databaseinsight.oc1..xxxxxxEXAMPLExxxxxx"

- name: List database_insights
  oci_opsi_database_insights_facts:

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    enterprise_manager_bridge_id: "ocid1.enterprisemanagerbridge.oc1..xxxxxxEXAMPLExxxxxx"
    status: [ "DISABLED" ]
    lifecycle_state: [ "CREATING" ]
    database_type: [ "ADW-S" ]
    database_id: [ "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx" ]
    fields: [ "compartmentId" ]
    sort_order: ASC
    sort_by: databaseName
    exadata_insight_id: "ocid1.exadatainsight.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id_in_subtree: true
    opsi_private_endpoint_id: "ocid1.opsiprivateendpoint.oc1..xxxxxxEXAMPLExxxxxx"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
database_insights
complex
on success
List of DatabaseInsights resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connection_credential_details': {'credential_source_name': 'credential_source_name_example', 'credential_type': 'CREDENTIALS_BY_SOURCE', 'password_secret_id': 'ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx', 'role': 'NORMAL', 'user_name': 'user_name_example'}, 'connection_details': {'host_name': 'host_name_example', 'hosts': [{'host_ip': 'host_ip_example', 'port': 56}], 'port': 56, 'protocol': 'TCP', 'service_name': 'service_name_example'}, 'connector_id': 'ocid1.connector.oc1..xxxxxxEXAMPLExxxxxx', 'credential_details': {'credential_source_name': 'credential_source_name_example', 'credential_type': 'CREDENTIALS_BY_SOURCE', 'password_secret_id': 'ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx', 'role': 'NORMAL', 'user_name': 'user_name_example'}, 'database_connection_status_details': 'database_connection_status_details_example', 'database_display_name': 'database_display_name_example', 'database_host_names': [], 'database_id': 'ocid1.database.oc1..xxxxxxEXAMPLExxxxxx', 'database_name': 'database_name_example', 'database_resource_type': 'database_resource_type_example', 'database_type': 'database_type_example', 'database_version': 'database_version_example', 'db_additional_details': {}, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'enterprise_manager_bridge_id': 'ocid1.enterprisemanagerbridge.oc1..xxxxxxEXAMPLExxxxxx', 'enterprise_manager_entity_display_name': 'enterprise_manager_entity_display_name_example', 'enterprise_manager_entity_identifier': 'enterprise_manager_entity_identifier_example', 'enterprise_manager_entity_name': 'enterprise_manager_entity_name_example', 'enterprise_manager_entity_type': 'enterprise_manager_entity_type_example', 'enterprise_manager_identifier': 'enterprise_manager_identifier_example', 'entity_source': 'AUTONOMOUS_DATABASE', 'exadata_insight_id': 'ocid1.exadatainsight.oc1..xxxxxxEXAMPLExxxxxx', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'management_agent_id': 'ocid1.managementagent.oc1..xxxxxxEXAMPLExxxxxx', 'opsi_private_endpoint_id': 'ocid1.opsiprivateendpoint.oc1..xxxxxxEXAMPLExxxxxx', 'processor_count': 56, 'status': 'DISABLED', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
compartment_id
string
on success
Compartment identifier of the database

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
connection_credential_details
complex
on success
Returned for get operation
   
credential_source_name
string
on success
Credential source name that had been added in Management Agent wallet. This is supplied in the External Database Service.

Sample:
credential_source_name_example
   
credential_type
string
on success
Credential type.

Sample:
CREDENTIALS_BY_SOURCE
   
password_secret_id
string
on success
The secret OCID mapping to the database credentials.

Sample:
ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
   
role
string
on success
database user role.

Sample:
NORMAL
   
user_name
string
on success
database user name.

Sample:
user_name_example
 
connection_details
complex
on success
Returned for get operation
   
host_name
string
on success
Name of the listener host that will be used to create the connect string to the database.

Sample:
host_name_example
   
hosts
complex
on success
List of hosts and port for private endpoint accessed database resource.
     
host_ip
string
on success
Host IP used for connection requests for Cloud DB resource.

Sample:
host_ip_example
     
port
integer
on success
Listener port number used for connection requests for rivate endpoint accessed db resource.

Sample:
56
   
port
integer
on success
Listener port number used for connection requests.

Sample:
56
   
protocol
string
on success
Protocol used for connection requests.

Sample:
TCP
   
service_name
string
on success
Database service name used for connection requests.

Sample:
service_name_example
 
connector_id
string
on success
The OCID of External Database Connector
Returned for get operation

Sample:
ocid1.connector.oc1..xxxxxxEXAMPLExxxxxx
 
credential_details
complex
on success
Returned for get operation
   
credential_source_name
string
on success
Credential source name that had been added in Management Agent wallet. This is supplied in the External Database Service.

Sample:
credential_source_name_example
   
credential_type
string
on success
Credential type.

Sample:
CREDENTIALS_BY_SOURCE
   
password_secret_id
string
on success
The secret OCID mapping to the database credentials.

Sample:
ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
   
role
string
on success
database user role.

Sample:
NORMAL
   
user_name
string
on success
database user name.

Sample:
user_name_example
 
database_connection_status_details
string
on success
A message describing the status of the database connection of this resource. For example, it can be used to provide actionable information about the permission and content validity of the database connection.

Sample:
database_connection_status_details_example
 
database_display_name
string
on success
Display name of database

Sample:
database_display_name_example
 
database_host_names
list / elements=string
on success
The hostnames for the database.
Returned for list operation
 
database_id
string
on success
The OCID of the database.

Sample:
ocid1.database.oc1..xxxxxxEXAMPLExxxxxx
 
database_name
string
on success
Name of database

Sample:
database_name_example
 
database_resource_type
string
on success
OCI database resource type
Returned for get operation

Sample:
database_resource_type_example
 
database_type
string
on success
Operations Insights internal representation of the database type.

Sample:
database_type_example
 
database_version
string
on success
The version of the database.

Sample:
database_version_example
 
db_additional_details
dictionary
on success
Additional details of a database in JSON format. For autonomous databases, this is the AutonomousDatabase object serialized as a JSON string as defined in https://docs.cloud.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/. For EM, pass in null or an empty string. Note that this string needs to be escaped when specified in the curl command.
Returned for get operation
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
enterprise_manager_bridge_id
string
on success
OPSI Enterprise Manager Bridge OCID
Returned for get operation

Sample:
ocid1.enterprisemanagerbridge.oc1..xxxxxxEXAMPLExxxxxx
 
enterprise_manager_entity_display_name
string
on success
Enterprise Manager Entity Display Name
Returned for get operation

Sample:
enterprise_manager_entity_display_name_example
 
enterprise_manager_entity_identifier
string
on success
Enterprise Manager Entity Unique Identifier
Returned for get operation

Sample:
enterprise_manager_entity_identifier_example
 
enterprise_manager_entity_name
string
on success
Enterprise Manager Entity Name
Returned for get operation

Sample:
enterprise_manager_entity_name_example
 
enterprise_manager_entity_type
string
on success
Enterprise Manager Entity Type
Returned for get operation

Sample:
enterprise_manager_entity_type_example
 
enterprise_manager_identifier
string
on success
Enterprise Manager Unique Identifier
Returned for get operation

Sample:
enterprise_manager_identifier_example
 
entity_source
string
on success
Source of the database entity.

Sample:
AUTONOMOUS_DATABASE
 
exadata_insight_id
string
on success
The OCID of the Exadata insight.
Returned for get operation

Sample:
ocid1.exadatainsight.oc1..xxxxxxEXAMPLExxxxxx
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
Database insight identifier

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the database.

Sample:
CREATING
 
management_agent_id
string
on success
The OCID of the Management Agent
Returned for get operation

Sample:
ocid1.managementagent.oc1..xxxxxxEXAMPLExxxxxx
 
opsi_private_endpoint_id
string
on success
The OCID of the OPSI private endpoint
Returned for get operation

Sample:
ocid1.opsiprivateendpoint.oc1..xxxxxxEXAMPLExxxxxx
 
processor_count
integer
on success
Processor count. This is the OCPU count for Autonomous Database and CPU core count for other database types.

Sample:
56
 
status
string
on success
Indicates the status of a database insight in Operations Insights

Sample:
DISABLED
 
system_tags
dictionary
on success
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
 
time_created
string
on success
The time the the database insight was first enabled. An RFC3339 formatted datetime string

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the database insight was updated. An RFC3339 formatted datetime string

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)