Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace EsxiHost

An ESXi host is a node in a Cluster. At a minimum, each Cluster has 3 ESXi hosts that are used to implement a functioning VMware environment.

In terms of implementation, an ESXi host is a Compute instance that is configured with the chosen bundle of VMware software.

Notice that an {@code EsxiHost} object has its own OCID ({@code id}), and a separate attribute for the OCID of the Compute instance ({@code computeInstanceId}).

Properties

billingContractEndDate

billingContractEndDate: Date

Current billing cycle end date. If the value in {@code currentCommitment} and {@code nextCommitment} are different, the value specified in {@code nextCommitment} becomes the new {@code currentCommitment} when the {@code contractEndDate} is reached. Example: {@code 2016-08-25T21:10:29.600Z}

Optional billingDonorHostId

billingDonorHostId: undefined | string

The OCID of the deleted ESXi Host with LeftOver billing cycle.

Optional capacityReservationId

capacityReservationId: undefined | string

The OCID of the Capacity Reservation.

clusterId

clusterId: string

The OCID of the Cluster that the ESXi host belongs to.

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment that contains the Cluster.

computeAvailabilityDomain

computeAvailabilityDomain: string

The availability domain of the ESXi host.

Optional computeInstanceId

computeInstanceId: undefined | string

In terms of implementation, an ESXi host is a Compute instance that is configured with the chosen bundle of VMware software. The {@code computeInstanceId} is the OCID of that Compute instance.

currentCommitment

currentCommitment: Commitment

The billing option currently used by the ESXi host. {@link #listSupportedCommitments(ListSupportedCommitmentsRequest) listSupportedCommitments}.

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 ESXi host. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional esxiSoftwareVersion

esxiSoftwareVersion: undefined | string

The version of ESXi software that Oracle Cloud VMware Solution installed on the ESXi hosts.

Optional failedEsxiHostId

failedEsxiHostId: undefined | string

The OCID of the ESXi host that failed.

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

Optional gracePeriodEndDate

gracePeriodEndDate: Date

The date and time when the new esxi host should start billing cycle. RFC3339. Example: {@code 2021-07-25T21:10:29.600Z}

Optional hostOcpuCount

hostOcpuCount: undefined | number

The OCPU count of the ESXi host. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

hostShapeName

hostShapeName: string

The compute shape name of the ESXi host. {@link #listSupportedHostShapes(ListSupportedHostShapesRequest) listSupportedHostShapes}.

id

id: string

The OCID of the ESXi host.

Optional isBillingContinuationInProgress

isBillingContinuationInProgress: undefined | false | true

Indicates whether this host is in the progress of billing continuation.

Optional isBillingSwappingInProgress

isBillingSwappingInProgress: undefined | false | true

Indicates whether this host is in the progress of swapping billing.

Optional lifecycleState

lifecycleState: model.LifecycleStates

The current state of the ESXi host.

nextCommitment

nextCommitment: Commitment

The billing option to switch to after the current billing cycle ends. If {@code nextCommitment} is null or empty, {@code currentCommitment} continues to the next billing cycle. {@link #listSupportedCommitments(ListSupportedCommitmentsRequest) listSupportedCommitments}.

Optional nonUpgradedEsxiHostId

nonUpgradedEsxiHostId: undefined | string

The OCID of the ESXi host that will be upgraded.

Optional replacementEsxiHostId

replacementEsxiHostId: undefined | string

The OCID of the ESXi host that is created to replace the failed host.

sddcId

sddcId: string

The OCID of the SDDC that the ESXi host belongs to.

Optional swapBillingHostId

swapBillingHostId: undefined | string

The OCID of the active ESXi Host to swap billing with current host.

Optional timeCreated

timeCreated: Date

The date and time the ESXi host 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 ESXi host was updated, in the format defined by RFC3339.

Optional upgradedReplacementEsxiHostId

upgradedReplacementEsxiHostId: undefined | string

The OCID of the ESXi host that is newly created to upgrade the original host.

vmwareSoftwareVersion

vmwareSoftwareVersion: string

The version of VMware software that Oracle Cloud VMware Solution installed on the ESXi hosts.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: EsxiHost): object

getJsonObj