Class SddcClient

Service client instance for Sddc.

Inheritance

object

ClientBase

RegionalClientBase

SddcClient

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 SddcClient : RegionalClientBase, IDisposable

Constructors

SddcClient(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 SddcClient(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 SddcPaginators Paginators { get; }

Property Value

Type	Description
SddcPaginators

Waiters

Declaration

public SddcWaiters Waiters { get; }

Property Value

Type	Description
SddcWaiters

Methods

CancelDowngradeHcx(CancelDowngradeHcxRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancel the pending SDDC downgrade from HCX Enterprise to HCX Advanced.

Declaration

public Task<CancelDowngradeHcxResponse> CancelDowngradeHcx(CancelDowngradeHcxRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CancelDowngradeHcxRequest	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<CancelDowngradeHcxResponse>	A response object containing details about the completed operation

Examples

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

ChangeSddcCompartment(ChangeSddcCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an SDDC into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeSddcCompartmentResponse> ChangeSddcCompartment(ChangeSddcCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeSddcCompartmentRequest	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<ChangeSddcCompartmentResponse>	A response object containing details about the completed operation

Examples

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

CreateSddc(CreateSddcRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an Oracle Cloud VMware Solution software-defined data center (SDDC). <br/> Use the {@link WorkRequest} operations to track the creation of the SDDC. <br/> Important: You must configure the SDDC's networking resources with the security rules detailed in Security Rules for Oracle Cloud VMware Solution SDDCs. Otherwise, provisioning the SDDC will fail. The rules are based on the requirements set by VMware.

Declaration

public Task<CreateSddcResponse> CreateSddc(CreateSddcRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSddcRequest	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<CreateSddcResponse>	A response object containing details about the completed operation

Examples

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

DeleteSddc(DeleteSddcRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified SDDC, along with the other resources that were created with the SDDC. For example: the Compute instances, DNS records, and so on. <br/> Use the {@link WorkRequest} operations to track the deletion of the SDDC.

Declaration

public Task<DeleteSddcResponse> DeleteSddc(DeleteSddcRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSddcRequest	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<DeleteSddcResponse>	A response object containing details about the completed operation

Examples

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

DowngradeHcx(DowngradeHcxRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Downgrade the specified SDDC from HCX Enterprise to HCX Advanced. SDDC with standard compute shapes will always use HCX Enterprise if HCX is enabled and cannot be downgraded. Downgrading from HCX Enterprise to HCX Advanced reduces the number of provided license keys from 10 to 3. Downgrade remains in a PENDING state until the end of the current billing cycle. You can use {@link #cancelDowngradeHcx(CancelDowngradeHcxRequest) cancelDowngradeHcx} to cancel the downgrade while it's still in a PENDING state.

Declaration

public Task<DowngradeHcxResponse> DowngradeHcx(DowngradeHcxRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DowngradeHcxRequest	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<DowngradeHcxResponse>	A response object containing details about the completed operation

Examples

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

GetSddc(GetSddcRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified SDDC's information.

Declaration

public Task<GetSddcResponse> GetSddc(GetSddcRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSddcRequest	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<GetSddcResponse>	A response object containing details about the completed operation

Examples

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

ListSddcs(ListSddcsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the SDDCs in the specified compartment. The list can be filtered by display name or availability domain.

Declaration

public Task<ListSddcsResponse> ListSddcs(ListSddcsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSddcsRequest	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<ListSddcsResponse>	A response object containing details about the completed operation

Examples

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

ListSupportedCommitments(ListSupportedCommitmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists supported Commitments.

Declaration

public Task<ListSupportedCommitmentsResponse> ListSupportedCommitments(ListSupportedCommitmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSupportedCommitmentsRequest	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<ListSupportedCommitmentsResponse>	A response object containing details about the completed operation

Examples

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

ListSupportedHostShapes(ListSupportedHostShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists supported compute shapes for ESXi hosts.

Declaration

public Task<ListSupportedHostShapesResponse> ListSupportedHostShapes(ListSupportedHostShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSupportedHostShapesRequest	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<ListSupportedHostShapesResponse>	A response object containing details about the completed operation

Examples

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

ListSupportedVmwareSoftwareVersions(ListSupportedVmwareSoftwareVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the versions of bundled VMware software supported by the Oracle Cloud VMware Solution.

Declaration

public Task<ListSupportedVmwareSoftwareVersionsResponse> ListSupportedVmwareSoftwareVersions(ListSupportedVmwareSoftwareVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSupportedVmwareSoftwareVersionsRequest	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<ListSupportedVmwareSoftwareVersionsResponse>	A response object containing details about the completed operation

Examples

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

RefreshHcxLicenseStatus(RefreshHcxLicenseStatusRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Refresh HCX on-premise licenses status of the specified SDDC.

Declaration

public Task<RefreshHcxLicenseStatusResponse> RefreshHcxLicenseStatus(RefreshHcxLicenseStatusRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RefreshHcxLicenseStatusRequest	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<RefreshHcxLicenseStatusResponse>	A response object containing details about the completed operation

Examples

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

RetrievePassword(RetrievePasswordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieve the SDDC password.

Declaration

public Task<RetrievePasswordResponse> RetrievePassword(RetrievePasswordRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RetrievePasswordRequest	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<RetrievePasswordResponse>	A response object containing details about the completed operation

Examples

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

UpdateSddc(UpdateSddcRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified SDDC. <br/> Important: Updating an SDDC affects only certain attributes in the Sddc object and does not affect the VMware environment currently running in the SDDC. For more information, see {@link #updateSddcDetails(UpdateSddcDetailsRequest) updateSddcDetails}.

Declaration

public Task<UpdateSddcResponse> UpdateSddc(UpdateSddcRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateSddcRequest	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<UpdateSddcResponse>	A response object containing details about the completed operation

Examples

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

UpgradeHcx(UpgradeHcxRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Upgrade the specified SDDC from HCX Advanced to HCX Enterprise.

Declaration

public Task<UpgradeHcxResponse> UpgradeHcx(UpgradeHcxRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpgradeHcxRequest	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<UpgradeHcxResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable