Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace InstanceConsoleConnection

The {@code InstanceConsoleConnection} API provides you with console access to Compute instances, enabling you to troubleshoot malfunctioning instances remotely.

For more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](https://docs.cloud.oracle.com/iaas/Content/Compute/References/serialconsole.htm).

Properties

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment to contain the console connection.

Optional connectionString

connectionString: undefined | string

The SSH connection string for the console connection.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional fingerprint

fingerprint: undefined | string

The SSH public key's fingerprint for client authentication to the console connection.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {@code {\"Department\": \"Finance\"}}

Optional id

id: undefined | string

The OCID of the console connection.

Optional instanceId

instanceId: undefined | string

The OCID of the instance the console connection connects to.

Optional lifecycleState

lifecycleState: LifecycleState

The current state of the console connection.

Optional serviceHostKeyFingerprint

serviceHostKeyFingerprint: undefined | string

The SSH public key's fingerprint for the console connection service host.

Optional vncConnectionString

vncConnectionString: undefined | string

The SSH connection string for the SSH tunnel used to connect to the console connection over VNC.

Functions

getDeserializedJsonObj

getJsonObj