Skip to main content

exadb_vm_clusters

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

Overview​

Nameexadb_vm_clusters
TypeResource
Idoci.database.exadb_vm_clusters

Fields​

The following fields are returned by SELECT queries:

Information about the Exadata VM cluster on Exascale Infrastructure

NameDatatypeDescription
idstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata VM cluster on Exascale Infrastructure.
availabilityDomainstringThe name of the availability domain in which the Exadata VM cluster on Exascale Infrastructure is located.
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 Exadata VM cluster on Exascale Infrastructure.
clusterNamestringThe cluster name for Exadata VM cluster on Exascale Infrastructure. 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.
clusterPlacementGroupIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure.
compartmentIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
dataCollectionOptionsobjectIndicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
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 VM cluster on Exascale Infrastructure. The name does not need to be unique.
domainstringA domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, then the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Database Service on Exascale Infrastructure only.
enabledECpuCountinteger (int32)The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure.
exascaleDbStorageVaultIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault.
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"}
giVersionstringA valid Oracle Grid Infrastructure (GI) software version.
gridImageIdstringGrid Setup will be done using this grid image id. The grid image ID can be obtained using the API /20160918/giVersions/{majorVersion}/minorVersions?compartmentId=<compartmentId>&shapeFamily=EXADB_XS&availabilityDomain=<AD name>. The list of supported major versions can be obtained using the API /20160918/giVersions?compartmentId=<compartmentId>&shape=ExaDbXS&availabilityDomain=<AD name>
gridImageTypestringThe type of Grid Image (RELEASE_UPDATE, CUSTOM_IMAGE)
hostnamestringThe hostname for the Exadata VM cluster on Exascale Infrastructure. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). For Exadata systems, the maximum length of the hostname is 12 characters. The maximum length of the combined hostname and domain is 63 characters. Note: The hostname must be unique within the subnet. If it is not unique, then the Exadata VM cluster on Exascale Infrastructure will fail to provision.
iormConfigCacheobjectThe IORM settings of the Exadata DB system.
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 Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. (LICENSE_INCLUDED, BRING_YOUR_OWN_LICENSE)
lifecycleDetailsstringAdditional information about the current lifecycle state.
lifecycleStatestringThe current state of the Exadata VM cluster on Exascale Infrastructure. (PROVISIONING, AVAILABLE, UPDATING, TERMINATING, TERMINATED, FAILED, MAINTENANCE_IN_PROGRESS)
listenerPortinteger (int64)The port number configured for the listener on the Exadata VM cluster on Exascale Infrastructure.
memorySizeInGBsintegerThe memory that you want to be allocated in GBs. Memory is calculated based on 11 GB per VM core reserved.
nodeCountinteger (int32)The number of nodes in the Exadata VM cluster on Exascale Infrastructure.
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).
privateZoneIdstringThe private zone ID in which you want DNS records to be created.
scanDnsNamestringThe FQDN of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure.
scanDnsRecordIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure.
scanIpIdsarrayThe [OCID](/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IP addresses associated with the Exadata VM cluster on Exascale Infrastructure. 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.
scanListenerPortTcpintegerThe TCP Single Client Access Name (SCAN) port. The default port is 1521.
scanListenerPortTcpSslintegerThe Secured Communication (TCPS) protocol Single Client Access Name (SCAN) port. The default port 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: &#123;"Oracle-ZPR": &#123;"MaxEgressCount": &#123;"value": "42", "mode": "audit"&#125;&#125;&#125;
shapestringThe shape of the Exadata VM cluster on Exascale Infrastructure resource
shapeAttributestringThe type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later (SMART_STORAGE, BLOCK_STORAGE)
snapshotFileSystemStorageobjectStorage Details on the Exadata VM cluster.
sshPublicKeysarrayThe public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure.
subnetIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure.
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.
timeCreatedstring (date-time)The date and time that the Exadata VM cluster on Exascale Infrastructure was created.
timeZonestringThe time zone to use for the Exadata VM cluster on Exascale Infrastructure. For details, see [Time Zones](/Content/Database/References/timezones.htm).
totalECpuCountinteger (int32)The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure.
totalFileSystemStorageobjectStorage Details on the Exadata VM cluster.
vipIdsarrayThe [OCID](/Content/General/Concepts/identifiers.htm) of the virtual IP (VIP) addresses associated with the Exadata VM cluster on Exascale Infrastructure. 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, then the VIP is reassigned to another active node in the cluster.
vmFileSystemStorageobjectStorage Details on the Exadata VM cluster.
zoneIdstringThe OCID of the zone with which the Exadata VM cluster on Exascale Infrastructure is associated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectexadbVmClusterId, regionopc-request-idGets information about the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.<br />
listselectcompartmentId, regionlimit, page, sortBy, sortOrder, lifecycleState, exascaleDbStorageVaultId, clusterPlacementGroupId, displayName, opc-request-idGets a list of the Exadata VM clusters on Exascale Infrastructure in the specified compartment. Applies to Exadata Database Service on Exascale Infrastructure only.<br />
createinsertregion, compartmentId, displayName, sshPublicKeys, gridImageId, hostname, subnetId, backupSubnetId, nodeCount, totalECpuCount, enabledECpuCount, vmFileSystemStorage, exascaleDbStorageVaultId, availabilityDomain, shapeopc-retry-token, opc-request-idCreates an Exadata VM cluster on Exascale Infrastructure<br />
updateupdateexadbVmClusterId, regionif-match, opc-request-idUpdates the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.<br />
deletedeleteexadbVmClusterId, regionif-match, opc-request-idDeletes the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.<br />
add_dbnode_snapshots_for_exadb_vm_clusterexecexadbVmClusterId, region, name, sourceDbnodeIdsopc-retry-token, opc-request-id, if-matchAdd a database node snapshots to the Exadb VM cluster..<br />
change_compartmentexecexadbVmClusterId, region, compartmentIdopc-retry-token, opc-request-id, if-matchMoves a Exadata VM cluster on Exascale Infrastructure and its dependent resources to another compartment. Applies to Exadata Database Service on Exascale Infrastructure only.<br />
change_exadb_vm_cluster_subscriptionexecexadbVmClusterId, regionopc-retry-token, opc-request-id, if-matchAssociate a Exadata VM cluster on Exascale Infrastructure with a different subscription.<br />
remove_virtual_machine_from_exadb_vm_clusterexecexadbVmClusterId, region, dbNodesopc-retry-token, opc-request-id, if-matchRemove Virtual Machines from the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Cloud 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).
exadbVmClusterIdstringThe Exadata VM cluster [OCID](/Content/General/Concepts/identifiers.htm) on Exascale Infrastructure.
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)
clusterPlacementGroupIdstringA filter to return only resources that match the given cluster placement group ID exactly.
displayNamestringA filter to return only resources that match the entire display name given. The match is not case sensitive.
exascaleDbStorageVaultIdstringA filter to return only Exadata VM clusters on Exascale Infrastructure that match the given Exascale Database Storage Vault ID.
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 Exadata VM clusters on Exascale Infrastructure 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 Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.<br />

