Skip to main content

exadb_vm_clusters

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

Overview​

Nameexadb_vm_clusters
TypeResource
Idazure_isv.oracledatabase.exadb_vm_clusters

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
backupSubnetCidrstringClient OCI backup subnet CIDR, default is 192.168.252.0/22.
backupSubnetOcidstringCluster backup subnet ocid.
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.
dataCollectionOptionsobjectIndicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
displayNamestringDisplay Name. Required.
domainstringA domain name used for the Exadata VM cluster on Exascale Infrastructure.
enabledEcpuCountintegerThe number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. Required.
exascaleDbStorageVaultIdstringThe Azure Resource ID of the Exadata Database Storage Vault. Required.
giVersionstringOracle Grid Infrastructure (GI) software version.
gridImageOcidstringGrid Setup will be done using this Grid Image OCID. Can be obtained using giMinorVersions API.
gridImageTypestringThe type of Grid Image. Known values are: "ReleaseUpdate" and "CustomImage". (ReleaseUpdate, CustomImage)
hostnamestringThe hostname for the Exadata VM cluster on Exascale Infrastructure. Required.
iormConfigCacheobjectiormConfigCache details for Exadata VM cluster on Exascale Infrastructure.
licenseModelstringThe Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is LICENSE_INCLUDED. Known values are: "LicenseIncluded" and "BringYourOwnLicense". (LicenseIncluded, BringYourOwnLicense)
lifecycleDetailsstringAdditional information about the current lifecycle state.
lifecycleStatestringCloudVmCluster lifecycle state. Known values are: "Provisioning", "Available", "Updating", "Terminating", "Terminated", "MaintenanceInProgress", and "Failed". (Provisioning, Available, Updating, Terminating, Terminated, MaintenanceInProgress, Failed)
listenerPortintegerThe port number configured for the listener on the Exadata VM cluster on Exascale Infrastructure.
locationstringThe geo-location where the resource lives. Required.
memorySizeInGbsintegerThe memory that you want to be allocated in GBs. Memory is calculated based on 11 GB per VM core reserved.
nodeCountintegerThe number of nodes in the Exadata VM cluster on Exascale Infrastructure. Required.
nsgCidrsarrayCIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default.
nsgUrlstringHTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface.
ociUrlstringHTTPS link to OCI resources exposed to Azure Customer via Azure Interface.
ocidstringExadbVmCluster ocid.
privateZoneOcidstringThe OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with.
provisioningStatestringExadata VM cluster on Exascale Infrastructure provisioning state. Known values are: "Succeeded", "Failed", "Canceled", and "Provisioning". (Succeeded, Failed, Canceled, Provisioning)
scanDnsNamestringThe FQDN of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure.
scanDnsRecordIdstringThe OCID of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure.
scanIpIdsarrayThe 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 TCPS Single Client Access Name (SCAN) port. The default port is 2484.
shapestringThe shape of the Exadata VM cluster on Exascale Infrastructure resource. Required.
shapeAttributestringThe type of Exascale storage used for Exadata VM cluster. Known values are: "SMART_STORAGE" and "BLOCK_STORAGE". (SMART_STORAGE, BLOCK_STORAGE)
snapshotFileSystemStorageobjectSnapshot filesystem storage details.
sshPublicKeysarrayThe public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. Required.
subnetIdstringClient subnet. Required.
subnetOcidstringCluster subnet ocid.
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
systemVersionstringOperating system version of the image.
tagsobjectResource tags.
timeZonestringThe time zone of the Exadata VM cluster on Exascale Infrastructure. For details, see Exadata Infrastructure Time Zones _.
totalEcpuCountintegerThe number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. Required.
totalFileSystemStorageobjectTotal file system storage details.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vipIdsarrayThe 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, the VIP is reassigned to another active node in the cluster. Note: For a single-node DB system, this list is empty.
vmFileSystemStorageobjectFilesystem storage details. Required.
vnetIdstringVNET for network connectivity. Required.
zoneOcidstringThe OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with.
zonesarrayThe availability zones.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresource_group_name, exadb_vm_cluster_name, subscription_idGet a ExadbVmCluster.
list_by_resource_groupselectresource_group_name, subscription_idList ExadbVmCluster resources by resource group.
list_by_subscriptionselectsubscription_idList ExadbVmCluster resources by subscription ID.
create_or_updateinsertresource_group_name, exadb_vm_cluster_name, subscription_id, locationCreate a ExadbVmCluster.
updateupdateresource_group_name, exadb_vm_cluster_name, subscription_idUpdate a ExadbVmCluster.
create_or_updatereplaceresource_group_name, exadb_vm_cluster_name, subscription_id, locationCreate a ExadbVmCluster.
deletedeleteresource_group_name, exadb_vm_cluster_name, subscription_idDelete a ExadbVmCluster.
remove_vmsexecresource_group_name, exadb_vm_cluster_name, subscription_id, dbNodesRemove VMs from the VM Cluster.

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
exadb_vm_cluster_namestringThe name of the ExadbVmCluster. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring

SELECT examples​

Get a ExadbVmCluster.

SELECT
id,
name,
backupSubnetCidr,
backupSubnetOcid,
clusterName,
dataCollectionOptions,
displayName,
domain,
enabledEcpuCount,
exascaleDbStorageVaultId,
giVersion,
gridImageOcid,
gridImageType,
hostname,
iormConfigCache,
licenseModel,
lifecycleDetails,
lifecycleState,
listenerPort,
location,
memorySizeInGbs,
nodeCount,
nsgCidrs,
nsgUrl,
ociUrl,
ocid,
privateZoneOcid,
provisioningState,
scanDnsName,
scanDnsRecordId,
scanIpIds,
scanListenerPortTcp,
scanListenerPortTcpSsl,
shape,
shapeAttribute,
snapshotFileSystemStorage,
sshPublicKeys,
subnetId,
subnetOcid,
systemData,
systemVersion,
tags,
timeZone,
totalEcpuCount,
totalFileSystemStorage,
type,
vipIds,
vmFileSystemStorage,
vnetId,
zoneOcid,
zones
FROM azure_isv.oracledatabase.exadb_vm_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND exadb_vm_cluster_name = '{{ exadb_vm_cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples​

Create a ExadbVmCluster.

INSERT INTO azure_isv.oracledatabase.exadb_vm_clusters (
tags,
location,
properties,
zones,
resource_group_name,
exadb_vm_cluster_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ zones }}',
'{{ resource_group_name }}',
'{{ exadb_vm_cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type,
zones
;

UPDATE examples​

Update a ExadbVmCluster.

UPDATE azure_isv.oracledatabase.exadb_vm_clusters
SET 
zones = '{{ zones }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND exadb_vm_cluster_name = '{{ exadb_vm_cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type,
zones;

REPLACE examples​

Create a ExadbVmCluster.

REPLACE azure_isv.oracledatabase.exadb_vm_clusters
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
zones = '{{ zones }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND exadb_vm_cluster_name = '{{ exadb_vm_cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type,
zones;

DELETE examples​

Delete a ExadbVmCluster.

DELETE FROM azure_isv.oracledatabase.exadb_vm_clusters
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND exadb_vm_cluster_name = '{{ exadb_vm_cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods​

Remove VMs from the VM Cluster.

EXEC azure_isv.oracledatabase.exadb_vm_clusters.remove_vms 
@resource_group_name='{{ resource_group_name }}' --required, 
@exadb_vm_cluster_name='{{ exadb_vm_cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"dbNodes": "{{ dbNodes }}"
}'
;