Interface ProvisionProvider.HypervisorConsoleFacetV2

Enclosing interface:
ProvisionProvider

public static interface ProvisionProvider.HypervisorConsoleFacetV2
Provides a typed hypervisor console contract for browser-based VM consoles. Implement this facet for new development. The returned HypervisorConsoleConnection.getProtocols() value controls WebSocket sub-protocol handling:
  • null: no override specified, preserve Morpheus defaults
  • empty list: send no Sec-WebSocket-Protocol header
  • non-empty list: send the provided values in order
Since:
1.3.4
  • Method Details

    • getXvpVNCConsoleConnection

      default ServiceResponse<HypervisorConsoleConnection> getXvpVNCConsoleConnection(ComputeServer server)
      Builds the connection details required to connect to the target server using xvpVnc.
      Parameters:
      server - server to connect to
      Returns:
      Connection details for an xvpVnc console connection to the server
      Since:
      1.3.4
    • getNoVNCConsoleConnection

      default ServiceResponse<HypervisorConsoleConnection> getNoVNCConsoleConnection(ComputeServer server)
      Builds the connection details required to connect to the target server using noVNC.
      Parameters:
      server - server to connect to
      Returns:
      Connection details for a noVNC console connection to the server
      Since:
      1.3.4
    • getWMKSConsoleConnection

      default ServiceResponse<HypervisorConsoleConnection> getWMKSConsoleConnection(ComputeServer server)
      Builds the connection details required to connect to the target server using WMKS.
      Parameters:
      server - server to connect to
      Returns:
      Connection details for a WMKS console connection to the server
      Since:
      1.3.4
    • updateServerHost

      default ServiceResponse updateServerHost(ComputeServer server)
      Method called before using the console host to ensure it is accurate.
      Parameters:
      server - server to connect to
      Returns:
      Success or failure
      Since:
      1.3.4
    • enableConsoleAccess

      default ServiceResponse enableConsoleAccess(ComputeServer server)
      Method called before making a hypervisor console connection to a server to ensure that the server settings are correct.
      Parameters:
      server - server to connect to
      Returns:
      Success or failure
      Since:
      1.3.4