Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EsxiHostClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • EsxiHostClient

Constructors

constructor

  • new EsxiHostClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): EsxiHostClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: EsxiHostWaiter

targetService

targetService: string = "EsxiHost"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://ocvps.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

close

  • close(): void

createEsxiHost

  • Adds another ESXi host to an existing SDDC. The attributes of the specified Sddc determine the VMware software and other configuration settings used by the ESXi host.

    Use the WorkRequest operations to track the creation of the ESXi host.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateEsxiHost API.

    Parameters

    Returns Promise<CreateEsxiHostResponse>

    CreateEsxiHostResponse

createWaiters

  • Creates a new EsxiHostWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns EsxiHostWaiter

    The service waiters.

deleteEsxiHost

  • Deletes the specified ESXi host. Before deleting the host, back up or migrate any VMware workloads running on it.

    When you delete an ESXi host, Oracle does not remove the node configuration within the VMware environment itself. That is your responsibility.

    *Note:** If you delete EXSi hosts from the SDDC to total less than 3, you are still billed for the 3 minimum recommended EXSi hosts. Also, you cannot add more VMware workloads to the SDDC until it again has at least 3 ESXi hosts.

    Use the WorkRequest operations to track the deletion of the ESXi host.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteEsxiHost API.

    Parameters

    Returns Promise<DeleteEsxiHostResponse>

    DeleteEsxiHostResponse

getEsxiHost

  • Gets the specified ESXi host's information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetEsxiHost API.

    Parameters

    Returns Promise<GetEsxiHostResponse>

    GetEsxiHostResponse

getWaiters

inplaceUpgrade

  • In-place upgrade a ESXi host.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use InplaceUpgrade API.

    Parameters

    Returns Promise<InplaceUpgradeResponse>

    InplaceUpgradeResponse

listEsxiHosts

  • Lists the ESXi hosts in the specified SDDC. The list can be filtered by Compute instance OCID or ESXi display name.

    Remember that in terms of implementation, an ESXi host is a Compute instance that is configured with the chosen bundle of VMware software. Each `EsxiHost` object has its own OCID (`id`), and a separate attribute for the OCID of the Compute instance (`computeInstanceId`). When filtering the list of ESXi hosts, you can specify the OCID of the Compute instance, not the ESXi host OCID.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListEsxiHosts API.

    Parameters

    Returns Promise<ListEsxiHostsResponse>

    ListEsxiHostsResponse

replaceHost

  • Replace a faulty ESXi host whose underlying bare metal is broken

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ReplaceHost API.

    Parameters

    Returns Promise<ReplaceHostResponse>

    ReplaceHostResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

swapBilling

  • Swap billing between two Active ESXi hosts.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SwapBilling API.

    Parameters

    Returns Promise<SwapBillingResponse>

    SwapBillingResponse

updateEsxiHost

  • Updates the specified ESXi host. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateEsxiHost API.

    Parameters

    Returns Promise<UpdateEsxiHostResponse>

    UpdateEsxiHostResponse