Skip to main content

cloud_vm_clusters

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

Overview​

Namecloud_vm_clusters
TypeResource
Idoci.database.cloud_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 VM cluster.
availabilityDomainstringThe name of the availability domain that the cloud Exadata infrastructure resource is located in.
backupNetworkNsgIdsarrayA list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems.
backupSubnetIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the cloud VM cluster. Subnet Restriction: See the subnet restrictions information for subnetId.
cloudExadataInfrastructureIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure.
clusterNamestringThe cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
compartmentIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
computeModelstringThe compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. (ECPU, OCPU) (x-default-description: Null used when unspecified.)
cpuCoreCountinteger (int32)The number of CPU cores enabled on the cloud VM cluster.
dataCollectionOptionsobjectIndicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
dataStoragePercentageinteger (int32)The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage.
dataStorageSizeInTBsnumber (double)The data disk group size to be allocated in TBs.
dbNodeStorageSizeInGBsintegerThe local node storage to be allocated in GBs.
dbServersarrayThe list of 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).
diskRedundancystringThe type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. (HIGH, NORMAL)
displayNamestringThe user-friendly name for the cloud VM cluster. The name does not need to be unique.
domainstringThe domain name for the cloud VM cluster.
exascaleDbStorageVaultIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault.
fileSystemConfigurationDetailsarrayDetails of the file system configuration of the VM cluster.
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"}
giSoftwareImageIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type GRID_IMAGE.
giVersionstringA valid Oracle Grid Infrastructure (GI) software version.
hostnamestringThe hostname for the cloud VM cluster.
iormConfigCacheobjectThe IORM settings of the Exadata DB system.
isLocalBackupEnabledbooleanIf true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster.
isSparseDiskgroupEnabledbooleanIf true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.
lastUpdateHistoryEntryIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance update history entry. This value is updated when a maintenance update starts.
licenseModelstringThe Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. (LICENSE_INCLUDED, BRING_YOUR_OWN_LICENSE)
lifecycleDetailsstringAdditional information about the current lifecycle state.
lifecycleStatestringThe current state of the cloud VM cluster. (PROVISIONING, AVAILABLE, UPDATING, TERMINATING, TERMINATED, FAILED, MAINTENANCE_IN_PROGRESS)
listenerPortinteger (int64)The port number configured for the listener on the cloud VM cluster.
memorySizeInGBsintegerThe memory to be allocated in GBs.
multiCloudIdentityConnectorConfigsarrayDetails of the multi cloud identity connectors of the VM cluster.
nodeCountinteger (int32)The number of nodes in the cloud 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 OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.
recoStoragePercentageinteger (int32)The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage.
scanDnsNamestringThe FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.
scanDnsRecordIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.
scanIpIdsarrayThe [OCID](/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. Note: For a single-node DB system, this list is empty.
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"}}}
shapestringThe model name of the Exadata hardware running the cloud VM cluster.
sparseStoragePercentageinteger (int32)The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage.
sshPublicKeysarrayThe public key portion of one or more key pairs used for SSH access to the cloud VM cluster.
storageManagementTypestringSpecifies the type of storage management for the Cloud VM Cluster if its ASM or Exascale. (ASM, EXASCALE)
storageSizeInGBsinteger (int32)The storage allocation for the disk group, in gigabytes (GB).
subnetIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the cloud VM cluster. Subnet Restrictions: - For Exadata and virtual machine 2-node RAC 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.
subscriptionIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.
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).
systemVersionstringOperating system version of the image.
tdeKeyStoreTypestringTDE keystore type (AZURE, OCI) (x-default-description: null)
timeCreatedstring (date-time)The date and time that the cloud VM cluster was created.
timeZonestringThe time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm).
vipIdsarrayThe [OCID](/Content/General/Concepts/identifiers.htm) of the virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. Note: For a single-node DB system, this list is empty.
vmBackupStorageTypestringSpecifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL (LOCAL, EXASCALE)
vmFileSystemStorageTypestringSpecifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL (LOCAL, EXASCALE)
zoneIdstringThe OCID of the zone the cloud VM cluster is associated with.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectcloudVmClusterId, regionopc-request-idGets information about the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.<br />
listselectcompartmentId, regioncloudExadataInfrastructureId, limit, page, sortBy, sortOrder, lifecycleState, displayName, opc-request-idGets a list of the cloud VM clusters in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.<br />
createinsertregion, compartmentId, displayName, cloudExadataInfrastructureId, cpuCoreCount, sshPublicKeys, giVersion, hostname, subnetId, backupSubnetIdopc-retry-token, opc-request-idCreates a cloud VM cluster.<br />
updateupdatecloudVmClusterId, regionif-match, opc-request-idUpdates the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.<br />
deletedeletecloudVmClusterId, regionif-match, opc-request-idDeletes the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.<br />
add_virtual_machine_to_cloud_vm_clusterexeccloudVmClusterId, region, dbServersopc-retry-token, opc-request-id, if-matchAdd Virtual Machines to the Cloud VM cluster. Applies to Exadata Cloud instances only.<br />
change_compartmentexeccloudVmClusterId, region, compartmentIdopc-retry-token, opc-request-id, if-matchMoves a cloud VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.<br />
change_cloud_vm_cluster_subscriptionexeccloudVmClusterId, regionopc-retry-token, opc-request-id, if-matchAssociate a cloud VM cluster with a different subscription.<br />
register_cloud_vm_cluster_pkcsexeccloudVmClusterId, region, tdeKeyStoreTypeopc-retry-token, opc-request-id, if-matchInstall the PKCS11 driver for given keystore type<br />
remove_virtual_machine_from_cloud_vm_clusterexeccloudVmClusterId, region, dbServersopc-retry-token, opc-request-id, if-matchRemove Virtual Machines from the Cloud VM cluster. Applies to Exadata Cloud instances only.<br />
unregister_cloud_vm_cluster_pkcsexeccloudVmClusterId, region, tdeKeyStoreTypeopc-retry-token, opc-request-id, if-matchUninstall the PKCS11 driver for given keystore type<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
cloudVmClusterIdstringThe 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)
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 cloud VM clusters 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 cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.<br />

