oracle.oci.oci_database_cloud_autonomous_vm_cluster – Manage a CloudAutonomousVmCluster resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_cloud_autonomous_vm_cluster
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a CloudAutonomousVmCluster resource in Oracle Cloud Infrastructure
For state=present, creates an Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see CreateAutonomousVmCluster.
This resource has the following action operations in the oracle.oci.oci_database_cloud_autonomous_vm_cluster_actions module: change_compartment, rotate_cloud_autonomous_vm_cluster_ords_certs, rotate_cloud_autonomous_vm_cluster_ssl_certs.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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. |
||
autonomous_data_storage_size_in_tbs
float
|
The data disk group size to be allocated for Autonomous Databases, in TBs.
|
|||
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.
|
|||
cloud_autonomous_vm_cluster_id
string
|
The Cloud VM cluster 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 |
|||
cloud_exadata_infrastructure_id
string
|
The OCID of the cloud Exadata infrastructure.
Required for create using state=present.
|
|||
cluster_time_zone
string
|
The time zone to use for the Cloud Autonomous VM cluster. For details, see DB System Time Zones.
|
|||
compartment_id
string
|
The OCID of the compartment.
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. |
|||
compute_model
string
|
|
The compute model of the Cloud Autonomous VM Cluster. ECPU compute model is the recommended model and OCPU compute model is legacy.
|
||
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 . |
|||
cpu_core_count_per_node
integer
|
The number of CPU cores to be enabled per VM cluster node.
|
|||
db_servers
list
/ elements=string
|
The list of database servers.
|
|||
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
This parameter is updatable.
|
|||
description
string
|
User defined description of the cloud Autonomous VM cluster.
This parameter is updatable.
|
|||
display_name
string
|
The user-friendly name for the cloud Autonomous VM cluster. The name does not need to be unique.
Required for create using state=present.
Required for update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
|||
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
||
freeform_tags
dictionary
|
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
This parameter is updatable.
|
|||
is_mtls_enabled_vm_cluster
boolean
|
|
Enable mutual TLS(mTLS) authentication for database at time of provisioning a VMCluster. This is applicable to database TLS Certificates only. Default is TLS
|
||
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.
|
|||
license_model
string
|
|
The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on- premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure, this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an Autonomous Database Serverless] database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter.
This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.
This parameter is updatable.
|
||
maintenance_window_details
dictionary
|
This parameter is updatable.
|
|||
custom_action_timeout_in_mins
integer
|
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).
|
|||
days_of_week
list
/ elements=dictionary
|
Days during the week when maintenance should be performed.
|
|||
name
string
/ required
|
|
Name of the day of the week.
|
||
hours_of_day
list
/ elements=integer
|
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
|
|||
is_custom_action_timeout_enabled
boolean
|
|
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
|
||
is_monthly_patching_enabled
boolean
|
|
If true, enables the monthly patching option.
|
||
lead_time_in_weeks
integer
|
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.
|
|||
months
list
/ elements=dictionary
|
Months during the year when maintenance should be performed.
|
|||
name
string
/ required
|
|
Name of the month of the year.
|
||
patching_mode
string
|
|
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
*IMPORTANT*: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.
|
||
preference
string
|
|
The maintenance window scheduling preference.
|
||
weeks_of_month
list
/ elements=integer
|
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.
|
|||
memory_per_oracle_compute_unit_in_gbs
integer
|
The amount of memory (in GBs) to be enabled per OCPU or ECPU.
|
|||
nsg_ids
list
/ elements=string
|
The list of OCIDs 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 Security Rules. **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.
|
|||
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
||
region
string
|
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See
config_file_location ). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
|||
scan_listener_port_non_tls
integer
|
The SCAN Listener Non TLS port. Default is 1521.
|
|||
scan_listener_port_tls
integer
|
The SCAN Listener TLS port. Default is 2484.
|
|||
state
string
|
|
The state of the CloudAutonomousVmCluster.
Use state=present to create or update a CloudAutonomousVmCluster.
Use state=absent to delete a CloudAutonomousVmCluster.
|
||
subnet_id
string
|
The OCID of the subnet the cloud Autonomous VM Cluster is associated with.
Required for create using state=present.
|
|||
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 |
|||
total_container_databases
integer
|
The total number of Autonomous Container Databases that can be created.
|
|||
wait
boolean
|
|
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.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create cloud_autonomous_vm_cluster
oci_database_cloud_autonomous_vm_cluster:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
cloud_exadata_infrastructure_id: "ocid1.cloudexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
total_container_databases: 56
cpu_core_count_per_node: 56
memory_per_oracle_compute_unit_in_gbs: 56
autonomous_data_storage_size_in_tbs: 3.4
cluster_time_zone: cluster_time_zone_example
compute_model: ECPU
is_mtls_enabled_vm_cluster: true
db_servers: [ "db_servers_example" ]
scan_listener_port_tls: 56
scan_listener_port_non_tls: 56
description: description_example
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
license_model: LICENSE_INCLUDED
nsg_ids: [ "nsg_ids_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update cloud_autonomous_vm_cluster
oci_database_cloud_autonomous_vm_cluster:
# required
cloud_autonomous_vm_cluster_id: "ocid1.cloudautonomousvmcluster.oc1..xxxxxxEXAMPLExxxxxx"
# optional
description: description_example
display_name: display_name_example
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
license_model: LICENSE_INCLUDED
nsg_ids: [ "nsg_ids_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update cloud_autonomous_vm_cluster using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_database_cloud_autonomous_vm_cluster:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
description: description_example
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
license_model: LICENSE_INCLUDED
nsg_ids: [ "nsg_ids_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete cloud_autonomous_vm_cluster
oci_database_cloud_autonomous_vm_cluster:
# required
cloud_autonomous_vm_cluster_id: "ocid1.cloudautonomousvmcluster.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete cloud_autonomous_vm_cluster using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_database_cloud_autonomous_vm_cluster:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||
---|---|---|---|---|---|
cloud_autonomous_vm_cluster
complex
|
on success |
Details of the CloudAutonomousVmCluster resource acted upon by the current operation
Sample:
{'autonomous_data_storage_size_in_tbs': 1.2, 'availability_domain': 'Uocm:PHX-AD-1', 'available_autonomous_data_storage_size_in_tbs': 1.2, 'available_container_databases': 56, 'available_cpus': 3.4, 'cloud_exadata_infrastructure_id': 'ocid1.cloudexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx', 'cluster_time_zone': 'cluster_time_zone_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'compute_model': 'ECPU', 'cpu_core_count': 56, 'cpu_core_count_per_node': 56, 'data_storage_size_in_gbs': 1.2, 'data_storage_size_in_tbs': 1.2, 'db_node_storage_size_in_gbs': 56, 'db_servers': [], 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'domain': 'domain_example', 'freeform_tags': {'Department': 'Finance'}, 'hostname': 'hostname_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_mtls_enabled_vm_cluster': True, 'last_maintenance_run_id': 'ocid1.lastmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx', 'last_update_history_entry_id': 'ocid1.lastupdatehistoryentry.oc1..xxxxxxEXAMPLExxxxxx', 'license_model': 'LICENSE_INCLUDED', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'PROVISIONING', '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_per_oracle_compute_unit_in_gbs': 56, 'memory_size_in_gbs': 56, 'next_maintenance_run_id': 'ocid1.nextmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx', 'node_count': 56, 'nsg_ids': [], 'ocpu_count': 3.4, 'reclaimable_cpus': 3.4, 'scan_listener_port_non_tls': 56, 'scan_listener_port_tls': 56, 'shape': 'shape_example', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_database_ssl_certificate_expires': '2013-10-20T19:20:30+01:00', 'time_ords_certificate_expires': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'total_container_databases': 56}
|
|||
autonomous_data_storage_size_in_tbs
float
|
on success |
The data disk group size allocated for Autonomous Databases, in TBs.
Sample:
1.2
|
|||
availability_domain
string
|
on success |
The name of the availability domain that the cloud Autonomous VM cluster is located in.
Sample:
Uocm:PHX-AD-1
|
|||
available_autonomous_data_storage_size_in_tbs
float
|
on success |
The data disk group size available for Autonomous Databases, in TBs.
Sample:
1.2
|
|||
available_container_databases
integer
|
on success |
The number of Autonomous Container Databases that can be created with the currently available local storage.
Sample:
56
|
|||
available_cpus
float
|
on success |
CPU cores available for allocation to Autonomous Databases.
Sample:
3.4
|
|||
cloud_exadata_infrastructure_id
string
|
on success |
The OCID of the cloud Exadata infrastructure.
Sample:
ocid1.cloudexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
|
|||
cluster_time_zone
string
|
on success |
The time zone of the Cloud Autonomous VM Cluster.
Sample:
cluster_time_zone_example
|
|||
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|||
compute_model
string
|
on success |
The compute model of the Cloud Autonomous VM Cluster. ECPU compute model is the recommended model and OCPU compute model is legacy. See Compute Models in Autonomous Database on Dedicated Exadata #Infrastructure for more details.
Sample:
ECPU
|
|||
cpu_core_count
integer
|
on success |
The number of CPU cores on the cloud Autonomous VM cluster.
Sample:
56
|
|||
cpu_core_count_per_node
integer
|
on success |
The number of CPU cores enabled per VM cluster node.
Sample:
56
|
|||
data_storage_size_in_gbs
float
|
on success |
The total data storage allocated, in gigabytes (GB).
Sample:
1.2
|
|||
data_storage_size_in_tbs
float
|
on success |
The total data storage allocated, in terabytes (TB).
Sample:
1.2
|
|||
db_node_storage_size_in_gbs
integer
|
on success |
The local node storage allocated in GBs.
Sample:
56
|
|||
db_servers
list
/ elements=string
|
on success |
The list of OCIDs of the Db servers.
|
|||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|||
description
string
|
on success |
User defined description of the cloud Autonomous VM cluster.
Sample:
description_example
|
|||
display_name
string
|
on success |
The user-friendly name for the cloud Autonomous VM cluster. The name does not need to be unique.
Sample:
display_name_example
|
|||
domain
string
|
on success |
The domain name for the cloud Autonomous VM cluster.
Sample:
domain_example
|
|||
freeform_tags
dictionary
|
on success |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
Sample:
{'Department': 'Finance'}
|
|||
hostname
string
|
on success |
The hostname for the cloud Autonomous VM cluster.
Sample:
hostname_example
|
|||
id
string
|
on success |
The OCID of the Cloud Autonomous VM cluster.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||
is_mtls_enabled_vm_cluster
boolean
|
on success |
Enable mutual TLS(mTLS) authentication for database at time of provisioning a VMCluster. This is applicable to database TLS Certificates only. Default is TLS
Sample:
True
|
|||
last_maintenance_run_id
string
|
on success |
The OCID of the last maintenance run.
Sample:
ocid1.lastmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
|
|||
last_update_history_entry_id
string
|
on success |
The OCID of the last maintenance update history. This value is updated when a maintenance update starts.
Sample:
ocid1.lastupdatehistoryentry.oc1..xxxxxxEXAMPLExxxxxx
|
|||
license_model
string
|
on success |
The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on- premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure, this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an Autonomous Database Serverless] database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter.
This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.
Sample:
LICENSE_INCLUDED
|
|||
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 cloud Autonomous VM cluster.
Sample:
PROVISIONING
|
|||
maintenance_window
complex
|
on success |
|
|||
custom_action_timeout_in_mins
integer
|
on success |
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).
Sample:
56
|
|||
days_of_week
complex
|
on success |
Days during the week when maintenance should be performed.
|
|||
name
string
|
on success |
Name of the day of the week.
Sample:
MONDAY
|
|||
hours_of_day
list
/ elements=string
|
on success |
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
|
|||
is_custom_action_timeout_enabled
boolean
|
on success |
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
Sample:
True
|
|||
is_monthly_patching_enabled
boolean
|
on success |
If true, enables the monthly patching option.
Sample:
True
|
|||
lead_time_in_weeks
integer
|
on success |
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.
Sample:
56
|
|||
months
complex
|
on success |
Months during the year when maintenance should be performed.
|
|||
name
string
|
on success |
Name of the month of the year.
Sample:
JANUARY
|
|||
patching_mode
string
|
on success |
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
*IMPORTANT*: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.
Sample:
ROLLING
|
|||
preference
string
|
on success |
The maintenance window scheduling preference.
Sample:
NO_PREFERENCE
|
|||
weeks_of_month
list
/ elements=string
|
on success |
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.
|
|||
memory_per_oracle_compute_unit_in_gbs
integer
|
on success |
The amount of memory (in GBs) enabled per OCPU or ECPU.
Sample:
56
|
|||
memory_size_in_gbs
integer
|
on success |
The memory allocated in GBs.
Sample:
56
|
|||
next_maintenance_run_id
string
|
on success |
The OCID of the next maintenance run.
Sample:
ocid1.nextmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
|
|||
node_count
integer
|
on success |
The number of database servers in the cloud VM cluster.
Sample:
56
|
|||
nsg_ids
list
/ elements=string
|
on success |
The list of OCIDs 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 Security Rules. **NsgIds restrictions:** - A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
|
|||
ocpu_count
float
|
on success |
The number of CPU cores on the cloud Autonomous VM cluster. Only 1 decimal place is allowed for the fractional part.
Sample:
3.4
|
|||
reclaimable_cpus
float
|
on success |
CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database.
Sample:
3.4
|
|||
scan_listener_port_non_tls
integer
|
on success |
The SCAN Listener Non TLS port. Default is 1521.
Sample:
56
|
|||
scan_listener_port_tls
integer
|
on success |
The SCAN Listenenr TLS port. Default is 2484.
Sample:
56
|
|||
shape
string
|
on success |
The model name of the Exadata hardware running the cloud Autonomous VM cluster.
Sample:
shape_example
|
|||
subnet_id
string
|
on success |
The OCID of the subnet the cloud Autonomous VM Cluster is associated with.
**Subnet Restrictions:** - 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.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
|||
time_created
string
|
on success |
The date and time that the cloud Autonomous VM cluster was created.
Sample:
2013-10-20T19:20:30+01:00
|
|||
time_database_ssl_certificate_expires
string
|
on success |
The date and time of Database SSL certificate expiration.
Sample:
2013-10-20T19:20:30+01:00
|
|||
time_ords_certificate_expires
string
|
on success |
The date and time of ORDS certificate expiration.
Sample:
2013-10-20T19:20:30+01:00
|
|||
time_updated
string
|
on success |
The last date and time that the cloud Autonomous VM cluster was updated.
Sample:
2013-10-20T19:20:30+01:00
|
|||
total_container_databases
integer
|
on success |
The total number of Autonomous Container Databases that can be created with the allocated local storage.
Sample:
56
|
Authors¶
Oracle (@oracle)