Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ClusterSummary

A summary of the Cluster.

Properties

compartmentId

compartmentId: string

The OCID of the compartment that contains the Cluster.

computeAvailabilityDomain

computeAvailabilityDomain: string

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

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.

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 compartment that contains the Cluster.

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

sddcId

sddcId: string

The OCID of the SDDC that the Cluster belongs to.

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

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.

Functions

getDeserializedJsonObj

getJsonObj