SELECT
id,
availabilityDomain,
backupNetworkNsgIds,
backupSubnetId,
cloudExadataInfrastructureId,
clusterName,
compartmentId,
computeModel,
cpuCoreCount,
dataCollectionOptions,
dataStoragePercentage,
dataStorageSizeInTBs,
dbNodeStorageSizeInGBs,
dbServers,
definedTags,
diskRedundancy,
displayName,
domain,
exascaleDbStorageVaultId,
fileSystemConfigurationDetails,
freeformTags,
giSoftwareImageId,
giVersion,
hostname,
iormConfigCache,
isLocalBackupEnabled,
isSparseDiskgroupEnabled,
lastUpdateHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
listenerPort,
memorySizeInGBs,
multiCloudIdentityConnectorConfigs,
nodeCount,
nsgIds,
ocpuCount,
recoStoragePercentage,
scanDnsName,
scanDnsRecordId,
scanIpIds,
securityAttributes,
shape,
sparseStoragePercentage,
sshPublicKeys,
storageManagementType,
storageSizeInGBs,
subnetId,
subscriptionId,
systemTags,
systemVersion,
tdeKeyStoreType,
timeCreated,
timeZone,
vipIds,
vmBackupStorageType,
vmFileSystemStorageType,
zoneId
FROM oci.database.cloud_vm_clusters
WHERE cloudVmClusterId = '{{ cloudVmClusterId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates a cloud VM cluster.<br />

INSERT INTO oci.database.cloud_vm_clusters (
backupNetworkNsgIds,
backupSubnetId,
cloudExadataInfrastructureId,
clusterName,
compartmentId,
cpuCoreCount,
dataCollectionOptions,
dataStoragePercentage,
dataStorageSizeInTBs,
dbNodeStorageSizeInGBs,
dbServers,
definedTags,
displayName,
domain,
exascaleDbStorageVaultId,
fileSystemConfigurationDetails,
freeformTags,
giVersion,
hostname,
isLocalBackupEnabled,
isSparseDiskgroupEnabled,
licenseModel,
memorySizeInGBs,
nsgIds,
ocpuCount,
privateZoneId,
recoStoragePercentage,
securityAttributes,
sparseStoragePercentage,
sshPublicKeys,
subnetId,
subscriptionId,
systemVersion,
timeZone,
vmBackupStorageType,
vmFileSystemStorageType,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ backupNetworkNsgIds }}',
'{{ backupSubnetId }}' /* required */,
'{{ cloudExadataInfrastructureId }}' /* required */,
'{{ clusterName }}',
'{{ compartmentId }}' /* required */,
{{ cpuCoreCount }} /* required */,
'{{ dataCollectionOptions }}',
{{ dataStoragePercentage }},
{{ dataStorageSizeInTBs }},
{{ dbNodeStorageSizeInGBs }},
'{{ dbServers }}',
'{{ definedTags }}',
'{{ displayName }}' /* required */,
'{{ domain }}',
'{{ exascaleDbStorageVaultId }}',
'{{ fileSystemConfigurationDetails }}',
'{{ freeformTags }}',
'{{ giVersion }}' /* required */,
'{{ hostname }}' /* required */,
{{ isLocalBackupEnabled }},
{{ isSparseDiskgroupEnabled }},
'{{ licenseModel }}',
{{ memorySizeInGBs }},
'{{ nsgIds }}',
{{ ocpuCount }},
'{{ privateZoneId }}',
{{ recoStoragePercentage }},
'{{ securityAttributes }}',
{{ sparseStoragePercentage }},
'{{ sshPublicKeys }}' /* required */,
'{{ subnetId }}' /* required */,
'{{ subscriptionId }}',
'{{ systemVersion }}',
'{{ timeZone }}',
'{{ vmBackupStorageType }}',
'{{ vmFileSystemStorageType }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
availabilityDomain,
backupNetworkNsgIds,
backupSubnetId,
cloudExadataInfrastructureId,
clusterName,
compartmentId,
computeModel,
cpuCoreCount,
dataCollectionOptions,
dataStoragePercentage,
dataStorageSizeInTBs,
dbNodeStorageSizeInGBs,
dbServers,
definedTags,
diskRedundancy,
displayName,
domain,
exascaleDbStorageVaultId,
fileSystemConfigurationDetails,
freeformTags,
giSoftwareImageId,
giVersion,
hostname,
iormConfigCache,
isLocalBackupEnabled,
isSparseDiskgroupEnabled,
lastUpdateHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
listenerPort,
memorySizeInGBs,
multiCloudIdentityConnectorConfigs,
nodeCount,
nsgIds,
ocpuCount,
recoStoragePercentage,
scanDnsName,
scanDnsRecordId,
scanIpIds,
securityAttributes,
shape,
sparseStoragePercentage,
sshPublicKeys,
storageManagementType,
storageSizeInGBs,
subnetId,
subscriptionId,
systemTags,
systemVersion,
tdeKeyStoreType,
timeCreated,
timeZone,
vipIds,
vmBackupStorageType,
vmFileSystemStorageType,
zoneId
;

