oracle / oracle.oci / 4.21.0 / module / oci_database_pdb_conversion_history_entry_facts Fetches details about one or multiple PdbConversionHistoryEntry resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_pdb_conversion_history_entry_facts (4.21.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.21.0
collections: - name: oracle.oci version: 4.21.0
Fetches details about one or multiple PdbConversionHistoryEntry resources in Oracle Cloud Infrastructure
Gets the pluggable database conversion history for a specified database in a bare metal or virtual machine DB system.
If I(pdb_conversion_history_entry_id) is specified, the details of a single PdbConversionHistoryEntry will be returned.
- name: Get a specific pdb_conversion_history_entry oci_database_pdb_conversion_history_entry_facts: # required pdb_conversion_history_entry_id: "ocid1.pdbconversionhistoryentry.oc1..xxxxxxEXAMPLExxxxxx" database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
- name: List pdb_conversion_history_entries oci_database_pdb_conversion_history_entry_facts: # required database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx" # optional pdb_conversion_action: PRECHECK lifecycle_state: SUCCEEDED sort_by: TIMESTARTED sort_order: ASC
region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str sort_by: choices: - TIMESTARTED description: - The field to sort by. You can provide one sort order (`sortOrder`). The default order for `TIMECREATED` is ascending. type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str sort_order: choices: - ASC - DESC description: - The sort order to use, either ascending (`ASC`) or descending (`DESC`). type: str cert_bundle: description: - 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. type: str database_id: description: - The database L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). required: true type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str lifecycle_state: choices: - SUCCEEDED - FAILED - IN_PROGRESS description: - A filter to return only the pluggable database conversion history entries that match the specified lifecycle state. For example, you can use this filter to return only entries in the "failed" lifecycle state. type: str api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - 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. type: str pdb_conversion_action: choices: - PRECHECK - CONVERT - SYNC - SYNC_ROLLBACK description: - A filter to return only the pluggable database conversion history entries that match the specified conversion action. For example, you can use this filter to return only entries for the precheck operation. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str pdb_conversion_history_entry_id: aliases: - id description: - The database conversion history L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). - Required to get a specific pdb_conversion_history_entry. type: str realm_specific_endpoint_template_enabled: description: - 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. type: bool
pdb_conversion_history_entries: contains: action: description: - The operations used to convert a non-container database to a pluggable database. - Use `PRECHECK` to run a pre-check operation on non-container database prior to converting it into a pluggable database. - Use `CONVERT` to convert a non-container database into a pluggable database. - Use `SYNC` if the non-container database was manually converted into a pluggable database using the dbcli command-line utility. Databases may need to be converted manually if the CONVERT action fails when converting a non-container database using the API. - Use `SYNC_ROLLBACK` if the conversion of a non-container database into a pluggable database was manually rolled back using the dbcli command line utility. Conversions may need to be manually rolled back if the CONVERT action fails when converting a non-container database using the API. returned: on success sample: PRECHECK type: str additional_cdb_params: description: - Additional container database parameter. returned: on success sample: additional_cdb_params_example type: str cdb_name: description: - The database name. The name must begin with an alphabetic character and can contain a maximum of 8 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. returned: on success sample: cdb_name_example type: str id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the database conversion history. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str lifecycle_details: description: - Additional information about the current lifecycle state for the conversion operation. returned: on success sample: lifecycle_details_example type: str lifecycle_state: description: - Status of an operation performed during the conversion of a non-container database to a pluggable database. returned: on success sample: SUCCEEDED type: str source_database_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the database. returned: on success sample: ocid1.sourcedatabase.oc1..xxxxxxEXAMPLExxxxxx type: str target: description: - The target container database of the pluggable database created by the database conversion operation. Currently, the database conversion operation only supports creating the pluggable database in a new container database. - Use `NEW_DATABASE` to specify that the pluggable database be created within a new container database in the same database home. returned: on success sample: NEW_DATABASE type: str target_database_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the database. returned: on success sample: ocid1.targetdatabase.oc1..xxxxxxEXAMPLExxxxxx type: str time_ended: description: - The date and time when the database conversion operation ended. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_started: description: - The date and time when the database conversion operation started. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - List of PdbConversionHistoryEntry resources returned: on success sample: - action: PRECHECK additional_cdb_params: additional_cdb_params_example cdb_name: cdb_name_example id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx lifecycle_details: lifecycle_details_example lifecycle_state: SUCCEEDED source_database_id: ocid1.sourcedatabase.oc1..xxxxxxEXAMPLExxxxxx target: NEW_DATABASE target_database_id: ocid1.targetdatabase.oc1..xxxxxxEXAMPLExxxxxx time_ended: '2013-10-20T19:20:30+01:00' time_started: '2013-10-20T19:20:30+01:00' type: complex