Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Cluster

An Oracle Cloud VMware Solution Cluster contains the resources required for a functional VMware environment. Instances in a Cluster (see EsxiHost) run in a virtual cloud network (VCN) and are preconfigured with VMware and storage. Use the vCenter utility to manage and deploy VMware virtual machines (VMs) in the Cluster.

The Cluster uses a single management subnet for provisioning the Cluster. It also uses a set of VLANs for various components of the VMware environment (vSphere, vMotion, vSAN, and so on). See the Core Services API for information about VCN subnets and VLANs.

Properties

Optional capacityReservationId

capacityReservationId: undefined | string

The OCID of the Capacity Reservation.

compartmentId

compartmentId: string

The OCID of the compartment that contains the Cluster.

computeAvailabilityDomain

computeAvailabilityDomain: string

The availability domain the ESXi hosts are running in. For Multi-AD Cluster, it is {@code multi-AD}.

Example: {@code Uocm:PHX-AD-1}, {@code multi-AD}

Optional datastores

datastores: Array<DatastoreDetails>

Datastores used for the Cluster.

definedTags

definedTags: object

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

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Type declaration

  • [key: string]: object
    • [key: string]: any

displayName

displayName: string

A descriptive name for the Cluster. It must be unique, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information.

esxiHostsCount

esxiHostsCount: number

The number of ESXi hosts in the Cluster. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional esxiSoftwareVersion

esxiSoftwareVersion: undefined | string

In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see {@link #listSupportedVmwareSoftwareVersions(ListSupportedVmwareSoftwareVersionsRequest) listSupportedVmwareSoftwareVersions}).

This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the SDDC. The purpose of this attribute is to show the version of software that the Oracle Cloud VMware Solution will install on any new ESXi hosts that you *add to this SDDC in the future* with {@link #createEsxiHost(CreateEsxiHostRequest) createEsxiHost} unless a different version is configured on the ESXi host level.

Therefore, if you upgrade the existing ESXi hosts in the Cluster to use a newer version of bundled ESXi software supported by the Oracle Cloud VMware Solution, you should use {@link #updateCluster(UpdateClusterRequest) updateCluster} to update the Cluster's {@code esxiSoftwareVersion} with that new version.

freeformTags

freeformTags: 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\"}}

Type declaration

  • [key: string]: string

id

id: string

The OCID of the Cluster.

Optional initialCommitment

initialCommitment: model.Commitment

The billing option selected during Cluster creation. {@link #listSupportedCommitments(ListSupportedCommitmentsRequest) listSupportedCommitments}.

Optional initialHostOcpuCount

initialHostOcpuCount: undefined | number

The initial OCPU count of the Cluster's ESXi hosts. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

initialHostShapeName

initialHostShapeName: string

The initial compute shape of the Cluster's ESXi hosts. {@link #listSupportedHostShapes(ListSupportedHostShapesRequest) listSupportedHostShapes}.

Optional instanceDisplayNamePrefix

instanceDisplayNamePrefix: undefined | string

A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's {@code displayName} is used as the prefix.

For example, if the value is {@code MyCluster}, the ESXi hosts are named {@code MyCluster-1}, {@code MyCluster-2}, and so on.

Optional isShieldedInstanceEnabled

isShieldedInstanceEnabled: undefined | false | true

Indicates whether shielded instance is enabled at the Cluster level.

Optional lifecycleState

lifecycleState: model.LifecycleStates

The current state of the Cluster.

networkConfiguration

networkConfiguration: NetworkConfiguration

sddcId

sddcId: string

The OCID of the SDDC that the Cluster belongs to.

timeCreated

timeCreated: Date

The date and time the Cluster was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Optional timeUpdated

timeUpdated: Date

The date and time the Cluster was updated, in the format defined by RFC3339.

Optional upgradeLicenses

upgradeLicenses: Array<VsphereLicense>

The vSphere licenses to use when upgrading the Cluster.

vmwareSoftwareVersion

vmwareSoftwareVersion: string

In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see {@link #listSupportedVmwareSoftwareVersions(ListSupportedVmwareSoftwareVersionsRequest) listSupportedVmwareSoftwareVersions}).

This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the Cluster. The purpose of this attribute is to show the version of software that the Oracle Cloud VMware Solution will install on any new ESXi hosts that you *add to this Cluster in the future* with {@link #createEsxiHost(CreateEsxiHostRequest) createEsxiHost}.

Therefore, if you upgrade the existing ESXi hosts in the Cluster to use a newer version of bundled VMware software supported by the Oracle Cloud VMware Solution, you should use {@link #updateCluster(UpdateClusterRequest) updateCluster} to update the Cluster's {@code vmwareSoftwareVersion} with that new version.

vsphereType

vsphereType: VsphereTypes

vSphere Cluster types.

Optional vsphereUpgradeObjects

vsphereUpgradeObjects: Array<VsphereUpgradeObject>

The links to binary objects needed to upgrade vSphere.

Optional workloadNetworkCidr

workloadNetworkCidr: undefined | string

The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Cluster): object

getJsonObj