Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SddcClient

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

  • SddcClient

Constructors

constructor

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

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: SddcWaiter

targetService

targetService: string = "Sddc"

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

cancelDowngradeHcx

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

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

    Parameters

    Returns Promise<CancelDowngradeHcxResponse>

    CancelDowngradeHcxResponse

changeSddcCompartment

close

  • close(): void

createSddc

  • Creates an Oracle Cloud VMware Solution software-defined data center (SDDC).

    Use the WorkRequest operations to track the creation of the SDDC.

    *Important:** You must configure the SDDC's networking resources with the security rules detailed in [Security Rules for Oracle Cloud VMware Solution SDDCs](https://docs.cloud.oracle.com/iaas/Content/VMware/Reference/ocvssecurityrules.htm). Otherwise, provisioning the SDDC will fail. The rules are based on the requirements set by VMware.

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

    Parameters

    Returns Promise<CreateSddcResponse>

    CreateSddcResponse

createWaiters

  • createWaiters(config?: common.WaiterConfiguration): SddcWaiter
  • Creates a new SddcWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns SddcWaiter

    The service waiters.

deleteSddc

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

    Use the WorkRequest operations to track the deletion of the SDDC.

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

    Parameters

    Returns Promise<DeleteSddcResponse>

    DeleteSddcResponse

downgradeHcx

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

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

    Parameters

    Returns Promise<DowngradeHcxResponse>

    DowngradeHcxResponse

getSddc

  • Gets the specified SDDC'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 GetSddc API.

    Parameters

    Returns Promise<GetSddcResponse>

    GetSddcResponse

getWaiters

listSddcs

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

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

    Parameters

    Returns Promise<ListSddcsResponse>

    ListSddcsResponse

listSupportedCommitments

listSupportedHostShapes

  • Lists supported compute shapes for 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 ListSupportedHostShapes API.

    Parameters

    Returns Promise<ListSupportedHostShapesResponse>

    ListSupportedHostShapesResponse

listSupportedVmwareSoftwareVersions

refreshHcxLicenseStatus

  • Refresh HCX on-premise licenses status of the specified SDDC. 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 RefreshHcxLicenseStatus API.

    Parameters

    Returns Promise<RefreshHcxLicenseStatusResponse>

    RefreshHcxLicenseStatusResponse

retrievePassword

  • Retrieve the SDDC password.

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

    Parameters

    Returns Promise<RetrievePasswordResponse>

    RetrievePasswordResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateSddc

  • Updates the specified SDDC.

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

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

    Parameters

    Returns Promise<UpdateSddcResponse>

    UpdateSddcResponse

upgradeHcx

  • Upgrade the specified SDDC from HCX Advanced to HCX Enterprise.

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

    Parameters

    Returns Promise<UpgradeHcxResponse>

    UpgradeHcxResponse