oracle.oci.oci_data_safe_target_database_facts – Fetches details about one or multiple TargetDatabase resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.1.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_data_safe_target_database_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple TargetDatabase resources in Oracle Cloud Infrastructure
Returns the list of registered target databases in Data Safe.
If target_database_id is specified, the details of a single TargetDatabase will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
access_level
string
|
|
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.
|
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 ). |
|
associated_resource_id
string
|
A filter to return the target databases that are associated to the resource id passed in as a parameter value.
|
|
auth_purpose
string
|
|
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
|
|
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
|
A filter to return only resources that match the specified compartment OCID.
Required to list multiple target_databases.
|
|
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.
|
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_type
string
|
|
A filter to return only target databases that match the specified database type.
|
display_name
string
|
A filter to return only resources that match the specified display name.
aliases: name |
|
infrastructure_type
string
|
|
A filter to return only target databases that match the specified infrastructure type.
|
lifecycle_state
string
|
|
A filter to return only target databases that match the specified lifecycle state.
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
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
|
|
The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
|
sort_order
string
|
|
The sort order to use, either ascending (ASC) or descending (DESC).
|
target_database_id
string
|
The OCID of the Data Safe target database.
Required to get a specific target_database.
aliases: id |
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific target_database
oci_data_safe_target_database_facts:
# required
target_database_id: "ocid1.targetdatabase.oc1..xxxxxxEXAMPLExxxxxx"
- name: List target_databases
oci_data_safe_target_database_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
associated_resource_id: "ocid1.associatedresource.oc1..xxxxxxEXAMPLExxxxxx"
target_database_id: "ocid1.targetdatabase.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
lifecycle_state: CREATING
database_type: DATABASE_CLOUD_SERVICE
infrastructure_type: ORACLE_CLOUD
compartment_id_in_subtree: true
access_level: RESTRICTED
sort_order: ASC
sort_by: TIMECREATED
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
target_databases
complex
|
on success |
List of TargetDatabase resources
Sample:
[{'associated_resource_ids': [], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connection_option': {'connection_type': 'PRIVATE_ENDPOINT', 'datasafe_private_endpoint_id': 'ocid1.datasafeprivateendpoint.oc1..xxxxxxEXAMPLExxxxxx', 'on_prem_connector_id': 'ocid1.onpremconnector.oc1..xxxxxxEXAMPLExxxxxx'}, 'credentials': {'password': 'example-password', 'user_name': 'user_name_example'}, 'database_details': {'autonomous_database_id': 'ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx', 'database_type': 'DATABASE_CLOUD_SERVICE', 'db_system_id': 'ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx', 'infrastructure_type': 'ORACLE_CLOUD', 'instance_id': 'ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx', 'ip_addresses': [], 'listener_port': 56, 'service_name': 'service_name_example', 'vm_cluster_id': 'ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx'}, 'database_type': 'DATABASE_CLOUD_SERVICE', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'infrastructure_type': 'ORACLE_CLOUD', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'tls_config': {'certificate_store_type': 'JKS', 'key_store_content': 'key_store_content_example', 'status': 'ENABLED', 'store_password': 'example-password', 'trust_store_content': 'trust_store_content_example'}}]
|
||
associated_resource_ids
list
/ elements=string
|
on success |
The OCIDs of associated resources like database, Data Safe private endpoint etc.
|
||
compartment_id
string
|
on success |
The OCID of the compartment which contains the Data Safe target database.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
connection_option
complex
|
on success |
Returned for get operation
|
||
connection_type
string
|
on success |
The connection type used to connect to the database. Allowed values: - PRIVATE_ENDPOINT - Represents connection through private endpoint in Data Safe. - ONPREM_CONNECTOR - Represents connection through on-premises connector in Data Safe.
Sample:
PRIVATE_ENDPOINT
|
||
datasafe_private_endpoint_id
string
|
on success |
The OCID of the Data Safe private endpoint.
Sample:
ocid1.datasafeprivateendpoint.oc1..xxxxxxEXAMPLExxxxxx
|
||
on_prem_connector_id
string
|
on success |
The OCID of the on-premises connector.
Sample:
ocid1.onpremconnector.oc1..xxxxxxEXAMPLExxxxxx
|
||
credentials
complex
|
on success |
Returned for get operation
|
||
password
string
|
on success |
The password of the database user.
Sample:
example-password
|
||
user_name
string
|
on success |
The database user name.
Sample:
user_name_example
|
||
database_details
complex
|
on success |
Returned for get operation
|
||
autonomous_database_id
string
|
on success |
The OCID of the Autonomous Database registered as a target database in Data Safe.
Sample:
ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx
|
||
database_type
string
|
on success |
The database type.
Sample:
DATABASE_CLOUD_SERVICE
|
||
db_system_id
string
|
on success |
The OCID of the cloud database registered as a target database in Data Safe.
Sample:
ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx
|
||
infrastructure_type
string
|
on success |
The infrastructure type the database is running on.
Sample:
ORACLE_CLOUD
|
||
instance_id
string
|
on success |
The OCID of the compute instance on which the database is running.
Sample:
ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx
|
||
ip_addresses
list
/ elements=string
|
on success |
The list of database host IP Addresses. Fully qualified domain names can be used if connectionType is 'ONPREM_CONNECTOR'.
|
||
listener_port
integer
|
on success |
The port number of the database listener.
Sample:
56
|
||
service_name
string
|
on success |
The database service name.
Sample:
service_name_example
|
||
vm_cluster_id
string
|
on success |
The OCID of the VM cluster in which the database is running.
Sample:
ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx
|
||
database_type
string
|
on success |
The database type.
Returned for list operation
Sample:
DATABASE_CLOUD_SERVICE
|
||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags
Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
description
string
|
on success |
The description of the target database in Data Safe.
Sample:
description_example
|
||
display_name
string
|
on success |
The display name of the target database in Data Safe.
Sample:
display_name_example
|
||
freeform_tags
dictionary
|
on success |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags
Example: `{"Department": "Finance"}`
Sample:
{'Department': 'Finance'}
|
||
id
string
|
on success |
The OCID of the Data Safe target database.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
infrastructure_type
string
|
on success |
The infrastructure type the database is running on.
Returned for list operation
Sample:
ORACLE_CLOUD
|
||
lifecycle_details
string
|
on success |
Details about the current state of the target database in Data Safe.
Sample:
lifecycle_details_example
|
||
lifecycle_state
string
|
on success |
The current state of the target database in Data Safe.
Sample:
CREATING
|
||
system_tags
dictionary
|
on success |
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
Returned for get operation
|
||
time_created
string
|
on success |
The date and time of the target database registration and creation in Data Safe.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The date and time of the target database update in Data Safe.
Returned for get operation
Sample:
2013-10-20T19:20:30+01:00
|
||
tls_config
complex
|
on success |
Returned for get operation
|
||
certificate_store_type
string
|
on success |
The format of the certificate store.
Sample:
JKS
|
||
key_store_content
string
|
on success |
Base64 encoded string of key store file content.
Sample:
key_store_content_example
|
||
status
string
|
on success |
Status to represent whether the database connection is TLS enabled or not.
Sample:
ENABLED
|
||
store_password
string
|
on success |
The password to read the trust store and key store files, if they are password protected.
Sample:
example-password
|
||
trust_store_content
string
|
on success |
Base64 encoded string of trust store file content.
Sample:
trust_store_content_example
|
Authors¶
Oracle (@oracle)