Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CloudVmCluster

Details of the cloud VM cluster. Applies to Exadata Cloud Service instances only.

Properties

availabilityDomain

availabilityDomain: string

The name of the availability domain that the cloud Exadata infrastructure resource is located in.

Optional backupNetworkNsgIds

backupNetworkNsgIds: Array<string>

A list of the OCIDs 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. Applicable only to Exadata systems.

Optional backupSubnetId

backupSubnetId: undefined | string

The OCID of the backup network subnet associated with the cloud VM cluster.

*Subnet Restriction:** See the subnet restrictions information for **subnetId**.

cloudExadataInfrastructureId

cloudExadataInfrastructureId: string

The OCID of the cloud Exadata infrastructure.

Optional clusterName

clusterName: undefined | string

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

compartmentId: string

The OCID of the compartment.

cpuCoreCount

cpuCoreCount: number

The number of CPU cores enabled on the cloud VM cluster. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional dataCollectionOptions

dataCollectionOptions: model.DataCollectionOptions

Optional dataStoragePercentage

dataStoragePercentage: undefined | number

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. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional dataStorageSizeInTBs

dataStorageSizeInTBs: undefined | number

The data disk group size to be allocated in TBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional dbNodeStorageSizeInGBs

dbNodeStorageSizeInGBs: undefined | number

The local node storage to be allocated in GBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional dbServers

dbServers: Array<string>

The list of DB servers.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Optional diskRedundancy

diskRedundancy: DiskRedundancy

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

displayName

displayName: string

The user-friendly name for the cloud VM cluster. The name does not need to be unique.

domain

domain: string

The domain name for the cloud VM cluster.

Optional freeformTags

freeformTags: undefined | object

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

Example: {@code {\"Department\": \"Finance\"}}

Optional giSoftwareImageId

giSoftwareImageId: undefined | string

The OCID of a grid infrastructure software image. This is a database software image of the type {@code GRID_IMAGE}.

Optional giVersion

giVersion: undefined | string

A valid Oracle Grid Infrastructure (GI) software version.

hostname

hostname: string

The hostname for the cloud VM cluster.

id

id: string

The OCID of the cloud VM cluster.

Optional iormConfigCache

iormConfigCache: model.ExadataIormConfig

Optional isLocalBackupEnabled

isLocalBackupEnabled: undefined | false | true

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.

Optional isSparseDiskgroupEnabled

isSparseDiskgroupEnabled: undefined | false | true

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

Optional lastUpdateHistoryEntryId

lastUpdateHistoryEntryId: undefined | string

The OCID of the last maintenance update history entry. This value is updated when a maintenance update starts.

Optional licenseModel

licenseModel: LicenseModel

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

Optional lifecycleDetails

lifecycleDetails: undefined | string

Additional information about the current lifecycle state.

lifecycleState

lifecycleState: LifecycleState

The current state of the cloud VM cluster.

Optional listenerPort

listenerPort: undefined | number

The port number configured for the listener on the cloud VM cluster. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional memorySizeInGBs

memorySizeInGBs: undefined | number

The memory to be allocated in GBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional nodeCount

nodeCount: undefined | number

The number of nodes in the cloud VM cluster. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional nsgIds

nsgIds: Array<string>

The list of OCIDs 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. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

Optional ocpuCount

ocpuCount: undefined | number

The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional scanDnsName

scanDnsName: undefined | string

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

Optional scanDnsRecordId

scanDnsRecordId: undefined | string

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

Optional scanIpIds

scanIpIds: Array<string>

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

Optional scanListenerPortTcp

scanListenerPortTcp: undefined | number

The TCP Single Client Access Name (SCAN) port. The default port is 1521. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional scanListenerPortTcpSsl

scanListenerPortTcpSsl: undefined | number

The TCPS Single Client Access Name (SCAN) port. The default port is 2484. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

shape

shape: string

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

sshPublicKeys

sshPublicKeys: Array<string>

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

Optional storageSizeInGBs

storageSizeInGBs: undefined | number

The storage allocation for the disk group, in gigabytes (GB). Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

subnetId

subnetId: string

The OCID of the subnet associated with the cloud VM cluster.

*Subnet Restrictions:** - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20.

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Optional systemVersion

systemVersion: undefined | string

Operating system version of the image.

Optional timeCreated

timeCreated: Date

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

Optional timeZone

timeZone: undefined | string

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

Optional vipIds

vipIds: Array<string>

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

Optional zoneId

zoneId: undefined | string

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

Functions

getDeserializedJsonObj

getJsonObj