cloud_autonomous_vm_clusters
Creates, updates, deletes, gets or lists a cloud_autonomous_vm_clusters resource.
Overview​
| Name | cloud_autonomous_vm_clusters |
| Type | Resource |
| Id | oci.database.cloud_autonomous_vm_clusters |
Fields​
The following fields are returned by SELECT queries:
- get
- list
Information about the cloud VM cluster.
| Name | Datatype | Description |
|---|---|---|
id | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the Cloud Autonomous VM cluster. |
autonomousDataStoragePercentage | number (float) | The percentage of the data storage used for the Autonomous AI Databases in an Autonomous VM Cluster. |
autonomousDataStorageSizeInTBs | number (double) | The data disk group size allocated for Autonomous AI Databases, in TBs. |
availabilityDomain | string | The name of the availability domain that the cloud Autonomous VM cluster is located in. |
availableAutonomousDataStorageSizeInTBs | number (double) | The data disk group size available for Autonomous AI Databases, in TBs. |
availableContainerDatabases | integer | The number of Autonomous Container Databases that can be created with the currently available local storage. |
availableCpus | number (float) | CPU cores available for allocation to Autonomous AI Databases. |
cloudExadataInfrastructureId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure. |
clusterTimeZone | string (x-obmcs-time-zone) | The time zone of the Cloud Autonomous VM Cluster. |
compartmentId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. |
computeModel | string | 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 AI Database on Dedicated Exadata #Infrastructure](https:​//docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. (ECPU, OCPU) |
cpuCoreCount | integer (int32) | The number of CPU cores on the cloud Autonomous VM cluster. |
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. |
dataStorageSizeInGBs | number (double) | The total data storage allocated, in gigabytes (GB). |
dataStorageSizeInTBs | number (double) | The total data storage allocated, in terabytes (TB). |
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). |
description | string | User defined description of the cloud Autonomous VM cluster. |
displayName | string | The user-friendly name for the cloud 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) |
domain | string | The domain name for the cloud Autonomous VM cluster. |
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"} |
hostname | string | The hostname for the cloud Autonomous VM cluster. |
isMtlsEnabledVmCluster | 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 |
lastMaintenanceRunId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. |
lastUpdateHistoryEntryId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance update history. This value is updated when a maintenance update starts. |
licenseModel | string | The 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) |
lifecycleDetails | string | Additional information about the current lifecycle state. |
lifecycleState | string | The current state of the cloud 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 (int32) | The amount of memory (in GBs) to be enabled per OCPU or ECPU. |
memorySizeInGBs | integer (int32) | 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 database servers in the cloud VM cluster. |
nonProvisionableAutonomousContainerDatabases | integer | The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster. |
nsgIds | array | The 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). |
ocpuCount | number (float) | The number of CPU cores on the cloud Autonomous VM cluster. Only 1 decimal place is allowed for the fractional part. |
ocpusLowestScaledValue | integer (int32) | The lowest value to which ocpus can be scaled down. |
provisionableAutonomousContainerDatabases | integer | The number of provisionable Autonomous Container Databases in an Autonomous VM Cluster. |
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 | number (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. |
reservedCpus | number (float) | The number of CPUs reserved in an Autonomous VM Cluster. |
scanListenerPortNonTls | integer | The SCAN Listener Non TLS port. Default is 1521. |
scanListenerPortTls | integer | The SCAN Listenenr TLS port. Default is 2484. |
securityAttributes | object | Security 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"}}} |
sgaPercentage | number (float) | Percentage of ECPU memory allocated for SGA(System Global Area). |
shape | string | The model name of the Exadata hardware running the cloud Autonomous VM cluster. |
subnetId | string | The [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. |
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 cloud Autonomous VM cluster was created. |
timeDatabaseSslCertificateExpires | string (date-time) | The date and time of Database SSL certificate expiration. |
timeOrdsCertificateExpires | string (date-time) | The date and time of ORDS certificate expiration. |
timeUpdated | string (date-time) | The last date and time that the cloud Autonomous VM cluster was updated. |
totalAutonomousDataStorageInTBs | number (float) | The total data disk group size for Autonomous AI Databases, in TBs. |
totalContainerDatabases | integer | The total number of Autonomous Container Databases that can be created with the allocated local storage. |
totalCpus | number (float) | The total number of CPUs in an Autonomous VM Cluster. |
Details of the cloud Autonomous VM cluster.<br />
| Name | Datatype | Description |
|---|---|---|
id | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the Cloud Autonomous VM cluster. |
autonomousDataStoragePercentage | number (float) | The percentage of the data storage used for the Autonomous AI Databases in an Autonomous VM Cluster. |
autonomousDataStorageSizeInTBs | number (double) | The data disk group size allocated for Autonomous AI Databases, in TBs. |
availabilityDomain | string | The name of the availability domain that the cloud Autonomous VM cluster is located in. |
availableAutonomousDataStorageSizeInTBs | number (double) | The data disk group size available for Autonomous AI Databases, in TBs. |
availableContainerDatabases | integer | The number of Autonomous Container Databases that can be created with the currently available local storage. |
availableCpus | number (float) | CPU cores available for allocation to Autonomous AI Databases. |
cloudExadataInfrastructureId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure. |
clusterTimeZone | string (x-obmcs-time-zone) | The time zone of the Cloud Autonomous VM Cluster. |
compartmentId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. |
computeModel | string | 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 AI Database on Dedicated Exadata #Infrastructure](https:​//docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. (ECPU, OCPU) |
cpuCoreCount | integer (int32) | The number of CPU cores on the cloud Autonomous VM cluster. |
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. |
dataStorageSizeInGBs | number (double) | The total data storage allocated, in gigabytes (GB). |
dataStorageSizeInTBs | number (double) | The total data storage allocated, in terabytes (TB). |
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). |
description | string | User defined description of the cloud Autonomous VM cluster. |
displayName | string | The user-friendly name for the cloud 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) |
domain | string | The domain name for the cloud Autonomous VM cluster. |
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"} |
hostname | string | The hostname for the cloud Autonomous VM cluster. |
isMtlsEnabledVmCluster | 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 |
lastMaintenanceRunId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. |
lastUpdateHistoryEntryId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance update history. This value is updated when a maintenance update starts. |
licenseModel | string | The 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) |
lifecycleDetails | string | Additional information about the current lifecycle state. |
lifecycleState | string | The current state of the cloud 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 (int32) | The amount of memory (in GBs) to be enabled per OCPU or ECPU. |
memorySizeInGBs | integer (int32) | 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 database servers in the cloud VM cluster. |
nonProvisionableAutonomousContainerDatabases | integer | The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster. |
nsgIds | array | The 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). |
ocpuCount | number (float) | The number of CPU cores on the cloud Autonomous VM cluster. Only 1 decimal place is allowed for the fractional part. |
ocpusLowestScaledValue | integer (int32) | The lowest value to which ocpus can be scaled down. |
provisionableAutonomousContainerDatabases | integer | The number of provisionable Autonomous Container Databases in an Autonomous VM Cluster. |
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 | number (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. |
reservedCpus | number (float) | The number of CPUs reserved in an Autonomous VM Cluster. |
scanListenerPortNonTls | integer | The SCAN Listener Non TLS port. Default is 1521. |
scanListenerPortTls | integer | The SCAN Listenenr TLS port. Default is 2484. |
securityAttributes | object | Security 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"}}} |
sgaPercentage | number (float) | Percentage of ECPU memory allocated for SGA(System Global Area). |
shape | string | The model name of the Exadata hardware running the cloud Autonomous VM cluster. |
subnetId | string | The [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. |
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 cloud Autonomous VM cluster was created. |
timeDatabaseSslCertificateExpires | string (date-time) | The date and time of Database SSL certificate expiration. |
timeOrdsCertificateExpires | string (date-time) | The date and time of ORDS certificate expiration. |
timeUpdated | string (date-time) | The last date and time that the cloud Autonomous VM cluster was updated. |
totalAutonomousDataStorageInTBs | number (float) | The total data disk group size for Autonomous AI Databases, in TBs. |
totalContainerDatabases | integer | The total number of Autonomous Container Databases that can be created with the allocated local storage. |
totalCpus | number (float) | The total number of CPUs in an Autonomous VM Cluster. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | cloudAutonomousVmClusterId, region | opc-request-id | 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 /> |
list | select | compartmentId, region | cloudExadataInfrastructureId, limit, page, sortBy, sortOrder, lifecycleState, availabilityDomain, displayName, opc-request-id | Lists Autonomous Exadata VM clusters in the Oracle cloud. For Exadata Cloud@Customer systems, see [ListAutonomousVmClusters](#/en/database/latest/AutonomousVmCluster/ListAutonomousVmClusters).<br /> |
create | insert | region, compartmentId, displayName, cloudExadataInfrastructureId, subnetId | opc-retry-token, opc-request-id | Creates an Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [CreateAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/CreateAutonomousVmCluster).<br /> |
update | update | cloudAutonomousVmClusterId, region | if-match, opc-request-id | Updates the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [UpdateAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/UpdateAutonomousVmCluster).<br /> |
delete | delete | cloudAutonomousVmClusterId, region | if-match, opc-request-id | Deletes the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [DeleteAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/DeleteAutonomousVmCluster).<br /> |
change_compartment | exec | cloudAutonomousVmClusterId, region, compartmentId | opc-retry-token, opc-request-id, if-match | 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 /> |
restart_cloud_autonomous_vm_cluster_ords | exec | cloudAutonomousVmClusterId, region | opc-retry-token, opc-request-id, if-match | Restarts Oracle REST Data Services (ORDS) for a cloud Autonomous Exadata VM cluster.<br /> |
rotate_cloud_autonomous_vm_cluster_ords_certs | exec | cloudAutonomousVmClusterId, region, certificateGenerationType | opc-retry-token, opc-request-id, if-match | Rotates the Oracle REST Data Services (ORDS) certificates for a cloud Autonomous Exadata VM cluster.<br /> |
rotate_cloud_autonomous_vm_cluster_ssl_certs | exec | cloudAutonomousVmClusterId, region, certificateGenerationType | opc-retry-token, opc-request-id, if-match | Rotates 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.
| Name | Datatype | Description |
|---|---|---|
cloudAutonomousVmClusterId | string | The Cloud 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) |
availabilityDomain | string | A filter to return only resources that match the given availability domain exactly. |
cloudExadataInfrastructureId | string | If provided, filters the results for the specified cloud Exadata infrastructure. |
displayName | string | A filter to return only resources that match the entire display name given. The match is not case sensitive. |
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 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 }}'
;
Lists Autonomous Exadata VM clusters in the Oracle cloud. For Exadata Cloud@Customer systems, see [ListAutonomousVmClusters](#/en/database/latest/AutonomousVmCluster/ListAutonomousVmClusters).<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 compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND cloudExadataInfrastructureId = '{{ cloudExadataInfrastructureId }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
AND availabilityDomain = '{{ availabilityDomain }}'
AND displayName = '{{ displayName }}'
AND opc-request-id = '{{ opc-request-id }}'
;
INSERT examples​
- create
- Manifest
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
;
# Description fields are for documentation purposes
- name: cloud_autonomous_vm_clusters
props:
- name: region
value: "{{ region }}"
description: Required parameter for the cloud_autonomous_vm_clusters resource.
- name: autonomousDataStorageSizeInTBs
value: {{ autonomousDataStorageSizeInTBs }}
description: |
The data disk group size to be allocated for Autonomous AI Databases, in TBs.
- name: cloudExadataInfrastructureId
value: "{{ cloudExadataInfrastructureId }}"
description: |
The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure.
- name: clusterTimeZone
value: "{{ clusterTimeZone }}"
description: |
The time zone to use for the Cloud Autonomous VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm).
default: Etc/UTC
- 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 Cloud 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 be enabled per VM cluster node.
- name: dbServers
value:
- "{{ dbServers }}"
description: |
The list of database 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: description
value: "{{ description }}"
description: |
User defined description of the cloud Autonomous VM cluster.
- name: displayName
value: "{{ displayName }}"
description: |
The user-friendly name for the cloud 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: 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: isMtlsEnabledVmCluster
value: {{ isMtlsEnabledVmCluster }}
description: |
Enable mutual TLS(mTLS) authentication for database at time of provisioning a VMCluster. This is applicable to database TLS Certificates only. Default is TLS
default: false
- name: licenseModel
value: "{{ licenseModel }}"
description: |
The 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.
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: nsgIds
value:
- "{{ nsgIds }}"
description: |
The 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).
- name: scanListenerPortNonTls
value: {{ scanListenerPortNonTls }}
description: |
The SCAN Listener Non TLS port. Default is 1521.
- name: scanListenerPortTls
value: {{ scanListenerPortTls }}
description: |
The SCAN Listener TLS port. Default is 2484.
- name: securityAttributes
value: "{{ securityAttributes }}"
description: |
Security 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"}}}`
- name: sgaPercentage
value: {{ sgaPercentage }}
description: |
Percentage of ECPU memory allocated for SGA(System Global Area).
- name: subnetId
value: "{{ subnetId }}"
description: |
The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the cloud Autonomous VM Cluster is associated with.
- name: totalContainerDatabases
value: {{ totalContainerDatabases }}
description: |
The total number of Autonomous Container Databases that can be created.
- 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 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​
- delete
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​
- change_compartment
- restart_cloud_autonomous_vm_cluster_ords
- rotate_cloud_autonomous_vm_cluster_ords_certs
- rotate_cloud_autonomous_vm_cluster_ssl_certs
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 }}"
}'
;
Restarts Oracle REST Data Services (ORDS) for a cloud Autonomous Exadata VM cluster.<br />
EXEC oci.database.cloud_autonomous_vm_clusters.restart_cloud_autonomous_vm_cluster_ords
@cloudAutonomousVmClusterId='{{ cloudAutonomousVmClusterId }}' --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 a cloud Autonomous Exadata VM cluster.<br />
EXEC oci.database.cloud_autonomous_vm_clusters.rotate_cloud_autonomous_vm_cluster_ords_certs
@cloudAutonomousVmClusterId='{{ cloudAutonomousVmClusterId }}' --required,
@region='{{ region }}' --required,
@opc-retry-token='{{ opc-retry-token }}',
@opc-request-id='{{ opc-request-id }}',
@if-match='{{ if-match }}'
@@json=
'{
"caBundleId": "{{ caBundleId }}",
"certificateAuthorityId": "{{ certificateAuthorityId }}",
"certificateGenerationType": "{{ certificateGenerationType }}",
"certificateId": "{{ certificateId }}"
}'
;
Rotates the SSL certficates for a cloud Autonomous Exadata VM cluster.<br />
EXEC oci.database.cloud_autonomous_vm_clusters.rotate_cloud_autonomous_vm_cluster_ssl_certs
@cloudAutonomousVmClusterId='{{ cloudAutonomousVmClusterId }}' --required,
@region='{{ region }}' --required,
@opc-retry-token='{{ opc-retry-token }}',
@opc-request-id='{{ opc-request-id }}',
@if-match='{{ if-match }}'
@@json=
'{
"caBundleId": "{{ caBundleId }}",
"certificateAuthorityId": "{{ certificateAuthorityId }}",
"certificateGenerationType": "{{ certificateGenerationType }}",
"certificateId": "{{ certificateId }}"
}'
;