SELECT
id,
availabilityDomain,
backupNetworkNsgIds,
backupSubnetId,
clusterName,
clusterPlacementGroupId,
compartmentId,
dataCollectionOptions,
definedTags,
displayName,
domain,
enabledECpuCount,
exascaleDbStorageVaultId,
freeformTags,
giVersion,
gridImageId,
gridImageType,
hostname,
iormConfigCache,
lastUpdateHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
listenerPort,
memorySizeInGBs,
nodeCount,
nsgIds,
privateZoneId,
scanDnsName,
scanDnsRecordId,
scanIpIds,
scanListenerPortTcp,
scanListenerPortTcpSsl,
securityAttributes,
shape,
shapeAttribute,
snapshotFileSystemStorage,
sshPublicKeys,
subnetId,
subscriptionId,
systemTags,
systemVersion,
timeCreated,
timeZone,
totalECpuCount,
totalFileSystemStorage,
vipIds,
vmFileSystemStorage,
zoneId
FROM oci.database.exadb_vm_clusters
WHERE exadbVmClusterId = '{{ exadbVmClusterId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates an Exadata VM cluster on Exascale Infrastructure<br />

INSERT INTO oci.database.exadb_vm_clusters (
availabilityDomain,
backupNetworkNsgIds,
backupSubnetId,
clusterName,
compartmentId,
dataCollectionOptions,
definedTags,
displayName,
domain,
enabledECpuCount,
exascaleDbStorageVaultId,
freeformTags,
gridImageId,
hostname,
licenseModel,
nodeCount,
nsgIds,
privateZoneId,
scanListenerPortTcp,
scanListenerPortTcpSsl,
securityAttributes,
shape,
shapeAttribute,
sshPublicKeys,
subnetId,
subscriptionId,
systemVersion,
timeZone,
totalECpuCount,
vmFileSystemStorage,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ availabilityDomain }}' /* required */,
'{{ backupNetworkNsgIds }}',
'{{ backupSubnetId }}' /* required */,
'{{ clusterName }}',
'{{ compartmentId }}' /* required */,
'{{ dataCollectionOptions }}',
'{{ definedTags }}',
'{{ displayName }}' /* required */,
'{{ domain }}',
{{ enabledECpuCount }} /* required */,
'{{ exascaleDbStorageVaultId }}' /* required */,
'{{ freeformTags }}',
'{{ gridImageId }}' /* required */,
'{{ hostname }}' /* required */,
'{{ licenseModel }}',
{{ nodeCount }} /* required */,
'{{ nsgIds }}',
'{{ privateZoneId }}',
{{ scanListenerPortTcp }},
{{ scanListenerPortTcpSsl }},
'{{ securityAttributes }}',
'{{ shape }}' /* required */,
'{{ shapeAttribute }}',
'{{ sshPublicKeys }}' /* required */,
'{{ subnetId }}' /* required */,
'{{ subscriptionId }}',
'{{ systemVersion }}',
'{{ timeZone }}',
{{ totalECpuCount }} /* required */,
'{{ vmFileSystemStorage }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
availabilityDomain,
backupNetworkNsgIds,
backupSubnetId,
clusterName,
clusterPlacementGroupId,
compartmentId,
dataCollectionOptions,
definedTags,
displayName,
domain,
enabledECpuCount,
exascaleDbStorageVaultId,
freeformTags,
giVersion,
gridImageId,
gridImageType,
hostname,
iormConfigCache,
lastUpdateHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
listenerPort,
memorySizeInGBs,
nodeCount,
nsgIds,
privateZoneId,
scanDnsName,
scanDnsRecordId,
scanIpIds,
scanListenerPortTcp,
scanListenerPortTcpSsl,
securityAttributes,
shape,
shapeAttribute,
snapshotFileSystemStorage,
sshPublicKeys,
subnetId,
subscriptionId,
systemTags,
systemVersion,
timeCreated,
timeZone,
totalECpuCount,
totalFileSystemStorage,
vipIds,
vmFileSystemStorage,
zoneId
;

