Try SpotterFetches details about one or multiple DatabaseUpgradeHistoryEntry resources in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches 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 I(upgrade_history_entry_id) is specified, the details of a single DatabaseUpgradeHistoryEntry will be returned.
- 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
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`). 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
- security_token
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
upgrade_action:
choices:
- PRECHECK
- UPGRADE
- ROLLBACK
description:
- A filter to return only upgradeHistoryEntries that match the specified Upgrade Action.
type: str
lifecycle_state:
choices:
- SUCCEEDED
- FAILED
- IN_PROGRESS
description:
- A filter to return only upgradeHistoryEntries that match the given lifecycle state
exactly.
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
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
upgrade_history_entry_id:
aliases:
- id
description:
- The database/db system upgrade History L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
- Required to get a specific database_upgrade_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
database_upgrade_history_entries:
contains:
action:
description:
- The database upgrade action.
returned: on success
sample: PRECHECK
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the database upgrade history.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
lifecycle_details:
description:
- Additional information about the current lifecycle state.
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- Status of database upgrade history SUCCEEDED|IN_PROGRESS|FAILED.
returned: on success
sample: SUCCEEDED
type: str
options:
description:
- 'Additional upgrade options supported by DBUA(Database Upgrade Assistant).
Example: "-upgradeTimezone false -keepEvents"'
returned: on success
sample: options_example
type: str
source:
description:
- 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 L(database software image,https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/databasesoftwareimage.htm)
to upgrade the database.
returned: on success
sample: DB_HOME
type: str
source_db_home_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Database Home.
returned: on success
sample: ocid1.sourcedbhome.oc1..xxxxxxEXAMPLExxxxxx
type: str
target_database_software_image_id:
description:
- the database software image used for upgrading database.
returned: on success
sample: ocid1.targetdatabasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx
type: str
target_db_home_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Database Home.
returned: on success
sample: ocid1.targetdbhome.oc1..xxxxxxEXAMPLExxxxxx
type: str
target_db_version:
description:
- A valid Oracle Database version. For a list of supported versions, use the
ListDbVersions operation.
- 'This cannot be updated in parallel with any of the following: licenseModel,
dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps,
isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel,
nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled,
or isFreeTier.'
returned: on success
sample: target_db_version_example
type: str
time_ended:
description:
- The date and time when the database upgrade ended.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_started:
description:
- The date and time when the database upgrade started.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- List of DatabaseUpgradeHistoryEntry resources
returned: on success
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'
type: complex