oci_db_system_patch_history_entry_facts - Fetches details of one or more DB System Patch History Entries

New in version 2.5.

Synopsis

  • Fetches details of one or more DB System Patch History Entries.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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
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
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
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_type
    Choices:
  • api_key ←
  • instance_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.
config_file_location
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 Default:
DEFAULT
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.
db_system_id
required
Identifier of the DB System whose Patch History Entries needs to be fetched
patch_history_entry_id
Identifier of a Patch History Entry whose details needs to be fetched.
region
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.
tenancy
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

Examples

#Fetch all DB System Patch History Entries
- name: List DB System Patch History Entries
  oci_db_system_patch_history_entry_facts:
    db_system_id: 'ocid1.dbSystem.aaaa'
#Fetch a specific DB System Patch History Entry
- name: List a specific DB System Patch History Entry
  oci_db_system_patch_history_entry_facts:
    db_system_id: 'ocid1.dbSystem.aaaa'
    patch_history_entry_id: 'ocid1.dbpatchhistory.oc1.ad.abu'

Return Values

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

Key Returned Description
db_system_patch_history_entries
complex
 success
Attributes of the DB System Patch History Entry

Sample:
[{'time_ended': '2018-02-24T18:28:52.198000+00:00', 'lifecycle_state': 'SUCCEEDED', 'patch_id': 'ocid1.dbpatch.oc1.iad.xxxxxEXAMPLExxxxx', 'time_started': '2018-02-24T18:25:06.151000+00:00', 'action': 'PRECHECK', 'lifecycle_details': 'Action was successful', 'id': 'ocid1.dbpatchhistory.oc1.iad.xxxxxEXAMPLExxxxx'}]
  time_ended
string
 always
The date and time when the patch action completed.

Sample:
2018-01-29 01:00:00
  lifecycle_state
string
 always
The current state of the action.

Sample:
SUCCEEDED
  patch_id
string
 always
Identifier of the Patch whose history is fetched

Sample:
ocid1.dbpatch.oc1.iad.xxxxxEXAMPLExxxxx
  time_started
string
 always
The date and time when the patch action started.

Sample:
2018-01-29 12:30:00
  action
string
 always
The action being performed or was completed.

Sample:
APPLY
  lifecycle_details
string
 always
A descriptive text associated with the lifecycle_state. Typically can contain additional displayable text.

Sample:
DCS-10001:Internal error encountered
  id
string
 always
Identifier of the DB System Patch History Entry.

Sample:
ocid1.dbpatchhistory.oc1.iad.xxxxxEXAMPLExxxxx


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Debayan Gupta(@debayan_gupta)

Hint

If you notice any issues in this documentation you can edit this document to improve it.