Skip to main content

cloud_vm_clusters

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

Overview

Namecloud_vm_clusters
TypeResource
Idazure_isv.oracledatabase.cloud_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.
cloudExadataInfrastructureIdstringCloud Exadata Infrastructure ID. Required.
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.
compartmentIdstringCluster compartmentId.
computeModelstringThe compute model of the VM Cluster. Known values are: "ECPU" and "OCPU". (ECPU, OCPU)
computeNodesarrayThe list of compute servers to be added to the cloud VM cluster.
cpuCoreCountintegerThe number of CPU cores enabled on the cloud VM cluster. Required.
dataCollectionOptionsobjectIndicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
dataStoragePercentageintegerThe percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See Storage Configuration _ in the Exadata documentation for details on the impact of the configuration settings on storage.
dataStorageSizeInTbsnumberThe data disk group size to be allocated in TBs.
dbNodeStorageSizeInGbsintegerThe local node storage to be allocated in GBs.
dbServersarrayThe list of DB servers.
diskRedundancystringThe type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. Known values are: "High" and "Normal". (High, Normal)
displayNamestringDisplay Name. Required.
domainstringThe domain name for the cloud VM cluster.
exascaleDbStorageVaultIdstringExadata Database Storage Vault ID.
fileSystemConfigurationDetailsarrayArray of mount path and size.
giVersionstringOracle Grid Infrastructure (GI) software version. Required.
hostnamestringThe hostname for the cloud VM cluster. Required.
iormConfigCacheobjectiormConfigCache details for cloud VM cluster.
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 of the last maintenance update history entry.
licenseModelstringThe Oracle license model that applies to the cloud VM cluster. 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 cloud VM cluster.
locationstringThe geo-location where the resource lives. Required.
memorySizeInGbsintegerThe memory to be allocated in GBs.
nodeCountintegerThe number of nodes in the cloud VM cluster.
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.
ocidstringCloud VM Cluster ocid.
ocpuCountnumberThe number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.
provisioningStatestringCloudVmCluster 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 cloud VM cluster.
scanDnsRecordIdstringThe OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.
scanIpIdsarrayThe 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.
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 model name of the Exadata hardware running the cloud VM cluster.
sshPublicKeysarrayThe public key portion of one or more key pairs used for SSH access to the cloud VM cluster. Required.
storageManagementTypestringSpecifies whether the type of storage management for the VM cluster is ASM or Exascale. Known values are: "ASM" and "Exascale". (ASM, Exascale)
storageSizeInGbsintegerThe data disk group size to be allocated in GBs per VM.
subnetIdstringClient subnet. Required.
subnetOcidstringCluster subnet ocid.
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
systemVersionstringOperating system version of the image.
tagsobjectResource tags.
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 _.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vipIdsarrayThe 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.
vnetIdstringVNET for network connectivity. Required.
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
getselectresource_group_name, cloudvmclustername, subscription_idGet a CloudVmCluster.
list_by_resource_groupselectresource_group_name, subscription_idList CloudVmCluster resources by resource group.
list_by_subscriptionselectsubscription_idList CloudVmCluster resources by subscription ID.
create_or_updateinsertresource_group_name, cloudvmclustername, subscription_id, locationCreate a CloudVmCluster.
updateupdateresource_group_name, cloudvmclustername, subscription_idUpdate a CloudVmCluster.
create_or_updatereplaceresource_group_name, cloudvmclustername, subscription_id, locationCreate a CloudVmCluster.
deletedeleteresource_group_name, cloudvmclustername, subscription_idDelete a CloudVmCluster.
list_private_ip_addressesexecresource_group_name, cloudvmclustername, subscription_id, subnetId, vnicIdList Private IP Addresses by the provided filter.
add_vmsexecresource_group_name, cloudvmclustername, subscription_id, dbServersAdd VMs to the VM Cluster.
remove_vmsexecresource_group_name, cloudvmclustername, subscription_id, dbServersRemove 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
cloudvmclusternamestringCloudVmCluster name. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring

SELECT examples

Get a CloudVmCluster.

SELECT
id,
name,
backupSubnetCidr,
cloudExadataInfrastructureId,
clusterName,
compartmentId,
computeModel,
computeNodes,
cpuCoreCount,
dataCollectionOptions,
dataStoragePercentage,
dataStorageSizeInTbs,
dbNodeStorageSizeInGbs,
dbServers,
diskRedundancy,
displayName,
domain,
exascaleDbStorageVaultId,
fileSystemConfigurationDetails,
giVersion,
hostname,
iormConfigCache,
isLocalBackupEnabled,
isSparseDiskgroupEnabled,
lastUpdateHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
listenerPort,
location,
memorySizeInGbs,
nodeCount,
nsgCidrs,
nsgUrl,
ociUrl,
ocid,
ocpuCount,
provisioningState,
scanDnsName,
scanDnsRecordId,
scanIpIds,
scanListenerPortTcp,
scanListenerPortTcpSsl,
shape,
sshPublicKeys,
storageManagementType,
storageSizeInGbs,
subnetId,
subnetOcid,
systemData,
systemVersion,
tags,
timeCreated,
timeZone,
type,
vipIds,
vnetId,
zoneId
FROM azure_isv.oracledatabase.cloud_vm_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloudvmclustername = '{{ cloudvmclustername }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

Create a CloudVmCluster.

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

UPDATE examples

Update a CloudVmCluster.

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

REPLACE examples

Create a CloudVmCluster.

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

DELETE examples

Delete a CloudVmCluster.

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

Lifecycle Methods

List Private IP Addresses by the provided filter.

EXEC azure_isv.oracledatabase.cloud_vm_clusters.list_private_ip_addresses 
@resource_group_name='{{ resource_group_name }}' --required,
@cloudvmclustername='{{ cloudvmclustername }}' --required,
@subscription_id='{{ subscription_id }}' --required
@@json=
'{
"subnetId": "{{ subnetId }}",
"vnicId": "{{ vnicId }}"
}'
;