oracle.oci.oci_database_upgrade_history_entry_facts – Fetches details about one or multiple DatabaseUpgradeHistoryEntry resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Gets the upgrade history for a specified database in a bare metal or virtual machine DB system.

  • If upgrade_history_entry_id is specified, the details of a single DatabaseUpgradeHistoryEntry 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.
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
string / required
The database OCID.
lifecycle_state
string
    Choices:
  • SUCCEEDED
  • FAILED
  • IN_PROGRESS
A filter to return only upgradeHistoryEntries that match the given lifecycle state exactly.
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:
  • TIMESTARTED
The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is ascending.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`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
upgrade_action
string
    Choices:
  • PRECHECK
  • UPGRADE
  • ROLLBACK
A filter to return only upgradeHistoryEntries that match the specified Upgrade Action.
upgrade_history_entry_id
string
The database/db system upgrade History OCID.
Required to get a specific database_upgrade_history_entry.

aliases: id

Examples

- name: Get a specific database_upgrade_history_entry
  oci_database_upgrade_history_entry_facts:
    # required
    upgrade_history_entry_id: "ocid1.upgradehistoryentry.oc1..xxxxxxEXAMPLExxxxxx"
    database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"

- name: List database_upgrade_history_entries
  oci_database_upgrade_history_entry_facts:
    # required
    database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    upgrade_action: PRECHECK
    lifecycle_state: SUCCEEDED
    sort_by: TIMESTARTED
    sort_order: ASC

Return Values

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

Key Returned Description
database_upgrade_history_entries
complex
on success
List of DatabaseUpgradeHistoryEntry resources

Sample:
[{'action': 'PRECHECK', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'SUCCEEDED', 'options': 'options_example', 'source': 'DB_HOME', 'source_db_home_id': 'ocid1.sourcedbhome.oc1..xxxxxxEXAMPLExxxxxx', 'target_database_software_image_id': 'ocid1.targetdatabasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx', 'target_db_home_id': 'ocid1.targetdbhome.oc1..xxxxxxEXAMPLExxxxxx', 'target_db_version': 'target_db_version_example', 'time_ended': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}]
 
action
string
on success
The database upgrade action.

Sample:
PRECHECK
 
id
string
on success
The OCID of the database upgrade history.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
Additional information about the current lifecycle state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
Status of database upgrade history SUCCEEDED|IN_PROGRESS|FAILED.

Sample:
SUCCEEDED
 
options
string
on success
Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents"

Sample:
options_example
 
source
string
on success
The source of the Oracle Database software to be used for the upgrade. - Use `DB_HOME` to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home. - Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database. - Use `DB_SOFTWARE_IMAGE` to specify a database software image to upgrade the database.

Sample:
DB_HOME
 
source_db_home_id
string
on success
The OCID of the Database Home.

Sample:
ocid1.sourcedbhome.oc1..xxxxxxEXAMPLExxxxxx
 
target_database_software_image_id
string
on success
the database software image used for upgrading database.

Sample:
ocid1.targetdatabasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx
 
target_db_home_id
string
on success
The OCID of the Database Home.

Sample:
ocid1.targetdbhome.oc1..xxxxxxEXAMPLExxxxxx
 
target_db_version
string
on success
A valid Oracle Database version. To get a list of supported versions, use the ListDbVersions operation.

Sample:
target_db_version_example
 
time_ended
string
on success
The date and time when the database upgrade ended.

Sample:
2013-10-20T19:20:30+01:00
 
time_started
string
on success
The date and time when the database upgrade started.

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


Authors

  • Oracle (@oracle)