Class EsxiHostClient

Service client instance for EsxiHost.

Inheritance

object

ClientBase

RegionalClientBase

EsxiHostClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OcvpService

Assembly: OCI.DotNetSDK.Ocvp.dll

Syntax

public class EsxiHostClient : RegionalClientBase, IDisposable

Constructors

EsxiHostClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public EsxiHostClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public EsxiHostPaginators Paginators { get; }

Property Value

Type	Description
EsxiHostPaginators

Waiters

Declaration

public EsxiHostWaiters Waiters { get; }

Property Value

Type	Description
EsxiHostWaiters

Methods

CreateEsxiHost(CreateEsxiHostRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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 {@link WorkRequest} operations to track the creation of the ESXi host.

Declaration

public Task<CreateEsxiHostResponse> CreateEsxiHost(CreateEsxiHostRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateEsxiHostRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateEsxiHostResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateEsxiHost API.

DeleteEsxiHost(DeleteEsxiHostRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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 {@link WorkRequest} operations to track the deletion of the ESXi host.

Declaration

public Task<DeleteEsxiHostResponse> DeleteEsxiHost(DeleteEsxiHostRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteEsxiHostRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteEsxiHostResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteEsxiHost API.

GetEsxiHost(GetEsxiHostRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified ESXi host's information.

Declaration

public Task<GetEsxiHostResponse> GetEsxiHost(GetEsxiHostRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetEsxiHostRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetEsxiHostResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetEsxiHost API.

InplaceUpgrade(InplaceUpgradeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

In-place upgrade a ESXi host.

Declaration

public Task<InplaceUpgradeResponse> InplaceUpgrade(InplaceUpgradeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
InplaceUpgradeRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<InplaceUpgradeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use InplaceUpgrade API.

ListEsxiHosts(ListEsxiHostsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<ListEsxiHostsResponse> ListEsxiHosts(ListEsxiHostsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListEsxiHostsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListEsxiHostsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListEsxiHosts API.

ReplaceHost(ReplaceHostRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a faulty ESXi host whose underlying bare metal is broken

Declaration

public Task<ReplaceHostResponse> ReplaceHost(ReplaceHostRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ReplaceHostRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ReplaceHostResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ReplaceHost API.

SwapBilling(SwapBillingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Swap billing between two Active ESXi hosts.

Declaration

public Task<SwapBillingResponse> SwapBilling(SwapBillingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SwapBillingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SwapBillingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SwapBilling API.

UpdateEsxiHost(UpdateEsxiHostRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified ESXi host.

Declaration

public Task<UpdateEsxiHostResponse> UpdateEsxiHost(UpdateEsxiHostRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateEsxiHostRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateEsxiHostResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateEsxiHost API.

Implements

IDisposable