Share via


CloudVmClusterProperties interface

CloudVmCluster resource model

Properties

backupSubnetCidr

Client OCI backup subnet CIDR, default is 192.168.252.0/22

cloudExadataInfrastructureId

Cloud Exadata Infrastructure ID

clusterName

The 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.

compartmentId

Cluster compartmentId

computeModel

The compute model of the VM Cluster.

computeNodes

The list of compute servers to be added to the cloud VM cluster.

cpuCoreCount

The number of CPU cores enabled on the cloud VM cluster.

dataCollectionOptions

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

dataStoragePercentage

The 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.

dataStorageSizeInTbs

The data disk group size to be allocated in TBs.

dbNodeStorageSizeInGbs

The local node storage to be allocated in GBs.

dbServers

The list of DB servers.

diskRedundancy

The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

displayName

Display Name

domain

The domain name for the cloud VM cluster.

exascaleDbStorageVaultId

Exadata Database Storage Vault ID

fileSystemConfigurationDetails

Array of mount path and size.

giVersion

Oracle Grid Infrastructure (GI) software version

hostname

The hostname for the cloud VM cluster.

iormConfigCache

iormConfigCache details for cloud VM cluster.

isLocalBackupEnabled

If 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.

isSparseDiskgroupEnabled

If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.

lastUpdateHistoryEntryId

The OCID of the last maintenance update history entry.

licenseModel

The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.

lifecycleDetails

Additional information about the current lifecycle state.

lifecycleState

CloudVmCluster lifecycle state

listenerPort

The port number configured for the listener on the cloud VM cluster.

memorySizeInGbs

The memory to be allocated in GBs.

nodeCount

The number of nodes in the cloud VM cluster.

nsgCidrs

CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default.

nsgUrl

HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface.

ocid

Cloud VM Cluster ocid

ociUrl

HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.

ocpuCount

The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

provisioningState

CloudVmCluster provisioning state

scanDnsName

The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

scanDnsRecordId

The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

scanIpIds

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.

scanListenerPortTcp

The TCP Single Client Access Name (SCAN) port. The default port is 1521.

scanListenerPortTcpSsl

The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

shape

The model name of the Exadata hardware running the cloud VM cluster.

sshPublicKeys

The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.

storageManagementType

Specifies whether the type of storage management for the VM cluster is ASM or Exascale.

storageSizeInGbs

The data disk group size to be allocated in GBs per VM.

subnetId

Client subnet

subnetOcid

Cluster subnet ocid

systemVersion

Operating system version of the image.

timeCreated

The date and time that the cloud VM cluster was created.

timeZone

The time zone of the cloud VM cluster. For details, see Exadata Infrastructure Time Zones.

vipIds

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.

vnetId

VNET for network connectivity

zoneId

The OCID of the zone the cloud VM cluster is associated with.

Property Details

backupSubnetCidr

Client OCI backup subnet CIDR, default is 192.168.252.0/22

backupSubnetCidr?: string

Property Value

string

cloudExadataInfrastructureId

Cloud Exadata Infrastructure ID

cloudExadataInfrastructureId: string

Property Value

string

clusterName

The 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.

clusterName?: string

Property Value

string

compartmentId

Cluster compartmentId

compartmentId?: string

Property Value

string

computeModel

The compute model of the VM Cluster.

computeModel?: string

Property Value

string

computeNodes

The list of compute servers to be added to the cloud VM cluster.

computeNodes?: string[]

Property Value

string[]

cpuCoreCount

The number of CPU cores enabled on the cloud VM cluster.

cpuCoreCount: number

Property Value

number

dataCollectionOptions

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

dataCollectionOptions?: DataCollectionOptions

Property Value

dataStoragePercentage

The 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.

dataStoragePercentage?: number

Property Value

number

dataStorageSizeInTbs

The data disk group size to be allocated in TBs.

dataStorageSizeInTbs?: number

Property Value

number

dbNodeStorageSizeInGbs

The local node storage to be allocated in GBs.

dbNodeStorageSizeInGbs?: number

