oracle.oci.oci_database_software_image – Manage a DatabaseSoftwareImage resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a DatabaseSoftwareImage resource in Oracle Cloud Infrastructure

  • For state=present, create database software image in the specified compartment.

  • This resource has the following action operations in the oracle.oci.oci_database_software_image_actions module: change_compartment.

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
  • security_token
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 OCID of the compartment the database software image belongs in.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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_software_image_id
string
The DB system OCID.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
database_software_image_one_off_patches
list / elements=string
List of one-off patches for Database Homes.
database_version
string
The database version with which the database software image is to be built.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
This parameter is updatable.
display_name
string
The user-friendly name for the database software image. The name does not have to be unique.
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
This parameter is updatable.
image_shape_family
string
    Choices:
  • VM_BM_SHAPE
  • EXADATA_SHAPE
  • EXACC_SHAPE
To what shape the image is meant for.
image_type
string
    Choices:
  • GRID_IMAGE
  • DATABASE_IMAGE
The type of software image. Can be grid or database.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
ls_inventory
string
The output from the OPatch lsInventory command, which is passed as a string.
patch_set
string
The PSU or PBP or Release Updates. To get a list of supported versions, use the ListDbVersions operation.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
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.
source_db_home_id
string
The OCID of the Database Home.
state
string
    Choices:
  • present ←
  • absent
The state of the DatabaseSoftwareImage.
Use state=present to create or update a DatabaseSoftwareImage.
Use state=absent to delete a DatabaseSoftwareImage.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create database_software_image
  oci_database_software_image:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    database_version: database_version_example
    image_shape_family: VM_BM_SHAPE
    image_type: GRID_IMAGE
    patch_set: patch_set_example
    database_software_image_one_off_patches: [ "database_software_image_one_off_patches_example" ]
    ls_inventory: ls_inventory_example
    source_db_home_id: "ocid1.sourcedbhome.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update database_software_image
  oci_database_software_image:
    # required
    database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update database_software_image using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_database_software_image:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete database_software_image
  oci_database_software_image:
    # required
    database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete database_software_image using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_database_software_image:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

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

Key Returned Description
database_software_image
complex
on success
Details of the DatabaseSoftwareImage resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'database_software_image_included_patches': [], 'database_software_image_one_off_patches': [], 'database_version': 'database_version_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'image_shape_family': 'VM_BM_SHAPE', 'image_type': 'GRID_IMAGE', 'included_patches_summary': 'included_patches_summary_example', 'is_upgrade_supported': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'PROVISIONING', 'ls_inventory': 'ls_inventory_example', 'patch_set': 'patch_set_example', 'time_created': '2013-10-20T19:20:30+01:00'}
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
database_software_image_included_patches
list / elements=string
on success
List of one-off patches for Database Homes.
 
database_software_image_one_off_patches
list / elements=string
on success
List of one-off patches for Database Homes.
 
database_version
string
on success
The database version with which the database software image is to be built.

Sample:
database_version_example
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
The user-friendly name for the database software image. The name does not have to be unique.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the database software image.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
image_shape_family
string
on success
To what shape the image is meant for.

Sample:
VM_BM_SHAPE
 
image_type
string
on success
The type of software image. Can be grid or database.

Sample:
GRID_IMAGE
 
included_patches_summary
string
on success
The patches included in the image and the version of the image.

Sample:
included_patches_summary_example
 
is_upgrade_supported
boolean
on success
True if this Database software image is supported for Upgrade.

Sample:
True
 
lifecycle_details
string
on success
Detailed message for the lifecycle state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the database software image.

Sample:
PROVISIONING
 
ls_inventory
string
on success
The output from the OPatch lsInventory command, which is passed as a string.

Sample:
ls_inventory_example
 
patch_set
string
on success
The PSU or PBP or Release Updates. To get a list of supported versions, use the ListDbVersions operation.

Sample:
patch_set_example
 
time_created
string
on success
The date and time the database software image was created.

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


Authors

  • Oracle (@oracle)