Package com.oracle.bmc.ocvp

Interface EsxiHostAsync

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the serice.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        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 - flag to enable the use of realm specific endpoint template

      • createEsxiHost

        Future<CreateEsxiHostResponse> createEsxiHost​(CreateEsxiHostRequest request,
                                              AsyncHandler<CreateEsxiHostRequest,​CreateEsxiHostResponse> handler)
        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.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • deleteEsxiHost

        Future<DeleteEsxiHostResponse> deleteEsxiHost​(DeleteEsxiHostRequest request,
                                              AsyncHandler<DeleteEsxiHostRequest,​DeleteEsxiHostResponse> handler)
        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.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getEsxiHost

        Future<GetEsxiHostResponse> getEsxiHost​(GetEsxiHostRequest request,
                                        AsyncHandler<GetEsxiHostRequest,​GetEsxiHostResponse> handler)
        Gets the specified ESXi host’s information.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • inplaceUpgrade

        Future<InplaceUpgradeResponse> inplaceUpgrade​(InplaceUpgradeRequest request,
                                              AsyncHandler<InplaceUpgradeRequest,​InplaceUpgradeResponse> handler)
        In-place upgrade a ESXi host.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listEsxiHosts

        Future<ListEsxiHostsResponse> listEsxiHosts​(ListEsxiHostsRequest request,
                                            AsyncHandler<ListEsxiHostsRequest,​ListEsxiHostsResponse> handler)
        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.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • replaceHost

        Future<ReplaceHostResponse> replaceHost​(ReplaceHostRequest request,
                                        AsyncHandler<ReplaceHostRequest,​ReplaceHostResponse> handler)
        Replace a faulty ESXi host whose underlying bare metal is broken
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • swapBilling

        Future<SwapBillingResponse> swapBilling​(SwapBillingRequest request,
                                        AsyncHandler<SwapBillingRequest,​SwapBillingResponse> handler)
        Swap billing between two Active ESXi hosts.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateEsxiHost

        Future<UpdateEsxiHostResponse> updateEsxiHost​(UpdateEsxiHostRequest request,
                                              AsyncHandler<UpdateEsxiHostRequest,​UpdateEsxiHostResponse> handler)
        Updates the specified ESXi host.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.