oracle.oci.oci_database_db_home – Manage a DbHome resource 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_db_home.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates a new Database Home in the specified database system based on the request parameters you provide. Applies to bare metal DB systems, Exadata systems, and Exadata Cloud@Customer systems.

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.
compartment_id
string
The compartment OCID.
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
dictionary
Required when source is one of ['VM_CLUSTER_BACKUP', 'DATABASE', 'DB_BACKUP']
admin_password
string / required
A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.
backup_id
string
The backup OCID.
Required when source is one of ['VM_CLUSTER_BACKUP', 'DB_BACKUP']
backup_tde_password
string
The password to open the TDE wallet.
Applicable when source is one of ['VM_CLUSTER_BACKUP', 'DATABASE', 'DB_BACKUP']
character_set
string
The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
Applicable when source is one of ['VM_CLUSTER_NEW', 'NONE']
database_id
string
The database OCID.
Required when source is 'DATABASE'
database_software_image_id
string
The database software image OCID
Applicable when source is one of ['VM_CLUSTER_NEW', 'NONE']
db_backup_config
dictionary
Applicable when source is one of ['VM_CLUSTER_NEW', 'NONE']
auto_backup_enabled
boolean
    Choices:
  • no
  • yes
If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
Applicable when source is 'NONE'
auto_backup_window
string
    Choices:
  • SLOT_ONE
  • SLOT_TWO
  • SLOT_THREE
  • SLOT_FOUR
  • SLOT_FIVE
  • SLOT_SIX
  • SLOT_SEVEN
  • SLOT_EIGHT
  • SLOT_NINE
  • SLOT_TEN
  • SLOT_ELEVEN
  • SLOT_TWELVE
Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive).
Example: `SLOT_TWO`
Applicable when source is 'NONE'
backup_destination_details
list / elements=dictionary
Backup destination details.
Applicable when source is 'NONE'
id
string
The OCID of the backup destination.
Applicable when source is 'NONE'
internet_proxy
string
Proxy URL to connect to object store.
Applicable when source is 'NONE'
type
string / required
    Choices:
  • NFS
  • RECOVERY_APPLIANCE
  • OBJECT_STORE
  • LOCAL
Type of the database backup destination.
Required when source is 'NONE'
vpc_password
string
For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
Applicable when source is 'NONE'
vpc_user
string
For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
Applicable when source is 'NONE'
recovery_window_in_days
integer
Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
Applicable when source is 'NONE'
db_name
string
The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
Required when source is one of ['VM_CLUSTER_NEW', 'NONE']
db_unique_name
string
The `DB_UNIQUE_NAME` of the Oracle Database being backed up.
db_workload
string
    Choices:
  • OLTP
  • DSS
The database workload type.
Applicable when source is one of ['VM_CLUSTER_NEW', 'NONE']
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Applicable when source is one of ['VM_CLUSTER_NEW', 'NONE']
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"}`
Applicable when source is one of ['VM_CLUSTER_NEW', 'NONE']
kms_key_id
string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
Applicable when source is one of ['VM_CLUSTER_NEW', 'NONE']
kms_key_version_id
string
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.
Applicable when source is one of ['VM_CLUSTER_NEW', 'NONE']
ncharacter_set
string
The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
Applicable when source is one of ['VM_CLUSTER_NEW', 'NONE']
pdb_name
string
The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
Applicable when source is one of ['VM_CLUSTER_NEW', 'NONE']
sid_prefix
string
Specifies a prefix for the `Oracle SID` of the database to be created.
Applicable when source is one of ['VM_CLUSTER_BACKUP', 'VM_CLUSTER_NEW', 'NONE', 'DB_BACKUP']
tde_wallet_password
string
The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.
Applicable when source is one of ['VM_CLUSTER_NEW', 'NONE']
time_stamp_for_point_in_time_recovery
string
The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.
Applicable when source is 'DATABASE'
vault_id
string
The OCID of the Oracle Cloud Infrastructure vault.
Applicable when source is one of ['VM_CLUSTER_NEW', 'NONE']
database_software_image_id
string
The database software image OCID
db_home_id
string
The Database Home 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
db_system_id
string
The OCID of the DB system.
Required when source is one of ['DATABASE', 'NONE', 'DB_BACKUP']
db_version
string
A valid Oracle Database version. To get a list of supported versions, use the ListDbVersions operation.
Applicable when source is one of ['VM_CLUSTER_NEW', 'NONE']
display_name
string
The user-provided name of the Database Home.
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is 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.
is_desupported_version
boolean
    Choices:
  • no
  • yes
If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.
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.
kms_key_id
string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kms_key_version_id
string
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.
one_off_patches
list / elements=string
List of one-off patches for Database Homes.
This parameter is updatable.
patch_details
dictionary
This parameter is updatable.
action
string
    Choices:
  • APPLY
  • PRECHECK