UPDATE examples​

Updates the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.<br />

UPDATE oci.database.cloud_vm_clusters
SET 
backupNetworkNsgIds = '{{ backupNetworkNsgIds }}',
computeNodes = '{{ computeNodes }}',
cpuCoreCount = {{ cpuCoreCount }},
dataCollectionOptions = '{{ dataCollectionOptions }}',
dataStoragePercentage = {{ dataStoragePercentage }},
dataStorageSizeInTBs = {{ dataStorageSizeInTBs }},
dbNodeStorageSizeInGBs = {{ dbNodeStorageSizeInGBs }},
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
fileSystemConfigurationDetails = '{{ fileSystemConfigurationDetails }}',
freeformTags = '{{ freeformTags }}',
isLocalBackupEnabled = {{ isLocalBackupEnabled }},
isSparseDiskgroupEnabled = {{ isSparseDiskgroupEnabled }},
licenseModel = '{{ licenseModel }}',
memorySizeInGBs = {{ memorySizeInGBs }},
nsgIds = '{{ nsgIds }}',
ocpuCount = {{ ocpuCount }},
recoStoragePercentage = {{ recoStoragePercentage }},
securityAttributes = '{{ securityAttributes }}',
sparseStoragePercentage = {{ sparseStoragePercentage }},
sshPublicKeys = '{{ sshPublicKeys }}',
storageSizeInGBs = {{ storageSizeInGBs }},
updateDetails = '{{ updateDetails }}',
vmBackupStorageType = '{{ vmBackupStorageType }}'
WHERE 
cloudVmClusterId = '{{ cloudVmClusterId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
availabilityDomain,
backupNetworkNsgIds,
backupSubnetId,
cloudExadataInfrastructureId,
clusterName,
compartmentId,
computeModel,
cpuCoreCount,
dataCollectionOptions,
dataStoragePercentage,
dataStorageSizeInTBs,
dbNodeStorageSizeInGBs,
dbServers,
definedTags,
diskRedundancy,
displayName,
domain,
exascaleDbStorageVaultId,
fileSystemConfigurationDetails,
freeformTags,
giSoftwareImageId,
giVersion,
hostname,
iormConfigCache,
isLocalBackupEnabled,
isSparseDiskgroupEnabled,
lastUpdateHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
listenerPort,
memorySizeInGBs,
multiCloudIdentityConnectorConfigs,
nodeCount,
nsgIds,
ocpuCount,
recoStoragePercentage,
scanDnsName,
scanDnsRecordId,
scanIpIds,
securityAttributes,
shape,
sparseStoragePercentage,
sshPublicKeys,
storageManagementType,
storageSizeInGBs,
subnetId,
subscriptionId,
systemTags,
systemVersion,
tdeKeyStoreType,
timeCreated,
timeZone,
vipIds,
vmBackupStorageType,
vmFileSystemStorageType,
zoneId;

DELETE examples​

Deletes the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.<br />

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

Lifecycle Methods​

Add Virtual Machines to the Cloud VM cluster. Applies to Exadata Cloud instances only.<br />

EXEC oci.database.cloud_vm_clusters.add_virtual_machine_to_cloud_vm_cluster 
@cloudVmClusterId='{{ cloudVmClusterId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"dbServers": "{{ dbServers }}"
}'
;