autonomous_vm_clusters

Creates, updates, deletes, gets or lists an autonomous_vm_clusters resource.

Overview

Name	`autonomous_vm_clusters`
Type	Resource
Id	`oci.database.autonomous_vm_clusters`

Fields

The following fields are returned by SELECT queries:

get
list

Information about the Autonomous VM cluster.

Name	Datatype	Description
`id`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous VM cluster.
`autonomousDataStoragePercentage`	`number (float)`	The percentage of the data storage used for the Autonomous Databases in an Autonomous VM Cluster.
`autonomousDataStorageSizeInTBs`	`number (double)`	The data disk group size allocated for Autonomous Databases, in TBs.
`availableAutonomousDataStorageSizeInTBs`	`number (double)`	The data disk group size available for Autonomous Databases, in TBs.
`availableContainerDatabases`	`integer`	The number of Autonomous Container Databases that can be created with the currently available local storage.
`availableCpus`	`integer`	The numnber of CPU cores available.
`availableDataStorageSizeInTBs`	`number (double)`	Deprecated. Use `availableAutonomousDataStorageSizeInTBs` for Autonomous Databases' data storage availability in TBs.
`compartmentId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
`computeModel`	`string`	The compute model of the 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](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. (ECPU, OCPU)
`cpuCoreCountPerNode`	`integer`	The number of CPU cores enabled per VM cluster node.
`cpuPercentage`	`number (float)`	The percentage of total number of CPUs used in an Autonomous VM Cluster.
`cpusEnabled`	`integer`	The number of enabled CPU cores.
`cpusLowestScaledValue`	`integer (int32)`	The lowest value to which cpus can be scaled down.
`dataStorageSizeInGBs`	`number (double)`	The total data storage allocated in GBs.
`dataStorageSizeInTBs`	`number (double)`	The total data storage allocated in TBs
`dbNodeStorageSizeInGBs`	`integer`	The local node storage allocated in GBs.
`dbServers`	`array`	The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Db servers.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
`displayName`	`string`	The user-friendly name for the Autonomous VM cluster. The name does not need to be unique.
`distributionAlgorithm`	`string`	The distribution algorithm used for the Autonomous VM cluster. (RESOURCE_OPTIMIZED, DISTRIBUTION_OPTIMIZED)
`exadataInfrastructureId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
`exadataStorageInTBsLowestScaledValue`	`number (double)`	The lowest value to which exadataStorage(in TBs) can be scaled down.
`freeformTags`	`object`	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](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`isLocalBackupEnabled`	`boolean`	If true, database backup on local Exadata storage is configured for the Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster.
`isMtlsEnabled`	`boolean`	Enable mutual TLS(mTLS) authentication for database while provisioning a VMCluster. Default is TLS.
`lastMaintenanceRunId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run.
`licenseModel`	`string`	The Oracle license model that applies to the Autonomous VM cluster. The default is LICENSE_INCLUDED. (LICENSE_INCLUDED, BRING_YOUR_OWN_LICENSE)
`lifecycleDetails`	`string`	Additional information about the current lifecycle state.
`lifecycleState`	`string`	The current state of the Autonomous VM cluster. (PROVISIONING, AVAILABLE, UPDATING, TERMINATING, TERMINATED, FAILED, MAINTENANCE_IN_PROGRESS)
`maintenanceWindow`	`object`	The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
`maxAcdsLowestScaledValue`	`integer (int32)`	The lowest value to which maximum number of ACDs can be scaled down.
`memoryPerOracleComputeUnitInGBs`	`integer`	The amount of memory (in GBs) to be enabled per each CPU core.
`memorySizeInGBs`	`integer`	The memory allocated in GBs.
`nextMaintenanceRunId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run.
`nodeCount`	`integer (int32)`	The number of nodes in the Autonomous VM Cluster.
`nonProvisionableAutonomousContainerDatabases`	`integer`	The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster.
`ocpusEnabled`	`number (float)`	The number of enabled OCPU cores.
`provisionableAutonomousContainerDatabases`	`integer`	Deprecated. Use field totalContainerDatabases.
`provisionedAutonomousContainerDatabases`	`integer`	The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster.
`provisionedCpus`	`number (float)`	The number of CPUs provisioned in an Autonomous VM Cluster.
`reclaimableCpus`	`integer`	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.
`reservedCpus`	`number (float)`	The number of CPUs reserved in an Autonomous VM Cluster.
`scanListenerPortNonTls`	`integer`	The SCAN Listener Non TLS port number. Default value is 1521.
`scanListenerPortTls`	`integer`	The SCAN Listener TLS port number. Default value is 2484.
`sgaPercentage`	`number (float)`	Percentage of ECPU memory allocated for SGA(System Global Area).
`systemTags`	`object`	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
`timeCreated`	`string (date-time)`	The date and time that the Autonomous VM cluster was created.
`timeDatabaseSslCertificateExpires`	`string (date-time)`	The date and time of the Database SSL certificate expiration.
`timeOrdsCertificateExpires`	`string (date-time)`	The date and time of the ORDS certificate expiration.
`timeZone`	`string`	The time zone to use for the Autonomous VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm).
`totalAutonomousDataStorageInTBs`	`number (float)`	The total data disk group size for Autonomous Databases, in TBs.
`totalContainerDatabases`	`integer`	The total number of Autonomous Container Databases that can be created.
`vmClusterNetworkId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network.

Details of the Autonomous VM cluster.

Name	Datatype	Description
`id`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous VM cluster.
`autonomousDataStoragePercentage`	`number (float)`	The percentage of the data storage used for the Autonomous Databases in an Autonomous VM Cluster.
`autonomousDataStorageSizeInTBs`	`number (double)`	The data disk group size allocated for Autonomous Databases, in TBs.
`availableAutonomousDataStorageSizeInTBs`	`number (double)`	The data disk group size available for Autonomous Databases, in TBs.
`availableContainerDatabases`	`integer`	The number of Autonomous Container Databases that can be created with the currently available local storage.
`availableCpus`	`integer`	The numnber of CPU cores available.
`availableDataStorageSizeInTBs`	`number (double)`	Deprecated. Use `availableAutonomousDataStorageSizeInTBs` for Autonomous Databases' data storage availability in TBs.
`compartmentId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
`computeModel`	`string`	The compute model of the 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](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. (ECPU, OCPU)
`cpuCoreCountPerNode`	`integer`	The number of CPU cores enabled per VM cluster node.
`cpuPercentage`	`number (float)`	The percentage of total number of CPUs used in an Autonomous VM Cluster.
`cpusEnabled`	`integer`	The number of enabled CPU cores.
`cpusLowestScaledValue`	`integer (int32)`	The lowest value to which cpus can be scaled down.
`dataStorageSizeInGBs`	`number (double)`	The total data storage allocated in GBs.
`dataStorageSizeInTBs`	`number (double)`	The total data storage allocated in TBs
`dbNodeStorageSizeInGBs`	`integer`	The local node storage allocated in GBs.
`dbServers`	`array`	The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Db servers.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
`displayName`	`string`	The user-friendly name for the Autonomous VM cluster. The name does not need to be unique.
`distributionAlgorithm`	`string`	The distribution algorithm used for the Autonomous VM cluster. (RESOURCE_OPTIMIZED, DISTRIBUTION_OPTIMIZED)
`exadataInfrastructureId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
`exadataStorageInTBsLowestScaledValue`	`number (double)`	The lowest value to which exadataStorage(in TBs) can be scaled down.
`freeformTags`	`object`	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](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`isLocalBackupEnabled`	`boolean`	If true, database backup on local Exadata storage is configured for the Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster.
`isMtlsEnabled`	`boolean`	Enable mutual TLS(mTLS) authentication for database while provisioning a VMCluster. Default is TLS.
`lastMaintenanceRunId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run.
`licenseModel`	`string`	The Oracle license model that applies to the Autonomous VM cluster. The default is LICENSE_INCLUDED. (LICENSE_INCLUDED, BRING_YOUR_OWN_LICENSE)
`lifecycleDetails`	`string`	Additional information about the current lifecycle state.
`lifecycleState`	`string`	The current state of the Autonomous VM cluster. (PROVISIONING, AVAILABLE, UPDATING, TERMINATING, TERMINATED, FAILED, MAINTENANCE_IN_PROGRESS)
`maintenanceWindow`	`object`	The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
`maxAcdsLowestScaledValue`	`integer (int32)`	The lowest value to which maximum number of ACDs can be scaled down.
`memoryPerOracleComputeUnitInGBs`	`integer`	The amount of memory (in GBs) to be enabled per each CPU core.
`memorySizeInGBs`	`integer`	The memory allocated in GBs.
`nextMaintenanceRunId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run.
`nodeCount`	`integer (int32)`	The number of nodes in the Autonomous VM Cluster.
`nonProvisionableAutonomousContainerDatabases`	`integer`	The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster.
`ocpusEnabled`	`number (float)`	The number of enabled OCPU cores.
`provisionableAutonomousContainerDatabases`	`integer`	Deprecated. Use field totalContainerDatabases.
`provisionedAutonomousContainerDatabases`	`integer`	The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster.
`provisionedCpus`	`number (float)`	The number of CPUs provisioned in an Autonomous VM Cluster.
`reclaimableCpus`	`integer`	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.
`reservedCpus`	`number (float)`	The number of CPUs reserved in an Autonomous VM Cluster.
`scanListenerPortNonTls`	`integer`	The SCAN Listener Non TLS port number. Default value is 1521.
`scanListenerPortTls`	`integer`	The SCAN Listener TLS port number. Default value is 2484.
`sgaPercentage`	`number (float)`	Percentage of ECPU memory allocated for SGA(System Global Area).
`systemTags`	`object`	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
`timeCreated`	`string (date-time)`	The date and time that the Autonomous VM cluster was created.
`timeDatabaseSslCertificateExpires`	`string (date-time)`	The date and time of the Database SSL certificate expiration.
`timeOrdsCertificateExpires`	`string (date-time)`	The date and time of the ORDS certificate expiration.
`timeZone`	`string`	The time zone to use for the Autonomous VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm).
`totalAutonomousDataStorageInTBs`	`number (float)`	The total data disk group size for Autonomous Databases, in TBs.
`totalContainerDatabases`	`integer`	The total number of Autonomous Container Databases that can be created.
`vmClusterNetworkId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`autonomousVmClusterId`, `region`	`opc-request-id`	Gets information about the specified Autonomous VM cluster for an Exadata Cloud@Customer system. To get information about an Autonomous VM Cluster in the Oracle cloud, see [GetCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/GetCloudAutonomousVmCluster).<br />
`list`	`select`	`compartmentId`, `region`	`exadataInfrastructureId`, `limit`, `page`, `sortBy`, `sortOrder`, `lifecycleState`, `displayName`, `opc-request-id`	Gets a list of Exadata Cloud@Customer Autonomous VM clusters in the specified compartment. To list Autonomous VM Clusters in the Oracle Cloud, see [ListCloudAutonomousVmClusters](#/en/database/latest/CloudAutonomousVmCluster/ListCloudAutonomousVmClusters).<br />
`create`	`insert`	`region`, `compartmentId`, `displayName`, `exadataInfrastructureId`, `vmClusterNetworkId`	`opc-retry-token`, `opc-request-id`	Creates an Autonomous VM cluster for Exadata Cloud@Customer. To create an Autonomous VM Cluster in the Oracle cloud, see [CreateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/CreateCloudAutonomousVmCluster).<br />
`update`	`update`	`autonomousVmClusterId`, `region`	`if-match`, `opc-request-id`	Updates the specified Autonomous VM cluster for the Exadata Cloud@Customer system.To update an Autonomous VM Cluster in the Oracle cloud, see [UpdateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/UpdateCloudAutonomousVmCluster).<br />
`delete`	`delete`	`autonomousVmClusterId`, `region`	`if-match`, `opc-request-id`	Deletes the specified Autonomous VM cluster in an Exadata Cloud@Customer system. To delete an Autonomous VM Cluster in the Oracle cloud, see [DeleteCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/DeleteCloudAutonomousVmCluster).<br />
`change_compartment`	`exec`	`autonomousVmClusterId`, `region`, `compartmentId`	`opc-retry-token`, `opc-request-id`, `if-match`	Moves an Autonomous VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer only. For systems in the Oracle cloud, see [ChangeAutonomousVmClusterCompartment](#/en/database/latest/AutonomousVmCluster/ChangeAutonomousVmClusterCompartment).<br />
`restart_autonomous_vm_cluster_ords`	`exec`	`autonomousVmClusterId`, `region`	`opc-retry-token`, `opc-request-id`, `if-match`	Restarts Oracle REST Data Services (ORDS) for Autonomous Exadata VM cluster.<br />
`rotate_autonomous_vm_cluster_ords_certs`	`exec`	`autonomousVmClusterId`, `region`, `certificateGenerationType`	`opc-request-id`, `opc-retry-token`, `if-match`	Rotates the Oracle REST Data Services (ORDS) certificates for Autonomous Exadata VM cluster.<br />
`rotate_autonomous_vm_cluster_ssl_certs`	`exec`	`autonomousVmClusterId`, `region`, `certificateGenerationType`	`opc-request-id`, `opc-retry-token`, `if-match`	Rotates the SSL certificates for Autonomous Exadata VM cluster.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`autonomousVmClusterId`	`string`	The autonomous VM cluster [OCID](/Content/General/Concepts/identifiers.htm).
`compartmentId`	`string`	The compartment [OCID](/Content/General/Concepts/identifiers.htm).
`region`	`string`	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
`displayName`	`string`	A filter to return only resources that match the entire display name given. The match is not case sensitive.
`exadataInfrastructureId`	`string`	If provided, filters the results for the given Exadata Infrastructure.
`if-match`	`string`	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`lifecycleState`	`string`	A filter to return only resources that match the given lifecycle state exactly.
`limit`	`integer`	The maximum number of items to return per page.
`opc-request-id`	`string`	Unique identifier for the request.
`opc-retry-token`	`string`	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`page`	`string`	The pagination token to continue listing from.
`sortBy`	`string`	The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
`sortOrder`	`string`	The sort order to use, either ascending (`ASC`) or descending (`DESC`).

`SELECT` examples

get
list

Gets information about the specified Autonomous VM cluster for an Exadata Cloud@Customer system. To get information about an Autonomous VM Cluster in the Oracle cloud, see [GetCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/GetCloudAutonomousVmCluster).

SELECT
id,
autonomousDataStoragePercentage,
autonomousDataStorageSizeInTBs,
availableAutonomousDataStorageSizeInTBs,
availableContainerDatabases,
availableCpus,
availableDataStorageSizeInTBs,
compartmentId,
computeModel,
cpuCoreCountPerNode,
cpuPercentage,
cpusEnabled,
cpusLowestScaledValue,
dataStorageSizeInGBs,
dataStorageSizeInTBs,
dbNodeStorageSizeInGBs,
dbServers,
definedTags,
displayName,
distributionAlgorithm,
exadataInfrastructureId,
exadataStorageInTBsLowestScaledValue,
freeformTags,
isLocalBackupEnabled,
isMtlsEnabled,
lastMaintenanceRunId,
licenseModel,
lifecycleDetails,
lifecycleState,
maintenanceWindow,
maxAcdsLowestScaledValue,
memoryPerOracleComputeUnitInGBs,
memorySizeInGBs,
nextMaintenanceRunId,
nodeCount,
nonProvisionableAutonomousContainerDatabases,
ocpusEnabled,
provisionableAutonomousContainerDatabases,
provisionedAutonomousContainerDatabases,
provisionedCpus,
reclaimableCpus,
reservedCpus,
scanListenerPortNonTls,
scanListenerPortTls,
sgaPercentage,
systemTags,
timeCreated,
timeDatabaseSslCertificateExpires,
timeOrdsCertificateExpires,
timeZone,
totalAutonomousDataStorageInTBs,
totalContainerDatabases,
vmClusterNetworkId
FROM oci.database.autonomous_vm_clusters
WHERE autonomousVmClusterId = '{{ autonomousVmClusterId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

Gets a list of Exadata Cloud@Customer Autonomous VM clusters in the specified compartment. To list Autonomous VM Clusters in the Oracle Cloud, see [ListCloudAutonomousVmClusters](#/en/database/latest/CloudAutonomousVmCluster/ListCloudAutonomousVmClusters).

SELECT
id,
autonomousDataStoragePercentage,
autonomousDataStorageSizeInTBs,
availableAutonomousDataStorageSizeInTBs,
availableContainerDatabases,
availableCpus,
availableDataStorageSizeInTBs,
compartmentId,
computeModel,
cpuCoreCountPerNode,
cpuPercentage,
cpusEnabled,
cpusLowestScaledValue,
dataStorageSizeInGBs,
dataStorageSizeInTBs,
dbNodeStorageSizeInGBs,
dbServers,
definedTags,
displayName,
distributionAlgorithm,
exadataInfrastructureId,
exadataStorageInTBsLowestScaledValue,
freeformTags,
isLocalBackupEnabled,
isMtlsEnabled,
lastMaintenanceRunId,
licenseModel,
lifecycleDetails,
lifecycleState,
maintenanceWindow,
maxAcdsLowestScaledValue,
memoryPerOracleComputeUnitInGBs,
memorySizeInGBs,
nextMaintenanceRunId,
nodeCount,
nonProvisionableAutonomousContainerDatabases,
ocpusEnabled,
provisionableAutonomousContainerDatabases,
provisionedAutonomousContainerDatabases,
provisionedCpus,
reclaimableCpus,
reservedCpus,
scanListenerPortNonTls,
scanListenerPortTls,
sgaPercentage,
systemTags,
timeCreated,
timeDatabaseSslCertificateExpires,
timeOrdsCertificateExpires,
timeZone,
totalAutonomousDataStorageInTBs,
totalContainerDatabases,
vmClusterNetworkId
FROM oci.database.autonomous_vm_clusters
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND exadataInfrastructureId = '{{ exadataInfrastructureId }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
AND displayName = '{{ displayName }}'
AND opc-request-id = '{{ opc-request-id }}'
;

`INSERT` examples

create
Manifest

Creates an Autonomous VM cluster for Exadata Cloud@Customer. To create an Autonomous VM Cluster in the Oracle cloud, see [CreateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/CreateCloudAutonomousVmCluster).

INSERT INTO oci.database.autonomous_vm_clusters (
autonomousDataStorageSizeInTBs,
compartmentId,
computeModel,
cpuCoreCountPerNode,
dbServers,
definedTags,
displayName,
distributionAlgorithm,
exadataInfrastructureId,
freeformTags,
isLocalBackupEnabled,
isMtlsEnabled,
licenseModel,
maintenanceWindowDetails,
memoryPerOracleComputeUnitInGBs,
scanListenerPortNonTls,
scanListenerPortTls,
sgaPercentage,
timeZone,
totalContainerDatabases,
vmClusterNetworkId,
region,
opc-retry-token,
opc-request-id
)
SELECT 
{{ autonomousDataStorageSizeInTBs }},
'{{ compartmentId }}' /* required */,
'{{ computeModel }}',
{{ cpuCoreCountPerNode }},
'{{ dbServers }}',
'{{ definedTags }}',
'{{ displayName }}' /* required */,
'{{ distributionAlgorithm }}',
'{{ exadataInfrastructureId }}' /* required */,
'{{ freeformTags }}',
{{ isLocalBackupEnabled }},
{{ isMtlsEnabled }},
'{{ licenseModel }}',
'{{ maintenanceWindowDetails }}',
{{ memoryPerOracleComputeUnitInGBs }},
{{ scanListenerPortNonTls }},
{{ scanListenerPortTls }},
{{ sgaPercentage }},
'{{ timeZone }}',
{{ totalContainerDatabases }},
'{{ vmClusterNetworkId }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
autonomousDataStoragePercentage,
autonomousDataStorageSizeInTBs,
availableAutonomousDataStorageSizeInTBs,
availableContainerDatabases,
availableCpus,
availableDataStorageSizeInTBs,
compartmentId,
computeModel,
cpuCoreCountPerNode,
cpuPercentage,
cpusEnabled,
cpusLowestScaledValue,
dataStorageSizeInGBs,
dataStorageSizeInTBs,
dbNodeStorageSizeInGBs,
dbServers,
definedTags,
displayName,
distributionAlgorithm,
exadataInfrastructureId,
exadataStorageInTBsLowestScaledValue,
freeformTags,
isLocalBackupEnabled,
isMtlsEnabled,
lastMaintenanceRunId,
licenseModel,
lifecycleDetails,
lifecycleState,
maintenanceWindow,
maxAcdsLowestScaledValue,
memoryPerOracleComputeUnitInGBs,
memorySizeInGBs,
nextMaintenanceRunId,
nodeCount,
nonProvisionableAutonomousContainerDatabases,
ocpusEnabled,
provisionableAutonomousContainerDatabases,
provisionedAutonomousContainerDatabases,
provisionedCpus,
reclaimableCpus,
reservedCpus,
scanListenerPortNonTls,
scanListenerPortTls,
sgaPercentage,
systemTags,
timeCreated,
timeDatabaseSslCertificateExpires,
timeOrdsCertificateExpires,
timeZone,
totalAutonomousDataStorageInTBs,
totalContainerDatabases,
vmClusterNetworkId
;

# Description fields are for documentation purposes
- name: autonomous_vm_clusters
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the autonomous_vm_clusters resource.
  - name: autonomousDataStorageSizeInTBs
    value: {{ autonomousDataStorageSizeInTBs }}
    description: |
      The data disk group size to be allocated for Autonomous Databases, in TBs.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
  - name: computeModel
    value: "{{ computeModel }}"
    description: |
      The compute model of the Autonomous VM Cluster. ECPU compute model is the recommended model and OCPU compute model is legacy.
    valid_values: ['ECPU', 'OCPU']
    default: ECPU
  - name: cpuCoreCountPerNode
    value: {{ cpuCoreCountPerNode }}
    description: |
      The number of CPU cores to enable per VM cluster node.
  - name: dbServers
    value:
      - "{{ dbServers }}"
    description: |
      The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Db servers.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a namespace.
      For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The user-friendly name for the Autonomous VM cluster. The name does not need to be unique.
  - name: distributionAlgorithm
    value: "{{ distributionAlgorithm }}"
    description: |
      The distribution algorithm used for the Autonomous VM cluster.
    valid_values: ['RESOURCE_OPTIMIZED', 'DISTRIBUTION_OPTIMIZED']
  - name: exadataInfrastructureId
    value: "{{ exadataInfrastructureId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
  - name: freeformTags
    value: "{{ freeformTags }}"
    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 [Resource Tags](/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: isLocalBackupEnabled
    value: {{ isLocalBackupEnabled }}
    description: |
      If true, database backup on local Exadata storage is configured for the Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster.
  - name: isMtlsEnabled
    value: {{ isMtlsEnabled }}
    description: |
      Enable mutual TLS(mTLS) authentication for database while provisioning a VMCluster. Default is TLS.
    default: false
  - name: licenseModel
    value: "{{ licenseModel }}"
    description: |
      The Oracle license model that applies to the Autonomous VM cluster. The default is BRING_YOUR_OWN_LICENSE.
    valid_values: ['LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE']
  - name: maintenanceWindowDetails
    description: |
      The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
    value:
      customActionTimeoutInMins: {{ customActionTimeoutInMins }}
      daysOfWeek:
        - name: "{{ name }}"
      hoursOfDay:
        - {{ hoursOfDay }}
      isCustomActionTimeoutEnabled: {{ isCustomActionTimeoutEnabled }}
      leadTimeInWeeks: {{ leadTimeInWeeks }}
      months:
        - name: "{{ name }}"
      patchingMode: "{{ patchingMode }}"
      preference: "{{ preference }}"
      skipRu:
        - {{ skipRu }}
      weeksOfMonth:
        - {{ weeksOfMonth }}
  - name: memoryPerOracleComputeUnitInGBs
    value: {{ memoryPerOracleComputeUnitInGBs }}
    description: |
      The amount of memory (in GBs) to be enabled per OCPU or ECPU.
  - name: scanListenerPortNonTls
    value: {{ scanListenerPortNonTls }}
    description: |
      The SCAN Listener Non TLS port number. Default value is 1521.
  - name: scanListenerPortTls
    value: {{ scanListenerPortTls }}
    description: |
      The SCAN Listener TLS port number. Default value is 2484.
  - name: sgaPercentage
    value: {{ sgaPercentage }}
    description: |
      Percentage of ECPU memory allocated for SGA(System Global Area).
  - name: timeZone
    value: "{{ timeZone }}"
    description: |
      The time zone to use for the Autonomous VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm).
  - name: totalContainerDatabases
    value: {{ totalContainerDatabases }}
    description: |
      The total number of Autonomous Container Databases that can be created.
  - name: vmClusterNetworkId
    value: "{{ vmClusterNetworkId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network.
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: Unique identifier for the request. 
    description: Unique identifier for the request. 

`UPDATE` examples

update

Updates the specified Autonomous VM cluster for the Exadata Cloud@Customer system.To update an Autonomous VM Cluster in the Oracle cloud, see [UpdateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/UpdateCloudAutonomousVmCluster).

UPDATE oci.database.autonomous_vm_clusters
SET 
autonomousDataStorageSizeInTBs = {{ autonomousDataStorageSizeInTBs }},
cpuCoreCountPerNode = {{ cpuCoreCountPerNode }},
definedTags = '{{ definedTags }}',
distributionAlgorithm = '{{ distributionAlgorithm }}',
freeformTags = '{{ freeformTags }}',
isMtlsEnabled = {{ isMtlsEnabled }},
licenseModel = '{{ licenseModel }}',
maintenanceWindowDetails = '{{ maintenanceWindowDetails }}',
scanListenerPortNonTls = {{ scanListenerPortNonTls }},
scanListenerPortTls = {{ scanListenerPortTls }},
timeZone = '{{ timeZone }}',
totalContainerDatabases = {{ totalContainerDatabases }}
WHERE 
autonomousVmClusterId = '{{ autonomousVmClusterId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
autonomousDataStoragePercentage,
autonomousDataStorageSizeInTBs,
availableAutonomousDataStorageSizeInTBs,
availableContainerDatabases,
availableCpus,
availableDataStorageSizeInTBs,
compartmentId,
computeModel,
cpuCoreCountPerNode,
cpuPercentage,
cpusEnabled,
cpusLowestScaledValue,
dataStorageSizeInGBs,
dataStorageSizeInTBs,
dbNodeStorageSizeInGBs,
dbServers,
definedTags,
displayName,
distributionAlgorithm,
exadataInfrastructureId,
exadataStorageInTBsLowestScaledValue,
freeformTags,
isLocalBackupEnabled,
isMtlsEnabled,
lastMaintenanceRunId,
licenseModel,
lifecycleDetails,
lifecycleState,
maintenanceWindow,
maxAcdsLowestScaledValue,
memoryPerOracleComputeUnitInGBs,
memorySizeInGBs,
nextMaintenanceRunId,
nodeCount,
nonProvisionableAutonomousContainerDatabases,
ocpusEnabled,
provisionableAutonomousContainerDatabases,
provisionedAutonomousContainerDatabases,
provisionedCpus,
reclaimableCpus,
reservedCpus,
scanListenerPortNonTls,
scanListenerPortTls,
sgaPercentage,
systemTags,
timeCreated,
timeDatabaseSslCertificateExpires,
timeOrdsCertificateExpires,
timeZone,
totalAutonomousDataStorageInTBs,
totalContainerDatabases,
vmClusterNetworkId;

`DELETE` examples

delete

Deletes the specified Autonomous VM cluster in an Exadata Cloud@Customer system. To delete an Autonomous VM Cluster in the Oracle cloud, see [DeleteCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/DeleteCloudAutonomousVmCluster).

DELETE FROM oci.database.autonomous_vm_clusters
WHERE autonomousVmClusterId = '{{ autonomousVmClusterId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
;

Lifecycle Methods

change_compartment
restart_autonomous_vm_cluster_ords
rotate_autonomous_vm_cluster_ords_certs
rotate_autonomous_vm_cluster_ssl_certs

Moves an Autonomous VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer only. For systems in the Oracle cloud, see [ChangeAutonomousVmClusterCompartment](#/en/database/latest/AutonomousVmCluster/ChangeAutonomousVmClusterCompartment).

EXEC oci.database.autonomous_vm_clusters.change_compartment 
@autonomousVmClusterId='{{ autonomousVmClusterId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;

Restarts Oracle REST Data Services (ORDS) for Autonomous Exadata VM cluster.

EXEC oci.database.autonomous_vm_clusters.restart_autonomous_vm_cluster_ords 
@autonomousVmClusterId='{{ autonomousVmClusterId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}'
;

Rotates the Oracle REST Data Services (ORDS) certificates for Autonomous Exadata VM cluster.

EXEC oci.database.autonomous_vm_clusters.rotate_autonomous_vm_cluster_ords_certs 
@autonomousVmClusterId='{{ autonomousVmClusterId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"caBundleId": "{{ caBundleId }}", 
"certificateAuthorityId": "{{ certificateAuthorityId }}", 
"certificateGenerationType": "{{ certificateGenerationType }}", 
"certificateId": "{{ certificateId }}"
}'
;

Rotates the SSL certificates for Autonomous Exadata VM cluster.

EXEC oci.database.autonomous_vm_clusters.rotate_autonomous_vm_cluster_ssl_certs 
@autonomousVmClusterId='{{ autonomousVmClusterId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"caBundleId": "{{ caBundleId }}", 
"certificateAuthorityId": "{{ certificateAuthorityId }}", 
"certificateGenerationType": "{{ certificateGenerationType }}", 
"certificateId": "{{ certificateId }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​