UPDATE examples​

Updates the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.<br />

UPDATE oci.database.exadb_vm_clusters
SET 
backupNetworkNsgIds = '{{ backupNetworkNsgIds }}',
dataCollectionOptions = '{{ dataCollectionOptions }}',
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
enabledECpuCount = {{ enabledECpuCount }},
freeformTags = '{{ freeformTags }}',
gridImageId = '{{ gridImageId }}',
licenseModel = '{{ licenseModel }}',
nodeCount = {{ nodeCount }},
nsgIds = '{{ nsgIds }}',
securityAttributes = '{{ securityAttributes }}',
sshPublicKeys = '{{ sshPublicKeys }}',
systemVersion = '{{ systemVersion }}',
totalECpuCount = {{ totalECpuCount }},
updateAction = '{{ updateAction }}',
vmFileSystemStorage = '{{ vmFileSystemStorage }}'
WHERE 
exadbVmClusterId = '{{ exadbVmClusterId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
availabilityDomain,
backupNetworkNsgIds,
backupSubnetId,
clusterName,
clusterPlacementGroupId,
compartmentId,
dataCollectionOptions,
definedTags,
displayName,
domain,
enabledECpuCount,
exascaleDbStorageVaultId,
freeformTags,
giVersion,
gridImageId,
gridImageType,
hostname,
iormConfigCache,
lastUpdateHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
listenerPort,
memorySizeInGBs,
nodeCount,
nsgIds,
privateZoneId,
scanDnsName,
scanDnsRecordId,
scanIpIds,
scanListenerPortTcp,
scanListenerPortTcpSsl,
securityAttributes,
shape,
shapeAttribute,
snapshotFileSystemStorage,
sshPublicKeys,
subnetId,
subscriptionId,
systemTags,
systemVersion,
timeCreated,
timeZone,
totalECpuCount,
totalFileSystemStorage,
vipIds,
vmFileSystemStorage,
zoneId;

DELETE examples​

Deletes the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.<br />

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

Lifecycle Methods​

Add a database node snapshots to the Exadb VM cluster..<br />

EXEC oci.database.exadb_vm_clusters.add_dbnode_snapshots_for_exadb_vm_cluster 
@exadbVmClusterId='{{ exadbVmClusterId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"definedTags": "{{ definedTags }}", 
"freeformTags": "{{ freeformTags }}", 
"name": "{{ name }}", 
"sourceDbnodeIds": "{{ sourceDbnodeIds }}"
}'
;