Skip to main content

cloud_autonomous_vm_clusters

Creates, updates, deletes, gets or lists a cloud_autonomous_vm_clusters resource.

Overview​

Namecloud_autonomous_vm_clusters
TypeResource
Idoci.database.cloud_autonomous_vm_clusters

Fields​

The following fields are returned by SELECT queries:

Information about the cloud VM cluster.

NameDatatypeDescription
idstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the Cloud Autonomous VM cluster.
autonomousDataStoragePercentagenumber (float)The percentage of the data storage used for the Autonomous AI Databases in an Autonomous VM Cluster.
autonomousDataStorageSizeInTBsnumber (double)The data disk group size allocated for Autonomous AI Databases, in TBs.
availabilityDomainstringThe name of the availability domain that the cloud Autonomous VM cluster is located in.
availableAutonomousDataStorageSizeInTBsnumber (double)The data disk group size available for Autonomous AI Databases, in TBs.
availableContainerDatabasesintegerThe number of Autonomous Container Databases that can be created with the currently available local storage.
availableCpusnumber (float)CPU cores available for allocation to Autonomous AI Databases.
cloudExadataInfrastructureIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure.
clusterTimeZonestring (x-obmcs-time-zone)The time zone of the Cloud Autonomous VM Cluster.
compartmentIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
computeModelstringThe 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 AI Database on Dedicated Exadata #Infrastructure](https:​//docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. (ECPU, OCPU)
cpuCoreCountinteger (int32)The number of CPU cores on the cloud Autonomous VM cluster.
cpuCoreCountPerNodeintegerThe number of CPU cores enabled per VM cluster node.
cpuPercentagenumber (float)The percentage of total number of CPUs used in an Autonomous VM Cluster.
dataStorageSizeInGBsnumber (double)The total data storage allocated, in gigabytes (GB).
dataStorageSizeInTBsnumber (double)The total data storage allocated, in terabytes (TB).
dbNodeStorageSizeInGBsintegerThe local node storage allocated in GBs.
dbServersarrayThe list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Db servers.
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
descriptionstringUser defined description of the cloud Autonomous VM cluster.
displayNamestringThe user-friendly name for the cloud Autonomous VM cluster. The name does not need to be unique.
distributionAlgorithmstringThe distribution algorithm used for the Autonomous VM cluster. (RESOURCE_OPTIMIZED, DISTRIBUTION_OPTIMIZED)
domainstringThe domain name for the cloud Autonomous VM cluster.
exadataStorageInTBsLowestScaledValuenumber (double)The lowest value to which exadataStorage (in TBs) can be scaled down.
freeformTagsobjectFree-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"}
hostnamestringThe hostname for the cloud Autonomous VM cluster.
isMtlsEnabledVmClusterbooleanEnable mutual TLS(mTLS) authentication for database at time of provisioning a VMCluster. This is applicable to database TLS Certificates only. Default is TLS
lastMaintenanceRunIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run.
lastUpdateHistoryEntryIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance update history. This value is updated when a maintenance update starts.
licenseModelstringThe Oracle license model that applies to the Oracle Autonomous AI 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 AI Database software licenses and the Oracle AI Database service. Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https:​//docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https:​//docs.oracle.com/en/cloud/paas/autonomous-database/index.html) 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. (LICENSE_INCLUDED, BRING_YOUR_OWN_LICENSE)
lifecycleDetailsstringAdditional information about the current lifecycle state.
lifecycleStatestringThe current state of the cloud Autonomous VM cluster. (PROVISIONING, AVAILABLE, UPDATING, TERMINATING, TERMINATED, FAILED, MAINTENANCE_IN_PROGRESS)
maintenanceWindowobjectThe scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
maxAcdsLowestScaledValueinteger (int32)The lowest value to which maximum number of ACDs can be scaled down.
memoryPerOracleComputeUnitInGBsinteger (int32)The amount of memory (in GBs) to be enabled per OCPU or ECPU.
memorySizeInGBsinteger (int32)The memory allocated in GBs.
nextMaintenanceRunIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run.
nodeCountinteger (int32)The number of database servers in the cloud VM cluster.
nonProvisionableAutonomousContainerDatabasesintegerThe number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster.
nsgIdsarrayThe list of [OCIDs](/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 [Security Rules](/Content/Network/Concepts/securityrules.htm).
ocpuCountnumber (float)The number of CPU cores on the cloud Autonomous VM cluster. Only 1 decimal place is allowed for the fractional part.
ocpusLowestScaledValueinteger (int32)The lowest value to which ocpus can be scaled down.
provisionableAutonomousContainerDatabasesintegerThe number of provisionable Autonomous Container Databases in an Autonomous VM Cluster.
provisionedAutonomousContainerDatabasesintegerThe number of provisioned Autonomous Container Databases in an Autonomous VM Cluster.
provisionedCpusnumber (float)The number of CPUs provisioned in an Autonomous VM Cluster.
reclaimableCpusnumber (float)CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous AI 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.
reservedCpusnumber (float)The number of CPUs reserved in an Autonomous VM Cluster.
scanListenerPortNonTlsintegerThe SCAN Listener Non TLS port. Default is 1521.
scanListenerPortTlsintegerThe SCAN Listenenr TLS port. Default is 2484.
securityAttributesobjectSecurity Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
sgaPercentagenumber (float)Percentage of ECPU memory allocated for SGA(System Global Area).
shapestringThe model name of the Exadata hardware running the cloud Autonomous VM cluster.
subnetIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) 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.
systemTagsobjectSystem tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
timeCreatedstring (date-time)The date and time that the cloud Autonomous VM cluster was created.
timeDatabaseSslCertificateExpiresstring (date-time)The date and time of Database SSL certificate expiration.
timeOrdsCertificateExpiresstring (date-time)The date and time of ORDS certificate expiration.
timeUpdatedstring (date-time)The last date and time that the cloud Autonomous VM cluster was updated.
totalAutonomousDataStorageInTBsnumber (float)The total data disk group size for Autonomous AI Databases, in TBs.
totalContainerDatabasesintegerThe total number of Autonomous Container Databases that can be created with the allocated local storage.
totalCpusnumber (float)The total number of CPUs in an Autonomous VM Cluster.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectcloudAutonomousVmClusterId, regionopc-request-idGets information about the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Custustomer systems, see [GetAutonomousVmCluster ](#/en/database/latest/AutonomousVmCluster/GetAutonomousVmCluster).<br />
listselectcompartmentId, regioncloudExadataInfrastructureId, limit, page, sortBy, sortOrder, lifecycleState, availabilityDomain, displayName, opc-request-idLists Autonomous Exadata VM clusters in the Oracle cloud. For Exadata Cloud@Customer systems, see [ListAutonomousVmClusters](#/en/database/latest/AutonomousVmCluster/ListAutonomousVmClusters).<br />
createinsertregion, compartmentId, displayName, cloudExadataInfrastructureId, subnetIdopc-retry-token, opc-request-idCreates an Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [CreateAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/CreateAutonomousVmCluster).<br />
updateupdatecloudAutonomousVmClusterId, regionif-match, opc-request-idUpdates the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [UpdateAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/UpdateAutonomousVmCluster).<br />
deletedeletecloudAutonomousVmClusterId, regionif-match, opc-request-idDeletes the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [DeleteAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/DeleteAutonomousVmCluster).<br />
change_compartmentexeccloudAutonomousVmClusterId, region, compartmentIdopc-retry-token, opc-request-id, if-matchMoves an Autonomous Exadata VM cluster in the Oracle cloud and its dependent resources to another compartment. For Exadata Cloud@Customer systems, see [ChangeAutonomousVmClusterCompartment](#/en/database/latest/AutonomousVmCluster/ChangeAutonomousVmClusterCompartment).<br />
restart_cloud_autonomous_vm_cluster_ordsexeccloudAutonomousVmClusterId, regionopc-retry-token, opc-request-id, if-matchRestarts Oracle REST Data Services (ORDS) for a cloud Autonomous Exadata VM cluster.<br />
rotate_cloud_autonomous_vm_cluster_ords_certsexeccloudAutonomousVmClusterId, region, certificateGenerationTypeopc-retry-token, opc-request-id, if-matchRotates the Oracle REST Data Services (ORDS) certificates for a cloud Autonomous Exadata VM cluster.<br />
rotate_cloud_autonomous_vm_cluster_ssl_certsexeccloudAutonomousVmClusterId, region, certificateGenerationTypeopc-retry-token, opc-request-id, if-matchRotates the SSL certficates for a cloud 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.

NameDatatypeDescription
cloudAutonomousVmClusterIdstringThe Cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm).
compartmentIdstringThe compartment [OCID](/Content/General/Concepts/identifiers.htm).
regionstringOCI 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)
availabilityDomainstringA filter to return only resources that match the given availability domain exactly.
cloudExadataInfrastructureIdstringIf provided, filters the results for the specified cloud Exadata infrastructure.
displayNamestringA filter to return only resources that match the entire display name given. The match is not case sensitive.
if-matchstringFor 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.
lifecycleStatestringA filter to return only resources that match the given lifecycle state exactly.
limitintegerThe maximum number of items to return per page.
opc-request-idstringUnique identifier for the request.
opc-retry-tokenstringA 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).
pagestringThe pagination token to continue listing from.
sortBystringThe 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.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC).

