Skip to main content

vm_clusters

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

Overview​

Namevm_clusters
TypeResource
Idoci.database.vm_clusters

Fields​

The following fields are returned by SELECT queries:

Information about the Exadata Cloud@Customer VM cluster.

NameDatatypeDescription
idstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster.
availabilityDomainstringThe name of the availability domain that the VM cluster is located in.
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.)
cpusEnabledintegerThe number of enabled CPU cores.
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.
dataStorageSizeInGBsnumber (double)Size of the DATA disk group in GBs.
dataStorageSizeInTBsnumber (double)Size, in terabytes, of the DATA disk group.
dbNodeStorageSizeInGBsintegerThe local node storage allocated in GBs.
dbServersarrayThe list of Db server.
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).
displayNamestringThe user-friendly name for the Exadata Cloud@Customer VM cluster. The name does not need to be unique.
exadataInfrastructureIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
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.
giVersionstringThe Oracle Grid Infrastructure software version for the VM cluster.
isLocalBackupEnabledbooleanIf true, database backup on local Exadata storage is configured for the VM cluster. If false, database backup on local Exadata storage is not available in the VM cluster.
isSparseDiskgroupEnabledbooleanIf true, sparse disk group is configured for the VM cluster. If false, sparse disk group is not created.
lastPatchHistoryEntryIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation starts.
licenseModelstringThe Oracle license model that applies to the 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 VM cluster. (PROVISIONING, AVAILABLE, UPDATING, TERMINATING, TERMINATED, FAILED, MAINTENANCE_IN_PROGRESS)
memorySizeInGBsintegerThe memory allocated in GBs.
ocpusEnablednumber (float)The number of enabled OCPU cores.
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.
shapestringThe shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.
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 VM cluster.
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.
timeCreatedstring (date-time)The date and time that the VM cluster was created.
timeZonestring (x-obmcs-time-zone)The time zone of the Exadata infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm).
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)
vmClusterNetworkIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network.
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)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectvmClusterId, regionopc-request-idGets information about the VM cluster. Applies to Exadata Cloud@Customer instances only.<br />
listselectcompartmentId, regionexadataInfrastructureId, limit, page, sortBy, sortOrder, lifecycleState, displayName, opc-request-idLists the VM clusters in the specified compartment. Applies to Exadata Cloud@Customer instances only.<br />To list the cloud VM clusters in an Exadata Cloud Service instance, use the [ListCloudVmClusters ](#/en/database/latest/CloudVmCluster/ListCloudVmClusters) operation.<br />
createinsertregion, compartmentId, displayName, exadataInfrastructureId, cpuCoreCount, vmClusterNetworkId, sshPublicKeys, giVersionopc-retry-token, opc-request-idCreates an Exadata Cloud@Customer VM cluster.<br />
updateupdatevmClusterId, regionif-match, opc-request-idUpdates the specified VM cluster. Applies to Exadata Cloud@Customer instances only.<br />
deletedeletevmClusterId, regionif-match, opc-request-idDeletes the specified VM cluster. Applies to Exadata Cloud@Customer instances only.<br />
add_virtual_machine_to_vm_clusterexecvmClusterId, region, dbServersopc-retry-token, opc-request-id, if-matchAdd Virtual Machines to the VM cluster. Applies to Exadata Cloud@Customer instances only.<br />
change_compartmentexecvmClusterId, region, compartmentIdopc-retry-token, opc-request-id, if-matchMoves a VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer instances only.<br />To move a cloud VM cluster in an Exadata Cloud Service instance to another compartment, use the [ChangeCloudVmClusterCompartment ](#/en/database/latest/CloudVmCluster/ChangeCloudVmClusterCompartment) operation.<br />
remove_virtual_machine_from_vm_clusterexecvmClusterId, region, dbServersopc-retry-token, opc-request-id, if-matchRemove Virtual Machines from the VM cluster. Applies to Exadata Cloud@Customer instances only.<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
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)
vmClusterIdstringThe VM cluster [OCID](/Content/General/Concepts/identifiers.htm).
displayNamestringA filter to return only resources that match the entire display name given. The match is not case sensitive.
exadataInfrastructureIdstringIf provided, filters the results for the given Exadata Infrastructure.
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 VM cluster. Applies to Exadata Cloud@Customer instances only.<br />

SELECT
id,
availabilityDomain,
compartmentId,
computeModel,
cpusEnabled,
dataCollectionOptions,
dataStoragePercentage,
dataStorageSizeInGBs,
dataStorageSizeInTBs,
dbNodeStorageSizeInGBs,
dbServers,
definedTags,
displayName,
exadataInfrastructureId,
fileSystemConfigurationDetails,
freeformTags,
giSoftwareImageId,
giVersion,
isLocalBackupEnabled,
isSparseDiskgroupEnabled,
lastPatchHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
memorySizeInGBs,
ocpusEnabled,
recoStoragePercentage,
shape,
sparseStoragePercentage,
sshPublicKeys,
systemTags,
systemVersion,
timeCreated,
timeZone,
vmBackupStorageType,
vmClusterNetworkId,
vmFileSystemStorageType
FROM oci.database.vm_clusters
WHERE vmClusterId = '{{ vmClusterId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates an Exadata Cloud@Customer VM cluster.<br />

INSERT INTO oci.database.vm_clusters (
compartmentId,
cpuCoreCount,
dataCollectionOptions,
dataStoragePercentage,
dataStorageSizeInGBs,
dataStorageSizeInTBs,
dbNodeStorageSizeInGBs,
dbServers,
definedTags,
displayName,
exadataInfrastructureId,
fileSystemConfigurationDetails,
freeformTags,
giVersion,
isLocalBackupEnabled,
isSparseDiskgroupEnabled,
licenseModel,
memorySizeInGBs,
ocpuCount,
recoStoragePercentage,
sparseStoragePercentage,
sshPublicKeys,
systemVersion,
timeZone,
vmBackupStorageType,
vmClusterNetworkId,
vmFileSystemStorageType,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ compartmentId }}' /* required */,
{{ cpuCoreCount }} /* required */,
'{{ dataCollectionOptions }}',
{{ dataStoragePercentage }},
{{ dataStorageSizeInGBs }},
{{ dataStorageSizeInTBs }},
{{ dbNodeStorageSizeInGBs }},
'{{ dbServers }}',
'{{ definedTags }}',
'{{ displayName }}' /* required */,
'{{ exadataInfrastructureId }}' /* required */,
'{{ fileSystemConfigurationDetails }}',
'{{ freeformTags }}',
'{{ giVersion }}' /* required */,
{{ isLocalBackupEnabled }},
{{ isSparseDiskgroupEnabled }},
'{{ licenseModel }}',
{{ memorySizeInGBs }},
{{ ocpuCount }},
{{ recoStoragePercentage }},
{{ sparseStoragePercentage }},
'{{ sshPublicKeys }}' /* required */,
'{{ systemVersion }}',
'{{ timeZone }}',
'{{ vmBackupStorageType }}',
'{{ vmClusterNetworkId }}' /* required */,
'{{ vmFileSystemStorageType }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
availabilityDomain,
compartmentId,
computeModel,
cpusEnabled,
dataCollectionOptions,
dataStoragePercentage,
dataStorageSizeInGBs,
dataStorageSizeInTBs,
dbNodeStorageSizeInGBs,
dbServers,
definedTags,
displayName,
exadataInfrastructureId,
fileSystemConfigurationDetails,
freeformTags,
giSoftwareImageId,
giVersion,
isLocalBackupEnabled,
isSparseDiskgroupEnabled,
lastPatchHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
memorySizeInGBs,
ocpusEnabled,
recoStoragePercentage,
shape,
sparseStoragePercentage,
sshPublicKeys,
systemTags,
systemVersion,
timeCreated,
timeZone,
vmBackupStorageType,
vmClusterNetworkId,
vmFileSystemStorageType
;

UPDATE examples​

Updates the specified VM cluster. Applies to Exadata Cloud@Customer instances only.<br />

UPDATE oci.database.vm_clusters
SET 
cpuCoreCount = {{ cpuCoreCount }},
dataCollectionOptions = '{{ dataCollectionOptions }}',
dataStoragePercentage = {{ dataStoragePercentage }},
dataStorageSizeInGBs = {{ dataStorageSizeInGBs }},
dataStorageSizeInTBs = {{ dataStorageSizeInTBs }},
dbNodeStorageSizeInGBs = {{ dbNodeStorageSizeInGBs }},
definedTags = '{{ definedTags }}',
fileSystemConfigurationDetails = '{{ fileSystemConfigurationDetails }}',
freeformTags = '{{ freeformTags }}',
isLocalBackupEnabled = {{ isLocalBackupEnabled }},
isSparseDiskgroupEnabled = {{ isSparseDiskgroupEnabled }},
licenseModel = '{{ licenseModel }}',
memorySizeInGBs = {{ memorySizeInGBs }},
ocpuCount = {{ ocpuCount }},
recoStoragePercentage = {{ recoStoragePercentage }},
sparseStoragePercentage = {{ sparseStoragePercentage }},
sshPublicKeys = '{{ sshPublicKeys }}',
updateDetails = '{{ updateDetails }}',
version = '{{ version }}',
vmBackupStorageType = '{{ vmBackupStorageType }}'
WHERE 
vmClusterId = '{{ vmClusterId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
availabilityDomain,
compartmentId,
computeModel,
cpusEnabled,
dataCollectionOptions,
dataStoragePercentage,
dataStorageSizeInGBs,
dataStorageSizeInTBs,
dbNodeStorageSizeInGBs,
dbServers,
definedTags,
displayName,
exadataInfrastructureId,
fileSystemConfigurationDetails,
freeformTags,
giSoftwareImageId,
giVersion,
isLocalBackupEnabled,
isSparseDiskgroupEnabled,
lastPatchHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
memorySizeInGBs,
ocpusEnabled,
recoStoragePercentage,
shape,
sparseStoragePercentage,
sshPublicKeys,
systemTags,
systemVersion,
timeCreated,
timeZone,
vmBackupStorageType,
vmClusterNetworkId,
vmFileSystemStorageType;

DELETE examples​

Deletes the specified VM cluster. Applies to Exadata Cloud@Customer instances only.<br />

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

Lifecycle Methods​

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

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