The action to perform on the patch.
This parameter is updatable.
database_software_image_id
string
The OCID of the database software image.
This parameter is updatable.
patch_id
string
The OCID of the patch.
This parameter is updatable.
perform_final_backup
boolean
    Choices:
  • no
  • yes
Whether to perform a final backup of the database or not. Default is false.
If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
This parameter is used in multiple APIs. Refer to the API description for details on how the operation uses it.
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
string
    Choices:
  • DATABASE
  • DB_BACKUP
  • VM_CLUSTER_BACKUP
  • NONE ←
  • VM_CLUSTER_NEW
The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup.
state
string
    Choices:
  • present ←
  • absent
The state of the DbHome.
Use state=present to create or update a DbHome.
Use state=absent to delete a DbHome.
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
vm_cluster_id
string
The OCID of the VM cluster.
Required when source is one of ['VM_CLUSTER_BACKUP', 'VM_CLUSTER_NEW']
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 db_home with source = DATABASE
  oci_database_db_home:
    # required
    db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
    source: DATABASE
    database:
      # required
      admin_password: example-password

      # optional
      database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
      time_stamp_for_point_in_time_recovery: time_stamp_for_point_in_time_recovery_example
      backup_id: "ocid1.backup.oc1..xxxxxxEXAMPLExxxxxx"
      backup_tde_password: example-password
      db_name: db_name_example
      db_unique_name: db_unique_name_example
      database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
      pdb_name: pdb_name_example
      tde_wallet_password: example-password
      character_set: character_set_example
      ncharacter_set: ncharacter_set_example
      db_workload: OLTP
      db_backup_config:
        # optional
        auto_backup_enabled: true
        recovery_window_in_days: 56
        auto_backup_window: SLOT_ONE
        backup_destination_details:
        - # required
          type: NFS

          # optional
          id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
          vpc_user: vpc_user_example
          vpc_password: example-password
          internet_proxy: internet_proxy_example
      freeform_tags: {'Department': 'Finance'}
      defined_tags: {'Operations': {'CostCenter': 'US'}}
      kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
      kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
      vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
      sid_prefix: sid_prefix_example

    # optional
    display_name: display_name_example
    kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
    kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
    database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
    is_desupported_version: true

- name: Create db_home with source = DB_BACKUP
  oci_database_db_home:
    # required
    db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
    source: DB_BACKUP
    database:
      # required
      admin_password: example-password

      # optional
      database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
      time_stamp_for_point_in_time_recovery: time_stamp_for_point_in_time_recovery_example
      backup_id: "ocid1.backup.oc1..xxxxxxEXAMPLExxxxxx"
      backup_tde_password: example-password
      db_name: db_name_example
      db_unique_name: db_unique_name_example
      database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
      pdb_name: pdb_name_example
      tde_wallet_password: example-password
      character_set: character_set_example
      ncharacter_set: ncharacter_set_example
      db_workload: OLTP
      db_backup_config:
        # optional
        auto_backup_enabled: true
        recovery_window_in_days: 56
        auto_backup_window: SLOT_ONE
        backup_destination_details:
        - # required
          type: NFS

          # optional
          id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
          vpc_user: vpc_user_example
          vpc_password: example-password
          internet_proxy: internet_proxy_example
      freeform_tags: {'Department': 'Finance'}
      defined_tags: {'Operations': {'CostCenter': 'US'}}
      kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
      kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
      vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
      sid_prefix: sid_prefix_example

    # optional
    display_name: display_name_example
    kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
    kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
    database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
    is_desupported_version: true

- name: Create db_home with source = VM_CLUSTER_BACKUP
  oci_database_db_home:
    # required
    source: VM_CLUSTER_BACKUP
    vm_cluster_id: "ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx"
    database:
      # required
      admin_password: example-password

      # optional
      database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
      time_stamp_for_point_in_time_recovery: time_stamp_for_point_in_time_recovery_example
      backup_id: "ocid1.backup.oc1..xxxxxxEXAMPLExxxxxx"
      backup_tde_password: example-password
      db_name: db_name_example
      db_unique_name: db_unique_name_example
      database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
      pdb_name: pdb_name_example
      tde_wallet_password: example-password
      character_set: character_set_example
      ncharacter_set: ncharacter_set_example
      db_workload: OLTP
      db_backup_config:
        # optional
        auto_backup_enabled: true
        recovery_window_in_days: 56
        auto_backup_window: SLOT_ONE
        backup_destination_details:
        - # required
          type: NFS

          # optional
          id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
          vpc_user: vpc_user_example
          vpc_password: example-password
          internet_proxy: internet_proxy_example
      freeform_tags: {'Department': 'Finance'}
      defined_tags: {'Operations': {'CostCenter': 'US'}}
      kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
      kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
      vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
      sid_prefix: sid_prefix_example

    # optional
    display_name: display_name_example
    kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
    kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
    database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
    is_desupported_version: true