Property Value

number

dbServers

The list of DB servers.

dbServers?: string[]

Property Value

string[]

diskRedundancy

The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

diskRedundancy?: string

Property Value

string

displayName

Display Name

displayName: string

Property Value

string

domain

The domain name for the cloud VM cluster.

domain?: string

Property Value

string

exascaleDbStorageVaultId

Exadata Database Storage Vault ID

exascaleDbStorageVaultId?: string

Property Value

string

fileSystemConfigurationDetails

Array of mount path and size.

fileSystemConfigurationDetails?: FileSystemConfigurationDetails[]

Property Value

giVersion

Oracle Grid Infrastructure (GI) software version

giVersion: string

Property Value

string

hostname

The hostname for the cloud VM cluster.

hostname: string

Property Value

string

iormConfigCache

iormConfigCache details for cloud VM cluster.

iormConfigCache?: ExadataIormConfig

Property Value

isLocalBackupEnabled

If 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.

isLocalBackupEnabled?: boolean

Property Value

boolean

isSparseDiskgroupEnabled

If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.

isSparseDiskgroupEnabled?: boolean

Property Value

boolean

lastUpdateHistoryEntryId

The OCID of the last maintenance update history entry.

lastUpdateHistoryEntryId?: string

Property Value

string

licenseModel

The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.

licenseModel?: string

Property Value

string

lifecycleDetails

Additional information about the current lifecycle state.

lifecycleDetails?: string

Property Value

string

lifecycleState

CloudVmCluster lifecycle state

lifecycleState?: string

Property Value

string

listenerPort

The port number configured for the listener on the cloud VM cluster.

listenerPort?: number

Property Value

number

memorySizeInGbs

The memory to be allocated in GBs.

memorySizeInGbs?: number

Property Value

number

nodeCount

The number of nodes in the cloud VM cluster.

nodeCount?: number

Property Value

number

nsgCidrs

CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default.

nsgCidrs?: NsgCidr[]

Property Value

nsgUrl

HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface.

nsgUrl?: string

Property Value

string

ocid

Cloud VM Cluster ocid

ocid?: string

Property Value

string

ociUrl

HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.

ociUrl?: string

Property Value

string

ocpuCount

The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

ocpuCount?: number

Property Value

number

provisioningState

CloudVmCluster provisioning state

provisioningState?: string

Property Value

string

scanDnsName

The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

scanDnsName?: string

Property Value

string

scanDnsRecordId

The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

scanDnsRecordId?: string

Property Value

string

scanIpIds

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.

scanIpIds?: string[]

Property Value

string[]

scanListenerPortTcp

The TCP Single Client Access Name (SCAN) port. The default port is 1521.

scanListenerPortTcp?: number

Property Value

number

scanListenerPortTcpSsl

The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

scanListenerPortTcpSsl?: number

Property Value

number

shape

The model name of the Exadata hardware running the cloud VM cluster.

shape?: string

Property Value

string

sshPublicKeys

The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.

sshPublicKeys: string[]

Property Value

string[]

storageManagementType

Specifies whether the type of storage management for the VM cluster is ASM or Exascale.

storageManagementType?: string

Property Value

string

storageSizeInGbs

The data disk group size to be allocated in GBs per VM.

storageSizeInGbs?: number

Property Value

number

subnetId

Client subnet

subnetId: string

Property Value

string

subnetOcid

Cluster subnet ocid

subnetOcid?: string

Property Value

string

systemVersion

Operating system version of the image.

systemVersion?: string

Property Value

string

timeCreated

The date and time that the cloud VM cluster was created.

timeCreated?: Date

Property Value

Date

timeZone

The time zone of the cloud VM cluster. For details, see Exadata Infrastructure Time Zones.

timeZone?: string

Property Value

string

vipIds

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.

vipIds?: string[]

Property Value

string[]

vnetId

VNET for network connectivity

vnetId: string

Property Value

string

zoneId

The OCID of the zone the cloud VM cluster is associated with.

zoneId?: string

Property Value

string