SELECT examples​

Gets information about the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Custustomer systems, see [GetAutonomousVmCluster ](#/en/database/latest/AutonomousVmCluster/GetAutonomousVmCluster).<br />

SELECT
id,
autonomousDataStoragePercentage,
autonomousDataStorageSizeInTBs,
availabilityDomain,
availableAutonomousDataStorageSizeInTBs,
availableContainerDatabases,
availableCpus,
cloudExadataInfrastructureId,
clusterTimeZone,
compartmentId,
computeModel,
cpuCoreCount,
cpuCoreCountPerNode,
cpuPercentage,
dataStorageSizeInGBs,
dataStorageSizeInTBs,
dbNodeStorageSizeInGBs,
dbServers,
definedTags,
description,
displayName,
distributionAlgorithm,
domain,
exadataStorageInTBsLowestScaledValue,
freeformTags,
hostname,
isMtlsEnabledVmCluster,
lastMaintenanceRunId,
lastUpdateHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
maintenanceWindow,
maxAcdsLowestScaledValue,
memoryPerOracleComputeUnitInGBs,
memorySizeInGBs,
nextMaintenanceRunId,
nodeCount,
nonProvisionableAutonomousContainerDatabases,
nsgIds,
ocpuCount,
ocpusLowestScaledValue,
provisionableAutonomousContainerDatabases,
provisionedAutonomousContainerDatabases,
provisionedCpus,
reclaimableCpus,
reservedCpus,
scanListenerPortNonTls,
scanListenerPortTls,
securityAttributes,
sgaPercentage,
shape,
subnetId,
systemTags,
timeCreated,
timeDatabaseSslCertificateExpires,
timeOrdsCertificateExpires,
timeUpdated,
totalAutonomousDataStorageInTBs,
totalContainerDatabases,
totalCpus
FROM oci.database.cloud_autonomous_vm_clusters
WHERE cloudAutonomousVmClusterId = '{{ cloudAutonomousVmClusterId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates an Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [CreateAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/CreateAutonomousVmCluster).<br />

INSERT INTO oci.database.cloud_autonomous_vm_clusters (
autonomousDataStorageSizeInTBs,
cloudExadataInfrastructureId,
clusterTimeZone,
compartmentId,
computeModel,
cpuCoreCountPerNode,
dbServers,
definedTags,
description,
displayName,
distributionAlgorithm,
freeformTags,
isMtlsEnabledVmCluster,
licenseModel,
maintenanceWindowDetails,
memoryPerOracleComputeUnitInGBs,
nsgIds,
scanListenerPortNonTls,
scanListenerPortTls,
securityAttributes,
sgaPercentage,
subnetId,
totalContainerDatabases,
region,
opc-retry-token,
opc-request-id
)
SELECT
{{ autonomousDataStorageSizeInTBs }},
'{{ cloudExadataInfrastructureId }}' /* required */,
'{{ clusterTimeZone }}',
'{{ compartmentId }}' /* required */,
'{{ computeModel }}',
{{ cpuCoreCountPerNode }},
'{{ dbServers }}',
'{{ definedTags }}',
'{{ description }}',
'{{ displayName }}' /* required */,
'{{ distributionAlgorithm }}',
'{{ freeformTags }}',
{{ isMtlsEnabledVmCluster }},
'{{ licenseModel }}',
'{{ maintenanceWindowDetails }}',
{{ memoryPerOracleComputeUnitInGBs }},
'{{ nsgIds }}',
{{ scanListenerPortNonTls }},
{{ scanListenerPortTls }},
'{{ securityAttributes }}',
{{ sgaPercentage }},
'{{ subnetId }}' /* required */,
{{ totalContainerDatabases }},
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
autonomousDataStoragePercentage,
autonomousDataStorageSizeInTBs,
availabilityDomain,
availableAutonomousDataStorageSizeInTBs,
availableContainerDatabases,
availableCpus,
cloudExadataInfrastructureId,
clusterTimeZone,
compartmentId,
computeModel,
cpuCoreCount,
cpuCoreCountPerNode,
cpuPercentage,
dataStorageSizeInGBs,
dataStorageSizeInTBs,
dbNodeStorageSizeInGBs,
dbServers,
definedTags,
description,
displayName,
distributionAlgorithm,
domain,
exadataStorageInTBsLowestScaledValue,
freeformTags,
hostname,
isMtlsEnabledVmCluster,
lastMaintenanceRunId,
lastUpdateHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
maintenanceWindow,
maxAcdsLowestScaledValue,
memoryPerOracleComputeUnitInGBs,
memorySizeInGBs,
nextMaintenanceRunId,
nodeCount,
nonProvisionableAutonomousContainerDatabases,
nsgIds,
ocpuCount,
ocpusLowestScaledValue,
provisionableAutonomousContainerDatabases,
provisionedAutonomousContainerDatabases,
provisionedCpus,
reclaimableCpus,
reservedCpus,
scanListenerPortNonTls,
scanListenerPortTls,
securityAttributes,
sgaPercentage,
shape,
subnetId,
systemTags,
timeCreated,
timeDatabaseSslCertificateExpires,
timeOrdsCertificateExpires,
timeUpdated,
totalAutonomousDataStorageInTBs,
totalContainerDatabases,
totalCpus
;

UPDATE examples​

Updates the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [UpdateAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/UpdateAutonomousVmCluster).<br />

UPDATE oci.database.cloud_autonomous_vm_clusters
SET
autonomousDataStorageSizeInTBs = {{ autonomousDataStorageSizeInTBs }},
clusterTimeZone = '{{ clusterTimeZone }}',
cpuCoreCountPerNode = {{ cpuCoreCountPerNode }},
definedTags = '{{ definedTags }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
distributionAlgorithm = '{{ distributionAlgorithm }}',
freeformTags = '{{ freeformTags }}',
isMtlsEnabledVmCluster = {{ isMtlsEnabledVmCluster }},
licenseModel = '{{ licenseModel }}',
maintenanceWindowDetails = '{{ maintenanceWindowDetails }}',
nsgIds = '{{ nsgIds }}',
scanListenerPortNonTls = {{ scanListenerPortNonTls }},
scanListenerPortTls = {{ scanListenerPortTls }},
securityAttributes = '{{ securityAttributes }}',
totalContainerDatabases = {{ totalContainerDatabases }}
WHERE
cloudAutonomousVmClusterId = '{{ cloudAutonomousVmClusterId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
autonomousDataStoragePercentage,
autonomousDataStorageSizeInTBs,
availabilityDomain,
availableAutonomousDataStorageSizeInTBs,
availableContainerDatabases,
availableCpus,
cloudExadataInfrastructureId,
clusterTimeZone,
compartmentId,
computeModel,
cpuCoreCount,
cpuCoreCountPerNode,
cpuPercentage,
dataStorageSizeInGBs,
dataStorageSizeInTBs,
dbNodeStorageSizeInGBs,
dbServers,
definedTags,
description,
displayName,
distributionAlgorithm,
domain,
exadataStorageInTBsLowestScaledValue,
freeformTags,
hostname,
isMtlsEnabledVmCluster,
lastMaintenanceRunId,
lastUpdateHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
maintenanceWindow,
maxAcdsLowestScaledValue,
memoryPerOracleComputeUnitInGBs,
memorySizeInGBs,
nextMaintenanceRunId,
nodeCount,
nonProvisionableAutonomousContainerDatabases,
nsgIds,
ocpuCount,
ocpusLowestScaledValue,
provisionableAutonomousContainerDatabases,
provisionedAutonomousContainerDatabases,
provisionedCpus,
reclaimableCpus,
reservedCpus,
scanListenerPortNonTls,
scanListenerPortTls,
securityAttributes,
sgaPercentage,
shape,
subnetId,
systemTags,
timeCreated,
timeDatabaseSslCertificateExpires,
timeOrdsCertificateExpires,
timeUpdated,
totalAutonomousDataStorageInTBs,
totalContainerDatabases,
totalCpus;

DELETE examples​

Deletes the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [DeleteAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/DeleteAutonomousVmCluster).<br />

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

Lifecycle Methods​

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

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