Manages Remote Consoles of the Resource

Create or list all the remote consoles of the resource.

Supported Fields

Name Type Mandatory References
consoleConnector String true Agent, Gateway
consoleProtocol String true SSH,RDP,TELNET
ipAddress String true
port Integer true
consoleAuthType String false PASSWORD, PUBLICKEY
userName String false
password String false
name String false

List all the remote consoles on the resource.

Path Parameters

  • resourceIdstringrequired

    Resource uuid of the managed resource

  • clientIdstringrequired

    Describes the clientId of the tenant

Responses

  • resultsarray

  • totalResultsnumberrequired

  • pageNonumberrequired

  • pageSizenumberrequired

  • totalPagesnumberrequired

  • nextPagebooleanrequired

  • nextPageNonumberrequired

  • previousPageNonumberrequired

  • descendingOrderbooleanrequired

Loading Examples...
  • consoleAuthTypes - PASSWORD or PUBLICKEY only applicable if the consoleProtocol is SSH.
  • consoleProtocol - TELNET,SSH,RDP for browser consoles

Path Parameters

  • resourceIdstringrequired

    Resource uuid of the managed resource

  • clientIdstringrequired

    Describes the clientId of the tenant

Request Body

application/json

  • consoleConnectorstring

  • consoleAuthTypestring

  • consoleProtocolstring

  • ipAddressstring

  • portstring

  • userNamestring

  • namestring

Loading Examples...

Responses

  • consoleConnectorstring

  • consoleAuthTypestring

  • consoleProtocolstring

  • ipAddressstring

  • portstring

  • userNamestring

  • namestring

Loading Examples...