Try SpotterManage a DbSystem resource 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.0This module allows the user to create, update and delete a DbSystem resource in Oracle Cloud Infrastructure
For I(state=present), creates a new DB system in the specified compartment and availability domain. The Oracle Database edition that you specify applies to all the databases on that DB system. The selected edition cannot be changed.
An initial database is created on the DB system based on the request parameters you provide and some default options. For detailed information about default options, see L(Bare metal and virtual machine DB system default options.,https://docs.cloud.oracle.com/Content/Database/Tasks/creatingDBsystem.htm#Default)
**Note:** Deprecated for Exadata Cloud Service systems. Use the L(new resource model APIs,https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.
For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See L(Switching an Exadata DB System to the New Resource Model and APIs,https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.
Use the L(CreateCloudExadataInfrastructure,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/CloudExadataInfrastructure/CreateCloudExadataInfrastructure/) and L(CreateCloudVmCluster,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/database/latest/CloudVmCluster/CreateCloudVmCluster/) APIs to provision a new Exadata Cloud Service instance.
This resource has the following action operations in the M(oracle.oci.oci_database_db_system_actions) module: precheck, rollback, update_snapshot_retention_days, upgrade.
- name: Create db_system with source = NONE
oci_database_db_system:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
availability_domain: Uocm:PHX-AD-1
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
hostname: hostname_example
db_home:
# required
database:
# required
admin_password: example-password
# optional
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
kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
db_domain: db_domain_example
db_backup_config:
# optional
auto_backup_enabled: true
recovery_window_in_days: 56
auto_backup_window: SLOT_ONE
auto_full_backup_window: SLOT_ONE
auto_full_backup_day: SUNDAY
run_immediate_full_backup: true
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
dbrs_policy_id: "ocid1.dbrspolicy.oc1..xxxxxxEXAMPLExxxxxx"
backup_deletion_policy: DELETE_IMMEDIATELY
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
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_unique_name: db_unique_name_example
db_name: db_name_example
sid_prefix: sid_prefix_example
pluggable_databases: [ "pluggable_databases_example" ]
# optional
db_version: db_version_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
database_edition: STANDARD_EDITION
cpu_core_count: 56
ssh_public_keys: [ "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz..." ]
shape: shape_example
# optional
fault_domains: [ "fault_domains_example" ]
display_name: display_name_example
backup_subnet_id: "ocid1.backupsubnet.oc1..xxxxxxEXAMPLExxxxxx"
time_zone: time_zone_example
db_system_options:
# optional
storage_management: ASM
storage_volume_performance_mode: BALANCED
sparse_diskgroup: true
domain: domain_example
cluster_name: cluster_name_example
data_storage_percentage: 56
kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
node_count: 56
source: NONE
private_ip: private_ip_example
disk_redundancy: HIGH
data_storage_size_in_gbs: 56
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
nsg_ids: [ "nsg_ids_example" ]
backup_network_nsg_ids: [ "backup_network_nsg_ids_example" ]
license_model: LICENSE_INCLUDED
maintenance_window_details:
# optional
preference: NO_PREFERENCE
patching_mode: ROLLING
is_custom_action_timeout_enabled: true
custom_action_timeout_in_mins: 56
is_monthly_patching_enabled: true
months:
- # required
name: JANUARY
weeks_of_month: [ "weeks_of_month_example" ]
days_of_week:
- # required
name: MONDAY
hours_of_day: [ "hours_of_day_example" ]
lead_time_in_weeks: 56
data_collection_options:
# optional
is_diagnostics_events_enabled: true
is_health_monitoring_enabled: true
is_incident_logs_enabled: true
- name: Create db_system with source = DB_SYSTEM
oci_database_db_system:
# required
source_db_system_id: "ocid1.sourcedbsystem.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
availability_domain: Uocm:PHX-AD-1
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
hostname: hostname_example
source: DB_SYSTEM
db_home:
# required
database:
# required
admin_password: example-password
# optional
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
kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
db_domain: db_domain_example
db_backup_config:
# optional
auto_backup_enabled: true
recovery_window_in_days: 56
auto_backup_window: SLOT_ONE
auto_full_backup_window: SLOT_ONE
auto_full_backup_day: SUNDAY
run_immediate_full_backup: true
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
dbrs_policy_id: "ocid1.dbrspolicy.oc1..xxxxxxEXAMPLExxxxxx"
backup_deletion_policy: DELETE_IMMEDIATELY
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
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_unique_name: db_unique_name_example
db_name: db_name_example
sid_prefix: sid_prefix_example
pluggable_databases: [ "pluggable_databases_example" ]
# optional
db_version: db_version_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
cpu_core_count: 56
ssh_public_keys: [ "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz..." ]
shape: shape_example
# optional
fault_domains: [ "fault_domains_example" ]
display_name: display_name_example
backup_subnet_id: "ocid1.backupsubnet.oc1..xxxxxxEXAMPLExxxxxx"
time_zone: time_zone_example
db_system_options:
# optional
storage_management: ASM
storage_volume_performance_mode: BALANCED
sparse_diskgroup: true
domain: domain_example
cluster_name: cluster_name_example
data_storage_percentage: 56
kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
node_count: 56
private_ip: private_ip_example
data_storage_size_in_gbs: 56
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
nsg_ids: [ "nsg_ids_example" ]
backup_network_nsg_ids: [ "backup_network_nsg_ids_example" ]
license_model: LICENSE_INCLUDED
data_collection_options:
# optional
is_diagnostics_events_enabled: true
is_health_monitoring_enabled: true
is_incident_logs_enabled: true
- name: Create db_system with source = DATABASE
oci_database_db_system:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
availability_domain: Uocm:PHX-AD-1
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
hostname: hostname_example
source: DATABASE
db_home:
# required
database:
# required
admin_password: example-password
# optional
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
kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
db_domain: db_domain_example
db_backup_config:
# optional
auto_backup_enabled: true
recovery_window_in_days: 56
auto_backup_window: SLOT_ONE
auto_full_backup_window: SLOT_ONE
auto_full_backup_day: SUNDAY
run_immediate_full_backup: true
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
dbrs_policy_id: "ocid1.dbrspolicy.oc1..xxxxxxEXAMPLExxxxxx"
backup_deletion_policy: DELETE_IMMEDIATELY
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
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_unique_name: db_unique_name_example
db_name: db_name_example
sid_prefix: sid_prefix_example
pluggable_databases: [ "pluggable_databases_example" ]
# optional
db_version: db_version_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
database_edition: STANDARD_EDITION
cpu_core_count: 56
ssh_public_keys: [ "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz..." ]
shape: shape_example
# optional
fault_domains: [ "fault_domains_example" ]
display_name: display_name_example
backup_subnet_id: "ocid1.backupsubnet.oc1..xxxxxxEXAMPLExxxxxx"
time_zone: time_zone_example
db_system_options:
# optional
storage_management: ASM
storage_volume_performance_mode: BALANCED
sparse_diskgroup: true
domain: domain_example
cluster_name: cluster_name_example
data_storage_percentage: 56
kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
node_count: 56
private_ip: private_ip_example
disk_redundancy: HIGH
data_storage_size_in_gbs: 56
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
nsg_ids: [ "nsg_ids_example" ]
backup_network_nsg_ids: [ "backup_network_nsg_ids_example" ]
license_model: LICENSE_INCLUDED
data_collection_options:
# optional
is_diagnostics_events_enabled: true
is_health_monitoring_enabled: true
is_incident_logs_enabled: true
- name: Create db_system with source = DB_BACKUP
oci_database_db_system:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
availability_domain: Uocm:PHX-AD-1
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
hostname: hostname_example
source: DB_BACKUP
db_home:
# required
database:
# required
admin_password: example-password
# optional
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
kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
db_domain: db_domain_example
db_backup_config:
# optional
auto_backup_enabled: true
recovery_window_in_days: 56
auto_backup_window: SLOT_ONE
auto_full_backup_window: SLOT_ONE
auto_full_backup_day: SUNDAY
run_immediate_full_backup: true
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
dbrs_policy_id: "ocid1.dbrspolicy.oc1..xxxxxxEXAMPLExxxxxx"
backup_deletion_policy: DELETE_IMMEDIATELY
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
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_unique_name: db_unique_name_example
db_name: db_name_example
sid_prefix: sid_prefix_example
pluggable_databases: [ "pluggable_databases_example" ]
# optional
db_version: db_version_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
database_edition: STANDARD_EDITION
cpu_core_count: 56
ssh_public_keys: [ "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz..." ]
shape: shape_example
# optional
fault_domains: [ "fault_domains_example" ]
display_name: display_name_example
backup_subnet_id: "ocid1.backupsubnet.oc1..xxxxxxEXAMPLExxxxxx"
time_zone: time_zone_example
db_system_options:
# optional
storage_management: ASM
storage_volume_performance_mode: BALANCED
sparse_diskgroup: true
domain: domain_example
cluster_name: cluster_name_example
data_storage_percentage: 56
kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
node_count: 56
private_ip: private_ip_example
disk_redundancy: HIGH
data_storage_size_in_gbs: 56
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
nsg_ids: [ "nsg_ids_example" ]
backup_network_nsg_ids: [ "backup_network_nsg_ids_example" ]
license_model: LICENSE_INCLUDED
data_collection_options:
# optional
is_diagnostics_events_enabled: true
is_health_monitoring_enabled: true
is_incident_logs_enabled: true
- name: Update db_system
oci_database_db_system:
# required
db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
# optional
cpu_core_count: 56
version:
# optional
patch_id: "ocid1.patch.oc1..xxxxxxEXAMPLExxxxxx"
database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
action: APPLY
ssh_public_keys: [ "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz..." ]
data_storage_size_in_gbs: 56
reco_storage_size_in_gb: 56
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
shape: shape_example
nsg_ids: [ "nsg_ids_example" ]
backup_network_nsg_ids: [ "backup_network_nsg_ids_example" ]
license_model: LICENSE_INCLUDED
maintenance_window_details:
# optional
preference: NO_PREFERENCE
patching_mode: ROLLING
is_custom_action_timeout_enabled: true
custom_action_timeout_in_mins: 56
is_monthly_patching_enabled: true
months:
- # required
name: JANUARY
weeks_of_month: [ "weeks_of_month_example" ]
days_of_week:
- # required
name: MONDAY
hours_of_day: [ "hours_of_day_example" ]
lead_time_in_weeks: 56
data_collection_options:
# optional
is_diagnostics_events_enabled: true
is_health_monitoring_enabled: true
is_incident_logs_enabled: true
- name: Update db_system using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_database_db_system:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
cpu_core_count: 56
version:
# optional
patch_id: "ocid1.patch.oc1..xxxxxxEXAMPLExxxxxx"
database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
action: APPLY
ssh_public_keys: [ "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz..." ]
data_storage_size_in_gbs: 56
reco_storage_size_in_gb: 56
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
shape: shape_example
nsg_ids: [ "nsg_ids_example" ]
backup_network_nsg_ids: [ "backup_network_nsg_ids_example" ]
license_model: LICENSE_INCLUDED
maintenance_window_details:
# optional
preference: NO_PREFERENCE
patching_mode: ROLLING
is_custom_action_timeout_enabled: true
custom_action_timeout_in_mins: 56
is_monthly_patching_enabled: true
months:
- # required
name: JANUARY
weeks_of_month: [ "weeks_of_month_example" ]
days_of_week:
- # required
name: MONDAY
hours_of_day: [ "hours_of_day_example" ]
lead_time_in_weeks: 56
data_collection_options:
# optional
is_diagnostics_events_enabled: true
is_health_monitoring_enabled: true
is_incident_logs_enabled: true
- name: Delete db_system
oci_database_db_system:
# required
db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete db_system using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_database_db_system:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
wait:
default: true
description: Whether to wait for create or delete operation to complete.
type: bool
shape:
description:
- The shape of the DB system. The shape determines resources allocated to the DB system.
- For virtual machine shapes, the number of CPU cores and memory - For bare metal
and Exadata shapes, the number of CPU cores, memory, and storage
- To get a list of shapes, use the L(ListDbSystemShapes,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/database/latest/DbSystemShapeSummary/ListDbSystemShapes) operation.
- Required for create using I(state=present).
- This parameter is updatable.
type: str
state:
choices:
- present
- absent
default: present
description:
- The state of the DbSystem.
- Use I(state=present) to create or update a DbSystem.
- Use I(state=absent) to delete a DbSystem.
required: false
type: str
domain:
description:
- A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver
is enabled for the specified subnet, the domain name for the subnet is used (do
not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not
permitted.
type: str
key_by:
description: 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.
elements: str
type: list
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
source:
choices:
- NONE
- DB_SYSTEM
- DATABASE
- DB_BACKUP
default: NONE
description:
- 'The source of the database: Use `NONE` for creating a new database. Use `DB_BACKUP`
for creating a new database by restoring from a backup. Use `DATABASE` for creating
a new database from an existing database, including archive redo log data. The default
is `NONE`.'
type: str
db_home:
description:
- ''
- Required for create using I(state=present).
suboptions:
database:
description:
- ''
required: true
suboptions:
admin_password:
description:
- 'A strong password for SYS, SYSTEM, and PDB Admin. 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 -.'
required: true
type: str
backup_id:
description:
- The backup L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
- Required when source is 'DB_BACKUP'
type: str
backup_tde_password:
description:
- The password to open the TDE wallet.
- Applicable when source is one of ['DATABASE', 'DB_BACKUP']
type: str
character_set:
description:
- '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 'NONE'
type: str
database_id:
description:
- The database L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
- Required when source is 'DATABASE'
type: str
database_software_image_id:
description:
- The database software image L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
- Applicable when source is 'NONE'
type: str
db_backup_config:
description:
- ''
- Applicable when source is one of ['DB_SYSTEM', 'NONE']
suboptions:
auto_backup_enabled:
description:
- 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'
type: bool
auto_backup_window:
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
description:
- 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'
type: str
auto_full_backup_day:
choices:
- SUNDAY
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
description:
- Day of the week the full backup should be applied on the database system.
If no option is selected, the value is null and we will default to Sunday.
- Applicable when source is 'NONE'
type: str
auto_full_backup_window:
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
description:
- Time window selected for initiating full backup for the database system.
There are twelve available two-hour time windows. If no option is selected,
the value is null and 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'
type: str
backup_deletion_policy:
choices:
- DELETE_IMMEDIATELY
- DELETE_AFTER_RETENTION_PERIOD
description:
- This defines when the backups will be deleted. - IMMEDIATE option keep
the backup for predefined time i.e 72 hours and then delete permanently...
- RETAIN will keep the backups as per the policy defined for database
backups.
- Applicable when source is 'NONE'
type: str
backup_destination_details:
description:
- Backup destination details.
- Applicable when source is 'NONE'
elements: dict
suboptions:
dbrs_policy_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the DBRS policy used for backup.
- Applicable when source is 'NONE'
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the backup destination.
- Applicable when source is 'NONE'
type: str
internet_proxy:
description:
- Proxy URL to connect to object store.
- Applicable when source is 'NONE'
type: str
type:
choices:
- NFS
- RECOVERY_APPLIANCE
- OBJECT_STORE
- LOCAL
- DBRS
description:
- Type of the database backup destination.
- Required when source is 'NONE'
required: true
type: str
vpc_password:
description:
- 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'
type: str
vpc_user:
description:
- 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'
type: str
type: list
recovery_window_in_days:
description:
- 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'
type: int
run_immediate_full_backup:
description:
- If set to true, configures automatic full backups in the local region
(the region of the DB system) for the first backup run immediately.
- Applicable when source is 'NONE'
type: bool
type: dict
db_domain:
description:
- The database domain. In a distributed database system, DB_DOMAIN specifies
the logical location of the database within the network structure.
- Applicable when source is 'DB_SYSTEM'
type: str
db_name:
description:
- The database name. The name must begin with an alphabetic character and
can contain a maximum of eight alphanumeric characters. Special characters
are not permitted.
- Required when source is 'NONE'
type: str
db_unique_name:
description:
- The `DB_UNIQUE_NAME` of the Oracle Database being backed up.
type: str
db_workload:
choices:
- OLTP
- DSS
description:
- '**Deprecated.** The dbWorkload field has been deprecated for Exadata Database
Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer,
and Base Database Service. Support for this attribute will end in November
2023. You may choose to update your custom scripts to exclude the dbWorkload
attribute. After November 2023 if you pass a value to the dbWorkload attribute,
it will be ignored.'
- The database workload type.
- Applicable when source is 'NONE'
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
- Applicable when source is one of ['DB_SYSTEM', 'NONE']
type: dict
freeform_tags:
description:
- 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 L(Resource
Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
- Applicable when source is one of ['DB_SYSTEM', 'NONE']
type: dict
kms_key_id:
description:
- 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 'NONE'
type: str
kms_key_version_id:
description:
- 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. Autonomous Database Serverless does not use key
versions, hence is not applicable for Autonomous Database Serverless instances.
- Applicable when source is 'NONE'
type: str
ncharacter_set:
description:
- 'The national character set for the database. The default is AL16UTF16.
Allowed values are: AL16UTF16 or UTF8.'
- Applicable when source is 'NONE'
type: str
pdb_name:
description:
- 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 'NONE'
type: str
pluggable_databases:
description:
- The list of pluggable databases that needs to be restored into new database.
- Applicable when source is one of ['DATABASE', 'DB_BACKUP']
elements: str
type: list
sid_prefix:
description:
- Specifies a prefix for the `Oracle SID` of the database to be created.
- Applicable when source is one of ['NONE', 'DB_BACKUP']
type: str
tde_wallet_password:
description:
- '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 'NONE'
type: str
time_stamp_for_point_in_time_recovery:
description:
- 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'
type: str
vault_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Oracle Cloud Infrastructure L(vault,https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm#concepts).
This parameter and `secretId` are required for Customer Managed Keys.
- Applicable when source is 'NONE'
type: str
type: dict
database_software_image_id:
description:
- The database software image L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
- Applicable when source is one of ['NONE', 'DB_BACKUP']
type: str
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.'
- Required when source is 'NONE'
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
- Applicable when source is 'DB_SYSTEM'
type: dict
display_name:
aliases:
- name
description:
- The user-provided name of the Database Home.
type: str
freeform_tags:
description:
- 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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
- Applicable when source is 'DB_SYSTEM'
type: dict
type: dict
nsg_ids:
description:
- The list of L(OCIDs,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
for the network security groups (NSGs) to which this resource belongs. Setting this
to an empty list removes all resources from all NSGs. For more information about
NSGs, see L(Security Rules,https://docs.cloud.oracle.com/Content/Network/Concepts/securityrules.htm).
**NsgIds restrictions:** - A network security group (NSG) is optional for Autonomous
Databases with private access. The nsgIds list can be empty.
- This parameter is updatable.
elements: str
type: list
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
version:
description:
- ''
- This parameter is updatable.
suboptions:
action:
choices:
- APPLY
- PRECHECK
description:
- The action to perform on the patch.
- This parameter is updatable.
type: str
database_software_image_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the database software image.
- This parameter is updatable.
type: str
patch_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the patch.
- This parameter is updatable.
type: str
type: dict
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
hostname:
description:
- The hostname for the DB system. The hostname must begin with an alphabetic character,
and can contain alphanumeric characters and hyphens (-). The maximum length of the
hostname is 16 characters for bare metal and virtual machine DB systems, and 12
characters for Exadata DB systems.
- The maximum length of the combined hostname and domain is 63 characters.
- '**Note:** The hostname must be unique within the subnet. If it is not unique, the
DB system will fail to provision.'
- Required for create using I(state=present).
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
subnet_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the subnet the DB system is associated with.
- '**Subnet Restrictions:** - For bare metal DB systems and for single node virtual
machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For
Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps
with 192.168.128.0/20.'
- These subnets are used by the Oracle Clusterware private interconnect on the database
instance. Specifying an overlapping subnet will cause the private interconnect to
malfunction. This restriction applies to both the client subnet and the backup subnet.
- Required for create using I(state=present).
type: str
time_zone:
description:
- The time zone to use for the DB system. For details, see L(DB System Time Zones,https://docs.cloud.oracle.com/Content/Database/References/timezones.htm).
type: str
kms_key_id:
description:
- The OCID of the key container that is used as the master encryption key in database
transparent data encryption (TDE) operations.
type: str
node_count:
description:
- The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify
either 1 or 2.
type: int
private_ip:
description:
- A private IP address of your choice. Must be an available IP address within the
subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private
IP address from the subnet.
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
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
cluster_name:
description:
- The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster
name must begin with an alphabetic character, and may contain hyphens (-). Underscores
(_) are not permitted. The cluster name can be no longer than 11 characters and
is not case sensitive.
type: str
db_system_id:
aliases:
- id
description:
- The DB system L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
- Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
- Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
- This parameter is updatable.
type: dict
display_name:
aliases:
- name
description:
- The user-friendly name for the DB system. The name does not have to be unique.
- Required for create, update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is set.
type: str
force_create:
default: false
description: 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 I(key_by).
type: bool
wait_timeout:
description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most
of the services but some services might have a longer wait timeout.
type: int
fault_domains:
description:
- A Fault Domain is a grouping of hardware and infrastructure within an availability
domain. Fault Domains let you distribute your instances so that they are not on
the same physical hardware within a single availability domain. A hardware failure
or maintenance that affects one Fault Domain does not affect DB systems in other
Fault Domains.
- If you do not specify the Fault Domain, the system selects one for you. To change
the Fault Domain for a DB system, terminate it and launch a new DB system in the
preferred Fault Domain.
- If the node count is greater than 1, you can specify which Fault Domains these nodes
will be distributed into. The system assigns your nodes automatically to the Fault
Domains you specify so that no Fault Domain contains more than one node.
- To get a list of Fault Domains, use the L(ListFaultDomains,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/identity/latest/FaultDomain/ListFaultDomains)
operation in the Identity and Access Management Service API.
- 'Example: `FAULT-DOMAIN-1`'
elements: str
type: list
freeform_tags:
description:
- 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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
- This parameter is updatable.
type: dict
license_model:
choices:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
description:
- The Oracle license model that applies to all the databases on the DB system. The
default is LICENSE_INCLUDED.
- This parameter is updatable.
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment the DB system belongs in.
- Required for create using I(state=present).
- Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
- Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
type: str
cpu_core_count:
description:
- 'The number of CPU cores to enable for a bare metal or Exadata DB system or AMD
VMDB Systems. The valid values depend on the specified shape:'
- '- BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36. - BM.DenseIO2.52 - Specify
a multiple of 2, from 2 to 52. - Exadata.Base.48 - Specify a multiple of 2, from
0 to 48. - Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84. - Exadata.Half1.168
- Specify a multiple of 4, from 44 to 168. - Exadata.Full1.336 - Specify a multiple
of 8, from 88 to 336. - Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to
92. - Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184. - Exadata.Full2.368
- Specify a multiple of 8, from 0 to 368. - VM.Standard.E4.Flex - Specify any thing
from 1 to 64.'
- This parameter is not used for INTEL virtual machine DB systems because virtual
machine DB systems have a set number of cores for each shape. For information about
the number of cores for a virtual machine DB system shape, see L(Virtual Machine
DB Systems,https://docs.cloud.oracle.com/Content/Database/Concepts/overview.htm#virtualmachine)
- Required for create using I(state=present).
- This parameter is updatable.
type: int
disk_redundancy:
choices:
- HIGH
- NORMAL
description:
- The type of redundancy configured for the DB system. Normal is 2-way redundancy,
recommended for test and development systems. High is 3-way redundancy, recommended
for production systems.
- Applicable when source is one of ['DATABASE', 'NONE', 'DB_BACKUP']
type: str
ssh_public_keys:
description:
- The public key portion of the key pair to use for SSH access to the DB system. Multiple
public keys can be provided. The length of the combined keys cannot exceed 40,000
characters.
- Required for create using I(state=present).
- This parameter is updatable.
elements: str
type: list
backup_subnet_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the backup network subnet the DB system is associated with. Applicable only to
Exadata DB systems.
- '**Subnet Restrictions:** See the subnet restrictions information for **subnetId**.'
type: str
database_edition:
choices:
- STANDARD_EDITION
- ENTERPRISE_EDITION
- ENTERPRISE_EDITION_HIGH_PERFORMANCE
- ENTERPRISE_EDITION_EXTREME_PERFORMANCE
description:
- The Oracle Database Edition that applies to all the databases on the DB system.
Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
- Required when source is one of ['DATABASE', 'NONE', 'DB_BACKUP']
type: str
sparse_diskgroup:
description:
- If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup
is not configured.
type: bool
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
db_system_options:
description:
- ''
suboptions:
storage_management:
choices:
- ASM
- LVM
description:
- The storage option used in DB system. ASM - Automatic storage management LVM
- Logical Volume management
- Applicable when source is 'NONE'
type: str
type: dict
kms_key_version_id:
description:
- 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. Autonomous
Database Serverless does not use key versions, hence is not applicable for Autonomous
Database Serverless instances.
type: str
availability_domain:
description:
- The availability domain where the DB system is located.
- Required for create using I(state=present).
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
source_db_system_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the DB system.
- Required when source is 'DB_SYSTEM'
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
backup_network_nsg_ids:
description:
- A list of the L(OCIDs,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the network security groups (NSGs) that the backup network of this DB system
belongs to. Setting this to an empty array after the list is created removes the
resource from all NSGs. For more information about NSGs, see L(Security Rules,https://docs.cloud.oracle.com/Content/Network/Concepts/securityrules.htm).
Applicable only to Exadata systems.
- This parameter is updatable.
elements: str
type: list
data_collection_options:
description:
- ''
- This parameter is updatable.
suboptions:
is_diagnostics_events_enabled:
description:
- Indicates whether diagnostic collection is enabled for the VM cluster/Cloud
VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events
service notifications for guest VM issues. Diagnostic collection also allows
Oracle to provide enhanced service and proactive support for your Exadata system.
You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning.
You can also disable or enable it at any time using the `UpdateVmCluster` or
`updateCloudVmCluster` API.
- Applicable when source is 'NONE'
type: bool
is_health_monitoring_enabled:
description:
- Indicates whether health monitoring is enabled for the VM cluster / Cloud VM
cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic
data and share it with its operations and support personnel. You may also receive
notifications for some events. Collecting health diagnostics enables Oracle
to provide proactive support and enhanced service for your system. Optionally
enable health monitoring while provisioning a system. You can also disable or
enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster`
or `updateDbsystem` API.
- Applicable when source is 'NONE'
type: bool
is_incident_logs_enabled:
description:
- Indicates whether incident logs and trace collection are enabled for the VM
cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows
Oracle to receive Events service notifications for guest VM issues, collect
incident logs and traces, and use them to diagnose issues and resolve them.
Optionally enable incident logs collection while provisioning a system. You
can also disable or enable incident logs collection anytime using the `UpdateVmCluster`,
`updateCloudVmCluster` or `updateDbsystem` API.
- Applicable when source is 'NONE'
type: bool
type: dict
data_storage_percentage:
description:
- The percentage assigned to DATA storage (user data and database files). The remaining
percentage is assigned to RECO storage (database redo logs, archive logs, and recovery
manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage.
Not applicable for virtual machine DB systems.
type: int
reco_storage_size_in_gb:
description:
- The size, in gigabytes, to scale the attached RECO storage up to for this virtual
machine DB system. This value must be greater than current storage size. Note that
the resulting total storage size attached will be greater than the amount requested
to allow for the software volume. Applies only to virtual machine DB systems.
- This parameter is updatable.
type: int
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
data_storage_size_in_gbs:
aliases:
- initial_data_storage_size_in_gb
description:
- Size (in GB) of the initial data volume that will be created and attached to a virtual
machine DB system. You can scale up storage after provisioning, as needed. Note
that the total storage size attached will be more than the amount you specify to
allow for REDO/RECO space and software volume.
- This parameter is updatable.
type: int
maintenance_window_details:
description:
- ''
- This parameter is updatable.
- Applicable when source is 'NONE'
suboptions:
custom_action_timeout_in_mins:
description:
- Determines the amount of time the system will wait before the start of each
database server patching operation. Custom action timeout is in minutes and
valid value is between 15 to 120 (inclusive).
- Applicable when source is 'NONE'
type: int
days_of_week:
description:
- Days during the week when maintenance should be performed.
- Applicable when source is 'NONE'
elements: dict
suboptions:
name:
choices:
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
description:
- Name of the day of the week.
- Required when source is 'NONE'
required: true
type: str
type: list
hours_of_day:
description:
- The window of hours during the day when maintenance should be performed. The
window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 -
3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot
8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents
time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
- Applicable when source is 'NONE'
elements: int
type: list
is_custom_action_timeout_enabled:
description:
- If true, enables the configuration of a custom action timeout (waiting period)
between database server patching operations.
- Applicable when source is 'NONE'
type: bool
is_monthly_patching_enabled:
description:
- If true, enables the monthly patching option.
- Applicable when source is 'NONE'
type: bool
lead_time_in_weeks:
description:
- Lead time window allows user to set a lead time to prepare for a down time.
The lead time is in weeks and valid value is between 1 to 4.
- Applicable when source is 'NONE'
type: int
months:
description:
- Months during the year when maintenance should be performed.
- Applicable when source is 'NONE'
elements: dict
suboptions:
name:
choices:
- JANUARY
- FEBRUARY
- MARCH
- APRIL
- MAY
- JUNE
- JULY
- AUGUST
- SEPTEMBER
- OCTOBER
- NOVEMBER
- DECEMBER
description:
- Name of the month of the year.
- Required when source is 'NONE'
required: true
type: str
type: list
patching_mode:
choices:
- ROLLING
- NONROLLING
description:
- Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING".
Default value is ROLLING.
- '*IMPORTANT*: Non-rolling infrastructure patching involves system down time.
See L(Oracle-Managed Infrastructure Maintenance Updates,https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/examaintenance.htm#Oracle)
for more information.'
- Applicable when source is 'NONE'
type: str
preference:
choices:
- NO_PREFERENCE
- CUSTOM_PREFERENCE
description:
- The maintenance window scheduling preference.
- Applicable when source is 'NONE'
type: str
weeks_of_month:
description:
- Weeks during the month when maintenance should be performed. Weeks start on
the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days.
Weeks start and end based on calendar dates, not days of the week. For example,
to allow maintenance during the 2nd week of the month (from the 8th day to the
14th day of the month), use the value 2. Maintenance cannot be scheduled for
the fifth week of months that contain more than 28 days. Note that this parameter
works in conjunction with the daysOfWeek and hoursOfDay parameters to allow
you to specify specific days of the week and hours that maintenance will be
performed.
- Applicable when source is 'NONE'
elements: int
type: list
type: dict
storage_volume_performance_mode:
choices:
- BALANCED
- HIGH_PERFORMANCE
description:
- The block storage volume performance level. Valid values are `BALANCED` and `HIGH_PERFORMANCE`.
See L(Block Volume Performance,https://docs.cloud.oracle.com/Content/Block/Concepts/blockvolumeperformance.htm)
for more information.
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
db_system:
contains:
availability_domain:
description:
- The name of the availability domain that the DB system is located in.
returned: on success
sample: Uocm:PHX-AD-1
type: str
backup_network_nsg_ids:
description:
- A list of the L(OCIDs,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the network security groups (NSGs) that the backup network of this DB system
belongs to. Setting this to an empty array after the list is created removes
the resource from all NSGs. For more information about NSGs, see L(Security
Rules,https://docs.cloud.oracle.com/Content/Network/Concepts/securityrules.htm).
Applicable only to Exadata systems.
returned: on success
sample: []
type: list
backup_subnet_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the backup network subnet the DB system is associated with. Applicable
only to Exadata DB systems.
- '**Subnet Restriction:** See the subnet restrictions information for **subnetId**.'
returned: on success
sample: ocid1.backupsubnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
cluster_name:
description:
- The cluster name for Exadata and 2-node RAC virtual machine DB systems. The
cluster name must begin with an alphabetic character, and may contain hyphens
(-). Underscores (_) are not permitted. The cluster name can be no longer
than 11 characters and is not case sensitive.
returned: on success
sample: cluster_name_example
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
cpu_core_count:
description:
- The number of CPU cores enabled on the DB system.
returned: on success
sample: 56
type: int
data_collection_options:
contains:
is_diagnostics_events_enabled:
description:
- Indicates whether diagnostic collection is enabled for the VM cluster/Cloud
VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive
Events service notifications for guest VM issues. Diagnostic collection
also allows Oracle to provide enhanced service and proactive support for
your Exadata system. You can enable diagnostic collection during VM cluster/Cloud
VM cluster provisioning. You can also disable or enable it at any time
using the `UpdateVmCluster` or `updateCloudVmCluster` API.
returned: on success
sample: true
type: bool
is_health_monitoring_enabled:
description:
- Indicates whether health monitoring is enabled for the VM cluster / Cloud
VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect
diagnostic data and share it with its operations and support personnel.
You may also receive notifications for some events. Collecting health
diagnostics enables Oracle to provide proactive support and enhanced service
for your system. Optionally enable health monitoring while provisioning
a system. You can also disable or enable health monitoring anytime using
the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API.
returned: on success
sample: true
type: bool
is_incident_logs_enabled:
description:
- Indicates whether incident logs and trace collection are enabled for the
VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection
allows Oracle to receive Events service notifications for guest VM issues,
collect incident logs and traces, and use them to diagnose issues and
resolve them. Optionally enable incident logs collection while provisioning
a system. You can also disable or enable incident logs collection anytime
using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem`
API.
returned: on success
sample: true
type: bool
description:
- ''
returned: on success
type: complex
data_storage_percentage:
description:
- The percentage assigned to DATA storage (user data and database files). The
remaining percentage is assigned to RECO storage (database redo logs, archive
logs, and recovery manager backups). Accepted values are 40 and 80. The default
is 80 percent assigned to DATA storage. Not applicable for virtual machine
DB systems.
returned: on success
sample: 56
type: int
data_storage_size_in_gbs:
description:
- The data storage size, in gigabytes, that is currently available to the DB
system. Applies only for virtual machine DB systems.
returned: on success
sample: 56
type: int
database_edition:
description:
- The Oracle Database edition that applies to all the databases on the DB system.
returned: on success
sample: STANDARD_EDITION
type: str
db_system_options:
contains:
storage_management:
description:
- The storage option used in DB system. ASM - Automatic storage management
LVM - Logical Volume management
returned: on success
sample: ASM
type: str
description:
- ''
returned: on success
type: complex
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
returned: on success
sample:
Operations:
CostCenter: US
type: dict
disk_redundancy:
description:
- The type of redundancy configured for the DB system. NORMAL is 2-way redundancy.
HIGH is 3-way redundancy.
returned: on success
sample: HIGH
type: str
display_name:
description:
- The user-friendly name for the DB system. The name does not have to be unique.
returned: on success
sample: display_name_example
type: str
domain:
description:
- The domain name for the DB system.
returned: on success
sample: domain_example
type: str
fault_domains:
description:
- List of the Fault Domains in which this DB system is provisioned.
returned: on success
sample: []
type: list
freeform_tags:
description:
- 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 L(Resource
Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
hostname:
description:
- The hostname for the DB system.
returned: on success
sample: hostname_example
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the DB system.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
iorm_config_cache:
contains:
db_plans:
contains:
db_name:
description:
- The database name. For the default `DbPlan`, the `dbName` is `default`.
returned: on success
sample: db_name_example
type: str
flash_cache_limit:
description:
- The flash cache limit for this database. This value is internally
configured based on the share value assigned to the database.
returned: on success
sample: flash_cache_limit_example
type: str
share:
description:
- The relative priority of this database.
returned: on success
sample: 56
type: int
description:
- An array of IORM settings for all the database in the Exadata DB system.
returned: on success
type: complex
lifecycle_details:
description:
- Additional information about the current `lifecycleState`.
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- The current state of IORM configuration for the Exadata DB system.
returned: on success
sample: BOOTSTRAPPING
type: str
objective:
description:
- The current value for the IORM objective. The default is `AUTO`.
returned: on success
sample: LOW_LATENCY
type: str
description:
- ''
returned: on success
type: complex
kms_key_id:
description:
- The OCID of the key container that is used as the master encryption key in
database transparent data encryption (TDE) operations.
returned: on success
sample: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
type: str
last_maintenance_run_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the last maintenance run.
returned: on success
sample: ocid1.lastmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
type: str
last_patch_history_entry_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the last patch history. This value is updated as soon as a patch operation
starts.
returned: on success
sample: ocid1.lastpatchhistoryentry.oc1..xxxxxxEXAMPLExxxxxx
type: str
license_model:
description:
- The Oracle license model that applies to all the databases on the DB system.
The default is LICENSE_INCLUDED.
returned: on success
sample: LICENSE_INCLUDED
type: str
lifecycle_details:
description:
- Additional information about the current lifecycle state.
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- The current state of the DB system.
returned: on success
sample: PROVISIONING
type: str
listener_port:
description:
- The port number configured for the listener on the DB system.
returned: on success
sample: 56
type: int
maintenance_window:
contains:
custom_action_timeout_in_mins:
description:
- Determines the amount of time the system will wait before the start of
each database server patching operation. Custom action timeout is in minutes
and valid value is between 15 to 120 (inclusive).
returned: on success
sample: 56
type: int
days_of_week:
contains:
name:
description:
- Name of the day of the week.
returned: on success
sample: MONDAY
type: str
description:
- Days during the week when maintenance should be performed.
returned: on success
type: complex
hours_of_day:
description:
- The window of hours during the day when maintenance should be performed.
The window is a 4 hour slot. Valid values are - 0 - represents time slot
0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents
time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC
- 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot
20:00 - 23:59 UTC
returned: on success
sample: []
type: list
is_custom_action_timeout_enabled:
description:
- If true, enables the configuration of a custom action timeout (waiting
period) between database server patching operations.
returned: on success
sample: true
type: bool
is_monthly_patching_enabled:
description:
- If true, enables the monthly patching option.
returned: on success
sample: true
type: bool
lead_time_in_weeks:
description:
- Lead time window allows user to set a lead time to prepare for a down
time. The lead time is in weeks and valid value is between 1 to 4.
returned: on success
sample: 56
type: int
months:
contains:
name:
description:
- Name of the month of the year.
returned: on success
sample: JANUARY
type: str
description:
- Months during the year when maintenance should be performed.
returned: on success
type: complex
patching_mode:
description:
- Cloud Exadata infrastructure node patching method, either "ROLLING" or
"NONROLLING". Default value is ROLLING.
- '*IMPORTANT*: Non-rolling infrastructure patching involves system down
time. See L(Oracle-Managed Infrastructure Maintenance Updates,https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/examaintenance.htm#Oracle)
for more information.'
returned: on success
sample: ROLLING
type: str
preference:
description:
- The maintenance window scheduling preference.
returned: on success
sample: NO_PREFERENCE
type: str
weeks_of_month:
description:
- Weeks during the month when maintenance should be performed. Weeks start
on the 1st, 8th, 15th, and 22nd days of the month, and have a duration
of 7 days. Weeks start and end based on calendar dates, not days of the
week. For example, to allow maintenance during the 2nd week of the month
(from the 8th day to the 14th day of the month), use the value 2. Maintenance
cannot be scheduled for the fifth week of months that contain more than
28 days. Note that this parameter works in conjunction with the daysOfWeek
and hoursOfDay parameters to allow you to specify specific days of the
week and hours that maintenance will be performed.
returned: on success
sample: []
type: list
description:
- ''
returned: on success
type: complex
memory_size_in_gbs:
description:
- Memory allocated to the DB system, in gigabytes.
returned: on success
sample: 56
type: int
next_maintenance_run_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the next maintenance run.
returned: on success
sample: ocid1.nextmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
type: str
node_count:
description:
- The number of nodes in the DB system. For RAC DB systems, the value is greater
than 1.
returned: on success
sample: 56
type: int
nsg_ids:
description:
- The list of L(OCIDs,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
for the network security groups (NSGs) to which this resource belongs. Setting
this to an empty list removes all resources from all NSGs. For more information
about NSGs, see L(Security Rules,https://docs.cloud.oracle.com/Content/Network/Concepts/securityrules.htm).
**NsgIds restrictions:** - A network security group (NSG) is optional for
Autonomous Databases with private access. The nsgIds list can be empty.
returned: on success
sample: []
type: list
os_version:
description:
- The most recent OS Patch Version applied on the DB system.
returned: on success
sample: os_version_example
type: str
point_in_time_data_disk_clone_timestamp:
description:
- The point in time for a cloned database system when the data disks were cloned
from the source database system, as described in L(RFC 3339,https://tools.ietf.org/rfc/rfc3339).
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
reco_storage_size_in_gb:
description:
- The RECO/REDO storage size, in gigabytes, that is currently allocated to the
DB system. Applies only for virtual machine DB systems.
returned: on success
sample: 56
type: int
scan_dns_name:
description:
- The FQDN of the DNS record for the SCAN IP addresses that are associated with
the DB system.
returned: on success
sample: scan_dns_name_example
type: str
scan_dns_record_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the DNS record for the SCAN IP addresses that are associated with the DB
system.
returned: on success
sample: ocid1.scandnsrecord.oc1..xxxxxxEXAMPLExxxxxx
type: str
scan_ip_ids:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Single Client Access Name (SCAN) IP addresses associated with the DB
system. SCAN IP addresses are typically used for load balancing and are not
assigned to any interface. Oracle Clusterware directs the requests to the
appropriate nodes in the cluster.
- '**Note:** For a single-node DB system, this list is empty.'
returned: on success
sample: []
type: list
shape:
description:
- The shape of the DB system. The shape determines resources to allocate to
the DB system. - For virtual machine shapes, the number of CPU cores and memory
- For bare metal and Exadata shapes, the number of CPU cores, storage, and
memory
returned: on success
sample: shape_example
type: str
source_db_system_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the DB system.
returned: on success
sample: ocid1.sourcedbsystem.oc1..xxxxxxEXAMPLExxxxxx
type: str
sparse_diskgroup:
description:
- True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse
diskgroup was not configured.
returned: on success
sample: true
type: bool
ssh_public_keys:
description:
- The public key portion of one or more key pairs used for SSH access to the
DB system.
returned: on success
sample:
- ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...
type: list
storage_volume_performance_mode:
description:
- The block storage volume performance level. Valid values are `BALANCED` and
`HIGH_PERFORMANCE`. See L(Block Volume Performance,https://docs.cloud.oracle.com/Content/Block/Concepts/blockvolumeperformance.htm)
for more information.
returned: on success
sample: BALANCED
type: str
subnet_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the subnet the DB system is associated with.
- '**Subnet Restrictions:** - For bare metal DB systems and for single node
virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet
that overlaps with 192.168.128.0/20.'
- These subnets are used by the Oracle Clusterware private interconnect on the
database instance. Specifying an overlapping subnet will cause the private
interconnect to malfunction. This restriction applies to both the client subnet
and backup subnet.
returned: on success
sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
time_created:
description:
- The date and time the DB system was created.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_zone:
description:
- The time zone of the DB system. For details, see L(DB System Time Zones,https://docs.cloud.oracle.com/Content/Database/References/timezones.htm).
returned: on success
sample: time_zone_example
type: str
version:
description:
- The Oracle Database version of the DB system.
returned: on success
sample: version_example
type: str
vip_ids:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the virtual IP (VIP) addresses associated with the DB system. The Cluster
Ready Services (CRS) creates and maintains one VIP address for each node in
the DB system to enable failover. If one node fails, the VIP is reassigned
to another active node in the cluster.
- '**Note:** For a single-node DB system, this list is empty.'
returned: on success
sample: []
type: list
zone_id:
description:
- The OCID of the zone the DB system is associated with.
returned: on success
sample: ocid1.zone.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- Details of the DbSystem resource acted upon by the current operation
returned: on success
sample:
availability_domain: Uocm:PHX-AD-1
backup_network_nsg_ids: []
backup_subnet_id: ocid1.backupsubnet.oc1..xxxxxxEXAMPLExxxxxx
cluster_name: cluster_name_example
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
cpu_core_count: 56
data_collection_options:
is_diagnostics_events_enabled: true
is_health_monitoring_enabled: true
is_incident_logs_enabled: true
data_storage_percentage: 56
data_storage_size_in_gbs: 56
database_edition: STANDARD_EDITION
db_system_options:
storage_management: ASM
defined_tags:
Operations:
CostCenter: US
disk_redundancy: HIGH
display_name: display_name_example
domain: domain_example
fault_domains: []
freeform_tags:
Department: Finance
hostname: hostname_example
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
iorm_config_cache:
db_plans:
- db_name: db_name_example
flash_cache_limit: flash_cache_limit_example
share: 56
lifecycle_details: lifecycle_details_example
lifecycle_state: BOOTSTRAPPING
objective: LOW_LATENCY
kms_key_id: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
last_maintenance_run_id: ocid1.lastmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
last_patch_history_entry_id: ocid1.lastpatchhistoryentry.oc1..xxxxxxEXAMPLExxxxxx
license_model: LICENSE_INCLUDED
lifecycle_details: lifecycle_details_example
lifecycle_state: PROVISIONING
listener_port: 56
maintenance_window:
custom_action_timeout_in_mins: 56
days_of_week:
- name: MONDAY
hours_of_day: []
is_custom_action_timeout_enabled: true
is_monthly_patching_enabled: true
lead_time_in_weeks: 56
months:
- name: JANUARY
patching_mode: ROLLING
preference: NO_PREFERENCE
weeks_of_month: []
memory_size_in_gbs: 56
next_maintenance_run_id: ocid1.nextmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
node_count: 56
nsg_ids: []
os_version: os_version_example
point_in_time_data_disk_clone_timestamp: '2013-10-20T19:20:30+01:00'
reco_storage_size_in_gb: 56
scan_dns_name: scan_dns_name_example
scan_dns_record_id: ocid1.scandnsrecord.oc1..xxxxxxEXAMPLExxxxxx
scan_ip_ids: []
shape: shape_example
source_db_system_id: ocid1.sourcedbsystem.oc1..xxxxxxEXAMPLExxxxxx
sparse_diskgroup: true
ssh_public_keys:
- ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...
storage_volume_performance_mode: BALANCED
subnet_id: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
time_created: '2013-10-20T19:20:30+01:00'
time_zone: time_zone_example
version: version_example
vip_ids: []
zone_id: ocid1.zone.oc1..xxxxxxEXAMPLExxxxxx
type: complex