oracle.oci.oci_recovery_protected_database_facts – Fetches details about one or multiple ProtectedDatabase resources in Oracle Cloud Infrastructure¶

Note

This plugin is part of the oracle.oci collection (version 4.14.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_recovery_protected_database_facts.

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

Fetches details about one or multiple ProtectedDatabase resources in Oracle Cloud Infrastructure
Lists the protected databases based on the specified parameters.
If protected_database_id is specified, the details of a single ProtectedDatabase 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
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 compartment OCID. Required to list multiple protected_databases.
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`.
display_name string		A filter to return only resources that match the entire 'displayname' given. aliases: name
lifecycle_state string	Choices: CREATING UPDATING ACTIVE DELETING DELETED FAILED	A filter to return only the resources that match the specified lifecycle state.
protected_database_id string		The protected database OCID. Required to get a specific protected_database. aliases: id
protection_policy_id string		The protection policy OCID.
recovery_service_subnet_id string		The recovery service subnet OCID.
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: timeCreated displayName	The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If you do not specify a value, then TIMECREATED is used as the default sort order. Allowed values are: - TIMECREATED - DISPLAYNAME
sort_order string	Choices: ASC DESC	The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: - ASC - DESC
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 protected_database
  oci_recovery_protected_database_facts:
    # required
    protected_database_id: "ocid1.protecteddatabase.oc1..xxxxxxEXAMPLExxxxxx"

- name: List protected_databases
  oci_recovery_protected_database_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    lifecycle_state: CREATING
    display_name: display_name_example
    protection_policy_id: "ocid1.protectionpolicy.oc1..xxxxxxEXAMPLExxxxxx"
    recovery_service_subnet_id: "ocid1.recoveryservicesubnet.oc1..xxxxxxEXAMPLExxxxxx"
    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
protected_databases complex			on success	List of ProtectedDatabase resources Sample: [{'change_rate': 1.2, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'compression_ratio': 1.2, 'database_id': 'ocid1.database.oc1..xxxxxxEXAMPLExxxxxx', 'database_size': 'XS', 'database_size_in_gbs': 56, 'db_unique_name': 'db_unique_name_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'health': 'PROTECTED', 'health_details': 'health_details_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_read_only_resource': True, 'is_redo_logs_shipped': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'metrics': {'backup_space_estimate_in_gbs': 3.4, 'backup_space_used_in_gbs': 3.4, 'current_retention_period_in_seconds': 3.4, 'db_size_in_gbs': 3.4, 'is_redo_logs_enabled': True, 'retention_period_in_days': 3.4, 'unprotected_window_in_seconds': 3.4}, 'protection_policy_id': 'ocid1.protectionpolicy.oc1..xxxxxxEXAMPLExxxxxx', 'recovery_service_subnets': [{'lifecycle_state': 'CREATING', 'recovery_service_subnet_id': 'ocid1.recoveryservicesubnet.oc1..xxxxxxEXAMPLExxxxxx'}], 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'vpc_user_name': 'vpc_user_name_example'}]
	change_rate float		on success	The percentage of data changes that exist in the database between successive incremental backups. Returned for get operation Sample: 1.2
	compartment_id string		on success	The OCID of the compartment that contains the protected database. Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
	compression_ratio float		on success	The compression ratio of the protected database. The compression ratio represents the ratio of compressed block size to expanded block size. Returned for get operation Sample: 1.2
	database_id string		on success	The OCID of the protected database. Sample: ocid1.database.oc1..xxxxxxEXAMPLExxxxxx
	database_size string		on success	The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB. Sample: XS
	database_size_in_gbs integer		on success	The size of the database in GBs, in gigabytes. Returned for get operation Sample: 56
	db_unique_name string		on success	The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name. Sample: db_unique_name_example
	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"}}`. For more information, see Resource Tags Sample: {'Operations': {'CostCenter': 'US'}}
	display_name string		on success	The protected database name. You can change the displayName. Avoid entering confidential information. Sample: display_name_example
	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'}
	health string		on success	Indicates the protection status of the database. Allowed values are: - HEALTHY - WARNING - ALERT A 'HEALTHY' status indicates that Recovery Service can ensure database recovery to any point in time within the entire recovery window. The potential data loss exposure since the last backup is: - Less than 10 seconds, if Real-time data protection is enabled - Less than 70 minutes if Real-time data protection is disabled A 'WARNING' status indicates that Recovery Service can ensure database recovery within the current recovery window - 1 day. The potential data loss exposure since the last backup is: - Greater than 10 seconds, if Real-time data protection is enabled - Greater than 60 minutes, if if Real-time data protection is disabled An 'ALERT' status indicates that Recovery Service cannot recover the database within the current recovery window. Sample: PROTECTED
	health_details string		on success	A message describing the current health of the protected database. Sample: health_details_example
	id string		on success	The OCID of the protected database. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	is_read_only_resource boolean		on success	Indicates whether the protected database is created by Recovery Service or created manually. Set to <b>TRUE</b> for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to <b>FALSE</b> for a user-defined protected database. Sample: True
	is_redo_logs_shipped boolean		on success	The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. For this to be effective, additional configuration is needed on client side. Returned for get operation Sample: True
	lifecycle_details string		on success	Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state. Sample: lifecycle_details_example
	lifecycle_state string		on success	The current state of the Protected Database. Sample: CREATING
	metrics complex		on success
		backup_space_estimate_in_gbs float	on success	The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database. Sample: 3.4
		backup_space_used_in_gbs float	on success	Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used. Sample: 3.4
		current_retention_period_in_seconds float	on success	Number of seconds backups are currently retained for this database. Sample: 3.4
		db_size_in_gbs float	on success	The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs. Sample: 3.4
		is_redo_logs_enabled boolean	on success	The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. Sample: True
		retention_period_in_days float	on success	The maximum number of days to retain backups for a protected database. Sample: 3.4
		unprotected_window_in_seconds float	on success	This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available. This is the time we received the last backup or last redo-log shipped. Sample: 3.4
	protection_policy_id string		on success	The OCID of the protection policy associated with the protected database. Sample: ocid1.protectionpolicy.oc1..xxxxxxEXAMPLExxxxxx
	recovery_service_subnets complex		on success	List of recovery service subnet resources associated with the protected database.
		lifecycle_state string	on success	The current state of the Recovery Service Subnet. Sample: CREATING
		recovery_service_subnet_id string	on success	Recovery Service Subnet Identifier. Sample: ocid1.recoveryservicesubnet.oc1..xxxxxxEXAMPLExxxxxx
	system_tags dictionary		on success	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. For more information, see Resource Tags
	time_created string		on success	An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z' Sample: 2013-10-20T19:20:30+01:00
	time_updated string		on success	An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z' Sample: 2013-10-20T19:20:30+01:00
	vpc_user_name string		on success	The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service. Sample: vpc_user_name_example

Authors¶

Oracle (@oracle)

oracle.oci.oci_recovery_protected_database_facts – Fetches details about one or multiple ProtectedDatabase resources in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