- name: Create db_home with source = NONE
  oci_database_db_home:
    # required
    db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
    kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
    database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
    source: NONE
    is_desupported_version: true
    db_version: db_version_example
    database:
      # required
      admin_password: example-password

      # optional
      database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
      time_stamp_for_point_in_time_recovery: time_stamp_for_point_in_time_recovery_example
      backup_id: "ocid1.backup.oc1..xxxxxxEXAMPLExxxxxx"
      backup_tde_password: example-password
      db_name: db_name_example
      db_unique_name: db_unique_name_example
      database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
      pdb_name: pdb_name_example
      tde_wallet_password: example-password
      character_set: character_set_example
      ncharacter_set: ncharacter_set_example
      db_workload: OLTP
      db_backup_config:
        # optional
        auto_backup_enabled: true
        recovery_window_in_days: 56
        auto_backup_window: SLOT_ONE
        backup_destination_details:
        - # required
          type: NFS

          # optional
          id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
          vpc_user: vpc_user_example
          vpc_password: example-password
          internet_proxy: internet_proxy_example
      freeform_tags: {'Department': 'Finance'}
      defined_tags: {'Operations': {'CostCenter': 'US'}}
      kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
      kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
      vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
      sid_prefix: sid_prefix_example

- name: Create db_home with source = VM_CLUSTER_NEW
  oci_database_db_home:
    # required
    source: VM_CLUSTER_NEW
    vm_cluster_id: "ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
    kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
    database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
    is_desupported_version: true
    db_version: db_version_example
    database:
      # required
      admin_password: example-password

      # optional
      database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
      time_stamp_for_point_in_time_recovery: time_stamp_for_point_in_time_recovery_example
      backup_id: "ocid1.backup.oc1..xxxxxxEXAMPLExxxxxx"
      backup_tde_password: example-password
      db_name: db_name_example
      db_unique_name: db_unique_name_example
      database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
      pdb_name: pdb_name_example
      tde_wallet_password: example-password
      character_set: character_set_example
      ncharacter_set: ncharacter_set_example
      db_workload: OLTP
      db_backup_config:
        # optional
        auto_backup_enabled: true
        recovery_window_in_days: 56
        auto_backup_window: SLOT_ONE
        backup_destination_details:
        - # required
          type: NFS

          # optional
          id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
          vpc_user: vpc_user_example
          vpc_password: example-password
          internet_proxy: internet_proxy_example
      freeform_tags: {'Department': 'Finance'}
      defined_tags: {'Operations': {'CostCenter': 'US'}}
      kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
      kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
      vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
      sid_prefix: sid_prefix_example

- name: Update db_home
  oci_database_db_home:
    # required
    db_home_id: "ocid1.dbhome.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    patch_details:
      # optional
      patch_id: "ocid1.patch.oc1..xxxxxxEXAMPLExxxxxx"
      database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
      action: APPLY
    one_off_patches: [ "one_off_patches_example" ]

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

    # optional
    patch_details:
      # optional
      patch_id: "ocid1.patch.oc1..xxxxxxEXAMPLExxxxxx"
      database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
      action: APPLY
    one_off_patches: [ "one_off_patches_example" ]

- name: Delete db_home
  oci_database_db_home:
    # required
    db_home_id: "ocid1.dbhome.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

    # optional
    perform_final_backup: true

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

Return Values

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

Key Returned Description
db_home
complex
on success
Details of the DbHome resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'database_software_image_id': 'ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx', 'db_home_location': 'db_home_location_example', 'db_system_id': 'ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx', 'db_version': 'db_version_example', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx', 'last_patch_history_entry_id': 'ocid1.lastpatchhistoryentry.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'PROVISIONING', 'one_off_patches': [], 'time_created': '2013-10-20T19:20:30+01:00', 'vm_cluster_id': 'ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx'}
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
database_software_image_id
string
on success
The database software image OCID

Sample:
ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx
 
db_home_location
string
on success
The location of the Oracle Database Home.

Sample:
db_home_location_example
 
db_system_id
string
on success
The OCID of the DB system.

Sample:
ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx
 
db_version
string
on success
The Oracle Database version.

Sample:
db_version_example
 
display_name
string
on success
The user-provided name for the Database Home. The name does not need to be unique.

Sample:
display_name_example
 
id
string
on success
The OCID of the Database Home.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
kms_key_id
string
on success
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
 
last_patch_history_entry_id
string
on success
The OCID of the last patch history. This value is updated as soon as a patch operation is started.

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

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the Database Home.

Sample:
PROVISIONING
 
one_off_patches
list / elements=string
on success
List of one-off patches for Database Homes.

 
time_created
string
on success
The date and time the Database Home was created.

Sample:
2013-10-20T19:20:30+01:00
 
vm_cluster_id
string
on success
The OCID of the VM cluster.

Sample:
ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)